gemseo.formulations.bilevel_bcd_settings module#

Settings of the BiLevel BCD formulation .

Settings BiLevel_BCD_Settings(*, differentiated_input_names_substitute=(), main_mda_name='MDAChain', main_mda_settings=<factory>, parallel_scenarios=False, multithread_scenarios=True, apply_cstr_tosub_scenarios=True, apply_cstr_to_system=True, reset_x0_before_opt=False, sub_scenarios_log_level=None, keep_opt_history=True, save_opt_history=False, naming=Naming.NUMBERED, bcd_mda_settings=MDAGaussSeidel_Settings(coupling_structure=None, linear_solver=<LinearSolver.DEFAULT: 'DEFAULT'>, linear_solver_settings={}, linear_solver_tolerance=1e-12, log_convergence=False, max_mda_iter=20, max_consecutive_unsuccessful_iterations=8, name='', tolerance=1e-06, use_lu_fact=False, warm_start=True, acceleration_method=<AccelerationMethod.NONE: 'NoTransformation'>, over_relaxation_factor=1.0))[source]#

Bases: BiLevel_Settings

Settings of the BiLevel 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>.

  • parallel_scenarios (bool) --

    By default it is set to False.

  • multithread_scenarios (bool) --

    By default it is set to True.

  • apply_cstr_tosub_scenarios (bool) --

    By default it is set to True.

  • apply_cstr_to_system (bool) --

    By default it is set to True.

  • reset_x0_before_opt (bool) --

    By default it is set to False.

  • sub_scenarios_log_level (int | None)

  • keep_opt_history (bool) --

    By default it is set to True.

  • save_opt_history (bool) --

    By default it is set to False.

  • naming (Naming) --

    By default it is set to "NUMBERED".

  • bcd_mda_settings (MDAGaussSeidel_Settings) --

    By default it is set to coupling_structure=None linear_solver=<LinearSolver.DEFAULT: 'DEFAULT'> linear_solver_settings={} linear_solver_tolerance=1e-12 log_convergence=False max_mda_iter=20 max_consecutive_unsuccessful_iterations=8 name='' tolerance=1e-06 use_lu_fact=False warm_start=True acceleration_method=<AccelerationMethod.NONE: 'NoTransformation'> over_relaxation_factor=1.0.

Return type:

None

bcd_mda_settings: MDAGaussSeidel_Settings = MDAGaussSeidel_Settings(coupling_structure=None, linear_solver=<LinearSolver.DEFAULT: 'DEFAULT'>, linear_solver_settings={}, linear_solver_tolerance=1e-12, log_convergence=False, max_mda_iter=20, max_consecutive_unsuccessful_iterations=8, name='', tolerance=1e-06, use_lu_fact=False, warm_start=True, acceleration_method=<AccelerationMethod.NONE: 'NoTransformation'>, over_relaxation_factor=1.0)#

The settings for the MDA used in the BCD method.

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