clockTime Class Reference

Starts timing and returns elapsed time from start. Uses std::chrono::high_resolution_clock for better resolution (2uSec instead of ~20mSec) than cpuTime. More...

#include <clockTime.H>

Public Member Functions
	clockTime ()
	Construct with the current clock value for the start point.
	clockTime (const clockValue &clockval)
	Implicit construct from the clock value as the start point.
void	resetTime ()
	Reset to use the current clock value for the start and increment points.
void	resetTimeIncrement () const
	Reset to use the current clock value for the increment point.
double	elapsedTime () const
	The time [seconds] since the start point.
double	timeIncrement () const
	The time [seconds] since the last call to elapsedTime(), timeIncrement() or resetTime(), resetTimeIncrement().

Detailed Description

Starts timing and returns elapsed time from start. Uses std::chrono::high_resolution_clock for better resolution (2uSec instead of ~20mSec) than cpuTime.

Note

It has twice the storage requirement of a simple clockValue since it tracks both total and incremental elapsed times. Additionally, it always invokes a clock query on construction which may make it less desirable for arrays of values (for example).

See also

Foam::clockValue

Source files

• clockTime.H
• clockTimeI.H

Definition at line 58 of file clockTime.H.

Constructor & Destructor Documentation

clockTime() [1/2]

clockTime ( )

inline

Construct with the current clock value for the start point.

Definition at line 23 of file clockTimeI.H.

clockTime() [2/2]

clockTime ( const clockValue & clockval )

inline

Implicit construct from the clock value as the start point.

Definition at line 30 of file clockTimeI.H.

Member Function Documentation

resetTime()

void resetTime ( )

inline

Reset to use the current clock value for the start and increment points.

Definition at line 39 of file clockTimeI.H.

resetTimeIncrement()

void resetTimeIncrement ( ) const

inline

Reset to use the current clock value for the increment point.

Definition at line 46 of file clockTimeI.H.

elapsedTime()

double elapsedTime ( ) const

inline

The time [seconds] since the start point.

Definition at line 52 of file clockTimeI.H.

timeIncrement()

double timeIncrement ( ) const

inline

The time [seconds] since the last call to elapsedTime(), timeIncrement() or resetTime(), resetTimeIncrement().

Definition at line 59 of file clockTimeI.H.

Referenced by TDACChemistryModel< psiReactionThermo, constGasHThermoPhysics >::solve().

Here is the caller graph for this function:

---

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

• src/OpenFOAM/global/clockTime/clockTime.H
• src/OpenFOAM/global/clockTime/clockTimeI.H