newton.py

newton.py#

Define the NewtonSolver class.

class openmdao.solvers.nonlinear.newton.NewtonSolver(**kwargs)[source]

Bases: NonlinearSolver

Newton solver.

The default linear solver is the linear_solver in the containing system.

Parameters:
**kwargsdict

Options dictionary.

Attributes:
linear_solverLinearSolver

Linear solver to use to find the Newton search direction. The default is the parent system’s linear solver.

_linesearchNonlinearSolver

Line search algorithm. Default is None for no line search.

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: Newton'
__init__(**kwargs)[source]

Initialize all attributes.

cleanup()[source]

Clean up resources prior to exit.

use_relevance()[source]

Return True if relevance should be active.

Returns:
bool

True if relevance should be active.