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

source: branches/2012/dev_MERGE_2012/NEMOGCM/NEMO/OPA_SRC/IOM/iom.F90 @ 3695

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

dev_MERGE_2012: add xios

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