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::StepperForwardEulerModifierXDefault< Scalar > Class Template Reference

Default ModifierX for StepperForwardEuler. More...

#include <Tempus_StepperForwardEulerModifierXDefault.hpp>

Inheritance diagram for Tempus::StepperForwardEulerModifierXDefault< Scalar >:
Tempus::StepperForwardEulerModifierXBase< Scalar > Tempus::StepperForwardEulerAppAction< Scalar >

Public Member Functions

 StepperForwardEulerModifierXDefault ()
 Constructor. More...
 
virtual ~StepperForwardEulerModifierXDefault ()
 Destructor. More...
 
virtual void modify (Teuchos::RCP< Thyra::VectorBase< Scalar > >, const Scalar, const Scalar, const typename StepperForwardEulerModifierXBase< Scalar >::MODIFIER_TYPE modType)
 Modify solution based on the MODIFIER_TYPE. More...
 
- Public Member Functions inherited from Tempus::StepperForwardEulerModifierXBase< 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::StepperForwardEulerAppAction< Scalar >
 StepperForwardEulerAppAction ()
 Constructor. More...
 
virtual ~StepperForwardEulerAppAction ()
 Destructor. More...
 

Additional Inherited Members

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

Detailed Description

template<class Scalar>
class Tempus::StepperForwardEulerModifierXDefault< Scalar >

Default ModifierX for StepperForwardEuler.

The default provides no-op functionality for ModifierX. See StepperForwardEulerModifierXBase 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_StepperForwardEulerModifierXDefault.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 33 of file Tempus_StepperForwardEulerModifierXDefault.hpp.

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

Destructor.

Definition at line 36 of file Tempus_StepperForwardEulerModifierXDefault.hpp.

Member Function Documentation

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

Modify solution based on the MODIFIER_TYPE.

Definition at line 39 of file Tempus_StepperForwardEulerModifierXDefault.hpp.

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