Tempus::IntegratorObserverComposite< Scalar > Class Template Reference

This observer is a composite observer,. More...

#include <Tempus_IntegratorObserverComposite_decl.hpp>

Inheritance diagram for Tempus::IntegratorObserverComposite< Scalar >:

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

Private Attributes
std::vector< Teuchos::RCP < IntegratorObserver< Scalar > > >	observers_

Override IntegratorObserver basic 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
	Observe after checking time step. More...
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...
void	addObserver (const Teuchos::RCP< IntegratorObserver< Scalar > > &observer)
void	clearObservers ()

Detailed Description

template<class Scalar>
class Tempus::IntegratorObserverComposite< Scalar >

This observer is a composite observer,.

which takes other IntegratorObservers and sequentially calls each individual observer function.

Definition at line 25 of file Tempus_IntegratorObserverComposite_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Tempus::IntegratorObserverComposite< Scalar >::IntegratorObserverComposite

(

)

Default constructor.

Definition at line 18 of file Tempus_IntegratorObserverComposite_impl.hpp.

template<class Scalar >

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

virtual

Destructor.

Definition at line 21 of file Tempus_IntegratorObserverComposite_impl.hpp.

Member Function Documentation

template<class Scalar >

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

overridevirtual

Observe the beginning of the time integrator.

Implements Tempus::IntegratorObserver< Scalar >.

Definition at line 25 of file Tempus_IntegratorObserverComposite_impl.hpp.

template<class Scalar >

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

overridevirtual

Observe the beginning of the time step loop.

Implements Tempus::IntegratorObserver< Scalar >.

Definition at line 33 of file Tempus_IntegratorObserverComposite_impl.hpp.

template<class Scalar >

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

overridevirtual

Observe after the next time step size is selected.

Implements Tempus::IntegratorObserver< Scalar >.

Definition at line 41 of file Tempus_IntegratorObserverComposite_impl.hpp.

template<class Scalar >

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

overridevirtual

Observe before Stepper takes step.

Implements Tempus::IntegratorObserver< Scalar >.

Definition at line 49 of file Tempus_IntegratorObserverComposite_impl.hpp.

template<class Scalar >

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

overridevirtual

Observe after Stepper takes step.

Implements Tempus::IntegratorObserver< Scalar >.

Definition at line 57 of file Tempus_IntegratorObserverComposite_impl.hpp.

template<class Scalar >

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

overridevirtual

Observe after checking time step.

Implements Tempus::IntegratorObserver< Scalar >.

Definition at line 65 of file Tempus_IntegratorObserverComposite_impl.hpp.

template<class Scalar >

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

overridevirtual

Observe the end of the time step loop.

Implements Tempus::IntegratorObserver< Scalar >.

Definition at line 73 of file Tempus_IntegratorObserverComposite_impl.hpp.

template<class Scalar >

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

overridevirtual

Observe the end of the time integrator.

Implements Tempus::IntegratorObserver< Scalar >.

Definition at line 81 of file Tempus_IntegratorObserverComposite_impl.hpp.

template<class Scalar >

void Tempus::IntegratorObserverComposite< Scalar >::addObserver

(

const Teuchos::RCP< IntegratorObserver< Scalar > > &

observer

)

Definition at line 89 of file Tempus_IntegratorObserverComposite_impl.hpp.

template<class Scalar >

void Tempus::IntegratorObserverComposite< Scalar >::clearObservers

(

)

Definition at line 96 of file Tempus_IntegratorObserverComposite_impl.hpp.

Member Data Documentation

template<class Scalar >

std::vector<Teuchos::RCP<IntegratorObserver<Scalar > > > Tempus::IntegratorObserverComposite< Scalar >::observers_

private

Definition at line 71 of file Tempus_IntegratorObserverComposite_decl.hpp.

---

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

• Tempus_IntegratorObserverComposite_decl.hpp
• Tempus_IntegratorObserverComposite_impl.hpp