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 <map>
#include <mpi.h>
#include <set>
#include <string>
#include <tuple>
 
namespace dolfinx::common
{

 
class TimeLogger
{
public:
  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;

  void register_timing(std::string task, double wall, double user,
                       double system);

  Table timings(std::set<TimingType> type);

  void list_timings(MPI_Comm comm, std::set<TimingType> type,
                    Table::Reduction reduction);

  std::tuple<int, double, double, double> timing(std::string task);
 
private:
  // List of timings for tasks, map from string to (num_timings,
  // total_wall_time, total_user_time, total_system_time)
  std::map<std::string, std::tuple<int, double, double, double>> _timings;
};
} // namespace dolfinx::common