Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Tempus_StepperObserverBasic_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ****************************************************************************
3 // Tempus: Copyright (2017) Sandia Corporation
4 //
5 // Distributed under BSD 3-clause license (See accompanying file Copyright.txt)
6 // ****************************************************************************
7 // @HEADER
8 
9 #ifndef Tempus_StepperObserverBasic_decl_hpp
10 #define Tempus_StepperObserverBasic_decl_hpp
11 
12 #include "Tempus_config.hpp"
13 #include "Tempus_Stepper.hpp"
14 #include "Tempus_StepperObserver.hpp"
15 
16 
17 namespace Tempus {
18 
19 // Forward Declaration for recursive includes (this Observer <--> Stepper)
20 template<class Scalar> class Stepper;
21 
22 /** \brief StepperObserverBasic class for Stepper class.
23  */
24 template<class Scalar>
25 class StepperObserverBasic : virtual public Tempus::StepperObserver<Scalar>
26 {
27 public:
28 
29  /// Constructor
30  StepperObserverBasic();
31 
32  /// Destructor
33  virtual ~StepperObserverBasic();
34 
35  /// Observe Stepper at beginning of takeStep.
36  virtual void observeBeginTakeStep(
37  Teuchos::RCP<SolutionHistory<Scalar> > sh,
38  Stepper<Scalar> & stepper);
39 
40  /// Observe Stepper at end of takeStep.
41  virtual void observeEndTakeStep(
42  Teuchos::RCP<SolutionHistory<Scalar> > sh,
43  Stepper<Scalar> & stepper);
44 };
45 
46 } // namespace Tempus
47 
48 #endif // Tempus_StepperObserverBasic_decl_hpp
Tempus::Stepper
Thyra Base interface for time steppers.
Definition: Tempus_Integrator.hpp:24
Tempus_StepperObserver.hpp
Tempus::StepperObserver
StepperObserver class for Stepper class.
Definition: Tempus_StepperObserver.hpp:38
Tempus::SolutionHistory
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
Definition: Tempus_Integrator.hpp:25
Tempus::StepperObserverBasic
StepperObserverBasic class for Stepper class.
Definition: Tempus_StepperObserverBasic_decl.hpp:25
Tempus::StepperObserverBasic::observeBeginTakeStep
virtual void observeBeginTakeStep(Teuchos::RCP< SolutionHistory< Scalar > > sh, Stepper< Scalar > &stepper)
Observe Stepper at beginning of takeStep.
Definition: Tempus_StepperObserverBasic_impl.hpp:27
Tempus::StepperObserverBasic::observeEndTakeStep
virtual void observeEndTakeStep(Teuchos::RCP< SolutionHistory< Scalar > > sh, Stepper< Scalar > &stepper)
Observe Stepper at end of takeStep.
Definition: Tempus_StepperObserverBasic_impl.hpp:33