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...

subroutine, public	calendar_sec2unit (value, second, unit)
	Convert several second to specified unit. 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...

subroutine, public	calendar_get_name (name)

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

NAMELIST

PARAM_CALENDAR

name type default value comment

CALENDAR_360DAYS logical .false.

CALENDAR_365DAYS logical .false.

DEBUG logical .false.

History Output: No history output

Function/Subroutine Documentation

◆ calendar_setup()

subroutine, public scale_calendar::calendar_setup ( )

Setup.

Definition at line 89 of file scale_calendar.F90.

References scale_io::io_fid_conf, and scale_prc::prc_abort().

Referenced by mod_rm_driver::rm_driver(), and mod_rm_prep::rm_prep().

     use scale_prc, only: &
        prc_abort
     implicit none
 
     namelist / param_calendar / &
        calendar_360days, &
        calendar_365days, &
        debug
 
     integer :: ierr
     !---------------------------------------------------------------------------
 
     log_newline
     log_info("CALENDAR_setup",*) 'Setup'
 
     !--- read namelist
     rewind(io_fid_conf)
     read(io_fid_conf,nml=param_calendar,iostat=ierr)
     if( ierr < 0 ) then !--- missing
        log_info("CALENDAR_setup",*) 'Not found namelist. Default used.'
     elseif( ierr > 0 ) then !--- fatal error
        log_error("CALENDAR_setup",*) 'Not appropriate names in namelist PARAM_CALENDAR. Check!'
        call prc_abort
     endif
     log_nml(param_calendar)
 
     if    ( calendar_360days ) then
        calendar_doi = 360.0_dp
     elseif( calendar_365days ) then
        calendar_doi = 365.0_dp
     endif
 
     log_newline
     log_info("CALENDAR_setup",*) 'Calendar settings'
     if    ( calendar_360days ) then
        log_info_cont(*) 'DayOfYear = 360 : ideal setting'
     elseif( calendar_365days ) then
        log_info_cont(*) 'DayOfYear = 365 : ideal setting'
     else
        log_info_cont(*) 'DayOfYear = 365 or 366 : Gregorian calendar'
     endif
 
     return

Here is the call graph for this function:

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 139 of file scale_calendar.F90.

Referenced by scale_atmos_solarins::atmos_solarins_ecliptic_longitude().

     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 159 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(), mod_atmos_bnd_driver::atmos_boundary_driver_set(), mod_atmos_bnd_driver::atmos_boundary_set_file(), scale_atmos_phy_rd_profile::atmos_phy_rd_profile_read(), scale_atmos_phy_rd_profile::atmos_phy_rd_profile_setup(), calendar_cfunits2sec(), scale_file_external_input::file_external_input_regist(), and scale_file_external_input::file_external_input_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 191 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_file_external_input::file_external_input_regist(), and scale_file_external_input::file_external_input_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 223 of file scale_calendar.F90.

Referenced by scale_atmos_solarins::atmos_solarins_ecliptic_longitude(), 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
 
     if ( calendar_360days .OR. calendar_365days ) then
        yearday = int( calendar_doi * ( gyear_mod - oyear ) )
     else
        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 )
     endif
 
     ileap = i_nonleapyear
     if( checkleap(gyear_mod) ) ileap = i_leapyear
     if( calendar_360days     ) ileap = i_360days
 
     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 322 of file scale_calendar.F90.

Referenced by scale_atmos_solarins::atmos_solarins_ecliptic_longitude(), 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 380 of file scale_calendar.F90.

Referenced by mod_admin_time::admin_time_advance(), mod_admin_time::admin_time_setup(), scale_file_external_input::file_external_input_regist(), and scale_file_external_input::file_external_input_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
 
     if ( abssec < 0.0_dp ) then
        absday = absday - 1
        abssec = abssec + calendar_hour * calendar_min * calendar_sec
     endif
 
     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 405 of file scale_calendar.F90.

Referenced by mod_admin_time::admin_time_advance(), mod_admin_time::admin_time_setup(), mod_atmos_bnd_driver::atmos_boundary_driver_set(), mod_atmos_bnd_driver::atmos_boundary_set_file(), calendar_cfunits2sec(), scale_file_external_input::file_external_input_regist(), and scale_file_external_input::file_external_input_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 424 of file scale_calendar.F90.

References scale_prc::prc_abort().

Referenced by mod_admin_time::admin_time_setup(), calendar_cfunits2sec(), mod_cnv2d::cnv2d(), scale_file_history::file_history_setup(), scale_land_dyn_bucket::land_dyn_bucket_setup(), scale_ocean_dyn_slab::ocean_dyn_slab_setup(), and scale_ocean_phy_ice_simple::ocean_phy_ice_setup().

     use scale_prc, only: &
        prc_abort
     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
        log_error("CALENDAR_unit2sec",*) 'Unsupported UNIT: ', trim(unit), ', ', value
        call prc_abort
     endselect
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calendar_sec2unit()

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

Convert several second to specified unit.

Definition at line 458 of file scale_calendar.F90.

References scale_prc::prc_abort().

Referenced by scale_file_history::file_history_query_id().

     use scale_prc, only: &
        prc_abort
     implicit none
 
     real(DP),         intent(out) :: value
     real(DP),         intent( in) :: second
     character(len=*), intent( in) :: unit
     !---------------------------------------------------------------------------
 
     select case(trim(unit))
     case('MSEC', 'msec')
        value = second / 1.0e-3_dp
     case('SEC', 'seconds', 'sec', 's')
        value = second
     case('MIN', 'mins', 'min')
        value = second / calendar_sec
     case('HOUR', 'hours', 'hour', 'h')
        value = second / (calendar_sec * calendar_min)
     case('DAY', 'days', 'day')
        value = second / (calendar_sec * calendar_min * calendar_hour)
     case default
        log_error("CALENDAR_sec2unit",*) 'Unsupported UNIT: ', trim(unit), ', ', value
        call prc_abort
     endselect
 

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 488 of file scale_calendar.F90.

References calendar_combine_daysec(), calendar_date2daysec(), calendar_unit2sec(), and scale_prc::prc_abort().

Referenced by mod_admin_time::admin_time_setup(), scale_file_external_input::file_external_input_regist(), and scale_file_external_input::file_external_input_update_3d().

     use scale_prc, only: &
        prc_abort
     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
           log_error("CALENDAR_CFunits2sec",*) 'units for time is invalid (year)'
           log_error_cont(*) trim(cfunits)
           log_error_cont(*) trim(buf)
           call prc_abort
        end if
        read(buf(1:4),*) date(1) ! year
        buf = buf(6:)
 
        l = index(buf,"-")
        if ( l /= 3 ) then
           log_error("CALENDAR_CFunits2sec",*) 'units for time is invalid (month)'
           log_error_cont(*) trim(cfunits)
           log_error_cont(*) trim(buf)
           call prc_abort
        end if
        read(buf(1:2),*) date(2) ! month
        buf = buf(4:)
 
        l = index(buf," ")
        if ( l /= 3 ) then
           log_error("CALENDAR_CFunits2sec",*) 'units for time is invalid (day)'
           log_error_cont(*) trim(cfunits)
           log_error_cont(*) trim(buf)
           call prc_abort
        end if
        read(buf(1:2),*) date(3) ! day
        buf = buf(4:)
 
        l = index(buf,":")
        if ( l /= 3 ) then
           log_error("CALENDAR_CFunits2sec",*) 'units for time is invalid (hour)'
           log_error_cont(*) trim(cfunits)
           log_error_cont(*) trim(buf)
           call prc_abort
        end if
        read(buf(1:2),*) date(4) ! hour
        buf = buf(4:)
 
        l = index(buf,":")
        if ( l /= 3 ) then
           log_error("CALENDAR_CFunits2sec",*) 'units for time is invalid (min)'
           log_error_cont(*) trim(cfunits)
           log_error_cont(*) trim(buf)
           call prc_abort
        end if
        read(buf(1:2),*) date(5) ! min
        buf = buf(4:)
 
        if ( len_trim(buf) /= 2 ) then
           log_error("CALENDAR_CFunits2sec",*) 'units for time is invalid (sec)'
           log_error_cont(*) trim(cfunits)
           log_error_cont(*) trim(buf)
           log_error_cont(*) len_trim(buf)
           call prc_abort
        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 603 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 mod_atmos_bnd_driver::atmos_boundary_driver_set().

     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:

◆ calendar_get_name()

subroutine, public scale_calendar::calendar_get_name ( character(len=*), intent(out) name )

Definition at line 715 of file scale_calendar.F90.

Referenced by scale_file_cartesc::file_cartesc_create(), scale_file_history_cartesc::file_history_cartesc_setup(), and scale_file_history_cartesc::file_history_cartesc_truncate_3d().

     character(len=*), intent(out) :: name
 
     if    ( calendar_360days ) then
        name = "360_day"
     elseif( calendar_365days ) then
        name = "365_day"
     else
        name = "gregorian"
     endif
 
     return