MODULE daymod !!====================================================================== !! *** MODULE daymod *** !! Ocean : management of the model calendar !!===================================================================== !! History : OPA ! 1994-09 (M. Pontaud M. Imbard) Original code !! ! 1997-03 (O. Marti) !! ! 1997-05 (G. Madec) !! ! 1997-08 (M. Imbard) !! NEMO 1.0 ! 2003-09 (G. Madec) F90 + nyear, nmonth, nday !! ! 2004-01 (A.M. Treguier) new calculation based on adatrj !! ! 2006-08 (G. Madec) surface module major update !! ! 2015-11 (D. Lea) Allow non-zero initial time of day !!---------------------------------------------------------------------- !!---------------------------------------------------------------------- !! day : calendar !!---------------------------------------------------------------------- !! ----------- WARNING ----------- !! ------------------------------- !! sbcmod assume that the time step is dividing the number of second of !! in a day, i.e. ===> MOD( rday, rn_Dt ) == 0 !! except when user defined forcing is used (see sbcmod.F90) !!---------------------------------------------------------------------- USE dom_oce ! ocean space and time domain USE phycst ! physical constants USE ioipsl , ONLY : ymds2ju ! for calendar USE trc_oce , ONLY : l_offline ! offline flag ! USE in_out_manager ! I/O manager USE prtctl ! Print control USE iom ! USE timing ! Timing USE restart ! restart IMPLICIT NONE PRIVATE PUBLIC day ! called by step.F90 PUBLIC day_init ! called by istate.F90 PUBLIC day_mth ! Needed by TAM INTEGER, PUBLIC :: nsecd, nsecd05, ndt, ndt05 !: (PUBLIC for TAM) !!---------------------------------------------------------------------- !! NEMO/OCE 4.0 , NEMO Consortium (2018) !! $Id$ !! Software governed by the CeCILL license (see ./LICENSE) !!---------------------------------------------------------------------- CONTAINS SUBROUTINE day_init !!---------------------------------------------------------------------- !! *** ROUTINE day_init *** !! !! ** Purpose : Initialization of the calendar values to their values 1 time step before nit000 !! because day will be called at the beginning of step !! !! ** Action : - nyear : current year !! - nmonth : current month of the current nyear !! - nday : current day of the current nmonth !! - nday_year : current day of the current nyear !! - nsec_year : seconds between 00h jan 1st of the current year and half of the current time step !! - nsec_month : seconds between 00h 1st day of the current month and half of the current time step !! - nsec_monday : seconds between 00h of the last Monday and half of the current time step !! - nsec_day : seconds between 00h of the current day and half of the current time step !! - nsec1jan000 : seconds between Jan. 1st 00h of nit000 year and Jan. 1st 00h of the current year !! - nmonth_len, nyear_len, nmonth_beg through day_mth !!---------------------------------------------------------------------- INTEGER :: inbday, imonday, isecrst ! local integers REAL(wp) :: zjul ! local scalar !!---------------------------------------------------------------------- ! ! max number of seconds between each restart IF( REAL( nitend - nit000 + 1 ) * rn_Dt > REAL( HUGE( nsec1jan000 ) ) ) THEN CALL ctl_stop( 'The number of seconds between each restart exceeds the integer 4 max value: 2^31-1. ', & & 'You must do a restart at higher frequency (or remove this stop and recompile the code in I8)' ) ENDIF nsecd = NINT( rday ) nsecd05 = NINT( 0.5 * rday ) ndt = NINT( rn_Dt ) ndt05 = NINT( 0.5 * rn_Dt ) lrst_oce = .NOT. l_offline ! force definition of offline IF( lrst_oce ) CALL day_rst( nit000, 'READ' ) ! set the calandar from ndastp (read in restart file and namelist) nyear = ndastp / 10000 nmonth = ( ndastp - (nyear * 10000) ) / 100 nday = ndastp - (nyear * 10000) - ( nmonth * 100 ) nhour = nn_time0 / 100 nminute = ( nn_time0 - nhour * 100 ) isecrst = ( nhour * NINT(rhhmm) + nminute ) * NINT(rmmss) CALL ymds2ju( nyear, nmonth, nday, REAL(isecrst,wp), fjulday ) IF( ABS(fjulday - REAL(NINT(fjulday),wp)) < 0.1 / rday ) fjulday = REAL(NINT(fjulday),wp) ! avoid truncation error IF( nhour*NINT(rhhmm*rmmss) + nminute*NINT(rmmss) - ndt05 .LT. 0 ) fjulday = fjulday+1. ! move back to the day at nit000 (and not at nit000 - 1) nsec1jan000 = 0 CALL day_mth IF ( nday == 0 ) THEN ! for ex if ndastp = ndate0 - 1 nmonth = nmonth - 1 nday = nmonth_len(nmonth) ENDIF IF ( nmonth == 0 ) THEN ! go at the end of previous year nmonth = 12 nyear = nyear - 1 nsec1jan000 = nsec1jan000 - nsecd * nyear_len(0) IF( nleapy == 1 ) CALL day_mth ENDIF ! day since january 1st nday_year = nday + SUM( nmonth_len(1:nmonth - 1) ) !compute number of days between last Monday and today CALL ymds2ju( 1900, 01, 01, 0.0_wp, zjul ) ! compute julian day value of 01.01.1900 (our reference that was a Monday) inbday = FLOOR(fjulday - zjul) ! compute nb day between 01.01.1900 and start of current day imonday = MOD(inbday, 7) ! compute nb day between last monday and current day IF (imonday .LT. 0) imonday = imonday + 7 ! Avoid negative values for dates before 01.01.1900 ! number of seconds since the beginning of current year/month/week/day at the middle of the time-step IF( isecrst - ndt05 .GT. 0 ) THEN ! 1 timestep before current middle of first time step is still the same day nsec_year = (nday_year-1) * nsecd + isecrst - ndt05 nsec_month = (nday-1) * nsecd + isecrst - ndt05 ELSE ! 1 time step before the middle of the first time step is the previous day nsec_year = nday_year * nsecd + isecrst - ndt05 nsec_month = nday * nsecd + isecrst - ndt05 ENDIF nsec_monday = imonday * nsecd + isecrst - ndt05 nsec_day = isecrst - ndt05 IF( nsec_day .LT. 0 ) nsec_day = nsec_day + nsecd IF( nsec_monday .LT. 0 ) nsec_monday = nsec_monday + nsecd*7 ! control print IF(lwp) WRITE(numout,'(a,i6,a,i2,a,i2,a,i8,a,i8,a,i8,a,i8)') & & ' =======>> 1/2 time step before the start of the run DATE Y/M/D = ', & & nyear, '/', nmonth, '/', nday, ' nsec_day:', nsec_day, ' nsec_monday:', nsec_monday, ' & & nsec_month:', nsec_month , ' nsec_year:' , nsec_year nsec000_1jan000 = nsec1jan000 + nsec_year + ndt05 nsecend_1jan000 = nsec000_1jan000 + ndt * ( nitend - nit000 + 1 ) ! Up to now, calendar parameters are related to the end of previous run (nit000-1) ! call day to set the calendar parameters at the begining of the current simulaton. needed by iom_init CALL day( nit000 ) ! IF( lwxios ) THEN ! define variables in restart file when writing with XIOS CALL iom_set_rstw_var_active('kt') CALL iom_set_rstw_var_active('ndastp') CALL iom_set_rstw_var_active('adatrj') CALL iom_set_rstw_var_active('ntime') ENDIF END SUBROUTINE day_init SUBROUTINE day_mth !!---------------------------------------------------------------------- !! *** ROUTINE day_init *** !! !! ** Purpose : calendar values related to the months !! !! ** Action : - nyear_len : length in days of the previous/current year !! - nmonth_len : length in days of the months of the current year !! - nmonth_half : second since the beginning of the current year and the halft of the months !! - nmonth_end : second since the beginning of the current year and the end of the months !!---------------------------------------------------------------------- INTEGER :: jm ,jy ! dummy loop indice INTEGER, DIMENSION(12) :: idaymt ! length in days of the 12 months for non-leap year !!---------------------------------------------------------------------- ! length of the month of the current year (from nleapy, read in namelist) IF ( nleapy < 2 ) THEN ! default values idaymt(1:12) = (/ 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 /) nmonth_len(-11: 25) = (/ idaymt(1:12), idaymt(1:12), idaymt(1:12), idaymt(1) /) nyear_len(:) = 365 ! IF ( nleapy == 1 ) THEN ! we are using calandar with leap years DO jy = -1,1 IF ( MOD(nyear+jy, 4) == 0 .AND. ( MOD(nyear+jy, 400) == 0 .OR. MOD(nyear+jy, 100) /= 0 ) ) THEN nmonth_len(2 + 12*jy) = 29 nyear_len( 1 + jy) = 366 ENDIF ENDDO ENDIF ELSE nmonth_len(:) = nleapy ! all months with nleapy days per year nyear_len(:) = 12 * nleapy ENDIF ! time since Jan 1st 0 1 2 ... 11 12 13 ! ---------*--|--*--|--*--| ... |--*--|--*--|--*--|-------------------------------------- ! <---> <---> <---> ... <---> <---> <---> ! month number 0 1 2 ... 11 12 13 nmonth_beg(1) = 0 DO jm = 2, 25 nmonth_beg(jm) = nmonth_beg(jm-1) + nsecd * nmonth_len(jm-1) END DO DO jm = 0,-11,-1 nmonth_beg(jm) = nmonth_beg(jm+1) - nsecd * nmonth_len(jm) END DO ! END SUBROUTINE SUBROUTINE day( kt ) !!---------------------------------------------------------------------- !! *** ROUTINE day *** !! !! ** Purpose : Compute the date with a day iteration IF necessary. !! !! ** Method : - ??? !! !! ** Action : - nyear : current year !! - nmonth : current month of the year nyear !! - nday : current day of the month nmonth !! - nday_year : current day of the year nyear !! - ndastp : = nyear*10000 + nmonth*100 + nday !! - adatrj : date in days since the beginning of the run !! - nsec_year : current time of the year (in second since 00h, jan 1st) !!---------------------------------------------------------------------- INTEGER, INTENT(in) :: kt ! ocean time-step indices ! CHARACTER (len=25) :: charout REAL(wp) :: zprec ! fraction of day corresponding to 0.1 second !!---------------------------------------------------------------------- ! IF( ln_timing ) CALL timing_start('day') ! zprec = 0.1 / rday ! ! New time-step nsec_year = nsec_year + ndt nsec_month = nsec_month + ndt nsec_monday = nsec_monday + ndt nsec_day = nsec_day + ndt adatrj = adatrj + rn_Dt / rday fjulday = fjulday + rn_Dt / rday IF( ABS(fjulday - REAL(NINT(fjulday),wp)) < zprec ) fjulday = REAL(NINT(fjulday),wp) ! avoid truncation error IF( ABS(adatrj - REAL(NINT(adatrj ),wp)) < zprec ) adatrj = REAL(NINT(adatrj ),wp) ! avoid truncation error IF( nsec_day > nsecd ) THEN ! New day ! nday = nday + 1 nday_year = nday_year + 1 nsec_day = ndt05 ! IF( nday == nmonth_len(nmonth) + 1 ) THEN ! New month nday = 1 nmonth = nmonth + 1 nsec_month = ndt05 IF( nmonth == 13 ) THEN ! New year nyear = nyear + 1 nmonth = 1 nday_year = 1 nsec_year = ndt05 nsec1jan000 = nsec1jan000 + nsecd * nyear_len(1) IF( nleapy == 1 ) CALL day_mth ENDIF ENDIF ! ndastp = nyear * 10000 + nmonth * 100 + nday ! New date ! !compute first day of the year in julian days CALL ymds2ju( nyear, 01, 01, 0.0_wp, fjulstartyear ) ! IF(lwp) WRITE(numout,'(a,i8,a,i4.4,a,i2.2,a,i2.2,a,i3.3)') '======>> time-step =', kt, & & ' New day, DATE Y/M/D = ', nyear, '/', nmonth, '/', nday, ' nday_year = ', nday_year IF(lwp) WRITE(numout,'(a,i8,a,i7,a,i5)') ' nsec_year = ', nsec_year, & & ' nsec_month = ', nsec_month, ' nsec_day = ', nsec_day, ' nsec_monday = ', nsec_monday ENDIF IF( nsec_monday > 7*nsecd ) nsec_monday = ndt05 ! New week IF(sn_cfctl%l_prtctl) THEN WRITE(charout,FMT="('kt =', I4,' d/m/y =',I2,I2,I4)") kt, nday, nmonth, nyear CALL prt_ctl_info( charout ) ENDIF IF( .NOT. l_offline ) CALL rst_opn( kt ) ! Open the restart file if needed and control lrst_oce IF( lrst_oce ) CALL day_rst( kt, 'WRITE' ) ! write day restart information ! IF( ln_timing ) CALL timing_stop('day') ! END SUBROUTINE day SUBROUTINE day_rst( kt, cdrw ) !!--------------------------------------------------------------------- !! *** ROUTINE day_rst *** !! !! ** Purpose : Read or write calendar in restart file: !! !! WRITE(READ) mode: !! kt : number of time step since the begining of the experiment at the !! end of the current(previous) run !! adatrj(0) : number of elapsed days since the begining of the experiment at the !! end of the current(previous) run (REAL -> keep fractions of day) !! ndastp : date at the end of the current(previous) run (coded as yyyymmdd integer) !! !! According to namelist parameter nrstdt, !! nrstdt = 0 no control on the date (nit000 is arbitrary). !! nrstdt = 1 we verify that nit000 is equal to the last !! time step of previous run + 1. !! In both those options, the exact duration of the experiment !! since the beginning (cumulated duration of all previous restart runs) !! is not stored in the restart and is assumed to be (nit000-1)*rn_Dt. !! This is valid is the time step has remained constant. !! !! nrstdt = 2 the duration of the experiment in days (adatrj) !! has been stored in the restart file. !!---------------------------------------------------------------------- INTEGER , INTENT(in) :: kt ! ocean time-step CHARACTER(len=*), INTENT(in) :: cdrw ! "READ"/"WRITE" flag ! REAL(wp) :: zkt, zndastp, zdayfrac, ksecs, ktime INTEGER :: ihour, iminute, isecond !!---------------------------------------------------------------------- IF( TRIM(cdrw) == 'READ' ) THEN IF( iom_varid( numror, 'kt', ldstop = .FALSE. ) > 0 ) THEN ! Get Calendar informations CALL iom_get( numror, 'kt', zkt, ldxios = lrxios ) ! last time-step of previous run IF(lwp) THEN WRITE(numout,*) ' *** Info read in restart : ' WRITE(numout,*) ' previous time-step : ', NINT( zkt ) WRITE(numout,*) ' *** restart option' SELECT CASE ( nrstdt ) CASE ( 0 ) ; WRITE(numout,*) ' nrstdt = 0 : no control of nit000' CASE ( 1 ) ; WRITE(numout,*) ' nrstdt = 1 : no control the date at nit000 (use ndate0 read in the namelist)' CASE ( 2 ) ; WRITE(numout,*) ' nrstdt = 2 : calendar parameters read in restart' END SELECT WRITE(numout,*) ENDIF ! Control of date IF( nit000 - NINT( zkt ) /= 1 .AND. nrstdt /= 0 ) & & CALL ctl_stop( ' ===>>>> : problem with nit000 for the restart', & & ' verify the restart file or rerun with nrstdt = 0 (namelist)' ) ! define ndastp and adatrj IF ( nrstdt == 2 ) THEN ! read the parameters corresponding to nit000 - 1 (last time step of previous run) CALL iom_get( numror, 'ndastp', zndastp, ldxios = lrxios ) ndastp = NINT( zndastp ) CALL iom_get( numror, 'adatrj', adatrj , ldxios = lrxios ) CALL iom_get( numror, 'ntime' , ktime , ldxios = lrxios ) nn_time0 = NINT(ktime) ! calculate start time in hours and minutes zdayfrac = adatrj - REAL(INT(adatrj), wp) ksecs = NINT(zdayfrac * rday) ! Nearest second to catch rounding errors in adatrj ihour = ksecs / NINT( rhhmm*rmmss ) iminute = ksecs / NINT(rmmss) - ihour*NINT(rhhmm) ! Add to nn_time0 nhour = nn_time0 / 100 nminute = ( nn_time0 - nhour * 100 ) nminute = nminute + iminute IF( nminute >= NINT(rhhmm) ) THEN nminute = nminute - NINT(rhhmm) nhour = nhour+1 ENDIF nhour=nhour+ihour IF( nhour >= NINT(rjjhh) ) THEN nhour = nhour - NINT(rjjhh) adatrj = adatrj + 1. ENDIF nn_time0 = nhour * 100 + nminute adatrj = REAL(INT(adatrj), wp) ! adatrj set to integer as nn_time0 updated ELSE ! parameters corresponding to nit000 - 1 (as we start the step loop with a call to day) ndastp = ndate0 ! ndate0 read in the namelist in dom_nam nhour = nn_time0 / 100 nminute = ( nn_time0 - nhour * 100 ) isecond = ( nhour * NINT(rhhmm) + nminute ) * NINT(rmmss) IF( isecond - ndt05 .lt. 0 ) ndastp = ndastp - 1 ! Start hour is specified in the namelist (default 0) adatrj = ( REAL( nit000-1, wp ) * rn_Dt ) / rday ! note this is wrong if time step has changed during run ENDIF ELSE ! parameters corresponding to nit000 - 1 (as we start the step loop with a call to day) ndastp = ndate0 ! ndate0 read in the namelist in dom_nam nhour = nn_time0 / 100 nminute = ( nn_time0 - nhour * 100 ) isecond = ( nhour * NINT(rhhmm) + nminute ) * NINT(rmmss) IF( isecond - ndt05 .LT. 0 ) ndastp = ndastp - 1 ! Start hour is specified in the namelist (default 0) adatrj = ( REAL( nit000-1, wp ) * rn_Dt ) / rday ENDIF IF( ABS(adatrj - REAL(NINT(adatrj),wp)) < 0.1 / rday ) adatrj = REAL(NINT(adatrj),wp) ! avoid truncation error ! IF(lwp) THEN WRITE(numout,*) ' *** Info used values : ' WRITE(numout,*) ' date ndastp : ', ndastp WRITE(numout,*) ' number of elapsed days since the begining of run : ', adatrj WRITE(numout,*) ' nn_time0 : ',nn_time0 WRITE(numout,*) ENDIF ! ELSEIF( TRIM(cdrw) == 'WRITE' ) THEN ! IF( kt == nitrst ) THEN IF(lwp) WRITE(numout,*) IF(lwp) WRITE(numout,*) 'rst_write : write oce restart file kt =', kt IF(lwp) WRITE(numout,*) '~~~~~~~' ENDIF ! calendar control IF( lwxios ) CALL iom_swap( cwxios_context ) CALL iom_rstput( kt, nitrst, numrow, 'kt' , REAL( kt , wp) , ldxios = lwxios ) ! time-step CALL iom_rstput( kt, nitrst, numrow, 'ndastp' , REAL( ndastp, wp) , ldxios = lwxios ) ! date CALL iom_rstput( kt, nitrst, numrow, 'adatrj' , adatrj , ldxios = lwxios ) ! number of elapsed days since ! ! the begining of the run [s] CALL iom_rstput( kt, nitrst, numrow, 'ntime' , REAL( nn_time0, wp), ldxios = lwxios ) ! time IF( lwxios ) CALL iom_swap( cxios_context ) ENDIF ! END SUBROUTINE day_rst !!====================================================================== END MODULE daymod