Tempus  Version of the Day
Time Integration
Public Member Functions | List of all members
Tempus::SolutionState< Scalar > Class Template Reference

Solution state for integrators and steppers. SolutionState contains the metadata for solutions and the solutions themselves. More...

#include <Tempus_SolutionState_decl.hpp>

Inheritance diagram for Tempus::SolutionState< Scalar >:

Public Member Functions

 SolutionState (const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xdot=Teuchos::null, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xddot=Teuchos::null, const Teuchos::RCP< StepperState< Scalar > > &stepperState=Teuchos::null, const Teuchos::RCP< PhysicsState< Scalar > > &physicsState=Teuchos::null)
 
 SolutionState (const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &xdot=Teuchos::null, const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &xddot=Teuchos::null, const Teuchos::RCP< const StepperState< Scalar > > &stepperSt=Teuchos::null, const Teuchos::RCP< const PhysicsState< Scalar > > &physicsSt=Teuchos::null)
 
 SolutionState (const Teuchos::RCP< SolutionStateMetaData< Scalar > > ssmd, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xdot, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xdotdot, const Teuchos::RCP< StepperState< Scalar > > &stepperState, const Teuchos::RCP< PhysicsState< Scalar > > &physicsState=Teuchos::null)
 
 SolutionState (const Teuchos::RCP< const SolutionStateMetaData< Scalar > > ssmd, const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &xdot, const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &xdotdot, const Teuchos::RCP< const StepperState< Scalar > > &stepperState, const Teuchos::RCP< const PhysicsState< Scalar > > &physicsState=Teuchos::null)
 
 SolutionState (const Scalar time, const Scalar dt, const int iStep, 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, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xdot, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xdotdot, const Teuchos::RCP< StepperState< Scalar > > &stepperState=Teuchos::null, const Teuchos::RCP< PhysicsState< Scalar > > &physicsState=Teuchos::null)
 
 SolutionState (const Scalar time, const Scalar dt, const int iStep, 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, const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &xdot, const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &xdotdot, const Teuchos::RCP< const StepperState< Scalar > > &stepperSt=Teuchos::null, const Teuchos::RCP< const PhysicsState< Scalar > > &physicsSt=Teuchos::null)
 
 SolutionState (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model, const Teuchos::RCP< StepperState< Scalar > > &stepperState=Teuchos::null, const Teuchos::RCP< PhysicsState< Scalar > > &physicsState=Teuchos::null)
 
 SolutionState (const SolutionState< Scalar > &ss)
 This is a shallow copy constructor, use clone for a deep copy constructor. More...
 
virtual Teuchos::RCP< SolutionState< Scalar > > clone () const
 This is a deep copy constructor. More...
 
virtual void copy (const Teuchos::RCP< const SolutionState< Scalar > > &ss)
 This is a deep copy. More...
 
virtual void copySolutionData (const Teuchos::RCP< const SolutionState< Scalar > > &s)
 Deep copy solution data, but keep metaData untouched. More...
 
virtual void swapSolutionData (const Teuchos::RCP< SolutionState< Scalar > > &ss)
 Swap solution data, but keep metaData untouched. More...
 
virtual ~SolutionState ()
 Destructor. More...
 
Get MetaData values
virtual Teuchos::RCP< const SolutionStateMetaData< Scalar > > getMetaData () const
 
virtual Teuchos::RCP< SolutionStateMetaData< Scalar > > getMetaData ()
 
virtual Scalar getTime () const
 
virtual Scalar getIndex () const
 
virtual Scalar getTimeStep () const
 
virtual Scalar getOrder () const
 
virtual Status getSolutionStatus () const
 
virtual bool getOutput () const
 
virtual bool getIsSynced () const
 
Set MetaData values
virtual void setMetaData (Teuchos::RCP< const SolutionStateMetaData< Scalar > > md)
 
virtual void setMetaData (Teuchos::RCP< SolutionStateMetaData< Scalar > > md)
 
virtual void setTime (Scalar time)
 
virtual void setIndex (Scalar index)
 
virtual void setTimeStep (Scalar dt)
 
virtual void setOrder (Scalar order)
 
virtual void setSolutionStatus (Status s)
 
virtual void setOutput (bool output)
 
virtual void setIsSynced (bool isSynced)
 
Get State Data
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > getX ()
 
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > getX () const
 
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > getXDot ()
 
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > getXDot () const
 
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > getXDotDot ()
 
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > getXDotDot () const
 
virtual Teuchos::RCP< StepperState< Scalar > > getStepperState ()
 
virtual Teuchos::RCP< const StepperState< Scalar > > getStepperState () const
 
virtual Teuchos::RCP< PhysicsState< Scalar > > getPhysicsState ()
 
virtual Teuchos::RCP< const PhysicsState< Scalar > > getPhysicsState () const
 
Set State Data
virtual void setPhysicsState (const Teuchos::RCP< PhysicsState< Scalar > > &ps)
 
Comparison methods
bool operator< (const SolutionState< Scalar > &ss) const
 Less than comparison for sorting based on time. More...
 
bool operator<= (const SolutionState< Scalar > &ss) const
 Less than comparison for sorting based on time. More...
 
bool operator< (const Scalar &t) const
 Less than comparison for sorting based on time. More...
 
bool operator<= (const Scalar &t) const
 Less than comparison for sorting based on time. More...
 
bool operator> (const SolutionState< Scalar > &ss) const
 Less than comparison for sorting based on time. More...
 
bool operator>= (const SolutionState< Scalar > &ss) const
 Less than comparison for sorting based on time. More...
 
bool operator> (const Scalar &t) const
 Less than comparison for sorting based on time. More...
 
bool operator>= (const Scalar &t) const
 Less than comparison for sorting based on time. More...
 
bool operator== (const SolutionState< Scalar > &ss) const
 Equality comparison for matching. More...
 
bool operator== (const Scalar &t) const
 Equality comparison for matching. More...
 

Overridden from Teuchos::Describable

Teuchos::RCP< const SolutionStateMetaData< Scalar > > metaData_
 Meta Data for the solution state. More...
 
Teuchos::RCP< SolutionStateMetaData< Scalar > > metaData_nc_
 
Teuchos::RCP< const Thyra::VectorBase< Scalar > > x_
 Solution. More...
 
Teuchos::RCP< Thyra::VectorBase< Scalar > > x_nc_
 
Teuchos::RCP< const Thyra::VectorBase< Scalar > > xdot_
 Time derivative of the solution. More...
 
Teuchos::RCP< Thyra::VectorBase< Scalar > > xdot_nc_
 
Teuchos::RCP< const Thyra::VectorBase< Scalar > > xdotdot_
 Second time derivative of the solution. More...
 
Teuchos::RCP< Thyra::VectorBase< Scalar > > xdotdot_nc_
 
Teuchos::RCP< const Tempus::StepperState< Scalar > > stepperState_
 StepperState for this SolutionState. More...
 
Teuchos::RCP< Tempus::StepperState< Scalar > > stepperState_nc_
 
Teuchos::RCP< const Tempus::PhysicsState< Scalar > > physicsState_
 PhysicsState for this SolutionState. More...
 
Teuchos::RCP< Tempus::PhysicsState< Scalar > > physicsState_nc_
 
virtual std::string description () const
 
virtual void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 

Detailed Description

template<class Scalar>
class Tempus::SolutionState< Scalar >

Solution state for integrators and steppers. SolutionState contains the metadata for solutions and the solutions themselves.

For simple time integration, the SolutionState is sufficient for checkpointing, restart and undo operations (i.e., it is the Memento object).

For more complex time integration where the physics has additional state information or the time integrator is not a one-step method (i.e., can not accurately start from a single time step), this class can be inherited and the physics state or additional time-integration parameters can be managed.

SolutionStates can be interpolated to generate solutions at various times (see SolutionHistory). However not all metadata or state information can be interpolated. Thus interpolated solutions may not be suitable for checkpointing, restart and undo operations, but may be useful for adjoint sensitivities.

The solution vectors, $x$, $\dot{x}$, and $\ddot{x}$, in SolutionState can be null pointers. This indicates that the application does not need them, so do not storage them. This can be a huge savings when saving many states in the solution history. Some Steppers will need temporary memory to store time derivative(s) ( $\dot{x}$, or $\ddot{x}$) for evaluation of the ODE/DAE ( $f(x, \dot{x}, \ddot{x},t)$), but each individual Stepper will manage that.

Definition at line 56 of file Tempus_SolutionState_decl.hpp.

Constructor & Destructor Documentation

◆ SolutionState() [1/8]

template<class Scalar >
Tempus::SolutionState< Scalar >::SolutionState ( const Teuchos::RCP< Thyra::VectorBase< Scalar > > &  x,
const Teuchos::RCP< Thyra::VectorBase< Scalar > > &  xdot = Teuchos::null,
const Teuchos::RCP< Thyra::VectorBase< Scalar > > &  xddot = Teuchos::null,
const Teuchos::RCP< StepperState< Scalar > > &  stepperState = Teuchos::null,
const Teuchos::RCP< PhysicsState< Scalar > > &  physicsState = Teuchos::null 
)

Definition at line 18 of file Tempus_SolutionState_impl.hpp.

◆ SolutionState() [2/8]

template<class Scalar >
Tempus::SolutionState< Scalar >::SolutionState ( const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &  x,
const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &  xdot = Teuchos::null,
const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &  xddot = Teuchos::null,
const Teuchos::RCP< const StepperState< Scalar > > &  stepperSt = Teuchos::null,
const Teuchos::RCP< const PhysicsState< Scalar > > &  physicsSt = Teuchos::null 
)

Definition at line 48 of file Tempus_SolutionState_impl.hpp.

◆ SolutionState() [3/8]

template<class Scalar >
Tempus::SolutionState< Scalar >::SolutionState ( const Teuchos::RCP< SolutionStateMetaData< Scalar > >  ssmd,
const Teuchos::RCP< Thyra::VectorBase< Scalar > > &  x,
const Teuchos::RCP< Thyra::VectorBase< Scalar > > &  xdot,
const Teuchos::RCP< Thyra::VectorBase< Scalar > > &  xdotdot,
const Teuchos::RCP< StepperState< Scalar > > &  stepperState,
const Teuchos::RCP< PhysicsState< Scalar > > &  physicsState = Teuchos::null 
)

Definition at line 75 of file Tempus_SolutionState_impl.hpp.

◆ SolutionState() [4/8]

template<class Scalar >
Tempus::SolutionState< Scalar >::SolutionState ( const Teuchos::RCP< const SolutionStateMetaData< Scalar > >  ssmd,
const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &  x,
const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &  xdot,
const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &  xdotdot,
const Teuchos::RCP< const StepperState< Scalar > > &  stepperState,
const Teuchos::RCP< const PhysicsState< Scalar > > &  physicsState = Teuchos::null 
)

Definition at line 106 of file Tempus_SolutionState_impl.hpp.

◆ SolutionState() [5/8]

template<class Scalar >
Tempus::SolutionState< Scalar >::SolutionState ( const Scalar  time,
const Scalar  dt,
const int  iStep,
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,
const Teuchos::RCP< Thyra::VectorBase< Scalar > > &  x,
const Teuchos::RCP< Thyra::VectorBase< Scalar > > &  xdot,
const Teuchos::RCP< Thyra::VectorBase< Scalar > > &  xdotdot,
const Teuchos::RCP< StepperState< Scalar > > &  stepperState = Teuchos::null,
const Teuchos::RCP< PhysicsState< Scalar > > &  physicsState = Teuchos::null 
)

Definition at line 138 of file Tempus_SolutionState_impl.hpp.

◆ SolutionState() [6/8]

