source: CONFIG/UNIFORM/v6/IPSLCM6/SOURCES/NEMO/iom.F90 @ 3344

Last change on this file since 3344 was 3344, checked in by cetlod, 4 years ago

CM6.0.12: Adding modified NEMO routines to properly handle outputs when removing land processors

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