dccalconvertbyunit.f90 File Reference

Go to the source code of this file.

Functions/Subroutines
real(dp) function	dccalconvertbyunit1 (in_time, in_unit, out_unit, cal)
	Unit conversion functions for calendar.
real(dp) function	dccalconvertbyunit2 (in_time, in_unit, out_unit, cal)

Function/Subroutine Documentation

dccalconvertbyunit1()

real(dp) function dccalconvertbyunit1	(	real(dp), intent(in)	in_time,
		character(*), intent(in)	in_unit,
		character(*), intent(in)	out_unit,
		type(dc_cal), intent(in), optional, target	cal )

Unit conversion functions for calendar.

Author

Youhei SASAKI, Yasuhiro MORIKAWA

Copyright

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

Procedures described in this file are provided from "dc_calendar" module.

Convert time value between different units (string version)

Convert of unit.

Valid strings as units of time are follows.

Parameter	Description
dc_calendar_types#UNIT_SEC	Units of second
dc_calendar_types#UNIT_MIN	Units of minute
dc_calendar_types#UNIT_HOUR	Units of hour
dc_calendar_types#UNIT_DAY	Units of day

If an optional argument cal is omitted, unit is converted with information of a calendar that is stored in the "dc_calendar". If cal is not omitted, unit is converted with information of the variable.

Parameters

[in]	in_time	Numerical value of time before conversion
[in]	in_unit	Units of time before conversion (string)
[in]	out_unit	Units of time after conversion (string)
[in]	cal	An object that stores information of calendar

Returns

Numerical value of time after conversion

Definition at line 73 of file dccalconvertbyunit.f90.

 
  use dc_calendar_internal, only: default_cal, default_cal_set, &
    & dccaldate_str2usym
  use dc_calendar_types, only: dc_cal
  use dc_calendar_generic, only: dccalconvertbyunit
  use dc_message, only: messagenotify
  use dc_types, only: dp
  implicit none
  real(DP):: out_time
  real(DP), intent(in):: in_time
  character(*), intent(in):: in_unit
  character(*), intent(in):: out_unit
  type(DC_CAL), intent(in), optional, target:: cal
 
  ! 作業変数
  ! Work variables
  !
  type(DC_CAL), pointer:: calp =>null()
  integer:: in_unit_sym, out_unit_sym
  character(*), parameter:: subname = 'DCCalConvertByUnit1'
continue
 
  out_time = -1.0
 
  ! オブジェクトのポインタ割付
  ! Associate pointer of an object
  !
  if ( present( cal ) ) then
    calp => cal
  else
    calp => default_cal
    if ( .not. calp % initialized ) call default_cal_set
  end if
 
  ! 初期設定のチェック
  ! Check initialization
  !
  if ( .not. calp % initialized ) then
    call messagenotify('W', subname, '"cal" is not initialized. <-1> is returned.' )
    goto 999
  end if
 
  ! 単位の解釈
  ! Parse units
  !
  in_unit_sym  = dccaldate_str2usym( in_unit )
  out_unit_sym = dccaldate_str2usym( out_unit )
 
  ! 数値の変換
  ! Convert a value
  !
  out_time = dccalconvertbyunit( in_time, in_unit_sym, out_unit_sym, cal )
 
  ! 終了処理, 例外処理
  ! Termination and Exception handling
  !
999 continue
  nullify( calp )

References dc_calendar_internal::dccaldate_str2usym(), dc_calendar_internal::default_cal, dc_calendar_internal::default_cal_set(), and dc_types::dp.

Here is the call graph for this function:

dccalconvertbyunit2()

real(dp) function dccalconvertbyunit2	(	real(dp), intent(in)	in_time,
		integer, intent(in)	in_unit,
		integer, intent(in)	out_unit,
		type(dc_cal), intent(in), optional, target	cal )

Convert time value between different units (symbol version)

Convert of unit.

Valid integer variables as units of time are follows. Do not specify integer directly, but specify following variables.

Parameter	Description
dc_calendar_types#UNIT_SYMBOL_SEC	Units of second
dc_calendar_types#UNIT_SYMBOL_MIN	Units of minute
dc_calendar_types#UNIT_SYMBOL_HOUR	Units of hour
dc_calendar_types#UNIT_SYMBOL_DAY	Units of day

If an optional argument cal is omitted, unit is converted with information of a calendar that is stored in the "dc_calendar". If cal is not omitted, unit is converted with information of the variable.

Parameters

[in]	in_time	Numerical value of time before conversion
[in]	in_unit	Units of time before conversion (integer symbol)
[in]	out_unit	Units of time after conversion (integer symbol)
[in]	cal	An object that stores information of calendar

Returns

Numerical value of time after conversion

Definition at line 189 of file dccalconvertbyunit.f90.

 
  use dc_calendar_internal, only: default_cal, default_cal_set
  use dc_calendar_types, only: dc_cal, &
    & unit_symbol_day, unit_symbol_hour, unit_symbol_min, unit_symbol_sec
  use dc_message, only: messagenotify
  use dc_types, only: dp
  implicit none
  real(DP):: out_time
  real(DP), intent(in):: in_time
  integer, intent(in):: in_unit
  integer, intent(in):: out_unit
  type(DC_CAL), intent(in), optional, target:: cal
 
  ! 作業変数
  ! Work variables
  !
  type(DC_CAL), pointer:: calp =>null()
  real(DP):: in_timew
  character(*), parameter:: subname = 'DCCalConvertByUnit2'
continue
 
  out_time = -1.0
 
  ! オブジェクトのポインタ割付
  ! Associate pointer of an object
  !
  if ( present( cal ) ) then
    calp => cal
  else
    calp => default_cal
    if ( .not. calp % initialized ) call default_cal_set
  end if
 
  ! 初期設定のチェック
  ! Check initialization
  !
  if ( .not. calp % initialized ) then
    call messagenotify('W', subname, '"cal" is not initialized. <-1> is returned.' )
    goto 999
  end if
 
  ! 数値の変換
  ! Convert a value
  !
  select case(in_unit)
  case(unit_symbol_day)
    in_timew = in_time * calp % hour_in_day &
      &                * calp % min_in_hour &
      &                * calp % sec_in_min
  case(unit_symbol_hour)
    in_timew = in_time * calp % min_in_hour &
      &                * calp % sec_in_min
  case(unit_symbol_min)
    in_timew = in_time * calp % sec_in_min
  case(unit_symbol_sec)
    in_timew = in_time
  case default
    call messagenotify('W', subname, 'in_unit=<%d> is invalid. (ONLY day,hour,min,sec are valid).'  // &
      & ' <-1> is returned.', &
      & i = (/ in_unit /) )
    goto 999
  end select
 
  select case(out_unit)
  case(unit_symbol_day)
    out_time = in_timew / calp % hour_in_day &
      &                 / calp % min_in_hour &
      &                 / calp % sec_in_min
  case(unit_symbol_hour)
    out_time = in_timew / calp % min_in_hour &
      &                 / calp % sec_in_min
  case(unit_symbol_min)
    out_time = in_timew / calp % sec_in_min
  case(unit_symbol_sec)
    out_time = in_timew
  case default
    call messagenotify('W', subname, 'out_unit=<%d> is invalid. (ONLY day,hour,min,sec are valid).'  // &
      & ' <-1> is returned.', &
      & i = (/ out_unit /) )
    goto 999
  end select
 
  ! 終了処理, 例外処理
  ! Termination and Exception handling
  !
999 continue
  nullify( calp )

References dc_calendar_internal::default_cal, dc_calendar_internal::default_cal_set(), dc_types::dp, dc_calendar_types::unit_symbol_day, dc_calendar_types::unit_symbol_hour, dc_calendar_types::unit_symbol_min, and dc_calendar_types::unit_symbol_sec.

Here is the call graph for this function: