TimeLogger.h

// Copyright (C) 2003-2016 Anders Logg, 2015 Jan Blechta
//
// This file is part of DOLFINx (https://www.fenicsproject.org)
//
// SPDX-License-Identifier:    LGPL-3.0-or-later
 
#pragma once
 
#include "Table.h"
#include "timing.h"
#include <chrono>
#include <functional>
#include <map>
#include <mpi.h>
#include <string>
#include <string_view>
#include <utility>
 
namespace dolfinx::common
{
class TimeLogger
{
public:
  static TimeLogger& instance();

  void register_timing(std::string_view task,
                       std::chrono::duration<double, std::ratio<1>> wall);

  Table timing_table() const;

  void list_timings(MPI_Comm comm, Table::Reduction reduction) const;

  std::pair<int, std::chrono::duration<double, std::ratio<1>>>
  timing(std::string_view task) const;

  std::map<std::string,
           std::pair<int, std::chrono::duration<double, std::ratio<1>>>,
           std::less<>>
  timings() const;
 
private:
  TimeLogger() = default;
 
  // This class is used as a singleton and thus should not allow copies.
  TimeLogger(const TimeLogger&) = delete;
 
  // This class is used as a singleton and thus should not allow copies.
  TimeLogger& operator=(const TimeLogger&) = delete;

  ~TimeLogger() = default;
 
  // List of timings for tasks, map from string to (num_timings,
  // total_wall_time)
  std::map<std::string,
           std::pair<int, std::chrono::duration<double, std::ratio<1>>>,
           std::less<>>
      _timings;
};
} // namespace dolfinx::common