source: branches/UKMO/dev_r8864_restart_date/NEMOGCM/NEMO/OPA_SRC/IOM/restart.F90 @ 9390

Last change on this file since 9390 was 9390, checked in by davestorkey, 3 years ago

UKMO/dev_r8864_restart_date branch: commit changes.

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