olb::util::Timer< T > Class Template Reference

How to use in Code: More...

#include <timer.h>

Collaboration diagram for olb::util::Timer< T >:

Public Member Functions
	Timer (int maxTimeSteps, std::size_t numFluidCells=1, unsigned int printModeSummary=0)
	initializes timer with the given values, abbreviation to Timer() + initialize(int,int)
T	timevalDiffTimeMs (timeval end, timeval start)
	returns the time difference between two timeval objects in ms
T	getMLUPs ()
	returns Million DESCRIPTOR Site Updates per second (all processes together)
T	getMLUPps ()
	returns Million DESCRIPTOR Site Updates per second and process
T	getTotalMLUPs ()
	returns average Million DESCRIPTOR Site Updates per second between start() and stop()
T	getTotalMLUPps ()
	returns average Million DESCRIPTOR Site Updates per second and process between start() and stop()
void	start ()
	(Re-)sets start value for time measurement.
void	update (int currentTimeStep)
	Updates all time values of interest during computation.
void	stop ()
	Terminates time measurement and sets end value.
double	getTotalCpuTime ()
	Returns the total cpu time in seconds between start() and stop().
T	getTotalRealTime ()
	Returns the total measured time between start() and stop() in seconds.
T	getTotalRealTimeMs ()
	Returns the total measured time between start() and stop() in ms.
void	printStep (int printMode=0)
	Prints a one-line-summary of the values calculated in update() for use during computation.
void	printStep (OstreamManager &fout, int printMode=0)
void	print (std::size_t currentTimeStep, int printMode=0)
	Performs an update() followed by a printStep().
void	printSummary ()
	Prints a (short) summary containing the overall time consumption in real and in cpu time for use after computation.
void	printSummary (OstreamManager &fout)
void	printShortSummary ()
	Prints a short summary containing only time consumptions (real and cpu time)
void	printShortSummary (OstreamManager &fout)

Detailed Description

template<typename T>
class olb::util::Timer< T >

How to use in Code:

Timer timer;
timer.inizialize();

timer.start();

loop(i=1..iMax)
{
  do_some_calculation();
  timer.print(i);
} end_loop;

timer.stop();

timer.printSummary();

class for measurement of computation time

Definition at line 72 of file timer.h.

Constructor & Destructor Documentation

Timer()

template<typename T >

olb::util::Timer< T >::Timer	(	int	maxTimeSteps,
		std::size_t	numFluidCells = 1,
		unsigned int	printModeSummary = 0 )

initializes timer with the given values, abbreviation to Timer() + initialize(int,int)

Definition at line 36 of file timer.hh.

  : clout(std::cout,"Timer"),
    deltaTS(0), curTS(0), maxTS(maxTimeSteps),
    numFC(numFluidCells), rtRemMs(1) // avoids some stupid numbers in first call of printStep() (not for T=double)
 
{
  tp = nullptr;
  this->_printModeSummary = printModeSummary;
}

Member Function Documentation

getMLUPps()

template<typename T >

T olb::util::Timer< T >::getMLUPps

(

)

returns Million DESCRIPTOR Site Updates per second and process

Definition at line 62 of file timer.hh.

{
  T mlupps = getMLUPs()/singleton::mpi().getSize();
#ifdef PARALLEL_MODE_OMP
  mlupps /= singleton::omp().getSize();
#endif
  return mlupps;
}

References olb::singleton::MpiManager::getSize(), olb::ompManager::getSize(), olb::singleton::mpi(), and olb::singleton::omp().

Here is the call graph for this function:

getMLUPs()

template<typename T >

T olb::util::Timer< T >::getMLUPs

(

)

returns Million DESCRIPTOR Site Updates per second (all processes together)

Definition at line 55 of file timer.hh.

{
  T mlups = (numFC * deltaTS) / (timevalDiffTimeMs(msTimeCur, msTimeLast)*1000);
  return mlups;
}

getTotalCpuTime()

template<typename T >

double olb::util::Timer< T >::getTotalCpuTime

(

)

Returns the total cpu time in seconds between start() and stop().

Definition at line 134 of file timer.hh.

{
  return (cpuTimeEnd-cpuTimeStart)/CLOCKS_PER_SEC;
}

getTotalMLUPps()

template<typename T >

T olb::util::Timer< T >::getTotalMLUPps

(

)

returns average Million DESCRIPTOR Site Updates per second and process between start() and stop()

Definition at line 79 of file timer.hh.

{
  T tmlupps = getTotalMLUPs()/singleton::mpi().getSize();
#ifdef PARALLEL_MODE_OMP
  tmlupps /= singleton::omp().getSize();
#endif
  return tmlupps;
}

References olb::singleton::MpiManager::getSize(), olb::ompManager::getSize(), olb::singleton::mpi(), and olb::singleton::omp().

Here is the call graph for this function:

getTotalMLUPs()

template<typename T >

T olb::util::Timer< T >::getTotalMLUPs

(

)

returns average Million DESCRIPTOR Site Updates per second between start() and stop()

Definition at line 72 of file timer.hh.

{
  T tmlups = (numFC * curTS) / double(timevalDiffTimeMs(msTimeEnd, msTimeStart)*1000);
  return tmlups;
}

getTotalRealTime()

template<typename T >

T olb::util::Timer< T >::getTotalRealTime

(

)

Returns the total measured time between start() and stop() in seconds.

Definition at line 140 of file timer.hh.

{
  return difftime(sTimeEnd,sTimeStart);
}

getTotalRealTimeMs()

template<typename T >

T olb::util::Timer< T >::getTotalRealTimeMs

(

)

Returns the total measured time between start() and stop() in ms.

Definition at line 146 of file timer.hh.

{
  return timevalDiffTimeMs(msTimeEnd, msTimeStart);
}

print()

template<typename T >

void olb::util::Timer< T >::print	(	std::size_t	currentTimeStep,
		int	printMode = 0 )

Performs an update() followed by a printStep().

Automatically calls the function update(currentTimeStep) (if not yet done with currentTimeStep) and displays the timer's during-iteration-information.

Parameters

currentTimeStep	current iteration value, e.g. i or iT
printMode	mode of display style passed to printStep()

See also

printStep()

Definition at line 152 of file timer.hh.

{
  if (currentTimeStep!=curTS) {
    update(currentTimeStep);
  }
  printStep(printMode);
}

printShortSummary() [1/2]

template<typename T >

void olb::util::Timer< T >::printShortSummary

(

)

Prints a short summary containing only time consumptions (real and cpu time)

Definition at line 244 of file timer.hh.

{
  printShortSummary(clout);
}

printShortSummary() [2/2]

template<typename T >

void olb::util::Timer< T >::printShortSummary

(

OstreamManager &

fout

)

Definition at line 250 of file timer.hh.

{
  fout << "realTime=" << (int)getTotalRealTimeMs()/1000 << "." << (int)getTotalRealTimeMs()-(int)getTotalRealTimeMs()/1000*1000
       << "; cpuTime=" <<  std::setprecision(3) << std::fixed << getTotalCpuTime() << std::endl;
}

printStep() [1/2]

template<typename T >

void olb::util::Timer< T >::printStep

(

int

printMode = 0

)

Prints a one-line-summary of the values calculated in update() for use during computation.

Displays timer informations about current calculation with two different output modes. Before calling printStep() one should first recalculate all values with update().

Parameters

printMode

Value for selecting style of output. 0 = default semicolon-separated single row mode without cpu-time 1 = single row mode without cpu-time 2 = nicely formatted two-line layout including current and remaining cpu-time

See also

update()

Definition at line 161 of file timer.hh.

{
  printStep(clout, printMode);
}

printStep() [2/2]

template<typename T >

void olb::util::Timer< T >::printStep	(	OstreamManager &	fout,
		int	printMode = 0 )

Definition at line 167 of file timer.hh.

{
  switch (printMode) {
  case 0: //single-line layout, usable for data extraction as csv
    fout
        << "step=" << curTS << "; "
        //      << "stepMax=" << maxTS << "; "
        << "percent=" << 100.0*curTS/maxTS << "; "
        << "passedTime=" << (double)rtPasMs/1000 << "; "
        //      << "totalTime=" << (double)rtTotMs/1000 << "; "
        << "remTime=" << rtRemMs/1000 << "; "
        << "MLUPs=" << getMLUPs()
        << std::endl;
    break;
 
  case 1: //single-line layout (not conform with output-rules)
    fout
        << "latticeTS: "
        << curTS << "/" << maxTS << " (" << 100*curTS/maxTS << "%); "
        << "pas/totTime: "
        << std::setprecision(2) << std::fixed << (double)rtPasMs/1000 << "/"
        << std::setprecision(1) << std::fixed << (double)rtTotMs/1000 << "s; "
        << "remTime: "
        << std::setw(2) << (int)((double)rtRemMs/1000)/60 << "m " << std::setfill('0') << std::setw(4) << (double)((int)((double)rtRemMs/100)%600)/10 << "s; "
        << std::setfill(' ')
        << "MLUPs: " << getMLUPs()
        << std::endl;
    break;
 
  case 2: //pretty double line layout in colums, but non-conform
    fout
        << std::setw(21) << std::left << "Lattice-Timesteps"
        << std::setw(17) << std::left << "| CPU time/estim"
        << std::setw(18) << std::left << "| REAL time/estim"
        << std::setw(6)  << std::left << "| ETA"
        << std::setw(6)  << std::left << "| MLUPs"
        << std::endl << std::right
        << std::setw(6) << std::setprecision(2) << std::fixed << curTS << "/" << std::setw(6) << maxTS << " (" << std::setw(3) << 100*curTS/maxTS << "%) |"
        << std::setw(7) << ctPas << "/" << std::setw(7) << ctTot << " |"
        << std::setw(8) << (double)rtPasMs/1000 << "/" << std::setw(7) << (double)rtTotMs/1000 << " |"
        << std::setw(4) << (int)rtRemMs/1000+1 << " |"
        << std::setw(6) << getMLUPs()
        << std::endl;
    break;
 
  case 3: //performance output only
    fout
        << "step " << curTS << "; "
        << "MLUPs=" << std::setw(8) << getMLUPs() << ", MLUPps=" << std::setw(8) << getMLUPps() << std::endl;
    break;
 
  default:
    fout << "Error in function printStep in class_timer.h: printMode="<<printMode<<" not found" << std::endl << std::flush;
  }
}

printSummary() [1/2]

template<typename T >

void olb::util::Timer< T >::printSummary

(

)

Prints a (short) summary containing the overall time consumption in real and in cpu time for use after computation.

Definition at line 224 of file timer.hh.

{
  printSummary(clout);
}

printSummary() [2/2]

template<typename T >

void olb::util::Timer< T >::printSummary

(

OstreamManager &

fout

)

Definition at line 230 of file timer.hh.

{
  fout << std::endl;
  fout << "----------------Summary:Timer----------------" << std::endl;
  fout << "measured time (rt) : " << (int)getTotalRealTimeMs()/1000 << "." << (int)getTotalRealTimeMs()-(int)getTotalRealTimeMs()/1000*1000 << "s" << std::endl;
  fout << "measured time (cpu): " << std::setprecision(3) << std::fixed << getTotalCpuTime() << "s" << std::endl;
  if (numFC > 0 && curTS > 0) {
    fout << "average MLUPs :       " << getTotalMLUPs()  << std::endl;
    fout << "average MLUPps:       " << getTotalMLUPps() << std::endl;
  }
  fout << "---------------------------------------------" << std::endl;
}

start()

template<typename T >

void olb::util::Timer< T >::start

(

)

(Re-)sets start value for time measurement.

Definition at line 90 of file timer.hh.

{
  sTimeStart = time(tp);          // time in s
  gettimeofday(&msTimeStart, nullptr);  // time in ms
  gettimeofday(&msTimeCur, nullptr);    // time in ms, here only necessary for MLUP-calculations
  cpuTimeStart = clock();         //cpu-time
}

stop()

template<typename T >

void olb::util::Timer< T >::stop

(

)

Terminates time measurement and sets end value.

It is necessary to call this function immediately after the computation loop has terminated. Otherwise printSummary() would display incorrect values.

See also

printSummary()

Definition at line 126 of file timer.hh.

{
  cpuTimeEnd = clock();           // cpu-time
  sTimeEnd = time(tp);            // time in s
  gettimeofday(&msTimeEnd, nullptr);    // time in ms
}

timevalDiffTimeMs()

template<typename T >

T olb::util::Timer< T >::timevalDiffTimeMs	(	timeval	end,
		timeval	start )

returns the time difference between two timeval objects in ms

The timeval data type is used in the variables for ms-time measurement.

See also

getTotalRealTimeMs

Definition at line 47 of file timer.hh.

{
  const T msDiff ( 1000*(end.tv_sec - start.tv_sec)
                  +(end.tv_usec-start.tv_usec)/1000 );
  return util::max<T>(msDiff, 1.0);
}

update()

template<typename T >

void olb::util::Timer< T >::update

(

int

currentTimeStep

)

Updates all time values of interest during computation.

i.e. elapsed time, remaining time and total time. Recommended to be used directly before printStep to output up-to-date values.

Definition at line 99 of file timer.hh.

{
 
  cpuTimeCur = clock();           // CPU-time
  sTimeCur   = time(tp);          // time in s
  msTimeLast = msTimeCur;
  gettimeofday(&msTimeCur, nullptr);    // time in ms
 
  // calculate and update missing time-values
  deltaTS = currentTimeStep - curTS;      // this makes multiple calls
  curTS   = currentTimeStep;              // of update() critical
 
  rtPas   = difftime(sTimeCur,sTimeStart);                // here calculation is based on s-time
  rtTot   = rtPas*maxTS/util::max<int>(curTS, 1);
  rtRem   = rtTot-rtPas;
 
  rtPasMs = timevalDiffTimeMs(msTimeCur, msTimeStart);    // here with ms-time as timeval-value
  rtTotMs = rtPasMs*maxTS/util::max<int>(curTS, 1);
  rtRemMs = rtTotMs-rtPasMs;
 
  ctPas   = (cpuTimeCur-cpuTimeStart)/CLOCKS_PER_SEC;     // and here the same for CPU-time
  ctTot   = ctPas*maxTS/util::max<int>(curTS, 1);
  ctRem   = ctTot-ctPas;
 
}

---

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

• src/utilities/timer.h
• src/utilities/timer.hh