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.
restart.F90 in branches/NERC/dev_r5518_NOC_MEDUSA_Stable/NEMOGCM/NEMO/OPA_SRC/IOM – NEMO

source: branches/NERC/dev_r5518_NOC_MEDUSA_Stable/NEMOGCM/NEMO/OPA_SRC/IOM/restart.F90 @ 6154

Last change on this file since 6154 was 6154, checked in by jpalmier, 8 years ago

JPALM -- 22-12-2015 -- add more print statement for restart writing checkings
File size: 15.3 KB
Line 
1MODULE restart
2   !!======================================================================
3   !!                     ***  MODULE  restart  ***
4   !! Ocean restart :  write the ocean restart file
5   !!======================================================================
6   !! History :  OPA  !  1999-11  (M. Imbard)  Original code
7   !!   NEMO     1.0  !  2002-08  (G. Madec)  F90: Free form
8   !!            2.0  !  2006-07  (S. Masson)  use IOM for restart
9   !!            3.3  !  2010-04  (M. Leclair, G. Madec)  modified LF-RA
10   !!            - -  !  2010-10  (C. Ethe, G. Madec) TRC-TRA merge (T-S in 4D)
11   !!----------------------------------------------------------------------
12
13   !!----------------------------------------------------------------------
14   !!   rst_opn    : open the ocean restart file
15   !!   rst_write  : write the ocean restart file
16   !!   rst_read   : read the ocean restart file
17   !!----------------------------------------------------------------------
18   USE oce             ! ocean dynamics and tracers
19   USE dom_oce         ! ocean space and time domain
20   USE phycst          ! physical constants
21   USE in_out_manager  ! I/O manager
22   USE iom             ! I/O module
23   USE eosbn2          ! equation of state            (eos bn2 routine)
24   USE trdmxl_oce      ! ocean active mixed layer tracers trends variables
25   USE divcur          ! hor. divergence and curl      (div & cur routines)
26
27   IMPLICIT NONE
28   PRIVATE
29
30   PUBLIC   rst_opn         ! routine called by step module
31   PUBLIC   rst_write       ! routine called by step module
32   PUBLIC   rst_read        ! routine called by istate module
33   PUBLIC   rst_read_open   ! routine called in rst_read and (possibly) in dom_vvl_init
34
35   !! * Substitutions
36#  include "domzgr_substitute.h90"
37#  include "vectopt_loop_substitute.h90"
38   !!----------------------------------------------------------------------
39   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
40   !! $Id$
41   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
42   !!----------------------------------------------------------------------
43CONTAINS
44
45   SUBROUTINE rst_opn( kt )
46      !!---------------------------------------------------------------------
47      !!                   ***  ROUTINE rst_opn  ***
48      !!                     
49      !! ** Purpose : + initialization (should be read in the namelist) of nitrst
50      !!              + open the restart when we are one time step before nitrst
51      !!                   - restart header is defined when kt = nitrst-1
52      !!                   - restart data  are written when kt = nitrst
53      !!              + define lrst_oce to .TRUE. when we need to define or write the restart
54      !!----------------------------------------------------------------------
55      INTEGER, INTENT(in) ::   kt     ! ocean time-step
56      !!
57      CHARACTER(LEN=20)   ::   clkt     ! ocean time-step deine as a character
58      CHARACTER(LEN=50)   ::   clname   ! ocean output restart file name
59      CHARACTER(lc)       ::   clpath   ! full path to ocean output restart file
60      !!----------------------------------------------------------------------
61      !
62      IF( kt == nit000 ) THEN   ! default definitions
63         lrst_oce = .FALSE.   
64         IF( ln_rst_list ) THEN
65            nrst_lst = 1
66            nitrst = nstocklist( nrst_lst )
67         ELSE
68            nitrst = nitend
69         ENDIF
70      ENDIF
71
72      ! frequency-based restart dumping (nn_stock)
73      IF( .NOT. ln_rst_list .AND. MOD( kt - 1, nstock ) == 0 ) THEN   
74         ! we use kt - 1 and not kt - nit000 to keep the same periodicity from the beginning of the experiment
75         nitrst = kt + nstock - 1                  ! define the next value of nitrst for restart writing
76         IF( nitrst > nitend )   nitrst = nitend   ! make sure we write a restart at the end of the run
77      ENDIF
78      !! JPALM test -
79      IF( kt == nitrst - 1 .OR. nstock == 1 .OR. ( kt == nitend .AND. .NOT. lrst_oce ) ) THEN
80         IF( nitrst <= nitend .AND. nitrst > 0 ) THEN
81            IF ( ln_rstdate ) THEN
82            WRITE(numout,*) 'JPALM - we want all informations for restart file name -- '
83            WRITE(numout,*) 'JPALM - 1 - conditions for openning rst file :'
84            WRITE(numout,*) 'JPALM - oce restart kt = ',kt,'==', nitrst - 1
85            WRITE(numout,*) 'JPALM - oce restart nstock = ',nstock,'== 1 '
86            WRITE(numout,*) 'JPALM - oce restart kt = ',kt,'==',nitend
87            WRITE(numout,*) 'JPALM - oce restart nitrst = ',nitrst,'<=',nitend,' and > 0'
88            WRITE(numout,*) '-----------------------------'
89            CALL ju2ymds( fjulday + rdttra(1) / rday, iyear, imonth, iday, zsec )
90            WRITE(clkt, '(i4.4,2i2.2)') iyear, imonth, iday
91            WRITE(numout,*) 'JPALM - 2 - date calculated by ju2ymds: '
92            WRITE(numout,*) 'JPALM - oce restart fjulday = ',fjulday
93            WRITE(numout,*) 'JPALM - oce restart rdttra/rday  = ',rdttra(1)/rday
94            WRITE(numout,*) 'JPALM - oce restart rdttra  = ',rdttra(1)
95            WRITE(numout,*) 'JPALM - oce restart rday = ',rday
96            WRITE(numout,*) 'JPALM - oce restart iyear = ',iyear
97            WRITE(numout,*) 'JPALM - oce restart imonth = ',imonth
98            WRITE(numout,*) 'JPALM - oce restart iday = ',iday
99
100            ENDIF
101         ENDIF
102      ENDIF
103      !!
104      ! to get better performances with NetCDF format:
105      ! we open and define the ocean restart file one time step before writing the data (-> at nitrst - 1)
106      ! except if we write ocean restart files every time step or if an ocean restart file was writen at nitend - 1
107      IF( kt == nitrst - 1 .OR. nstock == 1 .OR. ( kt == nitend .AND. .NOT. lrst_oce ) ) THEN
108         IF( nitrst <= nitend .AND. nitrst > 0 ) THEN 
109            ! beware of the format used to write kt (default is i8.8, that should be large enough...)
110            IF( nitrst > 999999999 ) THEN   ;   WRITE(clkt, *       ) nitrst
111            ELSE                            ;   WRITE(clkt, '(i8.8)') nitrst
112            ENDIF
113            ! create the file
114            clname = TRIM(cexper)//"_"//TRIM(ADJUSTL(clkt))//"_"//TRIM(cn_ocerst_out)
115            clpath = TRIM(cn_ocerst_outdir)
116            IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
117            IF(lwp) THEN
118               WRITE(numout,*)
119               SELECT CASE ( jprstlib )
120               CASE ( jprstdimg )   ;   WRITE(numout,*)                            &
121                   '             open ocean restart binary file: ',TRIM(clpath)//clname
122               CASE DEFAULT         ;   WRITE(numout,*)                            &
123                   '             open ocean restart NetCDF file: ',TRIM(clpath)//clname
124               END SELECT
125               IF ( snc4set%luse )      WRITE(numout,*) '             opened for NetCDF4 chunking and compression'
126               IF( kt == nitrst - 1 ) THEN   ;   WRITE(numout,*) '             kt = nitrst - 1 = ', kt
127               ELSE                          ;   WRITE(numout,*) '             kt = '             , kt
128               ENDIF
129            ENDIF
130            !
131            CALL iom_open( TRIM(clpath)//TRIM(clname), numrow, ldwrt = .TRUE., kiolib = jprstlib )
132            lrst_oce = .TRUE.
133         ENDIF
134      ENDIF
135      !
136   END SUBROUTINE rst_opn
137
138
139   SUBROUTINE rst_write( kt )
140      !!---------------------------------------------------------------------
141      !!                   ***  ROUTINE rstwrite  ***
142      !!                     
143      !! ** Purpose :   Write restart fields in the format corresponding to jprstlib
144      !!
145      !! ** Method  :   Write in numrow when kt == nitrst in NetCDF
146      !!              file, save fields which are necessary for restart
147      !!----------------------------------------------------------------------
148      INTEGER, INTENT(in) ::   kt   ! ocean time-step
149      !!----------------------------------------------------------------------
150
151                     CALL iom_rstput( kt, nitrst, numrow, 'rdt'    , rdt       )   ! dynamics time step
152                     CALL iom_rstput( kt, nitrst, numrow, 'rdttra1', rdttra(1) )   ! surface tracer time step
153
154                     CALL iom_rstput( kt, nitrst, numrow, 'ub'     , ub        )     ! before fields
155                     CALL iom_rstput( kt, nitrst, numrow, 'vb'     , vb        )
156                     CALL iom_rstput( kt, nitrst, numrow, 'tb'     , tsb(:,:,:,jp_tem) )
157                     CALL iom_rstput( kt, nitrst, numrow, 'sb'     , tsb(:,:,:,jp_sal) )
158                     CALL iom_rstput( kt, nitrst, numrow, 'rotb'   , rotb      )
159                     CALL iom_rstput( kt, nitrst, numrow, 'hdivb'  , hdivb     )
160                     CALL iom_rstput( kt, nitrst, numrow, 'sshb'   , sshb      )
161                     !
162                     CALL iom_rstput( kt, nitrst, numrow, 'un'     , un        )     ! now fields
163                     CALL iom_rstput( kt, nitrst, numrow, 'vn'     , vn        )
164                     CALL iom_rstput( kt, nitrst, numrow, 'tn'     , tsn(:,:,:,jp_tem) )
165                     CALL iom_rstput( kt, nitrst, numrow, 'sn'     , tsn(:,:,:,jp_sal) )
166                     CALL iom_rstput( kt, nitrst, numrow, 'rotn'   , rotn      )
167                     CALL iom_rstput( kt, nitrst, numrow, 'hdivn'  , hdivn     )
168                     CALL iom_rstput( kt, nitrst, numrow, 'sshn'   , sshn      )
169                     CALL iom_rstput( kt, nitrst, numrow, 'rhop'   , rhop      )
170#if defined key_zdfkpp
171                     CALL iom_rstput( kt, nitrst, numrow, 'rhd'    , rhd       )
172#endif
173      IF( kt == nitrst ) THEN
174         CALL iom_close( numrow )     ! close the restart file (only at last time step)
175!!gm         IF( .NOT. lk_trdmld )   lrst_oce = .FALSE.
176!!gm  not sure what to do here   ===>>>  ask to Sebastian
177         lrst_oce = .FALSE.
178            IF( ln_rst_list ) THEN
179               nrst_lst = MIN(nrst_lst + 1, SIZE(nstocklist,1))
180               nitrst = nstocklist( nrst_lst )
181            ENDIF
182            lrst_oce = .FALSE.
183      ENDIF
184      !
185   END SUBROUTINE rst_write
186
187
188   SUBROUTINE rst_read_open
189      !!----------------------------------------------------------------------
190      !!                   ***  ROUTINE rst_read_open  ***
191      !!
192      !! ** Purpose :   Open read files for restart (format fixed by jprstlib )
193      !!
194      !! ** Method  :   Use a non-zero, positive value of numror to assess whether or not
195      !!                the file has already been opened
196      !!----------------------------------------------------------------------
197      INTEGER        ::   jlibalt = jprstlib
198      LOGICAL        ::   llok
199      CHARACTER(lc)  ::   clpath   ! full path to ocean output restart file
200      !!----------------------------------------------------------------------
201      !
202      IF( numror <= 0 ) THEN
203         IF(lwp) THEN                                             ! Contol prints
204            WRITE(numout,*)
205            SELECT CASE ( jprstlib )
206            CASE ( jpnf90    )   ;   WRITE(numout,*) 'rst_read : read oce NetCDF restart file'
207            CASE ( jprstdimg )   ;   WRITE(numout,*) 'rst_read : read oce binary restart file'
208            END SELECT
209            IF ( snc4set%luse )      WRITE(numout,*) 'rst_read : configured with NetCDF4 support'
210            WRITE(numout,*) '~~~~~~~~'
211         ENDIF
212
213         clpath = TRIM(cn_ocerst_indir)
214         IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
215         IF ( jprstlib == jprstdimg ) THEN
216           ! eventually read netcdf file (monobloc)  for restarting on different number of processors
217           ! if {cn_ocerst_in}.nc exists, then set jlibalt to jpnf90
218           INQUIRE( FILE = TRIM(cn_ocerst_indir)//'/'//TRIM(cn_ocerst_in)//'.nc', EXIST = llok )
219           IF ( llok ) THEN ; jlibalt = jpnf90  ; ELSE ; jlibalt = jprstlib ; ENDIF
220         ENDIF
221         CALL iom_open( TRIM(clpath)//cn_ocerst_in, numror, kiolib = jlibalt )
222      ENDIF
223   END SUBROUTINE rst_read_open
224
225   SUBROUTINE rst_read
226      !!----------------------------------------------------------------------
227      !!                   ***  ROUTINE rst_read  ***
228      !!
229      !! ** Purpose :   Read files for restart (format fixed by jprstlib )
230      !!
231      !! ** Method  :   Read in restart.nc file fields which are necessary for restart
232      !!----------------------------------------------------------------------
233      REAL(wp) ::   zrdt, zrdttra1
234      INTEGER  ::   jk
235      LOGICAL  ::   llok
236      !!----------------------------------------------------------------------
237
238      CALL rst_read_open           ! open restart for reading (if not already opened)
239
240      ! Check dynamics and tracer time-step consistency and force Euler restart if changed
241      IF( iom_varid( numror, 'rdt', ldstop = .FALSE. ) > 0 )   THEN
242         CALL iom_get( numror, 'rdt', zrdt )
243         IF( zrdt /= rdt )   neuler = 0
244      ENDIF
245      IF( iom_varid( numror, 'rdttra1', ldstop = .FALSE. ) > 0 )   THEN
246         CALL iom_get( numror, 'rdttra1', zrdttra1 )
247         IF( zrdttra1 /= rdttra(1) )   neuler = 0
248      ENDIF
249      !
250      IF( iom_varid( numror, 'ub', ldstop = .FALSE. ) > 0 ) THEN
251         CALL iom_get( numror, jpdom_autoglo, 'ub'     , ub      )   ! before fields
252         CALL iom_get( numror, jpdom_autoglo, 'vb'     , vb      )
253         CALL iom_get( numror, jpdom_autoglo, 'tb'     , tsb(:,:,:,jp_tem) )
254         CALL iom_get( numror, jpdom_autoglo, 'sb'     , tsb(:,:,:,jp_sal) )
255         CALL iom_get( numror, jpdom_autoglo, 'rotb'   , rotb    )
256         CALL iom_get( numror, jpdom_autoglo, 'hdivb'  , hdivb   )
257         CALL iom_get( numror, jpdom_autoglo, 'sshb'   , sshb    )
258      ELSE
259         neuler = 0
260      ENDIF
261      !
262      CALL iom_get( numror, jpdom_autoglo, 'un'     , un      )   ! now    fields
263      CALL iom_get( numror, jpdom_autoglo, 'vn'     , vn      )
264      CALL iom_get( numror, jpdom_autoglo, 'tn'     , tsn(:,:,:,jp_tem) )
265      CALL iom_get( numror, jpdom_autoglo, 'sn'     , tsn(:,:,:,jp_sal) )
266      CALL iom_get( numror, jpdom_autoglo, 'sshn'   , sshn    )
267      IF( iom_varid( numror, 'rotn', ldstop = .FALSE. ) > 0 ) THEN
268         CALL iom_get( numror, jpdom_autoglo, 'rotn'   , rotn    )
269         CALL iom_get( numror, jpdom_autoglo, 'hdivn'  , hdivn   )
270      ELSE
271         CALL div_cur( 0 )                              ! Horizontal divergence & Relative vorticity
272      ENDIF
273      IF( iom_varid( numror, 'rhop', ldstop = .FALSE. ) > 0 ) THEN
274         CALL iom_get( numror, jpdom_autoglo, 'rhop'   , rhop    )   ! now    potential density
275      ELSE
276         CALL eos    ( tsn, rhd, rhop, fsdept_n(:,:,:) )   
277      ENDIF
278#if defined key_zdfkpp
279      IF( iom_varid( numror, 'rhd', ldstop = .FALSE. ) > 0 ) THEN
280         CALL iom_get( numror, jpdom_autoglo, 'rhd'    , rhd     )   ! now    in situ density anomaly
281      ELSE
282         CALL eos( tsn, rhd, fsdept_n(:,:,:) )   ! compute rhd
283      ENDIF
284#endif
285      !
286      IF( neuler == 0 ) THEN                                  ! Euler restart (neuler=0)
287         tsb  (:,:,:,:) = tsn  (:,:,:,:)                             ! all before fields set to now values
288         ub   (:,:,:)   = un   (:,:,:)
289         vb   (:,:,:)   = vn   (:,:,:)
290         rotb (:,:,:)   = rotn (:,:,:)
291         hdivb(:,:,:)   = hdivn(:,:,:)
292         sshb (:,:)     = sshn (:,:)
293
294         IF( lk_vvl ) THEN
295            DO jk = 1, jpk
296               fse3t_b(:,:,jk) = fse3t_n(:,:,jk)
297            END DO
298         ENDIF
299
300      ENDIF
301      !
302   END SUBROUTINE rst_read
303
304   !!=====================================================================
305END MODULE restart
Note: See TracBrowser for help on using the repository browser.