nonlinear_block_gs.py

Define the NonlinearBlockGS class.

class openmdao.solvers.nonlinear.nonlinear_block_gs.NonlinearBlockGS(**kwargs)[source]

Bases: openmdao.solvers.solver.NonlinearSolver

Nonlinear block Gauss-Seidel solver.

SOLVER = 'NL: NLBGS'
__init__(self, **kwargs)[source]

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)

Run the solver.