Tempus: Tempus::PhysicsState< Scalar > Class Template Reference

Tempus Version of the Day

Time Integration

Loading...

Searching...

No Matches

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.

virtual	~PhysicsState ()
	Destructor.

virtual Teuchos::RCP< PhysicsState< Scalar > >	clone () const
	Clone constructor.

virtual void	copy (const Teuchos::RCP< const PhysicsState< Scalar > > &pS)
	This is a deep copy.

virtual std::string	getName () const
	Return name of PhysicsState.

virtual void	setName (std::string pN)
	Set name of PhysicsState.

Overridden from Teuchos::Describable
std::string	physicsName_
	Name of the creating Physics.

virtual std::string	description () const

virtual void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) 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.

Definition at line 37 of file Tempus_PhysicsState_decl.hpp.

Constructor & Destructor Documentation

◆ PhysicsState()

template<class Scalar >

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

Constructor.

Definition at line 20 of file Tempus_PhysicsState_impl.hpp.

◆ ~PhysicsState()

template<class Scalar >

virtual Tempus::PhysicsState< Scalar >::~PhysicsState ( )

inlinevirtual

Destructor.

Definition at line 45 of file Tempus_PhysicsState_decl.hpp.

Member Function Documentation

◆ clone()

template<class Scalar >

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

virtual

Clone constructor.

Reimplemented in Tempus_Test::PhysicsStateCounter< Scalar >.

Definition at line 25 of file Tempus_PhysicsState_impl.hpp.

◆ copy()

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 36 of file Tempus_PhysicsState_impl.hpp.

◆ getName()

template<class Scalar >

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

virtual

Return name of PhysicsState.

Definition at line 43 of file Tempus_PhysicsState_impl.hpp.

◆ setName()

template<class Scalar >

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

virtual

Set name of PhysicsState.

Definition at line 49 of file Tempus_PhysicsState_impl.hpp.

◆ description()

template<class Scalar >

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

virtual

Definition at line 55 of file Tempus_PhysicsState_impl.hpp.

◆ describe()

template<class Scalar >

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

virtual

Reimplemented in Tempus_Test::PhysicsStateCounter< Scalar >.

Definition at line 61 of file Tempus_PhysicsState_impl.hpp.

Member Data Documentation

◆ physicsName_

template<class Scalar >

std::string Tempus::PhysicsState< Scalar >::physicsName_

protected

Name of the creating Physics.

Definition at line 68 of file Tempus_PhysicsState_decl.hpp.

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