Octopus
clock_oct_m::clock_t Interface Reference

Detailed Description

Definition at line 138 of file clock.F90.

Private Member Functions

type(iteration_counter_t) pure function clock_constructor (time_step, initial_iteration)
 Initialize the clock with a given time step. More...
 

Member Function/Subroutine Documentation

◆ clock_constructor()

type(iteration_counter_t) pure function clock_oct_m::clock_t::clock_constructor ( real(8), intent(in), optional  time_step,
integer, intent(in), optional  initial_iteration 
)
private

Initialize the clock with a given time step.

The internal clock counter starts at zero or if the optional argument initial_value is given at the value of initial_value.

Note that the time step used by the clock might not be identical to the requested time step. This is because we need to enforce the time step to be a multiple of the minimum time step or otherwise the calculated time will not be an exact multiple of the time step.

Definition at line 154 of file clock.F90.


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