Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros 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

enum  ACTION_LOCATION { BEGIN_STEP, BEFORE_EXPLICIT_EVAL, END_STEP }
 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 the data) to change any of it (USER BEWARE!).

Below is the ForwardEuler algorithm and includes the locations where the application can take actions (in italicized).

\begin{algorithm} \renewcommand{\thealgorithm}{} \caption{Forward Euler with the locations of the application actions indicated.} \begin{algorithmic}[1] \State Start with $x_n$, $\Delta t_n$ \State {\it appAction.execute(solutionHistory, stepper, BEGIN\_STEP)} \State Form $f(x_{n},t_{n})$ \State {\it appAction.execute(solutionHistory, stepper, BEFORE\_EXPLICIT\_EVAL)} \State Form $x_n \leftarrow x_{n} + \Delta t_n f(x_{n},t_n)$ \State {\it appAction.execute(solutionHistory, stepper, END\_STEP)} \end{algorithmic} \end{algorithm}

Definition at line 46 of file Tempus_StepperForwardEulerAppAction.hpp.

Member Enumeration Documentation

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

Indicates the location of application action (see algorithm).

Enumerator
BEGIN_STEP 

At the beginning of the step.

BEFORE_EXPLICIT_EVAL 

Before the explicit evaluation.

END_STEP 

At the end of the step.

Definition at line 51 of file Tempus_StepperForwardEulerAppAction.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 58 of file Tempus_StepperForwardEulerAppAction.hpp.

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

Destructor.

Definition at line 61 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

Execute application action for ForwardEuler Stepper.

Implemented in Tempus::StepperForwardEulerModifierXBase< Scalar >, Tempus::StepperForwardEulerModifierXBase< double >, Tempus::StepperForwardEulerObserverBase< Scalar >, Tempus::StepperForwardEulerObserverBase< double >, Tempus::StepperForwardEulerModifierBase< Scalar >, Tempus::StepperForwardEulerModifierBase< double >, and Tempus::StepperForwardEulerAppActionComposite< Scalar >.

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