gemseo.mda.base_mda_solver module

The base class for MDA solvers.

class BaseMDASolver(disciplines, settings_model=None, **settings)

Bases: BaseMDA

The base class for MDA solvers.

Initialize self. See help(type(self)) for accurate signature.

Parameters:

• disciplines (Sequence[Discipline]) -- The disciplines from which to compute the MDA.

• settings_model (BaseMDASolverSettings | None) -- The MDA settings as a Pydantic model. If None, use **settings.

• **settings (Any) -- The MDA settings. These arguments are ignored when settings_model is not None.

get_current_resolved_residual_vector()

Return the vector of residuals.

Return type:

ndarray

get_current_resolved_variables_vector()

Return the vector of resolved variables (couplings and state variables).

Return type:

ndarray

set_bounds(variable_names_to_bounds)

Set the bounds for the resolved variables.

Parameters:

variable_names_to_bounds (Mapping[str, tuple[RealArray | None, RealArray | None]]) -- The mapping from variable names to bounds.

Return type:

None

Settings: ClassVar[type[BaseMDASolverSettings]]

The Pydantic model for the settings.

property acceleration_method: AccelerationMethod

The acceleration method.

property lower_bound_vector: RealArray | None

The vector of resolved variables lower bound.

property over_relaxation_factor: float

The over-relaxation factor.

settings: BaseMDASolverSettings

The settings of the MDA.

property upper_bound_vector: RealArray | None

The vector of resolved variables upper bound.