Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
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.
 
virtual ~IntegratorObserverBasic ()
 Destructor.
 
- Public Member Functions inherited from Tempus::IntegratorObserver< Scalar >
virtual ~IntegratorObserver ()=default
 default destructor
 

Basic IntegratorObserver methods

virtual void observeStartIntegrator (const Integrator< Scalar > &integrator) override
 Observe the beginning of the time integrator.
 
virtual void observeStartTimeStep (const Integrator< Scalar > &integrator) override
 Observe the beginning of the time step loop.
 
virtual void observeNextTimeStep (const Integrator< Scalar > &integrator) override
 Observe after the next time step size is selected.
 
virtual void observeBeforeTakeStep (const Integrator< Scalar > &integrator) override
 Observe before Stepper takes step.
 
virtual void observeAfterTakeStep (const Integrator< Scalar > &integrator) override
 Observe after Stepper takes step.
 
virtual void observeAfterCheckTimeStep (const Integrator< Scalar > &integrator) override
 Observe after checking time step. Observer can still fail the time step here.
 
virtual void observeEndTimeStep (const Integrator< Scalar > &integrator) override
 Observe the end of the time step loop.
 
virtual void observeEndIntegrator (const Integrator< Scalar > &integrator) override
 Observe the end of the time integrator.
 

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 24 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

◆ 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 23 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.

◆ 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.

◆ 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.

◆ 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.

◆ observeAfterCheckTimeStep()

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

◆ observeEndTimeStep()

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


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