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::PhysicsState< Scalar > Class Template Reference

PhysicsState is a simple class to hold information about the physics. More...

#include <Tempus_PhysicsState_decl.hpp>

Inheritance diagram for Tempus::PhysicsState< Scalar >:
Teuchos::Describable Teuchos::VerboseObject< Tempus::PhysicsState< Scalar > > Teuchos::LabeledObject Teuchos::VerboseObjectBase Tempus_Test::PhysicsStateCounter< Scalar >

Public Member Functions

 PhysicsState (std::string pN="Tempus::PhysicsState")
 Constructor. More...
 
virtual ~PhysicsState ()
 Destructor. More...
 
virtual Teuchos::RCP
< PhysicsState< Scalar > > 
clone () const
 Clone constructor. More...
 
virtual void copy (const Teuchos::RCP< const PhysicsState< Scalar > > &pS)
 This is a deep copy. More...
 
virtual std::string getName () const
 Return name of PhysicsState. More...
 
virtual void setName (std::string pN)
 Set name of PhysicsState. More...
 
- 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

std::string physicsName_
 Name of the creating Physics. More...
 

Overridden from Teuchos::Describable

virtual std::string description () const
 
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::PhysicsState< Scalar >

PhysicsState is a simple class to hold information about the physics.

Design Considerations

Definition at line 36 of file Tempus_PhysicsState_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >
Tempus::PhysicsState< Scalar >::PhysicsState ( std::string  pN = "Tempus::PhysicsState< Scalar >")

Constructor.

Definition at line 19 of file Tempus_PhysicsState_impl.hpp.

template<class Scalar >
virtual Tempus::PhysicsState< Scalar >::~PhysicsState ( )
inlinevirtual

Destructor.

Definition at line 44 of file Tempus_PhysicsState_decl.hpp.

Member Function Documentation

template<class Scalar >
Teuchos::RCP< PhysicsState< Scalar > > Tempus::PhysicsState< Scalar >::clone ( ) const
virtual

Clone constructor.

Reimplemented in Tempus_Test::PhysicsStateCounter< Scalar >.

Definition at line 24 of file Tempus_PhysicsState_impl.hpp.

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

This is a deep copy.

Reimplemented in Tempus_Test::PhysicsStateCounter< Scalar >.

Definition at line 35 of file Tempus_PhysicsState_impl.hpp.

template<class Scalar >
std::string Tempus::PhysicsState< Scalar >::getName ( ) const
virtual

Return name of PhysicsState.

Definition at line 42 of file Tempus_PhysicsState_impl.hpp.

template<class Scalar >
void Tempus::PhysicsState< Scalar >::setName ( std::string  pN)
virtual

Set name of PhysicsState.

Definition at line 48 of file Tempus_PhysicsState_impl.hpp.

template<class Scalar >
std::string Tempus::PhysicsState< Scalar >::description ( ) const
virtual

Reimplemented from Teuchos::Describable.

Definition at line 54 of file Tempus_PhysicsState_impl.hpp.

template<class Scalar >
void Tempus::PhysicsState< Scalar >::describe ( Teuchos::FancyOStream out,
const Teuchos::EVerbosityLevel  verbLevel 
) const
virtual

Reimplemented from Teuchos::Describable.

Reimplemented in Tempus_Test::PhysicsStateCounter< Scalar >.

Definition at line 60 of file Tempus_PhysicsState_impl.hpp.

Member Data Documentation

template<class Scalar >
std::string Tempus::PhysicsState< Scalar >::physicsName_
protected

Name of the creating Physics.

Definition at line 67 of file Tempus_PhysicsState_decl.hpp.


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