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 @ 13286

Last change on this file since 13286 was 13286, checked in by smasson, 4 years ago
trunk: merge extra halos branch in trunk, see #2366
Property svn:keywords set to `Id`
File size: 15.3 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
[12377]	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
	40	!!----------------------------------------------------------------------
[9598]	41	!! NEMO/OCE 4.0 , NEMO Consortium (2018)
[888]	42	!! $Id$
[10068]	43	!! Software governed by the CeCILL license (see ./LICENSE)
[359]	44	!!----------------------------------------------------------------------
[3]	45	CONTAINS
	46
[508]	47	SUBROUTINE rst_opn( kt )
	48	!!---------------------------------------------------------------------
	49	!! * ROUTINE rst_opn *
	50	!!
	51	!! ** Purpose : + initialization (should be read in the namelist) of nitrst
	52	!! + open the restart when we are one time step before nitrst
	53	!! - restart header is defined when kt = nitrst-1
	54	!! - restart data are written when kt = nitrst
	55	!! + define lrst_oce to .TRUE. when we need to define or write the restart
	56	!!----------------------------------------------------------------------
	57	INTEGER, INTENT(in) :: kt ! ocean time-step
	58	!!
	59	CHARACTER(LEN=20) :: clkt ! ocean time-step deine as a character
[5341]	60	CHARACTER(LEN=50) :: clname ! ocean output restart file name
	61	CHARACTER(lc) :: clpath ! full path to ocean output restart file
[9367]	62	CHARACTER(LEN=52) :: clpname ! ocean output restart file name including prefix for AGRIF
[9535]	63	CHARACTER(LEN=256) :: clinfo ! info character
[508]	64	!!----------------------------------------------------------------------
	65	!
[783]	66	IF( kt == nit000 ) THEN ! default definitions
	67	lrst_oce = .FALSE.
[5341]	68	IF( ln_rst_list ) THEN
	69	nrst_lst = 1
[11536]	70	nitrst = nn_stocklist( nrst_lst )
[5341]	71	ELSE
	72	nitrst = nitend
	73	ENDIF
[508]	74	ENDIF
[11536]	75
	76	IF( .NOT. ln_rst_list .AND. nn_stock == -1 ) RETURN ! we will never do any restart
[5341]	77
	78	! frequency-based restart dumping (nn_stock)
[11536]	79	IF( .NOT. ln_rst_list .AND. MOD( kt - 1, nn_stock ) == 0 ) THEN
[783]	80	! we use kt - 1 and not kt - nit000 to keep the same periodicity from the beginning of the experiment
[11536]	81	nitrst = kt + nn_stock - 1 ! define the next value of nitrst for restart writing
[783]	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
[11536]	87	IF( kt == nitrst - 1 .OR. nn_stock == 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
[12377]	133	SUBROUTINE rst_write( kt, Kbb, Kmm )
[3]	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	!!----------------------------------------------------------------------
[12377]	142	INTEGER, INTENT(in) :: kt ! ocean time-step
	143	INTEGER, INTENT(in) :: Kbb, Kmm ! ocean time level indices
[3]	144	!!----------------------------------------------------------------------
[9367]	145	IF(lwxios) CALL iom_swap( cwxios_context )
[12489]	146	CALL iom_rstput( kt, nitrst, numrow, 'rdt' , rn_Dt , ldxios = lwxios) ! dynamics time step
[10425]	147	CALL iom_delay_rst( 'WRITE', 'OCE', numrow ) ! save only ocean delayed global communication variables
[1239]	148
[6140]	149	IF ( .NOT. ln_diurnal_only ) THEN
[12377]	150	CALL iom_rstput( kt, nitrst, numrow, 'ub' , uu(:,:,: ,Kbb), ldxios = lwxios ) ! before fields
	151	CALL iom_rstput( kt, nitrst, numrow, 'vb' , vv(:,:,: ,Kbb), ldxios = lwxios )
	152	CALL iom_rstput( kt, nitrst, numrow, 'tb' , ts(:,:,:,jp_tem,Kbb), ldxios = lwxios )
	153	CALL iom_rstput( kt, nitrst, numrow, 'sb' , ts(:,:,:,jp_sal,Kbb), ldxios = lwxios )
	154	CALL iom_rstput( kt, nitrst, numrow, 'sshb' ,ssh(:,: ,Kbb), ldxios = lwxios )
[4990]	155	!
[12377]	156	CALL iom_rstput( kt, nitrst, numrow, 'un' , uu(:,:,: ,Kmm), ldxios = lwxios ) ! now fields
	157	CALL iom_rstput( kt, nitrst, numrow, 'vn' , vv(:,:,: ,Kmm), ldxios = lwxios )
	158	CALL iom_rstput( kt, nitrst, numrow, 'tn' , ts(:,:,:,jp_tem,Kmm), ldxios = lwxios )
	159	CALL iom_rstput( kt, nitrst, numrow, 'sn' , ts(:,:,:,jp_sal,Kmm), ldxios = lwxios )
	160	CALL iom_rstput( kt, nitrst, numrow, 'sshn' ,ssh(:,: ,Kmm), ldxios = lwxios )
[9367]	161	CALL iom_rstput( kt, nitrst, numrow, 'rhop' , rhop, ldxios = lwxios )
[6140]	162	ENDIF
	163
[9367]	164	IF (ln_diurnal) CALL iom_rstput( kt, nitrst, numrow, 'Dsst', x_dsst, ldxios = lwxios )
	165	IF(lwxios) CALL iom_swap( cxios_context )
[508]	166	IF( kt == nitrst ) THEN
[9367]	167	IF(.NOT.lwxios) THEN
	168	CALL iom_close( numrow ) ! close the restart file (only at last time step)
	169	ELSE
	170	CALL iom_context_finalize( cwxios_context )
	171	ENDIF
[4990]	172	!!gm IF( .NOT. lk_trdmld ) lrst_oce = .FALSE.
	173	!!gm not sure what to do here ===>>> ask to Sebastian
	174	lrst_oce = .FALSE.
[5341]	175	IF( ln_rst_list ) THEN
[11536]	176	nrst_lst = MIN(nrst_lst + 1, SIZE(nn_stocklist,1))
	177	nitrst = nn_stocklist( nrst_lst )
[5341]	178	ENDIF
[3]	179	ENDIF
[508]	180	!
[3]	181	END SUBROUTINE rst_write
	182
[4990]	183
[4292]	184	SUBROUTINE rst_read_open
	185	!!----------------------------------------------------------------------
	186	!! * ROUTINE rst_read_open *
	187	!!
[10425]	188	!! ** Purpose : Open read files for NetCDF restart
[4292]	189	!!
	190	!! ** Method : Use a non-zero, positive value of numror to assess whether or not
	191	!! the file has already been opened
	192	!!----------------------------------------------------------------------
[5341]	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,*)
[10425]	200	WRITE(numout,*) 'rst_read : read oce NetCDF restart file'
[4292]	201	IF ( snc4set%luse ) WRITE(numout,*) 'rst_read : configured with NetCDF4 support'
	202	WRITE(numout,*) '~~~~~~~~'
	203	ENDIF
[9367]	204	lxios_sini = .FALSE.
[5341]	205	clpath = TRIM(cn_ocerst_indir)
	206	IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
