Tempus  Version of the Day
Time Integration
Public Member Functions | List of all members
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 >:
Tempus::IntegratorObserver< Scalar >

Public Member Functions

 IntegratorObserverBasic ()
 Constructor. More...
 
virtual ~IntegratorObserverBasic ()
 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 observeAcceptedTimeStep (const Integrator< Scalar > &integrator) override
 Observe after accepting time step. More...
 
virtual void observeEndIntegrator (const Integrator< Scalar > &integrator) override
 Observe the end of the time integrator. More...
 
Basic IntegratorObserver methods

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 23 of file Tempus_IntegratorObserverBasic_decl.hpp.

Constructor & Destructor Documentation

◆ IntegratorObserverBasic()

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

Constructor.

Definition at line 17 of file Tempus_IntegratorObserverBasic_impl.hpp.

◆ ~IntegratorObserverBasic()

template<class Scalar >
Tempus::IntegratorObserverBasic< Scalar >::~IntegratorObserverBasic ( )
virtual

Destructor.

Definition at line 20 of file Tempus_IntegratorObserverBasic_impl.hpp.

Member Function Documentation

◆ observeAcceptedTimeStep()

template<class Scalar >
void Tempus::IntegratorObserverBasic< Scalar >::observeAcceptedTimeStep ( const Integrator< Scalar > &  integrator)
overridevirtual

Observe after accepting time step.

Implements Tempus::IntegratorObserver< Scalar >.

Definition at line 59 of file Tempus_IntegratorObserverBasic_impl.hpp.

◆ observeAfterTakeStep()

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 55 of file Tempus_IntegratorObserverBasic_impl.hpp.

◆ observeBeforeTakeStep()

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 51 of file Tempus_IntegratorObserverBasic_impl.hpp.

◆ observeEndIntegrator()

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 90 of file Tempus_IntegratorObserverBasic_impl.hpp.

◆ observeNextTimeStep()

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 47 of file Tempus_IntegratorObserverBasic_impl.hpp.

◆ observeStartIntegrator()

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 24 of file Tempus_IntegratorObserverBasic_impl.hpp.

◆ observeStartTimeStep()

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 43 of file Tempus_IntegratorObserverBasic_impl.hpp.

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