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/2015/dev_r5218_CNRS17_coupling/NEMOGCM/NEMO/OPA_SRC/IOM – NEMO

Context Navigation

source: branches/2015/dev_r5218_CNRS17_coupling/NEMOGCM/NEMO/OPA_SRC/IOM/restart.F90 @ 5299

Last change on this file since 5299 was 5299, checked in by smasson, 9 years ago
dev_r5218_CNRS17_coupling: bugfixes
Property svn:keywords set to `Id`
File size: 13.8 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)
[4990]	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
[5299]	27	USE sbc_oce, ONLY : nn_components, jp_iam_opa
[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
	58	!!
	59	CHARACTER(LEN=20) :: clkt ! ocean time-step deine as a character
	60	CHARACTER(LEN=50) :: clname ! ice output restart file name
	61	!!----------------------------------------------------------------------
	62	!
[783]	63	IF( kt == nit000 ) THEN ! default definitions
	64	lrst_oce = .FALSE.
	65	nitrst = nitend
[508]	66	ENDIF
[783]	67	IF( MOD( kt - 1, nstock ) == 0 ) THEN
	68	! we use kt - 1 and not kt - nit000 to keep the same periodicity from the beginning of the experiment
	69	nitrst = kt + nstock - 1 ! define the next value of nitrst for restart writing
	70	IF( nitrst > nitend ) nitrst = nitend ! make sure we write a restart at the end of the run
	71	ENDIF
	72	! to get better performances with NetCDF format:
	73	! we open and define the ocean restart file one time step before writing the data (-> at nitrst - 1)
	74	! except if we write ocean restart files every time step or if an ocean restart file was writen at nitend - 1
	75	IF( kt == nitrst - 1 .OR. nstock == 1 .OR. ( kt == nitend .AND. .NOT. lrst_oce ) ) THEN
	76	! beware of the format used to write kt (default is i8.8, that should be large enough...)
	77	IF( nitrst > 999999999 ) THEN ; WRITE(clkt, * ) nitrst
	78	ELSE ; WRITE(clkt, '(i8.8)') nitrst
[508]	79	ENDIF
	80	! create the file
[1229]	81	clname = TRIM(cexper)//"_"//TRIM(ADJUSTL(clkt))//"_"//TRIM(cn_ocerst_out)
[611]	82	IF(lwp) THEN
	83	WRITE(numout,*)
[632]	84	SELECT CASE ( jprstlib )
[783]	85	CASE ( jprstdimg ) ; WRITE(numout,*) ' open ocean restart binary file: '//clname
	86	CASE DEFAULT ; WRITE(numout,*) ' open ocean restart NetCDF file: '//clname
[632]	87	END SELECT
[2528]	88	IF ( snc4set%luse ) WRITE(numout,*) ' opened for NetCDF4 chunking and compression'
[1130]	89	IF( kt == nitrst - 1 ) THEN ; WRITE(numout,*) ' kt = nitrst - 1 = ', kt
	90	ELSE ; WRITE(numout,*) ' kt = ' , kt
[611]	91	ENDIF
	92	ENDIF
[2528]	93	!
[547]	94	CALL iom_open( clname, numrow, ldwrt = .TRUE., kiolib = jprstlib )
[508]	95	lrst_oce = .TRUE.
	96	ENDIF
	97	!
	98	END SUBROUTINE rst_opn
	99
	100
[3]	101	SUBROUTINE rst_write( kt )
	102	!!---------------------------------------------------------------------
	103	!! * ROUTINE rstwrite *
	104	!!
[632]	105	!! ** Purpose : Write restart fields in the format corresponding to jprstlib
[3]	106	!!
[508]	107	!! ** Method : Write in numrow when kt == nitrst in NetCDF
[2528]	108	!! file, save fields which are necessary for restart
[3]	109	!!----------------------------------------------------------------------
[508]	110	INTEGER, INTENT(in) :: kt ! ocean time-step
[3]	111	!!----------------------------------------------------------------------
[1239]	112
[2528]	113	CALL iom_rstput( kt, nitrst, numrow, 'rdt' , rdt ) ! dynamics time step
	114	CALL iom_rstput( kt, nitrst, numrow, 'rdttra1', rdttra(1) ) ! surface tracer time step
[3]	115
[2528]	116	CALL iom_rstput( kt, nitrst, numrow, 'ub' , ub ) ! before fields
	117	CALL iom_rstput( kt, nitrst, numrow, 'vb' , vb )
[3294]	118	CALL iom_rstput( kt, nitrst, numrow, 'tb' , tsb(:,:,:,jp_tem) )
	119	CALL iom_rstput( kt, nitrst, numrow, 'sb' , tsb(:,:,:,jp_sal) )
[2528]	120	CALL iom_rstput( kt, nitrst, numrow, 'rotb' , rotb )
	121	CALL iom_rstput( kt, nitrst, numrow, 'hdivb' , hdivb )
	122	CALL iom_rstput( kt, nitrst, numrow, 'sshb' , sshb )
[4990]	123	!
[5299]	124	IF( lk_lim3 .OR. ( nn_components == jp_iam_opa ) ) CALL iom_rstput( kt, nitrst, numrow, 'fse3t_b', fse3t_b(:,:,:) )
[2528]	125	!
	126	CALL iom_rstput( kt, nitrst, numrow, 'un' , un ) ! now fields
	127	CALL iom_rstput( kt, nitrst, numrow, 'vn' , vn )
[3294]	128	CALL iom_rstput( kt, nitrst, numrow, 'tn' , tsn(:,:,:,jp_tem) )
	129	CALL iom_rstput( kt, nitrst, numrow, 'sn' , tsn(:,:,:,jp_sal) )
[2528]	130	CALL iom_rstput( kt, nitrst, numrow, 'rotn' , rotn )
	131	CALL iom_rstput( kt, nitrst, numrow, 'hdivn' , hdivn )
	132	CALL iom_rstput( kt, nitrst, numrow, 'sshn' , sshn )
	133	CALL iom_rstput( kt, nitrst, numrow, 'rhop' , rhop )
[1545]	134	#if defined key_zdfkpp
[2528]	135	CALL iom_rstput( kt, nitrst, numrow, 'rhd' , rhd )
[1483]	136	#endif
[5299]	137	IF( lk_lim3 .OR. ( nn_components == jp_iam_opa ) ) THEN
[4990]	138	CALL iom_rstput( kt, nitrst, numrow, 'fraqsr_1lev' , fraqsr_1lev ) !clem modif
[4206]	139	ENDIF
[508]	140	IF( kt == nitrst ) THEN
	141	CALL iom_close( numrow ) ! close the restart file (only at last time step)
[4990]	142	!!gm IF( .NOT. lk_trdmld ) lrst_oce = .FALSE.
	143	!!gm not sure what to do here ===>>> ask to Sebastian
	144	lrst_oce = .FALSE.
[3]	145	ENDIF
[508]	146	!
[3]	147	END SUBROUTINE rst_write
	148
[4990]	149
[4292]	150	SUBROUTINE rst_read_open
	151	!!----------------------------------------------------------------------
	152	!! * ROUTINE rst_read_open *
	153	!!
	154	!! ** Purpose : Open read files for restart (format fixed by jprstlib )
	155	!!
	156	!! ** Method : Use a non-zero, positive value of numror to assess whether or not
	157	!! the file has already been opened
	158	!!----------------------------------------------------------------------
	159	INTEGER :: jlibalt = jprstlib
	160	LOGICAL :: llok
	161	!!----------------------------------------------------------------------
[4990]	162	!
	163	IF( numror <= 0 ) THEN
[4292]	164	IF(lwp) THEN ! Contol prints
	165	WRITE(numout,*)
	166	SELECT CASE ( jprstlib )
	167	CASE ( jpnf90 ) ; WRITE(numout,*) 'rst_read : read oce NetCDF restart file'
	168	CASE ( jprstdimg ) ; WRITE(numout,*) 'rst_read : read oce binary restart file'
	169	END SELECT
	170	IF ( snc4set%luse ) WRITE(numout,*) 'rst_read : configured with NetCDF4 support'
	171	WRITE(numout,*) '~~~~~~~~'
	172	ENDIF
	173
	174	IF ( jprstlib == jprstdimg ) THEN
	175	! eventually read netcdf file (monobloc) for restarting on different number of processors
	176	! if {cn_ocerst_in}.nc exists, then set jlibalt to jpnf90
	177	INQUIRE( FILE = TRIM(cn_ocerst_in)//'.nc', EXIST = llok )
	178	IF ( llok ) THEN ; jlibalt = jpnf90 ; ELSE ; jlibalt = jprstlib ; ENDIF
	179	ENDIF
	180	CALL iom_open( cn_ocerst_in, numror, kiolib = jlibalt )
	181	ENDIF
	182	END SUBROUTINE rst_read_open
	183
[3]	184	SUBROUTINE rst_read
	185	!!----------------------------------------------------------------------
	186	!! * ROUTINE rst_read *
	187	!!
[632]	188	!! ** Purpose : Read files for restart (format fixed by jprstlib )
[3]	189	!!
[1531]	190	!! ** Method : Read in restart.nc file fields which are necessary for restart
[3]	191	!!----------------------------------------------------------------------
[1130]	192	REAL(wp) :: zrdt, zrdttra1
[4292]	193	INTEGER :: jk
[1473]	194	LOGICAL :: llok
[3]	195	!!----------------------------------------------------------------------
	196
[4292]	197	CALL rst_read_open ! open restart for reading (if not already opened)
[3]	198
[544]	199	! Check dynamics and tracer time-step consistency and force Euler restart if changed
[746]	200	IF( iom_varid( numror, 'rdt', ldstop = .FALSE. ) > 0 ) THEN
[544]	201	CALL iom_get( numror, 'rdt', zrdt )
	202	IF( zrdt /= rdt ) neuler = 0
	203	ENDIF
[746]	204	IF( iom_varid( numror, 'rdttra1', ldstop = .FALSE. ) > 0 ) THEN
[544]	205	CALL iom_get( numror, 'rdttra1', zrdttra1 )
	206	IF( zrdttra1 /= rdttra(1) ) neuler = 0
	207	ENDIF
[1607]	208	!
[3680]	209	IF( iom_varid( numror, 'ub', ldstop = .FALSE. ) > 0 ) THEN
	210	CALL iom_get( numror, jpdom_autoglo, 'ub' , ub ) ! before fields
	211	CALL iom_get( numror, jpdom_autoglo, 'vb' , vb )
	212	CALL iom_get( numror, jpdom_autoglo, 'tb' , tsb(:,:,:,jp_tem) )
	213	CALL iom_get( numror, jpdom_autoglo, 'sb' , tsb(:,:,:,jp_sal) )
	214	CALL iom_get( numror, jpdom_autoglo, 'rotb' , rotb )
	215	CALL iom_get( numror, jpdom_autoglo, 'hdivb' , hdivb )
	216	CALL iom_get( numror, jpdom_autoglo, 'sshb' , sshb )
[5299]	217	! EM Attention Ceci doit etre reimplemente correctement
	218	!EM IF( lk_lim3 .OR. ( nn_components == jp_iam_opa ) ) CALL iom_get( numror, jpdom_autoglo, 'fse3t_b', fse3t_b(:,:,:) )
	219	CALL iom_get( numror, jpdom_autoglo, 'fse3t_b', fse3t_b(:,:,:) )
[3680]	220	ELSE
	221	neuler = 0
	222	ENDIF
	223	!
	224	CALL iom_get( numror, jpdom_autoglo, 'un' , un ) ! now fields
	225	CALL iom_get( numror, jpdom_autoglo, 'vn' , vn )
	226	CALL iom_get( numror, jpdom_autoglo, 'tn' , tsn(:,:,:,jp_tem) )
	227	CALL iom_get( numror, jpdom_autoglo, 'sn' , tsn(:,:,:,jp_sal) )
	228	CALL iom_get( numror, jpdom_autoglo, 'sshn' , sshn )
	229	IF( iom_varid( numror, 'rotn', ldstop = .FALSE. ) > 0 ) THEN
	230	CALL iom_get( numror, jpdom_autoglo, 'rotn' , rotn )
	231	CALL iom_get( numror, jpdom_autoglo, 'hdivn' , hdivn )
	232	ELSE
	233	CALL div_cur( 0 ) ! Horizontal divergence & Relative vorticity
	234	ENDIF
	235	IF( iom_varid( numror, 'rhop', ldstop = .FALSE. ) > 0 ) THEN
	236	CALL iom_get( numror, jpdom_autoglo, 'rhop' , rhop ) ! now potential density
	237	ELSE
[4313]	238	CALL eos ( tsn, rhd, rhop, fsdept_n(:,:,:) )
[3680]	239	ENDIF
[1545]	240	#if defined key_zdfkpp
	241	IF( iom_varid( numror, 'rhd', ldstop = .FALSE. ) > 0 ) THEN
[3680]	242	CALL iom_get( numror, jpdom_autoglo, 'rhd' , rhd ) ! now in situ density anomaly
[1545]	243	ELSE
[4313]	244	CALL eos( tsn, rhd, fsdept_n(:,:,:) ) ! compute rhd
[1545]	245	ENDIF
[1483]	246	#endif
[2528]	247	!
[508]	248	IF( neuler == 0 ) THEN ! Euler restart (neuler=0)
[3294]	249	tsb (:,:,:,:) = tsn (:,:,:,:) ! all before fields set to now values
	250	ub (:,:,:) = un (:,:,:)
	251	vb (:,:,:) = vn (:,:,:)
	252	rotb (:,:,:) = rotn (:,:,:)
	253	hdivb(:,:,:) = hdivn(:,:,:)
	254	sshb (:,:) = sshn (:,:)
[4990]	255
	256	IF( lk_vvl ) THEN
[4689]	257	DO jk = 1, jpk
	258	fse3t_b(:,:,jk) = fse3t_n(:,:,jk)
	259	END DO
	260	ENDIF
[4990]	261
[5299]	262	IF( ( lk_lim3 .OR. ( nn_components == jp_iam_opa ) ) .AND. .NOT. lk_vvl ) THEN
[4990]	263	DO jk = 1, jpk
	264	fse3t_b(:,:,jk) = fse3t_n(:,:,jk)
	265	END DO
	266	ENDIF
	267
[3]	268	ENDIF
[508]	269	!
[5299]	270	!EM Idem
	271	!EM IF( lk_lim3 .OR. ( nn_components == jp_iam_opa ) ) THEN
[4990]	272	CALL iom_get( numror, jpdom_autoglo, 'fraqsr_1lev' , fraqsr_1lev )
[5299]	273	!EM ENDIF
[4205]	274	!
[508]	275	END SUBROUTINE rst_read
[473]	276
[3]	277	!!=====================================================================
	278	END MODULE restart

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

Download in other formats: