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

Base modifier for OperatorSplit. More...

#include <Tempus_StepperOperatorSplitModifierBase.hpp>

Inheritance diagram for Tempus::StepperOperatorSplitModifierBase< Scalar >:
Tempus::StepperOperatorSplitAppAction< Scalar > Tempus::StepperOperatorSplitModifierDefault< Scalar >

Public Member Functions

virtual void modify (Teuchos::RCP< SolutionHistory< Scalar > >, Teuchos::RCP< StepperOperatorSplit< Scalar > >, const typename StepperOperatorSplitAppAction< Scalar >::ACTION_LOCATION actLoc)=0
 Modify OperatorSplit Stepper. More...
 
- Public Member Functions inherited from Tempus::StepperOperatorSplitAppAction< Scalar >
 StepperOperatorSplitAppAction ()
 Constructor. More...
 
virtual ~StepperOperatorSplitAppAction ()
 Destructor. More...
 

Private Member Functions

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

Additional Inherited Members

- Public Types inherited from Tempus::StepperOperatorSplitAppAction< Scalar >
enum  ACTION_LOCATION { BEGIN_STEP, BEFORE_STEPPER, AFTER_STEPPER, END_STEP }
 

Detailed Description

template<class Scalar>
class Tempus::StepperOperatorSplitModifierBase< Scalar >

Base modifier for OperatorSplit.

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

The locations for these AppAction calls (StepperOperatorSplitAppAction::ACTION_LOCATION) are shown in the algorithm documentation of the StepperOperatorSplit.

Definition at line 36 of file Tempus_StepperOperatorSplitModifierBase.hpp.

Member Function Documentation

template<class Scalar>
void Tempus::StepperOperatorSplitModifierBase< Scalar >::execute ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Teuchos::RCP< StepperOperatorSplit< Scalar > >  stepper,
const typename StepperOperatorSplitAppAction< Scalar >::ACTION_LOCATION  actLoc 
)
inlineprivatevirtual

Execute application action for OperatorSplit Stepper.

Implements Tempus::StepperOperatorSplitAppAction< Scalar >.

Definition at line 48 of file Tempus_StepperOperatorSplitModifierBase.hpp.

template<class Scalar>
virtual void Tempus::StepperOperatorSplitModifierBase< Scalar >::modify ( Teuchos::RCP< SolutionHistory< Scalar > >  ,
Teuchos::RCP< StepperOperatorSplit< Scalar > >  ,
const typename StepperOperatorSplitAppAction< Scalar >::ACTION_LOCATION  actLoc 
)
pure virtual

Modify OperatorSplit Stepper.

Implemented in Tempus::StepperOperatorSplitModifierDefault< Scalar >.


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