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 branches/nemo_v3_3_beta/NEMOGCM/NEMO/OPA_SRC/DYN – NEMO

source: branches/nemo_v3_3_beta/NEMOGCM/NEMO/OPA_SRC/DYN/dynhpg.F90 @ 2287

Last change on this file since 2287 was 2287, checked in by smasson, 14 years ago

update licence of all NEMO files...
  • Property svn:keywords set to Id
File size: 52.1 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   !!----------------------------------------------------------------------
17
18   !!----------------------------------------------------------------------
19   !!   dyn_hpg      : update the momentum trend with the now horizontal
20   !!                  gradient of the hydrostatic pressure
21   !!   dyn_hpg_init : initialisation and control of options
22   !!       hpg_zco  : z-coordinate scheme
23   !!       hpg_zps  : z-coordinate plus partial steps (interpolation)
24   !!       hpg_sco  : s-coordinate (standard jacobian formulation)
25   !!       hpg_hel  : s-coordinate (helsinki modification)
26   !!       hpg_wdj  : s-coordinate (weighted density jacobian)
27   !!       hpg_djc  : s-coordinate (Density Jacobian with Cubic polynomial)
28   !!       hpg_rot  : s-coordinate (ROTated axes scheme)
29   !!----------------------------------------------------------------------
30   USE oce             ! ocean dynamics and tracers
31   USE dom_oce         ! ocean space and time domain
32   USE phycst          ! physical constants
33   USE in_out_manager  ! I/O manager
34   USE trdmod          ! ocean dynamics trends
35   USE trdmod_oce      ! ocean variables trends
36   USE prtctl          ! Print control
37   USE lbclnk          ! lateral boundary condition
38
39   IMPLICIT NONE
40   PRIVATE
41
42   PUBLIC   dyn_hpg        ! routine called by step module
43   PUBLIC   dyn_hpg_init   ! routine called by opa module
44
45   !                                              !!* Namelist namdyn_hpg : hydrostatic pressure gradient
46   LOGICAL , PUBLIC ::   ln_hpg_zco    = .TRUE.    !: z-coordinate - full steps
47   LOGICAL , PUBLIC ::   ln_hpg_zps    = .FALSE.   !: z-coordinate - partial steps (interpolation)
48   LOGICAL , PUBLIC ::   ln_hpg_sco    = .FALSE.   !: s-coordinate (standard jacobian formulation)
49   LOGICAL , PUBLIC ::   ln_hpg_hel    = .FALSE.   !: s-coordinate (helsinki modification)
50   LOGICAL , PUBLIC ::   ln_hpg_wdj    = .FALSE.   !: s-coordinate (weighted density jacobian)
51   LOGICAL , PUBLIC ::   ln_hpg_djc    = .FALSE.   !: s-coordinate (Density Jacobian with Cubic polynomial)
52   LOGICAL , PUBLIC ::   ln_hpg_rot    = .FALSE.   !: s-coordinate (ROTated axes scheme)
53   REAL(wp), PUBLIC ::   rn_gamma      = 0.e0      !: weighting coefficient
54   LOGICAL , PUBLIC ::   ln_dynhpg_imp = .FALSE.   !: semi-implicite hpg flag
55   INTEGER , PUBLIC ::   nn_dynhpg_rst = 0         !: add dynhpg implicit variables in restart ot not
56
57   INTEGER  ::   nhpg  =  0   ! = 0 to 6, type of pressure gradient scheme used ! (deduced from ln_hpg_... flags)
58
59   !! * Substitutions
60#  include "domzgr_substitute.h90"
61#  include "vectopt_loop_substitute.h90"
62   !!----------------------------------------------------------------------
63   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
64   !! $Id$
65   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
66   !!----------------------------------------------------------------------
67
68CONTAINS
69
70   SUBROUTINE dyn_hpg( kt )
71      !!---------------------------------------------------------------------
72      !!                  ***  ROUTINE dyn_hpg  ***
73      !!
74      !! ** Method  :   Call the hydrostatic pressure gradient routine
75      !!              using the scheme defined in the namelist
76      !!   
77      !! ** Action : - Update (ua,va) with the now hydrastatic pressure trend
78      !!             - Save the trend (l_trddyn=T)
79      !!----------------------------------------------------------------------
80      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
81      !!
82      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   ztrdu, ztrdv   ! 3D temporary workspace
83      !!----------------------------------------------------------------------
84   
85      IF( l_trddyn ) THEN                    ! Temporary saving of ua and va trends (l_trddyn)
86         ztrdu(:,:,:) = ua(:,:,:) 
87         ztrdv(:,:,:) = va(:,:,:) 
88      ENDIF     
89
90      SELECT CASE ( nhpg )      ! Hydrastatic pressure gradient computation
91      CASE (  0 )   ;   CALL hpg_zco    ( kt )      ! z-coordinate
92      CASE (  1 )   ;   CALL hpg_zps    ( kt )      ! z-coordinate plus partial steps (interpolation)
93      CASE (  2 )   ;   CALL hpg_sco    ( kt )      ! s-coordinate (standard jacobian formulation)
94      CASE (  3 )   ;   CALL hpg_hel    ( kt )      ! s-coordinate (helsinki modification)
95      CASE (  4 )   ;   CALL hpg_wdj    ( kt )      ! s-coordinate (weighted density jacobian)
96      CASE (  5 )   ;   CALL hpg_djc    ( kt )      ! s-coordinate (Density Jacobian with Cubic polynomial)
97      CASE (  6 )   ;   CALL hpg_rot    ( kt )      ! s-coordinate (ROTated axes scheme)
98      END SELECT
99
100      IF( l_trddyn ) THEN      ! save the hydrostatic pressure gradient trends for momentum trend diagnostics
101         ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
102         ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
103         CALL trd_mod( ztrdu, ztrdv, jpdyn_trd_hpg, 'DYN', kt )
104      ENDIF         
105      !
106      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' hpg  - Ua: ', mask1=umask,   &
107         &                       tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
108      !
109   END SUBROUTINE dyn_hpg
110
111
112   SUBROUTINE dyn_hpg_init
113      !!----------------------------------------------------------------------
114      !!                 ***  ROUTINE dyn_hpg_init  ***
115      !!
116      !! ** Purpose :   initializations for the hydrostatic pressure gradient
117      !!              computation and consistency control
118      !!
119      !! ** Action  :   Read the namelist namdyn_hpg and check the consistency
120      !!      with the type of vertical coordinate used (zco, zps, sco)
121      !!----------------------------------------------------------------------
122      INTEGER ::   ioptio = 0      ! temporary integer
123      !!
124      NAMELIST/namdyn_hpg/ ln_hpg_zco   , ln_hpg_zps   , ln_hpg_sco, ln_hpg_hel,   &
125         &                 ln_hpg_wdj   , ln_hpg_djc   , ln_hpg_rot, rn_gamma  ,   &
126         &                 ln_dynhpg_imp, nn_dynhpg_rst
127      !!----------------------------------------------------------------------
128      !
129      REWIND( numnam )               ! Read Namelist namdyn_hpg
130      READ  ( numnam, namdyn_hpg )
131      !
132      IF(lwp) THEN                   ! Control print
133         WRITE(numout,*)
134         WRITE(numout,*) 'dyn_hpg_init : hydrostatic pressure gradient initialisation'
135         WRITE(numout,*) '~~~~~~~~~~~~'
136         WRITE(numout,*) '   Namelist namdyn_hpg : choice of hpg scheme'
137         WRITE(numout,*) '      z-coord. - full steps                             ln_hpg_zco    = ', ln_hpg_zco
138         WRITE(numout,*) '      z-coord. - partial steps (interpolation)          ln_hpg_zps    = ', ln_hpg_zps
139         WRITE(numout,*) '      s-coord. (standard jacobian formulation)          ln_hpg_sco    = ', ln_hpg_sco
140         WRITE(numout,*) '      s-coord. (helsinki modification)                  ln_hpg_hel    = ', ln_hpg_hel
141         WRITE(numout,*) '      s-coord. (weighted density jacobian)              ln_hpg_wdj    = ', ln_hpg_wdj
142         WRITE(numout,*) '      s-coord. (Density Jacobian: Cubic polynomial)     ln_hpg_djc    = ', ln_hpg_djc
143         WRITE(numout,*) '      s-coord. (ROTated axes scheme)                    ln_hpg_rot    = ', ln_hpg_rot
144         WRITE(numout,*) '      weighting coeff. (wdj scheme)                     rn_gamma      = ', rn_gamma
145         WRITE(numout,*) '      time stepping: centered (F) or semi-implicit (T)  ln_dynhpg_imp = ', ln_dynhpg_imp
146         WRITE(numout,*) '      add in restart dynhpg semi-implicit variable      nn_dynhpg_rst = ', nn_dynhpg_rst
147      ENDIF
148      !
149      IF( .NOT. ln_dynhpg_imp )   nn_dynhpg_rst = 0      ! force no additional dynhpg implicit variables in restart file
150      !
151      IF( lk_vvl .AND. .NOT. ln_hpg_sco )   &
152         &   CALL ctl_stop( 'dyn_hpg_init : variable volume key_vvl require the standard jacobian formulation hpg_sco')
153      !
154      !                               ! Set nhpg from ln_hpg_... flags
155      IF( ln_hpg_zco )   nhpg = 0
156      IF( ln_hpg_zps )   nhpg = 1
157      IF( ln_hpg_sco )   nhpg = 2
158      IF( ln_hpg_hel )   nhpg = 3
159      IF( ln_hpg_wdj )   nhpg = 4
160      IF( ln_hpg_djc )   nhpg = 5
161      IF( ln_hpg_rot )   nhpg = 6
162      !
163      !                               ! Consitency check
164      ioptio = 0 
165      IF( ln_hpg_zco )   ioptio = ioptio + 1
166      IF( ln_hpg_zps )   ioptio = ioptio + 1
167      IF( ln_hpg_sco )   ioptio = ioptio + 1
168      IF( ln_hpg_hel )   ioptio = ioptio + 1
169      IF( ln_hpg_wdj )   ioptio = ioptio + 1
170      IF( ln_hpg_djc )   ioptio = ioptio + 1
171      IF( ln_hpg_rot )   ioptio = ioptio + 1
172      IF ( ioptio /= 1 )   CALL ctl_stop( ' NO or several hydrostatic pressure gradient options used' )
173      !
174   END SUBROUTINE dyn_hpg_init
175
176
177   SUBROUTINE hpg_zco( kt )
178      !!---------------------------------------------------------------------
179      !!                  ***  ROUTINE hpg_zco  ***
180      !!
181      !! ** Method  :   z-coordinate case, levels are horizontal surfaces.
182      !!      The now hydrostatic pressure gradient at a given level, jk,
183      !!      is computed by taking the vertical integral of the in-situ
184      !!      density gradient along the model level from the suface to that
185      !!      level:    zhpi = grav .....
186      !!                zhpj = grav .....
187      !!      add it to the general momentum trend (ua,va).
188      !!            ua = ua - 1/e1u * zhpi
189      !!            va = va - 1/e2v * zhpj
190      !!
191      !! ** Action : - Update (ua,va) with the now hydrastatic pressure trend
192      !!----------------------------------------------------------------------
193      USE oce, ONLY :   zhpi => ta   ! use ta as 3D workspace
194      USE oce, ONLY :   zhpj => sa   ! use sa as 3D workspace
195      !!
196      INTEGER, INTENT(in) ::   kt    ! ocean time-step index
197      !!
198      INTEGER  ::   ji, jj, jk       ! dummy loop indices
199      REAL(wp) ::   zcoef0, zcoef1   ! temporary scalars
200      !!----------------------------------------------------------------------
201     
202      IF( kt == nit000 ) THEN
203         IF(lwp) WRITE(numout,*)
204         IF(lwp) WRITE(numout,*) 'dyn:hpg_zco : hydrostatic pressure gradient trend'
205         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   z-coordinate case '
206      ENDIF
207     
208      ! Local constant initialization
209      zcoef0 = - grav * 0.5
210
211      ! Surface value
212      DO jj = 2, jpjm1
213         DO ji = fs_2, fs_jpim1   ! vector opt.
214            zcoef1 = zcoef0 * fse3w(ji,jj,1)
215            ! hydrostatic pressure gradient
216            zhpi(ji,jj,1) = zcoef1 * ( rhd(ji+1,jj,1) - rhd(ji,jj,1) ) / e1u(ji,jj)
217            zhpj(ji,jj,1) = zcoef1 * ( rhd(ji,jj+1,1) - rhd(ji,jj,1) ) / e2v(ji,jj)
218            ! add to the general momentum trend
219            ua(ji,jj,1) = ua(ji,jj,1) + zhpi(ji,jj,1)
220            va(ji,jj,1) = va(ji,jj,1) + zhpj(ji,jj,1)
221         END DO
222      END DO
223      !
224      ! interior value (2=<jk=<jpkm1)
225      DO jk = 2, jpkm1
226         DO jj = 2, jpjm1
227            DO ji = fs_2, fs_jpim1   ! vector opt.
228               zcoef1 = zcoef0 * fse3w(ji,jj,jk)
229               ! hydrostatic pressure gradient
230               zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1)   &
231                  &           + zcoef1 * (  ( rhd(ji+1,jj,jk)+rhd(ji+1,jj,jk-1) )   &
232                  &                       - ( rhd(ji  ,jj,jk)+rhd(ji  ,jj,jk-1) )  ) / e1u(ji,jj)
233
234               zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1)   &
235                  &           + zcoef1 * (  ( rhd(ji,jj+1,jk)+rhd(ji,jj+1,jk-1) )   &
236                  &                       - ( rhd(ji,jj,  jk)+rhd(ji,jj  ,jk-1) )  ) / e2v(ji,jj)
237               ! add to the general momentum trend
238               ua(ji,jj,jk) = ua(ji,jj,jk) + zhpi(ji,jj,jk)
239               va(ji,jj,jk) = va(ji,jj,jk) + zhpj(ji,jj,jk)
240            END DO
241         END DO
242      END DO
243      !
244   END SUBROUTINE hpg_zco
245
246
247   SUBROUTINE hpg_zps( kt )
248      !!---------------------------------------------------------------------
249      !!                 ***  ROUTINE hpg_zps  ***
250      !!                   
251      !! ** Method  :   z-coordinate plus partial steps case.  blahblah...
252      !!
253      !! ** Action  : - Update (ua,va) with the now hydrastatic pressure trend
254      !!----------------------------------------------------------------------
255      USE oce, ONLY :   zhpi => ta   ! use ta as 3D workspace
256      USE oce, ONLY :   zhpj => sa   ! use sa as 3D workspace
257      !!
258      INTEGER, INTENT(in) ::   kt    ! ocean time-step index
259      !!
260      INTEGER  ::   ji, jj, jk                       ! dummy loop indices
261      INTEGER  ::   iku, ikv                         ! temporary integers
262      REAL(wp) ::   zcoef0, zcoef1, zcoef2, zcoef3   ! temporary scalars
263      !!----------------------------------------------------------------------
264
265      IF( kt == nit000 ) THEN
266         IF(lwp) WRITE(numout,*)
267         IF(lwp) WRITE(numout,*) 'dyn:hpg_zps : hydrostatic pressure gradient trend'
268         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   z-coordinate with partial steps - vector optimization'
269      ENDIF
270
271      ! Local constant initialization
272      zcoef0 = - grav * 0.5
273
274      !  Surface value
275      DO jj = 2, jpjm1
276         DO ji = fs_2, fs_jpim1   ! vector opt.
277            zcoef1 = zcoef0 * fse3w(ji,jj,1)
278            ! hydrostatic pressure gradient
279            zhpi(ji,jj,1) = zcoef1 * ( rhd(ji+1,jj  ,1) - rhd(ji,jj,1) ) / e1u(ji,jj)
280            zhpj(ji,jj,1) = zcoef1 * ( rhd(ji  ,jj+1,1) - rhd(ji,jj,1) ) / e2v(ji,jj)
281            ! add to the general momentum trend
282            ua(ji,jj,1) = ua(ji,jj,1) + zhpi(ji,jj,1)
283            va(ji,jj,1) = va(ji,jj,1) + zhpj(ji,jj,1)
284         END DO
285      END DO
286
287      ! interior value (2=<jk=<jpkm1)
288      DO jk = 2, jpkm1
289         DO jj = 2, jpjm1
290            DO ji = fs_2, fs_jpim1   ! vector opt.
291               zcoef1 = zcoef0 * fse3w(ji,jj,jk)
292               ! hydrostatic pressure gradient
293               zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1)   &
294                  &           + zcoef1 * (  ( rhd(ji+1,jj,jk) + rhd(ji+1,jj,jk-1) )   &
295                  &                       - ( rhd(ji  ,jj,jk) + rhd(ji  ,jj,jk-1) )  ) / e1u(ji,jj)
296
297               zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1)   &
298                  &           + zcoef1 * (  ( rhd(ji,jj+1,jk) + rhd(ji,jj+1,jk-1) )   &
299                  &                       - ( rhd(ji,jj,  jk) + rhd(ji,jj  ,jk-1) )  ) / e2v(ji,jj)
300               ! add to the general momentum trend
301               ua(ji,jj,jk) = ua(ji,jj,jk) + zhpi(ji,jj,jk)
302               va(ji,jj,jk) = va(ji,jj,jk) + zhpj(ji,jj,jk)
303            END DO
304         END DO
305      END DO
306
307      ! partial steps correction at the last level  (new gradient with  intgrd.F)
308# if defined key_vectopt_loop
309         jj = 1
310         DO ji = jpi+2, jpij-jpi-1   ! vector opt. (forced unrolling)
311# else
312      DO jj = 2, jpjm1
313         DO ji = 2, jpim1
314# endif
315            iku = MIN ( mbathy(ji,jj), mbathy(ji+1,jj) ) - 1
316            ikv = MIN ( mbathy(ji,jj), mbathy(ji,jj+1) ) - 1
317            zcoef2 = zcoef0 * MIN( fse3w(ji,jj,iku), fse3w(ji+1,jj  ,iku) )
318            zcoef3 = zcoef0 * MIN( fse3w(ji,jj,ikv), fse3w(ji  ,jj+1,ikv) )
319            ! on i-direction
320            IF ( iku > 2 ) THEN
321               ! subtract old value
322               ua(ji,jj,iku) = ua(ji,jj,iku) - zhpi(ji,jj,iku)
323               ! compute the new one
324               zhpi (ji,jj,iku) = zhpi(ji,jj,iku-1)   &
325                  + zcoef2 * ( rhd(ji+1,jj,iku-1) - rhd(ji,jj,iku-1) + gru(ji,jj) ) / e1u(ji,jj)
326               ! add the new one to the general momentum trend
327               ua(ji,jj,iku) = ua(ji,jj,iku) + zhpi(ji,jj,iku)
328            ENDIF
329            ! on j-direction
330            IF ( ikv > 2 ) THEN
331               ! subtract old value
332               va(ji,jj,ikv) = va(ji,jj,ikv) - zhpj(ji,jj,ikv)
333               ! compute the new one
334               zhpj (ji,jj,ikv) = zhpj(ji,jj,ikv-1)   &
335                  + zcoef3 * ( rhd(ji,jj+1,ikv-1) - rhd(ji,jj,ikv-1) + grv(ji,jj) ) / e2v(ji,jj)
336               ! add the new one to the general momentum trend
337               va(ji,jj,ikv) = va(ji,jj,ikv) + zhpj(ji,jj,ikv)
338            ENDIF
339# if ! defined key_vectopt_loop
340         END DO
341# endif
342      END DO
343      !
344   END SUBROUTINE hpg_zps
345
346
347   SUBROUTINE hpg_sco( kt )
348      !!---------------------------------------------------------------------
349      !!                  ***  ROUTINE hpg_sco  ***
350      !!
351      !! ** Method  :   s-coordinate case. Jacobian scheme.
352      !!      The now hydrostatic pressure gradient at a given level, jk,
353      !!      is computed by taking the vertical integral of the in-situ
354      !!      density gradient along the model level from the suface to that
355      !!      level. s-coordinates (ln_sco): a corrective term is added
356      !!      to the horizontal pressure gradient :
357      !!         zhpi = grav .....  + 1/e1u mi(rhd) di[ grav dep3w ]
358      !!         zhpj = grav .....  + 1/e2v mj(rhd) dj[ grav dep3w ]
359      !!      add it to the general momentum trend (ua,va).
360      !!         ua = ua - 1/e1u * zhpi
361      !!         va = va - 1/e2v * zhpj
362      !!
363      !! ** Action : - Update (ua,va) with the now hydrastatic pressure trend
364      !!----------------------------------------------------------------------
365      USE oce, ONLY :   zhpi => ta   ! use ta as 3D workspace
366      USE oce, ONLY :   zhpj => sa   ! use sa as 3D workspace
367      !!
368      INTEGER, INTENT(in) ::   kt    ! ocean time-step index
369      !!
370      INTEGER  ::   ji, jj, jk                 ! dummy loop indices
371      REAL(wp) ::   zcoef0, zuap, zvap, znad   ! temporary scalars
372      !!----------------------------------------------------------------------
373
374      IF( kt == nit000 ) THEN
375         IF(lwp) WRITE(numout,*)
376         IF(lwp) WRITE(numout,*) 'dyn:hpg_sco : hydrostatic pressure gradient trend'
377         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   s-coordinate case, OPA original scheme used'
378      ENDIF
379
380      ! Local constant initialization
381      zcoef0 = - grav * 0.5
382      ! To use density and not density anomaly
383      IF ( lk_vvl ) THEN   ;     znad = 1.            ! Variable volume
384      ELSE                 ;     znad = 0.e0          ! Fixed volume
385      ENDIF
386
387      ! Surface value
388      DO jj = 2, jpjm1
389         DO ji = fs_2, fs_jpim1   ! vector opt.   
390            ! hydrostatic pressure gradient along s-surfaces
391            zhpi(ji,jj,1) = zcoef0 / e1u(ji,jj) * ( fse3w(ji+1,jj  ,1) * ( znad + rhd(ji+1,jj  ,1) )   &
392               &                                  - fse3w(ji  ,jj  ,1) * ( znad + rhd(ji  ,jj  ,1) ) )
393            zhpj(ji,jj,1) = zcoef0 / e2v(ji,jj) * ( fse3w(ji  ,jj+1,1) * ( znad + rhd(ji  ,jj+1,1) )   &
394               &                                  - fse3w(ji  ,jj  ,1) * ( znad + rhd(ji  ,jj  ,1) ) )
395            ! s-coordinate pressure gradient correction
396            zuap = -zcoef0 * ( rhd   (ji+1,jj,1) + rhd   (ji,jj,1) + 2*znad )   &
397               &           * ( fsde3w(ji+1,jj,1) - fsde3w(ji,jj,1) ) / e1u(ji,jj)
398            zvap = -zcoef0 * ( rhd   (ji,jj+1,1) + rhd   (ji,jj,1) + 2*znad )   &
399               &           * ( fsde3w(ji,jj+1,1) - fsde3w(ji,jj,1) ) / e2v(ji,jj)
400            ! add to the general momentum trend
401            ua(ji,jj,1) = ua(ji,jj,1) + zhpi(ji,jj,1) + zuap
402            va(ji,jj,1) = va(ji,jj,1) + zhpj(ji,jj,1) + zvap
403         END DO 
404      END DO   
405           
406      ! interior value (2=<jk=<jpkm1)
407      DO jk = 2, jpkm1                                 
408         DO jj = 2, jpjm1     
409            DO ji = fs_2, fs_jpim1   ! vector opt.     
410               ! hydrostatic pressure gradient along s-surfaces
411               zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1) + zcoef0 / e1u(ji,jj)   & 
412                  &           * (  fse3w(ji+1,jj,jk) * ( rhd(ji+1,jj,jk) + rhd(ji+1,jj,jk-1) + 2*znad )   & 
413                  &              - fse3w(ji  ,jj,jk) * ( rhd(ji  ,jj,jk) + rhd(ji  ,jj,jk-1) + 2*znad )  )
414               zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1) + zcoef0 / e2v(ji,jj)   &
415                  &           * (  fse3w(ji,jj+1,jk) * ( rhd(ji,jj+1,jk) + rhd(ji,jj+1,jk-1) + 2*znad )   &
416                  &              - fse3w(ji,jj  ,jk) * ( rhd(ji,jj,  jk) + rhd(ji,jj  ,jk-1) + 2*znad )  )
417               ! s-coordinate pressure gradient correction
418               zuap = -zcoef0 * ( rhd   (ji+1,jj  ,jk) + rhd   (ji,jj,jk) + 2*znad )   &
419                  &           * ( fsde3w(ji+1,jj  ,jk) - fsde3w(ji,jj,jk) ) / e1u(ji,jj)
420               zvap = -zcoef0 * ( rhd   (ji  ,jj+1,jk) + rhd   (ji,jj,jk) + 2*znad )   &
421                  &           * ( fsde3w(ji  ,jj+1,jk) - fsde3w(ji,jj,jk) ) / e2v(ji,jj)
422               ! add to the general momentum trend
423               ua(ji,jj,jk) = ua(ji,jj,jk) + zhpi(ji,jj,jk) + zuap
424               va(ji,jj,jk) = va(ji,jj,jk) + zhpj(ji,jj,jk) + zvap
425            END DO
426         END DO
427      END DO
428      !
429   END SUBROUTINE hpg_sco
430
431
432   SUBROUTINE hpg_hel( kt )
433      !!---------------------------------------------------------------------
434      !!                  ***  ROUTINE hpg_hel  ***
435      !!
436      !! ** Method  :   s-coordinate case.
437      !!      The now hydrostatic pressure gradient at a given level
438      !!      jk is computed by taking the vertical integral of the in-situ
439      !!      density gradient along the model level from the suface to that
440      !!      level. s-coordinates (ln_sco): a corrective term is added
441      !!      to the horizontal pressure gradient :
442      !!         zhpi = grav .....  + 1/e1u mi(rhd) di[ grav dep3w ]
443      !!         zhpj = grav .....  + 1/e2v mj(rhd) dj[ grav dep3w ]
444      !!      add it to the general momentum trend (ua,va).
445      !!         ua = ua - 1/e1u * zhpi
446      !!         va = va - 1/e2v * zhpj
447      !!
448      !! ** Action : - Update (ua,va) with the now hydrastatic pressure trend
449      !!             - Save the trend (l_trddyn=T)
450      !!----------------------------------------------------------------------
451      USE oce, ONLY :   zhpi => ta   ! use ta as 3D workspace
452      USE oce, ONLY :   zhpj => sa   ! use sa as 3D workspace
453      !!
454      INTEGER, INTENT(in) ::   kt    ! ocean time-step index
455      !!
456      INTEGER  ::   ji, jj, jk           ! dummy loop indices
457      REAL(wp) ::   zcoef0, zuap, zvap   ! temporary scalars
458      !!----------------------------------------------------------------------
459
460      IF( kt == nit000 ) THEN
461         IF(lwp) WRITE(numout,*)
462         IF(lwp) WRITE(numout,*) 'dyn:hpg_hel : hydrostatic pressure gradient trend'
463         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   s-coordinate case, helsinki modified scheme'
464      ENDIF
465
466      ! Local constant initialization
467      zcoef0 = - grav * 0.5
468 
469      ! Surface value
470      DO jj = 2, jpjm1
471         DO ji = fs_2, fs_jpim1   ! vector opt.
472            ! hydrostatic pressure gradient along s-surfaces
473            zhpi(ji,jj,1) = zcoef0 / e1u(ji,jj) * ( fse3t(ji+1,jj  ,1) * rhd(ji+1,jj  ,1)  &
474               &                                  - fse3t(ji  ,jj  ,1) * rhd(ji  ,jj  ,1) )
475            zhpj(ji,jj,1) = zcoef0 / e2v(ji,jj) * ( fse3t(ji  ,jj+1,1) * rhd(ji  ,jj+1,1)  &
476               &                                  - fse3t(ji  ,jj  ,1) * rhd(ji  ,jj  ,1) )
477            ! s-coordinate pressure gradient correction
478            zuap = -zcoef0 * ( rhd   (ji+1,jj,1) + rhd   (ji,jj,1) )   &
479               &           * ( fsdept(ji+1,jj,1) - fsdept(ji,jj,1) ) / e1u(ji,jj)
480            zvap = -zcoef0 * ( rhd   (ji,jj+1,1) + rhd   (ji,jj,1) )   &
481               &           * ( fsdept(ji,jj+1,1) - fsdept(ji,jj,1) ) / e2v(ji,jj)
482            ! add to the general momentum trend
483            ua(ji,jj,1) = ua(ji,jj,1) + zhpi(ji,jj,1) + zuap
484            va(ji,jj,1) = va(ji,jj,1) + zhpj(ji,jj,1) + zvap
485         END DO
486      END DO
487      !
488      ! interior value (2=<jk=<jpkm1)
489      DO jk = 2, jpkm1
490         DO jj = 2, jpjm1
491            DO ji = fs_2, fs_jpim1   ! vector opt.
492               ! hydrostatic pressure gradient along s-surfaces
493               zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1) &
494                  &           +  zcoef0 / e1u(ji,jj) * ( fse3t(ji+1,jj,jk  ) * rhd(ji+1,jj,jk)     &
495                  &                                     -fse3t(ji  ,jj,jk  ) * rhd(ji  ,jj,jk)   ) &
496                  &           +  zcoef0 / e1u(ji,jj) * ( fse3t(ji+1,jj,jk-1) * rhd(ji+1,jj,jk-1)   &
497                  &                                     -fse3t(ji  ,jj,jk-1) * rhd(ji  ,jj,jk-1) )
498               zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1) &
499                  &           +  zcoef0 / e2v(ji,jj) * ( fse3t(ji,jj+1,jk  ) * rhd(ji,jj+1,jk)   &
500                  &                                     -fse3t(ji,jj  ,jk  ) * rhd(ji,jj,  jk)   ) &
501                  &           +  zcoef0 / e2v(ji,jj) * ( fse3t(ji,jj+1,jk-1) * rhd(ji,jj+1,jk-1) &
502                  &                                     -fse3t(ji,jj  ,jk-1) * rhd(ji,jj,  jk-1) )
503               ! s-coordinate pressure gradient correction
504               zuap = - zcoef0 * ( rhd   (ji+1,jj,jk) + rhd   (ji,jj,jk) )   &
505                  &            * ( fsdept(ji+1,jj,jk) - fsdept(ji,jj,jk) ) / e1u(ji,jj)
506               zvap = - zcoef0 * ( rhd   (ji,jj+1,jk) + rhd   (ji,jj,jk) )   &
507                  &            * ( fsdept(ji,jj+1,jk) - fsdept(ji,jj,jk) ) / e2v(ji,jj)
508               ! add to the general momentum trend
509               ua(ji,jj,jk) = ua(ji,jj,jk) + zhpi(ji,jj,jk) + zuap
510               va(ji,jj,jk) = va(ji,jj,jk) + zhpj(ji,jj,jk) + zvap
511            END DO
512         END DO
513      END DO
514      !
515   END SUBROUTINE hpg_hel
516
517
518   SUBROUTINE hpg_wdj( kt )
519      !!---------------------------------------------------------------------
520      !!                  ***  ROUTINE hpg_wdj  ***
521      !!
522      !! ** Method  :   Weighted Density Jacobian (wdj) scheme (song 1998)
523      !!      The weighting coefficients from the namelist parameter rn_gamma
524      !!      (alpha=0.5-rn_gamma ; beta=1-alpha=0.5+rn_gamma
525      !!
526      !! Reference : Song, Mon. Wea. Rev., 126, 3213-3230, 1998.
527      !!----------------------------------------------------------------------
528      USE oce, ONLY :   zhpi => ta   ! use ta as 3D workspace
529      USE oce, ONLY :   zhpj => sa   ! use sa as 3D workspace
530      !!
531      INTEGER, INTENT(in) ::   kt    ! ocean time-step index
532      !!
533      INTEGER  ::   ji, jj, jk           ! dummy loop indices
534      REAL(wp) ::   zcoef0, zuap, zvap   ! temporary scalars
535      REAL(wp) ::   zalph , zbeta        !    "         "
536      !!----------------------------------------------------------------------
537
538      IF( kt == nit000 ) THEN
539         IF(lwp) WRITE(numout,*)
540         IF(lwp) WRITE(numout,*) 'dyn:hpg_wdj : hydrostatic pressure gradient trend'
541         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   Weighted Density Jacobian'
542      ENDIF
543
544      ! Local constant initialization
545      zcoef0 = - grav * 0.5
546      zalph  = 0.5 - rn_gamma    ! weighting coefficients (alpha=0.5-rn_gamma
547      zbeta  = 0.5 + rn_gamma    !                        (beta =1-alpha=0.5+rn_gamma
548
549      ! Surface value (no ponderation)
550      DO jj = 2, jpjm1
551         DO ji = fs_2, fs_jpim1   ! vector opt.
552            ! hydrostatic pressure gradient along s-surfaces
553            zhpi(ji,jj,1) = zcoef0 / e1u(ji,jj) * (  fse3w(ji+1,jj  ,1) * rhd(ji+1,jj  ,1)   &
554               &                                   - fse3w(ji  ,jj  ,1) * rhd(ji  ,jj  ,1)  )
555            zhpj(ji,jj,1) = zcoef0 / e2v(ji,jj) * (  fse3w(ji  ,jj+1,1) * rhd(ji  ,jj+1,1)   &
556               &                                   - fse3w(ji  ,jj  ,1) * rhd(ji,  jj  ,1)  )
557            ! s-coordinate pressure gradient correction
558            zuap = -zcoef0 * ( rhd   (ji+1,jj,1) + rhd   (ji,jj,1) )   &
559               &           * ( fsde3w(ji+1,jj,1) - fsde3w(ji,jj,1) ) / e1u(ji,jj)
560            zvap = -zcoef0 * ( rhd   (ji,jj+1,1) + rhd   (ji,jj,1) )   &
561               &           * ( fsde3w(ji,jj+1,1) - fsde3w(ji,jj,1) ) / e2v(ji,jj)
562            ! add to the general momentum trend
563            ua(ji,jj,1) = ua(ji,jj,1) + zhpi(ji,jj,1) + zuap
564            va(ji,jj,1) = va(ji,jj,1) + zhpj(ji,jj,1) + zvap
565         END DO
566      END DO
567
568      ! Interior value (2=<jk=<jpkm1) (weighted with zalph & zbeta)
569      DO jk = 2, jpkm1
570         DO jj = 2, jpjm1
571            DO ji = fs_2, fs_jpim1   ! vector opt.
572               zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1) + zcoef0 / e1u(ji,jj)                            &
573                  &           * (   (            fsde3w(ji+1,jj,jk  ) + fsde3w(ji,jj,jk  )        &
574                  &                            - fsde3w(ji+1,jj,jk-1) - fsde3w(ji,jj,jk-1)    )   &
575                  &               * (  zalph * ( rhd   (ji+1,jj,jk-1) - rhd   (ji,jj,jk-1) )      &
576                  &                  + zbeta * ( rhd   (ji+1,jj,jk  ) - rhd   (ji,jj,jk  ) )  )   &
577                  &             -   (            rhd   (ji+1,jj,jk  ) + rhd   (ji,jj,jk  )        &
578                  &                           - rhd   (ji+1,jj,jk-1) - rhd   (ji,jj,jk-1)     )   &
579                  &               * (  zalph * ( fsde3w(ji+1,jj,jk-1) - fsde3w(ji,jj,jk-1) )      &
580                  &                  + zbeta * ( fsde3w(ji+1,jj,jk  ) - fsde3w(ji,jj,jk  ) )  )  )
581               zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1) + zcoef0 / e2v(ji,jj)                            &
582                  &           * (   (           fsde3w(ji,jj+1,jk  ) + fsde3w(ji,jj,jk  )         &
583                  &                           - fsde3w(ji,jj+1,jk-1) - fsde3w(ji,jj,jk-1)     )   &
584                  &               * (  zalph * ( rhd   (ji,jj+1,jk-1) - rhd   (ji,jj,jk-1) )      &
585                  &                  + zbeta * ( rhd   (ji,jj+1,jk  ) - rhd   (ji,jj,jk  ) )  )   &
586                  &             -   (            rhd   (ji,jj+1,jk  ) + rhd   (ji,jj,jk  )        &
587                  &                            - rhd   (ji,jj+1,jk-1) - rhd   (ji,jj,jk-1)    )   &
588                  &               * (  zalph * ( fsde3w(ji,jj+1,jk-1) - fsde3w(ji,jj,jk-1) )      &
589                  &                  + zbeta * ( fsde3w(ji,jj+1,jk  ) - fsde3w(ji,jj,jk  ) )  )  )
590               ! add to the general momentum trend
591               ua(ji,jj,jk) = ua(ji,jj,jk) + zhpi(ji,jj,jk)
592               va(ji,jj,jk) = va(ji,jj,jk) + zhpj(ji,jj,jk)
593            END DO
594         END DO
595      END DO
596      !
597   END SUBROUTINE hpg_wdj
598
599
600   SUBROUTINE hpg_djc( kt )
601      !!---------------------------------------------------------------------
602      !!                  ***  ROUTINE hpg_djc  ***
603      !!
604      !! ** Method  :   Density Jacobian with Cubic polynomial scheme
605      !!
606      !! Reference: Shchepetkin and McWilliams, J. Geophys. Res., 108(C3), 3090, 2003
607      !!----------------------------------------------------------------------
608      USE oce, ONLY :   zhpi => ta   ! use ta as 3D workspace
609      USE oce, ONLY :   zhpj => sa   ! use sa as 3D workspace
610      !!
611      INTEGER, INTENT(in) ::   kt    ! ocean time-step index
612      !!
613      INTEGER  ::   ji, jj, jk          ! dummy loop indices
614      REAL(wp) ::   zcoef0, zep, cffw   ! temporary scalars
615      REAL(wp) ::   z1_10, cffu, cffx   !    "         "
616      REAL(wp) ::   z1_12, cffv, cffy   !    "         "
617      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   drhox, dzx, drhou, dzu, rho_i   ! 3D workspace
618      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   drhoy, dzy, drhov, dzv, rho_j   !  "      "
619      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   drhoz, dzz, drhow, dzw, rho_k   !  "      "
620      !!----------------------------------------------------------------------
621
622      IF( kt == nit000 ) THEN
623         IF(lwp) WRITE(numout,*)
624         IF(lwp) WRITE(numout,*) 'dyn:hpg_djc : hydrostatic pressure gradient trend'
625         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   s-coordinate case, density Jacobian with cubic polynomial scheme'
626      ENDIF
627
628
629      ! Local constant initialization
630      zcoef0 = - grav * 0.5
631      z1_10  = 1.0 / 10.0
632      z1_12  = 1.0 / 12.0
633
634      !----------------------------------------------------------------------------------------
635      !  compute and store in provisional arrays elementary vertical and horizontal differences
636      !----------------------------------------------------------------------------------------
637
638!!bug gm   Not a true bug, but... dzz=e3w  for dzx, dzy verify what it is really
639
640      DO jk = 2, jpkm1
641         DO jj = 2, jpjm1
642            DO ji = fs_2, fs_jpim1   ! vector opt.
643               drhoz(ji,jj,jk) = rhd   (ji  ,jj  ,jk) - rhd   (ji,jj,jk-1)
644               dzz  (ji,jj,jk) = fsde3w(ji  ,jj  ,jk) - fsde3w(ji,jj,jk-1)
645               drhox(ji,jj,jk) = rhd   (ji+1,jj  ,jk) - rhd   (ji,jj,jk  )
646               dzx  (ji,jj,jk) = fsde3w(ji+1,jj  ,jk) - fsde3w(ji,jj,jk  )
647               drhoy(ji,jj,jk) = rhd   (ji  ,jj+1,jk) - rhd   (ji,jj,jk  )
648               dzy  (ji,jj,jk) = fsde3w(ji  ,jj+1,jk) - fsde3w(ji,jj,jk  )
649            END DO
650         END DO
651      END DO
652
653      !-------------------------------------------------------------------------
654      ! compute harmonic averages using eq. 5.18
655      !-------------------------------------------------------------------------
656      zep = 1.e-15
657
658!!bug  gm  drhoz not defined at level 1 and used (jk-1 with jk=2)
659!!bug  gm  idem for drhox, drhoy et ji=jpi and jj=jpj
660
661      DO jk = 2, jpkm1
662         DO jj = 2, jpjm1
663            DO ji = fs_2, fs_jpim1   ! vector opt.
664               cffw = 2.0 * drhoz(ji  ,jj  ,jk) * drhoz(ji,jj,jk-1)
665
666               cffu = 2.0 * drhox(ji+1,jj  ,jk) * drhox(ji,jj,jk  )
667               cffx = 2.0 * dzx  (ji+1,jj  ,jk) * dzx  (ji,jj,jk  )
668 
669               cffv = 2.0 * drhoy(ji  ,jj+1,jk) * drhoy(ji,jj,jk  )
670               cffy = 2.0 * dzy  (ji  ,jj+1,jk) * dzy  (ji,jj,jk  )
671
672               IF( cffw > zep) THEN
673                  drhow(ji,jj,jk) = 2.0 *   drhoz(ji,jj,jk) * drhoz(ji,jj,jk-1)   &
674                     &                  / ( drhoz(ji,jj,jk) + drhoz(ji,jj,jk-1) )
675               ELSE
676                  drhow(ji,jj,jk) = 0.e0
677               ENDIF
678
679               dzw(ji,jj,jk) = 2.0 *   dzz(ji,jj,jk) * dzz(ji,jj,jk-1)   &
680                  &                / ( dzz(ji,jj,jk) + dzz(ji,jj,jk-1) )
681
682               IF( cffu > zep ) THEN
683                  drhou(ji,jj,jk) = 2.0 *   drhox(ji+1,jj,jk) * drhox(ji,jj,jk)   &
684                     &                  / ( drhox(ji+1,jj,jk) + drhox(ji,jj,jk) )
685               ELSE
686                  drhou(ji,jj,jk ) = 0.e0
687               ENDIF
688
689               IF( cffx > zep ) THEN
690                  dzu(ji,jj,jk) = 2.0*dzx(ji+1,jj,jk)*dzx(ji,jj,jk)   &
691                     &            /(dzx(ji+1,jj,jk)+dzx(ji,jj,jk))
692               ELSE
693                  dzu(ji,jj,jk) = 0.e0
694               ENDIF
695
696               IF( cffv > zep ) THEN
697                  drhov(ji,jj,jk) = 2.0 *   drhoy(ji,jj+1,jk) * drhoy(ji,jj,jk)   &
698                     &                  / ( drhoy(ji,jj+1,jk) + drhoy(ji,jj,jk) )
699               ELSE
700                  drhov(ji,jj,jk) = 0.e0
701               ENDIF
702
703               IF( cffy > zep ) THEN
704                  dzv(ji,jj,jk) = 2.0 *   dzy(ji,jj+1,jk) * dzy(ji,jj,jk)   &
705                     &                / ( dzy(ji,jj+1,jk) + dzy(ji,jj,jk) )
706               ELSE
707                  dzv(ji,jj,jk) = 0.e0
708               ENDIF
709
710            END DO
711         END DO
712      END DO
713
714      !----------------------------------------------------------------------------------
715      ! apply boundary conditions at top and bottom using 5.36-5.37
716      !----------------------------------------------------------------------------------
717      drhow(:,:, 1 ) = 1.5 * ( drhoz(:,:, 2 ) - drhoz(:,:,  1  ) ) - 0.5 * drhow(:,:,  2  )
718      drhou(:,:, 1 ) = 1.5 * ( drhox(:,:, 2 ) - drhox(:,:,  1  ) ) - 0.5 * drhou(:,:,  2  )
719      drhov(:,:, 1 ) = 1.5 * ( drhoy(:,:, 2 ) - drhoy(:,:,  1  ) ) - 0.5 * drhov(:,:,  2  )
720
721      drhow(:,:,jpk) = 1.5 * ( drhoz(:,:,jpk) - drhoz(:,:,jpkm1) ) - 0.5 * drhow(:,:,jpkm1)
722      drhou(:,:,jpk) = 1.5 * ( drhox(:,:,jpk) - drhox(:,:,jpkm1) ) - 0.5 * drhou(:,:,jpkm1)
723      drhov(:,:,jpk) = 1.5 * ( drhoy(:,:,jpk) - drhoy(:,:,jpkm1) ) - 0.5 * drhov(:,:,jpkm1)
724
725
726      !--------------------------------------------------------------
727      ! Upper half of top-most grid box, compute and store
728      !-------------------------------------------------------------
729
730!!bug gm   :  e3w-de3w = 0.5*e3w  ....  and de3w(2)-de3w(1)=e3w(2) ....   to be verified
731!          true if de3w is really defined as the sum of the e3w scale factors as, it seems to me, it should be
732
733      DO jj = 2, jpjm1
734         DO ji = fs_2, fs_jpim1   ! vector opt.
735            rho_k(ji,jj,1) = -grav * ( fse3w(ji,jj,1) - fsde3w(ji,jj,1) )            &
736               &                   * (  rhd(ji,jj,1)                                 &
737               &                     + 0.5 * ( rhd(ji,jj,2) - rhd(ji,jj,1) )         &
738               &                           * ( fse3w (ji,jj,1) - fsde3w(ji,jj,1) )   &
739               &                           / ( fsde3w(ji,jj,2) - fsde3w(ji,jj,1) )  ) 
740         END DO
741      END DO
742
743!!bug gm    : here also, simplification is possible
744!!bug gm    : optimisation: 1/10 and 1/12 the division should be done before the loop
745
746      DO jk = 2, jpkm1
747         DO jj = 2, jpjm1
748            DO ji = fs_2, fs_jpim1   ! vector opt.
749
750               rho_k(ji,jj,jk) = zcoef0 * ( rhd   (ji,jj,jk) + rhd   (ji,jj,jk-1) )                                   &
751                  &                     * ( fsde3w(ji,jj,jk) - fsde3w(ji,jj,jk-1) )                                   &
752                  &            - grav * z1_10 * (                                                                     &
753                  &     ( drhow (ji,jj,jk) - drhow (ji,jj,jk-1) )                                                     &
754                  &   * ( fsde3w(ji,jj,jk) - fsde3w(ji,jj,jk-1) - z1_12 * ( dzw  (ji,jj,jk) + dzw  (ji,jj,jk-1) ) )   &
755                  &   - ( dzw   (ji,jj,jk) - dzw   (ji,jj,jk-1) )                                                     &
756                  &   * ( rhd   (ji,jj,jk) - rhd   (ji,jj,jk-1) - z1_12 * ( drhow(ji,jj,jk) + drhow(ji,jj,jk-1) ) )   &
757                  &                             )
758
759               rho_i(ji,jj,jk) = zcoef0 * ( rhd   (ji+1,jj,jk) + rhd   (ji,jj,jk) )                                   &
760                  &                     * ( fsde3w(ji+1,jj,jk) - fsde3w(ji,jj,jk) )                                   &
761                  &            - grav* z1_10 * (                                                                      &
762                  &     ( drhou (ji+1,jj,jk) - drhou (ji,jj,jk) )                                                     &
763                  &   * ( fsde3w(ji+1,jj,jk) - fsde3w(ji,jj,jk) - z1_12 * ( dzu  (ji+1,jj,jk) + dzu  (ji,jj,jk) ) )   &
764                  &   - ( dzu   (ji+1,jj,jk) - dzu   (ji,jj,jk) )                                                     &
765                  &   * ( rhd   (ji+1,jj,jk) - rhd   (ji,jj,jk) - z1_12 * ( drhou(ji+1,jj,jk) + drhou(ji,jj,jk) ) )   &
766                  &                            )
767
768               rho_j(ji,jj,jk) = zcoef0 * ( rhd   (ji,jj+1,jk) + rhd   (ji,jj,jk) )                                   &
769                  &                     * ( fsde3w(ji,jj+1,jk) - fsde3w(ji,jj,jk) )                                   &
770                  &            - grav* z1_10 * (                                                                      &
771                  &     ( drhov (ji,jj+1,jk) - drhov (ji,jj,jk) )                                                     &
772                  &   * ( fsde3w(ji,jj+1,jk) - fsde3w(ji,jj,jk) - z1_12 * ( dzv  (ji,jj+1,jk) + dzv  (ji,jj,jk) ) )   &
773                  &   - ( dzv   (ji,jj+1,jk) - dzv   (ji,jj,jk) )                                                     &
774                  &   * ( rhd   (ji,jj+1,jk) - rhd   (ji,jj,jk) - z1_12 * ( drhov(ji,jj+1,jk) + drhov(ji,jj,jk) ) )   &
775                  &                            )
776
777            END DO
778         END DO
779      END DO
780      CALL lbc_lnk(rho_k,'W',1.)
781      CALL lbc_lnk(rho_i,'U',1.)
782      CALL lbc_lnk(rho_j,'V',1.)
783
784
785      ! ---------------
786      !  Surface value
787      ! ---------------
788      DO jj = 2, jpjm1
789         DO ji = fs_2, fs_jpim1   ! vector opt.
790            zhpi(ji,jj,1) = ( rho_k(ji+1,jj  ,1) - rho_k(ji,jj,1) - rho_i(ji,jj,1) ) / e1u(ji,jj)
791            zhpj(ji,jj,1) = ( rho_k(ji  ,jj+1,1) - rho_k(ji,jj,1) - rho_j(ji,jj,1) ) / e2v(ji,jj)
792            ! add to the general momentum trend
793            ua(ji,jj,1) = ua(ji,jj,1) + zhpi(ji,jj,1)
794            va(ji,jj,1) = va(ji,jj,1) + zhpj(ji,jj,1)
795         END DO
796      END DO
797
798      ! ----------------
799      !  interior value   (2=<jk=<jpkm1)
800      ! ----------------
801      DO jk = 2, jpkm1
802         DO jj = 2, jpjm1 
803            DO ji = fs_2, fs_jpim1   ! vector opt.
804               ! hydrostatic pressure gradient along s-surfaces
805               zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1)                                &
806                  &           + (  ( rho_k(ji+1,jj,jk) - rho_k(ji,jj,jk  ) )    &
807                  &              - ( rho_i(ji  ,jj,jk) - rho_i(ji,jj,jk-1) )  ) / e1u(ji,jj)
808               zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1)                                &
809                  &           + (  ( rho_k(ji,jj+1,jk) - rho_k(ji,jj,jk  ) )    &
810                  &               -( rho_j(ji,jj  ,jk) - rho_j(ji,jj,jk-1) )  ) / e2v(ji,jj)
811               ! add to the general momentum trend
812               ua(ji,jj,jk) = ua(ji,jj,jk) + zhpi(ji,jj,jk)
813               va(ji,jj,jk) = va(ji,jj,jk) + zhpj(ji,jj,jk)
814            END DO
815         END DO
816      END DO
817      !
818   END SUBROUTINE hpg_djc
819
820
821   SUBROUTINE hpg_rot( kt )
822      !!---------------------------------------------------------------------
823      !!                  ***  ROUTINE hpg_rot  ***
824      !!
825      !! ** Method  :   rotated axes scheme (Thiem and Berntsen 2005)
826      !!
827      !! Reference: Thiem & Berntsen, Ocean Modelling, In press, 2005.
828      !!----------------------------------------------------------------------
829      USE oce, ONLY :   zhpi => ta   ! use ta as 3D workspace
830      USE oce, ONLY :   zhpj => sa   ! use sa as 3D workspace
831      !!
832      INTEGER, INTENT(in) ::   kt    ! ocean time-step index
833      !!
834      INTEGER  ::   ji, jj, jk          ! dummy loop indices
835      REAL(wp) ::   zforg, zcoef0, zuap, zmskd1, zmskd1m   ! temporary scalar
836      REAL(wp) ::   zfrot        , zvap, zmskd2, zmskd2m   !    "         "
837      REAL(wp), DIMENSION(jpi,jpj)     ::   zdistr, zsina, zcosa                ! 2D workspace
838      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zhpiorg, zhpirot, zhpitra, zhpine   ! 3D workspace
839      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zhpjorg, zhpjrot, zhpjtra, zhpjne   !  "      "
840      !!----------------------------------------------------------------------
841
842      IF( kt == nit000 ) THEN
843         IF(lwp) WRITE(numout,*)
844         IF(lwp) WRITE(numout,*) 'dyn:hpg_rot : hydrostatic pressure gradient trend'
845         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   s-coordinate case, rotated axes scheme used'
846      ENDIF
847
848      ! -------------------------------
849      !  Local constant initialization
850      ! -------------------------------
851      zcoef0 = - grav * 0.5
852      zforg  = 0.95e0
853      zfrot  = 1.e0 - zforg
854
855      ! inverse of the distance between 2 diagonal T-points (defined at F-point) (here zcoef0/distance)
856      zdistr(:,:) = zcoef0 / SQRT( e1f(:,:)*e1f(:,:) + e2f(:,:)*e1f(:,:) )
857
858      ! sinus and cosinus of diagonal angle at F-point
859      zsina(:,:) = ATAN2( e2f(:,:), e1f(:,:) )
860      zcosa(:,:) = COS( zsina(:,:) )
861      zsina(:,:) = SIN( zsina(:,:) )
862
863      ! ---------------
864      !  Surface value
865      ! ---------------
866      ! compute and add to the general trend the pressure gradients along the axes
867      DO jj = 2, jpjm1
868         DO ji = fs_2, fs_jpim1   ! vector opt.
869            ! hydrostatic pressure gradient along s-surfaces
870            zhpiorg(ji,jj,1) = zcoef0 / e1u(ji,jj) * (  fse3t(ji+1,jj,1) * rhd(ji+1,jj,1)   &
871               &                                      - fse3t(ji  ,jj,1) * rhd(ji  ,jj,1)  )
872            zhpjorg(ji,jj,1) = zcoef0 / e2v(ji,jj) * (  fse3t(ji,jj+1,1) * rhd(ji,jj+1,1)   &
873               &                                      - fse3t(ji,jj  ,1) * rhd(ji,jj  ,1)  )
874            ! s-coordinate pressure gradient correction
875            zuap = -zcoef0 * ( rhd   (ji+1,jj  ,1) + rhd   (ji,jj,1) )   &
876               &           * ( fsdept(ji+1,jj  ,1) - fsdept(ji,jj,1) ) / e1u(ji,jj)
877            zvap = -zcoef0 * ( rhd   (ji  ,jj+1,1) + rhd   (ji,jj,1) )   &
878               &           * ( fsdept(ji  ,jj+1,1) - fsdept(ji,jj,1) ) / e2v(ji,jj)
879            ! add to the general momentum trend
880            ua(ji,jj,1) = ua(ji,jj,1) + zforg * ( zhpiorg(ji,jj,1) + zuap )
881            va(ji,jj,1) = va(ji,jj,1) + zforg * ( zhpjorg(ji,jj,1) + zvap )
882         END DO
883      END DO
884
885      ! compute the pressure gradients in the diagonal directions
886      DO jj = 1, jpjm1
887         DO ji = 1, fs_jpim1   ! vector opt.
888            zmskd1 = tmask(ji+1,jj+1,1) * tmask(ji  ,jj,1)      ! mask in the 1st diagnonal
889            zmskd2 = tmask(ji  ,jj+1,1) * tmask(ji+1,jj,1)      ! mask in the 2nd diagnonal
890            ! hydrostatic pressure gradient along s-surfaces
891            zhpitra(ji,jj,1) = zdistr(ji,jj) * zmskd1 * (  fse3t(ji+1,jj+1,1) * rhd(ji+1,jj+1,1)   &
892               &                                         - fse3t(ji  ,jj  ,1) * rhd(ji  ,jj  ,1)  )
893            zhpjtra(ji,jj,1) = zdistr(ji,jj) * zmskd2 * (  fse3t(ji  ,jj+1,1) * rhd(ji  ,jj+1,1)   &
894               &                                         - fse3t(ji+1,jj  ,1) * rhd(ji+1,jj  ,1)  )
895            ! s-coordinate pressure gradient correction
896            zuap = -zdistr(ji,jj) * zmskd1 * ( rhd   (ji+1,jj+1,1) + rhd   (ji  ,jj,1) )   &
897               &                           * ( fsdept(ji+1,jj+1,1) - fsdept(ji  ,jj,1) )
898            zvap = -zdistr(ji,jj) * zmskd2 * ( rhd   (ji  ,jj+1,1) + rhd   (ji+1,jj,1) )   &
899               &                           * ( fsdept(ji  ,jj+1,1) - fsdept(ji+1,jj,1) )
900            ! back rotation
901            zhpine(ji,jj,1) = zcosa(ji,jj) * ( zhpitra(ji,jj,1) + zuap )   &
902               &            - zsina(ji,jj) * ( zhpjtra(ji,jj,1) + zvap )
903            zhpjne(ji,jj,1) = zsina(ji,jj) * ( zhpitra(ji,jj,1) + zuap )   &
904               &            + zcosa(ji,jj) * ( zhpjtra(ji,jj,1) + zvap )
905         END DO
906      END DO
907
908      ! interpolate and add to the general trend the diagonal gradient
909      DO jj = 2, jpjm1
910         DO ji = fs_2, fs_jpim1   ! vector opt.
911            ! averaging
912            zhpirot(ji,jj,1) = 0.5 * ( zhpine(ji,jj,1) + zhpine(ji  ,jj-1,1) )
913            zhpjrot(ji,jj,1) = 0.5 * ( zhpjne(ji,jj,1) + zhpjne(ji-1,jj  ,1) )
914            ! add to the general momentum trend
915            ua(ji,jj,1) = ua(ji,jj,1) + zfrot * zhpirot(ji,jj,1) 
916            va(ji,jj,1) = va(ji,jj,1) + zfrot * zhpjrot(ji,jj,1) 
917         END DO
918      END DO
919
920      ! -----------------
921      ! 2. interior value (2=<jk=<jpkm1)
922      ! -----------------
923      ! compute and add to the general trend the pressure gradients along the axes
924      DO jk = 2, jpkm1
925         DO jj = 2, jpjm1
926            DO ji = fs_2, fs_jpim1   ! vector opt.
927               ! hydrostatic pressure gradient along s-surfaces
928               zhpiorg(ji,jj,jk) = zhpiorg(ji,jj,jk-1)                                                 &
929                  &              +  zcoef0 / e1u(ji,jj) * (  fse3t(ji+1,jj,jk  ) * rhd(ji+1,jj,jk  )   &
930                  &                                        - fse3t(ji  ,jj,jk  ) * rhd(ji  ,jj,jk  )   &
931                  &                                        + fse3t(ji+1,jj,jk-1) * rhd(ji+1,jj,jk-1)   &
932                  &                                        - fse3t(ji  ,jj,jk-1) * rhd(ji  ,jj,jk-1)  )
933               zhpjorg(ji,jj,jk) = zhpjorg(ji,jj,jk-1)                                                 &
934                  &              +  zcoef0 / e2v(ji,jj) * (  fse3t(ji,jj+1,jk  ) * rhd(ji,jj+1,jk  )   &
935                  &                                        - fse3t(ji,jj  ,jk  ) * rhd(ji,jj,  jk  )   &
936                  &                                        + fse3t(ji,jj+1,jk-1) * rhd(ji,jj+1,jk-1)   &
937                  &                                        - fse3t(ji,jj  ,jk-1) * rhd(ji,jj,  jk-1)  )
938               ! s-coordinate pressure gradient correction
939               zuap = - zcoef0 * ( rhd   (ji+1,jj  ,jk) + rhd   (ji,jj,jk) )   &
940                  &            * ( fsdept(ji+1,jj  ,jk) - fsdept(ji,jj,jk) ) / e1u(ji,jj)
941               zvap = - zcoef0 * ( rhd   (ji  ,jj+1,jk) + rhd   (ji,jj,jk) )   &
942                  &            * ( fsdept(ji  ,jj+1,jk) - fsdept(ji,jj,jk) ) / e2v(ji,jj)
943               ! add to the general momentum trend
944               ua(ji,jj,jk) = ua(ji,jj,jk) + zforg*( zhpiorg(ji,jj,jk) + zuap )
945               va(ji,jj,jk) = va(ji,jj,jk) + zforg*( zhpjorg(ji,jj,jk) + zvap )
946            END DO
947         END DO
948      END DO
949
950      ! compute the pressure gradients in the diagonal directions
951      DO jk = 2, jpkm1
952         DO jj = 1, jpjm1
953            DO ji = 1, fs_jpim1   ! vector opt.
954               zmskd1  = tmask(ji+1,jj+1,jk  ) * tmask(ji  ,jj,jk  )      ! level jk   mask in the 1st diagnonal
955               zmskd1m = tmask(ji+1,jj+1,jk-1) * tmask(ji  ,jj,jk-1)      ! level jk-1    "               "     
956               zmskd2  = tmask(ji  ,jj+1,jk  ) * tmask(ji+1,jj,jk  )      ! level jk   mask in the 2nd diagnonal
957               zmskd2m = tmask(ji  ,jj+1,jk-1) * tmask(ji+1,jj,jk-1)      ! level jk-1    "               "     
958               ! hydrostatic pressure gradient along s-surfaces
959               zhpitra(ji,jj,jk) = zhpitra(ji,jj,jk-1)                                                       &
960                  &              + zdistr(ji,jj) * zmskd1  * ( fse3t(ji+1,jj+1,jk  ) * rhd(ji+1,jj+1,jk)     &
961                  &                                           -fse3t(ji  ,jj  ,jk  ) * rhd(ji  ,jj  ,jk) )   &
962                  &              + zdistr(ji,jj) * zmskd1m * ( fse3t(ji+1,jj+1,jk-1) * rhd(ji+1,jj+1,jk-1)   &
963                  &                                           -fse3t(ji  ,jj  ,jk-1) * rhd(ji  ,jj  ,jk-1) )
964               zhpjtra(ji,jj,jk) = zhpjtra(ji,jj,jk-1)                                                       &
965                  &              + zdistr(ji,jj) * zmskd2  * ( fse3t(ji  ,jj+1,jk  ) * rhd(ji  ,jj+1,jk)     &
966                  &                                           -fse3t(ji+1,jj  ,jk  ) * rhd(ji+1,jj,  jk) )   &
967                  &              + zdistr(ji,jj) * zmskd2m * ( fse3t(ji  ,jj+1,jk-1) * rhd(ji  ,jj+1,jk-1)   &
968                  &                                           -fse3t(ji+1,jj  ,jk-1) * rhd(ji+1,jj,  jk-1) )
969               ! s-coordinate pressure gradient correction
970               zuap = - zdistr(ji,jj) * zmskd1 * ( rhd   (ji+1,jj+1,jk) + rhd   (ji  ,jj,jk) )   &
971                  &                            * ( fsdept(ji+1,jj+1,jk) - fsdept(ji  ,jj,jk) )
972               zvap = - zdistr(ji,jj) * zmskd2 * ( rhd   (ji  ,jj+1,jk) + rhd   (ji+1,jj,jk) )   &
973                  &                            * ( fsdept(ji  ,jj+1,jk) - fsdept(ji+1,jj,jk) )
974               ! back rotation
975               zhpine(ji,jj,jk) = zcosa(ji,jj) * ( zhpitra(ji,jj,jk) + zuap )   &
976                  &             - zsina(ji,jj) * ( zhpjtra(ji,jj,jk) + zvap )
977               zhpjne(ji,jj,jk) = zsina(ji,jj) * ( zhpitra(ji,jj,jk) + zuap )   &
978                  &             + zcosa(ji,jj) * ( zhpjtra(ji,jj,jk) + zvap )
979            END DO
980         END DO
981      END DO
982
983      ! interpolate and add to the general trend
984      DO jk = 2, jpkm1
985         DO jj = 2, jpjm1
986            DO ji = fs_2, fs_jpim1   ! vector opt.
987               ! averaging
988               zhpirot(ji,jj,jk) = 0.5 * ( zhpine(ji,jj,jk) + zhpine(ji  ,jj-1,jk) )
989               zhpjrot(ji,jj,jk) = 0.5 * ( zhpjne(ji,jj,jk) + zhpjne(ji-1,jj  ,jk) )
990               ! add to the general momentum trend
991               ua(ji,jj,jk) = ua(ji,jj,jk) + zfrot * zhpirot(ji,jj,jk) 
992               va(ji,jj,jk) = va(ji,jj,jk) + zfrot * zhpjrot(ji,jj,jk) 
993            END DO
994         END DO
995      END DO
996      !
997   END SUBROUTINE hpg_rot
998
999   !!======================================================================
1000END MODULE dynhpg
Note: See TracBrowser for help on using the repository browser.