research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Cleaned up Doxygen docs for class clockWC

Browse source
This commit is contained in:
Ray Speth 2013-04-18 22:07:11 +00:00
parent 71bc4afe3b
commit 9a4b843d5e
2 changed files with 9 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
include/cantera/base/clockWC.h
View file

@ -62,6 +62,14 @@ public:
double start();
//! Returns the wall clock time in seconds since the last reset.
/*!
* Returns system cpu and wall clock time in seconds. This is a strictly
* Ansi C timer, since clock() is defined as an Ansi C function. On some
* machines clock() returns type unsigned long (HP) and on others (SUN)
* it returns type long. An attempt to recover the actual time for clocks
* which have rolled over is made also. However, it only works if this
* function is called fairly regularily during the solution procedure.
*/
double secondsWC();
private:

19
src/base/clockWC.cpp
View file

@ -12,10 +12,9 @@
#include <time.h>
#include "cantera/base/clockWC.h"
namespace Cantera
{
clockWC::clockWC() :
last_num_ticks(clock()),
clock_rollovers(0u),
@ -26,9 +25,6 @@ clockWC::clockWC() :
start_ticks = last_num_ticks;
}
/*
* Reinitialize the tick counters within the object
*/
double clockWC::start()
{
start_ticks = last_num_ticks = clock();
@ -36,19 +32,6 @@ double clockWC::start()
return 0.0;
}
/*
* Returns system cpu and wall clock time in seconds. This
* is a strictly Ansi C timer, since clock() is defined as an
* Ansi C function. On some machines clock() returns type
* unsigned long (HP) and on others (SUN) it returns type long.
* An attempt to recover the actual time for clocks which have
* rolled over is made also. However, it only works if this
* function is called fairly regularily during
* the solution procedure.
*
* clock() -> returns the time in microseconds. Division by
* the macro CLOCKS_PER_SEC recovers the time in seconds.
*/
double clockWC::secondsWC()
{
clock_t num_ticks = clock();