TimeEventListIndex specifies a list of index events. More...

#include <Tempus_TimeEventListIndex_decl.hpp>

Inheritance diagram for Tempus::TimeEventListIndex< Scalar >:

Public Member Functions
	TimeEventListIndex ()
	Default constructor. More...

	TimeEventListIndex (std::string name, std::vector< int > indexList)
	Construct with full argument list of data members. More...

virtual	~TimeEventListIndex ()
	Destructor. More...

Basic methods
virtual bool	isIndex (int index) const
	Test if index is near a index event (within tolerance). More...

virtual int	indexToNextEvent (int index) const
	How many indices until the next event. Negative indicating the last event is in the past. More...

virtual int	indexOfNextEvent (int index) const
	Index of the next event. Negative indicating the last event is in the past. More...

virtual bool	eventInRangeIndex (int index1, int index2) const
	Test if an event occurs within the index range. More...

virtual void	describe () const
	Describe member data. More...

Accessor methods
virtual std::vector< int >	getIndexList () const

virtual void	setIndexList (std::vector< int > indexList, bool sort=true)

virtual void	addIndex (int index)

virtual void	clearIndexList ()

Public Member Functions inherited from Tempus::TimeEventBase< Scalar >
	TimeEventBase ()
	Constructor. More...

virtual	~TimeEventBase ()
	Destructor. More...

virtual bool	isTime (Scalar time) const
	Test if time is near a TimeEvent (within tolerance). More...

virtual Scalar	getAbsTol () const

virtual Scalar	timeToNextEvent (Scalar time) const
	How much time until the next event. Negative indicating the last event is in the past. More...

virtual Scalar	timeOfNextEvent (Scalar time) const
	Time of the next event. Negative indicating the last event is in the past. More...

virtual bool	eventInRange (Scalar time1, Scalar time2) const
	Test if an event occurs within the time range. More...

virtual std::string	getName () const

virtual void	setName (std::string name)

virtual Scalar	getDefaultTime () const

virtual Scalar	getDefaultTol () const

virtual int	getDefaultIndex () const

Protected Attributes
std::vector< int >	indexList_

Detailed Description

template<class Scalar>
class Tempus::TimeEventListIndex< Scalar >

TimeEventListIndex specifies a list of index events.

Definition at line 29 of file Tempus_TimeEventListIndex_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Tempus::TimeEventListIndex< Scalar >::TimeEventListIndex ( )

Default constructor.

Definition at line 16 of file Tempus_TimeEventListIndex_impl.hpp.

template<class Scalar >

Tempus::TimeEventListIndex< Scalar >::TimeEventListIndex	(	std::string	name,
		std::vector< int >	indexList
	)

Construct with full argument list of data members.

Definition at line 23 of file Tempus_TimeEventListIndex_impl.hpp.

template<class Scalar >

virtual Tempus::TimeEventListIndex< Scalar >::~TimeEventListIndex ( )

inlinevirtual

Destructor.

Definition at line 40 of file Tempus_TimeEventListIndex_decl.hpp.

Member Function Documentation

template<class Scalar >

void Tempus::TimeEventListIndex< Scalar >::addIndex ( int index )

virtual

Definition at line 44 of file Tempus_TimeEventListIndex_impl.hpp.

template<class Scalar >

virtual void Tempus::TimeEventListIndex< Scalar >::clearIndexList ( )

inlinevirtual

Definition at line 65 of file Tempus_TimeEventListIndex_decl.hpp.

template<class Scalar >

void Tempus::TimeEventListIndex< Scalar >::describe ( ) const

virtual

Describe member data.

Reimplemented from Tempus::TimeEventBase< Scalar >.

Definition at line 125 of file Tempus_TimeEventListIndex_impl.hpp.

template<class Scalar >

bool Tempus::TimeEventListIndex< Scalar >::eventInRangeIndex	(	int	index1,
		int	index2
	)		const

virtual

Test if an event occurs within the index range.

Reimplemented from Tempus::TimeEventBase< Scalar >.

Definition at line 99 of file Tempus_TimeEventListIndex_impl.hpp.

template<class Scalar >

virtual std::vector<int> Tempus::TimeEventListIndex< Scalar >::getIndexList ( ) const

inlinevirtual

Definition at line 62 of file Tempus_TimeEventListIndex_decl.hpp.

template<class Scalar >

int Tempus::TimeEventListIndex< Scalar >::indexOfNextEvent ( int index ) const

virtual

Index of the next event. Negative indicating the last event is in the past.

Reimplemented from Tempus::TimeEventBase< Scalar >.

Definition at line 76 of file Tempus_TimeEventListIndex_impl.hpp.

template<class Scalar >

int Tempus::TimeEventListIndex< Scalar >::indexToNextEvent ( int index ) const

virtual

How many indices until the next event. Negative indicating the last event is in the past.

Reimplemented from Tempus::TimeEventBase< Scalar >.

Definition at line 69 of file Tempus_TimeEventListIndex_impl.hpp.

template<class Scalar >

bool Tempus::TimeEventListIndex< Scalar >::isIndex ( int index ) const

virtual

Test if index is near a index event (within tolerance).

Reimplemented from Tempus::TimeEventBase< Scalar >.

Definition at line 62 of file Tempus_TimeEventListIndex_impl.hpp.

template<class Scalar >

void Tempus::TimeEventListIndex< Scalar >::setIndexList	(	std::vector< int >	indexList,
		bool	sort = `true`
	)

virtual

Definition at line 32 of file Tempus_TimeEventListIndex_impl.hpp.

Member Data Documentation

template<class Scalar >

std::vector<int> Tempus::TimeEventListIndex< Scalar >::indexList_

protected

Definition at line 71 of file Tempus_TimeEventListIndex_decl.hpp.

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

http://docs.trilinos.org/r13.0/packages/tempus/src/Tempus_TimeEventListIndex_decl.hpp
http://docs.trilinos.org/r13.0/packages/tempus/src/Tempus_TimeEventListIndex_impl.hpp

Public Member Functions

Protected Attributes

Detailed Description

template<class Scalar> class Tempus::TimeEventListIndex< Scalar >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class Scalar>
class Tempus::TimeEventListIndex< Scalar >