libMesh::PerfData Class Reference

The PerfData class simply contains the performance data that is recorded for individual events. More...

#include <perf_log.h>

Public Member Functions
	PerfData ()
	Constructor.
void	start ()
void	restart ()
double	pause ()
double	pause_for (PerfData &other)
double	stopit ()
PerfData &	operator+= (const PerfData &other)
	Sums timing results from other.

Public Attributes
double	tot_time
	Total time spent in this event.
double	tot_time_incl_sub
	Total time spent in this event, including sub-events.
struct timeval	tstart
	Structure defining when the event was last started.
struct timeval	tstart_incl_sub
	Structure defining when the event was last started, including sub-events.
unsigned int	count
	The number of times this event has been executed.
bool	open
	Flag indicating if we are currently monitoring this event.
int	called_recursively

Protected Member Functions
double	stop_or_pause (const bool do_stop)

Detailed Description

The PerfData class simply contains the performance data that is recorded for individual events.

Author

Benjamin Kirk

Date

2003

Data object managed by PerfLog

Definition at line 61 of file perf_log.h.

Constructor & Destructor Documentation

PerfData()

libMesh::PerfData::PerfData ( )

inline

Constructor.

Initializes data to be empty.

Definition at line 68 of file perf_log.h.

              :
    tot_time(0.),
    tot_time_incl_sub(0.),
    tstart(),
    tstart_incl_sub(),
    count(0),
    open(false),
    called_recursively(0)
  {}

Member Function Documentation

operator+=()

PerfData & libMesh::PerfData::operator+= ( const PerfData &  other )

inline

Sums timing results from other.

Definition at line 123 of file perf_log.h.

  {
    libmesh_assert(!open);
    tot_time += other.tot_time;
    tot_time_incl_sub += other.tot_time_incl_sub;
    count += other.count;
 
    return *this;
  }

References count, libMesh::libmesh_assert(), open, tot_time, and tot_time_incl_sub.

pause()

double libMesh::PerfData::pause ( )

inline

Definition at line 447 of file perf_log.h.

{
  return this->stop_or_pause(false);
}

pause_for()

double libMesh::PerfData::pause_for ( PerfData &  other )

inline

Definition at line 483 of file perf_log.h.

{
  gettimeofday (&(other.tstart), nullptr);
 
  const double elapsed_time = (static_cast<double>(other.tstart.tv_sec  - this->tstart.tv_sec) +
                               static_cast<double>(other.tstart.tv_usec - this->tstart.tv_usec)*1.e-6);
  this->tot_time += elapsed_time;
 
  other.count++;
  other.called_recursively++;
  other.tstart_incl_sub = other.tstart;
 
  return elapsed_time;
}

References called_recursively, count, gettimeofday(), tstart, libMesh::PerfLog::tstart, tstart_incl_sub, timeval::tv_sec, and timeval::tv_usec.

Referenced by libMesh::PerfLog::fast_push().

restart()

void libMesh::PerfData::restart ( )

inline

Definition at line 439 of file perf_log.h.

{
  gettimeofday (&(this->tstart), nullptr);
}

References gettimeofday(), and libMesh::PerfLog::tstart.

start()

void libMesh::PerfData::start ( )

inline

Definition at line 428 of file perf_log.h.

{
  this->count++;
  this->called_recursively++;
  gettimeofday (&(this->tstart), nullptr);
  this->tstart_incl_sub = this->tstart;
}

References gettimeofday(), and libMesh::PerfLog::tstart.

Referenced by libMesh::PerfLog::fast_push().

stop_or_pause()

double libMesh::PerfData::stop_or_pause ( const bool  do_stop )

inlineprotected

Definition at line 454 of file perf_log.h.

{
  // save the start times, reuse the structure we have rather than create
  // a new one.
  const time_t
    tstart_tv_sec  = this->tstart.tv_sec,
    tstart_tv_usec = this->tstart.tv_usec;
 
  gettimeofday (&(this->tstart), nullptr);
 
  const double elapsed_time = (static_cast<double>(this->tstart.tv_sec  - tstart_tv_sec) +
                               static_cast<double>(this->tstart.tv_usec - tstart_tv_usec)*1.e-6);
 
  this->tot_time += elapsed_time;
 
  if (do_stop)
    {
      const double elapsed_time_incl_sub = (static_cast<double>(this->tstart.tv_sec  - this->tstart_incl_sub.tv_sec) +
                                            static_cast<double>(this->tstart.tv_usec - this->tstart_incl_sub.tv_usec)*1.e-6);
 
      this->tot_time_incl_sub += elapsed_time_incl_sub;
    }
 
  return elapsed_time;
}

References gettimeofday(), libMesh::PerfLog::tstart, timeval::tv_sec, and timeval::tv_usec.

stopit()

double libMesh::PerfData::stopit ( )

inline

Definition at line 501 of file perf_log.h.

{
  // stopit is just similar to pause except that it decrements the
  // recursive call counter
 
  this->called_recursively--;
  return this->stop_or_pause(true);
}

Member Data Documentation

called_recursively

int libMesh::PerfData::called_recursively

Definition at line 133 of file perf_log.h.

Referenced by pause_for().

count

unsigned int libMesh::PerfData::count

The number of times this event has been executed.

Definition at line 105 of file perf_log.h.

Referenced by libMesh::PerfLog::get_perf_info(), operator+=(), and pause_for().

open

bool libMesh::PerfData::open

Flag indicating if we are currently monitoring this event.

Should only be true while the event is executing.

Definition at line 112 of file perf_log.h.

Referenced by operator+=().

tot_time

double libMesh::PerfData::tot_time

Total time spent in this event.

Definition at line 82 of file perf_log.h.

Referenced by libMesh::PerfLog::get_perf_info(), and operator+=().

tot_time_incl_sub

double libMesh::PerfData::tot_time_incl_sub

Total time spent in this event, including sub-events.

Definition at line 87 of file perf_log.h.

Referenced by libMesh::PerfLog::get_perf_info(), and operator+=().

tstart

struct timeval libMesh::PerfData::tstart

Structure defining when the event was last started.

Definition at line 93 of file perf_log.h.

Referenced by pause_for().

tstart_incl_sub

struct timeval libMesh::PerfData::tstart_incl_sub

Structure defining when the event was last started, including sub-events.

Definition at line 99 of file perf_log.h.

Referenced by pause_for().

---

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

• include/utils/perf_log.h