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

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

iom.F90 in trunk/NEMOGCM/NEMO/OPA_SRC/IOM – NEMO

Context Navigation

source: trunk/NEMOGCM/NEMO/OPA_SRC/IOM/iom.F90 @ 2528

Last change on this file since 2528 was 2528, checked in by rblod, 13 years ago
Update NEMOGCM from branch nemo_v3_3_beta
Property svn:keywords set to `Id`
File size: 61.9 KB

Line
1	MODULE iom
2	!!=====================================================================
3	!! * MODULE iom *
4	!! Input/Output manager : Library to read input files
5	!!====================================================================
6	!! History : 9.0 ! 05 12 (J. Belier) Original code
7	!! 9.0 ! 06 02 (S. Masson) Adaptation to NEMO
8	!! " ! 07 07 (D. Storkey) Changes to iom_gettime
9	!!--------------------------------------------------------------------
10	!!gm caution add !DIR nec: improved performance to be checked as well as no result changes
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 in_out_manager ! I/O manager
21	USE dom_oce ! ocean space and time domain
22	USE lbclnk ! lateal boundary condition / mpp exchanges
23	USE iom_def ! iom variables definitions
24	USE iom_ioipsl ! NetCDF format with IOIPSL library
25	USE iom_nf90 ! NetCDF format with native NetCDF library
26	USE iom_rstdimg ! restarts access direct format "dimg" style...
27
28	#if defined key_iomput
29	USE sbc_oce, ONLY : nn_fsbc ! ocean space and time domain
30	USE domngb ! ocean space and time domain
31	USE phycst ! physical constants
32	USE dianam ! build name of file
33	USE mod_event_client
34	USE mod_attribut
35	# endif
36
37	IMPLICIT NONE
38	PUBLIC ! must be public to be able to access iom_def through iom
39
40	#if defined key_iomput
41	LOGICAL, PUBLIC, PARAMETER :: lk_iomput = .TRUE. !: iom_put flag
42	#else
43	LOGICAL, PUBLIC, PARAMETER :: lk_iomput = .FALSE. !: iom_put flag
44	#endif
45	PUBLIC iom_init, iom_swap, iom_open, iom_close, iom_setkt, iom_varid, iom_get, iom_gettime, iom_rstput, iom_put
46	PUBLIC iom_getatt
47
48	PRIVATE iom_rp0d, iom_rp1d, iom_rp2d, iom_rp3d
49	PRIVATE iom_g0d, iom_g1d, iom_g2d, iom_g3d, iom_get_123d
50	PRIVATE iom_p2d, iom_p3d
51	#if defined key_iomput
52	PRIVATE set_grid
53	# endif
54
55	INTERFACE iom_get
56	MODULE PROCEDURE iom_g0d, iom_g1d, iom_g2d, iom_g3d
57	END INTERFACE
58	INTERFACE iom_getatt
59	MODULE PROCEDURE iom_g0d_intatt
60	END INTERFACE
61	INTERFACE iom_rstput
62	MODULE PROCEDURE iom_rp0d, iom_rp1d, iom_rp2d, iom_rp3d
63	END INTERFACE
64	INTERFACE iom_put
65	MODULE PROCEDURE iom_p0d, iom_p2d, iom_p3d
66	END INTERFACE
67	#if defined key_iomput
68	INTERFACE iom_setkt
69	MODULE PROCEDURE event__set_timestep
70	END INTERFACE
71	# endif
72
73	!!----------------------------------------------------------------------
74	!! NEMO/OPA 3.3 , NEMO Consortium (2010)
75	!! $Id$
76	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
77	!!----------------------------------------------------------------------
78
79	CONTAINS
80
81	SUBROUTINE iom_init
82	!!----------------------------------------------------------------------
83	!! * ROUTINE *
84	!!
85	!! ** Purpose :
86	!!
87	!!----------------------------------------------------------------------
88	#if defined key_iomput
89	REAL(wp) :: ztmp
90	!!----------------------------------------------------------------------
91	! read the xml file
92	IF( Agrif_Root() ) CALL event__parse_xml_file( 'iodef.xml' ) ! <- to get from the nameliste (namrun)...
93	CALL iom_swap
94
95	! calendar parameters
96	SELECT CASE ( nleapy ) ! Choose calendar for IOIPSL
97	CASE ( 1) ; CALL event__set_calendar('gregorian')
98	CASE ( 0) ; CALL event__set_calendar('noleap' )
99	CASE (30) ; CALL event__set_calendar('360d' )
100	END SELECT
101	ztmp = fjulday - adatrj
102	IF( ABS(ztmp - REAL(NINT(ztmp),wp)) < 0.1 / rday ) ztmp = REAL(NINT(ztmp),wp) ! avoid truncation error
103	CALL event__set_time_parameters( nit000 - 1, ztmp, rdt )
104
105	! horizontal grid definition
106	CALL set_scalar
107	CALL set_grid( "grid_T", glamt, gphit )
108	CALL set_grid( "grid_U", glamu, gphiu )
109	CALL set_grid( "grid_V", glamv, gphiv )
110	CALL set_grid( "grid_W", glamt, gphit )
111
112	! vertical grid definition
113	CALL event__set_vert_axis( "deptht", gdept_0 )
114	CALL event__set_vert_axis( "depthu", gdept_0 )
115	CALL event__set_vert_axis( "depthv", gdept_0 )
116	CALL event__set_vert_axis( "depthw", gdepw_0 )
117
118	! automatic definitions of some of the xml attributs
119	CALL set_xmlatt
120
121	! end file definition
122	CALL event__close_io_definition
123	#endif
124
125	END SUBROUTINE iom_init
126
127
128	SUBROUTINE iom_swap
129	!!---------------------------------------------------------------------
130	!! * SUBROUTINE iom_swap *
131	!!
132	!! ** Purpose : swap context between different agrif grid for xmlio_server
133	!!---------------------------------------------------------------------
134	#if defined key_iomput
135
136	IF( TRIM(Agrif_CFixed()) == '0' ) THEN
137	CALL event__swap_context("nemo")
138	ELSE
139	CALL event__swap_context(TRIM(Agrif_CFixed())//"_nemo")
140	ENDIF
141
142	#endif
143	END SUBROUTINE iom_swap
144
145
146	SUBROUTINE iom_open( cdname, kiomid, ldwrt, kdom, kiolib, ldstop, ldiof )
147	!!---------------------------------------------------------------------
148	!! * SUBROUTINE iom_open *
149	!!
150	!! ** Purpose : open an input file (return 0 if not found)
151	!!---------------------------------------------------------------------
152	CHARACTER(len=*), INTENT(in ) :: cdname ! File name
153	INTEGER , INTENT( out) :: kiomid ! iom identifier of the opened file
154	LOGICAL , INTENT(in ), OPTIONAL :: ldwrt ! open in write modeb (default = .FALSE.)
155	INTEGER , INTENT(in ), OPTIONAL :: kdom ! Type of domain to be written (default = jpdom_local_noovlap)
156	INTEGER , INTENT(in ), OPTIONAL :: kiolib ! library used to open the file (default = jpnf90)
157	LOGICAL , INTENT(in ), OPTIONAL :: ldstop ! stop if open to read a non-existing file (default = .TRUE.)
158	LOGICAL , INTENT(in ), OPTIONAL :: ldiof ! Interp On the Fly, needed for AGRIF (default = .FALSE.)
159
160	CHARACTER(LEN=100) :: clname ! the name of the file based on cdname [[+clcpu]+clcpu]
161	CHARACTER(LEN=100) :: cltmpn ! tempory name to store clname (in writting mode)
162	CHARACTER(LEN=10) :: clsuffix ! ".nc" or ".dimg"
163	CHARACTER(LEN=15) :: clcpu ! the cpu number (max jpmax_digits digits)
164	CHARACTER(LEN=100) :: clinfo ! info character
165	LOGICAL :: llok ! check the existence
166	LOGICAL :: llwrt ! local definition of ldwrt
167	LOGICAL :: llnoov ! local definition to read overlap
168	LOGICAL :: llstop ! local definition of ldstop
169	LOGICAL :: lliof ! local definition of ldiof
170	INTEGER :: iolib ! library do we use to open the file
171	INTEGER :: icnt ! counter for digits in clcpu (max = jpmax_digits)
172	INTEGER :: iln, ils ! lengths of character
173	INTEGER :: idom ! type of domain
174	INTEGER :: istop !
175	INTEGER, DIMENSION(2,5) :: idompar ! domain parameters:
176	! local number of points for x,y dimensions
177	! position of first local point for x,y dimensions
178	! position of last local point for x,y dimensions
179	! start halo size for x,y dimensions
180	! end halo size for x,y dimensions
181	!---------------------------------------------------------------------
182	! Initializations and control
183	! =============
184	kiomid = -1
185	clinfo = ' iom_open ~~~ '
186	istop = nstop
187	! if iom_open is called for the first time: initialize iom_file(:)%nfid to 0
188	! (could be done when defining iom_file in f95 but not in f90)
189	IF( Agrif_Root() ) THEN
190	IF( iom_open_init == 0 ) THEN
191	iom_file(:)%nfid = 0
192	iom_open_init = 1
193	ENDIF
194	ENDIF
195	! do we read or write the file?
196	IF( PRESENT(ldwrt) ) THEN ; llwrt = ldwrt
197	ELSE ; llwrt = .FALSE.
198	ENDIF
199	! do we call ctl_stop if we try to open a non-existing file in read mode?
200	IF( PRESENT(ldstop) ) THEN ; llstop = ldstop
201	ELSE ; llstop = .TRUE.
202	ENDIF
203	! what library do we use to open the file?
204	IF( PRESENT(kiolib) ) THEN ; iolib = kiolib
205	ELSE ; iolib = jpnf90
206	ENDIF
207	! are we using interpolation on the fly?
208	IF( PRESENT(ldiof) ) THEN ; lliof = ldiof
209	ELSE ; lliof = .FALSE.
210	ENDIF
211	! do we read the overlap
212	! ugly patch SM+JMM+RB to overwrite global definition in some cases
213	llnoov = (jpni * jpnj ) == jpnij .AND. .NOT. lk_agrif
214	! create the file name by added, if needed, TRIM(Agrif_CFixed()) and TRIM(clsuffix)
215	! =============
216	clname = trim(cdname)
217	IF ( .NOT. Agrif_Root() .AND. .NOT. lliof ) THEN
218	iln = INDEX(clname,'/')
219	cltmpn = clname(1:iln)
220	clname = clname(iln+1:LEN_TRIM(clname))
221	clname=TRIM(cltmpn)//TRIM(Agrif_CFixed())//'_'//TRIM(clname)
222	ENDIF
223	! which suffix should we use?
224	SELECT CASE (iolib)
225	CASE (jpioipsl ) ; clsuffix = '.nc'
226	CASE (jpnf90 ) ; clsuffix = '.nc'
227	CASE (jprstdimg) ; clsuffix = '.dimg'
228	CASE DEFAULT ; clsuffix = ''
229	CALL ctl_stop( TRIM(clinfo), 'accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
230	END SELECT
231	! Add the suffix if needed
232	iln = LEN_TRIM(clname)
233	ils = LEN_TRIM(clsuffix)
234	IF( iln <= ils .OR. INDEX( TRIM(clname), TRIM(clsuffix), back = .TRUE. ) /= iln - ils + 1 ) &
235	& clname = TRIM(clname)//TRIM(clsuffix)
236	cltmpn = clname ! store this name
237	! try to find if the file to be opened already exist
238	! =============
239	INQUIRE( FILE = clname, EXIST = llok )
240	IF( .NOT.llok ) THEN
241	! we try to add the cpu number to the name
242	IF( iolib == jprstdimg ) THEN ; WRITE(clcpu,*) narea
243	ELSE ; WRITE(clcpu,*) narea-1
244	ENDIF
245	clcpu = TRIM(ADJUSTL(clcpu))
246	iln = INDEX(clname,TRIM(clsuffix), back = .TRUE.)
247	clname = clname(1:iln-1)//'_'//TRIM(clcpu)//TRIM(clsuffix)
248	icnt = 0
249	INQUIRE( FILE = clname, EXIST = llok )
250	! we try different formats for the cpu number by adding 0
251	DO WHILE( .NOT.llok .AND. icnt < jpmax_digits )
252	clcpu = "0"//trim(clcpu)
253	clname = clname(1:iln-1)//'_'//TRIM(clcpu)//TRIM(clsuffix)
254	INQUIRE( FILE = clname, EXIST = llok )
255	icnt = icnt + 1
256	END DO
257	ENDIF
258	IF( llwrt ) THEN
259	! check the domain definition
260	! JMM + SM: ugly patch before getting the new version of lib_mpp)
261	! idom = jpdom_local_noovlap ! default definition
262	IF( llnoov ) THEN ; idom = jpdom_local_noovlap ! default definition
263	ELSE ; idom = jpdom_local_full ! default definition
264	ENDIF
265	IF( PRESENT(kdom) ) idom = kdom
266	! create the domain informations
267	! =============
268	SELECT CASE (idom)
269	CASE (jpdom_local_full)
270	idompar(:,1) = (/ jpi , jpj /)
271	idompar(:,2) = (/ nimpp , njmpp /)
272	idompar(:,3) = (/ nimpp + jpi - 1 , njmpp + jpj - 1 /)
273	idompar(:,4) = (/ nldi - 1 , nldj - 1 /)
274	idompar(:,5) = (/ jpi - nlei , jpj - nlej /)
275	CASE (jpdom_local_noextra)
276	idompar(:,1) = (/ nlci , nlcj /)
277	idompar(:,2) = (/ nimpp , njmpp /)
278	idompar(:,3) = (/ nimpp + nlci - 1, njmpp + nlcj - 1 /)
279	idompar(:,4) = (/ nldi - 1 , nldj - 1 /)
280	idompar(:,5) = (/ nlci - nlei , nlcj - nlej /)
281	CASE (jpdom_local_noovlap)
282	idompar(:,1) = (/ nlei - nldi + 1, nlej - nldj + 1 /)
283	idompar(:,2) = (/ nimpp + nldi - 1, njmpp + nldj - 1 /)
284	idompar(:,3) = (/ nimpp + nlei - 1, njmpp + nlej - 1 /)
285	idompar(:,4) = (/ 0 , 0 /)
286	idompar(:,5) = (/ 0 , 0 /)
287	CASE DEFAULT
288	CALL ctl_stop( TRIM(clinfo), 'wrong value of kdom, only jpdom_local* cases are accepted' )
289	END SELECT
290	ENDIF
291	! Open the NetCDF or RSTDIMG file
292	! =============
293	! do we have some free file identifier?
294	IF( MINVAL(iom_file(:)%nfid) /= 0 ) &
295	& CALL ctl_stop( TRIM(clinfo), 'No more free file identifier', 'increase jpmax_files in iom_def' )
296	! if no file was found...
297	IF( .NOT. llok ) THEN
298	IF( .NOT. llwrt ) THEN ! we are in read mode
299	IF( llstop ) THEN ; CALL ctl_stop( TRIM(clinfo), 'File '//TRIM(cltmpn)//'* not found' )
300	ELSE ; istop = nstop + 1 ! make sure that istop /= nstop so we don't open the file
301	ENDIF
302	ELSE ! we are in write mode so we
303	clname = cltmpn ! get back the file name without the cpu number
304	ENDIF
305	ENDIF
306	IF( istop == nstop ) THEN ! no error within this routine
307	SELECT CASE (iolib)
308	CASE (jpioipsl ) ; CALL iom_ioipsl_open( clname, kiomid, llwrt, llok, idompar )
309	CASE (jpnf90 ) ; CALL iom_nf90_open( clname, kiomid, llwrt, llok, idompar )
310	CASE (jprstdimg) ; CALL iom_rstdimg_open( clname, kiomid, llwrt, llok, idompar )
311	CASE DEFAULT
312	CALL ctl_stop( TRIM(clinfo)//' accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
313	END SELECT
314	ENDIF
315	!
316	END SUBROUTINE iom_open
317
318
319	SUBROUTINE iom_close( kiomid )
320	!!--------------------------------------------------------------------
321	!! * SUBROUTINE iom_close *
322	!!
323	!! ** Purpose : close an input file, or all files opened by iom
324	!!--------------------------------------------------------------------
325	INTEGER, INTENT(inout), OPTIONAL :: kiomid ! iom identifier of the file to be closed
326	! ! return 0 when file is properly closed
327	! ! No argument: all files opened by iom are closed
328
329	INTEGER :: jf ! dummy loop indices
330	INTEGER :: i_s, i_e ! temporary integer
331	CHARACTER(LEN=100) :: clinfo ! info character
332	!---------------------------------------------------------------------
333	!
334	clinfo = ' iom_close ~~~ '
335	IF( PRESENT(kiomid) ) THEN
336	i_s = kiomid
337	i_e = kiomid
338	ELSE
339	i_s = 1
340	i_e = jpmax_files
341	#if defined key_iomput
342	CALL event__stop_ioserver
343	#endif
344	ENDIF
345
346	IF( i_s > 0 ) THEN
347	DO jf = i_s, i_e
348	IF( iom_file(jf)%nfid > 0 ) THEN
349	SELECT CASE (iom_file(jf)%iolib)
350	CASE (jpioipsl ) ; CALL iom_ioipsl_close( jf )
351	CASE (jpnf90 ) ; CALL iom_nf90_close( jf )
352	CASE (jprstdimg) ; CALL iom_rstdimg_close( jf )
353	CASE DEFAULT
354	CALL ctl_stop( TRIM(clinfo)//' accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
355	END SELECT
356	iom_file(jf)%nfid = 0 ! free the id
357	IF( PRESENT(kiomid) ) kiomid = 0 ! return 0 as id to specify that the file was closed
358	IF(lwp) WRITE(numout,*) TRIM(clinfo)//' close file: '//TRIM(iom_file(jf)%name)//' ok'
359	ELSEIF( PRESENT(kiomid) ) THEN
360	WRITE(ctmp1,*) '--->', kiomid
361	CALL ctl_stop( TRIM(clinfo)//' Invalid file identifier', ctmp1 )
362	ENDIF
363	END DO
364	ENDIF
365	!
366	END SUBROUTINE iom_close
367
368
369	FUNCTION iom_varid ( kiomid, cdvar, kdimsz, ldstop )
370	!!-----------------------------------------------------------------------
371	!! * FUNCTION iom_varid *
372	!!
373	!! ** Purpose : get the id of a variable in a file (return 0 if not found)
374	!!-----------------------------------------------------------------------
375	INTEGER , INTENT(in ) :: kiomid ! file Identifier
376	CHARACTER(len=*) , INTENT(in ) :: cdvar ! name of the variable
377	INTEGER, DIMENSION(:), INTENT( out), OPTIONAL :: kdimsz ! size of the dimensions
378	LOGICAL , INTENT(in ), OPTIONAL :: ldstop ! stop if looking for non-existing variable (default = .TRUE.)
379	!
380	INTEGER :: iom_varid, iiv, i_nvd
381	LOGICAL :: ll_fnd
382	CHARACTER(LEN=100) :: clinfo ! info character
383	LOGICAL :: llstop ! local definition of ldstop
384	!!-----------------------------------------------------------------------
385	iom_varid = 0 ! default definition
386	! do we call ctl_stop if we look for non-existing variable?
387	IF( PRESENT(ldstop) ) THEN ; llstop = ldstop
388	ELSE ; llstop = .TRUE.
389	ENDIF
390	!
391	IF( kiomid > 0 ) THEN
392	clinfo = 'iom_varid, file: '//trim(iom_file(kiomid)%name)//', var: '//trim(cdvar)
393	IF( iom_file(kiomid)%nfid == 0 ) THEN
394	CALL ctl_stop( trim(clinfo), 'the file is not open' )
395	ELSE
396	ll_fnd = .FALSE.
397	iiv = 0
398	!
399	DO WHILE ( .NOT.ll_fnd .AND. iiv < iom_file(kiomid)%nvars )
400	iiv = iiv + 1
401	ll_fnd = ( TRIM(cdvar) == TRIM(iom_file(kiomid)%cn_var(iiv)) )
402	END DO
403	!
404	IF( .NOT.ll_fnd ) THEN
405	iiv = iiv + 1
406	IF( iiv <= jpmax_vars ) THEN
407	SELECT CASE (iom_file(kiomid)%iolib)
408	CASE (jpioipsl ) ; iom_varid = iom_ioipsl_varid( kiomid, cdvar, iiv, kdimsz )
409	CASE (jpnf90 ) ; iom_varid = iom_nf90_varid ( kiomid, cdvar, iiv, kdimsz )
410	CASE (jprstdimg) ; iom_varid = -1 ! all variables are listed in iom_file
411	CASE DEFAULT
412	CALL ctl_stop( TRIM(clinfo)//' accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
413	END SELECT
414	ELSE
415	CALL ctl_stop( trim(clinfo), 'Too many variables in the file '//iom_file(kiomid)%name, &
416	& 'increase the parameter jpmax_vars')
417	ENDIF
418	IF( llstop .AND. iom_varid == -1 ) CALL ctl_stop( TRIM(clinfo)//' not found' )
419	ELSE
420	iom_varid = iiv
421	IF( PRESENT(kdimsz) ) THEN
422	i_nvd = iom_file(kiomid)%ndims(iiv)
423	IF( i_nvd == size(kdimsz) ) THEN
424	kdimsz(:) = iom_file(kiomid)%dimsz(1:i_nvd,iiv)
425	ELSE
426	WRITE(ctmp1,*) i_nvd, size(kdimsz)
427	CALL ctl_stop( trim(clinfo), 'error in kdimsz size'//trim(ctmp1) )
428	ENDIF
429	ENDIF
430	ENDIF
431	ENDIF
432	ENDIF
433	!
434	END FUNCTION iom_varid
435
436
437	!!----------------------------------------------------------------------
438	!! INTERFACE iom_get
439	!!----------------------------------------------------------------------
440	SUBROUTINE iom_g0d( kiomid, cdvar, pvar )
441	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
442	CHARACTER(len=*), INTENT(in ) :: cdvar ! Name of the variable
443	REAL(wp) , INTENT( out) :: pvar ! read field
444	!
445	INTEGER :: idvar ! variable id
446	!
447	IF( kiomid > 0 ) THEN
448	idvar = iom_varid( kiomid, cdvar )
449	IF( iom_file(kiomid)%nfid > 0 .AND. idvar > 0 ) THEN
450	SELECT CASE (iom_file(kiomid)%iolib)
451	CASE (jpioipsl ) ; CALL iom_ioipsl_get( kiomid, idvar, pvar )
452	CASE (jpnf90 ) ; CALL iom_nf90_get( kiomid, idvar, pvar )
453	CASE (jprstdimg) ; CALL iom_rstdimg_get( kiomid, idvar, pvar )
454	CASE DEFAULT
455	CALL ctl_stop( 'iom_g0d: accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
456	END SELECT
457	ENDIF
458	ENDIF
459	END SUBROUTINE iom_g0d
460
461	SUBROUTINE iom_g1d( kiomid, kdom, cdvar, pvar, ktime, kstart, kcount )
462	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
463	INTEGER , INTENT(in ) :: kdom ! Type of domain to be read
464	CHARACTER(len=*), INTENT(in ) :: cdvar ! Name of the variable
465	REAL(wp) , INTENT( out), DIMENSION(:) :: pvar ! read field
466	INTEGER , INTENT(in ) , OPTIONAL :: ktime ! record number
467	INTEGER , INTENT(in ), DIMENSION(1), OPTIONAL :: kstart ! start axis position of the reading
468	INTEGER , INTENT(in ), DIMENSION(1), OPTIONAL :: kcount ! number of points in each axis
469	!
470	IF( kiomid > 0 ) THEN
471	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_get_123d( kiomid, kdom , cdvar , pv_r1d=pvar, &
472	& ktime=ktime, kstart=kstart, kcount=kcount )
473	ENDIF
474	END SUBROUTINE iom_g1d
475
476	SUBROUTINE iom_g2d( kiomid, kdom, cdvar, pvar, ktime, kstart, kcount )
477	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
478	INTEGER , INTENT(in ) :: kdom ! Type of domain to be read
479	CHARACTER(len=*), INTENT(in ) :: cdvar ! Name of the variable
480	REAL(wp) , INTENT( out), DIMENSION(:,:) :: pvar ! read field
481	INTEGER , INTENT(in ) , OPTIONAL :: ktime ! record number
482	INTEGER , INTENT(in ), DIMENSION(2) , OPTIONAL :: kstart ! start axis position of the reading
483	INTEGER , INTENT(in ), DIMENSION(2) , OPTIONAL :: kcount ! number of points in each axis
484	!
485	IF( kiomid > 0 ) THEN
486	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_get_123d( kiomid, kdom , cdvar , pv_r2d=pvar, &
487	& ktime=ktime, kstart=kstart, kcount=kcount )
488	ENDIF
489	END SUBROUTINE iom_g2d
490
491	SUBROUTINE iom_g3d( kiomid, kdom, cdvar, pvar, ktime, kstart, kcount )
492	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
493	INTEGER , INTENT(in ) :: kdom ! Type of domain to be read
494	CHARACTER(len=*), INTENT(in ) :: cdvar ! Name of the variable
495	REAL(wp) , INTENT( out), DIMENSION(:,:,:) :: pvar ! read field
496	INTEGER , INTENT(in ) , OPTIONAL :: ktime ! record number
497	INTEGER , INTENT(in ), DIMENSION(3) , OPTIONAL :: kstart ! start axis position of the reading
498	INTEGER , INTENT(in ), DIMENSION(3) , OPTIONAL :: kcount ! number of points in each axis
499	!
500	IF( kiomid > 0 ) THEN
501	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_get_123d( kiomid, kdom , cdvar , pv_r3d=pvar, &
502	& ktime=ktime, kstart=kstart, kcount=kcount )
503	ENDIF
504	END SUBROUTINE iom_g3d
505	!!----------------------------------------------------------------------
506
507	SUBROUTINE iom_get_123d( kiomid, kdom , cdvar , &
508	& pv_r1d, pv_r2d, pv_r3d, &
509	& ktime , kstart, kcount )
510	!!-----------------------------------------------------------------------
511	!! * ROUTINE iom_get_123d *
512	!!
513	!! ** Purpose : read a 1D/2D/3D variable
514	!!
515	!! ** Method : read ONE record at each CALL
516	!!-----------------------------------------------------------------------
517	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
518	INTEGER , INTENT(in ) :: kdom ! Type of domain to be read
519	CHARACTER(len=*) , INTENT(in ) :: cdvar ! Name of the variable
520	REAL(wp), DIMENSION(:) , INTENT( out), OPTIONAL :: pv_r1d ! read field (1D case)
521	REAL(wp), DIMENSION(:,:) , INTENT( out), OPTIONAL :: pv_r2d ! read field (2D case)
522	REAL(wp), DIMENSION(:,:,:) , INTENT( out), OPTIONAL :: pv_r3d ! read field (3D case)
523	INTEGER , INTENT(in ), OPTIONAL :: ktime ! record number
524	INTEGER , DIMENSION(:) , INTENT(in ), OPTIONAL :: kstart ! start position of the reading in each axis
525	INTEGER , DIMENSION(:) , INTENT(in ), OPTIONAL :: kcount ! number of points to be read in each axis
526	!
527	LOGICAL :: llnoov ! local definition to read overlap
528	INTEGER :: jl ! loop on number of dimension
529	INTEGER :: idom ! type of domain
530	INTEGER :: idvar ! id of the variable
531	INTEGER :: inbdim ! number of dimensions of the variable
532	INTEGER :: idmspc ! number of spatial dimensions
533	INTEGER :: itime ! record number
534	INTEGER :: istop ! temporary value of nstop
535	INTEGER :: ix1, ix2, iy1, iy2 ! subdomain indexes
536	INTEGER :: ji, jj ! loop counters
537	INTEGER :: irankpv !
538	INTEGER :: ind1, ind2 ! substring index
539	INTEGER, DIMENSION(jpmax_dims) :: istart ! starting point to read for each axis
540	INTEGER, DIMENSION(jpmax_dims) :: icnt ! number of value to read along each axis
541	INTEGER, DIMENSION(jpmax_dims) :: idimsz ! size of the dimensions of the variable
542	INTEGER, DIMENSION(jpmax_dims) :: ishape ! size of the dimensions of the variable
543	REAL(wp) :: zscf, zofs ! sacle_factor and add_offset
544	INTEGER :: itmp ! temporary integer
545	CHARACTER(LEN=100) :: clinfo ! info character
546	CHARACTER(LEN=100) :: clname ! file name
547	CHARACTER(LEN=1) :: clrankpv, cldmspc !
548	!---------------------------------------------------------------------
549	!
550	clname = iom_file(kiomid)%name ! esier to read
551	clinfo = ' iom_get_123d, file: '//trim(clname)//', var: '//trim(cdvar)
552	! local definition of the domain ?
553	idom = kdom
554	! do we read the overlap
555	! ugly patch SM+JMM+RB to overwrite global definition in some cases
556	llnoov = (jpni * jpnj ) == jpnij .AND. .NOT. lk_agrif
557	! check kcount and kstart optionals parameters...
558	IF( PRESENT(kcount) .AND. (.NOT. PRESENT(kstart)) ) CALL ctl_stop(trim(clinfo), 'kcount present needs kstart present')
559	IF( PRESENT(kstart) .AND. (.NOT. PRESENT(kcount)) ) CALL ctl_stop(trim(clinfo), 'kstart present needs kcount present')
560	IF( PRESENT(kstart) .AND. idom /= jpdom_unknown ) CALL ctl_stop(trim(clinfo), 'kstart present needs kdom = jpdom_unknown')
561
562	! Search for the variable in the data base (eventually actualize data)
563	istop = nstop
564	idvar = iom_varid( kiomid, cdvar )
565	!
566	IF( idvar > 0 ) THEN
567	! to write iom_file(kiomid)%dimsz in a shorter way !
568	idimsz(:) = iom_file(kiomid)%dimsz(:, idvar)
569	inbdim = iom_file(kiomid)%ndims(idvar) ! number of dimensions in the file
570	idmspc = inbdim ! number of spatial dimensions in the file
571	IF( iom_file(kiomid)%luld(idvar) ) idmspc = inbdim - 1
572	IF( idmspc > 3 ) CALL ctl_stop(trim(clinfo), 'the file has more than 3 spatial dimensions this case is not coded...')
573	!
574	! update idom definition...
575	! Identify the domain in case of jpdom_auto(glo/dta) definition
576	IF( idom == jpdom_autoglo .OR. idom == jpdom_autodta ) THEN
577	IF( idom == jpdom_autoglo ) THEN ; idom = jpdom_global
578	ELSE ; idom = jpdom_data
579	ENDIF
580	ind1 = INDEX( clname, '_', back = .TRUE. ) + 1
581	ind2 = INDEX( clname, '.', back = .TRUE. ) - 1
582	IF( ind2 > ind1 ) THEN ; IF( VERIFY( clname(ind1:ind2), '0123456789' ) == 0 ) idom = jpdom_local ; ENDIF
583	ENDIF
584	! Identify the domain in case of jpdom_local definition
585	IF( idom == jpdom_local ) THEN
586	IF( idimsz(1) == jpi .AND. idimsz(2) == jpj ) THEN ; idom = jpdom_local_full
587	ELSEIF( idimsz(1) == nlci .AND. idimsz(2) == nlcj ) THEN ; idom = jpdom_local_noextra
588	ELSEIF( idimsz(1) == (nlei - nldi + 1) .AND. idimsz(2) == (nlej - nldj + 1) ) THEN ; idom = jpdom_local_noovlap
589	ELSE ; CALL ctl_stop( trim(clinfo), 'impossible to identify the local domain' )
590	ENDIF
591	ENDIF
592	!
593	! check the consistency between input array and data rank in the file
594	!
595	! initializations
596	itime = 1
597	IF( PRESENT(ktime) ) itime = ktime
598
599	irankpv = 1 * COUNT( (/PRESENT(pv_r1d)/) ) + 2 * COUNT( (/PRESENT(pv_r2d)/) ) + 3 * COUNT( (/PRESENT(pv_r3d)/) )
600	WRITE(clrankpv, fmt='(i1)') irankpv
601	WRITE(cldmspc , fmt='(i1)') idmspc
602	!
603	IF( idmspc < irankpv ) THEN
604	CALL ctl_stop( TRIM(clinfo), 'The file has only '//cldmspc//' spatial dimension', &
605	& 'it is impossible to read a '//clrankpv//'D array from this file...' )
606	ELSEIF( idmspc == irankpv ) THEN
607	IF( PRESENT(pv_r1d) .AND. idom /= jpdom_unknown ) &
608	& CALL ctl_stop( TRIM(clinfo), 'case not coded...You must use jpdom_unknown' )
609	ELSEIF( idmspc > irankpv ) THEN
610	IF( PRESENT(pv_r2d) .AND. itime == 1 .AND. idimsz(3) == 1 .AND. idmspc == 3 ) THEN
611	CALL ctl_warn( trim(clinfo), '2D array but 3 spatial dimensions for the data...' , &
612	& 'As the size of the z dimension is 1 and as we try to read the first record, ', &
613	& 'we accept this case, even if there is a possible mix-up between z and time dimension' )
614	idmspc = idmspc - 1
615	ELSE
616	CALL ctl_stop( TRIM(clinfo), 'To keep iom lisibility, when reading a '//clrankpv//'D array,' , &
617	& 'we do not accept data with more than '//cldmspc//' spatial dimension', &
618	& 'Use ncwa -a to suppress the unnecessary dimensions' )
619	ENDIF
620	ENDIF
621
622	!
623	! definition of istart and icnt
624	!
625	icnt (:) = 1
626	istart(:) = 1
627	istart(idmspc+1) = itime
628
629	IF( PRESENT(kstart) ) THEN ; istart(1:idmspc) = kstart(1:idmspc) ; icnt(1:idmspc) = kcount(1:idmspc)
630	ELSE
631	IF( idom == jpdom_unknown ) THEN ; icnt(1:idmspc) = idimsz(1:idmspc)
632	ELSE
633	IF( .NOT. PRESENT(pv_r1d) ) THEN ! not a 1D array
634	IF( idom == jpdom_data ) THEN ; istart(1:2) = (/ mig(1), mjg(1) /) ! icnt(1:2) done bellow
635	ELSEIF( idom == jpdom_global ) THEN ; istart(1:2) = (/ nimpp , njmpp /) ! icnt(1:2) done bellow
636	ENDIF
637	! we do not read the overlap -> we start to read at nldi, nldj
638	! JMM + SM: ugly patch before getting the new version of lib_mpp)
639	! IF( idom /= jpdom_local_noovlap ) istart(1:2) = istart(1:2) + (/ nldi - 1, nldj - 1 /)
640	IF( llnoov .AND. idom /= jpdom_local_noovlap ) istart(1:2) = istart(1:2) + (/ nldi - 1, nldj - 1 /)
641	! we do not read the overlap and the extra-halos -> from nldi to nlei and from nldj to nlej
642	! JMM + SM: ugly patch before getting the new version of lib_mpp)
643	! icnt(1:2) = (/ nlei - nldi + 1, nlej - nldj + 1 /)
644	IF( llnoov ) THEN ; icnt(1:2) = (/ nlei - nldi + 1, nlej - nldj + 1 /)
645	ELSE ; icnt(1:2) = (/ nlci , nlcj /)
646	ENDIF
647	IF( PRESENT(pv_r3d) ) THEN
648	IF( idom == jpdom_data ) THEN ; icnt(3) = jpkdta
649	ELSE ; icnt(3) = jpk
650	ENDIF
651	ENDIF
652	ENDIF
653	ENDIF
654	ENDIF
655
656	! check that istart and icnt can be used with this file
657	!-
658	DO jl = 1, jpmax_dims
659	itmp = istart(jl)+icnt(jl)-1
660	IF( itmp > idimsz(jl) .AND. idimsz(jl) /= 0 ) THEN
661	WRITE( ctmp1, FMT="('(istart(', i1, ') + icnt(', i1, ') - 1) = ', i5)" ) jl, jl, itmp
662	WRITE( ctmp2, FMT="(' is larger than idimsz(', i1,') = ', i5)" ) jl, idimsz(jl)
663	CALL ctl_stop( trim(clinfo), 'start and count too big regarding to the size of the data, ', ctmp1, ctmp2 )
664	ENDIF
665	END DO
666
667	! check that icnt matches the input array
668	!-
669	IF( idom == jpdom_unknown ) THEN
670	IF( irankpv == 1 ) ishape(1:1) = SHAPE(pv_r1d)
671	IF( irankpv == 2 ) ishape(1:2) = SHAPE(pv_r2d)
672	IF( irankpv == 3 ) ishape(1:3) = SHAPE(pv_r3d)
673	ctmp1 = 'd'
674	ELSE
675	IF( irankpv == 2 ) THEN
676	! JMM + SM: ugly patch before getting the new version of lib_mpp)
677	! ishape(1:2) = SHAPE(pv_r2d(nldi:nlei,nldj:nlej )) ; ctmp1 = 'd(nldi:nlei,nldj:nlej)'
678	IF( llnoov ) THEN ; ishape(1:2)=SHAPE(pv_r2d(nldi:nlei,nldj:nlej )) ; ctmp1='d(nldi:nlei,nldj:nlej)'
679	ELSE ; ishape(1:2)=SHAPE(pv_r2d(1 :nlci,1 :nlcj )) ; ctmp1='d(1:nlci,1:nlcj)'
680	ENDIF
681	ENDIF
682	IF( irankpv == 3 ) THEN
683	! JMM + SM: ugly patch before getting the new version of lib_mpp)
684	! ishape(1:3) = SHAPE(pv_r3d(nldi:nlei,nldj:nlej,:)) ; ctmp1 = 'd(nldi:nlei,nldj:nlej,:)'
685	IF( llnoov ) THEN ; ishape(1:3)=SHAPE(pv_r3d(nldi:nlei,nldj:nlej,:)) ; ctmp1='d(nldi:nlei,nldj:nlej,:)'
686	ELSE ; ishape(1:3)=SHAPE(pv_r3d(1 :nlci,1 :nlcj,:)) ; ctmp1='d(1:nlci,1:nlcj,:)'
687	ENDIF
688	ENDIF
689	ENDIF
690
691	DO jl = 1, irankpv
692	WRITE( ctmp2, FMT="(', ', i1,'): ', i5,' /= icnt(', i1,'):', i5)" ) jl, ishape(jl), jl, icnt(jl)
693	IF( ishape(jl) /= icnt(jl) ) CALL ctl_stop( TRIM(clinfo), 'size(pv_r'//clrankpv//TRIM(ctmp1)//TRIM(ctmp2) )
694	END DO
695
696	ENDIF
697
698	! read the data
699	!-
700	IF( idvar > 0 .AND. istop == nstop ) THEN ! no additional errors until this point...
701	!
702	! find the right index of the array to be read
703	! JMM + SM: ugly patch before getting the new version of lib_mpp)
704	! IF( idom /= jpdom_unknown ) THEN ; ix1 = nldi ; ix2 = nlei ; iy1 = nldj ; iy2 = nlej
705	! ELSE ; ix1 = 1 ; ix2 = icnt(1) ; iy1 = 1 ; iy2 = icnt(2)
706	! ENDIF
707	IF( llnoov ) THEN
708	IF( idom /= jpdom_unknown ) THEN ; ix1 = nldi ; ix2 = nlei ; iy1 = nldj ; iy2 = nlej
709	ELSE ; ix1 = 1 ; ix2 = icnt(1) ; iy1 = 1 ; iy2 = icnt(2)
710	ENDIF
711	ELSE
712	IF( idom /= jpdom_unknown ) THEN ; ix1 = 1 ; ix2 = nlci ; iy1 = 1 ; iy2 = nlcj
713	ELSE ; ix1 = 1 ; ix2 = icnt(1) ; iy1 = 1 ; iy2 = icnt(2)
714	ENDIF
715	ENDIF
716
717	SELECT CASE (iom_file(kiomid)%iolib)
718	CASE (jpioipsl ) ; CALL iom_ioipsl_get( kiomid, idvar, inbdim, istart, icnt, ix1, ix2, iy1, iy2, &
719	& pv_r1d, pv_r2d, pv_r3d )
720	CASE (jpnf90 ) ; CALL iom_nf90_get( kiomid, idvar, inbdim, istart, icnt, ix1, ix2, iy1, iy2, &
721	& pv_r1d, pv_r2d, pv_r3d )
722	CASE (jprstdimg) ; CALL iom_rstdimg_get( kiomid, idom, idvar, ix1, ix2, iy1, iy2, &
723	& pv_r1d, pv_r2d, pv_r3d )
724	CASE DEFAULT
725	CALL ctl_stop( TRIM(clinfo)//' accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
726	END SELECT
727
728	IF( istop == nstop ) THEN ! no additional errors until this point...
729	IF(lwp) WRITE(numout,"(10x,' read ',a,' (rec: ',i4,') in ',a,' ok')") TRIM(cdvar), itime, TRIM(iom_file(kiomid)%name)
730
731	!--- overlap areas and extra hallows (mpp)
732	IF( PRESENT(pv_r2d) .AND. idom /= jpdom_unknown ) THEN
733	CALL lbc_lnk( pv_r2d,'Z',-999.,'no0' )
734	ELSEIF( PRESENT(pv_r3d) .AND. idom /= jpdom_unknown ) THEN
735	! this if could be simplified with the new lbc_lnk that works with any size of the 3rd dimension
736	IF( icnt(3) == jpk ) THEN
737	CALL lbc_lnk( pv_r3d,'Z',-999.,'no0' )
738	ELSE ! put some arbitrary value (a call to lbc_lnk will be done later...)
739	DO jj = nlcj+1, jpj ; pv_r3d(1:nlci, jj, :) = pv_r3d(1:nlci, nlej, :) ; END DO
740	DO ji = nlci+1, jpi ; pv_r3d(ji , : , :) = pv_r3d(nlei , : , :) ; END DO
741	ENDIF
742	ENDIF
743
744	!--- Apply scale_factor and offset
745	zscf = iom_file(kiomid)%scf(idvar) ! scale factor
746	zofs = iom_file(kiomid)%ofs(idvar) ! offset
747	IF( PRESENT(pv_r1d) ) THEN
748	IF( zscf /= 1. ) pv_r1d(:) = pv_r1d(:) * zscf
749	IF( zofs /= 0. ) pv_r1d(:) = pv_r1d(:) + zofs
750	ELSEIF( PRESENT(pv_r2d) ) THEN
751	!CDIR COLLAPSE
752	IF( zscf /= 1.) pv_r2d(:,:) = pv_r2d(:,:) * zscf
753	!CDIR COLLAPSE
754	IF( zofs /= 0.) pv_r2d(:,:) = pv_r2d(:,:) + zofs
755	ELSEIF( PRESENT(pv_r3d) ) THEN
756	!CDIR COLLAPSE
757	IF( zscf /= 1.) pv_r3d(:,:,:) = pv_r3d(:,:,:) * zscf
758	!CDIR COLLAPSE
759	IF( zofs /= 0.) pv_r3d(:,:,:) = pv_r3d(:,:,:) + zofs
760	ENDIF
761	!
762	ENDIF
763	!
764	ENDIF
765	!
766	END SUBROUTINE iom_get_123d
767
768
769	SUBROUTINE iom_gettime( kiomid, ptime, cdvar, kntime, cdunits, cdcalendar )
770	!!--------------------------------------------------------------------
771	!! * SUBROUTINE iom_gettime *
772	!!
773	!! ** Purpose : read the time axis cdvar in the file
774	!!--------------------------------------------------------------------
775	INTEGER , INTENT(in ) :: kiomid ! file Identifier
776	REAL(wp), DIMENSION(:) , INTENT( out) :: ptime ! the time axis
777	CHARACTER(len=*), OPTIONAL , INTENT(in ) :: cdvar ! time axis name
778	INTEGER , OPTIONAL , INTENT( out) :: kntime ! number of times in file
779	CHARACTER(len=*), OPTIONAL , INTENT( out) :: cdunits ! units attribute of time coordinate
780	CHARACTER(len=*), OPTIONAL , INTENT( out) :: cdcalendar ! calendar attribute of
781	!
782	INTEGER, DIMENSION(1) :: kdimsz
783	INTEGER :: idvar ! id of the variable
784	CHARACTER(LEN=32) :: tname ! local name of time coordinate
785	CHARACTER(LEN=100) :: clinfo ! info character
786	!---------------------------------------------------------------------
787	!
788	IF ( PRESENT(cdvar) ) THEN
789	tname = cdvar
790	ELSE
791	tname = iom_file(kiomid)%uldname
792	ENDIF
793	IF( kiomid > 0 ) THEN
794	clinfo = 'iom_gettime, file: '//trim(iom_file(kiomid)%name)//', var: '//trim(tname)
795	IF ( PRESENT(kntime) ) THEN
796	idvar = iom_varid( kiomid, tname, kdimsz = kdimsz )
797	kntime = kdimsz(1)
798	ELSE
799	idvar = iom_varid( kiomid, tname )
800	ENDIF
801	!
802	ptime(:) = 0. ! default definition
803	IF( idvar > 0 ) THEN
804	IF( iom_file(kiomid)%ndims(idvar) == 1 ) THEN
805	IF( iom_file(kiomid)%luld(idvar) ) THEN
806	IF( iom_file(kiomid)%dimsz(1,idvar) <= size(ptime) ) THEN
807	SELECT CASE (iom_file(kiomid)%iolib)
808	CASE (jpioipsl ) ; CALL iom_ioipsl_gettime( kiomid, idvar, ptime, cdunits, cdcalendar )
809	CASE (jpnf90 ) ; CALL iom_nf90_gettime( kiomid, idvar, ptime, cdunits, cdcalendar )
810	CASE (jprstdimg) ; CALL ctl_stop( TRIM(clinfo)//' case IO library == jprstdimg not coded...' )
811	CASE DEFAULT
812	CALL ctl_stop( TRIM(clinfo)//' accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
813	END SELECT
814	ELSE
815	WRITE(ctmp1,*) 'error with the size of ptime ',size(ptime),iom_file(kiomid)%dimsz(1,idvar)
816	CALL ctl_stop( trim(clinfo), trim(ctmp1) )
817	ENDIF
818	ELSE
819	CALL ctl_stop( trim(clinfo), 'variable dimension is not unlimited... use iom_get' )
820	ENDIF
821	ELSE
822	CALL ctl_stop( trim(clinfo), 'the variable has more than 1 dimension' )
823	ENDIF
824	ELSE
825	CALL ctl_stop( trim(clinfo), 'variable not found in '//iom_file(kiomid)%name )
826	ENDIF
827	ENDIF
828	!
829	END SUBROUTINE iom_gettime
830
831
832	!!----------------------------------------------------------------------
833	!! INTERFACE iom_getatt
834	!!----------------------------------------------------------------------
835	SUBROUTINE iom_g0d_intatt( kiomid, cdatt, pvar )
836	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
837	CHARACTER(len=*), INTENT(in ) :: cdatt ! Name of the attribute
838	INTEGER , INTENT( out) :: pvar ! read field
839	!
840	IF( kiomid > 0 ) THEN
841	IF( iom_file(kiomid)%nfid > 0 ) THEN
842	SELECT CASE (iom_file(kiomid)%iolib)
843	CASE (jpioipsl ) ; CALL ctl_stop('iom_getatt: only nf90 available')
844	CASE (jpnf90 ) ; CALL iom_nf90_getatt( kiomid, cdatt, pvar )
845	CASE (jprstdimg) ; CALL ctl_stop('iom_getatt: only nf90 available')
846	CASE DEFAULT
847	CALL ctl_stop( 'iom_g0d_att: accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
848	END SELECT
849	ENDIF
850	ENDIF
851	END SUBROUTINE iom_g0d_intatt
852
853
854	!!----------------------------------------------------------------------
855	!! INTERFACE iom_rstput
856	!!----------------------------------------------------------------------
857	SUBROUTINE iom_rp0d( kt, kwrite, kiomid, cdvar, pvar, ktype )
858	INTEGER , INTENT(in) :: kt ! ocean time-step
859	INTEGER , INTENT(in) :: kwrite ! writing time-step
860	INTEGER , INTENT(in) :: kiomid ! Identifier of the file
861	CHARACTER(len=*), INTENT(in) :: cdvar ! time axis name
862	REAL(wp) , INTENT(in) :: pvar ! written field
863	INTEGER , INTENT(in), OPTIONAL :: ktype ! variable external type
864	INTEGER :: ivid ! variable id
865	IF( kiomid > 0 ) THEN
866	IF( iom_file(kiomid)%nfid > 0 ) THEN
867	ivid = iom_varid( kiomid, cdvar, ldstop = .FALSE. )
868	SELECT CASE (iom_file(kiomid)%iolib)
869	CASE (jpioipsl ) ; CALL iom_ioipsl_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r0d = pvar )
870	CASE (jpnf90 ) ; CALL iom_nf90_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r0d = pvar )
871	CASE (jprstdimg) ; IF( kt == kwrite ) CALL iom_rstdimg_rstput( kiomid, cdvar, ivid, pvar )
872	CASE DEFAULT
873	CALL ctl_stop( 'iom_rp0d: accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
874	END SELECT
875	ENDIF
876	ENDIF
877	END SUBROUTINE iom_rp0d
878
879	SUBROUTINE iom_rp1d( kt, kwrite, kiomid, cdvar, pvar, ktype )
880	INTEGER , INTENT(in) :: kt ! ocean time-step
881	INTEGER , INTENT(in) :: kwrite ! writing time-step
882	INTEGER , INTENT(in) :: kiomid ! Identifier of the file
883	CHARACTER(len=*), INTENT(in) :: cdvar ! time axis name
884	REAL(wp) , INTENT(in), DIMENSION( jpk) :: pvar ! written field
885	INTEGER , INTENT(in), OPTIONAL :: ktype ! variable external type
886	INTEGER :: ivid ! variable id
887	IF( kiomid > 0 ) THEN
888	IF( iom_file(kiomid)%nfid > 0 ) THEN
889	ivid = iom_varid( kiomid, cdvar, ldstop = .FALSE. )
890	SELECT CASE (iom_file(kiomid)%iolib)
891	CASE (jpioipsl ) ; CALL iom_ioipsl_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r1d = pvar )
892	CASE (jpnf90 ) ; CALL iom_nf90_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r1d = pvar )
893	CASE (jprstdimg) ; IF( kt == kwrite ) CALL iom_rstdimg_rstput( kiomid, cdvar, ivid, pv_r1d = pvar )
894	CASE DEFAULT
895	CALL ctl_stop( 'iom_rp1d: accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
896	END SELECT
897	ENDIF
898	ENDIF
899	END SUBROUTINE iom_rp1d
900
901	SUBROUTINE iom_rp2d( kt, kwrite, kiomid, cdvar, pvar, ktype )
902	INTEGER , INTENT(in) :: kt ! ocean time-step
903	INTEGER , INTENT(in) :: kwrite ! writing time-step
904	INTEGER , INTENT(in) :: kiomid ! Identifier of the file
905	CHARACTER(len=*), INTENT(in) :: cdvar ! time axis name
906	REAL(wp) , INTENT(in), DIMENSION(jpi,jpj ) :: pvar ! written field
907	INTEGER , INTENT(in), OPTIONAL :: ktype ! variable external type
908	INTEGER :: ivid ! variable id
909	IF( kiomid > 0 ) THEN
910	IF( iom_file(kiomid)%nfid > 0 ) THEN
911	ivid = iom_varid( kiomid, cdvar, ldstop = .FALSE. )
912	SELECT CASE (iom_file(kiomid)%iolib)
913	CASE (jpioipsl ) ; CALL iom_ioipsl_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r2d = pvar )
914	CASE (jpnf90 ) ; CALL iom_nf90_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r2d = pvar )
915	CASE (jprstdimg) ; IF( kt == kwrite ) CALL iom_rstdimg_rstput( kiomid, cdvar, ivid, pv_r2d = pvar )
916	CASE DEFAULT
917	CALL ctl_stop( 'iom_rp2d: accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
918	END SELECT
919	ENDIF
920	ENDIF
921	END SUBROUTINE iom_rp2d
922
923	SUBROUTINE iom_rp3d( kt, kwrite, kiomid, cdvar, pvar, ktype )
924	INTEGER , INTENT(in) :: kt ! ocean time-step
925	INTEGER , INTENT(in) :: kwrite ! writing time-step
926	INTEGER , INTENT(in) :: kiomid ! Identifier of the file
927	CHARACTER(len=*), INTENT(in) :: cdvar ! time axis name
928	REAL(wp) , INTENT(in), DIMENSION(jpi,jpj,jpk) :: pvar ! written field
929	INTEGER , INTENT(in), OPTIONAL :: ktype ! variable external type
930	INTEGER :: ivid ! variable id
931	IF( kiomid > 0 ) THEN
932	IF( iom_file(kiomid)%nfid > 0 ) THEN
933	ivid = iom_varid( kiomid, cdvar, ldstop = .FALSE. )
934	SELECT CASE (iom_file(kiomid)%iolib)
935	CASE (jpioipsl ) ; CALL iom_ioipsl_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r3d = pvar )
936	CASE (jpnf90 ) ; CALL iom_nf90_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r3d = pvar )
937	CASE (jprstdimg) ; IF( kt == kwrite ) CALL iom_rstdimg_rstput( kiomid, cdvar, ivid, pv_r3d = pvar )
938	CASE DEFAULT
939	CALL ctl_stop( 'iom_rp3d: accepted IO library are only jpioipsl and jprstdimg' )
940	END SELECT
941	ENDIF
942	ENDIF
943	END SUBROUTINE iom_rp3d
944
945
946	!!----------------------------------------------------------------------
947	!! INTERFACE iom_put
948	!!----------------------------------------------------------------------
949	SUBROUTINE iom_p0d( cdname, pfield0d )
950	CHARACTER(LEN=*), INTENT(in) :: cdname
951	REAL(wp) , INTENT(in) :: pfield0d
952	#if defined key_iomput
953	CALL event__write_field2D( cdname, RESHAPE( (/pfield0d/), (/1,1/) ) )
954	#else
955	IF( .FALSE. ) WRITE(numout,*) cdname, pfield0d ! useless test to avoid compilation warnings
956	#endif
957	END SUBROUTINE iom_p0d
958
959	SUBROUTINE iom_p2d( cdname, pfield2d )
960	CHARACTER(LEN=*) , INTENT(in) :: cdname
961	REAL(wp), DIMENSION(jpi,jpj), INTENT(in) :: pfield2d
962	#if defined key_iomput
963	CALL event__write_field2D( cdname, pfield2d(nldi:nlei, nldj:nlej) )
964	#else
965	IF( .FALSE. ) WRITE(numout,*) cdname, pfield2d ! useless test to avoid compilation warnings
966	#endif
967	END SUBROUTINE iom_p2d
968
969	SUBROUTINE iom_p3d( cdname, pfield3d )
970	CHARACTER(LEN=*) , INTENT(in) :: cdname
971	REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in) :: pfield3d
972	#if defined key_iomput
973	CALL event__write_field3D( cdname, pfield3d(nldi:nlei, nldj:nlej, :) )
974	#else
975	IF( .FALSE. ) WRITE(numout,*) cdname, pfield3d ! useless test to avoid compilation warnings
976	#endif
977	END SUBROUTINE iom_p3d
978	!!----------------------------------------------------------------------
979
980
981	#if defined key_iomput
982
983	SUBROUTINE set_grid( cdname, plon, plat )
984	!!----------------------------------------------------------------------
985	!! * ROUTINE *
986	!!
987	!! ** Purpose : define horizontal grids
988	!!
989	!!----------------------------------------------------------------------
990	CHARACTER(LEN=*) , INTENT(in) :: cdname
991	REAL(wp), DIMENSION(jpi,jpj), INTENT(in) :: plon
992	REAL(wp), DIMENSION(jpi,jpj), INTENT(in) :: plat
993
994	CALL event__set_grid_dimension( cdname, jpiglo, jpjglo)
995	CALL event__set_grid_domain( cdname, nlei-nldi+1, nlej-nldj+1, nimpp+nldi-1, njmpp+nldj-1, &
996	& plon(nldi:nlei, nldj:nlej), plat(nldi:nlei, nldj:nlej) )
997	CALL event__set_grid_type_nemo( cdname )
998
999	END SUBROUTINE set_grid
1000
1001
1002	SUBROUTINE set_scalar
1003	!!----------------------------------------------------------------------
1004	!! * ROUTINE *
1005	!!
1006	!! ** Purpose : define fake grids for scalar point
1007	!!
1008	!!----------------------------------------------------------------------
1009	REAL(wp), DIMENSION(1,1) :: zz = 1.
1010	!!----------------------------------------------------------------------
1011	CALL event__set_grid_dimension( 'scalarpoint', jpnij, 1)
1012	CALL event__set_grid_domain ( 'scalarpoint', 1, 1, narea, 1, zz, zz )
1013	CALL event__set_grid_type_nemo( 'scalarpoint' )
1014
1015	END SUBROUTINE set_scalar
1016
1017
1018	SUBROUTINE set_xmlatt
1019	!!----------------------------------------------------------------------
1020	!! * ROUTINE *
1021	!!
1022	!! ** Purpose : automatic definitions of some of the xml attributs...
1023	!!
1024	!!----------------------------------------------------------------------
1025	CHARACTER(len=6),DIMENSION( 8) :: clsuff ! suffix name
1026	CHARACTER(len=1),DIMENSION( 3) :: clgrd ! suffix name
1027	CHARACTER(len=50) :: clname ! file name
1028	CHARACTER(len=1) :: cl1 ! 1 character
1029	CHARACTER(len=2) :: cl2 ! 1 character
1030	INTEGER :: idt ! time-step in seconds
1031	INTEGER :: iddss, ihhss ! number of seconds in 1 day, 1 hour and 1 year
1032	INTEGER :: iyymo ! number of months in 1 year
1033	INTEGER :: jg, jh, jd, jm, jy ! loop counters
1034	INTEGER :: ix, iy ! i-,j- index
1035	REAL(wp) ,DIMENSION(11) :: zlontao ! longitudes of tao moorings
1036	REAL(wp) ,DIMENSION( 7) :: zlattao ! latitudes of tao moorings
1037	REAL(wp) ,DIMENSION( 4) :: zlonrama ! longitudes of rama moorings
1038	REAL(wp) ,DIMENSION(11) :: zlatrama ! latitudes of rama moorings
1039	REAL(wp) ,DIMENSION( 3) :: zlonpira ! longitudes of pirata moorings
1040	REAL(wp) ,DIMENSION( 9) :: zlatpira ! latitudes of pirata moorings
1041	!!----------------------------------------------------------------------
1042	!
1043	idt = NINT( rdttra(1) )
1044	iddss = NINT( rday ) ! number of seconds in 1 day
1045	ihhss = NINT( rmmss * rhhmm ) ! number of seconds in 1 hour
1046	iyymo = NINT( raamo ) ! number of months in 1 year
1047
1048	! frequency of the call of iom_put (attribut: freq_op)
1049	CALL event__set_attribut( 'field_definition', attr( field__freq_op, idt ) ) ! model time-step
1050	CALL event__set_attribut( 'SBC' , attr( field__freq_op, idt * nn_fsbc ) ) ! SBC time-step
1051
1052	! output file names (attribut: name)
1053	clsuff(:) = (/ 'grid_T', 'grid_U', 'grid_V', 'grid_W', 'icemod', 'ptrc_T', 'diad_T', 'scalar' /)
1054	DO jg = 1, SIZE(clsuff) ! grid type
1055	DO jh = 1, 12 ! 1, 2, 3, 4, 6, 12 hours
1056	IF( MOD(12,jh) == 0 ) THEN
1057	WRITE(cl2,'(i2)') jh
1058	CALL dia_nam( clname, jh * ihhss, clsuff(jg), ldfsec = .TRUE. )
1059	CALL event__set_attribut( TRIM(ADJUSTL(cl2))//'h_'//clsuff(jg), attr( file__name, TRIM(clname) ) )
1060	ENDIF
1061	END DO
1062	DO jd = 1, 5, 2 ! 1, 3, 5 days
1063	WRITE(cl1,'(i1)') jd
1064	CALL dia_nam( clname, jd * iddss, clsuff(jg), ldfsec = .TRUE. )
1065	CALL event__set_attribut( cl1//'d_'//clsuff(jg), attr( file__name, TRIM(clname) ) )
1066	END DO
1067	DO jm = 1, 6 ! 1, 2, 3, 4, 6 months
1068	IF( MOD(6,jm) == 0 ) THEN
1069	WRITE(cl1,'(i1)') jm
1070	CALL dia_nam( clname, -jm, clsuff(jg) )
1071	CALL event__set_attribut( cl1//'m_'//clsuff(jg), attr( file__name, TRIM(clname) ) )
1072	ENDIF
1073	END DO
1074	DO jy = 1, 10 ! 1, 2, 5, 10 years
1075	IF( MOD(10,jy) == 0 ) THEN
1076	WRITE(cl2,'(i2)') jy
1077	CALL dia_nam( clname, -jy * iyymo, clsuff(jg) )
1078	CALL event__set_attribut( TRIM(ADJUSTL(cl2))//'y_'//clsuff(jg), attr( file__name, TRIM(clname) ) )
1079	ENDIF
1080	END DO
1081	END DO
1082
1083	! Zooms...
1084	clgrd = (/ 'T', 'U', 'W' /)
1085	DO jg = 1, SIZE(clgrd) ! grid type
1086	cl1 = clgrd(jg)
1087	! Equatorial section (attributs: jbegin, ni, name_suffix)
1088	CALL dom_ngb( 0., 0., ix, iy, cl1 )
1089	CALL event__set_attribut( 'Eq'//cl1, attr( zoom__jbegin , iy ) )
1090	CALL event__set_attribut( 'Eq'//cl1, attr( zoom__ni , jpiglo ) )
1091	CALL event__set_attribut( 'Eq'//cl1, attr( file__name_suffix, '_Eq' ) )
1092	END DO
1093	! TAO moorings (attributs: ibegin, jbegin, name_suffix)
1094	zlontao = (/ 137.0, 147.0, 156.0, 165.0, -180.0, -170.0, -155.0, -140.0, -125.0, -110.0, -95.0 /)
1095	zlattao = (/ -8.0, -5.0, -2.0, 0.0, 2.0, 5.0, 8.0 /)
1096	CALL set_mooring( zlontao, zlattao )
1097	! RAMA moorings (attributs: ibegin, jbegin, name_suffix)
1098	zlonrama = (/ 55.0, 67.0, 80.5, 90.0 /)
1099	zlatrama = (/ -16.0, -12.0, -8.0, -4.0, -1.5, 0.0, 1.5, 4.0, 8.0, 12.0, 15.0 /)
1100	CALL set_mooring( zlonrama, zlatrama )
1101	! PIRATA moorings (attributs: ibegin, jbegin, name_suffix)
1102	zlonpira = (/ -38.0, -23.0, -10.0 /)
1103	zlatpira = (/ -19.0, -14.0, -8.0, 0.0, 4.0, 8.0, 12.0, 15.0, 20.0 /)
1104	CALL set_mooring( zlonpira, zlatpira )
1105
1106	END SUBROUTINE set_xmlatt
1107
1108
1109	SUBROUTINE set_mooring( plon, plat)
1110	!!----------------------------------------------------------------------
1111	!! * ROUTINE *
1112	!!
1113	!! ** Purpose : automatic definitions of moorings xml attributs...
1114	!!
1115	!!----------------------------------------------------------------------
1116	REAL(wp), DIMENSION(:), INTENT(in) :: plon, plat ! longitudes/latitudes oft the mooring
1117	!
1118	!!$ CHARACTER(len=1),DIMENSION(4) :: clgrd = (/ 'T', 'U', 'V', 'W' /) ! suffix name
1119	CHARACTER(len=1),DIMENSION(1) :: clgrd = (/ 'T' /) ! suffix name
1120	CHARACTER(len=50) :: clname ! file name
1121	CHARACTER(len=1) :: cl1 ! 1 character
1122	CHARACTER(len=6) :: clon,clat ! name of longitude, latitude
1123	INTEGER :: ji, jj, jg ! loop counters
1124	INTEGER :: ix, iy ! i-,j- index
1125	REAL(wp) :: zlon, zlat
1126	!!----------------------------------------------------------------------
1127	DO jg = 1, SIZE(clgrd)
1128	cl1 = clgrd(jg)
1129	DO ji = 1, SIZE(plon)
1130	DO jj = 1, SIZE(plat)
1131	zlon = plon(ji)
1132	zlat = plat(jj)
1133	! modifications for RAMA moorings
1134	IF( zlon == 67. .AND. zlat == 15. ) zlon = 65.
1135	IF( zlon == 90. .AND. zlat <= -4. ) zlon = 95.
1136	IF( zlon == 95. .AND. zlat == -4. ) zlat = -5.
1137	! modifications for PIRATA moorings
1138	IF( zlon == -38. .AND. zlat == -19. ) zlon = -34.
1139	IF( zlon == -38. .AND. zlat == -14. ) zlon = -32.
1140	IF( zlon == -38. .AND. zlat == -8. ) zlon = -30.
1141	IF( zlon == -38. .AND. zlat == 0. ) zlon = -35.
1142	IF( zlon == -23. .AND. zlat == 20. ) zlat = 21.
1143	IF( zlon == -10. .AND. zlat == -14. ) zlat = -10.
1144	IF( zlon == -10. .AND. zlat == -8. ) zlat = -6.
1145	IF( zlon == -10. .AND. zlat == 4. ) THEN ; zlon = 0. ; zlat = 0. ; ENDIF
1146	CALL dom_ngb( zlon, zlat, ix, iy, cl1 )
1147	IF( zlon >= 0. ) THEN
1148	IF( zlon == REAL(NINT(zlon), wp) ) THEN ; WRITE(clon, '(i3, a)') NINT( zlon), 'e'
1149	ELSE ; WRITE(clon, '(f5.1,a)') zlon , 'e'
1150	ENDIF
1151	ELSE
1152	IF( zlon == REAL(NINT(zlon), wp) ) THEN ; WRITE(clon, '(i3, a)') NINT(-zlon), 'w'
1153	ELSE ; WRITE(clon, '(f5.1,a)') -zlon , 'w'
1154	ENDIF
1155	ENDIF
1156	IF( zlat >= 0. ) THEN
1157	IF( zlat == REAL(NINT(zlat), wp) ) THEN ; WRITE(clat, '(i2, a)') NINT( zlat), 'n'
1158	ELSE ; WRITE(clat, '(f4.1,a)') zlat , 'n'
1159	ENDIF
1160	ELSE
1161	IF( zlat == REAL(NINT(zlat), wp) ) THEN ; WRITE(clat, '(i2, a)') NINT(-zlat), 's'
1162	ELSE ; WRITE(clat, '(f4.1,a)') -zlat , 's'
1163	ENDIF
1164	ENDIF
1165	clname = TRIM(ADJUSTL(clat))//TRIM(ADJUSTL(clon))
1166	CALL event__set_attribut( TRIM(clname)//cl1, attr( zoom__ibegin , ix ) )
1167	CALL event__set_attribut( TRIM(clname)//cl1, attr( zoom__jbegin , iy ) )
1168	CALL event__set_attribut( TRIM(clname)//cl1, attr( file__name_suffix, '_'//TRIM(clname) ) )
1169	END DO
1170	END DO
1171	END DO
1172
1173	END SUBROUTINE set_mooring
1174
1175	#else
1176
1177	SUBROUTINE iom_setkt( kt )
1178	INTEGER, INTENT(in ):: kt
1179	IF( .FALSE. ) WRITE(numout,*) kt ! useless test to avoid compilation warnings
1180	END SUBROUTINE iom_setkt
1181
1182	#endif
1183
1184
1185	!!======================================================================
1186	END MODULE iom

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

Download in other formats: