Octopus
clock_oct_m::clock_t Interface Reference

Detailed Description

Definition at line 128 of file clock.F90.

Private Member Functions

procedure print => clock_print
 print internal state of the clock More...
 
procedure print_str => clock_print_str
 print internal state of the clock to a string More...
 
procedure set_time => clock_set_time
 set the clock only to the time of a given input clock More...
 
procedure copy => clock_copy
 set the clock to the state of a given input clock More...
 
procedure get_tick => clock_get_tick
 get value of internal clock counter More...
 
procedure get_dt => clock_get_dt
 get value of the time step More...
 
procedure time => clock_time
 get the current physical simulation time of the clock More...
 
procedure reset => clock_reset
 set the internal clock counter back to zero More...
 
procedure clock_is_equal
 
generic operator => clock_is_equal
 
procedure clock_is_different
 
generic operator => clock_is_different
 
procedure clock_is_earlier
 
generic operator => clock_is_earlier
 
procedure clock_is_later
 
generic operator => clock_is_later
 
procedure clock_is_equal_or_earlier
 
generic operator => clock_is_equal_or_earlier
 
procedure clock_is_equal_or_later
 
generic operator => clock_is_equal_or_later
 
procedure clock_copy
 
generic assignment => clock_copy
 
procedure clock_add_tick
 
generic operator => clock_add_tick
 
procedure clock_subtract_tick
 
generic operator => clock_subtract_tick
 
procedure restart_write => clock_restart_write
 
procedure restart_read => clock_restart_read
 
type(clock_t) function clock_init (time_step, initial_tick)
 Initialize the clock with a given label and associated physical time step. The internal clock counter starts at zero or if the optional argument initial_tick is given at the value of initial_tick. More...
 

Private Attributes

integer tick
 internal clock counter which is incremented by one when the clock is advanced More...
 
real(8) time_step
 physical simulation time increment which corresponds to a single clock tick More...
 
real(8) time_
 physical simulation time More...
 

Member Function/Subroutine Documentation

◆ print()

procedure clock_oct_m::clock_t::print
private

print internal state of the clock

Definition at line 134 of file clock.F90.

◆ print_str()

procedure clock_oct_m::clock_t::print_str
private

print internal state of the clock to a string

Definition at line 135 of file clock.F90.

◆ set_time()

procedure clock_oct_m::clock_t::set_time
private

set the clock only to the time of a given input clock

Definition at line 136 of file clock.F90.

◆ copy()

procedure clock_oct_m::clock_t::copy
private

set the clock to the state of a given input clock

Definition at line 137 of file clock.F90.

◆ get_tick()

procedure clock_oct_m::clock_t::get_tick
private

get value of internal clock counter

Definition at line 138 of file clock.F90.

◆ get_dt()

procedure clock_oct_m::clock_t::get_dt
private

get value of the time step

Definition at line 139 of file clock.F90.

◆ time()

procedure clock_oct_m::clock_t::time
private

get the current physical simulation time of the clock

Definition at line 140 of file clock.F90.

◆ reset()

procedure clock_oct_m::clock_t::reset
private

set the internal clock counter back to zero

Definition at line 141 of file clock.F90.

◆ clock_is_equal()

procedure clock_oct_m::clock_t::clock_is_equal
private

Definition at line 142 of file clock.F90.

◆ operator() [1/8]

generic clock_oct_m::clock_t::operator
private

Definition at line 143 of file clock.F90.

◆ clock_is_different()

procedure clock_oct_m::clock_t::clock_is_different
private

Definition at line 144 of file clock.F90.

◆ operator() [2/8]

generic clock_oct_m::clock_t::operator
private

Definition at line 145 of file clock.F90.

◆ clock_is_earlier()

procedure clock_oct_m::clock_t::clock_is_earlier
private

Definition at line 146 of file clock.F90.

◆ operator() [3/8]

generic clock_oct_m::clock_t::operator
private

Definition at line 147 of file clock.F90.

◆ clock_is_later()

procedure clock_oct_m::clock_t::clock_is_later
private

Definition at line 148 of file clock.F90.

◆ operator() [4/8]

generic clock_oct_m::clock_t::operator
private

Definition at line 149 of file clock.F90.

◆ clock_is_equal_or_earlier()

procedure clock_oct_m::clock_t::clock_is_equal_or_earlier
private

Definition at line 150 of file clock.F90.

◆ operator() [5/8]

generic clock_oct_m::clock_t::operator
private

Definition at line 151 of file clock.F90.

◆ clock_is_equal_or_later()

procedure clock_oct_m::clock_t::clock_is_equal_or_later
private

Definition at line 152 of file clock.F90.

◆ operator() [6/8]

generic clock_oct_m::clock_t::operator
private

Definition at line 153 of file clock.F90.

◆ clock_copy()

procedure clock_oct_m::clock_t::clock_copy
private

Definition at line 154 of file clock.F90.

◆ assignment()

generic clock_oct_m::clock_t::assignment
private

Definition at line 155 of file clock.F90.

◆ clock_add_tick()

procedure clock_oct_m::clock_t::clock_add_tick
private

Definition at line 156 of file clock.F90.

◆ operator() [7/8]

generic clock_oct_m::clock_t::operator
private

Definition at line 157 of file clock.F90.

◆ clock_subtract_tick()

procedure clock_oct_m::clock_t::clock_subtract_tick
private

Definition at line 158 of file clock.F90.

◆ operator() [8/8]

generic clock_oct_m::clock_t::operator
private

Definition at line 159 of file clock.F90.

◆ restart_write()

procedure clock_oct_m::clock_t::restart_write
private

Definition at line 160 of file clock.F90.

◆ restart_read()

procedure clock_oct_m::clock_t::restart_read
private

Definition at line 161 of file clock.F90.

◆ clock_init()

type(clock_t) function clock_oct_m::clock_t::clock_init ( real(8), intent(in), optional  time_step,
integer, intent(in), optional  initial_tick 
)
private

Initialize the clock with a given label and associated physical time step. The internal clock counter starts at zero or if the optional argument initial_tick is given at the value of initial_tick.

Definition at line 174 of file clock.F90.

Member Data Documentation

◆ tick

integer clock_oct_m::clock_t::tick
private

internal clock counter which is incremented by one when the clock is advanced

Definition at line 130 of file clock.F90.

◆ time_step

real(8) clock_oct_m::clock_t::time_step
private

physical simulation time increment which corresponds to a single clock tick

Definition at line 131 of file clock.F90.

◆ time_

real(8) clock_oct_m::clock_t::time_
private

physical simulation time

Definition at line 132 of file clock.F90.


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