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/2019/dev_r11756_SI3restart_XIOS/src/OCE/IOM – NEMO

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

Last change on this file since 11923 was 11923, checked in by andmirek, 4 years ago

Ticket #2323 all other SETTE/tests configurations

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