gemseo.formulations.mdf_settings module

Settings of the MDF formulation.

Settings MDF_Settings(*, differentiated_input_names_substitute=(), main_mda_name='MDAChain', main_mda_settings=None)

Bases: BaseFormulationSettings

Settings of the MDF formulation.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

• differentiated_input_names_substitute (Sequence[str]) --

  By default it is set to ().

• main_mda_name (str) --

  By default it is set to "MDAChain".

• main_mda_settings (Mapping[str, Any] | BaseMDASettings)

Return type:

None

main_mda_name: str = 'MDAChain'

The name of the class of the main MDA.

Typically the MDAChain, but one can force to use MDAGaussSeidel for instance.

main_mda_settings: StrKeyMapping | BaseMDASettings [Optional]

The settings of the main MDA.

These settings may include those of the inner-MDA.

model_post_init(context, /)

We need to both initialize private attributes and call the user-defined model_post_init method.

Parameters:

• self (BaseModel)

• context (Any)

Return type:

None