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

Default observer for StepperRK. More...

#include <Tempus_StepperRKObserverDefault.hpp>

Inheritance diagram for Tempus::StepperRKObserverDefault< Scalar >:
Tempus::StepperRKObserverBase< Scalar > Tempus::StepperRKAppAction< Scalar >

Public Member Functions

 StepperRKObserverDefault ()
 Constructor. More...
 
virtual ~StepperRKObserverDefault ()
 Destructor. More...
 
virtual void observe (Teuchos::RCP< const SolutionHistory< Scalar > >, Teuchos::RCP< const StepperRKBase< Scalar > >, const typename StepperRKAppAction< Scalar >::ACTION_LOCATION actLoc)
 Observe RK Stepper at end of takeStep. 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::StepperRKObserverDefault< Scalar >

Default observer for StepperRK.

The default observer provides no-op functionality for the observer. See StepperRKObserverBase 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_StepperRKObserverDefault.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 35 of file Tempus_StepperRKObserverDefault.hpp.

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

Destructor.

Definition at line 38 of file Tempus_StepperRKObserverDefault.hpp.

Member Function Documentation

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

Observe RK Stepper at end of takeStep.

Implements Tempus::StepperRKObserverBase< Scalar >.

Definition at line 41 of file Tempus_StepperRKObserverDefault.hpp.


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