Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_SolutionStateMetaData_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_SolutionStateMetaData_decl_hpp
10#define Tempus_SolutionStateMetaData_decl_hpp
11
12// Teuchos
13#include "Teuchos_VerboseObject.hpp"
14#include "Teuchos_Describable.hpp"
15// Tempus
16#include "Tempus_config.hpp"
17#include "Tempus_Types.hpp"
18
19
20namespace Tempus {
21
24template<class Scalar>
26 public Teuchos::Describable,
27 public Teuchos::VerboseObject<Tempus::SolutionStateMetaData<Scalar> >
28{
29public:
30
33
36 const Scalar time,
37 const int iStep,
38 const Scalar dt,
39 const Scalar errorAbs,
40 const Scalar errorRel,
41 const Scalar errorRelNm1,
42 const Scalar errorRelNm2,
43 const int order,
44 const int nFailures,
45 const int nRunningFailures,
46 const int nConsecutiveFailures,
47 const Scalar tolRel,
48 const Scalar tolAbs,
49 const Scalar xNormL2,
50 const Scalar dxNormL2Rel,
51 const Scalar dxNormL2Abs,
52 const bool computeNorms,
53 const Status solutionStatus,
54 const bool output,
55 const bool outputScreen,
56 const bool isSynced,
57 const bool isInterpolated,
58 const Scalar accuracy);
59
61 SolutionStateMetaData(const SolutionStateMetaData<Scalar>& ssmd);
62
64 Teuchos::RCP<SolutionStateMetaData<Scalar> > clone() const;
65
67 void copy(const Teuchos::RCP<const SolutionStateMetaData<Scalar> >& ssmd);
68
71
73
74 Scalar getTime() const {return time_;}
75 int getIStep() const {return iStep_;}
76 Scalar getDt() const {return dt_;}
77 Scalar getErrorAbs() const {return errorAbs_;}
78 Scalar getErrorRel() const {return errorRel_;}
79 Scalar getErrorRelNm1() const {return errorRelNm1_;}
80 Scalar getErrorRelNm2() const {return errorRelNm2_;}
81 Scalar getOrder() const {return order_;}
82 int getNFailures() const {return nFailures_;}
85 Scalar getTolAbs() const {return tolAbs_;}
86 Scalar getTolRel() const {return tolRel_;}
87 Scalar getXNormL2() const {return xNormL2_;}
88 Scalar getDxNormL2Abs() const {return dxNormL2Abs_;}
89 Scalar getDxNormL2Rel() const {return dxNormL2Rel_;}
90 bool getComputeNorms() const {return computeNorms_;}
92 bool getOutput() const {return output_;}
93 bool getOutputScreen() const {return outputScreen_;}
94 bool getIsSynced() const {return isSynced_;}
95 bool getIsInterpolated() const {return isInterpolated_;}
96 Scalar getAccuracy() const {return accuracy_;}
97
98 void setTime(Scalar time) {time_ = time;}
99 void setIStep(int iStep) {iStep_ = iStep;}
100 void setDt(Scalar dt) {dt_ = dt;}
101 void setErrorAbs (Scalar errorAbs) {errorAbs_ = errorAbs;}
102 void setErrorRel (Scalar errorRel) {errorRelNm2_ = errorRelNm1_;
104 errorRel_ = errorRel;}
105 void setErrorRelNm1 (Scalar errorRelNm1) {errorRelNm1_ = errorRelNm1;}
106 void setErrorRelNm2 (Scalar errorRelNm2) {errorRelNm2_ = errorRelNm2;}
107 void setOrder(Scalar order) {order_ = order;}
108 void setNFailures(int nFailures) {nFailures_ = nFailures;}
109 void setNRunningFailures(int nFailures) {nRunningFailures_ = nFailures;}
110 void setNConsecutiveFailures(int nConsecutiveFailures)
111 {nConsecutiveFailures_ = nConsecutiveFailures;}
112 void setTolRel (Scalar tolRel) {tolRel_ = tolRel;}
113 void setTolAbs (Scalar tolAbs) {tolAbs_ = tolAbs;}
114 void setXNormL2 (Scalar xNormL2) {xNormL2_ = xNormL2;}
115 void setDxNormL2Rel (Scalar dxNormL2Rel) {dxNormL2Rel_ = dxNormL2Rel;}
116 void setDxNormL2Abs (Scalar dxNormL2Abs) {dxNormL2Abs_ = dxNormL2Abs;}
117 void setComputeNorms (bool computeNorms) {computeNorms_ = computeNorms;}
118 void setSolutionStatus(Status solutionStatus)
119 {solutionStatus_ = solutionStatus;}
120 void setOutput(bool output) {output_ = output;}
121 void setOutputScreen(bool outputScreen) {outputScreen_ = outputScreen;}
122 void setIsSynced(bool isSynced) {isSynced_=isSynced;}
123 void setIsInterpolated(bool isInterpolated)
124 {isInterpolated_ = isInterpolated;}
125 void setAccuracy(Scalar accuracy) {accuracy_ = accuracy;}
127
129
130 virtual std::string description() const;
131 virtual void describe(Teuchos::FancyOStream &out,
132 const Teuchos::EVerbosityLevel verbLevel) const;
134
135protected:
136 Scalar time_;
137 int iStep_;
138 Scalar dt_;
139 Scalar errorAbs_;
140 Scalar errorRel_;
143 Scalar order_;
147 Scalar tolRel_;
148 Scalar tolAbs_;
149 Scalar xNormL2_;
153
162 bool output_;
170 Scalar accuracy_;
171
172};
173
174
175} // namespace Tempus
176
177#endif // Tempus_SolutionStateMetaData_decl_hpp
Teuchos::RCP< SolutionStateMetaData< Scalar > > clone() const
Clone constructor.
Scalar errorRel_
Relative local truncation error (@ t_n)
Status solutionStatus_
The solutionStatus is used to indicate.
Scalar errorRelNm2_
Relative local truncation error (@ t_{n-2})
Scalar dxNormL2Abs_
Absolute L2-Norm of the change in solution, ||x_i-x_{i-1}||.
void copy(const Teuchos::RCP< const SolutionStateMetaData< Scalar > > &ssmd)
This is a deep copy.
bool isInterpolated_
F - soln is time integrated; T - soln is interpolated.
Scalar accuracy_
Interpolation accuracy of solution.
int iStep_
Time step index for this solution.
bool isSynced_
True - all of soln (x, xDot, xDotDot) is at the same time level. False - solution is at different tim...
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
int nRunningFailures_
Total number of running stepper failures.
Scalar errorAbs_
Absolute local truncation error (@ t_n)
int nConsecutiveFailures_
Consecutive number of stepper failures.
Scalar dxNormL2Rel_
Relative L2-Norm of the change in solution, ||x_i-x_{i-1}||/||x_{i-1}||.
bool computeNorms_
flag to compute norms of solution
bool output_
SolutionState should be or has been outputted.
Scalar errorRelNm1_
Relative local truncation error (@ t_{n-1})
int nFailures_
Total number of stepper failures.
void setNConsecutiveFailures(int nConsecutiveFailures)
Status
Status for the Integrator, the Stepper and the SolutionState.