Ikarus::NewtonRaphsonWithSubsidiaryFunction< NonLinearOperatorImpl, LinearSolver, UpdateFunctionTypeImpl > Class Template Reference

Newton-Raphson solver with subsidiary function. More...

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

Inheritance diagram for Ikarus::NewtonRaphsonWithSubsidiaryFunction< NonLinearOperatorImpl, LinearSolver, UpdateFunctionTypeImpl >:

Public Types
using	ValueType = typename NonLinearOperatorImpl::template ParameterValue< 0 >
	Type representing the update function. More...
using	UpdateFunctionType = UpdateFunctionTypeImpl
using	NonLinearOperator = NonLinearOperatorImpl
	Type of the non-linear operator. More...

Public Member Functions
	NewtonRaphsonWithSubsidiaryFunction (const NonLinearOperatorImpl &p_nonLinearOperator, LinearSolver &&p_linearSolver={}, UpdateFunctionType p_updateFunction={})
	Constructor for NewtonRaphsonWithSubsidiaryFunction. More...
void	setup (const NewtonRaphsonWithSubsidiaryFunctionSettings &p_settings)
	Setup the Newton-Raphson solver with subsidiary function. More...
template<typename SolutionType = NoPredictor, typename SubsidiaryType > requires std::is_same_v<SolutionType, NoPredictor> || std::is_convertible_v< SolutionType, std::remove_cvref_t<typename NonLinearOperatorImpl::ValueType>>
NonLinearSolverInformation	solve (SubsidiaryType &subsidiaryFunction, SubsidiaryArgs &subsidiaryArgs, const SolutionType &dx_predictor=NoPredictor{})
	Solve the nonlinear system using the Newton-Raphson method with subsidiary function. 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...

Static Public Attributes
static constexpr bool	isLinearSolver
	< Compile-time boolean indicating if the linear solver satisfies the non-linear solver concept More...

Detailed Description

template<typename NonLinearOperatorImpl, typename LinearSolver = utils::SolverDefault, typename UpdateFunctionTypeImpl = utils::UpdateDefault>
class Ikarus::NewtonRaphsonWithSubsidiaryFunction< NonLinearOperatorImpl, LinearSolver, UpdateFunctionTypeImpl >

This class provides a Newton-Raphson solver for solving nonlinear systems with a subsidiary function. It uses a linear solver to handle the linear system arising in each iteration.

Template Parameters

NonLinearOperatorImpl	Type of the nonlinear operator.
LinearSolver	Type of the linear solver used internally (default is SolverDefault).
UpdateFunctionTypeImpl	Type of the update function (default is UpdateDefault).

Member Typedef Documentation

NonLinearOperator

template<typename NonLinearOperatorImpl , typename LinearSolver = utils::SolverDefault, typename UpdateFunctionTypeImpl = utils::UpdateDefault>

using Ikarus::NewtonRaphsonWithSubsidiaryFunction< NonLinearOperatorImpl, LinearSolver, UpdateFunctionTypeImpl >::NonLinearOperator = NonLinearOperatorImpl

UpdateFunctionType

template<typename NonLinearOperatorImpl , typename LinearSolver = utils::SolverDefault, typename UpdateFunctionTypeImpl = utils::UpdateDefault>

using Ikarus::NewtonRaphsonWithSubsidiaryFunction< NonLinearOperatorImpl, LinearSolver, UpdateFunctionTypeImpl >::UpdateFunctionType = UpdateFunctionTypeImpl

ValueType

template<typename NonLinearOperatorImpl , typename LinearSolver = utils::SolverDefault, typename UpdateFunctionTypeImpl = utils::UpdateDefault>

using Ikarus::NewtonRaphsonWithSubsidiaryFunction< NonLinearOperatorImpl, LinearSolver, UpdateFunctionTypeImpl >::ValueType = typename NonLinearOperatorImpl::template ParameterValue<0>

Constructor & Destructor Documentation

NewtonRaphsonWithSubsidiaryFunction()

template<typename NonLinearOperatorImpl , typename LinearSolver = utils::SolverDefault, typename UpdateFunctionTypeImpl = utils::UpdateDefault>

