dc_calendar_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
!> @copyright Copyright (C) GFD Dennou Club, 2009-2026. All rights reserved. <br/>
!>            License is BSD-2-Clause. see [COPYRIGHT](@ref COPYRIGHT) in detail
!> @en
!> @brief Derived types and parameters of calendar and date
!> @details
!> Derived types and parameters for "dc_calendar" are provided.
!>
!> @section caltypes_types Derived types
!>
!> | Type         | Description                                      |
!> |--------------|--------------------------------------------------|
!> | DC_CAL       | Calendar information                             |
!> | DC_CAL_DATE  | Date information                                 |
!>
!> @section caltypes_calparams Calendar type parameters
!>
!> | Parameter         | Description                                 |
!> |-------------------|---------------------------------------------|
!> | CAL_USER_DEFINED  | User-defined calendar with arbitrary settings |
!> | CAL_GREGORIAN     | Gregorian calendar                          |
!> | CAL_JULIAN        | Julian calendar                             |
!> | CAL_NOLEAP        | Calendar without leap year                  |
!> | CAL_360DAY        | Calendar with 30 days per month             |
!> | CAL_CYCLIC        | Cyclic calendar (30.6 days per month)       |
!>
!> @section caltypes_units Unit strings and symbols
!>
!> | Parameter        | Description                                  |
!> |------------------|----------------------------------------------|
!> | 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                    |
!>
!> @enden
!>
!> @ja
!> @brief 暦と日時に関する構造データ型と定数
!> @details
!> dc_calendar に関連する構造体や定数を提供します.
!>
!> @section caltypes_types_ja 派生型一覧
!>
!> | 型           | 説明                                           |
!> |--------------|------------------------------------------------|
!> | DC_CAL       | 暦情報                                         |
!> | DC_CAL_DATE  | 日時情報                                       |
!>
!> @section caltypes_calparams_ja 暦タイプパラメータ
!>
!> | パラメータ        | 説明                                        |
!> |-------------------|---------------------------------------------|
!> | CAL_USER_DEFINED  | 任意に設定可能なユーザー定義暦              |
!> | CAL_GREGORIAN     | グレゴリオ暦                                |
!> | CAL_JULIAN        | ユリウス暦                                  |
!> | CAL_NOLEAP        | 閏年無しの暦                                |
!> | CAL_360DAY        | 1ヶ月が 30 日の暦                           |
!> | CAL_CYCLIC        | 周期暦 (1ヶ月 30.6 日)                      |
!>
!> @section caltypes_units_ja 単位文字列とシンボル
!>
!> | パラメータ       | 説明                                         |
!> |------------------|----------------------------------------------|
!> | UNIT_SEC         | 秒の単位を示す文字列                         |
!> | UNIT_MIN         | 分の単位を示す文字列                         |
!> | UNIT_HOUR        | 時間の単位を示す文字列                       |
!> | UNIT_DAY         | 日の単位を示す文字列                         |
!> | UNIT_MONTH       | 月の単位を示す文字列                         |
!> | UNIT_YEAR        | 年の単位を示す文字列                         |
!> | UNIT_SYMBOL_*    | 単位を示す整数シンボル                       |
!>
!> @endja
!>
 
module dc_calendar_types
  !
 
  use dc_types, only: dp, token
  implicit none
 
  private
  public:: dc_cal, dc_cal_date
  public:: cal_user_defined, cal_cyclic, cal_noleap, cal_julian, &
    &      cal_gregorian, cal_360day
  public:: unit_sec, unit_min, unit_hour, &
    &      unit_day, unit_month, unit_year
  public:: unit_symbol_sec, unit_symbol_min, &
    &      unit_symbol_hour, unit_symbol_day, unit_symbol_month, &
    &      unit_symbol_year, unit_symbol_err
 
  integer, parameter:: cal_user_defined = 1
                                         ! 利用者が任意で指定する暦. 
                                         ! User defined calendar. 
                                         !
  integer, parameter:: cal_cyclic = 2    ! 1 ヵ月を 30.6 日 (CYCLIC_MDAYS) 
                                         ! とする暦. 
                                         !
                                         ! All months are 30.6 day. 
                                         !
  integer, parameter:: cal_noleap = 3    ! 1 年 365 日 (閏年無し) の暦. 
                                         !
                                         ! Gregorian calendar without
                                         ! leap years, i.e., all years
                                         ! are 365 days long.
                                         !
  integer, parameter:: cal_julian = 4    ! ユリウス暦. 
                                         ! Julian calendar. 
                                         !
  integer, parameter:: cal_gregorian = 5 ! グレゴリオ暦. 
                                         ! Gregorian calendar. 
                                         !
  integer, parameter:: cal_360day = 6    ! 1 年 360 日 (1 月 30 日) の暦. 
                                         !
                                         ! All years are 360 days 
                                         ! divided into 30 day months.
 
  !> @en
  !> @brief Derived type for calendar
  !> @details
  !> A derived type that expresses calendar.
  !>
  !> Do not refer and modify elements of this derived type directly.
  !> Use procedures provided by "dc_calendar_generic" for handling
  !> this derived type.
  !> @enden
  !>
  !> @ja
  !> @brief 暦を表現する派生型
  !> @details
  !> 暦を表現する構造体.
  !>
  !> この構造体の要素を直接参照および変更してはなりません.
  !> この構造体を扱う上では必ず dc_calendar_generic より提供される
  !> 手続きを用いてください.
  !> @endja
  type dc_cal
    logical:: initialized = .false.            !< @en Initialization flag @enden @ja 初期設定フラグ @endja
    integer:: month_in_year                    !< @en Months in a year @enden @ja 1年の月数 @endja
    integer, pointer:: day_in_month(:) => null() !< @en Days in months @enden @ja 1ヶ月の日数 @endja
    integer:: hour_in_day                      !< @en Hours in a day @enden @ja 1日の時間数 @endja
    integer:: min_in_hour                      !< @en Minutes in a hour @enden @ja 1時間の分数 @endja
    real(dp):: sec_in_min                      !< @en Seconds in a minute @enden @ja 1分の秒数 @endja
    integer:: cal_type                         !< @en Kind of calendar @enden @ja 暦の種別 @endja
  end type dc_cal
 
  !> @en
  !> @brief Derived type for date
  !> @details
  !> A derived type that expresses date.
  !>
  !> Do not refer and modify elements of this derived type directly.
  !> Use procedures provided by "dc_calendar_generic" for handling
  !> this derived type.
  !> @enden
  !>
  !> @ja
  !> @brief 日時を表現する派生型
  !> @details
  !> 日時を表現する構造体.
  !>
  !> この構造体の要素を直接参照および変更してはなりません.
  !> この構造体を扱う上では必ず dc_calendar_generic より提供される
  !> 手続きを用いてください.
  !> @endja
  type dc_cal_date
    logical:: initialized = .false.  !< @en Initialization flag @enden @ja 初期設定フラグ @endja
    integer:: year                   !< @en Year @enden @ja 年 @endja
    integer:: month                  !< @en Month @enden @ja 月 @endja
    integer:: day                    !< @en Day @enden @ja 日 @endja
    integer:: hour                   !< @en Hour @enden @ja 時 @endja
    integer:: min                    !< @en Minute @enden @ja 分 @endja
    real(dp):: sec                   !< @en Seconds @enden @ja 秒 @endja
    character(TOKEN):: zone          !< @en Time-zone (offset from UTC) @enden @ja UTCからの時差 @endja
  end type dc_cal_date
 
  ! 日時の単位として認識される文字列
  ! Strings recognized as units of date and time 
  !
  character(*), parameter, dimension(8) :: unit_sec = (/ &
    & 'seconds', 'second ', 'secs.  ', 'secs   ', &
    & 'sec.   ', 'sec    ', 's.     ', 's      '/) ! 秒の単位を示す文字列
 
  character(*), parameter, dimension(4) :: unit_min = (/ &
    & 'minutes', 'minute ', 'min.   ', 'min    '/) ! 分の単位を示す文字列
  character(*), parameter, dimension(8) :: unit_hour = (/ &
    & 'hours', 'hour ', 'hrs. ', 'hrs  ', &
    & 'hr.  ', 'hr   ', 'h.   ', 'h    '/)         ! 時の単位を示す文字列
  character(*), parameter, dimension(4) :: unit_day = (/ &
    & 'days', 'day ', 'd.  ', 'd   '/)             ! 日の単位を示す文字列
  character(*), parameter, dimension(6) :: unit_month = (/ &
    & 'months', 'month ', 'mon.  ', &
    & 'mon   ', 'mo.   ', 'mo    '/)               ! 月の単位を示す文字列
  character(*), parameter, dimension(4) :: unit_year = (/ &
    & 'years', 'year ', 'yr.  ', 'yr   '/)         ! 年の単位を示す文字列
 
 
  ! 日時の単位のシンボル
  ! Synbols of units of date and time
  !
  integer, parameter:: unit_symbol_err    = -1 ! 無効な単位を示すシンボル
  integer, parameter:: unit_symbol_sec    = 2 ! 秒の単位を示すシンボル
  integer, parameter:: unit_symbol_min    = 3 ! 分の単位を示すシンボル
  integer, parameter:: unit_symbol_hour   = 4 ! 時間の単位を示すシンボル
  integer, parameter:: unit_symbol_day    = 5 ! 日の単位を示すシンボル
  integer, parameter:: unit_symbol_month  = 6 ! 月の単位を示すシンボル
  integer, parameter:: unit_symbol_year   = 7 ! 年の単位を示すシンボル
 
  !> @namespace dc_calendar_types
end module dc_calendar_types