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

Application Action for StepperRKBase. More...

#include <Tempus_StepperRKAppAction.hpp>

Inheritance diagram for Tempus::StepperRKAppAction< Scalar >:
Tempus::StepperRKAppActionComposite< Scalar > Tempus::StepperRKModifierBase< Scalar > Tempus::StepperRKModifierXBase< Scalar > Tempus::StepperRKObserverBase< Scalar > Tempus::StepperRKModifierDefault< Scalar > Tempus::StepperRKModifierXDefault< Scalar > Tempus::StepperRKObserverDefault< Scalar >

Public Types

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...
 

Public Member Functions

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

Detailed Description

template<class Scalar>
class Tempus::StepperRKAppAction< Scalar >

Application Action for StepperRKBase.

This class provides a means to apply various actions with the RK 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!).

The locations of the RK AppActions (ACTION_LOCATION) in takeStep are documented in each of the RK Algorithm sections: StepperExplicitRK, StepperDIRK and StepperIMEX_RK.

Definition at line 35 of file Tempus_StepperRKAppAction.hpp.

Member Enumeration Documentation

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

Indicates the location of application action (see algorithm).

Enumerator
BEGIN_STEP 

At the beginning of the step.

BEGIN_STAGE 

At the beginning of the stage.

BEFORE_SOLVE 

Before the implicit solve.

AFTER_SOLVE 

After the implicit solve.

BEFORE_EXPLICIT_EVAL 

Before the explicit evaluation.

END_STAGE 

At the end of the stage.

END_STEP 

At the end of the step.

Definition at line 40 of file Tempus_StepperRKAppAction.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 51 of file Tempus_StepperRKAppAction.hpp.

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

Destructor.

Definition at line 54 of file Tempus_StepperRKAppAction.hpp.

Member Function Documentation

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

Execute application action for RK Stepper.

Implemented in Tempus::StepperRKModifierXBase< Scalar >, Tempus::StepperRKModifierXBase< double >, Tempus::StepperRKModifierBase< Scalar >, Tempus::StepperRKModifierBase< double >, Tempus::StepperRKObserverBase< Scalar >, Tempus::StepperRKObserverBase< double >, and Tempus::StepperRKAppActionComposite< Scalar >.

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