Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

iom.F90 @ 6205

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

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

Context Navigation

source: CONFIG_DEVT/IPSLCM6.2.2_ENSEMBLES/config/IPSLCM6/SOURCES/NEMO/iom.F90 @ 6205

Download in other formats: