nonlinear_block_gs.py

Define the NonlinearBlockGS class.

class openmdao.solvers.nonlinear.nonlinear_block_gs.NonlinearBlockGS(**kwargs)

Bases: NonlinearSolver

Nonlinear block Gauss-Seidel solver.

Parameters:

**kwargsdict

Options dictionary.

Attributes:

_delta_outputs_n_1ndarray

Cached change in the full output vector for the previous iteration. Only used if the aitken acceleration option is turned on.

_theta_n_1float

Cached relaxation factor from previous iteration. Only used if the aitken acceleration option is turned on.

SOLVER = 'NL: NLBGS'

__init__(**kwargs)

Initialize all attributes.

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.

get_reports_dir()

Get the path to the directory where the report files should go.

If it doesn’t exist, it will be created.

Returns:

str

The path to the directory where reports should be written.

property msginfo

Return info to prepend to messages.

Returns:

str

Info to prepend to messages.

record_iteration(**kwargs)

Record an iteration of the current Solver.

Parameters:

**kwargsdict

Keyword arguments (used for abs and rel error).

solve()

Run the solver.