source: vendor/nemo/current/NEMOGCM/NEMO/OPA_SRC/IOM/iom.F90 @ 44

Last change on this file since 44 was 44, checked in by cholod, 12 years ago

Load NEMO_TMP into vendor/nemo/current.

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