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__(**kwargs)

Initialize all attributes.

Parameters:
**kwargs : dict

options dictionary.

add_recorder(recorder)

Add a recorder to the solver’s RecordingManager.

Parameters:
recorder : <CaseRecorder>

A recorder instance to be added to RecManager.

cleanup()

Clean up resources prior to exit.

record_iteration(**kwargs)

Record an iteration of the current Solver.

Parameters:
**kwargs : dict

Keyword arguments (used for abs and rel error).

solve()

Run the solver.

Returns:
boolean

Failure flag; True if failed to converge, False is successful.

float

absolute error.

float

relative error.