db/d41/timing_8h_source.html

// Copyright (C) 2005-2010 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 <dolfinx/common/Table.h>

#include <mpi.h>

#include <set>

#include <string>

#include <tuple>


namespace dolfinx

{


enum class TimingType : int

{

  wall = 0,

  user = 1,

  system = 2

};


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


void list_timings(MPI_Comm comm, std::set<TimingType> type,

                  Table::Reduction reduction = Table::Reduction::max);


std::tuple<std::size_t, double, double, double> timing(std::string task);


} // namespace dolfinx

dolfinx::Table::Reduction
Reduction
Types of MPI reduction available for Table, to get the max, min or average values over an MPI_Comm.
Definition Table.h:33

dolfinx
Top-level namespace.
Definition defines.h:12

dolfinx::list_timings
void list_timings(MPI_Comm comm, std::set< TimingType > type, Table::Reduction reduction=Table::Reduction::max)
List a summary of timings and tasks. MPI_AVG reduction is printed.
Definition timing.cpp:22

dolfinx::timing
std::tuple< std::size_t, double, double, double > timing(std::string task)
Return timing (count, total wall time, total user time, total system time) for given task.
Definition timing.cpp:29

dolfinx::timings
Table timings(std::set< TimingType > type)
Return a summary of timings and tasks in a Table.
Definition timing.cpp:17

dolfinx::TimingType
TimingType
Timing types:
Definition timing.h:23