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

Base modifier for StepperRK. More...

#include <Tempus_StepperRKModifierBase.hpp>

Inheritance diagram for Tempus::StepperRKModifierBase< Scalar >:
Tempus::StepperRKAppAction< Scalar > Tempus::StepperRKModifierDefault< Scalar >

Public Member Functions

virtual void modify (Teuchos::RCP< SolutionHistory< Scalar > >, Teuchos::RCP< StepperRKBase< Scalar > >, const typename StepperRKAppAction< Scalar >::ACTION_LOCATION actLoc)=0
 Modify RK Stepper. More...
 
- Public Member Functions inherited from Tempus::StepperRKAppAction< Scalar >
 StepperRKAppAction ()
 Constructor. More...
 
virtual ~StepperRKAppAction ()
 Destructor. More...
 

Private Member Functions

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

Additional Inherited Members

- Public Types inherited from Tempus::StepperRKAppAction< Scalar >
enum  ACTION_LOCATION {
  BEGIN_STEP, BEGIN_STAGE, BEFORE_SOLVE, AFTER_SOLVE,
  BEFORE_EXPLICIT_EVAL, END_STAGE, END_STEP
}
 Indicates the location of application action (see algorithm). More...
 

Detailed Description

template<class Scalar>
class Tempus::StepperRKModifierBase< Scalar >

Base modifier for StepperRK.

This class provides a means to modify values (e.g., solution variables through SolutionHistory, and stepper member data through the Stepper), and can be very powerful and easy to make changes to the stepper and the solution.

Users deriving from this class can access a lot of data, and it is expected that those users know what changes are allowable without affecting the Stepper correctness, performance, accuracy and stability. Thus the user should be careful when accessing data through classes derived from the default modifier (i.e., USER RKWARE!!).

Below is the RK algorithm with the locations of the modify calls italicized.

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

Definition at line 51 of file Tempus_StepperRKModifierBase.hpp.

Member Function Documentation

template<class Scalar>
void Tempus::StepperRKModifierBase< Scalar >::execute ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Teuchos::RCP< StepperRKBase< Scalar > >  stepper,
const typename StepperRKAppAction< Scalar >::ACTION_LOCATION  actLoc 
)
inlineprivatevirtual

Execute application action for RK Stepper.

Implements Tempus::StepperRKAppAction< Scalar >.

Definition at line 65 of file Tempus_StepperRKModifierBase.hpp.

template<class Scalar>
virtual void Tempus::StepperRKModifierBase< Scalar >::modify ( Teuchos::RCP< SolutionHistory< Scalar > >  ,
Teuchos::RCP< StepperRKBase< Scalar > >  ,
const typename StepperRKAppAction< Scalar >::ACTION_LOCATION  actLoc 
)
pure virtual

Modify RK Stepper.

Implemented in Tempus_Unit_Test::StepperRKModifierTest, and Tempus::StepperRKModifierDefault< Scalar >.

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