newton.py

Define the NewtonSolver class.

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

Bases: openmdao.solvers.solver.NonlinearSolver

Newton solver.

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

Attributes

linear_solver

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

linesearch

(NonlinearSolver) Line search algorithm. Default is None for no line search.

SOLVER = 'NL: Newton'
__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)[source]

Clean up resources prior to exit.

Return the current linesearch object.

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.