Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

restart.F90 @ 12489

Last change on this file since 12489 was 8243, checked in by andmirek, 7 years ago
#1914 working XIOS read, XIOS write and single processor read
File size: 19.2 KB

Line
1	MODULE restart
2	!!======================================================================
3	!! * MODULE restart *
4	!! Ocean restart : write the ocean restart file
5	!!======================================================================
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)
11	!!----------------------------------------------------------------------
12
13	!!----------------------------------------------------------------------
14	!! rst_opn : open the ocean restart file
15	!! rst_write : write the ocean restart file
16	!! rst_read : read the ocean restart file
17	!!----------------------------------------------------------------------
18	USE oce ! ocean dynamics and tracers
19	USE dom_oce ! ocean space and time domain
20	USE phycst ! physical constants
21	USE in_out_manager ! I/O manager
22	USE iom ! I/O module
23	USE ioipsl, ONLY : ju2ymds ! for calendar
24	USE eosbn2 ! equation of state (eos bn2 routine)
25	USE trdmxl_oce ! ocean active mixed layer tracers trends variables
26	USE divcur ! hor. divergence and curl (div & cur routines)
27	USE sbc_oce ! for icesheet freshwater input variables
28	USE iom_def, ONLY : lxios_read, lxios_set, lxios_sini, lwxios
29	USE timing
30
31	IMPLICIT NONE
32	PRIVATE
33
34	PUBLIC rst_opn ! routine called by step module
35	PUBLIC rst_write ! routine called by step module
36	PUBLIC rst_read ! routine called by istate module
37	PUBLIC rst_read_open ! routine called in rst_read and (possibly) in dom_vvl_init
38
39	!! * Substitutions
40	# include "domzgr_substitute.h90"
41	# include "vectopt_loop_substitute.h90"
42	!!----------------------------------------------------------------------
43	!! NEMO/OPA 3.3 , NEMO Consortium (2010)
44	!! $Id$
45	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
46	!!----------------------------------------------------------------------
47	CONTAINS
48
49	SUBROUTINE rst_opn( kt )
50	!!---------------------------------------------------------------------
51	!! * ROUTINE rst_opn *
52	!!
53	!! ** Purpose : + initialization (should be read in the namelist) of nitrst
54	!! + open the restart when we are one time step before nitrst
55	!! - restart header is defined when kt = nitrst-1
56	!! - restart data are written when kt = nitrst
57	!! + define lrst_oce to .TRUE. when we need to define or write the restart
58	!!----------------------------------------------------------------------
59	INTEGER, INTENT(in) :: kt ! ocean time-step
60	INTEGER :: iyear, imonth, iday
61	REAL (wp) :: zsec
62	REAL (wp) :: zfjulday
63	!!
64	CHARACTER(LEN=20) :: clkt ! ocean time-step deine as a character
65	CHARACTER(LEN=50) :: clname ! ocean output restart file name
66	CHARACTER(LEN=150) :: clpath ! full path to ocean output restart file
67	!!----------------------------------------------------------------------
68	!
69
70	IF( kt == nit000 ) THEN ! default definitions
71	lrst_oce = .FALSE.
72	IF( ln_rst_list ) THEN
73	nrst_lst = 1
74	nitrst = nstocklist( nrst_lst )
75	ELSE
76	nitrst = nitend
77	ENDIF
78	ENDIF
79
80	! frequency-based restart dumping (nn_stock)
81	IF( .NOT. ln_rst_list .AND. MOD( kt - 1, nstock ) == 0 ) THEN
82	! we use kt - 1 and not kt - nit000 to keep the same periodicity from the beginning of the experiment
83	nitrst = kt + nstock - 1 ! define the next value of nitrst for restart writing
84	IF( nitrst > nitend ) nitrst = nitend ! make sure we write a restart at the end of the run
85	ENDIF
86	! to get better performances with NetCDF format:
87	! we open and define the ocean restart file one time step before writing the data (-> at nitrst - 1)
88	! except if we write ocean restart files every time step or if an ocean restart file was writen at nitend - 1
89	IF( kt == nitrst - 1 .OR. nstock == 1 .OR. ( kt == nitend .AND. .NOT. lrst_oce ) ) THEN
90	IF( nitrst <= nitend .AND. nitrst > 0 ) THEN
91	IF ( ln_rstdate ) THEN
92	zfjulday = fjulday + rdttra(1) / rday
93	IF( ABS(zfjulday - REAL(NINT(zfjulday),wp)) < 0.1 / rday ) zfjulday = REAL(NINT(zfjulday),wp) ! avoid truncation error
94	CALL ju2ymds( zfjulday, iyear, imonth, iday, zsec )
95	WRITE(clkt, '(i4.4,2i2.2)') iyear, imonth, iday
96	ELSE
97	! beware of the format used to write kt (default is i8.8, that should be large enough...)
98	IF( nitrst > 999999999 ) THEN ; WRITE(clkt, * ) nitrst
99	ELSE ; WRITE(clkt, '(i8.8)') nitrst
100	ENDIF
101	ENDIF
102	! create the file
103	clname = TRIM(cexper)//"_"//TRIM(ADJUSTL(clkt))//"_"//TRIM(cn_ocerst_out)
104	clpath = TRIM(cn_ocerst_outdir)
105	IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
106	IF(lwp) THEN
107	WRITE(numout,*)
108	IF(lwxios) THEN
109	WRITE(numout,*) &
110	' XIOS open ocean restart NetCDF file: ',TRIM(clpath)//TRIM(clname)
111	ELSE
112	SELECT CASE ( jprstlib )
113	CASE ( jprstdimg ) ; WRITE(numout,*) &
114	' open ocean restart binary file: ',TRIM(clpath)//TRIM(clname)
115	CASE DEFAULT ; WRITE(numout,*) &
116	' open ocean restart NetCDF file: ',TRIM(clpath)//TRIM(clname)
117	END SELECT
118	IF ( snc4set%luse ) WRITE(numout,*) ' opened for NetCDF4 chunking and compression'
119	IF( kt == nitrst - 1 ) THEN ; WRITE(numout,*) ' kt = nitrst - 1 = ', kt
120	ELSE ; WRITE(numout,*) ' kt = ' , kt
121	ENDIF
122	ENDIF
123	ENDIF
124	!
125	IF(.NOT.lwxios) THEN
126	CALL iom_open( TRIM(clpath)//TRIM(clname), numrow, ldwrt = .TRUE., kiolib = jprstlib )
127	ELSE
128	CALL iom_init( wxios_context, TRIM(clpath)//TRIM(clname) )
129	CALL xios_update_calendar(nitrst)
130	CALL iom_swap( cxios_context )
131	ENDIF
132	lrst_oce = .TRUE.
133	ENDIF
134	ENDIF
135	!
136	END SUBROUTINE rst_opn
137
138
139	SUBROUTINE rst_write( kt )
140	!!---------------------------------------------------------------------
141	!! * ROUTINE rstwrite *
142	!!
143	!! ** Purpose : Write restart fields in the format corresponding to jprstlib
144	!!
145	!! ** Method : Write in numrow when kt == nitrst in NetCDF
146	!! file, save fields which are necessary for restart
147	!!----------------------------------------------------------------------
148	INTEGER, INTENT(in) :: kt ! ocean time-step
149	!!----------------------------------------------------------------------
150	IF(lwxios) CALL iom_swap( wxios_context )
151	CALL iom_rstput( kt, nitrst, numrow, 'rdt' , rdt , lxios = lwxios) ! dynamics time step
152	CALL iom_rstput( kt, nitrst, numrow, 'rdttra1', rdttra(1) , lxios = lwxios) ! surface tracer time step
153
154	CALL iom_rstput( kt, nitrst, numrow, 'ub' , ub , lxios = lwxios) ! before fields
155	CALL iom_rstput( kt, nitrst, numrow, 'vb' , vb , lxios = lwxios)
156	CALL iom_rstput( kt, nitrst, numrow, 'tb' , tsb(:,:,:,jp_tem) , lxios = lwxios)
157	CALL iom_rstput( kt, nitrst, numrow, 'sb' , tsb(:,:,:,jp_sal) , lxios = lwxios)
158	CALL iom_rstput( kt, nitrst, numrow, 'rotb' , rotb , lxios = lwxios)
159	CALL iom_rstput( kt, nitrst, numrow, 'hdivb' , hdivb , lxios = lwxios)
160	CALL iom_rstput( kt, nitrst, numrow, 'sshb' , sshb , lxios = lwxios)
161	!
162	CALL iom_rstput( kt, nitrst, numrow, 'un' , un , lxios = lwxios) ! now fields
163	CALL iom_rstput( kt, nitrst, numrow, 'vn' , vn , lxios = lwxios)
164	CALL iom_rstput( kt, nitrst, numrow, 'tn' , tsn(:,:,:,jp_tem) , lxios = lwxios)
165	CALL iom_rstput( kt, nitrst, numrow, 'sn' , tsn(:,:,:,jp_sal) , lxios = lwxios)
166	CALL iom_rstput( kt, nitrst, numrow, 'rotn' , rotn , lxios = lwxios)
167	CALL iom_rstput( kt, nitrst, numrow, 'hdivn' , hdivn , lxios = lwxios)
168	CALL iom_rstput( kt, nitrst, numrow, 'sshn' , sshn , lxios = lwxios)
169	CALL iom_rstput( kt, nitrst, numrow, 'rhop' , rhop , lxios = lwxios)
170	#if defined key_zdfkpp
171	CALL iom_rstput( kt, nitrst, numrow, 'rhd' , rhd , lxios = lwxios)
172	#endif
173	IF( lk_oasis) THEN
174	! ln_coupled_iceshelf_fluxes uninitialised unless lk_oasis=true
175	IF( ln_coupled_iceshelf_fluxes ) THEN
176	CALL iom_rstput( kt, nitrst, numrow, 'greenland_icesheet_mass', greenland_icesheet_mass ,&
177	& lxios = lwxios)
178	CALL iom_rstput( kt, nitrst, numrow, 'greenland_icesheet_timelapsed', greenland_icesheet_timelapsed ,&
179	& lxios = lwxios)
180	CALL iom_rstput( kt, nitrst, numrow, 'greenland_icesheet_mass_roc', greenland_icesheet_mass_rate_of_change ,&
181	& lxios = lwxios)
182	CALL iom_rstput( kt, nitrst, numrow, 'antarctica_icesheet_mass', antarctica_icesheet_mass , &
183	& lxios = lwxios)
184	CALL iom_rstput( kt, nitrst, numrow, 'antarctica_icesheet_timelapsed', antarctica_icesheet_timelapsed ,&
185	& lxios = lwxios)
186	CALL iom_rstput( kt, nitrst, numrow, 'antarctica_icesheet_mass_roc', &
187	& antarctica_icesheet_mass_rate_of_change , lxios = lwxios)
188	ENDIF
189	ENDIF
190
191	IF( kt == nitrst ) THEN
192	IF(.NOT.lwxios) THEN
193	CALL iom_close( numrow ) ! close the restart file (only at last time step)
194	ELSE
195	CALL iom_context_finalize( wxios_context )
196	CALL iom_swap( cxios_context )
197	ENDIF
198	!!gm IF( .NOT. lk_trdmld ) lrst_oce = .FALSE.
199	!!gm not sure what to do here ===>>> ask to Sebastian
200	lrst_oce = .FALSE.
201	IF( ln_rst_list ) THEN
202	nrst_lst = MIN(nrst_lst + 1, SIZE(nstocklist,1))
203	nitrst = nstocklist( nrst_lst )
204	ENDIF
205	ENDIF
206	!
207	END SUBROUTINE rst_write
208
209
210	SUBROUTINE rst_read_open
211	!!----------------------------------------------------------------------
212	!! * ROUTINE rst_read_open *
213	!!
214	!! ** Purpose : Open read files for restart (format fixed by jprstlib )
215	!!
216	!! ** Method : Use a non-zero, positive value of numror to assess whether or not
217	!! the file has already been opened
218	!!----------------------------------------------------------------------
219	INTEGER :: jlibalt = jprstlib
220	LOGICAL :: llok
221	CHARACTER(lc) :: clpath ! full path to ocean output restart file
222	!!----------------------------------------------------------------------
223	!
224	IF( numror <= 0 ) THEN
225	IF(lwp) THEN ! Contol prints
226	WRITE(numout,*)
227	SELECT CASE ( jprstlib )
228	CASE ( jpnf90 ) ; WRITE(numout,*) 'rst_read : read oce NetCDF restart file'
229	CASE ( jprstdimg ) ; WRITE(numout,*) 'rst_read : read oce binary restart file'
230	END SELECT
231	IF ( snc4set%luse ) WRITE(numout,*) 'rst_read : configured with NetCDF4 support'
232	WRITE(numout,*) '~~~~~~~~'
233	ENDIF
234	lxios_sini = .FALSE.
235	clpath = TRIM(cn_ocerst_indir)
236	IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
237	IF ( jprstlib == jprstdimg ) THEN
238	! eventually read netcdf file (monobloc) for restarting on different number of processors
239	! if {cn_ocerst_in}.nc exists, then set jlibalt to jpnf90
240	INQUIRE( FILE = TRIM(cn_ocerst_indir)//'/'//TRIM(cn_ocerst_in)//'.nc', EXIST = llok )
241	IF ( llok ) THEN ; jlibalt = jpnf90 ; ELSE ; jlibalt = jprstlib ; ENDIF
242	ENDIF
243	lspr = .FALSE. ! do not read restart using single processor
244	CALL iom_open( TRIM(clpath)//cn_ocerst_in, numror, kiolib = jlibalt )
245	! are we using XIOS to read the data? Part above will have to modified once XIOS
246	! can handle checking if variable is in the restart file (there will be no need to open
247	! restart)
248	IF(.NOT.lxios_set) lxios_read = lxios_read.AND.lxios_sini
249	IF( lxios_read) THEN
250	if(.NOT.lxios_set) then
251	call iom_init( rxios_context )
252	lxios_set = .TRUE.
253	endif
254	ENDIF
255	IF( TRIM(Agrif_CFixed()) /= '0' .AND. lxios_read) THEN
256	call iom_init( rxios_context )
257	ENDIF
258	ENDIF
259
260	END SUBROUTINE rst_read_open
261
262	SUBROUTINE rst_read
263	!!----------------------------------------------------------------------
264	!! * ROUTINE rst_read *
265	!!
266	!! ** Purpose : Read files for restart (format fixed by jprstlib )
267	!!
268	!! ** Method : Read in restart.nc file fields which are necessary for restart
269	!!----------------------------------------------------------------------
270	REAL(wp) :: zrdt, zrdttra1
271	INTEGER :: jk
272	LOGICAL :: llok
273	TYPE(xios_duration):: dtime
274	integer::ni,nj,nk
275	!!----------------------------------------------------------------------
276
277	CALL rst_read_open ! open restart for reading (if not already opened)
278
279	! Check dynamics and tracer time-step consistency and force Euler restart if changed
280	IF( iom_varid( numror, 'rdt', ldstop = .FALSE. ) > 0 ) THEN
281	CALL iom_get( numror, 'rdt', zrdt, lrxios = lxios_read )
282	IF( zrdt /= rdt ) neuler = 0
283	ENDIF
284	IF( iom_varid( numror, 'rdttra1', ldstop = .FALSE. ) > 0 ) THEN
285	CALL iom_get( numror, 'rdttra1', zrdttra1, lrxios = lxios_read )
286	IF( zrdttra1 /= rdttra(1) ) neuler = 0
287	ENDIF
288	!
289	IF( iom_varid( numror, 'ub', ldstop = .FALSE. ) > 0 ) THEN
290	CALL iom_get( numror, jpdom_autoglo, 'ub' , ub, lrxios = lxios_read ) ! before fields
291	CALL iom_get( numror, jpdom_autoglo, 'vb' , vb, lrxios = lxios_read )
292	CALL iom_get( numror, jpdom_autoglo, 'tb' , tsb(:,:,:,jp_tem), lrxios = lxios_read )
293	CALL iom_get( numror, jpdom_autoglo, 'sb' , tsb(:,:,:,jp_sal), lrxios = lxios_read )
294	CALL iom_get( numror, jpdom_autoglo, 'rotb' , rotb, lrxios = lxios_read )
295	CALL iom_get( numror, jpdom_autoglo, 'hdivb' , hdivb, lrxios = lxios_read )
296	CALL iom_get( numror, jpdom_autoglo, 'sshb' , sshb, lrxios = lxios_read )
297	ELSE
298	neuler = 0
299	ENDIF
300	!
301	CALL iom_get( numror, jpdom_autoglo, 'un' , un, lrxios = lxios_read ) ! now fields
302	CALL iom_get( numror, jpdom_autoglo, 'vn' , vn, lrxios = lxios_read )
303	CALL iom_get( numror, jpdom_autoglo, 'tn' , tsn(:,:,:,jp_tem), lrxios = lxios_read )
304	CALL iom_get( numror, jpdom_autoglo, 'sn' , tsn(:,:,:,jp_sal), lrxios = lxios_read )
305	CALL iom_get( numror, jpdom_autoglo, 'sshn' , sshn, lrxios = lxios_read )
306	IF( iom_varid( numror, 'rotn', ldstop = .FALSE. ) > 0 ) THEN
307	CALL iom_get( numror, jpdom_autoglo, 'rotn' , rotn, lrxios = lxios_read )
308	CALL iom_get( numror, jpdom_autoglo, 'hdivn' , hdivn, lrxios = lxios_read )
309	ELSE
310	CALL div_cur( 0 ) ! Horizontal divergence & Relative vorticity
311	ENDIF
312	IF( iom_varid( numror, 'rhop', ldstop = .FALSE. ) > 0 ) THEN
313	CALL iom_get( numror, jpdom_autoglo, 'rhop' , rhop, lrxios = lxios_read ) ! now potential density
314	ELSE
315	CALL eos ( tsn, rhd, rhop, fsdept_n(:,:,:) )
316	ENDIF
317	#if defined key_zdfkpp
318	IF( iom_varid( numror, 'rhd', ldstop = .FALSE. ) > 0 ) THEN
319	CALL iom_get( numror, jpdom_autoglo, 'rhd' , rhd, lrxios = lxios_read ) ! now in situ density anomaly
320	ELSE
321	CALL eos( tsn, rhd, fsdept_n(:,:,:) ) ! compute rhd
322	ENDIF
323	#endif
324	!
325	IF( iom_varid( numror, 'greenland_icesheet_mass', ldstop = .FALSE. ) > 0 ) THEN
326	CALL iom_get( numror, 'greenland_icesheet_mass', greenland_icesheet_mass, lrxios = lxios_read )
327	CALL iom_get( numror, 'greenland_icesheet_timelapsed', greenland_icesheet_timelapsed, lrxios = lxios_read )
328	CALL iom_get( numror, 'greenland_icesheet_mass_roc', greenland_icesheet_mass_rate_of_change, lrxios = lxios_read )
329	ELSE
330	greenland_icesheet_mass = 0.0
331	greenland_icesheet_mass_rate_of_change = 0.0
332	greenland_icesheet_timelapsed = 0.0
333	ENDIF
334	IF( iom_varid( numror, 'antarctica_icesheet_mass', ldstop = .FALSE. ) > 0 ) THEN
335	CALL iom_get( numror, 'antarctica_icesheet_mass', antarctica_icesheet_mass, lrxios = lxios_read )
336	CALL iom_get( numror, 'antarctica_icesheet_timelapsed', antarctica_icesheet_timelapsed, lrxios = lxios_read )
337	CALL iom_get( numror, 'antarctica_icesheet_mass_roc', antarctica_icesheet_mass_rate_of_change, lrxios = lxios_read )
338	ELSE
339	antarctica_icesheet_mass = 0.0
340	antarctica_icesheet_mass_rate_of_change = 0.0
341	antarctica_icesheet_timelapsed = 0.0
342	ENDIF
343	! IF( nn_timing == 1 ) CALL timing_stop('iom_read')
344
345	IF( neuler == 0 ) THEN ! Euler restart (neuler=0)
346	tsb (:,:,:,:) = tsn (:,:,:,:) ! all before fields set to now values
347	ub (:,:,:) = un (:,:,:)
348	vb (:,:,:) = vn (:,:,:)
349	rotb (:,:,:) = rotn (:,:,:)
350	hdivb(:,:,:) = hdivn(:,:,:)
351	sshb (:,:) = sshn (:,:)
352
353	IF( lk_vvl ) THEN
354	DO jk = 1, jpk
355	fse3t_b(:,:,jk) = fse3t_n(:,:,jk)
356	END DO
357	ENDIF
358
359	ENDIF
360	!
361	END SUBROUTINE rst_read
362	!!=====================================================================
363	END MODULE restart

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

New URL for NEMO forge! http://forge.nemo-ocean.eu

Context Navigation

source: branches/UKMO/test_moci_test_suite_namelist_read/NEMOGCM/NEMO/OPA_SRC/IOM/restart.F90 @ 12489

Download in other formats: