source: NEMO/branches/2019/ENHANCE-02_ISF_nemo/src/OCE/IOM/restart.F90 @ 11553

Last change on this file since 11553 was 11553, checked in by mathiot, 14 months ago

ENHANCE-02_ISF: fix coupling issue (ticket #2142)

  • Property svn:keywords set to Id
File size: 14.9 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   !!            3.7  !  2014-01  (G. Madec) suppression of curl and hdiv from the restart
12   !!             -   !  2014-12  (G. Madec) remove KPP scheme
13   !!----------------------------------------------------------------------
14
15   !!----------------------------------------------------------------------
16   !!   rst_opn    : open the ocean restart file
17   !!   rst_write  : write the ocean restart file
18   !!   rst_read   : read the ocean restart file
19   !!----------------------------------------------------------------------
20   USE oce             ! ocean dynamics and tracers
21   USE isf             ! ice shelf
22   USE isfcpl          ! ice shelf coupling
23   USE dom_oce         ! ocean space and time domain
24   USE sbc_ice         ! only lk_si3
25   USE phycst          ! physical constants
26   USE eosbn2          ! equation of state            (eos bn2 routine)
27   USE trdmxl_oce      ! ocean active mixed layer tracers trends variables
28   !
29   USE in_out_manager  ! I/O manager
30   USE iom             ! I/O module
31   USE diurnal_bulk
32   USE lib_mpp         ! distribued memory computing library
33
34   IMPLICIT NONE
35   PRIVATE
36
37   PUBLIC   rst_opn         ! routine called by step module
38   PUBLIC   rst_write       ! routine called by step module
39   PUBLIC   rst_read        ! routine called by istate module
40   PUBLIC   rst_read_open   ! routine called in rst_read and (possibly) in dom_vvl_init
41
42   !! * Substitutions
43#  include "vectopt_loop_substitute.h90"
44   !!----------------------------------------------------------------------
45   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
46   !! $Id$
47   !! Software governed by the CeCILL license (see ./LICENSE)
48   !!----------------------------------------------------------------------
49CONTAINS
50
51   SUBROUTINE rst_opn( kt )
52      !!---------------------------------------------------------------------
53      !!                   ***  ROUTINE rst_opn  ***
54      !!                     
55      !! ** Purpose : + initialization (should be read in the namelist) of nitrst
56      !!              + open the restart when we are one time step before nitrst
57      !!                   - restart header is defined when kt = nitrst-1
58      !!                   - restart data  are written when kt = nitrst
59      !!              + define lrst_oce to .TRUE. when we need to define or write the restart
60      !!----------------------------------------------------------------------
61      INTEGER, INTENT(in) ::   kt     ! ocean time-step
62      !!
63      CHARACTER(LEN=20)   ::   clkt     ! ocean time-step deine as a character
64      CHARACTER(LEN=50)   ::   clname   ! ocean output restart file name
65      CHARACTER(lc)       ::   clpath   ! full path to ocean output restart file
66      CHARACTER(LEN=52)   ::   clpname   ! ocean output restart file name including prefix for AGRIF
67      CHARACTER(LEN=256)  ::   clinfo    ! info character
68      !!----------------------------------------------------------------------
69      !
70      IF( kt == nit000 ) THEN   ! default definitions
71         lrst_oce = .FALSE.   
72         IF( ln_rst_list ) THEN
73            nrst_lst = 1
74            nitrst = nstocklist( nrst_lst )
75         ELSE
76            nitrst = nitend
77         ENDIF
78      ENDIF
79
80      ! frequency-based restart dumping (nn_stock)
81      IF( .NOT. ln_rst_list .AND. MOD( kt - 1, nstock ) == 0 ) THEN   
82         ! we use kt - 1 and not kt - nit000 to keep the same periodicity from the beginning of the experiment
83         nitrst = kt + nstock - 1                  ! define the next value of nitrst for restart writing
84         IF( nitrst > nitend )   nitrst = nitend   ! make sure we write a restart at the end of the run
85      ENDIF
86      ! to get better performances with NetCDF format:
87      ! we open and define the ocean restart file one time step before writing the data (-> at nitrst - 1)
88      ! except if we write ocean restart files every time step or if an ocean restart file was writen at nitend - 1
89      IF( kt == nitrst - 1 .OR. nstock == 1 .OR. ( kt == nitend .AND. .NOT. lrst_oce ) ) THEN
90         IF( nitrst <= nitend .AND. nitrst > 0 ) THEN 
91            ! beware of the format used to write kt (default is i8.8, that should be large enough...)
92            IF( nitrst > 999999999 ) THEN   ;   WRITE(clkt, *       ) nitrst
93            ELSE                            ;   WRITE(clkt, '(i8.8)') nitrst
94            ENDIF
95            ! create the file
96            clname = TRIM(cexper)//"_"//TRIM(ADJUSTL(clkt))//"_"//TRIM(cn_ocerst_out)
97            clpath = TRIM(cn_ocerst_outdir)
98            IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
99            IF(lwp) THEN
100               WRITE(numout,*)
101               IF(.NOT.lwxios) THEN
102                  WRITE(numout,*) '             open ocean restart NetCDF file: ',TRIM(clpath)//TRIM(clname)
103                  IF ( snc4set%luse )      WRITE(numout,*) '             opened for NetCDF4 chunking and compression'
104                  IF( kt == nitrst - 1 ) THEN   ;   WRITE(numout,*) '             kt = nitrst - 1 = ', kt
105                  ELSE                          ;   WRITE(numout,*) '             kt = '             , kt
106                  ENDIF
107               ENDIF
108            ENDIF
109            !
110            IF(.NOT.lwxios) THEN
111               CALL iom_open( TRIM(clpath)//TRIM(clname), numrow, ldwrt = .TRUE. )
112            ELSE
113#if defined key_iomput
114               cwxios_context = "rstw_"//TRIM(ADJUSTL(clkt))
115               IF( TRIM(Agrif_CFixed()) == '0' ) THEN
116                  clpname = clname
117               ELSE
118                  clpname = TRIM(Agrif_CFixed())//"_"//clname   
119               ENDIF
120               CALL iom_init( cwxios_context, TRIM(clpath)//TRIM(clpname), .false. )
121               CALL xios_update_calendar(nitrst)
122               CALL iom_swap(      cxios_context          )
123#else
124               clinfo = 'Can not use XIOS in rst_opn'
125               CALL ctl_stop(TRIM(clinfo))
126#endif
127            ENDIF
128            lrst_oce = .TRUE.
129         ENDIF
130      ENDIF
131      !
132   END SUBROUTINE rst_opn
133
134
135   SUBROUTINE rst_write( kt )
136      !!---------------------------------------------------------------------
137      !!                   ***  ROUTINE rstwrite  ***
138      !!                     
139      !! ** Purpose :   Write restart fields in NetCDF format
140      !!
141      !! ** Method  :   Write in numrow when kt == nitrst in NetCDF
142      !!              file, save fields which are necessary for restart
143      !!----------------------------------------------------------------------
144      INTEGER, INTENT(in) ::   kt   ! ocean time-step
145      !!----------------------------------------------------------------------
146                     IF(lwxios) CALL iom_swap(      cwxios_context          )
147                     CALL iom_rstput( kt, nitrst, numrow, 'rdt'    , rdt       , ldxios = lwxios)   ! dynamics time step
148                     CALL iom_delay_rst( 'WRITE', 'OCE', numrow )   ! save only ocean delayed global communication variables
149
150      IF ( .NOT. ln_diurnal_only ) THEN
151                     CALL iom_rstput( kt, nitrst, numrow, 'ub'     , ub, ldxios = lwxios        )     ! before fields
152                     CALL iom_rstput( kt, nitrst, numrow, 'vb'     , vb, ldxios = lwxios        )
153                     CALL iom_rstput( kt, nitrst, numrow, 'tb'     , tsb(:,:,:,jp_tem), ldxios = lwxios )
154                     CALL iom_rstput( kt, nitrst, numrow, 'sb'     , tsb(:,:,:,jp_sal), ldxios = lwxios )
155                     CALL iom_rstput( kt, nitrst, numrow, 'sshb'   , sshb, ldxios = lwxios      )
156                     !
157                     CALL iom_rstput( kt, nitrst, numrow, 'un'     , un, ldxios = lwxios        )     ! now fields
158                     CALL iom_rstput( kt, nitrst, numrow, 'vn'     , vn, ldxios = lwxios        )
159                     CALL iom_rstput( kt, nitrst, numrow, 'tn'     , tsn(:,:,:,jp_tem), ldxios = lwxios )
160                     CALL iom_rstput( kt, nitrst, numrow, 'sn'     , tsn(:,:,:,jp_sal), ldxios = lwxios )
161                     CALL iom_rstput( kt, nitrst, numrow, 'sshn'   , sshn, ldxios = lwxios      )
162                     CALL iom_rstput( kt, nitrst, numrow, 'rhop'   , rhop, ldxios = lwxios      )
163      ENDIF
164     
165      IF (ln_diurnal) CALL iom_rstput( kt, nitrst, numrow, 'Dsst', x_dsst, ldxios = lwxios ) 
166      IF(lwxios) CALL iom_swap(      cxios_context          )
167      IF( kt == nitrst ) THEN
168         IF(.NOT.lwxios) THEN
169            CALL iom_close( numrow )     ! close the restart file (only at last time step)
170         ELSE
171            CALL iom_context_finalize(      cwxios_context          )
172         ENDIF
173!!gm         IF( .NOT. lk_trdmld )   lrst_oce = .FALSE.
174!!gm  not sure what to do here   ===>>>  ask to Sebastian
175         lrst_oce = .FALSE.
176            IF( ln_rst_list ) THEN
177               nrst_lst = MIN(nrst_lst + 1, SIZE(nstocklist,1))
178               nitrst = nstocklist( nrst_lst )
179            ENDIF
180      ENDIF
181      !
182   END SUBROUTINE rst_write
183
184
185   SUBROUTINE rst_read_open
186      !!----------------------------------------------------------------------
187      !!                   ***  ROUTINE rst_read_open  ***
188      !!
189      !! ** Purpose :   Open read files for NetCDF restart
190      !!
191      !! ** Method  :   Use a non-zero, positive value of numror to assess whether or not
192      !!                the file has already been opened
193      !!----------------------------------------------------------------------
194      LOGICAL        ::   llok
195      CHARACTER(lc)  ::   clpath   ! full path to ocean output restart file
196      !!----------------------------------------------------------------------
197      !
198      IF( numror <= 0 ) THEN
199         IF(lwp) THEN                                             ! Contol prints
200            WRITE(numout,*)
201            WRITE(numout,*) 'rst_read : read oce NetCDF restart file'
202            IF ( snc4set%luse )      WRITE(numout,*) 'rst_read : configured with NetCDF4 support'
203            WRITE(numout,*) '~~~~~~~~'
204         ENDIF
205         lxios_sini = .FALSE.
206         clpath = TRIM(cn_ocerst_indir)
207         IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
208         CALL iom_open( TRIM(clpath)//cn_ocerst_in, numror )
209! are we using XIOS to read the data? Part above will have to modified once XIOS
210! can handle checking if variable is in the restart file (there will be no need to open
211! restart)
212         IF(.NOT.lxios_set) lrxios = lrxios.AND.lxios_sini
213         IF( lrxios) THEN
214             crxios_context = 'nemo_rst'
215             IF( .NOT.lxios_set ) THEN
216                 IF(lwp) WRITE(numout,*) 'Enable restart reading by XIOS'
217                 CALL iom_init( crxios_context, ld_tmppatch = .false. )
218                 lxios_set = .TRUE.
219             ENDIF
220         ENDIF
221         IF( TRIM(Agrif_CFixed()) /= '0' .AND. lrxios) THEN
222             CALL iom_init( crxios_context, ld_tmppatch = .false. )
223             IF(lwp) WRITE(numout,*) 'Enable restart reading by XIOS for AGRIF'
224             lxios_set = .TRUE.
225         ENDIF
226      ENDIF
227
228   END SUBROUTINE rst_read_open
229
230
231   SUBROUTINE rst_read
232      !!----------------------------------------------------------------------
233      !!                   ***  ROUTINE rst_read  ***
234      !!
235      !! ** Purpose :   Read files for NetCDF restart
236      !!
237      !! ** Method  :   Read in restart.nc file fields which are necessary for restart
238      !!----------------------------------------------------------------------
239      REAL(wp) ::   zrdt
240      INTEGER  ::   jk
241      REAL(wp), DIMENSION(jpi, jpj, jpk) :: w3d
242      !!----------------------------------------------------------------------
243
244      CALL rst_read_open           ! open restart for reading (if not already opened)
245
246      ! Check dynamics and tracer time-step consistency and force Euler restart if changed
247      IF( iom_varid( numror, 'rdt', ldstop = .FALSE. ) > 0 )   THEN
248         CALL iom_get( numror, 'rdt', zrdt, ldxios = lrxios )
249         IF( zrdt /= rdt )   neuler = 0
250      ENDIF
251
252      CALL iom_delay_rst( 'READ', 'OCE', numror )   ! read only ocean delayed global communication variables
253     
254      ! Diurnal DSST
255      IF( ln_diurnal ) CALL iom_get( numror, jpdom_autoglo, 'Dsst' , x_dsst, ldxios = lrxios ) 
256      IF ( ln_diurnal_only ) THEN
257         IF(lwp) WRITE( numout, * ) &
258         &   "rst_read:- ln_diurnal_only set, setting rhop=rau0" 
259         rhop = rau0
260         CALL iom_get( numror, jpdom_autoglo, 'tn'     , w3d, ldxios = lrxios ) 
261         tsn(:,:,1,jp_tem) = w3d(:,:,1)
262         RETURN
263      ENDIF 
264     
265      IF( iom_varid( numror, 'ub', ldstop = .FALSE. ) > 0 ) THEN
266         CALL iom_get( numror, jpdom_autoglo, 'ub'     , ub, ldxios = lrxios                )   ! before fields
267         CALL iom_get( numror, jpdom_autoglo, 'vb'     , vb, ldxios = lrxios                )
268         CALL iom_get( numror, jpdom_autoglo, 'tb'     , tsb(:,:,:,jp_tem), ldxios = lrxios )
269         CALL iom_get( numror, jpdom_autoglo, 'sb'     , tsb(:,:,:,jp_sal), ldxios = lrxios )
270         CALL iom_get( numror, jpdom_autoglo, 'sshb'   , sshb, ldxios = lrxios              )
271      ELSE
272         neuler = 0
273      ENDIF
274      !
275      CALL iom_get( numror, jpdom_autoglo, 'un'     , un, ldxios = lrxios )   ! now    fields
276      CALL iom_get( numror, jpdom_autoglo, 'vn'     , vn, ldxios = lrxios )
277      CALL iom_get( numror, jpdom_autoglo, 'tn'     , tsn(:,:,:,jp_tem), ldxios = lrxios )
278      CALL iom_get( numror, jpdom_autoglo, 'sn'     , tsn(:,:,:,jp_sal), ldxios = lrxios )
279      CALL iom_get( numror, jpdom_autoglo, 'sshn'   , sshn, ldxios = lrxios )
280      IF( iom_varid( numror, 'rhop', ldstop = .FALSE. ) > 0 ) THEN
281         CALL iom_get( numror, jpdom_autoglo, 'rhop'   , rhop, ldxios = lrxios )   ! now    potential density
282      ELSE
283         CALL eos( tsn, rhd, rhop, gdept_n(:,:,:) )   
284      ENDIF
285      !
286      ! ice sheet coupling: extrapolation of restart to fill new wet cell and compute divergence correction
287      IF ( ln_isfcpl ) CALL isfcpl_init()
288      !
289      IF( neuler == 0 ) THEN                                  ! Euler restart (neuler=0)
290         tsb  (:,:,:,:) = tsn  (:,:,:,:)                             ! all before fields set to now values
291         ub   (:,:,:)   = un   (:,:,:)
292         vb   (:,:,:)   = vn   (:,:,:)
293         sshb (:,:)     = sshn (:,:)
294         !
295         IF( .NOT.ln_linssh ) THEN
296            DO jk = 1, jpk
297               e3t_b(:,:,jk) = e3t_n(:,:,jk)
298            END DO
299         ENDIF
300         !
301      ENDIF
302      !
303   END SUBROUTINE rst_read
304
305   !!=====================================================================
306END MODULE restart
Note: See TracBrowser for help on using the repository browser.