nonlinear_block_gs.py#

Define the NonlinearBlockGS class.

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

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.

Methods

add_recorder(recorder)

Add a recorder to the solver's RecordingManager.

can_solve_cycle()

Return True if this solver can solve groups with cycles.

check_config(logger)

Perform optional error checks.

cleanup()

Clean up resources prior to exit.

get_outputs_dir(*subdirs[, mkdir])

Get the path under which all output files of this solver are to be placed.

get_reports_dir()

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

record_iteration(**kwargs)

Record an iteration of the current Solver.

report_failure(msg)

Report a failure that has occurred.

solve()

Run the solver.

use_relevance()

Return True if relevance should be active.

SOLVER = 'NL: NLBGS'

__init__(**kwargs)[source]

Initialize all attributes.

`add_recorder`(recorder)	Add a recorder to the solver's RecordingManager.
`can_solve_cycle`()	Return True if this solver can solve groups with cycles.
`check_config`(logger)	Perform optional error checks.
`cleanup`()	Clean up resources prior to exit.
`get_outputs_dir`(*subdirs[, mkdir])	Get the path under which all output files of this solver are to be placed.
`get_reports_dir`()	Get the path to the directory where the report files should go.
`record_iteration`(**kwargs)	Record an iteration of the current Solver.
`report_failure`(msg)	Report a failure that has occurred.
`solve`()	Run the solver.
`use_relevance`()	Return True if relevance should be active.