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/branches/2019/dev_r11943_MERGE_2019/src/OCE/IOM – NEMO

Context Navigation

source: NEMO/branches/2019/dev_r11943_MERGE_2019/src/OCE/IOM/restart.F90 @ 12242

Last change on this file since 12242 was 12150, checked in by davestorkey, 5 years ago
2019/dev_r11943_MERGE_2019: Merge in UKMO_MERGE_2019.
Property svn:keywords set to `Id`
File size: 15.2 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
[11949]	29	USE diu_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
[11536]	72	nitrst = nn_stocklist( nrst_lst )
[5341]	73	ELSE
	74	nitrst = nitend
	75	ENDIF
[508]	76	ENDIF
[11536]	77
	78	IF( .NOT. ln_rst_list .AND. nn_stock == -1 ) RETURN ! we will never do any restart
[5341]	79
	80	! frequency-based restart dumping (nn_stock)
[11536]	81	IF( .NOT. ln_rst_list .AND. MOD( kt - 1, nn_stock ) == 0 ) THEN
[783]	82	! we use kt - 1 and not kt - nit000 to keep the same periodicity from the beginning of the experiment
[11536]	83	nitrst = kt + nn_stock - 1 ! define the next value of nitrst for restart writing
[783]	84	IF( nitrst > nitend ) nitrst = nitend ! make sure we write a restart at the end of the run
	85	ENDIF
	86	! to get better performances with NetCDF format:
	87	! we open and define the ocean restart file one time step before writing the data (-> at nitrst - 1)
	88	! except if we write ocean restart files every time step or if an ocean restart file was writen at nitend - 1
[11536]	89	IF( kt == nitrst - 1 .OR. nn_stock == 1 .OR. ( kt == nitend .AND. .NOT. lrst_oce ) ) THEN
[5341]	90	IF( nitrst <= nitend .AND. nitrst > 0 ) THEN
	91	! beware of the format used to write kt (default is i8.8, that should be large enough...)
	92	IF( nitrst > 999999999 ) THEN ; WRITE(clkt, * ) nitrst
	93	ELSE ; WRITE(clkt, '(i8.8)') nitrst
[611]	94	ENDIF
[5341]	95	! create the file
	96	clname = TRIM(cexper)//"_"//TRIM(ADJUSTL(clkt))//"_"//TRIM(cn_ocerst_out)
	97	clpath = TRIM(cn_ocerst_outdir)
	98	IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
	99	IF(lwp) THEN
	100	WRITE(numout,*)
[9367]	101	IF(.NOT.lwxios) THEN
[10425]	102	WRITE(numout,*) ' open ocean restart NetCDF file: ',TRIM(clpath)//TRIM(clname)
[9367]	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
[10425]	111	CALL iom_open( TRIM(clpath)//TRIM(clname), numrow, ldwrt = .TRUE. )
[9367]	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
[11949]	135	SUBROUTINE rst_write( kt, Kbb, Kmm )
[3]	136	!!---------------------------------------------------------------------
	137	!! * ROUTINE rstwrite *
	138	!!
[10425]	139	!! ** Purpose : Write restart fields in NetCDF format
[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	!!----------------------------------------------------------------------
[11949]	144	INTEGER, INTENT(in) :: kt ! ocean time-step
	145	INTEGER, INTENT(in) :: Kbb, Kmm ! ocean time level indices
[3]	146	!!----------------------------------------------------------------------
[9367]	147	IF(lwxios) CALL iom_swap( cwxios_context )
	148	CALL iom_rstput( kt, nitrst, numrow, 'rdt' , rdt , ldxios = lwxios) ! dynamics time step
[10425]	149	CALL iom_delay_rst( 'WRITE', 'OCE', numrow ) ! save only ocean delayed global communication variables
[1239]	150
[6140]	151	IF ( .NOT. ln_diurnal_only ) THEN
[11949]	152	CALL iom_rstput( kt, nitrst, numrow, 'ub' , uu(:,:,: ,Kbb), ldxios = lwxios ) ! before fields
	153	CALL iom_rstput( kt, nitrst, numrow, 'vb' , vv(:,:,: ,Kbb), ldxios = lwxios )
	154	CALL iom_rstput( kt, nitrst, numrow, 'tb' , ts(:,:,:,jp_tem,Kbb), ldxios = lwxios )
	155	CALL iom_rstput( kt, nitrst, numrow, 'sb' , ts(:,:,:,jp_sal,Kbb), ldxios = lwxios )
	156	CALL iom_rstput( kt, nitrst, numrow, 'sshb' ,ssh(:,: ,Kbb), ldxios = lwxios )
[4990]	157	!
[11949]	158	CALL iom_rstput( kt, nitrst, numrow, 'un' , uu(:,:,: ,Kmm), ldxios = lwxios ) ! now fields
	159	CALL iom_rstput( kt, nitrst, numrow, 'vn' , vv(:,:,: ,Kmm), ldxios = lwxios )
	160	CALL iom_rstput( kt, nitrst, numrow, 'tn' , ts(:,:,:,jp_tem,Kmm), ldxios = lwxios )
	161	CALL iom_rstput( kt, nitrst, numrow, 'sn' , ts(:,:,:,jp_sal,Kmm), ldxios = lwxios )
	162	CALL iom_rstput( kt, nitrst, numrow, 'sshn' ,ssh(:,: ,Kmm), ldxios = lwxios )
[9367]	163	CALL iom_rstput( kt, nitrst, numrow, 'rhop' , rhop, ldxios = lwxios )
[6140]	164	ENDIF
	165
[9367]	166	IF (ln_diurnal) CALL iom_rstput( kt, nitrst, numrow, 'Dsst', x_dsst, ldxios = lwxios )
	167	IF(lwxios) CALL iom_swap( cxios_context )
[508]	168	IF( kt == nitrst ) THEN
[9367]	169	IF(.NOT.lwxios) THEN
	170	CALL iom_close( numrow ) ! close the restart file (only at last time step)
	171	ELSE
	172	CALL iom_context_finalize( cwxios_context )
	173	ENDIF
[4990]	174	!!gm IF( .NOT. lk_trdmld ) lrst_oce = .FALSE.
	175	!!gm not sure what to do here ===>>> ask to Sebastian
	176	lrst_oce = .FALSE.
[5341]	177	IF( ln_rst_list ) THEN
[11536]	178	nrst_lst = MIN(nrst_lst + 1, SIZE(nn_stocklist,1))
	179	nitrst = nn_stocklist( nrst_lst )
[5341]	180	ENDIF
[3]	181	ENDIF
[508]	182	!
[3]	183	END SUBROUTINE rst_write
	184
[4990]	185
[4292]	186	SUBROUTINE rst_read_open
	187	!!----------------------------------------------------------------------
	188	!! * ROUTINE rst_read_open *
	189	!!
[10425]	190	!! ** Purpose : Open read files for NetCDF restart
[4292]	191	!!
	192	!! ** Method : Use a non-zero, positive value of numror to assess whether or not
	193	!! the file has already been opened
	194	!!----------------------------------------------------------------------
[5341]	195	LOGICAL :: llok
	196	CHARACTER(lc) :: clpath ! full path to ocean output restart file
[4292]	197	!!----------------------------------------------------------------------
[4990]	198	!
	199	IF( numror <= 0 ) THEN
[4292]	200	IF(lwp) THEN ! Contol prints
	201	WRITE(numout,*)
[10425]	202	WRITE(numout,*) 'rst_read : read oce NetCDF restart file'
[4292]	203	IF ( snc4set%luse ) WRITE(numout,*) 'rst_read : configured with NetCDF4 support'
	204	WRITE(numout,*) '~~~~~~~~'
	205	ENDIF
[9367]	206	lxios_sini = .FALSE.
[5341]	207	clpath = TRIM(cn_ocerst_indir)
	208	IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
[10425]	209	CALL iom_open( TRIM(clpath)//cn_ocerst_in, numror )
[9367]	210	! are we using XIOS to read the data? Part above will have to modified once XIOS
	211	! can handle checking if variable is in the restart file (there will be no need to open
	212	! restart)
	213	IF(.NOT.lxios_set) lrxios = lrxios.AND.lxios_sini
	214	IF( lrxios) THEN
	215	crxios_context = 'nemo_rst'
	216	IF( .NOT.lxios_set ) THEN
	217	IF(lwp) WRITE(numout,*) 'Enable restart reading by XIOS'
[9903]	218	CALL iom_init( crxios_context, ld_tmppatch = .false. )
[9367]	219	lxios_set = .TRUE.
	220	ENDIF
	221	ENDIF
	222	IF( TRIM(Agrif_CFixed()) /= '0' .AND. lrxios) THEN
[9903]	223	CALL iom_init( crxios_context, ld_tmppatch = .false. )
[9367]	224	IF(lwp) WRITE(numout,*) 'Enable restart reading by XIOS for AGRIF'
	225	lxios_set = .TRUE.
	226	ENDIF
[4292]	227	ENDIF
[9367]	228
[4292]	229	END SUBROUTINE rst_read_open
	230
[5836]	231
[11949]	232	SUBROUTINE rst_read( Kbb, Kmm )
[3]	233	!!----------------------------------------------------------------------
	234	!! * ROUTINE rst_read *
	235	!!
[10425]	236	!! ** Purpose : Read files for NetCDF restart
[3]	237	!!
[1531]	238	!! ** Method : Read in restart.nc file fields which are necessary for restart
[3]	239	!!----------------------------------------------------------------------
[11949]	240	INTEGER, INTENT(in) :: Kbb, Kmm ! ocean time level indices
[6140]	241	REAL(wp) :: zrdt
[4292]	242	INTEGER :: jk
[9367]	243	REAL(wp), DIMENSION(jpi, jpj, jpk) :: w3d
[3]	244	!!----------------------------------------------------------------------
	245
[4292]	246	CALL rst_read_open ! open restart for reading (if not already opened)
[3]	247
[544]	248	! Check dynamics and tracer time-step consistency and force Euler restart if changed
[746]	249	IF( iom_varid( numror, 'rdt', ldstop = .FALSE. ) > 0 ) THEN
[9367]	250	CALL iom_get( numror, 'rdt', zrdt, ldxios = lrxios )
[544]	251	IF( zrdt /= rdt ) neuler = 0
	252	ENDIF
[6140]	253
[10425]	254	CALL iom_delay_rst( 'READ', 'OCE', numror ) ! read only ocean delayed global communication variables
	255
[6140]	256	! Diurnal DSST
[9367]	257	IF( ln_diurnal ) CALL iom_get( numror, jpdom_autoglo, 'Dsst' , x_dsst, ldxios = lrxios )
[6140]	258	IF ( ln_diurnal_only ) THEN
	259	IF(lwp) WRITE( numout, * ) &
	260	& "rst_read:- ln_diurnal_only set, setting rhop=rau0"
	261	rhop = rau0
[9367]	262	CALL iom_get( numror, jpdom_autoglo, 'tn' , w3d, ldxios = lrxios )
[11949]	263	ts(:,:,1,jp_tem,Kmm) = w3d(:,:,1)
[6140]	264	RETURN
	265	ENDIF
	266
[3680]	267	IF( iom_varid( numror, 'ub', ldstop = .FALSE. ) > 0 ) THEN
[11949]	268	CALL iom_get( numror, jpdom_autoglo, 'ub' , uu(:,:,: ,Kbb), ldxios = lrxios ) ! before fields
	269	CALL iom_get( numror, jpdom_autoglo, 'vb' , vv(:,:,: ,Kbb), ldxios = lrxios )
	270	CALL iom_get( numror, jpdom_autoglo, 'tb' , ts(:,:,:,jp_tem,Kbb), ldxios = lrxios )
	271	CALL iom_get( numror, jpdom_autoglo, 'sb' , ts(:,:,:,jp_sal,Kbb), ldxios = lrxios )
	272	CALL iom_get( numror, jpdom_autoglo, 'sshb' ,ssh(:,: ,Kbb), ldxios = lrxios )
[3680]	273	ELSE
	274	neuler = 0
	275	ENDIF
	276	!
[11949]	277	CALL iom_get( numror, jpdom_autoglo, 'un' , uu(:,:,: ,Kmm), ldxios = lrxios ) ! now fields
	278	CALL iom_get( numror, jpdom_autoglo, 'vn' , vv(:,:,: ,Kmm), ldxios = lrxios )
	279	CALL iom_get( numror, jpdom_autoglo, 'tn' , ts(:,:,:,jp_tem,Kmm), ldxios = lrxios )
	280	CALL iom_get( numror, jpdom_autoglo, 'sn' , ts(:,:,:,jp_sal,Kmm), ldxios = lrxios )
	281	CALL iom_get( numror, jpdom_autoglo, 'sshn' ,ssh(:,: ,Kmm), ldxios = lrxios )
[3680]	282	IF( iom_varid( numror, 'rhop', ldstop = .FALSE. ) > 0 ) THEN
[9367]	283	CALL iom_get( numror, jpdom_autoglo, 'rhop' , rhop, ldxios = lrxios ) ! now potential density
[3680]	284	ELSE
[11949]	285	CALL eos( ts(:,:,:,:,Kmm), rhd, rhop, gdept(:,:,:,Kmm) )
[3680]	286	ENDIF
[2528]	287	!
[508]	288	IF( neuler == 0 ) THEN ! Euler restart (neuler=0)
[11949]	289	ts (:,:,:,:,Kbb) = ts (:,:,:,:,Kmm) ! all before fields set to now values
	290	uu (:,:,: ,Kbb) = uu (:,:,: ,Kmm)
	291	vv (:,:,: ,Kbb) = vv (:,:,: ,Kmm)
	292	ssh (:,: ,Kbb) = ssh (:,: ,Kmm)
[5836]	293	!
[6140]	294	IF( .NOT.ln_linssh ) THEN
[4689]	295	DO jk = 1, jpk
[11949]	296	e3t(:,:,jk,Kbb) = e3t(:,:,jk,Kmm)
[4689]	297	END DO
	298	ENDIF
[5836]	299	!
[3]	300	ENDIF
[508]	301	!
	302	END SUBROUTINE rst_read
[473]	303
[3]	304	!!=====================================================================
	305	END MODULE restart

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

Download in other formats: