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

Default modifier for StepperRK. More...

#include <Tempus_StepperRKModifierDefault.hpp>

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

Public Member Functions

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

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

Default modifier for StepperRK.

The default modifier provides no-op functionality for the modifier. See StepperRKModifierBase 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 31 of file Tempus_StepperRKModifierDefault.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 37 of file Tempus_StepperRKModifierDefault.hpp.

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

Destructor.

Definition at line 40 of file Tempus_StepperRKModifierDefault.hpp.

Member Function Documentation

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

Modify RK Stepper.

Implements Tempus::StepperRKModifierBase< Scalar >.

Definition at line 43 of file Tempus_StepperRKModifierDefault.hpp.

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