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

Base observer for StepperBDF2. More...

#include <Tempus_StepperBDF2ObserverBase.hpp>

Inheritance diagram for Tempus::StepperBDF2ObserverBase< Scalar >:
Tempus::StepperBDF2AppAction< Scalar > Tempus::StepperBDF2ObserverDefault< Scalar >

Public Member Functions

virtual void observe (Teuchos::RCP< const SolutionHistory< Scalar > >, Teuchos::RCP< const StepperBDF2< Scalar > >, const typename StepperBDF2AppAction< Scalar >::ACTION_LOCATION actLoc)=0
 Observe BDF2 Stepper.
 
- Public Member Functions inherited from Tempus::StepperBDF2AppAction< Scalar >
 StepperBDF2AppAction ()
 Constructor.
 
virtual ~StepperBDF2AppAction ()
 Destructor.
 

Private Member Functions

void execute (Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperBDF2< Scalar > > stepper, const typename StepperBDF2AppAction< Scalar >::ACTION_LOCATION actLoc)
 Execute application action for BDF2 Stepper.
 

Additional Inherited Members

- Public Types inherited from Tempus::StepperBDF2AppAction< 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::StepperBDF2ObserverBase< Scalar >

Base observer for StepperBDF2.

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 (StepperBDF2AppAction::ACTION_LOCATION) are shown in the algorithm documentation of the StepperBDF2.

Definition at line 35 of file Tempus_StepperBDF2ObserverBase.hpp.

Member Function Documentation

◆ execute()

template<class Scalar >
void Tempus::StepperBDF2ObserverBase< Scalar >::execute ( Teuchos::RCP< SolutionHistory< Scalar > > sh,
Teuchos::RCP< StepperBDF2< Scalar > > stepper,
const typename StepperBDF2AppAction< Scalar >::ACTION_LOCATION actLoc )
inlineprivatevirtual

Execute application action for BDF2 Stepper.

Implements Tempus::StepperBDF2AppAction< Scalar >.

Definition at line 50 of file Tempus_StepperBDF2ObserverBase.hpp.

◆ observe()

template<class Scalar >
virtual void Tempus::StepperBDF2ObserverBase< Scalar >::observe ( Teuchos::RCP< const SolutionHistory< Scalar > > ,
Teuchos::RCP< const StepperBDF2< Scalar > > ,
const typename StepperBDF2AppAction< Scalar >::ACTION_LOCATION actLoc )
pure virtual

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