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

Application Action for StepperSubcycling. More...

#include <Tempus_StepperSubcyclingAppAction.hpp>

Inheritance diagram for Tempus::StepperSubcyclingAppAction< Scalar >:
Tempus::StepperSubcyclingAppActionComposite< Scalar > Tempus::StepperSubcyclingModifierBase< Scalar > Tempus::StepperSubcyclingModifierXBase< Scalar > Tempus::StepperSubcyclingObserverBase< Scalar > Tempus::StepperSubcyclingModifierDefault< Scalar > Tempus::StepperSubcyclingModifierXDefault< Scalar > Tempus::StepperSubcyclingObserverDefault< Scalar >

Public Types

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

Public Member Functions

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

Detailed Description

template<class Scalar>
class Tempus::StepperSubcyclingAppAction< Scalar >

Application Action for StepperSubcycling.

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

\begin{algorithm} \renewcommand{\thealgorithm}{} \caption{Subcyling with the locations of the application actions indicated.} \begin{algorithmic}[1] \State {\it appAction.execute(solutionHistory, stepper, BEGIN\_STEP)} \State Compute $x_{n}$ from $x_{n-1}$, applying appActions from sub-steppers \State {\it appAction.execute(solutionHistory, stepper, END\_STEP)} \end{algorithmic} \end{algorithm}

Definition at line 43 of file Tempus_StepperSubcyclingAppAction.hpp.

Member Enumeration Documentation

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

Indicates the location of application action (see algorithm).

Enumerator
BEGIN_STEP 

At the beginning of the step.

END_STEP 

At the end of the step.

Definition at line 48 of file Tempus_StepperSubcyclingAppAction.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 54 of file Tempus_StepperSubcyclingAppAction.hpp.

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

Destructor.

Definition at line 57 of file Tempus_StepperSubcyclingAppAction.hpp.

Member Function Documentation

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

Execute application action for Subcycling Stepper.

Implemented in Tempus::StepperSubcyclingModifierXBase< Scalar >, Tempus::StepperSubcyclingModifierXBase< double >, Tempus::StepperSubcyclingObserverBase< Scalar >, Tempus::StepperSubcyclingObserverBase< double >, Tempus::StepperSubcyclingModifierBase< Scalar >, Tempus::StepperSubcyclingModifierBase< double >, and Tempus::StepperSubcyclingAppActionComposite< Scalar >.

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