gemseo.algos.linear_solvers.base_linear_solver_library module#

Base class for libraries of linear solvers.

class BaseLinearSolverLibrary(algo_name)[source]#

Bases: BaseAlgorithmLibrary

Base class for libraries of linear solvers.

Parameters:

algo_name (str) -- The algorithm name.

Raises:

KeyError -- When the algorithm is not in the library.

file_path: Path#

The file path to save the linear problem after an execution.

class LinearSolverDescription(algorithm_name, internal_algorithm_name, library_name='', description='', website='', Settings=<class 'gemseo.algos.linear_solvers.base_linear_solver_settings.BaseLinearSolverSettings'>, lhs_must_be_symmetric=False, lhs_must_be_positive_definite=False, lhs_must_be_linear_operator=False)[source]#

Bases: AlgorithmDescription

The description of a linear solver.

Parameters:

  • algorithm_name (str)

  • internal_algorithm_name (str)

  • library_name (str) --

    By default it is set to "".

  • description (str) --

    By default it is set to "".

  • website (str) --

    By default it is set to "".

  • Settings (type[BaseLinearSolverSettings]) --

    By default it is set to <class 'gemseo.algos.linear_solvers.base_linear_solver_settings.BaseLinearSolverSettings'>.

  • lhs_must_be_symmetric (bool) --

    By default it is set to False.

  • lhs_must_be_positive_definite (bool) --

    By default it is set to False.

  • lhs_must_be_linear_operator (bool) --

    By default it is set to False.

Settings#

The linear solver libraries settings.

alias of BaseLinearSolverSettings

lhs_must_be_linear_operator: bool = False#

Whether the left-hand side matrix must be a linear operator.

lhs_must_be_positive_definite: bool = False#

Whether the left-hand side matrix must be positive definite.

lhs_must_be_symmetric: bool = False#

Whether the left-hand side matrix must be symmetric.