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: Time Integration and Sensitivity Analysis Package
4//
5// Copyright 2017 NTESS and the Tempus contributors.
6// SPDX-License-Identifier: BSD-3-Clause
7// *****************************************************************************
8//@HEADER
9
10#ifndef Tempus_PhysicsState_hpp
11#define Tempus_PhysicsState_hpp
12
13#include "Teuchos_VerboseObject.hpp"
14#include "Teuchos_Describable.hpp"
15#include <string>
16#include "Tempus_config.hpp"
17
18namespace Tempus {
19
20template <class Scalar>
38 : public Teuchos::Describable,
39 public Teuchos::VerboseObject<Tempus::PhysicsState<Scalar> > {
40 public:
42 PhysicsState(std::string pN = "Tempus::PhysicsState");
43
45 virtual ~PhysicsState() {}
46
48 virtual Teuchos::RCP<PhysicsState<Scalar> > clone() const;
49
51 virtual void copy(const Teuchos::RCP<const PhysicsState<Scalar> >& pS);
52
54 virtual std::string getName() const;
55
57 virtual void setName(std::string pN);
58
60
61 virtual std::string description() const;
62
63 virtual void describe(Teuchos::FancyOStream& out,
64 const Teuchos::EVerbosityLevel verbLevel) const;
66
67 protected:
68 std::string physicsName_;
69};
70} // namespace Tempus
71#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.