source: NEMO/branches/2019/dev_r11756_SI3restart_XIOS/src/OCE/IOM/iom.F90 @ 11840

Last change on this file since 11840 was 11840, checked in by andmirek, 2 years ago

Ticket #2323 write SI3 restart with XIOS

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