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

Base modifier for StepperRK. More...

#include <Tempus_StepperRKModifierBase.hpp>

Inheritance diagram for Tempus::StepperRKModifierBase< Scalar >:
Tempus::StepperRKAppAction< Scalar > Tempus::StepperRKModifierDefault< Scalar >

Public Member Functions

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

Private Member Functions

void execute (Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperRKBase< Scalar > > stepper, const typename StepperRKAppAction< Scalar >::ACTION_LOCATION actLoc)
 Execute application action for RK Stepper.
 

Additional Inherited Members

- 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::StepperRKModifierBase< Scalar >

Base modifier for StepperRK.

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 of the RK AppActions (StepperRKAppAction::ACTION_LOCATION) in takeStep are documented in each of the RK Algorithm sections: StepperExplicitRK, StepperDIRK and StepperIMEX_RK.

Definition at line 40 of file Tempus_StepperRKModifierBase.hpp.

Member Function Documentation

◆ execute()

template<class Scalar >
void Tempus::StepperRKModifierBase< Scalar >::execute ( Teuchos::RCP< SolutionHistory< Scalar > > sh,
Teuchos::RCP< StepperRKBase< Scalar > > stepper,
const typename StepperRKAppAction< Scalar >::ACTION_LOCATION actLoc )
inlineprivatevirtual

Execute application action for RK Stepper.

Implements Tempus::StepperRKAppAction< Scalar >.

Definition at line 54 of file Tempus_StepperRKModifierBase.hpp.

◆ modify()

template<class Scalar >
virtual void Tempus::StepperRKModifierBase< Scalar >::modify ( Teuchos::RCP< SolutionHistory< Scalar > > ,
Teuchos::RCP< StepperRKBase< Scalar > > ,
const typename StepperRKAppAction< Scalar >::ACTION_LOCATION actLoc )
pure virtual

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