scipy_iter_solver.py

Define the scipy iterative solver class.

class openmdao.solvers.linear.scipy_iter_solver.ScipyIterativeSolver(*args, **kwargs)[source]

Bases: openmdao.solvers.linear.scipy_iter_solver.ScipyKrylov

Deprecated. See ScipyKrylov.

SOLVER = 'LN: SCIPY'
__init__(self, *args, **kwargs)[source]

Deprecated.

Parameters
*argslist of object

Positional args.

**kwargsdict

Named args.

add_recorder(self, recorder)

Add a recorder to the solver’s RecordingManager.

Parameters
recorder<CaseRecorder>

A recorder instance to be added to RecManager.

cleanup(self)

Clean up resources prior to exit.

preconditioner

Provide ‘preconditioner’ property for backwards compatibility.

Returns
LinearSolver

reference to the ‘precon’ property.

record_iteration(self, **kwargs)

Record an iteration of the current Solver.

Parameters
**kwargsdict

Keyword arguments (used for abs and rel error).

solve(self, vec_names, mode, rel_systems=None)

Run the solver.

Parameters
vec_names[str, …]

list of names of the right-hand-side vectors.

modestr

‘fwd’ or ‘rev’.

rel_systemsset of str

Names of systems relevant to the current solve.

class openmdao.solvers.linear.scipy_iter_solver.ScipyKrylov(**kwargs)[source]

Bases: openmdao.solvers.solver.LinearSolver

The Krylov iterative solvers in scipy.sparse.linalg.

Attributes

precon

(Solver) Preconditioner for linear solve. Default is None for no preconditioner.

SOLVER = 'LN: SCIPY'
__init__(self, **kwargs)[source]

Declare the solver option.

Parameters
**kwargs{}

dictionary of options set by the instantiating class/script.

add_recorder(self, recorder)

Add a recorder to the solver’s RecordingManager.

Parameters
recorder<CaseRecorder>

A recorder instance to be added to RecManager.

cleanup(self)

Clean up resources prior to exit.

preconditioner

Provide ‘preconditioner’ property for backwards compatibility.

Returns
LinearSolver

reference to the ‘precon’ property.

record_iteration(self, **kwargs)

Record an iteration of the current Solver.

Parameters
**kwargsdict

Keyword arguments (used for abs and rel error).

solve(self, vec_names, mode, rel_systems=None)[source]

Run the solver.

Parameters
vec_names[str, …]

list of names of the right-hand-side vectors.

modestr

‘fwd’ or ‘rev’.

rel_systemsset of str

Names of systems relevant to the current solve.