Ikarus::NewtonRaphsonWithSubsidiaryFunction< NonLinearOperatorImpl, LinearSolver, UpdateFunctionTypeImpl >::NewtonRaphsonWithSubsidiaryFunction ( const NonLinearOperatorImpl &  p_nonLinearOperator, LinearSolver &&  p_linearSolver = {}, UpdateFunctionType  p_updateFunction = {}  )

inlineexplicit

Parameters

p_nonLinearOperator	Nonlinear operator to solve.
p_linearSolver	Linear solver used internally (default is SolverDefault).
p_updateFunction	Update function (default is UpdateDefault).

Member Function Documentation

nonLinearOperator()

template<typename NonLinearOperatorImpl , typename LinearSolver = utils::SolverDefault, typename UpdateFunctionTypeImpl = utils::UpdateDefault>

auto & Ikarus::NewtonRaphsonWithSubsidiaryFunction< NonLinearOperatorImpl, LinearSolver, UpdateFunctionTypeImpl >::nonLinearOperator ( )

inline

Returns

Reference to the nonlinear operator.

notify() [1/7]

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

inherited

Parameters

message

The message type to notify about.

notify() [2/7]

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() [3/7]

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() [4/7]

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() [5/7]

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() [6/7]

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() [7/7]

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 NonLinearOperatorImpl , typename LinearSolver = utils::SolverDefault, typename UpdateFunctionTypeImpl = utils::UpdateDefault>

void Ikarus::NewtonRaphsonWithSubsidiaryFunction< NonLinearOperatorImpl, LinearSolver, UpdateFunctionTypeImpl >::setup ( const NewtonRaphsonWithSubsidiaryFunctionSettings &  p_settings )

inline

Parameters

p_settings

Settings for the solver.

solve()

template<typename NonLinearOperatorImpl , typename LinearSolver = utils::SolverDefault, typename UpdateFunctionTypeImpl = utils::UpdateDefault>

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

NonLinearSolverInformation Ikarus::NewtonRaphsonWithSubsidiaryFunction< NonLinearOperatorImpl, LinearSolver, UpdateFunctionTypeImpl >::solve ( SubsidiaryType &  subsidiaryFunction, SubsidiaryArgs &  subsidiaryArgs, const SolutionType &  dx_predictor = NoPredictor{}  )

inline

Template Parameters

SolutionType	Type of the solution predictor (default is NoPredictor).
SubsidiaryType	Type of the subsidiary function.

Parameters

subsidiaryFunction	Subsidiary function to be solved.
subsidiaryArgs	Additional arguments for the subsidiary function.
dx_predictor	Predictor for the solution increment (default is NoPredictor).

Returns

Information about the solution process.

Initializations

Determine Fext0 It is assumed that Fext = Fext0 * lambda such that dRdlambda = Fext0 Generalization for Fext0 = Fext0(lambda) is not implemented

Iterative solving scheme

Two-step solving procedure

subscribe()

void Ikarus::IObservable< NonLinearSolverMessages >::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< NonLinearSolverMessages >::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< NonLinearSolverMessages >::unSubscribeAll ( std::shared_ptr< IObserver< NonLinearSolverMessages > >  observer )

inherited

Parameters

observer

The observer to be unsubscribed.

Member Data Documentation

isLinearSolver

template<typename NonLinearOperatorImpl , typename LinearSolver = utils::SolverDefault, typename UpdateFunctionTypeImpl = utils::UpdateDefault>

constexpr bool Ikarus::NewtonRaphsonWithSubsidiaryFunction< NonLinearOperatorImpl, LinearSolver, UpdateFunctionTypeImpl >::isLinearSolver

staticconstexpr

Initial value:

= Ikarus::Concepts::LinearSolverCheck<LinearSolver, typename NonLinearOperatorImpl::DerivativeType,
                                              typename NonLinearOperatorImpl::ValueType>

Type representing the parameter vector of the nonlinear operator.

---

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

• newtonraphsonwithscalarsubsidiaryfunction.hh