Tempus_IntegratorObserverComposite_decl.hpp

Go to the documentation of this file.

//@HEADER
// *****************************************************************************
//          Tempus: Time Integration and Sensitivity Analysis Package
//
// Copyright 2017 NTESS and the Tempus contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
//@HEADER

#ifndef Tempus_IntegratorObserverComposite_decl_hpp
#define Tempus_IntegratorObserverComposite_decl_hpp

#include "Tempus_config.hpp"
#include "Tempus_IntegratorObserver.hpp"
#include "Tempus_TimeStepControl.hpp"
#include <vector>

namespace Tempus {

template <class Scalar>
class IntegratorObserverComposite
  : virtual public Tempus::IntegratorObserver<Scalar> {
 public:
  IntegratorObserverComposite();

  virtual ~IntegratorObserverComposite();


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

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

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

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

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

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

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

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

  // add observer to the composite observer list
  void addObserver(const Teuchos::RCP<IntegratorObserver<Scalar> >& observer);

  // clear all observer from the composite observer list
  void clearObservers();

 private:
  std::vector<Teuchos::RCP<IntegratorObserver<Scalar> > > observers_;
};

}  // namespace Tempus
#endif  // Tempus_IntegratorObserverComposite_decl_hpp