9#ifndef Tempus_TimeEventIndexRange_decl_hpp
10#define Tempus_TimeEventIndexRange_decl_hpp
14#include "Teuchos_Time.hpp"
15#include "Teuchos_ParameterList.hpp"
17#include "Tempus_config.hpp"
51 virtual bool isIndex(
int index)
const;
85 virtual void describe(Teuchos::FancyOStream &out,
86 const Teuchos::EVerbosityLevel verbLevel)
const;
157template<
class Scalar>
158Teuchos::RCP<TimeEventRangeIndex<Scalar> >
This class defines time events which can be used to "trigger" an action.
TimeEventRangeIndex specifies a start, stop and stride index.
virtual int getIndexStop() const
Return the stop of the index range.
virtual bool isIndex(int index) const
Test if index is a time event.
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
Describe member data.
int stop_
Stop of index range.
virtual void setIndexStop(int stop)
Set the stop of the index range.
virtual int indexOfNextEvent(int index) const
Return the index of the next event following the input index.
TimeEventRangeIndex()
Default constructor.
int stride_
Stride of index range.
virtual void setIndexRange(int start, int stop, int stride)
Set the range of event indices.
virtual bool eventInRangeIndex(int index1, int index2) const
Test if an event occurs within the index range.
unsigned numEvents_
Number of events in index range.
virtual void setIndexStart(int start)
Set the start of the index range.
virtual int getNumEvents() const
Return the number of events.
virtual void setNumEvents()
Set the number of events from start_, stop_ and stride_.
virtual int indexToNextEvent(int index) const
How many indices until the next event.
virtual int getIndexStride() const
Return the stride of the index range.
virtual int getIndexStart() const
Return the start of the index range.
virtual ~TimeEventRangeIndex()
Destructor.
int start_
Start of index range.
virtual void setIndexStride(int stride)
Set the stride of the index range.
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
Return a valid ParameterList with current settings.
Teuchos::RCP< TimeEventRangeIndex< Scalar > > createTimeEventRangeIndex(Teuchos::RCP< Teuchos::ParameterList > pList)
Nonmember Constructor via ParameterList.