oomph::Timer Class Reference

Timer. More...

#include <oomph_utilities.h>

Public Member Functions
	Timer (const unsigned &n_timer)
	Constructor: Specify number of timers. More...
void	start (const unsigned &i)
	(Re-)start i-th timer More...
void	halt (const unsigned &i)
	Halt i-th timer. More...
double	cumulative_time (const unsigned &i)
	Report time accumulated by i-th timer. More...
void	reset (const unsigned &i)
	Reset i-th timer. More...
void	reset ()
	Reset all timers. More...
void	set_ntimers (const unsigned &ntimers)
	Set number of timings that can be recorded in parallel. More...

Private Attributes
Vector< clock_t >	Timing
	Cumulative timings. More...
Vector< clock_t >	Start_time
	Start times of active timers. More...

Detailed Description

Timer.

/////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////

Constructor & Destructor Documentation

Timer()

oomph::Timer::Timer ( const unsigned &  n_timer )

inline

Constructor: Specify number of timers.

    {
      set_ntimers(n_timer);
    }

References oomph::CumulativeTimings::set_ntimers().

Member Function Documentation

cumulative_time()

double oomph::Timer::cumulative_time ( const unsigned &  i )

inline

Report time accumulated by i-th timer.

    {
      return double(Timing[i]) / CLOCKS_PER_SEC;
    }

References i, and oomph::CumulativeTimings::Timing.

halt()

void oomph::Timer::halt ( const unsigned &  i )

inline

Halt i-th timer.

    {
      Timing[i] += clock() - Start_time[i];
    }

References i, oomph::CumulativeTimings::Start_time, and oomph::CumulativeTimings::Timing.

reset() [1/2]

void oomph::Timer::reset ( )

inline

Reset all timers.

    {
      unsigned n = Timing.size();
      for (unsigned i = 0; i < n; i++)
      {
        Timing[i] = clock_t(0.0);
      }
    }

References i, n, and oomph::CumulativeTimings::Timing.

reset() [2/2]

void oomph::Timer::reset ( const unsigned &  i )

inline

Reset i-th timer.

    {
      Timing[i] = clock_t(0.0);
    }

References i, and oomph::CumulativeTimings::Timing.

set_ntimers()

void oomph::Timer::set_ntimers ( const unsigned &  ntimers )

inline

Set number of timings that can be recorded in parallel.

    {
      Timing.resize(ntimers, clock_t(0.0));
      Start_time.resize(ntimers, clock_t(0.0));
    }

References oomph::CumulativeTimings::Start_time, and oomph::CumulativeTimings::Timing.

start()

void oomph::Timer::start ( const unsigned &  i )

inline

(Re-)start i-th timer

    {
      Start_time[i] = clock();
    }

References i, and oomph::CumulativeTimings::Start_time.

Member Data Documentation

Start_time

Vector<clock_t> oomph::Timer::Start_time

private

Start times of active timers.

Timing

Vector<clock_t> oomph::Timer::Timing

private

Cumulative timings.

---

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

• oomph_utilities.h