Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

iom.F90 @ 12721

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

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

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

Context Navigation

source: NEMO/branches/UKMO/NEMO_4.0.2_GO8_package_ENHANCE-02_ISF_nemo/src/OCE/IOM/iom.F90 @ 12721

Download in other formats: