Tempus
Version of the Day
Time Integration
Toggle main menu visibility
Loading...
Searching...
No Matches
src
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
18
namespace
Tempus
{
19
20
template
<
class
Scalar>
37
class
PhysicsState
:
38
public
Teuchos::Describable,
39
public
Teuchos::VerboseObject<Tempus::PhysicsState<Scalar> >
40
{
41
public
:
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
69
protected
:
70
71
std::string
physicsName_
;
72
73
};
74
}
// namespace Tempus
75
#endif
// Tempus_PhysicsState_hpp
Tempus::PhysicsState
PhysicsState is a simple class to hold information about the physics.
Definition
Tempus_PhysicsState_decl.hpp:40
Tempus::PhysicsState::~PhysicsState
virtual ~PhysicsState()
Destructor.
Definition
Tempus_PhysicsState_decl.hpp:47
Tempus::PhysicsState::getName
virtual std::string getName() const
Return name of PhysicsState.
Definition
Tempus_PhysicsState_impl.hpp:44
Tempus::PhysicsState::setName
virtual void setName(std::string pN)
Set name of PhysicsState.
Definition
Tempus_PhysicsState_impl.hpp:50
Tempus::PhysicsState::description
virtual std::string description() const
Definition
Tempus_PhysicsState_impl.hpp:56
Tempus::PhysicsState::PhysicsState
PhysicsState(std::string pN="Tempus::PhysicsState")
Constructor.
Definition
Tempus_PhysicsState_impl.hpp:20
Tempus::PhysicsState::copy
virtual void copy(const Teuchos::RCP< const PhysicsState< Scalar > > &pS)
This is a deep copy.
Definition
Tempus_PhysicsState_impl.hpp:37
Tempus::PhysicsState::clone
virtual Teuchos::RCP< PhysicsState< Scalar > > clone() const
Clone constructor.
Definition
Tempus_PhysicsState_impl.hpp:26
Tempus::PhysicsState::describe
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
Definition
Tempus_PhysicsState_impl.hpp:62
Tempus::PhysicsState::physicsName_
std::string physicsName_
Name of the creating Physics.
Definition
Tempus_PhysicsState_decl.hpp:71
Tempus
Definition
Tempus_AdjointAuxSensitivityModelEvaluator_decl.hpp:21
Generated by
1.17.0