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::StepperBackwardEulerAppAction< Scalar > Class Template Referenceabstract

Application Action for StepperBackwardEuler. More...

#include <Tempus_StepperBackwardEulerAppAction.hpp>

Inheritance diagram for Tempus::StepperBackwardEulerAppAction< Scalar >:
Tempus::StepperBackwardEulerAppActionComposite< Scalar > Tempus::StepperBackwardEulerModifierBase< Scalar > Tempus::StepperBackwardEulerModifierXBase< Scalar > Tempus::StepperBackwardEulerObserverBase< Scalar > Tempus::StepperBackwardEulerModifierDefault< Scalar > Tempus::StepperBackwardEulerModifierXDefault< Scalar > Tempus::StepperBackwardEulerObserverDefault< Scalar >

Public Types

enum  ACTION_LOCATION { BEGIN_STEP, BEFORE_SOLVE, AFTER_SOLVE, END_STEP }
 Indicates the location of application action (see algorithm). More...
 

Public Member Functions

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

Detailed Description

template<class Scalar>
class Tempus::StepperBackwardEulerAppAction< Scalar >

Application Action for StepperBackwardEuler.

This class provides a means to apply various actions with the BackwardEuler 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 BackwardEuler algorithm and includes the locations where the application can take actions (in italicized).

\begin{algorithm} \renewcommand{\thealgorithm}{} \caption{Backward Euler with application-action locations indicated.} \begin{algorithmic}[1] \State {\it appAction.execute(solutionHistory, stepper, BEGIN\_STEP)} \State Compute the predictor (e.g., apply stepper to $x_n$). \State {\it appAction.execute(solutionHistory, stepper, BEFORE\_SOLVE)} \State Solve $\mathcal{F}_n(\dot{x}=(x_n-x_{n-1})/\Delta t_n, x_n, t_n)=0$ for $x_n$ \State {\it appAction.execute(solutionHistory, stepper, AFTER\_SOLVE)} \State $\dot{x}_n \leftarrow (x_n-x_{n-1})/\Delta t_n$ \State {\it appAction.execute(solutionHistory, stepper, END\_STEP)} \end{algorithmic} \end{algorithm}

Definition at line 47 of file Tempus_StepperBackwardEulerAppAction.hpp.

Member Enumeration Documentation

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

Indicates the location of application action (see algorithm).

Enumerator
BEGIN_STEP 

At the beginning of the step.

BEFORE_SOLVE 

Before the implicit solve.

AFTER_SOLVE 

After the implicit solve.

END_STEP 

At the end of the step.

Definition at line 52 of file Tempus_StepperBackwardEulerAppAction.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 60 of file Tempus_StepperBackwardEulerAppAction.hpp.

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

Destructor.

Definition at line 63 of file Tempus_StepperBackwardEulerAppAction.hpp.

Member Function Documentation

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

Execute application action for BackwardEuler Stepper.

Implemented in Tempus::StepperBackwardEulerModifierXBase< Scalar >, Tempus::StepperBackwardEulerModifierXBase< double >, Tempus::StepperBackwardEulerModifierBase< Scalar >, Tempus::StepperBackwardEulerModifierBase< double >, Tempus::StepperBackwardEulerObserverBase< Scalar >, Tempus::StepperBackwardEulerObserverBase< double >, and Tempus::StepperBackwardEulerAppActionComposite< Scalar >.

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