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

Application Action for StepperForwardEuler. More...

#include <Tempus_StepperForwardEulerAppAction.hpp>

Inheritance diagram for Tempus::StepperForwardEulerAppAction< Scalar >:
Tempus::StepperForwardEulerAppActionComposite< Scalar > Tempus::StepperForwardEulerModifierBase< Scalar > Tempus::StepperForwardEulerModifierXBase< Scalar > Tempus::StepperForwardEulerObserverBase< Scalar > Tempus::StepperForwardEulerModifierDefault< Scalar > Tempus::StepperForwardEulerModifierXDefault< Scalar > Tempus::StepperForwardEulerObserverDefault< Scalar >

Public Types

 Indicates the location of application action (see algorithm). More...

Public Member Functions

 StepperForwardEulerAppAction ()
 Constructor. More...
virtual ~StepperForwardEulerAppAction ()
 Destructor. More...
virtual void execute (Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperForwardEuler< Scalar > > stepper, const typename StepperForwardEulerAppAction< Scalar >::ACTION_LOCATION actLoc)=0
 Execute application action for ForwardEuler Stepper. More...

Detailed Description

template<class Scalar>
class Tempus::StepperForwardEulerAppAction< Scalar >

Application Action for StepperForwardEuler.

This class provides a means to apply various actions with the ForwardEuler time step. The data available to this class is solution variables (through SolutionHistory), and stepper data (through the Stepper). It allows the application to just observe this data, i.e., use but not change any of it (USER BEWARE!).

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

Definition at line 35 of file Tempus_StepperForwardEulerAppAction.hpp.

Member Enumeration Documentation

Indicates the location of application action (see algorithm).


At the beginning of the step.


Before the explicit evaluation.


At the end of the step.

Definition at line 38 of file Tempus_StepperForwardEulerAppAction.hpp.

Constructor & Destructor Documentation

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


Definition at line 45 of file Tempus_StepperForwardEulerAppAction.hpp.

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


Definition at line 48 of file Tempus_StepperForwardEulerAppAction.hpp.

Member Function Documentation

template<class Scalar>
virtual void Tempus::StepperForwardEulerAppAction< Scalar >::execute ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Teuchos::RCP< StepperForwardEuler< Scalar > >  stepper,
const typename StepperForwardEulerAppAction< Scalar >::ACTION_LOCATION  actLoc 
pure virtual

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