Implementation of the Newton-Raphson method for solving nonlinear equations. More...

#include <ikarus/solver/nonlinearsolver/newtonraphson.hh>

Inheritance diagram for Ikarus::NewtonRaphson< NLO, LS, UF >:

Public Types
using	Settings = NRSettings
	Compile-time boolean indicating if the linear solver satisfies the non-linear solver concept. More...

using	ValueType = typename NLO::template ParameterValue< 0 >

using	UpdateFunction = UF
	Type representing the update function. More...

using	NonLinearOperator = NLO
	Type of the non-linear operator. More...

Public Member Functions
template<typename LS2 = LS, typename UF2 = UF>
	NewtonRaphson (const NonLinearOperator &nonLinearOperator, LS2 &&linearSolver={}, UF2 &&updateFunction={})
	Constructor for NewtonRaphson. More...

void	setup (const Settings &settings)
	Set up the solver with the given settings. More...

template<typename SolutionType = NoPredictor> requires std::is_same_v<SolutionType, NoPredictor> \|\| std::is_convertible_v<SolutionType, std::remove_cvref_t<typename NonLinearOperator::ValueType>>
Ikarus::NonLinearSolverInformation	solve (const SolutionType &dxPredictor=NoPredictor{})
	Solve the nonlinear system. More...

auto &	nonLinearOperator ()
	Access the nonlinear operator. More...

void	subscribe (NonLinearSolverMessages message, std::shared_ptr< IObserver< NonLinearSolverMessages > > observer)
	Subscribe an observer to receive notifications for a specific message type. More...

void	subscribeAll (std::shared_ptr< IObserver< NonLinearSolverMessages > > observer)
	Subscribe an observer to receive notifications for all message types. More...

void	subscribeAll (std::initializer_list< std::shared_ptr< IObserver< NonLinearSolverMessages > > > observers)
	Subscribe multiple observers to receive notifications for all message types. More...

void	unSubscribe (NonLinearSolverMessages message, std::shared_ptr< IObserver< NonLinearSolverMessages > > observer)
	Unsubscribe an observer from receiving notifications for a specific message type. More...

void	unSubscribeAll (std::shared_ptr< IObserver< NonLinearSolverMessages > > observer)
	Unsubscribe an observer from receiving notifications for all message types. More...

void	notify (NonLinearSolverMessages message)
	Notify observers about a specific message type. More...

void	notify (NonLinearSolverMessages message, ScalarType val)
	Notify observers about a specific message type with a floating-point value. More...

void	notify (NonLinearSolverMessages message, int val)
	Notify observers about a specific message type with an integer value. More...

void	notify (NonLinearSolverMessages message, const std::string &val)
	Notify observers about a specific message type with a string value. More...

void	notify (NonLinearSolverMessages message, int val1, double val2)
	Notify observers about a specific message type with an integer and a double value. More...

void	notify (NonLinearSolverMessages message, int val1, const std::string &val2)
	Notify observers about a specific message type with an integer value and a string value. More...

void	notify (NonLinearSolverMessages message, Eigen::VectorX< ScalarType > vec)
	Notify observers about a specific message type with an Eigen::VectorX. More...

void	notify (MT message)

void	notify (MT message, ScalarType val)

void	notify (MT message, int val)

void	notify (MT message, const std::string &val)

void	notify (MT message, int val1, double val2)

void	notify (MT message, int val1, const std::string &val2)

void	notify (MT message, Eigen::VectorX< ScalarType > vec)

Static Public Attributes
static constexpr bool	isLinearSolver
	Type representing the parameter vector of the nonlinear operator. More...

Detailed Description

template<typename NLO, typename LS, typename UF>
class Ikarus::NewtonRaphson< NLO, LS, UF >

Template Parameters

NLO	Type of the nonlinear operator to solve.
LS	Type of the linear solver used internally (default is SolverDefault).
UF	Type of the update function (default is UpdateDefault).

Member Typedef Documentation

◆ NonLinearOperator

template<typename NLO , typename LS , typename UF >

using Ikarus::NewtonRaphson< NLO, LS, UF >::NonLinearOperator = NLO

◆ Settings

