Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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 >:
Tempus::PhysicsState< Scalar >

Public Member Functions

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

Protected Attributes

int physicsCounter_
 Counter for steps. More...
 
- Protected Attributes inherited from Tempus::PhysicsState< Scalar >
std::string physicsName_
 Name of the creating Physics. More...
 

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

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

Constructor.

Definition at line 30 of file Tempus_PhysicsStateCounter.hpp.

template<class Scalar >
virtual Tempus_Test::PhysicsStateCounter< Scalar >::~PhysicsStateCounter ( )
inlinevirtual

Destructor.

Definition at line 36 of file Tempus_PhysicsStateCounter.hpp.

Member Function Documentation

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 39 of file Tempus_PhysicsStateCounter.hpp.

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 49 of file Tempus_PhysicsStateCounter.hpp.

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 66 of file Tempus_PhysicsStateCounter.hpp.

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

Return counter of PhysicsStateCounter.

Definition at line 59 of file Tempus_PhysicsStateCounter.hpp.

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

Set counter of PhysicsStateCounter.

Definition at line 62 of file Tempus_PhysicsStateCounter.hpp.

Member Data Documentation

template<class Scalar >
int Tempus_Test::PhysicsStateCounter< Scalar >::physicsCounter_
protected

Counter for steps.

Definition at line 77 of file Tempus_PhysicsStateCounter.hpp.


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