dcdatetimecreate.f90

Go to the documentation of this file.

! -*- mode: f90; coding: utf-8 -*-
!-----------------------------------------------------------------------
! Copyright (c) 2000-2026 Gtool Development Group. All rights reserved.
!-----------------------------------------------------------------------
 
subroutine dcdatetimecreate1(time, &
  & year, mon, day, hour, min, sec, &
  & zone, zone_hour, zone_min, caltype, caltype_str, day_seconds, &
  & sclyear, sclmon, sclday, sclsec, err)
 
  use dc_date_generic, only: dcdifftimecreate, &
    & validcaltype, validzone, tochar
  use dc_date_internal, only: dcdate_set_day_seconds_scl
  use dc_date_types, only: dc_datetime, dc_difftime, &
    & caltype_default => caltype, &
    & flag_set_day_seconds_scl, day_seconds_scl, &
    & cyclic_mdays, cal_noleap, cal_julian, cal_cyclic, cal_gregorian, &
    & min_seconds, hour_seconds, four_years, year_months
  use dc_error, only: storeerror, dc_ebadcaltype, dc_ebadtimezone, dc_noerr
  use dc_message, only: messagenotify
  use dc_trace, only: beginsub, endsub
  use dc_present, only: present_select
  use dc_string, only: lchar, cprintf
  use dc_scaledsec, only: dc_scaled_sec, &
    & assignment(=), dcscaledsecputline, &
    & operator(==), operator(>), operator(<), operator(>=), operator(<=), &
    & operator(+), operator(-), operator(*), operator(/), mod, modulo, &
    & abs, int, sign, floor, dcscaledsecputline
  use dc_types,      only: dp, string
  implicit none
  type(dc_datetime), intent(out) :: time
  integer, intent(in), optional:: year
  integer, intent(in), optional:: mon
  integer, intent(in), optional:: day
  integer, intent(in), optional:: hour
  integer, intent(in), optional:: min
  real(DP),intent(in), optional:: sec
  character(*), intent(in), optional :: zone
  integer, intent(in), optional :: zone_hour
  integer, intent(in), optional :: zone_min
  integer, intent(in), optional:: caltype
  character(*), intent(in), optional:: caltype_str
  real(DP),intent(in), optional:: day_seconds
  type(dc_scaled_sec), intent(in), optional:: sclyear
  type(dc_scaled_sec), intent(in), optional:: sclmon
  type(dc_scaled_sec), intent(in), optional:: sclday
  type(dc_scaled_sec), intent(in), optional:: sclsec
  logical, intent(out), optional:: err
 
  real(DP):: gcsec
  integer :: gcday, gcmon, gcyear
  real(DP):: essec, esds
  integer :: esday
  type(dc_scaled_sec):: iday, imon, month, iyear, century, isec
  character(6) :: izone
  integer, parameter:: year_default = 0, mon_default = 1
  integer, parameter:: day_default = 1
  integer, parameter:: sec_default = 0
  logical :: current_time_used
  type(dc_difftime):: zonediff
  character(STRING):: zone_str_long
  integer :: stat, cause_i
  character(STRING) :: cause_c
  character(*), parameter :: subname = 'DCDateTimeCreate1'
continue
  current_time_used = .not. present(year) &
    & .and. .not. present(mon) &
    & .and. .not. present(day) &
    & .and. .not. present(hour) &
    & .and. .not. present(min) &
    & .and. .not. present(sec) &
    & .and. .not. present(sclyear) &
    & .and. .not. present(sclmon) &
    & .and. .not. present(sclday) &
    & .and. .not. present(sclsec)
  call beginsub(subname, 'current_time_used=<%y>', l=(/current_time_used/))
  stat = dc_noerr
  cause_i = dc_noerr
  cause_c = ''
 
  if ( present(day_seconds) ) then
    time % day_seconds = day_seconds
  else
    if ( .not. flag_set_day_seconds_scl ) call dcdate_set_day_seconds_scl
    time % day_seconds = day_seconds_scl
  end if
 
  call get_current_time(gcyear, gcmon, gcday, gcsec, izone) ! (out)
  iyear = gcyear
  imon = gcmon
  iday = gcday
  isec = gcsec
 
  if (.not. current_time_used) then
    if ( present(zone_hour) .or. present(zone_min) ) then
      call dcdifftimecreate( zonediff, &     ! (out)
        & hour = zone_hour, min = zone_min ) ! (in)
      zone_str_long = tochar(zonediff)
      if ( zone_str_long(1:1) == '-' ) then
        izone(1:1) = '-'
      else
        izone(1:1) = '+'
      end if
      izone(2:6) = zone_str_long(13:17)
    end if
    if (present(zone)) then
      izone = zone
    end if
    if ( .not. validzone(izone)) then
      stat = dc_ebadtimezone
      cause_c = izone
      if (present(err)) then
        call messagenotify('W', subname, &
          & 'zone=<%c> is invalid.', &
          & c1=trim(izone))
      else
        goto 999
      end if
    end if
 
    if ( present(sclsec) ) then
      isec = sclsec
    elseif( present(sec) ) then
      isec = sec
    else
      isec = sec_default
    end if
    if (present(min)) then
      isec = isec + min * min_seconds
    end if
    if (present(hour)) then
      isec = isec + hour * hour_seconds
    end if
 
    if ( present(sclday) ) then
      iday = sclday
    elseif( present(day) ) then
      iday = day
    else
      iday = day_default
    end if
 
    if ( present(sclday) ) then
      iday = sclday
    elseif( present(day) ) then
      iday = day
    else
      iday = day_default
    end if
    iday = iday + floor(isec / time % day_seconds)
 
    if ( present(sclmon) ) then
      imon = sclmon
    elseif( present(mon) ) then
      imon = mon
    else
      imon = mon_default
    end if
 
    if ( present(sclyear) ) then
      iyear = sclyear
    elseif( present(year) ) then
      iyear = year
    else
      iyear = year_default
    end if
  end if
 
  time % zone = izone
  time % sec = modulo(isec, time % day_seconds)
  time % caltype = caltype_default
  if (present(caltype_str)) then
    select case( lchar(trim(caltype_str)) )
    case('cyclic')
      time % caltype = cal_cyclic
    case('noleap')
      time % caltype = cal_noleap
    case('julian')
      time % caltype = cal_julian
    case('gregorian')
      time % caltype = cal_gregorian
    case('')
      time % caltype = cal_gregorian
    case default
      stat = dc_ebadcaltype
      cause_i = 0
      call messagenotify('W', subname, &
        & 'caltype=<%c> is invalid calender type.', &
        & c1 = trim(caltype_str) )
      if ( .not. present(err) ) then
        goto 999
      end if
    end select
  end if
 
  if (present(caltype)) then
    if (validcaltype(caltype)) then
      time % caltype = caltype
    else
      stat = dc_ebadcaltype
      cause_i = caltype
      if (present(err)) then
        call messagenotify('W', subname, &
          & 'caltype=<%d> is invalid calender type.', &
          & i=(/caltype/))
      else
        goto 999
      end if
    end if
  end if
  if (time % caltype == cal_cyclic) then
    time % day = int( iday + imon * cyclic_mdays )
    goto 999
  endif
  month = modulo(imon - 3, year_months) + 3
  iyear = iyear + int( (imon - month) / year_months )
  iday = iday + int( (month * 306 - 914) / 10 )
  if (time % caltype == cal_noleap) then
    time % day = iday + iyear * 365 + 90
  else
    iday = iday + int( (iyear * four_years - modulo(iyear * four_years, 4)) / 4 )
    if (time % caltype == cal_julian) then
      time % day = iday + 91
    elseif (iday < 640116) then
      time % day = iday + 91
    else
      century = (iyear - modulo(iyear, 100)) / 100 + 1
      time % day = iday - int( (century * 3 - modulo(century * 3, 4)) / 4 ) + 93
    endif
  endif
 
 
999 continue
  call storeerror(stat, subname, err, cause_c, cause_i)
  esday = time % day ; essec = time % sec ; esds = time % day_seconds
  call endsub(subname, 'time (caltype=%d, day=%d, sec=%f, zone=%c, day_seconds=%f)', &
    & i=(/time % caltype, esday/), d=(/essec, esds/), &
    & c1=trim(time % zone))
 
  contains
    subroutine get_current_time(jyear, jmon, jday, jsec, jzone)
      use dc_types, only: dp
      use dc_string, only: stod
      implicit none
      integer, intent(out) :: jyear, jmon, jday
      real(DP), intent(out) :: jsec
      character(*), intent(out) :: jzone
 
      integer :: date_time_values(1:8)
      character(5)  :: zone_raw
    continue
 
      call date_and_time(zone=zone_raw, values=date_time_values)
 
      jzone = zone_raw(1:3) // ":" // zone_raw(4:5)
 
      jyear = date_time_values(1)
      jmon  = date_time_values(2)
      jday  = date_time_values(3)
      jsec  = real(date_time_values(5), dp) * hour_seconds &
        &     + real(date_time_values(6), dp) * min_seconds &
        &     + real(date_time_values(7), dp)
 
    end subroutine get_current_time
 
