CD_Timer.H

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */
 
#ifndef CD_TIMER_H
#define CD_TIMER_H
 
// Std includes
#include <chrono>
#include <map>
#include <tuple>
 
// Chombo includes
#include <REAL.H>
 
// Our includes
#include <CD_NamespaceHeader.H>
 
class Timer
{
public:
  using Clock = std::chrono::steady_clock;
 
  using TimePoint = std::chrono::steady_clock::time_point;
 
  using Duration = std::chrono::duration<Real>;
 
  inline static Real
  wallClock();
 
  inline Timer() = default;
 
  inline Timer(const std::string& a_process);
 
  inline ~Timer();
 
  Timer(const Timer& a_other) = default;
 
  Timer&
  operator=(const Timer& a_other) = default;
 
  inline void
  startEvent(const std::string& a_event) noexcept;
 
  inline void
  stopEvent(const std::string& a_event) noexcept;
 
  inline void
  eventReport(std::ostream& a_outputStream, const bool a_localReportOnly = false) const noexcept;
 
  inline void
  writeReportToFile(const std::string& a_fileName) const noexcept;
 
  inline void
  clear() noexcept;
 
protected:
  enum EventFields
  {
    StoppedEvent = 0,
    StartClock   = 1,
    ElapsedTime  = 2
  };
 
  std::string m_processName;
 
  std::map<std::string, std::tuple<bool, TimePoint, Duration>> m_events;
 
  void
  printReportHeader(std::ostream& a_outputStream) const noexcept;
 
  void
  printReportTail(std::ostream& a_outputStream, const std::pair<Real, Real> a_elapsedTime) const noexcept;
 
  std::pair<Real, Real>
  computeTotalElapsedTime(const bool a_localReportOnly) const noexcept;
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_TimerImplem.H>
 
#endif