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

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.

iom.F90 in branches/UKMO/dev_r5518_GO6_package_XIOS_read/NEMOGCM/NEMO/OPA_SRC/IOM – NEMO

Context Navigation

source: branches/UKMO/dev_r5518_GO6_package_XIOS_read/NEMOGCM/NEMO/OPA_SRC/IOM/iom.F90 @ 8293

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

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

Download in other formats: