Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
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
18namespace Tempus {
19
20template<class Scalar>
38 public Teuchos::Describable,
39 public Teuchos::VerboseObject<Tempus::PhysicsState<Scalar> >
40{
41public:
42
44 PhysicsState(std::string pN = "Tempus::PhysicsState");
45
47 virtual ~PhysicsState() {}
48
50 virtual Teuchos::RCP<PhysicsState<Scalar> > clone() const;
51
53 virtual void copy(const Teuchos::RCP<const PhysicsState<Scalar> >& pS);
54
56 virtual std::string getName() const;
57
59 virtual void setName(std::string pN);
60
62
63 virtual std::string description() const;
64
65 virtual void describe(Teuchos::FancyOStream & out,
66 const Teuchos::EVerbosityLevel verbLevel) const;
68
69protected:
70
71 std::string physicsName_;
72
73};
74} // namespace Tempus
75#endif // Tempus_PhysicsState_hpp
PhysicsState is a simple class to hold information about the physics.
virtual ~PhysicsState()
Destructor.
virtual std::string getName() const
Return name of PhysicsState.
virtual void setName(std::string pN)
Set name of PhysicsState.
virtual std::string description() const
virtual void copy(const Teuchos::RCP< const PhysicsState< Scalar > > &pS)
This is a deep copy.
virtual Teuchos::RCP< PhysicsState< Scalar > > clone() const
Clone constructor.
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
std::string physicsName_
Name of the creating Physics.