Note: this is documentation for an old release. View the latest documentation at docs.fenicsproject.org/v0.1.0/v0.9.0/cpp
DOLFINx  0.1.0
DOLFINx C++ interface
Public Member Functions | List of all members
dolfinx::common::TimeLogger Class Reference

Timer logging. More...

#include <TimeLogger.h>

Public Member Functions

 TimeLogger ()=default
 Constructor.
 
 TimeLogger (const TimeLogger &)=delete
 
TimeLoggeroperator= (const TimeLogger &)=delete
 
 ~TimeLogger ()=default
 Destructor.
 
void register_timing (std::string task, double wall, double user, double system)
 Register timing (for later summary)
 
Table timings (std::set< TimingType > type)
 Return a summary of timings and tasks in a Table.
 
void list_timings (MPI_Comm mpi_comm, std::set< TimingType > type)
 List a summary of timings and tasks. MPI_AVG reduction is printed. More...
 
std::tuple< int, double, double, double > timing (std::string task)
 Return timing. More...
 

Detailed Description

Timer logging.

Member Function Documentation

◆ list_timings()

void TimeLogger::list_timings ( MPI_Comm  mpi_comm,
std::set< TimingType >  type 
)

List a summary of timings and tasks. MPI_AVG reduction is printed.

Parameters
mpi_commMPI Communicator
typeSet of possible timings: wall, user or system

◆ timing()

std::tuple< int, double, double, double > TimeLogger::timing ( std::string  task)

Return timing.

Parameters
[in]taskThe task name to retrieve the timing for
Returns
Values (count, total wall time, total user time, total system time) for given task.

The documentation for this class was generated from the following files: