Ikarus::NewtonRaphsonWithSubsidiaryFunctionConfig< LS, UF, IDBCF > 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
using	IDBCForceFunction = IDBCF
template<typename F >
using	Solver = NewtonRaphsonWithSubsidiaryFunction< F, LS, UF >

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

Public Attributes
NewtonRaphsonWithSubsidiaryFunctionSettings	parameters {}
LS	linearSolver {}
UF	updateFunction {}
IDBCF	idbcForceFunction {}

Member Typedef Documentation

IDBCForceFunction

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

using Ikarus::NewtonRaphsonWithSubsidiaryFunctionConfig< LS, UF, IDBCF >::IDBCForceFunction = IDBCF

LinearSolver

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

using Ikarus::NewtonRaphsonWithSubsidiaryFunctionConfig< LS, UF, IDBCF >::LinearSolver = LS

Solver

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

template<typename F >

using Ikarus::NewtonRaphsonWithSubsidiaryFunctionConfig< LS, UF, IDBCF >::Solver = NewtonRaphsonWithSubsidiaryFunction<F, LS, UF>

UpdateFunction

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

using Ikarus::NewtonRaphsonWithSubsidiaryFunctionConfig< LS, UF, IDBCF >::UpdateFunction = UF

Member Function Documentation

rebindIDBCForceFunction()

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

template<typename IDBCF2 >

auto Ikarus::NewtonRaphsonWithSubsidiaryFunctionConfig< LS, UF, IDBCF >::rebindIDBCForceFunction ( IDBCF2 &&  idbcForceFunction ) const

inline

rebindUpdateFunction()

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

template<typename UF2 >

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

inline

Member Data Documentation

idbcForceFunction

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

IDBCF Ikarus::NewtonRaphsonWithSubsidiaryFunctionConfig< LS, UF, IDBCF >::idbcForceFunction {}

linearSolver

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

LS Ikarus::NewtonRaphsonWithSubsidiaryFunctionConfig< LS, UF, IDBCF >::linearSolver {}

parameters

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

NewtonRaphsonWithSubsidiaryFunctionSettings Ikarus::NewtonRaphsonWithSubsidiaryFunctionConfig< LS, UF, IDBCF >::parameters {}

updateFunction

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

UF Ikarus::NewtonRaphsonWithSubsidiaryFunctionConfig< LS, UF, IDBCF >::updateFunction {}

---

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

• newtonraphsonwithscalarsubsidiaryfunction.hh