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/UKMO/dev_r5518_GO6_package_landice_fw_input_option2/NEMOGCM/NEMO/OPA_SRC/IOM – NEMO

Context Navigation

source: branches/UKMO/dev_r5518_GO6_package_landice_fw_input_option2/NEMOGCM/NEMO/OPA_SRC/IOM/restart.F90 @ 7919

Last change on this file since 7919 was 7919, checked in by davestorkey, 7 years ago
Commit changes to UKMO branch to implement updated scheme for freshwater input from icesheets for coupled models.
File size: 16.5 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)
[508]	11	!!----------------------------------------------------------------------
[3]	12
	13	!!----------------------------------------------------------------------
[508]	14	!! rst_opn : open the ocean restart file
	15	!! rst_write : write the ocean restart file
	16	!! rst_read : read the ocean restart file
[3]	17	!!----------------------------------------------------------------------
[2528]	18	USE oce ! ocean dynamics and tracers
[3]	19	USE dom_oce ! ocean space and time domain
	20	USE phycst ! physical constants
[508]	21	USE in_out_manager ! I/O manager
	22	USE iom ! I/O module
[6491]	23	USE ioipsl, ONLY : ju2ymds ! for calendar
[544]	24	USE eosbn2 ! equation of state (eos bn2 routine)
[4990]	25	USE trdmxl_oce ! ocean active mixed layer tracers trends variables
[3680]	26	USE divcur ! hor. divergence and curl (div & cur routines)
[6488]	27	USE sbc_oce ! for icesheet freshwater input variables
[3]	28
	29	IMPLICIT NONE
	30	PRIVATE
	31
[4292]	32	PUBLIC rst_opn ! routine called by step module
	33	PUBLIC rst_write ! routine called by step module
	34	PUBLIC rst_read ! routine called by istate module
	35	PUBLIC rst_read_open ! routine called in rst_read and (possibly) in dom_vvl_init
