Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Protected Attributes | List of all members
Tempus::SolutionStateMetaData< Scalar > Class Template Reference

Solution state meta data. More...

#include <Tempus_SolutionStateMetaData_decl.hpp>

Inheritance diagram for Tempus::SolutionStateMetaData< Scalar >:

Public Member Functions

 SolutionStateMetaData ()
 Default constructor. More...
 
 SolutionStateMetaData (const Scalar time, const int iStep, const Scalar dt, const Scalar errorAbs, const Scalar errorRel, const int order, const int nFailures, const int nRunningFailures, const int nConsecutiveFailures, 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...
 
Accessor methods
Scalar getTime () const
 
int getIStep () const
 
Scalar getDt () const
 
Scalar getErrorAbs () const
 
Scalar getErrorRel () const
 
Scalar getOrder () const
 
int getNFailures () const
 
int getNRunningFailures () const
 
int getNConsecutiveFailures () const
 
Status getSolutionStatus () const
 
bool getOutput () const
 
bool getOutputScreen () const
 
bool getIsSynced () const
 
bool getIsInterpolated () const
 
Scalar getAccuracy () const
 
Scalar getTolAbs () const
 
Scalar getTolRel () const
 
void setTime (Scalar time)
 
void setIStep (int iStep)
 
void setDt (Scalar dt)
 
void setErrorAbs (Scalar errorAbs)
 
void setErrorRel (Scalar errorRel)
 
void setOrder (Scalar order)
 
void setNFailures (int nFailures)
 
void setNRunningFailures (int nFailures)
 
void setNConsecutiveFailures (int nConsecutiveFailures)
 
void setSolutionStatus (Status solutionStatus)
 
void setOutput (bool output)
 
void setOutputScreen (bool outputScreen)
 
void setIsSynced (bool isSynced)
 
void setIsInterpolated (bool isInterpolated)
 
void setAccuracy (Scalar accuracy)
 
void setTolAbs (Scalar tolAbs)
 
void setTolRel (Scalar tolRel)
 
Overridden from Teuchos::Describable
virtual std::string description () const
 
virtual void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) 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. More...
 
Scalar errorRel_
 Relative local truncation error. 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_
 Absolute tolerance. More...
 
Scalar tolAbs_
 Relative tolerance. 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 $x_n$ and $\dot{x}_{n+1/2}$. More...
 
bool isInterpolated_
 F - soln is time integrated; T - soln is interpolated. More...
 
Scalar accuracy_
 Interpolation accuracy of solution. More...
 

Detailed Description

template<class Scalar>
class Tempus::SolutionStateMetaData< Scalar >

Solution state meta data.

Definition at line 24 of file Tempus_SolutionStateMetaData_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >
Tempus::SolutionStateMetaData< Scalar >::SolutionStateMetaData ( )

Default constructor.

Definition at line 18 of file Tempus_SolutionStateMetaData_impl.hpp.

template<class Scalar >
Tempus::SolutionStateMetaData< Scalar >::SolutionStateMetaData ( const Scalar  time,
const int  iStep,
const Scalar  dt,
const Scalar  errorAbs,
const Scalar  errorRel,
const int  order,
const int  nFailures,
const int  nRunningFailures,
const int  nConsecutiveFailures,
const Status  solutionStatus,
const bool  output,
const bool  outputScreen,
const bool  isSynced,
const bool  isInterpolated,
const Scalar  accuracy 
)

Constructor.

Definition at line 37 of file Tempus_SolutionStateMetaData_impl.hpp.

template<class Scalar >
Tempus::SolutionStateMetaData< Scalar >::SolutionStateMetaData ( const SolutionStateMetaData< Scalar > &  ssmd)

Copy constructor.

Definition at line 71 of file Tempus_SolutionStateMetaData_impl.hpp.

template<class Scalar>
virtual Tempus::SolutionStateMetaData< Scalar >::~SolutionStateMetaData ( )
inlinevirtual

Destructor.

Definition at line 61 of file Tempus_SolutionStateMetaData_decl.hpp.

Member Function Documentation

template<class Scalar >
Teuchos::RCP< SolutionStateMetaData< Scalar > > Tempus::SolutionStateMetaData< Scalar >::clone ( ) const

Clone constructor.

Definition at line 91 of file Tempus_SolutionStateMetaData_impl.hpp.

template<class Scalar >
void Tempus::SolutionStateMetaData< Scalar >::copy ( const Teuchos::RCP< const SolutionStateMetaData< Scalar > > &  ssmd)

This is a deep copy.

Definition at line 117 of file Tempus_SolutionStateMetaData_impl.hpp.

template<class Scalar >
void Tempus::SolutionStateMetaData< Scalar >::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel 
) const
virtual

Definition at line 146 of file Tempus_SolutionStateMetaData_impl.hpp.

template<class Scalar >
std::string Tempus::SolutionStateMetaData< Scalar >::description ( ) const
virtual

Definition at line 138 of file Tempus_SolutionStateMetaData_impl.hpp.

template<class Scalar>
Scalar Tempus::SolutionStateMetaData< Scalar >::getAccuracy ( ) const
inline

Definition at line 79 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
Scalar Tempus::SolutionStateMetaData< Scalar >::getDt ( ) const
inline

Definition at line 67 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
Scalar Tempus::SolutionStateMetaData< Scalar >::getErrorAbs ( ) const
inline

Definition at line 68 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
Scalar Tempus::SolutionStateMetaData< Scalar >::getErrorRel ( ) const
inline

Definition at line 69 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
bool Tempus::SolutionStateMetaData< Scalar >::getIsInterpolated ( ) const
inline

Definition at line 78 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
bool Tempus::SolutionStateMetaData< Scalar >::getIsSynced ( ) const
inline

Definition at line 77 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
int Tempus::SolutionStateMetaData< Scalar >::getIStep ( ) const
inline

Definition at line 66 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
int Tempus::SolutionStateMetaData< Scalar >::getNConsecutiveFailures ( ) const
inline

Definition at line 73 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
int Tempus::SolutionStateMetaData< Scalar >::getNFailures ( ) const
inline

Definition at line 71 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
int Tempus::SolutionStateMetaData< Scalar >::getNRunningFailures ( ) const
inline

Definition at line 72 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
Scalar Tempus::SolutionStateMetaData< Scalar >::getOrder ( ) const
inline

Definition at line 70 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
bool Tempus::SolutionStateMetaData< Scalar >::getOutput ( ) const
inline

Definition at line 75 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
bool Tempus::SolutionStateMetaData< Scalar >::getOutputScreen ( ) const
inline

Definition at line 76 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
Status Tempus::SolutionStateMetaData< Scalar >::getSolutionStatus ( ) const
inline

Definition at line 74 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
Scalar Tempus::SolutionStateMetaData< Scalar >::getTime ( ) const
inline

Definition at line 65 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
Scalar Tempus::SolutionStateMetaData< Scalar >::getTolAbs ( ) const
inline

Definition at line 80 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
Scalar Tempus::SolutionStateMetaData< Scalar >::getTolRel ( ) const
inline

Definition at line 81 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
void Tempus::SolutionStateMetaData< Scalar >::setAccuracy ( Scalar  accuracy)
inline

Definition at line 100 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
void Tempus::SolutionStateMetaData< Scalar >::setDt ( Scalar  dt)
inline

Definition at line 85 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
void Tempus::SolutionStateMetaData< Scalar >::setErrorAbs ( Scalar  errorAbs)
inline

Definition at line 86 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
void Tempus::SolutionStateMetaData< Scalar >::setErrorRel ( Scalar  errorRel)
inline

Definition at line 87 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
void Tempus::SolutionStateMetaData< Scalar >::setIsInterpolated ( bool  isInterpolated)
inline

Definition at line 98 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
void Tempus::SolutionStateMetaData< Scalar >::setIsSynced ( bool  isSynced)
inline

Definition at line 97 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
void Tempus::SolutionStateMetaData< Scalar >::setIStep ( int  iStep)
inline

Definition at line 84 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
void Tempus::SolutionStateMetaData< Scalar >::setNConsecutiveFailures ( int  nConsecutiveFailures)
inline

