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

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

source: NEMO/branches/UKMO/NEMO_4.0.4_CO9_shelf_climate/src/OCE/IOM/iom.F90 @ 15358

Last change on this file since 15358 was 15358, checked in by hadjt, 12 months ago

DIA/diaregmean.F90

Region mean namelist switch added to allow area weighted region means.

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