template<class Scalar >
Tempus::SolutionState< Scalar >::SolutionState ( const Scalar  time,
const Scalar  dt,
const int  iStep,
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,
const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &  x,
const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &  xdot,
const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &  xdotdot,
const Teuchos::RCP< const StepperState< Scalar > > &  stepperSt = Teuchos::null,
const Teuchos::RCP< const PhysicsState< Scalar > > &  physicsSt = Teuchos::null 
)

Definition at line 199 of file Tempus_SolutionState_impl.hpp.

◆ SolutionState() [7/8]

template<class Scalar >
Tempus::SolutionState< Scalar >::SolutionState ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  model,
const Teuchos::RCP< StepperState< Scalar > > &  stepperState = Teuchos::null,
const Teuchos::RCP< PhysicsState< Scalar > > &  physicsState = Teuchos::null 
)

Definition at line 260 of file Tempus_SolutionState_impl.hpp.

◆ SolutionState() [8/8]

template<class Scalar >
Tempus::SolutionState< Scalar >::SolutionState ( const SolutionState< Scalar > &  ss)

This is a shallow copy constructor, use clone for a deep copy constructor.

Definition at line 318 of file Tempus_SolutionState_impl.hpp.

◆ ~SolutionState()

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

Destructor.

Definition at line 159 of file Tempus_SolutionState_decl.hpp.

Member Function Documentation

◆ clone()

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

This is a deep copy constructor.

Definition at line 335 of file Tempus_SolutionState_impl.hpp.

◆ copy()

template<class Scalar >
void Tempus::SolutionState< Scalar >::copy ( const Teuchos::RCP< const SolutionState< Scalar > > &  ss)
virtual

This is a deep copy.

Definition at line 366 of file Tempus_SolutionState_impl.hpp.

◆ copySolutionData()

template<class Scalar >
void Tempus::SolutionState< Scalar >::copySolutionData ( const Teuchos::RCP< const SolutionState< Scalar > > &  s)
virtual

Deep copy solution data, but keep metaData untouched.

Definition at line 375 of file Tempus_SolutionState_impl.hpp.

◆ describe()

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

Definition at line 502 of file Tempus_SolutionState_impl.hpp.

◆ description()

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

Definition at line 495 of file Tempus_SolutionState_impl.hpp.

◆ getIndex()

template<class Scalar>
virtual Scalar Tempus::SolutionState< Scalar >::getIndex ( ) const
inlinevirtual

Definition at line 170 of file Tempus_SolutionState_decl.hpp.

◆ getIsSynced()

template<class Scalar>
virtual bool Tempus::SolutionState< Scalar >::getIsSynced ( ) const
inlinevirtual

Definition at line 176 of file Tempus_SolutionState_decl.hpp.

◆ getMetaData() [1/2]

template<class Scalar>
virtual Teuchos::RCP<SolutionStateMetaData<Scalar> > Tempus::SolutionState< Scalar >::getMetaData ( )
inlinevirtual

Definition at line 165 of file Tempus_SolutionState_decl.hpp.

◆ getMetaData() [2/2]

template<class Scalar>
virtual Teuchos::RCP<const SolutionStateMetaData<Scalar> > Tempus::SolutionState< Scalar >::getMetaData ( ) const
inlinevirtual

Definition at line 164 of file Tempus_SolutionState_decl.hpp.

◆ getOrder()

template<class Scalar>
virtual Scalar Tempus::SolutionState< Scalar >::getOrder ( ) const
inlinevirtual

Definition at line 172 of file Tempus_SolutionState_decl.hpp.

◆ getOutput()

template<class Scalar>
virtual bool Tempus::SolutionState< Scalar >::getOutput ( ) const
inlinevirtual

Definition at line 175 of file Tempus_SolutionState_decl.hpp.

◆ getPhysicsState() [1/2]

template<class Scalar>
virtual Teuchos::RCP<PhysicsState<Scalar> > Tempus::SolutionState< Scalar >::getPhysicsState ( )
inlinevirtual

Definition at line 225 of file Tempus_SolutionState_decl.hpp.

◆ getPhysicsState() [2/2]

template<class Scalar>
virtual Teuchos::RCP<const PhysicsState<Scalar> > Tempus::SolutionState< Scalar >::getPhysicsState ( ) const
inlinevirtual

Definition at line 227 of file Tempus_SolutionState_decl.hpp.

◆ getSolutionStatus()

template<class Scalar>
virtual Status Tempus::SolutionState< Scalar >::getSolutionStatus ( ) const
inlinevirtual

Definition at line 173 of file Tempus_SolutionState_decl.hpp.

◆ getStepperState() [1/2]

template<class Scalar>
virtual Teuchos::RCP<StepperState<Scalar> > Tempus::SolutionState< Scalar >::getStepperState ( )
inlinevirtual

Definition at line 219 of file Tempus_SolutionState_decl.hpp.

◆ getStepperState() [2/2]

template<class Scalar>
virtual Teuchos::RCP<const StepperState<Scalar> > Tempus::SolutionState< Scalar >::getStepperState ( ) const
inlinevirtual

Definition at line 222 of file Tempus_SolutionState_decl.hpp.

◆ getTime()

template<class Scalar>
virtual Scalar Tempus::SolutionState< Scalar >::getTime ( ) const
inlinevirtual

Definition at line 169 of file Tempus_SolutionState_decl.hpp.

◆ getTimeStep()

template<class Scalar>
virtual Scalar Tempus::SolutionState< Scalar >::getTimeStep ( ) const
inlinevirtual

Definition at line 171 of file Tempus_SolutionState_decl.hpp.

◆ getX() [1/2]

template<class Scalar>
virtual Teuchos::RCP<Thyra::VectorBase<Scalar> > Tempus::SolutionState< Scalar >::getX ( )
inlinevirtual

Definition at line 205 of file Tempus_SolutionState_decl.hpp.

◆ getX() [2/2]

template<class Scalar>
virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> > Tempus::SolutionState< Scalar >::getX ( ) const
inlinevirtual

Definition at line 208 of file Tempus_SolutionState_decl.hpp.

◆ getXDot() [1/2]

template<class Scalar>
virtual Teuchos::RCP<Thyra::VectorBase<Scalar> > Tempus::SolutionState< Scalar >::getXDot ( )
inlinevirtual

Definition at line 210 of file Tempus_SolutionState_decl.hpp.

◆ getXDot() [2/2]

template<class Scalar>
virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> > Tempus::SolutionState< Scalar >::getXDot ( ) const
inlinevirtual

Definition at line 212 of file Tempus_SolutionState_decl.hpp.

◆ getXDotDot() [1/2]

template<class Scalar>
virtual Teuchos::RCP<Thyra::VectorBase<Scalar> > Tempus::SolutionState< Scalar >::getXDotDot ( )
inlinevirtual

Definition at line 214 of file Tempus_SolutionState_decl.hpp.

◆ getXDotDot() [2/2]

template<class Scalar>
virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> > Tempus::SolutionState< Scalar >::getXDotDot ( ) const
inlinevirtual

Definition at line 216 of file Tempus_SolutionState_decl.hpp.

◆ operator<() [1/2]

template<class Scalar >
bool Tempus::SolutionState< Scalar >::operator< ( const Scalar &  t) const

Less than comparison for sorting based on time.

Definition at line 447 of file Tempus_SolutionState_impl.hpp.

◆ operator<() [2/2]

template<class Scalar >
bool Tempus::SolutionState< Scalar >::operator< ( const SolutionState< Scalar > &  ss) const

Less than comparison for sorting based on time.

Definition at line 435 of file Tempus_SolutionState_impl.hpp.

◆ operator<=() [1/2]

template<class Scalar >
bool Tempus::SolutionState< Scalar >::operator<= ( const Scalar &  t) const

Less than comparison for sorting based on time.

Definition at line 453 of file Tempus_SolutionState_impl.hpp.

◆ operator<=() [2/2]

template<class Scalar >
bool Tempus::SolutionState< Scalar >::operator<= ( const SolutionState< Scalar > &  ss) const

Less than comparison for sorting based on time.

Definition at line 441 of file Tempus_SolutionState_impl.hpp.

◆ operator==() [1/2]

template<class Scalar >
bool Tempus::SolutionState< Scalar >::operator== ( const Scalar &  t) const

Equality comparison for matching.

Definition at line 489 of file Tempus_SolutionState_impl.hpp.

◆ operator==() [2/2]

template<class Scalar >
bool Tempus::SolutionState< Scalar >::operator== ( const SolutionState< Scalar > &  ss) const

Equality comparison for matching.

Definition at line 483 of file Tempus_SolutionState_impl.hpp.

◆ operator>() [1/2]

template<class Scalar >
bool Tempus::SolutionState< Scalar >::operator> ( const Scalar &  t) const

Less than comparison for sorting based on time.

Definition at line 471 of file Tempus_SolutionState_impl.hpp.

◆ operator>() [2/2]

template<class Scalar >
bool Tempus::SolutionState< Scalar >::operator> ( const SolutionState< Scalar > &  ss) const

Less than comparison for sorting based on time.

Definition at line 459 of file Tempus_SolutionState_impl.hpp.

◆ operator>=() [1/2]

template<class Scalar >
bool Tempus::SolutionState< Scalar >::operator>= ( const Scalar &  t) const

Less than comparison for sorting based on time.

Definition at line 477 of file Tempus_SolutionState_impl.hpp.

◆ operator>=() [2/2]

template<class Scalar >
bool Tempus::SolutionState< Scalar >::operator>= ( const SolutionState< Scalar > &  ss) const

Less than comparison for sorting based on time.

Definition at line 465 of file Tempus_SolutionState_impl.hpp.

◆ setIndex()

template<class Scalar>
virtual void Tempus::SolutionState< Scalar >::setIndex ( Scalar  index)
inlinevirtual

Definition at line 188 of file Tempus_SolutionState_decl.hpp.

◆ setIsSynced()

template<class Scalar>
virtual void Tempus::SolutionState< Scalar >::setIsSynced ( bool  isSynced)
inlinevirtual

Definition at line 198 of file Tempus_SolutionState_decl.hpp.

◆ setMetaData() [1/2]

template<class Scalar>
virtual void Tempus::SolutionState< Scalar >::setMetaData ( Teuchos::RCP< const SolutionStateMetaData< Scalar > >  md)
inlinevirtual

Definition at line 181 of file Tempus_SolutionState_decl.hpp.

◆ setMetaData() [2/2]

template<class Scalar>
virtual void Tempus::SolutionState< Scalar >::setMetaData ( Teuchos::RCP< SolutionStateMetaData< Scalar > >  md)
inlinevirtual

Definition at line 184 of file Tempus_SolutionState_decl.hpp.

◆ setOrder()

template<class Scalar>
virtual void Tempus::SolutionState< Scalar >::setOrder ( Scalar  order)
inlinevirtual

Definition at line 190 of file Tempus_SolutionState_decl.hpp.

◆ setOutput()

template<class Scalar>
virtual void Tempus::SolutionState< Scalar >::setOutput ( bool  output)
inlinevirtual

Definition at line 195 of file Tempus_SolutionState_decl.hpp.

◆ setPhysicsState()

template<class Scalar>
virtual void Tempus::SolutionState< Scalar >::setPhysicsState ( const Teuchos::RCP< PhysicsState< Scalar > > &  ps)
inlinevirtual

Definition at line 233 of file Tempus_SolutionState_decl.hpp.

◆ setSolutionStatus()

template<class Scalar>
virtual void Tempus::SolutionState< Scalar >::setSolutionStatus ( Status  s)
inlinevirtual

Definition at line 193 of file Tempus_SolutionState_decl.hpp.

◆ setTime()

template<class Scalar>
virtual void Tempus::SolutionState< Scalar >::setTime ( Scalar  time)
inlinevirtual

Definition at line 187 of file Tempus_SolutionState_decl.hpp.

◆ setTimeStep()

template<class Scalar>
virtual void Tempus::SolutionState< Scalar >::setTimeStep ( Scalar  dt)
inlinevirtual

Definition at line 189 of file Tempus_SolutionState_decl.hpp.

◆ swapSolutionData()

template<class Scalar >
void Tempus::SolutionState< Scalar >::swapSolutionData ( const Teuchos::RCP< SolutionState< Scalar > > &  ss)
virtual

Swap solution data, but keep metaData untouched.

Definition at line 388 of file Tempus_SolutionState_impl.hpp.

Member Data Documentation

◆ metaData_

template<class Scalar>
Teuchos::RCP<const SolutionStateMetaData<Scalar> > Tempus::SolutionState< Scalar >::metaData_
private

Meta Data for the solution state.

Definition at line 282 of file Tempus_SolutionState_decl.hpp.

◆ metaData_nc_

template<class Scalar>
Teuchos::RCP<SolutionStateMetaData<Scalar> > Tempus::SolutionState< Scalar >::metaData_nc_
private

Definition at line 283 of file Tempus_SolutionState_decl.hpp.

◆ physicsState_

template<class Scalar>
Teuchos::RCP<const Tempus::PhysicsState<Scalar> > Tempus::SolutionState< Scalar >::physicsState_
private

PhysicsState for this SolutionState.

Definition at line 302 of file Tempus_SolutionState_decl.hpp.

◆ physicsState_nc_

template<class Scalar>
Teuchos::RCP<Tempus::PhysicsState<Scalar> > Tempus::SolutionState< Scalar >::physicsState_nc_
private

Definition at line 303 of file Tempus_SolutionState_decl.hpp.

◆ stepperState_

template<class Scalar>
Teuchos::RCP<const Tempus::StepperState<Scalar> > Tempus::SolutionState< Scalar >::stepperState_
private

StepperState for this SolutionState.

Definition at line 298 of file Tempus_SolutionState_decl.hpp.

◆ stepperState_nc_

template<class Scalar>
Teuchos::RCP<Tempus::StepperState<Scalar> > Tempus::SolutionState< Scalar >::stepperState_nc_
private

Definition at line 299 of file Tempus_SolutionState_decl.hpp.

◆ x_

template<class Scalar>
Teuchos::RCP<const Thyra::VectorBase<Scalar> > Tempus::SolutionState< Scalar >::x_
private

Solution.

Definition at line 286 of file Tempus_SolutionState_decl.hpp.

◆ x_nc_

template<class Scalar>
Teuchos::RCP<Thyra::VectorBase<Scalar> > Tempus::SolutionState< Scalar >::x_nc_
private

Definition at line 287 of file Tempus_SolutionState_decl.hpp.

◆ xdot_

template<class Scalar>
Teuchos::RCP<const Thyra::VectorBase<Scalar> > Tempus::SolutionState< Scalar >::xdot_
private

Time derivative of the solution.

Definition at line 290 of file Tempus_SolutionState_decl.hpp.

◆ xdot_nc_

template<class Scalar>
Teuchos::RCP<Thyra::VectorBase<Scalar> > Tempus::SolutionState< Scalar >::xdot_nc_
private

Definition at line 291 of file Tempus_SolutionState_decl.hpp.

◆ xdotdot_

template<class Scalar>
Teuchos::RCP<const Thyra::VectorBase<Scalar> > Tempus::SolutionState< Scalar >::xdotdot_
private

Second time derivative of the solution.

Definition at line 294 of file Tempus_SolutionState_decl.hpp.

◆ xdotdot_nc_

template<class Scalar>
Teuchos::RCP<Thyra::VectorBase<Scalar> > Tempus::SolutionState< Scalar >::xdotdot_nc_
private

Definition at line 295 of file Tempus_SolutionState_decl.hpp.

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