Definition at line 91 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
void Tempus::SolutionStateMetaData< Scalar >::setNFailures ( int  nFailures)
inline

Definition at line 89 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
void Tempus::SolutionStateMetaData< Scalar >::setNRunningFailures ( int  nFailures)
inline

Definition at line 90 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
void Tempus::SolutionStateMetaData< Scalar >::setOrder ( Scalar  order)
inline

Definition at line 88 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
void Tempus::SolutionStateMetaData< Scalar >::setOutput ( bool  output)
inline

Definition at line 95 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
void Tempus::SolutionStateMetaData< Scalar >::setOutputScreen ( bool  outputScreen)
inline

Definition at line 96 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
void Tempus::SolutionStateMetaData< Scalar >::setSolutionStatus ( Status  solutionStatus)
inline

Definition at line 93 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
void Tempus::SolutionStateMetaData< Scalar >::setTime ( Scalar  time)
inline

Definition at line 83 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
void Tempus::SolutionStateMetaData< Scalar >::setTolAbs ( Scalar  tolAbs)
inline

Definition at line 101 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
void Tempus::SolutionStateMetaData< Scalar >::setTolRel ( Scalar  tolRel)
inline

Definition at line 102 of file Tempus_SolutionStateMetaData_decl.hpp.

Member Data Documentation

template<class Scalar>
Scalar Tempus::SolutionStateMetaData< Scalar >::accuracy_
protected

Interpolation accuracy of solution.

Definition at line 142 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
Scalar Tempus::SolutionStateMetaData< Scalar >::dt_
protected

Time step for this solution.

Definition at line 116 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
Scalar Tempus::SolutionStateMetaData< Scalar >::errorAbs_
protected

Absolute local truncation error.

Definition at line 117 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
Scalar Tempus::SolutionStateMetaData< Scalar >::errorRel_
protected

Relative local truncation error.

Definition at line 118 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
bool Tempus::SolutionStateMetaData< Scalar >::isInterpolated_
protected

F - soln is time integrated; T - soln is interpolated.

Definition at line 141 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
bool Tempus::SolutionStateMetaData< Scalar >::isSynced_
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 $x_n$ and $\dot{x}_{n+1/2}$.

Definition at line 140 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
int Tempus::SolutionStateMetaData< Scalar >::iStep_
protected

Time step index for this solution.

Definition at line 115 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
int Tempus::SolutionStateMetaData< Scalar >::nConsecutiveFailures_
protected

Consecutive number of stepper failures.

Definition at line 122 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
int Tempus::SolutionStateMetaData< Scalar >::nFailures_
protected

Total number of stepper failures.

Definition at line 120 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
int Tempus::SolutionStateMetaData< Scalar >::nRunningFailures_
protected

Total number of running stepper failures.

Definition at line 121 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
Scalar Tempus::SolutionStateMetaData< Scalar >::order_
protected

Order of this solution.

Definition at line 119 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
bool Tempus::SolutionStateMetaData< Scalar >::output_
protected

SolutionState should be or has been outputted.

Definition at line 134 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
bool Tempus::SolutionStateMetaData< Scalar >::outputScreen_
protected

Output screen dump.

Definition at line 135 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
Status Tempus::SolutionStateMetaData< Scalar >::solutionStatus_
protected

The solutionStatus is used to indicate.

  • if the solution is still being worked on; WORKING
  • if the solution is accepted and completed (e.g., past solutions in SolutionHistory); PASSED.
  • if the time step has FAILED. This may be caused by the Stepper failing, or Integrator not accepting the time step.

Definition at line 133 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
Scalar Tempus::SolutionStateMetaData< Scalar >::time_
protected

Time of solution.

Definition at line 114 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
Scalar Tempus::SolutionStateMetaData< Scalar >::tolAbs_
protected

Relative tolerance.

Definition at line 124 of file Tempus_SolutionStateMetaData_decl.hpp.

template<class Scalar>
Scalar Tempus::SolutionStateMetaData< Scalar >::tolRel_
protected

Absolute tolerance.

Definition at line 123 of file Tempus_SolutionStateMetaData_decl.hpp.

The documentation for this class was generated from the following files: