Globals Library 1.0
Loading...
Searching...
No Matches
timing::tim Type Reference

Public Member Functions

procedure, pass, public init (this)
 Static constructor (public for type timing::tim).
procedure, pass, public kill (this)
 Static destructor (public for type timing::tim).
procedure, pass, public info (this, lun, add_msg, add_msg1, add_msg2)
 Outputs the content of the variable (public for type timing::tim).
procedure, pass, public set (this, code)
 Sets the current timing::tim vars (public for type timing::tim).

Public Attributes

real(kind=doublewct
 Actual value of wall-clock-time.
real(kind=doubleusr
 Actual value of user (cpu) time (summed across threads).
real(kind=doublecumwct
 Cumulated value of wall-clock-time.
real(kind=doublecumusr
 Cumulated value of user (cpu) time (summed across threads).
character(len=15) status
 Status variable: both command and stutus can be: start, stop, stac, accumulate and reset. Can be abbreviated using the first 3 characters of the word.

Detailed Description

Definition at line 10 of file modTiming.f90.

Member Function/Subroutine Documentation

◆ init()

procedure, pass, public timing::tim::init ( class(tim), intent(out) this)

Static constructor (public for type timing::tim).


Instantiate (allocate if necessary) and initilize (by also reading from input file) variable of type timing::tim.

Parameters
[out]thisObject of type timing::tim calling the constructor

Definition at line 25 of file modTiming.f90.

◆ kill()

procedure, pass, public timing::tim::kill ( class(tim), intent(inout) this)

Static destructor (public for type timing::tim).


Definition at line 27 of file modTiming.f90.

◆ info()

procedure, pass, public timing::tim::info ( class(tim), intent(in) this,
integer, intent(in) lun,
character(len=*), intent(in), optional add_msg,
character(len=*), intent(in), optional add_msg1,
character(len=*), intent(in), optional add_msg2 )

Outputs the content of the variable (public for type timing::tim).


Prints content of a variable of type timing::tim.

Parameters
[in]luninteger. output unit
[in]add_msgcharacter, optional. additional message to be printed.
[in]add_msg1character, optional. additional message to be printed.
[in]add_msg2character, optional. additional message to be printed.

Definition at line 29 of file modTiming.f90.

◆ set()

procedure, pass, public timing::tim::set ( class(tim), intent(inout) this,
character(len=*), intent(in), optional code )

Sets the current timing::tim vars (public for type timing::tim).


Parameters
[in]codecharacter, optional. Commands to start/stop/reset/accumulate stopwatch. If the variable is not given, the value of status will be used. Admissible values for code are two up to now are:
  1. start: starts stopwatch.
  2. stop: stops stopwatch and accumulates measured timing.

Definition at line 31 of file modTiming.f90.

Member Data Documentation

◆ wct

real(kind=double) timing::tim::wct

Actual value of wall-clock-time.

Definition at line 12 of file modTiming.f90.

◆ usr

real(kind=double) timing::tim::usr

Actual value of user (cpu) time (summed across threads).

Definition at line 14 of file modTiming.f90.

◆ cumwct

real(kind=double) timing::tim::cumwct

Cumulated value of wall-clock-time.

Definition at line 16 of file modTiming.f90.

◆ cumusr

real(kind=double) timing::tim::cumusr

Cumulated value of user (cpu) time (summed across threads).

Definition at line 18 of file modTiming.f90.

◆ status

character(len=15) timing::tim::status

Status variable: both command and stutus can be: start, stop, stac, accumulate and reset. Can be abbreviated using the first 3 characters of the word.

Definition at line 22 of file modTiming.f90.


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