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

Application Action for StepperLeapfrog. More...

#include <Tempus_StepperLeapfrogAppAction.hpp>

Inheritance diagram for Tempus::StepperLeapfrogAppAction< Scalar >:
Tempus::StepperLeapfrogAppActionComposite< Scalar > Tempus::StepperLeapfrogModifierBase< Scalar > Tempus::StepperLeapfrogModifierXBase< Scalar > Tempus::StepperLeapfrogObserverBase< Scalar > Tempus::StepperLeapfrogModifierDefault< Scalar > Tempus::StepperLeapfrogModifierXDefault< Scalar > Tempus::StepperLeapfrogObserverDefault< Scalar >

Public Types

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

Public Member Functions

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

Detailed Description

template<class Scalar>
class Tempus::StepperLeapfrogAppAction< Scalar >

Application Action for StepperLeapfrog.

This class provides a means to apply various actions with the Leapfrog 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 for these AppAction calls (StepperLeapfrogAppAction::ACTION_LOCATION) are shown in the algorithm documentation of the StepperLeapfrog.

Definition at line 35 of file Tempus_StepperLeapfrogAppAction.hpp.

Member Enumeration Documentation

Indicates the location of application action (see algorithm).

Enumerator
BEGIN_STEP 

At the beginning of the step.

BEFORE_X_UPDATE 

Before updating x.

BEFORE_EXPLICIT_EVAL 

Before the explicit ME evaluation.

BEFORE_XDOT_UPDATE 

Before updating xDot.

END_STEP 

At the end of the step.

Definition at line 38 of file Tempus_StepperLeapfrogAppAction.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 47 of file Tempus_StepperLeapfrogAppAction.hpp.

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

Destructor.

Definition at line 50 of file Tempus_StepperLeapfrogAppAction.hpp.

Member Function Documentation

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

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