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.
domzgr.F90 in branches/2011/DEV_r2739_STFC_dCSE/NEMOGCM/NEMO/OPA_SRC/DOM – NEMO

source: branches/2011/DEV_r2739_STFC_dCSE/NEMOGCM/NEMO/OPA_SRC/DOM/domzgr.F90 @ 3837

Last change on this file since 3837 was 3837, checked in by trackstand2, 11 years ago

Merge of finiss
  • Property svn:keywords set to Id
File size: 87.2 KB
Line 
1MODULE domzgr
2   !!==============================================================================
3   !!                       ***  MODULE domzgr   ***
4   !! Ocean initialization : domain initialization
5   !!==============================================================================
6   !! History :  OPA  ! 1995-12  (G. Madec)  Original code : s vertical coordinate
7   !!                 ! 1997-07  (G. Madec)  lbc_lnk call
8   !!                 ! 1997-04  (J.-O. Beismann)
9   !!            8.5  ! 2002-09  (A. Bozec, G. Madec)  F90: Free form and module
10   !!             -   ! 2002-09  (A. de Miranda)  rigid-lid + islands
11   !!  NEMO      1.0  ! 2003-08  (G. Madec)  F90: Free form and module
12   !!             -   ! 2005-10  (A. Beckmann)  modifications for hybrid s-ccordinates & new stretching function
13   !!            2.0  ! 2006-04  (R. Benshila, G. Madec)  add zgr_zco
14   !!            3.0  ! 2008-06  (G. Madec)  insertion of domzgr_zps.h90 & conding style
15   !!            3.2  ! 2009-07  (R. Benshila) Suppression of rigid-lid option
16   !!            3.3  ! 2010-11  (G. Madec) add mbk. arrays associated to the deepest ocean level
17   !!----------------------------------------------------------------------
18
19   !!----------------------------------------------------------------------
20   !!   dom_zgr          : defined the ocean vertical coordinate system
21   !!       zgr_bat      : bathymetry fields (levels and meters)
22   !!       zgr_bat_zoom : modify the bathymetry field if zoom domain
23   !!       zgr_bat_ctl  : check the bathymetry files
24   !!       zgr_bot_level: deepest ocean level for t-, u, and v-points
25   !!       zgr_z        : reference z-coordinate
26   !!       zgr_zco      : z-coordinate
27   !!       zgr_zps      : z-coordinate with partial steps
28   !!       zgr_sco      : s-coordinate
29   !!       fssig        : sigma coordinate non-dimensional function
30   !!       dfssig       : derivative of the sigma coordinate function    !!gm  (currently missing!)
31   !!---------------------------------------------------------------------
32   USE oce               ! ocean variables
33   USE dom_oce           ! ocean domain
34   USE closea            ! closed seas
35   USE c1d               ! 1D vertical configuration
36   USE in_out_manager    ! I/O manager
37   USE iom               ! I/O library
38   USE lbclnk            ! ocean lateral boundary conditions (or mpp link)
39   USE lib_mpp           ! distributed memory computing library
40
41   IMPLICIT NONE
42   PRIVATE
43
44   PUBLIC   dom_zgr        ! called by dom_init.F90
45   PUBLIC   zgr_z, zgr_bat, zgr_zco, zgr_zps ! called by nemogcm::recursive_partition
46   PUBLIC   fssig1         ! called by partition_mod::smooth_bathy
47
48   !                                       !!* Namelist namzgr_sco *
49   REAL(wp) ::   rn_sbot_min =  300._wp     ! minimum depth of s-bottom surface (>0) (m)
50   REAL(wp) ::   rn_sbot_max = 5250._wp     ! maximum depth of s-bottom surface (= ocean depth) (>0) (m)
51   REAL(wp) ::   rn_theta    =    6.00_wp   ! surface control parameter (0<=rn_theta<=20)
52   REAL(wp) ::   rn_thetb    =    0.75_wp   ! bottom control parameter  (0<=rn_thetb<= 1)
53   REAL(wp) ::   rn_rmax     =    0.15_wp   ! maximum cut-off r-value allowed (0<rn_rmax<1)
54   LOGICAL  ::   ln_s_sigma  = .false.      ! use hybrid s-sigma -coordinate & stretching function fssig1 (ln_sco=T)
55   REAL(wp) ::   rn_bb       =    0.80_wp   ! stretching parameter for song and haidvogel stretching
56   !                                        ! ( rn_bb=0; top only, rn_bb =1; top and bottom)
57   REAL(wp) ::   rn_hc       =  150._wp     ! Critical depth for s-sigma coordinates
58   PUBLIC rn_sbot_min, rn_sbot_max, rn_theta, rn_thetb, rn_rmax, &
59          ln_s_sigma, rn_bb, rn_hc
60   PUBLIC ln_zco, ln_zps, ln_sco
61
62   !! * Control permutation of array indices
63#  include "oce_ftrans.h90"
64#  include "dom_oce_ftrans.h90"
65
66  !! * Substitutions
67#  include "domzgr_substitute.h90"
68#  include "vectopt_loop_substitute.h90"
69
70   NAMELIST/namzgr/ ln_zco, ln_zps, ln_sco
71   NAMELIST/namzgr_sco/ rn_sbot_max, rn_sbot_min, rn_theta, rn_thetb, &
72                        rn_rmax, ln_s_sigma, rn_bb, rn_hc
73   PUBLIC namzgr, namzgr_sco
74   !!----------------------------------------------------------------------
75   !! NEMO/OPA 3.3.1 , NEMO Consortium (2011)
76   !! $Id$
77   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
78   !!----------------------------------------------------------------------
79CONTAINS       
80
81   SUBROUTINE dom_zgr
82      !!----------------------------------------------------------------------
83      !!                ***  ROUTINE dom_zgr  ***
84      !!                   
85      !! ** Purpose :  set the depth of model levels and the resulting
86      !!      vertical scale factors.
87      !!
88      !! ** Method  : - reference 1D vertical coordinate (gdep._0, e3._0)
89      !!              - read/set ocean depth and ocean levels (bathy, mbathy)
90      !!              - vertical coordinate (gdep., e3.) depending on the
91      !!                coordinate chosen :
92      !!                   ln_zco=T   z-coordinate   
93      !!                   ln_zps=T   z-coordinate with partial steps
94      !!                   ln_zco=T   s-coordinate
95      !!
96      !! ** Action  :   define gdep., e3., mbathy and bathy
97      !!----------------------------------------------------------------------
98      INTEGER ::   ioptio = 0   ! temporary integer
99      !
100      !NAMELIST/namzgr/ ln_zco, ln_zps, ln_sco
101      !!----------------------------------------------------------------------
102
103      REWIND( numnam )                 ! Read Namelist namzgr : vertical coordinate
104      READ  ( numnam, namzgr )
105
106      IF(lwp) THEN                     ! Control print
107         WRITE(numout,*)
108         WRITE(numout,*) 'dom_zgr : vertical coordinate'
109         WRITE(numout,*) '~~~~~~~'
110         WRITE(numout,*) '          Namelist namzgr : set vertical coordinate'
111         WRITE(numout,*) '             z-coordinate - full steps      ln_zco = ', ln_zco
112         WRITE(numout,*) '             z-coordinate - partial steps   ln_zps = ', ln_zps
113         WRITE(numout,*) '             s- or hybrid z-s-coordinate    ln_sco = ', ln_sco
114      ENDIF
115
116      ioptio = 0                       ! Check Vertical coordinate options
117      IF( ln_zco ) ioptio = ioptio + 1
118      IF( ln_zps ) ioptio = ioptio + 1
119      IF( ln_sco ) ioptio = ioptio + 1
120      IF( ioptio /= 1 )   CALL ctl_stop( ' none or several vertical coordinate options used' )
121      !
122      ! Build the vertical coordinate system
123      ! ------------------------------------
124                          CALL zgr_z            ! Reference z-coordinate system (always called)
125                          CALL zgr_bat          ! Bathymetry fields (levels and meters)
126      IF( ln_zco      )   CALL zgr_zco          ! z-coordinate
127      IF( ln_zps      )   CALL zgr_zps          ! Partial step z-coordinate
128      IF( ln_sco      )   CALL zgr_sco          ! s-coordinate or hybrid z-s coordinate
129      !
130      ! final adjustment of mbathy & check
131      ! -----------------------------------
132      IF( lzoom       )   CALL zgr_bat_zoom     ! correct mbathy in case of zoom subdomain
133      IF( .NOT.lk_c1d )   CALL zgr_bat_ctl      ! check bathymetry (mbathy) and suppress isoated ocean points
134                          CALL zgr_bot_level    ! deepest ocean level for t-, u- and v-points
135      !
136      !
137
138      IF( nprint == 1 .AND. lwp )   THEN
139         WRITE(numout,*) ' MIN val mbathy ', MINVAL( mbathy(:,:) ), ' MAX ', MAXVAL( mbathy(:,:) )
140         WRITE(numout,*) ' MIN val depth t ', MINVAL( fsdept(:,:,:) ),   &
141            &                   ' w ',   MINVAL( fsdepw(:,:,:) ), '3w ', MINVAL( fsde3w(:,:,:) )
142         WRITE(numout,*) ' MIN val e3    t ', MINVAL( fse3t(:,:,:) ), ' f ', MINVAL( fse3f(:,:,:) ),  &
143            &                   ' u ',   MINVAL( fse3u(:,:,:) ), ' u ', MINVAL( fse3v(:,:,:) ),  &
144            &                   ' uw',   MINVAL( fse3uw(:,:,:)), ' vw', MINVAL( fse3vw(:,:,:)),   &
145            &                   ' w ',   MINVAL( fse3w(:,:,:) )
146
147         WRITE(numout,*) ' MAX val depth t ', MAXVAL( fsdept(:,:,:) ),   &
148            &                   ' w ',   MAXVAL( fsdepw(:,:,:) ), '3w ', MAXVAL( fsde3w(:,:,:) )
149         WRITE(numout,*) ' MAX val e3    t ', MAXVAL( fse3t(:,:,:) ), ' f ', MAXVAL( fse3f(:,:,:) ),  &
150            &                   ' u ',   MAXVAL( fse3u(:,:,:) ), ' u ', MAXVAL( fse3v(:,:,:) ),  &
151            &                   ' uw',   MAXVAL( fse3uw(:,:,:)), ' vw', MAXVAL( fse3vw(:,:,:)),   &
152            &                   ' w ',   MAXVAL( fse3w(:,:,:) )
153      ENDIF
154      !
155   END SUBROUTINE dom_zgr
156
157
158   SUBROUTINE zgr_z
159      !!----------------------------------------------------------------------
160      !!                   ***  ROUTINE zgr_z  ***
161      !!                   
162      !! ** Purpose :   set the depth of model levels and the resulting
163      !!      vertical scale factors.
164      !!
165      !! ** Method  :   z-coordinate system (use in all type of coordinate)
166      !!        The depth of model levels is defined from an analytical
167      !!      function the derivative of which gives the scale factors.
168      !!        both depth and scale factors only depend on k (1d arrays).
169      !!              w-level: gdepw_0  = fsdep(k)
170      !!                       e3w_0(k) = dk(fsdep)(k)     = fse3(k)
171      !!              t-level: gdept_0  = fsdep(k+0.5)
172      !!                       e3t_0(k) = dk(fsdep)(k+0.5) = fse3(k+0.5)
173      !!
174      !! ** Action  : - gdept_0, gdepw_0 : depth of T- and W-point (m)
175      !!              - e3t_0  , e3w_0   : scale factors at T- and W-levels (m)
176      !!
177      !! Reference : Marti, Madec & Delecluse, 1992, JGR, 97, No8, 12,763-12,766.
178      !!----------------------------------------------------------------------
179      INTEGER  ::   jk                     ! dummy loop indices
180      REAL(wp) ::   zt, zw                 ! temporary scalars
181      REAL(wp) ::   zsur, za0, za1, zkth   ! Values set from parameters in
182      REAL(wp) ::   zacr, zdzmin, zhmax    ! par_CONFIG_Rxx.h90
183      REAL(wp) ::   zrefdep                ! depth of the reference level (~10m)
184      REAL(wp) ::   za2, zkth2, zacr2      ! Values for optional double tanh function set from parameters
185      !!----------------------------------------------------------------------
186
187      ! Set variables from parameters
188      ! ------------------------------
189       zkth = ppkth       ;   zacr = ppacr
190       zdzmin = ppdzmin   ;   zhmax = pphmax
191       zkth2 = ppkth2     ;   zacr2 = ppacr2   ! optional (ldbletanh=T) double tanh parameters
192
193      ! If ppa1 and ppa0 and ppsur are et to pp_to_be_computed
194      !  za0, za1, zsur are computed from ppdzmin , pphmax, ppkth, ppacr
195      IF(   ppa1  == pp_to_be_computed  .AND.  &
196         &  ppa0  == pp_to_be_computed  .AND.  &
197         &  ppsur == pp_to_be_computed           ) THEN
198         !
199         za1  = (  ppdzmin - pphmax / FLOAT(jpkm1)  )                                                      &
200            & / ( TANH((1-ppkth)/ppacr) - ppacr/FLOAT(jpk-1) * (  LOG( COSH( (jpk - ppkth) / ppacr) )      &
201            &                                                   - LOG( COSH( ( 1  - ppkth) / ppacr) )  )  )
202         za0  = ppdzmin - za1 *              TANH( (1-ppkth) / ppacr )
203         zsur =   - za0 - za1 * ppacr * LOG( COSH( (1-ppkth) / ppacr )  )
204      ELSE
205         za1 = ppa1 ;       za0 = ppa0 ;          zsur = ppsur
206         za2 = ppa2                            ! optional (ldbletanh=T) double tanh parameter
207      ENDIF
208
209      IF(lwp) THEN                         ! Parameter print
210         WRITE(numout,*)
211         WRITE(numout,*) '    zgr_z   : Reference vertical z-coordinates'
212         WRITE(numout,*) '    ~~~~~~~'
213         IF(  ppkth == 0._wp ) THEN             
214              WRITE(numout,*) '            Uniform grid with ',jpk-1,' layers'
215              WRITE(numout,*) '            Total depth    :', zhmax
216              WRITE(numout,*) '            Layer thickness:', zhmax/(jpk-1)
217         ELSE
218            IF( ppa1 == 0._wp .AND. ppa0 == 0._wp .AND. ppsur == 0._wp ) THEN
219               WRITE(numout,*) '         zsur, za0, za1 computed from '
220               WRITE(numout,*) '                 zdzmin = ', zdzmin
221               WRITE(numout,*) '                 zhmax  = ', zhmax
222            ENDIF
223            WRITE(numout,*) '           Value of coefficients for vertical mesh:'
224            WRITE(numout,*) '                 zsur = ', zsur
225            WRITE(numout,*) '                 za0  = ', za0
226            WRITE(numout,*) '                 za1  = ', za1
227            WRITE(numout,*) '                 zkth = ', zkth
228            WRITE(numout,*) '                 zacr = ', zacr
229            IF( ldbletanh ) THEN
230               WRITE(numout,*) ' (Double tanh    za2  = ', za2
231               WRITE(numout,*) '  parameters)    zkth2= ', zkth2
232               WRITE(numout,*) '                 zacr2= ', zacr2
233            ENDIF
234         ENDIF
235      ENDIF
236
237
238      ! Reference z-coordinate (depth - scale factor at T- and W-points)
239      ! ======================
240      IF( ppkth == 0._wp ) THEN            !  uniform vertical grid       
241         za1 = zhmax / FLOAT(jpk-1) 
242         DO jk = 1, jpk
243            zw = FLOAT( jk )
244            zt = FLOAT( jk ) + 0.5_wp
245            gdepw_0(jk) = ( zw - 1 ) * za1
246            gdept_0(jk) = ( zt - 1 ) * za1
247            e3w_0  (jk) =  za1
248            e3t_0  (jk) =  za1
249         END DO
250      ELSE                                ! Madec & Imbard 1996 function
251         IF( .NOT. ldbletanh ) THEN
252            DO jk = 1, jpk
253               zw = REAL( jk , wp )
254               zt = REAL( jk , wp ) + 0.5_wp
255               gdepw_0(jk) = ( zsur + za0 * zw + za1 * zacr * LOG ( COSH( (zw-zkth) / zacr ) )  )
256               gdept_0(jk) = ( zsur + za0 * zt + za1 * zacr * LOG ( COSH( (zt-zkth) / zacr ) )  )
257               e3w_0  (jk) =          za0      + za1        * TANH(       (zw-zkth) / zacr   )
258               e3t_0  (jk) =          za0      + za1        * TANH(       (zt-zkth) / zacr   )
259            END DO
260         ELSE
261            DO jk = 1, jpk
262               zw = FLOAT( jk )
263               zt = FLOAT( jk ) + 0.5_wp
264               ! Double tanh function
265               gdepw_0(jk) = ( zsur + za0 * zw + za1 * zacr * LOG ( COSH( (zw-zkth ) / zacr  ) )    &
266                  &                            + za2 * zacr2* LOG ( COSH( (zw-zkth2) / zacr2 ) )  )
267               gdept_0(jk) = ( zsur + za0 * zt + za1 * zacr * LOG ( COSH( (zt-zkth ) / zacr  ) )    &
268                  &                            + za2 * zacr2* LOG ( COSH( (zt-zkth2) / zacr2 ) )  )
269               e3w_0  (jk) =          za0      + za1        * TANH(       (zw-zkth ) / zacr  )    &
270                  &                            + za2        * TANH(       (zw-zkth2) / zacr2 )
271               e3t_0  (jk) =          za0      + za1        * TANH(       (zt-zkth ) / zacr  )    &
272                  &                            + za2        * TANH(       (zt-zkth2) / zacr2 )
273            END DO
274         ENDIF
275         gdepw_0(1) = 0._wp                    ! force first w-level to be exactly at zero
276      ENDIF
277
278!!gm BUG in s-coordinate this does not work!
279      ! deepest/shallowest W level Above/Below ~10m
280      zrefdep = 10._wp - 0.1_wp * MINVAL( e3w_0 )                    ! ref. depth with tolerance (10% of minimum layer thickness)
281      nlb10 = MINLOC( gdepw_0, mask = gdepw_0 > zrefdep, dim = 1 )   ! shallowest W level Below ~10m
282      nla10 = nlb10 - 1                                              ! deepest    W level Above ~10m
283!!gm end bug
284
285      IF(lwp) THEN                        ! control print
286         WRITE(numout,*)
287         WRITE(numout,*) '              Reference z-coordinate depth and scale factors:'
288         WRITE(numout, "(9x,' level   gdept    gdepw     e3t      e3w  ')" )
289         WRITE(numout, "(10x, i4, 4f9.2)" ) ( jk, gdept_0(jk), gdepw_0(jk), e3t_0(jk), e3w_0(jk), jk = 1, jpk )
290      ENDIF
291      DO jk = 1, jpk                      ! control positivity
292         IF( e3w_0  (jk) <= 0._wp .OR. e3t_0  (jk) <= 0._wp )   CALL ctl_stop( 'dom:zgr_z: e3w or e3t =< 0 '    )
293         IF( gdepw_0(jk) <  0._wp .OR. gdept_0(jk) <  0._wp )   CALL ctl_stop( 'dom:zgr_z: gdepw or gdept < 0 ' )
294      END DO
295      !
296   END SUBROUTINE zgr_z
297
298
299   SUBROUTINE zgr_bat(global_domain)
300      !!----------------------------------------------------------------------
301      !!                    ***  ROUTINE zgr_bat  ***
302      !!
303      !! ** Purpose :   set bathymetry both in levels and meters
304      !!
305      !! ** Method  :   read or define mbathy and bathy arrays
306      !!       * level bathymetry:
307      !!      The ocean basin geometry is given by a two-dimensional array,
308      !!      mbathy, which is defined as follow :
309      !!            mbathy(ji,jj) = 1, ..., jpk-1, the number of ocean level
310      !!                              at t-point (ji,jj).
311      !!                            = 0  over the continental t-point.
312      !!      The array mbathy is checked to verified its consistency with
313      !!      model option. in particular:
314      !!            mbathy must have at least 1 land grid-points (mbathy<=0)
315      !!                  along closed boundary.
316      !!            mbathy must be cyclic IF jperio=1.
317      !!            mbathy must be lower or equal to jpk-1.
318      !!            isolated ocean grid points are suppressed from mbathy
319      !!                  since they are only connected to remaining
320      !!                  ocean through vertical diffusion.
321      !!      ntopo=-1 :   rectangular channel or bassin with a bump
322      !!      ntopo= 0 :   flat rectangular channel or basin
323      !!      ntopo= 1 :   mbathy is read in 'bathy_level.nc' NetCDF file
324      !!                   bathy  is read in 'bathy_meter.nc' NetCDF file
325      !!
326      !! ** Action  : - mbathy: level bathymetry (in level index)
327      !!              - bathy : meter bathymetry (in meters)
328      !!----------------------------------------------------------------------
329      LOGICAL, OPTIONAL, INTENT(in) :: global_domain ! Whether dealing with
330                                                     ! whole domain (T) or a
331                                                     ! sub-domain after domain
332                                                     ! decomposition
333      ! Locals
334      INTEGER  ::   ji, jj, jl, jk            ! dummy loop indices
335      INTEGER  ::   inum                      ! temporary logical unit
336      INTEGER  ::   ii_bump, ij_bump, ih      ! bump center position
337      INTEGER  ::   ii0, ii1, ij0, ij1, ik    ! local indices
338      REAL(wp) ::   r_bump , h_bump , h_oce   ! bump characteristics
339      REAL(wp) ::   zi, zj, zh, zhmin         ! local scalars
340      INTEGER , DIMENSION(jpidta,jpjdta) ::   idta   ! global domain integer data
341      REAL(wp), DIMENSION(jpidta,jpjdta) ::   zdta   ! global domain scalar data
342      LOGICAL  ::   is_global 
343      !!----------------------------------------------------------------------
344
345      IF(lwp) WRITE(numout,*)
346      IF(lwp) WRITE(numout,*) '    zgr_bat : defines level and meter bathymetry'
347      IF(lwp) WRITE(numout,*) '    ~~~~~~~'
348
349      ! Set local flag to signal whether we're dealing with the global domain
350      ! (pre decomposition) or a local part of it. Required by the
351      ! recursive k-section partitioning.
352      is_global = .FALSE.
353      IF( PRESENT(global_domain) )THEN
354         IF( global_domain ) is_global = .TRUE.
355      END IF
356
357      !                                               ! ================== !
358      IF( ntopo == 0 .OR. ntopo == -1 ) THEN          !   defined by hand  !
359         !                                            ! ================== !
360         !                                            ! global domain level and meter bathymetry (idta,zdta)
361         !
362         IF( ntopo == 0 ) THEN                        ! flat basin
363            IF(lwp) WRITE(numout,*)
364            IF(lwp) WRITE(numout,*) '         bathymetry field: flat basin'
365            idta(:,:) = jpkm1                            ! before last level
366            zdta(:,:) = gdepw_0(jpk)                     ! last w-point depth
367            h_oce     = gdepw_0(jpk)
368         ELSE                                         ! bump centered in the basin
369            IF(lwp) WRITE(numout,*)
370            IF(lwp) WRITE(numout,*) '         bathymetry field: flat basin with a bump'
371            ii_bump = jpidta / 2                           ! i-index of the bump center
372            ij_bump = jpjdta / 2                           ! j-index of the bump center
373            r_bump  = 0.165*MIN(jpidta,jpjdta)             ! bump radius (grid cells)       
374            h_bump  =  3000._wp                            ! bump height (meters)
375            h_oce   = gdepw_0(jpk)                         ! background ocean depth (meters)
376            IF(lwp) WRITE(numout,*) '            bump characteristics: '
377            IF(lwp) WRITE(numout,*) '               bump center (i,j)   = ', ii_bump, ij_bump
378            IF(lwp) WRITE(numout,*) '               bump height         = ', h_bump , ' meters'
379            IF(lwp) WRITE(numout,*) '               bump radius         = ', r_bump , ' cells'
380            IF(lwp) WRITE(numout,*) '            background ocean depth = ', h_oce  , ' meters'
381            !                                       
382            DO jj = 1, jpjdta                              ! zdta :
383               DO ji = 1, jpidta
384                  !zi = FLOAT( ji - ii_bump ) * ppe1_m / r_bump
385                  !zj = FLOAT( jj - ij_bump ) * ppe2_m / r_bump
386                  zi = FLOAT( ji - ii_bump ) / r_bump
387                  zj = FLOAT( jj - ij_bump ) / r_bump
388                  zdta(ji,jj) = h_oce - h_bump * EXP( -( zi*zi + zj*zj ) )
389               END DO
390            END DO
391            !                                              ! idta :
392            IF( ln_sco ) THEN                                   ! s-coordinate (zsc       ): idta()=jpk
393               idta(:,:) = jpkm1
394            ELSE                                                ! z-coordinate (zco or zps): step-like topography
395               idta(:,:) = jpkm1
396               DO jk = 1, jpkm1
397                  WHERE( gdept_0(jk) < zdta(:,:) .AND. zdta(:,:) <= gdept_0(jk+1) )   idta(:,:) = jk
398               END DO
399            ENDIF
400         ENDIF
401         !                                            ! set GLOBAL boundary conditions
402         !                                            ! Caution : idta on the global domain: use of jperio, not nperio
403         IF( jperio == 1 .OR. jperio == 4 .OR. jperio == 6 ) THEN
404            idta( :    , 1    ) = -1                ;      zdta( :    , 1    ) = -1._wp
405            idta( :    ,jpjdta) =  0                ;      zdta( :    ,jpjdta) =  0._wp
406         ELSEIF( jperio == 2 ) THEN
407            idta( :    , 1    ) = idta( : ,  3  )   ;      zdta( :    , 1    ) = zdta( : ,  3  )
408            idta( :    ,jpjdta) = 0                 ;      zdta( :    ,jpjdta) =  0._wp
409            idta( 1    , :    ) = 0                 ;      zdta( 1    , :    ) =  0._wp
410            idta(jpidta, :    ) = 0                 ;      zdta(jpidta, :    ) =  0._wp
411         ELSE
412            ih = 0                                  ;      zh = 0._wp
413            IF( ln_sco )   ih = jpkm1               ;      IF( ln_sco )   zh = h_oce
414            idta( :    , 1    ) = ih                ;      zdta( :    , 1    ) =  zh
415            idta( :    ,jpjdta) = ih                ;      zdta( :    ,jpjdta) =  zh
416            idta( 1    , :    ) = ih                ;      zdta( 1    , :    ) =  zh
417            idta(jpidta, :    ) = ih                ;      zdta(jpidta, :    ) =  zh
418         ENDIF
419
420         !                                            ! local domain level and meter bathymetries (mbathy,bathy)
421         mbathy(:,:) = 0                                   ! set to zero extra halo points
422         bathy (:,:) = 0._wp                               ! (require for mpp case)
423#if defined key_mpp_rkpart
424         DO jj = nldj, nlcj                                   ! interior values
425            DO ji = nldi, nlci
426#else
427         DO jj = 1, nlcj                                   ! interior values
428            DO ji = 1, nlci
429#endif
430               mbathy(ji,jj) = idta( mig(ji), mjg(jj) )
431               bathy (ji,jj) = zdta( mig(ji), mjg(jj) )
432            END DO
433         END DO
434         !
435         !                                            ! ================ !
436      ELSEIF( ntopo == 1 ) THEN                       !   read in file   ! (over the local domain)
437         !                                            ! ================ !
438         !
439         IF( ln_zco )   THEN                          ! zco : read level bathymetry
440            CALL iom_open ( 'bathy_level.nc', inum ) 
441            IF(is_global)THEN
442               CALL iom_get ( inum, jpdom_unknown, 'Bathymetry' , bathy, &
443                              kstart=(/jpizoom,jpjzoom/),                &
444                              kcount=(/jpiglo,jpjglo/) )
445            ELSE
446               CALL iom_get  ( inum, jpdom_data, 'Bathy_level', bathy )
447            END IF
448
449            CALL iom_close( inum )
450            mbathy(:,:) = INT( bathy(:,:) )
451            !                                                ! =====================
452            IF( cp_cfg == "orca" .AND. jp_cfg == 2 ) THEN    ! ORCA R2 configuration
453               !                                             ! =====================
454               IF( nn_cla == 0 ) THEN
455                  ii0 = 140   ;   ii1 = 140                  ! Gibraltar Strait open
456                  ij0 = 102   ;   ij1 = 102                  ! (Thomson, Ocean Modelling, 1995)
457                  DO ji = mi0(ii0), mi1(ii1)
458                     DO jj = mj0(ij0), mj1(ij1)
459                        mbathy(ji,jj) = 15
460                     END DO
461                  END DO
462                  IF(lwp) WRITE(numout,*)
463                  IF(lwp) WRITE(numout,*) '      orca_r2: Gibraltar strait open at i=',ii0,' j=',ij0
464                  !
465                  ii0 = 160   ;   ii1 = 160                  ! Bab el mandeb Strait open
466                  ij0 = 88    ;   ij1 = 88                   ! (Thomson, Ocean Modelling, 1995)
467                  DO ji = mi0(ii0), mi1(ii1)
468                     DO jj = mj0(ij0), mj1(ij1)
469                        mbathy(ji,jj) = 12
470                     END DO
471                  END DO
472                  IF(lwp) WRITE(numout,*)
473                  IF(lwp) WRITE(numout,*) '      orca_r2: Bab el Mandeb strait open at i=',ii0,' j=',ij0
474               ENDIF
475               !
476            ENDIF
477            !
478         ENDIF
479         IF( ln_zps .OR. ln_sco )   THEN              ! zps or sco : read meter bathymetry
480            CALL iom_open ( 'bathy_meter.nc', inum ) 
481            IF(is_global)THEN
482               CALL iom_get ( inum, jpdom_unknown, 'Bathymetry' , bathy, &
483                              kstart=(/jpizoom,jpjzoom/),                &
484                              kcount=(/jpiglo,jpjglo/) )
485            ELSE
486               CALL iom_get  ( inum, jpdom_data, 'Bathymetry', bathy )
487            END IF
488            CALL iom_close( inum )
489            !                                                ! =====================
490            IF( cp_cfg == "orca" .AND. jp_cfg == 1 ) THEN    ! ORCA R1 configuration
491               ii0 = 142   ;   ii1 = 142                     ! =====================
492               ij0 =  51   ;   ij1 =  53                     
493               DO ji = mi0(ii0), mi1(ii1)                    ! Close Halmera Strait
494                  DO jj = mj0(ij0), mj1(ij1)
495                     bathy(ji,jj) = 0._wp
496                  END DO
497               END DO
498               IF(lwp) WRITE(numout,*)
499               IF(lwp) WRITE(numout,*) '      orca_r1: Halmera strait closed at i=',ii0,' j=',ij0,'->',ij1
500            ENDIF
501            !                                                ! =====================
502            IF( cp_cfg == "orca" .AND. jp_cfg == 2 ) THEN    ! ORCA R2 configuration
503               !                                             ! =====================
504              IF( nn_cla == 0 ) THEN
505                 ii0 = 140   ;   ii1 = 140                   ! Gibraltar Strait open
506                 ij0 = 102   ;   ij1 = 102                   ! (Thomson, Ocean Modelling, 1995)
507                 DO ji = mi0(ii0), mi1(ii1)
508                    DO jj = mj0(ij0), mj1(ij1)
509                       bathy(ji,jj) = 284._wp
510                    END DO
511                 END DO
512                 IF(lwp) WRITE(numout,*)
513                 IF(lwp) WRITE(numout,*) '      orca_r2: Gibraltar strait open at i=',ii0,' j=',ij0
514                 !
515                 ii0 = 160   ;   ii1 = 160                   ! Bab el mandeb Strait open
516                 ij0 = 88    ;   ij1 = 88                    ! (Thomson, Ocean Modelling, 1995)
517                 DO ji = mi0(ii0), mi1(ii1)
518                    DO jj = mj0(ij0), mj1(ij1)
519                       bathy(ji,jj) = 137._wp
520                    END DO
521                 END DO
522                 IF(lwp) WRITE(numout,*)
523                 IF(lwp) WRITE(numout,*) '             orca_r2: Bab el Mandeb strait open at i=',ii0,' j=',ij0
524              ENDIF
525              !
526           ENDIF
527            !
528        ENDIF
529         !                                            ! =============== !
530      ELSE                                            !      error      !
531         !                                            ! =============== !
532         WRITE(ctmp1,*) 'parameter , ntopo = ', ntopo
533         CALL ctl_stop( '    zgr_bat : '//trim(ctmp1) )
534      ENDIF
535      !
536      !                                               ! =========================== !
537      IF( nclosea == 0 ) THEN                         !   NO closed seas or lakes   !
538         DO jl = 1, jpncs                             ! =========================== !
539            DO jj = ncsj1(jl), ncsj2(jl)
540               DO ji = ncsi1(jl), ncsi2(jl)
541                  mbathy(ji,jj) = 0                   ! suppress closed seas and lakes from bathymetry
542                  bathy (ji,jj) = 0._wp               
543               END DO
544            END DO
545         END DO
546      ENDIF
547      !
548      !                                               ! =========================== !
549      !                                               !     set a minimum depth     !
550      !                                               ! =========================== !
551      IF ( .not. ln_sco ) THEN
552         IF( rn_hmin < 0._wp ) THEN    ;   ik = - INT( rn_hmin )                                      ! from a nb of level
553         ELSE                          ;   ik = MINLOC( gdepw_0, mask = gdepw_0 > rn_hmin, dim = 1 )  ! from a depth
554         ENDIF
555         zhmin = gdepw_0(ik+1)                                                         ! minimum depth = ik+1 w-levels
556         WHERE( bathy(:,:) <= 0._wp )   ;   bathy(:,:) = 0._wp                         ! min=0     over the lands
557         ELSEWHERE                      ;   bathy(:,:) = MAX(  zhmin , bathy(:,:)  )   ! min=zhmin over the oceans
558         END WHERE
559         IF(lwp) write(numout,*) 'Minimum ocean depth: ', zhmin, ' minimum number of ocean levels : ', ik
560      ENDIF
561      !
562   END SUBROUTINE zgr_bat
563
564
565   SUBROUTINE zgr_bat_zoom
566      !!----------------------------------------------------------------------
567      !!                    ***  ROUTINE zgr_bat_zoom  ***
568      !!
569      !! ** Purpose : - Close zoom domain boundary if necessary
570      !!              - Suppress Med Sea from ORCA R2 and R05 arctic zoom
571      !!
572      !! ** Method  :
573      !!
574      !! ** Action  : - update mbathy: level bathymetry (in level index)
575      !!----------------------------------------------------------------------
576      INTEGER ::   ii0, ii1, ij0, ij1   ! temporary integers
577      !!----------------------------------------------------------------------
578      !
579      IF(lwp) WRITE(numout,*)
580      IF(lwp) WRITE(numout,*) '    zgr_bat_zoom : modify the level bathymetry for zoom domain'
581      IF(lwp) WRITE(numout,*) '    ~~~~~~~~~~~~'
582      !
583      ! Zoom domain
584      ! ===========
585      !
586      ! Forced closed boundary if required
587      IF( lzoom_s )   mbathy(  : , mj0(jpjzoom):mj1(jpjzoom) )      = 0
588      IF( lzoom_w )   mbathy(      mi0(jpizoom):mi1(jpizoom) , :  ) = 0
589      IF( lzoom_e )   mbathy(      mi0(jpiglo+jpizoom-1):mi1(jpiglo+jpizoom-1) , :  ) = 0
590      IF( lzoom_n )   mbathy(  : , mj0(jpjglo+jpjzoom-1):mj1(jpjglo+jpjzoom-1) )      = 0
591      !
592      ! Configuration specific domain modifications
593      ! (here, ORCA arctic configuration: suppress Med Sea)
594      IF( cp_cfg == "orca" .AND. lzoom_arct ) THEN
595         SELECT CASE ( jp_cfg )
596         !                                        ! =======================
597         CASE ( 2 )                               !  ORCA_R2 configuration
598            !                                     ! =======================
599            IF(lwp) WRITE(numout,*) '                   ORCA R2 arctic zoom: suppress the Med Sea'
600            ii0 = 141   ;   ii1 = 162      ! Sea box i,j indices
601            ij0 =  98   ;   ij1 = 110
602            !                                     ! =======================
603         CASE ( 05 )                              !  ORCA_R05 configuration
604            !                                     ! =======================
605            IF(lwp) WRITE(numout,*) '                   ORCA R05 arctic zoom: suppress the Med Sea'
606            ii0 = 563   ;   ii1 = 642      ! zero over the Med Sea boxe
607            ij0 = 314   ;   ij1 = 370 
608         END SELECT
609         !
610         mbathy( mi0(ii0):mi1(ii1) , mj0(ij0):mj1(ij1) ) = 0   ! zero over the Med Sea boxe
611         !
612      ENDIF
613      !
614   END SUBROUTINE zgr_bat_zoom
615
616
617   SUBROUTINE zgr_bat_ctl
618      !!----------------------------------------------------------------------
619      !!                    ***  ROUTINE zgr_bat_ctl  ***
620      !!
621      !! ** Purpose :   check the bathymetry in levels
622      !!
623      !! ** Method  :   The array mbathy is checked to verified its consistency
624      !!      with the model options. in particular:
625      !!            mbathy must have at least 1 land grid-points (mbathy<=0)
626      !!                  along closed boundary.
627      !!            mbathy must be cyclic IF jperio=1.
628      !!            mbathy must be lower or equal to jpk-1.
629      !!            isolated ocean grid points are suppressed from mbathy
630      !!                  since they are only connected to remaining
631      !!                  ocean through vertical diffusion.
632      !!      C A U T I O N : mbathy will be modified during the initializa-
633      !!      tion phase to become the number of non-zero w-levels of a water
634      !!      column, with a minimum value of 1.
635      !!
636      !! ** Action  : - update mbathy: level bathymetry (in level index)
637      !!              - update bathy : meter bathymetry (in meters)
638      !!----------------------------------------------------------------------
639      USE mapcomm_mod, ONLY:   trimmed, nidx,eidx,sidx,widx
640      USE wrk_nemo,    ONLY:   wrk_in_use, wrk_not_released
641      USE wrk_nemo,    ONLY:   zbathy => wrk_2d_1
642      !!
643      INTEGER ::   ji, jj, jl                    ! dummy loop indices
644      INTEGER ::   icompt, ibtest, ikmax         ! temporary integers
645      !!----------------------------------------------------------------------
646
647      IF( wrk_in_use(2, 1) ) THEN
648         CALL ctl_stop('zgr_bat_ctl: requested workspace array unavailable')   ;   RETURN
649      ENDIF
650
651      IF(lwp) WRITE(numout,*)
652      IF(lwp) WRITE(numout,*) '    zgr_bat_ctl : check the bathymetry'
653      IF(lwp) WRITE(numout,*) '    ~~~~~~~~~~~'
654
655      !                                          ! Suppress isolated ocean grid points
656      IF(lwp) WRITE(numout,*)
657      IF(lwp) WRITE(numout,*)'                   suppress isolated ocean grid points'
658      IF(lwp) WRITE(numout,*)'                   -----------------------------------'
659      icompt = 0
660      DO jl = 1, 2
661         IF( nperio == 1 .OR. nperio  ==  4 .OR. nperio  ==  6 ) THEN
662            mbathy( 1 ,:) = mbathy(jpim1,:)           ! local domain is cyclic east-west
663            mbathy(jpi,:) = mbathy(  2  ,:)
664         ENDIF
665         DO jj = 2, jpjm1
666            DO ji = 2, jpim1
667               ibtest = MAX(  mbathy(ji-1,jj), mbathy(ji+1,jj),   &
668                  &           mbathy(ji,jj-1), mbathy(ji,jj+1)  )
669               IF( ibtest < mbathy(ji,jj) ) THEN
670                  IF(lwp) WRITE(numout,*) ' the number of ocean level at ',   &
671                     &   'grid-point (i,j) =  ',ji,jj,' is changed from ', mbathy(ji,jj),' to ', ibtest
672                  mbathy(ji,jj) = ibtest
673                  icompt = icompt + 1
674               ENDIF
675            END DO
676         END DO
677      END DO
678      IF( icompt == 0 ) THEN
679         IF(lwp) WRITE(numout,*)'     no isolated ocean grid points'
680      ELSE
681         IF(lwp) WRITE(numout,*)'    ',icompt,' ocean grid points suppressed'
682      ENDIF
683
684      IF( lk_mpp ) THEN
685         zbathy(:,:) = FLOAT( mbathy(:,:) )
686         CALL lbc_lnk( zbathy, 'T', 1._wp )
687         mbathy(:,:) = INT( zbathy(:,:) )
688      ENDIF
689
690      !                                          ! East-west cyclic boundary conditions
691      IF( nperio == 0 ) THEN
692         IF(lwp) WRITE(numout,*) ' mbathy set to 0 along east and west boundary: nperio = ', nperio
693         IF( lk_mpp ) THEN
694            IF( (nbondi == -1 .OR. nbondi == 2) .AND. (.NOT. trimmed(widx,narea) ) ) THEN
695               IF( jperio /= 1 )   mbathy(1,:) = 0
696            ENDIF
697            IF( (nbondi == 1 .OR. nbondi == 2) .AND. (.NOT. trimmed(eidx,narea) ) ) THEN
698               IF( jperio /= 1 )   mbathy(nlci,:) = 0
699            ENDIF
700         ELSE
701            IF( ln_zco .OR. ln_zps ) THEN
702               mbathy( 1 ,:) = 0
703               mbathy(jpi,:) = 0
704            ELSE
705               mbathy( 1 ,:) = jpkm1
706               mbathy(jpi,:) = jpkm1
707            ENDIF
708         ENDIF
709      ELSEIF( nperio == 1 .OR. nperio == 4 .OR. nperio ==  6 ) THEN
710         IF(lwp) WRITE(numout,*)' east-west cyclic boundary conditions on mbathy: nperio = ', nperio
711         mbathy( 1 ,:) = mbathy(jpim1,:)
712         mbathy(jpi,:) = mbathy(  2  ,:)
713      ELSEIF( nperio == 2 ) THEN
714         IF(lwp) WRITE(numout,*) '   equatorial boundary conditions on mbathy: nperio = ', nperio
715      ELSE
716         IF(lwp) WRITE(numout,*) '    e r r o r'
717         IF(lwp) WRITE(numout,*) '    parameter , nperio = ', nperio
718         !         STOP 'dom_mba'
719      ENDIF
720
721      !  Boundary condition on mbathy
722      IF( .NOT.lk_mpp ) THEN 
723!!gm     !!bug ???  think about it !
724         !   ... mono- or macro-tasking: T-point, >0, 2D array, no slab
725         zbathy(:,:) = FLOAT( mbathy(:,:) )
726         CALL lbc_lnk( zbathy, 'T', 1._wp )
727         mbathy(:,:) = INT( zbathy(:,:) )
728      ENDIF
729
730      ! Number of ocean level inferior or equal to jpkm1
731      ikmax = 0
732      DO jj = 1, jpj
733         DO ji = 1, jpi
734            ikmax = MAX( ikmax, mbathy(ji,jj) )
735         END DO
736      END DO
737!!gm  !!! test to do:   ikmax = MAX( mbathy(:,:) )   ???
738      IF( ikmax > jpkm1 ) THEN
739         IF(lwp) WRITE(numout,*) ' maximum number of ocean level = ', ikmax,' >  jpk-1'
740         IF(lwp) WRITE(numout,*) ' change jpk to ',ikmax+1,' to use the exact ead bathymetry'
741      ELSE IF( ikmax < jpkm1 ) THEN
742         IF(lwp) WRITE(numout,*) ' maximum number of ocean level = ', ikmax,' < jpk-1' 
743         IF(lwp) WRITE(numout,*) ' you can decrease jpk to ', ikmax+1
744      ENDIF
745
746      IF( lwp .AND. nprint == 1 ) THEN      ! control print
747         WRITE(numout,*)
748         WRITE(numout,*) ' bathymetric field :   number of non-zero T-levels '
749         WRITE(numout,*) ' ------------------'
750         CALL prihin( mbathy, jpi, jpj, 1, jpi, 1, 1, jpj, 1, 3, numout )
751         WRITE(numout,*)
752      ENDIF
753      !
754      IF( wrk_not_released(2, 1) )   CALL ctl_stop('zgr_bat_ctl: failed to release workspace array')
755      !
756   END SUBROUTINE zgr_bat_ctl
757
758
759   SUBROUTINE zgr_bot_level
760      !!----------------------------------------------------------------------
761      !!                    ***  ROUTINE zgr_bot_level  ***
762      !!
763      !! ** Purpose :   defines the vertical index of ocean bottom (mbk. arrays)
764      !!
765      !! ** Method  :   computes from mbathy with a minimum value of 1 over land
766      !!
767      !! ** Action  :   mbkt, mbku, mbkv :   vertical indices of the deeptest
768      !!                                     ocean level at t-, u- & v-points
769      !!                                     (min value = 1 over land)
770      !!----------------------------------------------------------------------
771      !USE arpdebugging, ONLY: dump_array
772      USE wrk_nemo, ONLY:   wrk_in_use, wrk_not_released
773      USE wrk_nemo, ONLY:   zmbk => wrk_2d_1
774      !!
775      INTEGER ::   ji, jj   ! dummy loop indices
776      !!----------------------------------------------------------------------
777      !
778      IF( wrk_in_use(2, 1) ) THEN
779         CALL ctl_stop('zgr_bot_level: requested 2D workspace unavailable')   ;   RETURN
780      ENDIF
781      !
782      IF(lwp) WRITE(numout,*)
783      IF(lwp) WRITE(numout,*) '    zgr_bot_level : ocean bottom k-index of T-, U-, V- and W-levels '
784      IF(lwp) WRITE(numout,*) '    ~~~~~~~~~~~~~'
785      !
786      !CALL dump_array(0, 'mbathy', mbathy, withHalos=.TRUE.)
787
788      mbkt(:,:) = MAX( mbathy(:,:) , 1 )    ! bottom k-index of T-level (=1 over land)
789      !                                     ! bottom k-index of W-level = mbkt+1
790      DO jj = 1, jpjm1                      ! bottom k-index of u- (v-) level
791         DO ji = 1, jpim1
792            mbku(ji,jj) = MIN(  mbkt(ji+1,jj  ) , mbkt(ji,jj)  )
793            mbkv(ji,jj) = MIN(  mbkt(ji  ,jj+1) , mbkt(ji,jj)  )
794         END DO
795      END DO
796      ! converte into REAL to use lbc_lnk ; impose a min value of 1 as a zero can be set in lbclnk
797      zmbk(:,:) = REAL( mbku(:,:), wp )   ;   CALL lbc_lnk(zmbk,'U',1.)   ;   mbku  (:,:) = MAX( INT( zmbk(:,:) ), 1 )
798      zmbk(:,:) = REAL( mbkv(:,:), wp )   ;   CALL lbc_lnk(zmbk,'V',1.)   ;   mbkv  (:,:) = MAX( INT( zmbk(:,:) ), 1 )
799      !
800      ! Compute and store the deepest bottom level of any grid-type at each grid point
801      ! For use in removing data below ocean floor from halo exchanges.
802      mbkmax(:,:) = MAX(mbkt(:,:)+1, mbku(:,:), mbkv(:,:))
803      !
804      IF( wrk_not_released(2, 1) )   CALL ctl_stop('zgr_bot_level: failed to release workspace array')
805      !
806   END SUBROUTINE zgr_bot_level
807
808
809   SUBROUTINE zgr_zco
810      !!----------------------------------------------------------------------
811      !!                  ***  ROUTINE zgr_zco  ***
812      !!
813      !! ** Purpose :   define the z-coordinate system
814      !!
815      !! ** Method  :   set 3D coord. arrays to reference 1D array
816      !!----------------------------------------------------------------------
817#if defined key_z_first
818      INTEGER  ::   ji, jj   ! Dummy loop indices
819#else
820      INTEGER  ::   jk
821#endif
822      !!----------------------------------------------------------------------
823      !
824#if defined key_z_first
825      DO jj = 1, jpj
826         DO ji = 1, jpi
827            fsdept(ji,jj,:) = gdept_0(:)
828            fsdepw(ji,jj,:) = gdepw_0(:)
829            fsde3w(ji,jj,:) = gdepw_0(:)
830            fse3t (ji,jj,:) = e3t_0(:)
831            fse3u (ji,jj,:) = e3t_0(:)
832            fse3v (ji,jj,:) = e3t_0(:)
833            fse3f (ji,jj,:) = e3t_0(:)
834            fse3w (ji,jj,:) = e3w_0(:)
835            fse3uw(ji,jj,:) = e3w_0(:)
836            fse3vw(ji,jj,:) = e3w_0(:)
837         END DO
838      END DO
839#else
840      DO jk = 1, jpk
841         fsdept(:,:,jk) = gdept_0(jk)
842         fsdepw(:,:,jk) = gdepw_0(jk)
843         fsde3w(:,:,jk) = gdepw_0(jk)
844         fse3t (:,:,jk) = e3t_0(jk)
845         fse3u (:,:,jk) = e3t_0(jk)
846         fse3v (:,:,jk) = e3t_0(jk)
847         fse3f (:,:,jk) = e3t_0(jk)
848         fse3w (:,:,jk) = e3w_0(jk)
849         fse3uw(:,:,jk) = e3w_0(jk)
850         fse3vw(:,:,jk) = e3w_0(jk)
851      END DO
852#endif
853      !
854   END SUBROUTINE zgr_zco
855
856
857   SUBROUTINE zgr_zps(pre_domain_decomp)
858      !!----------------------------------------------------------------------
859      !!                  ***  ROUTINE zgr_zps  ***
860      !!                     
861      !! ** Purpose :   the depth and vertical scale factor in partial step
862      !!      z-coordinate case
863      !!
864      !! ** Method  :   Partial steps : computes the 3D vertical scale factors
865      !!      of T-, U-, V-, W-, UW-, VW and F-points that are associated with
866      !!      a partial step representation of bottom topography.
867      !!
868      !!        The reference depth of model levels is defined from an analytical
869      !!      function the derivative of which gives the reference vertical
870      !!      scale factors.
871      !!        From  depth and scale factors reference, we compute there new value
872      !!      with partial steps  on 3d arrays ( i, j, k ).
873      !!
874      !!              w-level: gdepw(i,j,k)  = fsdep(k)
875      !!                       e3w(i,j,k) = dk(fsdep)(k)     = fse3(i,j,k)
876      !!              t-level: gdept(i,j,k)  = fsdep(k+0.5)
877      !!                       e3t(i,j,k) = dk(fsdep)(k+0.5) = fse3(i,j,k+0.5)
878      !!
879      !!        With the help of the bathymetric file ( bathymetry_depth_ORCA_R2.nc),
880      !!      we find the mbathy index of the depth at each grid point.
881      !!      This leads us to three cases:
882      !!
883      !!              - bathy = 0 => mbathy = 0
884      !!              - 1 < mbathy < jpkm1   
885      !!              - bathy > gdepw(jpk) => mbathy = jpkm1 
886      !!
887      !!        Then, for each case, we find the new depth at t- and w- levels
888      !!      and the new vertical scale factors at t-, u-, v-, w-, uw-, vw-
889      !!      and f-points.
890      !!
891      !!        This routine is given as an example, it must be modified
892      !!      following the user s desiderata. nevertheless, the output as
893      !!      well as the way to compute the model levels and scale factors
894      !!      must be respected in order to insure second order accuracy
895      !!      schemes.
896      !!
897      !!         c a u t i o n : gdept_0, gdepw_0 and e3._0 are positives
898      !!         - - - - - - -   gdept, gdepw and e3. are positives
899      !!     
900      !!  Reference :   Pacanowsky & Gnanadesikan 1997, Mon. Wea. Rev., 126, 3248-3270.
901      !!----------------------------------------------------------------------
902      USE wrk_nemo, ONLY:   wrk_in_use, wrk_not_released
903      USE wrk_nemo, ONLY:   zprt => wrk_3d_1
904      !! DCSE_NEMO: wrk_3d_1 renamed, need additional directive
905!FTRANS zprt :I :I :z
906      LOGICAL, INTENT(in), OPTIONAL :: pre_domain_decomp
907      !!
908      INTEGER  ::   ji, jj, jk       ! dummy loop indices
909      INTEGER  ::   ik, it           ! temporary integers
910      LOGICAL  ::   ll_print         ! Allow  control print for debugging
911      REAL(wp) ::   ze3tp , ze3wp    ! Last ocean level thickness at T- and W-points
912      REAL(wp) ::   zdepwp, zdepth   ! Ajusted ocean depth to avoid too small e3t
913      REAL(wp) ::   zmax             ! Maximum depth
914      REAL(wp) ::   zdiff            ! temporary scalar
915      REAL(wp) ::   zrefdep          ! temporary scalar
916      !!---------------------------------------------------------------------
917      !
918      IF( wrk_in_use(3, 1) ) THEN
919         CALL ctl_stop('zgr_zps: requested workspace unavailable.')   ;   RETURN
920      ENDIF
921
922      IF(lwp) WRITE(numout,*)
923      IF(lwp) WRITE(numout,*) '    zgr_zps : z-coordinate with partial steps'
924      IF(lwp) WRITE(numout,*) '    ~~~~~~~ '
925      IF(lwp) WRITE(numout,*) '              mbathy is recomputed : bathy_level file is NOT used'
926
927      ll_print = .FALSE.                   ! Local variable for debugging
928     
929      IF(lwp .AND. ll_print) THEN          ! control print of the ocean depth
930         WRITE(numout,*)
931         WRITE(numout,*) 'dom_zgr_zps:  bathy (in hundred of meters)'
932         CALL prihre( bathy, jpi, jpj, 1,jpi, 1, 1, jpj, 1, 1.e-2, numout )
933      ENDIF
934
935
936      ! bathymetry in level (from bathy_meter)
937      ! ===================
938      zmax = gdepw_0(jpk) + e3t_0(jpk)          ! maximum depth (i.e. the last ocean level thickness <= 2*e3t_0(jpkm1) )
939      bathy(:,:) = MIN( zmax ,  bathy(:,:) )    ! bounded value of bathy (min already set at the end of zgr_bat)
940      WHERE( bathy(:,:) == 0._wp )   ;   mbathy(:,:) = 0       ! land  : set mbathy to 0
941      ELSEWHERE                     ;   mbathy(:,:) = jpkm1   ! ocean : initialize mbathy to the max ocean level
942      END WHERE
943
944      ! Compute mbathy for ocean points (i.e. the number of ocean levels)
945      ! find the number of ocean levels such that the last level thickness
946      ! is larger than the minimum of e3zps_min and e3zps_rat * e3t_0 (where
947      ! e3t_0 is the reference level thickness
948      DO jk = jpkm1, 1, -1
949         zdepth = gdepw_0(jk) + MIN( e3zps_min, e3t_0(jk)*e3zps_rat )
950         WHERE( 0._wp < bathy(:,:) .AND. bathy(:,:) <= zdepth )   mbathy(:,:) = jk-1
951      END DO
952
953      ! If we've been called before domain decomposition then we only want to compute
954      ! mbathy and the return.
955      IF( PRESENT(pre_domain_decomp) )THEN
956         IF( pre_domain_decomp )RETURN
957      ENDIF
958
959      ! Scale factors and depth at T- and W-points
960#if defined key_z_first
961      DO jj = 1, jpj
962         DO ji = 1, jpi                     ! intitialization to the reference z-coordinate
963            gdept(ji,jj,:) = gdept_0(:)
964            gdepw(ji,jj,:) = gdepw_0(:)
965            e3t  (ji,jj,:) = e3t_0  (:)
966            e3w  (ji,jj,:) = e3w_0  (:)
967         END DO
968      END DO
969#else
970      DO jk = 1, jpk                        ! intitialization to the reference z-coordinate
971         gdept(:,:,jk) = gdept_0(jk)
972         gdepw(:,:,jk) = gdepw_0(jk)
973         e3t  (:,:,jk) = e3t_0  (jk)
974         e3w  (:,:,jk) = e3w_0  (jk)
975      END DO
976#endif
977      !
978      DO jj = 1, jpj
979         DO ji = 1, jpi
980            ik = mbathy(ji,jj)
981            IF( ik > 0 ) THEN               ! ocean point only
982               ! max ocean level case
983               IF( ik == jpkm1 ) THEN
984                  zdepwp = bathy(ji,jj)
985                  ze3tp  = bathy(ji,jj) - gdepw_0(ik)
986                  ze3wp = 0.5_wp * e3w_0(ik) * ( 1._wp + ( ze3tp/e3t_0(ik) ) )
987                  e3t(ji,jj,ik  ) = ze3tp
988                  e3t(ji,jj,ik+1) = ze3tp
989                  e3w(ji,jj,ik  ) = ze3wp
990                  e3w(ji,jj,ik+1) = ze3tp
991                  gdepw(ji,jj,ik+1) = zdepwp
992                  gdept(ji,jj,ik  ) = gdept_0(ik-1) + ze3wp
993                  gdept(ji,jj,ik+1) = gdept(ji,jj,ik) + ze3tp
994                  !
995               ELSE                         ! standard case
996                  IF( bathy(ji,jj) <= gdepw_0(ik+1) ) THEN   ;   gdepw(ji,jj,ik+1) = bathy(ji,jj)
997                  ELSE                                       ;   gdepw(ji,jj,ik+1) = gdepw_0(ik+1)
998                  ENDIF
999!gm Bug?  check the gdepw_0
1000                  !       ... on ik
1001                  gdept(ji,jj,ik) = gdepw_0(ik) + ( gdepw  (ji,jj,ik+1) - gdepw_0(ik) )   &
1002                     &                          * ((gdept_0(      ik  ) - gdepw_0(ik) )   &
1003                     &                          / ( gdepw_0(      ik+1) - gdepw_0(ik) ))
1004                  e3t  (ji,jj,ik) = e3t_0  (ik) * ( gdepw  (ji,jj,ik+1) - gdepw_0(ik) )   & 
1005                     &                          / ( gdepw_0(      ik+1) - gdepw_0(ik) ) 
1006                  e3w  (ji,jj,ik) = 0.5_wp * ( gdepw(ji,jj,ik+1) + gdepw_0(ik+1) - 2._wp * gdepw_0(ik) )   &
1007                     &                     * ( e3w_0(ik) / ( gdepw_0(ik+1) - gdepw_0(ik) ) )
1008                  !       ... on ik+1
1009                  e3w  (ji,jj,ik+1) = e3t  (ji,jj,ik)
1010                  e3t  (ji,jj,ik+1) = e3t  (ji,jj,ik)
1011                  gdept(ji,jj,ik+1) = gdept(ji,jj,ik) + e3t(ji,jj,ik)
1012               ENDIF
1013            ENDIF
1014         END DO
1015      END DO
1016      !
1017      it = 0
1018      DO jj = 1, jpj
1019         DO ji = 1, jpi
1020            ik = mbathy(ji,jj)
1021            IF( ik > 0 ) THEN               ! ocean point only
1022               e3tp (ji,jj) = e3t(ji,jj,ik  )
1023               e3wp (ji,jj) = e3w(ji,jj,ik  )
1024               ! test
1025               zdiff= gdepw(ji,jj,ik+1) - gdept(ji,jj,ik  )
1026               IF( zdiff <= 0._wp .AND. lwp ) THEN
1027                  it = it + 1
1028                  WRITE(numout,*) ' it      = ', it, ' ik      = ', ik, ' (i,j) = ', ji, jj
1029                  WRITE(numout,*) ' bathy = ', bathy(ji,jj)
1030                  WRITE(numout,*) ' gdept = ', gdept(ji,jj,ik), ' gdepw = ', gdepw(ji,jj,ik+1), ' zdiff = ', zdiff
1031                  WRITE(numout,*) ' e3tp  = ', e3t  (ji,jj,ik), ' e3wp  = ', e3w  (ji,jj,ik  )
1032               ENDIF
1033            ENDIF
1034         END DO
1035      END DO
1036
1037      ! Scale factors and depth at U-, V-, UW and VW-points
1038#if defined key_z_first
1039      DO jj = 1, jpj                        ! initialisation to z-scale factors
1040         DO ji = 1, jpi
1041            e3u (ji,jj,:) = e3t_0(:)
1042            e3v (ji,jj,:) = e3t_0(:)
1043            e3uw(ji,jj,:) = e3w_0(:)
1044            e3vw(ji,jj,:) = e3w_0(:)
1045         END DO
1046      END DO
1047#else
1048      DO jk = 1, jpk                        ! initialisation to z-scale factors
1049         e3u (:,:,jk) = e3t_0(jk)
1050         e3v (:,:,jk) = e3t_0(jk)
1051         e3uw(:,:,jk) = e3w_0(jk)
1052         e3vw(:,:,jk) = e3w_0(jk)
1053      END DO
1054#endif
1055#if defined key_z_first
1056      DO jj = 1, jpjm1
1057         DO ji = 1, jpim1
1058            DO jk = 1, jpk        ! Computed as the minimum of neighbouring scale factors
1059#else
1060      DO jk = 1,jpk               ! Computed as the minimum of neighbouring scale factors
1061         DO jj = 1, jpjm1
1062            DO ji = 1, fs_jpim1   ! vector opt.
1063#endif
1064               e3u (ji,jj,jk) = MIN( e3t(ji,jj,jk), e3t(ji+1,jj,jk) )
1065               e3v (ji,jj,jk) = MIN( e3t(ji,jj,jk), e3t(ji,jj+1,jk) )
1066               e3uw(ji,jj,jk) = MIN( e3w(ji,jj,jk), e3w(ji+1,jj,jk) )
1067               e3vw(ji,jj,jk) = MIN( e3w(ji,jj,jk), e3w(ji,jj+1,jk) )
1068            END DO
1069         END DO
1070      END DO
1071      CALL lbc_lnk( e3u , 'U', 1._wp )   ;   CALL lbc_lnk( e3uw, 'U', 1._wp )   ! lateral boundary conditions
1072      CALL lbc_lnk( e3v , 'V', 1._wp )   ;   CALL lbc_lnk( e3vw, 'V', 1._wp )
1073      !
1074      DO jk = 1, jpk                        ! set to z-scale factor if zero (i.e. along closed boundaries)
1075         WHERE( e3u (:,:,jk) == 0._wp )   e3u (:,:,jk) = e3t_0(jk)
1076         WHERE( e3v (:,:,jk) == 0._wp )   e3v (:,:,jk) = e3t_0(jk)
1077         WHERE( e3uw(:,:,jk) == 0._wp )   e3uw(:,:,jk) = e3w_0(jk)
1078         WHERE( e3vw(:,:,jk) == 0._wp )   e3vw(:,:,jk) = e3w_0(jk)
1079      END DO
1080     
1081      ! Scale factor at F-point
1082#if defined key_z_first
1083      DO jj = 1, jpj
1084         DO ji = 1, jpi                     ! initialisation to z-scale factors
1085            e3f(ji,jj,:) = e3t_0(:)
1086         END DO
1087      END DO
1088      DO jj = 1, jpjm1
1089         DO ji = 1, jpim1                   ! NO vector opt.
1090            DO jk = 1, jpk                  ! Computed as the minimum of neighbooring V-scale factors
1091               e3f(ji,jj,jk) = MIN( e3v(ji,jj,jk), e3v(ji+1,jj,jk) )
1092            END DO
1093         END DO
1094      END DO
1095#else
1096      DO jk = 1, jpk                        ! initialisation to z-scale factors
1097         e3f(:,:,jk) = e3t_0(jk)
1098      END DO
1099      DO jk = 1, jpk                        ! Computed as the minimum of neighbooring V-scale factors
1100         DO jj = 1, jpjm1
1101            DO ji = 1, fs_jpim1   ! vector opt.
1102               e3f(ji,jj,jk) = MIN( e3v(ji,jj,jk), e3v(ji+1,jj,jk) )
1103            END DO
1104         END DO
1105      END DO
1106#endif
1107      CALL lbc_lnk( e3f, 'F', 1._wp )       ! Lateral boundary conditions
1108      !
1109      DO jk = 1, jpk                        ! set to z-scale factor if zero (i.e. along closed boundaries)
1110         WHERE( e3f(:,:,jk) == 0._wp )   e3f(:,:,jk) = e3t_0(jk)
1111      END DO
1112!!gm  bug ? :  must be a do loop with mj0,mj1
1113      !
1114      e3t(:,mj0(1),:) = e3t(:,mj0(2),:)     ! we duplicate factor scales for jj = 1 and jj = 2
1115      e3w(:,mj0(1),:) = e3w(:,mj0(2),:) 
1116      e3u(:,mj0(1),:) = e3u(:,mj0(2),:) 
1117      e3v(:,mj0(1),:) = e3v(:,mj0(2),:) 
1118      e3f(:,mj0(1),:) = e3f(:,mj0(2),:) 
1119
1120      ! Control of the sign
1121      IF( MINVAL( e3t  (:,:,:) ) <= 0._wp )   CALL ctl_stop( '    zgr_zps :   e r r o r   e3t   <= 0' )
1122      IF( MINVAL( e3w  (:,:,:) ) <= 0._wp )   CALL ctl_stop( '    zgr_zps :   e r r o r   e3w   <= 0' )
1123      IF( MINVAL( gdept(:,:,:) ) <  0._wp )   CALL ctl_stop( '    zgr_zps :   e r r o r   gdepw <  0' )
1124      IF( MINVAL( gdepw(:,:,:) ) <  0._wp )   CALL ctl_stop( '    zgr_zps :   e r r o r   gdepw <  0' )
1125     
1126      ! Compute gdep3w (vertical sum of e3w)
1127      gdep3w(:,:,1) = 0.5_wp * e3w(:,:,1)
1128      DO jk = 2, jpk
1129         gdep3w(:,:,jk) = gdep3w(:,:,jk-1) + e3w(:,:,jk) 
1130      END DO
1131       
1132      !                                               ! ================= !
1133      IF(lwp .AND. ll_print) THEN                     !   Control print   !
1134         !                                            ! ================= !
1135         DO jj = 1,jpj
1136            DO ji = 1, jpi
1137               ik = MAX( mbathy(ji,jj), 1 )
1138               zprt(ji,jj,1) = e3t   (ji,jj,ik)
1139               zprt(ji,jj,2) = e3w   (ji,jj,ik)
1140               zprt(ji,jj,3) = e3u   (ji,jj,ik)
1141               zprt(ji,jj,4) = e3v   (ji,jj,ik)
1142               zprt(ji,jj,5) = e3f   (ji,jj,ik)
1143               zprt(ji,jj,6) = gdep3w(ji,jj,ik)
1144            END DO
1145         END DO
1146         WRITE(numout,*)
1147         WRITE(numout,*) 'domzgr e3t(mbathy)'      ;   CALL prihre(zprt(:,:,1),jpi,jpj,1,jpi,1,1,jpj,1,1.e-3,numout)
1148         WRITE(numout,*)
1149         WRITE(numout,*) 'domzgr e3w(mbathy)'      ;   CALL prihre(zprt(:,:,1),jpi,jpj,1,jpi,1,1,jpj,1,1.e-3,numout)
1150         WRITE(numout,*)
1151         WRITE(numout,*) 'domzgr e3u(mbathy)'      ;   CALL prihre(zprt(:,:,1),jpi,jpj,1,jpi,1,1,jpj,1,1.e-3,numout)
1152         WRITE(numout,*)
1153         WRITE(numout,*) 'domzgr e3v(mbathy)'      ;   CALL prihre(zprt(:,:,1),jpi,jpj,1,jpi,1,1,jpj,1,1.e-3,numout)
1154         WRITE(numout,*)
1155         WRITE(numout,*) 'domzgr e3f(mbathy)'      ;   CALL prihre(zprt(:,:,1),jpi,jpj,1,jpi,1,1,jpj,1,1.e-3,numout)
1156         WRITE(numout,*)
1157         WRITE(numout,*) 'domzgr gdep3w(mbathy)'   ;   CALL prihre(zprt(:,:,1),jpi,jpj,1,jpi,1,1,jpj,1,1.e-3,numout)
1158      ENDIF 
1159      !
1160      IF( wrk_not_released(3, 1) )   CALL ctl_stop('zgr_zps: failed to release workspace')
1161      !
1162   END SUBROUTINE zgr_zps
1163
1164
1165   FUNCTION fssig( pk ) RESULT( pf )
1166      !!----------------------------------------------------------------------
1167      !!                 ***  ROUTINE eos_init  ***
1168      !!       
1169      !! ** Purpose :   provide the analytical function in s-coordinate
1170      !!         
1171      !! ** Method  :   the function provide the non-dimensional position of
1172      !!                T and W (i.e. between 0 and 1)
1173      !!                T-points at integer values (between 1 and jpk)
1174      !!                W-points at integer values - 1/2 (between 0.5 and jpk-0.5)
1175      !!----------------------------------------------------------------------
1176      REAL(wp), INTENT(in) ::   pk   ! continuous "k" coordinate
1177      REAL(wp)             ::   pf   ! sigma value
1178      !!----------------------------------------------------------------------
1179      !
1180      pf =   (   TANH( rn_theta * ( -(pk-0.5_wp) / REAL(jpkm1) + rn_thetb )  )   &
1181         &     - TANH( rn_thetb * rn_theta                                )  )   &
1182         & * (   COSH( rn_theta                           )                      &
1183         &     + COSH( rn_theta * ( 2._wp * rn_thetb - 1._wp ) )  )              &
1184         & / ( 2._wp * SINH( rn_theta ) )
1185      !
1186   END FUNCTION fssig
1187
1188
1189   FUNCTION fssig1( pk1, pbb ) RESULT( pf1 )
1190      !!----------------------------------------------------------------------
1191      !!                 ***  ROUTINE eos_init  ***
1192      !!
1193      !! ** Purpose :   provide the Song and Haidvogel version of the analytical function in s-coordinate
1194      !!
1195      !! ** Method  :   the function provides the non-dimensional position of
1196      !!                T and W (i.e. between 0 and 1)
1197      !!                T-points at integer values (between 1 and jpk)
1198      !!                W-points at integer values - 1/2 (between 0.5 and jpk-0.5)
1199      !!----------------------------------------------------------------------
1200      REAL(wp), INTENT(in) ::   pk1   ! continuous "k" coordinate
1201      REAL(wp), INTENT(in) ::   pbb   ! Stretching coefficient
1202      REAL(wp)             ::   pf1   ! sigma value
1203      !!----------------------------------------------------------------------
1204      !
1205      IF ( rn_theta == 0 ) then      ! uniform sigma
1206         pf1 = - ( pk1 - 0.5_wp ) / REAL( jpkm1 )
1207      ELSE                        ! stretched sigma
1208         pf1 =   ( 1._wp - pbb ) * ( SINH( rn_theta*(-(pk1-0.5_wp)/REAL(jpkm1)) ) ) / SINH( rn_theta )              &
1209            &  + pbb * (  (TANH( rn_theta*( (-(pk1-0.5_wp)/REAL(jpkm1)) + 0.5_wp) ) - TANH( 0.5_wp * rn_theta )  )  &
1210            &        / ( 2._wp * TANH( 0.5_wp * rn_theta ) )  )
1211      ENDIF
1212      !
1213   END FUNCTION fssig1
1214
1215
1216   SUBROUTINE zgr_sco
1217      !!----------------------------------------------------------------------
1218      !!                  ***  ROUTINE zgr_sco  ***
1219      !!                     
1220      !! ** Purpose :   define the s-coordinate system
1221      !!
1222      !! ** Method  :   s-coordinate
1223      !!         The depth of model levels is defined as the product of an
1224      !!      analytical function by the local bathymetry, while the vertical
1225      !!      scale factors are defined as the product of the first derivative
1226      !!      of the analytical function by the bathymetry.
1227      !!      (this solution save memory as depth and scale factors are not
1228      !!      3d fields)
1229      !!          - Read bathymetry (in meters) at t-point and compute the
1230      !!         bathymetry at u-, v-, and f-points.
1231      !!            hbatu = mi( hbatt )
1232      !!            hbatv = mj( hbatt )
1233      !!            hbatf = mi( mj( hbatt ) )
1234      !!          - Compute gsigt, gsigw, esigt, esigw from an analytical
1235      !!         function and its derivative given as function.
1236      !!            gsigt(k) = fssig (k    )
1237      !!            gsigw(k) = fssig (k-0.5)
1238      !!            esigt(k) = fsdsig(k    )
1239      !!            esigw(k) = fsdsig(k-0.5)
1240      !!      This routine is given as an example, it must be modified
1241      !!      following the user s desiderata. nevertheless, the output as
1242      !!      well as the way to compute the model levels and scale factors
1243      !!      must be respected in order to insure second order a!!uracy
1244      !!      schemes.
1245      !!
1246      !! Reference : Madec, Lott, Delecluse and Crepon, 1996. JPO, 26, 1393-1408.
1247      !!----------------------------------------------------------------------
1248      USE wrk_nemo, ONLY:   wrk_in_use, wrk_not_released
1249      USE wrk_nemo, ONLY:   zenv => wrk_2d_1 , ztmp => wrk_2d_2 , zmsk  => wrk_2d_3
1250      USE wrk_nemo, ONLY:   ztmp2 => wrk_2d_4 , zhbat => wrk_2d_5
1251      USE wrk_nemo, ONLY:   gsigw3  => wrk_3d_1
1252      USE wrk_nemo, ONLY:   gsigt3  => wrk_3d_2
1253      USE wrk_nemo, ONLY:   gsi3w3  => wrk_3d_3
1254      USE wrk_nemo, ONLY:   esigt3  => wrk_3d_4
1255      USE wrk_nemo, ONLY:   esigw3  => wrk_3d_5
1256      USE wrk_nemo, ONLY:   esigtu3 => wrk_3d_6
1257      USE wrk_nemo, ONLY:   esigtv3 => wrk_3d_7
1258      USE wrk_nemo, ONLY:   esigtf3 => wrk_3d_8
1259      USE wrk_nemo, ONLY:   esigwu3 => wrk_3d_9
1260      USE wrk_nemo, ONLY:   esigwv3 => wrk_3d_10
1261      USE mapcomm_mod, ONLY: trimmed, cyclic_bc
1262      USE mapcomm_mod, ONLY: nidx, eidx, sidx, widx
1263
1264      !! DCSE_NEMO: wrk_nemo module variables renamed, need additional directives
1265!FTRANS gsigw3 :I :I :z
1266!FTRANS gsigt3 :I :I :z
1267!FTRANS gsi3w3 :I :I :z
1268!FTRANS esigt3 :I :I :z
1269!FTRANS esigw3 :I :I :z
1270!FTRANS esigtu3 :I :I :z
1271!FTRANS esigtv3 :I :I :z
1272!FTRANS esigtf3 :I :I :z
1273!FTRANS esigwu3 :I :I :z
1274!FTRANS esigwv3 :I :I :z
1275      !
1276      INTEGER  ::   ji, jj, jk, jl           ! dummy loop argument
1277      INTEGER  ::   iip1, ijp1, iim1, ijm1   ! temporary integers
1278      REAL(wp) ::   zcoeft, zcoefw, zrmax, ztaper, zri, zrj   ! temporary scalars
1279      REAL(wp), PARAMETER :: TOL_ZERO = 1.0E-20_wp ! Any value less than this assumed zero
1280      !
1281
1282!      NAMELIST/namzgr_sco/ rn_sbot_max, rn_sbot_min, rn_theta, rn_thetb, rn_rmax, ln_s_sigma, rn_bb, rn_hc
1283      !!----------------------------------------------------------------------
1284
1285      IF( wrk_in_use(2, 1,2,3,4,5) .OR. wrk_in_use(3, 1,2,3,4,5,6,7,8,9,10) ) THEN
1286         CALL ctl_stop('zgr_sco: ERROR - requested workspace arrays unavailable')   ;   RETURN
1287      ENDIF
1288
1289      REWIND( numnam )                       ! Read Namelist namzgr_sco : sigma-stretching parameters
1290      READ  ( numnam, namzgr_sco )
1291
1292      IF(lwp) THEN                           ! control print
1293         WRITE(numout,*)
1294         WRITE(numout,*) 'dom:zgr_sco : s-coordinate or hybrid z-s-coordinate'
1295         WRITE(numout,*) '~~~~~~~~~~~'
1296         WRITE(numout,*) '   Namelist namzgr_sco'
1297         WRITE(numout,*) '      sigma-stretching coeffs '
1298         WRITE(numout,*) '      maximum depth of s-bottom surface (>0)       rn_sbot_max   = ' ,rn_sbot_max
1299         WRITE(numout,*) '      minimum depth of s-bottom surface (>0)       rn_sbot_min   = ' ,rn_sbot_min
1300         WRITE(numout,*) '      surface control parameter (0<=rn_theta<=20)  rn_theta      = ', rn_theta
1301         WRITE(numout,*) '      bottom  control parameter (0<=rn_thetb<= 1)  rn_thetb      = ', rn_thetb
1302         WRITE(numout,*) '      maximum cut-off r-value allowed              rn_rmax       = ', rn_rmax
1303         WRITE(numout,*) '      Hybrid s-sigma-coordinate                    ln_s_sigma    = ', ln_s_sigma
1304         WRITE(numout,*) '      stretching parameter (song and haidvogel)    rn_bb         = ', rn_bb
1305         WRITE(numout,*) '      Critical depth                               rn_hc         = ', rn_hc
1306      ENDIF
1307
1308      gsigw3  = 0._wp   ;   gsigt3  = 0._wp   ;   gsi3w3  = 0._wp
1309      esigt3  = 0._wp   ;   esigw3  = 0._wp 
1310      esigtu3 = 0._wp   ;   esigtv3 = 0._wp   ;   esigtf3 = 0._wp
1311      esigwu3 = 0._wp   ;   esigwv3 = 0._wp
1312
1313      hift(:,:) = rn_sbot_min                     ! set the minimum depth for the s-coordinate
1314      hifu(:,:) = rn_sbot_min
1315      hifv(:,:) = rn_sbot_min
1316      hiff(:,:) = rn_sbot_min
1317
1318      !                                        ! set maximum ocean depth
1319      bathy(:,:) = MIN( rn_sbot_max, bathy(:,:) )
1320
1321      DO jj = 1, jpj
1322         DO ji = 1, jpi
1323           IF( bathy(ji,jj) > 0._wp )   bathy(ji,jj) = MAX( rn_sbot_min, bathy(ji,jj) )
1324         END DO
1325      END DO
1326      !                                        ! =============================
1327      !                                        ! Define the envelop bathymetry   (hbatt)
1328      !                                        ! =============================
1329      ! use r-value to create hybrid coordinates
1330      DO jj = 1, jpj
1331         DO ji = 1, jpi
1332            zenv(ji,jj) = MAX( bathy(ji,jj), rn_sbot_min )
1333         END DO
1334      END DO
1335
1336      CALL lbc_lnk( zenv, 'T', 1._wp, lzero=.FALSE. )
1337      !
1338      ! Smooth the bathymetry (if required)
1339      scosrf(:,:) = 0._wp             ! ocean surface depth (here zero: no under ice-shelf sea)
1340      scobot(:,:) = bathy(:,:)        ! ocean bottom  depth
1341      !
1342      jl = 0
1343      zrmax = 1._wp
1344      !                                                     ! ================ !
1345      DO WHILE( jl <= 10000 .AND. zrmax > rn_rmax )         !  Iterative loop  !
1346         !                                                  ! ================ !
1347         jl = jl + 1
1348         zrmax = 0._wp
1349         zmsk(:,:) = 0._wp
1350
1351         DO jj = 1, nlcj
1352            DO ji = 1, nlci
1353               iip1 = MIN( ji+1, nlci )      ! force zri = 0 on last line (ji=ncli+1 to jpi)
1354               ijp1 = MIN( jj+1, nlcj )      ! force zrj = 0 on last row  (jj=nclj+1 to jpj)
1355               zri = ABS( zenv(iip1,jj  ) - zenv(ji,jj) ) / ( zenv(iip1,jj  ) + zenv(ji,jj) )
1356               zrj = ABS( zenv(ji  ,ijp1) - zenv(ji,jj) ) / ( zenv(ji  ,ijp1) + zenv(ji,jj) )
1357               zrmax = MAX( zrmax, zri, zrj )
1358               IF( zri > rn_rmax )   zmsk(ji  ,jj  ) = 1._wp
1359               IF( zri > rn_rmax )   zmsk(iip1,jj  ) = 1._wp
1360               IF( zrj > rn_rmax )   zmsk(ji  ,jj  ) = 1._wp
1361               IF( zrj > rn_rmax )   zmsk(ji  ,ijp1) = 1._wp
1362            END DO
1363         END DO
1364
1365         ! lateral boundary condition on zmsk: retain any 1's along closed
1366         ! boundary (use of lzero flag to lbc_lnk)
1367         CALL lbc_lnk( zmsk, 'T', 1._wp, lzero=.FALSE. )
1368
1369         IF( lk_mpp )   CALL mpp_max( zrmax )   ! max over the global domain
1370         !
1371         IF(lwp)WRITE(numout,"('zgr_sco : iter=',I5,' rmax=',F8.4,' nb of pt= ',I8)") &
1372                                                         jl, zrmax, INT( SUM(zmsk(:,:) ) )
1373         !
1374
1375         ! Copy current surface before next smoothing iteration
1376         ztmp(:,:) = zenv(:,:)
1377
1378         DO jj = nldj, nlcj
1379            DO ji = nldi, nlci
1380               iip1 = MIN( ji+1, nlci )     ! last  line (ji=nlci)
1381               ijp1 = MIN( jj+1, nlcj )     ! last  raw  (jj=nlcj)
1382               iim1 = MAX( ji-1,  1  )      ! first line (ji=nlci)
1383               ijm1 = MAX( jj-1,  1  )      ! first raw  (jj=nlcj)
1384               IF( zmsk(ji,jj) == 1._wp ) THEN
1385                  ztmp(ji,jj) =   (                                                                                   &
1386             &      zenv(iim1,ijp1)*zmsk(iim1,ijp1) + zenv(ji,ijp1)*zmsk(ji,ijp1) + zenv(iip1,ijp1)*zmsk(iip1,ijp1)   &
1387             &    + zenv(iim1,jj  )*zmsk(iim1,jj  ) + zenv(ji,jj  )*    2._wp     + zenv(iip1,jj  )*zmsk(iip1,jj  )   &
1388             &    + zenv(iim1,ijm1)*zmsk(iim1,ijm1) + zenv(ji,ijm1)*zmsk(ji,ijm1) + zenv(iip1,ijm1)*zmsk(iip1,ijm1)   &
1389             &                    ) / (                                                                               &
1390             &                      zmsk(iim1,ijp1) +               zmsk(ji,ijp1) +                 zmsk(iip1,ijp1)   &
1391             &    +                 zmsk(iim1,jj  ) +                   2._wp     +                 zmsk(iip1,jj  )   &
1392             &    +                 zmsk(iim1,ijm1) +               zmsk(ji,ijm1) +                 zmsk(iip1,ijm1)   &
1393             &                        )
1394               ENDIF
1395            END DO
1396         END DO
1397         !
1398
1399         ! Need to update halos of ztmp here but do not zero halos on closed
1400         ! boundaries
1401         CALL lbc_lnk( ztmp, 'T', 1._wp, lzero=.FALSE.)
1402
1403         DO jj = 1,nlcj
1404            DO ji = 1,nlci
1405               IF( zmsk(ji,jj) >= 1._wp-TOL_ZERO ) zenv(ji,jj) = MAX( ztmp(ji,jj), bathy(ji,jj) )
1406            END DO
1407         END DO
1408         !
1409         ! Apply lateral boundary condition but do not zero on closed boundaries
1410         CALL lbc_lnk( zenv, 'T', 1._wp, lzero=.FALSE. )
1411
1412         !                                                  ! ================ !
1413      END DO                                                !     End loop     !
1414      !                                                     ! ================ !
1415      !
1416      !                                        ! envelop bathymetry saved in hbatt
1417      hbatt(:,:) = zenv(:,:) 
1418      IF( MINVAL( gphit(:,:) ) * MAXVAL( gphit(:,:) ) <= 0._wp ) THEN
1419         CALL ctl_warn( ' s-coordinates are tapered in vicinity of the Equator' )
1420         DO jj = 1, jpj
1421            DO ji = 1, jpi
1422               ztaper = EXP( -(gphit(ji,jj)/8._wp)**2 )
1423               hbatt(ji,jj) = rn_sbot_max * ztaper + hbatt(ji,jj) * ( 1._wp - ztaper )
1424            END DO
1425         END DO
1426      ENDIF
1427      !
1428      IF(lwp) THEN                             ! Control print
1429         WRITE(numout,*)
1430         WRITE(numout,*) ' domzgr: hbatt field; ocean depth in meters'
1431         WRITE(numout,*)
1432         CALL prihre( hbatt(1,1), jpi, jpj, 1, jpi, 1, 1, jpj, 1, 0._wp, numout )
1433         IF( nprint == 1 )   THEN       
1434            WRITE(numout,*) ' bathy  MAX ', MAXVAL( bathy(:,:) ), ' MIN ', MINVAL( bathy(:,:) )
1435            WRITE(numout,*) ' hbatt  MAX ', MAXVAL( hbatt(:,:) ), ' MIN ', MINVAL( hbatt(:,:) )
1436         ENDIF
1437      ENDIF
1438
1439!      CALL dump_array(0, 'hbatt', hbatt, withHalos=.FALSE.)
1440
1441      !                                        ! ==============================
1442      !                                        !   hbatu, hbatv, hbatf fields
1443      !                                        ! ==============================
1444      IF(lwp) THEN
1445         WRITE(numout,*)
1446         WRITE(numout,*) ' zgr_sco: minimum depth of the envelop topography set to : ', rn_sbot_min
1447      ENDIF
1448      hbatu(:,:) = rn_sbot_min
1449      hbatv(:,:) = rn_sbot_min
1450      hbatf(:,:) = rn_sbot_min
1451      DO jj = 1, jpjm1
1452        DO ji = 1, jpim1   ! NO vector opt.
1453           hbatu(ji,jj) = 0.50_wp * ( hbatt(ji  ,jj) + hbatt(ji+1,jj  ) )
1454           hbatv(ji,jj) = 0.50_wp * ( hbatt(ji  ,jj) + hbatt(ji  ,jj+1) )
1455           hbatf(ji,jj) = 0.25_wp * ( hbatt(ji  ,jj) + hbatt(ji  ,jj+1)   &
1456              &                     + hbatt(ji+1,jj) + hbatt(ji+1,jj+1) )
1457        END DO
1458      END DO
1459      !
1460      ! Apply lateral boundary condition
1461!!gm  ! CAUTION: retain non zero value in the initial file this should be OK for orca cfg, not for EEL
1462      zhbat(:,:) = hbatu(:,:)   ;   CALL lbc_lnk( hbatu, 'U', 1._wp )
1463      DO jj = 1, jpj
1464         DO ji = 1, jpi
1465            IF( hbatu(ji,jj) == 0._wp ) THEN
1466               IF( zhbat(ji,jj) == 0._wp )   hbatu(ji,jj) = rn_sbot_min
1467               IF( zhbat(ji,jj) /= 0._wp )   hbatu(ji,jj) = zhbat(ji,jj)
1468            ENDIF
1469         END DO
1470      END DO
1471      zhbat(:,:) = hbatv(:,:)   ;   CALL lbc_lnk( hbatv, 'V', 1._wp )
1472      DO jj = 1, jpj
1473         DO ji = 1, jpi
1474            IF( hbatv(ji,jj) == 0._wp ) THEN
1475               IF( zhbat(ji,jj) == 0._wp )   hbatv(ji,jj) = rn_sbot_min
1476               IF( zhbat(ji,jj) /= 0._wp )   hbatv(ji,jj) = zhbat(ji,jj)
1477            ENDIF
1478         END DO
1479      END DO
1480      zhbat(:,:) = hbatf(:,:)   ;   CALL lbc_lnk( hbatf, 'F', 1._wp )
1481      DO jj = 1, jpj
1482         DO ji = 1, jpi
1483            IF( hbatf(ji,jj) == 0._wp ) THEN
1484               IF( zhbat(ji,jj) == 0._wp )   hbatf(ji,jj) = rn_sbot_min
1485               IF( zhbat(ji,jj) /= 0._wp )   hbatf(ji,jj) = zhbat(ji,jj)
1486            ENDIF
1487         END DO
1488      END DO
1489
1490!!bug:  key_helsinki a verifer
1491      hift(:,:) = MIN( hift(:,:), hbatt(:,:) )
1492      hifu(:,:) = MIN( hifu(:,:), hbatu(:,:) )
1493      hifv(:,:) = MIN( hifv(:,:), hbatv(:,:) )
1494      hiff(:,:) = MIN( hiff(:,:), hbatf(:,:) )
1495
1496      IF( nprint == 1 .AND. lwp )   THEN
1497         WRITE(numout,*) ' MAX val hif   t ', MAXVAL( hift (:,:) ), ' f ', MAXVAL( hiff (:,:) ),  &
1498            &                        ' u ',   MAXVAL( hifu (:,:) ), ' v ', MAXVAL( hifv (:,:) )
1499         WRITE(numout,*) ' MIN val hif   t ', MINVAL( hift (:,:) ), ' f ', MINVAL( hiff (:,:) ),  &
1500            &                        ' u ',   MINVAL( hifu (:,:) ), ' v ', MINVAL( hifv (:,:) )
1501         WRITE(numout,*) ' MAX val hbat  t ', MAXVAL( hbatt(:,:) ), ' f ', MAXVAL( hbatf(:,:) ),  &
1502            &                        ' u ',   MAXVAL( hbatu(:,:) ), ' v ', MAXVAL( hbatv(:,:) )
1503         WRITE(numout,*) ' MIN val hbat  t ', MINVAL( hbatt(:,:) ), ' f ', MINVAL( hbatf(:,:) ),  &
1504            &                        ' u ',   MINVAL( hbatu(:,:) ), ' v ', MINVAL( hbatv(:,:) )
1505      ENDIF
1506!! helsinki
1507
1508      !                                            ! =======================
1509      !                                            !   s-ccordinate fields     (gdep., e3.)
1510      !                                            ! =======================
1511      !
1512      ! non-dimensional "sigma" for model level depth at w- and t-levels
1513
1514      IF( ln_s_sigma ) THEN        ! Song and Haidvogel style stretched sigma for depths
1515         !                         ! below rn_hc, with uniform sigma in shallower waters
1516         DO ji = 1, jpi
1517            DO jj = 1, jpj
1518
1519               IF( hbatt(ji,jj) > rn_hc ) THEN    !deep water, stretched sigma
1520                  DO jk = 1, jpk
1521                     gsigw3(ji,jj,jk) = -fssig1( REAL(jk,wp)-0.5_wp, rn_bb )
1522                     gsigt3(ji,jj,jk) = -fssig1( REAL(jk,wp)       , rn_bb )
1523                  END DO
1524               ELSE ! shallow water, uniform sigma
1525                  DO jk = 1, jpk
1526                     gsigw3(ji,jj,jk) =   REAL(jk-1,wp)            / REAL(jpk-1,wp)
1527                     gsigt3(ji,jj,jk) = ( REAL(jk-1,wp) + 0.5_wp ) / REAL(jpk-1,wp)
1528                  END DO
1529               ENDIF
1530               IF( nprint == 1 .AND. lwp )   WRITE(numout,*) 'gsigw3 1 jpk    ', gsigw3(ji,jj,1), gsigw3(ji,jj,jpk)
1531               !
1532               DO jk = 1, jpkm1
1533                  esigt3(ji,jj,jk  ) = gsigw3(ji,jj,jk+1) - gsigw3(ji,jj,jk)
1534                  esigw3(ji,jj,jk+1) = gsigt3(ji,jj,jk+1) - gsigt3(ji,jj,jk)
1535               END DO
1536               esigw3(ji,jj,1  ) = 2._wp * ( gsigt3(ji,jj,1  ) - gsigw3(ji,jj,1  ) )
1537               esigt3(ji,jj,jpk) = 2._wp * ( gsigt3(ji,jj,jpk) - gsigw3(ji,jj,jpk) )
1538               !
1539               ! Coefficients for vertical depth as the sum of e3w scale factors
1540               gsi3w3(ji,jj,1) = 0.5_wp * esigw3(ji,jj,1)
1541               DO jk = 2, jpk
1542                  gsi3w3(ji,jj,jk) = gsi3w3(ji,jj,jk-1) + esigw3(ji,jj,jk)
1543               END DO
1544               !
1545               DO jk = 1, jpk
1546                  zcoeft = ( REAL(jk,wp) - 0.5_wp ) / REAL(jpkm1,wp)
1547                  zcoefw = ( REAL(jk,wp) - 1.0_wp ) / REAL(jpkm1,wp)
1548                  gdept (ji,jj,jk) = ( scosrf(ji,jj) + (hbatt(ji,jj)-rn_hc)*gsigt3(ji,jj,jk)+rn_hc*zcoeft )
1549                  gdepw (ji,jj,jk) = ( scosrf(ji,jj) + (hbatt(ji,jj)-rn_hc)*gsigw3(ji,jj,jk)+rn_hc*zcoefw )
1550                  gdep3w(ji,jj,jk) = ( scosrf(ji,jj) + (hbatt(ji,jj)-rn_hc)*gsi3w3(ji,jj,jk)+rn_hc*zcoeft )
1551               END DO
1552               !
1553            END DO   ! for all jj's
1554         END DO    ! for all ji's
1555
1556         DO ji = 1, jpim1
1557            DO jj = 1, jpjm1
1558               DO jk = 1, jpk
1559                  esigtu3(ji,jj,jk) = ( hbatt(ji,jj)*esigt3(ji,jj,jk)+hbatt(ji+1,jj)*esigt3(ji+1,jj,jk) )   &
1560                     &              / ( hbatt(ji,jj)+hbatt(ji+1,jj) )
1561                  esigtv3(ji,jj,jk) = ( hbatt(ji,jj)*esigt3(ji,jj,jk)+hbatt(ji,jj+1)*esigt3(ji,jj+1,jk) )   &
1562                     &              / ( hbatt(ji,jj)+hbatt(ji,jj+1) )
1563                  esigtf3(ji,jj,jk) = ( hbatt(ji,jj)*esigt3(ji,jj,jk)+hbatt(ji+1,jj)*esigt3(ji+1,jj,jk)     &
1564                     &                + hbatt(ji,jj+1)*esigt3(ji,jj+1,jk)+hbatt(ji+1,jj+1)*esigt3(ji+1,jj+1,jk) )   &
1565                     &              / ( hbatt(ji,jj)+hbatt(ji+1,jj)+hbatt(ji,jj+1)+hbatt(ji+1,jj+1) )
1566                  esigwu3(ji,jj,jk) = ( hbatt(ji,jj)*esigw3(ji,jj,jk)+hbatt(ji+1,jj)*esigw3(ji+1,jj,jk) )   &
1567                     &              / ( hbatt(ji,jj)+hbatt(ji+1,jj) )
1568                  esigwv3(ji,jj,jk) = ( hbatt(ji,jj)*esigw3(ji,jj,jk)+hbatt(ji,jj+1)*esigw3(ji,jj+1,jk) )   &
1569                     &              / ( hbatt(ji,jj)+hbatt(ji,jj+1) )
1570                  !
1571                  e3t(ji,jj,jk) = ( (hbatt(ji,jj)-rn_hc)*esigt3 (ji,jj,jk) + rn_hc/FLOAT(jpkm1) )
1572                  e3u(ji,jj,jk) = ( (hbatu(ji,jj)-rn_hc)*esigtu3(ji,jj,jk) + rn_hc/FLOAT(jpkm1) )
1573                  e3v(ji,jj,jk) = ( (hbatv(ji,jj)-rn_hc)*esigtv3(ji,jj,jk) + rn_hc/FLOAT(jpkm1) )
1574                  e3f(ji,jj,jk) = ( (hbatf(ji,jj)-rn_hc)*esigtf3(ji,jj,jk) + rn_hc/FLOAT(jpkm1) )
1575                  !
1576                  e3w (ji,jj,jk) = ( (hbatt(ji,jj)-rn_hc)*esigw3 (ji,jj,jk) + rn_hc/FLOAT(jpkm1) )
1577                  e3uw(ji,jj,jk) = ( (hbatu(ji,jj)-rn_hc)*esigwu3(ji,jj,jk) + rn_hc/FLOAT(jpkm1) )
1578                  e3vw(ji,jj,jk) = ( (hbatv(ji,jj)-rn_hc)*esigwv3(ji,jj,jk) + rn_hc/FLOAT(jpkm1) )
1579               END DO
1580            END DO
1581         END DO
1582
1583         CALL lbc_lnk( e3t , 'T', 1._wp )
1584         CALL lbc_lnk( e3u , 'U', 1._wp )
1585         CALL lbc_lnk( e3v , 'V', 1._wp )
1586         CALL lbc_lnk( e3f , 'F', 1._wp )
1587         CALL lbc_lnk( e3w , 'W', 1._wp )
1588         CALL lbc_lnk( e3uw, 'U', 1._wp )
1589         CALL lbc_lnk( e3vw, 'V', 1._wp )
1590
1591         !
1592      ELSE   ! not ln_s_sigma
1593         !
1594         DO jk = 1, jpk
1595           gsigw(jk) = -fssig( REAL(jk,wp)-0.5_wp )
1596           gsigt(jk) = -fssig( REAL(jk,wp)        )
1597         END DO
1598         IF( nprint == 1 .AND. lwp )   WRITE(numout,*) 'gsigw 1 jpk    ', gsigw(1), gsigw(jpk)
1599         !
1600         ! Coefficients for vertical scale factors at w-, t- levels
1601!!gm bug :  define it from analytical function, not like juste bellow....
1602!!gm        or betteroffer the 2 possibilities....
1603         DO jk = 1, jpkm1
1604            esigt(jk  ) = gsigw(jk+1) - gsigw(jk)
1605            esigw(jk+1) = gsigt(jk+1) - gsigt(jk)
1606         END DO
1607         esigw( 1 ) = 2._wp * ( gsigt(1  ) - gsigw(1  ) ) 
1608         esigt(jpk) = 2._wp * ( gsigt(jpk) - gsigw(jpk) )
1609
1610!!gm  original form
1611!!org DO jk = 1, jpk
1612!!org    esigt(jk)=fsdsig( FLOAT(jk)     )
1613!!org    esigw(jk)=fsdsig( FLOAT(jk)-0.5 )
1614!!org END DO
1615!!gm
1616         !
1617         ! Coefficients for vertical depth as the sum of e3w scale factors
1618         gsi3w(1) = 0.5_wp * esigw(1)
1619         DO jk = 2, jpk
1620            gsi3w(jk) = gsi3w(jk-1) + esigw(jk)
1621         END DO
1622!!gm: depuw, depvw can be suppressed (modif in ldfslp) and depw=dep3w can be set (save 3 3D arrays)
1623         DO jk = 1, jpk
1624            zcoeft = ( REAL(jk,wp) - 0.5_wp ) / REAL(jpkm1,wp)
1625            zcoefw = ( REAL(jk,wp) - 1.0_wp ) / REAL(jpkm1,wp)
1626            gdept (:,:,jk) = ( scosrf(:,:) + (hbatt(:,:)-hift(:,:))*gsigt(jk) + hift(:,:)*zcoeft )
1627            gdepw (:,:,jk) = ( scosrf(:,:) + (hbatt(:,:)-hift(:,:))*gsigw(jk) + hift(:,:)*zcoefw )
1628            gdep3w(:,:,jk) = ( scosrf(:,:) + (hbatt(:,:)-hift(:,:))*gsi3w(jk) + hift(:,:)*zcoeft )
1629         END DO
1630!!gm: e3uw, e3vw can be suppressed  (modif in dynzdf, dynzdf_iso, zdfbfr) (save 2 3D arrays)
1631         DO jj = 1, jpj
1632            DO ji = 1, jpi
1633               DO jk = 1, jpk
1634                 e3t(ji,jj,jk) = ( (hbatt(ji,jj)-hift(ji,jj))*esigt(jk) + hift(ji,jj)/REAL(jpkm1,wp) )
1635                 e3u(ji,jj,jk) = ( (hbatu(ji,jj)-hifu(ji,jj))*esigt(jk) + hifu(ji,jj)/REAL(jpkm1,wp) )
1636                 e3v(ji,jj,jk) = ( (hbatv(ji,jj)-hifv(ji,jj))*esigt(jk) + hifv(ji,jj)/REAL(jpkm1,wp) )
1637                 e3f(ji,jj,jk) = ( (hbatf(ji,jj)-hiff(ji,jj))*esigt(jk) + hiff(ji,jj)/REAL(jpkm1,wp) )
1638                 !
1639                 e3w (ji,jj,jk) = ( (hbatt(ji,jj)-hift(ji,jj))*esigw(jk) + hift(ji,jj)/REAL(jpkm1,wp) )
1640                 e3uw(ji,jj,jk) = ( (hbatu(ji,jj)-hifu(ji,jj))*esigw(jk) + hifu(ji,jj)/REAL(jpkm1,wp) )
1641                 e3vw(ji,jj,jk) = ( (hbatv(ji,jj)-hifv(ji,jj))*esigw(jk) + hifv(ji,jj)/REAL(jpkm1,wp) )
1642               END DO
1643            END DO
1644         END DO
1645         !
1646      ENDIF ! ln_s_sigma
1647
1648
1649      !
1650!!    H. Liu, POL. April 2009. Added for passing the scale check for the new released vvl code.
1651      where (e3t   (:,:,:).eq.0.0)  e3t(:,:,:) = 1.0
1652      where (e3u   (:,:,:).eq.0.0)  e3u(:,:,:) = 1.0
1653      where (e3v   (:,:,:).eq.0.0)  e3v(:,:,:) = 1.0
1654      where (e3f   (:,:,:).eq.0.0)  e3f(:,:,:) = 1.0
1655      where (e3w   (:,:,:).eq.0.0)  e3w(:,:,:) = 1.0
1656      where (e3uw  (:,:,:).eq.0.0)  e3uw(:,:,:) = 1.0
1657      where (e3vw  (:,:,:).eq.0.0)  e3vw(:,:,:) = 1.0
1658
1659
1660      fsdept(:,:,:) = gdept (:,:,:)
1661      fsdepw(:,:,:) = gdepw (:,:,:)
1662      fsde3w(:,:,:) = gdep3w(:,:,:)
1663      fse3t (:,:,:) = e3t   (:,:,:)
1664      fse3u (:,:,:) = e3u   (:,:,:)
1665      fse3v (:,:,:) = e3v   (:,:,:)
1666      fse3f (:,:,:) = e3f   (:,:,:)
1667      fse3w (:,:,:) = e3w   (:,:,:)
1668      fse3uw(:,:,:) = e3uw  (:,:,:)
1669      fse3vw(:,:,:) = e3vw  (:,:,:)
1670!!
1671      ! HYBRID :
1672      DO jj = 1, jpj
1673         DO ji = 1, jpi
1674            DO jk = 1, jpkm1
1675               IF( scobot(ji,jj) >= fsdept(ji,jj,jk) )   mbathy(ji,jj) = MAX( 2, jk )
1676               IF( scobot(ji,jj) == 0._wp            )   mbathy(ji,jj) = 0
1677            END DO
1678         END DO
1679      END DO
1680
1681      IF( nprint == 1 .AND. lwp ) WRITE(numout,*) ' MIN val mbathy h90 ', MINVAL( mbathy(:,:) ),   &
1682         &                                                       ' MAX ', MAXVAL( mbathy(:,:) )
1683
1684      !                                               ! =============
1685      IF(lwp) THEN                                    ! Control print
1686         !                                            ! =============
1687         WRITE(numout,*) 
1688         WRITE(numout,*) ' domzgr: vertical coefficients for model level'
1689         WRITE(numout, "(9x,'  level    gsigt      gsigw      esigt      esigw      gsi3w')" )
1690         WRITE(numout, "(10x,i4,5f11.4)" ) ( jk, gsigt(jk), gsigw(jk), esigt(jk), esigw(jk), gsi3w(jk), jk=1,jpk )
1691      ENDIF
1692      IF( nprint == 1  .AND. lwp )   THEN         ! min max values over the local domain
1693         WRITE(numout,*) ' MIN val mbathy  ', MINVAL( mbathy(:,:)   ), ' MAX ', MAXVAL( mbathy(:,:) )
1694         WRITE(numout,*) ' MIN val depth t ', MINVAL( fsdept(:,:,:) ),   &
1695            &                          ' w ', MINVAL( fsdepw(:,:,:) ), '3w '  , MINVAL( fsde3w(:,:,:) )
1696         WRITE(numout,*) ' MIN val e3    t ', MINVAL( fse3t (:,:,:) ), ' f '  , MINVAL( fse3f (:,:,:) ),   &
1697            &                          ' u ', MINVAL( fse3u (:,:,:) ), ' u '  , MINVAL( fse3v (:,:,:) ),   &
1698            &                          ' uw', MINVAL( fse3uw(:,:,:) ), ' vw'  , MINVAL( fse3vw(:,:,:) ),   &
1699            &                          ' w ', MINVAL( fse3w (:,:,:) )
1700
1701         WRITE(numout,*) ' MAX val depth t ', MAXVAL( fsdept(:,:,:) ),   &
1702            &                          ' w ', MAXVAL( fsdepw(:,:,:) ), '3w '  , MAXVAL( fsde3w(:,:,:) )
1703         WRITE(numout,*) ' MAX val e3    t ', MAXVAL( fse3t (:,:,:) ), ' f '  , MAXVAL( fse3f (:,:,:) ),   &
1704            &                          ' u ', MAXVAL( fse3u (:,:,:) ), ' u '  , MAXVAL( fse3v (:,:,:) ),   &
1705            &                          ' uw', MAXVAL( fse3uw(:,:,:) ), ' vw'  , MAXVAL( fse3vw(:,:,:) ),   &
1706            &                          ' w ', MAXVAL( fse3w (:,:,:) )
1707      ENDIF
1708      !
1709      IF(lwp) THEN                                  ! selected vertical profiles
1710         WRITE(numout,*)
1711         WRITE(numout,*) ' domzgr: vertical coordinates : point (1,1,k) bathy = ', bathy(1,1), hbatt(1,1)
1712         WRITE(numout,*) ' ~~~~~~  --------------------'
1713         WRITE(numout,"(9x,' level   gdept    gdepw    gde3w     e3t      e3w  ')")
1714         WRITE(numout,"(10x,i4,4f9.2)") ( jk, fsdept(1,1,jk), fsdepw(1,1,jk),     &
1715            &                                 fse3t (1,1,jk), fse3w (1,1,jk), jk=1,jpk )
1716         DO jj = mj0(20), mj1(20)
1717            DO ji = mi0(20), mi1(20)
1718               WRITE(numout,*)
1719               WRITE(numout,*) ' domzgr: vertical coordinates : point (20,20,k)   bathy = ', bathy(ji,jj), hbatt(ji,jj)
1720               WRITE(numout,*) ' ~~~~~~  --------------------'
1721               WRITE(numout,"(9x,' level   gdept    gdepw    gde3w     e3t      e3w  ')")
1722               WRITE(numout,"(10x,i4,4f9.2)") ( jk, fsdept(ji,jj,jk), fsdepw(ji,jj,jk),     &
1723                  &                                 fse3t (ji,jj,jk), fse3w (ji,jj,jk), jk=1,jpk )
1724            END DO
1725         END DO
1726!!$ ARPDBG - out of bounds if jpj < 74 or jpi < 100, e.g. default GYRE
1727!!$         DO jj = mj0(74), mj1(74)
1728!!$            DO ji = mi0(100), mi1(100)
1729!!$               WRITE(numout,*)
1730!!$               WRITE(numout,*) ' domzgr: vertical coordinates : point (100,74,k)   bathy = ', bathy(ji,jj), hbatt(ji,jj)
1731!!$               WRITE(numout,*) ' ~~~~~~  --------------------'
1732!!$               WRITE(numout,"(9x,' level   gdept    gdepw    gde3w     e3t      e3w  ')")
1733!!$               WRITE(numout,"(10x,i4,4f9.2)") ( jk, fsdept(ji,jj,jk), fsdepw(ji,jj,jk),     &
1734!!$                  &                                 fse3t (ji,jj,jk), fse3w (ji,jj,jk), jk=1,jpk )
1735!!$            END DO
1736!!$         END DO
1737      ENDIF
1738
1739!!gm bug?  no more necessary?  if ! defined key_helsinki
1740#if defined key_z_first
1741      DO jj = 1, jpj
1742         DO ji = 1, jpi
1743            DO jk = 1, jpk
1744#else
1745      DO jk = 1, jpk
1746         DO jj = 1, jpj
1747            DO ji = 1, jpi
1748#endif
1749               IF( fse3w(ji,jj,jk) <= 0._wp .OR. fse3t(ji,jj,jk) <= 0._wp ) THEN
1750                  WRITE(ctmp1,*) 'zgr_sco :   e3w   or e3t   =< 0  at point (i,j,k)= ', ji, jj, jk
1751                  CALL ctl_stop( ctmp1 )
1752               ENDIF
1753#if defined key_vvl
1754               IF( gdepw_1(ji,jj,jk) < 0._wp .OR. gdept_1(ji,jj,jk) < 0._wp ) THEN
1755                  WRITE(ctmp1,*) 'zgr_sco :   gdepw or gdept =< 0  at point (i,j,k)= ', ji, jj, jk
1756                  CALL ctl_stop( ctmp1 )
1757               ENDIF
1758#endif
1759            END DO
1760         END DO
1761      END DO
1762!!gm bug    #endif
1763      !
1764      IF( wrk_not_released(2, 1,2,3,4,5) .OR. wrk_not_released(3, 1,2,3,4,5,6,7,8,9,10) )  &
1765        &  CALL ctl_stop('dom:zgr_sco: failed to release workspace arrays')
1766      !
1767   END SUBROUTINE zgr_sco
1768
1769   !!======================================================================
1770END MODULE domzgr
Note: See TracBrowser for help on using the repository browser.