dc_date_internal Module Reference

Internal module for dc_date. More...

Functions/Subroutines
subroutine, public	dcdate_normalize (day, sec, day_seconds, nondim_flag)
subroutine, public	dcdate_set_day_seconds_scl
subroutine, public	dcdate_nondimcheck (opr, diff1, diff2, rslt)
character(token) function, public	dcdate_parse_unit (str)

Detailed Description

Internal module for dc_date.

Author

Yasuhiro MORIKAWA, Eizi TOYODA

Copyright

Copyright (C) GFD Dennou Club, 2000-2026. All rights reserved.
License is BSD-2-Clause. see COPYRIGHT in detail

This module provides internal constants, variables, and procedures used by the dc_date module. These are for internal use only and should not be used outside of dc_date module.

Internal procedures

Procedure	Description
dcdate_normalize	Normalize day and seconds
dcdate_set_day_seconds_scl	Set scaled seconds for day
dcdate_nondimcheck	Check dimensionality consistency
dcdate_parse_unit	Parse time unit string

Function/Subroutine Documentation

dcdate_nondimcheck()

subroutine, public dc_date_internal::dcdate_nondimcheck	(	character(*), intent(in)	opr,
		type(dc_difftime), intent(in)	diff1,
		type(dc_difftime), intent(in)	diff2,
		type(dc_difftime), intent(inout)	rslt )

Check dimensionality consistency

Checks whether diff1 and diff2 are both dimensional or both non-dimensional, and applies the result to rslt. If one is dimensional and the other is non-dimensional, an error is raised.

This is an internal subroutine and should not be used outside of dc_date module.

Parameters

[in]	opr	Name of the operator
[in]	diff1	First operand
[in]	diff2	Second operand
[in,out]	rslt	Result operand

Definition at line 186 of file dc_date_internal.f90.

    use dc_error, only: storeerror, dc_edimtime
    implicit none
    character(*), intent(in):: opr
    type(DC_DIFFTIME), intent(in):: diff1, diff2
    type(DC_DIFFTIME), intent(inout):: rslt
  continue
    if (      (       diff1 % nondim_flag .and. .not. diff2 % nondim_flag ) &
      &  .or. ( .not. diff1 % nondim_flag .and.       diff2 % nondim_flag ) ) then
      call storeerror(dc_edimtime, opr)
    end if
    rslt % nondim_flag = diff1 % nondim_flag

References dc_error::dc_edimtime, and dc_error::storeerror().

Here is the call graph for this function:

dcdate_normalize()

subroutine, public dc_date_internal::dcdate_normalize	(	type(dc_scaled_sec), intent(inout)	day,
		type(dc_scaled_sec), intent(inout)	sec,
		type(dc_scaled_sec), intent(in), optional	day_seconds,
		logical, intent(in)	nondim_flag )

Normalize day and seconds

Normalizes day and seconds values. If sec exceeds day_seconds, the excess is carried over to day. Also ensures that sec and day have the same sign.

This is an internal subroutine and should not be used outside of dc_date module.

Parameters

[in,out]	day	Day value
[in,out]	sec	Second value
[in]	day_seconds	Seconds in a day (optional)
[in]	nondim_flag	Non-dimensional flag

Definition at line 93 of file dc_date_internal.f90.

    use dc_date_types, only: &
      & flag_set_day_seconds_scl, day_seconds_scl
    use dc_scaledsec, only: dc_scaled_sec, &
      & operator(<), operator(>), operator(<=), operator(>=), &
      & operator(+), operator(-), operator(*), operator(/), &
      & modulo, int, abs, sign
    implicit none
    type(DC_SCALED_SEC), intent(inout):: day
    type(DC_SCALED_SEC), intent(inout):: sec
    type(DC_SCALED_SEC), intent(in), optional:: day_seconds
    logical, intent(in):: nondim_flag
    type(DC_SCALED_SEC):: sgn, day_sec, zero_sec
  continue
    if ( nondim_flag ) return
    if (present(day_seconds)) then
      day_sec = day_seconds
    else
      if ( .not. flag_set_day_seconds_scl ) call dcdate_set_day_seconds_scl
      day_sec = day_seconds_scl
    end if
    if (abs(sec) >= day_sec) then
      day = day + int(sec / day_sec)
      sec = modulo(sec, day_sec)
    end if
!!    zero_sec = 0  (デフォルト値 = 0 を使用する).
    if (      ( sec > zero_sec .and. day < zero_sec ) &
      &  .or. ( sec < zero_sec .and. day > zero_sec )   ) then
      sgn = sign(day, 1)
      day = day - sgn
      sec = sec + sgn * day_sec
    endif

References dc_date_types::day_seconds, dc_date_types::day_seconds_scl, dcdate_set_day_seconds_scl(), and dc_date_types::flag_set_day_seconds_scl.

Here is the call graph for this function:

dcdate_parse_unit()

character(token) function, public dc_date_internal::dcdate_parse_unit

(

character(*), intent(in)

str

)

Parse time unit string and return symbol

Interprets the string str and returns the time unit symbol. The following strings are interpreted as time units (case insensitive):

Unit	Symbol constant
year	UNIT_SYMBOL_YEAR
month	UNIT_SYMBOL_MONTH
day	UNIT_SYMBOL_DAY
hour	UNIT_SYMBOL_HOUR
minute	UNIT_SYMBOL_MIN
second	UNIT_SYMBOL_SEC
non-dimensional	UNIT_SYMBOL_NONDIM

If str does not match any of these, UNIT_SYMBOL_ERR is returned.

Parameters

[in]

str

Input unit string

Returns

Unit symbol integer

Parse time unit string and return unit string

Interprets the string str and returns the time unit string. Case insensitive. Returns the first element of the unit array. Returns empty string for unrecognized unit.

This is an internal function and should not be used outside of dc_date module.

Parameters

[in]

str

Input unit string

Returns

Standardized unit string

Definition at line 277 of file dc_date_internal.f90.

    use dc_types, only: token
    use dc_date_types, only: unit_year, unit_month, unit_day, &
      & unit_hour, unit_min, unit_sec, unit_nondim
    use dc_string, only: strieq
    implicit none
    character(*), intent(in):: str
    integer :: unit_str_size, i
  continue
    unit = adjustl(str)
    unit_str_size = size(unit_nondim)
    do i = 1, unit_str_size
      if (strieq(trim(unit), trim(unit_nondim(i)))) then
        unit = unit_nondim(1)
        return
      end if
    end do
 
    unit_str_size = size(unit_sec)
    do i = 1, unit_str_size
      if (strieq(trim(unit), trim(unit_sec(i)))) then
        unit = unit_sec(1)
        return
      end if
    end do
 
    unit_str_size = size(unit_min)
    do i = 1, unit_str_size
      if (strieq(trim(unit), trim(unit_min(i)))) then
        unit = unit_min(1)
        return
      end if
    end do
 
    unit_str_size = size(unit_hour)
    do i = 1, unit_str_size
      if (strieq(trim(unit), trim(unit_hour(i)))) then
        unit = unit_hour(1)
        return
      end if
    end do
 
    unit_str_size = size(unit_day)
    do i = 1, unit_str_size
      if (strieq(trim(unit), trim(unit_day(i)))) then
        unit = unit_day(1)
        return
      end if
    end do
 
    unit_str_size = size(unit_month)
    do i = 1, unit_str_size
      if (strieq(trim(unit), trim(unit_month(i)))) then
        unit = unit_month(1)
        return
      end if
    end do
 
    unit_str_size = size(unit_year)
    do i = 1, unit_str_size
      if (strieq(trim(unit), trim(unit_year(i)))) then
        unit = unit_year(1)
        return
      end if
    end do
 
    unit = ''
 

References dc_types::token, dc_date_types::unit_day, dc_date_types::unit_hour, dc_date_types::unit_min, dc_date_types::unit_month, dc_date_types::unit_nondim, dc_date_types::unit_sec, and dc_date_types::unit_year.

dcdate_set_day_seconds_scl()

subroutine, public dc_date_internal::dcdate_set_day_seconds_scl

Set scaled seconds for day

Sets the scaled seconds value for day_seconds_scl.

Definition at line 140 of file dc_date_internal.f90.

    use dc_scaledsec, only: dc_scaled_sec, assignment(=)
    use dc_date_types, only: day_seconds,  &
      & flag_set_day_seconds_scl, day_seconds_scl
  continue
    if ( .not. flag_set_day_seconds_scl ) then
      flag_set_day_seconds_scl = .true.
      day_seconds_scl = day_seconds
    end if

References dc_date_types::day_seconds, dc_date_types::day_seconds_scl, and dc_date_types::flag_set_day_seconds_scl.