[10425]	207	CALL iom_open( TRIM(clpath)//cn_ocerst_in, numror )
[9367]	208	! are we using XIOS to read the data? Part above will have to modified once XIOS
	209	! can handle checking if variable is in the restart file (there will be no need to open
	210	! restart)
	211	IF(.NOT.lxios_set) lrxios = lrxios.AND.lxios_sini
	212	IF( lrxios) THEN
	213	crxios_context = 'nemo_rst'
	214	IF( .NOT.lxios_set ) THEN
	215	IF(lwp) WRITE(numout,*) 'Enable restart reading by XIOS'
[13286]	216	CALL iom_init( crxios_context )
[9367]	217	lxios_set = .TRUE.
	218	ENDIF
	219	ENDIF
	220	IF( TRIM(Agrif_CFixed()) /= '0' .AND. lrxios) THEN
[13286]	221	CALL iom_init( crxios_context )
[9367]	222	IF(lwp) WRITE(numout,*) 'Enable restart reading by XIOS for AGRIF'
	223	lxios_set = .TRUE.
	224	ENDIF
[4292]	225	ENDIF
[9367]	226
[4292]	227	END SUBROUTINE rst_read_open
	228
[5836]	229
[12377]	230	SUBROUTINE rst_read( Kbb, Kmm )
[3]	231	!!----------------------------------------------------------------------
	232	!! * ROUTINE rst_read *
	233	!!
[10425]	234	!! ** Purpose : Read files for NetCDF restart
[3]	235	!!
[1531]	236	!! ** Method : Read in restart.nc file fields which are necessary for restart
[3]	237	!!----------------------------------------------------------------------
[12377]	238	INTEGER, INTENT(in) :: Kbb, Kmm ! ocean time level indices
[6140]	239	REAL(wp) :: zrdt
[4292]	240	INTEGER :: jk
[9367]	241	REAL(wp), DIMENSION(jpi, jpj, jpk) :: w3d
[3]	242	!!----------------------------------------------------------------------
	243
[4292]	244	CALL rst_read_open ! open restart for reading (if not already opened)
[3]	245
[544]	246	! Check dynamics and tracer time-step consistency and force Euler restart if changed
[746]	247	IF( iom_varid( numror, 'rdt', ldstop = .FALSE. ) > 0 ) THEN
[9367]	248	CALL iom_get( numror, 'rdt', zrdt, ldxios = lrxios )
[12489]	249	IF( zrdt /= rn_Dt ) THEN
	250	IF(lwp) WRITE( numout,*)
	251	IF(lwp) WRITE( numout,*) 'rst_read: rdt not equal to the read one'
	252	IF(lwp) WRITE( numout,*)
	253	IF(lwp) WRITE( numout,*) ' ==>>> forced euler first time-step'
	254	l_1st_euler = .TRUE.
	255	ENDIF
[544]	256	ENDIF
[6140]	257
[10425]	258	CALL iom_delay_rst( 'READ', 'OCE', numror ) ! read only ocean delayed global communication variables
	259
[6140]	260	! Diurnal DSST
[13286]	261	IF( ln_diurnal ) CALL iom_get( numror, jpdom_auto, 'Dsst' , x_dsst, ldxios = lrxios )
[6140]	262	IF ( ln_diurnal_only ) THEN
	263	IF(lwp) WRITE( numout, * ) &
[12489]	264	& "rst_read:- ln_diurnal_only set, setting rhop=rho0"
	265	rhop = rho0
[13286]	266	CALL iom_get( numror, jpdom_auto, 'tn' , w3d, ldxios = lrxios )
[12377]	267	ts(:,:,1,jp_tem,Kmm) = w3d(:,:,1)
[6140]	268	RETURN
	269	ENDIF
	270
[3680]	271	IF( iom_varid( numror, 'ub', ldstop = .FALSE. ) > 0 ) THEN
[13286]	272	! before fields
	273	CALL iom_get( numror, jpdom_auto, 'ub' , uu(:,:,: ,Kbb), ldxios = lrxios, cd_type = 'U', psgn = -1._wp )
	274	CALL iom_get( numror, jpdom_auto, 'vb' , vv(:,:,: ,Kbb), ldxios = lrxios, cd_type = 'V', psgn = -1._wp )
	275	CALL iom_get( numror, jpdom_auto, 'tb' , ts(:,:,:,jp_tem,Kbb), ldxios = lrxios )
	276	CALL iom_get( numror, jpdom_auto, 'sb' , ts(:,:,:,jp_sal,Kbb), ldxios = lrxios )
	277	CALL iom_get( numror, jpdom_auto, 'sshb' ,ssh(:,: ,Kbb), ldxios = lrxios )
[3680]	278	ELSE
[12489]	279	l_1st_euler = .TRUE. ! before field not found, forced euler 1st time-step
[3680]	280	ENDIF
	281	!
[13286]	282	! now fields
	283	CALL iom_get( numror, jpdom_auto, 'un' , uu(:,:,: ,Kmm), ldxios = lrxios, cd_type = 'U', psgn = -1._wp )
	284	CALL iom_get( numror, jpdom_auto, 'vn' , vv(:,:,: ,Kmm), ldxios = lrxios, cd_type = 'V', psgn = -1._wp )
	285	CALL iom_get( numror, jpdom_auto, 'tn' , ts(:,:,:,jp_tem,Kmm), ldxios = lrxios )
	286	CALL iom_get( numror, jpdom_auto, 'sn' , ts(:,:,:,jp_sal,Kmm), ldxios = lrxios )
	287	CALL iom_get( numror, jpdom_auto, 'sshn' ,ssh(:,: ,Kmm), ldxios = lrxios )
[3680]	288	IF( iom_varid( numror, 'rhop', ldstop = .FALSE. ) > 0 ) THEN
[13286]	289	CALL iom_get( numror, jpdom_auto, 'rhop' , rhop, ldxios = lrxios ) ! now potential density
[3680]	290	ELSE
[12377]	291	CALL eos( ts(:,:,:,:,Kmm), rhd, rhop, gdept(:,:,:,Kmm) )
[3680]	292	ENDIF
[2528]	293	!
[12489]	294	IF( l_1st_euler ) THEN ! Euler restart
[12377]	295	ts (:,:,:,:,Kbb) = ts (:,:,:,:,Kmm) ! all before fields set to now values
	296	uu (:,:,: ,Kbb) = uu (:,:,: ,Kmm)
	297	vv (:,:,: ,Kbb) = vv (:,:,: ,Kmm)
	298	ssh (:,: ,Kbb) = ssh (:,: ,Kmm)
[3]	299	ENDIF
[508]	300	!
	301	END SUBROUTINE rst_read
[473]	302
[3]	303	!!=====================================================================
	304	END MODULE restart

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

Download in other formats: