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 branches/2017/dev_r8600_xios_read_write/NEMOGCM/NEMO/OPA_SRC/IOM – NEMO

Context Navigation

source: branches/2017/dev_r8600_xios_read_write/NEMOGCM/NEMO/OPA_SRC/IOM/restart.F90 @ 8770

Last change on this file since 8770 was 8770, checked in by andmirek, 6 years ago
#1953 and #1962 merged (and some modifications) with write branch
Property svn:keywords set to `Id`
File size: 15.7 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
[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
[6140]	29	USE diurnal_bulk
[8770]	30	USE iom_def, ONLY : lwxios
	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]	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
[8770]	64	CHARACTER(LEN=52) :: clpname ! ocean output restart file name including prefix for AGRIF
[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,*)
[8770]	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	!
[8770]	110	IF(.NOT.lwxios) THEN
	111	CALL iom_open( TRIM(clpath)//TRIM(clname), numrow, ldwrt = .TRUE., kiolib = jprstlib )
	112	ELSE
	113	cwxios_context = "rstw_"//TRIM(ADJUSTL(clkt))
	114	IF( TRIM(Agrif_CFixed()) == '0' ) THEN
	115	clpname = clname
	116	ELSE
	117	clpname = TRIM(Agrif_CFixed())//"_"//clname
	118	ENDIF
	119	CALL iom_init( cwxios_context, TRIM(clpath)//TRIM(clpname))
	120	CALL xios_update_calendar(nitrst)
	121	CALL iom_swap( cxios_context )
	122	ENDIF
[5341]	123	lrst_oce = .TRUE.
[611]	124	ENDIF
[508]	125	ENDIF
	126	!
	127	END SUBROUTINE rst_opn
	128
	129
[3]	130	SUBROUTINE rst_write( kt )
	131	!!---------------------------------------------------------------------
	132	!! * ROUTINE rstwrite *
	133	!!
[632]	134	!! ** Purpose : Write restart fields in the format corresponding to jprstlib
[3]	135	!!
[508]	136	!! ** Method : Write in numrow when kt == nitrst in NetCDF
[2528]	137	!! file, save fields which are necessary for restart
[3]	138	!!----------------------------------------------------------------------
[508]	139	INTEGER, INTENT(in) :: kt ! ocean time-step
[3]	140	!!----------------------------------------------------------------------
[8770]	141	IF(lwxios) CALL iom_swap( cwxios_context )
	142	CALL iom_rstput( kt, nitrst, numrow, 'rdt' , rdt , ldxios = lwxios) ! dynamics time step
[1239]	143
[6140]	144	IF ( .NOT. ln_diurnal_only ) THEN
[8770]	145	CALL iom_rstput( kt, nitrst, numrow, 'ub' , ub, ldxios = lwxios ) ! before fields
	146	CALL iom_rstput( kt, nitrst, numrow, 'vb' , vb, ldxios = lwxios )
	147	CALL iom_rstput( kt, nitrst, numrow, 'tb' , tsb(:,:,:,jp_tem), ldxios = lwxios )
	148	CALL iom_rstput( kt, nitrst, numrow, 'sb' , tsb(:,:,:,jp_sal), ldxios = lwxios )
	149	CALL iom_rstput( kt, nitrst, numrow, 'sshb' , sshb, ldxios = lwxios )
[4990]	150	!
[8770]	151	CALL iom_rstput( kt, nitrst, numrow, 'un' , un, ldxios = lwxios ) ! now fields
	152	CALL iom_rstput( kt, nitrst, numrow, 'vn' , vn, ldxios = lwxios )
	153	CALL iom_rstput( kt, nitrst, numrow, 'tn' , tsn(:,:,:,jp_tem), ldxios = lwxios )
	154	CALL iom_rstput( kt, nitrst, numrow, 'sn' , tsn(:,:,:,jp_sal), ldxios = lwxios )
	155	CALL iom_rstput( kt, nitrst, numrow, 'sshn' , sshn, ldxios = lwxios )
	156	CALL iom_rstput( kt, nitrst, numrow, 'rhop' , rhop, ldxios = lwxios )
[6140]	157	! extra variable needed for the ice sheet coupling
	158	IF ( ln_iscpl ) THEN
[8770]	159	CALL iom_rstput( kt, nitrst, numrow, 'tmask' , tmask, ldxios = lwxios ) ! need to extrapolate T/S
	160	CALL iom_rstput( kt, nitrst, numrow, 'umask' , umask, ldxios = lwxios ) ! need to correct barotropic velocity
	161	CALL iom_rstput( kt, nitrst, numrow, 'vmask' , vmask, ldxios = lwxios ) ! need to correct barotropic velocity
	162	CALL iom_rstput( kt, nitrst, numrow, 'smask' , ssmask, ldxios = lwxios) ! need to correct barotropic velocity
	163	CALL iom_rstput( kt, nitrst, numrow, 'e3t_n', e3t_n(:,:,:), ldxios = lwxios ) ! need to compute temperature correction
	164	CALL iom_rstput( kt, nitrst, numrow, 'e3u_n', e3u_n(:,:,:), ldxios = lwxios ) ! need to compute bt conservation
	165	CALL iom_rstput( kt, nitrst, numrow, 'e3v_n', e3v_n(:,:,:), ldxios = lwxios ) ! need to compute bt conservation
	166	CALL iom_rstput( kt, nitrst, numrow, 'gdepw_n', gdepw_n(:,:,:), ldxios = lwxios ) ! need to compute extrapolation if vvl
[6140]	167	END IF
	168	ENDIF
	169
[8770]	170	IF (ln_diurnal) CALL iom_rstput( kt, nitrst, numrow, 'Dsst', x_dsst, ldxios = lwxios )
	171	IF(lwxios) CALL iom_swap( cxios_context )
[508]	172	IF( kt == nitrst ) THEN
[8770]	173	IF(.NOT.lwxios) THEN
	174	CALL iom_close( numrow ) ! close the restart file (only at last time step)
	175	ELSE
	176	CALL iom_context_finalize( cwxios_context )
	177	ENDIF
[4990]	178	!!gm IF( .NOT. lk_trdmld ) lrst_oce = .FALSE.
	179	!!gm not sure what to do here ===>>> ask to Sebastian
	180	lrst_oce = .FALSE.
[5341]	181	IF( ln_rst_list ) THEN
	182	nrst_lst = MIN(nrst_lst + 1, SIZE(nstocklist,1))
	183	nitrst = nstocklist( nrst_lst )
	184	ENDIF
[3]	185	ENDIF
[508]	186	!
[3]	187	END SUBROUTINE rst_write
	188
[4990]	189
[4292]	190	SUBROUTINE rst_read_open
	191	!!----------------------------------------------------------------------
	192	!! * ROUTINE rst_read_open *
	193	!!
	194	!! ** Purpose : Open read files for restart (format fixed by jprstlib )
	195	!!
	196	!! ** Method : Use a non-zero, positive value of numror to assess whether or not
	197	!! the file has already been opened
	198	!!----------------------------------------------------------------------
[5341]	199	INTEGER :: jlibalt = jprstlib
	200	LOGICAL :: llok
	201	CHARACTER(lc) :: clpath ! full path to ocean output restart file
[4292]	202	!!----------------------------------------------------------------------
[4990]	203	!
	204	IF( numror <= 0 ) THEN
[4292]	205	IF(lwp) THEN ! Contol prints
	206	WRITE(numout,*)
	207	SELECT CASE ( jprstlib )
	208	CASE ( jpnf90 ) ; WRITE(numout,*) 'rst_read : read oce NetCDF restart file'
	209	END SELECT
	210	IF ( snc4set%luse ) WRITE(numout,*) 'rst_read : configured with NetCDF4 support'
	211	WRITE(numout,*) '~~~~~~~~'
	212	ENDIF
[8612]	213	lxios_sini = .FALSE.
[5341]	214	clpath = TRIM(cn_ocerst_indir)
	215	IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
	216	CALL iom_open( TRIM(clpath)//cn_ocerst_in, numror, kiolib = jlibalt )
[8612]	217	! are we using XIOS to read the data? Part above will have to modified once XIOS
	218	! can handle checking if variable is in the restart file (there will be no need to open
	219	! restart)
	220	IF(.NOT.lxios_set) lxios_read = lxios_read.AND.lxios_sini
	221	IF( lxios_read) THEN
[8668]	222	crxios_context = 'nemo_rst'
[8612]	223	if(.NOT.lxios_set) then
	224	IF(lwp) WRITE(numout,*) 'Enable restart reading by XIOS'
[8668]	225	CALL iom_init( crxios_context )
[8612]	226	lxios_set = .TRUE.
	227	endif
	228	ENDIF
	229	IF( TRIM(Agrif_CFixed()) /= '0' .AND. lxios_read) THEN
[8668]	230	CALL iom_init( crxios_context )
[8612]	231	IF(lwp) WRITE(numout,*) 'Enable restart reading by XIOS for AGRIF'
	232	lxios_set = .TRUE.
	233	ENDIF
[4292]	234	ENDIF
[8612]	235
[4292]	236	END SUBROUTINE rst_read_open
	237
[5836]	238
[3]	239	SUBROUTINE rst_read
	240	!!----------------------------------------------------------------------
	241	!! * ROUTINE rst_read *
	242	!!
[632]	243	!! ** Purpose : Read files for restart (format fixed by jprstlib )
[3]	244	!!
[1531]	245	!! ** Method : Read in restart.nc file fields which are necessary for restart
[3]	246	!!----------------------------------------------------------------------
[6140]	247	REAL(wp) :: zrdt
[4292]	248	INTEGER :: jk
[8612]	249	TYPE(xios_duration):: dtime
	250	integer::ni,nj,nk
[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
[8668]	257	CALL iom_get( numror, 'rdt', zrdt, ldxios = lxios_read )
[544]	258	IF( zrdt /= rdt ) neuler = 0
	259	ENDIF
[6140]	260
	261	! Diurnal DSST
[8668]	262	IF( ln_diurnal ) CALL iom_get( numror, jpdom_autoglo, 'Dsst' , x_dsst, ldxios = lxios_read )
[6140]	263	IF ( ln_diurnal_only ) THEN
	264	IF(lwp) WRITE( numout, * ) &
	265	& "rst_read:- ln_diurnal_only set, setting rhop=rau0"
	266	rhop = rau0
[8668]	267	CALL iom_get( numror, jpdom_autoglo, 'tn' , tsn(:,:,1,jp_tem), ldxios = lxios_read )
[6140]	268	RETURN
	269	ENDIF
	270
[3680]	271	IF( iom_varid( numror, 'ub', ldstop = .FALSE. ) > 0 ) THEN
[8668]	272	CALL iom_get( numror, jpdom_autoglo, 'ub' , ub, ldxios = lxios_read ) ! before fields
	273	CALL iom_get( numror, jpdom_autoglo, 'vb' , vb, ldxios = lxios_read )
	274	CALL iom_get( numror, jpdom_autoglo, 'tb' , tsb(:,:,:,jp_tem), ldxios = lxios_read )
	275	CALL iom_get( numror, jpdom_autoglo, 'sb' , tsb(:,:,:,jp_sal), ldxios = lxios_read )
	276	CALL iom_get( numror, jpdom_autoglo, 'sshb' , sshb, ldxios = lxios_read )
[3680]	277	ELSE
	278	neuler = 0
	279	ENDIF
	280	!
[8668]	281	CALL iom_get( numror, jpdom_autoglo, 'un' , un, ldxios = lxios_read ) ! now fields
	282	CALL iom_get( numror, jpdom_autoglo, 'vn' , vn, ldxios = lxios_read )
	283	CALL iom_get( numror, jpdom_autoglo, 'tn' , tsn(:,:,:,jp_tem), ldxios = lxios_read )
	284	CALL iom_get( numror, jpdom_autoglo, 'sn' , tsn(:,:,:,jp_sal), ldxios = lxios_read )
	285	CALL iom_get( numror, jpdom_autoglo, 'sshn' , sshn, ldxios = lxios_read )
[3680]	286	IF( iom_varid( numror, 'rhop', ldstop = .FALSE. ) > 0 ) THEN
[8668]	287	CALL iom_get( numror, jpdom_autoglo, 'rhop' , rhop, ldxios = lxios_read ) ! now potential density
[3680]	288	ELSE
[6140]	289	CALL eos( tsn, rhd, rhop, gdept_n(:,:,:) )
[3680]	290	ENDIF
[2528]	291	!
[508]	292	IF( neuler == 0 ) THEN ! Euler restart (neuler=0)
[3294]	293	tsb (:,:,:,:) = tsn (:,:,:,:) ! all before fields set to now values
	294	ub (:,:,:) = un (:,:,:)
	295	vb (:,:,:) = vn (:,:,:)
	296	sshb (:,:) = sshn (:,:)
[5836]	297	!
[6140]	298	IF( .NOT.ln_linssh ) THEN
[4689]	299	DO jk = 1, jpk
[6140]	300	e3t_b(:,:,jk) = e3t_n(:,:,jk)
[4689]	301	END DO
	302	ENDIF
[5836]	303	!
[3]	304	ENDIF
[508]	305	!
	306	END SUBROUTINE rst_read
[473]	307
[3]	308	!!=====================================================================
	309	END MODULE restart

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

Download in other formats: