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::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 is a means for application developers to perform tasks during the time steps, e.g.,

  • Compute specific quantities
  • Output information
  • "Massage" the working solution state
  • ...

Design Considerations

  • StepperOperatorSplitAppAction is not stateless! Developers may touch the solution state! Developers need to be careful not to break the restart (checkpoint) capability.

Definition at line 36 of file Tempus_StepperOperatorSplitAppAction.hpp.

Member Enumeration Documentation

template<class Scalar>
enum Tempus::StepperOperatorSplitAppAction::ACTION_LOCATION
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 40 of file Tempus_StepperOperatorSplitAppAction.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 48 of file Tempus_StepperOperatorSplitAppAction.hpp.

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

Destructor.

Definition at line 51 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

Execute application action for OperatorSplit Stepper.

Implemented in Tempus::StepperOperatorSplitModifierXBase< Scalar >, Tempus::StepperOperatorSplitModifierXBase< double >, Tempus::StepperOperatorSplitObserverBase< Scalar >, Tempus::StepperOperatorSplitObserverBase< double >, Tempus::StepperOperatorSplitModifierBase< Scalar >, Tempus::StepperOperatorSplitModifierBase< double >, and Tempus::StepperOperatorSplitAppActionComposite< Scalar >.

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