version 0.4.1
Public Types | Public Member Functions | Public Attributes | List of all members
Ikarus::NewtonRaphsonWithSubsidiaryFunctionConfig< LS, UF > Struct Template Reference

Settings for the Newton-Raphson solver with subsidiary function.

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

Public Types

using LinearSolver = LS
 
using UpdateFunction = UF
 
template<typename NLO >
using Solver = NewtonRaphsonWithSubsidiaryFunction< NLO, LS, UF >
 

Public Member Functions

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

Public Attributes

NewtonRaphsonWithSubsidiaryFunctionSettings parameters
 
LS linearSolver
 
UF updateFunction
 

Member Typedef Documentation

◆ LinearSolver

template<typename LS = utils::SolverDefault, typename UF = utils::UpdateDefault>
using Ikarus::NewtonRaphsonWithSubsidiaryFunctionConfig< LS, UF >::LinearSolver = LS

◆ Solver

template<typename LS = utils::SolverDefault, typename UF = utils::UpdateDefault>
template<typename NLO >
using Ikarus::NewtonRaphsonWithSubsidiaryFunctionConfig< LS, UF >::Solver = NewtonRaphsonWithSubsidiaryFunction<NLO, LS, UF>

◆ UpdateFunction

template<typename LS = utils::SolverDefault, typename UF = utils::UpdateDefault>
using Ikarus::NewtonRaphsonWithSubsidiaryFunctionConfig< LS, UF >::UpdateFunction = UF

Member Function Documentation

◆ rebindUpdateFunction()

template<typename LS = utils::SolverDefault, typename UF = utils::UpdateDefault>
template<typename UF2 >
auto Ikarus::NewtonRaphsonWithSubsidiaryFunctionConfig< LS, UF >::rebindUpdateFunction ( UF2 &&  updateFunction) const
inline

Member Data Documentation

◆ linearSolver

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

◆ parameters

template<typename LS = utils::SolverDefault, typename UF = utils::UpdateDefault>
NewtonRaphsonWithSubsidiaryFunctionSettings Ikarus::NewtonRaphsonWithSubsidiaryFunctionConfig< LS, UF >::parameters

◆ updateFunction

template<typename LS = utils::SolverDefault, typename UF = utils::UpdateDefault>
UF Ikarus::NewtonRaphsonWithSubsidiaryFunctionConfig< LS, UF >::updateFunction
The documentation for this struct was generated from the following file: