version 0.4.1
Ikarus::LoadControlSubsidiaryFunction Struct Reference

Structure representing the subsidiary function for the load control method. More...

#include <ikarus/controlroutines/pathfollowingfunctions.hh>

Public Member Functions

void operator() (SubsidiaryArgs &args) const
 Evaluates the subsidiary function for the load control method. More...
 
template<typename NLO >
void initialPrediction (NLO &nonLinearOperator, SubsidiaryArgs &args)
 Performs initial prediction for the load control method. More...
 
template<typename NLO >
void intermediatePrediction (NLO &nonLinearOperator, SubsidiaryArgs &args)
 Performs intermediate prediction for the load control method. More...
 
constexpr auto name () const
 The name of the PathFollowing method. More...
 

Detailed Description

The equation for the load control method reads

\[ f(\mathrm{D}\mathbf{D}, \mathrm{D} \lambda)= \mathrm{D} \lambda - \hat{s}, \]

where \(\mathrm{D}\mathbf{D}\) is the increment of the solution vector and \(\mathrm{D} \lambda\) is the load factor increment. The scalar \(\hat{s} \) defines the requested size of the step.

Member Function Documentation

◆ initialPrediction()

template<typename NLO >
void Ikarus::LoadControlSubsidiaryFunction::initialPrediction ( NLO &  nonLinearOperator,
SubsidiaryArgs args 
)
inline

This method initializes the prediction step for the load control method.

Template Parameters
NLOType of the nonlinear operator.
Parameters
nonLinearOperatorThe nonlinear operator.
argsThe subsidiary function arguments.

◆ intermediatePrediction()

template<typename NLO >
void Ikarus::LoadControlSubsidiaryFunction::intermediatePrediction ( NLO &  nonLinearOperator,
SubsidiaryArgs args 
)
inline

This method updates the prediction step for the load control method.

Template Parameters
NLOType of the nonlinear operator.
Parameters
nonLinearOperatorThe nonlinear operator.
argsThe subsidiary function arguments.

◆ name()

constexpr auto Ikarus::LoadControlSubsidiaryFunction::name ( ) const
inlineconstexpr

◆ operator()()

void Ikarus::LoadControlSubsidiaryFunction::operator() ( SubsidiaryArgs args) const
inline

This method calculates the subsidiary function value and its derivatives for the given arguments.

Parameters
argsThe subsidiary function arguments.

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