end subroutine dcdatetimecreate1
 
 
subroutine dcdifftimecreate1(diff, &
  & year, mon, day, hour, min, sec, day_seconds, nondim, &
  & sclyear, sclmon, sclday, sclsec )
  use dc_date_internal, only: dcdate_normalize
  use dc_date_generic, only: validcaltype
  use dc_date_types, only: dc_difftime, &
    & day_seconds_default => day_seconds, &
    & min_seconds, hour_seconds, year_months
  use dc_message, only: messagenotify
  use dc_trace, only: beginsub, endsub, debug
  use dc_present, only: present_select
  use dc_scaledsec, only: dc_scaled_sec, &
    & assignment(=), dcscaledsecputline, &
    & operator(==), operator(>), operator(<), operator(>=), operator(<=), &
    & operator(+), operator(-), operator(*), operator(/), mod, modulo, &
    & abs, int, sign, floor
  use dc_string, only: cprintf
  use dc_types,      only: dp, string
  implicit none
  type(dc_difftime), intent(out) :: diff
  integer,  intent(in), optional:: year
  integer,  intent(in), optional:: mon
  integer,  intent(in), optional:: day
  integer,  intent(in), optional:: hour
  integer,  intent(in), optional:: min
  real(DP), intent(in), optional:: sec
  real(DP), intent(in), optional:: day_seconds
  real(DP), intent(in), optional:: nondim
  type(dc_scaled_sec), intent(in), optional:: sclyear
  type(dc_scaled_sec), intent(in), optional:: sclmon
  type(dc_scaled_sec), intent(in), optional:: sclday
  type(dc_scaled_sec), intent(in), optional:: sclsec
 
  type(dc_scaled_sec):: iyear, imon, iday, ihour, imin, isec
  integer, parameter:: year_default = 0, mon_default = 0
  integer, parameter:: day_default = 0, hour_default = 0, min_default = 0
  integer, parameter:: sec_default = 0
  real(DP):: essec, esds
  integer :: esmon, esday
  character(STRING):: endsub_msb
  logical:: dbg_mode
  character(*), parameter :: subname = 'DCDiffTimeCreate1'
continue
  call beginsub(subname)
 
  if ( present(nondim) ) then
    diff % nondim_flag = .true.
    diff % mon = 0
    diff % day = 0
    diff % sec = nondim
    goto 999
  else
    diff % nondim_flag = .false.
  end if
 
  if ( present(sclyear) ) then
    iyear = sclyear
  elseif( present(year) ) then
    iyear = year
  else
    iyear = year_default
  end if
 
  if ( present(sclmon) ) then
    imon = sclmon
  elseif( present(mon) ) then
    imon = mon
  else
    imon = mon_default
  end if
 
  if ( present(sclday) ) then
    iday = sclday
  elseif( present(day) ) then
    iday = day
  else
    iday = day_default
  end if
 
  ihour = present_select(.false., hour_default, hour)
  imin  = present_select(.false., min_default, min)
 
  if ( present(sclsec) ) then
    isec = sclsec
  elseif( present(sec) ) then
    isec = sec
  else
    isec = sec_default
  end if
 
  diff % mon = iyear * year_months + imon
  diff % day = iday
  diff % sec =   ihour * hour_seconds &
    &          + imin  * min_seconds &
    &          + isec
 
  if( present(day_seconds) ) then
    diff % day_seconds = day_seconds
  else
    diff % day_seconds = day_seconds_default
  end if
 
  call dcdate_normalize(diff % day, diff % sec, diff % day_seconds, diff % nondim_flag)
 
999 continue
  call debug( dbg_mode )
  if ( dbg_mode ) then
    esmon = diff % mon ; esday = diff % day
    essec = diff % sec ; esds = diff % day_seconds
    endsub_msb = &
      & cprintf( 'mon=%d, day=%d, sec=%f, day_seconds=%f, nondim_flag=%b', &
      &          i = (/ esmon, esday /), d = (/ essec, esds /), &
      &          l = (/ diff % nondim_flag /) )
  else
    endsub_msb = ''
  end if
  call endsub(subname, 'diff (%c)', c1 = trim(endsub_msb) )
end subroutine dcdifftimecreate1
 
 
subroutine dcdifftimecreate2d(diff, value, unit, unit_symbol, err)
  use dc_types, only: dp, string
  use dc_trace, only: beginsub, endsub
  use dc_error, only: storeerror, dc_ebadunit, dc_noerr
  use dc_string, only: strieq
  use dc_date_generic, only: dcdifftimecreate, parsetimeunits
  use dc_date_types, only: dc_difftime, &
    & unit_symbol_year, unit_symbol_month, unit_symbol_day, &
    & unit_symbol_hour, unit_symbol_min, unit_symbol_sec, unit_symbol_nondim, &
    & unit_symbol_err, &
    & min_seconds, hour_seconds, day_seconds, cyclic_mdays, year_months
  use dc_scaledsec, only: dc_scaled_sec, &
    & assignment(=), dcscaledsecputline, &
    & operator(==), operator(>), operator(<), operator(>=), operator(<=), &
    & operator(+), operator(-), operator(*), operator(/), mod, modulo, &
    & abs, int, sign, floor
  implicit none
  type(dc_difftime), intent(out) :: diff
  real(DP), intent(in) :: value
  character(*), intent(in) :: unit
  integer, intent(in), optional :: unit_symbol
  logical, intent(out), optional :: err
 
  real(DP):: essec
  integer :: esmon, esday
  integer :: stat, val_int
  type(dc_scaled_sec):: val_scl, val_dec
  character(STRING) :: cause_c
  integer:: symbol
 
  character(*), parameter :: subname = 'DCDiffTimeCreate2'
continue
  call beginsub(subname, 'value=%f', d=(/value/))
  stat = dc_noerr
  cause_c = ''
  symbol = unit_symbol_err
  if ( present(unit_symbol) ) then
    symbol = unit_symbol
  else
    symbol = parsetimeunits(unit)
  end if
 
  if ( symbol == unit_symbol_sec ) then
    call dcdifftimecreate(diff, sec=value)
    goto 999
  elseif ( symbol == unit_symbol_nondim ) then
    call dcdifftimecreate(diff, nondim=value)
    goto 999
  end if
 
  val_int = int(value)
  val_scl = int(value)
  val_dec = value - int(value)
 
  if ( symbol == unit_symbol_min ) then
    call dcdifftimecreate(diff, min = val_int, sclsec = val_dec * min_seconds)
  elseif ( symbol == unit_symbol_hour ) then
    call dcdifftimecreate(diff, hour = val_int, sclsec = val_dec * hour_seconds)
  elseif ( symbol == unit_symbol_day ) then
    call dcdifftimecreate(diff, sclday = val_scl, sclsec = val_dec * day_seconds)
  elseif ( symbol == unit_symbol_month ) then
    call dcdifftimecreate(diff, sclmon = val_scl, &
      & sclsec = int(val_dec * cyclic_mdays) * day_seconds)
  elseif ( symbol == unit_symbol_year ) then
    call dcdifftimecreate(diff, sclyear = val_scl, &
      & sclsec = int(val_dec * cyclic_mdays * year_months) * day_seconds)
  else
    stat = dc_ebadunit
    cause_c = unit
  end if
 
999 continue
  call storeerror(stat, subname, err, cause_c)
  esmon = diff % mon ; esday = diff % day ; essec = diff % sec
  call endsub(subname, 'diff (mon=%d, day=%d, sec=%f)', &
    & i=(/esmon, esday/), d=(/essec/))
end subroutine dcdifftimecreate2d
 
subroutine dcdifftimecreate2r(diff, value, unit, unit_symbol, err)
  use dc_types, only: dp
  use dc_date_generic, only: dcdifftimecreate
  use dc_date_types, only: dc_difftime
  implicit none
  type(dc_difftime), intent(out) :: diff
  real, intent(in) :: value
  character(*), intent(in) :: unit
  integer, intent(in), optional :: unit_symbol
  logical, intent(out), optional :: err
continue
  call dcdifftimecreate(diff, real( value, dp ), unit, unit_symbol, err)
end subroutine dcdifftimecreate2r
 
subroutine dcdifftimecreate2i(diff, value, unit, unit_symbol, err)
  use dc_types, only: dp
  use dc_date_generic, only: dcdifftimecreate
  use dc_date_types, only: dc_difftime
  implicit none
  type(dc_difftime), intent(out) :: diff
  integer, intent(in) :: value
  character(*), intent(in) :: unit
  integer, intent(in), optional :: unit_symbol
  logical, intent(out), optional :: err
continue
  call dcdifftimecreate(diff, real( value, dp ), unit, unit_symbol, err)
end subroutine dcdifftimecreate2i
 
subroutine dcdatetimecreatei(time, sec)
  use dc_types, only: dp
  use dc_date_types, only: dc_datetime
  use dc_date_generic, only: dcdatetimecreate
  use dc_scaledsec, only: dc_scaled_sec, assignment(=)
  implicit none
  type(dc_datetime), intent(out):: time
  integer, intent(in):: sec
continue
  call dcdatetimecreate(time, sec = real(sec, dp) )
end subroutine dcdatetimecreatei
 
subroutine dcdatetimecreater(time, sec)
  use dc_types, only: dp
  use dc_date_types, only: dc_datetime
  use dc_date_generic, only: dcdatetimecreate
  use dc_scaledsec, only: dc_scaled_sec, assignment(=)
  implicit none
  type(dc_datetime), intent(out):: time
  real, intent(in):: sec
continue
  call dcdatetimecreate(time, sec = real(sec, dp) )
end subroutine dcdatetimecreater
 
subroutine dcdatetimecreated(time, sec)
  use dc_types, only: dp
  use dc_date_types, only: dc_datetime
  use dc_date_generic, only: dcdatetimecreate
  use dc_scaledsec, only: dc_scaled_sec, assignment(=)
  implicit none
  type(dc_datetime), intent(out):: time
  real(DP), intent(in):: sec
continue
  call dcdatetimecreate(time, sec = sec)
end subroutine dcdatetimecreated
 
subroutine dcdifftimecreatei(diff, sec)
  use dc_types, only: dp
  use dc_date_types, only: dc_difftime
  use dc_date_generic, only: dcdifftimecreate
  use dc_scaledsec, only: dc_scaled_sec, assignment(=)
  implicit none
  type(dc_difftime), intent(out):: diff
  integer, intent(in):: sec
continue
  call dcdifftimecreate(diff, sec = real(sec, dp) )
end subroutine dcdifftimecreatei
 
subroutine dcdifftimecreater(diff, sec)
  use dc_types, only: dp
  use dc_date_types, only: dc_difftime
  use dc_date_generic, only: dcdifftimecreate
  use dc_scaledsec, only: dc_scaled_sec, assignment(=)
  implicit none
  type(dc_difftime), intent(out):: diff
  real, intent(in):: sec
continue
  call dcdifftimecreate(diff, sec = real(sec, dp) )
end subroutine dcdifftimecreater
 
subroutine dcdifftimecreated(diff, sec)
  use dc_types, only: dp
  use dc_date_types, only: dc_difftime
  use dc_date_generic, only: dcdifftimecreate
  use dc_scaledsec, only: dc_scaled_sec, assignment(=)
  implicit none
  type(dc_difftime), intent(out):: diff
  real(DP), intent(in):: sec
continue
  call dcdifftimecreate(diff, sec = sec)
end subroutine dcdifftimecreated
 
 
!-----------------------------------------------
! For backward compatibility
subroutine dcdatetimecreate1_bc(time, &
  & year, mon, day, hour, min, sec, &
  & zone, caltype, day_seconds, err)
  use dc_types, only: dp
  use dc_date_types, only: dc_datetime
  use dc_date_generic, only: dcdatetimecreate
  type(dc_datetime), intent(out):: time
  integer, intent(in), optional:: year, mon, day, hour, min
  real(DP),intent(in), optional:: sec, day_seconds
  character(*), intent(in), optional :: zone
  integer, intent(in), optional:: caltype
  logical, intent(out), optional:: err
continue
  call dcdatetimecreate( time, &
    & year, mon, day, hour, min, sec, &
    & zone, caltype, day_seconds = day_seconds, err = err )
end subroutine dcdatetimecreate1_bc
 
subroutine dcdifftimecreate1_bc(diff, &
  & year, mon, day, hour, min, sec, day_seconds)
  use dc_types, only: dp
  use dc_date_types, only: dc_difftime
  use dc_date_generic, only: dcdifftimecreate
  type(dc_difftime), intent(out) :: diff
  integer, intent(in), optional:: year, mon, day, hour, min
  real(DP),intent(in), optional:: sec, day_seconds
continue
  call dcdifftimecreate( diff, &
    & year, mon, day, hour, min, sec, day_seconds )
end subroutine dcdifftimecreate1_bc
 
subroutine dcdifftimecreate2_bc(diff, value, unit, err)
  use dc_types, only: dp
  use dc_date_types, only: dc_difftime
  use dc_date_generic, only: dcdifftimecreate
  type(dc_difftime), intent(out) :: diff
  real(DP), intent(in) :: value
  character(*), intent(in) :: unit
  logical, intent(out), optional :: err
continue
  call dcdifftimecreate( diff, value, unit, err = err )
end subroutine dcdifftimecreate2_bc