New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
daymod.F90 in branches/2014/dev_r4650_UKMO7_STARTHOUR/NEMOGCM/NEMO/OPA_SRC/DOM – NEMO

source: branches/2014/dev_r4650_UKMO7_STARTHOUR/NEMOGCM/NEMO/OPA_SRC/DOM/daymod.F90 @ 5164

Last change on this file since 5164 was 5164, checked in by timgraham, 9 years ago

Fixed initial calculation of nsec_day, nsec_month,nsec_week,nsec_year

  • Property svn:keywords set to Id
File size: 19.0 KB
Line 
1MODULE 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 trc_oce, ONLY : lk_offline ! offline flag
35   USE timing          ! Timing
36   USE restart         ! restart
37
38   IMPLICIT NONE
39   PRIVATE
40
41   PUBLIC   day        ! called by step.F90
42   PUBLIC   day_init   ! called by istate.F90
43   PUBLIC   day_mth    ! Needed by TAM
44
45   INTEGER, PUBLIC ::   nsecd, nsecd05, ndt, ndt05 ! (PUBLIC for TAM)
46
47   !!----------------------------------------------------------------------
48   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
49   !! $Id$
50   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
51   !!----------------------------------------------------------------------
52CONTAINS
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      INTEGER  ::   inbday, idweek
72      REAL(wp) ::   zjul
73      !!----------------------------------------------------------------------
74      !
75      ! all calendar staff is based on the fact that MOD( rday, rdttra(1) ) == 0
76      IF( MOD( rday     , rdttra(1) ) /= 0. )   CALL ctl_stop( 'the time step must devide the number of second of in a day' )
77      IF( MOD( rday     , 2.        ) /= 0. )   CALL ctl_stop( 'the number of second of in a day must be an even number'    )
78      IF( MOD( rdttra(1), 2.        ) /= 0. )   CALL ctl_stop( 'the time step (in second) must be an even number'           )
79      nsecd   = NINT(rday           )
80      nsecd05 = NINT(0.5 * rday     )
81      ndt     = NINT(      rdttra(1))
82      ndt05   = NINT(0.5 * rdttra(1))
83
84      IF( .NOT. lk_offline ) CALL day_rst( nit000, 'READ' )
85
86      ! set the calandar from ndastp (read in restart file and namelist)
87
88      nyear   =   ndastp / 10000
89      nmonth  = ( ndastp - (nyear * 10000) ) / 100
90      nday    =   ndastp - (nyear * 10000) - ( nmonth * 100 )
91
92      CALL ymds2ju( nyear, nmonth, nday, nn_time0*3600._wp, fjulday ) 
93      IF( ABS(fjulday - REAL(NINT(fjulday),wp)) < 0.1 / rday )   fjulday = REAL(NINT(fjulday),wp)   ! avoid truncation error
94      IF( nn_time0*3600 - ndt05 .lt. 0 ) fjulday = fjulday + 1.                    ! move back to the day at nit000 (and not at nit000 - 1)
95
96      nsec1jan000 = 0
97      CALL day_mth
98
99      IF ( nday == 0 ) THEN     !   for ex if ndastp = ndate0 - 1
100         nmonth = nmonth - 1
101         nday = nmonth_len(nmonth)
102      ENDIF
103      IF ( nmonth == 0 ) THEN   ! go at the end of previous year
104         nmonth = 12
105         nyear = nyear - 1
106         nsec1jan000 = nsec1jan000 - nsecd * nyear_len(0)
107         IF( nleapy == 1 )   CALL day_mth
108      ENDIF
109
110      ! day since january 1st
111      nday_year = nday + SUM( nmonth_len(1:nmonth - 1) )
112
113      !compute number of days between last monday and today
114      CALL ymds2ju( 1900, 01, 01, 0.0, zjul )  ! compute julian day value of 01.01.1900 (our reference that was a Monday)
115      inbday = FLOOR(fjulday - zjul)            ! compute nb day between  01.01.1900 and start of current day
116      idweek = MOD(inbday, 7)                  ! compute nb day between last monday and current day
117      IF (idweek .lt. 0) idweek=idweek+7       ! Avoid negative values for dates before 01.01.1900
118
119      ! number of seconds since the beginning of current year/month/week/day at the middle of the time-step
120      IF (nn_time0*3600-ndt05 .gt. 0) THEN
121         ! 1 timestep before current middle of first time step is still the same day
122         nsec_year  = (nday_year-1) * nsecd + nn_time0*3600._wp - ndt05 
123         nsec_month = (nday-1)      * nsecd + nn_time0*3600._wp - ndt05   
124      ELSE
125         ! 1 time step before the middle of the first time step is the previous day
126         nsec_year  = nday_year * nsecd + nn_time0*3600._wp - ndt05 
127         nsec_month = nday      * nsecd + nn_time0*3600._wp - ndt05   
128      ENDIF
129      nsec_week  = idweek    * nsecd + nn_time0*3600._wp - ndt05
130      nsec_day   =             nn_time0*3600._wp - ndt05 
131      IF( nsec_day .lt. 0 ) nsec_day = nsec_day + nsecd
132      IF( nsec_week .lt. 0 ) nsec_week = nsec_week + nsecd*7
133
134      ! control print
135      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 = ',   &
136           &                   nyear, '/', nmonth, '/', nday, '  nsec_day:', nsec_day, '  nsec_week:', nsec_week, '  &
137           &                   nsec_month:', nsec_month , '  nsec_year:' , nsec_year
138
139      ! Up to now, calendar parameters are related to the end of previous run (nit000-1)
140      ! call day to set the calendar parameters at the begining of the current simulaton. needed by iom_init
141      CALL day( nit000 )
142      !
143   END SUBROUTINE day_init
144
145
146   SUBROUTINE day_mth
147      !!----------------------------------------------------------------------
148      !!                   ***  ROUTINE day_init  ***
149      !!
150      !! ** Purpose :   calendar values related to the months
151      !!
152      !! ** Action  : - nmonth_len    : length in days of the months of the current year
153      !!              - nyear_len     : length in days of the previous/current year
154      !!              - nmonth_half   : second since the beginning of the year and the halft of the months
155      !!              - nmonth_end    : second since the beginning of the year and the end of the months
156      !!----------------------------------------------------------------------
157      INTEGER  ::   jm               ! dummy loop indice
158      !!----------------------------------------------------------------------
159
160      ! length of the month of the current year (from nleapy, read in namelist)
161      IF ( nleapy < 2 ) THEN
162         nmonth_len(:) = (/ 31, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31, 31 /)
163         nyear_len(:) = 365
164         IF ( nleapy == 1 ) THEN   ! we are using calandar with leap years
165            IF ( MOD(nyear-1, 4) == 0 .AND. ( MOD(nyear-1, 400) == 0 .OR. MOD(nyear-1, 100) /= 0 ) ) THEN
166               nyear_len(0)  = 366
167            ENDIF
168            IF ( MOD(nyear  , 4) == 0 .AND. ( MOD(nyear  , 400) == 0 .OR. MOD(nyear  , 100) /= 0 ) ) THEN
169               nmonth_len(2) = 29
170               nyear_len(1)  = 366
171            ENDIF
172            IF ( MOD(nyear+1, 4) == 0 .AND. ( MOD(nyear+1, 400) == 0 .OR. MOD(nyear+1, 100) /= 0 ) ) THEN
173               nyear_len(2)  = 366
174            ENDIF
175         ENDIF
176      ELSE
177         nmonth_len(:) = nleapy   ! all months with nleapy days per year
178         nyear_len(:) = 12 * nleapy
179      ENDIF
180
181      ! half month in second since the begining of the year:
182      ! time since Jan 1st   0     1     2    ...    11    12    13
183      !          ---------*--|--*--|--*--| ... |--*--|--*--|--*--|--------------------------------------
184      !                 <---> <---> <--->  ...  <---> <---> <--->
185      ! month number      0     1     2    ...    11    12    13
186      !
187      ! nmonth_half(jm) = rday * REAL( 0.5 * nmonth_len(jm) + SUM(nmonth_len(1:jm-1)) )
188      nmonth_half(0) = - nsecd05 * nmonth_len(0)
189      DO jm = 1, 13
190         nmonth_half(jm) = nmonth_half(jm-1) + nsecd05 * ( nmonth_len(jm-1) + nmonth_len(jm) )
191      END DO
192
193      nmonth_end(0) = 0
194      DO jm = 1, 13
195         nmonth_end(jm) = nmonth_end(jm-1) + nsecd * nmonth_len(jm)
196      END DO
197      !
198   END SUBROUTINE
199
200
201   SUBROUTINE day( kt )
202      !!----------------------------------------------------------------------
203      !!                      ***  ROUTINE day  ***
204      !!
205      !! ** Purpose :   Compute the date with a day iteration IF necessary.
206      !!
207      !! ** Method  : - ???
208      !!
209      !! ** Action  : - nyear     : current year
210      !!              - nmonth    : current month of the year nyear
211      !!              - nday      : current day of the month nmonth
212      !!              - nday_year : current day of the year nyear
213      !!              - ndastp    : = nyear*10000 + nmonth*100 + nday
214      !!              - adatrj    : date in days since the beginning of the run
215      !!              - nsec_year : current time of the year (in second since 00h, jan 1st)
216      !!----------------------------------------------------------------------
217      INTEGER, INTENT(in) ::   kt        ! ocean time-step indices
218      !
219      CHARACTER (len=25) ::   charout
220      REAL(wp)           ::   zprec      ! fraction of day corresponding to 0.1 second
221      !!----------------------------------------------------------------------
222      !
223      IF( nn_timing == 1 )  CALL timing_start('day')
224      !
225      zprec = 0.1 / rday
226      !                                                 ! New time-step
227      nsec_year  = nsec_year  + ndt
228      nsec_month = nsec_month + ndt
229      nsec_week  = nsec_week  + ndt
230      nsec_day   = nsec_day   + ndt
231      adatrj  = adatrj  + rdttra(1) / rday
232      fjulday = fjulday + rdttra(1) / rday
233      IF( ABS(fjulday - REAL(NINT(fjulday),wp)) < zprec )   fjulday = REAL(NINT(fjulday),wp)   ! avoid truncation error
234      IF( ABS(adatrj  - REAL(NINT(adatrj ),wp)) < zprec )   adatrj  = REAL(NINT(adatrj ),wp)   ! avoid truncation error
235
236      IF( nsec_day > nsecd ) THEN                       ! New day
237         !
238         nday      = nday + 1
239         nday_year = nday_year + 1
240         nsec_day  = ndt05
241         !
242         IF( nday == nmonth_len(nmonth) + 1 ) THEN      ! New month
243            nday   = 1
244            nmonth = nmonth + 1
245            nsec_month = ndt05
246            IF( nmonth == 13 ) THEN                     ! New year
247               nyear     = nyear + 1
248               nmonth    = 1
249               nday_year = 1
250               nsec_year = ndt05
251               IF( nsec1jan000 >= 2 * (2**30 - nsecd * nyear_len(1) / 2 ) ) THEN   ! test integer 4 max value
252                  CALL ctl_stop( 'The number of seconds between Jan. 1st 00h of nit000 year and Jan. 1st 00h ',   &
253                     &           'of the current year is exceeding the INTEGER 4 max VALUE: 2^31-1 -> 68.09 years in seconds', &
254                     & 'You must do a restart at higher frequency (or remove this STOP and recompile everything in I8)' )
255               ENDIF
256               nsec1jan000 = nsec1jan000 + nsecd * nyear_len(1)
257               IF( nleapy == 1 )   CALL day_mth
258            ENDIF
259         ENDIF
260         !
261         ndastp = nyear * 10000 + nmonth * 100 + nday   ! New date
262         !
263         !compute first day of the year in julian days
264         CALL ymds2ju( nyear, 01, 01, 0.0, fjulstartyear )
265         !
266         IF(lwp) WRITE(numout,'(a,i8,a,i4.4,a,i2.2,a,i2.2,a,i3.3)') '======>> time-step =', kt,   &
267              &   '      New day, DATE Y/M/D = ', nyear, '/', nmonth, '/', nday, '      nday_year = ', nday_year
268         IF(lwp) WRITE(numout,'(a,i8,a,i7,a,i5)') '         nsec_year = ', nsec_year,   &
269              &   '   nsec_month = ', nsec_month, '   nsec_day = ', nsec_day, '   nsec_week = ', nsec_week
270      ENDIF
271
272      IF( nsec_week > 7*nsecd )   nsec_week = ndt05     ! New week
273
274      IF(ln_ctl) THEN
275         WRITE(charout,FMT="('kt =', I4,'  d/m/y =',I2,I2,I4)") kt, nday, nmonth, nyear
276         CALL prt_ctl_info(charout)
277      ENDIF
278
279      IF( .NOT. lk_offline ) CALL rst_opn( kt )               ! Open the restart file if needed and control lrst_oce
280      IF( lrst_oce         ) CALL day_rst( kt, 'WRITE' )      ! write day restart information
281      !
282      IF( nn_timing == 1 )  CALL timing_stop('day')
283      !
284   END SUBROUTINE day
285
286
287   SUBROUTINE day_rst( kt, cdrw )
288      !!---------------------------------------------------------------------
289      !!                   ***  ROUTINE ts_rst  ***
290      !!
291      !!  ** Purpose : Read or write calendar in restart file:
292      !!
293      !!  WRITE(READ) mode:
294      !!       kt        : number of time step since the begining of the experiment at the
295      !!                   end of the current(previous) run
296      !!       adatrj(0) : number of elapsed days since the begining of the experiment at the
297      !!                   end of the current(previous) run (REAL -> keep fractions of day)
298      !!       ndastp    : date at the end of the current(previous) run (coded as yyyymmdd integer)
299      !!
300      !!   According to namelist parameter nrstdt,
301      !!       nrstdt = 0  no control on the date (nit000 is  arbitrary).
302      !!       nrstdt = 1  we verify that nit000 is equal to the last
303      !!                   time step of previous run + 1.
304      !!       In both those options, the  exact duration of the experiment
305      !!       since the beginning (cumulated duration of all previous restart runs)
306      !!       is not stored in the restart and is assumed to be (nit000-1)*rdt.
307      !!       This is valid is the time step has remained constant.
308      !!
309      !!       nrstdt = 2  the duration of the experiment in days (adatrj)
310      !!                    has been stored in the restart file.
311      !!----------------------------------------------------------------------
312      INTEGER         , INTENT(in) ::   kt         ! ocean time-step
313      CHARACTER(len=*), INTENT(in) ::   cdrw       ! "READ"/"WRITE" flag
314      !
315      REAL(wp) ::   zkt, zndastp
316      !!----------------------------------------------------------------------
317
318      IF( TRIM(cdrw) == 'READ' ) THEN
319
320         IF( iom_varid( numror, 'kt', ldstop = .FALSE. ) > 0 ) THEN
321            ! Get Calendar informations
322            CALL iom_get( numror, 'kt', zkt )   ! last time-step of previous run
323            IF(lwp) THEN
324               WRITE(numout,*) ' *** Info read in restart : '
325               WRITE(numout,*) '   previous time-step                               : ', NINT( zkt )
326               WRITE(numout,*) ' *** restart option'
327               SELECT CASE ( nrstdt )
328               CASE ( 0 )   ;   WRITE(numout,*) ' nrstdt = 0 : no control of nit000'
329               CASE ( 1 )   ;   WRITE(numout,*) ' nrstdt = 1 : no control the date at nit000 (use ndate0 read in the namelist)'
330               CASE ( 2 )   ;   WRITE(numout,*) ' nrstdt = 2 : calendar parameters read in restart'
331               END SELECT
332               WRITE(numout,*)
333            ENDIF
334            ! Control of date
335            IF( nit000 - NINT( zkt ) /= 1 .AND. nrstdt /= 0 )                                         &
336                 &   CALL ctl_stop( ' ===>>>> : problem with nit000 for the restart',                 &
337                 &                  ' verify the restart file or rerun with nrstdt = 0 (namelist)' )
338            ! define ndastp and adatrj
339            IF ( nrstdt == 2 ) THEN
340               ! read the parameters corresponding to nit000 - 1 (last time step of previous run)
341               CALL iom_get( numror, 'ndastp', zndastp )
342               ndastp = NINT( zndastp )
343               CALL iom_get( numror, 'adatrj', adatrj  )
344            ELSE
345               ! parameters corresponding to nit000 - 1 (as we start the step loop with a call to day)
346               ndastp = ndate0        ! ndate0 read in the namelist in dom_nam
347               IF( nn_time0*3600-ndt05 .lt. 0 )  ndastp=ndastp-1      ! Start hour is specified in the namelist (default 0)
348               adatrj = ( REAL( nit000-1, wp ) * rdttra(1) ) / rday
349               ! note this is wrong if time step has changed during run
350            ENDIF
351         ELSE
352            ! parameters corresponding to nit000 - 1 (as we start the step loop with a call to day)
353            ndastp = ndate0           ! ndate0 read in the namelist in dom_nam
354            IF( nn_time0*3600-ndt05 .lt. 0 )  ndastp=ndastp-1      ! Start hour is specified in the namelist (default 0)
355            adatrj = ( REAL( nit000-1, wp ) * rdttra(1) ) / rday
356         ENDIF
357         IF( ABS(adatrj  - REAL(NINT(adatrj),wp)) < 0.1 / rday )   adatrj = REAL(NINT(adatrj),wp)   ! avoid truncation error
358         !
359         IF(lwp) THEN
360            WRITE(numout,*) ' *** Info used values : '
361            WRITE(numout,*) '   date ndastp                                      : ', ndastp
362            WRITE(numout,*) '   number of elapsed days since the begining of run : ', adatrj
363            WRITE(numout,*)
364         ENDIF
365         !
366      ELSEIF( TRIM(cdrw) == 'WRITE' ) THEN
367         !
368         IF( kt == nitrst ) THEN
369            IF(lwp) WRITE(numout,*)
370            IF(lwp) WRITE(numout,*) 'rst_write : write oce restart file  kt =', kt
371            IF(lwp) WRITE(numout,*) '~~~~~~~'
372         ENDIF
373         ! calendar control
374         CALL iom_rstput( kt, nitrst, numrow, 'kt'     , REAL( kt    , wp) )   ! time-step
375         CALL iom_rstput( kt, nitrst, numrow, 'ndastp' , REAL( ndastp, wp) )   ! date
376         CALL iom_rstput( kt, nitrst, numrow, 'adatrj' , adatrj            )   ! number of elapsed days since
377         !                                                                     ! the begining of the run [s]
378      ENDIF
379      !
380   END SUBROUTINE day_rst
381
382   !!======================================================================
383END MODULE daymod
Note: See TracBrowser for help on using the repository browser.