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

Default ModifierX for StepperSubcycling. More...

#include <Tempus_StepperSubcyclingModifierXDefault.hpp>

Inheritance diagram for Tempus::StepperSubcyclingModifierXDefault< Scalar >:
Tempus::StepperSubcyclingModifierXBase< Scalar > Tempus::StepperSubcyclingAppAction< Scalar >

Public Member Functions

 StepperSubcyclingModifierXDefault ()
 Constructor. More...
 
virtual ~StepperSubcyclingModifierXDefault ()
 Destructor. More...
 
virtual void modify (Teuchos::RCP< Thyra::VectorBase< Scalar > >, const Scalar, const Scalar, const typename StepperSubcyclingModifierXBase< Scalar >::MODIFIER_TYPE modType)
 Modify solution based on the MODIFIER_TYPE. More...
 
- Public Member Functions inherited from Tempus::StepperSubcyclingModifierXBase< Scalar >
virtual void modify (Teuchos::RCP< Thyra::VectorBase< Scalar > >, const Scalar, const Scalar, const MODIFIER_TYPE modType)=0
 Modify solution based on the MODIFIER_TYPE. More...
 
- Public Member Functions inherited from Tempus::StepperSubcyclingAppAction< Scalar >
 StepperSubcyclingAppAction ()
 Constructor. More...
 
virtual ~StepperSubcyclingAppAction ()
 Destructor. More...
 

Additional Inherited Members

- Public Types inherited from Tempus::StepperSubcyclingModifierXBase< Scalar >
enum  MODIFIER_TYPE { X_BEGIN_STEP, XDOT_END_STEP }
 Indicates the location of application action (see algorithm). More...
 
- Public Types inherited from Tempus::StepperSubcyclingAppAction< Scalar >
enum  ACTION_LOCATION { BEGIN_STEP, END_STEP }
 Indicates the location of application action (see algorithm). More...
 

Detailed Description

template<class Scalar>
class Tempus::StepperSubcyclingModifierXDefault< Scalar >

Default ModifierX for StepperSubcycling.

The default provides no-op functionality for ModifierX. See StepperSubcyclingModifierXBase for details on the algorithm.

Applications can copy this implementation, rename, implement their action, and set on the stepper to get app-specific functionality.

Definition at line 27 of file Tempus_StepperSubcyclingModifierXDefault.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 33 of file Tempus_StepperSubcyclingModifierXDefault.hpp.

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

Destructor.

Definition at line 36 of file Tempus_StepperSubcyclingModifierXDefault.hpp.

Member Function Documentation

template<class Scalar >
virtual void Tempus::StepperSubcyclingModifierXDefault< Scalar >::modify ( Teuchos::RCP< Thyra::VectorBase< Scalar > >  ,
const Scalar  ,
const Scalar  ,
const typename StepperSubcyclingModifierXBase< Scalar >::MODIFIER_TYPE  modType 
)
inlinevirtual

Modify solution based on the MODIFIER_TYPE.

Definition at line 39 of file Tempus_StepperSubcyclingModifierXDefault.hpp.

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