| 1 | MODULE daymod |
|---|
| 2 | !!====================================================================== |
|---|
| 3 | !! *** MODULE daymod *** |
|---|
| 4 | !! Ocean : calendar |
|---|
| 5 | !!===================================================================== |
|---|
| 6 | !! History : OPA ! 1994-09 (M. Pontaud M. Imbard) Original code |
|---|
| 7 | !! ! 1997-03 (O. Marti) |
|---|
| 8 | !! ! 1997-05 (G. Madec) |
|---|
| 9 | !! ! 1997-08 (M. Imbard) |
|---|
| 10 | !! NEMO 1.0 ! 2003-09 (G. Madec) F90 + nyear, nmonth, nday |
|---|
| 11 | !! ! 2004-01 (A.M. Treguier) new calculation based on adatrj |
|---|
| 12 | !! ! 2006-08 (G. Madec) surface module major update |
|---|
| 13 | !!---------------------------------------------------------------------- |
|---|
| 14 | |
|---|
| 15 | !!---------------------------------------------------------------------- |
|---|
| 16 | !! day : calendar |
|---|
| 17 | !! |
|---|
| 18 | !! ------------------------------- |
|---|
| 19 | !! ----------- WARNING ----------- |
|---|
| 20 | !! |
|---|
| 21 | !! we suppose that the time step is deviding the number of second of in a day |
|---|
| 22 | !! ---> MOD( rday, rdttra(1) ) == 0 |
|---|
| 23 | !! |
|---|
| 24 | !! ----------- WARNING ----------- |
|---|
| 25 | !! ------------------------------- |
|---|
| 26 | !! |
|---|
| 27 | !!---------------------------------------------------------------------- |
|---|
| 28 | USE dom_oce ! ocean space and time domain |
|---|
| 29 | USE phycst ! physical constants |
|---|
| 30 | USE in_out_manager ! I/O manager |
|---|
| 31 | USE iom ! |
|---|
| 32 | USE ioipsl, ONLY : ymds2ju ! for calendar |
|---|
| 33 | USE prtctl ! Print control |
|---|
| 34 | USE restart ! |
|---|
| 35 | |
|---|
| 36 | IMPLICIT NONE |
|---|
| 37 | PRIVATE |
|---|
| 38 | |
|---|
| 39 | PUBLIC day ! called by step.F90 |
|---|
| 40 | PUBLIC day_init ! called by istate.F90 |
|---|
| 41 | PUBLIC day_mth ! called by daymod_tam.F90 |
|---|
| 42 | |
|---|
| 43 | INTEGER, PUBLIC :: nsecd, ndt, ndt05 |
|---|
| 44 | INTEGER :: nsecd05 |
|---|
| 45 | |
|---|
| 46 | !!---------------------------------------------------------------------- |
|---|
| 47 | !! NEMO/OPA 3.2 , LOCEAN-IPSL (2009) |
|---|
| 48 | !! $Id$ |
|---|
| 49 | !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt) |
|---|
| 50 | !!---------------------------------------------------------------------- |
|---|
| 51 | |
|---|
| 52 | CONTAINS |
|---|
| 53 | |
|---|
| 54 | SUBROUTINE day_init |
|---|
| 55 | !!---------------------------------------------------------------------- |
|---|
| 56 | !! *** ROUTINE day_init *** |
|---|
| 57 | !! |
|---|
| 58 | !! ** Purpose : Initialization of the calendar values to their values 1 time step before nit000 |
|---|
| 59 | !! because day will be called at the beginning of step |
|---|
| 60 | !! |
|---|
| 61 | !! ** Action : - nyear : current year |
|---|
| 62 | !! - nmonth : current month of the year nyear |
|---|
| 63 | !! - nday : current day of the month nmonth |
|---|
| 64 | !! - nday_year : current day of the year nyear |
|---|
| 65 | !! - nsec_year : current time step counted in second since 00h jan 1st of the current year |
|---|
| 66 | !! - nsec_month : current time step counted in second since 00h 1st day of the current month |
|---|
| 67 | !! - nsec_day : current time step counted in second since 00h of the current day |
|---|
| 68 | !! - nsec1jan000 : second since Jan. 1st 00h of nit000 year and Jan. 1st 00h of the current year |
|---|
| 69 | !! - nmonth_len, nyear_len, nmonth_half, nmonth_end through day_mth |
|---|
| 70 | !!---------------------------------------------------------------------- |
|---|
| 71 | |
|---|
| 72 | ! all calendar staff is based on the fact that MOD( rday, rdttra(1) ) == 0 |
|---|
| 73 | IF( MOD( rday , rdttra(1) ) /= 0. ) CALL ctl_stop( 'the time step must devide the number of second of in a day' ) |
|---|
| 74 | IF( MOD( rday , 2. ) /= 0. ) CALL ctl_stop( 'the number of second of in a day must be an even number' ) |
|---|
| 75 | IF( MOD( rdttra(1), 2. ) /= 0. ) CALL ctl_stop( 'the time step (in second) must be an even number' ) |
|---|
| 76 | nsecd = NINT(rday ) |
|---|
| 77 | nsecd05 = NINT(0.5 * rday ) |
|---|
| 78 | ndt = NINT( rdttra(1)) |
|---|
| 79 | ndt05 = NINT(0.5 * rdttra(1)) |
|---|
| 80 | |
|---|
| 81 | CALL day_rst( nit000, 'READ' ) |
|---|
| 82 | |
|---|
| 83 | ! set the calandar from ndastp (read in restart file and namelist) |
|---|
| 84 | |
|---|
| 85 | nyear = ndastp / 10000 |
|---|
| 86 | nmonth = ( ndastp - (nyear * 10000) ) / 100 |
|---|
| 87 | nday = ndastp - (nyear * 10000) - ( nmonth * 100 ) |
|---|
| 88 | |
|---|
| 89 | CALL ymds2ju( nyear, nmonth, nday, 0.0, fjulday ) ! we assume that we start run at 00:00 |
|---|
| 90 | IF( ABS(fjulday - REAL(NINT(fjulday),wp)) < 0.1 / rday ) fjulday = REAL(NINT(fjulday),wp) ! avoid truncation error |
|---|
| 91 | fjulday = fjulday + 1. ! move back to the day at nit000 (and not at nit000 - 1) |
|---|
| 92 | |
|---|
| 93 | nsec1jan000 = 0 |
|---|
| 94 | CALL day_mth |
|---|
| 95 | |
|---|
| 96 | IF ( nday == 0 ) THEN ! for ex if ndastp = ndate0 - 1 |
|---|
| 97 | nmonth = nmonth - 1 |
|---|
| 98 | nday = nmonth_len(nmonth) |
|---|
| 99 | ENDIF |
|---|
| 100 | IF ( nmonth == 0 ) THEN ! go at the end of previous year |
|---|
| 101 | nmonth = 12 |
|---|
| 102 | nyear = nyear - 1 |
|---|
| 103 | nsec1jan000 = nsec1jan000 - nsecd * nyear_len(0) |
|---|
| 104 | IF( nleapy == 1 ) CALL day_mth |
|---|
| 105 | ENDIF |
|---|
| 106 | |
|---|
| 107 | ! day since january 1st |
|---|
| 108 | nday_year = nday + SUM( nmonth_len(1:nmonth - 1) ) |
|---|
| 109 | |
|---|
| 110 | ! number of seconds since the beginning of current year/month at the middle of the time-step |
|---|
| 111 | nsec_year = nday_year * nsecd - ndt05 ! 1 time step before the middle of the first time step |
|---|
| 112 | nsec_month = nday * nsecd - ndt05 ! because day will be called at the beginning of step |
|---|
| 113 | nsec_day = nsecd - ndt05 |
|---|
| 114 | |
|---|
| 115 | ! control print |
|---|
| 116 | IF(lwp) WRITE(numout,'(a,i6,a,i2,a,i2,a,i6)')' ==============>> 1/2 time step before the start of the run DATE Y/M/D = ', & |
|---|
| 117 | & nyear, '/', nmonth, '/', nday, ' nsec_day:', nsec_day |
|---|
| 118 | |
|---|
| 119 | ! Up to now, calendar parameters are related to the end of previous run (nit000-1) |
|---|
| 120 | ! call day to set the calendar parameters at the begining of the current simulaton. needed by iom_init |
|---|
| 121 | CALL day( nit000 ) |
|---|
| 122 | |
|---|
| 123 | |
|---|
| 124 | END SUBROUTINE day_init |
|---|
| 125 | |
|---|
| 126 | |
|---|
| 127 | SUBROUTINE day_mth |
|---|
| 128 | !!---------------------------------------------------------------------- |
|---|
| 129 | !! *** ROUTINE day_init *** |
|---|
| 130 | !! |
|---|
| 131 | !! ** Purpose : calendar values related to the months |
|---|
| 132 | !! |
|---|
| 133 | !! ** Action : - nmonth_len : length in days of the months of the current year |
|---|
| 134 | !! - nyear_len : length in days of the previous/current year |
|---|
| 135 | !! - nmonth_half : second since the beginning of the year and the halft of the months |
|---|
| 136 | !! - nmonth_end : second since the beginning of the year and the end of the months |
|---|
| 137 | !!---------------------------------------------------------------------- |
|---|
| 138 | INTEGER :: jm ! dummy loop indice |
|---|
| 139 | !!---------------------------------------------------------------------- |
|---|
| 140 | |
|---|
| 141 | ! length of the month of the current year (from nleapy, read in namelist) |
|---|
| 142 | IF ( nleapy < 2 ) THEN |
|---|
| 143 | nmonth_len(:) = (/ 31, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31, 31 /) |
|---|
| 144 | nyear_len(:) = 365 |
|---|
| 145 | IF ( nleapy == 1 ) THEN ! we are using calandar with leap years |
|---|
| 146 | IF ( MOD(nyear-1, 4) == 0 .AND. ( MOD(nyear-1, 400) == 0 .OR. MOD(nyear-1, 100) /= 0 ) ) THEN |
|---|
| 147 | nyear_len(0) = 366 |
|---|
| 148 | ENDIF |
|---|
| 149 | IF ( MOD(nyear, 4) == 0 .AND. ( MOD(nyear, 400) == 0 .OR. MOD(nyear, 100) /= 0 ) ) THEN |
|---|
| 150 | nmonth_len(2) = 29 |
|---|
| 151 | nyear_len(1) = 366 |
|---|
| 152 | ENDIF |
|---|
| 153 | ENDIF |
|---|
| 154 | ELSE |
|---|
| 155 | nmonth_len(:) = nleapy ! all months with nleapy days per year |
|---|
| 156 | nyear_len(:) = 12 * nleapy |
|---|
| 157 | ENDIF |
|---|
| 158 | |
|---|
| 159 | ! half month in second since the begining of the year: |
|---|
| 160 | ! time since Jan 1st 0 1 2 ... 11 12 13 |
|---|
| 161 | ! ---------*--|--*--|--*--| ... |--*--|--*--|--*--|-------------------------------------- |
|---|
| 162 | ! <---> <---> <---> ... <---> <---> <---> |
|---|
| 163 | ! month number 0 1 2 ... 11 12 13 |
|---|
| 164 | ! |
|---|
| 165 | ! nmonth_half(jm) = rday * REAL( 0.5 * nmonth_len(jm) + SUM(nmonth_len(1:jm-1)) ) |
|---|
| 166 | nmonth_half(0) = - nsecd05 * nmonth_len(0) |
|---|
| 167 | DO jm = 1, 13 |
|---|
| 168 | nmonth_half(jm) = nmonth_half(jm-1) + nsecd05 * ( nmonth_len(jm-1) + nmonth_len(jm) ) |
|---|
| 169 | END DO |
|---|
| 170 | |
|---|
| 171 | nmonth_end(0) = 0 |
|---|
| 172 | DO jm = 1, 13 |
|---|
| 173 | nmonth_end(jm) = nmonth_end(jm-1) + nsecd * nmonth_len(jm) |
|---|
| 174 | END DO |
|---|
| 175 | ! |
|---|
| 176 | END SUBROUTINE |
|---|
| 177 | |
|---|
| 178 | |
|---|
| 179 | SUBROUTINE day( kt ) |
|---|
| 180 | !!---------------------------------------------------------------------- |
|---|
| 181 | !! *** ROUTINE day *** |
|---|
| 182 | !! |
|---|
| 183 | !! ** Purpose : Compute the date with a day iteration IF necessary. |
|---|
| 184 | !! |
|---|
| 185 | !! ** Method : - ??? |
|---|
| 186 | !! |
|---|
| 187 | !! ** Action : - nyear : current year |
|---|
| 188 | !! - nmonth : current month of the year nyear |
|---|
| 189 | !! - nday : current day of the month nmonth |
|---|
| 190 | !! - nday_year : current day of the year nyear |
|---|
| 191 | !! - ndastp : = nyear*10000 + nmonth*100 + nday |
|---|
| 192 | !! - adatrj : date in days since the beginning of the run |
|---|
| 193 | !! - nsec_year : current time of the year (in second since 00h, jan 1st) |
|---|
| 194 | !!---------------------------------------------------------------------- |
|---|
| 195 | INTEGER, INTENT(in) :: kt ! ocean time-step indices |
|---|
| 196 | ! |
|---|
| 197 | CHARACTER (len=25) :: charout |
|---|
| 198 | REAL(wp) :: zprec ! fraction of day corresponding to 0.1 second |
|---|
| 199 | !!---------------------------------------------------------------------- |
|---|
| 200 | zprec = 0.1 / rday |
|---|
| 201 | ! ! New time-step |
|---|
| 202 | nsec_year = nsec_year + ndt |
|---|
| 203 | nsec_month = nsec_month + ndt |
|---|
| 204 | nsec_day = nsec_day + ndt |
|---|
| 205 | adatrj = adatrj + rdttra(1) / rday |
|---|
| 206 | fjulday = fjulday + rdttra(1) / rday |
|---|
| 207 | IF( ABS(fjulday - REAL(NINT(fjulday),wp)) < zprec ) fjulday = REAL(NINT(fjulday),wp) ! avoid truncation error |
|---|
| 208 | IF( ABS(adatrj - REAL(NINT(adatrj ),wp)) < zprec ) adatrj = REAL(NINT(adatrj ),wp) ! avoid truncation error |
|---|
| 209 | |
|---|
| 210 | IF( nsec_day > nsecd ) THEN ! NEW day |
|---|
| 211 | ! |
|---|
| 212 | nday = nday + 1 |
|---|
| 213 | nday_year = nday_year + 1 |
|---|
| 214 | nsec_day = ndt05 |
|---|
| 215 | ! |
|---|
| 216 | IF( nday == nmonth_len(nmonth) + 1 ) THEN ! NEW month |
|---|
| 217 | nday = 1 |
|---|
| 218 | nmonth = nmonth + 1 |
|---|
| 219 | nsec_month = ndt05 |
|---|
| 220 | IF( nmonth == 13 ) THEN ! NEW year |
|---|
| 221 | nyear = nyear + 1 |
|---|
| 222 | nmonth = 1 |
|---|
| 223 | nday_year = 1 |
|---|
| 224 | nsec_year = ndt05 |
|---|
| 225 | nsec1jan000 = nsec1jan000 + nsecd * nyear_len(1) |
|---|
| 226 | IF( nleapy == 1 ) CALL day_mth |
|---|
| 227 | ENDIF |
|---|
| 228 | ENDIF |
|---|
| 229 | ! |
|---|
| 230 | ndastp = nyear * 10000 + nmonth * 100 + nday ! NEW date |
|---|
| 231 | ! |
|---|
| 232 | IF(lwp) WRITE(numout,'(a,i8,a,i4.4,a,i2.2,a,i2.2,a,i3.3)') '======>> time-step =', kt, & |
|---|
| 233 | & ' New day, DATE Y/M/D = ', nyear, '/', nmonth, '/', nday, ' nday_year = ', nday_year |
|---|
| 234 | IF(lwp) WRITE(numout,'(a,i8,a,i7,a,i5)') ' nsec_year = ', nsec_year, & |
|---|
| 235 | & ' nsec_month = ', nsec_month, ' nsec_day = ', nsec_day |
|---|
| 236 | ENDIF |
|---|
| 237 | |
|---|
| 238 | IF(ln_ctl) THEN |
|---|
| 239 | WRITE(charout,FMT="('kt =', I4,' d/m/y =',I2,I2,I4)") kt, nday, nmonth, nyear |
|---|
| 240 | CALL prt_ctl_info(charout) |
|---|
| 241 | ENDIF |
|---|
| 242 | |
|---|
| 243 | CALL rst_opn( kt ) ! Open the restart file if needed and control lrst_oce |
|---|
| 244 | IF( lrst_oce ) CALL day_rst( kt, 'WRITE' ) ! write day restart information |
|---|
| 245 | ! |
|---|
| 246 | END SUBROUTINE day |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | SUBROUTINE day_rst( kt, cdrw ) |
|---|
| 250 | !!--------------------------------------------------------------------- |
|---|
| 251 | !! *** ROUTINE ts_rst *** |
|---|
| 252 | !! |
|---|
| 253 | !! ** Purpose : Read or write calendar in restart file: |
|---|
| 254 | !! |
|---|
| 255 | !! WRITE(READ) mode: |
|---|
| 256 | !! kt : number of time step since the begining of the experiment at the |
|---|
| 257 | !! end of the current(previous) run |
|---|
| 258 | !! adatrj(0) : number of elapsed days since the begining of the experiment at the |
|---|
| 259 | !! end of the current(previous) run (REAL -> keep fractions of day) |
|---|
| 260 | !! ndastp : date at the end of the current(previous) run (coded as yyyymmdd integer) |
|---|
| 261 | !! |
|---|
| 262 | !! According to namelist parameter nrstdt, |
|---|
| 263 | !! nrstdt = 0 no control on the date (nit000 is arbitrary). |
|---|
| 264 | !! nrstdt = 1 we verify that nit000 is equal to the last |
|---|
| 265 | !! time step of previous run + 1. |
|---|
| 266 | !! In both those options, the exact duration of the experiment |
|---|
| 267 | !! since the beginning (cumulated duration of all previous restart runs) |
|---|
| 268 | !! is not stored in the restart and is assumed to be (nit000-1)*rdt. |
|---|
| 269 | !! This is valid is the time step has remained constant. |
|---|
| 270 | !! |
|---|
| 271 | !! nrstdt = 2 the duration of the experiment in days (adatrj) |
|---|
| 272 | !! has been stored in the restart file. |
|---|
| 273 | !!---------------------------------------------------------------------- |
|---|
| 274 | INTEGER , INTENT(in) :: kt ! ocean time-step |
|---|
| 275 | CHARACTER(len=*), INTENT(in) :: cdrw ! "READ"/"WRITE" flag |
|---|
| 276 | ! |
|---|
| 277 | REAL(wp) :: zkt, zndastp |
|---|
| 278 | !!---------------------------------------------------------------------- |
|---|
| 279 | |
|---|
| 280 | IF( TRIM(cdrw) == 'READ' ) THEN |
|---|
| 281 | |
|---|
| 282 | IF( iom_varid( numror, 'kt', ldstop = .FALSE. ) > 0 ) THEN |
|---|
| 283 | ! Get Calendar informations |
|---|
| 284 | CALL iom_get( numror, 'kt', zkt ) ! last time-step of previous run |
|---|
| 285 | IF(lwp) THEN |
|---|
| 286 | WRITE(numout,*) ' *** Info read in restart : ' |
|---|
| 287 | WRITE(numout,*) ' previous time-step : ', NINT( zkt ) |
|---|
| 288 | WRITE(numout,*) ' *** restart option' |
|---|
| 289 | SELECT CASE ( nrstdt ) |
|---|
| 290 | CASE ( 0 ) ; WRITE(numout,*) ' nrstdt = 0 : no control of nit000' |
|---|
| 291 | CASE ( 1 ) ; WRITE(numout,*) ' nrstdt = 1 : no control the date at nit000 (use ndate0 read in the namelist)' |
|---|
| 292 | CASE ( 2 ) ; WRITE(numout,*) ' nrstdt = 2 : calendar parameters read in restart' |
|---|
| 293 | END SELECT |
|---|
| 294 | WRITE(numout,*) |
|---|
| 295 | ENDIF |
|---|
| 296 | ! Control of date |
|---|
| 297 | IF( nit000 - NINT( zkt ) /= 1 .AND. nrstdt /= 0 ) & |
|---|
| 298 | & CALL ctl_stop( ' ===>>>> : problem with nit000 for the restart', & |
|---|
| 299 | & ' verify the restart file or rerun with nrstdt = 0 (namelist)' ) |
|---|
| 300 | ! define ndastp and adatrj |
|---|
| 301 | IF ( nrstdt == 2 ) THEN |
|---|
| 302 | ! read the parameters correspondting to nit000 - 1 (last time step of previous run) |
|---|
| 303 | CALL iom_get( numror, 'ndastp', zndastp ) |
|---|
| 304 | ndastp = NINT( zndastp ) |
|---|
| 305 | CALL iom_get( numror, 'adatrj', adatrj ) |
|---|
| 306 | ELSE |
|---|
| 307 | ! parameters correspondting to nit000 - 1 (as we start the step loop with a call to day) |
|---|
| 308 | ndastp = ndate0 - 1 ! ndate0 read in the namelist in dom_nam, we assume that we start run at 00:00 |
|---|
| 309 | adatrj = ( REAL( nit000-1, wp ) * rdttra(1) ) / rday |
|---|
| 310 | ! note this is wrong if time step has changed during run |
|---|
| 311 | ENDIF |
|---|
| 312 | ELSE |
|---|
| 313 | ! parameters correspondting to nit000 - 1 (as we start the step loop with a call to day) |
|---|
| 314 | ndastp = ndate0 - 1 ! ndate0 read in the namelist in dom_nam, we assume that we start run at 00:00 |
|---|
| 315 | adatrj = ( REAL( nit000-1, wp ) * rdttra(1) ) / rday |
|---|
| 316 | ENDIF |
|---|
| 317 | IF( ABS(adatrj - REAL(NINT(adatrj),wp)) < 0.1 / rday ) adatrj = REAL(NINT(adatrj),wp) ! avoid truncation error |
|---|
| 318 | ! |
|---|
| 319 | IF(lwp) THEN |
|---|
| 320 | WRITE(numout,*) ' *** Info used values : ' |
|---|
| 321 | WRITE(numout,*) ' date ndastp : ', ndastp |
|---|
| 322 | WRITE(numout,*) ' number of elapsed days since the begining of run : ', adatrj |
|---|
| 323 | WRITE(numout,*) |
|---|
| 324 | ENDIF |
|---|
| 325 | ! |
|---|
| 326 | ELSEIF( TRIM(cdrw) == 'WRITE' ) THEN |
|---|
| 327 | ! |
|---|
| 328 | IF( kt == nitrst ) THEN |
|---|
| 329 | IF(lwp) WRITE(numout,*) |
|---|
| 330 | IF(lwp) WRITE(numout,*) 'rst_write : write oce restart file kt =', kt |
|---|
| 331 | IF(lwp) WRITE(numout,*) '~~~~~~~' |
|---|
| 332 | ENDIF |
|---|
| 333 | ! calendar control |
|---|
| 334 | CALL iom_rstput( kt, nitrst, numrow, 'kt' , REAL( kt , wp) ) ! time-step |
|---|
| 335 | CALL iom_rstput( kt, nitrst, numrow, 'ndastp' , REAL( ndastp, wp) ) ! date |
|---|
| 336 | CALL iom_rstput( kt, nitrst, numrow, 'adatrj' , adatrj ) ! number of elapsed days since |
|---|
| 337 | ! ! the begining of the run [s] |
|---|
| 338 | ENDIF |
|---|
| 339 | ! |
|---|
| 340 | END SUBROUTINE day_rst |
|---|
| 341 | |
|---|
| 342 | !!====================================================================== |
|---|
| 343 | END MODULE daymod |
|---|
