Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Tempus_IntegratorObserverBasic_decl.hpp
Go to the documentation of this file.
1 //@HEADER
2 // *****************************************************************************
3 // Tempus: Time Integration and Sensitivity Analysis Package
4 //
5 // Copyright 2017 NTESS and the Tempus contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 //@HEADER
9 
10 #ifndef Tempus_IntegratorObserverBasic_decl_hpp
11 #define Tempus_IntegratorObserverBasic_decl_hpp
12 
13 #include "Tempus_config.hpp"
15 #include "Tempus_Integrator.hpp"
16 #include "Teuchos_Time.hpp"
17 
18 namespace Tempus {
19 
24 template <class Scalar>
26  : virtual public Tempus::IntegratorObserver<Scalar> {
27  public:
30 
32  virtual ~IntegratorObserverBasic();
33 
35 
36  virtual void observeStartIntegrator(
38  const Integrator<Scalar>& integrator) override;
39 
41  virtual void observeStartTimeStep(
42  const Integrator<Scalar>& integrator) override;
43 
45  virtual void observeNextTimeStep(
46  const Integrator<Scalar>& integrator) override;
47 
49  virtual void observeBeforeTakeStep(
50  const Integrator<Scalar>& integrator) override;
51 
53  virtual void observeAfterTakeStep(
54  const Integrator<Scalar>& integrator) override;
55 
58  virtual void observeAfterCheckTimeStep(
59  const Integrator<Scalar>& integrator) override;
60 
62  virtual void observeEndTimeStep(
63  const Integrator<Scalar>& integrator) override;
64 
66  virtual void observeEndIntegrator(
67  const Integrator<Scalar>& integrator) override;
69 };
70 } // namespace Tempus
71 #endif // Tempus_IntegratorObserverBasic_decl_hpp
virtual void observeEndIntegrator(const Integrator< Scalar > &integrator) override
Observe the end of the time integrator.
virtual void observeNextTimeStep(const Integrator< Scalar > &integrator) override
Observe after the next time step size is selected.
IntegratorObserverBasic class for time integrators. This basic class has simple no-op functions...
virtual void observeStartIntegrator(const Integrator< Scalar > &integrator) override
Observe the beginning of the time integrator.
virtual void observeAfterCheckTimeStep(const Integrator< Scalar > &integrator) override
IntegratorObserver class for time integrators.
Thyra Base interface for time integrators. Time integrators are designed to advance the solution from...
virtual void observeStartTimeStep(const Integrator< Scalar > &integrator) override
Observe the beginning of the time step loop.
virtual void observeAfterTakeStep(const Integrator< Scalar > &integrator) override
Observe after Stepper takes step.
virtual void observeEndTimeStep(const Integrator< Scalar > &integrator) override
Observe the end of the time step loop.
virtual void observeBeforeTakeStep(const Integrator< Scalar > &integrator) override
Observe before Stepper takes step.