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

StepperOperatorSplitAppAction class for StepperOperatorSplit. More...

#include <Tempus_StepperOperatorSplitAppAction.hpp>

Inheritance diagram for Tempus::StepperOperatorSplitAppAction< Scalar >:
Tempus::StepperOperatorSplitAppActionComposite< Scalar > Tempus::StepperOperatorSplitModifierBase< Scalar > Tempus::StepperOperatorSplitModifierXBase< Scalar > Tempus::StepperOperatorSplitObserverBase< Scalar > Tempus::StepperOperatorSplitModifierDefault< Scalar > Tempus::StepperOperatorSplitModifierXDefault< Scalar > Tempus::StepperOperatorSplitObserverDefault< Scalar >

Public Types

enum  ACTION_LOCATION { BEGIN_STEP, BEFORE_STEPPER, AFTER_STEPPER, END_STEP }
 

Public Member Functions

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

Detailed Description

template<class Scalar>
class Tempus::StepperOperatorSplitAppAction< Scalar >

StepperOperatorSplitAppAction class for StepperOperatorSplit.

This class provides a means to apply various actions with the OperatorSplit 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 (StepperOperatorSplitAppAction::ACTION_LOCATION) are shown in the algorithm documentation of the StepperOperatorSplit.

Design Considerations

Definition at line 40 of file Tempus_StepperOperatorSplitAppAction.hpp.

Member Enumeration Documentation

Enumerator
BEGIN_STEP 

At the beginning of the step.

BEFORE_STEPPER 

Before a stepper evaluation.

AFTER_STEPPER 

After a stepper evaluation.

END_STEP 

At the end of the step.

Definition at line 42 of file Tempus_StepperOperatorSplitAppAction.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 50 of file Tempus_StepperOperatorSplitAppAction.hpp.

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

Destructor.

Definition at line 53 of file Tempus_StepperOperatorSplitAppAction.hpp.

Member Function Documentation

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

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