version 0.4.1
Ikarus::AdaptiveStepSizing::NoOp Struct Reference

The NoOp strategy for adaptive step sizing. More...

#include <ikarus/controlroutines/adaptivestepsizing.hh>

Public Member Functions

template<typename NLO >
void operator() (const NonLinearSolverInformation &solverInfo, SubsidiaryArgs &subsidiaryArgs, const NLO &nonLinearOperator)
 Call operator for the NoOp strategy. More...
 
int targetIterations () const
 Get the target iterations. More...
 
void setTargetIterations (int targetIterations)
 Set the target iterations. More...
 

Detailed Description

This strategy does nothing and keeps the step size constant.

Member Function Documentation

◆ operator()()

template<typename NLO >
void Ikarus::AdaptiveStepSizing::NoOp::operator() ( const NonLinearSolverInformation solverInfo,
SubsidiaryArgs subsidiaryArgs,
const NLO &  nonLinearOperator 
)
inline

Does nothing.

Parameters
solverInfoInformation about the nonlinear solver.
subsidiaryArgsSubsidiary arguments for adaptive step sizing.
nonLinearOperatorThe nonlinear operator.
Template Parameters
NLOThe nonlinear operator type.

◆ setTargetIterations()

void Ikarus::AdaptiveStepSizing::NoOp::setTargetIterations ( int  targetIterations)
inline
Parameters
targetIterationsThe target iterations (ignored).

◆ targetIterations()

int Ikarus::AdaptiveStepSizing::NoOp::targetIterations ( ) const
inline
Returns
Always returns 0, indicating no specific target.

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