Tempus::StepperSubcyclingAppAction< Scalar > Class Template Reference

Application Action for StepperSubcycling. More...

#include <Tempus_StepperSubcyclingAppAction.hpp>

Inheritance diagram for Tempus::StepperSubcyclingAppAction< Scalar >:

Public Types
enum	ACTION_LOCATION { BEGIN_STEP, END_STEP }
	Indicates the location of application action (see algorithm). More...

Public Member Functions
	StepperSubcyclingAppAction ()
	Constructor. More...
virtual	~StepperSubcyclingAppAction ()
	Destructor. More...
virtual void	execute (Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperSubcycling< Scalar > > stepper, const typename StepperSubcyclingAppAction< Scalar >::ACTION_LOCATION actLoc)=0
	Execute application action for Subcycling Stepper. More...

Detailed Description

template<class Scalar>
class Tempus::StepperSubcyclingAppAction< Scalar >

Application Action for StepperSubcycling.

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

Definition at line 34 of file Tempus_StepperSubcyclingAppAction.hpp.

Member Enumeration Documentation

template<class Scalar>

enum Tempus::StepperSubcyclingAppAction::ACTION_LOCATION

Indicates the location of application action (see algorithm).

Enumerator
BEGIN_STEP	At the beginning of the step.
END_STEP	At the end of the step.

Definition at line 39 of file Tempus_StepperSubcyclingAppAction.hpp.

Constructor & Destructor Documentation

template<class Scalar>

Tempus::StepperSubcyclingAppAction< Scalar >::StepperSubcyclingAppAction ( )

inline

Constructor.

Definition at line 45 of file Tempus_StepperSubcyclingAppAction.hpp.

template<class Scalar>

virtual Tempus::StepperSubcyclingAppAction< Scalar >::~StepperSubcyclingAppAction ( )

inlinevirtual

Destructor.

Definition at line 48 of file Tempus_StepperSubcyclingAppAction.hpp.

Member Function Documentation

template<class Scalar>

virtual void Tempus::StepperSubcyclingAppAction< Scalar >::execute ( Teuchos::RCP< SolutionHistory< Scalar > >  sh, Teuchos::RCP< StepperSubcycling< Scalar > >  stepper, const typename StepperSubcyclingAppAction< Scalar >::ACTION_LOCATION  actLoc  )

pure virtual

Execute application action for Subcycling Stepper.

Implemented in Tempus::StepperSubcyclingModifierXBase< Scalar >, Tempus::StepperSubcyclingModifierXBase< double >, Tempus::StepperSubcyclingModifierBase< Scalar >, Tempus::StepperSubcyclingModifierBase< double >, Tempus::StepperSubcyclingObserverBase< Scalar >, Tempus::StepperSubcyclingObserverBase< double >, and Tempus::StepperSubcyclingAppActionComposite< Scalar >.

---

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

• Tempus_StepperSubcyclingAppAction.hpp