Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | List of all members
Tempus::StepperLeapfrogObserverBase< Scalar > Class Template Referenceabstract

Base observer for StepperLeapfrog. More...

#include <Tempus_StepperLeapfrogObserverBase.hpp>

Inheritance diagram for Tempus::StepperLeapfrogObserverBase< Scalar >:
Tempus::StepperLeapfrogAppAction< Scalar > Tempus::StepperLeapfrogObserverDefault< Scalar >

Public Member Functions

virtual void observe (Teuchos::RCP< const SolutionHistory< Scalar > >, Teuchos::RCP< const StepperLeapfrog< Scalar > >, const typename StepperLeapfrogAppAction< Scalar >::ACTION_LOCATION actLoc)=0
 Observe Leapfrog Stepper. More...
 
- Public Member Functions inherited from Tempus::StepperLeapfrogAppAction< Scalar >
 StepperLeapfrogAppAction ()
 Constructor. More...
 
virtual ~StepperLeapfrogAppAction ()
 Destructor. More...
 

Private Member Functions

void execute (Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperLeapfrog< Scalar > > stepper, const typename StepperLeapfrogAppAction< Scalar >::ACTION_LOCATION actLoc)
 Execute application action for Leapfrog Stepper. More...
 

Additional Inherited Members

- Public Types inherited from Tempus::StepperLeapfrogAppAction< Scalar >
enum  ACTION_LOCATION {
  BEGIN_STEP, BEFORE_X_UPDATE, BEFORE_EXPLICIT_EVAL, BEFORE_XDOT_UPDATE,
  END_STEP
}
 Indicates the location of application action (see algorithm). More...
 

Detailed Description

template<class Scalar>
class Tempus::StepperLeapfrogObserverBase< Scalar >

Base observer for StepperLeapfrog.

This class provides a means to observe values (e.g., solution variables through SolutionHistory, and stepper member data through the Stepper), and cannot modify them.

Users deriving from this class can observer a lot of data, and it is expected that users will NOT modify any of that data. If the user wishes to modify the solution and/or stepper data during the Stepper::takeStep, they should use the Modifier class (with care!).

The locations for these AppAction calls (StepperLeapfrogAppAction::ACTION_LOCATION) are shown in the algorithm documentation of the StepperLeapfrog.

Definition at line 35 of file Tempus_StepperLeapfrogObserverBase.hpp.

Member Function Documentation

template<class Scalar>
void Tempus::StepperLeapfrogObserverBase< Scalar >::execute ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Teuchos::RCP< StepperLeapfrog< Scalar > >  stepper,
const typename StepperLeapfrogAppAction< Scalar >::ACTION_LOCATION  actLoc 
)
inlineprivatevirtual

Execute application action for Leapfrog Stepper.

Implements Tempus::StepperLeapfrogAppAction< Scalar >.

Definition at line 48 of file Tempus_StepperLeapfrogObserverBase.hpp.

template<class Scalar>
virtual void Tempus::StepperLeapfrogObserverBase< Scalar >::observe ( Teuchos::RCP< const SolutionHistory< Scalar > >  ,
Teuchos::RCP< const StepperLeapfrog< Scalar > >  ,
const typename StepperLeapfrogAppAction< Scalar >::ACTION_LOCATION  actLoc 
)
pure virtual

Observe Leapfrog Stepper.

Implemented in Tempus::StepperLeapfrogObserverDefault< Scalar >.


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