scale_calendar Module Reference

module CALENDAR More...

Functions/Subroutines
subroutine, public	calendar_setup
	Setup. More...
subroutine, public	calendar_getdayofyear (DayOfYear, iyear)
	Get day of year. More...
subroutine, public	calendar_date2daysec (absday, abssec, ymdhms, subsec, offset_year)
	Convert from gregorian date to absolute day/second. More...
subroutine, public	calendar_daysec2date (ymdhms, subsec, absday, abssec, offset_year)
	Convert from gregorian date to absolute day/second. More...
subroutine, public	calendar_ymd2absday (absday, gyear, gmonth, gday, oyear)
	Convert from gregorian date to absolute day, DAY 0 is AD1/1/1. More...
subroutine, public	calendar_hms2abssec (abssec, hour, minute, second, subsec)
	Hour, minute, second, subsecond -> absolute second. More...
subroutine, public	calendar_adjust_daysec (absday, abssec)
	Adjust day and second. More...
real(dp) function, public	calendar_combine_daysec (absday, abssec)
	Combine day and second. More...
subroutine, public	calendar_unit2sec (second, value, unit)
	Convert several units to second. More...
real(dp) function, public	calendar_cfunits2sec (cftime, cfunits, offset_year, startdaysec)
	Convert time in units of the CF convention to second. More...
subroutine, public	calendar_date2char (chardate, ymdhms, subsec)
	Convert from gregorian date to absolute day/second. More...

Variables
integer, parameter, public	i_year = 1
	[index] year More...
integer, parameter, public	i_month = 2
	[index] month More...
integer, parameter, public	i_day = 3
	[index] day More...
integer, parameter, public	i_hour = 4
	[index] hour More...
integer, parameter, public	i_min = 5
	[index] minute More...
integer, parameter, public	i_sec = 6
	[index] second More...

Detailed Description

module CALENDAR

Description

gregorian calendar module this module is available in gregorian calendar date

Author

Team SCALE

History

• 2013-01-29 (H.Yashiro) [new]

Function/Subroutine Documentation

calendar_setup()

subroutine, public scale_calendar::calendar_setup

(

)

Setup.

Definition at line 82 of file scale_calendar.F90.

References scale_stdio::io_fid_log, and scale_stdio::io_l.

Referenced by mod_rm_driver::scalerm(), and mod_rm_prep::scalerm_prep().

    implicit none
    !---------------------------------------------------------------------------

    if( io_l ) write(io_fid_log,*)
    if( io_l ) write(io_fid_log,*) '++++++ Module[CALENDAR] / Categ[COMMON] / Origin[SCALElib]'
    if( io_l ) write(io_fid_log,*) '*** No namelists.'

    return

Here is the caller graph for this function:

calendar_getdayofyear()

subroutine, public scale_calendar::calendar_getdayofyear	(	real(dp), intent(out)	DayOfYear,
		integer, intent(in)	iyear
	)

Get day of year.

Definition at line 97 of file scale_calendar.F90.

Referenced by scale_atmos_solarins::atmos_solarins_insolation_0d(), and scale_atmos_solarins::atmos_solarins_insolation_2d().

    implicit none

    real(DP), intent(out) :: DayOfYear ! # of day of year
    integer,  intent(in)  :: iyear     ! current year
    !---------------------------------------------------------------------------

    dayofyear = calendar_doi
    if( checkleap(iyear) ) dayofyear = calendar_doi + 1.0_dp

    return

Here is the caller graph for this function:

calendar_date2daysec()

subroutine, public scale_calendar::calendar_date2daysec	(	integer, intent(out)	absday,
		real(dp), intent(out)	abssec,
		integer, dimension(6), intent(in)	ymdhms,
		real(dp), intent(in)	subsec,
		integer, intent(in)	offset_year
	)

Convert from gregorian date to absolute day/second.

Parameters

[out]	absday	absolute day
[out]	abssec	absolute second
[in]	ymdhms	date
[in]	subsec	subsecond
[in]	offset_year	offset year

Definition at line 117 of file scale_calendar.F90.

References calendar_hms2abssec(), calendar_ymd2absday(), i_day, i_hour, i_min, i_month, i_sec, and i_year.

Referenced by mod_admin_time::admin_time_setup(), scale_atmos_boundary::atmos_boundary_resume(), scale_atmos_boundary::atmos_boundary_resume_file(), scale_atmos_phy_rd_profile::atmos_phy_rd_profile_read(), scale_atmos_phy_rd_profile::atmos_phy_rd_profile_setup(), calendar_cfunits2sec(), scale_external_input::extin_regist(), and scale_external_input::extin_update_3d().

    implicit none

    integer,  intent(out) :: absday
    real(DP), intent(out) :: abssec
    integer,  intent(in)  :: ymdhms(6)
    real(DP), intent(in)  :: subsec
    integer,  intent(in)  :: offset_year
    !---------------------------------------------------------------------------

    call calendar_ymd2absday( absday,          & ! [OUT]
                              ymdhms(i_year),  & ! [IN]
                              ymdhms(i_month), & ! [IN]
                              ymdhms(i_day),   & ! [IN]
                              offset_year      ) ! [IN]

    call calendar_hms2abssec( abssec,          & ! [OUT]
                              ymdhms(i_hour),  & ! [IN]
                              ymdhms(i_min),   & ! [IN]
                              ymdhms(i_sec),   & ! [IN]
                              subsec           ) ! [IN]

    return

Here is the call graph for this function:

Here is the caller graph for this function:

calendar_daysec2date()

subroutine, public scale_calendar::calendar_daysec2date	(	integer, dimension(6), intent(out)	ymdhms,
		real(dp), intent(out)	subsec,
		integer, intent(in)	absday,
		real(dp), intent(in)	abssec,
		integer, intent(in)	offset_year
	)

Convert from gregorian date to absolute day/second.

Parameters

[out]	ymdhms	date
[out]	subsec	subsecond
[in]	absday	absolute day
[in]	abssec	absolute second
[in]	offset_year	offset year

Definition at line 149 of file scale_calendar.F90.

References i_day, i_hour, i_min, i_month, i_sec, and i_year.

Referenced by mod_admin_time::admin_time_advance(), mod_admin_time::admin_time_setup(), scale_external_input::extin_regist(), and scale_external_input::extin_update_3d().

    implicit none

    integer,  intent(out) :: ymdhms(6)
    real(DP), intent(out) :: subsec
    integer,  intent(in)  :: absday
    real(DP), intent(in)  :: abssec
    integer,  intent(in)  :: offset_year
    !---------------------------------------------------------------------------

    call calendar_absday2ymd( ymdhms(i_year),  & ! [OUT]
                              ymdhms(i_month), & ! [OUT]
                              ymdhms(i_day),   & ! [OUT]
                              absday,          & ! [IN]
                              offset_year      ) ! [IN]

    call calendar_abssec2hms( ymdhms(i_hour),  & ! [OUT]
                              ymdhms(i_min),   & ! [OUT]
                              ymdhms(i_sec),   & ! [OUT]
                              subsec,          & ! [OUT]
                              abssec           ) ! [IN]

    return

Here is the caller graph for this function:

calendar_ymd2absday()

subroutine, public scale_calendar::calendar_ymd2absday	(	integer, intent(out)	absday,
		integer, intent(in)	gyear,
		integer, intent(in)	gmonth,
		integer, intent(in)	gday,
		integer, intent(in)	oyear
	)

Convert from gregorian date to absolute day, DAY 0 is AD1/1/1.

Parameters

[out]	absday	absolute day
[in]	gyear	year
[in]	gmonth	month
[in]	gday	day
[in]	oyear	offset year

Definition at line 181 of file scale_calendar.F90.

Referenced by scale_atmos_solarins::atmos_solarins_insolation_0d(), scale_atmos_solarins::atmos_solarins_insolation_2d(), calendar_date2char(), and calendar_date2daysec().

    implicit none

    integer, intent(out) :: absday
    integer, intent(in)  :: gyear
    integer, intent(in)  :: gmonth
    integer, intent(in)  :: gday
    integer, intent(in)  :: oyear

    integer :: gyear_mod, gmonth_mod
    integer :: yearday, monthday
    integer :: m, ileap
    !---------------------------------------------------------------------------

    gmonth_mod = mod( gmonth-1, 12 ) + 1
    gyear_mod  = gyear + ( gmonth-gmonth_mod ) / 12

    yearday = int( calendar_doi * ( gyear_mod - oyear ) ) &
            + int( real(gyear_mod-1,kind=DP) /   4.0_DP ) &
            - int( real(gyear_mod-1,kind=DP) / 100.0_DP ) &
            + int( real(gyear_mod-1,kind=DP) / 400.0_DP ) &
            - int( real(oyear    -1,kind=DP) /   4.0_DP ) &
            + int( real(oyear    -1,kind=DP) / 100.0_DP ) &
            - int( real(oyear    -1,kind=DP) / 400.0_DP )

    ileap = i_nonleapyear
    if( checkleap(gyear_mod) ) ileap = i_leapyear

    monthday = 0
    do m = 1, gmonth_mod-1
       monthday = monthday + dayofmonth(m,ileap)
    enddo

    absday = yearday + monthday + gday - 1

    return

Here is the caller graph for this function:

calendar_hms2abssec()

subroutine, public scale_calendar::calendar_hms2abssec	(	real(dp), intent(out)	abssec,
		integer, intent(in)	hour,
		integer, intent(in)	minute,
		integer, intent(in)	second,
		real(dp), intent(in)	subsec
	)

Hour, minute, second, subsecond -> absolute second.

Parameters

[out]	abssec	absolute second
[in]	subsec	subsecond

Definition at line 269 of file scale_calendar.F90.

Referenced by scale_atmos_solarins::atmos_solarins_insolation_0d(), scale_atmos_solarins::atmos_solarins_insolation_2d(), and calendar_date2daysec().

    implicit none

    real(DP), intent(out) :: abssec
    integer,  intent(in)  :: hour
    integer,  intent(in)  :: minute
    integer,  intent(in)  :: second
    real(DP), intent(in)  :: subsec
    !---------------------------------------------------------------------------

    abssec = real(hour,  kind=DP) * CALENDAR_MIN * CALENDAR_SEC &
           + real(minute,kind=DP) * CALENDAR_SEC                &
           + real(second,kind=DP)                               &
           + subsec

    return

Here is the caller graph for this function:

calendar_adjust_daysec()

subroutine, public scale_calendar::calendar_adjust_daysec	(	integer, intent(inout)	absday,
		real(dp), intent(inout)	abssec
	)

Adjust day and second.

Parameters

[in,out]	absday	absolute day
[in,out]	abssec	absolute second

Definition at line 327 of file scale_calendar.F90.

Referenced by mod_admin_time::admin_time_advance(), mod_admin_time::admin_time_setup(), scale_external_input::extin_regist(), and scale_external_input::extin_update_3d().

    implicit none

    integer,  intent(inout) :: absday
    real(DP), intent(inout) :: abssec

    integer :: addday
    !---------------------------------------------------------------------------

    addday = int( abssec / ( calendar_hour * calendar_min * calendar_sec ) )

    absday = absday + addday

    abssec = abssec - real(addday,kind=DP) * CALENDAR_HOUR * CALENDAR_MIN * CALENDAR_SEC

    return

Here is the caller graph for this function:

calendar_combine_daysec()

real(dp) function, public scale_calendar::calendar_combine_daysec	(	integer, intent(in)	absday,
		real(dp), intent(in)	abssec
	)

Combine day and second.

Parameters

[in]	absday	absolute day
[in]	abssec	absolute second

Returns

absolute day.second

Definition at line 347 of file scale_calendar.F90.

Referenced by mod_admin_time::admin_time_advance(), mod_admin_time::admin_time_setup(), scale_atmos_boundary::atmos_boundary_resume(), scale_atmos_boundary::atmos_boundary_resume_file(), calendar_cfunits2sec(), scale_external_input::extin_regist(), and scale_external_input::extin_update_3d().

    implicit none

    integer,  intent(in) :: absday
    real(DP), intent(in) :: abssec
    real(DP)             :: daysec
    !---------------------------------------------------------------------------

    daysec = real(absday,kind=DP) * CALENDAR_SEC * CALENDAR_MIN * CALENDAR_HOUR &
           + abssec

    return

Here is the caller graph for this function:

calendar_unit2sec()

subroutine, public scale_calendar::calendar_unit2sec	(	real(dp), intent(out)	second,
		real(dp), intent(in)	value,
		character(len=*), intent(in)	unit
	)

Convert several units to second.

Parameters

[in]

unit

variable unit

Definition at line 366 of file scale_calendar.F90.

References scale_process::prc_mpistop().

Referenced by mod_admin_time::admin_time_setup(), and calendar_cfunits2sec().

    use scale_process, only: &
       prc_mpistop
    implicit none

    real(DP),         intent(out) :: second
    real(DP),         intent(in)  :: value
    character(len=*), intent(in)  :: unit
    !---------------------------------------------------------------------------

    select case(unit)
    case('MSEC')
       second = value * 1.e-3_dp
    case('SEC', 'seconds')
       second = value
    case('MIN')
       second = value * calendar_sec
    case('HOUR')
       second = value * calendar_sec * calendar_min
    case('DAY')
       second = value * calendar_sec * calendar_min * calendar_hour
    case default
       write(*,*) 'xxx Unsupported UNIT: ', trim(unit), ', ', value
       call prc_mpistop
    endselect

    return

Here is the call graph for this function:

Here is the caller graph for this function:

calendar_cfunits2sec()

real(dp) function, public scale_calendar::calendar_cfunits2sec	(	real(dp), intent(in)	cftime,
		character(len=*), intent(in)	cfunits,
		integer, intent(in)	offset_year,
		real(dp), intent(in), optional	startdaysec
	)

Convert time in units of the CF convention to second.

Definition at line 397 of file scale_calendar.F90.

References calendar_combine_daysec(), calendar_date2daysec(), calendar_unit2sec(), and scale_process::prc_mpistop().

Referenced by mod_admin_time::admin_time_setup(), and scale_external_input::extin_regist().

    use scale_process, only: &
       prc_mpistop
    implicit none

    real(DP),         intent(in) :: cftime
    character(len=*), intent(in) :: cfunits
    integer,          intent(in) :: offset_year
    real(DP),         intent(in), optional :: startdaysec
    real(DP)                     :: sec

    character(len=H_MID) :: tunit
    character(len=H_MID) :: buf

    integer  :: date(6)
    integer  :: day
    real(DP) :: sec0

    integer :: l

    intrinsic index
    !---------------------------------------------------------------------------

    l = index( cfunits, " since " )
    if ( l > 1 ) then ! untis is under the CF convension
       tunit = cfunits(1:l-1)
       buf   = cfunits(l+7:)

       l = index(buf,"-")
       if ( l /= 5 ) then
          write(*,*) 'xxx units for time is invalid (year)'
          write(*,*) 'xxx ', trim(cfunits)
          write(*,*) 'xxx ', trim(buf)
          call prc_mpistop
       end if
       read(buf(1:4),*) date(1) ! year
       buf = buf(6:)

       l = index(buf,"-")
       if ( l /= 3 ) then
          write(*,*) 'xxx units for time is invalid (month)'
          write(*,*) 'xxx ', trim(cfunits)
          write(*,*) 'xxx ', trim(buf)
          call prc_mpistop
       end if
       read(buf(1:2),*) date(2) ! month
       buf = buf(4:)

       l = index(buf," ")
       if ( l /= 3 ) then
          write(*,*) 'xxx units for time is invalid (day)'
          write(*,*) 'xxx ', trim(cfunits)
          write(*,*) 'xxx ', trim(buf)
          call prc_mpistop
       end if
       read(buf(1:2),*) date(3) ! day
       buf = buf(4:)

       l = index(buf,":")
       if ( l /= 3 ) then
          write(*,*) 'xxx units for time is invalid (hour)'
          write(*,*) 'xxx ', trim(cfunits)
          write(*,*) 'xxx ', trim(buf)
          call prc_mpistop
       end if
       read(buf(1:2),*) date(4) ! hour
       buf = buf(4:)

       l = index(buf,":")
       if ( l /= 3 ) then
          write(*,*) 'xxx units for time is invalid (min)'
          write(*,*) 'xxx ', trim(cfunits)
          write(*,*) 'xxx ', trim(buf)
          call prc_mpistop
       end if
       read(buf(1:2),*) date(5) ! min
       buf = buf(4:)

       if ( len_trim(buf) /= 2 ) then
          write(*,*) 'xxx units for time is invalid (sec)'
          write(*,*) 'xxx ', trim(cfunits)
          write(*,*) 'xxx ', trim(buf)
          write(*,*) 'xxx ', len_trim(buf)
          call prc_mpistop
       end if
       read(buf(1:2),*) date(6) ! sec

       call calendar_date2daysec( day,        & ! (out)
                                  sec0,       & ! (out)
                                  date(:),    & ! (in)
                                  0.0_dp,     & ! (in)
                                  offset_year ) ! (in)

       sec0 = calendar_combine_daysec( day, sec0 )
    else
       tunit = cfunits
       if ( present(startdaysec) ) then
          sec0 = startdaysec
       else
          sec0 = 0.0_dp
       end if
    end if

    call calendar_unit2sec( sec, cftime, tunit )

    sec = sec0 + sec

    return

Here is the call graph for this function:

Here is the caller graph for this function:

calendar_date2char()

subroutine, public scale_calendar::calendar_date2char	(	character(len=27), intent(out)	chardate,
		integer, dimension(6), intent(in)	ymdhms,
		real(dp), intent(in)	subsec
	)

Convert from gregorian date to absolute day/second.

Parameters

[out]	chardate	formatted date character
[in]	ymdhms	date
[in]	subsec	subsecond

Definition at line 512 of file scale_calendar.F90.

References calendar_ymd2absday(), i_day, i_month, and i_year.

Referenced by mod_admin_time::admin_time_checkstate(), mod_admin_time::admin_time_setup(), and scale_atmos_boundary::atmos_boundary_resume().

    implicit none

    character(len=27), intent(out) :: chardate
    integer,           intent(in)  :: ymdhms(6)
    real(DP),          intent(in)  :: subsec
    !---------------------------------------------------------------------------

    write(chardate,'(I4.4,A1,I2.2,A1,I2.2,A1,I2.2,A1,I2.2,A1,I2.2,A2,F6.3)')   &
                       ymdhms(1),'/',ymdhms(2),'/',ymdhms(3),' ',  &
                       ymdhms(4),':',ymdhms(5),':',ymdhms(6),' +', &
                       subsec

    return

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

i_year

integer, parameter, public scale_calendar::i_year = 1

[index] year

Definition at line 45 of file scale_calendar.F90.

Referenced by scale_atmos_solarins::atmos_solarins_insolation_0d(), scale_atmos_solarins::atmos_solarins_insolation_2d(), calendar_date2char(), calendar_date2daysec(), calendar_daysec2date(), scale_external_input::extin_regist(), and scale_external_input::extin_update_3d().

  integer, public, parameter :: I_year  = 1

i_month

integer, parameter, public scale_calendar::i_month = 2

[index] month

Definition at line 46 of file scale_calendar.F90.

Referenced by scale_atmos_solarins::atmos_solarins_insolation_0d(), scale_atmos_solarins::atmos_solarins_insolation_2d(), calendar_date2char(), calendar_date2daysec(), calendar_daysec2date(), scale_external_input::extin_regist(), and scale_external_input::extin_update_3d().

  integer, public, parameter :: I_month = 2

i_day

integer, parameter, public scale_calendar::i_day = 3

[index] day

Definition at line 47 of file scale_calendar.F90.

Referenced by scale_atmos_solarins::atmos_solarins_insolation_0d(), scale_atmos_solarins::atmos_solarins_insolation_2d(), calendar_date2char(), calendar_date2daysec(), calendar_daysec2date(), scale_external_input::extin_regist(), and scale_external_input::extin_update_3d().

  integer, public, parameter :: I_day   = 3

i_hour

integer, parameter, public scale_calendar::i_hour = 4

[index] hour

Definition at line 48 of file scale_calendar.F90.

Referenced by scale_atmos_solarins::atmos_solarins_insolation_0d(), scale_atmos_solarins::atmos_solarins_insolation_2d(), calendar_date2daysec(), and calendar_daysec2date().

  integer, public, parameter :: I_hour  = 4

i_min

integer, parameter, public scale_calendar::i_min = 5

[index] minute

Definition at line 49 of file scale_calendar.F90.

Referenced by scale_atmos_solarins::atmos_solarins_insolation_0d(), scale_atmos_solarins::atmos_solarins_insolation_2d(), calendar_date2daysec(), and calendar_daysec2date().

  integer, public, parameter :: I_min   = 5

i_sec

integer, parameter, public scale_calendar::i_sec = 6

[index] second

Definition at line 50 of file scale_calendar.F90.

Referenced by scale_atmos_solarins::atmos_solarins_insolation_0d(), scale_atmos_solarins::atmos_solarins_insolation_2d(), calendar_date2daysec(), and calendar_daysec2date().

  integer, public, parameter :: I_sec   = 6