source: NEMO/branches/2020/dev_12905_xios_restart/src/OCE/IOM/iom.F90 @ 12950

Last change on this file since 12950 was 12950, checked in by andmirek, 5 months ago

Ticket #2462: new XIOS restart read/write interfaces

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