[3]	36
[508]	37	!! * Substitutions
[2528]	38	# include "domzgr_substitute.h90"
[508]	39	# include "vectopt_loop_substitute.h90"
[3]	40	!!----------------------------------------------------------------------
[2528]	41	!! NEMO/OPA 3.3 , NEMO Consortium (2010)
[888]	42	!! $Id$
[2528]	43	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
[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
[6491]	58	INTEGER :: iyear, imonth, iday
	59	REAL (wp) :: zsec
[6755]	60	REAL (wp) :: zfjulday
[508]	61	!!
	62	CHARACTER(LEN=20) :: clkt ! ocean time-step deine as a character
[5341]	63	CHARACTER(LEN=50) :: clname ! ocean output restart file name
[6491]	64	CHARACTER(LEN=150) :: clpath ! full path to ocean output restart file
[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
[6491]	88	IF ( ln_rstdate ) THEN
[6755]	89	zfjulday = fjulday + rdttra(1) / rday
	90	IF( ABS(zfjulday - REAL(NINT(zfjulday),wp)) < 0.1 / rday ) zfjulday = REAL(NINT(zfjulday),wp) ! avoid truncation error
	91	CALL ju2ymds( zfjulday, iyear, imonth, iday, zsec )
[6491]	92	WRITE(clkt, '(i4.4,2i2.2)') iyear, imonth, iday
	93	ELSE
	94	! beware of the format used to write kt (default is i8.8, that should be large enough...)
	95	IF( nitrst > 999999999 ) THEN ; WRITE(clkt, * ) nitrst
	96	ELSE ; WRITE(clkt, '(i8.8)') nitrst
	97	ENDIF
[611]	98	ENDIF
[5341]	99	! create the file
	100	clname = TRIM(cexper)//"_"//TRIM(ADJUSTL(clkt))//"_"//TRIM(cn_ocerst_out)
	101	clpath = TRIM(cn_ocerst_outdir)
	102	IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
	103	IF(lwp) THEN
	104	WRITE(numout,*)
	105	SELECT CASE ( jprstlib )
	106	CASE ( jprstdimg ) ; WRITE(numout,*) &
	107	' open ocean restart binary file: ',TRIM(clpath)//clname
	108	CASE DEFAULT ; WRITE(numout,*) &
	109	' open ocean restart NetCDF file: ',TRIM(clpath)//clname
	110	END SELECT
	111	IF ( snc4set%luse ) WRITE(numout,*) ' opened for NetCDF4 chunking and compression'
	112	IF( kt == nitrst - 1 ) THEN ; WRITE(numout,*) ' kt = nitrst - 1 = ', kt
	113	ELSE ; WRITE(numout,*) ' kt = ' , kt
	114	ENDIF
	115	ENDIF
	116	!
	117	CALL iom_open( TRIM(clpath)//TRIM(clname), numrow, ldwrt = .TRUE., kiolib = jprstlib )
	118	lrst_oce = .TRUE.
[611]	119	ENDIF
[508]	120	ENDIF
	121	!
	122	END SUBROUTINE rst_opn
	123
	124
[3]	125	SUBROUTINE rst_write( kt )
	126	!!---------------------------------------------------------------------
	127	!! * ROUTINE rstwrite *
	128	!!
[632]	129	!! ** Purpose : Write restart fields in the format corresponding to jprstlib
[3]	130	!!
[508]	131	!! ** Method : Write in numrow when kt == nitrst in NetCDF
[2528]	132	!! file, save fields which are necessary for restart
[3]	133	!!----------------------------------------------------------------------
[508]	134	INTEGER, INTENT(in) :: kt ! ocean time-step
[3]	135	!!----------------------------------------------------------------------
[1239]	136
[2528]	137	CALL iom_rstput( kt, nitrst, numrow, 'rdt' , rdt ) ! dynamics time step
	138	CALL iom_rstput( kt, nitrst, numrow, 'rdttra1', rdttra(1) ) ! surface tracer time step
[3]	139
[2528]	140	CALL iom_rstput( kt, nitrst, numrow, 'ub' , ub ) ! before fields
	141	CALL iom_rstput( kt, nitrst, numrow, 'vb' , vb )
[3294]	142	CALL iom_rstput( kt, nitrst, numrow, 'tb' , tsb(:,:,:,jp_tem) )
	143	CALL iom_rstput( kt, nitrst, numrow, 'sb' , tsb(:,:,:,jp_sal) )
[2528]	144	CALL iom_rstput( kt, nitrst, numrow, 'rotb' , rotb )
	145	CALL iom_rstput( kt, nitrst, numrow, 'hdivb' , hdivb )
	146	CALL iom_rstput( kt, nitrst, numrow, 'sshb' , sshb )
[4990]	147	!
[2528]	148	CALL iom_rstput( kt, nitrst, numrow, 'un' , un ) ! now fields
	149	CALL iom_rstput( kt, nitrst, numrow, 'vn' , vn )
[3294]	150	CALL iom_rstput( kt, nitrst, numrow, 'tn' , tsn(:,:,:,jp_tem) )
	151	CALL iom_rstput( kt, nitrst, numrow, 'sn' , tsn(:,:,:,jp_sal) )
[2528]	152	CALL iom_rstput( kt, nitrst, numrow, 'rotn' , rotn )
	153	CALL iom_rstput( kt, nitrst, numrow, 'hdivn' , hdivn )
	154	CALL iom_rstput( kt, nitrst, numrow, 'sshn' , sshn )
	155	CALL iom_rstput( kt, nitrst, numrow, 'rhop' , rhop )
[1545]	156	#if defined key_zdfkpp
[2528]	157	CALL iom_rstput( kt, nitrst, numrow, 'rhd' , rhd )
[1483]	158	#endif
[6488]	159	IF( lk_oasis) THEN
[7919]	160	! nn_coupled_iceshelf_fluxes uninitialised unless lk_oasis=true
	161	IF( nn_coupled_iceshelf_fluxes .eq. 1 ) THEN
[6488]	162	CALL iom_rstput( kt, nitrst, numrow, 'greenland_icesheet_mass', greenland_icesheet_mass )
	163	CALL iom_rstput( kt, nitrst, numrow, 'greenland_icesheet_timelapsed', greenland_icesheet_timelapsed )
	164	CALL iom_rstput( kt, nitrst, numrow, 'greenland_icesheet_mass_roc', greenland_icesheet_mass_rate_of_change )
	165	CALL iom_rstput( kt, nitrst, numrow, 'antarctica_icesheet_mass', antarctica_icesheet_mass )
	166	CALL iom_rstput( kt, nitrst, numrow, 'antarctica_icesheet_timelapsed', antarctica_icesheet_timelapsed )
	167	CALL iom_rstput( kt, nitrst, numrow, 'antarctica_icesheet_mass_roc', antarctica_icesheet_mass_rate_of_change )
	168	ENDIF
	169	ENDIF
	170
[508]	171	IF( kt == nitrst ) THEN
	172	CALL iom_close( numrow ) ! close the restart file (only at last time step)
[4990]	173	!!gm IF( .NOT. lk_trdmld ) lrst_oce = .FALSE.
	174	!!gm not sure what to do here ===>>> ask to Sebastian
	175	lrst_oce = .FALSE.
[5341]	176	IF( ln_rst_list ) THEN
	177	nrst_lst = MIN(nrst_lst + 1, SIZE(nstocklist,1))
	178	nitrst = nstocklist( nrst_lst )
	179	ENDIF
	180	lrst_oce = .FALSE.
[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	!!
	190	!! ** Purpose : Open read files for restart (format fixed by jprstlib )
	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	INTEGER :: jlibalt = jprstlib
	196	LOGICAL :: llok
	197	CHARACTER(lc) :: clpath ! full path to ocean output restart file
[4292]	198	!!----------------------------------------------------------------------
[4990]	199	!
	200	IF( numror <= 0 ) THEN
[4292]	201	IF(lwp) THEN ! Contol prints
	202	WRITE(numout,*)
	203	SELECT CASE ( jprstlib )
	204	CASE ( jpnf90 ) ; WRITE(numout,*) 'rst_read : read oce NetCDF restart file'
	205	CASE ( jprstdimg ) ; WRITE(numout,*) 'rst_read : read oce binary restart file'
	206	END SELECT
	207	IF ( snc4set%luse ) WRITE(numout,*) 'rst_read : configured with NetCDF4 support'
	208	WRITE(numout,*) '~~~~~~~~'
	209	ENDIF
	210
[5341]	211	clpath = TRIM(cn_ocerst_indir)
	212	IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
[4292]	213	IF ( jprstlib == jprstdimg ) THEN
	214	! eventually read netcdf file (monobloc) for restarting on different number of processors
	215	! if {cn_ocerst_in}.nc exists, then set jlibalt to jpnf90
[5341]	216	INQUIRE( FILE = TRIM(cn_ocerst_indir)//'/'//TRIM(cn_ocerst_in)//'.nc', EXIST = llok )
[4292]	217	IF ( llok ) THEN ; jlibalt = jpnf90 ; ELSE ; jlibalt = jprstlib ; ENDIF
	218	ENDIF
[5341]	219	CALL iom_open( TRIM(clpath)//cn_ocerst_in, numror, kiolib = jlibalt )
[4292]	220	ENDIF
	221	END SUBROUTINE rst_read_open
	222
[3]	223	SUBROUTINE rst_read
	224	!!----------------------------------------------------------------------
	225	!! * ROUTINE rst_read *
	226	!!
[632]	227	!! ** Purpose : Read files for restart (format fixed by jprstlib )
[3]	228	!!
[1531]	229	!! ** Method : Read in restart.nc file fields which are necessary for restart
[3]	230	!!----------------------------------------------------------------------
[1130]	231	REAL(wp) :: zrdt, zrdttra1
[4292]	232	INTEGER :: jk
[1473]	233	LOGICAL :: llok
[3]	234	!!----------------------------------------------------------------------
	235
[4292]	236	CALL rst_read_open ! open restart for reading (if not already opened)
[3]	237
[544]	238	! Check dynamics and tracer time-step consistency and force Euler restart if changed
[746]	239	IF( iom_varid( numror, 'rdt', ldstop = .FALSE. ) > 0 ) THEN
[544]	240	CALL iom_get( numror, 'rdt', zrdt )
	241	IF( zrdt /= rdt ) neuler = 0
	242	ENDIF
[746]	243	IF( iom_varid( numror, 'rdttra1', ldstop = .FALSE. ) > 0 ) THEN
[544]	244	CALL iom_get( numror, 'rdttra1', zrdttra1 )
	245	IF( zrdttra1 /= rdttra(1) ) neuler = 0
	246	ENDIF
[1607]	247	!
[3680]	248	IF( iom_varid( numror, 'ub', ldstop = .FALSE. ) > 0 ) THEN
	249	CALL iom_get( numror, jpdom_autoglo, 'ub' , ub ) ! before fields
	250	CALL iom_get( numror, jpdom_autoglo, 'vb' , vb )
	251	CALL iom_get( numror, jpdom_autoglo, 'tb' , tsb(:,:,:,jp_tem) )
	252	CALL iom_get( numror, jpdom_autoglo, 'sb' , tsb(:,:,:,jp_sal) )
	253	CALL iom_get( numror, jpdom_autoglo, 'rotb' , rotb )
	254	CALL iom_get( numror, jpdom_autoglo, 'hdivb' , hdivb )
	255	CALL iom_get( numror, jpdom_autoglo, 'sshb' , sshb )
	256	ELSE
	257	neuler = 0
	258	ENDIF
	259	!
	260	CALL iom_get( numror, jpdom_autoglo, 'un' , un ) ! now fields
	261	CALL iom_get( numror, jpdom_autoglo, 'vn' , vn )
	262	CALL iom_get( numror, jpdom_autoglo, 'tn' , tsn(:,:,:,jp_tem) )
	263	CALL iom_get( numror, jpdom_autoglo, 'sn' , tsn(:,:,:,jp_sal) )
	264	CALL iom_get( numror, jpdom_autoglo, 'sshn' , sshn )
	265	IF( iom_varid( numror, 'rotn', ldstop = .FALSE. ) > 0 ) THEN
	266	CALL iom_get( numror, jpdom_autoglo, 'rotn' , rotn )
	267	CALL iom_get( numror, jpdom_autoglo, 'hdivn' , hdivn )
	268	ELSE
	269	CALL div_cur( 0 ) ! Horizontal divergence & Relative vorticity
	270	ENDIF
	271	IF( iom_varid( numror, 'rhop', ldstop = .FALSE. ) > 0 ) THEN
	272	CALL iom_get( numror, jpdom_autoglo, 'rhop' , rhop ) ! now potential density
	273	ELSE
[4313]	274	CALL eos ( tsn, rhd, rhop, fsdept_n(:,:,:) )
[3680]	275	ENDIF
[1545]	276	#if defined key_zdfkpp
	277	IF( iom_varid( numror, 'rhd', ldstop = .FALSE. ) > 0 ) THEN
[3680]	278	CALL iom_get( numror, jpdom_autoglo, 'rhd' , rhd ) ! now in situ density anomaly
[1545]	279	ELSE
[4313]	280	CALL eos( tsn, rhd, fsdept_n(:,:,:) ) ! compute rhd
[1545]	281	ENDIF
[1483]	282	#endif
[2528]	283	!
[6488]	284	IF( iom_varid( numror, 'greenland_icesheet_mass', ldstop = .FALSE. ) > 0 ) THEN
	285	CALL iom_get( numror, 'greenland_icesheet_mass', greenland_icesheet_mass )
	286	CALL iom_get( numror, 'greenland_icesheet_timelapsed', greenland_icesheet_timelapsed )
	287	CALL iom_get( numror, 'greenland_icesheet_mass_roc', greenland_icesheet_mass_rate_of_change )
	288	ELSE
	289	greenland_icesheet_mass = 0.0
	290	greenland_icesheet_mass_rate_of_change = 0.0
	291	greenland_icesheet_timelapsed = 0.0
	292	ENDIF
	293	IF( iom_varid( numror, 'antarctica_icesheet_mass', ldstop = .FALSE. ) > 0 ) THEN
	294	CALL iom_get( numror, 'antarctica_icesheet_mass', antarctica_icesheet_mass )
	295	CALL iom_get( numror, 'antarctica_icesheet_timelapsed', antarctica_icesheet_timelapsed )
	296	CALL iom_get( numror, 'antarctica_icesheet_mass_roc', antarctica_icesheet_mass_rate_of_change )
	297	ELSE
	298	antarctica_icesheet_mass = 0.0
	299	antarctica_icesheet_mass_rate_of_change = 0.0
	300	antarctica_icesheet_timelapsed = 0.0
	301	ENDIF
	302
[508]	303	IF( neuler == 0 ) THEN ! Euler restart (neuler=0)
[3294]	304	tsb (:,:,:,:) = tsn (:,:,:,:) ! all before fields set to now values
	305	ub (:,:,:) = un (:,:,:)
	306	vb (:,:,:) = vn (:,:,:)
	307	rotb (:,:,:) = rotn (:,:,:)
	308	hdivb(:,:,:) = hdivn(:,:,:)
	309	sshb (:,:) = sshn (:,:)
[4990]	310
	311	IF( lk_vvl ) THEN
[4689]	312	DO jk = 1, jpk
	313	fse3t_b(:,:,jk) = fse3t_n(:,:,jk)
	314	END DO
	315	ENDIF
[4990]	316
[3]	317	ENDIF
[508]	318	!
	319	END SUBROUTINE rst_read
[473]	320
[3]	321	!!=====================================================================
	322	END MODULE restart

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

Download in other formats: