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

Context Navigation

source: trunk/NEMOGCM/NEMO/OPA_SRC/IOM/restart.F90 @ 4689

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

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

Download in other formats: