Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Tempus::StepperSubcyclingModifierBase< Scalar > Class Template Referenceabstract

Base modifier for StepperSubcycling. More...

#include <Tempus_StepperSubcyclingModifierBase.hpp>

Inheritance diagram for Tempus::StepperSubcyclingModifierBase< Scalar >:
Tempus::StepperSubcyclingAppAction< Scalar > Tempus::StepperSubcyclingModifierDefault< Scalar >

Public Member Functions

virtual void modify (Teuchos::RCP< SolutionHistory< Scalar > >, Teuchos::RCP< StepperSubcycling< Scalar > >, const typename StepperSubcyclingAppAction< Scalar >::ACTION_LOCATION actLoc)=0
 Modify Subcycling Stepper. 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...
 

Additional Inherited Members

- Public Types inherited from Tempus::StepperSubcyclingAppAction< Scalar >
enum  ACTION_LOCATION { BEGIN_STEP, END_STEP }
 Indicates the location of application action (see algorithm). More...
 

Detailed Description

template<class Scalar>
class Tempus::StepperSubcyclingModifierBase< Scalar >

Base modifier for StepperSubcycling.

This class provides a means to modify values (e.g., solution variables through SolutionHistory, and stepper member data through the Stepper), and can be very powerful and easy to make changes to the stepper and the solution.

Users deriving from this class can access a lot of data, and it is expected that those users know what changes are allowable without affecting the Stepper correctness, performance, accuracy and stability. Thus the user should be careful when accessing data through classes derived from the default modifier (i.e., USER BEWARE!!).

\begin{algorithm} \renewcommand{\thealgorithm}{} \caption{Subcycling with the locations of the application actions indicated.} \begin{algorithmic}[1] \State {\it appAction.execute(solutionHistory, stepper, BEGIN\_STEP)} \State Compute $x_{n}$ from $x_{n-1}$, applying appActions from sub-steppers \State {\it appAction.execute(solutionHistory, stepper, END\_STEP)} \end{algorithmic} \end{algorithm}

Definition at line 43 of file Tempus_StepperSubcyclingModifierBase.hpp.

Member Function Documentation

template<class Scalar>
void Tempus::StepperSubcyclingModifierBase< 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 57 of file Tempus_StepperSubcyclingModifierBase.hpp.

template<class Scalar>
virtual void Tempus::StepperSubcyclingModifierBase< Scalar >::modify ( Teuchos::RCP< SolutionHistory< Scalar > >  ,
Teuchos::RCP< StepperSubcycling< Scalar > >  ,
const typename StepperSubcyclingAppAction< Scalar >::ACTION_LOCATION  actLoc 
)
pure virtual

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