source: trunk/NEMO/OPA_SRC/DYN/dynhpg.F90 @ 789

Last change on this file since 789 was 789, checked in by rblod, 13 years ago

Suppress jki routines and associated key_mpp_omp

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