Ticket #2078: iom.F90

File iom.F90, 127.4 KB (added by fschwarzkopf, 16 months ago)

Corrected iom.F90 (NEMO4.0)

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