WARPXM v1.10.0
Loading...
Searching...
No Matches
wxm::timer::WmTimer Class Reference

Parameters for the walltime report. More...

#include <wmtimer.h>

Detailed Description

Parameters for the walltime report.

The timers are set to report the time spent on the calculation of fluxes, syncing time for each rk stage, etc.

Public Member Functions

void start (const std::string &scope)
 Start a nested timing scope.
 
void stop ()
 Stop the currently running scope.
 
void stop (const std::string &scope)
 Stop the currently running scope, which must be the same as scope.
 
void add_scope (const std::string &scope)
 
void add_started_at (std::chrono::time_point< std::chrono::steady_clock, std::chrono::nanoseconds > started_at)
 
void pop_scope ()
 
void pop_started_at ()
 
const std::chrono::time_point< std::chrono::steady_clock, std::chrono::nanoseconds > current_started_at ()
 
std::map< std::vector< std::string >, long > get_scoped_timings ()
 
void print_timings (WxLogStream &stream)
 Print the timings in a readable table format to the given log stream.
 

Member Function Documentation

◆ add_scope()

void wxm::timer::WmTimer::add_scope ( const std::string &  scope)
inline

◆ add_started_at()

void wxm::timer::WmTimer::add_started_at ( std::chrono::time_point< std::chrono::steady_clock, std::chrono::nanoseconds >  started_at)
inline

◆ current_started_at()

const std::chrono::time_point< std::chrono::steady_clock, std::chrono::nanoseconds > wxm::timer::WmTimer::current_started_at ( )
inline

◆ get_scoped_timings()

std::map< std::vector< std::string >, long > wxm::timer::WmTimer::get_scoped_timings ( )
inline

◆ pop_scope()

void wxm::timer::WmTimer::pop_scope ( )
inline

◆ pop_started_at()

void wxm::timer::WmTimer::pop_started_at ( )
inline

◆ print_timings()

void wxm::timer::WmTimer::print_timings ( WxLogStream stream)

Print the timings in a readable table format to the given log stream.

◆ start()

void wxm::timer::WmTimer::start ( const std::string &  scope)

Start a nested timing scope.

◆ stop() [1/2]

void wxm::timer::WmTimer::stop ( )

Stop the currently running scope.

◆ stop() [2/2]

void wxm::timer::WmTimer::stop ( const std::string &  scope)

Stop the currently running scope, which must be the same as scope.

Verifies that the scope you pass in is the one that is indeed currently running.


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