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

Default ModifierX for StepperBackwardEuler. More...

#include <Tempus_StepperBackwardEulerModifierXDefault.hpp>

Inheritance diagram for Tempus::StepperBackwardEulerModifierXDefault< Scalar >:
Tempus::StepperBackwardEulerModifierXBase< Scalar > Tempus::StepperBackwardEulerAppAction< Scalar >

Public Member Functions

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

Additional Inherited Members

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

Detailed Description

template<class Scalar>
class Tempus::StepperBackwardEulerModifierXDefault< Scalar >

Default ModifierX for StepperBackwardEuler.

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

Constructor & Destructor Documentation

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

Constructor.

Definition at line 33 of file Tempus_StepperBackwardEulerModifierXDefault.hpp.

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

Destructor.

Definition at line 36 of file Tempus_StepperBackwardEulerModifierXDefault.hpp.

Member Function Documentation

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

Modify solution based on the MODIFIER_TYPE.

Definition at line 39 of file Tempus_StepperBackwardEulerModifierXDefault.hpp.

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