linear_block_gs.py

Define the LinearBlockGS class.

class openmdao.solvers.linear.linear_block_gs.LinearBlockGS(**kwargs)[source]

Bases: openmdao.solvers.solver.BlockLinearSolver

Linear block Gauss-Seidel solver.

SOLVER = 'LN: LNBGS'
__init__(self, **kwargs)

Initialize all attributes.

Parameters
**kwargsdict

options dictionary.

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.

property msginfo

Return info to prepend to messages.

Returns
str

Info to prepend to messages.

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

Set of names of relevant systems based on the current linear solve.