Octopus
clock_oct_m::clock_t Interface Reference

Detailed Description

Definition at line 147 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(real64), 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
: 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.
: The clock_constructor() does not return an object of type clock_t, but and iteration_counter_t. The extra functionality of returning a 'real' clock, is not achieved by polymorphism (overloading), but by assigning the function pointer clock_tvalue to the function clock_time() rather than iteration_counter_value().

Definition at line 167 of file clock.F90.


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