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

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

#include <Tempus_StepperRKObserverComposite_decl.hpp>

Inheritance diagram for Tempus::StepperRKObserverComposite< Scalar >:
Tempus::StepperRKObserver< Scalar > Tempus::StepperObserver< Scalar >

Public Member Functions

 StepperRKObserverComposite ()
 Default constructor. More...
 
virtual ~StepperRKObserverComposite ()
 Destructor. More...
 
Override StepperRKObserver basic methods
virtual void observeBeginTakeStep (Teuchos::RCP< SolutionHistory< Scalar > > sh, Stepper< Scalar > &stepper) override
 Observe Stepper at beginning of takeStep. More...
 
virtual void observeBeginStage (Teuchos::RCP< SolutionHistory< Scalar > > sh, Stepper< Scalar > &stepperRK) override
 Observe Stepper at beginning of each stage. More...
 
virtual void observeBeforeImplicitExplicitly (Teuchos::RCP< SolutionHistory< Scalar > >, Stepper< Scalar > &) override
 Observe Stepper before Explicit evaluation of Implicit ODE ME. More...
 
virtual void observeBeforeSolve (Teuchos::RCP< SolutionHistory< Scalar > > sh, Stepper< Scalar > &stepperRK) override
 Observe Stepper before nonlinear solve. More...
 
virtual void observeAfterSolve (Teuchos::RCP< SolutionHistory< Scalar > > sh, Stepper< Scalar > &stepperRK) override
 Observe Stepper after nonlinear solve. More...
 
virtual void observeBeforeExplicit (Teuchos::RCP< SolutionHistory< Scalar > > sh, Stepper< Scalar > &stepperRK) override
 Observe Stepper before evaluation of Implicit ODE ME. More...
 
virtual void observeEndStage (Teuchos::RCP< SolutionHistory< Scalar > > sh, Stepper< Scalar > &stepperRK) override
 Observe Stepper at end of each stage. More...
 
virtual void observeEndTakeStep (Teuchos::RCP< SolutionHistory< Scalar > > sh, Stepper< Scalar > &stepper) override
 Observe Stepper at end of takeStep. More...
 
void addObserver (const Teuchos::RCP< StepperRKObserver< Scalar > > &observer)
 
void clearObservers ()
 
std::size_t getSize () const
 
- Public Member Functions inherited from Tempus::StepperRKObserver< Scalar >
 StepperRKObserver ()
 Constructor. More...
 
virtual ~StepperRKObserver ()
 Destructor. More...
 

Private Attributes

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

Detailed Description

template<class Scalar>
class Tempus::StepperRKObserverComposite< Scalar >

This observer is a composite observer,.

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

NOTE: certain RK observers (ERK,DIRK) methods execute 'back-to-back' without any intermediate code.

Definition at line 27 of file Tempus_StepperRKObserverComposite_decl.hpp.

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 18 of file Tempus_StepperRKObserverComposite_impl.hpp.

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

Destructor.

Definition at line 21 of file Tempus_StepperRKObserverComposite_impl.hpp.

Member Function Documentation

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

Definition at line 96 of file Tempus_StepperRKObserverComposite_impl.hpp.

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

Definition at line 103 of file Tempus_StepperRKObserverComposite_impl.hpp.

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

Definition at line 87 of file Tempus_StepperRKObserverComposite_decl.hpp.

template<class Scalar >
void Tempus::StepperRKObserverComposite< Scalar >::observeAfterSolve ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Stepper< Scalar > &  stepperRK 
)
overridevirtual

Observe Stepper after nonlinear solve.

Reimplemented from Tempus::StepperRKObserver< Scalar >.

Definition at line 60 of file Tempus_StepperRKObserverComposite_impl.hpp.

template<class Scalar >
void Tempus::StepperRKObserverComposite< Scalar >::observeBeforeExplicit ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Stepper< Scalar > &  stepperRK 
)
overridevirtual

Observe Stepper before evaluation of Implicit ODE ME.

Reimplemented from Tempus::StepperRKObserver< Scalar >.

Definition at line 69 of file Tempus_StepperRKObserverComposite_impl.hpp.

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

Observe Stepper before Explicit evaluation of Implicit ODE ME.

Reimplemented from Tempus::StepperRKObserver< Scalar >.

Definition at line 42 of file Tempus_StepperRKObserverComposite_impl.hpp.

template<class Scalar >
void Tempus::StepperRKObserverComposite< Scalar >::observeBeforeSolve ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Stepper< Scalar > &  stepperRK 
)
overridevirtual

Observe Stepper before nonlinear solve.

Reimplemented from Tempus::StepperRKObserver< Scalar >.

Definition at line 51 of file Tempus_StepperRKObserverComposite_impl.hpp.

template<class Scalar >
void Tempus::StepperRKObserverComposite< Scalar >::observeBeginStage ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Stepper< Scalar > &  stepperRK 
)
overridevirtual

Observe Stepper at beginning of each stage.

Reimplemented from Tempus::StepperRKObserver< Scalar >.

Definition at line 33 of file Tempus_StepperRKObserverComposite_impl.hpp.

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

Observe Stepper at beginning of takeStep.

Reimplemented from Tempus::StepperRKObserver< Scalar >.

Definition at line 25 of file Tempus_StepperRKObserverComposite_impl.hpp.

template<class Scalar >
void Tempus::StepperRKObserverComposite< Scalar >::observeEndStage ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Stepper< Scalar > &  stepperRK 
)
overridevirtual

Observe Stepper at end of each stage.

Reimplemented from Tempus::StepperRKObserver< Scalar >.

Definition at line 77 of file Tempus_StepperRKObserverComposite_impl.hpp.

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

Observe Stepper at end of takeStep.

Reimplemented from Tempus::StepperRKObserver< Scalar >.

Definition at line 87 of file Tempus_StepperRKObserverComposite_impl.hpp.

Member Data Documentation

template<class Scalar >
std::vector<Teuchos::RCP<StepperRKObserver<Scalar > > > Tempus::StepperRKObserverComposite< Scalar >::observers_
private

Definition at line 92 of file Tempus_StepperRKObserverComposite_decl.hpp.


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