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

Base ModifierX for StepperSubcycling. More...

#include <Tempus_StepperSubcyclingModifierXBase.hpp>

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

Public Types

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...
 

Public Member Functions

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...
 

Private Member Functions

void execute (Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperSubcycling< Scalar > > stepper, const typename StepperSubcyclingAppAction< Scalar >::ACTION_LOCATION actLoc)
 Execute application action for Subcycling Stepper. More...
 

Detailed Description

template<class Scalar>
class Tempus::StepperSubcyclingModifierXBase< Scalar >

Base ModifierX for StepperSubcycling.

This class provides a means to modify just the solution values (i.e., $x$ and $dot{x}$), and nothing else, but time and timestep are also provided.

Users deriving from this class can access and change the solution during the timestep (e.g., limiting the solution for monoticity). It is expected that the user knows what changes are allowable without affecting the Stepper correctness, performance, accuracy and stability (i.e., USER BEWARE!!).

Below is the Subcycling algorithm with the locations of the ModifierX calls italicized.

\begin{algorithm} \renewcommand{\thealgorithm}{} \caption{Subcycling with the locations of the application actions indicated} \begin{algorithmic}[1] \State ToDO \end{algorithmic} \end{algorithm}

Definition at line 44 of file Tempus_StepperSubcyclingModifierXBase.hpp.

Member Enumeration Documentation

template<class Scalar>
enum Tempus::StepperSubcyclingModifierXBase::MODIFIER_TYPE

Indicates the location of application action (see algorithm).

Enumerator
X_BEGIN_STEP 

Modify $x$ at the beginning of the step.

XDOT_END_STEP 

Modify $\dot{x}$ at the end of the step.

Definition at line 99 of file Tempus_StepperSubcyclingModifierXBase.hpp.

Member Function Documentation

template<class Scalar>
void Tempus::StepperSubcyclingModifierXBase< Scalar >::execute ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Teuchos::RCP< StepperSubcycling< Scalar > >  stepper,
const typename StepperSubcyclingAppAction< Scalar >::ACTION_LOCATION  actLoc 
)
inlineprivatevirtual

Execute application action for Subcycling Stepper.

Implements Tempus::StepperSubcyclingAppAction< Scalar >.

Definition at line 62 of file Tempus_StepperSubcyclingModifierXBase.hpp.

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

Modify solution based on the MODIFIER_TYPE.

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