gemseo.formulations.mdf_settings module#

Settings of the MDF formulation.

Settings MDF_Settings(*, differentiated_input_names_substitute=(), main_mda_name='MDAChain', main_mda_settings=<factory>)[source]#

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) --

    By default it is set to <factory>.

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, /)#

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that's what pydantic-core passes when calling it.

Parameters:

  • self (BaseModel) -- The BaseModel instance.

  • context (Any) -- The context.

Return type:

None