Tempus::IntegratorObserverBasic< Scalar > Class Template Reference

IntegratorObserverBasic class for time integrators. This basic class has simple no-op functions, as all basic functionality should be handled through other methods. More...

#include <Tempus_IntegratorObserverBasic_decl.hpp>

Inheritance diagram for Tempus::IntegratorObserverBasic< Scalar >:

Public Member Functions
	IntegratorObserverBasic ()
	Constructor. More...
virtual	~IntegratorObserverBasic ()
	Destructor. More...
Public Member Functions inherited from Tempus::IntegratorObserver< Scalar >
virtual	~IntegratorObserver ()=default
	default destructor More...

Basic IntegratorObserver methods
virtual void	observeStartIntegrator (const Integrator< Scalar > &integrator) override
	Observe the beginning of the time integrator. More...
virtual void	observeStartTimeStep (const Integrator< Scalar > &integrator) override
	Observe the beginning of the time step loop. More...
virtual void	observeNextTimeStep (const Integrator< Scalar > &integrator) override
	Observe after the next time step size is selected. More...
virtual void	observeBeforeTakeStep (const Integrator< Scalar > &integrator) override
	Observe before Stepper takes step. More...
virtual void	observeAfterTakeStep (const Integrator< Scalar > &integrator) override
	Observe after Stepper takes step. More...
virtual void	observeAfterCheckTimeStep (const Integrator< Scalar > &integrator) override
virtual void	observeEndTimeStep (const Integrator< Scalar > &integrator) override
	Observe the end of the time step loop. More...
virtual void	observeEndIntegrator (const Integrator< Scalar > &integrator) override
	Observe the end of the time integrator. More...

Detailed Description

template<class Scalar>
class Tempus::IntegratorObserverBasic< Scalar >

IntegratorObserverBasic class for time integrators. This basic class has simple no-op functions, as all basic functionality should be handled through other methods.

Definition at line 25 of file Tempus_IntegratorObserverBasic_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Tempus::IntegratorObserverBasic< Scalar >::IntegratorObserverBasic

(

)

Constructor.

Definition at line 18 of file Tempus_IntegratorObserverBasic_impl.hpp.

template<class Scalar >

Tempus::IntegratorObserverBasic< Scalar >::~IntegratorObserverBasic ( )

virtual

Destructor.

Definition at line 23 of file Tempus_IntegratorObserverBasic_impl.hpp.

Member Function Documentation

template<class Scalar >

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

overridevirtual

Observe the beginning of the time integrator.

Implements Tempus::IntegratorObserver< Scalar >.

Definition at line 28 of file Tempus_IntegratorObserverBasic_impl.hpp.

template<class Scalar >

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

overridevirtual

Observe the beginning of the time step loop.

Implements Tempus::IntegratorObserver< Scalar >.

Definition at line 52 of file Tempus_IntegratorObserverBasic_impl.hpp.

template<class Scalar >

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

overridevirtual

Observe after the next time step size is selected.

Implements Tempus::IntegratorObserver< Scalar >.

Definition at line 58 of file Tempus_IntegratorObserverBasic_impl.hpp.

template<class Scalar >

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

overridevirtual

Observe before Stepper takes step.

Implements Tempus::IntegratorObserver< Scalar >.

Definition at line 64 of file Tempus_IntegratorObserverBasic_impl.hpp.

template<class Scalar >

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

overridevirtual

Observe after Stepper takes step.

Implements Tempus::IntegratorObserver< Scalar >.

Definition at line 70 of file Tempus_IntegratorObserverBasic_impl.hpp.

template<class Scalar >

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

overridevirtual

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

Implements Tempus::IntegratorObserver< Scalar >.

Definition at line 76 of file Tempus_IntegratorObserverBasic_impl.hpp.

template<class Scalar >

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

overridevirtual

Observe the end of the time step loop.

Implements Tempus::IntegratorObserver< Scalar >.

Definition at line 82 of file Tempus_IntegratorObserverBasic_impl.hpp.

template<class Scalar >

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

overridevirtual

Observe the end of the time integrator.

Implements Tempus::IntegratorObserver< Scalar >.

Definition at line 110 of file Tempus_IntegratorObserverBasic_impl.hpp.

---

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

• Tempus_IntegratorObserverBasic_decl.hpp
• Tempus_IntegratorObserverBasic_impl.hpp