dc_date_types.f90

Go to the documentation of this file.

! -*- mode: f90; coding: utf-8 -*-
!-----------------------------------------------------------------------
! Copyright (c) 2000-2026 Gtool Development Group. All rights reserved.
!-----------------------------------------------------------------------
!>
!> @author    Youhei SASAKI, Yasuhiro MORIKAWA, Eizi TOYODA
!> @copyright Copyright (C) GFD Dennou Club, 2000-2026. All rights reserved. <br/>
!>            License is BSD-2-Clause. see [COPYRIGHT](@ref COPYRIGHT) in detail
!> @en
!> @brief Derived types and parameters for date and time
!> @details
!> Derived types, variables, parameters for "dc_date" are provided.
!> Calendar information is also managed in this module.
!>
!> @section date_types_types Derived types
!>
!> | Type         | Description                                             |
!> |--------------|---------------------------------------------------------|
!> | DC_DATETIME  | Represents date-time as a pair of ordinal day and second |
!> | DC_DIFFTIME  | Represents time difference like "X months later" or "X days ago" |
!>
!> @section date_types_units Unit strings and symbols
!>
!> | Parameter        | Description                                    |
!> |------------------|------------------------------------------------|
!> | UNIT_NONDIM      | Strings for nondimensional unit                |
!> | UNIT_SEC         | Strings for second unit                        |
!> | UNIT_MIN         | Strings for minute unit                        |
!> | UNIT_HOUR        | Strings for hour unit                          |
!> | UNIT_DAY         | Strings for day unit                           |
!> | UNIT_MONTH       | Strings for month unit                         |
!> | UNIT_YEAR        | Strings for year unit                          |
!> | UNIT_SYMBOL_*    | Integer symbols for units                      |
!>
!> @section date_types_cal Calendar parameters
!>
!> | Parameter        | Description                                    |
!> |------------------|------------------------------------------------|
!> | CAL_CYCLIC       | Cyclic calendar (30.6 days per month)          |
!> | CAL_NOLEAP       | Calendar without leap years (365 days/year)    |
!> | CAL_JULIAN       | Julian calendar                                |
!> | CAL_GREGORIAN    | Gregorian calendar                             |
!>
!> @section date_types_conv Conversion parameters
!>
!> | Parameter         | Description                                   |
!> |-------------------|-----------------------------------------------|
!> | CYCLIC_MDAYS      | Days per month for cyclic calendar (30.6)     |
!> | DAY_SECONDS_EARTH | Seconds per day on Earth (86400)              |
!> | MIN_SECONDS       | Seconds per minute (60)                       |
!> | HOUR_SECONDS      | Seconds per hour (3600)                       |
!> | YEAR_MONTHS       | Months per year (12)                          |
!> | YEAR_DAYS         | Days per year (non-leap year, 365)            |
!> | FOUR_YEARS        | Days in 4 years                               |
!> | FOUR_CENTURY      | Days in 400 years                             |
!>
!> @enden
!>
!> @ja
!> @brief 日付・時刻に関する構造データ型と定数
!> @details
!> dc_date で用いられる構造体や変数, 定数を提供します.
!> 暦法に関する情報もこのモジュールで管理しています.
!>
!> @section date_types_types_ja 派生型一覧
!>
!> | 型           | 説明                                                    |
!> |--------------|---------------------------------------------------------|
!> | DC_DATETIME  | 通日と通秒の対で日付時刻を表現                          |
!> | DC_DIFFTIME  | X ヶ月後, X 日前, などを表現                            |
!>
!> @section date_types_units_ja 単位文字列とシンボル
!>
!> | パラメータ       | 説明                                           |
!> |------------------|------------------------------------------------|
!> | UNIT_NONDIM      | 無次元時間の単位を示す文字列                   |
!> | UNIT_SEC         | 秒の単位を示す文字列                           |
!> | UNIT_MIN         | 分の単位を示す文字列                           |
!> | UNIT_HOUR        | 時間の単位を示す文字列                         |
!> | UNIT_DAY         | 日の単位を示す文字列                           |
!> | UNIT_MONTH       | 月の単位を示す文字列                           |
!> | UNIT_YEAR        | 年の単位を示す文字列                           |
!> | UNIT_SYMBOL_*    | 単位を示す整数シンボル                         |
!>
!> @section date_types_cal_ja 暦パラメータ
!>
!> | パラメータ       | 説明                                           |
!> |------------------|------------------------------------------------|
!> | CAL_CYCLIC       | 周期暦 (1ヶ月 30.6 日)                         |
!> | CAL_NOLEAP       | 閏年無しの暦 (1年 365 日)                      |
!> | CAL_JULIAN       | ユリウス暦                                     |
!> | CAL_GREGORIAN    | グレゴリオ暦                                   |
!>
!> @section date_types_conv_ja 変換パラメータ
!>
!> | パラメータ        | 説明                                          |
!> |-------------------|-----------------------------------------------|
!> | CYCLIC_MDAYS      | 周期暦での1ヶ月の日数 (30.6)                  |
!> | DAY_SECONDS_EARTH | 地球の1日の秒数 (86400)                       |
!> | MIN_SECONDS       | 1分の秒数 (60)                                |
!> | HOUR_SECONDS      | 1時間の秒数 (3600)                            |
!> | YEAR_MONTHS       | 1年の月数 (12)                                |
!> | YEAR_DAYS         | 1年 (非閏年) の日数 (365)                     |
!> | FOUR_YEARS        | 4年の日数                                     |
!> | FOUR_CENTURY      | 400年の日数                                   |
!>
!> @endja
!>
 
module dc_date_types
 
  use dc_types, only: dp, string
  use dc_scaledsec, only: dc_scaled_sec
 
  implicit none
 
  private
  public:: dc_datetime, dc_difftime
  public:: unit_nondim, unit_sec, unit_min, unit_hour, unit_day, unit_month, unit_year
  public:: unit_symbol_nondim, unit_symbol_sec, unit_symbol_min
  public:: unit_symbol_hour, unit_symbol_day, unit_symbol_month, unit_symbol_year
  public:: unit_symbol_err
  public:: cal_cyclic, cal_noleap, cal_julian, cal_gregorian
  public:: cyclic_mdays, day_seconds_earth, min_seconds, hour_seconds
  public:: year_months, year_days, four_years, four_century
  public:: prepared_caltypes
  public:: caltype, day_seconds, day_seconds_scl, flag_set_day_seconds_scl
 
  !> @en
  !> @name Calendar type parameters
  !> @{
  !> @enden
  !> @ja
  !> @name 暦タイプパラメータ
  !> @{
  !> @endja
 
  !> @en Cyclic calendar (30.6 days per month)
  !> @details
  !> A calendar where each month has 30.6 days (CYCLIC_MDAYS).
  !> (e.g., month 0: 1-30 (30.6), month 1: 1-31 (61.2),
  !> month 2: 1-30 (91.8), month 3: 1-31 (122.4), ...)
  !> Intended for use in experiments with virtual time.
  !> @enden
  !> @ja 周期暦 (1ヶ月 30.6 日)
  !> @details
  !> 1 ヵ月を 30.6 日 (CYCLIC_MDAYS) とする暦.
  !> (例: 0 ヶ月目は 1 〜 30 (30.6), 1 ヶ月目は 1 〜 31 (61.2),
  !> 2 ヶ月目は 1 〜 30 (91.8), 3 ヶ月目は 1 〜 31 (122.4), ...)
  !> 仮想的な時間で実験を行う場合に使用することを想定しています.
  !> @endja
  integer, parameter:: cal_cyclic = 1
 
  !> @en Calendar without leap years (365 days per year) @enden
  !> @ja 閏年無しの暦 (1年 365 日) @endja
  integer, parameter:: cal_noleap = 2
 
  !> @en Julian calendar @enden
  !> @ja ユリウス暦 @endja
  integer, parameter:: cal_julian = 3
 
  !> @en Gregorian calendar @enden
  !> @ja グレゴリオ暦 @endja
  integer, parameter:: cal_gregorian = 4
 
  !> @en Array of prepared calendar types @enden
  !> @ja 利用可能な暦タイプの配列 @endja
  integer, parameter:: prepared_caltypes(0:3) = &
    & (/CAL_CYCLIC, CAL_NOLEAP, CAL_JULIAN, CAL_GREGORIAN/)
 
  !> @en Default calendar type (Gregorian) @enden
  !> @ja デフォルトの暦タイプ (グレゴリオ暦) @endja
  integer, save:: caltype = cal_gregorian
 
  !> @}
 
  !> @en
  !> @name Time unit conversion parameters
  !> @{
  !> @enden
  !> @ja
  !> @name 時間単位変換パラメータ
  !> @{
  !> @endja
 
  !> @en Days per month for cyclic calendar (also used for DC_DIFFTIME) @enden
  !> @ja 周期暦での1ヶ月の日数 (DC_DIFFTIME の月換算にも使用) @endja
  real(dp), parameter:: cyclic_mdays = 30.6_dp
 
  !> @en Seconds per minute @enden
  !> @ja 1分の秒数 @endja
  integer, parameter:: min_seconds  = 60
 
  !> @en Seconds per hour @enden
  !> @ja 1時間の秒数 @endja
  integer, parameter:: hour_seconds = 3600
 
  !> @en Seconds per day on Earth @enden
  !> @ja 地球の1日の秒数 @endja
  real(dp), parameter:: day_seconds_earth  = 86400.0_dp
 
  !> @en Seconds per day (variable, default is Earth day) @enden
  !> @ja 1日の秒数 (可変, デフォルトは地球の1日) @endja
  real(dp), save :: day_seconds = day_seconds_earth
 
  !> @en Seconds per day (DC_SCALED_SEC type) @enden
  !> @ja 1日の秒数 (DC_SCALED_SEC 型) @endja
  type(dc_scaled_sec), save :: day_seconds_scl
 
  !> @en Flag indicating if day_seconds_scl is set @enden
  !> @ja day_seconds_scl が設定済みかどうかのフラグ @endja
  logical, save :: flag_set_day_seconds_scl = .false.
 
  !> @en Days per year (non-leap year) @enden
  !> @ja 1年 (非閏年) の日数 @endja
  integer, parameter:: year_days = 365
 
  !> @en Months per year @enden
  !> @ja 1年の月数 @endja
  integer, parameter:: year_months = 12
 
  !> @en Days in 4 years (including leap year) @enden
  !> @ja 4年の日数 (閏年を含む) @endja
  integer, parameter:: four_years = year_days * 4 + 1
 
  !> @en Days in 400 years @enden
  !> @ja 400年の日数 @endja
  integer, parameter:: four_century = year_days * 400 + 97
 
  !> @}
 
  !> @en
  !> @name Unit string parameters
  !> @{
  !> @enden
  !> @ja
  !> @name 単位文字列パラメータ
  !> @{
  !> @endja
 
  !> @en Strings recognized as nondimensional unit @enden
  !> @ja 無次元時間の単位を示す文字列 @endja
  character(*), parameter, dimension(1) :: unit_nondim = (/ &
    & '1' /)
 
  !> @en Strings recognized as second unit @enden
  !> @ja 秒の単位を示す文字列 @endja
  character(*), parameter, dimension(8) :: unit_sec = (/ &
    & 'seconds', 'second ', 'secs.  ', 'secs   ', &
    & 'sec.   ', 'sec    ', 's.     ', 's      '/)
 
  !> @en Strings recognized as minute unit @enden
  !> @ja 分の単位を示す文字列 @endja
  character(*), parameter, dimension(4) :: unit_min = (/ &
    & 'minutes', 'minute ', 'min.   ', 'min    '/)
 
  !> @en Strings recognized as hour unit @enden
  !> @ja 時間の単位を示す文字列 @endja
  character(*), parameter, dimension(8) :: unit_hour = (/ &
    & 'hours', 'hour ', 'hrs. ', 'hrs  ', &
    & 'hr.  ', 'hr   ', 'h.   ', 'h    '/)
 
  !> @en Strings recognized as day unit @enden
  !> @ja 日の単位を示す文字列 @endja
  character(*), parameter, dimension(4) :: unit_day = (/ &
    & 'days', 'day ', 'd.  ', 'd   '/)
 
  !> @en Strings recognized as month unit @enden
  !> @ja 月の単位を示す文字列 @endja
  character(*), parameter, dimension(6) :: unit_month = (/ &
    & 'months', 'month ', 'mon.  ', &
    & 'mon   ', 'mo.   ', 'mo    '/)
 
  !> @en Strings recognized as year unit @enden
  !> @ja 年の単位を示す文字列 @endja
  character(*), parameter, dimension(4) :: unit_year = (/ &
    & 'years', 'year ', 'yr.  ', 'yr   '/)
 
  !> @}
 
  !> @en
  !> @name Unit symbol parameters
  !> @{
  !> @enden
  !> @ja
  !> @name 単位シンボルパラメータ
  !> @{
  !> @endja
 
  !> @en Symbol for invalid unit @enden
  !> @ja 無効な単位を示すシンボル @endja
  integer, parameter:: unit_symbol_err    = -1
 
  !> @en Symbol for nondimensional unit @enden
  !> @ja 無次元時間の単位を示すシンボル @endja
  integer, parameter:: unit_symbol_nondim = 1
 
  !> @en Symbol for second unit @enden
  !> @ja 秒の単位を示すシンボル @endja
  integer, parameter:: unit_symbol_sec    = 2
 
  !> @en Symbol for minute unit @enden
  !> @ja 分の単位を示すシンボル @endja
  integer, parameter:: unit_symbol_min    = 3
 
  !> @en Symbol for hour unit @enden
  !> @ja 時間の単位を示すシンボル @endja
  integer, parameter:: unit_symbol_hour   = 4
 
  !> @en Symbol for day unit @enden
  !> @ja 日の単位を示すシンボル @endja
  integer, parameter:: unit_symbol_day    = 5
 
  !> @en Symbol for month unit @enden
  !> @ja 月の単位を示すシンボル @endja
  integer, parameter:: unit_symbol_month  = 6
 
  !> @en Symbol for year unit @enden
  !> @ja 年の単位を示すシンボル @endja
  integer, parameter:: unit_symbol_year   = 7
 
  !> @}
 
  !> @en
  !> @brief Derived type for date-time
  !> @details
  !> Represents date-time as a pair of ordinal day and ordinal second.
  !>
  !> When using variables of this derived type, always initialize them
  !> using dc_date#Create or dc_date#assignment(=).
  !> Do not modify internal variables such as *day* or *sec* directly.
  !>
  !> See "List" and "Usage" sections in dc_date for usage details.
  !> @enden
  !>
  !> @ja
  !> @brief 日付時刻を表現する派生型
  !> @details
  !> 通日と通秒の対で日付時刻を表現します.
  !>
  !> この構造データ型の変数を使用する際は必ず変数を
  !> dc_date#Create または dc_date#assignment(=)
  !> によって初期化してください. また, *day*, *sec* などの内部変数は
  !> 直接変更しないでください.
  !>
  !> 利用法は dc_date の "List" および "Usage" を参照してください.
  !> @endja
  type dc_datetime
    sequence
    integer :: caltype = cal_gregorian !< @en Calendar type @enden @ja 暦法 @endja
    type(dc_scaled_sec):: day          !< @en Day @enden @ja 日 @endja
    type(dc_scaled_sec):: sec          !< @en Seconds @enden @ja 秒 @endja
    logical:: dummy = .false.          !< @en Dummy for alignment @enden @ja 境界調整用ダミー @endja
    type(dc_scaled_sec):: day_seconds  !< @en Seconds per day @enden @ja 1日の秒数 @endja
    character(STRING) :: zone = '+00:00' !< @en Time zone (offset from UTC) @enden @ja UTCからの時差 @endja
  end type dc_datetime
 
  !> @en
  !> @brief Derived type for time difference
  !> @details
  !> A data type for expressing time differences like "X months later"
  !> or "X days ago".
  !>
  !> When using variables of this derived type, always initialize them
  !> using dc_date#Create or dc_date#assignment(=).
  !> Do not modify internal variables such as *day* or *sec* directly.
  !>
  !> See "List" and "Usage" sections in dc_date for usage details.
  !>
  !> Note: One month is converted using dc_date_types#CYCLIC_MDAYS.
  !> @enden
  !>
  !> @ja
  !> @brief 時間差を表現する派生型
  !> @details
  !> X ヶ月後, X 日前, などを表現するためのデータ型です.
  !>
  !> この構造データ型の変数を使用する際は必ず変数を
  !> dc_date#Create または dc_date#assignment(=)
  !> によって初期化してください. また, *day*, *sec* などの内部変数は
  !> 直接変更しないでください.
  !>
  !> 利用法は dc_date の "List" および "Usage" を参照してください.
  !>
  !> なお, 1 ヶ月は dc_date_types#CYCLIC_MDAYS と換算します.
  !> @endja
  type dc_difftime
    sequence
    type(dc_scaled_sec):: mon !< @en Month @enden @ja 月 @endja
    type(dc_scaled_sec):: day !< @en Day @enden @ja 日 @endja
    type(dc_scaled_sec):: sec !< @en Seconds or nondimensional time @enden @ja 秒または無次元時間 @endja
    logical:: dummy0 = .false.         !< @en Dummy for alignment @enden @ja 境界調整用ダミー @endja
    type(dc_scaled_sec):: day_seconds  !< @en Seconds per day @enden @ja 1日の秒数 @endja
    logical:: nondim_flag = .false.    !< @en Flag for nondimensional number @enden @ja 無次元数フラグ @endja
    logical:: dummy1 = .false.         !< @en Dummy for alignment @enden @ja 境界調整用ダミー @endja
  end type dc_difftime
 
  !> @namespace dc_date_types
end module dc_date_types