clock.F90

Go to the documentation of this file.

!! Copyright (C) 2023 M. Oliveira
!!
!! This program is free software; you can redistribute it and/or modify
!! it under the terms of the GNU General Public License as published by
!! the Free Software Foundation; either version 2, or (at your option)
!! any later version.
!!
!! This program is distributed in the hope that it will be useful,
!! but WITHOUT ANY WARRANTY; without even the implied warranty of
!! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
!! GNU General Public License for more details.
!!
!! You should have received a copy of the GNU General Public License
!! along with this program; if not, write to the Free Software
!! Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
!! 02110-1301, USA.
!!
 
#include "global.h"
 
module clock_oct_m
  use, intrinsic :: iso_fortran_env
  use global_oct_m
  use iteration_counter_oct_m
 
  implicit none
 
  private
 
  public :: clock_t, &
    clock_minimum_dt
 
  real(real64), parameter :: CLOCK_MINIMUM_DT = 1.0e-13_real64
 
  interface clock_t
    module procedure clock_constructor
  end interface clock_t
 
contains
 
  ! ---------------------------------------------------------
  type(iteration_counter_t) pure function clock_constructor(time_step, initial_iteration) result(clock)
    real(real64),   optional, intent(in) :: time_step
    integer, optional, intent(in) :: initial_iteration
 
    if (present(initial_iteration)) then
      clock%iteration = initial_iteration
    end if
    if (present(time_step)) then
      if (time_step > m_zero) then
        clock%step = int(time_step/clock_minimum_dt, int64)
      else
        clock%step = 1
      end if
    end if
    clock%global_iteration = clock%step * clock%iteration
 
    clock%value => clock_time
 
  end function clock_constructor
 
  ! ---------------------------------------------------------
  pure real(real64) function clock_time(this)
    class(iteration_counter_t), intent(in) :: this
 
    clock_time = this%global_iteration * clock_minimum_dt
 
  end function clock_time
 
end module clock_oct_m
 
!! Local Variables:
!! mode: f90
!! coding: utf-8
!! End: