Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
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 > Teuchos::Describable Teuchos::VerboseObject< Tempus::PhysicsState< Scalar > > Teuchos::LabeledObject Teuchos::VerboseObjectBase

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...
 
- 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
 
- Public Member Functions inherited from Teuchos::Describable
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 
- Public Member Functions inherited from Teuchos::VerboseObject< Tempus::PhysicsState< Scalar > >
 VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetOverridingVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual EVerbosityLevel getVerbLevel () const
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP< const ParameterList
getValidVerboseObjectSublist ()
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void 
setupVerboseObjectSublist (ParameterList *paramList)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void 
readVerboseObjectSublist (ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel)
 
void readVerboseObjectSublist (ParameterList *paramList, VerboseObject< ObjectType > *verboseObject)
 
- Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual ~VerboseObjectBase ()
 
 VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectBasesetOStream (const RCP< FancyOStream > &oStream) const
 
virtual const VerboseObjectBasesetOverridingOStream (const RCP< FancyOStream > &oStream) const
 
virtual VerboseObjectBasesetLinePrefix (const std::string &linePrefix)
 
virtual RCP< FancyOStreamgetOStream () const
 
virtual RCP< FancyOStreamgetOverridingOStream () const
 
virtual std::string getLinePrefix () const
 
virtual OSTab getOSTab (const int tabs=1, const std::string &linePrefix="") 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...
 

Overridden from Teuchos::Describable

virtual void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 

Additional Inherited Members

- Static Public Member Functions inherited from Teuchos::VerboseObject< Tempus::PhysicsState< Scalar > >
static void setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)
 
static EVerbosityLevel getDefaultVerbLevel ()
 
- Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void setDefaultOStream (const RCP< FancyOStream > &defaultOStream)
 
static RCP< FancyOStreamgetDefaultOStream ()
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 
- Protected Member Functions inherited from Teuchos::VerboseObject< Tempus::PhysicsState< Scalar > >
void initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
- Protected Member Functions inherited from Teuchos::VerboseObjectBase
void initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual void informUpdatedVerbosityState () const
 

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

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

Destructor.

Definition at line 34 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 37 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 47 of file Tempus_PhysicsStateCounter.hpp.

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.

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.

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

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: