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

Default observer for StepperTrapezoidal. More...

#include <Tempus_StepperTrapezoidalObserverDefault.hpp>

Inheritance diagram for Tempus::StepperTrapezoidalObserverDefault< Scalar >:
Tempus::StepperTrapezoidalObserverBase< Scalar > Tempus::StepperTrapezoidalAppAction< Scalar >

Public Member Functions

 StepperTrapezoidalObserverDefault ()
 Constructor.
 
virtual ~StepperTrapezoidalObserverDefault ()
 Destructor.
 
virtual void observe (Teuchos::RCP< const SolutionHistory< Scalar > >, Teuchos::RCP< const StepperTrapezoidal< Scalar > >, const typename StepperTrapezoidalAppAction< Scalar >::ACTION_LOCATION actLoc)
 Observe Subcycling Stepper at end of takeStep.
 
virtual void observe (Teuchos::RCP< const SolutionHistory< Scalar > >, Teuchos::RCP< const StepperTrapezoidal< Scalar > >, const typename StepperTrapezoidalAppAction< Scalar >::ACTION_LOCATION actLoc)=0
 Observe Trapezoidal Stepper.
 
- Public Member Functions inherited from Tempus::StepperTrapezoidalAppAction< Scalar >
 StepperTrapezoidalAppAction ()
 Constructor.
 
virtual ~StepperTrapezoidalAppAction ()
 Destructor.
 
virtual void execute (Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperTrapezoidal< Scalar > > stepper, const typename StepperTrapezoidalAppAction< Scalar >::ACTION_LOCATION actLoc)=0
 Execute application action for Trapezoidal Stepper.
 

Additional Inherited Members

- Public Types inherited from Tempus::StepperTrapezoidalAppAction< Scalar >
enum  ACTION_LOCATION { BEGIN_STEP , BEFORE_SOLVE , AFTER_SOLVE , END_STEP }
 Indicates the location of application action (see algorithm). More...
 

Detailed Description

template<class Scalar>
class Tempus::StepperTrapezoidalObserverDefault< Scalar >

Default observer for StepperTrapezoidal.

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

Constructor & Destructor Documentation

◆ StepperTrapezoidalObserverDefault()

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

Constructor.

Definition at line 37 of file Tempus_StepperTrapezoidalObserverDefault.hpp.

◆ ~StepperTrapezoidalObserverDefault()

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

Destructor.

Definition at line 40 of file Tempus_StepperTrapezoidalObserverDefault.hpp.

Member Function Documentation

◆ observe()

template<class Scalar >
virtual void Tempus::StepperTrapezoidalObserverDefault< Scalar >::observe ( Teuchos::RCP< const SolutionHistory< Scalar > >  ,
Teuchos::RCP< const StepperTrapezoidal< Scalar > >  ,
const typename StepperTrapezoidalAppAction< Scalar >::ACTION_LOCATION  actLoc 
)
inlinevirtual

Observe Subcycling Stepper at end of takeStep.

Implements Tempus::StepperTrapezoidalObserverBase< Scalar >.

Definition at line 43 of file Tempus_StepperTrapezoidalObserverDefault.hpp.


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