Timer.h

Note

The documentation on this page was automatically extracted from the DOLFIN C++ code and may need to be edited or expanded.

class Timer

A timer can be used for timing tasks. The basic usage is

Timer timer(“Assembling over cells”);

The timer is started at construction and timing ends when the timer is destroyed (goes out of scope). It is also possible to start and stop a timer explicitly by

timer.start(); timer.stop();

Timings are stored globally and a summary may be printed by calling

list_timings();

Timer()

Create timer without logging

Timer(std::string task)

Create timer with logging

void start()

Zero and start timer

void resume()

Resume timer. Not well-defined for logging timer

double stop()

Stop timer, return wall time elapsed and store timing data into logger

double value() const

DEPRECATED: Return value of timer (or time at start if not stopped)

std::tuple<double, double, double> elapsed() const

Return wall, user and system time in seconds. Wall-clock time has precision around 1 microsecond; user and system around 10 millisecond.