libMesh::PerfMon Class Reference

PAPI stands for Performance Application Programming Interface. More...

#include <perfmon.h>

Public Member Functions
	PerfMon (std::string id, const unsigned int v=1, const unsigned int pid=0)
	~PerfMon ()
void	reset ()
double	print (std::string msg="NULL", std::ostream &my_out=libMesh::out)

Private Attributes
const std::string	id_string
struct timeval	the_time_start
struct timeval	the_time_stop
const unsigned int	verbose
const unsigned int	proc_id
float	rtime
float	ptime
float	mflops
long long int	flpins

Detailed Description

PAPI stands for Performance Application Programming Interface.

This class was supposed to provide an interface to the hardware timers that PAPI exposes, but it never really got developed.

Author

Benjamin S. Kirk

Date

2002

A class for interfacing with hardware timers.

Definition at line 57 of file perfmon.h.

Constructor & Destructor Documentation

PerfMon()

libMesh::PerfMon::PerfMon ( std::string  id, const unsigned int  v = 1, const unsigned int  pid = 0  )

inline

Definition at line 150 of file perfmon.h.

                                          :
  id_string(id),
  verbose(v),
  proc_id(pid)
{
  reset ();
}

References reset().

~PerfMon()

libMesh::PerfMon::~PerfMon ( )

inline

Definition at line 163 of file perfmon.h.

{
  print ();
}

References print().

Member Function Documentation

print()

double libMesh::PerfMon::print ( std::string  msg = "NULL", std::ostream &  my_out = libMesh::out  )

inline

Definition at line 102 of file perfmon.h.

{
  gettimeofday (&the_time_stop, nullptr);
 
#ifdef HAVE_PAPI_H
  Papi::PAPI_flops (&rtime, & ptime, &flpins, &mflops);
#endif
 
  const double elapsed_time = ((double) (the_time_stop.tv_sec - the_time_start.tv_sec)) +
    ((double) (the_time_stop.tv_usec - the_time_start.tv_usec))/1000000.;
 
  if (verbose)
    {
 
      if (proc_id == 0)
        {
          if (msg == "NULL")
            my_out << " " << id_string
                   << ": elapsed time: "
                   << elapsed_time << " (sec)"
                   << std::endl;
          else
            my_out << " " << msg
                   << ": elapsed time: "
                   << elapsed_time << " (sec)"
                   << std::endl;
 
#ifdef HAVE_PAPI_H
          if (msg == "NULL")
            my_out << " " << id_string
                   << ": mflops: "
                   << mflops
                   << std::endl;
          else
            my_out << " " << msg
                   << ": mflops: "
                   << mflops
                   << std::endl;
#endif
 
        }
    }
 
  return elapsed_time;
}

References flpins, gettimeofday(), id_string, mflops, proc_id, ptime, rtime, the_time_start, the_time_stop, timeval::tv_sec, timeval::tv_usec, and verbose.

Referenced by ~PerfMon().

reset()

void libMesh::PerfMon::reset ( )

inline

Definition at line 89 of file perfmon.h.

{
  gettimeofday (&the_time_start, nullptr);
 
#ifdef HAVE_PAPI_H
  Papi::PAPI_flops (&rtime, & ptime, &flpins, &mflops);
#endif
}

References flpins, gettimeofday(), mflops, ptime, rtime, and the_time_start.

Referenced by PerfMon().

Member Data Documentation

flpins

long long int libMesh::PerfMon::flpins

private

Definition at line 81 of file perfmon.h.

Referenced by print(), and reset().

id_string

const std::string libMesh::PerfMon::id_string

private

Definition at line 71 of file perfmon.h.

Referenced by print().

mflops

float libMesh::PerfMon::mflops

private

Definition at line 80 of file perfmon.h.

Referenced by print(), and reset().

proc_id

const unsigned int libMesh::PerfMon::proc_id

private

Definition at line 77 of file perfmon.h.

Referenced by print().

ptime

float libMesh::PerfMon::ptime

private

Definition at line 80 of file perfmon.h.

Referenced by print(), and reset().

rtime

float libMesh::PerfMon::rtime

private

Definition at line 80 of file perfmon.h.

Referenced by print(), and reset().

the_time_start

struct timeval libMesh::PerfMon::the_time_start

private

Definition at line 73 of file perfmon.h.

Referenced by print(), and reset().

the_time_stop

struct timeval libMesh::PerfMon::the_time_stop

private

Definition at line 74 of file perfmon.h.

Referenced by print().

verbose

const unsigned int libMesh::PerfMon::verbose

private

Definition at line 76 of file perfmon.h.

Referenced by print().

---

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

• include/utils/perfmon.h