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.

iom.F90 in NEMO/branches/2019/dev_r11756_SI3restart_XIOS/src/OCE/IOM – NEMO

Context Navigation

source: NEMO/branches/2019/dev_r11756_SI3restart_XIOS/src/OCE/IOM/iom.F90 @ 11893

Last change on this file since 11893 was 11893, checked in by andmirek, 4 years ago
Ticket #2323 read/write SI3 restart file
Property svn:keywords set to `Id`
File size: 150.3 KB

Line
1	MODULE iom
2	!!======================================================================
3	!! * MODULE iom *
4	!! Input/Output manager : Library to read input files
5	!!======================================================================
6	!! History : 2.0 ! 2005-12 (J. Belier) Original code
7	!! 2.0 ! 2006-02 (S. Masson) Adaptation to NEMO
8	!! 3.0 ! 2007-07 (D. Storkey) Changes to iom_gettime
9	!! 3.4 ! 2012-12 (R. Bourdalle-Badie and G. Reffray) add C1D case
10	!! 3.6 ! 2014-15 DIMG format removed
11	!! 3.6 ! 2015-15 (J. Harle) Added procedure to read REAL attributes
12	!! 4.0 ! 2017-11 (M. Andrejczuk) Extend IOM interface to write any 3D fields
13	!!----------------------------------------------------------------------
14
15	!!----------------------------------------------------------------------
16	!! iom_open : open a file read only
17	!! iom_close : close a file or all files opened by iom
18	!! iom_get : read a field (interfaced to several routines)
19	!! iom_varid : get the id of a variable in a file
20	!! iom_rstput : write a field in a restart file (interfaced to several routines)
21	!!----------------------------------------------------------------------
22	USE dom_oce ! ocean space and time domain
23	USE c1d ! 1D vertical configuration
24	USE flo_oce ! floats module declarations
25	USE lbclnk ! lateal boundary condition / mpp exchanges
26	USE iom_def ! iom variables definitions
27	USE iom_nf90 ! NetCDF format with native NetCDF library
28	USE in_out_manager ! I/O manager
29	USE lib_mpp ! MPP library
30	#if defined key_iomput
31	USE sbc_oce , ONLY : nn_fsbc ! ocean space and time domain
32	USE trc_oce , ONLY : nn_dttrc ! !: frequency of step on passive tracers
33	USE icb_oce , ONLY : nclasses, class_num ! !: iceberg classes
34	#if defined key_si3
35	USE ice , ONLY : jpl
36	#endif
37	USE domngb ! ocean space and time domain
38	USE phycst ! physical constants
39	USE dianam ! build name of file
40	USE xios
41	# endif
42	USE ioipsl, ONLY : ju2ymds ! for calendar
43	USE crs ! Grid coarsening
44	#if defined key_top
45	USE trc, ONLY : profsed
46	#endif
47	USE lib_fortran
48	USE diurnal_bulk, ONLY : ln_diurnal_only, ln_diurnal
49	#if defined key_si3
50	USE ice, ONLY: nlay_i, nlay_s, cn_icerst_outdir, cn_icerst_out
51	#endif
52
53
54	IMPLICIT NONE
55	PUBLIC ! must be public to be able to access iom_def through iom
56
57	#if defined key_iomput
58	LOGICAL, PUBLIC, PARAMETER :: lk_iomput = .TRUE. !: iom_put flag
59	#else
60	LOGICAL, PUBLIC, PARAMETER :: lk_iomput = .FALSE. !: iom_put flag
61	#endif
62	PUBLIC iom_init, iom_swap, iom_open, iom_close, iom_setkt, iom_varid, iom_get
63	PUBLIC iom_chkatt, iom_getatt, iom_putatt, iom_getszuld, iom_rstput, iom_delay_rst, iom_put
64	PUBLIC iom_use, iom_context_finalize, iom_miss_val
65
66	PRIVATE iom_rp0d, iom_rp1d, iom_rp2d, iom_rp3d, iom_rp4d
67	PRIVATE iom_g0d, iom_g1d, iom_g2d, iom_g3d, iom_g4d, iom_get_123d
68	PRIVATE iom_p1d, iom_p2d, iom_p3d
69	#if defined key_iomput
70	PRIVATE iom_set_domain_attr, iom_set_axis_attr, iom_set_field_attr, iom_set_file_attr, iom_get_file_attr, iom_set_grid_attr
71	PRIVATE set_grid, set_grid_bounds, set_scalar, set_xmlatt, set_mooring, iom_update_file_name, iom_sdate
72	PRIVATE iom_set_rst_context, iom_set_rstw_active, iom_set_rstr_active
73	# endif
74	PRIVATE iom_define_restartw, iom_set_rstw_validate
75	PUBLIC iom_set_rstw_var_active, iom_set_rstw_core, iom_set_rst_vars
76	PRIVATE iom_add
77	INTEGER, PRIVATE :: numrst
78	CHARACTER(len=12), PRIVATE :: snr
79
80
81	INTERFACE iom_get
82	MODULE PROCEDURE iom_g0d, iom_g1d, iom_g2d, iom_g3d, iom_g4d
83	END INTERFACE
84	INTERFACE iom_getatt
85	MODULE PROCEDURE iom_g0d_iatt, iom_g1d_iatt, iom_g0d_ratt, iom_g1d_ratt, iom_g0d_catt
86	END INTERFACE
87	INTERFACE iom_putatt
88	MODULE PROCEDURE iom_p0d_iatt, iom_p1d_iatt, iom_p0d_ratt, iom_p1d_ratt, iom_p0d_catt
89	END INTERFACE
90	INTERFACE iom_rstput
91	MODULE PROCEDURE iom_rp0d, iom_rp1d, iom_rp2d, iom_rp3d, iom_rp4d
92	END INTERFACE
93	INTERFACE iom_put
94	MODULE PROCEDURE iom_p0d, iom_p1d, iom_p2d, iom_p3d
95	END INTERFACE iom_put
96
97	!!----------------------------------------------------------------------
98	!! NEMO/OCE 4.0 , NEMO Consortium (2018)
99	!! $Id$
100	!! Software governed by the CeCILL license (see ./LICENSE)
101	!!----------------------------------------------------------------------
102	CONTAINS
103
104	SUBROUTINE iom_init( cdname, fname, ld_tmppatch )
105	!!----------------------------------------------------------------------
106	!! * ROUTINE *
107	!!
108	!! ** Purpose :
109	!!
110	!!----------------------------------------------------------------------
111	CHARACTER(len=*), INTENT(in) :: cdname
112	CHARACTER(len=*), OPTIONAL, INTENT(in) :: fname
113	LOGICAL , OPTIONAL, INTENT(in) :: ld_tmppatch
114	#if defined key_iomput
115	!
116	TYPE(xios_duration) :: dtime = xios_duration(0, 0, 0, 0, 0, 0)
117	TYPE(xios_date) :: start_date
118	CHARACTER(len=lc) :: clname
119	INTEGER :: ji, jkmin
120	LOGICAL :: llrst_context ! is context related to restart
121	!
122	REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: zt_bnds, zw_bnds
123	LOGICAL :: ll_tmppatch = .TRUE. !: seb: patch before we remove periodicity
124	INTEGER :: nldi_save, nlei_save !: and close boundaries in output files
125	INTEGER :: nldj_save, nlej_save !:
126	!!----------------------------------------------------------------------
127	!
128	! seb: patch before we remove periodicity and close boundaries in output files
129	IF( PRESENT(ld_tmppatch) ) THEN ; ll_tmppatch = ld_tmppatch
130	ELSE ; ll_tmppatch = .TRUE.
131	ENDIF
132	IF ( ll_tmppatch ) THEN
133	nldi_save = nldi ; nlei_save = nlei
134	nldj_save = nldj ; nlej_save = nlej
135	IF( nimpp == 1 ) nldi = 1
136	IF( nimpp + jpi - 1 == jpiglo ) nlei = jpi
137	IF( njmpp == 1 ) nldj = 1
138	IF( njmpp + jpj - 1 == jpjglo ) nlej = jpj
139	ENDIF
140	!
141	ALLOCATE( zt_bnds(2,jpk), zw_bnds(2,jpk) )
142	!
143	clname = cdname
144	IF( TRIM(Agrif_CFixed()) /= '0' ) clname = TRIM(Agrif_CFixed())//"_"//TRIM(cdname)
145	CALL xios_context_initialize(TRIM(clname), mpi_comm_oce)
146	CALL iom_swap( cdname )
147	llrst_context = (TRIM(cdname) == TRIM(crxios_context) .OR. TRIM(cdname) == TRIM(cwxios_context))
148
149	! Calendar type is now defined in xml file
150	SELECT CASE ( nleapy ) ! Choose calendar for IOIPSL
151	CASE ( 1) ; CALL xios_define_calendar( TYPE = "Gregorian", time_origin = xios_date(1900,01,01,00,00,00), &
152	& start_date = xios_date(nyear,nmonth,nday,0,0,0) )
153	CASE ( 0) ; CALL xios_define_calendar( TYPE = "NoLeap" , time_origin = xios_date(1900,01,01,00,00,00), &
154	& start_date = xios_date(nyear,nmonth,nday,0,0,0) )
155	CASE (30) ; CALL xios_define_calendar( TYPE = "D360" , time_origin = xios_date(1900,01,01,00,00,00), &
156	& start_date = xios_date(nyear,nmonth,nday,0,0,0) )
157	END SELECT
158
159	! horizontal grid definition
160	IF(.NOT.llrst_context) CALL set_scalar
161	!
162	IF( TRIM(cdname) == TRIM(cxios_context) ) THEN
163	CALL set_grid( "T", glamt, gphit, .FALSE., .FALSE. )
164	CALL set_grid( "U", glamu, gphiu, .FALSE., .FALSE. )
165	CALL set_grid( "V", glamv, gphiv, .FALSE., .FALSE. )
166	CALL set_grid( "W", glamt, gphit, .FALSE., .FALSE. )
167	CALL set_grid_znl( gphit )
168	!
169	IF( ln_cfmeta ) THEN ! Add additional grid metadata
170	CALL iom_set_domain_attr("grid_T", area = e1e2t(nldi:nlei, nldj:nlej))
171	CALL iom_set_domain_attr("grid_U", area = e1e2u(nldi:nlei, nldj:nlej))
172	CALL iom_set_domain_attr("grid_V", area = e1e2v(nldi:nlei, nldj:nlej))
173	CALL iom_set_domain_attr("grid_W", area = e1e2t(nldi:nlei, nldj:nlej))
174	CALL set_grid_bounds( "T", glamf, gphif, glamt, gphit )
175	CALL set_grid_bounds( "U", glamv, gphiv, glamu, gphiu )
176	CALL set_grid_bounds( "V", glamu, gphiu, glamv, gphiv )
177	CALL set_grid_bounds( "W", glamf, gphif, glamt, gphit )
178	ENDIF
179	ENDIF
180	!
181	IF( TRIM(cdname) == TRIM(cxios_context)//"_crs" ) THEN
182	CALL dom_grid_crs ! Save the parent grid information & Switch to coarse grid domain
183	!
184	CALL set_grid( "T", glamt_crs, gphit_crs, .FALSE., .FALSE. )
185	CALL set_grid( "U", glamu_crs, gphiu_crs, .FALSE., .FALSE. )
186	CALL set_grid( "V", glamv_crs, gphiv_crs, .FALSE., .FALSE. )
187	CALL set_grid( "W", glamt_crs, gphit_crs, .FALSE., .FALSE. )
188	CALL set_grid_znl( gphit_crs )
189	!
190	CALL dom_grid_glo ! Return to parent grid domain
191	!
192	IF( ln_cfmeta .AND. .NOT. llrst_context) THEN ! Add additional grid metadata
193	CALL iom_set_domain_attr("grid_T", area = e1e2t_crs(nldi:nlei, nldj:nlej))
194	CALL iom_set_domain_attr("grid_U", area = e1u_crs(nldi:nlei, nldj:nlej) * e2u_crs(nldi:nlei, nldj:nlej))
195	CALL iom_set_domain_attr("grid_V", area = e1v_crs(nldi:nlei, nldj:nlej) * e2v_crs(nldi:nlei, nldj:nlej))
196	CALL iom_set_domain_attr("grid_W", area = e1e2t_crs(nldi:nlei, nldj:nlej))
197	CALL set_grid_bounds( "T", glamf_crs, gphif_crs, glamt_crs, gphit_crs )
198	CALL set_grid_bounds( "U", glamv_crs, gphiv_crs, glamu_crs, gphiu_crs )
199	CALL set_grid_bounds( "V", glamu_crs, gphiu_crs, glamv_crs, gphiv_crs )
200	CALL set_grid_bounds( "W", glamf_crs, gphif_crs, glamt_crs, gphit_crs )
201	ENDIF
202	ENDIF
203	!
204	! vertical grid definition
205	IF(.NOT.llrst_context) THEN
206	CALL iom_set_axis_attr( "deptht", paxis = gdept_1d )
207	CALL iom_set_axis_attr( "depthu", paxis = gdept_1d )
208	CALL iom_set_axis_attr( "depthv", paxis = gdept_1d )
209	CALL iom_set_axis_attr( "depthw", paxis = gdepw_1d )
210
211	! Add vertical grid bounds
212	jkmin = MIN(2,jpk) ! in case jpk=1 (i.e. sas2D)
213	zt_bnds(2,: ) = gdept_1d(:)
214	zt_bnds(1,jkmin:jpk) = gdept_1d(1:jpkm1)
215	zt_bnds(1,1 ) = gdept_1d(1) - e3w_1d(1)
216	zw_bnds(1,: ) = gdepw_1d(:)
217	zw_bnds(2,1:jpkm1 ) = gdepw_1d(jkmin:jpk)
218	zw_bnds(2,jpk: ) = gdepw_1d(jpk) + e3t_1d(jpk)
219	CALL iom_set_axis_attr( "deptht", bounds=zw_bnds )
220	CALL iom_set_axis_attr( "depthu", bounds=zw_bnds )
221	CALL iom_set_axis_attr( "depthv", bounds=zw_bnds )
222	CALL iom_set_axis_attr( "depthw", bounds=zt_bnds )
223	CALL iom_set_axis_attr( "nfloat", (/ (REAL(ji,wp), ji=1,jpnfl) /) )
224	# if defined key_si3
225	CALL iom_set_axis_attr( "ncatice", (/ (REAL(ji,wp), ji=1,jpl) /) )
226	! SIMIP diagnostics (4 main arctic straits)
227	CALL iom_set_axis_attr( "nstrait", (/ (REAL(ji,wp), ji=1,4) /) )
228	# endif
229	#if defined key_top
230	IF( ALLOCATED(profsed) ) CALL iom_set_axis_attr( "profsed", paxis = profsed )
231	#endif
232	CALL iom_set_axis_attr( "icbcla", class_num )
233	CALL iom_set_axis_attr( "iax_20C", (/ REAL(20,wp) /) ) ! strange syntaxe and idea...
234	CALL iom_set_axis_attr( "iax_28C", (/ REAL(28,wp) /) ) ! strange syntaxe and idea...
235	ENDIF
236	!
237	! automatic definitions of some of the xml attributs
238	IF( TRIM(cdname) == TRIM(crxios_context) .OR. TRIM(cdname) == TRIM(crixios_context) ) THEN
239	numrst = numror
240	IF(TRIM(cdname) == TRIM(crixios_context)) numrst = numrir
241	!set names of the fields in restart file IF using XIOS to read data
242	CALL iom_set_rst_context(.TRUE.)
243	CALL iom_set_rst_vars(rst_rfields)
244	!set which fields are to be read from restart file
245	CALL iom_set_rstr_active(fname)
246	ELSE IF( TRIM(cdname) == TRIM(cwxios_context)) THEN
247	!validate output for issues
248	CALL iom_set_rstw_validate()
249	!set names of the fields in restart file IF using XIOS to write data
250	CALL iom_set_rst_context(.FALSE.) ! grid definition
251	!set which fields are to be written to a restart file
252	CALL iom_define_restartw() ! fields and files definition
253	ELSE
254	CALL set_xmlatt
255	ENDIF
256	!
257	! end file definition
258	dtime%second = rdt
259	CALL xios_set_timestep( dtime )
260	CALL xios_close_context_definition()
261	CALL xios_update_calendar( 0 )
262	!
263	DEALLOCATE( zt_bnds, zw_bnds )
264	!
265	IF ( ll_tmppatch ) THEN
266	nldi = nldi_save ; nlei = nlei_save
267	nldj = nldj_save ; nlej = nlej_save
268	ENDIF
269	#endif
270	!
271	END SUBROUTINE iom_init
272
273	SUBROUTINE iom_define_restartw()
274	!!---------------------------------------------------------------------
275	!! * SUBROUTINE iom_define_restatw *
276	!!
277	!! ** Purpose : Add files in nemo context to write restart (one and si3)
278	!!---------------------------------------------------------------------
279	INTEGER :: kt
280	CHARACTER(LEN=50) :: clname ! ocean output restart file name
281	CHARACTER(lc) :: clpath ! full path to ocean output restart file
282	CHARACTER(LEN=52) :: clpname ! ocean output restart file name including prefix for AGRIF
283	CHARACTER(LEN=20) :: clkt ! ocean time-step deine as a character
284	INTEGER :: iterx, nitrstx, nrst_lstx
285	LOGICAL :: lrst_icex, lrst_ocex
286	#if defined key_iomput
287
288	IF( ln_rst_list ) THEN
289	nrst_lstx = 1
290	nitrstx = nn_stocklist( nrst_lst )
291	ELSE
292	nitrstx = nitend
293	ENDIF
294
295	IF( .NOT. ln_rst_list .AND. nn_stock == -1 ) RETURN ! we will never do any restart
296
297	DO kt = nit000, nitend
298	IF( .NOT. ln_rst_list .AND. MOD( kt - 1, nn_stock ) == 0 ) THEN
299	! we use kt - 1 and not kt - nit000 to keep the same periodicity from the beginning of the experiment
300	nitrstx = kt + nn_stock - 1 ! define the next value of nitrst for restart writing
301	IF( nitrstx > nitend ) nitrstx = nitend ! make sure we write a restart at the end of the run
302	ENDIF
303	IF( kt == nitrstx .OR. nn_stock == 1 .OR. kt == nitend ) THEN
304	IF( nitrstx <= nitend .AND. nitrstx > 0 ) THEN
305
306	IF( nitrst > 999999999 ) THEN ; WRITE(clkt, * ) nitrstx
307	ELSE ; WRITE(clkt, '(i8.8)') nitrstx
308	ENDIF
309	! create the file
310	clname = TRIM(cexper)//"_"//TRIM(ADJUSTL(clkt))//"_"//TRIM(cn_ocerst_out)
311	clpath = TRIM(cn_ocerst_outdir)
312	IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
313	IF(lwp) THEN
314	write(numout, *) 'Create restart file at the step: ', kt
315	ENDIF
316	CALL iom_set_rstw_active(rst_wfields, TRIM(clpath)//TRIM(clname), nitrstx)
317	ENDIF
318	ENDIF
319	#if defined key_si3
320	IF( kt == nitrstx - 2*nn_fsbc + 1 .OR. nn_stock == nn_fsbc &
321	& .OR. ( kt == nitend - nn_fsbc + 1 .AND. .NOT. lrst_icex ) ) THEN
322	IF( nitrst <= nitend .AND. nitrst > 0 ) THEN
323	! beware of the format used to write kt (default is i8.8, that should be large enough...)
324	IF( nitrst > 99999999 ) THEN ; WRITE(clkt, * ) nitrstx
325	ELSE ; WRITE(clkt, '(i8.8)') nitrstx
326	ENDIF
327	! create the file
328	clname = TRIM(cexper)//"_"//TRIM(ADJUSTL(clkt))//"_"//TRIM(cn_icerst_out)
329	clpath = TRIM(cn_icerst_outdir)
330	IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath)//'/'
331	IF(lwp) THEN
332	WRITE(numout,*)
333	WRITE(numout,*) ' Create ice restart NetCDF file: ',TRIM(clpath)//clname
334	IF( kt == nitrstx - 2*nn_fsbc + 1 ) THEN
335	WRITE(numout,) ' kt = nitrst - 2nn_fsbc + 1 = ', kt,' date= ', ndastp
336	ELSE
337	WRITE(numout,*) ' kt = ' , kt,' date= ', ndastp
338	ENDIF
339	ENDIF
340	lrst_icex = .TRUE.
341	CALL iom_set_rstw_active(rsti_wfields, TRIM(clpath)//TRIM(clname), nitrstx)
342	ENDIF
343	ENDIF
344	iterx = kt + nn_fsbc - 1
345	IF( iterx == nitrstx ) THEN
346	lrst_icex = .FALSE.
347	lrst_ocex = .FALSE.
348	ENDIF
349	#endif
350	IF( ln_rst_list .AND. kt == nitrst) THEN
351	nrst_lstx = MIN(nrst_lst + 1, SIZE(nn_stocklist,1))
352	nitrstx = nn_stocklist( nrst_lst )
353	ENDIF
354	ENDDO
355	#endif
356	END SUBROUTINE iom_define_restartw
357
358	SUBROUTINE iom_set_rstw_validate()
359	!!---------------------------------------------------------------------
360	!! * SUBROUTINE iom_set_rst_validate *
361	!!
362	!! ** Purpose : validate restart files. This routine is only used if
363	!! restart is written with XIOS. It will check if the same variable
364	!! is written into more than 1 file. Currently with XIOS
365	!! the same variable can't be written into 2 different files. Print
366	!! warning if it's a case.
367	!!---------------------------------------------------------------------
368	INTEGER :: ik, jk
369	CHARACTER(LEN=256) :: clinfo ! info character
370
371	#if defined key_si3
372	DO ik =1, max_rst_fields
373	IF(rst_wfields(ik)%active) THEN
374	DO jk = 1, max_rst_fields
375	IF(rsti_wfields(jk)%active .AND. (TRIM(rsti_wfields(jk)%vname) == TRIM(rst_wfields(ik)%vname))) THEN
376	clinfo = 'Varaible '//TRIM(rsti_wfields(jk)%vname)//' will be written in NEMO and SI3 restart file!'
377	CALL ctl_warn( 'From iom_set_rstw_validate: ', &
378	trim(clinfo), 'This will cause problems with XIOS; use iom interface instead or rename', &
379	& 'in one of the restart files')
380	ENDIF
381	ENDDO
382	ENDIF
383	ENDDO
384	#endif
385
386	END SUBROUTINE iom_set_rstw_validate
387
388	SUBROUTINE iom_set_rstw_var_active(drst_wfields, field)
389	!!---------------------------------------------------------------------
390	!! * SUBROUTINE iom_set_rstw_var_active *
391	!!
392	!! ** Purpose : enable variable in restart file when writing with XIOS
393	!!---------------------------------------------------------------------
394	CHARACTER(len = *), INTENT(IN) :: field
395	TYPE(RST_FIELD), INTENT(INOUT) :: drst_wfields(max_rst_fields)
396	INTEGER :: i
397	LOGICAL :: llis_set
398	CHARACTER(LEN=256) :: clinfo ! info character
399
400	#if defined key_iomput
401	llis_set = .FALSE.
402
403	DO i = 1, max_rst_fields
404	IF(TRIM(drst_wfields(i)%vname) == field) THEN
405	drst_wfields(i)%active = .TRUE.
406	llis_set = .TRUE.
407	EXIT
408	ENDIF
409	ENDDO
410	!Warn if variable is not in defined in drst_wfields
411	IF(.NOT.llis_set) THEN
412	WRITE(ctmp1,*) 'iom_set_rstw_var_active: variable ', field ,' is available for writing but not defined'
413	CALL ctl_stop( 'iom_set_rstw_var_active:', ctmp1 )
414	ENDIF
415	#else
416	clinfo = 'iom_set_rstw_var_active: key_iomput is needed to use XIOS restart read/write functionality'
417	CALL ctl_stop('STOP', TRIM(clinfo))
418	#endif
419
420	END SUBROUTINE iom_set_rstw_var_active
421
422	SUBROUTINE iom_set_rstr_active(rst_file)
423	!!---------------------------------------------------------------------
424	!! * SUBROUTINE iom_set_rstr_active *
425	!!
426	!! ** Purpose : define file name in XIOS context for reading restart file,
427	!! enable variables present in restart file for reading with XIOS
428	!!---------------------------------------------------------------------
429
430	!sets enabled = .TRUE. for each field in restart file
431	CHARACTER(len=256) :: rst_file
432
433	#if defined key_iomput
434	TYPE(xios_field) :: field_hdl
435	TYPE(xios_file) :: file_hdl
436	TYPE(xios_filegroup) :: filegroup_hdl
437	INTEGER :: i
438
439	!set name of the restart file and enable available fields
440	if(lwp) WRITE(numout,*) 'Setting restart filename (for XIOS) to: ',rst_file
441	CALL xios_get_handle("file_definition", filegroup_hdl )
442	CALL xios_add_child(filegroup_hdl, file_hdl, 'rrestart')
443	CALL xios_set_file_attr( "rrestart", name=trim(rst_file), type="one_file", &
444	par_access="collective", enabled=.TRUE., mode="read", &
445	output_freq=xios_timestep)
446	!define variables for restart context
447	DO i = 1, max_rst_fields
448	IF( TRIM(rst_rfields(i)%vname) /= "NO_NAME") THEN
449	IF( iom_varid( numrst, TRIM(rst_rfields(i)%vname), ldstop = .FALSE. ) > 0 ) THEN
450	IF(TRIM(rst_rfields(i)%vname) == "e_s") lrsi3_nemo = .FALSE. ! SI3 restart written by XIOS
451	CALL xios_add_child(file_hdl, field_hdl, TRIM(rst_rfields(i)%vname))
452	SELECT CASE (TRIM(rst_rfields(i)%grid))
453	#if defined key_si3
454	CASE ("grid_Ni_4D")
455	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(rst_rfields(i)%vname), &
456	grid_ref="grid_Ni_4D", operation = "instant")
457	CASE ("grid_Ns_4D")
458	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(rst_rfields(i)%vname), &
459	grid_ref="grid_Ns_4D", operation = "instant")
460	CASE ("grid_Ni_3D")
461	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(rst_rfields(i)%vname), &
462	domain_ref="grid_N", axis_ref="numcat", operation = "instant")
463	#endif
464	CASE ("grid_N_3D")
465	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(rst_rfields(i)%vname), &
466	domain_ref="grid_N", axis_ref="nav_lev", operation = "instant")
467	CASE ("grid_N")
468	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(rst_rfields(i)%vname), &
469	domain_ref="grid_N", operation = "instant")
470	CASE ("grid_vector")
471	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(rst_rfields(i)%vname), &
472	axis_ref="nav_lev", operation = "instant")
473	CASE ("grid_scalar")
474	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(rst_rfields(i)%vname), &
475	scalar_ref = "grid_scalar", operation = "instant")
476	END SELECT
477	IF(lwp) WRITE(numout,*) 'XIOS read: ', TRIM(rst_rfields(i)%vname), ' enabled in ', TRIM(rst_file)
478	ENDIF
479	ENDIF
480	END DO
481	#endif
482	END SUBROUTINE iom_set_rstr_active
483
484	SUBROUTINE iom_set_rstw_core(drst_wfields, cdmdl)
485	!!---------------------------------------------------------------------
486	!! * SUBROUTINE iom_set_rstw_core *
487	!!
488	!! ** Purpose : set variables which are always in restart file
489	!!---------------------------------------------------------------------
490	CHARACTER (len=*), INTENT (IN) :: cdmdl ! model OPA, SAS or SI3
491	TYPE(RST_FIELD), INTENT(INOUT) :: drst_wfields(max_rst_fields)
492	CHARACTER(LEN=256) :: clinfo ! info character
493	CHARACTER(len=25) :: znam
494	CHARACTER(len=2) :: zchar1
495	INTEGER :: jk
496	#if defined key_iomput
497	IF(cdmdl == "OPA") THEN
498	!from restart.F90
499	CALL iom_set_rstw_var_active(drst_wfields, "rdt")
500	IF ( .NOT. ln_diurnal_only ) THEN
501	CALL iom_set_rstw_var_active(drst_wfields, 'ub' )
502	CALL iom_set_rstw_var_active(drst_wfields, 'vb' )
503	CALL iom_set_rstw_var_active(drst_wfields, 'tb' )
504	CALL iom_set_rstw_var_active(drst_wfields, 'sb' )
505	CALL iom_set_rstw_var_active(drst_wfields, 'sshb')
506	!
507	CALL iom_set_rstw_var_active(drst_wfields, 'un' )
508	CALL iom_set_rstw_var_active(drst_wfields, 'vn' )
509	CALL iom_set_rstw_var_active(drst_wfields, 'tn' )
510	CALL iom_set_rstw_var_active(drst_wfields, 'sn' )
511	CALL iom_set_rstw_var_active(drst_wfields, 'sshn')
512	CALL iom_set_rstw_var_active(drst_wfields, 'rhop')
513	! extra variable needed for the ice sheet coupling
514	IF ( ln_iscpl ) THEN
515	CALL iom_set_rstw_var_active(drst_wfields, 'tmask')
516	CALL iom_set_rstw_var_active(drst_wfields, 'umask')
517	CALL iom_set_rstw_var_active(drst_wfields, 'vmask')
518	CALL iom_set_rstw_var_active(drst_wfields, 'smask')
519	CALL iom_set_rstw_var_active(drst_wfields, 'e3t_n')
520	CALL iom_set_rstw_var_active(drst_wfields, 'e3u_n')
521	CALL iom_set_rstw_var_active(drst_wfields, 'e3v_n')
522	CALL iom_set_rstw_var_active(drst_wfields, 'gdepw_n')
523	END IF
524	ENDIF
525	IF(ln_diurnal) CALL iom_set_rstw_var_active(drst_wfields, 'Dsst')
526	!from trasbc.F90
527	CALL iom_set_rstw_var_active(drst_wfields, 'sbc_hc_b')
528	CALL iom_set_rstw_var_active(drst_wfields, 'sbc_sc_b')
529	ELSE IF(cdmdl == "SI3") THEN
530	#if defined key_si3
531	CALL iom_set_rstw_var_active(drst_wfields, 'nn_fsbc_ice')
532	CALL iom_set_rstw_var_active(drst_wfields, 'kt_ice' )
533	CALL iom_set_rstw_var_active(drst_wfields, 'v_i' )
534	CALL iom_set_rstw_var_active(drst_wfields, 'v_s' )
535	CALL iom_set_rstw_var_active(drst_wfields, 'sv_i' )
536	CALL iom_set_rstw_var_active(drst_wfields, 'a_i' )
537	CALL iom_set_rstw_var_active(drst_wfields, 't_su' )
538	CALL iom_set_rstw_var_active(drst_wfields, 'u_ice' )
539	CALL iom_set_rstw_var_active(drst_wfields, 'v_ice' )
540	CALL iom_set_rstw_var_active(drst_wfields, 'oa_i' )
541	CALL iom_set_rstw_var_active(drst_wfields, 'a_ip' )
542	CALL iom_set_rstw_var_active(drst_wfields, 'v_ip' )
543	CALL iom_set_rstw_var_active(drst_wfields, 'e_s' )
544	CALL iom_set_rstw_var_active(drst_wfields, 'e_i' )
545	#endif
546	ENDIF
547	#else
548	clinfo = 'iom_set_rstw_core: key_iomput is needed to use XIOS restart read/write functionality'
549	CALL ctl_stop('STOP', TRIM(clinfo))
550	#endif
551	END SUBROUTINE iom_set_rstw_core
552
553	SUBROUTINE iom_set_rst_vars(fields)
554	!!---------------------------------------------------------------------
555	!! * SUBROUTINE iom_set_rst_vars *
556	!!
557	!! ** Purpose : Fill array fields with the information about all
558	!! possible variables and corresponding grids definition
559	!! for reading/writing restart with XIOS
560	!!---------------------------------------------------------------------
561	TYPE(RST_FIELD), INTENT(INOUT) :: fields(max_rst_fields)
562	INTEGER :: i, jk
563	CHARACTER(len=2) :: zchar
564	CHARACTER(len=25) :: znam
565
566	i = 0
567	i = iom_add(i); fields(i)%vname="rdt"; fields(i)%grid="grid_scalar"
568	i = iom_add(i); fields(i)%vname="un"; fields(i)%grid="grid_N_3D"
569	i = iom_add(i); fields(i)%vname="ub"; fields(i)%grid="grid_N_3D"
570	i = iom_add(i); fields(i)%vname="vn"; fields(i)%grid="grid_N_3D"
571	i = iom_add(i); fields(i)%vname="vb"; fields(i)%grid="grid_N_3D"
572	i = iom_add(i); fields(i)%vname="tn"; fields(i)%grid="grid_N_3D"
573	i = iom_add(i); fields(i)%vname="tb"; fields(i)%grid="grid_N_3D"
574	i = iom_add(i); fields(i)%vname="sn"; fields(i)%grid="grid_N_3D"
575	i = iom_add(i); fields(i)%vname="sb"; fields(i)%grid="grid_N_3D"
576	i = iom_add(i); fields(i)%vname="sshn"; fields(i)%grid="grid_N"
577	i = iom_add(i); fields(i)%vname="sshb"; fields(i)%grid="grid_N"
578	i = iom_add(i); fields(i)%vname="rhop"; fields(i)%grid="grid_N_3D"
579	i = iom_add(i); fields(i)%vname="kt"; fields(i)%grid="grid_scalar"
580	i = iom_add(i); fields(i)%vname="ndastp"; fields(i)%grid="grid_scalar"
581	i = iom_add(i); fields(i)%vname="adatrj"; fields(i)%grid="grid_scalar"
582	i = iom_add(i); fields(i)%vname="utau_b"; fields(i)%grid="grid_N"
583	i = iom_add(i); fields(i)%vname="vtau_b"; fields(i)%grid="grid_N"
584	i = iom_add(i); fields(i)%vname="qns_b"; fields(i)%grid="grid_N"
585	i = iom_add(i); fields(i)%vname="emp_b"; fields(i)%grid="grid_N"
586	i = iom_add(i); fields(i)%vname="sfx_b"; fields(i)%grid="grid_N"
587	i = iom_add(i); fields(i)%vname="en" ; fields(i)%grid="grid_N_3D"
588	i = iom_add(i); fields(i)%vname="avt_k"; fields(i)%grid="grid_N_3D"
589	i = iom_add(i); fields(i)%vname="avm_k"; fields(i)%grid="grid_N_3D"
590	i = iom_add(i); fields(i)%vname="dissl"; fields(i)%grid="grid_N_3D"
591	i = iom_add(i); fields(i)%vname="sbc_hc_b"; fields(i)%grid="grid_N"
592	i = iom_add(i); fields(i)%vname="sbc_sc_b"; fields(i)%grid="grid_N"
593	i = iom_add(i); fields(i)%vname="qsr_hc_b"; fields(i)%grid="grid_N_3D"
594	i = iom_add(i); fields(i)%vname="fraqsr_1lev"; fields(i)%grid="grid_N"
595	i = iom_add(i); fields(i)%vname="greenland_icesheet_mass"
596	fields(i)%grid="grid_scalar"
597	i = iom_add(i); fields(i)%vname="greenland_icesheet_timelapsed"
598	fields(i)%grid="grid_scalar"
599	i = iom_add(i); fields(i)%vname="greenland_icesheet_mass_roc"
600	fields(i)%grid="grid_scalar"
601	i = iom_add(i); fields(i)%vname="antarctica_icesheet_mass"
602	fields(i)%grid="grid_scalar"
603	i = iom_add(i); fields(i)%vname="antarctica_icesheet_timelapsed"
604	fields(i)%grid="grid_scalar"
605	i = iom_add(i); fields(i)%vname="antarctica_icesheet_mass_roc"
606	fields(i)%grid="grid_scalar"
607	i = iom_add(i); fields(i)%vname="frc_v"; fields(i)%grid="grid_scalar"
608	i = iom_add(i); fields(i)%vname="frc_t"; fields(i)%grid="grid_scalar"
609	i = iom_add(i); fields(i)%vname="frc_s"; fields(i)%grid="grid_scalar"
610	i = iom_add(i); fields(i)%vname="frc_wn_t"; fields(i)%grid="grid_scalar"
611	i = iom_add(i); fields(i)%vname="frc_wn_s"; fields(i)%grid="grid_scalar"
612	i = iom_add(i); fields(i)%vname="ssh_ini"; fields(i)%grid="grid_N"
613	i = iom_add(i); fields(i)%vname="e3t_ini"; fields(i)%grid="grid_N_3D"
614	i = iom_add(i); fields(i)%vname="hc_loc_ini"; fields(i)%grid="grid_N_3D"
615	i = iom_add(i); fields(i)%vname="sc_loc_ini"; fields(i)%grid="grid_N_3D"
616	i = iom_add(i); fields(i)%vname="ssh_hc_loc_ini"; fields(i)%grid="grid_N"
617	i = iom_add(i); fields(i)%vname="ssh_sc_loc_ini"; fields(i)%grid="grid_N"
618	i = iom_add(i); fields(i)%vname="tilde_e3t_b"; fields(i)%grid="grid_N"
619	i = iom_add(i); fields(i)%vname="tilde_e3t_n"; fields(i)%grid="grid_N"
620	i = iom_add(i); fields(i)%vname="hdiv_lf"; fields(i)%grid="grid_N"
621	i = iom_add(i); fields(i)%vname="ub2_b"; fields(i)%grid="grid_N"
622	i = iom_add(i); fields(i)%vname="vb2_b"; fields(i)%grid="grid_N"
623	i = iom_add(i); fields(i)%vname="sshbb_e"; fields(i)%grid="grid_N"
624	i = iom_add(i); fields(i)%vname="ubb_e"; fields(i)%grid="grid_N"
625	i = iom_add(i); fields(i)%vname="vbb_e"; fields(i)%grid="grid_N"
626	i = iom_add(i); fields(i)%vname="sshb_e"; fields(i)%grid="grid_N"
627	i = iom_add(i); fields(i)%vname="ub_e"; fields(i)%grid="grid_N"
628	i = iom_add(i); fields(i)%vname="vb_e"; fields(i)%grid="grid_N"
629	i = iom_add(i); fields(i)%vname="fwf_isf_b"; fields(i)%grid="grid_N"
630	i = iom_add(i); fields(i)%vname="isf_sc_b"; fields(i)%grid="grid_N"
631	i = iom_add(i); fields(i)%vname="isf_hc_b"; fields(i)%grid="grid_N"
632	i = iom_add(i); fields(i)%vname="ssh_ibb"; fields(i)%grid="grid_N"
633	i = iom_add(i); fields(i)%vname="rnf_b"; fields(i)%grid="grid_N"
634	i = iom_add(i); fields(i)%vname="rnf_hc_b"; fields(i)%grid="grid_N"
635	i = iom_add(i); fields(i)%vname="rnf_sc_b"; fields(i)%grid="grid_N"
636	i = iom_add(i); fields(i)%vname="ssu_m"; fields(i)%grid="grid_N"
637	i = iom_add(i); fields(i)%vname="ssv_m"; fields(i)%grid="grid_N"
638	i = iom_add(i); fields(i)%vname="sst_m"; fields(i)%grid="grid_N"
639	i = iom_add(i); fields(i)%vname="sss_m"; fields(i)%grid="grid_N"
640	i = iom_add(i); fields(i)%vname="ssh_m"; fields(i)%grid="grid_N"
641	i = iom_add(i); fields(i)%vname="e3t_m"; fields(i)%grid="grid_N"
642	i = iom_add(i); fields(i)%vname="frq_m"; fields(i)%grid="grid_N"
643	i = iom_add(i); fields(i)%vname="avmb"; fields(i)%grid="grid_vector"
644	i = iom_add(i); fields(i)%vname="avtb"; fields(i)%grid="grid_vector"
645	i = iom_add(i); fields(i)%vname="ub2_i_b"; fields(i)%grid="grid_N"
646	i = iom_add(i); fields(i)%vname="vb2_i_b"; fields(i)%grid="grid_N"
647	i = iom_add(i); fields(i)%vname="ntime"; fields(i)%grid="grid_scalar"
648	i = iom_add(i); fields(i)%vname="Dsst"; fields(i)%grid="grid_scalar"
649	i = iom_add(i); fields(i)%vname="tmask"; fields(i)%grid="grid_N_3D"
650	i = iom_add(i); fields(i)%vname="umask"; fields(i)%grid="grid_N_3D"
651	i = iom_add(i); fields(i)%vname="vmask"; fields(i)%grid="grid_N_3D"
652	i = iom_add(i); fields(i)%vname="smask"; fields(i)%grid="grid_N_3D"
653	i = iom_add(i); fields(i)%vname="gdepw_n"; fields(i)%grid="grid_N_3D"
654	i = iom_add(i); fields(i)%vname="e3t_n"; fields(i)%grid="grid_N_3D"
655	i = iom_add(i); fields(i)%vname="e3u_n"; fields(i)%grid="grid_N_3D"
656	i = iom_add(i); fields(i)%vname="e3v_n"; fields(i)%grid="grid_N_3D"
657	i = iom_add(i); fields(i)%vname="surf_ini"; fields(i)%grid="grid_N"
658	i = iom_add(i); fields(i)%vname="e3t_b"; fields(i)%grid="grid_N_3D"
659	i = iom_add(i); fields(i)%vname="hmxl_n"; fields(i)%grid="grid_N_3D"
660	i = iom_add(i); fields(i)%vname="un_bf"; fields(i)%grid="grid_N"
661	i = iom_add(i); fields(i)%vname="vn_bf"; fields(i)%grid="grid_N"
662	i = iom_add(i); fields(i)%vname="hbl"; fields(i)%grid="grid_N"
663	i = iom_add(i); fields(i)%vname="hbli"; fields(i)%grid="grid_N"
664	i = iom_add(i); fields(i)%vname="wn"; fields(i)%grid="grid_N_3D"
665	i = iom_add(i); fields(i)%vname="nn_fsbc"; fields(i)%grid="grid_scalar"
666	#ifdef key_si3
667	!ICE/icedia.F90
668	i = iom_add(i); fields(i)%vname="kt_ice"; fields(i)%grid="grid_scalar"
669	i = iom_add(i); fields(i)%vname="frc_voltop"; fields(i)%grid="grid_scalar"
670	i = iom_add(i); fields(i)%vname="frc_volbot"; fields(i)%grid="grid_scalar"
671	i = iom_add(i); fields(i)%vname="frc_temtop"; fields(i)%grid="grid_scalar"
672	i = iom_add(i); fields(i)%vname="frc_tembot"; fields(i)%grid="grid_scalar"
673	i = iom_add(i); fields(i)%vname="frc_sal"; fields(i)%grid="grid_scalar"
674	i = iom_add(i); fields(i)%vname="vol_loc_ini"; fields(i)%grid="grid_N"
675	i = iom_add(i); fields(i)%vname="tem_loc_ini"; fields(i)%grid="grid_N"
676	i = iom_add(i); fields(i)%vname="sal_loc_ini"; fields(i)%grid="grid_N"
677	i = iom_add(i); fields(i)%vname="sal_loc_ini"; fields(i)%grid="grid_N"
678	!ICE/icedyn_adv_pra.F90 grid_Ni_3D - jpi,jpj,jpl
679	i = iom_add(i); fields(i)%vname="sxice"; fields(i)%grid="grid_Ni_3D"
680	i = iom_add(i); fields(i)%vname="syice"; fields(i)%grid="grid_Ni_3D"
681	i = iom_add(i); fields(i)%vname="sxxice"; fields(i)%grid="grid_Ni_3D"
682	i = iom_add(i); fields(i)%vname="syyice"; fields(i)%grid="grid_Ni_3D"
683	i = iom_add(i); fields(i)%vname="sxyice"; fields(i)%grid="grid_Ni_3D"
684	i = iom_add(i); fields(i)%vname="sxsn"; fields(i)%grid="grid_Ni_3D"
685	i = iom_add(i); fields(i)%vname="sysn"; fields(i)%grid="grid_Ni_3D"
686	i = iom_add(i); fields(i)%vname="sxxsn"; fields(i)%grid="grid_Ni_3D"
687	i = iom_add(i); fields(i)%vname="syysn"; fields(i)%grid="grid_Ni_3D"
688	i = iom_add(i); fields(i)%vname="sxysn"; fields(i)%grid="grid_Ni_3D"
689	i = iom_add(i); fields(i)%vname="sxa"; fields(i)%grid="grid_Ni_3D"
690	i = iom_add(i); fields(i)%vname="sya"; fields(i)%grid="grid_Ni_3D"
691	i = iom_add(i); fields(i)%vname="sxxa"; fields(i)%grid="grid_Ni_3D"
692	i = iom_add(i); fields(i)%vname="syya"; fields(i)%grid="grid_Ni_3D"
693	i = iom_add(i); fields(i)%vname="sxya"; fields(i)%grid="grid_Ni_3D"
694	i = iom_add(i); fields(i)%vname="sxsal"; fields(i)%grid="grid_Ni_3D"
695	i = iom_add(i); fields(i)%vname="sysal"; fields(i)%grid="grid_Ni_3D"
696	i = iom_add(i); fields(i)%vname="sxxsal"; fields(i)%grid="grid_Ni_3D"
697	i = iom_add(i); fields(i)%vname="syysal"; fields(i)%grid="grid_Ni_3D"
698	i = iom_add(i); fields(i)%vname="sxysal"; fields(i)%grid="grid_Ni_3D"
699	i = iom_add(i); fields(i)%vname="sxage"; fields(i)%grid="grid_Ni_3D"
700	i = iom_add(i); fields(i)%vname="syage"; fields(i)%grid="grid_Ni_3D"
701	i = iom_add(i); fields(i)%vname="sxxage"; fields(i)%grid="grid_Ni_3D"
702	i = iom_add(i); fields(i)%vname="syyage"; fields(i)%grid="grid_Ni_3D"
703	i = iom_add(i); fields(i)%vname="sxyage"; fields(i)%grid="grid_Ni_3D"
704	!this part is in addition to 4D grids, to handle old format for SI3 resart
705	!NEMO format restart
706	DO jk = 1, nlay_s
707	WRITE(zchar,'(I2.2)') jk
708	znam = 'sxc0'//'_l'//zchar
709	i = iom_add(i); fields(i)%vname=znam; fields(i)%grid="grid_Ni_3D"
710	znam = 'syc0'//'_l'//zchar
711	i = iom_add(i); fields(i)%vname=znam; fields(i)%grid="grid_Ni_3D"
712	znam = 'sxxc0'//'_l'//zchar
713	i = iom_add(i); fields(i)%vname=znam; fields(i)%grid="grid_Ni_3D"
714	znam = 'syyc0'//'_l'//zchar
715	i = iom_add(i); fields(i)%vname=znam; fields(i)%grid="grid_Ni_3D"
716	znam = 'sxyc0'//'_l'//zchar
717	i = iom_add(i); fields(i)%vname=znam; fields(i)%grid="grid_Ni_3D"
718	END DO
719	!XIOS format restart
720	i = iom_add(i); fields(i)%vname="sxc0"; fields(i)%grid="grid_Ns_4D"
721	i = iom_add(i); fields(i)%vname="syc0"; fields(i)%grid="grid_Ns_4D"
722	i = iom_add(i); fields(i)%vname="sxxc0"; fields(i)%grid="grid_Ns_4D"
723	i = iom_add(i); fields(i)%vname="syyc0"; fields(i)%grid="grid_Ns_4D"
724	i = iom_add(i); fields(i)%vname="sxyc0"; fields(i)%grid="grid_Ns_4D"
725	!
726	!NEMO format restart
727	DO jk = 1, nlay_i
728	WRITE(zchar,'(I2.2)') jk
729	znam = 'sxe'//'_l'//zchar
730	i = iom_add(i); fields(i)%vname=znam; fields(i)%grid="grid_Ni_3D"
731	znam = 'sye'//'_l'//zchar
732	i = iom_add(i); fields(i)%vname=znam; fields(i)%grid="grid_Ni_3D"
733	znam = 'sxxe'//'_l'//zchar
734	i = iom_add(i); fields(i)%vname=znam; fields(i)%grid="grid_Ni_3D"
735	znam = 'syye'//'_l'//zchar
736	i = iom_add(i); fields(i)%vname=znam; fields(i)%grid="grid_Ni_3D"
737	znam = 'sxye'//'_l'//zchar
738	i = iom_add(i); fields(i)%vname=znam; fields(i)%grid="grid_Ni_3D"
739	ENDDO
740	!XIOS format restart
741	i = iom_add(i); fields(i)%vname="sxe"; fields(i)%grid="grid_Ni_4D"
742	i = iom_add(i); fields(i)%vname="sye"; fields(i)%grid="grid_Ni_4D"
743	i = iom_add(i); fields(i)%vname="sxxe"; fields(i)%grid="grid_Ni_4D"
744	i = iom_add(i); fields(i)%vname="syye"; fields(i)%grid="grid_Ni_4D"
745	i = iom_add(i); fields(i)%vname="sxye"; fields(i)%grid="grid_Ni_4D"
746	!common for both
747	i = iom_add(i); fields(i)%vname="sxap"; fields(i)%grid="grid_Ni_3D"
748	i = iom_add(i); fields(i)%vname="syap"; fields(i)%grid="grid_Ni_3D"
749	i = iom_add(i); fields(i)%vname="sxxap"; fields(i)%grid="grid_Ni_3D"
750	i = iom_add(i); fields(i)%vname="syyap"; fields(i)%grid="grid_Ni_3D"
751	i = iom_add(i); fields(i)%vname="sxyap"; fields(i)%grid="grid_Ni_3D"
752	i = iom_add(i); fields(i)%vname="sxvp"; fields(i)%grid="grid_Ni_3D"
753	i = iom_add(i); fields(i)%vname="syvp"; fields(i)%grid="grid_Ni_3D"
754	i = iom_add(i); fields(i)%vname="sxxvp"; fields(i)%grid="grid_Ni_3D"
755	i = iom_add(i); fields(i)%vname="syyvp"; fields(i)%grid="grid_Ni_3D"
756	i = iom_add(i); fields(i)%vname="sxyvp"; fields(i)%grid="grid_Ni_3D"
757	i = iom_add(i); fields(i)%vname="stress1_i"; fields(i)%grid="grid_N"
758	i = iom_add(i); fields(i)%vname="stress2_i"; fields(i)%grid="grid_N"
759	i = iom_add(i); fields(i)%vname="stress12_i"; fields(i)%grid="grid_N"
760	i = iom_add(i); fields(i)%vname="nn_fsbc_ice"; fields(i)%grid="grid_scalar"
761	i = iom_add(i); fields(i)%vname="kt_ice"; fields(i)%grid="grid_scalar"
762	i = iom_add(i); fields(i)%vname="v_i"; fields(i)%grid="grid_Ni_3D"
763	i = iom_add(i); fields(i)%vname="v_s"; fields(i)%grid="grid_Ni_3D"
764	i = iom_add(i); fields(i)%vname="sv_i"; fields(i)%grid="grid_Ni_3D"
765	i = iom_add(i); fields(i)%vname="a_i"; fields(i)%grid="grid_Ni_3D"
766	i = iom_add(i); fields(i)%vname="t_su"; fields(i)%grid="grid_Ni_3D"
767	i = iom_add(i); fields(i)%vname="u_ice"; fields(i)%grid="grid_N"
768	i = iom_add(i); fields(i)%vname="v_ice"; fields(i)%grid="grid_N"
769	!NEMO format restat
770	DO jk = 1, nlay_s
771	WRITE(zchar,'(I2.2)') jk
772	znam = 'e_s'//'_l'//zchar
773	i = iom_add(i); fields(i)%vname=znam; fields(i)%grid="grid_Ni_3D"
774	END DO
775	!XIOS format restart
776	i = iom_add(i); fields(i)%vname="e_s"; fields(i)%grid="grid_Ns_4D"
777	!NEMO format restat
778	DO jk = 1, nlay_i
779	WRITE(zchar,'(I2.2)') jk
780	znam = 'e_i'//'_l'//zchar
781	i = iom_add(i); fields(i)%vname=znam; fields(i)%grid="grid_Ni_3D"
782	END DO
783	!XIOS format restart
784	i = iom_add(i); fields(i)%vname="e_i"; fields(i)%grid="grid_Ni_4D"
785	!common for both
786	i = iom_add(i); fields(i)%vname="oa_i"; fields(i)%grid="grid_Ni_3D"
787	i = iom_add(i); fields(i)%vname="a_ip"; fields(i)%grid="grid_Ni_3D"
788	i = iom_add(i); fields(i)%vname="v_ip"; fields(i)%grid="grid_Ni_3D"
789	i = iom_add(i); fields(i)%vname="cnd_ice"; fields(i)%grid="grid_Ni_3D"
790	i = iom_add(i); fields(i)%vname="t1_ice"; fields(i)%grid="grid_Ni_3D"
791	i = iom_add(i); fields(i)%vname="snwice_mass"; fields(i)%grid="grid_N"
792	i = iom_add(i); fields(i)%vname="snwice_mass_b"; fields(i)%grid="grid_N"
793	#endif
794	END SUBROUTINE iom_set_rst_vars
795
796
797	SUBROUTINE iom_set_rstw_active(drst_wfields, cdrst_file, kdstep)
798	!!---------------------------------------------------------------------
799	!! * SUBROUTINE iom_set_rstw_active *
800	!!
801	!! ** Purpose : define file name in XIOS context for writing restart
802	!! enable variables present in restart file for writing
803	!!---------------------------------------------------------------------
804	!sets enabled = .TRUE. for each field in restart file
805	CHARACTER(len=*), INTENT(IN) :: cdrst_file
806	TYPE(RST_FIELD), INTENT(IN) :: drst_wfields(max_rst_fields)
807	INTEGER , INTENT(IN) :: kdstep
808	#if defined key_iomput
809	TYPE(xios_field) :: field_hdl
810	TYPE(xios_file) :: file_hdl
811	TYPE(xios_filegroup) :: filegroup_hdl
812	TYPE(XIOS_DURATION) :: freq
813	INTEGER :: i
814	CHARACTER(lc) :: clpath
815
816	write(snr, *) kdstep
817	!set name of the restart file and enable available fields
818	IF(lwp) WRITE(numout,*) 'Setting restart filename (for XIOS write) to: ',cdrst_file
819	CALL xios_get_handle("file_definition", filegroup_hdl )
820	CALL xios_add_child(filegroup_hdl, file_hdl)
821	IF(nxioso.eq.1) THEN
822	CALL xios_set_attr( file_hdl, type="one_file", enabled=.TRUE.,&
823	mode="write", output_freq=kdstep*xios_timestep)
824	if(lwp) write(numout,*) 'Define ', trim(cdrst_file), ' in one_file mode'
825	ELSE
826	CALL xios_set_attr( file_hdl, type="multiple_file", enabled=.TRUE.,&
827	mode="write", output_freq=xios_timestep)
828	if(lwp) write(numout,*) 'Define ', trim(cdrst_file), ' in multiple_file mode'
829	ENDIF
830	CALL xios_set_attr( file_hdl, name=trim(cdrst_file))
831	!define fields for restart context
832	DO i = 1, max_rst_fields
833	IF( drst_wfields(i)%active ) THEN
834	CALL xios_add_child(file_hdl, field_hdl, TRIM(drst_wfields(i)%vname)//"_"//TRIM(ADJUSTL(snr)))
835	SELECT CASE (TRIM(drst_wfields(i)%grid))
836	#if defined key_si3
837	CASE ("grid_Ni_4D")
838	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(drst_wfields(i)%vname), &
839	grid_ref="grid_Ni_4D", prec = 8, operation = "instant")
840	CASE ("grid_Ns_4D")
841	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(drst_wfields(i)%vname), &
842	grid_ref="grid_Ns_4D", prec = 8, operation = "instant")
843	CASE ("grid_Ni_3D")
844	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(drst_wfields(i)%vname), &
845	domain_ref="grid_N", axis_ref="numcat", prec = 8, operation = "instant")
846	#endif
847	CASE ("grid_N_3D")
848	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(drst_wfields(i)%vname), &
849	domain_ref="grid_N", axis_ref="nav_lev", prec = 8, operation = "instant")
850	CASE ("grid_N")
851	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(drst_wfields(i)%vname), &
852	domain_ref="grid_N", prec = 8, operation = "instant")
853	CASE ("grid_vector")
854	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(drst_wfields(i)%vname), &
855	axis_ref="nav_lev", prec = 8, operation = "instant")
856	CASE ("grid_scalar")
857	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(drst_wfields(i)%vname), &
858	scalar_ref = "grid_scalar", prec = 8, operation = "instant")
859	END SELECT
860	ENDIF
861	END DO
862	#endif
863	END SUBROUTINE iom_set_rstw_active
864
865	SUBROUTINE iom_set_rst_context(ld_rstr)
866	!!---------------------------------------------------------------------
867	!! * SUBROUTINE iom_set_rst_context *
868	!!
869	!! ** Purpose : Define domain, axis and grid for restart (read/write)
870	!! context
871	!!
872	!!---------------------------------------------------------------------
873	LOGICAL, INTENT(IN) :: ld_rstr
874	!ld_rstr is true for restart context. There is no need to define grid for
875	!restart read, because it's read from file
876	#if defined key_iomput
877	TYPE(xios_domaingroup) :: domaingroup_hdl
878	TYPE(xios_domain) :: domain_hdl
879	TYPE(xios_axisgroup) :: axisgroup_hdl
880	TYPE(xios_axis) :: axis_hdl
881	TYPE(xios_scalar) :: scalar_hdl
882	TYPE(xios_scalargroup) :: scalargroup_hdl
883	INTEGER :: ji
884
885	CALL xios_get_handle("domain_definition",domaingroup_hdl)
886	CALL xios_add_child(domaingroup_hdl, domain_hdl, "grid_N")
887	CALL set_grid("N", glamt, gphit, .TRUE., ld_rstr)
888
889	CALL xios_get_handle("axis_definition",axisgroup_hdl)
890	CALL xios_add_child(axisgroup_hdl, axis_hdl, "nav_lev")
891	!AGRIF fails to compile when unit= is in call to xios_set_axis_attr
892	! CALL xios_set_axis_attr( "nav_lev", long_name="Vertical levels", unit="m", positive="down")
893	CALL xios_set_axis_attr( "nav_lev", long_name="Vertical levels in meters", positive="down")
894	CALL iom_set_axis_attr( "nav_lev", paxis = gdept_1d )
895
896	CALL xios_get_handle("scalar_definition", scalargroup_hdl)
897	CALL xios_add_child(scalargroup_hdl, scalar_hdl, "grid_scalar")
898	#if defined key_si3
899	CALL xios_get_handle("axis_definition",axisgroup_hdl)
900	CALL xios_add_child(axisgroup_hdl, axis_hdl, "numcat")
901	CALL iom_set_axis_attr( "numcat", (/ (REAL(ji,wp), ji=1,jpl) /) )
902	CALL xios_add_child(axisgroup_hdl, axis_hdl, "nlay_i")
903	CALL iom_set_axis_attr( "nlay_i", (/ (REAL(ji,wp), ji=1,nlay_i) /) )
904	CALL xios_add_child(axisgroup_hdl, axis_hdl, "nlay_s")
905	CALL iom_set_axis_attr( "nlay_s", (/ (REAL(ji,wp), ji=1,nlay_s) /) )
906	#endif
907	#endif
908	END SUBROUTINE iom_set_rst_context
909
910	SUBROUTINE iom_swap( cdname )
911	!!---------------------------------------------------------------------
912	!! * SUBROUTINE iom_swap *
913	!!
914	!! ** Purpose : swap context between different agrif grid for xmlio_server
915	!!---------------------------------------------------------------------
916	CHARACTER(len=*), INTENT(in) :: cdname
917	#if defined key_iomput
918	TYPE(xios_context) :: nemo_hdl
919
920	IF( TRIM(Agrif_CFixed()) == '0' ) THEN
921	CALL xios_get_handle(TRIM(cdname),nemo_hdl)
922	ELSE
923	CALL xios_get_handle(TRIM(Agrif_CFixed())//"_"//TRIM(cdname),nemo_hdl)
924	ENDIF
925	!
926	CALL xios_set_current_context(nemo_hdl)
927	#endif
928	!
929	END SUBROUTINE iom_swap
930
931
932	SUBROUTINE iom_open( cdname, kiomid, ldwrt, kdom, ldstop, ldiof, kdlev )
933	!!---------------------------------------------------------------------
934	!! * SUBROUTINE iom_open *
935	!!
936	!! ** Purpose : open an input file (return 0 if not found)
937	!!---------------------------------------------------------------------
938	CHARACTER(len=*), INTENT(in ) :: cdname ! File name
939	INTEGER , INTENT( out) :: kiomid ! iom identifier of the opened file
940	LOGICAL , INTENT(in ), OPTIONAL :: ldwrt ! open in write modeb (default = .FALSE.)
941	INTEGER , INTENT(in ), OPTIONAL :: kdom ! Type of domain to be written (default = jpdom_local_noovlap)
942	LOGICAL , INTENT(in ), OPTIONAL :: ldstop ! stop if open to read a non-existing file (default = .TRUE.)
943	LOGICAL , INTENT(in ), OPTIONAL :: ldiof ! Interp On the Fly, needed for AGRIF (default = .FALSE.)
944	INTEGER , INTENT(in ), OPTIONAL :: kdlev ! number of vertical levels
945	!
946	CHARACTER(LEN=256) :: clname ! the name of the file based on cdname [[+clcpu]+clcpu]
947	CHARACTER(LEN=256) :: cltmpn ! tempory name to store clname (in writting mode)
948	CHARACTER(LEN=10) :: clsuffix ! ".nc"
949	CHARACTER(LEN=15) :: clcpu ! the cpu number (max jpmax_digits digits)
950	CHARACTER(LEN=256) :: clinfo ! info character
951	LOGICAL :: llok ! check the existence
952	LOGICAL :: llwrt ! local definition of ldwrt
953	LOGICAL :: llnoov ! local definition to read overlap
954	LOGICAL :: llstop ! local definition of ldstop
955	LOGICAL :: lliof ! local definition of ldiof
956	INTEGER :: icnt ! counter for digits in clcpu (max = jpmax_digits)
957	INTEGER :: iln, ils ! lengths of character
958	INTEGER :: idom ! type of domain
959	INTEGER :: istop !
960	INTEGER, DIMENSION(2,5) :: idompar ! domain parameters:
961	! local number of points for x,y dimensions
962	! position of first local point for x,y dimensions
963	! position of last local point for x,y dimensions
964	! start halo size for x,y dimensions
965	! end halo size for x,y dimensions
966	!---------------------------------------------------------------------
967	! Initializations and control
968	! =============
969	kiomid = -1
970	clinfo = ' iom_open ~~~ '
971	istop = nstop
972	! if iom_open is called for the first time: initialize iom_file(:)%nfid to 0
973	! (could be done when defining iom_file in f95 but not in f90)
974	IF( Agrif_Root() ) THEN
975	IF( iom_open_init == 0 ) THEN
976	iom_file(:)%nfid = 0
977	iom_open_init = 1
978	ENDIF
979	ENDIF
980	! do we read or write the file?
981	IF( PRESENT(ldwrt) ) THEN ; llwrt = ldwrt
982	ELSE ; llwrt = .FALSE.
983	ENDIF
984	! do we call ctl_stop if we try to open a non-existing file in read mode?
985	IF( PRESENT(ldstop) ) THEN ; llstop = ldstop
986	ELSE ; llstop = .TRUE.
987	ENDIF
988	! are we using interpolation on the fly?
989	IF( PRESENT(ldiof) ) THEN ; lliof = ldiof
990	ELSE ; lliof = .FALSE.
991	ENDIF
992	! do we read the overlap
993	! ugly patch SM+JMM+RB to overwrite global definition in some cases
994	llnoov = (jpni * jpnj ) == jpnij .AND. .NOT. lk_agrif
995	! create the file name by added, if needed, TRIM(Agrif_CFixed()) and TRIM(clsuffix)
996	! =============
997	clname = trim(cdname)
998	IF ( .NOT. Agrif_Root() .AND. .NOT. lliof ) THEN
999	!FUS iln = INDEX(clname,'/')
1000	iln = INDEX(clname,'/',BACK=.true.) ! FUS: to insert the nest index at the right location within the string, the last / has to be found (search from the right to left)
1001	cltmpn = clname(1:iln)
1002	clname = clname(iln+1:LEN_TRIM(clname))
1003	clname=TRIM(cltmpn)//TRIM(Agrif_CFixed())//'_'//TRIM(clname)
1004	ENDIF
1005	! which suffix should we use?
1006	clsuffix = '.nc'
1007	! Add the suffix if needed
1008	iln = LEN_TRIM(clname)
1009	ils = LEN_TRIM(clsuffix)
1010	IF( iln <= ils .OR. INDEX( TRIM(clname), TRIM(clsuffix), back = .TRUE. ) /= iln - ils + 1 ) &
1011	& clname = TRIM(clname)//TRIM(clsuffix)
1012	cltmpn = clname ! store this name
1013	! try to find if the file to be opened already exist
1014	! =============
1015	INQUIRE( FILE = clname, EXIST = llok )
1016	IF( .NOT.llok ) THEN
1017	! we try to add the cpu number to the name
1018	WRITE(clcpu,*) narea-1
1019
1020	clcpu = TRIM(ADJUSTL(clcpu))
1021	iln = INDEX(clname,TRIM(clsuffix), back = .TRUE.)
1022	clname = clname(1:iln-1)//'_'//TRIM(clcpu)//TRIM(clsuffix)
1023	icnt = 0
1024	INQUIRE( FILE = clname, EXIST = llok )
1025	! we try different formats for the cpu number by adding 0
1026	DO WHILE( .NOT.llok .AND. icnt < jpmax_digits )
1027	clcpu = "0"//trim(clcpu)
1028	clname = clname(1:iln-1)//'_'//TRIM(clcpu)//TRIM(clsuffix)
1029	INQUIRE( FILE = clname, EXIST = llok )
1030	icnt = icnt + 1
1031	END DO
1032	ELSE
1033	lxios_sini = .TRUE.
1034	ENDIF
1035	IF( llwrt ) THEN
1036	! check the domain definition
1037	! JMM + SM: ugly patch before getting the new version of lib_mpp)
1038	! idom = jpdom_local_noovlap ! default definition
1039	IF( llnoov ) THEN ; idom = jpdom_local_noovlap ! default definition
1040	ELSE ; idom = jpdom_local_full ! default definition
1041	ENDIF
1042	IF( PRESENT(kdom) ) idom = kdom
1043	! create the domain informations
1044	! =============
1045	SELECT CASE (idom)
1046	CASE (jpdom_local_full)
1047	idompar(:,1) = (/ jpi , jpj /)
1048	idompar(:,2) = (/ nimpp , njmpp /)
1049	idompar(:,3) = (/ nimpp + jpi - 1 , njmpp + jpj - 1 /)
1050	idompar(:,4) = (/ nldi - 1 , nldj - 1 /)
1051	idompar(:,5) = (/ jpi - nlei , jpj - nlej /)
1052	CASE (jpdom_local_noextra)
1053	idompar(:,1) = (/ nlci , nlcj /)
1054	idompar(:,2) = (/ nimpp , njmpp /)
1055	idompar(:,3) = (/ nimpp + nlci - 1, njmpp + nlcj - 1 /)
1056	idompar(:,4) = (/ nldi - 1 , nldj - 1 /)
1057	idompar(:,5) = (/ nlci - nlei , nlcj - nlej /)
1058	CASE (jpdom_local_noovlap)
1059	idompar(:,1) = (/ nlei - nldi + 1, nlej - nldj + 1 /)
1060	idompar(:,2) = (/ nimpp + nldi - 1, njmpp + nldj - 1 /)
1061	idompar(:,3) = (/ nimpp + nlei - 1, njmpp + nlej - 1 /)
1062	idompar(:,4) = (/ 0 , 0 /)
1063	idompar(:,5) = (/ 0 , 0 /)
1064	CASE DEFAULT
1065	CALL ctl_stop( TRIM(clinfo), 'wrong value of kdom, only jpdom_local* cases are accepted' )
1066	END SELECT
1067	ENDIF
1068	! Open the NetCDF file
1069	! =============
1070	! do we have some free file identifier?
1071	IF( MINVAL(iom_file(:)%nfid) /= 0 ) &
1072	& CALL ctl_stop( TRIM(clinfo), 'No more free file identifier', 'increase jpmax_files in iom_def' )
1073	! if no file was found...
1074	IF( .NOT. llok ) THEN
1075	IF( .NOT. llwrt ) THEN ! we are in read mode
1076	IF( llstop ) THEN ; CALL ctl_stop( TRIM(clinfo), 'File '//TRIM(cltmpn)//'* not found' )
1077	ELSE ; istop = nstop + 1 ! make sure that istop /= nstop so we don't open the file
1078	ENDIF
1079	ELSE ! we are in write mode so we
1080	clname = cltmpn ! get back the file name without the cpu number
1081	ENDIF
1082	ELSE
1083	IF( llwrt .AND. .NOT. ln_clobber ) THEN ! we stop as we want to write in a new file
1084	CALL ctl_stop( TRIM(clinfo), 'We want to write in a new file but '//TRIM(clname)//' already exists...' )
1085	istop = nstop + 1 ! make sure that istop /= nstop so we don't open the file
1086	ELSEIF( llwrt ) THEN ! the file exists and we are in write mode with permission to
1087	clname = cltmpn ! overwrite so get back the file name without the cpu number
1088	ENDIF
1089	ENDIF
1090	IF( istop == nstop ) THEN ! no error within this routine
1091	CALL iom_nf90_open( clname, kiomid, llwrt, llok, idompar, kdlev = kdlev )
1092	ENDIF
1093	!
1094	END SUBROUTINE iom_open
1095
1096
1097	SUBROUTINE iom_close( kiomid )
1098	!!--------------------------------------------------------------------
1099	!! * SUBROUTINE iom_close *
1100	!!
1101	!! ** Purpose : close an input file, or all files opened by iom
1102	!!--------------------------------------------------------------------
1103	INTEGER, INTENT(inout), OPTIONAL :: kiomid ! iom identifier of the file to be closed
1104	! ! return 0 when file is properly closed
1105	! ! No argument: all files opened by iom are closed
1106
1107	INTEGER :: jf ! dummy loop indices
1108	INTEGER :: i_s, i_e ! temporary integer
1109	CHARACTER(LEN=100) :: clinfo ! info character
1110	!---------------------------------------------------------------------
1111	!
1112	clinfo = ' iom_close ~~~ '
1113	IF( PRESENT(kiomid) ) THEN
1114	i_s = kiomid
1115	i_e = kiomid
1116	ELSE
1117	i_s = 1
1118	i_e = jpmax_files
1119	ENDIF
1120
1121	IF( i_s > 0 ) THEN
1122	DO jf = i_s, i_e
1123	IF( iom_file(jf)%nfid > 0 ) THEN
1124	CALL iom_nf90_close( jf )
1125	iom_file(jf)%nfid = 0 ! free the id
1126	IF( PRESENT(kiomid) ) kiomid = 0 ! return 0 as id to specify that the file was closed
1127	IF(lwp) WRITE(numout,*) TRIM(clinfo)//' close file: '//TRIM(iom_file(jf)%name)//' ok'
1128	ELSEIF( PRESENT(kiomid) ) THEN
1129	WRITE(ctmp1,*) '--->', kiomid
1130	CALL ctl_stop( TRIM(clinfo)//' Invalid file identifier', ctmp1 )
1131	ENDIF
1132	END DO
1133	ENDIF
1134	!
1135	END SUBROUTINE iom_close
1136
1137
1138	FUNCTION iom_varid ( kiomid, cdvar, kdimsz, kndims, lduld, ldstop )
1139	!!-----------------------------------------------------------------------
1140	!! * FUNCTION iom_varid *
1141	!!
1142	!! ** Purpose : get the id of a variable in a file (return 0 if not found)
1143	!!-----------------------------------------------------------------------
1144	INTEGER , INTENT(in ) :: kiomid ! file Identifier
1145	CHARACTER(len=*) , INTENT(in ) :: cdvar ! name of the variable
1146	INTEGER, DIMENSION(:), INTENT( out), OPTIONAL :: kdimsz ! size of each dimension
1147	INTEGER , INTENT( out), OPTIONAL :: kndims ! number of dimensions
1148	LOGICAL , INTENT( out), OPTIONAL :: lduld ! true if the last dimension is unlimited (time)
1149	LOGICAL , INTENT(in ), OPTIONAL :: ldstop ! stop if looking for non-existing variable (default = .TRUE.)
1150	!
1151	INTEGER :: iom_varid, iiv, i_nvd
1152	LOGICAL :: ll_fnd
1153	CHARACTER(LEN=100) :: clinfo ! info character
1154	LOGICAL :: llstop ! local definition of ldstop
1155	!!-----------------------------------------------------------------------
1156	iom_varid = 0 ! default definition
1157	! do we call ctl_stop if we look for non-existing variable?
1158	IF( PRESENT(ldstop) ) THEN ; llstop = ldstop
1159	ELSE ; llstop = .TRUE.
1160	ENDIF
1161	!
1162	IF( kiomid > 0 ) THEN
1163	clinfo = 'iom_varid, file: '//trim(iom_file(kiomid)%name)//', var: '//trim(cdvar)
1164	IF( iom_file(kiomid)%nfid == 0 ) THEN
1165	CALL ctl_stop( trim(clinfo), 'the file is not open' )
1166	ELSE
1167	ll_fnd = .FALSE.
1168	iiv = 0
1169	!
1170	DO WHILE ( .NOT.ll_fnd .AND. iiv < iom_file(kiomid)%nvars )
1171	iiv = iiv + 1
1172	ll_fnd = ( TRIM(cdvar) == TRIM(iom_file(kiomid)%cn_var(iiv)) )
1173	END DO
1174	!
1175	IF( .NOT.ll_fnd ) THEN
1176	iiv = iiv + 1
1177	IF( iiv <= jpmax_vars ) THEN
1178	iom_varid = iom_nf90_varid( kiomid, cdvar, iiv, kdimsz, kndims, lduld )
1179	ELSE
1180	CALL ctl_stop( trim(clinfo), 'Too many variables in the file '//iom_file(kiomid)%name, &
1181	& 'increase the parameter jpmax_vars')
1182	ENDIF
1183	IF( llstop .AND. iom_varid == -1 ) CALL ctl_stop( TRIM(clinfo)//' not found' )
1184	ELSE
1185	iom_varid = iiv
1186	IF( PRESENT(kdimsz) ) THEN
1187	i_nvd = iom_file(kiomid)%ndims(iiv)
1188	IF( i_nvd <= size(kdimsz) ) THEN
1189	kdimsz(1:i_nvd) = iom_file(kiomid)%dimsz(1:i_nvd,iiv)
1190	ELSE
1191	WRITE(ctmp1,*) i_nvd, size(kdimsz)
1192	CALL ctl_stop( trim(clinfo), 'error in kdimsz size'//trim(ctmp1) )
1193	ENDIF
1194	ENDIF
1195	IF( PRESENT(kndims) ) kndims = iom_file(kiomid)%ndims(iiv)
1196	IF( PRESENT( lduld) ) lduld = iom_file(kiomid)%luld( iiv)
1197	ENDIF
1198	ENDIF
1199	ENDIF
1200	!
1201	END FUNCTION iom_varid
1202
1203
1204	!!----------------------------------------------------------------------
1205	!! INTERFACE iom_get
1206	!!----------------------------------------------------------------------
1207	SUBROUTINE iom_g0d( kiomid, cdvar, pvar, ktime, ldxios )
1208	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
1209	CHARACTER(len=*), INTENT(in ) :: cdvar ! Name of the variable
1210	REAL(wp) , INTENT( out) :: pvar ! read field
1211	INTEGER , INTENT(in ), OPTIONAL :: ktime ! record number
1212	LOGICAL , INTENT(in ), OPTIONAL :: ldxios ! use xios to read restart
1213	!
1214	INTEGER :: idvar ! variable id
1215	INTEGER :: idmspc ! number of spatial dimensions
1216	INTEGER , DIMENSION(1) :: itime ! record number
1217	CHARACTER(LEN=100) :: clinfo ! info character
1218	CHARACTER(LEN=100) :: clname ! file name
1219	CHARACTER(LEN=1) :: cldmspc !
1220	LOGICAL :: llxios
1221	!
1222	llxios = .FALSE.
1223	IF( PRESENT(ldxios) ) llxios = ldxios
1224
1225	IF(.NOT.llxios) THEN ! read data using default library
1226	itime = 1
1227	IF( PRESENT(ktime) ) itime = ktime
1228	!
1229	clname = iom_file(kiomid)%name
1230	clinfo = ' iom_g0d, file: '//trim(clname)//', var: '//trim(cdvar)
1231	!
1232	IF( kiomid > 0 ) THEN
1233	idvar = iom_varid( kiomid, cdvar )
1234	IF( iom_file(kiomid)%nfid > 0 .AND. idvar > 0 ) THEN
1235	idmspc = iom_file ( kiomid )%ndims( idvar )
1236	IF( iom_file(kiomid)%luld(idvar) ) idmspc = idmspc - 1
1237	WRITE(cldmspc , fmt='(i1)') idmspc
1238	IF( idmspc > 0 ) CALL ctl_stop( TRIM(clinfo), 'When reading to a 0D array, we do not accept data', &
1239	& 'with 1 or more spatial dimensions: '//cldmspc//' were found.' , &
1240	& 'Use ncwa -a to suppress the unnecessary dimensions' )
1241	CALL iom_nf90_get( kiomid, idvar, pvar, itime )
1242	ENDIF
1243	ENDIF
1244	ELSE
1245	#if defined key_iomput
1246	IF(lwp) WRITE(numout,*) 'XIOS RST READ (0D): ', trim(cdvar)
1247	CALL xios_recv_field( trim(cdvar), pvar)
1248	#else
1249	WRITE(ctmp1,*) 'Can not use XIOS in iom_g0d, file: '//trim(clname)//', var:'//trim(cdvar)
1250	CALL ctl_stop( 'iom_g0d', ctmp1 )
1251	#endif
1252	ENDIF
1253	END SUBROUTINE iom_g0d
1254
1255	SUBROUTINE iom_g1d( kiomid, kdom, cdvar, pvar, ktime, kstart, kcount, ldxios )
1256	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
1257	INTEGER , INTENT(in ) :: kdom ! Type of domain to be read
1258	CHARACTER(len=*), INTENT(in ) :: cdvar ! Name of the variable
1259	REAL(wp) , INTENT( out), DIMENSION(:) :: pvar ! read field
1260	INTEGER , INTENT(in ) , OPTIONAL :: ktime ! record number
1261	INTEGER , INTENT(in ), DIMENSION(1), OPTIONAL :: kstart ! start axis position of the reading
1262	INTEGER , INTENT(in ), DIMENSION(1), OPTIONAL :: kcount ! number of points in each axis
1263	LOGICAL , INTENT(in ), OPTIONAL :: ldxios ! read data using XIOS
1264	!
1265	IF( kiomid > 0 ) THEN
1266	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_get_123d( kiomid, kdom , cdvar , pv_r1d=pvar, &
1267	& ktime=ktime, kstart=kstart, kcount=kcount, &
1268	& ldxios=ldxios )
1269	ENDIF
1270	END SUBROUTINE iom_g1d
1271
1272	SUBROUTINE iom_g2d( kiomid, kdom, cdvar, pvar, ktime, kstart, kcount, lrowattr, ldxios)
1273	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
1274	INTEGER , INTENT(in ) :: kdom ! Type of domain to be read
1275	CHARACTER(len=*), INTENT(in ) :: cdvar ! Name of the variable
1276	REAL(wp) , INTENT( out), DIMENSION(:,:) :: pvar ! read field
1277	INTEGER , INTENT(in ) , OPTIONAL :: ktime ! record number
1278	INTEGER , INTENT(in ), DIMENSION(2) , OPTIONAL :: kstart ! start axis position of the reading
1279	INTEGER , INTENT(in ), DIMENSION(2) , OPTIONAL :: kcount ! number of points in each axis
1280	LOGICAL , INTENT(in ) , OPTIONAL :: lrowattr ! logical flag telling iom_get to
1281	! look for and use a file attribute
1282	! called open_ocean_jstart to set the start
1283	! value for the 2nd dimension (netcdf only)
1284	LOGICAL , INTENT(in ), OPTIONAL :: ldxios ! read data using XIOS
1285	!
1286	IF( kiomid > 0 ) THEN
1287	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_get_123d( kiomid, kdom , cdvar , pv_r2d=pvar, &
1288	& ktime=ktime, kstart=kstart, kcount=kcount, &
1289	& lrowattr=lrowattr, ldxios=ldxios)
1290	ENDIF
1291	END SUBROUTINE iom_g2d
1292
1293	SUBROUTINE iom_g3d( kiomid, kdom, cdvar, pvar, ktime, kstart, kcount, lrowattr, ldxios )
1294	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
1295	INTEGER , INTENT(in ) :: kdom ! Type of domain to be read
1296	CHARACTER(len=*), INTENT(in ) :: cdvar ! Name of the variable
1297	REAL(wp) , INTENT( out), DIMENSION(:,:,:) :: pvar ! read field
1298	INTEGER , INTENT(in ) , OPTIONAL :: ktime ! record number
1299	INTEGER , INTENT(in ), DIMENSION(3) , OPTIONAL :: kstart ! start axis position of the reading
1300	INTEGER , INTENT(in ), DIMENSION(3) , OPTIONAL :: kcount ! number of points in each axis
1301	LOGICAL , INTENT(in ) , OPTIONAL :: lrowattr ! logical flag telling iom_get to
1302	! look for and use a file attribute
1303	! called open_ocean_jstart to set the start
1304	! value for the 2nd dimension (netcdf only)
1305	LOGICAL , INTENT(in ), OPTIONAL :: ldxios ! read data using XIOS
1306	!
1307	IF( kiomid > 0 ) THEN
1308	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_get_123d( kiomid, kdom , cdvar , pv_r3d=pvar, &
1309	& ktime=ktime, kstart=kstart, kcount=kcount, &
1310	& lrowattr=lrowattr, ldxios=ldxios )
1311	ENDIF
1312	END SUBROUTINE iom_g3d
1313
1314	SUBROUTINE iom_g4d( kiomid, kdom, cdvar, pvar, ktime, kstart, kcount, lrowattr, ldxios )
1315	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
1316	INTEGER , INTENT(in ) :: kdom ! Type of domain to be read
1317	CHARACTER(len=*), INTENT(in ) :: cdvar ! Name of the variable
1318	REAL(wp) , INTENT( out), DIMENSION(:,:,:,:) :: pvar ! read field
1319	INTEGER , INTENT(in ) , OPTIONAL :: ktime ! record number
1320	INTEGER , INTENT(in ), DIMENSION(4) , OPTIONAL :: kstart ! start axis position of the reading
1321	INTEGER , INTENT(in ), DIMENSION(4) , OPTIONAL :: kcount ! number of points in each axis
1322	LOGICAL , INTENT(in ) , OPTIONAL :: lrowattr ! logical flag telling iom_get to
1323	! look for and use a file attribute
1324	! called open_ocean_jstart to set the start
1325	! value for the 2nd dimension (netcdf only)
1326	LOGICAL , INTENT(in ), OPTIONAL :: ldxios ! read data using XIOS
1327	!
1328	IF( kiomid > 0 ) THEN
1329	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_get_123d( kiomid, kdom , cdvar , pv_r4d=pvar, &
1330	& ktime=ktime, kstart=kstart, kcount=kcount, &
1331	& lrowattr=lrowattr, ldxios=ldxios )
1332	ENDIF
1333	END SUBROUTINE iom_g4d
1334	!!----------------------------------------------------------------------
1335
1336	SUBROUTINE iom_get_123d( kiomid, kdom , cdvar , &
1337	& pv_r1d, pv_r2d, pv_r3d, pv_r4d, &
1338	& ktime , kstart, kcount, &
1339	& lrowattr, ldxios )
1340	!!-----------------------------------------------------------------------
1341	!! * ROUTINE iom_get_123d *
1342	!!
1343	!! ** Purpose : read a 1D/2D/3D variable
1344	!!
1345	!! ** Method : read ONE record at each CALL
1346	!!-----------------------------------------------------------------------
1347	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
1348	INTEGER , INTENT(in ) :: kdom ! Type of domain to be read
1349	CHARACTER(len=*) , INTENT(in ) :: cdvar ! Name of the variable
1350	REAL(wp), DIMENSION(:) , INTENT( out), OPTIONAL :: pv_r1d ! read field (1D case)
1351	REAL(wp), DIMENSION(:,:) , INTENT( out), OPTIONAL :: pv_r2d ! read field (2D case)
1352	REAL(wp), DIMENSION(:,:,:) , INTENT( out), OPTIONAL :: pv_r3d ! read field (3D case)
1353	REAL(wp), DIMENSION(:,:,:,:),INTENT( out), OPTIONAL :: pv_r4d ! read field (4D case)
1354	INTEGER , INTENT(in ), OPTIONAL :: ktime ! record number
1355	INTEGER , DIMENSION(:) , INTENT(in ), OPTIONAL :: kstart ! start position of the reading in each axis
1356	INTEGER , DIMENSION(:) , INTENT(in ), OPTIONAL :: kcount ! number of points to be read in each axis
1357	LOGICAL , INTENT(in ), OPTIONAL :: lrowattr ! logical flag telling iom_get to
1358	! look for and use a file attribute
1359	! called open_ocean_jstart to set the start
1360	! value for the 2nd dimension (netcdf only)
1361	LOGICAL , INTENT(in ), OPTIONAL :: ldxios ! use XIOS to read restart
1362	!
1363	LOGICAL :: llxios ! local definition for XIOS read
1364	LOGICAL :: llnoov ! local definition to read overlap
1365	LOGICAL :: luse_jattr ! local definition to read open_ocean_jstart file attribute
1366	INTEGER :: jstartrow ! start point for 2nd dimension optionally set by file attribute
1367	INTEGER :: jl ! loop on number of dimension
1368	INTEGER :: idom ! type of domain
1369	INTEGER :: idvar ! id of the variable
1370	INTEGER :: inbdim ! number of dimensions of the variable
1371	INTEGER :: idmspc ! number of spatial dimensions
1372	INTEGER :: itime ! record number
1373	INTEGER :: istop ! temporary value of nstop
1374	INTEGER :: ix1, ix2, iy1, iy2 ! subdomain indexes
1375	INTEGER :: ji, jj ! loop counters
1376	INTEGER :: irankpv !
1377	INTEGER :: ind1, ind2 ! substring index
1378	INTEGER, DIMENSION(jpmax_dims) :: istart ! starting point to read for each axis
1379	INTEGER, DIMENSION(jpmax_dims) :: icnt ! number of value to read along each axis
1380	INTEGER, DIMENSION(jpmax_dims) :: idimsz ! size of the dimensions of the variable
1381	INTEGER, DIMENSION(jpmax_dims) :: ishape ! size of the dimensions of the variable
1382	REAL(wp) :: zscf, zofs ! sacle_factor and add_offset
1383	INTEGER :: itmp ! temporary integer
1384	CHARACTER(LEN=256) :: clinfo ! info character
1385	CHARACTER(LEN=256) :: clname ! file name
1386	CHARACTER(LEN=1) :: clrankpv, cldmspc !
1387	LOGICAL :: ll_depth_spec ! T => if kstart, kcount present then only use values for 3rd spatial dimension.
1388	INTEGER :: inlev ! number of levels for 3D data
1389	REAL(wp) :: gma, gmi
1390	!---------------------------------------------------------------------
1391	!
1392	inlev = -1
1393	IF( PRESENT(pv_r3d) ) inlev = SIZE(pv_r3d, 3)
1394	!
1395	llxios = .FALSE.
1396	if(PRESENT(ldxios)) llxios = ldxios
1397	idvar = iom_varid( kiomid, cdvar )
1398	idom = kdom
1399	!
1400	IF(.NOT.llxios) THEN
1401	clname = iom_file(kiomid)%name ! esier to read
1402	clinfo = ' iom_get_123d, file: '//trim(clname)//', var: '//trim(cdvar)
1403	! local definition of the domain ?
1404	! do we read the overlap
1405	! ugly patch SM+JMM+RB to overwrite global definition in some cases
1406	llnoov = (jpni * jpnj ) == jpnij .AND. .NOT. lk_agrif
1407	! check kcount and kstart optionals parameters...
1408	IF( PRESENT(kcount) .AND. (.NOT. PRESENT(kstart)) ) CALL ctl_stop(trim(clinfo), 'kcount present needs kstart present')
1409	IF( PRESENT(kstart) .AND. (.NOT. PRESENT(kcount)) ) CALL ctl_stop(trim(clinfo), 'kstart present needs kcount present')
1410	IF( PRESENT(kstart) .AND. idom /= jpdom_unknown .AND. idom /= jpdom_autoglo_xy ) &
1411	& CALL ctl_stop(trim(clinfo), 'kstart present needs kdom = jpdom_unknown or kdom = jpdom_autoglo_xy')
1412
1413	luse_jattr = .false.
1414	IF( PRESENT(lrowattr) ) THEN
1415	IF( lrowattr .AND. idom /= jpdom_data ) CALL ctl_stop(trim(clinfo), 'lrowattr present and true needs kdom = jpdom_data')
1416	IF( lrowattr .AND. idom == jpdom_data ) luse_jattr = .true.
1417	ENDIF
1418
1419	! Search for the variable in the data base (eventually actualize data)
1420	istop = nstop
1421	!
1422	IF( idvar > 0 ) THEN
1423	! to write iom_file(kiomid)%dimsz in a shorter way !
1424	idimsz(:) = iom_file(kiomid)%dimsz(:, idvar)
1425	inbdim = iom_file(kiomid)%ndims(idvar) ! number of dimensions in the file
1426	idmspc = inbdim ! number of spatial dimensions in the file
1427	IF( iom_file(kiomid)%luld(idvar) ) idmspc = inbdim - 1
1428	IF( idmspc > 3 ) CALL ctl_stop(trim(clinfo), 'the file has more than 3 spatial dimensions this case is not coded...')
1429	!
1430	! update idom definition...
1431	! Identify the domain in case of jpdom_auto(glo/dta) definition
1432	IF( idom == jpdom_autoglo_xy ) THEN
1433	ll_depth_spec = .TRUE.
1434	idom = jpdom_autoglo
1435	ELSE
1436	ll_depth_spec = .FALSE.
1437	ENDIF
1438	IF( idom == jpdom_autoglo .OR. idom == jpdom_autodta ) THEN
1439	IF( idom == jpdom_autoglo ) THEN ; idom = jpdom_global
1440	ELSE ; idom = jpdom_data
1441	ENDIF
1442	ind1 = INDEX( clname, '_', back = .TRUE. ) + 1
1443	ind2 = INDEX( clname, '.', back = .TRUE. ) - 1
1444	IF( ind2 > ind1 ) THEN ; IF( VERIFY( clname(ind1:ind2), '0123456789' ) == 0 ) idom = jpdom_local ; ENDIF
1445	ENDIF
1446	! Identify the domain in case of jpdom_local definition
1447	IF( idom == jpdom_local ) THEN
1448	IF( idimsz(1) == jpi .AND. idimsz(2) == jpj ) THEN ; idom = jpdom_local_full
1449	ELSEIF( idimsz(1) == nlci .AND. idimsz(2) == nlcj ) THEN ; idom = jpdom_local_noextra
1450	ELSEIF( idimsz(1) == (nlei - nldi + 1) .AND. idimsz(2) == (nlej - nldj + 1) ) THEN ; idom = jpdom_local_noovlap
1451	ELSE ; CALL ctl_stop( trim(clinfo), 'impossible to identify the local domain' )
1452	ENDIF
1453	ENDIF
1454	!
1455	! check the consistency between input array and data rank in the file
1456	!
1457	! initializations
1458	itime = 1
1459	IF( PRESENT(ktime) ) itime = ktime
1460	!
1461	irankpv = 1 * COUNT( (/PRESENT(pv_r1d)/) ) + 2 * COUNT( (/PRESENT(pv_r2d)/) ) + 3 * COUNT( (/PRESENT(pv_r3d)/) )
1462	WRITE(clrankpv, fmt='(i1)') irankpv
1463	WRITE(cldmspc , fmt='(i1)') idmspc
1464	!
1465	IF( idmspc < irankpv ) THEN
1466	CALL ctl_stop( TRIM(clinfo), 'The file has only '//cldmspc//' spatial dimension', &
1467	& 'it is impossible to read a '//clrankpv//'D array from this file...' )
1468	ELSEIF( idmspc == irankpv ) THEN
1469	IF( PRESENT(pv_r1d) .AND. idom /= jpdom_unknown ) &
1470	& CALL ctl_stop( TRIM(clinfo), 'case not coded...You must use jpdom_unknown' )
1471	ELSEIF( idmspc > irankpv ) THEN
1472	IF( PRESENT(pv_r2d) .AND. itime == 1 .AND. idimsz(3) == 1 .AND. idmspc == 3 ) THEN
1473	CALL ctl_warn( trim(clinfo), '2D array but 3 spatial dimensions for the data...' , &
1474	& 'As the size of the z dimension is 1 and as we try to read the first record, ', &
1475	& 'we accept this case, even if there is a possible mix-up between z and time dimension' )
1476	idmspc = idmspc - 1
1477	ELSE
1478	CALL ctl_stop( TRIM(clinfo), 'To keep iom lisibility, when reading a '//clrankpv//'D array,' , &
1479	& 'we do not accept data with '//cldmspc//' spatial dimensions', &
1480	& 'Use ncwa -a to suppress the unnecessary dimensions' )
1481	ENDIF
1482	ENDIF
1483	!
1484	! definition of istart and icnt
1485	!
1486	icnt (:) = 1
1487	istart(:) = 1
1488	istart(idmspc+1) = itime
1489
1490	IF( PRESENT(kstart) .AND. .NOT. ll_depth_spec ) THEN
1491	istart(1:idmspc) = kstart(1:idmspc)
1492	icnt (1:idmspc) = kcount(1:idmspc)
1493	ELSE
1494	IF(idom == jpdom_unknown ) THEN
1495	icnt(1:idmspc) = idimsz(1:idmspc)
1496	ELSE
1497	IF( .NOT. PRESENT(pv_r1d) ) THEN ! not a 1D array
1498	IF( idom == jpdom_data ) THEN
1499	jstartrow = 1
1500	IF( luse_jattr ) THEN
1501	CALL iom_getatt(kiomid, 'open_ocean_jstart', jstartrow ) ! -999 is returned if the attribute is not found
1502	jstartrow = MAX(1,jstartrow)
1503	ENDIF
1504	istart(1:2) = (/ mig(1), mjg(1) + jstartrow - 1 /) ! icnt(1:2) done below
1505	ELSEIF( idom == jpdom_global ) THEN ; istart(1:2) = (/ nimpp , njmpp /) ! icnt(1:2) done below
1506	ENDIF
1507	! we do not read the overlap -> we start to read at nldi, nldj
1508	! JMM + SM: ugly patch before getting the new version of lib_mpp)
1509	! IF( idom /= jpdom_local_noovlap ) istart(1:2) = istart(1:2) + (/ nldi - 1, nldj - 1 /)
1510	IF( llnoov .AND. idom /= jpdom_local_noovlap ) istart(1:2) = istart(1:2) + (/ nldi - 1, nldj - 1 /)
1511	! we do not read the overlap and the extra-halos -> from nldi to nlei and from nldj to nlej
1512	! JMM + SM: ugly patch before getting the new version of lib_mpp)
1513	! icnt(1:2) = (/ nlei - nldi + 1, nlej - nldj + 1 /)
1514	IF( llnoov ) THEN ; icnt(1:2) = (/ nlei - nldi + 1, nlej - nldj + 1 /)
1515	ELSE ; icnt(1:2) = (/ nlci , nlcj /)
1516	ENDIF
1517	IF( PRESENT(pv_r3d) ) THEN
1518	IF( idom == jpdom_data ) THEN ; icnt(3) = inlev
1519	ELSEIF( ll_depth_spec .AND. PRESENT(kstart) ) THEN ; istart(3) = kstart(3) ; icnt(3) = kcount(3)
1520	ELSE ; icnt(3) = inlev
1521	ENDIF
1522	ENDIF
1523	ENDIF
1524	ENDIF
1525	ENDIF
1526
1527	! check that istart and icnt can be used with this file
1528	!-
1529	DO jl = 1, jpmax_dims
1530	itmp = istart(jl)+icnt(jl)-1
1531	IF( itmp > idimsz(jl) .AND. idimsz(jl) /= 0 ) THEN
1532	WRITE( ctmp1, FMT="('(istart(', i1, ') + icnt(', i1, ') - 1) = ', i5)" ) jl, jl, itmp
1533	WRITE( ctmp2, FMT="(' is larger than idimsz(', i1,') = ', i5)" ) jl, idimsz(jl)
1534	CALL ctl_stop( trim(clinfo), 'start and count too big regarding to the size of the data, ', ctmp1, ctmp2 )
1535	ENDIF
1536	END DO
1537
1538	! check that icnt matches the input array
1539	!-
1540	IF( idom == jpdom_unknown ) THEN
1541	IF( irankpv == 1 ) ishape(1:1) = SHAPE(pv_r1d)
1542	IF( irankpv == 2 ) ishape(1:2) = SHAPE(pv_r2d)
1543	IF( irankpv == 3 ) ishape(1:3) = SHAPE(pv_r3d)
1544	ctmp1 = 'd'
1545	ELSE
1546	IF( irankpv == 2 ) THEN
1547	! JMM + SM: ugly patch before getting the new version of lib_mpp)
1548	! ishape(1:2) = SHAPE(pv_r2d(nldi:nlei,nldj:nlej )) ; ctmp1 = 'd(nldi:nlei,nldj:nlej)'
1549	IF( llnoov ) THEN ; ishape(1:2)=SHAPE(pv_r2d(nldi:nlei,nldj:nlej )) ; ctmp1='d(nldi:nlei,nldj:nlej)'
1550	ELSE ; ishape(1:2)=SHAPE(pv_r2d(1 :nlci,1 :nlcj )) ; ctmp1='d(1:nlci,1:nlcj)'
1551	ENDIF
1552	ENDIF
1553	IF( irankpv == 3 ) THEN
1554	! JMM + SM: ugly patch before getting the new version of lib_mpp)
1555	! ishape(1:3) = SHAPE(pv_r3d(nldi:nlei,nldj:nlej,:)) ; ctmp1 = 'd(nldi:nlei,nldj:nlej,:)'
1556	IF( llnoov ) THEN ; ishape(1:3)=SHAPE(pv_r3d(nldi:nlei,nldj:nlej,:)) ; ctmp1='d(nldi:nlei,nldj:nlej,:)'
1557	ELSE ; ishape(1:3)=SHAPE(pv_r3d(1 :nlci,1 :nlcj,:)) ; ctmp1='d(1:nlci,1:nlcj,:)'
1558	ENDIF
1559	ENDIF
1560	ENDIF
1561
1562	DO jl = 1, irankpv
1563	WRITE( ctmp2, FMT="(', ', i1,'): ', i5,' /= icnt(', i1,'):', i5)" ) jl, ishape(jl), jl, icnt(jl)
1564	IF( ishape(jl) /= icnt(jl) ) CALL ctl_stop( TRIM(clinfo), 'size(pv_r'//clrankpv//TRIM(ctmp1)//TRIM(ctmp2) )
1565	END DO
1566
1567	ENDIF
1568
1569	! read the data
1570	!-
1571	IF( idvar > 0 .AND. istop == nstop ) THEN ! no additional errors until this point...
1572	!
1573	! find the right index of the array to be read
1574	! JMM + SM: ugly patch before getting the new version of lib_mpp)
1575	! IF( idom /= jpdom_unknown ) THEN ; ix1 = nldi ; ix2 = nlei ; iy1 = nldj ; iy2 = nlej
1576	! ELSE ; ix1 = 1 ; ix2 = icnt(1) ; iy1 = 1 ; iy2 = icnt(2)
1577	! ENDIF
1578	IF( llnoov ) THEN
1579	IF( idom /= jpdom_unknown ) THEN ; ix1 = nldi ; ix2 = nlei ; iy1 = nldj ; iy2 = nlej
1580	ELSE ; ix1 = 1 ; ix2 = icnt(1) ; iy1 = 1 ; iy2 = icnt(2)
1581	ENDIF
1582	ELSE
1583	IF( idom /= jpdom_unknown ) THEN ; ix1 = 1 ; ix2 = nlci ; iy1 = 1 ; iy2 = nlcj
1584	ELSE ; ix1 = 1 ; ix2 = icnt(1) ; iy1 = 1 ; iy2 = icnt(2)
1585	ENDIF
1586	ENDIF
1587
1588	CALL iom_nf90_get( kiomid, idvar, inbdim, istart, icnt, ix1, ix2, iy1, iy2, pv_r1d, pv_r2d, pv_r3d )
1589
1590	IF( istop == nstop ) THEN ! no additional errors until this point...
1591	IF(lwp) WRITE(numout,"(10x,' read ',a,' (rec: ',i6,') in ',a,' ok')") TRIM(cdvar), itime, TRIM(iom_file(kiomid)%name)
1592
1593	!--- overlap areas and extra hallows (mpp)
1594	IF( PRESENT(pv_r2d) .AND. idom /= jpdom_unknown ) THEN
1595	CALL lbc_lnk( 'iom', pv_r2d,'Z', -999., kfillmode = jpfillnothing )
1596	ELSEIF( PRESENT(pv_r3d) .AND. idom /= jpdom_unknown ) THEN
1597	! this if could be simplified with the new lbc_lnk that works with any size of the 3rd dimension
1598	IF( icnt(3) == inlev ) THEN
1599	CALL lbc_lnk( 'iom', pv_r3d,'Z', -999., kfillmode = jpfillnothing )
1600	ELSE ! put some arbitrary value (a call to lbc_lnk will be done later...)
1601	DO jj = nlcj+1, jpj ; pv_r3d(1:nlci, jj, :) = pv_r3d(1:nlci, nlej, :) ; END DO
1602	DO ji = nlci+1, jpi ; pv_r3d(ji , : , :) = pv_r3d(nlei , : , :) ; END DO
1603	ENDIF
1604	ENDIF
1605	!
1606	ELSE
1607	! return if istop == nstop is false
1608	RETURN
1609	ENDIF
1610	ELSE
1611	! return if statment idvar > 0 .AND. istop == nstop is false
1612	RETURN
1613	ENDIF
1614	!
1615	ELSE ! read using XIOS. Only if KEY_IOMPUT is defined
1616	#if defined key_iomput
1617	!would be good to be able to check which context is active and swap only if current is not restart
1618	IF( PRESENT(pv_r4d) ) THEN
1619	pv_r4d(:, :, :, :) = 0.
1620	if(lwp) write(numout,*) 'XIOS RST READ (4D): ',trim(cdvar)
1621	CALL xios_recv_field( trim(cdvar), pv_r4d)
1622	IF(idom /= jpdom_unknown ) then
1623	CALL lbc_lnk( 'iom', pv_r4d,'Z', -999., kfillmode = jpfillnothing)
1624	ENDIF
1625	ELSEIF( PRESENT(pv_r3d) ) THEN
1626	pv_r3d(:, :, :) = 0.
1627	if(lwp) write(numout,*) 'XIOS RST READ (3D): ',trim(cdvar)
1628	CALL xios_recv_field( trim(cdvar), pv_r3d)
1629	IF(idom /= jpdom_unknown ) then
1630	CALL lbc_lnk( 'iom', pv_r3d,'Z', -999., kfillmode = jpfillnothing)
1631	ENDIF
1632	ELSEIF( PRESENT(pv_r2d) ) THEN
1633	pv_r2d(:, :) = 0.
1634	if(lwp) write(numout,*) 'XIOS RST READ (2D): ', trim(cdvar)
1635	CALL xios_recv_field( trim(cdvar), pv_r2d)
1636	IF(idom /= jpdom_unknown ) THEN
1637	CALL lbc_lnk('iom', pv_r2d,'Z',-999., kfillmode = jpfillnothing)
1638	ENDIF
1639	ELSEIF( PRESENT(pv_r1d) ) THEN
1640	pv_r1d(:) = 0.
1641	if(lwp) write(numout,*) 'XIOS RST READ (1D): ', trim(cdvar)
1642	CALL xios_recv_field( trim(cdvar), pv_r1d)
1643	ENDIF
1644	#else
1645	istop = istop + 1
1646	clinfo = 'Can not use XIOS in iom_get_123d, file: '//trim(clname)//', var:'//trim(cdvar)
1647	#endif
1648	ENDIF
1649	!some final adjustments
1650	! C1D case : always call lbc_lnk to replicate the central value over the whole 3X3 domain
1651	IF( lk_c1d .AND. PRESENT(pv_r2d) ) CALL lbc_lnk( 'iom', pv_r2d,'Z',1. )
1652	IF( lk_c1d .AND. PRESENT(pv_r3d) ) CALL lbc_lnk( 'iom', pv_r3d,'Z',1. )
1653
1654	!--- Apply scale_factor and offset
1655	zscf = iom_file(kiomid)%scf(idvar) ! scale factor
1656	zofs = iom_file(kiomid)%ofs(idvar) ! offset
1657	IF( PRESENT(pv_r1d) ) THEN
1658	IF( zscf /= 1. ) pv_r1d(:) = pv_r1d(:) * zscf
1659	IF( zofs /= 0. ) pv_r1d(:) = pv_r1d(:) + zofs
1660	ELSEIF( PRESENT(pv_r2d) ) THEN
1661	IF( zscf /= 1.) pv_r2d(:,:) = pv_r2d(:,:) * zscf
1662	IF( zofs /= 0.) pv_r2d(:,:) = pv_r2d(:,:) + zofs
1663	ELSEIF( PRESENT(pv_r3d) ) THEN
1664	IF( zscf /= 1.) pv_r3d(:,:,:) = pv_r3d(:,:,:) * zscf
1665	IF( zofs /= 0.) pv_r3d(:,:,:) = pv_r3d(:,:,:) + zofs
1666	ELSEIF( PRESENT(pv_r4d) ) THEN
1667	IF( zscf /= 1.) pv_r4d(:,:,:,:) = pv_r4d(:,:,:,:) * zscf
1668	IF( zofs /= 0.) pv_r4d(:,:,:,:) = pv_r4d(:,:,:,:) + zofs
1669	ENDIF
1670	!
1671	END SUBROUTINE iom_get_123d
1672
1673
1674	FUNCTION iom_getszuld ( kiomid )
1675	!!-----------------------------------------------------------------------
1676	!! * FUNCTION iom_getszuld *
1677	!!
1678	!! ** Purpose : get the size of the unlimited dimension in a file
1679	!! (return -1 if not found)
1680	!!-----------------------------------------------------------------------
1681	INTEGER, INTENT(in ) :: kiomid ! file Identifier
1682	!
1683	INTEGER :: iom_getszuld
1684	!!-----------------------------------------------------------------------
1685	iom_getszuld = -1
1686	IF( kiomid > 0 ) THEN
1687	IF( iom_file(kiomid)%iduld > 0 ) iom_getszuld = iom_file(kiomid)%lenuld
1688	ENDIF
1689	END FUNCTION iom_getszuld
1690
1691
1692	!!----------------------------------------------------------------------
1693	!! INTERFACE iom_chkatt
1694	!!----------------------------------------------------------------------
1695	SUBROUTINE iom_chkatt( kiomid, cdatt, llok, ksize, cdvar )
1696	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
1697	CHARACTER(len=*), INTENT(in ) :: cdatt ! Name of the attribute
1698	LOGICAL , INTENT( out) :: llok ! Error code
1699	INTEGER , INTENT( out), OPTIONAL :: ksize ! Size of the attribute array
1700	CHARACTER(len=*), INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
1701	!
1702	IF( kiomid > 0 ) THEN
1703	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_chkatt( kiomid, cdatt, llok, ksize=ksize, cdvar=cdvar )
1704	ENDIF
1705	!
1706	END SUBROUTINE iom_chkatt
1707
1708	!!----------------------------------------------------------------------
1709	!! INTERFACE iom_getatt
1710	!!----------------------------------------------------------------------
1711	SUBROUTINE iom_g0d_iatt( kiomid, cdatt, katt0d, cdvar )
1712	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
1713	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
1714	INTEGER , INTENT( out) :: katt0d ! read field
1715	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
1716	!
1717	IF( kiomid > 0 ) THEN
1718	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_getatt( kiomid, cdatt, katt0d = katt0d, cdvar=cdvar )
1719	ENDIF
1720	END SUBROUTINE iom_g0d_iatt
1721
1722	SUBROUTINE iom_g1d_iatt( kiomid, cdatt, katt1d, cdvar )
1723	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
1724	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
1725	INTEGER, DIMENSION(:) , INTENT( out) :: katt1d ! read field
1726	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
1727	!
1728	IF( kiomid > 0 ) THEN
1729	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_getatt( kiomid, cdatt, katt1d = katt1d, cdvar=cdvar )
1730	ENDIF
1731	END SUBROUTINE iom_g1d_iatt
1732
1733	SUBROUTINE iom_g0d_ratt( kiomid, cdatt, patt0d, cdvar )
1734	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
1735	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
1736	REAL(wp) , INTENT( out) :: patt0d ! read field
1737	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
1738	!
1739	IF( kiomid > 0 ) THEN
1740	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_getatt( kiomid, cdatt, patt0d = patt0d, cdvar=cdvar )
1741	ENDIF
1742	END SUBROUTINE iom_g0d_ratt
1743
1744	SUBROUTINE iom_g1d_ratt( kiomid, cdatt, patt1d, cdvar )
1745	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
1746	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
1747	REAL(wp), DIMENSION(:), INTENT( out) :: patt1d ! read field
1748	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
1749	!
1750	IF( kiomid > 0 ) THEN
1751	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_getatt( kiomid, cdatt, patt1d = patt1d, cdvar=cdvar )
1752	ENDIF
1753	END SUBROUTINE iom_g1d_ratt
1754
1755	SUBROUTINE iom_g0d_catt( kiomid, cdatt, cdatt0d, cdvar )
1756	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
1757	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
1758	CHARACTER(len=*) , INTENT( out) :: cdatt0d ! read field
1759	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
1760	!
1761	IF( kiomid > 0 ) THEN
1762	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_getatt( kiomid, cdatt, cdatt0d = cdatt0d, cdvar=cdvar )
1763	ENDIF
1764	END SUBROUTINE iom_g0d_catt
1765
1766
1767	!!----------------------------------------------------------------------
1768	!! INTERFACE iom_putatt
1769	!!----------------------------------------------------------------------
1770	SUBROUTINE iom_p0d_iatt( kiomid, cdatt, katt0d, cdvar )
1771	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
1772	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
1773	INTEGER , INTENT(in ) :: katt0d ! written field
1774	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
1775	!
1776	IF( kiomid > 0 ) THEN
1777	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_putatt( kiomid, cdatt, katt0d = katt0d, cdvar=cdvar )
1778	ENDIF
1779	END SUBROUTINE iom_p0d_iatt
1780
1781	SUBROUTINE iom_p1d_iatt( kiomid, cdatt, katt1d, cdvar )
1782	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
1783	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
1784	INTEGER, DIMENSION(:) , INTENT(in ) :: katt1d ! written field
1785	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
1786	!
1787	IF( kiomid > 0 ) THEN
1788	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_putatt( kiomid, cdatt, katt1d = katt1d, cdvar=cdvar )
1789	ENDIF
1790	END SUBROUTINE iom_p1d_iatt
1791
1792	SUBROUTINE iom_p0d_ratt( kiomid, cdatt, patt0d, cdvar )
1793	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
1794	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
1795	REAL(wp) , INTENT(in ) :: patt0d ! written field
1796	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
1797	!
1798	IF( kiomid > 0 ) THEN
1799	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_putatt( kiomid, cdatt, patt0d = patt0d, cdvar=cdvar )
1800	ENDIF
1801	END SUBROUTINE iom_p0d_ratt
1802
1803	SUBROUTINE iom_p1d_ratt( kiomid, cdatt, patt1d, cdvar )
1804	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
1805	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
1806	REAL(wp), DIMENSION(:), INTENT(in ) :: patt1d ! written field
1807	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
1808	!
1809	IF( kiomid > 0 ) THEN
1810	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_putatt( kiomid, cdatt, patt1d = patt1d, cdvar=cdvar )
1811	ENDIF
1812	END SUBROUTINE iom_p1d_ratt
1813
1814	SUBROUTINE iom_p0d_catt( kiomid, cdatt, cdatt0d, cdvar )
1815	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
1816	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
1817	CHARACTER(len=*) , INTENT(in ) :: cdatt0d ! written field
1818	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
1819	!
1820	IF( kiomid > 0 ) THEN
1821	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_putatt( kiomid, cdatt, cdatt0d = cdatt0d, cdvar=cdvar )
1822	ENDIF
1823	END SUBROUTINE iom_p0d_catt
1824
1825
1826	!!----------------------------------------------------------------------
1827	!! INTERFACE iom_rstput
1828	!!----------------------------------------------------------------------
1829	SUBROUTINE iom_rp0d( kt, kwrite, kiomid, cdvar, pvar, ktype, ldxios )
1830	INTEGER , INTENT(in) :: kt ! ocean time-step
1831	INTEGER , INTENT(in) :: kwrite ! writing time-step
1832	INTEGER , INTENT(in) :: kiomid ! Identifier of the file
1833	CHARACTER(len=*), INTENT(in) :: cdvar ! time axis name
1834	REAL(wp) , INTENT(in) :: pvar ! written field
1835	INTEGER , INTENT(in), OPTIONAL :: ktype ! variable external type
1836	LOGICAL, OPTIONAL :: ldxios ! xios write flag
1837	LOGICAL :: llx ! local xios write flag
1838	INTEGER :: ivid ! variable id
1839
1840	llx = .FALSE.
1841	IF(PRESENT(ldxios)) llx = ldxios
1842	IF( llx ) THEN
1843	#ifdef key_iomput
1844	IF( kt == kwrite ) THEN
1845	IF(lwp) write(numout,*) 'RESTART: write (XIOS 0D) ',trim(cdvar)
1846	write(snr, *) nitrst
1847	CALL xios_send_field(trim(cdvar)//"_"//TRIM(ADJUSTL(snr)), pvar)
1848	ENDIF
1849	#endif
1850	ELSE
1851	IF( kiomid > 0 ) THEN
1852	IF( iom_file(kiomid)%nfid > 0 ) THEN
1853	ivid = iom_varid( kiomid, cdvar, ldstop = .FALSE. )
1854	CALL iom_nf90_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r0d = pvar )
1855	ENDIF
1856	ENDIF
1857	ENDIF
1858	END SUBROUTINE iom_rp0d
1859
1860	SUBROUTINE iom_rp1d( kt, kwrite, kiomid, cdvar, pvar, ktype, ldxios )
1861	INTEGER , INTENT(in) :: kt ! ocean time-step
1862	INTEGER , INTENT(in) :: kwrite ! writing time-step
1863	INTEGER , INTENT(in) :: kiomid ! Identifier of the file
1864	CHARACTER(len=*), INTENT(in) :: cdvar ! time axis name
1865	REAL(wp) , INTENT(in), DIMENSION( :) :: pvar ! written field
1866	INTEGER , INTENT(in), OPTIONAL :: ktype ! variable external type
1867	LOGICAL, OPTIONAL :: ldxios ! xios write flag
1868	LOGICAL :: llx ! local xios write flag
1869	INTEGER :: ivid ! variable id
1870
1871	llx = .FALSE.
1872	IF(PRESENT(ldxios)) llx = ldxios
1873	IF( llx ) THEN
1874	#ifdef key_iomput
1875	IF( kt == kwrite ) THEN
1876	IF(lwp) write(numout,*) 'RESTART: write (XIOS 1D) ',trim(cdvar)
1877	write(snr, *) nitrst
1878	CALL xios_send_field(trim(cdvar)//"_"//TRIM(ADJUSTL(snr)), pvar)
1879	ENDIF
1880	#endif
1881	ELSE
1882	IF( kiomid > 0 ) THEN
1883	IF( iom_file(kiomid)%nfid > 0 ) THEN
1884	ivid = iom_varid( kiomid, cdvar, ldstop = .FALSE. )
1885	CALL iom_nf90_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r1d = pvar )
1886	ENDIF
1887	ENDIF
1888	ENDIF
1889	END SUBROUTINE iom_rp1d
1890
1891	SUBROUTINE iom_rp2d( kt, kwrite, kiomid, cdvar, pvar, ktype, ldxios )
1892	INTEGER , INTENT(in) :: kt ! ocean time-step
1893	INTEGER , INTENT(in) :: kwrite ! writing time-step
1894	INTEGER , INTENT(in) :: kiomid ! Identifier of the file
1895	CHARACTER(len=*), INTENT(in) :: cdvar ! time axis name
1896	REAL(wp) , INTENT(in), DIMENSION(:, : ) :: pvar ! written field
1897	INTEGER , INTENT(in), OPTIONAL :: ktype ! variable external type
1898	LOGICAL, OPTIONAL :: ldxios ! xios write flag
1899	LOGICAL :: llx
1900	INTEGER :: ivid ! variable id
1901
1902	llx = .FALSE.
1903	IF(PRESENT(ldxios)) llx = ldxios
1904	IF( llx ) THEN
1905	#ifdef key_iomput
1906	IF( kt == kwrite ) THEN
1907	IF(lwp) write(numout,*) 'RESTART: write (XIOS 2D) ',trim(cdvar)
1908	write(snr, *) nitrst
1909	CALL xios_send_field(trim(cdvar)//"_"//TRIM(ADJUSTL(snr)), pvar)
1910	ENDIF
1911	#endif
1912	ELSE
1913	IF( kiomid > 0 ) THEN
1914	IF( iom_file(kiomid)%nfid > 0 ) THEN
1915	ivid = iom_varid( kiomid, cdvar, ldstop = .FALSE. )
1916	CALL iom_nf90_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r2d = pvar )
1917	ENDIF
1918	ENDIF
1919	ENDIF
1920	END SUBROUTINE iom_rp2d
1921
1922	SUBROUTINE iom_rp3d( kt, kwrite, kiomid, cdvar, pvar, ktype, ldxios )
1923	INTEGER , INTENT(in) :: kt ! ocean time-step
1924	INTEGER , INTENT(in) :: kwrite ! writing time-step
1925	INTEGER , INTENT(in) :: kiomid ! Identifier of the file
1926	CHARACTER(len=*), INTENT(in) :: cdvar ! time axis name
1927	REAL(wp) , INTENT(in), DIMENSION(:,:,:) :: pvar ! written field
1928	INTEGER , INTENT(in), OPTIONAL :: ktype ! variable external type
1929	LOGICAL, OPTIONAL :: ldxios ! xios write flag
1930	LOGICAL :: llx ! local xios write flag
1931	INTEGER :: ivid ! variable id
1932
1933	llx = .FALSE.
1934	IF(PRESENT(ldxios)) llx = ldxios
1935	IF( llx ) THEN
1936	#ifdef key_iomput
1937	IF( kt == kwrite ) THEN
1938	IF(lwp) write(numout,*) 'RESTART: write (XIOS 3D) ',trim(cdvar)
1939	write(snr, *) nitrst
1940	CALL xios_send_field(trim(cdvar)//"_"//TRIM(ADJUSTL(snr)), pvar)
1941	ENDIF
1942	#endif
1943	ELSE
1944	IF( kiomid > 0 ) THEN
1945	IF( iom_file(kiomid)%nfid > 0 ) THEN
1946	ivid = iom_varid( kiomid, cdvar, ldstop = .FALSE. )
1947	CALL iom_nf90_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r3d = pvar )
1948	ENDIF
1949	ENDIF
1950	ENDIF
1951	END SUBROUTINE iom_rp3d
1952
1953	SUBROUTINE iom_rp4d( kt, kwrite, kiomid, cdvar, pvar, ktype, ldxios )
1954	INTEGER , INTENT(in) :: kt ! ocean time-step
1955	INTEGER , INTENT(in) :: kwrite ! writing time-step
1956	INTEGER , INTENT(in) :: kiomid ! Identifier of the file
1957	CHARACTER(len=*), INTENT(in) :: cdvar ! time axis name
1958	REAL(wp) , INTENT(in), DIMENSION(:,:,:,:) :: pvar ! written field
1959	INTEGER , INTENT(in), OPTIONAL :: ktype ! variable external type
1960	LOGICAL, OPTIONAL :: ldxios ! xios write flag
1961	LOGICAL :: llx ! local xios write flag
1962	INTEGER :: ivid ! variable id
1963
1964	llx = .FALSE.
1965	IF(PRESENT(ldxios)) llx = ldxios
1966	IF( llx ) THEN
1967	#ifdef key_iomput
1968	IF( kt == kwrite ) THEN
1969	IF(lwp) write(numout,*) 'RESTART: write (XIOS 4D) ',trim(cdvar)
1970	write(snr, *) nitrst
1971	CALL xios_send_field(trim(cdvar)//"_"//TRIM(ADJUSTL(snr)), pvar)
1972	ENDIF
1973	#endif
1974	ELSE
1975	CALL ctl_stop('Error in the name iom_rp4d for variable '//TRIM(cdvar), &
1976	& 'Restart with iom_nf90_rstput can not handle 4D cases' )
1977	ENDIF
1978	END SUBROUTINE iom_rp4d
1979
1980	SUBROUTINE iom_delay_rst( cdaction, cdcpnt, kncid )
1981	!!---------------------------------------------------------------------
1982	!! Routine iom_delay_rst: used read/write restart related to mpp_delay
1983	!!
1984	!!---------------------------------------------------------------------
1985	CHARACTER(len=*), INTENT(in ) :: cdaction !
1986	CHARACTER(len=*), INTENT(in ) :: cdcpnt
1987	INTEGER , INTENT(in ) :: kncid
1988	!
1989	INTEGER :: ji
1990	INTEGER :: indim
1991	LOGICAL :: llattexist
1992	REAL(wp), ALLOCATABLE, DIMENSION(:) :: zreal1d
1993	!!---------------------------------------------------------------------
1994	!
1995	!return for now. When XIOS is used to write restart it also should be used to write this attribute
1996	IF(lwxios) THEN
1997	CALL ctl_warn( 'From iom_delay_rst: ', 'Can not '//cdaction//' mpp_delay information with XIOS')
1998	RETURN
1999	ENDIF
2000
2001	! ===================================
2002	IF( TRIM(cdaction) == 'READ' ) THEN ! read restart related to mpp_delay !
2003	! ===================================
2004	DO ji = 1, nbdelay
2005	IF ( c_delaycpnt(ji) == cdcpnt ) THEN
2006	CALL iom_chkatt( kncid, 'DELAY_'//c_delaylist(ji), llattexist, indim )
2007	IF( llattexist ) THEN
2008	ALLOCATE( todelay(ji)%z1d(indim) )
2009	CALL iom_getatt( kncid, 'DELAY_'//c_delaylist(ji), todelay(ji)%z1d(:) )
2010	ndelayid(ji) = 0 ! set to 0 to specify that the value was read in the restart
2011	ENDIF
2012	ENDIF
2013	END DO
2014	! ====================================
2015	ELSE ! write restart related to mpp_delay !
2016	! ====================================
2017	DO ji = 1, nbdelay ! save only ocean delayed global communication variables
2018	IF ( c_delaycpnt(ji) == cdcpnt ) THEN
2019	IF( ASSOCIATED(todelay(ji)%z1d) ) THEN
2020	CALL mpp_delay_rcv(ji) ! make sure %z1d is received
2021	CALL iom_putatt( kncid, 'DELAY_'//c_delaylist(ji), todelay(ji)%z1d(:) )
2022	ENDIF
2023	ENDIF
2024	END DO
2025	!
2026	ENDIF
2027
2028	END SUBROUTINE iom_delay_rst
2029
2030
2031
2032	!!----------------------------------------------------------------------
2033	!! INTERFACE iom_put
2034	!!----------------------------------------------------------------------
2035	SUBROUTINE iom_p0d( cdname, pfield0d )
2036	CHARACTER(LEN=*), INTENT(in) :: cdname
2037	REAL(wp) , INTENT(in) :: pfield0d
2038	!! REAL(wp) , DIMENSION(jpi,jpj) :: zz ! masson
2039	#if defined key_iomput
2040	!!clem zz(:,:)=pfield0d
2041	!!clem CALL xios_send_field(cdname, zz)
2042	CALL xios_send_field(cdname, (/pfield0d/))
2043	#else
2044	IF( .FALSE. ) WRITE(numout,*) cdname, pfield0d ! useless test to avoid compilation warnings
2045	#endif
2046	END SUBROUTINE iom_p0d
2047
2048	SUBROUTINE iom_p1d( cdname, pfield1d )
2049	CHARACTER(LEN=*) , INTENT(in) :: cdname
2050	REAL(wp), DIMENSION(:), INTENT(in) :: pfield1d
2051	#if defined key_iomput
2052	CALL xios_send_field( cdname, RESHAPE( (/pfield1d/), (/1,1,SIZE(pfield1d)/) ) )
2053	#else
2054	IF( .FALSE. ) WRITE(numout,*) cdname, pfield1d ! useless test to avoid compilation warnings
2055	#endif
2056	END SUBROUTINE iom_p1d
2057
2058	SUBROUTINE iom_p2d( cdname, pfield2d )
2059	CHARACTER(LEN=*) , INTENT(in) :: cdname
2060	REAL(wp), DIMENSION(:,:), INTENT(in) :: pfield2d
2061	#if defined key_iomput
2062	CALL xios_send_field(cdname, pfield2d)
2063	#else
2064	IF( .FALSE. ) WRITE(numout,*) cdname, pfield2d ! useless test to avoid compilation warnings
2065	#endif
2066	END SUBROUTINE iom_p2d
2067
2068	SUBROUTINE iom_p3d( cdname, pfield3d )
2069	CHARACTER(LEN=*) , INTENT(in) :: cdname
2070	REAL(wp), DIMENSION(:,:,:), INTENT(in) :: pfield3d
2071	#if defined key_iomput
2072	CALL xios_send_field( cdname, pfield3d )
2073	#else
2074	IF( .FALSE. ) WRITE(numout,*) cdname, pfield3d ! useless test to avoid compilation warnings
2075	#endif
2076	END SUBROUTINE iom_p3d
2077
2078	#if defined key_iomput
2079	!!----------------------------------------------------------------------
2080	!! 'key_iomput' XIOS interface
2081	!!----------------------------------------------------------------------
2082
2083	SUBROUTINE iom_set_domain_attr( cdid, ni_glo, nj_glo, ibegin, jbegin, ni, nj, &
2084	& data_dim, data_ibegin, data_ni, data_jbegin, data_nj, lonvalue, latvalue, mask, &
2085	& nvertex, bounds_lon, bounds_lat, area )
2086	!!----------------------------------------------------------------------
2087	!!----------------------------------------------------------------------
2088	CHARACTER(LEN=*) , INTENT(in) :: cdid
2089	INTEGER , OPTIONAL, INTENT(in) :: ni_glo, nj_glo, ibegin, jbegin, ni, nj
2090	INTEGER , OPTIONAL, INTENT(in) :: data_dim, data_ibegin, data_ni, data_jbegin, data_nj
2091	INTEGER , OPTIONAL, INTENT(in) :: nvertex
2092	REAL(wp), DIMENSION(:) , OPTIONAL, INTENT(in) :: lonvalue, latvalue
2093	REAL(wp), DIMENSION(:,:), OPTIONAL, INTENT(in) :: bounds_lon, bounds_lat, area
2094	LOGICAL , DIMENSION(:) , OPTIONAL, INTENT(in) :: mask
2095	!!----------------------------------------------------------------------
2096	!
2097	IF( xios_is_valid_domain (cdid) ) THEN
2098	CALL xios_set_domain_attr ( cdid, ni_glo=ni_glo, nj_glo=nj_glo, ibegin=ibegin, jbegin=jbegin, ni=ni, nj=nj, &
2099	& data_dim=data_dim, data_ibegin=data_ibegin, data_ni=data_ni, data_jbegin=data_jbegin, data_nj=data_nj , &
2100	& lonvalue_1D=lonvalue, latvalue_1D=latvalue, mask_1D=mask, nvertex=nvertex, bounds_lon_1D=bounds_lon, &
2101	& bounds_lat_1D=bounds_lat, area=area, type='curvilinear')
2102	ENDIF
2103	IF( xios_is_valid_domaingroup(cdid) ) THEN
2104	CALL xios_set_domaingroup_attr( cdid, ni_glo=ni_glo, nj_glo=nj_glo, ibegin=ibegin, jbegin=jbegin, ni=ni, nj=nj, &
2105	& data_dim=data_dim, data_ibegin=data_ibegin, data_ni=data_ni, data_jbegin=data_jbegin, data_nj=data_nj , &
2106	& lonvalue_1D=lonvalue, latvalue_1D=latvalue, mask_1D=mask, nvertex=nvertex, bounds_lon_1D=bounds_lon, &
2107	& bounds_lat_1D=bounds_lat, area=area, type='curvilinear' )
2108	ENDIF
2109	!
2110	CALL xios_solve_inheritance()
2111	!
2112	END SUBROUTINE iom_set_domain_attr
2113
2114
2115	SUBROUTINE iom_set_zoom_domain_attr( cdid, ibegin, jbegin, ni, nj )
2116	!!----------------------------------------------------------------------
2117	!!----------------------------------------------------------------------
2118	CHARACTER(LEN=*), INTENT(in) :: cdid
2119	INTEGER , INTENT(in) :: ibegin, jbegin, ni, nj
2120	!
2121	TYPE(xios_gridgroup) :: gridgroup_hdl
2122	TYPE(xios_grid) :: grid_hdl
2123	TYPE(xios_domain) :: domain_hdl
2124	TYPE(xios_axis) :: axis_hdl
2125	CHARACTER(LEN=64) :: cldomrefid ! domain_ref name
2126	CHARACTER(len=1) :: cl1 ! last character of this name
2127	!!----------------------------------------------------------------------
2128	!
2129	IF( xios_is_valid_zoom_domain(cdid) ) THEN
2130	! define the zoom_domain attributs
2131	CALL xios_set_zoom_domain_attr( cdid, ibegin=ibegin, jbegin=jbegin, ni=ni, nj=nj )
2132	! define a new 2D grid with this new domain
2133	CALL xios_get_handle("grid_definition", gridgroup_hdl )
2134	CALL xios_add_child(gridgroup_hdl, grid_hdl, TRIM(cdid)//'_2D' ) ! add a new 2D grid to grid_definition
2135	CALL xios_add_child(grid_hdl, domain_hdl, TRIM(cdid) ) ! add its domain
2136	! define a new 3D grid with this new domain
2137	CALL xios_add_child(gridgroup_hdl, grid_hdl, TRIM(cdid)//'_3D' ) ! add a new 3D grid to grid_definition
2138	CALL xios_add_child(grid_hdl, domain_hdl, TRIM(cdid) ) ! add its domain
2139	! vertical axis
2140	cl1 = cdid(LEN_TRIM(cdid):) ! last letter of cdid
2141	cl1 = CHAR(ICHAR(cl1)+32) ! from upper to lower case
2142	CALL xios_add_child(grid_hdl, axis_hdl, 'depth'//cl1) ! add its axis
2143	ENDIF
2144	!
2145	END SUBROUTINE iom_set_zoom_domain_attr
2146
2147
2148	SUBROUTINE iom_set_axis_attr( cdid, paxis, bounds )
2149	!!----------------------------------------------------------------------
2150	!!----------------------------------------------------------------------
2151	CHARACTER(LEN=*) , INTENT(in) :: cdid
2152	REAL(wp), DIMENSION(:) , OPTIONAL, INTENT(in) :: paxis
2153	REAL(wp), DIMENSION(:,:), OPTIONAL, INTENT(in) :: bounds
2154	!!----------------------------------------------------------------------
2155	IF( PRESENT(paxis) ) THEN
2156	IF( xios_is_valid_axis (cdid) ) CALL xios_set_axis_attr ( cdid, n_glo=SIZE(paxis), value=paxis )
2157	IF( xios_is_valid_axisgroup(cdid) ) CALL xios_set_axisgroup_attr( cdid, n_glo=SIZE(paxis), value=paxis )
2158	ENDIF
2159	IF( xios_is_valid_axis (cdid) ) CALL xios_set_axis_attr ( cdid, bounds=bounds )
2160	IF( xios_is_valid_axisgroup(cdid) ) CALL xios_set_axisgroup_attr( cdid, bounds=bounds )
2161	CALL xios_solve_inheritance()
2162	END SUBROUTINE iom_set_axis_attr
2163
2164
2165	SUBROUTINE iom_set_field_attr( cdid, freq_op, freq_offset )
2166	!!----------------------------------------------------------------------
2167	!!----------------------------------------------------------------------
2168	CHARACTER(LEN=*) , INTENT(in) :: cdid
2169	TYPE(xios_duration), OPTIONAL, INTENT(in) :: freq_op
2170	TYPE(xios_duration), OPTIONAL, INTENT(in) :: freq_offset
2171	!!----------------------------------------------------------------------
2172	IF( xios_is_valid_field (cdid) ) CALL xios_set_field_attr ( cdid, freq_op=freq_op, freq_offset=freq_offset )
2173	IF( xios_is_valid_fieldgroup(cdid) ) CALL xios_set_fieldgroup_attr( cdid, freq_op=freq_op, freq_offset=freq_offset )
2174	CALL xios_solve_inheritance()
2175	END SUBROUTINE iom_set_field_attr
2176
2177
2178	SUBROUTINE iom_set_file_attr( cdid, name, name_suffix )
2179	!!----------------------------------------------------------------------
2180	!!----------------------------------------------------------------------
2181	CHARACTER(LEN=*) , INTENT(in) :: cdid
2182	CHARACTER(LEN=*),OPTIONAL , INTENT(in) :: name, name_suffix
2183	!!----------------------------------------------------------------------
2184	IF( xios_is_valid_file (cdid) ) CALL xios_set_file_attr ( cdid, name=name, name_suffix=name_suffix )
2185	IF( xios_is_valid_filegroup(cdid) ) CALL xios_set_filegroup_attr( cdid, name=name, name_suffix=name_suffix )
2186	CALL xios_solve_inheritance()
2187	END SUBROUTINE iom_set_file_attr
2188
2189
2190	SUBROUTINE iom_get_file_attr( cdid, name, name_suffix, output_freq )
2191	!!----------------------------------------------------------------------
2192	!!----------------------------------------------------------------------
2193	CHARACTER(LEN=*) , INTENT(in ) :: cdid
2194	CHARACTER(LEN=*),OPTIONAL , INTENT(out) :: name, name_suffix
2195	TYPE(xios_duration), OPTIONAL , INTENT(out) :: output_freq
2196	LOGICAL :: llexist1,llexist2,llexist3
2197	!---------------------------------------------------------------------
2198	IF( PRESENT( name ) ) name = '' ! default values
2199	IF( PRESENT( name_suffix ) ) name_suffix = ''
2200	IF( PRESENT( output_freq ) ) output_freq = xios_duration(0,0,0,0,0,0)
2201	IF( xios_is_valid_file (cdid) ) THEN
2202	CALL xios_solve_inheritance()
2203	CALL xios_is_defined_file_attr ( cdid, name = llexist1, name_suffix = llexist2, output_freq = llexist3)
2204	IF(llexist1) CALL xios_get_file_attr ( cdid, name = name )
2205	IF(llexist2) CALL xios_get_file_attr ( cdid, name_suffix = name_suffix )
2206	IF(llexist3) CALL xios_get_file_attr ( cdid, output_freq = output_freq )
2207	ENDIF
2208	IF( xios_is_valid_filegroup(cdid) ) THEN
2209	CALL xios_solve_inheritance()
2210	CALL xios_is_defined_filegroup_attr( cdid, name = llexist1, name_suffix = llexist2, output_freq = llexist3)
2211	IF(llexist1) CALL xios_get_filegroup_attr( cdid, name = name )
2212	IF(llexist2) CALL xios_get_filegroup_attr( cdid, name_suffix = name_suffix )
2213	IF(llexist3) CALL xios_get_filegroup_attr( cdid, output_freq = output_freq )
2214	ENDIF
2215	END SUBROUTINE iom_get_file_attr
2216
2217
2218	SUBROUTINE iom_set_grid_attr( cdid, mask )
2219	!!----------------------------------------------------------------------
2220	!!----------------------------------------------------------------------
2221	CHARACTER(LEN=*) , INTENT(in) :: cdid
2222	LOGICAL, DIMENSION(:,:,:), OPTIONAL, INTENT(in) :: mask
2223	!!----------------------------------------------------------------------
2224	IF( xios_is_valid_grid (cdid) ) CALL xios_set_grid_attr ( cdid, mask_3D=mask )
2225	IF( xios_is_valid_gridgroup(cdid) ) CALL xios_set_gridgroup_attr( cdid, mask_3D=mask )
2226	CALL xios_solve_inheritance()
2227	END SUBROUTINE iom_set_grid_attr
2228
2229	SUBROUTINE iom_setkt( kt, cdname )
2230	!!----------------------------------------------------------------------
2231	!!----------------------------------------------------------------------
2232	INTEGER , INTENT(in) :: kt
2233	CHARACTER(LEN=*), INTENT(in) :: cdname
2234	!!----------------------------------------------------------------------
2235	CALL iom_swap( cdname ) ! swap to cdname context
2236	CALL xios_update_calendar(kt)
2237	IF( cdname /= TRIM(cxios_context) ) CALL iom_swap( TRIM(cxios_context) ) ! return back to nemo context
2238	END SUBROUTINE iom_setkt
2239
2240	SUBROUTINE iom_context_finalize( cdname )
2241	!!----------------------------------------------------------------------
2242	!!----------------------------------------------------------------------
2243	CHARACTER(LEN=*), INTENT(in) :: cdname
2244	CHARACTER(LEN=120) :: clname
2245	!!----------------------------------------------------------------------
2246	clname = cdname
2247	IF( TRIM(Agrif_CFixed()) .NE. '0' ) clname = TRIM(Agrif_CFixed())//"_"//clname
2248	IF( xios_is_valid_context(clname) ) THEN
2249	CALL iom_swap( cdname ) ! swap to cdname context
2250	CALL xios_context_finalize() ! finalize the context
2251	IF( cdname /= TRIM(cxios_context) ) CALL iom_swap( TRIM(cxios_context) ) ! return back to nemo context
2252	ENDIF
2253	!
2254	END SUBROUTINE iom_context_finalize
2255
2256
2257	SUBROUTINE set_grid( cdgrd, plon, plat, ldxios, ldrxios )
2258	!!----------------------------------------------------------------------
2259	!! * ROUTINE set_grid *
2260	!!
2261	!! ** Purpose : define horizontal grids
2262	!!----------------------------------------------------------------------
2263	CHARACTER(LEN=1) , INTENT(in) :: cdgrd
2264	REAL(wp), DIMENSION(jpi,jpj), INTENT(in) :: plon
2265	REAL(wp), DIMENSION(jpi,jpj), INTENT(in) :: plat
2266	!
2267	INTEGER :: ni, nj
2268	REAL(wp), DIMENSION(jpi,jpj,jpk) :: zmask
2269	LOGICAL, INTENT(IN) :: ldxios, ldrxios
2270	!!----------------------------------------------------------------------
2271	!
2272	ni = nlei-nldi+1
2273	nj = nlej-nldj+1
2274	!
2275	CALL iom_set_domain_attr("grid_"//cdgrd, ni_glo=jpiglo, nj_glo=jpjglo, ibegin=nimpp+nldi-2, jbegin=njmpp+nldj-2, ni=ni, nj=nj)
2276	CALL iom_set_domain_attr("grid_"//cdgrd, data_dim=2, data_ibegin = 1-nldi, data_ni = jpi, data_jbegin = 1-nldj, data_nj = jpj)
2277	!don't define lon and lat for restart reading context.
2278	IF ( .NOT.ldrxios ) &
2279	CALL iom_set_domain_attr("grid_"//cdgrd, lonvalue = RESHAPE(plon(nldi:nlei, nldj:nlej),(/ ni*nj /)), &
2280	& latvalue = RESHAPE(plat(nldi:nlei, nldj:nlej),(/ ni*nj /)))
2281	!
2282	IF ( ln_mskland .AND. (.NOT.ldxios) ) THEN
2283	! mask land points, keep values on coast line -> specific mask for U, V and W points
2284	SELECT CASE ( cdgrd )
2285	CASE('T') ; zmask(:,:,:) = tmask(:,:,:)
2286	CASE('U') ; zmask(2:jpim1,:,:) = tmask(2:jpim1,:,:) + tmask(3:jpi,:,:) ; CALL lbc_lnk( 'iom', zmask, 'U', 1. )
2287	CASE('V') ; zmask(:,2:jpjm1,:) = tmask(:,2:jpjm1,:) + tmask(:,3:jpj,:) ; CALL lbc_lnk( 'iom', zmask, 'V', 1. )
2288	CASE('W') ; zmask(:,:,2:jpk ) = tmask(:,:,1:jpkm1) + tmask(:,:,2:jpk) ; zmask(:,:,1) = tmask(:,:,1)
2289	END SELECT
2290	!
2291	CALL iom_set_domain_attr( "grid_"//cdgrd , mask = RESHAPE(zmask(nldi:nlei,nldj:nlej,1),(/ni*nj /)) /= 0. )
2292	CALL iom_set_grid_attr ( "grid_"//cdgrd//"_3D", mask = RESHAPE(zmask(nldi:nlei,nldj:nlej,:),(/ni,nj,jpk/)) /= 0. )
2293	ENDIF
2294	!
2295	END SUBROUTINE set_grid
2296
2297
2298	SUBROUTINE set_grid_bounds( cdgrd, plon_cnr, plat_cnr, plon_pnt, plat_pnt )
2299	!!----------------------------------------------------------------------
2300	!! * ROUTINE set_grid_bounds *
2301	!!
2302	!! ** Purpose : define horizontal grid corners
2303	!!
2304	!!----------------------------------------------------------------------
2305	CHARACTER(LEN=1) , INTENT(in) :: cdgrd
2306	REAL(wp), DIMENSION(jpi,jpj) , INTENT(in) :: plon_cnr, plat_cnr ! Lat/lon coord. of a contiguous vertex of cell (i,j)
2307	REAL(wp), DIMENSION(jpi,jpj), OPTIONAL, INTENT(in) :: plon_pnt, plat_pnt ! Lat/lon coord. of the point of cell (i,j)
2308	!
2309	INTEGER :: ji, jj, jn, ni, nj
2310	INTEGER :: icnr, jcnr ! Offset such that the vertex coordinate (i+icnr,j+jcnr)
2311	! ! represents the bottom-left corner of cell (i,j)
2312	REAL(wp), ALLOCATABLE, DIMENSION(:,:,:,:) :: z_bnds ! Lat/lon coordinates of the vertices of cell (i,j)
2313	REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: z_fld ! Working array to determine where to rotate cells
2314	REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: z_rot ! Lat/lon working array for rotation of cells
2315	!!----------------------------------------------------------------------
2316	!
2317	ALLOCATE( z_bnds(4,jpi,jpj,2), z_fld(jpi,jpj), z_rot(4,2) )
2318	!
2319	! Offset of coordinate representing bottom-left corner
2320	SELECT CASE ( TRIM(cdgrd) )
2321	CASE ('T', 'W') ; icnr = -1 ; jcnr = -1
2322	CASE ('U') ; icnr = 0 ; jcnr = -1
2323	CASE ('V') ; icnr = -1 ; jcnr = 0
2324	END SELECT
2325	!
2326	ni = nlei-nldi+1 ! Dimensions of subdomain interior
2327	nj = nlej-nldj+1
2328	!
2329	z_fld(:,:) = 1._wp
2330	CALL lbc_lnk( 'iom', z_fld, cdgrd, -1. ) ! Working array for location of northfold
2331	!
2332	! Cell vertices that can be defined
2333	DO jj = 2, jpjm1
2334	DO ji = 2, jpim1
2335	z_bnds(1,ji,jj,1) = plat_cnr(ji+icnr, jj+jcnr ) ! Bottom-left
2336	z_bnds(2,ji,jj,1) = plat_cnr(ji+icnr+1,jj+jcnr ) ! Bottom-right
2337	z_bnds(3,ji,jj,1) = plat_cnr(ji+icnr+1,jj+jcnr+1) ! Top-right
2338	z_bnds(4,ji,jj,1) = plat_cnr(ji+icnr, jj+jcnr+1) ! Top-left
2339	z_bnds(1,ji,jj,2) = plon_cnr(ji+icnr, jj+jcnr ) ! Bottom-left
2340	z_bnds(2,ji,jj,2) = plon_cnr(ji+icnr+1,jj+jcnr ) ! Bottom-right
2341	z_bnds(3,ji,jj,2) = plon_cnr(ji+icnr+1,jj+jcnr+1) ! Top-right
2342	z_bnds(4,ji,jj,2) = plon_cnr(ji+icnr, jj+jcnr+1) ! Top-left
2343	END DO
2344	END DO
2345	!
2346	! Cell vertices on boundries
2347	DO jn = 1, 4
2348	CALL lbc_lnk( 'iom', z_bnds(jn,:,:,1), cdgrd, 1., pfillval=999._wp )
2349	CALL lbc_lnk( 'iom', z_bnds(jn,:,:,2), cdgrd, 1., pfillval=999._wp )
2350	END DO
2351	!
2352	! Zero-size cells at closed boundaries if cell points provided,
2353	! otherwise they are closed cells with unrealistic bounds
2354	IF( PRESENT(plon_pnt) .AND. PRESENT(plat_pnt) ) THEN
2355	IF( (nbondi == -1 .OR. nbondi == 2) .AND. .NOT. (jperio == 1 .OR. jperio == 4 .OR. jperio == 6) ) THEN
2356	DO jn = 1, 4 ! (West or jpni = 1), closed E-W
2357	z_bnds(jn,1,:,1) = plat_pnt(1,:) ; z_bnds(jn,1,:,2) = plon_pnt(1,:)
2358	END DO
2359	ENDIF
2360	IF( (nbondi == 1 .OR. nbondi == 2) .AND. .NOT. (jperio == 1 .OR. jperio == 4 .OR. jperio == 6) ) THEN
2361	DO jn = 1, 4 ! (East or jpni = 1), closed E-W
2362	z_bnds(jn,nlci,:,1) = plat_pnt(nlci,:) ; z_bnds(jn,nlci,:,2) = plon_pnt(nlci,:)
2363	END DO
2364	ENDIF
2365	IF( nbondj == -1 .OR. (nbondj == 2 .AND. jperio /= 2) ) THEN
2366	DO jn = 1, 4 ! South or (jpnj = 1, not symmetric)
2367	z_bnds(jn,:,1,1) = plat_pnt(:,1) ; z_bnds(jn,:,1,2) = plon_pnt(:,1)
2368	END DO
2369	ENDIF
2370	IF( (nbondj == 1 .OR. nbondj == 2) .AND. jperio < 3 ) THEN
2371	DO jn = 1, 4 ! (North or jpnj = 1), no north fold
2372	z_bnds(jn,:,nlcj,1) = plat_pnt(:,nlcj) ; z_bnds(jn,:,nlcj,2) = plon_pnt(:,nlcj)
2373	END DO
2374	ENDIF
2375	ENDIF
2376	!
2377	IF( (nbondj == 1 .OR. nbondj == 2) .AND. jperio >= 3 ) THEN ! Rotate cells at the north fold
2378	DO jj = 1, jpj
2379	DO ji = 1, jpi
2380	IF( z_fld(ji,jj) == -1. ) THEN
2381	z_rot(1,:) = z_bnds(3,ji,jj,:) ; z_rot(2,:) = z_bnds(4,ji,jj,:)
2382	z_rot(3,:) = z_bnds(1,ji,jj,:) ; z_rot(4,:) = z_bnds(2,ji,jj,:)
2383	z_bnds(:,ji,jj,:) = z_rot(:,:)
2384	ENDIF
2385	END DO
2386	END DO
2387	ELSE IF( nbondj == 2 .AND. jperio == 2 ) THEN ! Invert cells at the symmetric equator
2388	DO ji = 1, jpi
2389	z_rot(1:2,:) = z_bnds(3:4,ji,1,:)
2390	z_rot(3:4,:) = z_bnds(1:2,ji,1,:)
2391	z_bnds(:,ji,1,:) = z_rot(:,:)
2392	END DO
2393	ENDIF
2394	!
2395	CALL iom_set_domain_attr("grid_"//cdgrd, bounds_lat = RESHAPE(z_bnds(:,nldi:nlei,nldj:nlej,1),(/ 4,ni*nj /)), &
2396	& bounds_lon = RESHAPE(z_bnds(:,nldi:nlei,nldj:nlej,2),(/ 4,ni*nj /)), nvertex=4 )
2397	!
2398	DEALLOCATE( z_bnds, z_fld, z_rot )
2399	!
2400	END SUBROUTINE set_grid_bounds
2401
2402
2403	SUBROUTINE set_grid_znl( plat )
2404	!!----------------------------------------------------------------------
2405	!! * ROUTINE set_grid_znl *
2406	!!
2407	!! ** Purpose : define grids for zonal mean
2408	!!
2409	!!----------------------------------------------------------------------
2410	REAL(wp), DIMENSION(jpi,jpj), INTENT(in) :: plat
2411	!
2412	INTEGER :: ni, nj, ix, iy
2413	REAL(wp), DIMENSION(:), ALLOCATABLE :: zlon
2414	!!----------------------------------------------------------------------
2415	!
2416	ni=nlei-nldi+1 ! define zonal mean domain (jpj*jpk)
2417	nj=nlej-nldj+1
2418	ALLOCATE( zlon(ni*nj) ) ; zlon(:) = 0._wp
2419	!
2420	CALL dom_ngb( -168.53, 65.03, ix, iy, 'T' ) ! i-line that passes through Bering Strait: Reference latitude (used in plots)
2421	! CALL dom_ngb( 180., 90., ix, iy, 'T' ) ! i-line that passes near the North Pole : Reference latitude (used in plots)
2422	CALL iom_set_domain_attr("gznl", ni_glo=jpiglo, nj_glo=jpjglo, ibegin=nimpp+nldi-2, jbegin=njmpp+nldj-2, ni=ni, nj=nj)
2423	CALL iom_set_domain_attr("gznl", data_dim=2, data_ibegin = 1-nldi, data_ni = jpi, data_jbegin = 1-nldj, data_nj = jpj)
2424	CALL iom_set_domain_attr("gznl", lonvalue = zlon, &
2425	& latvalue = RESHAPE(plat(nldi:nlei, nldj:nlej),(/ ni*nj /)))
2426	CALL iom_set_zoom_domain_attr("znl_T", ibegin=ix-1, jbegin=0, ni=1, nj=jpjglo)
2427	CALL iom_set_zoom_domain_attr("znl_W", ibegin=ix-1, jbegin=0, ni=1, nj=jpjglo)
2428	!
2429	CALL iom_update_file_name('ptr')
2430	!
2431	END SUBROUTINE set_grid_znl
2432
2433
2434	SUBROUTINE set_scalar
2435	!!----------------------------------------------------------------------
2436	!! * ROUTINE set_scalar *
2437	!!
2438	!! ** Purpose : define fake grids for scalar point
2439	!!
2440	!!----------------------------------------------------------------------
2441	REAL(wp), DIMENSION(1) :: zz = 1.
2442	!!----------------------------------------------------------------------
2443	!
2444	CALL iom_set_domain_attr('scalarpoint', ni_glo=jpnij, nj_glo=1, ibegin=narea-1, jbegin=0, ni=1, nj=1)
2445	CALL iom_set_domain_attr('scalarpoint', data_dim=2, data_ibegin = 1, data_ni = 1, data_jbegin = 1, data_nj = 1)
2446	!
2447	zz = REAL( narea, wp )
2448	CALL iom_set_domain_attr('scalarpoint', lonvalue=zz, latvalue=zz)
2449	!
2450	END SUBROUTINE set_scalar
2451
2452
2453	SUBROUTINE set_xmlatt
2454	!!----------------------------------------------------------------------
2455	!! * ROUTINE set_xmlatt *
2456	!!
2457	!! ** Purpose : automatic definitions of some of the xml attributs...
2458	!!
2459	!!----------------------------------------------------------------------
2460	CHARACTER(len=1),DIMENSION( 3) :: clgrd ! suffix name
2461	CHARACTER(len=256) :: clsuff ! suffix name
2462	CHARACTER(len=1) :: cl1 ! 1 character
2463	CHARACTER(len=2) :: cl2 ! 2 characters
2464	CHARACTER(len=3) :: cl3 ! 3 characters
2465	INTEGER :: ji, jg ! loop counters
2466	INTEGER :: ix, iy ! i-,j- index
2467	REAL(wp) ,DIMENSION(11) :: zlontao ! longitudes of tao moorings
2468	REAL(wp) ,DIMENSION( 7) :: zlattao ! latitudes of tao moorings
2469	REAL(wp) ,DIMENSION( 4) :: zlonrama ! longitudes of rama moorings
2470	REAL(wp) ,DIMENSION(11) :: zlatrama ! latitudes of rama moorings
2471	REAL(wp) ,DIMENSION( 3) :: zlonpira ! longitudes of pirata moorings
2472	REAL(wp) ,DIMENSION( 9) :: zlatpira ! latitudes of pirata moorings
2473	TYPE(xios_duration) :: f_op, f_of
2474	!!----------------------------------------------------------------------
2475	!
2476	! frequency of the call of iom_put (attribut: freq_op)
2477	f_op%timestep = 1 ; f_of%timestep = 0 ; CALL iom_set_field_attr('field_definition', freq_op=f_op, freq_offset=f_of)
2478	f_op%timestep = 2 ; f_of%timestep = 0 ; CALL iom_set_field_attr('trendT_even' , freq_op=f_op, freq_offset=f_of)
2479	f_op%timestep = 2 ; f_of%timestep = -1 ; CALL iom_set_field_attr('trendT_odd' , freq_op=f_op, freq_offset=f_of)
2480	f_op%timestep = nn_fsbc ; f_of%timestep = 0 ; CALL iom_set_field_attr('SBC' , freq_op=f_op, freq_offset=f_of)
2481	f_op%timestep = nn_fsbc ; f_of%timestep = 0 ; CALL iom_set_field_attr('SBC_scalar' , freq_op=f_op, freq_offset=f_of)
2482	f_op%timestep = nn_dttrc ; f_of%timestep = 0 ; CALL iom_set_field_attr('ptrc_T' , freq_op=f_op, freq_offset=f_of)
2483	f_op%timestep = nn_dttrc ; f_of%timestep = 0 ; CALL iom_set_field_attr('diad_T' , freq_op=f_op, freq_offset=f_of)
2484
2485	! output file names (attribut: name)
2486	DO ji = 1, 9
2487	WRITE(cl1,'(i1)') ji
2488	CALL iom_update_file_name('file'//cl1)
2489	END DO
2490	DO ji = 1, 99
2491	WRITE(cl2,'(i2.2)') ji
2492	CALL iom_update_file_name('file'//cl2)
2493	END DO
2494	DO ji = 1, 999
2495	WRITE(cl3,'(i3.3)') ji
2496	CALL iom_update_file_name('file'//cl3)
2497	END DO
2498
2499	! Zooms...
2500	clgrd = (/ 'T', 'U', 'W' /)
2501	DO jg = 1, SIZE(clgrd) ! grid type
2502	cl1 = clgrd(jg)
2503	! Equatorial section (attributs: jbegin, ni, name_suffix)
2504	CALL dom_ngb( 0., 0., ix, iy, cl1 )
2505	CALL iom_set_zoom_domain_attr('Eq'//cl1, ibegin=0, jbegin=iy-1, ni=jpiglo, nj=1 )
2506	CALL iom_get_file_attr ('Eq'//cl1, name_suffix = clsuff )
2507	CALL iom_set_file_attr ('Eq'//cl1, name_suffix = TRIM(clsuff)//'_Eq')
2508	CALL iom_update_file_name('Eq'//cl1)
2509	END DO
2510	! TAO moorings (attributs: ibegin, jbegin, name_suffix)
2511	zlontao = (/ 137.0, 147.0, 156.0, 165.0, -180.0, -170.0, -155.0, -140.0, -125.0, -110.0, -95.0 /)
2512	zlattao = (/ -8.0, -5.0, -2.0, 0.0, 2.0, 5.0, 8.0 /)
2513	CALL set_mooring( zlontao, zlattao )
2514	! RAMA moorings (attributs: ibegin, jbegin, name_suffix)
2515	zlonrama = (/ 55.0, 67.0, 80.5, 90.0 /)
2516	zlatrama = (/ -16.0, -12.0, -8.0, -4.0, -1.5, 0.0, 1.5, 4.0, 8.0, 12.0, 15.0 /)
2517	CALL set_mooring( zlonrama, zlatrama )
2518	! PIRATA moorings (attributs: ibegin, jbegin, name_suffix)
2519	zlonpira = (/ -38.0, -23.0, -10.0 /)
2520	zlatpira = (/ -19.0, -14.0, -8.0, 0.0, 4.0, 8.0, 12.0, 15.0, 20.0 /)
2521	CALL set_mooring( zlonpira, zlatpira )
2522	!
2523	END SUBROUTINE set_xmlatt
2524
2525
2526	SUBROUTINE set_mooring( plon, plat )
2527	!!----------------------------------------------------------------------
2528	!! * ROUTINE set_mooring *
2529	!!
2530	!! ** Purpose : automatic definitions of moorings xml attributs...
2531	!!
2532	!!----------------------------------------------------------------------
2533	REAL(wp), DIMENSION(:), INTENT(in) :: plon, plat ! longitudes/latitudes oft the mooring
2534	!
2535	!!$ CHARACTER(len=1),DIMENSION(4) :: clgrd = (/ 'T', 'U', 'V', 'W' /) ! suffix name
2536	CHARACTER(len=1),DIMENSION(1) :: clgrd = (/ 'T' /) ! suffix name
2537	CHARACTER(len=256) :: clname ! file name
2538	CHARACTER(len=256) :: clsuff ! suffix name
2539	CHARACTER(len=1) :: cl1 ! 1 character
2540	CHARACTER(len=6) :: clon,clat ! name of longitude, latitude
2541	INTEGER :: ji, jj, jg ! loop counters
2542	INTEGER :: ix, iy ! i-,j- index
2543	REAL(wp) :: zlon, zlat
2544	!!----------------------------------------------------------------------
2545	DO jg = 1, SIZE(clgrd)
2546	cl1 = clgrd(jg)
2547	DO ji = 1, SIZE(plon)
2548	DO jj = 1, SIZE(plat)
2549	zlon = plon(ji)
2550	zlat = plat(jj)
2551	! modifications for RAMA moorings
2552	IF( zlon == 67. .AND. zlat == 15. ) zlon = 65.
2553	IF( zlon == 90. .AND. zlat <= -4. ) zlon = 95.
2554	IF( zlon == 95. .AND. zlat == -4. ) zlat = -5.
2555	! modifications for PIRATA moorings
2556	IF( zlon == -38. .AND. zlat == -19. ) zlon = -34.
2557	IF( zlon == -38. .AND. zlat == -14. ) zlon = -32.
2558	IF( zlon == -38. .AND. zlat == -8. ) zlon = -30.
2559	IF( zlon == -38. .AND. zlat == 0. ) zlon = -35.
2560	IF( zlon == -23. .AND. zlat == 20. ) zlat = 21.
2561	IF( zlon == -10. .AND. zlat == -14. ) zlat = -10.
2562	IF( zlon == -10. .AND. zlat == -8. ) zlat = -6.
2563	IF( zlon == -10. .AND. zlat == 4. ) THEN ; zlon = 0. ; zlat = 0. ; ENDIF
2564	CALL dom_ngb( zlon, zlat, ix, iy, cl1 )
2565	IF( zlon >= 0. ) THEN
2566	IF( zlon == REAL(NINT(zlon), wp) ) THEN ; WRITE(clon, '(i3, a)') NINT( zlon), 'e'
2567	ELSE ; WRITE(clon, '(f5.1,a)') zlon , 'e'
2568	ENDIF
2569	ELSE
2570	IF( zlon == REAL(NINT(zlon), wp) ) THEN ; WRITE(clon, '(i3, a)') NINT(-zlon), 'w'
2571	ELSE ; WRITE(clon, '(f5.1,a)') -zlon , 'w'
2572	ENDIF
2573	ENDIF
2574	IF( zlat >= 0. ) THEN
2575	IF( zlat == REAL(NINT(zlat), wp) ) THEN ; WRITE(clat, '(i2, a)') NINT( zlat), 'n'
2576	ELSE ; WRITE(clat, '(f4.1,a)') zlat , 'n'
2577	ENDIF
2578	ELSE
2579	IF( zlat == REAL(NINT(zlat), wp) ) THEN ; WRITE(clat, '(i2, a)') NINT(-zlat), 's'
2580	ELSE ; WRITE(clat, '(f4.1,a)') -zlat , 's'
2581	ENDIF
2582	ENDIF
2583	clname = TRIM(ADJUSTL(clat))//TRIM(ADJUSTL(clon))
2584	CALL iom_set_zoom_domain_attr(TRIM(clname)//cl1, ibegin= ix-1, jbegin= iy-1, ni=1, nj=1)
2585
2586	CALL iom_get_file_attr (TRIM(clname)//cl1, name_suffix = clsuff )
2587	CALL iom_set_file_attr (TRIM(clname)//cl1, name_suffix = TRIM(clsuff)//'_'//TRIM(clname))
2588	CALL iom_update_file_name(TRIM(clname)//cl1)
2589	END DO
2590	END DO
2591	END DO
2592
2593	END SUBROUTINE set_mooring
2594
2595
2596	SUBROUTINE iom_update_file_name( cdid )
2597	!!----------------------------------------------------------------------
2598	!! * ROUTINE iom_update_file_name *
2599	!!
2600	!! ** Purpose :
2601	!!
2602	!!----------------------------------------------------------------------
2603	CHARACTER(LEN=*) , INTENT(in) :: cdid
2604	!
2605	CHARACTER(LEN=256) :: clname
2606	CHARACTER(LEN=20) :: clfreq
2607	CHARACTER(LEN=20) :: cldate
2608	CHARACTER(LEN=256) :: cltmpn !FUS needed for correct path with AGRIF
2609	INTEGER :: iln !FUS needed for correct path with AGRIF
2610	INTEGER :: idx
2611	INTEGER :: jn
2612	INTEGER :: itrlen
2613	INTEGER :: iyear, imonth, iday, isec
2614	REAL(wp) :: zsec
2615	LOGICAL :: llexist
2616	TYPE(xios_duration) :: output_freq
2617	!!----------------------------------------------------------------------
2618	!
2619	DO jn = 1, 2
2620	!
2621	output_freq = xios_duration(0,0,0,0,0,0)
2622	IF( jn == 1 ) CALL iom_get_file_attr( cdid, name = clname, output_freq = output_freq )
2623	IF( jn == 2 ) CALL iom_get_file_attr( cdid, name_suffix = clname )
2624	!
2625	IF ( TRIM(clname) /= '' ) THEN
2626	!
2627	idx = INDEX(clname,'@expname@') + INDEX(clname,'@EXPNAME@')
2628	DO WHILE ( idx /= 0 )
2629	clname = clname(1:idx-1)//TRIM(cexper)//clname(idx+9:LEN_TRIM(clname))
2630	idx = INDEX(clname,'@expname@') + INDEX(clname,'@EXPNAME@')
2631	END DO
2632	!
2633	idx = INDEX(clname,'@freq@') + INDEX(clname,'@FREQ@')
2634	DO WHILE ( idx /= 0 )
2635	IF ( output_freq%timestep /= 0) THEN
2636	WRITE(clfreq,'(I18,A2)')INT(output_freq%timestep),'ts'
2637	itrlen = LEN_TRIM(ADJUSTL(clfreq))
2638	ELSE IF ( output_freq%second /= 0 ) THEN
2639	WRITE(clfreq,'(I19,A1)')INT(output_freq%second),'s'
2640	itrlen = LEN_TRIM(ADJUSTL(clfreq))
2641	ELSE IF ( output_freq%minute /= 0 ) THEN
2642	WRITE(clfreq,'(I18,A2)')INT(output_freq%minute),'mi'
2643	itrlen = LEN_TRIM(ADJUSTL(clfreq))
2644	ELSE IF ( output_freq%hour /= 0 ) THEN
2645	WRITE(clfreq,'(I19,A1)')INT(output_freq%hour),'h'
2646	itrlen = LEN_TRIM(ADJUSTL(clfreq))
2647	ELSE IF ( output_freq%day /= 0 ) THEN
2648	WRITE(clfreq,'(I19,A1)')INT(output_freq%day),'d'
2649	itrlen = LEN_TRIM(ADJUSTL(clfreq))
2650	ELSE IF ( output_freq%month /= 0 ) THEN
2651	WRITE(clfreq,'(I19,A1)')INT(output_freq%month),'m'
2652	itrlen = LEN_TRIM(ADJUSTL(clfreq))
2653	ELSE IF ( output_freq%year /= 0 ) THEN
2654	WRITE(clfreq,'(I19,A1)')INT(output_freq%year),'y'
2655	itrlen = LEN_TRIM(ADJUSTL(clfreq))
2656	ELSE
2657	CALL ctl_stop('error in the name of file id '//TRIM(cdid), &
2658	& ' attribute output_freq is undefined -> cannot replace @freq@ in '//TRIM(clname) )
2659	ENDIF
2660	clname = clname(1:idx-1)//TRIM(ADJUSTL(clfreq))//clname(idx+6:LEN_TRIM(clname))
2661	idx = INDEX(clname,'@freq@') + INDEX(clname,'@FREQ@')
2662	END DO
2663	!
2664	idx = INDEX(clname,'@startdate@') + INDEX(clname,'@STARTDATE@')
2665	DO WHILE ( idx /= 0 )
2666	cldate = iom_sdate( fjulday - rdt / rday )
2667	clname = clname(1:idx-1)//TRIM(cldate)//clname(idx+11:LEN_TRIM(clname))
2668	idx = INDEX(clname,'@startdate@') + INDEX(clname,'@STARTDATE@')
2669	END DO
2670	!
2671	idx = INDEX(clname,'@startdatefull@') + INDEX(clname,'@STARTDATEFULL@')
2672	DO WHILE ( idx /= 0 )
2673	cldate = iom_sdate( fjulday - rdt / rday, ldfull = .TRUE. )
2674	clname = clname(1:idx-1)//TRIM(cldate)//clname(idx+15:LEN_TRIM(clname))
2675	idx = INDEX(clname,'@startdatefull@') + INDEX(clname,'@STARTDATEFULL@')
2676	END DO
2677	!
2678	idx = INDEX(clname,'@enddate@') + INDEX(clname,'@ENDDATE@')
2679	DO WHILE ( idx /= 0 )
2680	cldate = iom_sdate( fjulday + rdt / rday * REAL( nitend - nit000, wp ), ld24 = .TRUE. )
2681	clname = clname(1:idx-1)//TRIM(cldate)//clname(idx+9:LEN_TRIM(clname))
2682	idx = INDEX(clname,'@enddate@') + INDEX(clname,'@ENDDATE@')
2683	END DO
2684	!
2685	idx = INDEX(clname,'@enddatefull@') + INDEX(clname,'@ENDDATEFULL@')
2686	DO WHILE ( idx /= 0 )
2687	cldate = iom_sdate( fjulday + rdt / rday * REAL( nitend - nit000, wp ), ld24 = .TRUE., ldfull = .TRUE. )
2688	clname = clname(1:idx-1)//TRIM(cldate)//clname(idx+13:LEN_TRIM(clname))
2689	idx = INDEX(clname,'@enddatefull@') + INDEX(clname,'@ENDDATEFULL@')
2690	END DO
2691	!
2692	!FUS IF( jn == 1 .AND. TRIM(Agrif_CFixed()) /= '0' ) clname = TRIM(Agrif_CFixed())//"_"//TRIM(clname)
2693	!FUS see comment line 700
2694	IF( jn == 1 .AND. TRIM(Agrif_CFixed()) /= '0' ) THEN
2695	iln = INDEX(clname,'/',BACK=.true.)
2696	cltmpn = clname(1:iln)
2697	clname = clname(iln+1:LEN_TRIM(clname))
2698	clname = TRIM(cltmpn)//TRIM(Agrif_CFixed())//'_'//TRIM(clname)
2699	ENDIF
2700	!FUS
2701	IF( jn == 1 ) CALL iom_set_file_attr( cdid, name = clname )
2702	IF( jn == 2 ) CALL iom_set_file_attr( cdid, name_suffix = clname )
2703	!
2704	ENDIF
2705	!
2706	END DO
2707	!
2708	END SUBROUTINE iom_update_file_name
2709
2710
2711	FUNCTION iom_sdate( pjday, ld24, ldfull )
2712	!!----------------------------------------------------------------------
2713	!! * ROUTINE iom_sdate *
2714	!!
2715	!! ** Purpose : send back the date corresponding to the given julian day
2716	!!----------------------------------------------------------------------
2717	REAL(wp), INTENT(in ) :: pjday ! julian day
2718	LOGICAL , INTENT(in ), OPTIONAL :: ld24 ! true to force 24:00 instead of 00:00
2719	LOGICAL , INTENT(in ), OPTIONAL :: ldfull ! true to get the compleate date: yyyymmdd_hh:mm:ss
2720	!
2721	CHARACTER(LEN=20) :: iom_sdate
2722	CHARACTER(LEN=50) :: clfmt ! format used to write the date
2723	INTEGER :: iyear, imonth, iday, ihour, iminute, isec
2724	REAL(wp) :: zsec
2725	LOGICAL :: ll24, llfull
2726	!!----------------------------------------------------------------------
2727	!
2728	IF( PRESENT(ld24) ) THEN ; ll24 = ld24
2729	ELSE ; ll24 = .FALSE.
2730	ENDIF
2731	!
2732	IF( PRESENT(ldfull) ) THEN ; llfull = ldfull
2733	ELSE ; llfull = .FALSE.
2734	ENDIF
2735	!
2736	CALL ju2ymds( pjday, iyear, imonth, iday, zsec )
2737	isec = NINT(zsec)
2738	!
2739	IF ( ll24 .AND. isec == 0 ) THEN ! 00:00 of the next day -> move to 24:00 of the current day
2740	CALL ju2ymds( pjday - 1., iyear, imonth, iday, zsec )
2741	isec = 86400
2742	ENDIF
2743	!
2744	IF( iyear < 10000 ) THEN ; clfmt = "i4.4,2i2.2" ! format used to write the date
2745	ELSE ; WRITE(clfmt, "('i',i1,',2i2.2')") INT(LOG10(REAL(iyear,wp))) + 1
2746	ENDIF
2747	!
2748	!$AGRIF_DO_NOT_TREAT
2749	! needed in the conv
2750	IF( llfull ) THEN
2751	clfmt = TRIM(clfmt)//",'_',i2.2,':',i2.2,':',i2.2"
2752	ihour = isec / 3600
2753	isec = MOD(isec, 3600)
2754	iminute = isec / 60
2755	isec = MOD(isec, 60)
2756	WRITE(iom_sdate, '('//TRIM(clfmt)//')') iyear, imonth, iday, ihour, iminute, isec ! date of the end of run
2757	ELSE
2758	WRITE(iom_sdate, '('//TRIM(clfmt)//')') iyear, imonth, iday ! date of the end of run
2759	ENDIF
2760	!$AGRIF_END_DO_NOT_TREAT
2761	!
2762	END FUNCTION iom_sdate
2763
2764	INTEGER FUNCTION iom_add(idm)
2765	INTEGER :: idm
2766
2767	iom_add = idm + 1
2768	IF( iom_add > max_rst_fields) THEN
2769	WRITE(ctmp1,*) 'E R R O R : iom_set_rst_vars SIZE of RST_FIELD array is too small'
2770	CALL ctl_stop( 'iom_add:', ctmp1, 'Increase parameter max_rst_fields')
2771	ENDIF
2772
2773	END FUNCTION iom_add
2774
2775	#else
2776	!!----------------------------------------------------------------------
2777	!! NOT 'key_iomput' a few dummy routines
2778	!!----------------------------------------------------------------------
2779	SUBROUTINE iom_setkt( kt, cdname )
2780	INTEGER , INTENT(in):: kt
2781	CHARACTER(LEN=*), INTENT(in) :: cdname
2782	IF( .FALSE. ) WRITE(numout,*) kt, cdname ! useless test to avoid compilation warnings
2783	END SUBROUTINE iom_setkt
2784
2785	SUBROUTINE iom_context_finalize( cdname )
2786	CHARACTER(LEN=*), INTENT(in) :: cdname
2787	IF( .FALSE. ) WRITE(numout,*) cdname ! useless test to avoid compilation warnings
2788	END SUBROUTINE iom_context_finalize
2789
2790	#endif
2791
2792	LOGICAL FUNCTION iom_use( cdname )
2793	CHARACTER(LEN=*), INTENT(in) :: cdname
2794	#if defined key_iomput
2795	iom_use = xios_field_is_active( cdname )
2796	#else
2797	iom_use = .FALSE.
2798	#endif
2799	END FUNCTION iom_use
2800
2801	SUBROUTINE iom_miss_val( cdname, pmiss_val )
2802	CHARACTER(LEN=*), INTENT(in ) :: cdname
2803	REAL(wp) , INTENT(out) :: pmiss_val
2804	#if defined key_iomput
2805	! get missing value
2806	CALL xios_get_field_attr( cdname, default_value = pmiss_val )
2807	#else
2808	IF( .FALSE. ) WRITE(numout,*) cdname, pmiss_val ! useless test to avoid compilation warnings
2809	#endif
2810	END SUBROUTINE iom_miss_val
2811
2812	!!======================================================================
2813	END MODULE iom

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

Download in other formats: