Tempus
Version of the Day
Time Integration
|
Solution state meta data. More...
#include <Tempus_SolutionStateMetaData_decl.hpp>
Public Member Functions | |
SolutionStateMetaData () | |
Default constructor. More... | |
SolutionStateMetaData (const Scalar time, const int iStep, const Scalar dt, const Scalar errorAbs, const Scalar errorRel, const Scalar errorRelNm1, const Scalar errorRelNm2, const int order, const int nFailures, const int nRunningFailures, const int nConsecutiveFailures, const Scalar tolRel, const Scalar tolAbs, const Scalar xNormL2, const Scalar dxNormL2Rel, const Scalar dxNormL2Abs, const bool computeNorms, const Status solutionStatus, const bool output, const bool outputScreen, const bool isSynced, const bool isInterpolated, const Scalar accuracy) | |
Constructor. More... | |
SolutionStateMetaData (const SolutionStateMetaData< Scalar > &ssmd) | |
Copy constructor. More... | |
Teuchos::RCP < SolutionStateMetaData < Scalar > > | clone () const |
Clone constructor. More... | |
void | copy (const Teuchos::RCP< const SolutionStateMetaData< Scalar > > &ssmd) |
This is a deep copy. More... | |
virtual | ~SolutionStateMetaData () |
Destructor. More... | |
Public Member Functions inherited from Teuchos::Describable | |
void | describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
virtual | ~Describable () |
LabeledObject () | |
virtual | ~LabeledObject () |
virtual void | setObjectLabel (const std::string &objectLabel) |
virtual std::string | getObjectLabel () const |
DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) |
std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) |
Public Member Functions inherited from Teuchos::VerboseObject< Tempus::SolutionStateMetaData< Scalar > > | |
VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null) | |
virtual const VerboseObject & | setVerbLevel (const EVerbosityLevel verbLevel) const |
virtual const VerboseObject & | setOverridingVerbLevel (const EVerbosityLevel verbLevel) const |
virtual EVerbosityLevel | getVerbLevel () const |
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList > | getValidVerboseObjectSublist () |
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void | setupVerboseObjectSublist (ParameterList *paramList) |
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void | readVerboseObjectSublist (ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel) |
void | readVerboseObjectSublist (ParameterList *paramList, VerboseObject< ObjectType > *verboseObject) |
Public Member Functions inherited from Teuchos::VerboseObjectBase | |
virtual | ~VerboseObjectBase () |
VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null) | |
virtual const VerboseObjectBase & | setOStream (const RCP< FancyOStream > &oStream) const |
virtual const VerboseObjectBase & | setOverridingOStream (const RCP< FancyOStream > &oStream) const |
virtual VerboseObjectBase & | setLinePrefix (const std::string &linePrefix) |
virtual RCP< FancyOStream > | getOStream () const |
virtual RCP< FancyOStream > | getOverridingOStream () const |
virtual std::string | getLinePrefix () const |
virtual OSTab | getOSTab (const int tabs=1, const std::string &linePrefix="") const |
Protected Attributes | |
Scalar | time_ |
Time of solution. More... | |
int | iStep_ |
Time step index for this solution. More... | |
Scalar | dt_ |
Time step for this solution. More... | |
Scalar | errorAbs_ |
Absolute local truncation error (@ t_n) More... | |
Scalar | errorRel_ |
Relative local truncation error (@ t_n) More... | |
Scalar | errorRelNm1_ |
Relative local truncation error (@ t_{n-1}) More... | |
Scalar | errorRelNm2_ |
Relative local truncation error (@ t_{n-2}) More... | |
Scalar | order_ |
Order of this solution. More... | |
int | nFailures_ |
Total number of stepper failures. More... | |
int | nRunningFailures_ |
Total number of running stepper failures. More... | |
int | nConsecutiveFailures_ |
Consecutive number of stepper failures. More... | |
Scalar | tolRel_ |
Relative tolerance. More... | |
Scalar | tolAbs_ |
Absolute tolerance. More... | |
Scalar | xNormL2_ |
L2-Norm of the solution. More... | |
Scalar | dxNormL2Rel_ |
Scalar | dxNormL2Abs_ |
bool | computeNorms_ |
flag to compute norms of solution More... | |
Status | solutionStatus_ |
The solutionStatus is used to indicate. More... | |
bool | output_ |
SolutionState should be or has been outputted. More... | |
bool | outputScreen_ |
Output screen dump. More... | |
bool | isSynced_ |
True - all of soln (x, xDot, xDotDot) is at the same time level. False - solution is at different time levels, e.g., leapfrog where and . More... | |
bool | isInterpolated_ |
Scalar | accuracy_ |
Interpolation accuracy of solution. More... | |
Accessor methods | |
Scalar | getTime () const |
int | getIStep () const |
Scalar | getDt () const |
Scalar | getErrorAbs () const |
Scalar | getErrorRel () const |
Scalar | getErrorRelNm1 () const |
Scalar | getErrorRelNm2 () const |
Scalar | getOrder () const |
int | getNFailures () const |
int | getNRunningFailures () const |
int | getNConsecutiveFailures () const |
Scalar | getTolAbs () const |
Scalar | getTolRel () const |
Scalar | getXNormL2 () const |
Scalar | getDxNormL2Abs () const |
Scalar | getDxNormL2Rel () const |
bool | getComputeNorms () const |
Status | getSolutionStatus () const |
bool | getOutput () const |
bool | getOutputScreen () const |
bool | getIsSynced () const |
bool | getIsInterpolated () const |
Scalar | getAccuracy () const |
void | setTime (Scalar time) |
void | setIStep (int iStep) |
void | setDt (Scalar dt) |
void | setErrorAbs (Scalar errorAbs) |
void | setErrorRel (Scalar errorRel) |
void | setErrorRelNm1 (Scalar errorRelNm1) |
void | setErrorRelNm2 (Scalar errorRelNm2) |
void | setOrder (Scalar order) |
void | setNFailures (int nFailures) |
void | setNRunningFailures (int nFailures) |
void | setNConsecutiveFailures (int nConsecutiveFailures) |
void | setTolRel (Scalar tolRel) |
void | setTolAbs (Scalar tolAbs) |
void | setXNormL2 (Scalar xNormL2) |
void | setDxNormL2Rel (Scalar dxNormL2Rel) |
void | setDxNormL2Abs (Scalar dxNormL2Abs) |
void | setComputeNorms (bool computeNorms) |
void | setSolutionStatus (Status solutionStatus) |
void | setOutput (bool output) |
void | setOutputScreen (bool outputScreen) |
void | setIsSynced (bool isSynced) |
void | setIsInterpolated (bool isInterpolated) |
void | setAccuracy (Scalar accuracy) |
Overridden from Teuchos::Describable | |
virtual std::string | description () const |
virtual void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const |
Additional Inherited Members | |
Static Public Member Functions inherited from Teuchos::VerboseObject< Tempus::SolutionStateMetaData< Scalar > > | |
static void | setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel) |
static EVerbosityLevel | getDefaultVerbLevel () |
Static Public Member Functions inherited from Teuchos::VerboseObjectBase | |
static void | setDefaultOStream (const RCP< FancyOStream > &defaultOStream) |
static RCP< FancyOStream > | getDefaultOStream () |
Static Public Attributes inherited from Teuchos::Describable | |
static const EVerbosityLevel | verbLevel_default |
Protected Member Functions inherited from Teuchos::VerboseObject< Tempus::SolutionStateMetaData< Scalar > > | |
void | initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null) |
Protected Member Functions inherited from Teuchos::VerboseObjectBase | |
void | initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null) |
virtual void | informUpdatedVerbosityState () const |
Solution state meta data.
The SolutionState’s Metadata contains all the data about the solution, except for the solution and its time derivatives. This data includes
Definition at line 40 of file Tempus_SolutionStateMetaData_decl.hpp.
Tempus::SolutionStateMetaData< Scalar >::SolutionStateMetaData | ( | ) |
Default constructor.
Definition at line 16 of file Tempus_SolutionStateMetaData_impl.hpp.
Tempus::SolutionStateMetaData< Scalar >::SolutionStateMetaData | ( | const Scalar | time, |
const int | iStep, | ||
const Scalar | dt, | ||
const Scalar | errorAbs, | ||
const Scalar | errorRel, | ||
const Scalar | errorRelNm1, | ||
const Scalar | errorRelNm2, | ||
const int | order, | ||
const int | nFailures, | ||
const int | nRunningFailures, | ||
const int | nConsecutiveFailures, | ||
const Scalar | tolRel, | ||
const Scalar | tolAbs, | ||
const Scalar | xNormL2, | ||
const Scalar | dxNormL2Rel, | ||
const Scalar | dxNormL2Abs, | ||
const bool | computeNorms, | ||
const Status | solutionStatus, | ||
const bool | output, | ||
const bool | outputScreen, | ||
const bool | isSynced, | ||
const bool | isInterpolated, | ||
const Scalar | accuracy | ||
) |
Constructor.
Definition at line 44 of file Tempus_SolutionStateMetaData_impl.hpp.
Tempus::SolutionStateMetaData< Scalar >::SolutionStateMetaData | ( | const SolutionStateMetaData< Scalar > & | ssmd | ) |
Copy constructor.
Definition at line 80 of file Tempus_SolutionStateMetaData_impl.hpp.
|
inlinevirtual |
Destructor.
Definition at line 71 of file Tempus_SolutionStateMetaData_decl.hpp.
Teuchos::RCP< SolutionStateMetaData< Scalar > > Tempus::SolutionStateMetaData< Scalar >::clone | ( | ) | const |
Clone constructor.
Definition at line 109 of file Tempus_SolutionStateMetaData_impl.hpp.
void Tempus::SolutionStateMetaData< Scalar >::copy | ( | const Teuchos::RCP< const SolutionStateMetaData< Scalar > > & | ssmd | ) |
This is a deep copy.
Definition at line 123 of file Tempus_SolutionStateMetaData_impl.hpp.
|
inline |
Definition at line 75 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 76 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 77 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 78 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 79 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 80 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 81 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 82 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 83 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 84 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 85 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 86 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 87 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 88 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 89 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 90 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 91 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 92 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 93 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 94 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 95 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 96 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 97 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 99 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 100 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 101 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 102 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 103 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 109 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 110 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 111 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 112 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 113 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 114 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 118 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 119 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 120 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 121 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 122 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 123 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 124 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 128 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 129 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 130 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 131 of file Tempus_SolutionStateMetaData_decl.hpp.
|
inline |
Definition at line 135 of file Tempus_SolutionStateMetaData_decl.hpp.
|
virtual |
Reimplemented from Teuchos::Describable.
Definition at line 148 of file Tempus_SolutionStateMetaData_impl.hpp.
|
virtual |
Reimplemented from Teuchos::Describable.
Definition at line 155 of file Tempus_SolutionStateMetaData_impl.hpp.
|
protected |
Time of solution.
Definition at line 146 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
Time step index for this solution.
Definition at line 147 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
Time step for this solution.
Definition at line 148 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
Absolute local truncation error (@ t_n)
Definition at line 149 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
Relative local truncation error (@ t_n)
Definition at line 150 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
Relative local truncation error (@ t_{n-1})
Definition at line 151 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
Relative local truncation error (@ t_{n-2})
Definition at line 152 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
Order of this solution.
Definition at line 153 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
Total number of stepper failures.
Definition at line 154 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
Total number of running stepper failures.
Definition at line 155 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
Consecutive number of stepper failures.
Definition at line 156 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
Relative tolerance.
Definition at line 157 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
Absolute tolerance.
Definition at line 158 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
L2-Norm of the solution.
Definition at line 159 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
Relative L2-Norm of the change in solution, ||x_i-x_{i-1}||/||x_{i-1}||
Definition at line 160 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
Absolute L2-Norm of the change in solution, ||x_i-x_{i-1}||
Definition at line 162 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
flag to compute norms of solution
Definition at line 164 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
The solutionStatus is used to indicate.
Definition at line 173 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
SolutionState should be or has been outputted.
Definition at line 174 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
Output screen dump.
Definition at line 175 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
True - all of soln (x, xDot, xDotDot) is at the same time level. False - solution is at different time levels, e.g., leapfrog where and .
Definition at line 180 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
F - soln is time integrated; T - soln is interpolated
Definition at line 181 of file Tempus_SolutionStateMetaData_decl.hpp.
|
protected |
Interpolation accuracy of solution.
Definition at line 183 of file Tempus_SolutionStateMetaData_decl.hpp.