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.
dynhpg.F90 in NEMO/branches/2020/dev_r13383_HPC-02_Daley_Tiling/src/OCE/DYN – NEMO

source: NEMO/branches/2020/dev_r13383_HPC-02_Daley_Tiling/src/OCE/DYN/dynhpg.F90 @ 13515

Last change on this file since 13515 was 13515, checked in by hadcv, 4 years ago

Tiling for tra_ldf

  • Property svn:keywords set to Id
File size: 69.6 KB
Line 
1MODULE dynhpg
2   !!======================================================================
3   !!                       ***  MODULE  dynhpg  ***
4   !! Ocean dynamics:  hydrostatic pressure gradient trend
5   !!======================================================================
6   !! History :  OPA  !  1987-09  (P. Andrich, M.-A. Foujols)  hpg_zco: Original code
7   !!            5.0  !  1991-11  (G. Madec)
8   !!            7.0  !  1996-01  (G. Madec)  hpg_sco: Original code for s-coordinates
9   !!            8.0  !  1997-05  (G. Madec)  split dynber into dynkeg and dynhpg
10   !!            8.5  !  2002-07  (G. Madec)  F90: Free form and module
11   !!            8.5  !  2002-08  (A. Bozec)  hpg_zps: Original code
12   !!   NEMO     1.0  !  2005-10  (A. Beckmann, B.W. An)  various s-coordinate options
13   !!                 !         Original code for hpg_ctl, hpg_hel hpg_wdj, hpg_djc, hpg_rot
14   !!             -   !  2005-11  (G. Madec) style & small optimisation
15   !!            3.3  !  2010-10  (C. Ethe, G. Madec) reorganisation of initialisation phase
16   !!            3.4  !  2011-11  (H. Liu) hpg_prj: Original code for s-coordinates
17   !!                 !           (A. Coward) suppression of hel, wdj and rot options
18   !!            3.6  !  2014-11  (P. Mathiot) hpg_isf: original code for ice shelf cavity
19   !!----------------------------------------------------------------------
20
21   !!----------------------------------------------------------------------
22   !!   dyn_hpg      : update the momentum trend with the now horizontal
23   !!                  gradient of the hydrostatic pressure
24   !!   dyn_hpg_init : initialisation and control of options
25   !!       hpg_zco  : z-coordinate scheme
26   !!       hpg_zps  : z-coordinate plus partial steps (interpolation)
27   !!       hpg_sco  : s-coordinate (standard jacobian formulation)
28   !!       hpg_isf  : s-coordinate (sco formulation) adapted to ice shelf
29   !!       hpg_djc  : s-coordinate (Density Jacobian with Cubic polynomial)
30   !!       hpg_prj  : s-coordinate (Pressure Jacobian with Cubic polynomial)
31   !!----------------------------------------------------------------------
32   USE oce             ! ocean dynamics and tracers
33   USE isf_oce , ONLY : risfload  ! ice shelf  (risfload variable)
34   USE isfload , ONLY : isf_load  ! ice shelf  (isf_load routine )
35   USE sbc_oce         ! surface variable (only for the flag with ice shelf)
36   USE dom_oce         ! ocean space and time domain
37   USE wet_dry         ! wetting and drying
38   USE phycst          ! physical constants
39   USE trd_oce         ! trends: ocean variables
40   USE trddyn          ! trend manager: dynamics
41   USE zpshde          ! partial step: hor. derivative     (zps_hde routine)
42   !
43   USE in_out_manager  ! I/O manager
44   USE prtctl          ! Print control
45   USE lbclnk          ! lateral boundary condition
46   USE lib_mpp         ! MPP library
47   USE eosbn2          ! compute density
48   USE timing          ! Timing
49   USE iom
50
51   IMPLICIT NONE
52   PRIVATE
53
54   PUBLIC   dyn_hpg        ! routine called by step module
55   PUBLIC   dyn_hpg_init   ! routine called by opa module
56
57   !                                !!* Namelist namdyn_hpg : hydrostatic pressure gradient
58   LOGICAL, PUBLIC ::   ln_hpg_zco   !: z-coordinate - full steps
59   LOGICAL, PUBLIC ::   ln_hpg_zps   !: z-coordinate - partial steps (interpolation)
60   LOGICAL, PUBLIC ::   ln_hpg_sco   !: s-coordinate (standard jacobian formulation)
61   LOGICAL, PUBLIC ::   ln_hpg_djc   !: s-coordinate (Density Jacobian with Cubic polynomial)
62   LOGICAL, PUBLIC ::   ln_hpg_prj   !: s-coordinate (Pressure Jacobian scheme)
63   LOGICAL, PUBLIC ::   ln_hpg_isf   !: s-coordinate similar to sco modify for isf
64
65   !                                !! Flag to control the type of hydrostatic pressure gradient
66   INTEGER, PARAMETER ::   np_ERROR  =-10   ! error in specification of lateral diffusion
67   INTEGER, PARAMETER ::   np_zco    =  0   ! z-coordinate - full steps
68   INTEGER, PARAMETER ::   np_zps    =  1   ! z-coordinate - partial steps (interpolation)
69   INTEGER, PARAMETER ::   np_sco    =  2   ! s-coordinate (standard jacobian formulation)
70   INTEGER, PARAMETER ::   np_djc    =  3   ! s-coordinate (Density Jacobian with Cubic polynomial)
71   INTEGER, PARAMETER ::   np_prj    =  4   ! s-coordinate (Pressure Jacobian scheme)
72   INTEGER, PARAMETER ::   np_isf    =  5   ! s-coordinate similar to sco modify for isf
73   !
74   INTEGER, PUBLIC ::   nhpg         !: type of pressure gradient scheme used ! (deduced from ln_hpg_... flags) (PUBLIC for TAM)
75
76   !! * Substitutions
77#  include "do_loop_substitute.h90"
78#  include "domzgr_substitute.h90"
79
80   !!----------------------------------------------------------------------
81   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
82   !! $Id$
83   !! Software governed by the CeCILL license (see ./LICENSE)
84   !!----------------------------------------------------------------------
85CONTAINS
86
87   SUBROUTINE dyn_hpg( kt, Kmm, puu, pvv, Krhs )
88      !!---------------------------------------------------------------------
89      !!                  ***  ROUTINE dyn_hpg  ***
90      !!
91      !! ** Method  :   Call the hydrostatic pressure gradient routine
92      !!              using the scheme defined in the namelist
93      !!
94      !! ** Action : - Update (puu(:,:,:,Krhs),pvv(:,:,:,Krhs)) with the now hydrastatic pressure trend
95      !!             - send trends to trd_dyn for futher diagnostics (l_trddyn=T)
96      !!----------------------------------------------------------------------
97      INTEGER                             , INTENT( in )  ::  kt          ! ocean time-step index
98      INTEGER                             , INTENT( in )  ::  Kmm, Krhs   ! ocean time level indices
99      REAL(wp), DIMENSION(jpi,jpj,jpk,jpt), INTENT(inout) ::  puu, pvv    ! ocean velocities and RHS of momentum equation
100      !
101      REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) ::   ztrdu, ztrdv
102      !!----------------------------------------------------------------------
103      !
104      IF( ln_timing )   CALL timing_start('dyn_hpg')
105      !
106      IF( l_trddyn ) THEN                    ! Temporary saving of puu(:,:,:,Krhs) and pvv(:,:,:,Krhs) trends (l_trddyn)
107         ALLOCATE( ztrdu(jpi,jpj,jpk) , ztrdv(jpi,jpj,jpk) )
108         ztrdu(:,:,:) = puu(:,:,:,Krhs)
109         ztrdv(:,:,:) = pvv(:,:,:,Krhs)
110      ENDIF
111      !
112      SELECT CASE ( nhpg )      ! Hydrostatic pressure gradient computation
113      CASE ( np_zco )   ;   CALL hpg_zco    ( kt, Kmm, puu, pvv, Krhs )  ! z-coordinate
114      CASE ( np_zps )   ;   CALL hpg_zps    ( kt, Kmm, puu, pvv, Krhs )  ! z-coordinate plus partial steps (interpolation)
115      CASE ( np_sco )   ;   CALL hpg_sco    ( kt, Kmm, puu, pvv, Krhs )  ! s-coordinate (standard jacobian formulation)
116      CASE ( np_djc )   ;   CALL hpg_djc    ( kt, Kmm, puu, pvv, Krhs )  ! s-coordinate (Density Jacobian with Cubic polynomial)
117      CASE ( np_prj )   ;   CALL hpg_prj    ( kt, Kmm, puu, pvv, Krhs )  ! s-coordinate (Pressure Jacobian scheme)
118      CASE ( np_isf )   ;   CALL hpg_isf    ( kt, Kmm, puu, pvv, Krhs )  ! s-coordinate similar to sco modify for ice shelf
119      END SELECT
120      !
121      IF( l_trddyn ) THEN      ! save the hydrostatic pressure gradient trends for momentum trend diagnostics
122         ztrdu(:,:,:) = puu(:,:,:,Krhs) - ztrdu(:,:,:)
123         ztrdv(:,:,:) = pvv(:,:,:,Krhs) - ztrdv(:,:,:)
124         CALL trd_dyn( ztrdu, ztrdv, jpdyn_hpg, kt, Kmm )
125         DEALLOCATE( ztrdu , ztrdv )
126      ENDIF
127      !
128      IF(sn_cfctl%l_prtctl)   CALL prt_ctl( tab3d_1=puu(:,:,:,Krhs), clinfo1=' hpg  - Ua: ', mask1=umask,   &
129         &                                  tab3d_2=pvv(:,:,:,Krhs), clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
130      !
131      IF( ln_timing )   CALL timing_stop('dyn_hpg')
132      !
133   END SUBROUTINE dyn_hpg
134
135
136   SUBROUTINE dyn_hpg_init( Kmm )
137      !!----------------------------------------------------------------------
138      !!                 ***  ROUTINE dyn_hpg_init  ***
139      !!
140      !! ** Purpose :   initializations for the hydrostatic pressure gradient
141      !!              computation and consistency control
142      !!
143      !! ** Action  :   Read the namelist namdyn_hpg and check the consistency
144      !!      with the type of vertical coordinate used (zco, zps, sco)
145      !!----------------------------------------------------------------------
146      INTEGER, INTENT( in ) :: Kmm   ! ocean time level index
147      !
148      INTEGER ::   ioptio = 0      ! temporary integer
149      INTEGER ::   ios             ! Local integer output status for namelist read
150      !!
151      INTEGER  ::   ji, jj, jk, ikt    ! dummy loop indices      ISF
152      REAL(wp) ::   znad
153      REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) ::  zts_top, zrhd   ! hypothesys on isf density
154      REAL(wp), ALLOCATABLE, DIMENSION(:,:)   ::  zrhdtop_isf    ! density at bottom of ISF
155      REAL(wp), ALLOCATABLE, DIMENSION(:,:)   ::  ziceload       ! density at bottom of ISF
156      !!
157      NAMELIST/namdyn_hpg/ ln_hpg_zco, ln_hpg_zps, ln_hpg_sco,     &
158         &                 ln_hpg_djc, ln_hpg_prj, ln_hpg_isf
159      !!----------------------------------------------------------------------
160      !
161      READ  ( numnam_ref, namdyn_hpg, IOSTAT = ios, ERR = 901)
162901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namdyn_hpg in reference namelist' )
163      !
164      READ  ( numnam_cfg, namdyn_hpg, IOSTAT = ios, ERR = 902 )
165902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namdyn_hpg in configuration namelist' )
166      IF(lwm) WRITE ( numond, namdyn_hpg )
167      !
168      IF(lwp) THEN                   ! Control print
169         WRITE(numout,*)
170         WRITE(numout,*) 'dyn_hpg_init : hydrostatic pressure gradient initialisation'
171         WRITE(numout,*) '~~~~~~~~~~~~'
172         WRITE(numout,*) '   Namelist namdyn_hpg : choice of hpg scheme'
173         WRITE(numout,*) '      z-coord. - full steps                             ln_hpg_zco    = ', ln_hpg_zco
174         WRITE(numout,*) '      z-coord. - partial steps (interpolation)          ln_hpg_zps    = ', ln_hpg_zps
175         WRITE(numout,*) '      s-coord. (standard jacobian formulation)          ln_hpg_sco    = ', ln_hpg_sco
176         WRITE(numout,*) '      s-coord. (standard jacobian formulation) for isf  ln_hpg_isf    = ', ln_hpg_isf
177         WRITE(numout,*) '      s-coord. (Density Jacobian: Cubic polynomial)     ln_hpg_djc    = ', ln_hpg_djc
178         WRITE(numout,*) '      s-coord. (Pressure Jacobian: Cubic polynomial)    ln_hpg_prj    = ', ln_hpg_prj
179      ENDIF
180      !
181      IF( ln_hpg_djc )   &
182         &   CALL ctl_stop('dyn_hpg_init : Density Jacobian: Cubic polynominal method',   &
183         &                 '   currently disabled (bugs under investigation).'        ,   &
184         &                 '   Please select either  ln_hpg_sco or  ln_hpg_prj instead' )
185         !
186      IF( .NOT.ln_linssh .AND. .NOT.(ln_hpg_sco.OR.ln_hpg_prj.OR.ln_hpg_isf) )          &
187         &   CALL ctl_stop('dyn_hpg_init : non-linear free surface requires either ',   &
188         &                 '   the standard jacobian formulation hpg_sco    or '    ,   &
189         &                 '   the pressure jacobian formulation hpg_prj'             )
190         !
191      IF( ln_hpg_isf ) THEN
192         IF( .NOT. ln_isfcav )   CALL ctl_stop( ' hpg_isf not available if ln_isfcav = false ' )
193       ELSE
194         IF(       ln_isfcav )   CALL ctl_stop( 'Only hpg_isf has been corrected to work with ice shelf cavity.' )
195      ENDIF
196      !
197      !                               ! Set nhpg from ln_hpg_... flags & consistency check
198      nhpg   = np_ERROR
199      ioptio = 0
200      IF( ln_hpg_zco ) THEN   ;   nhpg = np_zco   ;   ioptio = ioptio +1   ;   ENDIF
201      IF( ln_hpg_zps ) THEN   ;   nhpg = np_zps   ;   ioptio = ioptio +1   ;   ENDIF
202      IF( ln_hpg_sco ) THEN   ;   nhpg = np_sco   ;   ioptio = ioptio +1   ;   ENDIF
203      IF( ln_hpg_djc ) THEN   ;   nhpg = np_djc   ;   ioptio = ioptio +1   ;   ENDIF
204      IF( ln_hpg_prj ) THEN   ;   nhpg = np_prj   ;   ioptio = ioptio +1   ;   ENDIF
205      IF( ln_hpg_isf ) THEN   ;   nhpg = np_isf   ;   ioptio = ioptio +1   ;   ENDIF
206      !
207      IF( ioptio /= 1 )   CALL ctl_stop( 'NO or several hydrostatic pressure gradient options used' )
208      !
209      IF(lwp) THEN
210         WRITE(numout,*)
211         SELECT CASE( nhpg )
212         CASE( np_zco )   ;   WRITE(numout,*) '   ==>>>   z-coord. - full steps '
213         CASE( np_zps )   ;   WRITE(numout,*) '   ==>>>   z-coord. - partial steps (interpolation)'
214         CASE( np_sco )   ;   WRITE(numout,*) '   ==>>>   s-coord. (standard jacobian formulation)'
215         CASE( np_djc )   ;   WRITE(numout,*) '   ==>>>   s-coord. (Density Jacobian: Cubic polynomial)'
216         CASE( np_prj )   ;   WRITE(numout,*) '   ==>>>   s-coord. (Pressure Jacobian: Cubic polynomial)'
217         CASE( np_isf )   ;   WRITE(numout,*) '   ==>>>   s-coord. (standard jacobian formulation) for isf'
218         END SELECT
219         WRITE(numout,*)
220      ENDIF
221      !                         
222   END SUBROUTINE dyn_hpg_init
223
224
225   SUBROUTINE hpg_zco( kt, Kmm, puu, pvv, Krhs )
226      !!---------------------------------------------------------------------
227      !!                  ***  ROUTINE hpg_zco  ***
228      !!
229      !! ** Method  :   z-coordinate case, levels are horizontal surfaces.
230      !!      The now hydrostatic pressure gradient at a given level, jk,
231      !!      is computed by taking the vertical integral of the in-situ
232      !!      density gradient along the model level from the suface to that
233      !!      level:    zhpi = grav .....
234      !!                zhpj = grav .....
235      !!      add it to the general momentum trend (puu(:,:,:,Krhs),pvv(:,:,:,Krhs)).
236      !!            puu(:,:,:,Krhs) = puu(:,:,:,Krhs) - 1/e1u * zhpi
237      !!            pvv(:,:,:,Krhs) = pvv(:,:,:,Krhs) - 1/e2v * zhpj
238      !!
239      !! ** Action : - Update (puu(:,:,:,Krhs),pvv(:,:,:,Krhs)) with the now hydrastatic pressure trend
240      !!----------------------------------------------------------------------
241      INTEGER                             , INTENT( in )  ::  kt          ! ocean time-step index
242      INTEGER                             , INTENT( in )  ::  Kmm, Krhs   ! ocean time level indices
243      REAL(wp), DIMENSION(jpi,jpj,jpk,jpt), INTENT(inout) ::  puu, pvv    ! ocean velocities and RHS of momentum equation
244      !
245      INTEGER  ::   ji, jj, jk       ! dummy loop indices
246      REAL(wp) ::   zcoef0, zcoef1   ! temporary scalars
247      REAL(wp), DIMENSION(jpi,jpj,jpk) ::  zhpi, zhpj
248      !!----------------------------------------------------------------------
249      !
250      IF( kt == nit000 ) THEN
251         IF(lwp) WRITE(numout,*)
252         IF(lwp) WRITE(numout,*) 'dyn:hpg_zco : hydrostatic pressure gradient trend'
253         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   z-coordinate case '
254      ENDIF
255
256      zcoef0 = - grav * 0.5_wp      ! Local constant initialization
257
258      ! Surface value
259      DO_2D( 0, 0, 0, 0 )
260         zcoef1 = zcoef0 * e3w(ji,jj,1,Kmm)
261         ! hydrostatic pressure gradient
262         zhpi(ji,jj,1) = zcoef1 * ( rhd(ji+1,jj,1) - rhd(ji,jj,1) ) * r1_e1u(ji,jj)
263         zhpj(ji,jj,1) = zcoef1 * ( rhd(ji,jj+1,1) - rhd(ji,jj,1) ) * r1_e2v(ji,jj)
264         ! add to the general momentum trend
265         puu(ji,jj,1,Krhs) = puu(ji,jj,1,Krhs) + zhpi(ji,jj,1)
266         pvv(ji,jj,1,Krhs) = pvv(ji,jj,1,Krhs) + zhpj(ji,jj,1)
267      END_2D
268
269      !
270      ! interior value (2=<jk=<jpkm1)
271      DO_3D( 0, 0, 0, 0, 2, jpkm1 )
272         zcoef1 = zcoef0 * e3w(ji,jj,jk,Kmm)
273         ! hydrostatic pressure gradient
274         zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1)   &
275            &           + zcoef1 * (  ( rhd(ji+1,jj,jk)+rhd(ji+1,jj,jk-1) )    &
276            &                       - ( rhd(ji  ,jj,jk)+rhd(ji  ,jj,jk-1) )  ) * r1_e1u(ji,jj)
277
278         zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1)   &
279            &           + zcoef1 * (  ( rhd(ji,jj+1,jk)+rhd(ji,jj+1,jk-1) )    &
280            &                       - ( rhd(ji,jj,  jk)+rhd(ji,jj  ,jk-1) )  ) * r1_e2v(ji,jj)
281         ! add to the general momentum trend
282         puu(ji,jj,jk,Krhs) = puu(ji,jj,jk,Krhs) + zhpi(ji,jj,jk)
283         pvv(ji,jj,jk,Krhs) = pvv(ji,jj,jk,Krhs) + zhpj(ji,jj,jk)
284      END_3D
285      !
286   END SUBROUTINE hpg_zco
287
288
289   SUBROUTINE hpg_zps( kt, Kmm, puu, pvv, Krhs )
290      !!---------------------------------------------------------------------
291      !!                 ***  ROUTINE hpg_zps  ***
292      !!
293      !! ** Method  :   z-coordinate plus partial steps case.  blahblah...
294      !!
295      !! ** Action  : - Update (puu(:,:,:,Krhs),pvv(:,:,:,Krhs)) with the now hydrastatic pressure trend
296      !!----------------------------------------------------------------------
297      INTEGER                             , INTENT( in )  ::  kt          ! ocean time-step index
298      INTEGER                             , INTENT( in )  ::  Kmm, Krhs   ! ocean time level indices
299      REAL(wp), DIMENSION(jpi,jpj,jpk,jpt), INTENT(inout) ::  puu, pvv    ! ocean velocities and RHS of momentum equation
300      !!
301      INTEGER  ::   ji, jj, jk                       ! dummy loop indices
302      INTEGER  ::   iku, ikv                         ! temporary integers
303      REAL(wp) ::   zcoef0, zcoef1, zcoef2, zcoef3   ! temporary scalars
304      REAL(wp), DIMENSION(jpi,jpj,jpk) :: zhpi, zhpj
305      REAL(wp), DIMENSION(jpi,jpj,1)   :: zgtsu, zgtsv
306      REAL(wp), DIMENSION(jpi,jpj)     :: zgru, zgrv
307      !!----------------------------------------------------------------------
308      !
309      IF( kt == nit000 ) THEN
310         IF(lwp) WRITE(numout,*)
311         IF(lwp) WRITE(numout,*) 'dyn:hpg_zps : hydrostatic pressure gradient trend'
312         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   z-coordinate with partial steps - vector optimization'
313      ENDIF
314
315      ! Partial steps: Compute NOW horizontal gradient of t, s, rd at the last ocean level
316      CALL zps_hde( kt, Kmm, jpts, ts(:,:,:,:,Kmm), zgtsu, zgtsv, rhd, zgru , zgrv )
317
318      ! Local constant initialization
319      zcoef0 = - grav * 0.5_wp
320
321      !  Surface value (also valid in partial step case)
322      DO_2D( 0, 0, 0, 0 )
323         zcoef1 = zcoef0 * e3w(ji,jj,1,Kmm)
324         ! hydrostatic pressure gradient
325         zhpi(ji,jj,1) = zcoef1 * ( rhd(ji+1,jj  ,1) - rhd(ji,jj,1) ) * r1_e1u(ji,jj)
326         zhpj(ji,jj,1) = zcoef1 * ( rhd(ji  ,jj+1,1) - rhd(ji,jj,1) ) * r1_e2v(ji,jj)
327         ! add to the general momentum trend
328         puu(ji,jj,1,Krhs) = puu(ji,jj,1,Krhs) + zhpi(ji,jj,1)
329         pvv(ji,jj,1,Krhs) = pvv(ji,jj,1,Krhs) + zhpj(ji,jj,1)
330      END_2D
331
332      ! interior value (2=<jk=<jpkm1)
333      DO_3D( 0, 0, 0, 0, 2, jpkm1 )
334         zcoef1 = zcoef0 * e3w(ji,jj,jk,Kmm)
335         ! hydrostatic pressure gradient
336         zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1)   &
337            &           + zcoef1 * (  ( rhd(ji+1,jj,jk) + rhd(ji+1,jj,jk-1) )   &
338            &                       - ( rhd(ji  ,jj,jk) + rhd(ji  ,jj,jk-1) )  ) * r1_e1u(ji,jj)
339
340         zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1)   &
341            &           + zcoef1 * (  ( rhd(ji,jj+1,jk) + rhd(ji,jj+1,jk-1) )   &
342            &                       - ( rhd(ji,jj,  jk) + rhd(ji,jj  ,jk-1) )  ) * r1_e2v(ji,jj)
343         ! add to the general momentum trend
344         puu(ji,jj,jk,Krhs) = puu(ji,jj,jk,Krhs) + zhpi(ji,jj,jk)
345         pvv(ji,jj,jk,Krhs) = pvv(ji,jj,jk,Krhs) + zhpj(ji,jj,jk)
346      END_3D
347
348      ! partial steps correction at the last level  (use zgru & zgrv computed in zpshde.F90)
349      DO_2D( 0, 0, 0, 0 )
350         iku = mbku(ji,jj)
351         ikv = mbkv(ji,jj)
352         zcoef2 = zcoef0 * MIN( e3w(ji,jj,iku,Kmm), e3w(ji+1,jj  ,iku,Kmm) )
353         zcoef3 = zcoef0 * MIN( e3w(ji,jj,ikv,Kmm), e3w(ji  ,jj+1,ikv,Kmm) )
354         IF( iku > 1 ) THEN            ! on i-direction (level 2 or more)
355            puu  (ji,jj,iku,Krhs) = puu(ji,jj,iku,Krhs) - zhpi(ji,jj,iku)         ! subtract old value
356            zhpi(ji,jj,iku) = zhpi(ji,jj,iku-1)                   &   ! compute the new one
357               &            + zcoef2 * ( rhd(ji+1,jj,iku-1) - rhd(ji,jj,iku-1) + zgru(ji,jj) ) * r1_e1u(ji,jj)
358            puu  (ji,jj,iku,Krhs) = puu(ji,jj,iku,Krhs) + zhpi(ji,jj,iku)         ! add the new one to the general momentum trend
359         ENDIF
360         IF( ikv > 1 ) THEN            ! on j-direction (level 2 or more)
361            pvv  (ji,jj,ikv,Krhs) = pvv(ji,jj,ikv,Krhs) - zhpj(ji,jj,ikv)         ! subtract old value
362            zhpj(ji,jj,ikv) = zhpj(ji,jj,ikv-1)                   &   ! compute the new one
363               &            + zcoef3 * ( rhd(ji,jj+1,ikv-1) - rhd(ji,jj,ikv-1) + zgrv(ji,jj) ) * r1_e2v(ji,jj)
364            pvv  (ji,jj,ikv,Krhs) = pvv(ji,jj,ikv,Krhs) + zhpj(ji,jj,ikv)         ! add the new one to the general momentum trend
365         ENDIF
366      END_2D
367      !
368   END SUBROUTINE hpg_zps
369
370
371   SUBROUTINE hpg_sco( kt, Kmm, puu, pvv, Krhs )
372      !!---------------------------------------------------------------------
373      !!                  ***  ROUTINE hpg_sco  ***
374      !!
375      !! ** Method  :   s-coordinate case. Jacobian scheme.
376      !!      The now hydrostatic pressure gradient at a given level, jk,
377      !!      is computed by taking the vertical integral of the in-situ
378      !!      density gradient along the model level from the suface to that
379      !!      level. s-coordinates (ln_sco): a corrective term is added
380      !!      to the horizontal pressure gradient :
381      !!         zhpi = grav .....  + 1/e1u mi(rhd) di[ grav dep3w ]
382      !!         zhpj = grav .....  + 1/e2v mj(rhd) dj[ grav dep3w ]
383      !!      add it to the general momentum trend (puu(:,:,:,Krhs),pvv(:,:,:,Krhs)).
384      !!         puu(:,:,:,Krhs) = puu(:,:,:,Krhs) - 1/e1u * zhpi
385      !!         pvv(:,:,:,Krhs) = pvv(:,:,:,Krhs) - 1/e2v * zhpj
386      !!
387      !! ** Action : - Update (puu(:,:,:,Krhs),pvv(:,:,:,Krhs)) with the now hydrastatic pressure trend
388      !!----------------------------------------------------------------------
389      INTEGER                             , INTENT( in )  ::  kt          ! ocean time-step index
390      INTEGER                             , INTENT( in )  ::  Kmm, Krhs   ! ocean time level indices
391      REAL(wp), DIMENSION(jpi,jpj,jpk,jpt), INTENT(inout) ::  puu, pvv    ! ocean velocities and RHS of momentum equation
392      !!
393      INTEGER  ::   ji, jj, jk, jii, jjj                 ! dummy loop indices
394      REAL(wp) ::   zcoef0, zuap, zvap, znad, ztmp       ! temporary scalars
395      LOGICAL  ::   ll_tmp1, ll_tmp2                     ! local logical variables
396      REAL(wp), DIMENSION(jpi,jpj,jpk)      ::   zhpi, zhpj
397      REAL(wp), DIMENSION(:,:), ALLOCATABLE ::   zcpx, zcpy   !W/D pressure filter
398      !!----------------------------------------------------------------------
399      !
400      IF( ln_wd_il ) ALLOCATE(zcpx(jpi,jpj), zcpy(jpi,jpj))
401      !
402      IF( kt == nit000 ) THEN
403         IF(lwp) WRITE(numout,*)
404         IF(lwp) WRITE(numout,*) 'dyn:hpg_sco : hydrostatic pressure gradient trend'
405         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   s-coordinate case, OPA original scheme used'
406      ENDIF
407      !
408      zcoef0 = - grav * 0.5_wp
409      IF ( ln_linssh ) THEN   ;   znad = 0._wp         ! Fixed    volume: density anomaly
410      ELSE                    ;   znad = 1._wp         ! Variable volume: density
411      ENDIF
412      !
413      IF( ln_wd_il ) THEN
414        DO_2D( 0, 0, 0, 0 )
415          ll_tmp1 = MIN(  ssh(ji,jj,Kmm)               ,  ssh(ji+1,jj,Kmm) ) >                &
416               &    MAX( -ht_0(ji,jj)               , -ht_0(ji+1,jj) ) .AND.            &
417               &    MAX(  ssh(ji,jj,Kmm) +  ht_0(ji,jj),  ssh(ji+1,jj,Kmm) + ht_0(ji+1,jj) )  &
418               &                                                       > rn_wdmin1 + rn_wdmin2
419          ll_tmp2 = ( ABS( ssh(ji,jj,Kmm)              -  ssh(ji+1,jj,Kmm) ) > 1.E-12 ) .AND. (       &
420               &    MAX(   ssh(ji,jj,Kmm)              ,  ssh(ji+1,jj,Kmm) ) >                &
421               &    MAX(  -ht_0(ji,jj)              , -ht_0(ji+1,jj) ) + rn_wdmin1 + rn_wdmin2 )
422
423          IF(ll_tmp1) THEN
424            zcpx(ji,jj) = 1.0_wp
425          ELSE IF(ll_tmp2) THEN
426            ! no worries about  ssh(ji+1,jj,Kmm) -  ssh(ji  ,jj,Kmm) = 0, it won't happen ! here
427            zcpx(ji,jj) = ABS( (ssh(ji+1,jj,Kmm) + ht_0(ji+1,jj) - ssh(ji,jj,Kmm) - ht_0(ji,jj)) &
428                        &    / (ssh(ji+1,jj,Kmm) - ssh(ji  ,jj,Kmm)) )
429          ELSE
430            zcpx(ji,jj) = 0._wp
431          END IF
432   
433          ll_tmp1 = MIN(  ssh(ji,jj,Kmm)              ,  ssh(ji,jj+1,Kmm) ) >                &
434               &    MAX( -ht_0(ji,jj)              , -ht_0(ji,jj+1) ) .AND.            &
435               &    MAX(  ssh(ji,jj,Kmm) + ht_0(ji,jj),  ssh(ji,jj+1,Kmm) + ht_0(ji,jj+1) )  &
436               &                                                      > rn_wdmin1 + rn_wdmin2
437          ll_tmp2 = ( ABS( ssh(ji,jj,Kmm)             -  ssh(ji,jj+1,Kmm) ) > 1.E-12 ) .AND. (        &
438               &    MAX(   ssh(ji,jj,Kmm)             ,  ssh(ji,jj+1,Kmm) ) >                &
439               &    MAX(  -ht_0(ji,jj)             , -ht_0(ji,jj+1) ) + rn_wdmin1 + rn_wdmin2 )
440
441          IF(ll_tmp1) THEN
442            zcpy(ji,jj) = 1.0_wp
443          ELSE IF(ll_tmp2) THEN
444            ! no worries about  ssh(ji,jj+1,Kmm) -  ssh(ji,jj  ,Kmm) = 0, it won't happen ! here
445            zcpy(ji,jj) = ABS( (ssh(ji,jj+1,Kmm) + ht_0(ji,jj+1) - ssh(ji,jj,Kmm) - ht_0(ji,jj)) &
446                        &    / (ssh(ji,jj+1,Kmm) - ssh(ji,jj  ,Kmm)) )
447          ELSE
448            zcpy(ji,jj) = 0._wp
449          END IF
450        END_2D
451        CALL lbc_lnk_multi( 'dynhpg', zcpx, 'U', 1.0_wp, zcpy, 'V', 1.0_wp )
452      END IF
453
454      ! Surface value
455      DO_2D( 0, 0, 0, 0 )
456         ! hydrostatic pressure gradient along s-surfaces
457         zhpi(ji,jj,1) =   &
458            &  zcoef0 * (  e3w(ji+1,jj  ,1,Kmm) * ( znad + rhd(ji+1,jj  ,1) )    &
459            &            - e3w(ji  ,jj  ,1,Kmm) * ( znad + rhd(ji  ,jj  ,1) )  ) &
460            &           * r1_e1u(ji,jj)
461         zhpj(ji,jj,1) =   &
462            &  zcoef0 * (  e3w(ji  ,jj+1,1,Kmm) * ( znad + rhd(ji  ,jj+1,1) )    &
463            &            - e3w(ji  ,jj  ,1,Kmm) * ( znad + rhd(ji  ,jj  ,1) )  ) &
464            &           * r1_e2v(ji,jj)
465         ! s-coordinate pressure gradient correction
466         zuap = -zcoef0 * ( rhd    (ji+1,jj,1) + rhd    (ji,jj,1) + 2._wp * znad )   &
467            &           * ( gde3w(ji+1,jj,1) - gde3w(ji,jj,1) ) * r1_e1u(ji,jj)
468         zvap = -zcoef0 * ( rhd    (ji,jj+1,1) + rhd    (ji,jj,1) + 2._wp * znad )   &
469            &           * ( gde3w(ji,jj+1,1) - gde3w(ji,jj,1) ) * r1_e2v(ji,jj)
470         !
471         IF( ln_wd_il ) THEN
472            zhpi(ji,jj,1) = zhpi(ji,jj,1) * zcpx(ji,jj)
473            zhpj(ji,jj,1) = zhpj(ji,jj,1) * zcpy(ji,jj) 
474            zuap = zuap * zcpx(ji,jj)
475            zvap = zvap * zcpy(ji,jj)
476         ENDIF
477         !
478         ! add to the general momentum trend
479         puu(ji,jj,1,Krhs) = puu(ji,jj,1,Krhs) + zhpi(ji,jj,1) + zuap
480         pvv(ji,jj,1,Krhs) = pvv(ji,jj,1,Krhs) + zhpj(ji,jj,1) + zvap
481      END_2D
482
483      ! interior value (2=<jk=<jpkm1)
484      DO_3D( 0, 0, 0, 0, 2, jpkm1 )
485         ! hydrostatic pressure gradient along s-surfaces
486         zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1) + zcoef0 * r1_e1u(ji,jj)   &
487            &           * (  e3w(ji+1,jj,jk,Kmm) * ( rhd(ji+1,jj,jk) + rhd(ji+1,jj,jk-1) + 2*znad )   &
488            &              - e3w(ji  ,jj,jk,Kmm) * ( rhd(ji  ,jj,jk) + rhd(ji  ,jj,jk-1) + 2*znad )  )
489         zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1) + zcoef0 * r1_e2v(ji,jj)   &
490            &           * (  e3w(ji,jj+1,jk,Kmm) * ( rhd(ji,jj+1,jk) + rhd(ji,jj+1,jk-1) + 2*znad )   &
491            &              - e3w(ji,jj  ,jk,Kmm) * ( rhd(ji,jj,  jk) + rhd(ji,jj  ,jk-1) + 2*znad )  )
492         ! s-coordinate pressure gradient correction
493         zuap = -zcoef0 * ( rhd    (ji+1,jj  ,jk) + rhd    (ji,jj,jk) + 2._wp * znad )   &
494            &           * ( gde3w(ji+1,jj  ,jk) - gde3w(ji,jj,jk) ) * r1_e1u(ji,jj)
495         zvap = -zcoef0 * ( rhd    (ji  ,jj+1,jk) + rhd    (ji,jj,jk) + 2._wp * znad )   &
496            &           * ( gde3w(ji  ,jj+1,jk) - gde3w(ji,jj,jk) ) * r1_e2v(ji,jj)
497         !
498         IF( ln_wd_il ) THEN
499            zhpi(ji,jj,jk) = zhpi(ji,jj,jk) * zcpx(ji,jj)
500            zhpj(ji,jj,jk) = zhpj(ji,jj,jk) * zcpy(ji,jj) 
501            zuap = zuap * zcpx(ji,jj)
502            zvap = zvap * zcpy(ji,jj)
503         ENDIF
504         !
505         ! add to the general momentum trend
506         puu(ji,jj,jk,Krhs) = puu(ji,jj,jk,Krhs) + zhpi(ji,jj,jk) + zuap
507         pvv(ji,jj,jk,Krhs) = pvv(ji,jj,jk,Krhs) + zhpj(ji,jj,jk) + zvap
508      END_3D
509      !
510      IF( ln_wd_il )  DEALLOCATE( zcpx , zcpy )
511      !
512   END SUBROUTINE hpg_sco
513
514
515   SUBROUTINE hpg_isf( kt, Kmm, puu, pvv, Krhs )
516      !!---------------------------------------------------------------------
517      !!                  ***  ROUTINE hpg_isf  ***
518      !!
519      !! ** Method  :   s-coordinate case. Jacobian scheme.
520      !!      The now hydrostatic pressure gradient at a given level, jk,
521      !!      is computed by taking the vertical integral of the in-situ
522      !!      density gradient along the model level from the suface to that
523      !!      level. s-coordinates (ln_sco): a corrective term is added
524      !!      to the horizontal pressure gradient :
525      !!         zhpi = grav .....  + 1/e1u mi(rhd) di[ grav dep3w ]
526      !!         zhpj = grav .....  + 1/e2v mj(rhd) dj[ grav dep3w ]
527      !!      add it to the general momentum trend (puu(:,:,:,Krhs),pvv(:,:,:,Krhs)).
528      !!         puu(:,:,:,Krhs) = puu(:,:,:,Krhs) - 1/e1u * zhpi
529      !!         pvv(:,:,:,Krhs) = pvv(:,:,:,Krhs) - 1/e2v * zhpj
530      !!      iceload is added
531      !!     
532      !! ** Action : - Update (puu(:,:,:,Krhs),pvv(:,:,:,Krhs)) with the now hydrastatic pressure trend
533      !!----------------------------------------------------------------------
534      INTEGER                             , INTENT( in )  ::  kt          ! ocean time-step index
535      INTEGER                             , INTENT( in )  ::  Kmm, Krhs   ! ocean time level indices
536      REAL(wp), DIMENSION(jpi,jpj,jpk,jpt), INTENT(inout) ::  puu, pvv    ! ocean velocities and RHS of momentum equation
537      !!
538      INTEGER  ::   ji, jj, jk, ikt, iktp1i, iktp1j   ! dummy loop indices
539      REAL(wp) ::   zcoef0, zuap, zvap, znad          ! temporary scalars
540      REAL(wp), DIMENSION(jpi,jpj,jpk ) ::  zhpi, zhpj
541      REAL(wp), DIMENSION(jpi,jpj,jpts) ::  zts_top
542      REAL(wp), DIMENSION(jpi,jpj)      ::  zrhdtop_oce
543      !!----------------------------------------------------------------------
544      !
545      zcoef0 = - grav * 0.5_wp   ! Local constant initialization
546      !
547      znad=1._wp                 ! To use density and not density anomaly
548      !
549      !                          ! iniitialised to 0. zhpi zhpi
550      zhpi(:,:,:) = 0._wp   ;   zhpj(:,:,:) = 0._wp
551
552      ! compute rhd at the ice/oce interface (ocean side)
553      ! usefull to reduce residual current in the test case ISOMIP with no melting
554      DO ji = 1, jpi
555        DO jj = 1, jpj
556          ikt = mikt(ji,jj)
557          zts_top(ji,jj,1) = ts(ji,jj,ikt,1,Kmm)
558          zts_top(ji,jj,2) = ts(ji,jj,ikt,2,Kmm)
559        END DO
560      END DO
561      CALL eos( zts_top, risfdep, zrhdtop_oce )
562
563!==================================================================================     
564!===== Compute surface value =====================================================
565!==================================================================================
566      DO_2D( 0, 0, 0, 0 )
567         ikt    = mikt(ji,jj)
568         iktp1i = mikt(ji+1,jj)
569         iktp1j = mikt(ji,jj+1)
570         ! hydrostatic pressure gradient along s-surfaces and ice shelf pressure
571         ! we assume ISF is in isostatic equilibrium
572         zhpi(ji,jj,1) = zcoef0 / e1u(ji,jj) * ( 0.5_wp * e3w(ji+1,jj,iktp1i,Kmm)                                    &
573            &                                    * ( 2._wp * znad + rhd(ji+1,jj,iktp1i) + zrhdtop_oce(ji+1,jj) )   &
574            &                                  - 0.5_wp * e3w(ji,jj,ikt,Kmm)                                         &
575            &                                    * ( 2._wp * znad + rhd(ji,jj,ikt) + zrhdtop_oce(ji,jj) )          &
576            &                                  + ( risfload(ji+1,jj) - risfload(ji,jj))                            ) 
577         zhpj(ji,jj,1) = zcoef0 / e2v(ji,jj) * ( 0.5_wp * e3w(ji,jj+1,iktp1j,Kmm)                                    &
578            &                                    * ( 2._wp * znad + rhd(ji,jj+1,iktp1j) + zrhdtop_oce(ji,jj+1) )   &
579            &                                  - 0.5_wp * e3w(ji,jj,ikt,Kmm)                                         & 
580            &                                    * ( 2._wp * znad + rhd(ji,jj,ikt) + zrhdtop_oce(ji,jj) )          &
581            &                                  + ( risfload(ji,jj+1) - risfload(ji,jj))                            ) 
582         ! s-coordinate pressure gradient correction (=0 if z coordinate)
583         zuap = -zcoef0 * ( rhd    (ji+1,jj,1) + rhd    (ji,jj,1) + 2._wp * znad )   &
584            &           * ( gde3w(ji+1,jj,1) - gde3w(ji,jj,1) ) * r1_e1u(ji,jj)
585         zvap = -zcoef0 * ( rhd    (ji,jj+1,1) + rhd    (ji,jj,1) + 2._wp * znad )   &
586            &           * ( gde3w(ji,jj+1,1) - gde3w(ji,jj,1) ) * r1_e2v(ji,jj)
587         ! add to the general momentum trend
588         puu(ji,jj,1,Krhs) = puu(ji,jj,1,Krhs) + (zhpi(ji,jj,1) + zuap) * umask(ji,jj,1)
589         pvv(ji,jj,1,Krhs) = pvv(ji,jj,1,Krhs) + (zhpj(ji,jj,1) + zvap) * vmask(ji,jj,1)
590      END_2D
591!==================================================================================     
592!===== Compute interior value =====================================================
593!==================================================================================
594      ! interior value (2=<jk=<jpkm1)
595      DO_3D( 0, 0, 0, 0, 2, jpkm1 )
596         ! hydrostatic pressure gradient along s-surfaces
597         zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1) + zcoef0 / e1u(ji,jj)   &
598            &           * (  e3w(ji+1,jj,jk,Kmm)                   &
599            &                  * ( rhd(ji+1,jj,jk) + rhd(ji+1,jj,jk-1) + 2*znad ) * wmask(ji+1,jj,jk)   &
600            &              - e3w(ji  ,jj,jk,Kmm)                   &
601            &                  * ( rhd(ji  ,jj,jk) + rhd(ji  ,jj,jk-1) + 2*znad ) * wmask(ji  ,jj,jk)   )
602         zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1) + zcoef0 / e2v(ji,jj)   &
603            &           * (  e3w(ji,jj+1,jk,Kmm)                   &
604            &                  * ( rhd(ji,jj+1,jk) + rhd(ji,jj+1,jk-1) + 2*znad ) * wmask(ji,jj+1,jk)   &
605            &              - e3w(ji,jj  ,jk,Kmm)                   &
606            &                  * ( rhd(ji,jj,  jk) + rhd(ji,jj  ,jk-1) + 2*znad ) * wmask(ji,jj  ,jk)   )
607         ! s-coordinate pressure gradient correction
608         zuap = -zcoef0 * ( rhd   (ji+1,jj  ,jk) + rhd   (ji,jj,jk) + 2._wp * znad )   &
609            &           * ( gde3w(ji+1,jj  ,jk) - gde3w(ji,jj,jk) ) / e1u(ji,jj)
610         zvap = -zcoef0 * ( rhd   (ji  ,jj+1,jk) + rhd   (ji,jj,jk) + 2._wp * znad )   &
611            &           * ( gde3w(ji  ,jj+1,jk) - gde3w(ji,jj,jk) ) / e2v(ji,jj)
612         ! add to the general momentum trend
613         puu(ji,jj,jk,Krhs) = puu(ji,jj,jk,Krhs) + (zhpi(ji,jj,jk) + zuap) * umask(ji,jj,jk)
614         pvv(ji,jj,jk,Krhs) = pvv(ji,jj,jk,Krhs) + (zhpj(ji,jj,jk) + zvap) * vmask(ji,jj,jk)
615      END_3D
616      !
617   END SUBROUTINE hpg_isf
618
619
620   SUBROUTINE hpg_djc( kt, Kmm, puu, pvv, Krhs )
621      !!---------------------------------------------------------------------
622      !!                  ***  ROUTINE hpg_djc  ***
623      !!
624      !! ** Method  :   Density Jacobian with Cubic polynomial scheme
625      !!
626      !! Reference: Shchepetkin and McWilliams, J. Geophys. Res., 108(C3), 3090, 2003
627      !!----------------------------------------------------------------------
628      INTEGER                             , INTENT( in )  ::  kt          ! ocean time-step index
629      INTEGER                             , INTENT( in )  ::  Kmm, Krhs   ! ocean time level indices
630      REAL(wp), DIMENSION(jpi,jpj,jpk,jpt), INTENT(inout) ::  puu, pvv    ! ocean velocities and RHS of momentum equation
631      !!
632      INTEGER  ::   ji, jj, jk          ! dummy loop indices
633      REAL(wp) ::   zcoef0, zep, cffw   ! temporary scalars
634      REAL(wp) ::   z1_10, cffu, cffx   !    "         "
635      REAL(wp) ::   z1_12, cffv, cffy   !    "         "
636      LOGICAL  ::   ll_tmp1, ll_tmp2    ! local logical variables
637      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zhpi, zhpj
638      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   dzx, dzy, dzz, dzu, dzv, dzw
639      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   drhox, drhoy, drhoz, drhou, drhov, drhow
640      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   rho_i, rho_j, rho_k
641      REAL(wp), DIMENSION(:,:), ALLOCATABLE ::   zcpx, zcpy   !W/D pressure filter
642      !!----------------------------------------------------------------------
643      !
644      IF( ln_wd_il ) THEN
645         ALLOCATE( zcpx(jpi,jpj) , zcpy(jpi,jpj) )
646        DO_2D( 0, 0, 0, 0 )
647          ll_tmp1 = MIN(  ssh(ji,jj,Kmm)              ,  ssh(ji+1,jj,Kmm) ) >                &
648               &    MAX( -ht_0(ji,jj)              , -ht_0(ji+1,jj) ) .AND.            &
649               &    MAX(  ssh(ji,jj,Kmm) + ht_0(ji,jj),  ssh(ji+1,jj,Kmm) + ht_0(ji+1,jj) )  &
650               &                                                      > rn_wdmin1 + rn_wdmin2
651          ll_tmp2 = ( ABS( ssh(ji,jj,Kmm)             -  ssh(ji+1,jj,Kmm) ) > 1.E-12 ) .AND. (        &
652               &    MAX(   ssh(ji,jj,Kmm)             ,  ssh(ji+1,jj,Kmm) ) >                &
653               &    MAX(  -ht_0(ji,jj)             , -ht_0(ji+1,jj) ) + rn_wdmin1 + rn_wdmin2 )
654          IF(ll_tmp1) THEN
655            zcpx(ji,jj) = 1.0_wp
656          ELSE IF(ll_tmp2) THEN
657            ! no worries about  ssh(ji+1,jj,Kmm) -  ssh(ji  ,jj,Kmm) = 0, it won't happen ! here
658            zcpx(ji,jj) = ABS( (ssh(ji+1,jj,Kmm) + ht_0(ji+1,jj) - ssh(ji,jj,Kmm) - ht_0(ji,jj)) &
659                        &    / (ssh(ji+1,jj,Kmm) - ssh(ji  ,jj,Kmm)) )
660          ELSE
661            zcpx(ji,jj) = 0._wp
662          END IF
663   
664          ll_tmp1 = MIN(  ssh(ji,jj,Kmm)              ,  ssh(ji,jj+1,Kmm) ) >                &
665               &    MAX( -ht_0(ji,jj)              , -ht_0(ji,jj+1) ) .AND.            &
666               &    MAX(  ssh(ji,jj,Kmm) + ht_0(ji,jj),  ssh(ji,jj+1,Kmm) + ht_0(ji,jj+1) )  &
667               &                                                      > rn_wdmin1 + rn_wdmin2
668          ll_tmp2 = ( ABS( ssh(ji,jj,Kmm)             -  ssh(ji,jj+1,Kmm) ) > 1.E-12 ) .AND. (        &
669               &    MAX(   ssh(ji,jj,Kmm)             ,  ssh(ji,jj+1,Kmm) ) >                &
670               &    MAX(  -ht_0(ji,jj)             , -ht_0(ji,jj+1) ) + rn_wdmin1 + rn_wdmin2 )
671
672          IF(ll_tmp1) THEN
673            zcpy(ji,jj) = 1.0_wp
674          ELSE IF(ll_tmp2) THEN
675            ! no worries about  ssh(ji,jj+1,Kmm) -  ssh(ji,jj  ,Kmm) = 0, it won't happen ! here
676            zcpy(ji,jj) = ABS( (ssh(ji,jj+1,Kmm) + ht_0(ji,jj+1) - ssh(ji,jj,Kmm) - ht_0(ji,jj)) &
677                        &    / (ssh(ji,jj+1,Kmm) - ssh(ji,jj  ,Kmm)) )
678          ELSE
679            zcpy(ji,jj) = 0._wp
680          END IF
681        END_2D
682        CALL lbc_lnk_multi( 'dynhpg', zcpx, 'U', 1.0_wp, zcpy, 'V', 1.0_wp )
683      END IF
684
685      IF( kt == nit000 ) THEN
686         IF(lwp) WRITE(numout,*)
687         IF(lwp) WRITE(numout,*) 'dyn:hpg_djc : hydrostatic pressure gradient trend'
688         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   s-coordinate case, density Jacobian with cubic polynomial scheme'
689      ENDIF
690
691      ! Local constant initialization
692      zcoef0 = - grav * 0.5_wp
693      z1_10  = 1._wp / 10._wp
694      z1_12  = 1._wp / 12._wp
695
696      !----------------------------------------------------------------------------------------
697      !  compute and store in provisional arrays elementary vertical and horizontal differences
698      !----------------------------------------------------------------------------------------
699
700!!bug gm   Not a true bug, but... dzz=e3w  for dzx, dzy verify what it is really
701
702      DO_3D( 0, 0, 0, 0, 2, jpkm1 )
703         drhoz(ji,jj,jk) = rhd    (ji  ,jj  ,jk) - rhd    (ji,jj,jk-1)
704         dzz  (ji,jj,jk) = gde3w(ji  ,jj  ,jk) - gde3w(ji,jj,jk-1)
705         drhox(ji,jj,jk) = rhd    (ji+1,jj  ,jk) - rhd    (ji,jj,jk  )
706         dzx  (ji,jj,jk) = gde3w(ji+1,jj  ,jk) - gde3w(ji,jj,jk  )
707         drhoy(ji,jj,jk) = rhd    (ji  ,jj+1,jk) - rhd    (ji,jj,jk  )
708         dzy  (ji,jj,jk) = gde3w(ji  ,jj+1,jk) - gde3w(ji,jj,jk  )
709      END_3D
710
711      !-------------------------------------------------------------------------
712      ! compute harmonic averages using eq. 5.18
713      !-------------------------------------------------------------------------
714      zep = 1.e-15
715
716!!bug  gm  drhoz not defined at level 1 and used (jk-1 with jk=2)
717!!bug  gm  idem for drhox, drhoy et ji=jpi and jj=jpj
718
719      DO_3D( 0, 0, 0, 0, 2, jpkm1 )
720         cffw = 2._wp * drhoz(ji  ,jj  ,jk) * drhoz(ji,jj,jk-1)
721
722         cffu = 2._wp * drhox(ji+1,jj  ,jk) * drhox(ji,jj,jk  )
723         cffx = 2._wp * dzx  (ji+1,jj  ,jk) * dzx  (ji,jj,jk  )
724
725         cffv = 2._wp * drhoy(ji  ,jj+1,jk) * drhoy(ji,jj,jk  )
726         cffy = 2._wp * dzy  (ji  ,jj+1,jk) * dzy  (ji,jj,jk  )
727
728         IF( cffw > zep) THEN
729            drhow(ji,jj,jk) = 2._wp *   drhoz(ji,jj,jk) * drhoz(ji,jj,jk-1)   &
730               &                    / ( drhoz(ji,jj,jk) + drhoz(ji,jj,jk-1) )
731         ELSE
732            drhow(ji,jj,jk) = 0._wp
733         ENDIF
734
735         dzw(ji,jj,jk) = 2._wp *   dzz(ji,jj,jk) * dzz(ji,jj,jk-1)   &
736            &                  / ( dzz(ji,jj,jk) + dzz(ji,jj,jk-1) )
737
738         IF( cffu > zep ) THEN
739            drhou(ji,jj,jk) = 2._wp *   drhox(ji+1,jj,jk) * drhox(ji,jj,jk)   &
740               &                    / ( drhox(ji+1,jj,jk) + drhox(ji,jj,jk) )
741         ELSE
742            drhou(ji,jj,jk ) = 0._wp
743         ENDIF
744
745         IF( cffx > zep ) THEN
746            dzu(ji,jj,jk) = 2._wp *   dzx(ji+1,jj,jk) * dzx(ji,jj,jk)   &
747               &                  / ( dzx(ji+1,jj,jk) + dzx(ji,jj,jk) )
748         ELSE
749            dzu(ji,jj,jk) = 0._wp
750         ENDIF
751
752         IF( cffv > zep ) THEN
753            drhov(ji,jj,jk) = 2._wp *   drhoy(ji,jj+1,jk) * drhoy(ji,jj,jk)   &
754               &                    / ( drhoy(ji,jj+1,jk) + drhoy(ji,jj,jk) )
755         ELSE
756            drhov(ji,jj,jk) = 0._wp
757         ENDIF
758
759         IF( cffy > zep ) THEN
760            dzv(ji,jj,jk) = 2._wp *   dzy(ji,jj+1,jk) * dzy(ji,jj,jk)   &
761               &                  / ( dzy(ji,jj+1,jk) + dzy(ji,jj,jk) )
762         ELSE
763            dzv(ji,jj,jk) = 0._wp
764         ENDIF
765
766      END_3D
767
768      !----------------------------------------------------------------------------------
769      ! apply boundary conditions at top and bottom using 5.36-5.37
770      !----------------------------------------------------------------------------------
771      drhow(:,:, 1 ) = 1.5_wp * ( drhoz(:,:, 2 ) - drhoz(:,:,  1  ) ) - 0.5_wp * drhow(:,:,  2  )
772      drhou(:,:, 1 ) = 1.5_wp * ( drhox(:,:, 2 ) - drhox(:,:,  1  ) ) - 0.5_wp * drhou(:,:,  2  )
773      drhov(:,:, 1 ) = 1.5_wp * ( drhoy(:,:, 2 ) - drhoy(:,:,  1  ) ) - 0.5_wp * drhov(:,:,  2  )
774
775      drhow(:,:,jpk) = 1.5_wp * ( drhoz(:,:,jpk) - drhoz(:,:,jpkm1) ) - 0.5_wp * drhow(:,:,jpkm1)
776      drhou(:,:,jpk) = 1.5_wp * ( drhox(:,:,jpk) - drhox(:,:,jpkm1) ) - 0.5_wp * drhou(:,:,jpkm1)
777      drhov(:,:,jpk) = 1.5_wp * ( drhoy(:,:,jpk) - drhoy(:,:,jpkm1) ) - 0.5_wp * drhov(:,:,jpkm1)
778
779
780      !--------------------------------------------------------------
781      ! Upper half of top-most grid box, compute and store
782      !-------------------------------------------------------------
783
784!!bug gm   :  e3w-gde3w(:,:,:) = 0.5*e3w  ....  and gde3w(:,:,2)-gde3w(:,:,1)=e3w(:,:,2,Kmm) ....   to be verified
785!          true if gde3w(:,:,:) is really defined as the sum of the e3w scale factors as, it seems to me, it should be
786
787      DO_2D( 0, 0, 0, 0 )
788         rho_k(ji,jj,1) = -grav * ( e3w(ji,jj,1,Kmm) - gde3w(ji,jj,1) )               &
789            &                   * (  rhd(ji,jj,1)                                     &
790            &                     + 0.5_wp * ( rhd    (ji,jj,2) - rhd    (ji,jj,1) )  &
791            &                              * ( e3w  (ji,jj,1,Kmm) - gde3w(ji,jj,1) )  &
792            &                              / ( gde3w(ji,jj,2) - gde3w(ji,jj,1) )  )
793      END_2D
794
795!!bug gm    : here also, simplification is possible
796!!bug gm    : optimisation: 1/10 and 1/12 the division should be done before the loop
797
798      DO_3D( 0, 0, 0, 0, 2, jpkm1 )
799
800         rho_k(ji,jj,jk) = zcoef0 * ( rhd    (ji,jj,jk) + rhd    (ji,jj,jk-1) )                                   &
801            &                     * ( gde3w(ji,jj,jk) - gde3w(ji,jj,jk-1) )                                   &
802            &            - grav * z1_10 * (                                                                   &
803            &     ( drhow  (ji,jj,jk) - drhow  (ji,jj,jk-1) )                                                     &
804            &   * ( gde3w(ji,jj,jk) - gde3w(ji,jj,jk-1) - z1_12 * ( dzw  (ji,jj,jk) + dzw  (ji,jj,jk-1) ) )   &
805            &   - ( dzw    (ji,jj,jk) - dzw    (ji,jj,jk-1) )                                                     &
806            &   * ( rhd    (ji,jj,jk) - rhd    (ji,jj,jk-1) - z1_12 * ( drhow(ji,jj,jk) + drhow(ji,jj,jk-1) ) )   &
807            &                             )
808
809         rho_i(ji,jj,jk) = zcoef0 * ( rhd    (ji+1,jj,jk) + rhd    (ji,jj,jk) )                                   &
810            &                     * ( gde3w(ji+1,jj,jk) - gde3w(ji,jj,jk) )                                   &
811            &            - grav* z1_10 * (                                                                    &
812            &     ( drhou  (ji+1,jj,jk) - drhou  (ji,jj,jk) )                                                     &
813            &   * ( gde3w(ji+1,jj,jk) - gde3w(ji,jj,jk) - z1_12 * ( dzu  (ji+1,jj,jk) + dzu  (ji,jj,jk) ) )   &
814            &   - ( dzu    (ji+1,jj,jk) - dzu    (ji,jj,jk) )                                                     &
815            &   * ( rhd    (ji+1,jj,jk) - rhd    (ji,jj,jk) - z1_12 * ( drhou(ji+1,jj,jk) + drhou(ji,jj,jk) ) )   &
816            &                            )
817
818         rho_j(ji,jj,jk) = zcoef0 * ( rhd    (ji,jj+1,jk) + rhd    (ji,jj,jk) )                                 &
819            &                     * ( gde3w(ji,jj+1,jk) - gde3w(ji,jj,jk) )                                   &
820            &            - grav* z1_10 * (                                                                    &
821            &     ( drhov  (ji,jj+1,jk) - drhov  (ji,jj,jk) )                                                     &
822            &   * ( gde3w(ji,jj+1,jk) - gde3w(ji,jj,jk) - z1_12 * ( dzv  (ji,jj+1,jk) + dzv  (ji,jj,jk) ) )   &
823            &   - ( dzv    (ji,jj+1,jk) - dzv    (ji,jj,jk) )                                                     &
824            &   * ( rhd    (ji,jj+1,jk) - rhd    (ji,jj,jk) - z1_12 * ( drhov(ji,jj+1,jk) + drhov(ji,jj,jk) ) )   &
825            &                            )
826
827      END_3D
828      CALL lbc_lnk_multi( 'dynhpg', rho_k, 'W', 1.0_wp, rho_i, 'U', 1.0_wp, rho_j, 'V', 1.0_wp )
829
830      ! ---------------
831      !  Surface value
832      ! ---------------
833      DO_2D( 0, 0, 0, 0 )
834         zhpi(ji,jj,1) = ( rho_k(ji+1,jj  ,1) - rho_k(ji,jj,1) - rho_i(ji,jj,1) ) * r1_e1u(ji,jj)
835         zhpj(ji,jj,1) = ( rho_k(ji  ,jj+1,1) - rho_k(ji,jj,1) - rho_j(ji,jj,1) ) * r1_e2v(ji,jj)
836         IF( ln_wd_il ) THEN
837           zhpi(ji,jj,1) = zhpi(ji,jj,1) * zcpx(ji,jj)
838           zhpj(ji,jj,1) = zhpj(ji,jj,1) * zcpy(ji,jj) 
839         ENDIF
840         ! add to the general momentum trend
841         puu(ji,jj,1,Krhs) = puu(ji,jj,1,Krhs) + zhpi(ji,jj,1)
842         pvv(ji,jj,1,Krhs) = pvv(ji,jj,1,Krhs) + zhpj(ji,jj,1)
843      END_2D
844
845      ! ----------------
846      !  interior value   (2=<jk=<jpkm1)
847      ! ----------------
848      DO_3D( 0, 0, 0, 0, 2, jpkm1 )
849         ! hydrostatic pressure gradient along s-surfaces
850         zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1)                                &
851            &           + (  ( rho_k(ji+1,jj,jk) - rho_k(ji,jj,jk  ) )    &
852            &              - ( rho_i(ji  ,jj,jk) - rho_i(ji,jj,jk-1) )  ) * r1_e1u(ji,jj)
853         zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1)                                &
854            &           + (  ( rho_k(ji,jj+1,jk) - rho_k(ji,jj,jk  ) )    &
855            &               -( rho_j(ji,jj  ,jk) - rho_j(ji,jj,jk-1) )  ) * r1_e2v(ji,jj)
856         IF( ln_wd_il ) THEN
857           zhpi(ji,jj,jk) = zhpi(ji,jj,jk) * zcpx(ji,jj)
858           zhpj(ji,jj,jk) = zhpj(ji,jj,jk) * zcpy(ji,jj) 
859         ENDIF
860         ! add to the general momentum trend
861         puu(ji,jj,jk,Krhs) = puu(ji,jj,jk,Krhs) + zhpi(ji,jj,jk)
862         pvv(ji,jj,jk,Krhs) = pvv(ji,jj,jk,Krhs) + zhpj(ji,jj,jk)
863      END_3D
864      !
865      IF( ln_wd_il )   DEALLOCATE( zcpx, zcpy )
866      !
867   END SUBROUTINE hpg_djc
868
869
870   SUBROUTINE hpg_prj( kt, Kmm, puu, pvv, Krhs )
871      !!---------------------------------------------------------------------
872      !!                  ***  ROUTINE hpg_prj  ***
873      !!
874      !! ** Method  :   s-coordinate case.
875      !!      A Pressure-Jacobian horizontal pressure gradient method
876      !!      based on the constrained cubic-spline interpolation for
877      !!      all vertical coordinate systems
878      !!
879      !! ** Action : - Update (puu(:,:,:,Krhs),pvv(:,:,:,Krhs)) with the now hydrastatic pressure trend
880      !!----------------------------------------------------------------------
881      INTEGER, PARAMETER  :: polynomial_type = 1    ! 1: cubic spline, 2: linear
882      INTEGER                             , INTENT( in )  ::  kt          ! ocean time-step index
883      INTEGER                             , INTENT( in )  ::  Kmm, Krhs   ! ocean time level indices
884      REAL(wp), DIMENSION(jpi,jpj,jpk,jpt), INTENT(inout) ::  puu, pvv    ! ocean velocities and RHS of momentum equation
885      !!
886      INTEGER  ::   ji, jj, jk, jkk                 ! dummy loop indices
887      REAL(wp) ::   zcoef0, znad                    ! local scalars
888      !
889      !! The local variables for the correction term
890      INTEGER  :: jk1, jis, jid, jjs, jjd
891      LOGICAL  :: ll_tmp1, ll_tmp2                  ! local logical variables
892      REAL(wp) :: zuijk, zvijk, zpwes, zpwed, zpnss, zpnsd, zdeps
893      REAL(wp) :: zrhdt1
894      REAL(wp) :: zdpdx1, zdpdx2, zdpdy1, zdpdy2
895      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zdept, zrhh
896      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zhpi, zu, zv, fsp, xsp, asp, bsp, csp, dsp
897      REAL(wp), DIMENSION(jpi,jpj)   ::   zsshu_n, zsshv_n
898      REAL(wp), DIMENSION(:,:), ALLOCATABLE ::   zcpx, zcpy   !W/D pressure filter
899      !!----------------------------------------------------------------------
900      !
901      IF( kt == nit000 ) THEN
902         IF(lwp) WRITE(numout,*)
903         IF(lwp) WRITE(numout,*) 'dyn:hpg_prj : hydrostatic pressure gradient trend'
904         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   s-coordinate case, cubic spline pressure Jacobian'
905      ENDIF
906
907      ! Local constant initialization
908      zcoef0 = - grav
909      znad = 1._wp
910      IF( ln_linssh )   znad = 0._wp
911
912      IF( ln_wd_il ) THEN
913         ALLOCATE( zcpx(jpi,jpj) , zcpy(jpi,jpj) )
914         DO_2D( 0, 0, 0, 0 )
915          ll_tmp1 = MIN(  ssh(ji,jj,Kmm)              ,  ssh(ji+1,jj,Kmm) ) >                &
916               &    MAX( -ht_0(ji,jj)              , -ht_0(ji+1,jj) ) .AND.            &
917               &    MAX(  ssh(ji,jj,Kmm) + ht_0(ji,jj),  ssh(ji+1,jj,Kmm) + ht_0(ji+1,jj) )  &
918               &                                                      > rn_wdmin1 + rn_wdmin2
919          ll_tmp2 = ( ABS( ssh(ji,jj,Kmm)             -  ssh(ji+1,jj,Kmm) ) > 1.E-12 ) .AND. (         &
920               &    MAX(   ssh(ji,jj,Kmm)             ,  ssh(ji+1,jj,Kmm) ) >                &
921               &    MAX(  -ht_0(ji,jj)             , -ht_0(ji+1,jj) ) + rn_wdmin1 + rn_wdmin2 )
922
923          IF(ll_tmp1) THEN
924            zcpx(ji,jj) = 1.0_wp
925          ELSE IF(ll_tmp2) THEN
926            ! no worries about  ssh(ji+1,jj,Kmm) -  ssh(ji  ,jj,Kmm) = 0, it won't happen ! here
927            zcpx(ji,jj) = ABS( (ssh(ji+1,jj,Kmm) + ht_0(ji+1,jj) - ssh(ji,jj,Kmm) - ht_0(ji,jj)) &
928                        &    / (ssh(ji+1,jj,Kmm) -  ssh(ji  ,jj,Kmm)) )
929           
930             zcpx(ji,jj) = max(min( zcpx(ji,jj) , 1.0_wp),0.0_wp)
931          ELSE
932            zcpx(ji,jj) = 0._wp
933          END IF
934   
935          ll_tmp1 = MIN(  ssh(ji,jj,Kmm)              ,  ssh(ji,jj+1,Kmm) ) >                &
936               &    MAX( -ht_0(ji,jj)              , -ht_0(ji,jj+1) ) .AND.            &
937               &    MAX(  ssh(ji,jj,Kmm) + ht_0(ji,jj),  ssh(ji,jj+1,Kmm) + ht_0(ji,jj+1) )  &
938               &                                                      > rn_wdmin1 + rn_wdmin2
939          ll_tmp2 = ( ABS( ssh(ji,jj,Kmm)             -  ssh(ji,jj+1,Kmm) ) > 1.E-12 ) .AND. (      &
940               &    MAX(   ssh(ji,jj,Kmm)             ,  ssh(ji,jj+1,Kmm) ) >                &
941               &    MAX(  -ht_0(ji,jj)             , -ht_0(ji,jj+1) ) + rn_wdmin1 + rn_wdmin2 )
942
943          IF(ll_tmp1) THEN
944            zcpy(ji,jj) = 1.0_wp
945          ELSE IF(ll_tmp2) THEN
946            ! no worries about  ssh(ji,jj+1,Kmm) -  ssh(ji,jj  ,Kmm) = 0, it won't happen ! here
947            zcpy(ji,jj) = ABS( (ssh(ji,jj+1,Kmm) + ht_0(ji,jj+1) - ssh(ji,jj,Kmm) - ht_0(ji,jj)) &
948                        &    / (ssh(ji,jj+1,Kmm) - ssh(ji,jj  ,Kmm)) )
949             zcpy(ji,jj) = max(min( zcpy(ji,jj) , 1.0_wp),0.0_wp)
950
951            ELSE
952               zcpy(ji,jj) = 0._wp
953            ENDIF
954         END_2D
955         CALL lbc_lnk_multi( 'dynhpg', zcpx, 'U', 1.0_wp, zcpy, 'V', 1.0_wp )
956      ENDIF
957
958      ! Clean 3-D work arrays
959      zhpi(:,:,:) = 0._wp
960      zrhh(:,:,:) = rhd(:,:,:)
961
962      ! Preparing vertical density profile "zrhh(:,:,:)" for hybrid-sco coordinate
963      DO_2D( 1, 1, 1, 1 )
964       jk = mbkt(ji,jj)
965       IF(     jk <=  1   ) THEN   ;   zrhh(ji,jj,    :   ) = 0._wp
966       ELSEIF( jk ==  2   ) THEN   ;   zrhh(ji,jj,jk+1:jpk) = rhd(ji,jj,jk)
967       ELSEIF( jk < jpkm1 ) THEN
968          DO jkk = jk+1, jpk
969             zrhh(ji,jj,jkk) = interp1(gde3w(ji,jj,jkk  ), gde3w(ji,jj,jkk-1),   &
970                &                      gde3w(ji,jj,jkk-2), zrhh (ji,jj,jkk-1), zrhh(ji,jj,jkk-2))
971          END DO
972       ENDIF
973      END_2D
974
975      ! Transfer the depth of "T(:,:,:)" to vertical coordinate "zdept(:,:,:)"
976      DO_2D( 1, 1, 1, 1 )
977         zdept(ji,jj,1) = 0.5_wp * e3w(ji,jj,1,Kmm) - ssh(ji,jj,Kmm) * znad
978      END_2D
979
980      DO_3D( 1, 1, 1, 1, 2, jpk )
981         zdept(ji,jj,jk) = zdept(ji,jj,jk-1) + e3w(ji,jj,jk,Kmm)
982      END_3D
983
984      fsp(:,:,:) = zrhh (:,:,:)
985      xsp(:,:,:) = zdept(:,:,:)
986
987      ! Construct the vertical density profile with the
988      ! constrained cubic spline interpolation
989      ! rho(z) = asp + bsp*z + csp*z^2 + dsp*z^3
990      CALL cspline( fsp, xsp, asp, bsp, csp, dsp, polynomial_type )
991
992      ! Integrate the hydrostatic pressure "zhpi(:,:,:)" at "T(ji,jj,1)"
993      DO_2D( 0, 1, 0, 1 )
994       zrhdt1 = zrhh(ji,jj,1) - interp3( zdept(ji,jj,1), asp(ji,jj,1), bsp(ji,jj,1),  &
995          &                                              csp(ji,jj,1), dsp(ji,jj,1) ) * 0.25_wp * e3w(ji,jj,1,Kmm)
996
997       ! assuming linear profile across the top half surface layer
998       zhpi(ji,jj,1) =  0.5_wp * e3w(ji,jj,1,Kmm) * zrhdt1
999      END_2D
1000
1001      ! Calculate the pressure "zhpi(:,:,:)" at "T(ji,jj,2:jpkm1)"
1002      DO_3D( 0, 1, 0, 1, 2, jpkm1 )
1003      zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1) +                                  &
1004         &             integ_spline( zdept(ji,jj,jk-1), zdept(ji,jj,jk),   &
1005         &                           asp  (ji,jj,jk-1), bsp  (ji,jj,jk-1), &
1006         &                           csp  (ji,jj,jk-1), dsp  (ji,jj,jk-1)  )
1007      END_3D
1008
1009      ! Z coordinate of U(ji,jj,1:jpkm1) and V(ji,jj,1:jpkm1)
1010
1011      ! Prepare zsshu_n and zsshv_n
1012      DO_2D( 0, 0, 0, 0 )
1013!!gm BUG ?    if it is ssh at u- & v-point then it should be:
1014!          zsshu_n(ji,jj) = (e1e2t(ji,jj) * ssh(ji,jj,Kmm) + e1e2t(ji+1,jj) * ssh(ji+1,jj,Kmm)) * &
1015!                         & r1_e1e2u(ji,jj) * umask(ji,jj,1) * 0.5_wp
1016!          zsshv_n(ji,jj) = (e1e2t(ji,jj) * ssh(ji,jj,Kmm) + e1e2t(ji,jj+1) * ssh(ji,jj+1,Kmm)) * &
1017!                         & r1_e1e2v(ji,jj) * vmask(ji,jj,1) * 0.5_wp
1018!!gm not this:
1019       zsshu_n(ji,jj) = (e1e2u(ji,jj) * ssh(ji,jj,Kmm) + e1e2u(ji+1, jj) * ssh(ji+1,jj,Kmm)) * &
1020                      & r1_e1e2u(ji,jj) * umask(ji,jj,1) * 0.5_wp 
1021       zsshv_n(ji,jj) = (e1e2v(ji,jj) * ssh(ji,jj,Kmm) + e1e2v(ji+1, jj) * ssh(ji,jj+1,Kmm)) * &
1022                      & r1_e1e2v(ji,jj) * vmask(ji,jj,1) * 0.5_wp 
1023      END_2D
1024
1025      CALL lbc_lnk_multi ('dynhpg', zsshu_n, 'U', 1.0_wp, zsshv_n, 'V', 1.0_wp )
1026
1027      DO_2D( 0, 0, 0, 0 )
1028       zu(ji,jj,1) = - ( e3u(ji,jj,1,Kmm) - zsshu_n(ji,jj) * znad) 
1029       zv(ji,jj,1) = - ( e3v(ji,jj,1,Kmm) - zsshv_n(ji,jj) * znad)
1030      END_2D
1031
1032      DO_3D( 0, 0, 0, 0, 2, jpkm1 )
1033      zu(ji,jj,jk) = zu(ji,jj,jk-1) - e3u(ji,jj,jk,Kmm)
1034      zv(ji,jj,jk) = zv(ji,jj,jk-1) - e3v(ji,jj,jk,Kmm)
1035      END_3D
1036
1037      DO_3D( 0, 0, 0, 0, 1, jpkm1 )
1038      zu(ji,jj,jk) = zu(ji,jj,jk) + 0.5_wp * e3u(ji,jj,jk,Kmm)
1039      zv(ji,jj,jk) = zv(ji,jj,jk) + 0.5_wp * e3v(ji,jj,jk,Kmm)
1040      END_3D
1041
1042      DO_3D( 0, 0, 0, 0, 1, jpkm1 )
1043      zu(ji,jj,jk) = MIN(  zu(ji,jj,jk) , MAX( -zdept(ji,jj,jk) , -zdept(ji+1,jj,jk) )  )
1044      zu(ji,jj,jk) = MAX(  zu(ji,jj,jk) , MIN( -zdept(ji,jj,jk) , -zdept(ji+1,jj,jk) )  )
1045      zv(ji,jj,jk) = MIN(  zv(ji,jj,jk) , MAX( -zdept(ji,jj,jk) , -zdept(ji,jj+1,jk) )  )
1046      zv(ji,jj,jk) = MAX(  zv(ji,jj,jk) , MIN( -zdept(ji,jj,jk) , -zdept(ji,jj+1,jk) )  )
1047      END_3D
1048
1049
1050      DO_3D( 0, 0, 0, 0, 1, jpkm1 )
1051      zpwes = 0._wp; zpwed = 0._wp
1052      zpnss = 0._wp; zpnsd = 0._wp
1053      zuijk = zu(ji,jj,jk)
1054      zvijk = zv(ji,jj,jk)
1055
1056      !!!!!     for u equation
1057      IF( jk <= mbku(ji,jj) ) THEN
1058         IF( -zdept(ji+1,jj,jk) >= -zdept(ji,jj,jk) ) THEN
1059           jis = ji + 1; jid = ji
1060         ELSE
1061           jis = ji;     jid = ji +1
1062         ENDIF
1063
1064         ! integrate the pressure on the shallow side
1065         jk1 = jk
1066         DO WHILE ( -zdept(jis,jj,jk1) > zuijk )
1067           IF( jk1 == mbku(ji,jj) ) THEN
1068             zuijk = -zdept(jis,jj,jk1)
1069             EXIT
1070           ENDIF
1071           zdeps = MIN(zdept(jis,jj,jk1+1), -zuijk)
1072           zpwes = zpwes +                                    &
1073                integ_spline(zdept(jis,jj,jk1), zdeps,            &
1074                       asp(jis,jj,jk1),    bsp(jis,jj,jk1), &
1075                       csp(jis,jj,jk1),    dsp(jis,jj,jk1))
1076           jk1 = jk1 + 1
1077         END DO
1078
1079         ! integrate the pressure on the deep side
1080         jk1 = jk
1081         DO WHILE ( -zdept(jid,jj,jk1) < zuijk )
1082           IF( jk1 == 1 ) THEN
1083             zdeps = zdept(jid,jj,1) + MIN(zuijk, ssh(jid,jj,Kmm)*znad)
1084             zrhdt1 = zrhh(jid,jj,1) - interp3(zdept(jid,jj,1), asp(jid,jj,1), &
1085                                               bsp(jid,jj,1),   csp(jid,jj,1), &
1086                                               dsp(jid,jj,1)) * zdeps
1087             zpwed  = zpwed + 0.5_wp * (zrhh(jid,jj,1) + zrhdt1) * zdeps
1088             EXIT
1089           ENDIF
1090           zdeps = MAX(zdept(jid,jj,jk1-1), -zuijk)
1091           zpwed = zpwed +                                        &
1092                  integ_spline(zdeps,              zdept(jid,jj,jk1), &
1093                         asp(jid,jj,jk1-1), bsp(jid,jj,jk1-1),  &
1094                         csp(jid,jj,jk1-1), dsp(jid,jj,jk1-1) )
1095           jk1 = jk1 - 1
1096         END DO
1097
1098         ! update the momentum trends in u direction
1099
1100         zdpdx1 = zcoef0 * r1_e1u(ji,jj) * ( zhpi(ji+1,jj,jk) - zhpi(ji,jj,jk) )
1101         IF( .NOT.ln_linssh ) THEN
1102           zdpdx2 = zcoef0 * r1_e1u(ji,jj) * &
1103              &    ( REAL(jis-jid, wp) * (zpwes + zpwed) + (ssh(ji+1,jj,Kmm)-ssh(ji,jj,Kmm)) )
1104          ELSE
1105           zdpdx2 = zcoef0 * r1_e1u(ji,jj) * REAL(jis-jid, wp) * (zpwes + zpwed)
1106         ENDIF
1107         IF( ln_wd_il ) THEN
1108            zdpdx1 = zdpdx1 * zcpx(ji,jj) * wdrampu(ji,jj)
1109            zdpdx2 = zdpdx2 * zcpx(ji,jj) * wdrampu(ji,jj)
1110         ENDIF
1111         puu(ji,jj,jk,Krhs) = puu(ji,jj,jk,Krhs) + (zdpdx1 + zdpdx2) * umask(ji,jj,jk) 
1112      ENDIF
1113
1114      !!!!!     for v equation
1115      IF( jk <= mbkv(ji,jj) ) THEN
1116         IF( -zdept(ji,jj+1,jk) >= -zdept(ji,jj,jk) ) THEN
1117           jjs = jj + 1; jjd = jj
1118         ELSE
1119           jjs = jj    ; jjd = jj + 1
1120         ENDIF
1121
1122         ! integrate the pressure on the shallow side
1123         jk1 = jk
1124         DO WHILE ( -zdept(ji,jjs,jk1) > zvijk )
1125           IF( jk1 == mbkv(ji,jj) ) THEN
1126             zvijk = -zdept(ji,jjs,jk1)
1127             EXIT
1128           ENDIF
1129           zdeps = MIN(zdept(ji,jjs,jk1+1), -zvijk)
1130           zpnss = zpnss +                                      &
1131                  integ_spline(zdept(ji,jjs,jk1), zdeps,            &
1132                         asp(ji,jjs,jk1),    bsp(ji,jjs,jk1), &
1133                         csp(ji,jjs,jk1),    dsp(ji,jjs,jk1) )
1134           jk1 = jk1 + 1
1135         END DO
1136
1137         ! integrate the pressure on the deep side
1138         jk1 = jk
1139         DO WHILE ( -zdept(ji,jjd,jk1) < zvijk )
1140           IF( jk1 == 1 ) THEN
1141             zdeps = zdept(ji,jjd,1) + MIN(zvijk, ssh(ji,jjd,Kmm)*znad)
1142             zrhdt1 = zrhh(ji,jjd,1) - interp3(zdept(ji,jjd,1), asp(ji,jjd,1), &
1143                                               bsp(ji,jjd,1),   csp(ji,jjd,1), &
1144                                               dsp(ji,jjd,1) ) * zdeps
1145             zpnsd  = zpnsd + 0.5_wp * (zrhh(ji,jjd,1) + zrhdt1) * zdeps
1146             EXIT
1147           ENDIF
1148           zdeps = MAX(zdept(ji,jjd,jk1-1), -zvijk)
1149           zpnsd = zpnsd +                                        &
1150                  integ_spline(zdeps,              zdept(ji,jjd,jk1), &
1151                         asp(ji,jjd,jk1-1), bsp(ji,jjd,jk1-1), &
1152                         csp(ji,jjd,jk1-1), dsp(ji,jjd,jk1-1) )
1153           jk1 = jk1 - 1
1154         END DO
1155
1156
1157         ! update the momentum trends in v direction
1158
1159         zdpdy1 = zcoef0 * r1_e2v(ji,jj) * ( zhpi(ji,jj+1,jk) - zhpi(ji,jj,jk) )
1160         IF( .NOT.ln_linssh ) THEN
1161            zdpdy2 = zcoef0 * r1_e2v(ji,jj) * &
1162                    ( REAL(jjs-jjd, wp) * (zpnss + zpnsd) + (ssh(ji,jj+1,Kmm)-ssh(ji,jj,Kmm)) )
1163         ELSE
1164            zdpdy2 = zcoef0 * r1_e2v(ji,jj) * REAL(jjs-jjd, wp) * (zpnss + zpnsd )
1165         ENDIF
1166         IF( ln_wd_il ) THEN
1167            zdpdy1 = zdpdy1 * zcpy(ji,jj) * wdrampv(ji,jj) 
1168            zdpdy2 = zdpdy2 * zcpy(ji,jj) * wdrampv(ji,jj) 
1169         ENDIF
1170
1171         pvv(ji,jj,jk,Krhs) = pvv(ji,jj,jk,Krhs) + (zdpdy1 + zdpdy2) * vmask(ji,jj,jk)
1172      ENDIF
1173         !
1174      END_3D
1175      !
1176      IF( ln_wd_il )   DEALLOCATE( zcpx, zcpy )
1177      !
1178   END SUBROUTINE hpg_prj
1179
1180
1181   SUBROUTINE cspline( fsp, xsp, asp, bsp, csp, dsp, polynomial_type )
1182      !!----------------------------------------------------------------------
1183      !!                 ***  ROUTINE cspline  ***
1184      !!
1185      !! ** Purpose :   constrained cubic spline interpolation
1186      !!
1187      !! ** Method  :   f(x) = asp + bsp*x + csp*x^2 + dsp*x^3
1188      !!
1189      !! Reference: CJC Kruger, Constrained Cubic Spline Interpoltation
1190      !!----------------------------------------------------------------------
1191      REAL(wp), DIMENSION(:,:,:), INTENT(in   ) ::   fsp, xsp           ! value and coordinate
1192      REAL(wp), DIMENSION(:,:,:), INTENT(  out) ::   asp, bsp, csp, dsp ! coefficients of the interpoated function
1193      INTEGER                   , INTENT(in   ) ::   polynomial_type    ! 1: cubic spline   ;   2: Linear
1194      !
1195      INTEGER  ::   ji, jj, jk                 ! dummy loop indices
1196      INTEGER  ::   jpi, jpj, jpkm1
1197      REAL(wp) ::   zdf1, zdf2, zddf1, zddf2, ztmp1, ztmp2, zdxtmp
1198      REAL(wp) ::   zdxtmp1, zdxtmp2, zalpha
1199      REAL(wp) ::   zdf(size(fsp,3))
1200      !!----------------------------------------------------------------------
1201      !
1202!!gm  WHAT !!!!!   THIS IS VERY DANGEROUS !!!!! 
1203      jpi   = size(fsp,1)
1204      jpj   = size(fsp,2)
1205      jpkm1 = MAX( 1, size(fsp,3) - 1 )
1206      !
1207      IF (polynomial_type == 1) THEN     ! Constrained Cubic Spline
1208         DO ji = 1, jpi
1209            DO jj = 1, jpj
1210           !!Fritsch&Butland's method, 1984 (preferred, but more computation)
1211           !    DO jk = 2, jpkm1-1
1212           !       zdxtmp1 = xsp(ji,jj,jk)   - xsp(ji,jj,jk-1)
1213           !       zdxtmp2 = xsp(ji,jj,jk+1) - xsp(ji,jj,jk)
1214           !       zdf1    = ( fsp(ji,jj,jk)   - fsp(ji,jj,jk-1) ) / zdxtmp1
1215           !       zdf2    = ( fsp(ji,jj,jk+1) - fsp(ji,jj,jk)   ) / zdxtmp2
1216           !
1217           !       zalpha = ( zdxtmp1 + 2._wp * zdxtmp2 ) / ( zdxtmp1 + zdxtmp2 ) / 3._wp
1218           !
1219           !       IF(zdf1 * zdf2 <= 0._wp) THEN
1220           !           zdf(jk) = 0._wp
1221           !       ELSE
1222           !         zdf(jk) = zdf1 * zdf2 / ( ( 1._wp - zalpha ) * zdf1 + zalpha * zdf2 )
1223           !       ENDIF
1224           !    END DO
1225
1226           !!Simply geometric average
1227               DO jk = 2, jpkm1-1
1228                  zdf1 = (fsp(ji,jj,jk  ) - fsp(ji,jj,jk-1)) / (xsp(ji,jj,jk  ) - xsp(ji,jj,jk-1))
1229                  zdf2 = (fsp(ji,jj,jk+1) - fsp(ji,jj,jk  )) / (xsp(ji,jj,jk+1) - xsp(ji,jj,jk  ))
1230
1231                  IF(zdf1 * zdf2 <= 0._wp) THEN
1232                     zdf(jk) = 0._wp
1233                  ELSE
1234                     zdf(jk) = 2._wp * zdf1 * zdf2 / (zdf1 + zdf2)
1235                  ENDIF
1236               END DO
1237
1238               zdf(1)     = 1.5_wp * ( fsp(ji,jj,2) - fsp(ji,jj,1) ) / &
1239                          &          ( xsp(ji,jj,2) - xsp(ji,jj,1) )           -  0.5_wp * zdf(2)
1240               zdf(jpkm1) = 1.5_wp * ( fsp(ji,jj,jpkm1) - fsp(ji,jj,jpkm1-1) ) / &
1241                          &          ( xsp(ji,jj,jpkm1) - xsp(ji,jj,jpkm1-1) ) - 0.5_wp * zdf(jpkm1 - 1)
1242
1243               DO jk = 1, jpkm1 - 1
1244                 zdxtmp = xsp(ji,jj,jk+1) - xsp(ji,jj,jk)
1245                 ztmp1  = (zdf(jk+1) + 2._wp * zdf(jk)) / zdxtmp
1246                 ztmp2  =  6._wp * (fsp(ji,jj,jk+1) - fsp(ji,jj,jk)) / zdxtmp / zdxtmp
1247                 zddf1  = -2._wp * ztmp1 + ztmp2
1248                 ztmp1  = (2._wp * zdf(jk+1) + zdf(jk)) / zdxtmp
1249                 zddf2  =  2._wp * ztmp1 - ztmp2
1250
1251                 dsp(ji,jj,jk) = (zddf2 - zddf1) / 6._wp / zdxtmp
1252                 csp(ji,jj,jk) = ( xsp(ji,jj,jk+1) * zddf1 - xsp(ji,jj,jk)*zddf2 ) / 2._wp / zdxtmp
1253                 bsp(ji,jj,jk) = ( fsp(ji,jj,jk+1) - fsp(ji,jj,jk) ) / zdxtmp - &
1254                               & csp(ji,jj,jk) * ( xsp(ji,jj,jk+1) + xsp(ji,jj,jk) ) - &
1255                               & dsp(ji,jj,jk) * ((xsp(ji,jj,jk+1) + xsp(ji,jj,jk))**2 - &
1256                               &                   xsp(ji,jj,jk+1) * xsp(ji,jj,jk))
1257                 asp(ji,jj,jk) = fsp(ji,jj,jk) - xsp(ji,jj,jk) * (bsp(ji,jj,jk) + &
1258                               &                (xsp(ji,jj,jk) * (csp(ji,jj,jk) + &
1259                               &                 dsp(ji,jj,jk) * xsp(ji,jj,jk))))
1260               END DO
1261            END DO
1262         END DO
1263
1264      ELSEIF ( polynomial_type == 2 ) THEN     ! Linear
1265         DO ji = 1, jpi
1266            DO jj = 1, jpj
1267               DO jk = 1, jpkm1-1
1268                  zdxtmp =xsp(ji,jj,jk+1) - xsp(ji,jj,jk)
1269                  ztmp1 = fsp(ji,jj,jk+1) - fsp(ji,jj,jk)
1270
1271                  dsp(ji,jj,jk) = 0._wp
1272                  csp(ji,jj,jk) = 0._wp
1273                  bsp(ji,jj,jk) = ztmp1 / zdxtmp
1274                  asp(ji,jj,jk) = fsp(ji,jj,jk) - bsp(ji,jj,jk) * xsp(ji,jj,jk)
1275               END DO
1276            END DO
1277         END DO
1278         !
1279      ELSE
1280         CALL ctl_stop( 'invalid polynomial type in cspline' )
1281      ENDIF
1282      !
1283   END SUBROUTINE cspline
1284
1285
1286   FUNCTION interp1(x, xl, xr, fl, fr)  RESULT(f)
1287      !!----------------------------------------------------------------------
1288      !!                 ***  ROUTINE interp1  ***
1289      !!
1290      !! ** Purpose :   1-d linear interpolation
1291      !!
1292      !! ** Method  :   interpolation is straight forward
1293      !!                extrapolation is also permitted (no value limit)
1294      !!----------------------------------------------------------------------
1295      REAL(wp), INTENT(in) ::  x, xl, xr, fl, fr
1296      REAL(wp)             ::  f ! result of the interpolation (extrapolation)
1297      REAL(wp)             ::  zdeltx
1298      !!----------------------------------------------------------------------
1299      !
1300      zdeltx = xr - xl
1301      IF( abs(zdeltx) <= 10._wp * EPSILON(x) ) THEN
1302         f = 0.5_wp * (fl + fr)
1303      ELSE
1304         f = ( (x - xl ) * fr - ( x - xr ) * fl ) / zdeltx
1305      ENDIF
1306      !
1307   END FUNCTION interp1
1308
1309
1310   FUNCTION interp2( x, a, b, c, d )  RESULT(f)
1311      !!----------------------------------------------------------------------
1312      !!                 ***  ROUTINE interp1  ***
1313      !!
1314      !! ** Purpose :   1-d constrained cubic spline interpolation
1315      !!
1316      !! ** Method  :  cubic spline interpolation
1317      !!
1318      !!----------------------------------------------------------------------
1319      REAL(wp), INTENT(in) ::  x, a, b, c, d
1320      REAL(wp)             ::  f ! value from the interpolation
1321      !!----------------------------------------------------------------------
1322      !
1323      f = a + x* ( b + x * ( c + d * x ) )
1324      !
1325   END FUNCTION interp2
1326
1327
1328   FUNCTION interp3( x, a, b, c, d )  RESULT(f)
1329      !!----------------------------------------------------------------------
1330      !!                 ***  ROUTINE interp1  ***
1331      !!
1332      !! ** Purpose :   Calculate the first order of derivative of
1333      !!                a cubic spline function y=a+b*x+c*x^2+d*x^3
1334      !!
1335      !! ** Method  :   f=dy/dx=b+2*c*x+3*d*x^2
1336      !!
1337      !!----------------------------------------------------------------------
1338      REAL(wp), INTENT(in) ::  x, a, b, c, d
1339      REAL(wp)             ::  f ! value from the interpolation
1340      !!----------------------------------------------------------------------
1341      !
1342      f = b + x * ( 2._wp * c + 3._wp * d * x)
1343      !
1344   END FUNCTION interp3
1345
1346
1347   FUNCTION integ_spline( xl, xr, a, b, c, d )  RESULT(f)
1348      !!----------------------------------------------------------------------
1349      !!                 ***  ROUTINE interp1  ***
1350      !!
1351      !! ** Purpose :   1-d constrained cubic spline integration
1352      !!
1353      !! ** Method  :  integrate polynomial a+bx+cx^2+dx^3 from xl to xr
1354      !!
1355      !!----------------------------------------------------------------------
1356      REAL(wp), INTENT(in) ::  xl, xr, a, b, c, d
1357      REAL(wp)             ::  za1, za2, za3
1358      REAL(wp)             ::  f                   ! integration result
1359      !!----------------------------------------------------------------------
1360      !
1361      za1 = 0.5_wp * b
1362      za2 = c / 3.0_wp
1363      za3 = 0.25_wp * d
1364      !
1365      f  = xr * ( a + xr * ( za1 + xr * ( za2 + za3 * xr ) ) ) - &
1366         & xl * ( a + xl * ( za1 + xl * ( za2 + za3 * xl ) ) )
1367      !
1368   END FUNCTION integ_spline
1369
1370   !!======================================================================
1371END MODULE dynhpg
Note: See TracBrowser for help on using the repository browser.