Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
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::StepperRKModifierBase< double > Tempus::StepperRKModifierXBase< double > Tempus::StepperRKObserverBase< double > Tempus::StepperRKAppActionComposite< Scalar > Tempus::StepperRKModifierBase< Scalar > Tempus::StepperRKModifierXBase< Scalar > Tempus::StepperRKObserverBase< Scalar > Tempus_Unit_Test::StepperRKModifierTest Tempus_Unit_Test::StepperRKModifierXTest Tempus_Unit_Test::StepperRKObserverTest 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.
 
virtual ~StepperRKAppAction ()
 Destructor.
 
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.
 

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 any of it (USER BEWARE!).

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

Definition at line 34 of file Tempus_StepperRKAppAction.hpp.

Member Enumeration Documentation

◆ ACTION_LOCATION

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 39 of file Tempus_StepperRKAppAction.hpp.

Constructor & Destructor Documentation

◆ StepperRKAppAction()

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

Constructor.

Definition at line 50 of file Tempus_StepperRKAppAction.hpp.

◆ ~StepperRKAppAction()

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

Destructor.

Definition at line 53 of file Tempus_StepperRKAppAction.hpp.

Member Function Documentation

◆ execute()

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

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