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 @ 15357

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

Region means
IOM_use to only process variables in use.
namelist parameter to control whether hourly means, or instanteous values
Instantaneous values of heat, salt mass and volume.

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