Tempus_IntegratorObserverLogging_impl.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_IntegratorObserverLogging_impl_hpp
#define Tempus_IntegratorObserverLogging_impl_hpp

#include "Tempus_IntegratorObserver.hpp"
#include "Tempus_TimeStepControl.hpp"

namespace Tempus {

template <class Scalar>
IntegratorObserverLogging<Scalar>::IntegratorObserverLogging()
  : nameObserveStartIntegrator_("observeStartIntegrator"),
    nameObserveStartTimeStep_("observeStartTimeStep"),
    nameObserveNextTimeStep_("observeNextTimeStep"),
    nameObserveBeforeTakeStep_("observeBeforeTakeStep"),
    nameObserveAfterTakeStep_("observeAfterTakeStep"),
    nameObserveAfterCheckTimeStep_("observeAfterCheckTimeStep"),
    nameObserveEndTimeStep_("observeEndTimeStep"),
    nameObserveEndIntegrator_("observeEndIntegrator")
{
  counters_ = Teuchos::rcp(new std::map<std::string, int>);
  order_    = Teuchos::rcp(new std::list<std::string>);
  this->resetLogCounters();
}

template <class Scalar>
IntegratorObserverLogging<Scalar>::~IntegratorObserverLogging()
{
}

template <class Scalar>
void IntegratorObserverLogging<Scalar>::observeStartIntegrator(
    const Integrator<Scalar>&)
{
  logCall(nameObserveStartIntegrator_);
}

template <class Scalar>
void IntegratorObserverLogging<Scalar>::observeStartTimeStep(
    const Integrator<Scalar>&)
{
  logCall(nameObserveStartTimeStep_);
}

template <class Scalar>
void IntegratorObserverLogging<Scalar>::observeNextTimeStep(
    const Integrator<Scalar>&)
{
  logCall(nameObserveNextTimeStep_);
}

template <class Scalar>
void IntegratorObserverLogging<Scalar>::observeBeforeTakeStep(
    const Integrator<Scalar>&)
{
  logCall(nameObserveBeforeTakeStep_);
}

template <class Scalar>
void IntegratorObserverLogging<Scalar>::observeAfterTakeStep(
    const Integrator<Scalar>&)
{
  logCall(nameObserveAfterTakeStep_);
}

template <class Scalar>
void IntegratorObserverLogging<Scalar>::observeAfterCheckTimeStep(
    const Integrator<Scalar>&)
{
  logCall(nameObserveAfterCheckTimeStep_);
}

template <class Scalar>
void IntegratorObserverLogging<Scalar>::observeEndTimeStep(
    const Integrator<Scalar>&)
{
  logCall(nameObserveEndTimeStep_);
}

template <class Scalar>
void IntegratorObserverLogging<Scalar>::observeEndIntegrator(
    const Integrator<Scalar>&)
{
  logCall(nameObserveEndIntegrator_);
}

template <class Scalar>
void IntegratorObserverLogging<Scalar>::resetLogCounters()
{
  (*counters_)[nameObserveStartIntegrator_]    = 0;
  (*counters_)[nameObserveStartTimeStep_]      = 0;
  (*counters_)[nameObserveNextTimeStep_]       = 0;
  (*counters_)[nameObserveBeforeTakeStep_]     = 0;
  (*counters_)[nameObserveAfterTakeStep_]      = 0;
  (*counters_)[nameObserveAfterCheckTimeStep_] = 0;
  (*counters_)[nameObserveEndTimeStep_]        = 0;
  (*counters_)[nameObserveEndIntegrator_]      = 0;
  order_->clear();
}

template <class Scalar>
Teuchos::RCP<const std::map<std::string, int> >
IntegratorObserverLogging<Scalar>::getCounters()
{
  return counters_;
}

template <class Scalar>
Teuchos::RCP<const std::list<std::string> >
IntegratorObserverLogging<Scalar>::getOrder()
{
  return order_;
}

template <class Scalar>
void IntegratorObserverLogging<Scalar>::logCall(const std::string call) const
{
  (*counters_)[call] += 1;
  order_->push_back(call);
}

}  // namespace Tempus
#endif  // Tempus_IntegratorObserverLogging_impl_hpp