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_fix_rnf_MOCI_TEST_SUITE/NEMOGCM/NEMO/OPA_SRC/IOM – NEMO

Context Navigation

source: branches/UKMO/dev_r5518_GO6_package_fix_rnf_MOCI_TEST_SUITE/NEMOGCM/NEMO/OPA_SRC/IOM/iom.F90 @ 8191

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

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

Download in other formats: