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 branches/NERC/dev_r3874_FASTNEt/NEMOGCM/NEMO/OPA_SRC/IOM – NEMO

source: branches/NERC/dev_r3874_FASTNEt/NEMOGCM/NEMO/OPA_SRC/IOM/iom.F90 @ 6736

Last change on this file since 6736 was 6736, checked in by jamesharle, 8 years ago

FASTNEt code modifications

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