source: NEMO/trunk/src/OCE/IOM/iom_nf90.F90 @ 10068

Last change on this file since 10068 was 10068, checked in by nicolasmartin, 3 years ago

First part of modifications to have a common default header : fix typos and SVN keywords properties

  • Property svn:keywords set to Id
File size: 48.7 KB
Line 
1MODULE iom_nf90
2   !!======================================================================
3   !!                    ***  MODULE  iom_nf90 ***
4   !! Input/Output manager :  Library to read input files with NF90 (only fliocom module)
5   !!======================================================================
6   !! History :  9.0  ! 05 12  (J. Belier) Original code
7   !!            9.0  ! 06 02  (S. Masson) Adaptation to NEMO
8   !!             "   ! 07 07  (D. Storkey) Changes to iom_nf90_gettime
9   !!            3.6  ! 2015-15  (J. Harle) Added procedure to read REAL attributes
10   !!            4.0  ! 2017-11 (M. Andrejczuk) Extend IOM interface to write any 3D fields
11   !!----------------------------------------------------------------------
12
13   !!----------------------------------------------------------------------
14   !!   iom_open       : open a file read only
15   !!   iom_close      : close a file or all files opened by iom
16   !!   iom_get        : read a field (interfaced to several routines)
17   !!   iom_gettime    : read the time axis kvid in the file
18   !!   iom_varid      : get the id of a variable in a file
19   !!   iom_rstput     : write a field in a restart file (interfaced to several routines)
20   !!----------------------------------------------------------------------
21   USE dom_oce         ! ocean space and time domain
22   USE lbclnk          ! lateal boundary condition / mpp exchanges
23   USE iom_def         ! iom variables definitions
24   USE netcdf          ! NetCDF library
25   USE in_out_manager  ! I/O manager
26   USE lib_mpp         ! MPP library
27
28   IMPLICIT NONE
29   PRIVATE
30
31   PUBLIC iom_nf90_open  , iom_nf90_close, iom_nf90_varid, iom_nf90_get, iom_nf90_gettime, iom_nf90_rstput
32   PUBLIC iom_nf90_getatt, iom_nf90_putatt
33
34   INTERFACE iom_nf90_get
35      MODULE PROCEDURE iom_nf90_g0d, iom_nf90_g123d
36   END INTERFACE
37   INTERFACE iom_nf90_getatt
38      MODULE PROCEDURE iom_nf90_giatt, iom_nf90_gratt, iom_nf90_gcatt
39   END INTERFACE
40   INTERFACE iom_nf90_putatt
41      MODULE PROCEDURE iom_nf90_piatt, iom_nf90_pratt, iom_nf90_pcatt
42   END INTERFACE
43   INTERFACE iom_nf90_rstput
44      MODULE PROCEDURE iom_nf90_rp0123d
45   END INTERFACE
46
47   !!----------------------------------------------------------------------
48   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
49   !! $Id$
50   !! Software governed by the CeCILL license (see ./LICENSE)
51   !!----------------------------------------------------------------------
52CONTAINS
53
54   SUBROUTINE iom_nf90_open( cdname, kiomid, ldwrt, ldok, kdompar, kdlev )
55      !!---------------------------------------------------------------------
56      !!                   ***  SUBROUTINE  iom_open  ***
57      !!
58      !! ** Purpose : open an input file with NF90
59      !!---------------------------------------------------------------------
60      CHARACTER(len=*)       , INTENT(inout)           ::   cdname      ! File name
61      INTEGER                , INTENT(  out)           ::   kiomid      ! nf90 identifier of the opened file
62      LOGICAL                , INTENT(in   )           ::   ldwrt       ! read or write the file?
63      LOGICAL                , INTENT(in   )           ::   ldok        ! check the existence
64      INTEGER, DIMENSION(2,5), INTENT(in   ), OPTIONAL ::   kdompar     ! domain parameters:
65      INTEGER                , INTENT(in   ), OPTIONAL ::   kdlev       ! size of the third dimension
66
67      CHARACTER(LEN=256) ::   clinfo           ! info character
68      CHARACTER(LEN=256) ::   cltmp            ! temporary character
69      INTEGER            ::   iln              ! lengths of character
70      INTEGER            ::   istop            ! temporary storage of nstop
71      INTEGER            ::   if90id           ! nf90 identifier of the opened file
72      INTEGER            ::   idmy             ! dummy variable
73      INTEGER            ::   jl               ! loop variable
74      INTEGER            ::   ichunk           ! temporary storage of nn_chunksz
75      INTEGER            ::   imode            ! creation mode flag: NF90_CLOBBER or NF90_NOCLOBBER or NF90_HDF5
76      INTEGER            ::   ihdf5            ! local variable for retrieval of value for NF90_HDF5
77      LOGICAL            ::   llclobber        ! local definition of ln_clobber
78      INTEGER            ::   ilevels           ! vertical levels
79      !---------------------------------------------------------------------
80      !
81      clinfo = '                    iom_nf90_open ~~~  '
82      istop = nstop     ! store the actual value of nstop
83      !
84      !                 !number of vertical levels
85      IF( PRESENT(kdlev) ) THEN   ;   ilevels = kdlev    ! use input value (useful for sea-ice)
86      ELSE                        ;   ilevels = jpk      ! by default jpk
87      ENDIF
88      !
89      IF( nn_chunksz > 0 ) THEN   ;   ichunk = nn_chunksz
90      ELSE                        ;   ichunk = NF90_SIZEHINT_DEFAULT
91      ENDIF
92      !
93      llclobber = ldwrt .AND. ln_clobber
94      IF( ldok .AND. .NOT. llclobber ) THEN      !==  Open existing file ==!
95         !                                       !=========================!
96         IF( ldwrt ) THEN  ! ... in write mode
97            IF(lwp) WRITE(numout,*) TRIM(clinfo)//' open existing file: '//TRIM(cdname)//' in WRITE mode'
98            IF( snc4set%luse ) THEN
99               CALL iom_nf90_check(NF90_OPEN( TRIM(cdname), NF90_WRITE  , if90id ), clinfo)
100            ELSE
101               CALL iom_nf90_check(NF90_OPEN( TRIM(cdname), NF90_WRITE  , if90id, chunksize = ichunk ), clinfo)
102            ENDIF
103            CALL iom_nf90_check(NF90_SET_FILL( if90id, NF90_NOFILL, idmy                          ), clinfo)
104         ELSE              ! ... in read mode
105            IF(lwp) WRITE(numout,*) TRIM(clinfo)//' open existing file: '//TRIM(cdname)//' in READ mode'
106            CALL iom_nf90_check(NF90_OPEN( TRIM(cdname), NF90_NOWRITE, if90id, chunksize = ichunk ), clinfo)
107         ENDIF
108      ELSE                                       !== the file doesn't exist ==!   (or we overwrite it)
109         !                                       !============================!
110         iln = INDEX( cdname, '.nc' )
111         IF( ldwrt ) THEN              !* the file should be open in write mode so we create it...
112            IF( jpnij > 1 ) THEN
113               WRITE(cltmp,'(a,a,i4.4,a)') cdname(1:iln-1), '_', narea-1, '.nc'
114               cdname = TRIM(cltmp)
115            ENDIF
116            IF(lwp) WRITE(numout,*) TRIM(clinfo)//' create new file: '//TRIM(cdname)//' in WRITE mode'
117
118            IF( llclobber ) THEN   ;   imode = IOR( NF90_64BIT_OFFSET, NF90_CLOBBER   )
119            ELSE                   ;   imode = IOR( NF90_64BIT_OFFSET, NF90_NOCLOBBER ) 
120            ENDIF
121            IF( snc4set%luse ) THEN
122               IF(lwp) WRITE(numout,*) TRIM(clinfo)//' creating file: '//TRIM(cdname)//' in hdf5 (netcdf4) mode'
123               CALL GET_NF90_SYMBOL("NF90_HDF5", ihdf5)
124               IF( llclobber ) THEN   ;   imode = IOR(ihdf5, NF90_CLOBBER)
125               ELSE                   ;   imode = IOR(ihdf5, NF90_NOCLOBBER)
126               ENDIF
127               CALL iom_nf90_check(NF90_CREATE( TRIM(cdname), imode, if90id ), clinfo)
128            ELSE
129               CALL iom_nf90_check(NF90_CREATE( TRIM(cdname), imode, if90id, chunksize = ichunk ), clinfo)
130            ENDIF
131            CALL iom_nf90_check(NF90_SET_FILL( if90id, NF90_NOFILL, idmy                     ), clinfo)
132            ! define dimensions
133            CALL iom_nf90_check(NF90_DEF_DIM( if90id, 'x'      , kdompar(1,1)  , idmy ), clinfo)
134            CALL iom_nf90_check(NF90_DEF_DIM( if90id, 'y'      , kdompar(2,1)  , idmy ), clinfo)
135            IF( PRESENT(kdlev) ) THEN
136               CALL iom_nf90_check(NF90_DEF_DIM( if90id, 'numcat' , ilevels    , idmy ), clinfo)
137            ELSE
138               CALL iom_nf90_check(NF90_DEF_DIM( if90id, 'nav_lev', ilevels    , idmy ), clinfo)
139            ENDIF
140            CALL iom_nf90_check(NF90_DEF_DIM( if90id, 'time_counter', NF90_UNLIMITED, idmy ), clinfo)
141            ! global attributes
142            CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_number_total'   , jpnij              ), clinfo)
143            CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_number'         , narea-1            ), clinfo)
144            CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_dimensions_ids' , (/1     , 2     /) ), clinfo)
145            CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_size_global'    , (/jpiglo, jpjglo/) ), clinfo)
146            CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_size_local'     , kdompar(:,1)       ), clinfo)
147            CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_position_first' , kdompar(:,2)       ), clinfo)
148            CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_position_last'  , kdompar(:,3)       ), clinfo)
149            CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_halo_size_start', kdompar(:,4)       ), clinfo)
150            CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_halo_size_end'  , kdompar(:,5)       ), clinfo)
151            CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_type'           , 'BOX'              ), clinfo)
152         ELSE                          !* the file should be open for read mode so it must exist...
153            CALL ctl_stop( TRIM(clinfo), ' should be impossible case...' )
154         ENDIF
155      ENDIF
156      !
157      ! start to fill file informations
158      ! =============
159      IF( istop == nstop ) THEN   ! no error within this routine
160!does not work with some compilers         kiomid = MINLOC(iom_file(:)%nfid, dim = 1)
161         kiomid = 0
162         DO jl = jpmax_files, 1, -1
163            IF( iom_file(jl)%nfid == 0 )   kiomid = jl
164         ENDDO
165         iom_file(kiomid)%name   = TRIM(cdname)
166         iom_file(kiomid)%nfid   = if90id
167         iom_file(kiomid)%iolib  = jpnf90
168         iom_file(kiomid)%nvars  = 0
169         iom_file(kiomid)%irec   = -1   ! useless for NetCDF files, used to know if the file is in define mode
170         iom_file(kiomid)%nlev   = ilevels
171         CALL iom_nf90_check(NF90_Inquire(if90id, unlimitedDimId = iom_file(kiomid)%iduld), clinfo)
172         IF( iom_file(kiomid)%iduld .GE. 0 ) THEN
173            CALL iom_nf90_check(NF90_Inquire_Dimension(if90id, iom_file(kiomid)%iduld,    & 
174               &                                       name = iom_file(kiomid)%uldname,   &
175               &                                       len  = iom_file(kiomid)%lenuld ), clinfo )
176         ENDIF
177         IF(lwp) WRITE(numout,*) '                   ---> '//TRIM(cdname)//' OK'
178      ELSE
179         kiomid = 0               ! return error flag
180      ENDIF
181      !
182   END SUBROUTINE iom_nf90_open
183
184
185   SUBROUTINE iom_nf90_close( kiomid )
186      !!--------------------------------------------------------------------
187      !!                   ***  SUBROUTINE  iom_nf90_close  ***
188      !!
189      !! ** Purpose : close an input file with NF90
190      !!--------------------------------------------------------------------
191      INTEGER, INTENT(in) ::   kiomid   ! iom identifier of the file to be closed
192      CHARACTER(LEN=100)  ::   clinfo   ! info character
193      !---------------------------------------------------------------------
194      clinfo = '      iom_nf90_close    , file: '//TRIM(iom_file(kiomid)%name)
195      CALL iom_nf90_check(NF90_CLOSE(iom_file(kiomid)%nfid), clinfo)
196   END SUBROUTINE iom_nf90_close
197
198
199   FUNCTION iom_nf90_varid ( kiomid, cdvar, kiv, kdimsz, kndims ) 
200      !!-----------------------------------------------------------------------
201      !!                  ***  FUNCTION  iom_varid  ***
202      !!
203      !! ** Purpose : get the id of a variable in a file with NF90
204      !!-----------------------------------------------------------------------
205      INTEGER              , INTENT(in   )           ::   kiomid   ! file Identifier
206      CHARACTER(len=*)     , INTENT(in   )           ::   cdvar    ! name of the variable
207      INTEGER              , INTENT(in   )           ::   kiv   !
208      INTEGER, DIMENSION(:), INTENT(  out), OPTIONAL ::   kdimsz   ! size of the dimensions
209      INTEGER,               INTENT(  out), OPTIONAL ::   kndims   ! size of the dimensions
210      !
211      INTEGER                        ::   iom_nf90_varid   ! iom variable Id
212      INTEGER                        ::   if90id           ! nf90 file identifier
213      INTEGER                        ::   ji               ! dummy loop index
214      INTEGER                        ::   ivarid           ! NetCDF  variable Id
215      INTEGER                        ::   i_nvd            ! number of dimension of the variable
216      INTEGER, DIMENSION(jpmax_dims) ::   idimid           ! dimension ids of the variable
217      LOGICAL                        ::   llok             ! ok  test
218      CHARACTER(LEN=100)             ::   clinfo           ! info character
219      !!-----------------------------------------------------------------------
220      clinfo = '          iom_nf90_varid, file: '//TRIM(iom_file(kiomid)%name)//', var: '//TRIM(cdvar)
221      iom_nf90_varid = 0                    ! default definition
222      IF( PRESENT(kdimsz) ) kdimsz(:) = 0   ! default definition
223      if90id = iom_file(kiomid)%nfid        ! get back NetCDF file id
224      !
225      llok = NF90_INQ_VARID( if90id, TRIM(cdvar), ivarid ) == nf90_noerr   ! does the variable exist in the file
226      IF( llok ) THEN
227         iom_nf90_varid = kiv
228         iom_file(kiomid)%nvars       = kiv
229         iom_file(kiomid)%nvid(kiv)   = ivarid
230         iom_file(kiomid)%cn_var(kiv) = TRIM(cdvar)
231         CALL iom_nf90_check(NF90_Inquire_Variable(if90id, ivarid, ndims = i_nvd), clinfo)   ! number of dimensions
232         iom_file(kiomid)%ndims(kiv)  = i_nvd
233         CALL iom_nf90_check(NF90_Inquire_Variable(if90id, ivarid, dimids = idimid(1:i_nvd)), clinfo)   ! dimensions ids
234         iom_file(kiomid)%luld(kiv) = .FALSE.   ! default value
235         iom_file(kiomid)%dimsz(:,kiv) = 0      ! reset dimsz in case previously used
236         DO ji = 1, i_nvd                       ! dimensions size
237            CALL iom_nf90_check(NF90_Inquire_Dimension(if90id, idimid(ji), len = iom_file(kiomid)%dimsz(ji,kiv)), clinfo)   
238            IF( idimid(ji) == iom_file(kiomid)%iduld ) iom_file(kiomid)%luld(kiv) = .TRUE.   ! unlimited dimension?
239         END DO
240         !---------- Deal with scale_factor and add_offset
241         llok = NF90_Inquire_attribute(if90id, ivarid, 'scale_factor') == nf90_noerr
242         IF( llok) THEN
243            CALL iom_nf90_check(NF90_GET_ATT(if90id, ivarid, 'scale_factor', iom_file(kiomid)%scf(kiv)), clinfo)
244         ELSE
245            iom_file(kiomid)%scf(kiv) = 1.
246         END IF
247         llok = NF90_Inquire_attribute(if90id, ivarid, 'add_offset') == nf90_noerr
248         IF( llok ) THEN
249            CALL iom_nf90_check(NF90_GET_ATT(if90id, ivarid, 'add_offset', iom_file(kiomid)%ofs(kiv)), clinfo)
250         ELSE
251            iom_file(kiomid)%ofs(kiv) = 0.
252         END IF
253         ! return the simension size
254         IF( PRESENT(kdimsz) ) THEN
255            IF( i_nvd <= SIZE(kdimsz) ) THEN
256               kdimsz(1:i_nvd) = iom_file(kiomid)%dimsz(1:i_nvd,kiv)
257            ELSE
258               WRITE(ctmp1,*) i_nvd, SIZE(kdimsz)
259               CALL ctl_stop( TRIM(clinfo), 'error in kdimsz size'//TRIM(ctmp1) )
260            ENDIF
261         ENDIF
262         IF( PRESENT(kndims) )  kndims = iom_file(kiomid)%ndims(kiv)
263      ELSE 
264         iom_nf90_varid = -1   !   variable not found, return error code: -1
265      ENDIF
266      !
267   END FUNCTION iom_nf90_varid
268
269   !!----------------------------------------------------------------------
270   !!                   INTERFACE iom_nf90_get
271   !!----------------------------------------------------------------------
272
273   SUBROUTINE iom_nf90_g0d( kiomid, kvid, pvar, kstart )
274      !!-----------------------------------------------------------------------
275      !!                  ***  ROUTINE  iom_nf90_g0d  ***
276      !!
277      !! ** Purpose : read a scalar with NF90
278      !!-----------------------------------------------------------------------
279      INTEGER ,               INTENT(in   )            ::   kiomid   ! Identifier of the file
280      INTEGER ,               INTENT(in   )            ::   kvid     ! variable id
281      REAL(wp),               INTENT(  out)            ::   pvar     ! read field
282      INTEGER , DIMENSION(1), INTENT(in   ), OPTIONAL  ::   kstart   ! start position of the reading in each axis
283      !
284      CHARACTER(LEN=100)      ::   clinfo   ! info character
285      !---------------------------------------------------------------------
286      clinfo = 'iom_nf90_g0d , file: '//TRIM(iom_file(kiomid)%name)//', var: '//TRIM(iom_file(kiomid)%cn_var(kvid))
287      CALL iom_nf90_check(NF90_GET_VAR(iom_file(kiomid)%nfid, iom_file(kiomid)%nvid(kvid), pvar, start = kstart), clinfo )
288   END SUBROUTINE iom_nf90_g0d
289
290
291   SUBROUTINE iom_nf90_g123d( kiomid, kvid, knbdim, kstart, kcount, kx1, kx2, ky1, ky2,   &
292         &                    pv_r1d, pv_r2d, pv_r3d )
293      !!-----------------------------------------------------------------------
294      !!                  ***  ROUTINE  iom_nf90_g123d  ***
295      !!
296      !! ** Purpose : read a 1D/2D/3D variable with NF90
297      !!
298      !! ** Method : read ONE record at each CALL
299      !!-----------------------------------------------------------------------
300      INTEGER                    , INTENT(in   )           ::   kiomid    ! iom identifier of the file
301      INTEGER                    , INTENT(in   )           ::   kvid      ! Name of the variable
302      INTEGER                    , INTENT(in   )           ::   knbdim    ! number of dimensions of the variable
303      INTEGER , DIMENSION(:)     , INTENT(in   )           ::   kstart    ! start position of the reading in each axis
304      INTEGER , DIMENSION(:)     , INTENT(in   )           ::   kcount    ! number of points to be read in each axis
305      INTEGER ,                    INTENT(in   )           ::   kx1, kx2, ky1, ky2   ! subdomain indexes
306      REAL(wp), DIMENSION(:)     , INTENT(  out), OPTIONAL ::   pv_r1d    ! read field (1D case)
307      REAL(wp), DIMENSION(:,:)   , INTENT(  out), OPTIONAL ::   pv_r2d    ! read field (2D case)
308      REAL(wp), DIMENSION(:,:,:) , INTENT(  out), OPTIONAL ::   pv_r3d    ! read field (3D case)
309      !
310      CHARACTER(LEN=100) ::   clinfo               ! info character
311      INTEGER            ::   if90id               ! nf90 identifier of the opened file
312      INTEGER            ::   ivid                 ! nf90 variable id
313      !---------------------------------------------------------------------
314      clinfo = 'iom_nf90_g123d , file: '//TRIM(iom_file(kiomid)%name)//', var: '//TRIM(iom_file(kiomid)%cn_var(kvid))
315      if90id = iom_file(kiomid)%nfid         ! get back NetCDF file id
316      ivid   = iom_file(kiomid)%nvid(kvid)   ! get back NetCDF var id
317      !
318      IF(     PRESENT(pv_r1d) ) THEN
319         CALL iom_nf90_check( NF90_GET_VAR(if90id, ivid, pv_r1d(:                ), start = kstart(1:knbdim),   &
320            &                                                                       count = kcount(1:knbdim)), clinfo )
321      ELSEIF( PRESENT(pv_r2d) ) THEN
322         CALL iom_nf90_check( NF90_GET_VAR(if90id, ivid, pv_r2d(kx1:kx2,ky1:ky2  ), start = kstart(1:knbdim),   &
323            &                                                                       count = kcount(1:knbdim)), clinfo )
324      ELSEIF( PRESENT(pv_r3d) ) THEN
325         CALL iom_nf90_check( NF90_GET_VAR(if90id, ivid, pv_r3d(kx1:kx2,ky1:ky2,:), start = kstart(1:knbdim),   &
326            &                                                                       count = kcount(1:knbdim)), clinfo )
327      ENDIF
328      !
329   END SUBROUTINE iom_nf90_g123d
330
331   !!----------------------------------------------------------------------
332   !!                   INTERFACE iom_nf90_getatt
333   !!----------------------------------------------------------------------
334
335   SUBROUTINE iom_nf90_giatt( kiomid, cdatt, pv_i0d, cdvar)
336      !!-----------------------------------------------------------------------
337      !!                  ***  ROUTINE  iom_nf90_giatt  ***
338      !!
339      !! ** Purpose : read an integer attribute with NF90
340      !!              (either a global attribute (default) or a variable
341      !!               attribute if optional variable name is supplied (cdvar))
342      !!-----------------------------------------------------------------------
343      INTEGER         , INTENT(in   ) ::   kiomid   ! Identifier of the file
344      CHARACTER(len=*), INTENT(in   ) ::   cdatt    ! attribute name
345      INTEGER         , INTENT(  out) ::   pv_i0d   ! read field
346      CHARACTER(len=*), INTENT(in   ), OPTIONAL     &
347                      &               ::   cdvar    ! name of the variable
348      !
349      INTEGER                         ::   if90id   ! temporary integer
350      INTEGER                         ::   ivarid   ! NetCDF variable Id
351      LOGICAL                         ::   llok     ! temporary logical
352      CHARACTER(LEN=100)              ::   clinfo   ! info character
353      !---------------------------------------------------------------------
354      !
355      if90id = iom_file(kiomid)%nfid
356      IF( PRESENT(cdvar) ) THEN
357         ! check the variable exists in the file
358         llok = NF90_INQ_VARID( if90id, TRIM(cdvar), ivarid ) == nf90_noerr
359         IF( llok ) THEN
360            ! check the variable has the attribute required
361            llok = NF90_Inquire_attribute(if90id, ivarid, cdatt) == nf90_noerr
362         ELSE
363            CALL ctl_warn('iom_nf90_getatt: no variable '//cdvar//' found')
364         ENDIF
365      ELSE
366         llok = NF90_Inquire_attribute(if90id, NF90_GLOBAL, cdatt) == nf90_noerr
367         ivarid = NF90_GLOBAL
368      ENDIF
369      !
370      IF( llok) THEN
371         clinfo = 'iom_nf90_getatt, file: '//TRIM(iom_file(kiomid)%name)//', giatt: '//TRIM(cdatt)
372         CALL iom_nf90_check(NF90_GET_ATT(if90id, ivarid, cdatt, values=pv_i0d), clinfo)
373      ELSE
374         CALL ctl_warn('iom_nf90_getatt: no attribute '//cdatt//' found')
375         pv_i0d = -999
376      ENDIF
377      !
378   END SUBROUTINE iom_nf90_giatt
379
380
381   SUBROUTINE iom_nf90_gratt( kiomid, cdatt, pv_r0d, cdvar )
382      !!-----------------------------------------------------------------------
383      !!                  ***  ROUTINE  iom_nf90_gratt  ***
384      !!
385      !! ** Purpose : read a real attribute with NF90
386      !!              (either a global attribute (default) or a variable
387      !!               attribute if optional variable name is supplied (cdvar))
388      !!-----------------------------------------------------------------------
389      INTEGER                   , INTENT(in   ) ::   kiomid   ! Identifier of the file
390      CHARACTER(len=*)          , INTENT(in   ) ::   cdatt    ! attribute name
391      REAL(wp)                  , INTENT(  out) ::   pv_r0d   ! read field
392      CHARACTER(len=*), OPTIONAL, INTENT(in   ) ::   cdvar    ! name of the variable
393      !
394      INTEGER            ::   if90id   ! temporary integer
395      INTEGER            ::   ivarid   ! NetCDF variable Id
396      LOGICAL            ::   llok     ! temporary logical
397      CHARACTER(LEN=100) ::   clinfo   ! info character
398      !---------------------------------------------------------------------
399      !
400      if90id = iom_file(kiomid)%nfid
401      IF( PRESENT(cdvar) ) THEN
402         ! check the variable exists in the file
403         llok = NF90_INQ_VARID( if90id, TRIM(cdvar), ivarid ) == nf90_noerr
404         IF( llok ) THEN
405            ! check the variable has the attribute required
406            llok = NF90_Inquire_attribute(if90id, ivarid, cdatt) == nf90_noerr
407         ELSE
408            CALL ctl_warn('iom_nf90_getatt: no variable '//cdvar//' found')
409         ENDIF
410      ELSE
411         llok = NF90_Inquire_attribute(if90id, NF90_GLOBAL, cdatt) == nf90_noerr
412         ivarid = NF90_GLOBAL
413      ENDIF
414      !
415      IF( llok) THEN
416         clinfo = 'iom_nf90_getatt, file: '//TRIM(iom_file(kiomid)%name)//', gratt: '//TRIM(cdatt)
417         CALL iom_nf90_check(NF90_GET_ATT(if90id, ivarid, cdatt, values=pv_r0d), clinfo)
418      ELSE
419         CALL ctl_warn('iom_nf90_getatt: no attribute '//cdatt//' found')
420         pv_r0d = -999._wp
421      ENDIF
422      !
423   END SUBROUTINE iom_nf90_gratt
424
425
426   SUBROUTINE iom_nf90_gcatt( kiomid, cdatt, pv_c0d, cdvar )
427      !!-----------------------------------------------------------------------
428      !!                  ***  ROUTINE  iom_nf90_gcatt  ***
429      !!
430      !! ** Purpose : read a character attribute with NF90
431      !!              (either a global attribute (default) or a variable
432      !!               attribute if optional variable name is supplied (cdvar))
433      !!-----------------------------------------------------------------------
434      INTEGER                   , INTENT(in   ) ::   kiomid   ! Identifier of the file
435      CHARACTER(len=*)          , INTENT(in   ) ::   cdatt    ! attribute name
436      CHARACTER(len=*)          , INTENT(  out) ::   pv_c0d   ! read field
437      CHARACTER(len=*), OPTIONAL, INTENT(in   ) ::   cdvar    ! name of the variable
438      !
439      INTEGER            ::   if90id   ! temporary integer
440      INTEGER            ::   ivarid   ! NetCDF variable Id
441      LOGICAL            ::   llok     ! temporary logical
442      CHARACTER(LEN=100) ::   clinfo   ! info character
443      !---------------------------------------------------------------------
444      !
445      if90id = iom_file(kiomid)%nfid
446      IF( PRESENT(cdvar) ) THEN
447         ! check the variable exists in the file
448         llok = NF90_INQ_VARID( if90id, TRIM(cdvar), ivarid ) == nf90_noerr
449         IF( llok ) THEN
450            ! check the variable has the attribute required
451            llok = NF90_Inquire_attribute(if90id, ivarid, cdatt) == nf90_noerr
452         ELSE
453            CALL ctl_warn('iom_nf90_getatt: no variable '//cdvar//' found')
454         ENDIF
455      ELSE
456         llok = NF90_Inquire_attribute(if90id, NF90_GLOBAL, cdatt) == nf90_noerr
457         ivarid = NF90_GLOBAL
458      ENDIF
459!
460      IF( llok) THEN
461         clinfo = 'iom_nf90_getatt, file: '//TRIM(iom_file(kiomid)%name)//', gcatt: '//TRIM(cdatt)
462         CALL iom_nf90_check(NF90_GET_ATT(if90id, ivarid, cdatt, values=pv_c0d), clinfo)
463      ELSE
464         CALL ctl_warn('iom_nf90_getatt: no attribute '//cdatt//' found')
465         pv_c0d = '!'
466      ENDIF
467      !
468   END SUBROUTINE iom_nf90_gcatt
469
470
471   !!----------------------------------------------------------------------
472   !!                   INTERFACE iom_nf90_putatt
473   !!----------------------------------------------------------------------
474
475   SUBROUTINE iom_nf90_piatt( kiomid, cdatt, pv_i0d, cdvar)
476      !!-----------------------------------------------------------------------
477      !!                  ***  ROUTINE  iom_nf90_piatt  ***
478      !!
479      !! ** Purpose : write an integer attribute with NF90
480      !!              (either a global attribute (default) or a variable
481      !!               attribute if optional variable name is supplied (cdvar))
482      !!-----------------------------------------------------------------------
483      INTEGER         , INTENT(in   ) ::   kiomid   ! Identifier of the file
484      CHARACTER(len=*), INTENT(in   ) ::   cdatt    ! attribute name
485      INTEGER         , INTENT(in   ) ::   pv_i0d   ! write field
486      CHARACTER(len=*), INTENT(in   ), OPTIONAL     &
487                      &               ::   cdvar    ! name of the variable
488      !
489      INTEGER                         ::   if90id   ! temporary integer
490      INTEGER                         ::   ivarid   ! NetCDF variable Id
491      LOGICAL                         ::   llok     ! temporary logical
492      LOGICAL                         ::   lenddef  ! temporary logical
493      CHARACTER(LEN=100)              ::   clinfo   ! info character
494      !---------------------------------------------------------------------
495      !
496      if90id = iom_file(kiomid)%nfid
497      lenddef = .false.
498      IF( PRESENT(cdvar) ) THEN
499         ! check the variable exists in the file
500         llok = NF90_INQ_VARID( if90id, TRIM(cdvar), ivarid ) == nf90_noerr
501         IF( .NOT. llok ) THEN
502            CALL ctl_warn('iom_nf90_putatt: no variable '//cdvar//' found')
503         ENDIF
504      ELSE
505         llok = .true.
506         ivarid = NF90_GLOBAL
507      ENDIF
508      !
509      IF( llok) THEN
510         clinfo = 'iom_nf90_putatt, file: '//TRIM(iom_file(kiomid)%name)//', piatt: '//TRIM(cdatt)
511         IF( iom_file(kiomid)%irec /= -1 ) THEN   
512            ! trick: irec used to know if the file is in define mode or not
513            ! if it is not then temporarily put it into define mode
514            CALL iom_nf90_check(NF90_REDEF( if90id ), clinfo)
515            lenddef = .true.
516         ENDIF
517         !
518         CALL iom_nf90_check(NF90_PUT_ATT(if90id, ivarid, cdatt, values=pv_i0d), clinfo)
519         !
520         IF( lenddef ) THEN   
521            ! file was in data mode on entry; put it back in that mode
522            CALL iom_nf90_check(NF90_ENDDEF( if90id ), clinfo)
523         ENDIF
524      ELSE
525         CALL ctl_warn('iom_nf90_putatt: no attribute '//cdatt//' written')
526      ENDIF
527      !
528   END SUBROUTINE iom_nf90_piatt
529
530
531   SUBROUTINE iom_nf90_pratt( kiomid, cdatt, pv_r0d, cdvar )
532      !!-----------------------------------------------------------------------
533      !!                  ***  ROUTINE  iom_nf90_pratt  ***
534      !!
535      !! ** Purpose : write a real attribute with NF90
536      !!              (either a global attribute (default) or a variable
537      !!               attribute if optional variable name is supplied (cdvar))
538      !!-----------------------------------------------------------------------
539      INTEGER                   , INTENT(in   ) ::   kiomid   ! Identifier of the file
540      CHARACTER(len=*)          , INTENT(in   ) ::   cdatt    ! attribute name
541      REAL(wp)                  , INTENT(in   ) ::   pv_r0d   ! write field
542      CHARACTER(len=*), OPTIONAL, INTENT(in   ) ::   cdvar    ! name of the variable
543      !
544      INTEGER            ::   if90id   ! temporary integer
545      INTEGER            ::   ivarid   ! NetCDF variable Id
546      LOGICAL            ::   llok     ! temporary logical
547      LOGICAL            ::   lenddef  ! temporary logical
548      CHARACTER(LEN=100) ::   clinfo   ! info character
549      !---------------------------------------------------------------------
550      !
551      if90id = iom_file(kiomid)%nfid
552      lenddef = .false.
553      IF( PRESENT(cdvar) ) THEN
554         ! check the variable exists in the file
555         llok = NF90_INQ_VARID( if90id, TRIM(cdvar), ivarid ) == nf90_noerr
556         IF( .NOT. llok ) THEN
557            CALL ctl_warn('iom_nf90_putatt: no variable '//cdvar//' found')
558         ENDIF
559      ELSE
560         llok = .true.
561         ivarid = NF90_GLOBAL
562      ENDIF
563      !
564      IF( llok) THEN
565         clinfo = 'iom_nf90_putatt, file: '//TRIM(iom_file(kiomid)%name)//', pratt: '//TRIM(cdatt)
566         IF( iom_file(kiomid)%irec /= -1 ) THEN   
567            ! trick: irec used to know if the file is in define mode or not
568            ! if it is not then temporarily put it into define mode
569            CALL iom_nf90_check(NF90_REDEF( if90id ), clinfo)
570            lenddef = .true.
571         ENDIF
572         !
573         CALL iom_nf90_check(NF90_PUT_ATT(if90id, ivarid, cdatt, values=pv_r0d), clinfo)
574         !
575         IF( lenddef ) THEN   
576            ! file was in data mode on entry; put it back in that mode
577            CALL iom_nf90_check(NF90_ENDDEF( if90id ), clinfo)
578         ENDIF
579      ELSE
580         CALL ctl_warn('iom_nf90_putatt: no attribute '//cdatt//' written')
581      ENDIF
582      !
583   END SUBROUTINE iom_nf90_pratt
584
585
586   SUBROUTINE iom_nf90_pcatt( kiomid, cdatt, pv_c0d, cdvar )
587      !!-----------------------------------------------------------------------
588      !!                  ***  ROUTINE  iom_nf90_pcatt  ***
589      !!
590      !! ** Purpose : write a character attribute with NF90
591      !!              (either a global attribute (default) or a variable
592      !!               attribute if optional variable name is supplied (cdvar))
593      !!-----------------------------------------------------------------------
594      INTEGER                   , INTENT(in   ) ::   kiomid   ! Identifier of the file
595      CHARACTER(len=*)          , INTENT(in   ) ::   cdatt    ! attribute name
596      CHARACTER(len=*)          , INTENT(in   ) ::   pv_c0d   ! write field
597      CHARACTER(len=*), OPTIONAL, INTENT(in   ) ::   cdvar    ! name of the variable
598      !
599      INTEGER            ::   if90id   ! temporary integer
600      INTEGER            ::   ivarid   ! NetCDF variable Id
601      LOGICAL            ::   llok     ! temporary logical
602      LOGICAL            ::   lenddef  ! temporary logical
603      CHARACTER(LEN=100) ::   clinfo   ! info character
604      !---------------------------------------------------------------------
605      !
606      if90id = iom_file(kiomid)%nfid
607      lenddef = .false.
608      IF( PRESENT(cdvar) ) THEN
609         ! check the variable exists in the file
610         llok = NF90_INQ_VARID( if90id, TRIM(cdvar), ivarid ) == nf90_noerr
611         IF( .NOT. llok ) THEN
612            CALL ctl_warn('iom_nf90_putatt: no variable '//cdvar//' found')
613         ENDIF
614      ELSE
615         llok = .true.
616         ivarid = NF90_GLOBAL
617      ENDIF
618      !
619      IF( llok) THEN
620         clinfo = 'iom_nf90_putatt, file: '//TRIM(iom_file(kiomid)%name)//', pcatt: '//TRIM(cdatt)
621         IF( iom_file(kiomid)%irec /= -1 ) THEN   
622            ! trick: irec used to know if the file is in define mode or not
623            ! if it is not then temporarily put it into define mode
624            CALL iom_nf90_check(NF90_REDEF( if90id ), clinfo)
625            lenddef = .true.
626         ENDIF
627         !
628         CALL iom_nf90_check(NF90_PUT_ATT(if90id, ivarid, cdatt, values=pv_c0d), clinfo)
629         !
630         IF( lenddef ) THEN   
631            ! file was in data mode on entry; put it back in that mode
632            CALL iom_nf90_check(NF90_ENDDEF( if90id ), clinfo)
633         ENDIF
634      ELSE
635         CALL ctl_warn('iom_nf90_putatt: no attribute '//cdatt//' written')
636      ENDIF
637      !
638   END SUBROUTINE iom_nf90_pcatt
639
640
641   SUBROUTINE iom_nf90_gettime( kiomid, kvid, ptime, cdunits, cdcalendar )
642      !!--------------------------------------------------------------------
643      !!                   ***  SUBROUTINE iom_gettime  ***
644      !!
645      !! ** Purpose : read the time axis kvid in the file with NF90
646      !!--------------------------------------------------------------------
647      INTEGER                   , INTENT(in   ) ::   kiomid     ! file Identifier
648      INTEGER                   , INTENT(in   ) ::   kvid       ! variable id
649      REAL(wp), DIMENSION(:)    , INTENT(  out) ::   ptime      ! the time axis
650      CHARACTER(len=*), OPTIONAL, INTENT(  out) ::   cdunits    ! units attribute
651      CHARACTER(len=*), OPTIONAL, INTENT(  out) ::   cdcalendar ! calendar attribute
652      !
653      CHARACTER(LEN=100) ::   clinfo     ! info character
654      !---------------------------------------------------------------------
655      clinfo = 'iom_nf90_gettime, file: '//TRIM(iom_file(kiomid)%name)//', var: '//TRIM(iom_file(kiomid)%cn_var(kvid))
656      CALL iom_nf90_check(NF90_GET_VAR(iom_file(kiomid)%nfid, iom_file(kiomid)%nvid(kvid), ptime(:),   &
657            &                           start=(/ 1 /), count=(/ iom_file(kiomid)%dimsz(1, kvid) /)), clinfo)
658      IF ( PRESENT(cdunits) ) THEN
659         CALL iom_nf90_check(NF90_GET_ATT(iom_file(kiomid)%nfid, iom_file(kiomid)%nvid(kvid), "units", &
660            &                           values=cdunits), clinfo)
661      ENDIF
662      IF ( PRESENT(cdcalendar) ) THEN
663         CALL iom_nf90_check(NF90_GET_ATT(iom_file(kiomid)%nfid, iom_file(kiomid)%nvid(kvid), "calendar", &
664            &                           values=cdcalendar), clinfo)
665      ENDIF
666      !
667   END SUBROUTINE iom_nf90_gettime
668
669
670   SUBROUTINE iom_nf90_rp0123d( kt, kwrite, kiomid, cdvar , kvid  , ktype,   &
671         &                                  pv_r0d, pv_r1d, pv_r2d, pv_r3d )
672      !!--------------------------------------------------------------------
673      !!                   ***  SUBROUTINE  iom_nf90_rstput  ***
674      !!
675      !! ** Purpose : read the time axis cdvar in the file
676      !!--------------------------------------------------------------------
677      INTEGER                     , INTENT(in)           ::   kt       ! ocean time-step
678      INTEGER                     , INTENT(in)           ::   kwrite   ! writing time-step
679      INTEGER                     , INTENT(in)           ::   kiomid   ! Identifier of the file
680      CHARACTER(len=*)            , INTENT(in)           ::   cdvar    ! variable name
681      INTEGER                     , INTENT(in)           ::   kvid     ! variable id
682      INTEGER                     , INTENT(in), OPTIONAL ::   ktype    ! variable type (default R8)
683      REAL(wp)                    , INTENT(in), OPTIONAL ::   pv_r0d   ! written Od field
684      REAL(wp), DIMENSION(      :), INTENT(in), OPTIONAL ::   pv_r1d   ! written 1d field
685      REAL(wp), DIMENSION(:, :   ), INTENT(in), OPTIONAL ::   pv_r2d   ! written 2d field
686      REAL(wp), DIMENSION(:, :, :), INTENT(in), OPTIONAL ::   pv_r3d   ! written 3d field
687      !
688      INTEGER               :: idims                ! number of dimension
689      INTEGER               :: idvar                ! variable id
690      INTEGER               :: jd                   ! dimension loop counter   
691      INTEGER               :: ix1, ix2, iy1, iy2   ! subdomain indexes   
692      INTEGER, DIMENSION(4) :: idimsz               ! dimensions size 
693      INTEGER, DIMENSION(4) :: idimid               ! dimensions id
694      CHARACTER(LEN=256)    :: clinfo               ! info character
695      CHARACTER(LEN= 12), DIMENSION(4) :: cltmp     ! temporary character
696      INTEGER               :: if90id               ! nf90 file identifier
697      INTEGER               :: idmy                 ! dummy variable
698      INTEGER               :: itype                ! variable type
699      INTEGER, DIMENSION(4) :: ichunksz             ! NetCDF4 chunk sizes. Will be computed using
700      !                                             ! nn_nchunks_[i,j,k,t] namelist parameters
701      INTEGER               :: ichunkalg, ishuffle, ideflate, ideflate_level
702      !                                             ! NetCDF4 internally fixed parameters
703      LOGICAL               :: lchunk               ! logical switch to activate chunking and compression
704      !                                             ! when appropriate (currently chunking is applied to 4d fields only)
705      INTEGER               :: idlv                 ! local variable
706      !---------------------------------------------------------------------
707      !
708      clinfo = '          iom_nf90_rp0123d, file: '//TRIM(iom_file(kiomid)%name)//', var: '//TRIM(cdvar)
709      if90id = iom_file(kiomid)%nfid
710      !
711      ! define dimension variables if it is not already done
712      ! ==========================
713      IF( iom_file(kiomid)%nvars == 0 ) THEN
714         ! are we in define mode?
715         IF( iom_file(kiomid)%irec /= -1 ) THEN   ! trick: irec used to know if the file is in define mode or not
716            CALL iom_nf90_check(NF90_REDEF( if90id ), clinfo)   ;   iom_file(kiomid)%irec = -1
717         ENDIF
718         ! define the dimension variables if it is not already done
719         IF(iom_file(kiomid)%nlev == jpk ) THEN
720          cltmp = (/ 'nav_lon     ', 'nav_lat     ', 'nav_lev     ', 'time_counter' /)
721         ELSE
722          cltmp = (/ 'nav_lon     ', 'nav_lat     ', 'numcat      ', 'time_counter' /)
723         ENDIF
724         CALL iom_nf90_check(NF90_DEF_VAR( if90id, TRIM(cltmp(1)), NF90_FLOAT , (/ 1, 2 /), iom_file(kiomid)%nvid(1) ), clinfo)
725         CALL iom_nf90_check(NF90_DEF_VAR( if90id, TRIM(cltmp(2)), NF90_FLOAT , (/ 1, 2 /), iom_file(kiomid)%nvid(2) ), clinfo)
726         CALL iom_nf90_check(NF90_DEF_VAR( if90id, TRIM(cltmp(3)), NF90_FLOAT , (/ 3    /), iom_file(kiomid)%nvid(3) ), clinfo)
727         CALL iom_nf90_check(NF90_DEF_VAR( if90id, TRIM(cltmp(4)), NF90_DOUBLE, (/ 4    /), iom_file(kiomid)%nvid(4) ), clinfo)
728         ! update informations structure related the dimension variable we just added...
729         iom_file(kiomid)%nvars       = 4
730         iom_file(kiomid)%luld(1:4)   = (/ .FALSE., .FALSE., .FALSE., .TRUE. /)
731         iom_file(kiomid)%cn_var(1:4) = cltmp
732         iom_file(kiomid)%ndims(1:4)  = (/ 2, 2, 1, 1 /) 
733         ! trick: defined to 0 to say that dimension variables are defined but not yet written
734         iom_file(kiomid)%dimsz(1, 1)  = 0   
735         IF(lwp) WRITE(numout,*) TRIM(clinfo)//' define dimension variables done'
736      ENDIF
737      ! define the data if it is not already done
738      ! ===============
739      IF( kvid <= 0 ) THEN
740         !
741         ! NetCDF4 chunking and compression fixed settings
742         ichunkalg = 0
743         ishuffle = 1
744         ideflate = 1
745         ideflate_level = 1
746         !
747         idvar = iom_file(kiomid)%nvars + 1
748         ! are we in define mode?
749         IF( iom_file(kiomid)%irec /= -1 ) THEN   ! trick: irec used to know if the file is in define mode or not
750            CALL iom_nf90_check(NF90_REDEF( if90id ), clinfo)   ;   iom_file(kiomid)%irec = -1
751         ENDIF
752         ! variable definition
753         IF(     PRESENT(pv_r0d) ) THEN   ;   idims = 0
754         ELSEIF( PRESENT(pv_r1d) ) THEN   ;   idims = 2   ;   idimid(1:idims) = (/    3,4/)
755         ELSEIF( PRESENT(pv_r2d) ) THEN   ;   idims = 3   ;   idimid(1:idims) = (/1,2  ,4/)
756         ELSEIF( PRESENT(pv_r3d) ) THEN   ;   idims = 4   ;   idimid(1:idims) = (/1,2,3,4/)
757         ENDIF
758         IF( PRESENT(ktype) ) THEN   ! variable external type
759            SELECT CASE (ktype)
760            CASE (jp_r8)  ;   itype = NF90_DOUBLE
761            CASE (jp_r4)  ;   itype = NF90_FLOAT
762            CASE (jp_i4)  ;   itype = NF90_INT
763            CASE (jp_i2)  ;   itype = NF90_SHORT
764            CASE (jp_i1)  ;   itype = NF90_BYTE
765            CASE DEFAULT   ;   CALL ctl_stop( TRIM(clinfo)//' unknown variable type' )
766            END SELECT
767         ELSE
768            itype = NF90_DOUBLE
769         ENDIF
770         IF( PRESENT(pv_r0d) ) THEN
771            CALL iom_nf90_check(NF90_DEF_VAR( if90id, TRIM(cdvar), itype,                    &
772               &                              iom_file(kiomid)%nvid(idvar) ), clinfo )
773         ELSE
774            CALL iom_nf90_check(NF90_DEF_VAR( if90id, TRIM(cdvar), itype, idimid(1:idims),   &
775               &                              iom_file(kiomid)%nvid(idvar) ), clinfo )
776         ENDIF
777         lchunk = .false.
778         IF( snc4set%luse .AND. idims == 4 )   lchunk = .true.
779         ! update informations structure related the new variable we want to add...
780         iom_file(kiomid)%nvars         = idvar
781         iom_file(kiomid)%cn_var(idvar) = TRIM(cdvar)
782         iom_file(kiomid)%scf(idvar)    = 1.
783         iom_file(kiomid)%ofs(idvar)    = 0.
784         iom_file(kiomid)%ndims(idvar)  = idims
785         IF( .NOT. PRESENT(pv_r0d) ) THEN   ;   iom_file(kiomid)%luld(idvar) = .TRUE.
786         ELSE                               ;   iom_file(kiomid)%luld(idvar) = .FALSE.
787         ENDIF
788         DO jd = 1, idims
789            CALL iom_nf90_check(NF90_INQUIRE_DIMENSION( if90id, idimid(jd), len = iom_file(kiomid)%dimsz(jd,idvar) ), clinfo)
790            IF ( lchunk ) ichunksz(jd) = iom_file(kiomid)%dimsz(jd,idvar)
791         END DO
792         IF ( lchunk ) THEN
793            ! Calculate chunk sizes by partitioning each dimension as requested in namnc4 namelist
794            ! Disallow very small chunk sizes and prevent chunk sizes larger than each individual dimension
795            ichunksz(1) = MIN( ichunksz(1),MAX( (ichunksz(1)-1)/snc4set%ni + 1 ,16 ) ) ! Suggested default nc4set%ni=4
796            ichunksz(2) = MIN( ichunksz(2),MAX( (ichunksz(2)-1)/snc4set%nj + 1 ,16 ) ) ! Suggested default nc4set%nj=2
797            ichunksz(3) = MIN( ichunksz(3),MAX( (ichunksz(3)-1)/snc4set%nk + 1 , 1 ) ) ! Suggested default nc4set%nk=6
798            ichunksz(4) = 1                                                            ! Do not allow chunks to span the
799            !                                                                          ! unlimited dimension
800            CALL iom_nf90_check(SET_NF90_DEF_VAR_CHUNKING(if90id, idvar, ichunkalg, ichunksz), clinfo)
801            CALL iom_nf90_check(SET_NF90_DEF_VAR_DEFLATE(if90id, idvar, ishuffle, ideflate, ideflate_level), clinfo)
802            IF(lwp) WRITE(numout,*) TRIM(clinfo)//' chunked ok. Chunks sizes: ', ichunksz
803         ENDIF
804         IF(lwp) WRITE(numout,*) TRIM(clinfo)//' defined ok'
805      ELSE
806         idvar = kvid
807      ENDIF
808      !
809      ! time step kwrite : write the variable
810      IF( kt == kwrite ) THEN
811         ! are we in write mode?
812         IF( iom_file(kiomid)%irec == -1 ) THEN   ! trick: irec used to know if the file is in define mode or not
813            CALL iom_nf90_check(NF90_ENDDEF( if90id ), clinfo)   ;   iom_file(kiomid)%irec = 0
814         ENDIF
815         ! on what kind of domain must the data be written?
816         IF( PRESENT(pv_r2d) .OR. PRESENT(pv_r3d) ) THEN
817            idimsz(1:2) = iom_file(kiomid)%dimsz(1:2,idvar)
818            IF(     idimsz(1) == (nlei - nldi + 1) .AND. idimsz(2) == (nlej - nldj + 1) ) THEN
819               ix1 = nldi   ;   ix2 = nlei   ;   iy1 = nldj   ;   iy2 = nlej
820            ELSEIF( idimsz(1) == nlci              .AND. idimsz(2) == nlcj              ) THEN
821               ix1 = 1      ;   ix2 = nlci   ;   iy1 = 1      ;   iy2 = nlcj
822            ELSEIF( idimsz(1) == jpi               .AND. idimsz(2) == jpj               ) THEN
823               ix1 = 1      ;   ix2 = jpi    ;   iy1 = 1      ;   iy2 = jpj
824            ELSE
825               CALL ctl_stop( 'iom_nf90_rp0123d: should have been an impossible case...' )
826            ENDIF
827
828            ! write dimension variables if it is not already done
829            ! =============
830            ! trick: is defined to 0 => dimension variable are defined but not yet written
831            IF( iom_file(kiomid)%dimsz(1, 1) == 0 ) THEN
832               CALL iom_nf90_check( NF90_INQ_VARID( if90id, 'nav_lon'     , idmy )         , clinfo )
833               CALL iom_nf90_check( NF90_PUT_VAR  ( if90id, idmy, glamt(ix1:ix2, iy1:iy2) ), clinfo )
834               CALL iom_nf90_check( NF90_INQ_VARID( if90id, 'nav_lat'     , idmy )         , clinfo )
835               CALL iom_nf90_check( NF90_PUT_VAR  ( if90id, idmy, gphit(ix1:ix2, iy1:iy2) ), clinfo )
836               IF(iom_file(kiomid)%nlev == jpk ) THEN 
837                  !NEMO
838                  CALL iom_nf90_check( NF90_INQ_VARID( if90id, 'nav_lev'     , idmy ), clinfo )
839                  CALL iom_nf90_check( NF90_PUT_VAR  ( if90id, idmy, gdept_1d       ), clinfo )
840               ELSE
841                  CALL iom_nf90_check( NF90_INQ_VARID( if90id, 'numcat'     , idmy ), clinfo)
842                  CALL iom_nf90_check( NF90_PUT_VAR  ( if90id, idmy, (/ (idlv, idlv = 1,iom_file(kiomid)%nlev) /)), clinfo )
843               ENDIF
844               ! +++ WRONG VALUE: to be improved but not really useful...
845               CALL iom_nf90_check( NF90_INQ_VARID( if90id, 'time_counter', idmy ), clinfo )
846               CALL iom_nf90_check( NF90_PUT_VAR( if90id, idmy, kt                      ), clinfo )   
847               ! update the values of the variables dimensions size
848               CALL iom_nf90_check( NF90_INQUIRE_DIMENSION( if90id, 1, len = iom_file(kiomid)%dimsz(1,1) ), clinfo )
849               CALL iom_nf90_check( NF90_INQUIRE_DIMENSION( if90id, 2, len = iom_file(kiomid)%dimsz(2,1) ), clinfo )
850               iom_file(kiomid)%dimsz(1:2, 2) = iom_file(kiomid)%dimsz(1:2, 1)
851               CALL iom_nf90_check( NF90_INQUIRE_DIMENSION( if90id, 3, len = iom_file(kiomid)%dimsz(1,3) ), clinfo )
852               iom_file(kiomid)%dimsz(1  , 4) = 1   ! unlimited dimension
853               IF(lwp) WRITE(numout,*) TRIM(clinfo)//' write dimension variables done'
854            ENDIF
855         ENDIF
856
857         ! write the data
858         ! =============
859         IF(     PRESENT(pv_r0d) ) THEN
860            CALL iom_nf90_check( NF90_PUT_VAR( if90id, idvar, pv_r0d                    ), clinfo )
861         ELSEIF( PRESENT(pv_r1d) ) THEN
862            CALL iom_nf90_check( NF90_PUT_VAR( if90id, idvar, pv_r1d(:)                 ), clinfo )
863         ELSEIF( PRESENT(pv_r2d) ) THEN
864            CALL iom_nf90_check( NF90_PUT_VAR( if90id, idvar, pv_r2d(ix1:ix2,iy1:iy2)   ), clinfo )
865         ELSEIF( PRESENT(pv_r3d) ) THEN
866            CALL iom_nf90_check( NF90_PUT_VAR( if90id, idvar, pv_r3d(ix1:ix2,iy1:iy2,:) ), clinfo )
867         ENDIF
868         ! add 1 to the size of the temporal dimension (not really useful...)
869         IF( iom_file(kiomid)%luld(idvar) )   iom_file(kiomid)%dimsz(iom_file(kiomid)%ndims(idvar), idvar)    &
870               &                            = iom_file(kiomid)%dimsz(iom_file(kiomid)%ndims(idvar), idvar) + 1
871         IF(lwp) WRITE(numout,*) TRIM(clinfo)//' written ok'
872      ENDIF
873      !     
874   END SUBROUTINE iom_nf90_rp0123d
875
876
877   SUBROUTINE iom_nf90_check( kstatus, cdinfo )
878      !!--------------------------------------------------------------------
879      !!                   ***  SUBROUTINE iom_nf90_check  ***
880      !!
881      !! ** Purpose :   check nf90 errors
882      !!--------------------------------------------------------------------
883      INTEGER,          INTENT(in) :: kstatus
884      CHARACTER(LEN=*), INTENT(in) :: cdinfo
885      !---------------------------------------------------------------------
886      IF(kstatus /= nf90_noerr)   CALL ctl_stop( 'iom_nf90_check : '//TRIM(nf90_strerror(kstatus)), TRIM(cdinfo) )
887   END SUBROUTINE iom_nf90_check
888
889   !!======================================================================
890END MODULE iom_nf90
Note: See TracBrowser for help on using the repository browser.