template<typename NLO , typename LS , typename UF >

using Ikarus::NewtonRaphson< NLO, LS, UF >::Settings = NRSettings

◆ UpdateFunction

template<typename NLO , typename LS , typename UF >

using Ikarus::NewtonRaphson< NLO, LS, UF >::UpdateFunction = UF

◆ ValueType

template<typename NLO , typename LS , typename UF >

using Ikarus::NewtonRaphson< NLO, LS, UF >::ValueType = typename NLO::template ParameterValue<0>

Constructor & Destructor Documentation

◆ NewtonRaphson()

template<typename NLO , typename LS , typename UF >

template<typename LS2 = LS, typename UF2 = UF>

Ikarus::NewtonRaphson< NLO, LS, UF >::NewtonRaphson	(	const NonLinearOperator &	nonLinearOperator,
		LS2 &&	linearSolver = `{}`,
		UF2 &&	updateFunction = `{}`
	)

inlineexplicit

Parameters

nonLinearOperator	Nonlinear operator to solve.
linearSolver	Linear solver used internally (default is SolverDefault).
updateFunction	Update function (default is UpdateDefault).

Member Function Documentation

◆ nonLinearOperator()

template<typename NLO , typename LS , typename UF >

auto & Ikarus::NewtonRaphson< NLO, LS, UF >::nonLinearOperator ( )

inline

Returns: Reference to the nonlinear operator.

◆ notify() [1/14]

void Ikarus::IObservable< NonLinearSolverMessages >::notify ( MT message )

inherited

◆ notify() [2/14]

void Ikarus::IObservable< NonLinearSolverMessages >::notify	(	MT	message,
		const std::string &	val
	)

inherited

◆ notify() [3/14]

void Ikarus::IObservable< NonLinearSolverMessages >::notify	(	MT	message,
		Eigen::VectorX< ScalarType >	vec
	)

inherited

◆ notify() [4/14]

void Ikarus::IObservable< NonLinearSolverMessages >::notify	(	MT	message,
		int	val
	)

inherited

◆ notify() [5/14]

void Ikarus::IObservable< NonLinearSolverMessages >::notify	(	MT	message,
		int	val1,
		const std::string &	val2
	)

inherited

◆ notify() [6/14]

void Ikarus::IObservable< NonLinearSolverMessages >::notify	(	MT	message,
		int	val1,
		double	val2
	)

inherited

◆ notify() [7/14]

void Ikarus::IObservable< NonLinearSolverMessages >::notify	(	MT	message,
		ScalarType	val
	)

inherited

◆ notify() [8/14]

void Ikarus::IObservable< NonLinearSolverMessages >::notify ( NonLinearSolverMessages message )

inherited

Parameters

message The message type to notify about.

◆ notify() [9/14]

void Ikarus::IObservable< NonLinearSolverMessages >::notify	(	NonLinearSolverMessages	message,
		const std::string &	val
	)

inherited

Parameters

message	The message type to notify about.
val	The string value to be sent with the notification.

◆ notify() [10/14]

void Ikarus::IObservable< NonLinearSolverMessages >::notify	(	NonLinearSolverMessages	message,
		Eigen::VectorX< ScalarType >	vec
	)

inherited

Template Parameters

ScalarType The type of the elements in the Eigen::VectorX.

Parameters

message	The message type to notify about.
vec	The Eigen::VectorX to be sent with the notification.

◆ notify() [11/14]

void Ikarus::IObservable< NonLinearSolverMessages >::notify	(	NonLinearSolverMessages	message,
		int	val
	)

inherited

Parameters

message	The message type to notify about.
val	The integer value to be sent with the notification.

◆ notify() [12/14]

void Ikarus::IObservable< NonLinearSolverMessages >::notify	(	NonLinearSolverMessages	message,
		int	val1,
		const std::string &	val2
	)

inherited

Parameters

message	The message type to notify about.
val1	The integer value to be sent with the notification.
val2	The string value to be sent with the notification.

◆ notify() [13/14]

void Ikarus::IObservable< NonLinearSolverMessages >::notify	(	NonLinearSolverMessages	message,
		int	val1,
		double	val2
	)

