Ikarus::NewtonRaphsonConfig< LS, UF > Struct Template Reference

Config for the Newton-Raphson solver.

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

Public Types
using	LinearSolver = LS
using	UpdateFunction = UF
template<typename NLO >
using	Solver = NewtonRaphson< NLO, LS, UF >

Public Member Functions
template<typename UF2 >
auto	rebindUpdateFunction (UF2 &&updateFunction) const

Public Attributes
NRSettings	parameters
LS	linearSolver
UF	updateFunction

Member Typedef Documentation

LinearSolver

template<typename LS = utils::SolverDefault, typename UF = utils::UpdateDefault>

using Ikarus::NewtonRaphsonConfig< LS, UF >::LinearSolver = LS

Solver

template<typename LS = utils::SolverDefault, typename UF = utils::UpdateDefault>

template<typename NLO >

using Ikarus::NewtonRaphsonConfig< LS, UF >::Solver = NewtonRaphson<NLO, LS, UF>

UpdateFunction

template<typename LS = utils::SolverDefault, typename UF = utils::UpdateDefault>

using Ikarus::NewtonRaphsonConfig< LS, UF >::UpdateFunction = UF

Member Function Documentation

rebindUpdateFunction()

template<typename LS = utils::SolverDefault, typename UF = utils::UpdateDefault>

template<typename UF2 >

auto Ikarus::NewtonRaphsonConfig< LS, UF >::rebindUpdateFunction ( UF2 &&  updateFunction ) const

inline

Member Data Documentation

linearSolver

template<typename LS = utils::SolverDefault, typename UF = utils::UpdateDefault>

LS Ikarus::NewtonRaphsonConfig< LS, UF >::linearSolver

parameters

template<typename LS = utils::SolverDefault, typename UF = utils::UpdateDefault>

NRSettings Ikarus::NewtonRaphsonConfig< LS, UF >::parameters

updateFunction

template<typename LS = utils::SolverDefault, typename UF = utils::UpdateDefault>

UF Ikarus::NewtonRaphsonConfig< LS, UF >::updateFunction

---

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

• newtonraphson.hh