DOLFINx 0.9.0
DOLFINx C++ interface
Loading...
Searching...
No Matches
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 comm, std::set< TimingType > type, Table::Reduction reduction)
 
std::tuple< int, double, double, double > timing (std::string task)
 

Detailed Description

Timer logging.

Member Function Documentation

◆ list_timings()

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

List a summary of timings and tasks. Reduction type is printed.

Parameters
commMPI Communicator
typeSet of possible timings: wall, user or system
reductionReduction type (min, max or average)

◆ timing()

std::tuple< int, double, double, double > 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: