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

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
iom.F90 in NEMO/branches/UKMO/NEMO_4.0_mirror_text_diagnostics/src/OCE/IOM – NEMO

source: NEMO/branches/UKMO/NEMO_4.0_mirror_text_diagnostics/src/OCE/IOM/iom.F90 @ 10986

Last change on this file since 10986 was 10986, checked in by andmirek, 5 years ago

GMED 462 add flush

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