Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Tempus::StepperHHTAlphaModifierXDefault< Scalar > Class Template Reference

Default ModifierX for StepperHHTAlpha. More...

#include <Tempus_StepperHHTAlphaModifierXDefault.hpp>

Inheritance diagram for Tempus::StepperHHTAlphaModifierXDefault< Scalar >:
Tempus::StepperHHTAlphaModifierXBase< Scalar > Tempus::StepperHHTAlphaAppAction< Scalar >

Public Member Functions

 StepperHHTAlphaModifierXDefault ()
 Constructor.
 
virtual ~StepperHHTAlphaModifierXDefault ()
 Destructor.
 
virtual void modify (Teuchos::RCP< Thyra::VectorBase< Scalar > >, const Scalar, const Scalar, const typename StepperHHTAlphaModifierXBase< Scalar >::MODIFIER_TYPE modType)
 Modify solution based on the MODIFIER_TYPE.
 
- Public Member Functions inherited from Tempus::StepperHHTAlphaModifierXBase< 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.
 
- Public Member Functions inherited from Tempus::StepperHHTAlphaAppAction< Scalar >
 StepperHHTAlphaAppAction ()
 Constructor.
 
virtual ~StepperHHTAlphaAppAction ()
 Destructor.
 
virtual void execute (Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperHHTAlpha< Scalar > > stepper, const typename StepperHHTAlphaAppAction< Scalar >::ACTION_LOCATION actLoc)=0
 Execute application action for HHTAlpha Stepper.
 

Additional Inherited Members

- Public Types inherited from Tempus::StepperHHTAlphaModifierXBase< Scalar >
enum  MODIFIER_TYPE { X_BEGIN_STEP , X_BEFORE_SOLVE , X_AFTER_SOLVE , X_END_STEP }
 Indicates the location of application action (see algorithm). More...
 
- Public Types inherited from Tempus::StepperHHTAlphaAppAction< 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::StepperHHTAlphaModifierXDefault< Scalar >

Default ModifierX for StepperHHTAlpha.

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

Constructor & Destructor Documentation

◆ StepperHHTAlphaModifierXDefault()

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

Constructor.

Definition at line 33 of file Tempus_StepperHHTAlphaModifierXDefault.hpp.

◆ ~StepperHHTAlphaModifierXDefault()

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

Destructor.

Definition at line 36 of file Tempus_StepperHHTAlphaModifierXDefault.hpp.

Member Function Documentation

◆ modify()

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

Modify solution based on the MODIFIER_TYPE.

Definition at line 39 of file Tempus_StepperHHTAlphaModifierXDefault.hpp.


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