File: TimeLogger.h

package info (click to toggle)
fenics-dolfinx 1%3A0.10.0.post4-1exp1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 6,028 kB
  • sloc: cpp: 36,535; python: 25,391; makefile: 226; sh: 171; xml: 55
file content (74 lines) | stat: -rw-r--r-- 2,217 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
// 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 <map>
#include <mpi.h>
#include <string>
#include <utility>

namespace dolfinx::common
{
/// @brief Time logger maintaining data collected by Timer, if registered.
///
/// @note This is a monotstate, i.e. the data members are static and thus
/// timings are aggregated into a single map.
class TimeLogger
{
public:
  /// @brief Singleton access.
  /// @return Unique time logger object.
  static TimeLogger& instance();

  /// Register timing (for later summary)
  void register_timing(const std::string& task,
                       std::chrono::duration<double, std::ratio<1>> wall);

  /// Return a summary of timings and tasks in a Table
  Table timing_table() const;

  /// List a summary of timings and tasks. Reduction type is
  /// printed.
  /// @param comm MPI Communicator
  /// @param reduction Reduction type (min, max or average)
  void list_timings(MPI_Comm comm, Table::Reduction reduction) const;

  /// @brief Return timing.
  /// @param[in] task The task name to retrieve the timing for
  /// @return Values (count, total wall time) for given task.
  std::pair<int, std::chrono::duration<double, std::ratio<1>>>
  timing(const std::string& task) const;

  /// @brief Logged elapsed times.
  /// @return Elapsed [task id: (count, total wall time)].
  std::map<std::string,
           std::pair<int, std::chrono::duration<double, std::ratio<1>>>>
  timings() const;

private:
  /// Constructor
  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;

  /// Destructor
  ~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>>>>
      _timings;
};
} // namespace dolfinx::common