capd::dynsys::StepControlInterface< StepControlT, 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/StepControl.h>

Public Types
typedef StepControlT	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<class StepControlT, class Scalar>
class capd::dynsys::StepControlInterface< StepControlT, Scalar >

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

Member Typedef Documentation

StepControlType

template<class StepControlT , class Scalar >

typedef StepControlT capd::dynsys::StepControlInterface< StepControlT, Scalar >::StepControlType

Constructor & Destructor Documentation

StepControlInterface() [1/2]

template<class StepControlT , class Scalar >

capd::dynsys::StepControlInterface< StepControlT, Scalar >::StepControlInterface ( )

inline

StepControlInterface() [2/2]

template<class StepControlT , class Scalar >

capd::dynsys::StepControlInterface< StepControlT, Scalar >::StepControlInterface ( const StepControlType &  stepControl )

inline

Member Function Documentation

getAbsoluteTolerance()

template<class StepControlT , class Scalar >

TolScalarType capd::dynsys::StepControlInterface< StepControlT, Scalar >::getAbsoluteTolerance ( ) const

inline

getEffectiveTolerance()

template<class StepControlT , class Scalar >

template<class Solver , class SetType >

static TolScalarType capd::dynsys::StepControlInterface< StepControlT, Scalar >::getEffectiveTolerance ( Solver &  solver, const SetType &  s  )

inlinestatic

getMaxStep()

template<class StepControlT , class Scalar >

Scalar capd::dynsys::StepControlInterface< StepControlT, Scalar >::getMaxStep ( ) const

inline

getRelativeTolerance()

template<class StepControlT , class Scalar >

TolScalarType capd::dynsys::StepControlInterface< StepControlT, Scalar >::getRelativeTolerance ( ) const

inline

getStepControl()

template<class StepControlT , class Scalar >

const StepControlType& capd::dynsys::StepControlInterface< StepControlT, Scalar >::getStepControl ( ) const

inline

isStepChangeAllowed()

template<class StepControlT , class Scalar >

bool capd::dynsys::StepControlInterface< StepControlT, Scalar >::isStepChangeAllowed ( ) const

inline

onOffStepControl()

template<class StepControlT , class Scalar >

void capd::dynsys::StepControlInterface< StepControlT, Scalar >::onOffStepControl ( bool  _onOffStepControl )

inline

setAbsoluteTolerance()

template<class StepControlT , class Scalar >

void capd::dynsys::StepControlInterface< StepControlT, Scalar >::setAbsoluteTolerance ( TolScalarType  tol )

inline

setMaxStep()

template<class StepControlT , class Scalar >

void capd::dynsys::StepControlInterface< StepControlT, Scalar >::setMaxStep ( Scalar  maxStep )

inline

setRelativeTolerance()

template<class StepControlT , class Scalar >

void capd::dynsys::StepControlInterface< StepControlT, Scalar >::setRelativeTolerance ( TolScalarType  tol )

inline

setStepControl()

template<class StepControlT , class Scalar >

void capd::dynsys::StepControlInterface< StepControlT, Scalar >::setStepControl ( const StepControlType &  stepControl )

inline

turnOffStepControl()

template<class StepControlT , class Scalar >

void capd::dynsys::StepControlInterface< StepControlT, Scalar >::turnOffStepControl ( )

inline

turnOnStepControl()

template<class StepControlT , class Scalar >

void capd::dynsys::StepControlInterface< StepControlT, Scalar >::turnOnStepControl ( )

inline

Member Data Documentation

m_absoluteTolerance

template<class StepControlT , class Scalar >

TolScalarType capd::dynsys::StepControlInterface< StepControlT, Scalar >::m_absoluteTolerance

protected

m_maxStep

template<class StepControlT , class Scalar >

Scalar capd::dynsys::StepControlInterface< StepControlT, Scalar >::m_maxStep

protected

m_onOffStepControl

template<class StepControlT , class Scalar >

bool capd::dynsys::StepControlInterface< StepControlT, Scalar >::m_onOffStepControl

protected

m_relativeTolerance

template<class StepControlT , class Scalar >

TolScalarType capd::dynsys::StepControlInterface< StepControlT, Scalar >::m_relativeTolerance

protected

m_stepControl

template<class StepControlT , class Scalar >

StepControlType capd::dynsys::StepControlInterface< StepControlT, Scalar >::m_stepControl

protected

---

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

• capd/dynsys/StepControl.h