Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Tempus_PhysicsState_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ****************************************************************************
3 // Tempus: Copyright (2017) Sandia Corporation
4 //
5 // Distributed under BSD 3-clause license (See accompanying file Copyright.txt)
6 // ****************************************************************************
7 // @HEADER
8 
9 #ifndef Tempus_PhysicsState_hpp
10 #define Tempus_PhysicsState_hpp
11 
12 #include "Teuchos_VerboseObject.hpp"
13 #include "Teuchos_Describable.hpp"
14 #include <string>
15 #include "Tempus_config.hpp"
16 
17 namespace Tempus {
18 
19 template <class Scalar>
37  : public Teuchos::Describable,
38  public Teuchos::VerboseObject<Tempus::PhysicsState<Scalar> > {
39  public:
41  PhysicsState(std::string pN = "Tempus::PhysicsState");
42 
44  virtual ~PhysicsState() {}
45 
47  virtual Teuchos::RCP<PhysicsState<Scalar> > clone() const;
48 
50  virtual void copy(const Teuchos::RCP<const PhysicsState<Scalar> >& pS);
51 
53  virtual std::string getName() const;
54 
56  virtual void setName(std::string pN);
57 
59 
60  virtual std::string description() const;
61 
62  virtual void describe(Teuchos::FancyOStream& out,
63  const Teuchos::EVerbosityLevel verbLevel) const;
65 
66  protected:
67  std::string physicsName_;
68 };
69 } // namespace Tempus
70 #endif // Tempus_PhysicsState_hpp
PhysicsState is a simple class to hold information about the physics.
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
virtual ~PhysicsState()
Destructor.
PhysicsState(std::string pN="Tempus::PhysicsState")
Constructor.
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 description() const
virtual std::string getName() const
Return name of PhysicsState.
virtual void setName(std::string pN)
Set name of PhysicsState.
std::string physicsName_
Name of the creating Physics.