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::StepperSubcyclingObserverDefault< Scalar > Class Template Reference

Default observer for StepperSubcycling. More...

#include <Tempus_StepperSubcyclingObserverDefault.hpp>

Inheritance diagram for Tempus::StepperSubcyclingObserverDefault< Scalar >:
Inheritance graph
[legend]

Public Member Functions

 StepperSubcyclingObserverDefault ()
 Constructor. More...
 
virtual ~StepperSubcyclingObserverDefault ()
 Destructor. More...
 
virtual void observe (Teuchos::RCP< const SolutionHistory< Scalar > >, Teuchos::RCP< const StepperSubcycling< Scalar > >, const typename StepperSubcyclingAppAction< Scalar >::ACTION_LOCATION actLoc)
 Observe Subcycling Stepper at end of takeStep. More...
 
- Public Member Functions inherited from Tempus::StepperSubcyclingAppAction< Scalar >
 StepperSubcyclingAppAction ()
 Constructor. More...
 
virtual ~StepperSubcyclingAppAction ()
 Destructor. 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::StepperSubcyclingObserverDefault< Scalar >

Default observer for StepperSubcycling.

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

Constructor & Destructor Documentation

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

Constructor.

Definition at line 37 of file Tempus_StepperSubcyclingObserverDefault.hpp.

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

Destructor.

Definition at line 40 of file Tempus_StepperSubcyclingObserverDefault.hpp.

Member Function Documentation

template<class Scalar >
virtual void Tempus::StepperSubcyclingObserverDefault< Scalar >::observe ( Teuchos::RCP< const SolutionHistory< Scalar > >  ,
Teuchos::RCP< const StepperSubcycling< Scalar > >  ,
const typename StepperSubcyclingAppAction< Scalar >::ACTION_LOCATION  actLoc 
)
inlinevirtual

Observe Subcycling Stepper at end of takeStep.

Implements Tempus::StepperSubcyclingObserverBase< Scalar >.

Definition at line 43 of file Tempus_StepperSubcyclingObserverDefault.hpp.


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