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

#include <Tempus_PhysicsState_decl.hpp>

Inheritance diagram for Tempus::PhysicsState< 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 VerboseObject &	setVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setOverridingVerbLevel (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 VerboseObjectBase &	setOStream (const RCP< FancyOStream > &oStream) const

virtual const VerboseObjectBase &	setOverridingOStream (const RCP< FancyOStream > &oStream) const

virtual VerboseObjectBase &	setLinePrefix (const std::string &linePrefix)

virtual RCP< FancyOStream >	getOStream () const

virtual RCP< FancyOStream >	getOverridingOStream () 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< FancyOStream >	getDefaultOStream ()

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

The purpose of PhysicsState is to provide a means to store any physics information that is required to restart from a checkpoint.
The PhysicsState should be held by the SolutionState so that it has all the information needed to restart the solution.
Many Physics will simply need this base class, because they do not have any other additional state information.
PhysicsState can be inherited to expand the state information.
Examples of other information that could be included in derived PhysicsStates:
- Specialized data structures (e.g., particle lists)
The base class currently has a name so the Physics can be checked to see if PhysicsState matches the current physics.