gemseo.mda.gauss_seidel_settings module

Settings for MDAGaussSeidel.

Settings MDAGaussSeidel_Settings(*, coupling_structure=None, linear_solver=LinearSolver.DEFAULT, linear_solver_settings=None, 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, acceleration_method=AccelerationMethod.NONE, over_relaxation_factor=1.0)

Bases: BaseMDASolverSettings

The settings for MDAGaussSeidel.

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)

• 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.

• acceleration_method (AccelerationMethod) --

  By default it is set to "NoTransformation".

• over_relaxation_factor (Annotated[float, Le(le=2.0), Ge(ge=0)]) --

  By default it is set to 1.0.

Return type:

None