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/2014/dev_r4650_UKMO11_restart_functionality/NEMOGCM/NEMO/OPA_SRC/IOM – NEMO

Context Navigation

source: branches/2014/dev_r4650_UKMO11_restart_functionality/NEMOGCM/NEMO/OPA_SRC/IOM/restart.F90 @ 5312

Last change on this file since 5312 was 5312, checked in by timgraham, 9 years ago
Reset svn:keywords Id property
Property svn:keywords set to `Id`
File size: 14.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)
[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
[544]	23	USE eosbn2 ! equation of state (eos bn2 routine)
[5208]	24	USE trdmxl_oce ! ocean active mixed layer tracers trends variables
[3680]	25	USE divcur ! hor. divergence and curl (div & cur routines)
[4206]	26	USE sbc_ice, ONLY : lk_lim3
[3]	27
	28	IMPLICIT NONE
	29	PRIVATE
	30
[4292]	31	PUBLIC rst_opn ! routine called by step module
	32	PUBLIC rst_write ! routine called by step module
	33	PUBLIC rst_read ! routine called by istate module
	34	PUBLIC rst_read_open ! routine called in rst_read and (possibly) in dom_vvl_init
[3]	35
[508]	36	!! * Substitutions
[2528]	37	# include "domzgr_substitute.h90"
[508]	38	# include "vectopt_loop_substitute.h90"
[3]	39	!!----------------------------------------------------------------------
[2528]	40	!! NEMO/OPA 3.3 , NEMO Consortium (2010)
[5235]	41	!! $Id$
[2528]	42	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
[359]	43	!!----------------------------------------------------------------------
[3]	44	CONTAINS
	45
[508]	46	SUBROUTINE rst_opn( kt )
	47	!!---------------------------------------------------------------------
	48	!! * ROUTINE rst_opn *
	49	!!
	50	!! ** Purpose : + initialization (should be read in the namelist) of nitrst
	51	!! + open the restart when we are one time step before nitrst
	52	!! - restart header is defined when kt = nitrst-1
	53	!! - restart data are written when kt = nitrst
	54	!! + define lrst_oce to .TRUE. when we need to define or write the restart
	55	!!----------------------------------------------------------------------
	56	INTEGER, INTENT(in) :: kt ! ocean time-step
	57	!!
	58	CHARACTER(LEN=20) :: clkt ! ocean time-step deine as a character
[4775]	59	CHARACTER(LEN=50) :: clname ! ocean output restart file name
	60	CHARACTER(len=150) :: clpath ! full path to ocean output restart file
[508]	61	!!----------------------------------------------------------------------
	62	!
[783]	63	IF( kt == nit000 ) THEN ! default definitions
	64	lrst_oce = .FALSE.
[4780]	65	IF( ln_rst_list ) THEN
	66	nrst_lst = 1
	67	nitrst = nstocklist( nrst_lst )
	68	ELSE
	69	nitrst = nitend
	70	ENDIF
[508]	71	ENDIF
[4780]	72
	73	! frequency-based restart dumping (nn_stock)
	74	IF( .NOT. ln_rst_list .AND. MOD( kt - 1, nstock ) == 0 ) THEN
[783]	75	! we use kt - 1 and not kt - nit000 to keep the same periodicity from the beginning of the experiment
	76	nitrst = kt + nstock - 1 ! define the next value of nitrst for restart writing
	77	IF( nitrst > nitend ) nitrst = nitend ! make sure we write a restart at the end of the run
	78	ENDIF
	79	! to get better performances with NetCDF format:
	80	! we open and define the ocean restart file one time step before writing the data (-> at nitrst - 1)
	81	! except if we write ocean restart files every time step or if an ocean restart file was writen at nitend - 1
	82	IF( kt == nitrst - 1 .OR. nstock == 1 .OR. ( kt == nitend .AND. .NOT. lrst_oce ) ) THEN
[4780]	83	IF( nitrst <= nitend .AND. nitrst > 0 ) THEN
	84	! beware of the format used to write kt (default is i8.8, that should be large enough...)
	85	IF( nitrst > 999999999 ) THEN ; WRITE(clkt, * ) nitrst
	86	ELSE ; WRITE(clkt, '(i8.8)') nitrst
[611]	87	ENDIF
[4780]	88	! create the file
	89	clname = TRIM(cexper)//"_"//TRIM(ADJUSTL(clkt))//"_"//TRIM(cn_ocerst_out)
	90	clpath = TRIM(cn_ocerst_outdir)
	91	IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
	92	IF(lwp) THEN
	93	WRITE(numout,*)
	94	SELECT CASE ( jprstlib )
	95	CASE ( jprstdimg ) ; WRITE(numout,*) &
	96	' open ocean restart binary file: ',TRIM(clpath)//clname
	97	CASE DEFAULT ; WRITE(numout,*) &
	98	' open ocean restart NetCDF file: ',TRIM(clpath)//clname
	99	END SELECT
	100	IF ( snc4set%luse ) WRITE(numout,*) ' opened for NetCDF4 chunking and compression'
	101	IF( kt == nitrst - 1 ) THEN ; WRITE(numout,*) ' kt = nitrst - 1 = ', kt
	102	ELSE ; WRITE(numout,*) ' kt = ' , kt
	103	ENDIF
	104	ENDIF
	105	!
	106	CALL iom_open( TRIM(clpath)//TRIM(clname), numrow, ldwrt = .TRUE., kiolib = jprstlib )
	107	lrst_oce = .TRUE.
[611]	108	ENDIF
[508]	109	ENDIF
	110	!
	111	END SUBROUTINE rst_opn
	112
	113
[3]	114	SUBROUTINE rst_write( kt )
	115	!!---------------------------------------------------------------------
	116	!! * ROUTINE rstwrite *
	117	!!
[632]	118	!! ** Purpose : Write restart fields in the format corresponding to jprstlib
[3]	119	!!
[508]	120	!! ** Method : Write in numrow when kt == nitrst in NetCDF
[2528]	121	!! file, save fields which are necessary for restart
[3]	122	!!----------------------------------------------------------------------
[508]	123	INTEGER, INTENT(in) :: kt ! ocean time-step
[3]	124	!!----------------------------------------------------------------------
[1239]	125
[2528]	126	CALL iom_rstput( kt, nitrst, numrow, 'rdt' , rdt ) ! dynamics time step
	127	CALL iom_rstput( kt, nitrst, numrow, 'rdttra1', rdttra(1) ) ! surface tracer time step
[3]	128
[2528]	129	CALL iom_rstput( kt, nitrst, numrow, 'ub' , ub ) ! before fields
	130	CALL iom_rstput( kt, nitrst, numrow, 'vb' , vb )
[3294]	131	CALL iom_rstput( kt, nitrst, numrow, 'tb' , tsb(:,:,:,jp_tem) )
	132	CALL iom_rstput( kt, nitrst, numrow, 'sb' , tsb(:,:,:,jp_sal) )
[2528]	133	CALL iom_rstput( kt, nitrst, numrow, 'rotb' , rotb )
	134	CALL iom_rstput( kt, nitrst, numrow, 'hdivb' , hdivb )
	135	CALL iom_rstput( kt, nitrst, numrow, 'sshb' , sshb )
[5208]	136	!
[4693]	137	IF( lk_lim3 ) CALL iom_rstput( kt, nitrst, numrow, 'fse3t_b', fse3t_b(:,:,:) )
[2528]	138	!
	139	CALL iom_rstput( kt, nitrst, numrow, 'un' , un ) ! now fields
	140	CALL iom_rstput( kt, nitrst, numrow, 'vn' , vn )
[3294]	141	CALL iom_rstput( kt, nitrst, numrow, 'tn' , tsn(:,:,:,jp_tem) )
	142	CALL iom_rstput( kt, nitrst, numrow, 'sn' , tsn(:,:,:,jp_sal) )
[2528]	143	CALL iom_rstput( kt, nitrst, numrow, 'rotn' , rotn )
	144	CALL iom_rstput( kt, nitrst, numrow, 'hdivn' , hdivn )
	145	CALL iom_rstput( kt, nitrst, numrow, 'sshn' , sshn )
	146	CALL iom_rstput( kt, nitrst, numrow, 'rhop' , rhop )
[1545]	147	#if defined key_zdfkpp
[2528]	148	CALL iom_rstput( kt, nitrst, numrow, 'rhd' , rhd )
[1483]	149	#endif
[4206]	150	IF( lk_lim3 ) THEN
[5208]	151	CALL iom_rstput( kt, nitrst, numrow, 'fraqsr_1lev' , fraqsr_1lev ) !clem modif
[4206]	152	ENDIF
[508]	153	IF( kt == nitrst ) THEN
	154	CALL iom_close( numrow ) ! close the restart file (only at last time step)
[5208]	155	!!gm IF( .NOT. lk_trdmld ) lrst_oce = .FALSE.
	156	!!gm not sure what to do here ===>>> ask to Sebastian
	157	lrst_oce = .FALSE.
[4780]	158	IF( ln_rst_list ) THEN
	159	nrst_lst = nrst_lst + 1
	160	nitrst = nstocklist( nrst_lst )
	161	ENDIF
	162	lrst_oce = .FALSE.
[3]	163	ENDIF
[508]	164	!
[3]	165	END SUBROUTINE rst_write
	166
[5208]	167
[4292]	168	SUBROUTINE rst_read_open
	169	!!----------------------------------------------------------------------
	170	!! * ROUTINE rst_read_open *
	171	!!
	172	!! ** Purpose : Open read files for restart (format fixed by jprstlib )
	173	!!
	174	!! ** Method : Use a non-zero, positive value of numror to assess whether or not
	175	!! the file has already been opened
	176	!!----------------------------------------------------------------------
	177	INTEGER :: jlibalt = jprstlib
	178	LOGICAL :: llok
	179	!!----------------------------------------------------------------------
[5208]	180	!
	181	IF( numror <= 0 ) THEN
[4292]	182	IF(lwp) THEN ! Contol prints
	183	WRITE(numout,*)
	184	SELECT CASE ( jprstlib )
	185	CASE ( jpnf90 ) ; WRITE(numout,*) 'rst_read : read oce NetCDF restart file'
	186	CASE ( jprstdimg ) ; WRITE(numout,*) 'rst_read : read oce binary restart file'
	187	END SELECT
	188	IF ( snc4set%luse ) WRITE(numout,*) 'rst_read : configured with NetCDF4 support'
	189	WRITE(numout,*) '~~~~~~~~'
	190	ENDIF
	191
	192	IF ( jprstlib == jprstdimg ) THEN
	193	! eventually read netcdf file (monobloc) for restarting on different number of processors
	194	! if {cn_ocerst_in}.nc exists, then set jlibalt to jpnf90
[4775]	195	INQUIRE( FILE = TRIM(cn_ocerst_indir)//'/'//TRIM(cn_ocerst_in)//'.nc', EXIST = llok )
[4292]	196	IF ( llok ) THEN ; jlibalt = jpnf90 ; ELSE ; jlibalt = jprstlib ; ENDIF
	197	ENDIF
[4775]	198	CALL iom_open( TRIM(cn_ocerst_indir)//'/'//cn_ocerst_in, numror, kiolib = jlibalt )
[4292]	199	ENDIF
	200	END SUBROUTINE rst_read_open
	201
[3]	202	SUBROUTINE rst_read
	203	!!----------------------------------------------------------------------
	204	!! * ROUTINE rst_read *
	205	!!
[632]	206	!! ** Purpose : Read files for restart (format fixed by jprstlib )
[3]	207	!!
[1531]	208	!! ** Method : Read in restart.nc file fields which are necessary for restart
[3]	209	!!----------------------------------------------------------------------
[1130]	210	REAL(wp) :: zrdt, zrdttra1
[4292]	211	INTEGER :: jk
[1473]	212	LOGICAL :: llok
[3]	213	!!----------------------------------------------------------------------
	214
[4292]	215	CALL rst_read_open ! open restart for reading (if not already opened)
[3]	216
[544]	217	! Check dynamics and tracer time-step consistency and force Euler restart if changed
[746]	218	IF( iom_varid( numror, 'rdt', ldstop = .FALSE. ) > 0 ) THEN
[544]	219	CALL iom_get( numror, 'rdt', zrdt )
	220	IF( zrdt /= rdt ) neuler = 0
	221	ENDIF
[746]	222	IF( iom_varid( numror, 'rdttra1', ldstop = .FALSE. ) > 0 ) THEN
[544]	223	CALL iom_get( numror, 'rdttra1', zrdttra1 )
	224	IF( zrdttra1 /= rdttra(1) ) neuler = 0
	225	ENDIF
[1607]	226	!
[3680]	227	IF( iom_varid( numror, 'ub', ldstop = .FALSE. ) > 0 ) THEN
	228	CALL iom_get( numror, jpdom_autoglo, 'ub' , ub ) ! before fields
	229	CALL iom_get( numror, jpdom_autoglo, 'vb' , vb )
	230	CALL iom_get( numror, jpdom_autoglo, 'tb' , tsb(:,:,:,jp_tem) )
	231	CALL iom_get( numror, jpdom_autoglo, 'sb' , tsb(:,:,:,jp_sal) )
	232	CALL iom_get( numror, jpdom_autoglo, 'rotb' , rotb )
	233	CALL iom_get( numror, jpdom_autoglo, 'hdivb' , hdivb )
	234	CALL iom_get( numror, jpdom_autoglo, 'sshb' , sshb )
[4693]	235	IF( lk_lim3 ) CALL iom_get( numror, jpdom_autoglo, 'fse3t_b', fse3t_b(:,:,:) )
[3680]	236	ELSE
	237	neuler = 0
	238	ENDIF
	239	!
	240	CALL iom_get( numror, jpdom_autoglo, 'un' , un ) ! now fields
	241	CALL iom_get( numror, jpdom_autoglo, 'vn' , vn )
	242	CALL iom_get( numror, jpdom_autoglo, 'tn' , tsn(:,:,:,jp_tem) )
	243	CALL iom_get( numror, jpdom_autoglo, 'sn' , tsn(:,:,:,jp_sal) )
	244	CALL iom_get( numror, jpdom_autoglo, 'sshn' , sshn )
	245	IF( iom_varid( numror, 'rotn', ldstop = .FALSE. ) > 0 ) THEN
	246	CALL iom_get( numror, jpdom_autoglo, 'rotn' , rotn )
	247	CALL iom_get( numror, jpdom_autoglo, 'hdivn' , hdivn )
	248	ELSE
	249	CALL div_cur( 0 ) ! Horizontal divergence & Relative vorticity
	250	ENDIF
	251	IF( iom_varid( numror, 'rhop', ldstop = .FALSE. ) > 0 ) THEN
	252	CALL iom_get( numror, jpdom_autoglo, 'rhop' , rhop ) ! now potential density
	253	ELSE
[4313]	254	CALL eos ( tsn, rhd, rhop, fsdept_n(:,:,:) )
[3680]	255	ENDIF
[1545]	256	#if defined key_zdfkpp
	257	IF( iom_varid( numror, 'rhd', ldstop = .FALSE. ) > 0 ) THEN
[3680]	258	CALL iom_get( numror, jpdom_autoglo, 'rhd' , rhd ) ! now in situ density anomaly
[1545]	259	ELSE
[4313]	260	CALL eos( tsn, rhd, fsdept_n(:,:,:) ) ! compute rhd
[1545]	261	ENDIF
[1483]	262	#endif
[2528]	263	!
[508]	264	IF( neuler == 0 ) THEN ! Euler restart (neuler=0)
[3294]	265	tsb (:,:,:,:) = tsn (:,:,:,:) ! all before fields set to now values
	266	ub (:,:,:) = un (:,:,:)
	267	vb (:,:,:) = vn (:,:,:)
	268	rotb (:,:,:) = rotn (:,:,:)
	269	hdivb(:,:,:) = hdivn(:,:,:)
	270	sshb (:,:) = sshn (:,:)
[5208]	271
	272	IF( lk_vvl ) THEN
[4689]	273	DO jk = 1, jpk
	274	fse3t_b(:,:,jk) = fse3t_n(:,:,jk)
	275	END DO
	276	ENDIF
[5208]	277
	278	IF( lk_lim3 .AND. .NOT. lk_vvl ) THEN
	279	DO jk = 1, jpk
	280	fse3t_b(:,:,jk) = fse3t_n(:,:,jk)
	281	END DO
	282	ENDIF
	283
[3]	284	ENDIF
[508]	285	!
[4689]	286	IF( lk_lim3 ) THEN
[5208]	287	CALL iom_get( numror, jpdom_autoglo, 'fraqsr_1lev' , fraqsr_1lev )
[4206]	288	ENDIF
[4205]	289	!
[508]	290	END SUBROUTINE rst_read
[473]	291
[3]	292	!!=====================================================================
	293	END MODULE restart

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

Download in other formats: