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

Base ModifierX for StepperBackwardEuler. More...

#include <Tempus_StepperBackwardEulerModifierXBase.hpp>

Inheritance diagram for Tempus::StepperBackwardEulerModifierXBase< Scalar >:
Tempus::StepperBackwardEulerAppAction< Scalar > Tempus::StepperBackwardEulerModifierXDefault< Scalar >

Public Types

enum  MODIFIER_TYPE { X_BEGIN_STEP, X_BEFORE_SOLVE, X_AFTER_SOLVE, XDOT_END_STEP }
 Indicates the location of application action (see algorithm). More...
 
- Public Types inherited from Tempus::StepperBackwardEulerAppAction< Scalar >
enum  ACTION_LOCATION { BEGIN_STEP, BEFORE_SOLVE, AFTER_SOLVE, END_STEP }
 Indicates the location of application action (see algorithm). More...
 

Public Member Functions

virtual void modify (Teuchos::RCP< Thyra::VectorBase< Scalar > >, const Scalar, const Scalar, const MODIFIER_TYPE modType)=0
 Modify solution based on the MODIFIER_TYPE. More...
 
- Public Member Functions inherited from Tempus::StepperBackwardEulerAppAction< Scalar >
 StepperBackwardEulerAppAction ()
 Constructor. More...
 
virtual ~StepperBackwardEulerAppAction ()
 Destructor. More...
 

Private Member Functions

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

Detailed Description

template<class Scalar>
class Tempus::StepperBackwardEulerModifierXBase< Scalar >

Base ModifierX for StepperBackwardEuler.

This class provides a means to modify just the solution values (i.e., $x$ and $dot{x}$), and nothing else, but time and timestep are also provided.

Users deriving from this class can access and change the solution during the timestep (e.g., limiting the solution for monoticity). It is expected that the user knows what changes are allowable without affecting the Stepper correctness, performance, accuracy and stability (i.e., USER BEWARE!!).

Below is the BackwardEuler algorithm with the locations of the ModifierX calls italicized.

\begin{algorithm} \renewcommand{\thealgorithm}{} \caption{Backward Euler with modify calls indicated.} \begin{algorithmic}[1] \State \quad {\it modifierX.modify(x, time, dt, X\_BEGIN\_STEP)} \State Compute the predictor (e.g., apply stepper to $x_n$). \State \quad {\it modifierX.modify(x, time, dt, X\_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 \quad {\it modifierX.modify(x, time, dt, X\_AFTER\_SOLVE)} \State $\dot{x}_n \leftarrow (x_n-x_{n-1})/\Delta t_n$ \State \quad {\it modifierX.modify(x, time, dt, XDOT\_END\_STEP)} \end{algorithmic} \end{algorithm}

Definition at line 49 of file Tempus_StepperBackwardEulerModifierXBase.hpp.

Member Enumeration Documentation

template<class Scalar>
enum Tempus::StepperBackwardEulerModifierXBase::MODIFIER_TYPE

Indicates the location of application action (see algorithm).

Enumerator
X_BEGIN_STEP 

Modify $x$ at the beginning of the step.

X_BEFORE_SOLVE 

Modify $x$ before the implicit solve.

X_AFTER_SOLVE 

Modify $x$ after the implicit solve.

XDOT_END_STEP 

Modify $\dot{x}$ at the end of the step.

Definition at line 116 of file Tempus_StepperBackwardEulerModifierXBase.hpp.

Member Function Documentation

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

Execute application action for BackwardEuler Stepper.

Implements Tempus::StepperBackwardEulerAppAction< Scalar >.

Definition at line 67 of file Tempus_StepperBackwardEulerModifierXBase.hpp.

template<class Scalar>
virtual void Tempus::StepperBackwardEulerModifierXBase< Scalar >::modify ( Teuchos::RCP< Thyra::VectorBase< Scalar > >  ,
const Scalar  ,
const Scalar  ,
const MODIFIER_TYPE  modType 
)
pure virtual

Modify solution based on the MODIFIER_TYPE.

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