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/trunk/src/OCE/IOM – NEMO

Context Navigation

source: NEMO/trunk/src/OCE/IOM/restart.F90 @ 10425

Last change on this file since 10425 was 10425, checked in by smasson, 5 years ago
trunk: merge back dev_r10164_HPC09_ESIWACE_PREP_MERGE@10424 into the trunk
Property svn:keywords set to `Id`
File size: 15.8 KB

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats: