source: branches/UKMO/dev_r6393_CO6_package_trunk/NEMOGCM/NEMO/OPA_SRC/IOM/restart.F90 @ 7023

Last change on this file since 7023 was 7023, checked in by deazer, 5 years ago

Include update for restart date labelling for rose cycling.

File size: 13.7 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_lim3
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 ioipsl, ONLY : ju2ymds    ! for calendar
30   USE diurnal_bulk
31   
32   IMPLICIT NONE
33   PRIVATE
34
35   PUBLIC   rst_opn         ! routine called by step module
36   PUBLIC   rst_write       ! routine called by step module
37   PUBLIC   rst_read        ! routine called by istate module
38   PUBLIC   rst_read_open   ! routine called in rst_read and (possibly) in dom_vvl_init
39
40   !! * Substitutions
41#  include "vectopt_loop_substitute.h90"
42   !!----------------------------------------------------------------------
43   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
44   !! $Id$
45   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
46   !!----------------------------------------------------------------------
47CONTAINS
48
49   SUBROUTINE rst_opn( kt )
50      !!---------------------------------------------------------------------
51      !!                   ***  ROUTINE rst_opn  ***
52      !!                     
53      !! ** Purpose : + initialization (should be read in the namelist) of nitrst
54      !!              + open the restart when we are one time step before nitrst
55      !!                   - restart header is defined when kt = nitrst-1
56      !!                   - restart data  are written when kt = nitrst
57      !!              + define lrst_oce to .TRUE. when we need to define or write the restart
58      !!----------------------------------------------------------------------
59      INTEGER, INTENT(in) ::   kt     ! ocean time-step
60      INTEGER             ::   iyear, imonth, iday
61      REAL (wp)           ::   zsec
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      !!----------------------------------------------------------------------
67      !
68      IF( kt == nit000 ) THEN   ! default definitions
69         lrst_oce = .FALSE.   
70         IF( ln_rst_list ) THEN
71            nrst_lst = 1
72            nitrst = nstocklist( nrst_lst )
73         ELSE
74            nitrst = nitend
75         ENDIF
76      ENDIF
77
78      ! frequency-based restart dumping (nn_stock)
79      IF( .NOT. ln_rst_list .AND. MOD( kt - 1, nstock ) == 0 ) THEN   
80         ! we use kt - 1 and not kt - nit000 to keep the same periodicity from the beginning of the experiment
81         nitrst = kt + nstock - 1                  ! define the next value of nitrst for restart writing
82         IF( nitrst > nitend )   nitrst = nitend   ! make sure we write a restart at the end of the run
83      ENDIF
84      ! to get better performances with NetCDF format:
85      ! we open and define the ocean restart file one time step before writing the data (-> at nitrst - 1)
86      ! except if we write ocean restart files every time step or if an ocean restart file was writen at nitend - 1
87      IF( kt == nitrst - 1 .OR. nstock == 1 .OR. ( kt == nitend .AND. .NOT. lrst_oce ) ) THEN
88         IF( nitrst <= nitend .AND. nitrst > 0 ) THEN
89            IF ( ln_rstdate ) THEN
90               CALL ju2ymds( fjulday + rdt / rday, iyear, imonth, iday, zsec )           
91               WRITE(clkt, '(i4.4,2i2.2)') iyear, imonth, iday
92            ELSE
93               ! beware of the format used to write kt (default is i8.8, that should be large enough...)
94               IF( nitrst > 999999999 ) THEN   ;   WRITE(clkt, *       ) nitrst
95               ELSE                            ;   WRITE(clkt, '(i8.8)') nitrst
96               ENDIF
97            ENDIF
98            ! create the file
99            clname = TRIM(cexper)//"_"//TRIM(ADJUSTL(clkt))//"_"//TRIM(cn_ocerst_out)
100            clpath = TRIM(cn_ocerst_outdir)
101            IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
102            IF(lwp) THEN
103               WRITE(numout,*)
104               SELECT CASE ( jprstlib )
105               CASE DEFAULT         ;   WRITE(numout,*)                            &
106                   '             open ocean restart NetCDF file: ',TRIM(clpath)//clname
107               END SELECT
108               IF ( snc4set%luse )      WRITE(numout,*) '             opened for NetCDF4 chunking and compression'
109               IF( kt == nitrst - 1 ) THEN   ;   WRITE(numout,*) '             kt = nitrst - 1 = ', kt
110               ELSE                          ;   WRITE(numout,*) '             kt = '             , kt
111               ENDIF
112            ENDIF
113            !
114            CALL iom_open( TRIM(clpath)//TRIM(clname), numrow, ldwrt = .TRUE., kiolib = jprstlib )
115            lrst_oce = .TRUE.
116         ENDIF
117      ENDIF
118      !
119   END SUBROUTINE rst_opn
120
121
122   SUBROUTINE rst_write( kt )
123      !!---------------------------------------------------------------------
124      !!                   ***  ROUTINE rstwrite  ***
125      !!                     
126      !! ** Purpose :   Write restart fields in the format corresponding to jprstlib
127      !!
128      !! ** Method  :   Write in numrow when kt == nitrst in NetCDF
129      !!              file, save fields which are necessary for restart
130      !!----------------------------------------------------------------------
131      INTEGER, INTENT(in) ::   kt   ! ocean time-step
132      !!----------------------------------------------------------------------
133
134                     CALL iom_rstput( kt, nitrst, numrow, 'rdt'    , rdt       )   ! dynamics and tracer time step
135
136      IF ( .NOT. ln_diurnal_only ) THEN
137                     CALL iom_rstput( kt, nitrst, numrow, 'ub'     , ub        )     ! before fields
138                     CALL iom_rstput( kt, nitrst, numrow, 'vb'     , vb        )
139                     CALL iom_rstput( kt, nitrst, numrow, 'tb'     , tsb(:,:,:,jp_tem) )
140                     CALL iom_rstput( kt, nitrst, numrow, 'sb'     , tsb(:,:,:,jp_sal) )
141                     CALL iom_rstput( kt, nitrst, numrow, 'sshb'   , sshb      )
142                     !
143                     CALL iom_rstput( kt, nitrst, numrow, 'un'     , un        )     ! now fields
144                     CALL iom_rstput( kt, nitrst, numrow, 'vn'     , vn        )
145                     CALL iom_rstput( kt, nitrst, numrow, 'tn'     , tsn(:,:,:,jp_tem) )
146                     CALL iom_rstput( kt, nitrst, numrow, 'sn'     , tsn(:,:,:,jp_sal) )
147                     CALL iom_rstput( kt, nitrst, numrow, 'sshn'   , sshn      )
148                     CALL iom_rstput( kt, nitrst, numrow, 'rhop'   , rhop      )
149
150                  ! extra variable needed for the ice sheet coupling
151                  IF ( ln_iscpl ) THEN
152                     CALL iom_rstput( kt, nitrst, numrow, 'tmask'  , tmask     ) ! need to extrapolate T/S
153                     CALL iom_rstput( kt, nitrst, numrow, 'umask'  , umask     ) ! need to correct barotropic velocity
154                     CALL iom_rstput( kt, nitrst, numrow, 'vmask'  , vmask     ) ! need to correct barotropic velocity
155                     CALL iom_rstput( kt, nitrst, numrow, 'smask'  , ssmask    ) ! need to correct barotropic velocity
156                     CALL iom_rstput( kt, nitrst, numrow, 'e3t_n', e3t_n(:,:,:) )   ! need to compute temperature correction
157                     CALL iom_rstput( kt, nitrst, numrow, 'e3u_n', e3u_n(:,:,:) )   ! need to compute bt conservation
158                     CALL iom_rstput( kt, nitrst, numrow, 'e3v_n', e3v_n(:,:,:) )   ! need to compute bt conservation
159                     CALL iom_rstput( kt, nitrst, numrow, 'gdepw_n', gdepw_n(:,:,:) ) ! need to compute extrapolation if vvl
160                  END IF
161      ENDIF
162     
163      IF (ln_diurnal) CALL iom_rstput( kt, nitrst, numrow, 'Dsst', x_dsst    ) 
164
165      IF( kt == nitrst ) THEN
166         CALL iom_close( numrow )     ! close the restart file (only at last time step)
167!!gm         IF( .NOT. lk_trdmld )   lrst_oce = .FALSE.
168!!gm  not sure what to do here   ===>>>  ask to Sebastian
169         lrst_oce = .FALSE.
170            IF( ln_rst_list ) THEN
171               nrst_lst = MIN(nrst_lst + 1, SIZE(nstocklist,1))
172               nitrst = nstocklist( nrst_lst )
173            ENDIF
174            lrst_oce = .FALSE.
175      ENDIF
176      !
177   END SUBROUTINE rst_write
178
179
180   SUBROUTINE rst_read_open
181      !!----------------------------------------------------------------------
182      !!                   ***  ROUTINE rst_read_open  ***
183      !!
184      !! ** Purpose :   Open read files for restart (format fixed by jprstlib )
185      !!
186      !! ** Method  :   Use a non-zero, positive value of numror to assess whether or not
187      !!                the file has already been opened
188      !!----------------------------------------------------------------------
189      INTEGER        ::   jlibalt = jprstlib
190      LOGICAL        ::   llok
191      CHARACTER(lc)  ::   clpath   ! full path to ocean output restart file
192      !!----------------------------------------------------------------------
193      !
194      IF( numror <= 0 ) THEN
195         IF(lwp) THEN                                             ! Contol prints
196            WRITE(numout,*)
197            SELECT CASE ( jprstlib )
198            CASE ( jpnf90    )   ;   WRITE(numout,*) 'rst_read : read oce NetCDF restart file'
199            END SELECT
200            IF ( snc4set%luse )      WRITE(numout,*) 'rst_read : configured with NetCDF4 support'
201            WRITE(numout,*) '~~~~~~~~'
202         ENDIF
203
204         clpath = TRIM(cn_ocerst_indir)
205         IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
206         CALL iom_open( TRIM(clpath)//cn_ocerst_in, numror, kiolib = jlibalt )
207      ENDIF
208   END SUBROUTINE rst_read_open
209
210
211   SUBROUTINE rst_read
212      !!----------------------------------------------------------------------
213      !!                   ***  ROUTINE rst_read  ***
214      !!
215      !! ** Purpose :   Read files for restart (format fixed by jprstlib )
216      !!
217      !! ** Method  :   Read in restart.nc file fields which are necessary for restart
218      !!----------------------------------------------------------------------
219      REAL(wp) ::   zrdt
220      INTEGER  ::   jk
221      !!----------------------------------------------------------------------
222
223      CALL rst_read_open           ! open restart for reading (if not already opened)
224
225      ! Check dynamics and tracer time-step consistency and force Euler restart if changed
226      IF( iom_varid( numror, 'rdt', ldstop = .FALSE. ) > 0 )   THEN
227         CALL iom_get( numror, 'rdt', zrdt )
228         IF( zrdt /= rdt )   neuler = 0
229      ENDIF
230
231      ! Diurnal DSST
232      IF( ln_diurnal ) CALL iom_get( numror, jpdom_autoglo, 'Dsst' , x_dsst  ) 
233      IF ( ln_diurnal_only ) THEN
234         IF(lwp) WRITE( numout, * ) &
235         &   "rst_read:- ln_diurnal_only set, setting rhop=rau0" 
236         rhop = rau0
237         CALL iom_get( numror, jpdom_autoglo, 'tn'     , tsn(:,:,1,jp_tem) ) 
238         RETURN
239      ENDIF 
240     
241      IF( iom_varid( numror, 'ub', ldstop = .FALSE. ) > 0 ) THEN
242         CALL iom_get( numror, jpdom_autoglo, 'ub'     , ub      )   ! before fields
243         CALL iom_get( numror, jpdom_autoglo, 'vb'     , vb      )
244         CALL iom_get( numror, jpdom_autoglo, 'tb'     , tsb(:,:,:,jp_tem) )
245         CALL iom_get( numror, jpdom_autoglo, 'sb'     , tsb(:,:,:,jp_sal) )
246         CALL iom_get( numror, jpdom_autoglo, 'sshb'   , sshb    )
247      ELSE
248         neuler = 0
249      ENDIF
250      !
251      CALL iom_get( numror, jpdom_autoglo, 'un'     , un      )   ! now    fields
252      CALL iom_get( numror, jpdom_autoglo, 'vn'     , vn      )
253      CALL iom_get( numror, jpdom_autoglo, 'tn'     , tsn(:,:,:,jp_tem) )
254      CALL iom_get( numror, jpdom_autoglo, 'sn'     , tsn(:,:,:,jp_sal) )
255      CALL iom_get( numror, jpdom_autoglo, 'sshn'   , sshn    )
256      IF( iom_varid( numror, 'rhop', ldstop = .FALSE. ) > 0 ) THEN
257         CALL iom_get( numror, jpdom_autoglo, 'rhop'   , rhop    )   ! now    potential density
258      ELSE
259         CALL eos( tsn, rhd, rhop, gdept_n(:,:,:) )   
260      ENDIF
261      !
262      IF( neuler == 0 ) THEN                                  ! Euler restart (neuler=0)
263         tsb  (:,:,:,:) = tsn  (:,:,:,:)                             ! all before fields set to now values
264         ub   (:,:,:)   = un   (:,:,:)
265         vb   (:,:,:)   = vn   (:,:,:)
266         sshb (:,:)     = sshn (:,:)
267         !
268         IF( .NOT.ln_linssh ) THEN
269            DO jk = 1, jpk
270               e3t_b(:,:,jk) = e3t_n(:,:,jk)
271            END DO
272         ENDIF
273         !
274      ENDIF
275      !
276   END SUBROUTINE rst_read
277
278   !!=====================================================================
279END MODULE restart
Note: See TracBrowser for help on using the repository browser.