module time_manager 79,34
use shr_kind_mod
, only: r8 => shr_kind_r8, SHR_KIND_CS
use spmd_utils, only: masterproc
use ESMF_Mod
use string_utils, only: to_upper
use dycore, only: dycore_is
use abortutils, only: endrun
use cam_logfile, only: iulog
#ifdef SPMD
use mpishorthand, only: mpicom, mpiint, mpilog, mpichar
#endif
use pio, only : file_desc_t, var_desc_t, &
pio_char, pio_int, pio_global, &
pio_put_att, pio_def_var, pio_def_dim, &
pio_inq_varid, pio_put_var, pio_get_var
implicit none
private
save
! Public methods
public ::&
timemgr_init, &! time manager initialization
advance_timestep, &! increment timestep number
get_step_size, &! return step size in seconds
get_nstep, &! return timestep number
get_curr_date, &! return date components at end of current timestep
get_prev_date, &! return date components at beginning of current timestep
get_start_date, &! return components of the start date
get_ref_date, &! return components of the reference date
get_perp_date, &! return components of the perpetual date, and current time of day
get_curr_time, &! return components of elapsed time since reference date at end of current timestep
get_prev_time, &! return components of elapsed time since reference date at beg of current timestep
get_curr_calday, &! return calendar day at end of current timestep
get_calday, &! return calendar day from input date
get_calendar, &! return calendar name
is_first_step, &! return true on first step of initial run
is_first_restart_step, &! return true on first step of restart or branch run
is_end_curr_day, &! return true on last timestep in current day
is_end_curr_month, &! return true on last timestep in current month
is_last_step, &! return true on last timestep
is_perpetual, &! return true if perpetual calendar is in use
timemgr_init_restart, &! initialize the pio(netcdf) restart file for writting
timemgr_write_restart, &! write info to file needed to restart the time manager
timemgr_read_restart, &! read info from file needed to restart the time manager
timemgr_restart, &! restart the time manager
timemgr_check_restart, &! check that restart agrees with input clock info
timemgr_datediff, &! calculate difference between two time instants
timemgr_time_ge, &! check if time2 is later than or equal to time1
timemgr_time_inc, &! increment time instant by a given interval
timemgr_set_date_time, &! set the current date and time
set_time_float_from_date, &! returns a float representation of time given yr, mon, day, sec
set_date_from_time_float ! returns yr, mon, day, sec given time float
! interfaces
! Public data for namelist input
integer, parameter :: uninit_int = -999999999
integer, public ::&
dtime = uninit_int ! timestep in seconds
! Private module data
! The save attribute in the following declarations are there to make the xlf90 (v8.1.1.6)
! compiler happy. It shouldn't be there since this module has a global save.
type(ESMF_Calendar), save :: tm_cal ! calendar
type(ESMF_Clock), save :: tm_clock ! Model clock
type(ESMF_Time), save :: tm_perp_date ! perpetual date
integer ::& ! Data required to restart time manager:
rst_nstep = uninit_int, &! current step number
rst_step_days = uninit_int, &! days component of timestep size
rst_step_sec = uninit_int, &! timestep size seconds
rst_start_ymd = uninit_int, &! start date
rst_start_tod = uninit_int, &! start time of day
rst_stop_ymd = uninit_int, &! stop date
rst_stop_tod = uninit_int, &! stop time of day
rst_ref_ymd = uninit_int, &! reference date
rst_ref_tod = uninit_int, &! reference time of day
rst_curr_ymd = uninit_int, &! current date
rst_curr_tod = uninit_int, &! current time of day
rst_perp_ymd = uninit_int ! perpetual date
character(len=32) :: rst_calendar ! Calendar
logical ::&
rst_perp_cal = .false. ! true when using perpetual calendar
character(len=32) :: calendar ! Calendar type
logical :: tm_first_restart_step = .false. ! true for first step of a restart or branch run
logical :: tm_perp_calendar = .false. ! true when using perpetual calendar
integer :: cal_type = uninit_int ! calendar type
integer, parameter :: varcnt=14
type var_id
type(Var_desc_t) :: vardesc
character(len=18) :: name
end type var_id
type(var_id), target :: timevars(varcnt)
!=========================================================================================
contains
!=========================================================================================
subroutine timemgr_init( calendar_in, start_ymd, start_tod, ref_ymd, & 2,29
ref_tod, stop_ymd, stop_tod, &
perpetual_run, perpetual_ymd )
! Initialize the ESMF time manager.
!
! NOTE - Assumptions:
! 1) The namelist variables have been set before this routine is called. (set in control/parse_namelist.F90)
! Arguments
character(len=*), intent(IN) :: calendar_in ! Calendar type
integer, intent(IN) :: start_ymd ! Start date (YYYYMMDD)
integer, intent(IN) :: start_tod ! Start time of day (sec)
integer, intent(IN) :: ref_ymd ! Reference date (YYYYMMDD)
integer, intent(IN) :: ref_tod ! Reference time of day (sec)
integer, intent(IN) :: stop_ymd ! Stop date (YYYYMMDD)
integer, intent(IN) :: stop_tod ! Stop time of day (sec)
logical, intent(IN) :: perpetual_run ! If in perpetual mode or not
integer, intent(IN) :: perpetual_ymd ! Perpetual date (YYYYMMDD)
! Local variables
character(len=*), parameter :: sub = 'timemgr_init'
integer :: rc ! return code
type(ESMF_Time) :: start_date ! start date for run
type(ESMF_Time) :: stop_date ! stop date for run
type(ESMF_Time) :: curr_date ! temporary date used in logic
type(ESMF_Time) :: ref_date ! reference date for time coordinate
!----------------------------------------------------------------------------------------
! Initalize calendar type.
calendar = trim(calendar_in)
call init_calendar()
! Initalize start date.
start_date = TimeSetymd( start_ymd, start_tod, "start_date" )
! Initalize stop date.
stop_date = TimeSetymd( stop_ymd, stop_tod, "stop_date" )
! Initalize reference date for time coordinate.
ref_date = TimeSetymd( ref_ymd, ref_tod, "ref_date" )
curr_date = start_date
! Initialize clock and stop date
call initialize_clock( start_date, ref_date, curr_date, stop_date )
! Initialize date used for perpetual calendar day calculation.
if ( perpetual_run ) then
tm_perp_calendar = .true.
tm_perp_date = TimeSetymd( perpetual_ymd, 0, "tm_perp_date" )
end if
! Print configuration summary to log file (stdout).
if (masterproc) then
call timemgr_print()
end if
end subroutine timemgr_init
!=========================================================================================
subroutine initialize_clock( start_date, ref_date, curr_date, stop_date ) 2,16
!
! Purpose: Initialize the clock based on the start_date, ref_date, and curr_date
! as well as the settings from the namelist specifying the time to stop
!
! Input variables
type(ESMF_Time), intent(inout) :: start_date ! start date for run
type(ESMF_Time), intent(inout) :: ref_date ! reference date for time coordinate
type(ESMF_Time), intent(inout) :: curr_date ! current date (equal to start_date)
type(ESMF_Time), intent(inout) :: stop_date ! stop date for run
! Local variables
character(len=*), parameter :: sub = 'initialize_clock'
type(ESMF_TimeInterval) :: step_size ! timestep size
type(ESMF_Time) :: current ! current date (from clock)
integer :: yr, mon, day, tod ! Year, month, day, and second as integers
integer :: rc ! return code
if ( mod(86400,dtime) /= 0 ) then
!!!! call endrun (sub//': timestep must divide evenly into 1 day')
end if
call ESMF_TimeIntervalSet( step_size, s=dtime, rc=rc )
call chkrc(rc, sub//': error return from ESMF_TimeIntervalSet: setting step_size')
if ( stop_date <= start_date ) then
write(iulog,*)sub, ': stop date must be specified later than start date: '
call ESMF_TimeGet( start_date, yy=yr, mm=mon, dd=day, s=tod )
write(iulog,*) ' Start date (yr, mon, day, tod): ', yr, mon, day, tod
call ESMF_TimeGet( stop_date, yy=yr, mm=mon, dd=day, s=tod )
write(iulog,*) ' Stop date (yr, mon, day, tod): ', yr, mon, day, tod
call endrun
end if
if ( curr_date >= stop_date ) then
write(iulog,*)sub, ': stop date must be specified later than current date: '
call ESMF_TimeGet( curr_date, yy=yr, mm=mon, dd=day, s=tod )
write(iulog,*) ' Current date (yr, mon, day, tod): ', yr, mon, day, tod
call ESMF_TimeGet( stop_date, yy=yr, mm=mon, dd=day, s=tod )
write(iulog,*) ' Stop date (yr, mon, day, tod): ', yr, mon, day, tod
call endrun
end if
! Initialize the clock
tm_clock = ESMF_ClockCreate("CAM Time-manager clock", step_size, start_date, &
stopTime=stop_date, refTime=ref_date, rc=rc)
call chkrc(rc, sub//': error return from ESMF_ClockSetup')
! Advance clock to the current time (in case of a restart)
call ESMF_ClockGet(tm_clock, currTime=current, rc=rc )
call chkrc(rc, sub//': error return from ESMF_ClockGet')
do while( curr_date > current )
call ESMF_ClockAdvance( tm_clock, rc=rc )
call chkrc(rc, sub//': error return from ESMF_ClockAdvance')
call ESMF_ClockGet(tm_clock, currTime=current )
call chkrc(rc, sub//': error return from ESMF_ClockGet')
end do
end subroutine initialize_clock
!=========================================================================================
function TimeSetymd( ymd, tod, desc ) 30,6
!
! Set the time by an integer as YYYYMMDD and integer seconds in the day
!
integer, intent(in) :: ymd ! Year, month, day YYYYMMDD
integer, intent(in) :: tod ! Time of day in seconds
character(len=*), intent(in) :: desc ! Description of time to set
type(ESMF_Time) :: TimeSetymd ! Return value
character(len=*), parameter :: sub = 'TimeSetymd'
integer :: yr, mon, day ! Year, month, day as integers
integer :: rc ! return code
if ( (ymd < 0) .or. (tod < 0) .or. (tod > 24*3600) )then
write(iulog,*) sub//': error yymmdd is a negative number or time-of-day out of bounds', &
ymd, tod
call endrun
end if
yr = ymd / 10000
mon = (ymd - yr*10000) / 100
day = ymd - yr*10000 - mon*100
call ESMF_TimeSet( TimeSetymd, yy=yr, mm=mon, dd=day, s=tod, &
calendar=tm_cal, rc=rc)
call chkrc(rc, sub//': error return from ESMF_TimeSet: setting '//trim(desc))
end function TimeSetymd
!=========================================================================================
subroutine set_time_float_from_date( time, year, month, day, sec ) 14,7
!
! Set the time as a float given year, month, day, sec
!
implicit none
real(r8),intent(out):: time
integer, intent(in) :: year
integer, intent(in) :: month
integer, intent(in) :: day
integer, intent(in) :: sec
integer :: rc ! return code
character(len=*), parameter :: sub = 'set_time_float_from_date'
type(ESMF_Time) :: date, ref_date
type(ESMF_TimeInterval) :: diff
integer :: useday
call ESMF_TimeSet( date, yy=year, mm=month, dd=day, s=sec, calendar=tm_cal, rc=rc)
!
! If the subroutine returned error, check if it is Feb 29 of a non-leap year
! (legitimately used by the time-interpolation routines in tracer_data.F90)
! in which case, substitute Feb 28 for the day
!
if ( rc .ne. ESMF_SUCCESS ) then
if ( ( month .eq. 2 ) .and. ( day .eq. 29 ) ) then ! assume the failure is because it is leap day
useday = 28
call ESMF_TimeSet( date, yy=year, mm=month, dd=useday, s=sec, calendar=tm_cal, rc=rc)
else ! legitimate error, let the model quit
call chkrc(rc, sub//': error return from ESMF_TimeSet for set_time_float_from_date')
endif
endif
call ESMF_ClockGet(tm_clock, refTime=ref_date, rc=rc )
call chkrc(rc, sub//': error return from ESMF_ClockGet for set_time_float_from_date')
diff = date - ref_date
call ESMF_TimeIntervalGet( diff, d_r8=time, rc=rc)
call chkrc(rc, sub//': error return from ESMF_TimeIntervalGet for set_time_float_from_date')
endsubroutine set_time_float_from_date
!=========================================================================================
subroutine set_date_from_time_float( time, year, month, day, sec ) 4,7
!
! Set year, month, day, sec given the time as a float
!
implicit none
real(r8),intent(in) :: time
integer, intent(out) :: year
integer, intent(out) :: month
integer, intent(out) :: day
integer, intent(out) :: sec
integer :: rc ! return code
character(len=*), parameter :: sub = 'set_date_from_time_float'
type(ESMF_Time) :: date, ref_date
type(ESMF_TimeInterval) :: diff
call ESMF_ClockGet(tm_clock, refTime=ref_date, rc=rc )
call chkrc(rc, sub//': error return from ESMF_ClockGet for rset_date_from_time_float')
#ifdef USE_ESMF_LIB
call ESMF_TimeIntervalSet( diff, d_r8=time, rc=rc)
#else
call ESMF_TimeIntervalSet( diff, d_=time, rc=rc)
#endif
call chkrc(rc, sub//': error return from ESMF_TimeIntervalSet for set_date_from_time_float')
date = ref_date + diff
call ESMF_TimeGet( date, yy=year, mm=month, dd=day, s=sec, rc=rc)
call chkrc(rc, sub//': error return from ESMF_TimeGet for set_date_from_time_float')
endsubroutine set_date_from_time_float
!=========================================================================================
integer function TimeGetymd( date, tod ) 8,10
!
! Get the date and time of day in ymd from ESMF Time.
!
type(ESMF_Time), intent(inout) :: date ! Input date to convert to ymd
integer, intent(out), optional :: tod ! Time of day in seconds
character(len=*), parameter :: sub = 'TimeGetymd'
integer :: yr, mon, day
integer :: rc ! return code
call ESMF_TimeGet( date, yy=yr, mm=mon, dd=day, rc=rc)
call chkrc(rc, sub//': error return from ESMF_TimeGet')
TimeGetymd = yr*10000 + mon*100 + day
if ( present( tod ) )then
call ESMF_TimeGet( date, yy=yr, mm=mon, dd=day, s=tod, rc=rc)
call chkrc(rc, sub//': error return from ESMF_TimeGet')
end if
if ( yr < 0 )then
write(iulog,*) sub//': error year is less than zero', yr
call endrun
end if
end function TimeGetymd
!=========================================================================================
subroutine timemgr_set_date_time( new_ymd, new_tod ),8
implicit none
integer, intent(IN) :: new_ymd ! date (YYYYMMDD)
integer, intent(IN) :: new_tod ! time of day (sec)
type(ESMF_Time) :: new_time ! new time obj
type(ESMF_Time) :: clk_time ! clock's time obj
integer :: rc ! return code
character(len=*), parameter :: sub = 'timemgr_set_date_time'
new_time = TimeSetymd( new_ymd, new_tod, "curr_date" )
! Advance clock to the new time
call ESMF_ClockGet(tm_clock, currTime=clk_time, rc=rc )
call chkrc(rc, sub//': error return from ESMF_ClockGet')
do while( new_time > clk_time )
call ESMF_ClockAdvance( tm_clock, rc=rc )
call chkrc(rc, sub//': error return from ESMF_ClockAdvance')
call ESMF_ClockGet(tm_clock, currTime=clk_time )
call chkrc(rc, sub//': error return from ESMF_ClockGet')
end do
! Print configuration summary to log file (stdout).
if (masterproc) then
call timemgr_print()
end if
end subroutine timemgr_set_date_time
!=========================================================================================
subroutine timemgr_restart( stop_ymd, stop_tod ) 2,43
! Restart the ESMF time manager.
!
! NOTE - Assumptions:
! 1) Restart data have been read on the master process before this routine is called.
! (timemgr_read_restart called from control/restart.F90::cam_read_restart)
! 2) Stopping time has been set and input to this routine.
! Arguments
integer, intent(IN) :: stop_ymd ! Stop date (YYYYMMDD)
integer, intent(IN) :: stop_tod ! Stop time of day (sec)
! Local variables
character(len=*), parameter :: sub = 'timemgr_restart'
integer :: rc ! return code
type(ESMF_Time) :: start_date ! start date for run
type(ESMF_Time) :: stop_date ! stop date for run
type(ESMF_Time) :: ref_date ! reference date
type(ESMF_Time) :: curr_date ! date of data in restart file
!-----------------------------------------------------------------------------------------
#if ( defined SPMD )
call mpibcast(rst_calendar, len(rst_calendar), mpichar, 0, mpicom)
call mpibcast(rst_step_sec, 1, mpiint, 0, mpicom)
call mpibcast(rst_start_ymd, 1, mpiint, 0, mpicom)
call mpibcast(rst_start_tod, 1, mpiint, 0, mpicom)
call mpibcast(rst_stop_ymd, 1, mpiint, 0, mpicom)
call mpibcast(rst_stop_tod, 1, mpiint, 0, mpicom)
call mpibcast(rst_ref_ymd, 1, mpiint, 0, mpicom)
call mpibcast(rst_ref_tod, 1, mpiint, 0, mpicom)
call mpibcast(rst_curr_ymd, 1, mpiint, 0, mpicom)
call mpibcast(rst_curr_tod, 1, mpiint, 0, mpicom)
call mpibcast(rst_perp_ymd, 1, mpiint, 0, mpicom)
call mpibcast(rst_perp_cal, 1, mpilog, 0, mpicom)
#endif
calendar = trim(rst_calendar)
! Initialize calendar type.
call init_calendar( )
! Initialize the timestep.
dtime = rst_step_sec
! Initialize start date.
start_date = TimeSetymd( rst_start_ymd, rst_start_tod, "start_date" )
! Initialize stop date.
stop_date = TimeSetymd( stop_ymd, stop_tod, "stop_date" )
! Initialize current date.
curr_date = TimeSetymd( rst_curr_ymd, rst_curr_tod, "curr_date" )
! Initialize ref date.
ref_date = TimeSetymd( rst_ref_ymd, rst_ref_tod, "ref_date" )
! Initialize clock and the stop date
call initialize_clock( start_date, ref_date, curr_date, stop_date )
! Advance the timestep. Data from the restart file corresponds to the
! last timestep of the previous run.
call advance_timestep()
! Set flag that this is the first timestep of the restart run.
tm_first_restart_step = .true.
! Initialize date used for perpetual calendar day calculation.
if ( rst_perp_cal ) then
tm_perp_date = TimeSetymd( rst_perp_ymd, 0, "tm_perp_date" )
tm_perp_calendar = .true.
end if
! Print configuration summary to log file (stdout).
if (masterproc) then
call timemgr_print()
end if
end subroutine timemgr_restart
!=========================================================================================
subroutine timemgr_check_restart( calendar_in, start_ymd, start_tod, ref_ymd, & 1,6
ref_tod, dtime_in, perpetual_run, perpetual_ymd )
! Check that time-manager restart agrees with input clock information primitives.
!
! Arguments
character(len=*), intent(IN) :: calendar_in ! Calendar type
integer, intent(IN) :: start_ymd ! Start date (YYYYMMDD)
integer, intent(IN) :: start_tod ! Start time of day (sec)
integer, intent(IN) :: ref_ymd ! Reference date (YYYYMMDD)
integer, intent(IN) :: ref_tod ! Reference time of day (sec)
integer, intent(IN) :: dtime_in ! Time-step
logical, intent(IN) :: perpetual_run ! If in perpetual mode or not
integer, intent(IN) :: perpetual_ymd ! Perpetual date (YYYYMMDD)
! Local variables
character(len=*), parameter :: sub = 'timemgr_check_restart'
!-----------------------------------------------------------------------------------------
! Check that input agrees with data on restart file
if ( (rst_start_ymd /= start_ymd) .or. (rst_start_tod /= start_tod) )then
write(iulog,*) sub,' start ',rst_start_ymd,start_ymd,rst_start_tod,start_tod
call endrun( sub//': input start date does not agree with restart' )
end if
if ( (rst_ref_ymd /= ref_ymd) .or. (rst_ref_tod /= ref_tod) )then
write(iulog,*) sub,' ref ',rst_ref_ymd,ref_ymd,rst_ref_tod,ref_tod
call endrun( sub//': input ref date does not agree with restart' )
end if
if ( rst_perp_cal .neqv. perpetual_run )then
call endrun( sub//': input perpetual mode does not agree with restart' )
end if
if ( rst_step_sec /= dtime_in )then
call endrun( sub//': input dtime does not agree with restart' )
end if
if ( trim(rst_calendar) /= trim(calendar_in) )then
write(iulog,*) 'Input calendar: ', trim(calendar_in)
write(iulog,*) 'Restart calendar: ', trim(rst_calendar)
call endrun( sub//': input calendar does not agree with restart' )
end if
if ( perpetual_run )then
if ( (rst_perp_ymd /= perpetual_ymd) )then
call endrun( sub//': input perpetual date does not agree with restart' )
end if
end if
end subroutine timemgr_check_restart
!=========================================================================================
subroutine init_calendar( ) 5,10
!
! Initialize calendar
!
! Local variables
character(len=*), parameter :: sub = 'init_calendar'
type(ESMF_CalendarType) :: cal_type ! calendar type
character(len=len(calendar)) :: caltmp
integer :: rc ! return code
caltmp = to_upper(trim(calendar) )
if ( trim(caltmp) == 'NO_LEAP' .or. trim(caltmp) == 'NOLEAP' ) then
cal_type = ESMF_CAL_NOLEAP
else if ( trim(caltmp) == 'GREGORIAN' ) then
cal_type = ESMF_CAL_GREGORIAN
else
write(iulog,*)sub,': unrecognized calendar specified: ',calendar
call endrun
end if
tm_cal = ESMF_CalendarCreate( name=caltmp, calendarType=cal_type, rc=rc )
call chkrc(rc, sub//': error return from ESMF_CalendarSet')
end subroutine init_calendar
!=========================================================================================
subroutine timemgr_print() 5,28
! Local variables
character(len=*), parameter :: sub = 'timemgr_print'
integer :: rc
integer :: yr, mon, day
integer ::& ! Data required to restart time manager:
nstep = uninit_int, &! current step number
step_sec = uninit_int, &! timestep size seconds
start_yr = uninit_int, &! start year
start_mon = uninit_int, &! start month
start_day = uninit_int, &! start day of month
start_tod = uninit_int, &! start time of day
stop_yr = uninit_int, &! stop year
stop_mon = uninit_int, &! stop month
stop_day = uninit_int, &! stop day of month
stop_tod = uninit_int, &! stop time of day
ref_yr = uninit_int, &! reference year
ref_mon = uninit_int, &! reference month
ref_day = uninit_int, &! reference day of month
ref_tod = uninit_int, &! reference time of day
curr_yr = uninit_int, &! current year
curr_mon = uninit_int, &! current month
curr_day = uninit_int, &! current day of month
curr_tod = uninit_int ! current time of day
integer(ESMF_KIND_I8) :: step_no
type(ESMF_Time) :: start_date! start date for run
type(ESMF_Time) :: stop_date ! stop date for run
type(ESMF_Time) :: curr_date ! date of data in restart file
type(ESMF_Time) :: ref_date ! reference date
type(ESMF_TimeInterval) :: step ! Time-step
!-----------------------------------------------------------------------------------------
call ESMF_ClockGet( tm_clock, startTime=start_date, currTime=curr_date, &
refTime=ref_date, stopTime=stop_date, timeStep=step, &
advanceCount=step_no, rc=rc )
call chkrc(rc, sub//': error return from ESMF_ClockGet')
nstep = step_no
write(iulog,*)' ********** Time Manager Configuration **********'
call ESMF_TimeIntervalGet( step, s=step_sec, rc=rc )
call chkrc(rc, sub//': error return from ESMF_TimeIntervalGet')
call ESMF_TimeGet( start_date, yy=start_yr, mm=start_mon, dd=start_day, &
s=start_tod, rc=rc )
call chkrc(rc, sub//': error return from ESMF_TimeGet')
call ESMF_TimeGet( stop_date, yy=stop_yr, mm=stop_mon, dd=stop_day, &
s=stop_tod, rc=rc )
call chkrc(rc, sub//': error return from ESMF_TimeGet')
call ESMF_TimeGet( ref_date, yy=ref_yr, mm=ref_mon, dd=ref_day, s=ref_tod, &
rc=rc )
call chkrc(rc, sub//': error return from ESMF_TimeGet')
call ESMF_TimeGet( curr_date, yy=curr_yr, mm=curr_mon, dd=curr_day, &
s=curr_tod, rc=rc )
call chkrc(rc, sub//': error return from ESMF_TimeGet')
write(iulog,*)' Calendar type: ',trim(calendar)
write(iulog,*)' Timestep size (seconds): ', step_sec
write(iulog,*)' Start date (yr mon day tod): ', start_yr, start_mon, &
start_day, start_tod
write(iulog,*)' Stop date (yr mon day tod): ', stop_yr, stop_mon, &
stop_day, stop_tod
write(iulog,*)' Reference date (yr mon day tod): ', ref_yr, ref_mon, &
ref_day, ref_tod
write(iulog,*)' Current step number: ', nstep
write(iulog,*)' Current date (yr mon day tod): ', curr_yr, curr_mon, &
curr_day, curr_tod
if ( tm_perp_calendar ) then
call ESMF_TimeGet( tm_perp_date, yy=yr, mm=mon, dd=day, rc=rc )
call chkrc(rc, sub//': error return from ESMF_TimeGet')
write(iulog,*)' Use perpetual diurnal cycle date (yr mon day): ', &
yr, mon, day
end if
write(iulog,*)' ************************************************'
end subroutine timemgr_print
!=========================================================================================
subroutine advance_timestep() 4,4
! Increment the timestep number.
! Local variables
character(len=*), parameter :: sub = 'advance_timestep'
integer :: rc
!-----------------------------------------------------------------------------------------
call ESMF_ClockAdvance( tm_clock, rc=rc )
call chkrc(rc, sub//': error return from ESMF_ClockAdvance')
! Set first step flag off.
tm_first_restart_step = .false.
end subroutine advance_timestep
!=========================================================================================
integer function get_step_size() 94,8
! Return the step size in seconds.
! Local variables
character(len=*), parameter :: sub = 'get_step_size'
type(ESMF_TimeInterval) :: step_size ! timestep size
integer :: rc
!-----------------------------------------------------------------------------------------
call ESMF_ClockGet(tm_clock, timeStep=step_size, rc=rc)
call chkrc(rc, sub//': error return from ESMF_ClockGet')
call ESMF_TimeIntervalGet(step_size, s=get_step_size, rc=rc)
call chkrc(rc, sub//': error return from ESMF_ClockTimeIntervalGet')
end function get_step_size
!=========================================================================================
integer function get_nstep() 57,4
! Return the timestep number.
! Local variables
character(len=*), parameter :: sub = 'get_nstep'
integer :: rc
integer(ESMF_KIND_I8) :: step_no
!-----------------------------------------------------------------------------------------
call ESMF_ClockGet(tm_clock, advanceCount=step_no, rc=rc)
call chkrc(rc, sub//': error return from ESMF_ClockGet')
get_nstep = step_no
end function get_nstep
!=========================================================================================
subroutine get_curr_date(yr, mon, day, tod, offset) 63,16
! Return date components valid at end of current timestep with an optional
! offset (positive or negative) in seconds.
! Arguments
integer, intent(out) ::&
yr, &! year
mon, &! month
day, &! day of month
tod ! time of day (seconds past 0Z)
integer, optional, intent(in) :: offset ! Offset from current time in seconds.
! Positive for future times, negative
! for previous times.
! Local variables
character(len=*), parameter :: sub = 'get_curr_date'
integer :: rc
type(ESMF_Time) :: date
type(ESMF_TimeInterval) :: off
!-----------------------------------------------------------------------------------------
call ESMF_ClockGet( tm_clock, currTime=date, rc=rc )
call chkrc(rc, sub//': error return from ESMF_ClockGet')
if (present(offset)) then
if (offset > 0) then
call ESMF_TimeIntervalSet( off, s=offset, rc=rc )
call chkrc(rc, sub//': error return from ESMF_TimeIntervalSet')
date = date + off
else if (offset < 0) then
call ESMF_TimeIntervalSet( off, s=-offset, rc=rc )
call chkrc(rc, sub//': error return from ESMF_TimeIntervalSet')
date = date - off
end if
end if
call ESMF_TimeGet(date, yy=yr, mm=mon, dd=day, s=tod, rc=rc)
call chkrc(rc, sub//': error return from ESMF_TimeGet')
end subroutine get_curr_date
!=========================================================================================
subroutine get_perp_date(yr, mon, day, tod, offset) 8,20
! Return time of day valid at end of current timestep and the components
! of the perpetual date (with an optional offset (positive or negative) in seconds.
! Arguments
integer, intent(out) ::&
yr, &! year
mon, &! month
day, &! day of month
tod ! time of day (seconds past 0Z)
integer, optional, intent(in) :: offset ! Offset from current time in seconds.
! Positive for future times, negative
! for previous times.
! Local variables
character(len=*), parameter :: sub = 'get_perp_date'
integer :: rc
type(ESMF_Time) :: date
type(ESMF_TimeInterval) :: DelTime
!-----------------------------------------------------------------------------------------
call ESMF_ClockGet( tm_clock, currTime=date, rc=rc )
! Get time of day add it to perpetual date
! Get year, month, day so that seconds are time-of-day rather than since start time
call ESMF_TimeGet(date, yy=yr, mm=mon, dd=day, s=tod, rc=rc)
call chkrc(rc, sub//': error return from ESMF_TimeGet')
call ESMF_TimeIntervalSet(DelTime, s=tod, rc=rc)
call chkrc(rc, sub//': error return from ESMF_TimeIntervalSet')
date = tm_perp_date + DelTime
if ( present(offset) )then
call ESMF_TimeIntervalSet(DelTime, s=offset, rc=rc)
call chkrc(rc, sub//': error return from ESMF_TimeIntervalSet')
date = date + DelTime
end if
! Get time of day from the result
! Get year, month, day so that seconds are time-of-day rather than since start time
call ESMF_TimeGet(date, yy=yr, mm=mon, dd=day, s=tod, rc=rc)
! Get the date from the fixed perpetual date (in case it overflows to next day)
call ESMF_TimeGet(tm_perp_date, yy=yr, mm=mon, dd=day, rc=rc)
call chkrc(rc, sub//': error return from ESMF_TimeGet')
end subroutine get_perp_date
!=========================================================================================
subroutine get_prev_date(yr, mon, day, tod) 4,8
! Return date components valid at beginning of current timestep.
! Arguments
integer, intent(out) ::&
yr, &! year
mon, &! month
day, &! day of month
tod ! time of day (seconds past 0Z)
! Local variables
character(len=*), parameter :: sub = 'get_prev_date'
integer :: rc
type(ESMF_Time) :: date
!-----------------------------------------------------------------------------------------
call ESMF_ClockGet(tm_clock, prevTime=date, rc=rc )
call chkrc(rc, sub//': error return from ESMF_ClockGet')
call ESMF_TimeGet(date, yy=yr, mm=mon, dd=day, s=tod, rc=rc)
call chkrc(rc, sub//': error return from ESMF_TimeGet')
end subroutine get_prev_date
!=========================================================================================
subroutine get_start_date(yr, mon, day, tod) 1,8
! Return date components valid at beginning of initial run.
! Arguments
integer, intent(out) ::&
yr, &! year
mon, &! month
day, &! day of month
tod ! time of day (seconds past 0Z)
! Local variables
character(len=*), parameter :: sub = 'get_start_date'
integer :: rc
type(ESMF_Time) :: date
!-----------------------------------------------------------------------------------------
call ESMF_ClockGet(tm_clock, startTime=date, rc=rc)
call chkrc(rc, sub//': error return from ESMF_ClockGet')
call ESMF_TimeGet(date, yy=yr, mm=mon, dd=day, s=tod, rc=rc)
call chkrc(rc, sub//': error return from ESMF_TimeGet')
end subroutine get_start_date
!=========================================================================================
subroutine get_ref_date(yr, mon, day, tod) 4,8
! Return date components of the reference date.
! Arguments
integer, intent(out) ::&
yr, &! year
mon, &! month
day, &! day of month
tod ! time of day (seconds past 0Z)
! Local variables
character(len=*), parameter :: sub = 'get_ref_date'
integer :: rc
type(ESMF_Time) :: date
!-----------------------------------------------------------------------------------------
call ESMF_ClockGet(tm_clock, refTime=date, rc=rc)
call chkrc(rc, sub//': error return from ESMF_ClockGet')
call ESMF_TimeGet(date, yy=yr, mm=mon, dd=day, s=tod, rc=rc)
call chkrc(rc, sub//': error return from ESMF_TimeGet')
end subroutine get_ref_date
!=========================================================================================
subroutine get_curr_time(days, seconds) 7,12
! Return time components valid at end of current timestep.
! Current time is the time interval between the current date and the reference date.
! Arguments
integer, intent(out) ::&
days, &! number of whole days in time interval
seconds ! remaining seconds in time interval
! Local variables
character(len=*), parameter :: sub = 'get_curr_time'
integer :: rc
type(ESMF_Time) :: cdate, rdate
type(ESMF_TimeInterval) :: diff
!-----------------------------------------------------------------------------------------
call ESMF_ClockGet( tm_clock, currTime=cdate, rc=rc )
call chkrc(rc, sub//': error return from ESMF_ClockGet')
call ESMF_ClockGet( tm_clock, refTime=rdate, rc=rc )
call chkrc(rc, sub//': error return from ESMF_ClockGet')
diff = cdate - rdate
call ESMF_TimeIntervalGet(diff, d=days, s=seconds, rc=rc)
call chkrc(rc, sub//': error return from ESMF_TimeIntervalGet')
end subroutine get_curr_time
!=========================================================================================
subroutine get_prev_time(days, seconds) 2,12
! Return time components valid at beg of current timestep.
! prev time is the time interval between the prev date and the reference date.
! Arguments
integer, intent(out) ::&
days, &! number of whole days in time interval
seconds ! remaining seconds in time interval
! Local variables
character(len=*), parameter :: sub = 'get_prev_time'
integer :: rc
type(ESMF_Time) :: date, ref_date
type(ESMF_TimeInterval) :: diff
!-----------------------------------------------------------------------------------------
call ESMF_ClockGet(tm_clock, prevTime=date, rc=rc )
call chkrc(rc, sub//': error return from ESMF_ClockGet for prevTime')
call ESMF_ClockGet(tm_clock, refTime=ref_date, rc=rc )
call chkrc(rc, sub//': error return from ESMF_ClockGet for refTime')
diff = date - ref_date
call ESMF_TimeIntervalGet( diff, d=days, s=seconds, rc=rc )
call chkrc(rc, sub//': error return from ESMF_TimeintervalGet')
end subroutine get_prev_time
!=========================================================================================
function get_curr_calday(offset) 25,27
! Return calendar day at end of current timestep with optional offset.
! Calendar day 1.0 = 0Z on Jan 1.
! Arguments
integer, optional, intent(in) :: offset ! Offset from current time in seconds.
! Positive for future times, negative
! for previous times.
! Return value
real(r8) :: get_curr_calday
! Local variables
character(len=*), parameter :: sub = 'get_curr_calday'
integer :: rc
type(ESMF_Time) :: date
type(ESMF_TimeInterval) :: off, diurnal
integer :: year, month, day, tod
!-----------------------------------------------------------------------------------------
call ESMF_ClockGet( tm_clock, currTime=date, rc=rc )
call chkrc(rc, sub//': error return from ESMF_ClockGet')
if (present(offset)) then
if (offset > 0) then
call ESMF_TimeIntervalSet( off, s=offset, rc=rc )
call chkrc(rc, sub//': error return from ESMF_TimeIntervalSet')
date = date + off
else if (offset < 0) then
call ESMF_TimeIntervalSet( off, s=-offset, rc=rc )
call chkrc(rc, sub//': error return from ESMF_TimeIntervalSet')
date = date - off
end if
end if
if ( tm_perp_calendar ) then
! Get current time-of-day from clock
call ESMF_TimeGet(date, yy=year, mm=month, dd=day, s=tod, rc=rc)
call chkrc(rc, sub//': error return from ESMF_TimeGet')
! Get date from perpetual date add time-of-day to it
call ESMF_TimeIntervalSet( diurnal, s=tod, rc=rc )
call chkrc(rc, sub//': error return from ESMF_TimeIntervalSet')
date = tm_perp_date + diurnal
!!!! write(iulog,*) ' tod = ', tod
!!!! call ESMF_TimePrint( date, "string" )
end if
call ESMF_TimeGet( date, dayOfYear_r8=get_curr_calday, rc=rc )
call chkrc(rc, sub//': error return from ESMF_TimeGet')
!
! WARNING: Gregorian calendar fakes day 366
!
! The zenith angle calculation is only capable of using a 365-day calendar.
! If a Gregorian calendar is being used, the last day of a leap year (day 366)
! is sent to the model as a repetition of the previous day (day 365).
! This is done by decrementing calday by 1 immediately below.
! bundy, July 2008
!
if (( get_curr_calday > 366.0 ) .and. ( get_curr_calday <= 367.0 ) &
.and. (get_calendar() .eq. 'GREGORIAN')) then
get_curr_calday = get_curr_calday - 1.0
endif
if ( (get_curr_calday < 1.0) .or. (get_curr_calday > 366.0) )then
write(iulog,*) 'atm '//sub//' calday = ', get_curr_calday
if ( present(offset) ) write(iulog,*) 'offset = ', offset
call endrun( sub//': error get_curr_calday out of bounds' )
end if
end function get_curr_calday
!=========================================================================================
function get_calday(ymd, tod) 2,9
! Return calendar day corresponding to specified time instant.
! Calendar day 1.0 = 0Z on Jan 1.
! Arguments
integer, intent(in) :: &
ymd, &! date in yearmmdd format
tod ! time of day (seconds past 0Z)
! Return value
real(r8) :: get_calday
! Local variables
character(len=*), parameter :: sub = 'get_calday'
integer :: rc ! return code
type(ESMF_Time) :: date
!-----------------------------------------------------------------------------------------
date = TimeSetymd( ymd, tod, "get_calday" )
call ESMF_TimeGet( date, dayOfYear_r8=get_calday, rc=rc )
call chkrc(rc, sub//': error return from ESMF_TimeGet')
!
! WARNING: Gregorian calendar fakes day 366
!
! The zenith angle calculation is only capable of using a 365-day calendar.
! If a Gregorian calendar is being used, the last day of a leap year (day 366)
! is sent to the model as a repetition of the previous day (day 365).
! This is done by decrementing calday by 1 immediately below.
! bundy, July 2008
!
if (( get_calday > 366.0 ) .and. ( get_calday <= 367.0 ) &
.and. (get_calendar() .eq. 'GREGORIAN')) then
get_calday = get_calday - 1.0
endif
if ( (get_calday < 1.0) .or. (get_calday > 366.0) )then
write(iulog,*) 'atm '//sub//' calday = ', get_calday
call endrun( sub//': error calday out of range' )
end if
end function get_calday
!=========================================================================================
character(len=SHR_KIND_CS) function get_calendar() 5
! Return calendar type
! Local variables
character(len=*), parameter :: sub = 'get_calendar'
!-----------------------------------------------------------------------------------------
get_calendar = trim(calendar)
end function get_calendar
!=========================================================================================
function is_end_curr_day() 3,2
! Return true if current timestep is last timestep in current day.
! Return value
logical :: is_end_curr_day
! Local variables
integer ::&
yr, &! year
mon, &! month
day, &! day of month
tod ! time of day (seconds past 0Z)
!-----------------------------------------------------------------------------------------
call get_curr_date(yr, mon, day, tod)
is_end_curr_day = (tod == 0)
end function is_end_curr_day
!=========================================================================================
logical function is_end_curr_month(),2
! Return true if current timestep is last timestep in current month.
! Local variables
integer ::&
yr, &! year
mon, &! month
day, &! day of month
tod ! time of day (seconds past 0Z)
!-----------------------------------------------------------------------------------------
call get_curr_date(yr, mon, day, tod)
is_end_curr_month = (day == 1 .and. tod == 0)
end function is_end_curr_month
!=========================================================================================
logical function is_first_step() 17,4
! Return true on first step of initial run only.
! Local variables
character(len=*), parameter :: sub = 'is_first_step'
integer :: rc
integer :: nstep
integer(ESMF_KIND_I8) :: step_no
!-----------------------------------------------------------------------------------------
call ESMF_ClockGet( tm_clock, advanceCount=step_no, rc=rc )
call chkrc(rc, sub//': error return from ESMF_ClockGet')
nstep = step_no
is_first_step = (nstep == 0)
end function is_first_step
!=========================================================================================
logical function is_first_restart_step() 3
! Return true on first step of restart run only.
!-----------------------------------------------------------------------------------------
is_first_restart_step = tm_first_restart_step
end function is_first_restart_step
!=========================================================================================
logical function is_last_step() 1,4
! Return true on last timestep.
! Local variables
character(len=*), parameter :: sub = 'is_last_step'
type(ESMF_Time) :: stop_date
type(ESMF_Time) :: curr_date
type(ESMF_TimeInterval) :: time_step
integer :: rc
!-----------------------------------------------------------------------------------------
call ESMF_ClockGet( tm_clock, stopTime=stop_date, &
currTime=curr_date, TimeStep=time_step, rc=rc )
call chkrc(rc, sub//': error return from ESMF_ClockGet')
if ( curr_date+time_step > stop_date ) then
is_last_step = .true.
else
is_last_step = .false.
end if
end function is_last_step
!=========================================================================================
logical function is_perpetual() 11
! Return true on last timestep.
!-----------------------------------------------------------------------------------------
is_perpetual = tm_perp_calendar
end function is_perpetual
!=========================================================================================
subroutine timemgr_init_restart(File) 1,1
type(File_desc_t) :: File
integer :: i, ret, dims(1)
call timevars_set_names()
rst_calendar = trim(calendar)
ret = PIO_DEF_dim(File, 'cal_strlen', 32, dims(1))
ret = PIO_def_var(File, timevars(1)%name, PIO_CHAR,dims(1:1),timevars(1)%vardesc)
do i=2,varcnt
ret = PIO_def_var(File, timevars(i)%name, PIO_INT, dims(1:0), timevars(i)%vardesc)
end do
end subroutine timemgr_init_restart
subroutine timemgr_write_restart(File) 1,8
type(File_desc_t) :: File
type(var_id), pointer :: timevar
integer :: rst_perp_cal_int
integer :: i, ret
character(len=*), parameter :: sub = 'timemgr_write_nfrestart'
type(ESMF_Time) :: start_date ! start date for run
type(ESMF_Time) :: stop_date ! stop date for run
type(ESMF_Time) :: curr_date ! temporary date used in logic
type(ESMF_Time) :: ref_date ! reference date for time coordinate
if ( tm_perp_calendar ) then
rst_perp_ymd = TimeGetymd( tm_perp_date )
rst_perp_cal = tm_perp_calendar
else
rst_perp_cal = .false.
end if
call ESMF_ClockGet( tm_clock, startTime=start_date, stopTime=stop_date, &
currTime=curr_date, refTime=ref_date, rc=ret )
call chkrc(ret, sub//': error return from ESMF_ClockGet')
rst_step_sec = dtime
rst_start_ymd = TimeGetymd( start_date, tod=rst_start_tod )
rst_stop_ymd = TimeGetymd( stop_date, tod=rst_stop_tod )
rst_ref_ymd = TimeGetymd( ref_date, tod=rst_ref_tod )
rst_curr_ymd = TimeGetymd( curr_date, tod=rst_curr_tod )
if ( rst_perp_cal ) then
rst_perp_cal_int = 1
else
rst_perp_cal_int = 0
end if
do i=1,varcnt
timevar => timevars(i)
if(timevar%name .eq. 'rst_calendar') then
ret = PIO_put_var(File, timevar%vardesc%varID, rst_calendar)
else if(timevar%name == 'rst_nstep') then
ret = PIO_put_var(File, timevar%vardesc%varID, rst_nstep)
else if(timevar%name == 'rst_step_days') then
ret = PIO_put_var(File, timevar%vardesc%varID, rst_step_days)
else if(timevar%name == 'rst_step_sec') then
ret = PIO_put_var(File, timevar%vardesc%varID, rst_step_sec)
else if(timevar%name == 'rst_start_ymd') then
ret = PIO_put_var(File, timevar%vardesc%varID, rst_start_ymd)
else if(timevar%name == 'rst_start_tod') then
ret = PIO_put_var(File, timevar%vardesc%varID, rst_start_tod)
else if(timevar%name == 'rst_stop_ymd') then
ret = PIO_put_var(File, timevar%vardesc%varID, rst_stop_ymd)
else if(timevar%name == 'rst_stop_tod') then
ret = PIO_put_var(File, timevar%vardesc%varID, rst_stop_tod)
else if(timevar%name == 'rst_ref_ymd') then
ret = PIO_put_var(File, timevar%vardesc%varID, rst_ref_ymd)
else if(timevar%name == 'rst_ref_tod') then
ret = PIO_put_var(File, timevar%vardesc%varID, rst_ref_tod)
else if(timevar%name == 'rst_curr_ymd') then
ret = PIO_put_var(File, timevar%vardesc%varID, rst_curr_ymd)
else if(timevar%name == 'rst_curr_tod') then
ret = PIO_put_var(File, timevar%vardesc%varID, rst_curr_tod)
else if(timevar%name == 'rst_perp_ymd') then
ret = PIO_put_var(File, timevar%vardesc%varID, rst_perp_ymd)
else if(timevar%name == 'rst_perp_cal_int') then
ret = PIO_put_var(File, timevar%vardesc%varID, rst_perp_cal_int)
else
write(iulog,*) __FILE__,__LINE__,'Could not find a match for ', i, timevar%name
call endrun('time_manager')
end if
end do
end subroutine timemgr_write_restart
subroutine timemgr_read_restart(File) 1,2
type(File_desc_t) :: File
type(var_id), pointer :: timevar
integer :: ret, i
integer :: rst_perp_cal_int
call timevars_set_names()
do i=1,varcnt
ret = PIO_inq_varid(File, timevars(i)%name, timevars(i)%vardesc)
end do
do i=1,varcnt
timevar => timevars(i)
if(timevar%name == 'rst_calendar') then
ret = PIO_get_var(File, timevar%vardesc%varID, rst_calendar)
if(rst_calendar(1:7).eq.'NO_LEAP') then
rst_calendar(8:)=' '
else if(rst_calendar(1:9).eq.'GREGORIAN') then
rst_calendar(10:)=' '
end if
else if(timevar%name == 'rst_nstep') then
ret = PIO_get_var(File, timevar%vardesc%varID, rst_nstep)
else if(timevar%name == 'rst_step_days') then
ret = PIO_get_var(File, timevar%vardesc%varID, rst_step_days)
else if(timevar%name == 'rst_step_sec') then
ret = PIO_get_var(File, timevar%vardesc%varID, rst_step_sec)
else if(timevar%name == 'rst_start_ymd') then
ret = PIO_get_var(File, timevar%vardesc%varID, rst_start_ymd)
else if(timevar%name == 'rst_start_tod') then
ret = PIO_get_var(File, timevar%vardesc%varID, rst_start_tod)
else if(timevar%name == 'rst_stop_ymd') then
ret = PIO_get_var(File, timevar%vardesc%varID, rst_stop_ymd)
else if(timevar%name == 'rst_stop_tod') then
ret = PIO_get_var(File, timevar%vardesc%varID, rst_stop_tod)
else if(timevar%name == 'rst_ref_ymd') then
ret = PIO_get_var(File, timevar%vardesc%varID, rst_ref_ymd)
else if(timevar%name == 'rst_ref_tod') then
ret = PIO_get_var(File, timevar%vardesc%varID, rst_ref_tod)
else if(timevar%name == 'rst_curr_ymd') then
ret = PIO_get_var(File, timevar%vardesc%varID, rst_curr_ymd)
else if(timevar%name == 'rst_curr_tod') then
ret = PIO_get_var(File, timevar%vardesc%varID, rst_curr_tod)
else if(timevar%name == 'rst_perp_ymd') then
ret = PIO_get_var(File, timevar%vardesc%varID, rst_perp_ymd)
else if(timevar%name == 'rst_perp_cal_int') then
ret = PIO_get_var(File, timevar%vardesc%varID, rst_perp_cal_int)
else
write(iulog,*) __FILE__,__LINE__,'Could not find a match for ', i, timevar%name
call endrun('time_manager')
end if
end do
if ( rst_perp_cal_int /= 0 ) then
rst_perp_cal = .true.
else
rst_perp_cal = .false.
end if
end subroutine timemgr_read_restart
subroutine timevars_set_names() 2
timevars(1)%name = 'rst_calendar'
timevars(2)%name = 'rst_nstep'
timevars(3)%name = 'rst_step_days'
timevars(4)%name = 'rst_step_sec'
timevars(5)%name = 'rst_start_ymd'
timevars(6)%name = 'rst_start_tod'
timevars(7)%name = 'rst_stop_ymd'
timevars(8)%name = 'rst_stop_tod'
timevars(9)%name = 'rst_ref_ymd'
timevars(10)%name = 'rst_ref_tod'
timevars(11)%name = 'rst_curr_ymd'
timevars(12)%name = 'rst_curr_tod'
timevars(13)%name = 'rst_perp_ymd'
timevars(14)%name = 'rst_perp_cal_int'
end subroutine timevars_set_names
subroutine timemgr_datediff(ymd1, tod1, ymd2, tod2, days) 2,8
! Calculate the difference (ymd2,tod2) - (ymd1,tod1) and return the result in days.
! Arguments
integer, intent(in) ::&
ymd1, &! date1 in yyyymmdd format
tod1, &! time of day relative to date1 (seconds past 0Z)
ymd2, &! date2 in yyyymmdd format
tod2 ! time of day relative to date2 (seconds past 0Z)
real(r8) :: days ! (ymd2,tod2)-(ymd1,tod1) in days
! Local variables
character(len=*), parameter :: sub = 'timemgr_datediff'
integer :: rc ! return code
type(ESMF_Time) :: date1
type(ESMF_Time) :: date2
type(ESMF_TimeInterval) :: diff
!-----------------------------------------------------------------------------------------
date1 = TimeSetymd( ymd1, tod1, "date1" )
date2 = TimeSetymd( ymd2, tod2, "date2" )
diff = date2 - date1
call ESMF_TimeIntervalGet( diff, d_r8=days, rc=rc )
call chkrc(rc, sub//': error return from ESMF_TimeIntervalGet')
end subroutine timemgr_datediff
!=========================================================================================
subroutine timemgr_time_ge(ymd1, tod1, ymd2, tod2, time2_ge_time1),2
! time2_ge_time1 is set to true if (ymd2,tod2) is later than or equal to (ymd1,tod1)
! Arguments
integer, intent(in) ::&
ymd1, &! date1 in yyyymmdd format
tod1, &! time of day relative to date1 (seconds past 0Z)
ymd2, &! date2 in yyyymmdd format
tod2 ! time of day relative to date2 (seconds past 0Z)
logical :: time2_ge_time1
! Local variables
character(len=*), parameter :: sub = 'timemgr_time_ge'
integer :: rc ! return code
type(ESMF_Time) :: time1, time2
!-----------------------------------------------------------------------------------------
time1 = TimeSetymd( ymd1, tod1, "date1" )
time2 = TimeSetymd( ymd2, tod2, "date2" )
time2_ge_time1 = (time2 >= time1)
end subroutine timemgr_time_ge
!=========================================================================================
subroutine timemgr_time_inc(ymd1, tod1, ymd2, tod2, inc_s, inc_h, inc_d),8
! Increment the time instant (ymd1,tod1) by an interval and return the resulting
! time instant (ymd2,tod2).
! Arguments
integer, intent(in) ::&
ymd1, &! date1 in yyyymmdd format
tod1 ! time of day relative to date1 (seconds past 0Z)
integer, intent(out) ::&
ymd2, &! date2 in yyyymmdd format
tod2 ! time of day relative to date2 (seconds past 0Z)
integer, intent(in), optional ::&
inc_s, &! number of seconds in interval
inc_h, &! number of hours in interval
inc_d ! number of days in interval
! Local variables
character(len=*), parameter :: sub = 'timemgr_time_inc'
integer :: rc ! return code
type(ESMF_Time) :: date1
type(ESMF_Time) :: date2
type(ESMF_TimeInterval) :: t_interval
integer :: year, month, day
!-----------------------------------------------------------------------------------------
! set esmf time object
date1 = TimeSetymd( ymd1, tod1, "date1" )
! set esmf time interval object
if (present(inc_s)) then
call ESMF_TimeIntervalSet(t_interval, s=inc_s, rc=rc)
else if (present(inc_h)) then
call ESMF_TimeIntervalSet(t_interval, h=inc_h, rc=rc)
else if (present(inc_d)) then
call ESMF_TimeIntervalSet(t_interval, d=inc_d, rc=rc)
else
call endrun(sub//': one of the args inc_s, inc_h, or inc_d must be set')
end if
call chkrc(rc, sub//': error return from ESMF_TimeIntervalSet')
! increment the time instant
date2 = date1 + t_interval
! extract the time components
call ESMF_TimeGet(date2, yy=year, mm=month, dd=day, s=tod2, rc=rc)
call chkrc(rc, sub//': error return from ESMF_TimeGet')
ymd2 = year*10000 + month*100 + day
end subroutine timemgr_time_inc
!=========================================================================================
subroutine chkrc(rc, mes) 124,2
integer, intent(in) :: rc ! return code from time management library
character(len=*), intent(in) :: mes ! error message
if ( rc == ESMF_SUCCESS ) return
write(iulog,*) mes
call endrun ('CHKRC')
end subroutine chkrc
end module time_manager