Tempus::IntegratorObserver< Scalar > Class Template Reference

IntegratorObserver class for time integrators. More...

#include <Tempus_IntegratorObserver.hpp>

Inheritance diagram for Tempus::IntegratorObserver< Scalar >:

Basic IntegratorObserver methods
virtual void	observeStartIntegrator (const Integrator< Scalar > &integrator)=0
	Observe the beginning of the time integrator. More...
virtual void	observeStartTimeStep (const Integrator< Scalar > &integrator)=0
	Observe the beginning of the time step loop. More...
virtual void	observeNextTimeStep (const Integrator< Scalar > &integrator)=0
virtual void	observeBeforeTakeStep (const Integrator< Scalar > &integrator)=0
	Observe before Stepper takes step. More...
virtual void	observeAfterTakeStep (const Integrator< Scalar > &integrator)=0
	Observe after Stepper takes step. More...
virtual void	observeAfterCheckTimeStep (const Integrator< Scalar > &integrator)=0
virtual void	observeEndTimeStep (const Integrator< Scalar > &integrator)=0
	Observe the end of the time step loop. More...
virtual void	observeEndIntegrator (const Integrator< Scalar > &integrator)=0
	Observe the end of the time integrator. More...
virtual	~IntegratorObserver ()=default
	default destructor More...

Detailed Description

template<class Scalar>
class Tempus::IntegratorObserver< Scalar >

IntegratorObserver class for time integrators.

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

• Compute specific quantities
• Output information
• Adjust the time step (CFL stability)
• "Massage" the working solution state
• ...

Design Considerations

• IntegratorObserver should have access to the entire SolutionHistory, as application developers may have that need.
• The needed IntegratorObserver functions are determined by the access needs in Integrator::advanceTime().
• IntegratorObserver is not stateless! Developers may touch the solution state! Developers need to be careful not to break the restart (checkpoint) capability.

Definition at line 44 of file Tempus_IntegratorObserver.hpp.

Constructor & Destructor Documentation

template<class Scalar >

virtual Tempus::IntegratorObserver< Scalar >::~IntegratorObserver ( )

virtualdefault

default destructor

Member Function Documentation

template<class Scalar >

virtual void Tempus::IntegratorObserver< Scalar >::observeStartIntegrator ( const Integrator< Scalar > &  integrator )

pure virtual

Observe the beginning of the time integrator.

Implemented in Tempus::IntegratorObserverComposite< Scalar >, Tempus::IntegratorObserverBasic< Scalar >, Tempus::IntegratorObserverLogging< Scalar >, Tempus::IntegratorObserverNoOp< Scalar >, and Tempus::IntegratorObserverSubcycling< Scalar >.

template<class Scalar >

virtual void Tempus::IntegratorObserver< Scalar >::observeStartTimeStep ( const Integrator< Scalar > &  integrator )

pure virtual

Observe the beginning of the time step loop.

Implemented in Tempus::IntegratorObserverComposite< Scalar >, Tempus::IntegratorObserverBasic< Scalar >, Tempus::IntegratorObserverLogging< Scalar >, Tempus::IntegratorObserverNoOp< Scalar >, and Tempus::IntegratorObserverSubcycling< Scalar >.

template<class Scalar >

virtual void Tempus::IntegratorObserver< Scalar >::observeNextTimeStep ( const Integrator< Scalar > &  integrator )

pure virtual

Observe after the next time step size is selected. The observer can choose to change the current integratorStatus.

Implemented in Tempus::IntegratorObserverComposite< Scalar >, Tempus::IntegratorObserverBasic< Scalar >, Tempus::IntegratorObserverLogging< Scalar >, Tempus::IntegratorObserverNoOp< Scalar >, and Tempus::IntegratorObserverSubcycling< Scalar >.

template<class Scalar >

virtual void Tempus::IntegratorObserver< Scalar >::observeBeforeTakeStep ( const Integrator< Scalar > &  integrator )

pure virtual

Observe before Stepper takes step.

Implemented in Tempus::IntegratorObserverComposite< Scalar >, Tempus::IntegratorObserverBasic< Scalar >, Tempus::IntegratorObserverLogging< Scalar >, Tempus::IntegratorObserverNoOp< Scalar >, and Tempus::IntegratorObserverSubcycling< Scalar >.

template<class Scalar >

virtual void Tempus::IntegratorObserver< Scalar >::observeAfterTakeStep ( const Integrator< Scalar > &  integrator )

pure virtual

Observe after Stepper takes step.

Implemented in Tempus::IntegratorObserverComposite< Scalar >, Tempus::IntegratorObserverBasic< Scalar >, Tempus::IntegratorObserverLogging< Scalar >, Tempus::IntegratorObserverNoOp< Scalar >, and Tempus::IntegratorObserverSubcycling< Scalar >.

template<class Scalar >

virtual void Tempus::IntegratorObserver< Scalar >::observeAfterCheckTimeStep ( const Integrator< Scalar > &  integrator )

pure virtual

Observe after checking time step. Observer can still fail the time step here.

Implemented in Tempus::IntegratorObserverBasic< Scalar >, Tempus::IntegratorObserverComposite< Scalar >, Tempus::IntegratorObserverNoOp< Scalar >, Tempus::IntegratorObserverSubcycling< Scalar >, and Tempus::IntegratorObserverLogging< Scalar >.

template<class Scalar >

virtual void Tempus::IntegratorObserver< Scalar >::observeEndTimeStep ( const Integrator< Scalar > &  integrator )

pure virtual

Observe the end of the time step loop.

Implemented in Tempus::IntegratorObserverBasic< Scalar >, Tempus::IntegratorObserverComposite< Scalar >, Tempus::IntegratorObserverNoOp< Scalar >, Tempus::IntegratorObserverSubcycling< Scalar >, and Tempus::IntegratorObserverLogging< Scalar >.

template<class Scalar >

virtual void Tempus::IntegratorObserver< Scalar >::observeEndIntegrator ( const Integrator< Scalar > &  integrator )

pure virtual

Observe the end of the time integrator.

Implemented in Tempus::IntegratorObserverBasic< Scalar >, Tempus::IntegratorObserverComposite< Scalar >, Tempus::IntegratorObserverNoOp< Scalar >, Tempus::IntegratorObserverSubcycling< Scalar >, and Tempus::IntegratorObserverLogging< Scalar >.

---

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

• Tempus_IntegratorObserver.hpp