inherited

Parameters

message	The message type to notify about.
val1	The integer value to be sent with the notification.
val2	The double value to be sent with the notification.

◆ notify() [14/14]

void Ikarus::IObservable< NonLinearSolverMessages >::notify	(	NonLinearSolverMessages	message,
		ScalarType	val
	)

inherited

Template Parameters

ScalarType The type of the floating-point value.

Parameters

message	The message type to notify about.
val	The floating-point value to be sent with the notification.

◆ setup()

template<typename NLO , typename LS , typename UF >

void Ikarus::NewtonRaphson< NLO, LS, UF >::setup ( const Settings & settings )

inline

Parameters

settings Newton-Raphson settings.

◆ solve()

template<typename NLO , typename LS , typename UF >

template<typename SolutionType = NoPredictor>
requires std::is_same_v<SolutionType, NoPredictor> || std::is_convertible_v<SolutionType, std::remove_cvref_t<typename NonLinearOperator::ValueType>>

Ikarus::NonLinearSolverInformation Ikarus::NewtonRaphson< NLO, LS, UF >::solve ( const SolutionType & dxPredictor = NoPredictor{} )

inline

Parameters

dxPredictor Predictor for the solution increment (default is NoPredictor).

Returns: Information about the solution process.

◆ subscribe()

void Ikarus::IObservable< MT >::subscribe	(	NonLinearSolverMessages	message,
		std::shared_ptr< IObserver< NonLinearSolverMessages > >	observer
	)

inherited

Parameters

message	The message type to subscribe to.
observer	The observer to be subscribed.

◆ subscribeAll() [1/2]

void Ikarus::IObservable< NonLinearSolverMessages >::subscribeAll ( std::initializer_list< std::shared_ptr< IObserver< NonLinearSolverMessages > > > observers )

inherited

Parameters

observers List of observers to be subscribed.

◆ subscribeAll() [2/2]

void Ikarus::IObservable< NonLinearSolverMessages >::subscribeAll ( std::shared_ptr< IObserver< NonLinearSolverMessages > > observer )

inherited

Parameters

observer The observer to be subscribed.

◆ unSubscribe()

void Ikarus::IObservable< MT >::unSubscribe	(	NonLinearSolverMessages	message,
		std::shared_ptr< IObserver< NonLinearSolverMessages > >	observer
	)

inherited

Parameters

message	The message type to unsubscribe from.
observer	The observer to be unsubscribed.

◆ unSubscribeAll()

void Ikarus::IObservable< MT >::unSubscribeAll ( std::shared_ptr< IObserver< NonLinearSolverMessages > > observer )

inherited

Parameters

observer The observer to be unsubscribed.

Member Data Documentation

◆ isLinearSolver

template<typename NLO , typename LS , typename UF >

constexpr bool Ikarus::NewtonRaphson< NLO, LS, UF >::isLinearSolver

staticconstexpr

Initial value:

=

Ikarus::Concepts::LinearSolverCheck<LinearSolver, typename NLO::DerivativeType, typename NLO::ValueType>

Ikarus::Concepts::LinearSolverCheck

Concept to check if a linear solver implements all the needed functions for given vector and matrix t...

Definition: concepts.hh:215

The documentation for this class was generated from the following file:

newtonraphson.hh

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ NonLinearOperator

◆ Settings

◆ UpdateFunction

◆ ValueType

Constructor & Destructor Documentation

◆ NewtonRaphson()

Member Function Documentation

◆ nonLinearOperator()

◆ notify() [1/14]

◆ notify() [2/14]

◆ notify() [3/14]

◆ notify() [4/14]

◆ notify() [5/14]

◆ notify() [6/14]

◆ notify() [7/14]

◆ notify() [8/14]

◆ notify() [9/14]

◆ notify() [10/14]

◆ notify() [11/14]

◆ notify() [12/14]

◆ notify() [13/14]

◆ notify() [14/14]

◆ setup()

◆ solve()

◆ subscribe()

◆ subscribeAll() [1/2]

◆ subscribeAll() [2/2]

◆ unSubscribe()

◆ unSubscribeAll()

Member Data Documentation

◆ isLinearSolver