Ikarus::AdaptiveStepSizing::NoOp Struct Reference

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

#include <ikarus/controlroutines/adaptivestepsizing.hh>

Public Member Functions
template<typename F >
void	operator() (const NonLinearSolverInformation &solverInfo, SubsidiaryArgs &subsidiaryArgs, const F &f)
	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 F >

void Ikarus::AdaptiveStepSizing::NoOp::operator() ( const NonLinearSolverInformation &  solverInfo, SubsidiaryArgs &  subsidiaryArgs, const F &  f  )

inline

Does nothing.

Parameters

solverInfo	Information about the nonlinear solver.
subsidiaryArgs	Subsidiary arguments for adaptive step sizing.
f	The function.

Template Parameters

F	The Differentiable Function type.

setTargetIterations()

void Ikarus::AdaptiveStepSizing::NoOp::setTargetIterations ( int  targetIterations )

inline

Parameters

targetIterations

The 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:

• adaptivestepsizing.hh