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