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

Default ModifierX for StepperRK. More...

#include <Tempus_StepperRKModifierXDefault.hpp>

Inheritance diagram for Tempus::StepperRKModifierXDefault< Scalar >:
Tempus::StepperRKModifierXBase< Scalar > Tempus::StepperRKAppAction< Scalar >

Public Member Functions

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

Additional Inherited Members

- Public Types inherited from Tempus::StepperRKModifierXBase< Scalar >
enum  MODIFIER_TYPE {
  X_BEGIN_STEP, X_BEGIN_STAGE, X_BEFORE_SOLVE, X_AFTER_SOLVE,
  X_BEFORE_EXPLICIT_EVAL, X_END_STAGE, X_END_STEP
}
 Indicates the location of application action (see algorithm). More...
 
- Public Types inherited from Tempus::StepperRKAppAction< Scalar >
enum  ACTION_LOCATION {
  BEGIN_STEP, BEGIN_STAGE, BEFORE_SOLVE, AFTER_SOLVE,
  BEFORE_EXPLICIT_EVAL, END_STAGE, END_STEP
}
 Indicates the location of application action (see algorithm). More...
 

Detailed Description

template<class Scalar>
class Tempus::StepperRKModifierXDefault< Scalar >

Default ModifierX for StepperRK.

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

Constructor & Destructor Documentation

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

Constructor.

Definition at line 33 of file Tempus_StepperRKModifierXDefault.hpp.

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

Destructor.

Definition at line 36 of file Tempus_StepperRKModifierXDefault.hpp.

Member Function Documentation

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

Modify solution based on the MODIFIER_TYPE.

Definition at line 39 of file Tempus_StepperRKModifierXDefault.hpp.

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