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 @ 11901

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

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

Download in other formats: