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

StepperIMEX_RKObserver class for StepperIMEX_RK. More...

#include <Tempus_StepperIMEX_RKObserver.hpp>

Inheritance diagram for Tempus::StepperIMEX_RKObserver< Scalar >:
Tempus::StepperObserver< Scalar >

Public Member Functions

 StepperIMEX_RKObserver ()
 Constructor. More...
 
virtual ~StepperIMEX_RKObserver ()
 Destructor. More...
 
virtual void observeBeginTakeStep (Teuchos::RCP< SolutionHistory< Scalar > >, Stepper< Scalar > &)
 Observe Stepper at beginning of takeStep. More...
 
virtual void observeBeginStage (Teuchos::RCP< SolutionHistory< Scalar > >, StepperIMEX_RK< Scalar > &)
 Observe Stepper at beginning of each stage. More...
 
virtual void observeBeforeImplicitExplicitly (Teuchos::RCP< SolutionHistory< Scalar > >, StepperIMEX_RK< Scalar > &)
 Observe Stepper before Explicit evaluation of Implicit ODE ME. More...
 
virtual void observeBeforeSolve (Teuchos::RCP< SolutionHistory< Scalar > >, StepperIMEX_RK< Scalar > &)
 Observe Stepper before nonlinear solve. More...
 
virtual void observeAfterSolve (Teuchos::RCP< SolutionHistory< Scalar > >, StepperIMEX_RK< Scalar > &)
 Observe Stepper after nonlinear solve. More...
 
virtual void observeBeforeExplicit (Teuchos::RCP< SolutionHistory< Scalar > >, StepperIMEX_RK< Scalar > &)
 Observe Stepper before Explicit ME evaluation. More...
 
virtual void observeEndStage (Teuchos::RCP< SolutionHistory< Scalar > >, StepperIMEX_RK< Scalar > &)
 Observe Stepper at end of each stage. More...
 
virtual void observeEndTakeStep (Teuchos::RCP< SolutionHistory< Scalar > >, Stepper< Scalar > &)
 Observe Stepper at end of takeStep. More...
 

Detailed Description

template<class Scalar>
class Tempus::StepperIMEX_RKObserver< Scalar >

StepperIMEX_RKObserver class for StepperIMEX_RK.

This is a means for application developers to perform tasks during the time steps, e.g.,

  • Compute specific quantities
  • Output information
  • "Massage" the working solution state
  • ...

Design Considerations

  • StepperIMEX_RKObserver is not stateless! Developers may touch the solution state! Developers need to be careful not to break the restart (checkpoint) capability.

Definition at line 35 of file Tempus_StepperIMEX_RKObserver.hpp.

Constructor & Destructor Documentation

template<class Scalar >
Tempus::StepperIMEX_RKObserver< Scalar >::StepperIMEX_RKObserver ( )
inline

Constructor.

Definition at line 41 of file Tempus_StepperIMEX_RKObserver.hpp.

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

Destructor.

Definition at line 44 of file Tempus_StepperIMEX_RKObserver.hpp.

Member Function Documentation

template<class Scalar >
virtual void Tempus::StepperIMEX_RKObserver< Scalar >::observeAfterSolve ( Teuchos::RCP< SolutionHistory< Scalar > >  ,
StepperIMEX_RK< Scalar > &   
)
inlinevirtual

Observe Stepper after nonlinear solve.

Definition at line 67 of file Tempus_StepperIMEX_RKObserver.hpp.

template<class Scalar >
virtual void Tempus::StepperIMEX_RKObserver< Scalar >::observeBeforeExplicit ( Teuchos::RCP< SolutionHistory< Scalar > >  ,
StepperIMEX_RK< Scalar > &   
)
inlinevirtual

Observe Stepper before Explicit ME evaluation.

Definition at line 72 of file Tempus_StepperIMEX_RKObserver.hpp.

template<class Scalar >
virtual void Tempus::StepperIMEX_RKObserver< Scalar >::observeBeforeImplicitExplicitly ( Teuchos::RCP< SolutionHistory< Scalar > >  ,
StepperIMEX_RK< Scalar > &   
)
inlinevirtual

Observe Stepper before Explicit evaluation of Implicit ODE ME.

Definition at line 57 of file Tempus_StepperIMEX_RKObserver.hpp.

template<class Scalar >
virtual void Tempus::StepperIMEX_RKObserver< Scalar >::observeBeforeSolve ( Teuchos::RCP< SolutionHistory< Scalar > >  ,
StepperIMEX_RK< Scalar > &   
)
inlinevirtual

Observe Stepper before nonlinear solve.

Definition at line 62 of file Tempus_StepperIMEX_RKObserver.hpp.

template<class Scalar >
virtual void Tempus::StepperIMEX_RKObserver< Scalar >::observeBeginStage ( Teuchos::RCP< SolutionHistory< Scalar > >  ,
StepperIMEX_RK< Scalar > &   
)
inlinevirtual

Observe Stepper at beginning of each stage.

Definition at line 52 of file Tempus_StepperIMEX_RKObserver.hpp.

template<class Scalar >
virtual void Tempus::StepperIMEX_RKObserver< Scalar >::observeBeginTakeStep ( Teuchos::RCP< SolutionHistory< Scalar > >  ,
Stepper< Scalar > &   
)
inlinevirtual

Observe Stepper at beginning of takeStep.

Implements Tempus::StepperObserver< Scalar >.

Definition at line 47 of file Tempus_StepperIMEX_RKObserver.hpp.

template<class Scalar >
virtual void Tempus::StepperIMEX_RKObserver< Scalar >::observeEndStage ( Teuchos::RCP< SolutionHistory< Scalar > >  ,
StepperIMEX_RK< Scalar > &   
)
inlinevirtual

Observe Stepper at end of each stage.

Definition at line 77 of file Tempus_StepperIMEX_RKObserver.hpp.

template<class Scalar >
virtual void Tempus::StepperIMEX_RKObserver< Scalar >::observeEndTakeStep ( Teuchos::RCP< SolutionHistory< Scalar > >  ,
Stepper< Scalar > &   
)
inlinevirtual

Observe Stepper at end of takeStep.

Implements Tempus::StepperObserver< Scalar >.

Definition at line 82 of file Tempus_StepperIMEX_RKObserver.hpp.

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