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

Base observer for StepperTrapezoidal. More...

#include <Tempus_StepperTrapezoidalObserverBase.hpp>

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

Public Member Functions

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.
 

Private Member Functions

void execute (Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperTrapezoidal< Scalar > > stepper, const typename StepperTrapezoidalAppAction< Scalar >::ACTION_LOCATION actLoc)
 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::StepperTrapezoidalObserverBase< Scalar >

Base observer for StepperTrapezoidal.

This class provides a means to observe values (e.g., solution variables through SolutionHistory, and stepper member data through the Stepper), and cannot modify them.

Users deriving from this class can observer a lot of data, and it is expected that users will NOT modify any of that data. If the user wishes to modify the solution and/or stepper data during the Stepper::takeStep, they should use the Modifier class (with care!).

The locations for these AppAction calls (StepperTrapezoidalAppAction::ACTION_LOCATION) are shown in the algorithm documentation of the StepperTrapezoidal.

Definition at line 35 of file Tempus_StepperTrapezoidalObserverBase.hpp.

Member Function Documentation

◆ execute()

template<class Scalar >
void Tempus::StepperTrapezoidalObserverBase< Scalar >::execute ( Teuchos::RCP< SolutionHistory< Scalar > > sh,
Teuchos::RCP< StepperTrapezoidal< Scalar > > stepper,
const typename StepperTrapezoidalAppAction< Scalar >::ACTION_LOCATION actLoc )
inlineprivatevirtual

Execute application action for Trapezoidal Stepper.

Implements Tempus::StepperTrapezoidalAppAction< Scalar >.

Definition at line 50 of file Tempus_StepperTrapezoidalObserverBase.hpp.

◆ observe()

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

Observe Trapezoidal Stepper.

Implemented in Tempus::StepperTrapezoidalObserverDefault< Scalar >.


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