CAPD::DynSys Library  6.0.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar > Class Template Reference

This class is a common interface for StepControl used in PoincareMap and TimeMap. Both classes inherit this interface. More...

#include <capd/dynsys/MpStepControl.h>

Public Types

typedef MpLastTermsStepControl StepControlType
 

Public Member Functions

 StepControlInterface ()
 
 StepControlInterface (const StepControlType &stepControl)
 
void turnOnStepControl ()
 
void turnOffStepControl ()
 
void onOffStepControl (bool _onOffStepControl)
 
const StepControlType & getStepControl () const
 
void setStepControl (const StepControlType &stepControl)
 
bool isStepChangeAllowed () const
 
void setAbsoluteTolerance (TolScalarType tol)
 
void setRelativeTolerance (TolScalarType tol)
 
TolScalarType getAbsoluteTolerance () const
 
TolScalarType getRelativeTolerance () const
 
Scalar getMaxStep () const
 
void setMaxStep (Scalar maxStep)
 

Static Public Member Functions

template<class Solver , class SetType >
static TolScalarType getEffectiveTolerance (Solver &solver, const SetType &s)
 

Protected Attributes

StepControlType m_stepControl
 
bool m_onOffStepControl
 
TolScalarType m_absoluteTolerance
 
TolScalarType m_relativeTolerance
 
Scalar m_maxStep
 

Detailed Description

template<typename Scalar>
class capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >

This class is a common interface for StepControl used in PoincareMap and TimeMap. Both classes inherit this interface.

Member Typedef Documentation

◆ StepControlType

template<typename Scalar >
typedef MpLastTermsStepControl capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::StepControlType

Constructor & Destructor Documentation

◆ StepControlInterface() [1/2]

template<typename Scalar >
capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::StepControlInterface ( )
inline

◆ StepControlInterface() [2/2]

template<typename Scalar >
capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::StepControlInterface ( const StepControlType &  stepControl)
inline

Member Function Documentation

◆ getAbsoluteTolerance()

template<typename Scalar >
TolScalarType capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::getAbsoluteTolerance ( ) const
inline

◆ getEffectiveTolerance()

template<typename Scalar >
template<class Solver , class SetType >
static TolScalarType capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::getEffectiveTolerance ( Solver &  solver,
const SetType &  s 
)
inlinestatic

◆ getMaxStep()

template<typename Scalar >
Scalar capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::getMaxStep ( ) const
inline

◆ getRelativeTolerance()

template<typename Scalar >
TolScalarType capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::getRelativeTolerance ( ) const
inline

◆ getStepControl()

template<typename Scalar >
const StepControlType& capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::getStepControl ( ) const
inline

◆ isStepChangeAllowed()

template<typename Scalar >
bool capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::isStepChangeAllowed ( ) const
inline

◆ onOffStepControl()

template<typename Scalar >
void capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::onOffStepControl ( bool  _onOffStepControl)
inline

◆ setAbsoluteTolerance()

template<typename Scalar >
void capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::setAbsoluteTolerance ( TolScalarType  tol)
inline

◆ setMaxStep()

template<typename Scalar >
void capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::setMaxStep ( Scalar  maxStep)
inline

◆ setRelativeTolerance()

template<typename Scalar >
void capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::setRelativeTolerance ( TolScalarType  tol)
inline

◆ setStepControl()

template<typename Scalar >
void capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::setStepControl ( const StepControlType &  stepControl)
inline

◆ turnOffStepControl()

template<typename Scalar >
void capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::turnOffStepControl ( )
inline

◆ turnOnStepControl()

template<typename Scalar >
void capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::turnOnStepControl ( )
inline

Member Data Documentation

◆ m_absoluteTolerance

template<typename Scalar >
TolScalarType capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::m_absoluteTolerance
protected

◆ m_maxStep

template<typename Scalar >
Scalar capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::m_maxStep
protected

◆ m_onOffStepControl

template<typename Scalar >
bool capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::m_onOffStepControl
protected

◆ m_relativeTolerance

template<typename Scalar >
TolScalarType capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::m_relativeTolerance
protected

◆ m_stepControl

template<typename Scalar >
StepControlType capd::dynsys::StepControlInterface< MpLastTermsStepControl, Scalar >::m_stepControl
protected
The documentation for this class was generated from the following file: