Tempus_Test::PhysicsStateCounter< Scalar > Class Template Reference

PhysicsStateCounter is a simple PhysicsState that counts steps. More...

#include <Tempus_PhysicsStateCounter.hpp>

Inheritance diagram for Tempus_Test::PhysicsStateCounter< Scalar >:

Public Member Functions
	PhysicsStateCounter (std::string pN="Tempus::PhysicsStateCounter", int pI=0)
	Constructor.
virtual	~PhysicsStateCounter ()
	Destructor.
virtual Teuchos::RCP< Tempus::PhysicsState< Scalar > >	clone () const
	Clone constructor.
virtual void	copy (const Teuchos::RCP< const Tempus::PhysicsState< Scalar > > &pS)
	This is a deep copy.
virtual int	getCounter () const
	Return counter of PhysicsStateCounter.
virtual void	setCounter (int counter)
	Set counter of PhysicsStateCounter.
Public Member Functions inherited from Tempus::PhysicsState< Scalar >
	PhysicsState (std::string pN="Tempus::PhysicsState")
	Constructor.
virtual	~PhysicsState ()
	Destructor.
virtual std::string	getName () const
	Return name of PhysicsState.
virtual void	setName (std::string pN)
	Set name of PhysicsState.
virtual std::string	description () const

Overridden from Teuchos::Describable
int	physicsCounter_
	Counter for steps.
virtual void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const

Additional Inherited Members
Protected Attributes inherited from Tempus::PhysicsState< Scalar >
std::string	physicsName_
	Name of the creating Physics.

Detailed Description

template<class Scalar>
class Tempus_Test::PhysicsStateCounter< Scalar >

PhysicsStateCounter is a simple PhysicsState that counts steps.

Definition at line 24 of file Tempus_PhysicsStateCounter.hpp.

Constructor & Destructor Documentation

PhysicsStateCounter()

template<class Scalar >

Tempus_Test::PhysicsStateCounter< Scalar >::PhysicsStateCounter ( std::string  pN = "Tempus::PhysicsStateCounter< Scalar >", int  pI = 0  )

inline

Constructor.

Definition at line 27 of file Tempus_PhysicsStateCounter.hpp.

~PhysicsStateCounter()

template<class Scalar >

virtual Tempus_Test::PhysicsStateCounter< Scalar >::~PhysicsStateCounter ( )

inlinevirtual

Destructor.

Definition at line 34 of file Tempus_PhysicsStateCounter.hpp.

Member Function Documentation

clone()

template<class Scalar >

virtual Teuchos::RCP< Tempus::PhysicsState< Scalar > > Tempus_Test::PhysicsStateCounter< Scalar >::clone ( ) const

inlinevirtual

Clone constructor.

Reimplemented from Tempus::PhysicsState< Scalar >.

Definition at line 37 of file Tempus_PhysicsStateCounter.hpp.

copy()

template<class Scalar >

virtual void Tempus_Test::PhysicsStateCounter< Scalar >::copy ( const Teuchos::RCP< const Tempus::PhysicsState< Scalar > > &  pS )

inlinevirtual

This is a deep copy.

Reimplemented from Tempus::PhysicsState< Scalar >.

Definition at line 47 of file Tempus_PhysicsStateCounter.hpp.

getCounter()

template<class Scalar >

virtual int Tempus_Test::PhysicsStateCounter< Scalar >::getCounter ( ) const

inlinevirtual

Return counter of PhysicsStateCounter.

Definition at line 57 of file Tempus_PhysicsStateCounter.hpp.

setCounter()

template<class Scalar >

virtual void Tempus_Test::PhysicsStateCounter< Scalar >::setCounter ( int  counter )

inlinevirtual

Set counter of PhysicsStateCounter.

Definition at line 60 of file Tempus_PhysicsStateCounter.hpp.

describe()

template<class Scalar >

virtual void Tempus_Test::PhysicsStateCounter< Scalar >::describe ( Teuchos::FancyOStream &  out, const Teuchos::EVerbosityLevel  verbLevel  ) const

inlinevirtual

Reimplemented from Tempus::PhysicsState< Scalar >.

Definition at line 64 of file Tempus_PhysicsStateCounter.hpp.

Member Data Documentation

physicsCounter_

template<class Scalar >

int Tempus_Test::PhysicsStateCounter< Scalar >::physicsCounter_

protected

Counter for steps.

Definition at line 74 of file Tempus_PhysicsStateCounter.hpp.

---

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

• Tempus_PhysicsStateCounter.hpp