Tempus_IntegratorObserver.hpp

Go to the documentation of this file.

// @HEADER
// ****************************************************************************
//                Tempus: Copyright (2017) Sandia Corporation
//
// Distributed under BSD 3-clause license (See accompanying file Copyright.txt)
// ****************************************************************************
// @HEADER

#ifndef Tempus_IntegratorObserver_hpp
#define Tempus_IntegratorObserver_hpp

#include "Tempus_config.hpp"
#include "Tempus_TimeStepControl.hpp"

// Forward declarations
namespace Tempus {
template <typename Scalar>
class Integrator;
}

namespace Tempus {

template <class Scalar>
class IntegratorObserver {
 public:

  virtual void observeStartIntegrator(const Integrator<Scalar>& integrator) = 0;

  virtual void observeStartTimeStep(const Integrator<Scalar>& integrator) = 0;

  virtual void observeNextTimeStep(const Integrator<Scalar>& integrator) = 0;

  virtual void observeBeforeTakeStep(const Integrator<Scalar>& integrator) = 0;

  virtual void observeAfterTakeStep(const Integrator<Scalar>& integrator) = 0;

  virtual void observeAfterCheckTimeStep(
      const Integrator<Scalar>& integrator) = 0;

  virtual void observeEndTimeStep(const Integrator<Scalar>& integrator) = 0;

  virtual void observeEndIntegrator(const Integrator<Scalar>& integrator) = 0;

  virtual ~IntegratorObserver() = default;
};
}  // namespace Tempus
#endif  // Tempus_IntegratorObserver_hpp