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

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

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

Download in other formats: