source: NEMO/branches/2020/dev_12905_xios_restart/src/OCE/DOM/daymod.F90 @ 12950

Last change on this file since 12950 was 12950, checked in by andmirek, 5 months ago

Ticket #2462: new XIOS restart read/write interfaces

  • Property svn:keywords set to Id
File size: 21.1 KB
Line 
1MODULE daymod
2   !!======================================================================
3   !!                       ***  MODULE  daymod  ***
4   !! Ocean :   management of the model 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   !!                 ! 2015-11  (D. Lea) Allow non-zero initial time of day
14   !!----------------------------------------------------------------------
15
16   !!----------------------------------------------------------------------
17   !!   day        : calendar
18   !!----------------------------------------------------------------------
19   !!                    ----------- WARNING -----------
20   !!                    -------------------------------
21   !!   sbcmod assume that the time step is dividing the number of second of
22   !!   in a day, i.e. ===> MOD( rday, rn_Dt ) == 0
23   !!   except when user defined forcing is used (see sbcmod.F90)
24   !!----------------------------------------------------------------------
25   USE dom_oce        ! ocean space and time domain
26   USE phycst         ! physical constants
27   USE ioipsl  , ONLY :   ymds2ju      ! for calendar
28   USE trc_oce , ONLY :   l_offline   ! offline flag
29   !
30   USE in_out_manager ! I/O manager
31   USE prtctl         ! Print control
32   USE iom            !
33   USE timing         ! Timing
34   USE restart        ! 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    ! Needed by TAM
42
43   INTEGER, PUBLIC ::   nsecd, nsecd05, ndt, ndt05   !: (PUBLIC for TAM)
44
45   !!----------------------------------------------------------------------
46   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
47   !! $Id$
48   !! Software governed by the CeCILL license (see ./LICENSE)
49   !!----------------------------------------------------------------------
50CONTAINS
51
52   SUBROUTINE day_init
53      !!----------------------------------------------------------------------
54      !!                   ***  ROUTINE day_init  ***
55      !!
56      !! ** Purpose :   Initialization of the calendar values to their values 1 time step before nit000
57      !!                because day will be called at the beginning of step
58      !!
59      !! ** Action  : - nyear        : current year
60      !!              - nmonth       : current month of the current nyear
61      !!              - nday         : current   day of the current nmonth
62      !!              - nday_year    : current   day of the current nyear
63      !!              - nsec_year    : seconds between 00h jan 1st of the current  year and half of the current time step
64      !!              - nsec_month   : seconds between 00h 1st day of the current month and half of the current time step
65      !!              - nsec_monday  : seconds between 00h         of the   last Monday and half of the current time step
66      !!              - nsec_day     : seconds between 00h         of the current   day and half of the current time step
67      !!              - nsec1jan000  : seconds between Jan. 1st 00h of nit000 year and Jan. 1st 00h of the current year
68      !!              - nmonth_len, nyear_len, nmonth_beg through day_mth
69      !!----------------------------------------------------------------------
70      INTEGER  ::   inbday, imonday, isecrst   ! local integers
71      REAL(wp) ::   zjul             ! local scalar
72      !!----------------------------------------------------------------------
73      !
74      ! max number of seconds between each restart
75      IF( REAL( nitend - nit000 + 1 ) * rn_Dt > REAL( HUGE( nsec1jan000 ) ) ) THEN
76         CALL ctl_stop( 'The number of seconds between each restart exceeds the integer 4 max value: 2^31-1. ',   &
77            &           'You must do a restart at higher frequency (or remove this stop and recompile the code in I8)' )
78      ENDIF
79      nsecd   = NINT(       rday )
80      nsecd05 = NINT( 0.5 * rday )
81      ndt     = NINT(       rn_Dt  )
82      ndt05   = NINT( 0.5 * rn_Dt  )
83
84      IF( .NOT. l_offline )   CALL day_rst( nit000, 'READ' )
85
86      ! set the calandar from ndastp (read in restart file and namelist)
87      nyear   =   ndastp / 10000
88      nmonth  = ( ndastp - (nyear * 10000) ) / 100
89      nday    =   ndastp - (nyear * 10000) - ( nmonth * 100 )
90
91      nhour   =   nn_time0 / 100
92      nminute = ( nn_time0 - nhour * 100 )
93      isecrst = ( nhour * NINT(rhhmm) + nminute ) * NINT(rmmss)
94
95      CALL ymds2ju( nyear, nmonth, nday, REAL(isecrst,wp), fjulday ) 
96      IF( ABS(fjulday - REAL(NINT(fjulday),wp)) < 0.1 / rday )   fjulday = REAL(NINT(fjulday),wp)   ! avoid truncation error
97      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)
98
99      nsec1jan000 = 0
100      CALL day_mth
101
102      IF ( nday == 0 ) THEN     !   for ex if ndastp = ndate0 - 1
103         nmonth = nmonth - 1
104         nday = nmonth_len(nmonth)
105      ENDIF
106      IF ( nmonth == 0 ) THEN   ! go at the end of previous year
107         nmonth = 12
108         nyear = nyear - 1
109         nsec1jan000 = nsec1jan000 - nsecd * nyear_len(0)
110         IF( nleapy == 1 )   CALL day_mth
111      ENDIF
112
113      ! day since january 1st
114      nday_year = nday + SUM( nmonth_len(1:nmonth - 1) )
115
116      !compute number of days between last Monday and today
117      CALL ymds2ju( 1900, 01, 01, 0.0, zjul )     ! compute julian day value of 01.01.1900 (our reference that was a Monday)
118      inbday = FLOOR(fjulday - zjul)              ! compute nb day between  01.01.1900 and start of current day
119      imonday = MOD(inbday, 7)                    ! compute nb day between last monday and current day
120      IF (imonday .LT. 0) imonday = imonday + 7   ! Avoid negative values for dates before 01.01.1900
121
122      ! number of seconds since the beginning of current year/month/week/day at the middle of the time-step
123      IF( isecrst - ndt05 .GT. 0 ) THEN
124         ! 1 timestep before current middle of first time step is still the same day
125         nsec_year  = (nday_year-1) * nsecd + isecrst - ndt05 
126         nsec_month = (nday-1)      * nsecd + isecrst - ndt05   
127      ELSE
128         ! 1 time step before the middle of the first time step is the previous day
129         nsec_year  = nday_year     * nsecd + isecrst - ndt05 
130         nsec_month = nday          * nsecd + isecrst - ndt05   
131      ENDIF
132      nsec_monday   = imonday       * nsecd + isecrst - ndt05
133      nsec_day      =                         isecrst - ndt05 
134      IF( nsec_day    .LT. 0 ) nsec_day    = nsec_day    + nsecd
135      IF( nsec_monday .LT. 0 ) nsec_monday = nsec_monday + nsecd*7
136
137      ! control print
138      IF(lwp) WRITE(numout,'(a,i6,a,i2,a,i2,a,i8,a,i8,a,i8,a,i8)')   &
139           &                   ' =======>> 1/2 time step before the start of the run DATE Y/M/D = ',   &
140           &                   nyear, '/', nmonth, '/', nday, '  nsec_day:', nsec_day, '  nsec_monday:', nsec_monday, '  &
141           &                   nsec_month:', nsec_month , '  nsec_year:' , nsec_year
142
143      nsec000_1jan000 = nsec1jan000 + nsec_year + ndt05
144      nsecend_1jan000 = nsec000_1jan000 + ndt * ( nitend - nit000 + 1 )
145     
146      ! Up to now, calendar parameters are related to the end of previous run (nit000-1)
147      ! call day to set the calendar parameters at the begining of the current simulaton. needed by iom_init
148      CALL day( nit000 )
149      !
150   END SUBROUTINE day_init
151
152
153   SUBROUTINE day_mth
154      !!----------------------------------------------------------------------
155      !!                   ***  ROUTINE day_init  ***
156      !!
157      !! ** Purpose :   calendar values related to the months
158      !!
159      !! ** Action  : - nyear_len     : length in days of the previous/current year
160      !!              - nmonth_len    : length in days of the months of the current year
161      !!              - nmonth_half   : second since the beginning of the current year and the halft of the months
162      !!              - nmonth_end    : second since the beginning of the current year and the end of the months
163      !!----------------------------------------------------------------------
164      INTEGER  ::   jm ,jy                   ! dummy loop indice
165      INTEGER, DIMENSION(12) ::   idaymt     ! length in days of the 12 months for non-leap year
166      !!----------------------------------------------------------------------
167
168      ! length of the month of the current year (from nleapy, read in namelist)
169      IF ( nleapy < 2 ) THEN
170         ! default values
171         idaymt(1:12) = (/ 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 /)
172         nmonth_len(-11: 25) = (/ idaymt(1:12), idaymt(1:12), idaymt(1:12), idaymt(1) /)
173         nyear_len(:) = 365
174         !
175         IF ( nleapy == 1 ) THEN   ! we are using calandar with leap years
176            DO jy = -1,1
177               IF ( MOD(nyear+jy, 4) == 0 .AND. ( MOD(nyear+jy, 400) == 0 .OR. MOD(nyear+jy, 100) /= 0 ) ) THEN
178                  nmonth_len(2 + 12*jy) = 29
179                  nyear_len( 1 +    jy) = 366
180               ENDIF
181            ENDDO
182         ENDIF
183      ELSE
184         nmonth_len(:) = nleapy   ! all months with nleapy days per year
185         nyear_len(:) = 12 * nleapy
186      ENDIF
187
188      ! time since Jan 1st   0     1     2    ...    11    12    13
189      !          ---------*--|--*--|--*--| ... |--*--|--*--|--*--|--------------------------------------
190      !                 <---> <---> <--->  ...  <---> <---> <--->
191      ! month number      0     1     2    ...    11    12    13
192      nmonth_beg(1) = 0
193      DO jm = 2, 25
194         nmonth_beg(jm) = nmonth_beg(jm-1) + nsecd * nmonth_len(jm-1)
195      END DO
196      DO jm = 0,-11,-1
197         nmonth_beg(jm) = nmonth_beg(jm+1) - nsecd * nmonth_len(jm)
198      END DO
199      !
200   END SUBROUTINE
201
202
203   SUBROUTINE day( kt )
204      !!----------------------------------------------------------------------
205      !!                      ***  ROUTINE day  ***
206      !!
207      !! ** Purpose :   Compute the date with a day iteration IF necessary.
208      !!
209      !! ** Method  : - ???
210      !!
211      !! ** Action  : - nyear     : current year
212      !!              - nmonth    : current month of the year nyear
213      !!              - nday      : current day of the month nmonth
214      !!              - nday_year : current day of the year nyear
215      !!              - ndastp    : = nyear*10000 + nmonth*100 + nday
216      !!              - adatrj    : date in days since the beginning of the run
217      !!              - nsec_year : current time of the year (in second since 00h, jan 1st)
218      !!----------------------------------------------------------------------
219      INTEGER, INTENT(in) ::   kt        ! ocean time-step indices
220      !
221      CHARACTER (len=25) ::   charout
222      REAL(wp)           ::   zprec      ! fraction of day corresponding to 0.1 second
223      !!----------------------------------------------------------------------
224      !
225      IF( ln_timing )   CALL timing_start('day')
226      !
227      zprec = 0.1 / rday
228      !                                                 ! New time-step
229      nsec_year    = nsec_year    + ndt
230      nsec_month   = nsec_month   + ndt
231      nsec_monday  = nsec_monday  + ndt
232      nsec_day   = nsec_day   + ndt
233      adatrj  = adatrj  + rn_Dt / rday
234      fjulday = fjulday + rn_Dt / rday
235      IF( ABS(fjulday - REAL(NINT(fjulday),wp)) < zprec )   fjulday = REAL(NINT(fjulday),wp)   ! avoid truncation error
236      IF( ABS(adatrj  - REAL(NINT(adatrj ),wp)) < zprec )   adatrj  = REAL(NINT(adatrj ),wp)   ! avoid truncation error
237
238      IF( nsec_day > nsecd ) THEN                       ! New day
239         !
240         nday      = nday + 1
241         nday_year = nday_year + 1
242         nsec_day  = ndt05
243         !
244         IF( nday == nmonth_len(nmonth) + 1 ) THEN      ! New month
245            nday   = 1
246            nmonth = nmonth + 1
247            nsec_month = ndt05
248            IF( nmonth == 13 ) THEN                     ! New year
249               nyear     = nyear + 1
250               nmonth    = 1
251               nday_year = 1
252               nsec_year = ndt05
253               nsec1jan000 = nsec1jan000 + nsecd * nyear_len(1)
254               IF( nleapy == 1 )   CALL day_mth
255            ENDIF
256         ENDIF
257         !
258         ndastp = nyear * 10000 + nmonth * 100 + nday   ! New date
259         !
260         !compute first day of the year in julian days
261         CALL ymds2ju( nyear, 01, 01, 0.0, fjulstartyear )
262         !
263         IF(lwp) WRITE(numout,'(a,i8,a,i4.4,a,i2.2,a,i2.2,a,i3.3)') '======>> time-step =', kt,   &
264              &   '      New day, DATE Y/M/D = ', nyear, '/', nmonth, '/', nday, '      nday_year = ', nday_year
265         IF(lwp) WRITE(numout,'(a,i8,a,i7,a,i5)') '         nsec_year = ', nsec_year,   &
266              &   '   nsec_month = ', nsec_month, '   nsec_day = ', nsec_day, '   nsec_monday = ', nsec_monday
267      ENDIF
268
269      IF( nsec_monday > 7*nsecd )   nsec_monday = ndt05     ! New week
270
271      IF(sn_cfctl%l_prtctl) THEN
272         WRITE(charout,FMT="('kt =', I4,'  d/m/y =',I2,I2,I4)") kt, nday, nmonth, nyear
273         CALL prt_ctl_info(charout)
274      ENDIF
275
276      IF( .NOT. l_offline ) CALL rst_opn( kt )               ! Open the restart file if needed and control lrst_oce
277      IF( lrst_oce         ) CALL day_rst( kt, 'WRITE' )      ! write day restart information
278      !
279      IF( ln_timing )   CALL timing_stop('day')
280      !
281   END SUBROUTINE day
282
283
284   SUBROUTINE day_rst( kt, cdrw )
285      !!---------------------------------------------------------------------
286      !!                   ***  ROUTINE day_rst  ***
287      !!
288      !!  ** Purpose : Read or write calendar in restart file:
289      !!
290      !!  WRITE(READ) mode:
291      !!       kt        : number of time step since the begining of the experiment at the
292      !!                   end of the current(previous) run
293      !!       adatrj(0) : number of elapsed days since the begining of the experiment at the
294      !!                   end of the current(previous) run (REAL -> keep fractions of day)
295      !!       ndastp    : date at the end of the current(previous) run (coded as yyyymmdd integer)
296      !!
297      !!   According to namelist parameter nrstdt,
298      !!       nrstdt = 0  no control on the date (nit000 is  arbitrary).
299      !!       nrstdt = 1  we verify that nit000 is equal to the last
300      !!                   time step of previous run + 1.
301      !!       In both those options, the  exact duration of the experiment
302      !!       since the beginning (cumulated duration of all previous restart runs)
303      !!       is not stored in the restart and is assumed to be (nit000-1)*rn_Dt.
304      !!       This is valid is the time step has remained constant.
305      !!
306      !!       nrstdt = 2  the duration of the experiment in days (adatrj)
307      !!                    has been stored in the restart file.
308      !!----------------------------------------------------------------------
309      INTEGER         , INTENT(in) ::   kt         ! ocean time-step
310      CHARACTER(len=*), INTENT(in) ::   cdrw       ! "READ"/"WRITE" flag
311      !
312      REAL(wp) ::   zkt, zndastp, zdayfrac, ksecs, ktime
313      INTEGER  ::   ihour, iminute, isecond
314      !!----------------------------------------------------------------------
315
316      IF( TRIM(cdrw) == 'READ' ) THEN
317         IF( lrxios ) CALL iom_swap( TRIM(crxios_context) )
318         IF( iom_varid( numror, 'kt', ldstop = .FALSE. ) > 0 ) THEN
319            ! Get Calendar informations
320            CALL iom_get( numror, 'kt', zkt, ldxios = lrxios )   ! last time-step of previous run
321            IF(lwp) THEN
322               WRITE(numout,*) ' *** Info read in restart : '
323               WRITE(numout,*) '   previous time-step                               : ', NINT( zkt )
324               WRITE(numout,*) ' *** restart option'
325               SELECT CASE ( nrstdt )
326               CASE ( 0 )   ;   WRITE(numout,*) ' nrstdt = 0 : no control of nit000'
327               CASE ( 1 )   ;   WRITE(numout,*) ' nrstdt = 1 : no control the date at nit000 (use ndate0 read in the namelist)'
328               CASE ( 2 )   ;   WRITE(numout,*) ' nrstdt = 2 : calendar parameters read in restart'
329               END SELECT
330               WRITE(numout,*)
331            ENDIF
332            ! Control of date
333            IF( nit000 - NINT( zkt ) /= 1 .AND. nrstdt /= 0 )                                         &
334                 &   CALL ctl_stop( ' ===>>>> : problem with nit000 for the restart',                 &
335                 &                  ' verify the restart file or rerun with nrstdt = 0 (namelist)' )
336            ! define ndastp and adatrj
337            IF ( nrstdt == 2 ) THEN
338               ! read the parameters corresponding to nit000 - 1 (last time step of previous run)
339               CALL iom_get( numror, 'ndastp', zndastp, ldxios = lrxios )
340               ndastp = NINT( zndastp )
341               CALL iom_get( numror, 'adatrj', adatrj , ldxios = lrxios )
342          CALL iom_get( numror, 'ntime' , ktime  , ldxios = lrxios )
343               nn_time0 = NINT(ktime)
344               ! calculate start time in hours and minutes
345               zdayfrac = adatrj - REAL(INT(adatrj), wp)
346          ksecs = NINT(zdayfrac * rday)          ! Nearest second to catch rounding errors in adatrj         
347               ihour = ksecs / NINT( rhhmm*rmmss )
348          iminute = ksecs / NINT(rmmss) - ihour*NINT(rhhmm)
349           
350               ! Add to nn_time0
351               nhour   =   nn_time0 / 100
352               nminute = ( nn_time0 - nhour * 100 )
353          nminute = nminute + iminute
354         
355               IF( nminute >= NINT(rhhmm) ) THEN
356             nminute = nminute - NINT(rhhmm)
357        nhour = nhour+1
358          ENDIF
359          nhour=nhour+ihour
360          IF( nhour >= NINT(rjjhh) ) THEN
361        nhour = nhour - NINT(rjjhh)
362             adatrj = adatrj + 1.
363          ENDIF         
364          nn_time0 = nhour * 100 + nminute
365               adatrj = REAL(INT(adatrj), wp)                    ! adatrj set to integer as nn_time0 updated         
366            ELSE
367               ! parameters corresponding to nit000 - 1 (as we start the step loop with a call to day)
368               ndastp = ndate0        ! ndate0 read in the namelist in dom_nam
369               nhour   =   nn_time0 / 100
370               nminute = ( nn_time0 - nhour * 100 )
371               isecond = ( nhour * NINT(rhhmm) + nminute ) * NINT(rmmss)
372               IF( isecond - ndt05 .lt. 0 )   ndastp = ndastp - 1      ! Start hour is specified in the namelist (default 0)
373               adatrj = ( REAL( nit000-1, wp ) * rn_Dt ) / rday
374               ! note this is wrong if time step has changed during run
375            ENDIF
376         ELSE
377            ! parameters corresponding to nit000 - 1 (as we start the step loop with a call to day)
378            ndastp = ndate0           ! ndate0 read in the namelist in dom_nam
379            nhour   =   nn_time0 / 100
380       nminute = ( nn_time0 - nhour * 100 )
381            isecond = ( nhour * NINT(rhhmm) + nminute ) * NINT(rmmss)
382            IF( isecond - ndt05 .LT. 0 )   ndastp = ndastp - 1         ! Start hour is specified in the namelist (default 0)
383            adatrj = ( REAL( nit000-1, wp ) * rn_Dt ) / rday
384         ENDIF
385         IF( lrxios ) CALL iom_swap( TRIM(cxios_context) )
386         IF( ABS(adatrj  - REAL(NINT(adatrj),wp)) < 0.1 / rday )   adatrj = REAL(NINT(adatrj),wp)   ! avoid truncation error
387         !
388         IF(lwp) THEN
389            WRITE(numout,*) ' *** Info used values : '
390            WRITE(numout,*) '   date ndastp                                      : ', ndastp
391            WRITE(numout,*) '   number of elapsed days since the begining of run : ', adatrj
392       WRITE(numout,*) '   nn_time0                                         : ',nn_time0
393            WRITE(numout,*)
394         ENDIF
395         !
396      ELSEIF( TRIM(cdrw) == 'WRITE' ) THEN
397         !
398         IF( kt == nitrst ) THEN
399            IF(lwp) WRITE(numout,*)
400            IF(lwp) WRITE(numout,*) 'rst_write : write oce restart file  kt =', kt
401            IF(lwp) WRITE(numout,*) '~~~~~~~'
402         ENDIF
403         ! calendar control
404         IF( lwxios ) THEN
405            CALL iom_swap(      cwxios_context          )
406!           IF( kt == nitrst ) THEN
407!               CALL iom_init_closedef(cwxios_context)
408!               CALL iom_setkt( kt - nit000 + 1,      cwxios_context          )
409!               CALL iom_swap(      cwxios_context          )
410!           ENDIF
411         ENDIF
412         CALL iom_rstput( kt, nitrst, numrow, 'kt'     , REAL( kt    , wp)  , ldxios = lwxios )   ! time-step
413         CALL iom_rstput( kt, nitrst, numrow, 'ndastp' , REAL( ndastp, wp)  , ldxios = lwxios )   ! date
414         CALL iom_rstput( kt, nitrst, numrow, 'adatrj' , adatrj             , ldxios = lwxios            )   ! number of elapsed days since
415         !                                                                                                   ! the begining of the run [s]
416         CALL iom_rstput( kt, nitrst, numrow, 'ntime'  , REAL( nn_time0, wp), ldxios = lwxios ) ! time
417         IF( lwxios ) CALL iom_swap(      cxios_context          )
418      ENDIF
419      !
420   END SUBROUTINE day_rst
421
422   !!======================================================================
423END MODULE daymod
Note: See TracBrowser for help on using the repository browser.