The Open FUSION Toolkit 1.0.0-8905cc5
Modeling tools for plasma and fusion research and engineering
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
oft_timer Type Reference

Detailed Description

Simple timer class.

Public Member Functions

procedure int_tock (self)
 Get elapsed time since tick/tock in integer counts.
 
procedure tick (self)
 Start or reset timer.
 
procedure timeout (self, timeout)
 Check if time since tick/tock exceeds a limit.
 
procedure tock (self)
 Set elapsed time since tick/tock.
 

Public Attributes

integer(i8count = 0
 Integer value of system clock at last call.
 

Member Function/Subroutine Documentation

◆ int_tock()

procedure int_tock ( class(oft_timer), intent(inout)  self)

Get elapsed time since tick/tock in integer counts.

Parameters
[in,out]selfCalling timer class
Returns
Number of integer counts since last tick/tock
Parameters
[in,out]selfCalling timer class
Returns
Number of integer counts since last tick/tock

◆ tick()

procedure tick ( class(oft_timer), intent(inout)  self)

Start or reset timer.

Parameters
[in,out]selfCalling timer class

◆ timeout()

procedure timeout ( class(oft_timer), intent(inout)  self,
real(r8), intent(in)  timeout 
)

Check if time since tick/tock exceeds a limit.

Parameters
[in,out]selfCalling timer class
[in]timeoutLength of timeout (seconds)

◆ tock()

procedure tock ( class(oft_timer), intent(inout)  self)

Set elapsed time since tick/tock.

Parameters
[in,out]selfCalling timer class
Returns
Time since last tick/tock

Member Data Documentation

◆ count

integer(i8) count = 0

Integer value of system clock at last call.


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