Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Tempus::StepperObserverComposite< Scalar > Class Template Reference

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

#include <Tempus_StepperObserverComposite_decl.hpp>

Inheritance diagram for Tempus::StepperObserverComposite< Scalar >:
Tempus::StepperObserver< Scalar >

Public Member Functions

 StepperObserverComposite ()
 Default constructor. More...
 
virtual ~StepperObserverComposite ()
 Destructor. More...
 
Override StepperObserver basic methods
virtual void observeBeginTakeStep (Teuchos::RCP< SolutionHistory< Scalar > > sh, Stepper< Scalar > &stepper) override
 Observe the beginning of the time integrator. More...
 
virtual void observeEndTakeStep (Teuchos::RCP< SolutionHistory< Scalar > > sh, Stepper< Scalar > &stepper) override
 Observe the beginning of the time step loop. More...
 
void addObserver (const Teuchos::RCP< StepperObserver< Scalar > > &observer)
 
void clearObservers ()
 
std::size_t getSize () const
 

Private Attributes

std::vector< Teuchos::RCP
< StepperObserver< Scalar > > > 
observers_
 

Detailed Description

template<class Scalar>
class Tempus::StepperObserverComposite< Scalar >

This observer is a composite observer,.

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

Definition at line 24 of file Tempus_StepperObserverComposite_decl.hpp.

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 18 of file Tempus_StepperObserverComposite_impl.hpp.

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

Destructor.

Definition at line 21 of file Tempus_StepperObserverComposite_impl.hpp.

Member Function Documentation

template<class Scalar >
void Tempus::StepperObserverComposite< Scalar >::addObserver ( const Teuchos::RCP< StepperObserver< Scalar > > &  observer)

Definition at line 43 of file Tempus_StepperObserverComposite_impl.hpp.

template<class Scalar >
void Tempus::StepperObserverComposite< Scalar >::clearObservers ( )

Definition at line 50 of file Tempus_StepperObserverComposite_impl.hpp.

template<class Scalar >
std::size_t Tempus::StepperObserverComposite< Scalar >::getSize ( ) const
inline

Definition at line 50 of file Tempus_StepperObserverComposite_decl.hpp.

template<class Scalar >
void Tempus::StepperObserverComposite< Scalar >::observeBeginTakeStep ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Stepper< Scalar > &  stepper 
)
overridevirtual

Observe the beginning of the time integrator.

Implements Tempus::StepperObserver< Scalar >.

Definition at line 25 of file Tempus_StepperObserverComposite_impl.hpp.

template<class Scalar >
void Tempus::StepperObserverComposite< Scalar >::observeEndTakeStep ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Stepper< Scalar > &  stepper 
)
overridevirtual

Observe the beginning of the time step loop.

Implements Tempus::StepperObserver< Scalar >.

Definition at line 34 of file Tempus_StepperObserverComposite_impl.hpp.

Member Data Documentation

template<class Scalar >
std::vector<Teuchos::RCP<StepperObserver<Scalar > > > Tempus::StepperObserverComposite< Scalar >::observers_
private

Definition at line 55 of file Tempus_StepperObserverComposite_decl.hpp.


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