Ikarus::NewtonRaphson< F, LS, UF > Class Template Reference

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

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

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

Public Types
using	Settings = NRSettings
using	SignatureTraits = typename F::Traits
using	CorrectionType = typename SignatureTraits::template Range< 0 >
	Type of the correction of x += deltaX. More...
using	JacobianType = typename SignatureTraits::template Range< 1 >
	Compile-time boolean indicating if the linear solver satisfies the non-linear solver concept. More...
using	Domain = typename SignatureTraits::Domain
	Type representing the parameter vector of the function. More...
using	UpdateFunction = UF
	Type representing the update function. More...
using	DifferentiableFunction = F
	Type of the non-linear operator. More...
using	State = NonlinearSolverStateType< F >

Public Member Functions
template<typename LS2 = LS, typename UF2 = UF>
	NewtonRaphson (const DifferentiableFunction &residual, LS2 &&linearSolver={}, UF2 &&updateFunction={})
	Constructor for NewtonRaphson. More...
void	setup (const Settings &settings)
	Set up the solver with the given settings. More...
Ikarus::NonLinearSolverInformation	solve (Domain &x)
	Solve the nonlinear system. More...
auto &	residual ()
	Access the function. More...
Broadcaster< M > &	station ()
const Broadcaster< M > &	station () const

Static Public Attributes
static constexpr bool	isLinearSolver = Ikarus::Concepts::LinearSolverCheck<LS, JacobianType, CorrectionType>

Detailed Description

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

Template Parameters

F	Type of the differentiable function 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

CorrectionType

template<typename F , typename LS , typename UF >

using Ikarus::NewtonRaphson< F, LS, UF >::CorrectionType = typename SignatureTraits::template Range<0>

DifferentiableFunction

template<typename F , typename LS , typename UF >

using Ikarus::NewtonRaphson< F, LS, UF >::DifferentiableFunction = F

Domain

template<typename F , typename LS , typename UF >

using Ikarus::NewtonRaphson< F, LS, UF >::Domain = typename SignatureTraits::Domain

JacobianType

template<typename F , typename LS , typename UF >

using Ikarus::NewtonRaphson< F, LS, UF >::JacobianType = typename SignatureTraits::template Range<1>

Settings

template<typename F , typename LS , typename UF >

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

SignatureTraits

template<typename F , typename LS , typename UF >

using Ikarus::NewtonRaphson< F, LS, UF >::SignatureTraits = typename F::Traits

State

using Ikarus::NonlinearSolverBase< F, Args >::State = NonlinearSolverStateType<F>

inherited

UpdateFunction

template<typename F , typename LS , typename UF >

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

Constructor & Destructor Documentation

NewtonRaphson()

template<typename F , typename LS , typename UF >

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

Ikarus::NewtonRaphson< F, LS, UF >::NewtonRaphson ( const DifferentiableFunction &  residual, LS2 &&  linearSolver = {}, UF2 &&  updateFunction = {}  )

inlineexplicit

Parameters

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

Member Function Documentation

residual()

template<typename F , typename LS , typename UF >

auto & Ikarus::NewtonRaphson< F, LS, UF >::residual ( )

inline

Returns

Reference to the function.

setup()

template<typename F , typename LS , typename UF >

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

inline

Parameters

settings

Newton-Raphson settings.

solve()

template<typename F , typename LS , typename UF >

Ikarus::NonLinearSolverInformation Ikarus::NewtonRaphson< F, LS, UF >::solve ( Domain &  x )

inline

Parameters

x	Where the solution should be stored.

Returns

Information about the solution process.

station() [1/2]

Broadcaster< M > & Ikarus::Broadcasters< Signatures >::station ( )

inlineinherited

station() [2/2]

const Broadcaster< M > & Ikarus::Broadcasters< Signatures >::station ( ) const

inlineinherited

Member Data Documentation

isLinearSolver

template<typename F , typename LS , typename UF >

constexpr bool Ikarus::NewtonRaphson< F, LS, UF >::isLinearSolver = Ikarus::Concepts::LinearSolverCheck<LS, JacobianType, CorrectionType>

staticconstexpr

---

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

• newtonraphson.hh