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

source: NEMO/branches/UKMO/NEMO_4.0.4_icesheet_and_river_coupling/src/OCE/IOM/iom.F90 @ 14643

Last change on this file since 14643 was 14643, checked in by dancopsey, 3 years ago

Output timing information

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