Rythmos::BreakPointInformerBase< Scalar > Class Template Reference

Interface for using breakpoints. More...

#include <Rythmos_BreakPointInformerBase.hpp>

Inherits Describable, ParameterListAcceptor, and VerboseObject< BreakPointInformerBase< Scalar > >.

Public Member Functions
virtual bool	testForBreakPoint (Scalar &time0, Scalar &dt) const =0
	Basic breakpoint interface. More...
virtual Scalar	getNextBreakPoint (Scalar &time0) const =0
	Get next break point. More...
virtual void	removeNextBreakPoint (Scalar &time0)=0
	Remove breakpoint from list. More...

Detailed Description

template<class Scalar>
class Rythmos::BreakPointInformerBase< Scalar >

Interface for using breakpoints.

Definition at line 36 of file Rythmos_BreakPointInformerBase.hpp.

Member Function Documentation

template<class Scalar >

virtual bool Rythmos::BreakPointInformerBase< Scalar >::testForBreakPoint ( Scalar &  time0, Scalar &  dt  ) const

pure virtual

Basic breakpoint interface.

Returns true if there is a breakpoint between time0 and time0+dt

template<class Scalar >

virtual Scalar Rythmos::BreakPointInformerBase< Scalar >::getNextBreakPoint ( Scalar &  time0 ) const

pure virtual

Get next break point.

Returns the next breakpoint after time0.

template<class Scalar >

virtual void Rythmos::BreakPointInformerBase< Scalar >::removeNextBreakPoint ( Scalar &  time0 )

pure virtual

Remove breakpoint from list.

Removes the next breakpoint after time0.

---

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

• Rythmos_BreakPointInformerBase.hpp