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 NEMO/branches/UKMO/NEMO_4.0.1_icesheet_and_river_coupling/src/OCE/IOM – NEMO

source: NEMO/branches/UKMO/NEMO_4.0.1_icesheet_and_river_coupling/src/OCE/IOM/restart.F90 @ 12576

Last change on this file since 12576 was 12576, checked in by dancopsey, 2 years ago

Merge in iceberg calving stuff from dev_r5518_coupling_GSI7_GSI8_landice from the start of the branch to revision 6023.

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