Rythmos - Transient Integration for Differential Equations Version of the Day
Related Functions
Rythmos::CompositeIntegrationObserver< Scalar > Class Template Reference

Standard composite observer subclass. More...

#include <Rythmos_CompositeIntegrationObserver.hpp>

Inheritance diagram for Rythmos::CompositeIntegrationObserver< Scalar >:
Inheritance graph
[legend]

List of all members.

Related Functions

(Note that these are not member functions.)

template<class Scalar >
RCP
< CompositeIntegrationObserver
< Scalar > > 
createCompositeIntegrationObserver ()
 Non-member constructor.

Constructors/Initializers/Accessors

 CompositeIntegrationObserver ()
 
void addObserver (const RCP< IntegrationObserverBase< Scalar > > &observer)
 

Overridden from IntegrationObserverBase

virtual RCP
< IntegrationObserverBase
< Scalar > > 
cloneIntegrationObserver () const
 
virtual void resetIntegrationObserver (const TimeRange< Scalar > &integrationTimeDomain)
 
void observeStartTimeIntegration (const StepperBase< Scalar > &stepper)
 Observe the beginning of a time integration loop.
void observeEndTimeIntegration (const StepperBase< Scalar > &stepper)
 Observe the end of a time integration loop.
void observeStartTimeStep (const StepperBase< Scalar > &stepper, const StepControlInfo< Scalar > &stepCtrlInfo, const int timeStepIter)
 Observer the beginning of an integration step.
virtual void observeCompletedTimeStep (const StepperBase< Scalar > &stepper, const StepControlInfo< Scalar > &stepCtrlInfo, const int timeStepIter)
 
virtual void observeFailedTimeStep (const StepperBase< Scalar > &stepper, const StepControlInfo< Scalar > &stepCtrlInfo, const int timeStepIter)
 

Detailed Description

template<class Scalar>
class Rythmos::CompositeIntegrationObserver< Scalar >

Standard composite observer subclass.

ToDo: Finish Documentation

Definition at line 45 of file Rythmos_CompositeIntegrationObserver.hpp.


Constructor & Destructor Documentation

Definition at line 132 of file Rythmos_CompositeIntegrationObserver.hpp.


Member Function Documentation

template<class Scalar >
void Rythmos::CompositeIntegrationObserver< Scalar >::addObserver ( const RCP< IntegrationObserverBase< Scalar > > &  observer)

Definition at line 137 of file Rythmos_CompositeIntegrationObserver.hpp.

template<class Scalar >
RCP< IntegrationObserverBase< Scalar > > Rythmos::CompositeIntegrationObserver< Scalar >::cloneIntegrationObserver ( ) const [virtual]
template<class Scalar >
void Rythmos::CompositeIntegrationObserver< Scalar >::resetIntegrationObserver ( const TimeRange< Scalar > &  integrationTimeDomain) [virtual]
template<class Scalar >
void Rythmos::CompositeIntegrationObserver< Scalar >::observeStartTimeIntegration ( const StepperBase< Scalar > &  stepper) [virtual]

Observe the beginning of a time integration loop.

Parameters:
stepper[in] The stepper object.

Warning! This function is *NOT* stateless. It should be called once and only once at the beginning of getFwdPoints().

NOTE: The function resetIntegrationControlStrategy() must be called prior to even the first call to function.

NOTE: This method should be pure virtual but has been given a default implementation for backwards compatibility. We will make this pure virtual in the future.

Reimplemented from Rythmos::IntegrationObserverBase< Scalar >.

Definition at line 174 of file Rythmos_CompositeIntegrationObserver.hpp.

template<class Scalar >
void Rythmos::CompositeIntegrationObserver< Scalar >::observeEndTimeIntegration ( const StepperBase< Scalar > &  stepper) [virtual]

Observe the end of a time integration loop.

Parameters:
stepper[in] The stepper object.

Warning! This function is *NOT* stateless. It should be called once and only once at the end of getFwdPoints().

NOTE: The function resetIntegrationControlStrategy() must be called prior to even the first call to function.

NOTE: This method should be pure virtual but has been given a default implementation for backwards compatibility. We will make this pure virtual in the future.

Reimplemented from Rythmos::IntegrationObserverBase< Scalar >.

Definition at line 192 of file Rythmos_CompositeIntegrationObserver.hpp.

template<class Scalar >
void Rythmos::CompositeIntegrationObserver< Scalar >::observeStartTimeStep ( const StepperBase< Scalar > &  stepper,
const StepControlInfo< Scalar > &  stepCtrlInfo,
const int  timeStepIter 
) [virtual]

Observer the beginning of an integration step.

Parameters:
stepper[in] The stepper object.
stepCtrlInfo[in] The info for the time step about to be taken.
timeStepIter[in] The time step iteration counter. In the first call to this function, this should be timeStepIter==0 and it should be incremented on each call only once. While the concrete implementation of *this could keep track of the this counter, putting it in the argument list helps to simplify logic and helps to validate correct usage.

Warning! This function is *NOT* stateless. It should be called once and only once at the beginning of each time step.

NOTE: The function resetIntegrationControlStrategy() must be called prior to even the first call to function.

NOTE: This method should be pure virtual but has been given a default implementation for backwards compatibility. We will make this pure virtual in the future.

Reimplemented from Rythmos::IntegrationObserverBase< Scalar >.

Definition at line 210 of file Rythmos_CompositeIntegrationObserver.hpp.

template<class Scalar >
void Rythmos::CompositeIntegrationObserver< Scalar >::observeCompletedTimeStep ( const StepperBase< Scalar > &  stepper,
const StepControlInfo< Scalar > &  stepCtrlInfo,
const int  timeStepIter 
) [virtual]
template<class Scalar >
void Rythmos::CompositeIntegrationObserver< Scalar >::observeFailedTimeStep ( const StepperBase< Scalar > &  stepper,
const StepControlInfo< Scalar > &  stepCtrlInfo,
const int  timeStepIter 
) [virtual]

Friends And Related Function Documentation

template<class Scalar >
RCP< CompositeIntegrationObserver< Scalar > > createCompositeIntegrationObserver ( ) [related]

Non-member constructor.

Definition at line 115 of file Rythmos_CompositeIntegrationObserver.hpp.


The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Friends