12.1.5 Get Value Timer Functions

The Get Value Timer functions return values from a Timer object. Local or global values can be returned by specifying the Global logical input variable. Note that if the Timer object is currently running, data from the current timing is not included. Therefore, it is more meaningful to call these routines after calling Stop_Timer.

Calling syntax:

Output = Arithmetic_Mean (Timer, Clock, Global, Split)	,
Output = Average (Timer, Clock, Global, Split)	,
Output = Count (Timer, Clock, Global, Split)	,
Output = Geometric_Mean (Timer, Clock, Global, Split)	,
Output = Harmonic_Mean (Timer, Clock, Global, Split)	,
Output = Maximum (Timer, Clock, Global, Split)	,
Output = Mean (Timer, Clock, Global, Split)	,
Output = Minimum (Timer, Clock, Global, Split)	,
Output = Name (Timer)	,
Output = Standard_Deviation (Timer, Clock, Global, Split)	,
Output = Sum (Timer, Clock, Global, Split)	,
Output = Total (Timer, Clock, Global, Split)	or
Output = Totally_Positive (Timer, Clock, Global, Split)

Mean and Average are alternate interface names for the Arithmetic_Mean Procedure, and Total is an alternate interface name for the Sum Procedure.

Note that some combinations of options will return values that, while correct, have little useful meaning. For example, the function Total(Timer, Clock=``Wall_Clock'', Global=.true., Split=.false.) will return the total wall-clock time summed over all the processors, whereas a more meaningful value would be the maximum wall-clock time over all the processors, given by Maximum(Timer, Clock=``Wall_Clock'', Global=.true., Split=.false.) .

Input variables:

	Timer		The Timer object to be examined.
	Clock		Should have a value of ``CPU'' or ``Wall_Clock''. Default is ``CPU''. [Optional]
	Global		If present and true, the function does a global update and then returns the global value. Otherwise, the local PE value is returned. [Optional]
	Split		If present and true, the function returns values based on the individual split times, that is, for all the times that the timer was started and stopped. This can be either local (all the splits on a PE) or global (all the splits on all the PEs). If Split is false or absent, the function returns values based on the total times on each PE. If both Split and Global are false, the function returns values based on the single entry of the total time on the local PE. [Optional]

Output variables:

Output

For Name, returns a character variable containing the name assigned to the object upon initialization. For Count, returns the integer number of values in the Timer object (i.e. the number of splits). For Totally_Positive, returns a logical which is true only if all the values are positive. For all other functions, returns a real variable with the named value for the Timer object. Note that the values returned by Geometric_Mean and Harmonic_Mean have no significance if Totally_Positive is false.

The Get Value Timer code listing contains additional documentation.