Tempus_IntegratorObserverLogging_decl.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_IntegratorObserverLogging_decl_hpp
#define Tempus_IntegratorObserverLogging_decl_hpp

#include "Tempus_config.hpp"
#include "Tempus_IntegratorObserver.hpp"
#include <list>

namespace Tempus {

template<class Scalar>
class IntegratorObserverLogging
  : virtual public Tempus::IntegratorObserver<Scalar>
{
public:

  IntegratorObserverLogging();

  virtual ~IntegratorObserverLogging();


    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;

  void resetLogCounters();

  Teuchos::RCP<const std::map<std::string,int> > getCounters();

  Teuchos::RCP<const std::list<std::string> > getOrder();

    const std::string nameObserveStartIntegrator_;
    const std::string nameObserveStartTimeStep_;
    const std::string nameObserveNextTimeStep_;
    const std::string nameObserveBeforeTakeStep_;
    const std::string nameObserveAfterTakeStep_;
    const std::string nameObserveAfterCheckTimeStep_;
    const std::string nameObserveEndTimeStep_;
    const std::string nameObserveEndIntegrator_;

private:

  void logCall(const std::string call) const;

  Teuchos::RCP< std::map<std::string,int> > counters_;
  Teuchos::RCP< std::list<std::string> > order_;

};

} // namespace Tempus
#endif // Tempus_IntegratorObserverLogging_decl_hpp