gemseo.mda.gs_newton_settings module

Settings for MDAGSNewton.

Settings MDAGSNewton_Settings(*, coupling_structure=None, linear_solver=LinearSolver.DEFAULT, linear_solver_settings=<factory>, 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=False, gauss_seidel_settings=<factory>, newton_settings=<factory>)

Bases: MDASequential_Settings

The settings for MDAGSNewton.

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:

• coupling_structure (CouplingStructure | None)

• linear_solver (LinearSolver) --

  By default it is set to "DEFAULT".

• linear_solver_settings (Mapping[str, Any] | BaseLinearSolverSettings) --

  By default it is set to <factory>.

• linear_solver_tolerance (Annotated[float, Ge(ge=0)]) --

  By default it is set to 1e-12.

• log_convergence (bool) --

  By default it is set to False.

• max_mda_iter (Annotated[int, Ge(ge=0)]) --

  By default it is set to 20.

• max_consecutive_unsuccessful_iterations (Annotated[int, Ge(ge=0)]) --

  By default it is set to 8.

• name (str) --

  By default it is set to "".

• tolerance (Annotated[float, Ge(ge=0)]) --

  By default it is set to 1e-06.

• use_lu_fact (bool) --

  By default it is set to False.

• warm_start (bool) --

  By default it is set to False.

• gauss_seidel_settings (Mapping[str, Any] | MDAGaussSeidel_Settings) --

  By default it is set to <factory>.

• newton_settings (Mapping[str, Any] | MDANewtonRaphson_Settings) --

  By default it is set to <factory>.

Return type:

None

gauss_seidel_settings: StrKeyMapping | MDAGaussSeidel_Settings [Optional]

The settings for the Gauss-Seidel MDA.

newton_settings: StrKeyMapping | MDANewtonRaphson_Settings [Optional]

The settings for the Newton-Raphson 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