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 trunk/NEMOGCM/NEMO/OPA_SRC/IOM – NEMO

source: trunk/NEMOGCM/NEMO/OPA_SRC/IOM/iom.F90 @ 3907

Last change on this file since 3907 was 3907, checked in by smasson, 11 years ago

bugfix on mask sent to iom, see ticket #1103
  • Property svn:keywords set to Id
File size: 67.9 KB
Line 
1MODULE iom
2   !!=====================================================================
3   !!                    ***  MODULE  iom ***
4   !! Input/Output manager :  Library to read input files
5   !!====================================================================
6   !! History :  2.0  ! 2005-12  (J. Belier) Original code
7   !!            2.0  ! 2006-02  (S. Masson) Adaptation to NEMO
8   !!            3.0  ! 2007-07  (D. Storkey) Changes to iom_gettime
9   !!            3.4  ! 2012-12  (R. Bourdalle-Badie and G. Reffray)  add C1D case 
10   !!--------------------------------------------------------------------
11
12   !!--------------------------------------------------------------------
13   !!   iom_open       : open a file read only
14   !!   iom_close      : close a file or all files opened by iom
15   !!   iom_get        : read a field (interfaced to several routines)
16   !!   iom_gettime    : read the time axis cdvar in the file
17   !!   iom_varid      : get the id of a variable in a file
18   !!   iom_rstput     : write a field in a restart file (interfaced to several routines)
19   !!--------------------------------------------------------------------
20   USE dom_oce         ! ocean space and time domain
21   USE c1d             ! 1D vertical configuration
22   USE flo_oce         ! floats module declarations
23   USE lbclnk          ! lateal boundary condition / mpp exchanges
24   USE iom_def         ! iom variables definitions
25   USE iom_ioipsl      ! NetCDF format with IOIPSL library
26   USE iom_nf90        ! NetCDF format with native NetCDF library
27   USE iom_rstdimg     ! restarts access direct format "dimg" style...
28   USE in_out_manager  ! I/O manager
29   USE lib_mpp           ! MPP library
30#if defined key_iomput
31   USE sbc_oce, ONLY :   nn_fsbc         ! ocean space and time domain
32   USE trc_oce, ONLY :   nn_dttrc        !  !: frequency of step on passive tracers
33   USE domngb          ! ocean space and time domain
34   USE phycst          ! physical constants
35   USE dianam          ! build name of file
36   USE xios
37# endif
38
39   IMPLICIT NONE
40   PUBLIC   !   must be public to be able to access iom_def through iom
41   
42#if defined key_iomput
43   LOGICAL, PUBLIC, PARAMETER ::   lk_iomput = .TRUE.        !: iom_put flag
44#else
45   LOGICAL, PUBLIC, PARAMETER ::   lk_iomput = .FALSE.       !: iom_put flag
46#endif
47   PUBLIC iom_init, iom_swap, iom_open, iom_close, iom_setkt, iom_varid, iom_get, iom_gettime, iom_rstput, iom_put
48   PUBLIC iom_getatt
49
50   PRIVATE iom_rp0d, iom_rp1d, iom_rp2d, iom_rp3d
51   PRIVATE iom_g0d, iom_g1d, iom_g2d, iom_g3d, iom_get_123d
52   PRIVATE iom_p1d, iom_p2d, iom_p3d
53#if defined key_iomput
54   PRIVATE iom_set_domain_attr, iom_set_axis_attr, iom_set_field_attr, iom_set_file_attr, iom_set_grid_attr
55   PRIVATE set_grid, set_scalar, set_xmlatt, set_mooring
56# endif
57
58   INTERFACE iom_get
59      MODULE PROCEDURE iom_g0d, iom_g1d, iom_g2d, iom_g3d
60   END INTERFACE
61   INTERFACE iom_getatt
62      MODULE PROCEDURE iom_g0d_intatt
63   END INTERFACE
64   INTERFACE iom_rstput
65      MODULE PROCEDURE iom_rp0d, iom_rp1d, iom_rp2d, iom_rp3d
66   END INTERFACE
67  INTERFACE iom_put
68     MODULE PROCEDURE iom_p0d, iom_p1d, iom_p2d, iom_p3d
69  END INTERFACE
70#if defined key_iomput
71   INTERFACE iom_setkt
72      MODULE PROCEDURE xios_update_calendar
73   END INTERFACE
74# endif
75
76   !!----------------------------------------------------------------------
77   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
78   !! $Id$
79   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
80   !!----------------------------------------------------------------------
81
82CONTAINS
83
84   SUBROUTINE iom_init
85      !!----------------------------------------------------------------------
86      !!                     ***  ROUTINE   ***
87      !!
88      !! ** Purpose :   
89      !!
90      !!----------------------------------------------------------------------
91#if defined key_iomput
92      TYPE(xios_time)   :: dtime    = xios_time(0, 0, 0, 0, 0, 0)
93      CHARACTER(len=19) :: cldate 
94      CHARACTER(len=10) :: clname
95      INTEGER           ::   ji
96      !!----------------------------------------------------------------------
97
98      clname = "nemo"
99      IF( TRIM(Agrif_CFixed()) /= '0' )   clname = TRIM(Agrif_CFixed())//"_"//TRIM(clname)
100      CALL xios_context_initialize(TRIM(clname), mpi_comm_opa)
101      CALL iom_swap
102
103      ! calendar parameters
104      SELECT CASE ( nleapy )        ! Choose calendar for IOIPSL
105      CASE ( 1)   ;   CALL xios_set_context_attr(TRIM(clname), calendar_type= "Gregorian")
106      CASE ( 0)   ;   CALL xios_set_context_attr(TRIM(clname), calendar_type= "NoLeap")
107      CASE (30)   ;   CALL xios_set_context_attr(TRIM(clname), calendar_type= "D360")
108      END SELECT
109      WRITE(cldate,"(i4.4,'-',i2.2,'-',i2.2,' 00:00:00')") nyear,nmonth,nday 
110      CALL xios_set_context_attr(TRIM(clname), start_date=cldate )
111
112      ! horizontal grid definition
113      CALL set_scalar
114      CALL set_grid( "T", glamt, gphit ) 
115      CALL set_grid( "U", glamu, gphiu )
116      CALL set_grid( "V", glamv, gphiv )
117      CALL set_grid( "W", glamt, gphit )
118
119      ! vertical grid definition
120      CALL iom_set_axis_attr( "deptht", gdept_0 )
121      CALL iom_set_axis_attr( "depthu", gdept_0 )
122      CALL iom_set_axis_attr( "depthv", gdept_0 )
123      CALL iom_set_axis_attr( "depthw", gdepw_0 )
124# if defined key_floats
125      CALL iom_set_axis_attr( "nfloat", (ji, ji=1,nfloat) )
126# endif
127     
128      ! automatic definitions of some of the xml attributs
129      CALL set_xmlatt
130
131      ! end file definition
132       dtime%second=rdt
133       CALL xios_set_timestep(dtime)
134       CALL xios_close_context_definition()
135
136       CALL xios_update_calendar(0)
137#endif
138
139   END SUBROUTINE iom_init
140
141
142   SUBROUTINE iom_swap
143      !!---------------------------------------------------------------------
144      !!                   ***  SUBROUTINE  iom_swap  ***
145      !!
146      !! ** Purpose :  swap context between different agrif grid for xmlio_server
147      !!---------------------------------------------------------------------
148#if defined key_iomput
149      TYPE(xios_context) :: nemo_hdl
150
151     IF( TRIM(Agrif_CFixed()) == '0' ) THEN
152        CALL xios_get_handle("nemo",nemo_hdl)
153     ELSE
154        CALL xios_get_handle(TRIM(Agrif_CFixed())//"_nemo",nemo_hdl)
155     ENDIF
156     CALL xios_set_current_context(nemo_hdl)
157
158#endif
159   END SUBROUTINE iom_swap
160
161
162   SUBROUTINE iom_open( cdname, kiomid, ldwrt, kdom, kiolib, ldstop, ldiof )
163      !!---------------------------------------------------------------------
164      !!                   ***  SUBROUTINE  iom_open  ***
165      !!
166      !! ** Purpose :  open an input file (return 0 if not found)
167      !!---------------------------------------------------------------------
168      CHARACTER(len=*), INTENT(in   )           ::   cdname   ! File name
169      INTEGER         , INTENT(  out)           ::   kiomid   ! iom identifier of the opened file
170      LOGICAL         , INTENT(in   ), OPTIONAL ::   ldwrt    ! open in write modeb          (default = .FALSE.)
171      INTEGER         , INTENT(in   ), OPTIONAL ::   kdom     ! Type of domain to be written (default = jpdom_local_noovlap)
172      INTEGER         , INTENT(in   ), OPTIONAL ::   kiolib   ! library used to open the file (default = jpnf90)
173      LOGICAL         , INTENT(in   ), OPTIONAL ::   ldstop   ! stop if open to read a non-existing file (default = .TRUE.)
174      LOGICAL         , INTENT(in   ), OPTIONAL ::   ldiof    ! Interp On the Fly, needed for AGRIF (default = .FALSE.)
175
176      CHARACTER(LEN=100)    ::   clname    ! the name of the file based on cdname [[+clcpu]+clcpu]
177      CHARACTER(LEN=100)    ::   cltmpn    ! tempory name to store clname (in writting mode)
178      CHARACTER(LEN=10)     ::   clsuffix  ! ".nc" or ".dimg"
179      CHARACTER(LEN=15)     ::   clcpu     ! the cpu number (max jpmax_digits digits)
180      CHARACTER(LEN=100)    ::   clinfo    ! info character
181      LOGICAL               ::   llok      ! check the existence
182      LOGICAL               ::   llwrt     ! local definition of ldwrt
183      LOGICAL               ::   llnoov    ! local definition to read overlap
184      LOGICAL               ::   llstop    ! local definition of ldstop
185      LOGICAL               ::   lliof     ! local definition of ldiof
186      INTEGER               ::   iolib     ! library do we use to open the file
187      INTEGER               ::   icnt      ! counter for digits in clcpu (max = jpmax_digits)
188      INTEGER               ::   iln, ils  ! lengths of character
189      INTEGER               ::   idom      ! type of domain
190      INTEGER               ::   istop     !
191      INTEGER, DIMENSION(2,5) ::   idompar ! domain parameters:
192      ! local number of points for x,y dimensions
193      ! position of first local point for x,y dimensions
194      ! position of last local point for x,y dimensions
195      ! start halo size for x,y dimensions
196      ! end halo size for x,y dimensions
197      !---------------------------------------------------------------------
198      ! Initializations and control
199      ! =============
200      kiomid = -1
201      clinfo = '                    iom_open ~~~  '
202      istop = nstop
203      ! if iom_open is called for the first time: initialize iom_file(:)%nfid to 0
204      ! (could be done when defining iom_file in f95 but not in f90)
205      IF( Agrif_Root() ) THEN
206         IF( iom_open_init == 0 ) THEN
207            iom_file(:)%nfid = 0
208            iom_open_init = 1
209         ENDIF
210      ENDIF
211      ! do we read or write the file?
212      IF( PRESENT(ldwrt) ) THEN   ;   llwrt = ldwrt
213      ELSE                        ;   llwrt = .FALSE.
214      ENDIF
215      ! do we call ctl_stop if we try to open a non-existing file in read mode?
216      IF( PRESENT(ldstop) ) THEN   ;   llstop = ldstop
217      ELSE                         ;   llstop = .TRUE.
218      ENDIF
219      ! what library do we use to open the file?
220      IF( PRESENT(kiolib) ) THEN   ;   iolib = kiolib
221      ELSE                         ;   iolib = jpnf90
222      ENDIF
223      ! are we using interpolation on the fly?
224      IF( PRESENT(ldiof) ) THEN   ;   lliof = ldiof
225      ELSE                        ;   lliof = .FALSE.
226      ENDIF
227      ! do we read the overlap
228      ! ugly patch SM+JMM+RB to overwrite global definition in some cases
229      llnoov = (jpni * jpnj ) == jpnij .AND. .NOT. lk_agrif 
230      ! create the file name by added, if needed, TRIM(Agrif_CFixed()) and TRIM(clsuffix)
231      ! =============
232      clname   = trim(cdname)
233      IF ( .NOT. Agrif_Root() .AND. .NOT. lliof ) THEN
234         iln    = INDEX(clname,'/') 
235         cltmpn = clname(1:iln)
236         clname = clname(iln+1:LEN_TRIM(clname))
237         clname=TRIM(cltmpn)//TRIM(Agrif_CFixed())//'_'//TRIM(clname)
238      ENDIF
239      ! which suffix should we use?
240      SELECT CASE (iolib)
241      CASE (jpioipsl ) ;   clsuffix = '.nc'
242      CASE (jpnf90   ) ;   clsuffix = '.nc'
243      CASE (jprstdimg) ;   clsuffix = '.dimg'
244      CASE DEFAULT     ;   clsuffix = ''
245         CALL ctl_stop( TRIM(clinfo), 'accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
246      END SELECT
247      ! Add the suffix if needed
248      iln = LEN_TRIM(clname)
249      ils = LEN_TRIM(clsuffix)
250      IF( iln <= ils .OR. INDEX( TRIM(clname), TRIM(clsuffix), back = .TRUE. ) /= iln - ils + 1 )   &
251         &   clname = TRIM(clname)//TRIM(clsuffix)
252      cltmpn = clname   ! store this name
253      ! try to find if the file to be opened already exist
254      ! =============
255      INQUIRE( FILE = clname, EXIST = llok )
256      IF( .NOT.llok ) THEN
257         ! we try to add the cpu number to the name
258         IF( iolib == jprstdimg ) THEN   ;   WRITE(clcpu,*) narea
259         ELSE                            ;   WRITE(clcpu,*) narea-1
260         ENDIF
261         clcpu  = TRIM(ADJUSTL(clcpu))
262         iln = INDEX(clname,TRIM(clsuffix), back = .TRUE.)
263         clname = clname(1:iln-1)//'_'//TRIM(clcpu)//TRIM(clsuffix)
264         icnt = 0
265         INQUIRE( FILE = clname, EXIST = llok ) 
266         ! we try different formats for the cpu number by adding 0
267         DO WHILE( .NOT.llok .AND. icnt < jpmax_digits )
268            clcpu  = "0"//trim(clcpu)
269            clname = clname(1:iln-1)//'_'//TRIM(clcpu)//TRIM(clsuffix)
270            INQUIRE( FILE = clname, EXIST = llok )
271            icnt = icnt + 1
272         END DO
273      ENDIF
274      IF( llwrt ) THEN
275         ! check the domain definition
276! JMM + SM: ugly patch before getting the new version of lib_mpp)
277!         idom = jpdom_local_noovlap   ! default definition
278         IF( llnoov ) THEN   ;   idom = jpdom_local_noovlap   ! default definition
279         ELSE                ;   idom = jpdom_local_full      ! default definition
280         ENDIF
281         IF( PRESENT(kdom) )   idom = kdom
282         ! create the domain informations
283         ! =============
284         SELECT CASE (idom)
285         CASE (jpdom_local_full)
286            idompar(:,1) = (/ jpi             , jpj              /)
287            idompar(:,2) = (/ nimpp           , njmpp            /)
288            idompar(:,3) = (/ nimpp + jpi - 1 , njmpp + jpj - 1  /)
289            idompar(:,4) = (/ nldi - 1        , nldj - 1         /)
290            idompar(:,5) = (/ jpi - nlei      , jpj - nlej       /)
291         CASE (jpdom_local_noextra)
292            idompar(:,1) = (/ nlci            , nlcj             /)
293            idompar(:,2) = (/ nimpp           , njmpp            /)
294            idompar(:,3) = (/ nimpp + nlci - 1, njmpp + nlcj - 1 /)
295            idompar(:,4) = (/ nldi - 1        , nldj - 1         /)
296            idompar(:,5) = (/ nlci - nlei     , nlcj - nlej      /)
297         CASE (jpdom_local_noovlap)
298            idompar(:,1) = (/ nlei  - nldi + 1, nlej  - nldj + 1 /)
299            idompar(:,2) = (/ nimpp + nldi - 1, njmpp + nldj - 1 /)
300            idompar(:,3) = (/ nimpp + nlei - 1, njmpp + nlej - 1 /)
301            idompar(:,4) = (/ 0               , 0                /)
302            idompar(:,5) = (/ 0               , 0                /)
303         CASE DEFAULT
304            CALL ctl_stop( TRIM(clinfo), 'wrong value of kdom, only jpdom_local* cases are accepted' )
305         END SELECT
306      ENDIF
307      ! Open the NetCDF or RSTDIMG file
308      ! =============
309      ! do we have some free file identifier?
310      IF( MINVAL(iom_file(:)%nfid) /= 0 )   &
311         &   CALL ctl_stop( TRIM(clinfo), 'No more free file identifier', 'increase jpmax_files in iom_def' )
312      ! if no file was found...
313      IF( .NOT. llok ) THEN
314         IF( .NOT. llwrt ) THEN   ! we are in read mode
315            IF( llstop ) THEN   ;   CALL ctl_stop( TRIM(clinfo), 'File '//TRIM(cltmpn)//'* not found' )
316            ELSE                ;   istop = nstop + 1   ! make sure that istop /= nstop so we don't open the file
317            ENDIF
318         ELSE                     ! we are in write mode so we
319            clname = cltmpn       ! get back the file name without the cpu number
320         ENDIF
321      ELSE
322         IF( llwrt .AND. .NOT. ln_clobber ) THEN   ! we stop as we want to write in a new file
323            CALL ctl_stop( TRIM(clinfo), 'We want to write in a new file but '//TRIM(clname)//' already exists...' )
324            istop = nstop + 1                      ! make sure that istop /= nstop so we don't open the file
325         ENDIF
326      ENDIF
327      IF( istop == nstop ) THEN   ! no error within this routine
328         SELECT CASE (iolib)
329         CASE (jpioipsl )   ;   CALL iom_ioipsl_open(  clname, kiomid, llwrt, llok, idompar )
330         CASE (jpnf90   )   ;   CALL iom_nf90_open(    clname, kiomid, llwrt, llok, idompar )
331         CASE (jprstdimg)   ;   CALL iom_rstdimg_open( clname, kiomid, llwrt, llok, idompar )
332         CASE DEFAULT
333            CALL ctl_stop( TRIM(clinfo)//' accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
334         END SELECT
335      ENDIF
336      !
337   END SUBROUTINE iom_open
338
339
340   SUBROUTINE iom_close( kiomid )
341      !!--------------------------------------------------------------------
342      !!                   ***  SUBROUTINE  iom_close  ***
343      !!
344      !! ** Purpose : close an input file, or all files opened by iom
345      !!--------------------------------------------------------------------
346      INTEGER, INTENT(inout), OPTIONAL ::   kiomid   ! iom identifier of the file to be closed
347      !                                              ! return 0 when file is properly closed
348      !                                              ! No argument: all files opened by iom are closed
349
350      INTEGER ::   jf         ! dummy loop indices
351      INTEGER ::   i_s, i_e   ! temporary integer
352      CHARACTER(LEN=100)    ::   clinfo    ! info character
353      !---------------------------------------------------------------------
354      !
355      clinfo = '                    iom_close ~~~  '
356      IF( PRESENT(kiomid) ) THEN
357         i_s = kiomid
358         i_e = kiomid
359      ELSE
360         i_s = 1
361         i_e = jpmax_files
362      ENDIF
363
364      IF( i_s > 0 ) THEN
365         DO jf = i_s, i_e
366            IF( iom_file(jf)%nfid > 0 ) THEN
367               SELECT CASE (iom_file(jf)%iolib)
368               CASE (jpioipsl )   ;   CALL iom_ioipsl_close(  jf )
369               CASE (jpnf90   )   ;   CALL iom_nf90_close(    jf )
370               CASE (jprstdimg)   ;   CALL iom_rstdimg_close( jf )
371               CASE DEFAULT
372                  CALL ctl_stop( TRIM(clinfo)//' accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
373               END SELECT
374               iom_file(jf)%nfid       = 0          ! free the id
375               IF( PRESENT(kiomid) )   kiomid = 0   ! return 0 as id to specify that the file was closed
376               IF(lwp) WRITE(numout,*) TRIM(clinfo)//' close file: '//TRIM(iom_file(jf)%name)//' ok'
377            ELSEIF( PRESENT(kiomid) ) THEN
378               WRITE(ctmp1,*) '--->',  kiomid
379               CALL ctl_stop( TRIM(clinfo)//' Invalid file identifier', ctmp1 )
380            ENDIF
381         END DO
382      ENDIF
383      !   
384   END SUBROUTINE iom_close
385
386
387   FUNCTION iom_varid ( kiomid, cdvar, kdimsz, ldstop ) 
388      !!-----------------------------------------------------------------------
389      !!                  ***  FUNCTION  iom_varid  ***
390      !!
391      !! ** Purpose : get the id of a variable in a file (return 0 if not found)
392      !!-----------------------------------------------------------------------
393      INTEGER              , INTENT(in   )           ::   kiomid   ! file Identifier
394      CHARACTER(len=*)     , INTENT(in   )           ::   cdvar    ! name of the variable
395      INTEGER, DIMENSION(:), INTENT(  out), OPTIONAL ::   kdimsz   ! size of the dimensions
396      LOGICAL              , INTENT(in   ), OPTIONAL ::   ldstop   ! stop if looking for non-existing variable (default = .TRUE.)
397      !
398      INTEGER                        ::   iom_varid, iiv, i_nvd
399      LOGICAL                        ::   ll_fnd
400      CHARACTER(LEN=100)             ::   clinfo                   ! info character
401      LOGICAL                        ::   llstop                   ! local definition of ldstop
402      !!-----------------------------------------------------------------------
403      iom_varid = 0                         ! default definition
404      ! do we call ctl_stop if we look for non-existing variable?
405      IF( PRESENT(ldstop) ) THEN   ;   llstop = ldstop
406      ELSE                         ;   llstop = .TRUE.
407      ENDIF
408      !
409      IF( kiomid > 0 ) THEN
410         clinfo = 'iom_varid, file: '//trim(iom_file(kiomid)%name)//', var: '//trim(cdvar)
411         IF( iom_file(kiomid)%nfid == 0 ) THEN
412            CALL ctl_stop( trim(clinfo), 'the file is not open' )
413         ELSE
414            ll_fnd  = .FALSE.
415            iiv = 0
416            !
417            DO WHILE ( .NOT.ll_fnd .AND. iiv < iom_file(kiomid)%nvars )
418               iiv = iiv + 1
419               ll_fnd  = ( TRIM(cdvar) == TRIM(iom_file(kiomid)%cn_var(iiv)) )
420            END DO
421            !
422            IF( .NOT.ll_fnd ) THEN
423               iiv = iiv + 1
424               IF( iiv <= jpmax_vars ) THEN
425                  SELECT CASE (iom_file(kiomid)%iolib)
426                  CASE (jpioipsl )   ;   iom_varid = iom_ioipsl_varid( kiomid, cdvar, iiv, kdimsz )
427                  CASE (jpnf90   )   ;   iom_varid = iom_nf90_varid  ( kiomid, cdvar, iiv, kdimsz )
428                  CASE (jprstdimg)   ;   iom_varid = -1   ! all variables are listed in iom_file
429                  CASE DEFAULT   
430                     CALL ctl_stop( TRIM(clinfo)//' accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
431                  END SELECT
432               ELSE
433                  CALL ctl_stop( trim(clinfo), 'Too many variables in the file '//iom_file(kiomid)%name,   &
434                        &                         'increase the parameter jpmax_vars')
435               ENDIF
436               IF( llstop .AND. iom_varid == -1 )   CALL ctl_stop( TRIM(clinfo)//' not found' ) 
437            ELSE
438               iom_varid = iiv
439               IF( PRESENT(kdimsz) ) THEN
440                  i_nvd = iom_file(kiomid)%ndims(iiv)
441                  IF( i_nvd == size(kdimsz) ) THEN
442                     kdimsz(:) = iom_file(kiomid)%dimsz(1:i_nvd,iiv)
443                  ELSE
444                     WRITE(ctmp1,*) i_nvd, size(kdimsz)
445                     CALL ctl_stop( trim(clinfo), 'error in kdimsz size'//trim(ctmp1) )
446                  ENDIF
447               ENDIF
448            ENDIF
449         ENDIF
450      ENDIF
451      !
452   END FUNCTION iom_varid
453
454
455   !!----------------------------------------------------------------------
456   !!                   INTERFACE iom_get
457   !!----------------------------------------------------------------------
458   SUBROUTINE iom_g0d( kiomid, cdvar, pvar )
459      INTEGER         , INTENT(in   )                 ::   kiomid    ! Identifier of the file
460      CHARACTER(len=*), INTENT(in   )                 ::   cdvar     ! Name of the variable
461      REAL(wp)        , INTENT(  out)                 ::   pvar      ! read field
462      !
463      INTEGER               :: idvar   ! variable id
464      !
465      IF( kiomid > 0 ) THEN
466         idvar = iom_varid( kiomid, cdvar )
467         IF( iom_file(kiomid)%nfid > 0 .AND. idvar > 0 ) THEN
468            SELECT CASE (iom_file(kiomid)%iolib)
469            CASE (jpioipsl )   ;   CALL iom_ioipsl_get(  kiomid, idvar, pvar )
470            CASE (jpnf90   )   ;   CALL iom_nf90_get(    kiomid, idvar, pvar )
471            CASE (jprstdimg)   ;   CALL iom_rstdimg_get( kiomid, idvar, pvar )
472            CASE DEFAULT   
473               CALL ctl_stop( 'iom_g0d: accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
474            END SELECT
475         ENDIF
476      ENDIF
477   END SUBROUTINE iom_g0d
478
479   SUBROUTINE iom_g1d( kiomid, kdom, cdvar, pvar, ktime, kstart, kcount )
480      INTEGER         , INTENT(in   )                         ::   kiomid    ! Identifier of the file
481      INTEGER         , INTENT(in   )                         ::   kdom      ! Type of domain to be read
482      CHARACTER(len=*), INTENT(in   )                         ::   cdvar     ! Name of the variable
483      REAL(wp)        , INTENT(  out), DIMENSION(:)           ::   pvar      ! read field
484      INTEGER         , INTENT(in   )              , OPTIONAL ::   ktime     ! record number
485      INTEGER         , INTENT(in   ), DIMENSION(1), OPTIONAL ::   kstart    ! start axis position of the reading
486      INTEGER         , INTENT(in   ), DIMENSION(1), OPTIONAL ::   kcount    ! number of points in each axis
487      !
488      IF( kiomid > 0 ) THEN
489         IF( iom_file(kiomid)%nfid > 0 ) CALL iom_get_123d( kiomid, kdom       , cdvar        , pv_r1d=pvar,   &
490              &                                                     ktime=ktime, kstart=kstart, kcount=kcount )
491      ENDIF
492   END SUBROUTINE iom_g1d
493
494   SUBROUTINE iom_g2d( kiomid, kdom, cdvar, pvar, ktime, kstart, kcount )
495      INTEGER         , INTENT(in   )                           ::   kiomid    ! Identifier of the file
496      INTEGER         , INTENT(in   )                           ::   kdom      ! Type of domain to be read
497      CHARACTER(len=*), INTENT(in   )                           ::   cdvar     ! Name of the variable
498      REAL(wp)        , INTENT(  out), DIMENSION(:,:)           ::   pvar      ! read field
499      INTEGER         , INTENT(in   )                , OPTIONAL ::   ktime     ! record number
500      INTEGER         , INTENT(in   ), DIMENSION(2)  , OPTIONAL ::   kstart    ! start axis position of the reading
501      INTEGER         , INTENT(in   ), DIMENSION(2)  , OPTIONAL ::   kcount    ! number of points in each axis
502      !
503      IF( kiomid > 0 ) THEN
504         IF( iom_file(kiomid)%nfid > 0 ) CALL iom_get_123d( kiomid, kdom       , cdvar        , pv_r2d=pvar,   &
505              &                                                     ktime=ktime, kstart=kstart, kcount=kcount )
506      ENDIF
507   END SUBROUTINE iom_g2d
508
509   SUBROUTINE iom_g3d( kiomid, kdom, cdvar, pvar, ktime, kstart, kcount )
510      INTEGER         , INTENT(in   )                             ::   kiomid    ! Identifier of the file
511      INTEGER         , INTENT(in   )                             ::   kdom      ! Type of domain to be read
512      CHARACTER(len=*), INTENT(in   )                             ::   cdvar     ! Name of the variable
513      REAL(wp)        , INTENT(  out), DIMENSION(:,:,:)           ::   pvar      ! read field
514      INTEGER         , INTENT(in   )                  , OPTIONAL ::   ktime     ! record number
515      INTEGER         , INTENT(in   ), DIMENSION(3)    , OPTIONAL ::   kstart    ! start axis position of the reading
516      INTEGER         , INTENT(in   ), DIMENSION(3)    , OPTIONAL ::   kcount    ! number of points in each axis
517      !
518      IF( kiomid > 0 ) THEN
519         IF( iom_file(kiomid)%nfid > 0 ) CALL iom_get_123d( kiomid, kdom       , cdvar        , pv_r3d=pvar,   &
520              &                                                     ktime=ktime, kstart=kstart, kcount=kcount )
521      ENDIF
522   END SUBROUTINE iom_g3d
523   !!----------------------------------------------------------------------
524
525   SUBROUTINE iom_get_123d( kiomid, kdom  , cdvar ,   &
526         &                  pv_r1d, pv_r2d, pv_r3d,   &
527         &                  ktime , kstart, kcount  )
528      !!-----------------------------------------------------------------------
529      !!                  ***  ROUTINE  iom_get_123d  ***
530      !!
531      !! ** Purpose : read a 1D/2D/3D variable
532      !!
533      !! ** Method : read ONE record at each CALL
534      !!-----------------------------------------------------------------------
535      INTEGER                    , INTENT(in   )           ::   kiomid     ! Identifier of the file
536      INTEGER                    , INTENT(in   )           ::   kdom       ! Type of domain to be read
537      CHARACTER(len=*)           , INTENT(in   )           ::   cdvar      ! Name of the variable
538      REAL(wp), DIMENSION(:)     , INTENT(  out), OPTIONAL ::   pv_r1d     ! read field (1D case)
539      REAL(wp), DIMENSION(:,:)   , INTENT(  out), OPTIONAL ::   pv_r2d     ! read field (2D case)
540      REAL(wp), DIMENSION(:,:,:) , INTENT(  out), OPTIONAL ::   pv_r3d     ! read field (3D case)
541      INTEGER                    , INTENT(in   ), OPTIONAL ::   ktime      ! record number
542      INTEGER , DIMENSION(:)     , INTENT(in   ), OPTIONAL ::   kstart     ! start position of the reading in each axis
543      INTEGER , DIMENSION(:)     , INTENT(in   ), OPTIONAL ::   kcount     ! number of points to be read in each axis
544      !
545      LOGICAL                        ::   llnoov      ! local definition to read overlap
546      INTEGER                        ::   jl          ! loop on number of dimension
547      INTEGER                        ::   idom        ! type of domain
548      INTEGER                        ::   idvar       ! id of the variable
549      INTEGER                        ::   inbdim      ! number of dimensions of the variable
550      INTEGER                        ::   idmspc      ! number of spatial dimensions
551      INTEGER                        ::   itime       ! record number
552      INTEGER                        ::   istop       ! temporary value of nstop
553      INTEGER                        ::   ix1, ix2, iy1, iy2   ! subdomain indexes
554      INTEGER                        ::   ji, jj      ! loop counters
555      INTEGER                        ::   irankpv       !
556      INTEGER                        ::   ind1, ind2  ! substring index
557      INTEGER, DIMENSION(jpmax_dims) ::   istart      ! starting point to read for each axis
558      INTEGER, DIMENSION(jpmax_dims) ::   icnt        ! number of value to read along each axis
559      INTEGER, DIMENSION(jpmax_dims) ::   idimsz      ! size of the dimensions of the variable
560      INTEGER, DIMENSION(jpmax_dims) ::   ishape      ! size of the dimensions of the variable
561      REAL(wp)                       ::   zscf, zofs  ! sacle_factor and add_offset
562      INTEGER                        ::   itmp        ! temporary integer
563      CHARACTER(LEN=100)             ::   clinfo      ! info character
564      CHARACTER(LEN=100)             ::   clname      ! file name
565      CHARACTER(LEN=1)               ::   clrankpv, cldmspc      !
566      !---------------------------------------------------------------------
567      !
568      clname = iom_file(kiomid)%name   !   esier to read
569      clinfo = '          iom_get_123d, file: '//trim(clname)//', var: '//trim(cdvar)
570      ! local definition of the domain ?
571      idom = kdom
572      ! do we read the overlap
573      ! ugly patch SM+JMM+RB to overwrite global definition in some cases
574      llnoov = (jpni * jpnj ) == jpnij .AND. .NOT. lk_agrif 
575      ! check kcount and kstart optionals parameters...
576      IF( PRESENT(kcount) .AND. (.NOT. PRESENT(kstart)) ) CALL ctl_stop(trim(clinfo), 'kcount present needs kstart present')
577      IF( PRESENT(kstart) .AND. (.NOT. PRESENT(kcount)) ) CALL ctl_stop(trim(clinfo), 'kstart present needs kcount present')
578      IF( PRESENT(kstart) .AND. idom /= jpdom_unknown   ) CALL ctl_stop(trim(clinfo), 'kstart present needs kdom = jpdom_unknown')
579
580      ! Search for the variable in the data base (eventually actualize data)
581      istop = nstop
582      idvar = iom_varid( kiomid, cdvar )
583      !
584      IF( idvar > 0 ) THEN
585         ! to write iom_file(kiomid)%dimsz in a shorter way !
586         idimsz(:) = iom_file(kiomid)%dimsz(:, idvar) 
587         inbdim = iom_file(kiomid)%ndims(idvar)            ! number of dimensions in the file
588         idmspc = inbdim                                   ! number of spatial dimensions in the file
589         IF( iom_file(kiomid)%luld(idvar) )   idmspc = inbdim - 1
590         IF( idmspc > 3 )   CALL ctl_stop(trim(clinfo), 'the file has more than 3 spatial dimensions this case is not coded...') 
591         !
592         ! update idom definition...
593         ! Identify the domain in case of jpdom_auto(glo/dta) definition
594         IF( idom == jpdom_autoglo .OR. idom == jpdom_autodta ) THEN           
595            IF( idom == jpdom_autoglo ) THEN   ;   idom = jpdom_global 
596            ELSE                               ;   idom = jpdom_data
597            ENDIF
598            ind1 = INDEX( clname, '_', back = .TRUE. ) + 1
599            ind2 = INDEX( clname, '.', back = .TRUE. ) - 1
600            IF( ind2 > ind1 ) THEN   ;   IF( VERIFY( clname(ind1:ind2), '0123456789' ) == 0 )   idom = jpdom_local   ;   ENDIF
601         ENDIF
602         ! Identify the domain in case of jpdom_local definition
603         IF( idom == jpdom_local ) THEN
604            IF(     idimsz(1) == jpi               .AND. idimsz(2) == jpj               ) THEN   ;   idom = jpdom_local_full
605            ELSEIF( idimsz(1) == nlci              .AND. idimsz(2) == nlcj              ) THEN   ;   idom = jpdom_local_noextra
606            ELSEIF( idimsz(1) == (nlei - nldi + 1) .AND. idimsz(2) == (nlej - nldj + 1) ) THEN   ;   idom = jpdom_local_noovlap
607            ELSE   ;   CALL ctl_stop( trim(clinfo), 'impossible to identify the local domain' )
608            ENDIF
609         ENDIF
610         !
611         ! check the consistency between input array and data rank in the file
612         !
613         ! initializations
614         itime = 1
615         IF( PRESENT(ktime) ) itime = ktime
616
617         irankpv = 1 * COUNT( (/PRESENT(pv_r1d)/) ) + 2 * COUNT( (/PRESENT(pv_r2d)/) ) + 3 * COUNT( (/PRESENT(pv_r3d)/) )
618         WRITE(clrankpv, fmt='(i1)') irankpv
619         WRITE(cldmspc , fmt='(i1)') idmspc
620         !
621         IF(     idmspc <  irankpv ) THEN
622            CALL ctl_stop( TRIM(clinfo), 'The file has only '//cldmspc//' spatial dimension',   &
623               &                         'it is impossible to read a '//clrankpv//'D array from this file...' )
624         ELSEIF( idmspc == irankpv ) THEN
625            IF( PRESENT(pv_r1d) .AND. idom /= jpdom_unknown )   &
626               &   CALL ctl_stop( TRIM(clinfo), 'case not coded...You must use jpdom_unknown' )
627         ELSEIF( idmspc >  irankpv ) THEN
628               IF( PRESENT(pv_r2d) .AND. itime == 1 .AND. idimsz(3) == 1 .AND. idmspc == 3 ) THEN
629                  CALL ctl_warn( trim(clinfo), '2D array but 3 spatial dimensions for the data...'              ,   &
630                        &         'As the size of the z dimension is 1 and as we try to read the first record, ',   &
631                        &         'we accept this case, even if there is a possible mix-up between z and time dimension' )   
632                  idmspc = idmspc - 1
633               ELSE
634                  CALL ctl_stop( TRIM(clinfo), 'To keep iom lisibility, when reading a '//clrankpv//'D array,'         ,   &
635                     &                         'we do not accept data with more than '//cldmspc//' spatial dimension',   &
636                     &                         'Use ncwa -a to suppress the unnecessary dimensions' )
637               ENDIF
638         ENDIF
639
640         !
641         ! definition of istart and icnt
642         !
643         icnt  (:) = 1
644         istart(:) = 1
645         istart(idmspc+1) = itime
646
647         IF(              PRESENT(kstart)       ) THEN ; istart(1:idmspc) = kstart(1:idmspc) ; icnt(1:idmspc) = kcount(1:idmspc)
648         ELSE
649            IF(           idom == jpdom_unknown ) THEN                                       ; icnt(1:idmspc) = idimsz(1:idmspc)
650            ELSE
651               IF( .NOT. PRESENT(pv_r1d) ) THEN   !   not a 1D array
652                  IF(     idom == jpdom_data    ) THEN ; istart(1:2) = (/ mig(1), mjg(1) /)  ! icnt(1:2) done bellow
653                  ELSEIF( idom == jpdom_global  ) THEN ; istart(1:2) = (/ nimpp , njmpp  /)  ! icnt(1:2) done bellow
654                  ENDIF
655                  ! we do not read the overlap                     -> we start to read at nldi, nldj
656! JMM + SM: ugly patch before getting the new version of lib_mpp)
657!                  IF( idom /= jpdom_local_noovlap )   istart(1:2) = istart(1:2) + (/ nldi - 1, nldj - 1 /)
658                  IF( llnoov .AND. idom /= jpdom_local_noovlap ) istart(1:2) = istart(1:2) + (/ nldi - 1, nldj - 1 /)
659                  ! we do not read the overlap and the extra-halos -> from nldi to nlei and from nldj to nlej
660! JMM + SM: ugly patch before getting the new version of lib_mpp)
661!                  icnt(1:2) = (/ nlei - nldi + 1, nlej - nldj + 1 /)
662                  IF( llnoov ) THEN   ;   icnt(1:2) = (/ nlei - nldi + 1, nlej - nldj + 1 /)
663                  ELSE                ;   icnt(1:2) = (/ nlci           , nlcj            /)
664                  ENDIF
665                  IF( PRESENT(pv_r3d) ) THEN
666                     IF( idom == jpdom_data ) THEN   ; icnt(3) = jpkdta
667                     ELSE                            ; icnt(3) = jpk
668                     ENDIF
669                  ENDIF
670               ENDIF
671            ENDIF
672         ENDIF
673
674         ! check that istart and icnt can be used with this file
675         !-
676         DO jl = 1, jpmax_dims
677            itmp = istart(jl)+icnt(jl)-1
678            IF( itmp > idimsz(jl) .AND. idimsz(jl) /= 0 ) THEN
679               WRITE( ctmp1, FMT="('(istart(', i1, ') + icnt(', i1, ') - 1) = ', i5)" ) jl, jl, itmp
680               WRITE( ctmp2, FMT="(' is larger than idimsz(', i1,') = ', i5)"         ) jl, idimsz(jl)
681               CALL ctl_stop( trim(clinfo), 'start and count too big regarding to the size of the data, ', ctmp1, ctmp2 )     
682            ENDIF
683         END DO
684
685         ! check that icnt matches the input array
686         !-     
687         IF( idom == jpdom_unknown ) THEN
688            IF( irankpv == 1 )        ishape(1:1) = SHAPE(pv_r1d)
689            IF( irankpv == 2 )        ishape(1:2) = SHAPE(pv_r2d)
690            IF( irankpv == 3 )        ishape(1:3) = SHAPE(pv_r3d)
691            ctmp1 = 'd'
692         ELSE
693            IF( irankpv == 2 ) THEN
694! JMM + SM: ugly patch before getting the new version of lib_mpp)
695!               ishape(1:2) = SHAPE(pv_r2d(nldi:nlei,nldj:nlej  ))   ;   ctmp1 = 'd(nldi:nlei,nldj:nlej)'
696               IF( llnoov ) THEN ; ishape(1:2)=SHAPE(pv_r2d(nldi:nlei,nldj:nlej  )) ; ctmp1='d(nldi:nlei,nldj:nlej)'
697               ELSE              ; ishape(1:2)=SHAPE(pv_r2d(1   :nlci,1   :nlcj  )) ; ctmp1='d(1:nlci,1:nlcj)'
698               ENDIF
699            ENDIF
700            IF( irankpv == 3 ) THEN 
701! JMM + SM: ugly patch before getting the new version of lib_mpp)
702!               ishape(1:3) = SHAPE(pv_r3d(nldi:nlei,nldj:nlej,:))   ;   ctmp1 = 'd(nldi:nlei,nldj:nlej,:)'
703               IF( llnoov ) THEN ; ishape(1:3)=SHAPE(pv_r3d(nldi:nlei,nldj:nlej,:)) ; ctmp1='d(nldi:nlei,nldj:nlej,:)'
704               ELSE              ; ishape(1:3)=SHAPE(pv_r3d(1   :nlci,1   :nlcj,:)) ; ctmp1='d(1:nlci,1:nlcj,:)'
705               ENDIF
706            ENDIF
707         ENDIF
708         
709         DO jl = 1, irankpv
710            WRITE( ctmp2, FMT="(', ', i1,'): ', i5,' /= icnt(', i1,'):', i5)" ) jl, ishape(jl), jl, icnt(jl)
711            IF( ishape(jl) /= icnt(jl) )   CALL ctl_stop( TRIM(clinfo), 'size(pv_r'//clrankpv//TRIM(ctmp1)//TRIM(ctmp2) )
712         END DO
713
714      ENDIF
715
716      ! read the data
717      !-     
718      IF( idvar > 0 .AND. istop == nstop ) THEN   ! no additional errors until this point...
719         !
720         ! find the right index of the array to be read
721! JMM + SM: ugly patch before getting the new version of lib_mpp)
722!         IF( idom /= jpdom_unknown ) THEN   ;   ix1 = nldi   ;   ix2 = nlei      ;   iy1 = nldj   ;   iy2 = nlej
723!         ELSE                               ;   ix1 = 1      ;   ix2 = icnt(1)   ;   iy1 = 1      ;   iy2 = icnt(2)
724!         ENDIF
725         IF( llnoov ) THEN
726            IF( idom /= jpdom_unknown ) THEN   ;   ix1 = nldi   ;   ix2 = nlei      ;   iy1 = nldj   ;   iy2 = nlej
727            ELSE                               ;   ix1 = 1      ;   ix2 = icnt(1)   ;   iy1 = 1      ;   iy2 = icnt(2)
728            ENDIF
729         ELSE
730            IF( idom /= jpdom_unknown ) THEN   ;   ix1 = 1      ;   ix2 = nlci      ;   iy1 = 1      ;   iy2 = nlcj
731            ELSE                               ;   ix1 = 1      ;   ix2 = icnt(1)   ;   iy1 = 1      ;   iy2 = icnt(2)
732            ENDIF
733         ENDIF
734     
735         SELECT CASE (iom_file(kiomid)%iolib)
736         CASE (jpioipsl )   ;   CALL iom_ioipsl_get(  kiomid, idvar, inbdim, istart, icnt, ix1, ix2, iy1, iy2,   &
737            &                                         pv_r1d, pv_r2d, pv_r3d )
738         CASE (jpnf90   )   ;   CALL iom_nf90_get(    kiomid, idvar, inbdim, istart, icnt, ix1, ix2, iy1, iy2,   &
739            &                                         pv_r1d, pv_r2d, pv_r3d )
740         CASE (jprstdimg)   ;   CALL iom_rstdimg_get( kiomid, idom, idvar, ix1, ix2, iy1, iy2,   &
741            &                                         pv_r1d, pv_r2d, pv_r3d )
742         CASE DEFAULT   
743            CALL ctl_stop( TRIM(clinfo)//' accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
744         END SELECT
745
746         IF( istop == nstop ) THEN   ! no additional errors until this point...
747            IF(lwp) WRITE(numout,"(10x,' read ',a,' (rec: ',i4,') in ',a,' ok')") TRIM(cdvar), itime, TRIM(iom_file(kiomid)%name)
748         
749            !--- overlap areas and extra hallows (mpp)
750            IF(     PRESENT(pv_r2d) .AND. idom /= jpdom_unknown ) THEN
751               CALL lbc_lnk( pv_r2d,'Z',-999.,'no0' )
752            ELSEIF( PRESENT(pv_r3d) .AND. idom /= jpdom_unknown ) THEN
753               ! this if could be simplified with the new lbc_lnk that works with any size of the 3rd dimension
754               IF( icnt(3) == jpk ) THEN
755                  CALL lbc_lnk( pv_r3d,'Z',-999.,'no0' )
756               ELSE   ! put some arbitrary value (a call to lbc_lnk will be done later...)
757                  DO jj = nlcj+1, jpj   ;   pv_r3d(1:nlci, jj, :) = pv_r3d(1:nlci, nlej, :)   ;   END DO
758                  DO ji = nlci+1, jpi   ;   pv_r3d(ji    , : , :) = pv_r3d(nlei  , :   , :)   ;   END DO
759               ENDIF
760            ENDIF
761           
762            ! C1D case : always call lbc_lnk to replicate the central value over the whole 3X3 domain
763            IF( lk_c1d .AND. PRESENT(pv_r2d) )   CALL lbc_lnk( pv_r2d,'Z',1. )
764            IF( lk_c1d .AND. PRESENT(pv_r3d) )   CALL lbc_lnk( pv_r3d,'Z',1. )
765   
766            !--- Apply scale_factor and offset
767            zscf = iom_file(kiomid)%scf(idvar)      ! scale factor
768            zofs = iom_file(kiomid)%ofs(idvar)      ! offset
769            IF(     PRESENT(pv_r1d) ) THEN
770               IF( zscf /= 1. )   pv_r1d(:) = pv_r1d(:) * zscf 
771               IF( zofs /= 0. )   pv_r1d(:) = pv_r1d(:) + zofs
772            ELSEIF( PRESENT(pv_r2d) ) THEN
773!CDIR COLLAPSE
774               IF( zscf /= 1.)   pv_r2d(:,:) = pv_r2d(:,:) * zscf
775!CDIR COLLAPSE
776               IF( zofs /= 0.)   pv_r2d(:,:) = pv_r2d(:,:) + zofs
777            ELSEIF( PRESENT(pv_r3d) ) THEN
778!CDIR COLLAPSE
779               IF( zscf /= 1.)   pv_r3d(:,:,:) = pv_r3d(:,:,:) * zscf
780!CDIR COLLAPSE
781               IF( zofs /= 0.)   pv_r3d(:,:,:) = pv_r3d(:,:,:) + zofs
782            ENDIF
783            !
784         ENDIF
785         !
786      ENDIF
787      !
788   END SUBROUTINE iom_get_123d
789
790
791   SUBROUTINE iom_gettime( kiomid, ptime, cdvar, kntime, cdunits, cdcalendar )
792      !!--------------------------------------------------------------------
793      !!                   ***  SUBROUTINE iom_gettime  ***
794      !!
795      !! ** Purpose : read the time axis cdvar in the file
796      !!--------------------------------------------------------------------
797      INTEGER                    , INTENT(in   ) ::   kiomid     ! file Identifier
798      REAL(wp), DIMENSION(:)     , INTENT(  out) ::   ptime      ! the time axis
799      CHARACTER(len=*), OPTIONAL , INTENT(in   ) ::   cdvar      ! time axis name
800      INTEGER         , OPTIONAL , INTENT(  out) ::   kntime     ! number of times in file
801      CHARACTER(len=*), OPTIONAL , INTENT(  out) ::   cdunits    ! units attribute of time coordinate
802      CHARACTER(len=*), OPTIONAL , INTENT(  out) ::   cdcalendar ! calendar attribute of
803      !
804      INTEGER, DIMENSION(1) :: kdimsz
805      INTEGER            ::   idvar    ! id of the variable
806      CHARACTER(LEN=32)  ::   tname    ! local name of time coordinate
807      CHARACTER(LEN=100) ::   clinfo   ! info character
808      !---------------------------------------------------------------------
809      !
810      IF ( PRESENT(cdvar) ) THEN
811         tname = cdvar
812      ELSE
813         tname = iom_file(kiomid)%uldname
814      ENDIF
815      IF( kiomid > 0 ) THEN
816         clinfo = 'iom_gettime, file: '//trim(iom_file(kiomid)%name)//', var: '//trim(tname)
817         IF ( PRESENT(kntime) ) THEN
818            idvar  = iom_varid( kiomid, tname, kdimsz = kdimsz )
819            kntime = kdimsz(1)
820         ELSE
821            idvar = iom_varid( kiomid, tname )
822         ENDIF
823         !
824         ptime(:) = 0. ! default definition
825         IF( idvar > 0 ) THEN
826            IF( iom_file(kiomid)%ndims(idvar) == 1 ) THEN
827               IF( iom_file(kiomid)%luld(idvar) ) THEN
828                  IF( iom_file(kiomid)%dimsz(1,idvar) <= size(ptime) ) THEN
829                     SELECT CASE (iom_file(kiomid)%iolib)
830                     CASE (jpioipsl )   ;   CALL iom_ioipsl_gettime( kiomid, idvar, ptime, cdunits, cdcalendar )
831                     CASE (jpnf90   )   ;   CALL iom_nf90_gettime(   kiomid, idvar, ptime, cdunits, cdcalendar )
832                     CASE (jprstdimg)   ;   CALL ctl_stop( TRIM(clinfo)//' case IO library == jprstdimg not coded...' )
833                     CASE DEFAULT   
834                        CALL ctl_stop( TRIM(clinfo)//' accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
835                     END SELECT
836                  ELSE
837                     WRITE(ctmp1,*) 'error with the size of ptime ',size(ptime),iom_file(kiomid)%dimsz(1,idvar)
838                     CALL ctl_stop( trim(clinfo), trim(ctmp1) )
839                  ENDIF
840               ELSE
841                  CALL ctl_stop( trim(clinfo), 'variable dimension is not unlimited... use iom_get' )
842               ENDIF
843            ELSE
844               CALL ctl_stop( trim(clinfo), 'the variable has more than 1 dimension' )
845            ENDIF
846         ELSE
847            CALL ctl_stop( trim(clinfo), 'variable not found in '//iom_file(kiomid)%name )
848         ENDIF
849      ENDIF
850      !
851   END SUBROUTINE iom_gettime
852
853
854   !!----------------------------------------------------------------------
855   !!                   INTERFACE iom_getatt
856   !!----------------------------------------------------------------------
857   SUBROUTINE iom_g0d_intatt( kiomid, cdatt, pvar )
858      INTEGER         , INTENT(in   )                 ::   kiomid    ! Identifier of the file
859      CHARACTER(len=*), INTENT(in   )                 ::   cdatt     ! Name of the attribute
860      INTEGER         , INTENT(  out)                 ::   pvar      ! read field
861      !
862      IF( kiomid > 0 ) THEN
863         IF( iom_file(kiomid)%nfid > 0 ) THEN
864            SELECT CASE (iom_file(kiomid)%iolib)
865            CASE (jpioipsl )   ;   CALL ctl_stop('iom_getatt: only nf90 available')
866            CASE (jpnf90   )   ;   CALL iom_nf90_getatt( kiomid, cdatt, pvar )
867            CASE (jprstdimg)   ;   CALL ctl_stop('iom_getatt: only nf90 available')
868            CASE DEFAULT   
869               CALL ctl_stop( 'iom_g0d_att: accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
870            END SELECT
871         ENDIF
872      ENDIF
873   END SUBROUTINE iom_g0d_intatt
874
875
876   !!----------------------------------------------------------------------
877   !!                   INTERFACE iom_rstput
878   !!----------------------------------------------------------------------
879   SUBROUTINE iom_rp0d( kt, kwrite, kiomid, cdvar, pvar, ktype )
880      INTEGER         , INTENT(in)                         ::   kt       ! ocean time-step
881      INTEGER         , INTENT(in)                         ::   kwrite   ! writing time-step
882      INTEGER         , INTENT(in)                         ::   kiomid   ! Identifier of the file
883      CHARACTER(len=*), INTENT(in)                         ::   cdvar    ! time axis name
884      REAL(wp)        , INTENT(in)                         ::   pvar     ! written field
885      INTEGER         , INTENT(in), OPTIONAL               ::   ktype    ! variable external type
886      INTEGER :: ivid   ! variable id
887      IF( kiomid > 0 ) THEN
888         IF( iom_file(kiomid)%nfid > 0 ) THEN
889            ivid = iom_varid( kiomid, cdvar, ldstop = .FALSE. )
890            SELECT CASE (iom_file(kiomid)%iolib)
891            CASE (jpioipsl )   ;   CALL iom_ioipsl_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r0d = pvar )
892            CASE (jpnf90   )   ;   CALL iom_nf90_rstput(   kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r0d = pvar )
893            CASE (jprstdimg)   ;   IF( kt == kwrite )    CALL iom_rstdimg_rstput( kiomid, cdvar, ivid, pvar )
894            CASE DEFAULT     
895               CALL ctl_stop( 'iom_rp0d: accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
896            END SELECT
897         ENDIF
898      ENDIF
899   END SUBROUTINE iom_rp0d
900
901   SUBROUTINE iom_rp1d( kt, kwrite, kiomid, cdvar, pvar, ktype )
902      INTEGER         , INTENT(in)                         ::   kt       ! ocean time-step
903      INTEGER         , INTENT(in)                         ::   kwrite   ! writing time-step
904      INTEGER         , INTENT(in)                         ::   kiomid   ! Identifier of the file
905      CHARACTER(len=*), INTENT(in)                         ::   cdvar    ! time axis name
906      REAL(wp)        , INTENT(in), DIMENSION(          :) ::   pvar     ! written field
907      INTEGER         , INTENT(in), OPTIONAL               ::   ktype    ! variable external type
908      INTEGER :: ivid   ! variable id
909      IF( kiomid > 0 ) THEN
910         IF( iom_file(kiomid)%nfid > 0 ) THEN
911            ivid = iom_varid( kiomid, cdvar, ldstop = .FALSE. )
912            SELECT CASE (iom_file(kiomid)%iolib)
913            CASE (jpioipsl )   ;   CALL iom_ioipsl_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r1d = pvar )
914            CASE (jpnf90   )   ;   CALL iom_nf90_rstput(   kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r1d = pvar )
915            CASE (jprstdimg)   ;   IF( kt == kwrite )    CALL iom_rstdimg_rstput( kiomid, cdvar, ivid, pv_r1d = pvar )
916            CASE DEFAULT     
917               CALL ctl_stop( 'iom_rp1d: accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
918            END SELECT
919         ENDIF
920      ENDIF
921   END SUBROUTINE iom_rp1d
922
923   SUBROUTINE iom_rp2d( kt, kwrite, kiomid, cdvar, pvar, ktype )
924      INTEGER         , INTENT(in)                         ::   kt       ! ocean time-step
925      INTEGER         , INTENT(in)                         ::   kwrite   ! writing time-step
926      INTEGER         , INTENT(in)                         ::   kiomid   ! Identifier of the file
927      CHARACTER(len=*), INTENT(in)                         ::   cdvar    ! time axis name
928      REAL(wp)        , INTENT(in), DIMENSION(:,    :    ) ::   pvar     ! written field
929      INTEGER         , INTENT(in), OPTIONAL               ::   ktype    ! variable external type
930      INTEGER :: ivid   ! variable id
931      IF( kiomid > 0 ) THEN
932         IF( iom_file(kiomid)%nfid > 0 ) THEN
933            ivid = iom_varid( kiomid, cdvar, ldstop = .FALSE. )
934            SELECT CASE (iom_file(kiomid)%iolib)
935            CASE (jpioipsl )   ;   CALL iom_ioipsl_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r2d = pvar )
936            CASE (jpnf90   )   ;   CALL iom_nf90_rstput(   kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r2d = pvar )
937            CASE (jprstdimg)   ;   IF( kt == kwrite )   CALL iom_rstdimg_rstput( kiomid, cdvar, ivid, pv_r2d = pvar ) 
938            CASE DEFAULT     
939               CALL ctl_stop( 'iom_rp2d: accepted IO library are only jpioipsl, jpnf90 and jprstdimg' )
940            END SELECT
941         ENDIF
942      ENDIF
943   END SUBROUTINE iom_rp2d
944
945   SUBROUTINE iom_rp3d( kt, kwrite, kiomid, cdvar, pvar, ktype )
946      INTEGER         , INTENT(in)                         ::   kt       ! ocean time-step
947      INTEGER         , INTENT(in)                         ::   kwrite   ! writing time-step
948      INTEGER         , INTENT(in)                         ::   kiomid   ! Identifier of the file
949      CHARACTER(len=*), INTENT(in)                         ::   cdvar    ! time axis name
950      REAL(wp)        , INTENT(in),       DIMENSION(:,:,:) ::   pvar     ! written field
951      INTEGER         , INTENT(in), OPTIONAL               ::   ktype    ! variable external type
952      INTEGER :: ivid   ! variable id
953      IF( kiomid > 0 ) THEN
954         IF( iom_file(kiomid)%nfid > 0 ) THEN
955            ivid = iom_varid( kiomid, cdvar, ldstop = .FALSE. )
956            SELECT CASE (iom_file(kiomid)%iolib)
957            CASE (jpioipsl )   ;   CALL iom_ioipsl_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r3d = pvar )
958            CASE (jpnf90   )   ;   CALL iom_nf90_rstput(   kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r3d = pvar )
959            CASE (jprstdimg)   ;   IF( kt == kwrite )   CALL iom_rstdimg_rstput( kiomid, cdvar, ivid, pv_r3d = pvar )
960            CASE DEFAULT     
961               CALL ctl_stop( 'iom_rp3d: accepted IO library are only jpioipsl and jprstdimg' )
962            END SELECT
963         ENDIF
964      ENDIF
965   END SUBROUTINE iom_rp3d
966
967
968   !!----------------------------------------------------------------------
969   !!                   INTERFACE iom_put
970   !!----------------------------------------------------------------------
971   SUBROUTINE iom_p0d( cdname, pfield0d )
972      CHARACTER(LEN=*), INTENT(in) ::   cdname
973      REAL(wp)        , INTENT(in) ::   pfield0d
974#if defined key_iomput
975      CALL xios_send_field(cdname, (/pfield0d/))
976#else
977      IF( .FALSE. )   WRITE(numout,*) cdname, pfield0d   ! useless test to avoid compilation warnings
978#endif
979   END SUBROUTINE iom_p0d
980
981   SUBROUTINE iom_p1d( cdname, pfield1d )
982      CHARACTER(LEN=*)          , INTENT(in) ::   cdname
983      REAL(wp),     DIMENSION(:), INTENT(in) ::   pfield1d
984#if defined key_iomput
985      CALL xios_send_field( cdname, RESHAPE( (/pfield1d/), (/1,1,SIZE(pfield1d)/) ) )
986#else
987      IF( .FALSE. )   WRITE(numout,*) cdname, pfield1d   ! useless test to avoid compilation warnings
988#endif
989   END SUBROUTINE iom_p1d
990
991   SUBROUTINE iom_p2d( cdname, pfield2d )
992      CHARACTER(LEN=*)            , INTENT(in) ::   cdname
993      REAL(wp),     DIMENSION(:,:), INTENT(in) ::   pfield2d
994#if defined key_iomput
995      CALL xios_send_field(cdname, pfield2d)
996#else
997      IF( .FALSE. )   WRITE(numout,*) cdname, pfield2d   ! useless test to avoid compilation warnings
998#endif
999   END SUBROUTINE iom_p2d
1000
1001   SUBROUTINE iom_p3d( cdname, pfield3d )
1002      CHARACTER(LEN=*)                , INTENT(in) ::   cdname
1003      REAL(wp),       DIMENSION(:,:,:), INTENT(in) ::   pfield3d
1004#if defined key_iomput
1005      CALL xios_send_field(cdname, pfield3d)
1006#else
1007      IF( .FALSE. )   WRITE(numout,*) cdname, pfield3d   ! useless test to avoid compilation warnings
1008#endif
1009   END SUBROUTINE iom_p3d
1010   !!----------------------------------------------------------------------
1011
1012
1013#if defined key_iomput
1014
1015   SUBROUTINE iom_set_domain_attr( cdname, ni_glo, nj_glo, ibegin, jbegin, ni, nj, zoom_ibegin, zoom_jbegin, zoom_ni, zoom_nj,   &
1016      &                                    data_dim, data_ibegin, data_ni, data_jbegin, data_nj, lonvalue, latvalue, mask )
1017      CHARACTER(LEN=*)                 , INTENT(in) ::   cdname
1018      INTEGER                , OPTIONAL, INTENT(in) ::   ni_glo, nj_glo, ibegin, jbegin, ni, nj
1019      INTEGER                , OPTIONAL, INTENT(in) ::   data_dim, data_ibegin, data_ni, data_jbegin, data_nj
1020      INTEGER                , OPTIONAL, INTENT(in) ::   zoom_ibegin, zoom_jbegin, zoom_ni, zoom_nj
1021      REAL(wp), DIMENSION(:) , OPTIONAL, INTENT(in) ::   lonvalue, latvalue
1022      LOGICAL, DIMENSION(:,:), OPTIONAL, INTENT(in) ::   mask
1023
1024      IF ( xios_is_valid_domain     (cdname) ) THEN
1025         CALL xios_set_domain_attr     ( cdname, ni_glo=ni_glo, nj_glo=nj_glo, ibegin=ibegin, jbegin=jbegin, ni=ni, nj=nj,   &
1026            &    data_dim=data_dim, data_ibegin=data_ibegin, data_ni=data_ni, data_jbegin=data_jbegin, data_nj=data_nj   ,   &
1027            &    zoom_ibegin=zoom_ibegin, zoom_jbegin=zoom_jbegin, zoom_ni=zoom_ni, zoom_nj=zoom_nj,                         &
1028            &    lonvalue=lonvalue, latvalue=latvalue,mask=mask )
1029      ENDIF
1030
1031      IF ( xios_is_valid_domaingroup(cdname) ) THEN
1032         CALL xios_set_domaingroup_attr( cdname, ni_glo=ni_glo, nj_glo=nj_glo, ibegin=ibegin, jbegin=jbegin, ni=ni, nj=nj,   &
1033            &    data_dim=data_dim, data_ibegin=data_ibegin, data_ni=data_ni, data_jbegin=data_jbegin, data_nj=data_nj   ,   &
1034            &    zoom_ibegin=zoom_ibegin, zoom_jbegin=zoom_jbegin, zoom_ni=zoom_ni, zoom_nj=zoom_nj,                         &
1035            &    lonvalue=lonvalue, latvalue=latvalue,mask=mask )
1036      ENDIF
1037
1038   END SUBROUTINE iom_set_domain_attr
1039
1040
1041   SUBROUTINE iom_set_axis_attr( cdname, paxis )
1042      CHARACTER(LEN=*)      , INTENT(in) ::   cdname
1043      REAL(wp), DIMENSION(:), INTENT(in) ::   paxis
1044      IF ( xios_is_valid_axis     (cdname) )   CALL xios_set_axis_attr     ( cdname, size=size(paxis),value=paxis )
1045      IF ( xios_is_valid_axisgroup(cdname) )   CALL xios_set_axisgroup_attr( cdname, size=size(paxis),value=paxis )
1046   END SUBROUTINE iom_set_axis_attr
1047
1048
1049   SUBROUTINE iom_set_field_attr( cdname, freq_op)
1050      CHARACTER(LEN=*)          , INTENT(in) ::   cdname
1051      CHARACTER(LEN=*),OPTIONAL , INTENT(in) ::   freq_op
1052      IF ( xios_is_valid_field     (cdname) )   CALL xios_set_field_attr     ( cdname, freq_op=freq_op )
1053      IF ( xios_is_valid_fieldgroup(cdname) )   CALL xios_set_fieldgroup_attr( cdname, freq_op=freq_op )
1054   END SUBROUTINE iom_set_field_attr
1055
1056
1057   SUBROUTINE iom_set_file_attr( cdname, name, name_suffix )
1058      CHARACTER(LEN=*)          , INTENT(in) ::   cdname
1059      CHARACTER(LEN=*),OPTIONAL , INTENT(in) ::   name, name_suffix
1060      IF ( xios_is_valid_file     (cdname) )   CALL xios_set_file_attr     ( cdname, name=name, name_suffix=name_suffix )
1061      IF ( xios_is_valid_filegroup(cdname) )   CALL xios_set_filegroup_attr( cdname, name=name, name_suffix=name_suffix )
1062   END SUBROUTINE iom_set_file_attr
1063
1064
1065   SUBROUTINE iom_set_grid_attr( cdname, mask )
1066      CHARACTER(LEN=*)                   , INTENT(in) ::   cdname
1067      LOGICAL, DIMENSION(:,:,:), OPTIONAL, INTENT(in) ::   mask
1068      IF ( xios_is_valid_grid     (cdname) )   CALL xios_set_grid_attr     ( cdname, mask=mask )
1069      IF ( xios_is_valid_gridgroup(cdname) )   CALL xios_set_gridgroup_attr( cdname, mask=mask )
1070   END SUBROUTINE iom_set_grid_attr
1071
1072
1073   SUBROUTINE set_grid( cdgrd, plon, plat )
1074      !!----------------------------------------------------------------------
1075      !!                     ***  ROUTINE   ***
1076      !!
1077      !! ** Purpose :   define horizontal grids
1078      !!
1079      !!----------------------------------------------------------------------
1080      CHARACTER(LEN=1)            , INTENT(in) ::   cdgrd
1081      REAL(wp), DIMENSION(jpi,jpj), INTENT(in) ::   plon
1082      REAL(wp), DIMENSION(jpi,jpj), INTENT(in) ::   plat
1083      !
1084      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zmask
1085      INTEGER  :: ni,nj
1086     
1087      ni=nlei-nldi+1 ; nj=nlej-nldj+1
1088
1089      CALL iom_set_domain_attr("grid_"//cdgrd, ni_glo=jpiglo, nj_glo=jpjglo, ibegin=nimpp+nldi-1, jbegin=njmpp+nldj-1, ni=ni, nj=nj)
1090      CALL iom_set_domain_attr("grid_"//cdgrd, data_dim=2, data_ibegin = 1-nldi, data_ni = jpi, data_jbegin = 1-nldj, data_nj = jpj)
1091      CALL iom_set_domain_attr("grid_"//cdgrd, lonvalue = RESHAPE(plon(nldi:nlei, nldj:nlej),(/ ni*nj /)),   &
1092         &                                     latvalue = RESHAPE(plat(nldi:nlei, nldj:nlej),(/ ni*nj /))) 
1093
1094      IF ( ln_mskland ) THEN
1095         ! mask land points, keep values on coast line -> specific mask for U, V and W points
1096         SELECT CASE ( cdgrd )
1097         CASE('T')   ;   zmask(:,:,:)       = tmask(:,:,:)
1098         CASE('U')   ;   zmask(2:jpim1,:,:) = tmask(2:jpim1,:,:) + tmask(3:jpi,:,:)   ;   CALL lbc_lnk( zmask, 'U', 1. )
1099         CASE('V')   ;   zmask(:,2:jpjm1,:) = tmask(:,2:jpjm1,:) + tmask(:,3:jpi,:)   ;   CALL lbc_lnk( zmask, 'V', 1. )
1100         CASE('W')   ;   zmask(:,:,2:jpk  ) = tmask(:,:,1:jpkm1) + tmask(:,:,2:jpk)   ;   zmask(:,:,1) = tmask(:,:,1)
1101         END SELECT
1102         !
1103         CALL iom_set_domain_attr( "grid_"//cdgrd       , mask = RESHAPE(zmask(nldi:nlei,nldj:nlej,1),(/ni,nj    /)) /= 0. )
1104         CALL iom_set_grid_attr  ( "grid_"//cdgrd//"_3D", mask = RESHAPE(zmask(nldi:nlei,nldj:nlej,:),(/ni,nj,jpk/)) /= 0. )
1105      ENDIF
1106     
1107   END SUBROUTINE set_grid
1108
1109
1110   SUBROUTINE set_scalar
1111      !!----------------------------------------------------------------------
1112      !!                     ***  ROUTINE   ***
1113      !!
1114      !! ** Purpose :   define fake grids for scalar point
1115      !!
1116      !!----------------------------------------------------------------------
1117      REAL(wp), DIMENSION(1,1) ::   zz = 1.
1118      !!----------------------------------------------------------------------
1119      CALL iom_set_domain_attr('scalarpoint', ni_glo=jpnij, nj_glo=1, ibegin=narea, jbegin=1, ni=1, nj=1)
1120      CALL iom_set_domain_attr('scalarpoint', data_dim=1)
1121      CALL iom_set_domain_attr('scalarpoint', lonvalue=(/ zz /), latvalue=(/ zz /))
1122
1123   END SUBROUTINE set_scalar
1124
1125
1126   SUBROUTINE set_xmlatt
1127      !!----------------------------------------------------------------------
1128      !!                     ***  ROUTINE   ***
1129      !!
1130      !! ** Purpose :   automatic definitions of some of the xml attributs...
1131      !!
1132      !!----------------------------------------------------------------------
1133      CHARACTER(len=6),DIMENSION( 8) ::   clsuff                   ! suffix name
1134      CHARACTER(len=1),DIMENSION( 3) ::   clgrd                    ! suffix name
1135      CHARACTER(len=50)              ::   clname                   ! file name
1136      CHARACTER(len=1)               ::   cl1                      ! 1 character
1137      CHARACTER(len=2)               ::   cl2                      ! 1 character
1138      CHARACTER(len=255)             ::   tfo
1139      INTEGER                        ::   idt                      ! time-step in seconds
1140      INTEGER                        ::   iddss, ihhss             ! number of seconds in 1 day, 1 hour and 1 year
1141      INTEGER                        ::   iyymo                    ! number of months in 1 year
1142      INTEGER                        ::   jg, jh, jd, jm, jy       ! loop counters
1143      INTEGER                        ::   ix, iy                   ! i-,j- index
1144      REAL(wp)        ,DIMENSION(11) ::   zlontao                  ! longitudes of tao    moorings
1145      REAL(wp)        ,DIMENSION( 7) ::   zlattao                  ! latitudes  of tao    moorings
1146      REAL(wp)        ,DIMENSION( 4) ::   zlonrama                 ! longitudes of rama   moorings
1147      REAL(wp)        ,DIMENSION(11) ::   zlatrama                 ! latitudes  of rama   moorings
1148      REAL(wp)        ,DIMENSION( 3) ::   zlonpira                 ! longitudes of pirata moorings
1149      REAL(wp)        ,DIMENSION( 9) ::   zlatpira                 ! latitudes  of pirata moorings
1150      !!----------------------------------------------------------------------
1151      !
1152      idt   = NINT( rdttra(1)     )
1153      iddss = NINT( rday          )                                         ! number of seconds in 1 day
1154      ihhss = NINT( rmmss * rhhmm )                                         ! number of seconds in 1 hour
1155      iyymo = NINT( raamo         )                                         ! number of months in 1 year
1156
1157      ! frequency of the call of iom_put (attribut: freq_op)
1158      tfo = TRIM(i2str(idt))//'s'
1159      CALL iom_set_field_attr('field_definition', freq_op=tfo)
1160      CALL iom_set_field_attr('SBC'   , freq_op=TRIM(i2str(idt* nn_fsbc ))//'s')
1161      CALL iom_set_field_attr('ptrc_T', freq_op=TRIM(i2str(idt* nn_dttrc))//'s')
1162      CALL iom_set_field_attr('diad_T', freq_op=TRIM(i2str(idt* nn_dttrc))//'s')
1163       
1164      ! output file names (attribut: name)
1165      clsuff(:) = (/ 'grid_T', 'grid_U', 'grid_V', 'grid_W', 'icemod', 'ptrc_T', 'diad_T', 'scalar' /)     
1166      DO jg = 1, SIZE(clsuff)                                                                  ! grid type
1167         DO jh = 1, 24                                                                         ! 1-24 hours
1168            WRITE(cl2,'(i2)') jh 
1169            CALL dia_nam( clname, jh * ihhss, clsuff(jg), ldfsec = .TRUE. )
1170            CALL iom_set_file_attr(TRIM(ADJUSTL(cl2))//'h_'//clsuff(jg), name=TRIM(clname))
1171         END DO
1172         DO jd = 1, 30                                                                         ! 1-30 days
1173            WRITE(cl1,'(i1)') jd 
1174            CALL dia_nam( clname, jd * iddss, clsuff(jg), ldfsec = .TRUE. )
1175            CALL iom_set_file_attr(cl1//'d_'//clsuff(jg), name=TRIM(clname))
1176         END DO
1177         DO jm = 1, 11                                                                         ! 1-11 months
1178            WRITE(cl1,'(i1)') jm 
1179            CALL dia_nam( clname, -jm, clsuff(jg) )
1180            CALL iom_set_file_attr(cl1//'m_'//clsuff(jg), name=TRIM(clname))
1181         END DO
1182         DO jy = 1, 50                                                                         ! 1-50 years 
1183            WRITE(cl2,'(i2)') jy 
1184            CALL dia_nam( clname, -jy * iyymo, clsuff(jg) )
1185            CALL iom_set_file_attr(TRIM(ADJUSTL(cl2))//'y_'//clsuff(jg), name=TRIM(clname))
1186         END DO
1187      END DO
1188
1189      ! Zooms...
1190      clgrd = (/ 'T', 'U', 'W' /) 
1191      DO jg = 1, SIZE(clgrd)                                                                   ! grid type
1192         cl1 = clgrd(jg)
1193         ! Equatorial section (attributs: jbegin, ni, name_suffix)
1194         CALL dom_ngb( 0., 0., ix, iy, cl1 )
1195         CALL iom_set_domain_attr('Eq'//cl1, zoom_jbegin=iy, zoom_ni=jpiglo)
1196         CALL iom_set_file_attr('Eq'//cl1, name_suffix= '_Eq')
1197      END DO
1198      ! TAO moorings (attributs: ibegin, jbegin, name_suffix)
1199      zlontao = (/ 137.0, 147.0, 156.0, 165.0, -180.0, -170.0, -155.0, -140.0, -125.0, -110.0, -95.0 /)
1200      zlattao = (/  -8.0,  -5.0,  -2.0,   0.0,    2.0,    5.0,    8.0 /)
1201      CALL set_mooring( zlontao, zlattao )
1202      ! RAMA moorings (attributs: ibegin, jbegin, name_suffix)
1203      zlonrama = (/  55.0,  67.0, 80.5, 90.0 /)
1204      zlatrama = (/ -16.0, -12.0, -8.0, -4.0, -1.5, 0.0, 1.5, 4.0, 8.0, 12.0, 15.0 /)
1205      CALL set_mooring( zlonrama, zlatrama )
1206      ! PIRATA moorings (attributs: ibegin, jbegin, name_suffix)
1207      zlonpira = (/ -38.0, -23.0, -10.0 /)
1208      zlatpira = (/ -19.0, -14.0,  -8.0, 0.0, 4.0, 8.0, 12.0, 15.0, 20.0 /)
1209      CALL set_mooring( zlonpira, zlatpira )
1210     
1211   END SUBROUTINE set_xmlatt
1212
1213
1214   SUBROUTINE set_mooring( plon, plat)
1215      !!----------------------------------------------------------------------
1216      !!                     ***  ROUTINE   ***
1217      !!
1218      !! ** Purpose :   automatic definitions of moorings xml attributs...
1219      !!
1220      !!----------------------------------------------------------------------
1221      REAL(wp), DIMENSION(:), INTENT(in) ::  plon, plat           ! longitudes/latitudes oft the mooring
1222      !
1223!!$      CHARACTER(len=1),DIMENSION(4) ::   clgrd = (/ 'T', 'U', 'V', 'W' /)   ! suffix name
1224      CHARACTER(len=1),DIMENSION(1) ::   clgrd = (/ 'T' /)        ! suffix name
1225      CHARACTER(len=50)             ::   clname                   ! file name
1226      CHARACTER(len=1)              ::   cl1                      ! 1 character
1227      CHARACTER(len=6)              ::   clon,clat                ! name of longitude, latitude
1228      INTEGER                       ::   ji, jj, jg               ! loop counters
1229      INTEGER                       ::   ix, iy                   ! i-,j- index
1230      REAL(wp)                      ::   zlon, zlat
1231      !!----------------------------------------------------------------------
1232      DO jg = 1, SIZE(clgrd)
1233         cl1 = clgrd(jg)
1234         DO ji = 1, SIZE(plon)
1235            DO jj = 1, SIZE(plat)
1236               zlon = plon(ji)
1237               zlat = plat(jj)
1238               ! modifications for RAMA moorings
1239               IF( zlon ==  67. .AND. zlat ==  15. )   zlon =  65.
1240               IF( zlon ==  90. .AND. zlat <=  -4. )   zlon =  95.
1241               IF( zlon ==  95. .AND. zlat ==  -4. )   zlat =  -5.
1242               ! modifications for PIRATA moorings
1243               IF( zlon == -38. .AND. zlat == -19. )   zlon = -34.
1244               IF( zlon == -38. .AND. zlat == -14. )   zlon = -32.
1245               IF( zlon == -38. .AND. zlat ==  -8. )   zlon = -30.
1246               IF( zlon == -38. .AND. zlat ==   0. )   zlon = -35.
1247               IF( zlon == -23. .AND. zlat ==  20. )   zlat =  21.
1248               IF( zlon == -10. .AND. zlat == -14. )   zlat = -10.
1249               IF( zlon == -10. .AND. zlat ==  -8. )   zlat =  -6.
1250               IF( zlon == -10. .AND. zlat ==   4. ) THEN   ;   zlon = 0.   ;   zlat = 0.   ;   ENDIF
1251               CALL dom_ngb( zlon, zlat, ix, iy, cl1 )
1252               IF( zlon >= 0. ) THEN 
1253                  IF( zlon == REAL(NINT(zlon), wp) ) THEN   ;   WRITE(clon, '(i3,  a)') NINT( zlon), 'e'
1254                  ELSE                                      ;   WRITE(clon, '(f5.1,a)')       zlon , 'e'
1255                  ENDIF
1256               ELSE             
1257                  IF( zlon == REAL(NINT(zlon), wp) ) THEN   ;   WRITE(clon, '(i3,  a)') NINT(-zlon), 'w'
1258                  ELSE                                      ;   WRITE(clon, '(f5.1,a)')      -zlon , 'w'
1259                  ENDIF
1260               ENDIF
1261               IF( zlat >= 0. ) THEN 
1262                  IF( zlat == REAL(NINT(zlat), wp) ) THEN   ;   WRITE(clat, '(i2,  a)') NINT( zlat), 'n'
1263                  ELSE                                      ;   WRITE(clat, '(f4.1,a)')       zlat , 'n'
1264                  ENDIF
1265               ELSE             
1266                  IF( zlat == REAL(NINT(zlat), wp) ) THEN   ;   WRITE(clat, '(i2,  a)') NINT(-zlat), 's'
1267                  ELSE                                      ;   WRITE(clat, '(f4.1,a)')      -zlat , 's'
1268                  ENDIF
1269               ENDIF
1270               clname = TRIM(ADJUSTL(clat))//TRIM(ADJUSTL(clon))
1271               CALL iom_set_domain_attr(TRIM(clname)//cl1, zoom_ibegin= ix, zoom_jbegin= iy)
1272               CALL iom_set_file_attr(TRIM(clname)//cl1, name_suffix= '_'//TRIM(clname))
1273            END DO
1274         END DO
1275      END DO
1276     
1277   END SUBROUTINE set_mooring
1278
1279#else
1280
1281   SUBROUTINE iom_setkt( kt )
1282      INTEGER, INTENT(in   )::   kt 
1283      IF( .FALSE. )   WRITE(numout,*) kt   ! useless test to avoid compilation warnings
1284   END SUBROUTINE iom_setkt
1285
1286#endif
1287
1288   FUNCTION i2str(int)
1289   IMPLICIT NONE
1290      INTEGER, INTENT(IN) :: int
1291      CHARACTER(LEN=255) :: i2str
1292
1293      WRITE(i2str,*) int
1294     
1295   END FUNCTION i2str 
1296   
1297   !!======================================================================
1298END MODULE iom
Note: See TracBrowser for help on using the repository browser.