gemseo.algos.linear_solvers.base_linear_solver_settings module#

Settings for the linear solvers.

Settings BaseLinearSolverSettings(*, store_residuals=False, use_ilu_precond=False, save_when_fail=False, kkt_tol_abs=inf, kkt_tol_rel=inf)[source]#

Bases: BaseAlgorithmSettings

The settings common to all the linear solver libraries.

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:

  • store_residuals (bool) --

    By default it is set to False.

  • use_ilu_precond (bool) --

    By default it is set to False.

  • save_when_fail (bool) --

    By default it is set to False.

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

    By default it is set to inf.

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

    By default it is set to inf.

Return type:

None

save_when_fail: bool = False#

Whether to use an incomplete LU factorization as preconditioner.

store_residuals: bool = False#

Whether to store the residual norms at each iterations.

use_ilu_precond: bool = False#

Whether to use an incomplete LU factorization as preconditioner.