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/UKMO/2014_Surge_Modelling/NEMOGCM/NEMO/OPA_SRC/DYN – NEMO

source: branches/UKMO/2014_Surge_Modelling/NEMOGCM/NEMO/OPA_SRC/DYN/dynhpg.F90 @ 4794

Last change on this file since 4794 was 4794, checked in by rfurner, 10 years ago

commited changes to run as 1 vertical level, added simple hpg option for basic surge set up
  • Property svn:keywords set to Id
File size: 54.4 KB
Line 
1MODULE dynhpg
2   !!======================================================================
3   !!                       ***  MODULE  dynhpg  ***
4   !! Ocean dynamics:  hydrostatic pressure gradient trend
5   !!======================================================================
6   !! History :  OPA  !  1987-09  (P. Andrich, M.-A. Foujols)  hpg_zco: Original code
7   !!            5.0  !  1991-11  (G. Madec)
8   !!            7.0  !  1996-01  (G. Madec)  hpg_sco: Original code for s-coordinates
9   !!            8.0  !  1997-05  (G. Madec)  split dynber into dynkeg and dynhpg
10   !!            8.5  !  2002-07  (G. Madec)  F90: Free form and module
11   !!            8.5  !  2002-08  (A. Bozec)  hpg_zps: Original code
12   !!   NEMO     1.0  !  2005-10  (A. Beckmann, B.W. An)  various s-coordinate options
13   !!                 !         Original code for hpg_ctl, hpg_hel hpg_wdj, hpg_djc, hpg_rot
14   !!             -   !  2005-11  (G. Madec) style & small optimisation
15   !!            3.3  !  2010-10  (C. Ethe, G. Madec) reorganisation of initialisation phase
16   !!            3.4  !  2011-11  (H. Liu) hpg_prj: Original code for s-coordinates
17   !!                 !           (A. Coward) suppression of hel, wdj and rot options
18   !!----------------------------------------------------------------------
19
20   !!----------------------------------------------------------------------
21   !!   dyn_hpg      : update the momentum trend with the now horizontal
22   !!                  gradient of the hydrostatic pressure
23   !!   dyn_hpg_init : initialisation and control of options
24   !!       hpg_zco  : z-coordinate scheme
25   !!       hpg_zps  : z-coordinate plus partial steps (interpolation)
26   !!       hpg_sco  : s-coordinate (standard jacobian formulation)
27   !!       hpg_djc  : s-coordinate (Density Jacobian with Cubic polynomial)
28   !!       hpg_prj  : s-coordinate (Pressure Jacobian with Cubic polynomial)
29   !!----------------------------------------------------------------------
30   USE oce             ! ocean dynamics and tracers
31   USE dom_oce         ! ocean space and time domain
32   USE phycst          ! physical constants
33   USE trdmod          ! ocean dynamics trends
34   USE trdmod_oce      ! ocean variables trends
35   USE in_out_manager  ! I/O manager
36   USE prtctl          ! Print control
37   USE lbclnk          ! lateral boundary condition
38   USE lib_mpp         ! MPP library
39   USE wrk_nemo        ! Memory Allocation
40   USE timing          ! Timing
41
42   IMPLICIT NONE
43   PRIVATE
44
45   PUBLIC   dyn_hpg        ! routine called by step module
46   PUBLIC   dyn_hpg_init   ! routine called by opa module
47
48   !                                    !!* Namelist namdyn_hpg : hydrostatic pressure gradient
49   LOGICAL , PUBLIC ::   ln_hpg_zco      !: z-coordinate - full steps
50   LOGICAL , PUBLIC ::   ln_hpg_zps      !: z-coordinate - partial steps (interpolation)
51   LOGICAL , PUBLIC ::   ln_hpg_sco      !: s-coordinate (standard jacobian formulation)
52   LOGICAL , PUBLIC ::   ln_hpg_djc      !: s-coordinate (Density Jacobian with Cubic polynomial)
53   LOGICAL , PUBLIC ::   ln_hpg_prj      !: s-coordinate (Pressure Jacobian scheme)
54   LOGICAL , PUBLIC ::   ln_dynhpg_imp   !: semi-implicite hpg flag
55
56   INTEGER , PUBLIC ::   nhpg  =  0   ! = 0 to 7, type of pressure gradient scheme used ! (deduced from ln_hpg_... flags) (PUBLIC for TAM)
57
58   !! * Substitutions
59#  include "domzgr_substitute.h90"
60#  include "vectopt_loop_substitute.h90"
61   !!----------------------------------------------------------------------
62   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
63   !! $Id$
64   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
65   !!----------------------------------------------------------------------
66CONTAINS
67
68   SUBROUTINE dyn_hpg( kt )
69      !!---------------------------------------------------------------------
70      !!                  ***  ROUTINE dyn_hpg  ***
71      !!
72      !! ** Method  :   Call the hydrostatic pressure gradient routine
73      !!              using the scheme defined in the namelist
74      !!
75      !! ** Action : - Update (ua,va) with the now hydrastatic pressure trend
76      !!             - Save the trend (l_trddyn=T)
77      !!----------------------------------------------------------------------
78      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
79      REAL(wp), POINTER, DIMENSION(:,:,:) ::  ztrdu, ztrdv
80      !!----------------------------------------------------------------------
81      !
82      IF( nn_timing == 1 )  CALL timing_start('dyn_hpg')
83      !
84      IF( l_trddyn ) THEN                    ! Temporary saving of ua and va trends (l_trddyn)
85         CALL wrk_alloc( jpi,jpj,jpk, ztrdu, ztrdv )
86         ztrdu(:,:,:) = ua(:,:,:)
87         ztrdv(:,:,:) = va(:,:,:)
88      ENDIF
89      !
90      SELECT CASE ( nhpg )      ! Hydrostatic 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_djc    ( kt )      ! s-coordinate (Density Jacobian with Cubic polynomial)
95      CASE (  4 )   ;   CALL hpg_prj    ( kt )      ! s-coordinate (Pressure Jacobian scheme)
96      END SELECT
97      !
98      IF( l_trddyn ) THEN      ! save the hydrostatic pressure gradient trends for momentum trend diagnostics
99         ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
100         ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
101         CALL trd_mod( ztrdu, ztrdv, jpdyn_trd_hpg, 'DYN', kt )
102         CALL wrk_dealloc( jpi,jpj,jpk, ztrdu, ztrdv )
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      IF( nn_timing == 1 )  CALL timing_stop('dyn_hpg')
109      !
110   END SUBROUTINE dyn_hpg
111
112
113   SUBROUTINE dyn_hpg_init
114      !!----------------------------------------------------------------------
115      !!                 ***  ROUTINE dyn_hpg_init  ***
116      !!
117      !! ** Purpose :   initializations for the hydrostatic pressure gradient
118      !!              computation and consistency control
119      !!
120      !! ** Action  :   Read the namelist namdyn_hpg and check the consistency
121      !!      with the type of vertical coordinate used (zco, zps, sco)
122      !!----------------------------------------------------------------------
123      INTEGER ::   ioptio = 0      ! temporary integer
124      INTEGER ::   ios             ! Local integer output status for namelist read
125      !!
126      NAMELIST/namdyn_hpg/ ln_hpg_zco, ln_hpg_zps, ln_hpg_sco,     &
127         &                 ln_hpg_djc, ln_hpg_prj, ln_dynhpg_imp
128      !!----------------------------------------------------------------------
129      !
130      REWIND( numnam_ref )              ! Namelist namdyn_hpg in reference namelist : Hydrostatic pressure gradient
131      READ  ( numnam_ref, namdyn_hpg, IOSTAT = ios, ERR = 901)
132901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namdyn_hpg in reference namelist', lwp )
133
134      REWIND( numnam_cfg )              ! Namelist namdyn_hpg in configuration namelist : Hydrostatic pressure gradient
135      READ  ( numnam_cfg, namdyn_hpg, IOSTAT = ios, ERR = 902 )
136902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namdyn_hpg in configuration namelist', lwp )
137      IF(lwm) WRITE ( numond, namdyn_hpg )
138      !
139      IF(lwp) THEN                   ! Control print
140         WRITE(numout,*)
141         WRITE(numout,*) 'dyn_hpg_init : hydrostatic pressure gradient initialisation'
142         WRITE(numout,*) '~~~~~~~~~~~~'
143         WRITE(numout,*) '   Namelist namdyn_hpg : choice of hpg scheme'
144         WRITE(numout,*) '      z-coord. - full steps                             ln_hpg_zco    = ', ln_hpg_zco
145         WRITE(numout,*) '      z-coord. - partial steps (interpolation)          ln_hpg_zps    = ', ln_hpg_zps
146         WRITE(numout,*) '      s-coord. (standard jacobian formulation)          ln_hpg_sco    = ', ln_hpg_sco
147         WRITE(numout,*) '      s-coord. (Density Jacobian: Cubic polynomial)     ln_hpg_djc    = ', ln_hpg_djc
148         WRITE(numout,*) '      s-coord. (Pressure Jacobian: Cubic polynomial)    ln_hpg_prj    = ', ln_hpg_prj
149         WRITE(numout,*) '      time stepping: centered (F) or semi-implicit (T)  ln_dynhpg_imp = ', ln_dynhpg_imp
150      ENDIF
151      !
152      IF( ln_hpg_djc )   &
153         &   CALL ctl_stop('dyn_hpg_init : Density Jacobian: Cubic polynominal method &
154                           & currently disabled (bugs under investigation). Please select &
155                           & either  ln_hpg_sco or  ln_hpg_prj instead')
156      !
157      IF( lk_vvl .AND. .NOT. (ln_hpg_sco.OR.ln_hpg_prj) )   &
158         &   CALL ctl_stop('dyn_hpg_init : variable volume key_vvl requires:&
159                           & the standard jacobian formulation hpg_sco or &
160                           & the pressure jacobian formulation hpg_prj')
161      !
162      !                               ! Set nhpg from ln_hpg_... flags
163      IF( ln_hpg_zco )   nhpg = 0
164      IF( ln_hpg_zps )   nhpg = 1
165      IF( ln_hpg_sco )   nhpg = 2
166      IF( ln_hpg_djc )   nhpg = 3
167      IF( ln_hpg_prj )   nhpg = 4
168      !
169      !                               ! Consistency check
170      ioptio = 0
171      IF( ln_hpg_zco )   ioptio = ioptio + 1
172      IF( ln_hpg_zps )   ioptio = ioptio + 1
173      IF( ln_hpg_sco )   ioptio = ioptio + 1
174      IF( ln_hpg_djc )   ioptio = ioptio + 1
175      IF( ln_hpg_prj )   ioptio = ioptio + 1
176      IF( ioptio /= 1 )   CALL ctl_stop( 'NO or several hydrostatic pressure gradient options used' )
177      !
178   END SUBROUTINE dyn_hpg_init
179
180
181   SUBROUTINE hpg_zco( kt )
182      !!---------------------------------------------------------------------
183      !!                  ***  ROUTINE hpg_zco  ***
184      !!
185      !! ** Method  :   z-coordinate case, levels are horizontal surfaces.
186      !!      The now hydrostatic pressure gradient at a given level, jk,
187      !!      is computed by taking the vertical integral of the in-situ
188      !!      density gradient along the model level from the suface to that
189      !!      level:    zhpi = grav .....
190      !!                zhpj = grav .....
191      !!      add it to the general momentum trend (ua,va).
192      !!            ua = ua - 1/e1u * zhpi
193      !!            va = va - 1/e2v * zhpj
194      !!
195      !! ** Action : - Update (ua,va) with the now hydrastatic pressure trend
196      !!----------------------------------------------------------------------
197      INTEGER, INTENT(in) ::   kt    ! ocean time-step index
198      !!
199      INTEGER  ::   ji, jj, jk       ! dummy loop indices
200      REAL(wp) ::   zcoef0, zcoef1   ! temporary scalars
201      REAL(wp), POINTER, DIMENSION(:,:,:) ::  zhpi, zhpj
202      !!----------------------------------------------------------------------
203      !
204      CALL wrk_alloc( jpi,jpj,jpk, zhpi, zhpj )
205      !
206      IF( kt == nit000 ) THEN
207         IF(lwp) WRITE(numout,*)
208         IF(lwp) WRITE(numout,*) 'dyn:hpg_zco : hydrostatic pressure gradient trend'
209         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   z-coordinate case '
210      ENDIF
211
212      zcoef0 = - grav * 0.5_wp      ! Local constant initialization
213
214      ! Surface value
215      DO jj = 2, jpjm1
216         DO ji = fs_2, fs_jpim1   ! vector opt.
217            zcoef1 = zcoef0 * fse3w(ji,jj,1)
218            ! hydrostatic pressure gradient
219            zhpi(ji,jj,1) = zcoef1 * ( rhd(ji+1,jj,1) - rhd(ji,jj,1) ) / e1u(ji,jj)
220            zhpj(ji,jj,1) = zcoef1 * ( rhd(ji,jj+1,1) - rhd(ji,jj,1) ) / e2v(ji,jj)
221            ! add to the general momentum trend
222            ua(ji,jj,1) = ua(ji,jj,1) + zhpi(ji,jj,1)
223            va(ji,jj,1) = va(ji,jj,1) + zhpj(ji,jj,1)
224         END DO
225      END DO
226
227      !
228      ! interior value (2=<jk=<jpkm1)
229      DO jk = 2, jpkm1
230         DO jj = 2, jpjm1
231            DO ji = fs_2, fs_jpim1   ! vector opt.
232               zcoef1 = zcoef0 * fse3w(ji,jj,jk)
233               ! hydrostatic pressure gradient
234               zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1)   &
235                  &           + zcoef1 * (  ( rhd(ji+1,jj,jk)+rhd(ji+1,jj,jk-1) )   &
236                  &                       - ( rhd(ji  ,jj,jk)+rhd(ji  ,jj,jk-1) )  ) / e1u(ji,jj)
237
238               zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1)   &
239                  &           + zcoef1 * (  ( rhd(ji,jj+1,jk)+rhd(ji,jj+1,jk-1) )   &
240                  &                       - ( rhd(ji,jj,  jk)+rhd(ji,jj  ,jk-1) )  ) / e2v(ji,jj)
241               ! add to the general momentum trend
242               ua(ji,jj,jk) = ua(ji,jj,jk) + zhpi(ji,jj,jk)
243               va(ji,jj,jk) = va(ji,jj,jk) + zhpj(ji,jj,jk)
244            END DO
245         END DO
246      END DO
247      !
248      CALL wrk_dealloc( jpi,jpj,jpk, zhpi, zhpj )
249      !
250   END SUBROUTINE hpg_zco
251
252
253   SUBROUTINE hpg_zps( kt )
254      !!---------------------------------------------------------------------
255      !!                 ***  ROUTINE hpg_zps  ***
256      !!
257      !! ** Method  :   z-coordinate plus partial steps case.  blahblah...
258      !!
259      !! ** Action  : - Update (ua,va) with the now hydrastatic pressure trend
260      !!----------------------------------------------------------------------
261      INTEGER, INTENT(in) ::   kt    ! ocean time-step index
262      !!
263      INTEGER  ::   ji, jj, jk                       ! dummy loop indices
264      INTEGER  ::   iku, ikv                         ! temporary integers
265      REAL(wp) ::   zcoef0, zcoef1, zcoef2, zcoef3   ! temporary scalars
266      REAL(wp), POINTER, DIMENSION(:,:,:) ::  zhpi, zhpj
267      !!----------------------------------------------------------------------
268      !
269      CALL wrk_alloc( jpi,jpj,jpk, zhpi, zhpj )
270      !
271      IF( kt == nit000 ) THEN
272         IF(lwp) WRITE(numout,*)
273         IF(lwp) WRITE(numout,*) 'dyn:hpg_zps : hydrostatic pressure gradient trend'
274         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   z-coordinate with partial steps - vector optimization'
275      ENDIF
276
277
278      ! Local constant initialization
279      zcoef0 = - grav * 0.5_wp
280
281      !  Surface value (also valid in partial step case)
282      DO jj = 2, jpjm1
283         DO ji = fs_2, fs_jpim1   ! vector opt.
284            zcoef1 = zcoef0 * fse3w(ji,jj,1)
285            ! hydrostatic pressure gradient
286            zhpi(ji,jj,1) = zcoef1 * ( rhd(ji+1,jj  ,1) - rhd(ji,jj,1) ) / e1u(ji,jj)
287            zhpj(ji,jj,1) = zcoef1 * ( rhd(ji  ,jj+1,1) - rhd(ji,jj,1) ) / e2v(ji,jj)
288            ! add to the general momentum trend
289            ua(ji,jj,1) = ua(ji,jj,1) + zhpi(ji,jj,1)
290            va(ji,jj,1) = va(ji,jj,1) + zhpj(ji,jj,1)
291         END DO
292      END DO
293
294
295      ! interior value (2=<jk=<jpkm1)
296      DO jk = 2, jpkm1
297         DO jj = 2, jpjm1
298            DO ji = fs_2, fs_jpim1   ! vector opt.
299               zcoef1 = zcoef0 * fse3w(ji,jj,jk)
300               ! hydrostatic pressure gradient
301               zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1)   &
302                  &           + zcoef1 * (  ( rhd(ji+1,jj,jk) + rhd(ji+1,jj,jk-1) )   &
303                  &                       - ( rhd(ji  ,jj,jk) + rhd(ji  ,jj,jk-1) )  ) / e1u(ji,jj)
304
305               zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1)   &
306                  &           + zcoef1 * (  ( rhd(ji,jj+1,jk) + rhd(ji,jj+1,jk-1) )   &
307                  &                       - ( rhd(ji,jj,  jk) + rhd(ji,jj  ,jk-1) )  ) / e2v(ji,jj)
308               ! add to the general momentum trend
309               ua(ji,jj,jk) = ua(ji,jj,jk) + zhpi(ji,jj,jk)
310               va(ji,jj,jk) = va(ji,jj,jk) + zhpj(ji,jj,jk)
311            END DO
312         END DO
313      END DO
314
315
316      ! partial steps correction at the last level  (use gru & grv computed in zpshde.F90)
317# if defined key_vectopt_loop
318         jj = 1
319         DO ji = jpi+2, jpij-jpi-1   ! vector opt. (forced unrolling)
320# else
321      DO jj = 2, jpjm1
322         DO ji = 2, jpim1
323# endif
324            iku = mbku(ji,jj)
325            ikv = mbkv(ji,jj)
326            zcoef2 = zcoef0 * MIN( fse3w(ji,jj,iku), fse3w(ji+1,jj  ,iku) )
327            zcoef3 = zcoef0 * MIN( fse3w(ji,jj,ikv), fse3w(ji  ,jj+1,ikv) )
328            IF( iku > 1 ) THEN            ! on i-direction (level 2 or more)
329               ua  (ji,jj,iku) = ua(ji,jj,iku) - zhpi(ji,jj,iku)         ! subtract old value
330               zhpi(ji,jj,iku) = zhpi(ji,jj,iku-1)                   &   ! compute the new one
331                  &            + zcoef2 * ( rhd(ji+1,jj,iku-1) - rhd(ji,jj,iku-1) + gru(ji,jj) ) / e1u(ji,jj)
332               ua  (ji,jj,iku) = ua(ji,jj,iku) + zhpi(ji,jj,iku)         ! add the new one to the general momentum trend
333            ENDIF
334            IF( ikv > 1 ) THEN            ! on j-direction (level 2 or more)
335               va  (ji,jj,ikv) = va(ji,jj,ikv) - zhpj(ji,jj,ikv)         ! subtract old value
336               zhpj(ji,jj,ikv) = zhpj(ji,jj,ikv-1)                   &   ! compute the new one
337                  &            + zcoef3 * ( rhd(ji,jj+1,ikv-1) - rhd(ji,jj,ikv-1) + grv(ji,jj) ) / e2v(ji,jj)
338               va  (ji,jj,ikv) = va(ji,jj,ikv) + zhpj(ji,jj,ikv)         ! add the new one to the general momentum trend
339            ENDIF
340# if ! defined key_vectopt_loop
341         END DO
342# endif
343      END DO
344      !
345      CALL wrk_dealloc( jpi,jpj,jpk, zhpi, zhpj )
346      !
347   END SUBROUTINE hpg_zps
348
349
350   SUBROUTINE hpg_sco( kt )
351      !!---------------------------------------------------------------------
352      !!                  ***  ROUTINE hpg_sco  ***
353      !!
354      !! ** Method  :   s-coordinate case. Jacobian scheme.
355      !!      The now hydrostatic pressure gradient at a given level, jk,
356      !!      is computed by taking the vertical integral of the in-situ
357      !!      density gradient along the model level from the suface to that
358      !!      level. s-coordinates (ln_sco): a corrective term is added
359      !!      to the horizontal pressure gradient :
360      !!         zhpi = grav .....  + 1/e1u mi(rhd) di[ grav dep3w ]
361      !!         zhpj = grav .....  + 1/e2v mj(rhd) dj[ grav dep3w ]
362      !!      add it to the general momentum trend (ua,va).
363      !!         ua = ua - 1/e1u * zhpi
364      !!         va = va - 1/e2v * zhpj
365      !!
366      !! ** Action : - Update (ua,va) with the now hydrastatic pressure trend
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      REAL(wp), POINTER, DIMENSION(:,:,:) ::  zhpi, zhpj
373      !!----------------------------------------------------------------------
374      !
375      CALL wrk_alloc( jpi,jpj,jpk, zhpi, zhpj )
376      !
377      IF( kt == nit000 ) THEN
378         IF(lwp) WRITE(numout,*)
379         IF(lwp) WRITE(numout,*) 'dyn:hpg_sco : hydrostatic pressure gradient trend'
380         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   s-coordinate case, OPA original scheme used'
381      ENDIF
382
383      ! Local constant initialization
384      zcoef0 = - grav * 0.5_wp
385      ! To use density and not density anomaly
386      IF ( lk_vvl ) THEN   ;     znad = 1._wp          ! Variable volume
387      ELSE                 ;     znad = 0._wp         ! Fixed volume
388      ENDIF
389
390#if defined key_surge
391      ! Surface value
392      DO jj = 2, jpjm1
393         DO ji = fs_2, fs_jpim1   ! vector opt.
394            ! hydrostatic pressure gradient along s-surfaces
395            zhpi(ji,jj,1) = zcoef0 / e1u(ji,jj) * ( fse3w(ji+1,jj  ,1) * ( znad )   &
396               &                                  - fse3w(ji  ,jj  ,1) * ( znad ) )
397            zhpj(ji,jj,1) = zcoef0 / e2v(ji,jj) * ( fse3w(ji  ,jj+1,1) * ( znad )   &
398               &                                  - fse3w(ji  ,jj  ,1) * ( znad ) )
399            ! s-coordinate pressure gradient correction
400            zuap = -zcoef0 * ( 2._wp * znad )   &
401               &           * ( fsde3w(ji+1,jj,1) - fsde3w(ji,jj,1) ) / e1u(ji,jj)
402            zvap = -zcoef0 * ( 2._wp * znad )   &
403               &           * ( fsde3w(ji,jj+1,1) - fsde3w(ji,jj,1) ) / e2v(ji,jj)
404            ! add to the general momentum trend
405            ua(ji,jj,1) = ua(ji,jj,1) + zhpi(ji,jj,1) + zuap
406            va(ji,jj,1) = va(ji,jj,1) + zhpj(ji,jj,1) + zvap
407         END DO
408      END DO
409
410      ! interior value (2=<jk=<jpkm1)
411      DO jk = 2, jpkm1
412         DO jj = 2, jpjm1
413            DO ji = fs_2, fs_jpim1   ! vector opt.
414               ! hydrostatic pressure gradient along s-surfaces
415               zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1) + zcoef0 / e1u(ji,jj)   &
416                  &           * (  fse3w(ji+1,jj,jk) * ( 2*znad )   &
417                  &              - fse3w(ji  ,jj,jk) * ( 2*znad )  )
418               zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1) + zcoef0 / e2v(ji,jj)   &
419                  &           * (  fse3w(ji,jj+1,jk) * ( 2*znad )   &
420                  &              - fse3w(ji,jj  ,jk) * ( 2*znad )  )
421               ! s-coordinate pressure gradient correction
422               zuap = -zcoef0 * ( 2._wp * znad )   &
423                  &           * ( fsde3w(ji+1,jj  ,jk) - fsde3w(ji,jj,jk) ) / e1u(ji,jj)
424               zvap = -zcoef0 * ( 2._wp * znad )   &
425                  &           * ( fsde3w(ji  ,jj+1,jk) - fsde3w(ji,jj,jk) ) / e2v(ji,jj)
426               ! add to the general momentum trend
427               ua(ji,jj,jk) = ua(ji,jj,jk) + zhpi(ji,jj,jk) + zuap
428               va(ji,jj,jk) = va(ji,jj,jk) + zhpj(ji,jj,jk) + zvap
429            END DO
430         END DO
431      END DO
432      !
433#else
434      ! Surface value
435      DO jj = 2, jpjm1
436         DO ji = fs_2, fs_jpim1   ! vector opt.
437            ! hydrostatic pressure gradient along s-surfaces
438            zhpi(ji,jj,1) = zcoef0 / e1u(ji,jj) * ( fse3w(ji+1,jj  ,1) * ( znad + rhd(ji+1,jj  ,1) )   &
439               &                                  - fse3w(ji  ,jj  ,1) * ( znad + rhd(ji  ,jj  ,1) ) )
440            zhpj(ji,jj,1) = zcoef0 / e2v(ji,jj) * ( fse3w(ji  ,jj+1,1) * ( znad + rhd(ji  ,jj+1,1) )   &
441               &                                  - fse3w(ji  ,jj  ,1) * ( znad + rhd(ji  ,jj  ,1) ) )
442            ! s-coordinate pressure gradient correction
443            zuap = -zcoef0 * ( rhd   (ji+1,jj,1) + rhd   (ji,jj,1) + 2._wp * znad )   &
444               &           * ( fsde3w(ji+1,jj,1) - fsde3w(ji,jj,1) ) / e1u(ji,jj)
445            zvap = -zcoef0 * ( rhd   (ji,jj+1,1) + rhd   (ji,jj,1) + 2._wp * znad )   &
446               &           * ( fsde3w(ji,jj+1,1) - fsde3w(ji,jj,1) ) / e2v(ji,jj)
447            ! add to the general momentum trend
448            ua(ji,jj,1) = ua(ji,jj,1) + zhpi(ji,jj,1) + zuap
449            va(ji,jj,1) = va(ji,jj,1) + zhpj(ji,jj,1) + zvap
450         END DO
451      END DO
452
453      ! interior value (2=<jk=<jpkm1)
454      DO jk = 2, jpkm1
455         DO jj = 2, jpjm1
456            DO ji = fs_2, fs_jpim1   ! vector opt.
457               ! hydrostatic pressure gradient along s-surfaces
458               zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1) + zcoef0 / e1u(ji,jj)   &
459                  &           * (  fse3w(ji+1,jj,jk) * ( rhd(ji+1,jj,jk) + rhd(ji+1,jj,jk-1) + 2*znad )   &
460                  &              - fse3w(ji  ,jj,jk) * ( rhd(ji  ,jj,jk) + rhd(ji  ,jj,jk-1) + 2*znad )  )
461               zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1) + zcoef0 / e2v(ji,jj)   &
462                  &           * (  fse3w(ji,jj+1,jk) * ( rhd(ji,jj+1,jk) + rhd(ji,jj+1,jk-1) + 2*znad )   &
463                  &              - fse3w(ji,jj  ,jk) * ( rhd(ji,jj,  jk) + rhd(ji,jj  ,jk-1) + 2*znad )  )
464               ! s-coordinate pressure gradient correction
465               zuap = -zcoef0 * ( rhd   (ji+1,jj  ,jk) + rhd   (ji,jj,jk) + 2._wp * znad )   &
466                  &           * ( fsde3w(ji+1,jj  ,jk) - fsde3w(ji,jj,jk) ) / e1u(ji,jj)
467               zvap = -zcoef0 * ( rhd   (ji  ,jj+1,jk) + rhd   (ji,jj,jk) + 2._wp * znad )   &
468                  &           * ( fsde3w(ji  ,jj+1,jk) - fsde3w(ji,jj,jk) ) / e2v(ji,jj)
469               ! add to the general momentum trend
470               ua(ji,jj,jk) = ua(ji,jj,jk) + zhpi(ji,jj,jk) + zuap
471               va(ji,jj,jk) = va(ji,jj,jk) + zhpj(ji,jj,jk) + zvap
472            END DO
473         END DO
474      END DO
475#endif
476      !
477      CALL wrk_dealloc( jpi,jpj,jpk, zhpi, zhpj )
478      !
479   END SUBROUTINE hpg_sco
480
481   SUBROUTINE hpg_djc( kt )
482      !!---------------------------------------------------------------------
483      !!                  ***  ROUTINE hpg_djc  ***
484      !!
485      !! ** Method  :   Density Jacobian with Cubic polynomial scheme
486      !!
487      !! Reference: Shchepetkin and McWilliams, J. Geophys. Res., 108(C3), 3090, 2003
488      !!----------------------------------------------------------------------
489      INTEGER, INTENT(in) ::   kt    ! ocean time-step index
490      !!
491      INTEGER  ::   ji, jj, jk          ! dummy loop indices
492      REAL(wp) ::   zcoef0, zep, cffw   ! temporary scalars
493      REAL(wp) ::   z1_10, cffu, cffx   !    "         "
494      REAL(wp) ::   z1_12, cffv, cffy   !    "         "
495      REAL(wp), POINTER, DIMENSION(:,:,:) ::  zhpi, zhpj
496      REAL(wp), POINTER, DIMENSION(:,:,:) ::  dzx, dzy, dzz, dzu, dzv, dzw
497      REAL(wp), POINTER, DIMENSION(:,:,:) ::  drhox, drhoy, drhoz, drhou, drhov, drhow
498      REAL(wp), POINTER, DIMENSION(:,:,:) ::  rho_i, rho_j, rho_k
499      !!----------------------------------------------------------------------
500      !
501      CALL wrk_alloc( jpi, jpj, jpk, dzx  , dzy  , dzz  , dzu  , dzv  , dzw   )
502      CALL wrk_alloc( jpi, jpj, jpk, drhox, drhoy, drhoz, drhou, drhov, drhow )
503      CALL wrk_alloc( jpi, jpj, jpk, rho_i, rho_j, rho_k,  zhpi,  zhpj        )
504      !
505
506      IF( kt == nit000 ) THEN
507         IF(lwp) WRITE(numout,*)
508         IF(lwp) WRITE(numout,*) 'dyn:hpg_djc : hydrostatic pressure gradient trend'
509         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   s-coordinate case, density Jacobian with cubic polynomial scheme'
510      ENDIF
511
512      ! Local constant initialization
513      zcoef0 = - grav * 0.5_wp
514      z1_10  = 1._wp / 10._wp
515      z1_12  = 1._wp / 12._wp
516
517      !----------------------------------------------------------------------------------------
518      !  compute and store in provisional arrays elementary vertical and horizontal differences
519      !----------------------------------------------------------------------------------------
520
521!!bug gm   Not a true bug, but... dzz=e3w  for dzx, dzy verify what it is really
522
523      DO jk = 2, jpkm1
524         DO jj = 2, jpjm1
525            DO ji = fs_2, fs_jpim1   ! vector opt.
526               drhoz(ji,jj,jk) = rhd   (ji  ,jj  ,jk) - rhd   (ji,jj,jk-1)
527               dzz  (ji,jj,jk) = fsde3w(ji  ,jj  ,jk) - fsde3w(ji,jj,jk-1)
528               drhox(ji,jj,jk) = rhd   (ji+1,jj  ,jk) - rhd   (ji,jj,jk  )
529               dzx  (ji,jj,jk) = fsde3w(ji+1,jj  ,jk) - fsde3w(ji,jj,jk  )
530               drhoy(ji,jj,jk) = rhd   (ji  ,jj+1,jk) - rhd   (ji,jj,jk  )
531               dzy  (ji,jj,jk) = fsde3w(ji  ,jj+1,jk) - fsde3w(ji,jj,jk  )
532            END DO
533         END DO
534      END DO
535
536      !-------------------------------------------------------------------------
537      ! compute harmonic averages using eq. 5.18
538      !-------------------------------------------------------------------------
539      zep = 1.e-15
540
541!!bug  gm  drhoz not defined at level 1 and used (jk-1 with jk=2)
542!!bug  gm  idem for drhox, drhoy et ji=jpi and jj=jpj
543
544      DO jk = 2, jpkm1
545         DO jj = 2, jpjm1
546            DO ji = fs_2, fs_jpim1   ! vector opt.
547               cffw = 2._wp * drhoz(ji  ,jj  ,jk) * drhoz(ji,jj,jk-1)
548
549               cffu = 2._wp * drhox(ji+1,jj  ,jk) * drhox(ji,jj,jk  )
550               cffx = 2._wp * dzx  (ji+1,jj  ,jk) * dzx  (ji,jj,jk  )
551
552               cffv = 2._wp * drhoy(ji  ,jj+1,jk) * drhoy(ji,jj,jk  )
553               cffy = 2._wp * dzy  (ji  ,jj+1,jk) * dzy  (ji,jj,jk  )
554
555               IF( cffw > zep) THEN
556                  drhow(ji,jj,jk) = 2._wp *   drhoz(ji,jj,jk) * drhoz(ji,jj,jk-1)   &
557                     &                    / ( drhoz(ji,jj,jk) + drhoz(ji,jj,jk-1) )
558               ELSE
559                  drhow(ji,jj,jk) = 0._wp
560               ENDIF
561
562               dzw(ji,jj,jk) = 2._wp *   dzz(ji,jj,jk) * dzz(ji,jj,jk-1)   &
563                  &                  / ( dzz(ji,jj,jk) + dzz(ji,jj,jk-1) )
564
565               IF( cffu > zep ) THEN
566                  drhou(ji,jj,jk) = 2._wp *   drhox(ji+1,jj,jk) * drhox(ji,jj,jk)   &
567                     &                    / ( drhox(ji+1,jj,jk) + drhox(ji,jj,jk) )
568               ELSE
569                  drhou(ji,jj,jk ) = 0._wp
570               ENDIF
571
572               IF( cffx > zep ) THEN
573                  dzu(ji,jj,jk) = 2._wp *   dzx(ji+1,jj,jk) * dzx(ji,jj,jk)   &
574                     &                  / ( dzx(ji+1,jj,jk) + dzx(ji,jj,jk) )
575               ELSE
576                  dzu(ji,jj,jk) = 0._wp
577               ENDIF
578
579               IF( cffv > zep ) THEN
580                  drhov(ji,jj,jk) = 2._wp *   drhoy(ji,jj+1,jk) * drhoy(ji,jj,jk)   &
581                     &                    / ( drhoy(ji,jj+1,jk) + drhoy(ji,jj,jk) )
582               ELSE
583                  drhov(ji,jj,jk) = 0._wp
584               ENDIF
585
586               IF( cffy > zep ) THEN
587                  dzv(ji,jj,jk) = 2._wp *   dzy(ji,jj+1,jk) * dzy(ji,jj,jk)   &
588                     &                  / ( dzy(ji,jj+1,jk) + dzy(ji,jj,jk) )
589               ELSE
590                  dzv(ji,jj,jk) = 0._wp
591               ENDIF
592
593            END DO
594         END DO
595      END DO
596
597      !----------------------------------------------------------------------------------
598      ! apply boundary conditions at top and bottom using 5.36-5.37
599      !----------------------------------------------------------------------------------
600      drhow(:,:, 1 ) = 1.5_wp * ( drhoz(:,:, 2 ) - drhoz(:,:,  1  ) ) - 0.5_wp * drhow(:,:,  2  )
601      drhou(:,:, 1 ) = 1.5_wp * ( drhox(:,:, 2 ) - drhox(:,:,  1  ) ) - 0.5_wp * drhou(:,:,  2  )
602      drhov(:,:, 1 ) = 1.5_wp * ( drhoy(:,:, 2 ) - drhoy(:,:,  1  ) ) - 0.5_wp * drhov(:,:,  2  )
603
604      drhow(:,:,jpk) = 1.5_wp * ( drhoz(:,:,jpk) - drhoz(:,:,jpkm1) ) - 0.5_wp * drhow(:,:,jpkm1)
605      drhou(:,:,jpk) = 1.5_wp * ( drhox(:,:,jpk) - drhox(:,:,jpkm1) ) - 0.5_wp * drhou(:,:,jpkm1)
606      drhov(:,:,jpk) = 1.5_wp * ( drhoy(:,:,jpk) - drhoy(:,:,jpkm1) ) - 0.5_wp * drhov(:,:,jpkm1)
607
608
609      !--------------------------------------------------------------
610      ! Upper half of top-most grid box, compute and store
611      !-------------------------------------------------------------
612
613!!bug gm   :  e3w-de3w = 0.5*e3w  ....  and de3w(2)-de3w(1)=e3w(2) ....   to be verified
614!          true if de3w is really defined as the sum of the e3w scale factors as, it seems to me, it should be
615
616      DO jj = 2, jpjm1
617         DO ji = fs_2, fs_jpim1   ! vector opt.
618            rho_k(ji,jj,1) = -grav * ( fse3w(ji,jj,1) - fsde3w(ji,jj,1) )               &
619               &                   * (  rhd(ji,jj,1)                                    &
620               &                     + 0.5_wp * ( rhd(ji,jj,2) - rhd(ji,jj,1) )         &
621               &                              * ( fse3w (ji,jj,1) - fsde3w(ji,jj,1) )   &
622               &                              / ( fsde3w(ji,jj,2) - fsde3w(ji,jj,1) )  )
623         END DO
624      END DO
625
626!!bug gm    : here also, simplification is possible
627!!bug gm    : optimisation: 1/10 and 1/12 the division should be done before the loop
628
629      DO jk = 2, jpkm1
630         DO jj = 2, jpjm1
631            DO ji = fs_2, fs_jpim1   ! vector opt.
632
633               rho_k(ji,jj,jk) = zcoef0 * ( rhd   (ji,jj,jk) + rhd   (ji,jj,jk-1) )                                   &
634                  &                     * ( fsde3w(ji,jj,jk) - fsde3w(ji,jj,jk-1) )                                   &
635                  &            - grav * z1_10 * (                                                                     &
636                  &     ( drhow (ji,jj,jk) - drhow (ji,jj,jk-1) )                                                     &
637                  &   * ( fsde3w(ji,jj,jk) - fsde3w(ji,jj,jk-1) - z1_12 * ( dzw  (ji,jj,jk) + dzw  (ji,jj,jk-1) ) )   &
638                  &   - ( dzw   (ji,jj,jk) - dzw   (ji,jj,jk-1) )                                                     &
639                  &   * ( rhd   (ji,jj,jk) - rhd   (ji,jj,jk-1) - z1_12 * ( drhow(ji,jj,jk) + drhow(ji,jj,jk-1) ) )   &
640                  &                             )
641
642               rho_i(ji,jj,jk) = zcoef0 * ( rhd   (ji+1,jj,jk) + rhd   (ji,jj,jk) )                                   &
643                  &                     * ( fsde3w(ji+1,jj,jk) - fsde3w(ji,jj,jk) )                                   &
644                  &            - grav* z1_10 * (                                                                      &
645                  &     ( drhou (ji+1,jj,jk) - drhou (ji,jj,jk) )                                                     &
646                  &   * ( fsde3w(ji+1,jj,jk) - fsde3w(ji,jj,jk) - z1_12 * ( dzu  (ji+1,jj,jk) + dzu  (ji,jj,jk) ) )   &
647                  &   - ( dzu   (ji+1,jj,jk) - dzu   (ji,jj,jk) )                                                     &
648                  &   * ( rhd   (ji+1,jj,jk) - rhd   (ji,jj,jk) - z1_12 * ( drhou(ji+1,jj,jk) + drhou(ji,jj,jk) ) )   &
649                  &                            )
650
651               rho_j(ji,jj,jk) = zcoef0 * ( rhd   (ji,jj+1,jk) + rhd   (ji,jj,jk) )                                   &
652                  &                     * ( fsde3w(ji,jj+1,jk) - fsde3w(ji,jj,jk) )                                   &
653                  &            - grav* z1_10 * (                                                                      &
654                  &     ( drhov (ji,jj+1,jk) - drhov (ji,jj,jk) )                                                     &
655                  &   * ( fsde3w(ji,jj+1,jk) - fsde3w(ji,jj,jk) - z1_12 * ( dzv  (ji,jj+1,jk) + dzv  (ji,jj,jk) ) )   &
656                  &   - ( dzv   (ji,jj+1,jk) - dzv   (ji,jj,jk) )                                                     &
657                  &   * ( rhd   (ji,jj+1,jk) - rhd   (ji,jj,jk) - z1_12 * ( drhov(ji,jj+1,jk) + drhov(ji,jj,jk) ) )   &
658                  &                            )
659
660            END DO
661         END DO
662      END DO
663      CALL lbc_lnk(rho_k,'W',1.)
664      CALL lbc_lnk(rho_i,'U',1.)
665      CALL lbc_lnk(rho_j,'V',1.)
666
667
668      ! ---------------
669      !  Surface value
670      ! ---------------
671      DO jj = 2, jpjm1
672         DO ji = fs_2, fs_jpim1   ! vector opt.
673            zhpi(ji,jj,1) = ( rho_k(ji+1,jj  ,1) - rho_k(ji,jj,1) - rho_i(ji,jj,1) ) / e1u(ji,jj)
674            zhpj(ji,jj,1) = ( rho_k(ji  ,jj+1,1) - rho_k(ji,jj,1) - rho_j(ji,jj,1) ) / e2v(ji,jj)
675            ! add to the general momentum trend
676            ua(ji,jj,1) = ua(ji,jj,1) + zhpi(ji,jj,1)
677            va(ji,jj,1) = va(ji,jj,1) + zhpj(ji,jj,1)
678         END DO
679      END DO
680
681      ! ----------------
682      !  interior value   (2=<jk=<jpkm1)
683      ! ----------------
684      DO jk = 2, jpkm1
685         DO jj = 2, jpjm1
686            DO ji = fs_2, fs_jpim1   ! vector opt.
687               ! hydrostatic pressure gradient along s-surfaces
688               zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1)                                &
689                  &           + (  ( rho_k(ji+1,jj,jk) - rho_k(ji,jj,jk  ) )    &
690                  &              - ( rho_i(ji  ,jj,jk) - rho_i(ji,jj,jk-1) )  ) / e1u(ji,jj)
691               zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1)                                &
692                  &           + (  ( rho_k(ji,jj+1,jk) - rho_k(ji,jj,jk  ) )    &
693                  &               -( rho_j(ji,jj  ,jk) - rho_j(ji,jj,jk-1) )  ) / e2v(ji,jj)
694               ! add to the general momentum trend
695               ua(ji,jj,jk) = ua(ji,jj,jk) + zhpi(ji,jj,jk)
696               va(ji,jj,jk) = va(ji,jj,jk) + zhpj(ji,jj,jk)
697            END DO
698         END DO
699      END DO
700      !
701      CALL wrk_dealloc( jpi, jpj, jpk, dzx  , dzy  , dzz  , dzu  , dzv  , dzw   )
702      CALL wrk_dealloc( jpi, jpj, jpk, drhox, drhoy, drhoz, drhou, drhov, drhow )
703      CALL wrk_dealloc( jpi, jpj, jpk, rho_i, rho_j, rho_k,  zhpi,  zhpj        )
704      !
705   END SUBROUTINE hpg_djc
706
707
708   SUBROUTINE hpg_prj( kt )
709      !!---------------------------------------------------------------------
710      !!                  ***  ROUTINE hpg_prj  ***
711      !!
712      !! ** Method  :   s-coordinate case.
713      !!      A Pressure-Jacobian horizontal pressure gradient method
714      !!      based on the constrained cubic-spline interpolation for
715      !!      all vertical coordinate systems
716      !!
717      !! ** Action : - Update (ua,va) with the now hydrastatic pressure trend
718      !!             - Save the trend (l_trddyn=T)
719      !!
720      !!----------------------------------------------------------------------
721      INTEGER, PARAMETER  :: polynomial_type = 1    ! 1: cubic spline, 2: linear
722      INTEGER, INTENT(in) ::   kt                   ! ocean time-step index
723      !!
724      INTEGER  ::   ji, jj, jk, jkk                 ! dummy loop indices
725      REAL(wp) ::   zcoef0, znad                    ! temporary scalars
726      !!
727      !! The local variables for the correction term
728      INTEGER  :: jk1, jis, jid, jjs, jjd
729      REAL(wp) :: zuijk, zvijk, zpwes, zpwed, zpnss, zpnsd, zdeps
730      REAL(wp) :: zrhdt1
731      REAL(wp) :: zdpdx1, zdpdx2, zdpdy1, zdpdy2
732      REAL(wp), POINTER, DIMENSION(:,:,:) ::   zdept, zrhh
733      REAL(wp), POINTER, DIMENSION(:,:,:) ::   zhpi, zu, zv, fsp, xsp, asp, bsp, csp, dsp
734      !!----------------------------------------------------------------------
735      !
736      CALL wrk_alloc( jpi,jpj,jpk, zhpi, zu, zv, fsp, xsp, asp, bsp, csp, dsp )
737      CALL wrk_alloc( jpi,jpj,jpk, zdept, zrhh )
738      !
739      IF( kt == nit000 ) THEN
740         IF(lwp) WRITE(numout,*)
741         IF(lwp) WRITE(numout,*) 'dyn:hpg_prj : hydrostatic pressure gradient trend'
742         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   s-coordinate case, cubic spline pressure Jacobian'
743      ENDIF
744
745      !!----------------------------------------------------------------------
746      ! Local constant initialization
747      zcoef0 = - grav
748      znad = 0.0_wp
749      IF( lk_vvl ) znad = 1._wp
750
751      ! Clean 3-D work arrays
752      zhpi(:,:,:) = 0._wp
753      zrhh(:,:,:) = rhd(:,:,:)
754
755      ! Preparing vertical density profile "zrhh(:,:,:)" for hybrid-sco coordinate
756      DO jj = 1, jpj
757        DO ji = 1, jpi
758          jk = mbathy(ji,jj)
759          IF( jk <= 0 ) THEN; zrhh(ji,jj,:) = 0._wp
760          ELSE IF(jk == 1) THEN; zrhh(ji,jj, jk+1:jpk) = rhd(ji,jj,jk)
761          ELSE IF(jk < jpkm1) THEN
762             DO jkk = jk+1, jpk
763                zrhh(ji,jj,jkk) = interp1(fsde3w(ji,jj,jkk),   fsde3w(ji,jj,jkk-1), &
764                                         fsde3w(ji,jj,jkk-2), rhd(ji,jj,jkk-1), rhd(ji,jj,jkk-2))
765             END DO
766          ENDIF
767        END DO
768      END DO
769
770      ! Transfer the depth of "T(:,:,:)" to vertical coordinate "zdept(:,:,:)"
771      DO jj = 1, jpj;   DO ji = 1, jpi
772          zdept(ji,jj,1) = 0.5_wp * fse3w(ji,jj,1) - sshn(ji,jj) * znad
773      END DO        ;   END DO
774
775      DO jk = 2, jpk;   DO jj = 1, jpj;   DO ji = 1, jpi
776          zdept(ji,jj,jk) = zdept(ji,jj,jk-1) + fse3w(ji,jj,jk)
777      END DO        ;   END DO        ;   END DO
778
779      fsp(:,:,:) = zrhh(:,:,:)
780      xsp(:,:,:) = zdept(:,:,:)
781
782      ! Construct the vertical density profile with the
783      ! constrained cubic spline interpolation
784      ! rho(z) = asp + bsp*z + csp*z^2 + dsp*z^3
785      CALL cspline(fsp,xsp,asp,bsp,csp,dsp,polynomial_type)
786
787      ! Integrate the hydrostatic pressure "zhpi(:,:,:)" at "T(ji,jj,1)"
788      DO jj = 2, jpj
789        DO ji = 2, jpi
790          zrhdt1 = zrhh(ji,jj,1) - interp3(zdept(ji,jj,1),asp(ji,jj,1), &
791                                         bsp(ji,jj,1),   csp(ji,jj,1), &
792                                         dsp(ji,jj,1) ) * 0.25_wp * fse3w(ji,jj,1)
793
794          ! assuming linear profile across the top half surface layer
795          zhpi(ji,jj,1) =  0.5_wp * fse3w(ji,jj,1) * zrhdt1
796        END DO
797      END DO
798
799      ! Calculate the pressure "zhpi(:,:,:)" at "T(ji,jj,2:jpkm1)"
800      DO jk = 2, jpkm1
801        DO jj = 2, jpj
802          DO ji = 2, jpi
803            zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1) +                          &
804                             integ_spline(zdept(ji,jj,jk-1), zdept(ji,jj,jk),&
805                                    asp(ji,jj,jk-1),    bsp(ji,jj,jk-1), &
806                                    csp(ji,jj,jk-1),    dsp(ji,jj,jk-1))
807          END DO
808        END DO
809      END DO
810
811      ! Z coordinate of U(ji,jj,1:jpkm1) and V(ji,jj,1:jpkm1)
812      DO jj = 2, jpjm1
813        DO ji = 2, jpim1
814          zu(ji,jj,1) = - ( fse3u(ji,jj,1) - sshn(ji,jj) * znad)    ! probable bug: changed from sshu_n for ztilde compilation
815          zv(ji,jj,1) = - ( fse3v(ji,jj,1) - sshn(ji,jj) * znad)    ! probable bug: changed from sshv_n for ztilde compilation
816        END DO
817      END DO
818
819      DO jk = 2, jpkm1
820        DO jj = 2, jpjm1
821          DO ji = 2, jpim1
822            zu(ji,jj,jk) = zu(ji,jj,jk-1)- fse3u(ji,jj,jk)
823            zv(ji,jj,jk) = zv(ji,jj,jk-1)- fse3v(ji,jj,jk)
824          END DO
825        END DO
826      END DO
827
828      DO jk = 1, jpkm1
829        DO jj = 2, jpjm1
830          DO ji = 2, jpim1
831            zu(ji,jj,jk) = zu(ji,jj,jk) + 0.5_wp * fse3u(ji,jj,jk)
832            zv(ji,jj,jk) = zv(ji,jj,jk) + 0.5_wp * fse3v(ji,jj,jk)
833          END DO
834        END DO
835      END DO
836
837      DO jk = 1, jpkm1
838        DO jj = 2, jpjm1
839          DO ji = 2, jpim1
840            zu(ji,jj,jk) = min(zu(ji,jj,jk), max(-zdept(ji,jj,jk), -zdept(ji+1,jj,jk)))
841            zu(ji,jj,jk) = max(zu(ji,jj,jk), min(-zdept(ji,jj,jk), -zdept(ji+1,jj,jk)))
842            zv(ji,jj,jk) = min(zv(ji,jj,jk), max(-zdept(ji,jj,jk), -zdept(ji,jj+1,jk)))
843            zv(ji,jj,jk) = max(zv(ji,jj,jk), min(-zdept(ji,jj,jk), -zdept(ji,jj+1,jk)))
844          END DO
845        END DO
846      END DO
847
848
849      DO jk = 1, jpkm1
850        DO jj = 2, jpjm1
851          DO ji = 2, jpim1
852            zpwes = 0._wp; zpwed = 0._wp
853            zpnss = 0._wp; zpnsd = 0._wp
854            zuijk = zu(ji,jj,jk)
855            zvijk = zv(ji,jj,jk)
856
857            !!!!!     for u equation
858            IF( jk <= mbku(ji,jj) ) THEN
859               IF( -zdept(ji+1,jj,jk) >= -zdept(ji,jj,jk) ) THEN
860                 jis = ji + 1; jid = ji
861               ELSE
862                 jis = ji;     jid = ji +1
863               ENDIF
864
865               ! integrate the pressure on the shallow side
866               jk1 = jk
867               DO WHILE ( -zdept(jis,jj,jk1) > zuijk )
868                 IF( jk1 == mbku(ji,jj) ) THEN
869                   zuijk = -zdept(jis,jj,jk1)
870                   EXIT
871                 ENDIF
872                 zdeps = MIN(zdept(jis,jj,jk1+1), -zuijk)
873                 zpwes = zpwes +                                    &
874                      integ_spline(zdept(jis,jj,jk1), zdeps,            &
875                             asp(jis,jj,jk1),    bsp(jis,jj,jk1), &
876                             csp(jis,jj,jk1),    dsp(jis,jj,jk1))
877                 jk1 = jk1 + 1
878               END DO
879
880               ! integrate the pressure on the deep side
881               jk1 = jk
882               DO WHILE ( -zdept(jid,jj,jk1) < zuijk )
883                 IF( jk1 == 1 ) THEN
884                   zdeps = zdept(jid,jj,1) + MIN(zuijk, sshn(jid,jj)*znad)
885                   zrhdt1 = zrhh(jid,jj,1) - interp3(zdept(jid,jj,1), asp(jid,jj,1), &
886                                                     bsp(jid,jj,1),   csp(jid,jj,1), &
887                                                     dsp(jid,jj,1)) * zdeps
888                   zpwed  = zpwed + 0.5_wp * (zrhh(jid,jj,1) + zrhdt1) * zdeps
889                   EXIT
890                 ENDIF
891                 zdeps = MAX(zdept(jid,jj,jk1-1), -zuijk)
892                 zpwed = zpwed +                                        &
893                        integ_spline(zdeps,              zdept(jid,jj,jk1), &
894                               asp(jid,jj,jk1-1), bsp(jid,jj,jk1-1),  &
895                               csp(jid,jj,jk1-1), dsp(jid,jj,jk1-1) )
896                 jk1 = jk1 - 1
897               END DO
898
899               ! update the momentum trends in u direction
900
901               zdpdx1 = zcoef0 / e1u(ji,jj) * (zhpi(ji+1,jj,jk) - zhpi(ji,jj,jk))
902               IF( lk_vvl ) THEN
903                 zdpdx2 = zcoef0 / e1u(ji,jj) * &
904                         ( REAL(jis-jid, wp) * (zpwes + zpwed) + (sshn(ji+1,jj)-sshn(ji,jj)) )
905                ELSE
906                 zdpdx2 = zcoef0 / e1u(ji,jj) * REAL(jis-jid, wp) * (zpwes + zpwed)
907               ENDIF
908
909               ua(ji,jj,jk) = ua(ji,jj,jk) + (zdpdx1 + zdpdx2) * &
910               &           umask(ji,jj,jk) * tmask(ji,jj,jk) * tmask(ji+1,jj,jk)
911            ENDIF
912
913            !!!!!     for v equation
914            IF( jk <= mbkv(ji,jj) ) THEN
915               IF( -zdept(ji,jj+1,jk) >= -zdept(ji,jj,jk) ) THEN
916                 jjs = jj + 1; jjd = jj
917               ELSE
918                 jjs = jj    ; jjd = jj + 1
919               ENDIF
920
921               ! integrate the pressure on the shallow side
922               jk1 = jk
923               DO WHILE ( -zdept(ji,jjs,jk1) > zvijk )
924                 IF( jk1 == mbkv(ji,jj) ) THEN
925                   zvijk = -zdept(ji,jjs,jk1)
926                   EXIT
927                 ENDIF
928                 zdeps = MIN(zdept(ji,jjs,jk1+1), -zvijk)
929                 zpnss = zpnss +                                      &
930                        integ_spline(zdept(ji,jjs,jk1), zdeps,            &
931                               asp(ji,jjs,jk1),    bsp(ji,jjs,jk1), &
932                               csp(ji,jjs,jk1),    dsp(ji,jjs,jk1) )
933                 jk1 = jk1 + 1
934               END DO
935
936               ! integrate the pressure on the deep side
937               jk1 = jk
938               DO WHILE ( -zdept(ji,jjd,jk1) < zvijk )
939                 IF( jk1 == 1 ) THEN
940                   zdeps = zdept(ji,jjd,1) + MIN(zvijk, sshn(ji,jjd)*znad)
941                   zrhdt1 = zrhh(ji,jjd,1) - interp3(zdept(ji,jjd,1), asp(ji,jjd,1), &
942                                                     bsp(ji,jjd,1),   csp(ji,jjd,1), &
943                                                     dsp(ji,jjd,1) ) * zdeps
944                   zpnsd  = zpnsd + 0.5_wp * (zrhh(ji,jjd,1) + zrhdt1) * zdeps
945                   EXIT
946                 ENDIF
947                 zdeps = MAX(zdept(ji,jjd,jk1-1), -zvijk)
948                 zpnsd = zpnsd +                                        &
949                        integ_spline(zdeps,              zdept(ji,jjd,jk1), &
950                               asp(ji,jjd,jk1-1), bsp(ji,jjd,jk1-1), &
951                               csp(ji,jjd,jk1-1), dsp(ji,jjd,jk1-1) )
952                 jk1 = jk1 - 1
953               END DO
954
955
956               ! update the momentum trends in v direction
957
958               zdpdy1 = zcoef0 / e2v(ji,jj) * (zhpi(ji,jj+1,jk) - zhpi(ji,jj,jk))
959               IF( lk_vvl ) THEN
960                   zdpdy2 = zcoef0 / e2v(ji,jj) * &
961                           ( REAL(jjs-jjd, wp) * (zpnss + zpnsd) + (sshn(ji,jj+1)-sshn(ji,jj)) )
962               ELSE
963                   zdpdy2 = zcoef0 / e2v(ji,jj) * REAL(jjs-jjd, wp) * (zpnss + zpnsd )
964               ENDIF
965
966               va(ji,jj,jk) = va(ji,jj,jk) + (zdpdy1 + zdpdy2)*&
967               &              vmask(ji,jj,jk)*tmask(ji,jj,jk)*tmask(ji,jj+1,jk)
968            ENDIF
969
970
971           END DO
972        END DO
973      END DO
974      !
975      CALL wrk_dealloc( jpi,jpj,jpk, zhpi, zu, zv, fsp, xsp, asp, bsp, csp, dsp )
976      CALL wrk_dealloc( jpi,jpj,jpk, zdept, zrhh )
977      !
978   END SUBROUTINE hpg_prj
979
980   SUBROUTINE cspline(fsp, xsp, asp, bsp, csp, dsp, polynomial_type)
981      !!----------------------------------------------------------------------
982      !!                 ***  ROUTINE cspline  ***
983      !!
984      !! ** Purpose :   constrained cubic spline interpolation
985      !!
986      !! ** Method  :   f(x) = asp + bsp*x + csp*x^2 + dsp*x^3
987      !! Reference: CJC Kruger, Constrained Cubic Spline Interpoltation
988      !!
989      !!----------------------------------------------------------------------
990      IMPLICIT NONE
991      REAL(wp), DIMENSION(:,:,:), INTENT(in)  :: fsp, xsp           ! value and coordinate
992      REAL(wp), DIMENSION(:,:,:), INTENT(out) :: asp, bsp, csp, dsp ! coefficients of
993                                                                    ! the interpoated function
994      INTEGER, INTENT(in) :: polynomial_type                        ! 1: cubic spline
995                                                                    ! 2: Linear
996
997      ! Local Variables
998      INTEGER  ::   ji, jj, jk                 ! dummy loop indices
999      INTEGER  ::   jpi, jpj, jpkm1
1000      REAL(wp) ::   zdf1, zdf2, zddf1, zddf2, ztmp1, ztmp2, zdxtmp
1001      REAL(wp) ::   zdxtmp1, zdxtmp2, zalpha
1002      REAL(wp) ::   zdf(size(fsp,3))
1003      !!----------------------------------------------------------------------
1004
1005      jpi   = size(fsp,1)
1006      jpj   = size(fsp,2)
1007      jpkm1 = size(fsp,3) - 1
1008
1009
1010      IF (polynomial_type == 1) THEN     ! Constrained Cubic Spline
1011         DO ji = 1, jpi
1012            DO jj = 1, jpj
1013           !!Fritsch&Butland's method, 1984 (preferred, but more computation)
1014           !    DO jk = 2, jpkm1-1
1015           !       zdxtmp1 = xsp(ji,jj,jk)   - xsp(ji,jj,jk-1)
1016           !       zdxtmp2 = xsp(ji,jj,jk+1) - xsp(ji,jj,jk)
1017           !       zdf1    = ( fsp(ji,jj,jk)   - fsp(ji,jj,jk-1) ) / zdxtmp1
1018           !       zdf2    = ( fsp(ji,jj,jk+1) - fsp(ji,jj,jk)   ) / zdxtmp2
1019           !
1020           !       zalpha = ( zdxtmp1 + 2._wp * zdxtmp2 ) / ( zdxtmp1 + zdxtmp2 ) / 3._wp
1021           !
1022           !       IF(zdf1 * zdf2 <= 0._wp) THEN
1023           !           zdf(jk) = 0._wp
1024           !       ELSE
1025           !         zdf(jk) = zdf1 * zdf2 / ( ( 1._wp - zalpha ) * zdf1 + zalpha * zdf2 )
1026           !       ENDIF
1027           !    END DO
1028
1029           !!Simply geometric average
1030               DO jk = 2, jpkm1-1
1031                  zdf1 = (fsp(ji,jj,jk) - fsp(ji,jj,jk-1)) / (xsp(ji,jj,jk) - xsp(ji,jj,jk-1))
1032                  zdf2 = (fsp(ji,jj,jk+1) - fsp(ji,jj,jk)) / (xsp(ji,jj,jk+1) - xsp(ji,jj,jk))
1033
1034                  IF(zdf1 * zdf2 <= 0._wp) THEN
1035                     zdf(jk) = 0._wp
1036                  ELSE
1037                     zdf(jk) = 2._wp * zdf1 * zdf2 / (zdf1 + zdf2)
1038                  ENDIF
1039               END DO
1040
1041               zdf(1)     = 1.5_wp * ( fsp(ji,jj,2) - fsp(ji,jj,1) ) / &
1042                          &          ( xsp(ji,jj,2) - xsp(ji,jj,1) ) -  0.5_wp * zdf(2)
1043               zdf(jpkm1) = 1.5_wp * ( fsp(ji,jj,jpkm1) - fsp(ji,jj,jpkm1-1) ) / &
1044                          &          ( xsp(ji,jj,jpkm1) - xsp(ji,jj,jpkm1-1) ) - &
1045                          & 0.5_wp * zdf(jpkm1 - 1)
1046
1047               DO jk = 1, jpkm1 - 1
1048                 zdxtmp = xsp(ji,jj,jk+1) - xsp(ji,jj,jk)
1049                 ztmp1  = (zdf(jk+1) + 2._wp * zdf(jk)) / zdxtmp
1050                 ztmp2  =  6._wp * (fsp(ji,jj,jk+1) - fsp(ji,jj,jk)) / zdxtmp / zdxtmp
1051                 zddf1  = -2._wp * ztmp1 + ztmp2
1052                 ztmp1  = (2._wp * zdf(jk+1) + zdf(jk)) / zdxtmp
1053                 zddf2  =  2._wp * ztmp1 - ztmp2
1054
1055                 dsp(ji,jj,jk) = (zddf2 - zddf1) / 6._wp / zdxtmp
1056                 csp(ji,jj,jk) = ( xsp(ji,jj,jk+1) * zddf1 - xsp(ji,jj,jk)*zddf2 ) / 2._wp / zdxtmp
1057                 bsp(ji,jj,jk) = ( fsp(ji,jj,jk+1) - fsp(ji,jj,jk) ) / zdxtmp - &
1058                               & csp(ji,jj,jk) * ( xsp(ji,jj,jk+1) + xsp(ji,jj,jk) ) - &
1059                               & dsp(ji,jj,jk) * ((xsp(ji,jj,jk+1) + xsp(ji,jj,jk))**2 - &
1060                               &                   xsp(ji,jj,jk+1) * xsp(ji,jj,jk))
1061                 asp(ji,jj,jk) = fsp(ji,jj,jk) - xsp(ji,jj,jk) * (bsp(ji,jj,jk) + &
1062                               &                (xsp(ji,jj,jk) * (csp(ji,jj,jk) + &
1063                               &                 dsp(ji,jj,jk) * xsp(ji,jj,jk))))
1064               END DO
1065            END DO
1066         END DO
1067
1068      ELSE IF (polynomial_type == 2) THEN     ! Linear
1069         DO ji = 1, jpi
1070            DO jj = 1, jpj
1071               DO jk = 1, jpkm1-1
1072                  zdxtmp =xsp(ji,jj,jk+1) - xsp(ji,jj,jk)
1073                  ztmp1 = fsp(ji,jj,jk+1) - fsp(ji,jj,jk)
1074
1075                  dsp(ji,jj,jk) = 0._wp
1076                  csp(ji,jj,jk) = 0._wp
1077                  bsp(ji,jj,jk) = ztmp1 / zdxtmp
1078                  asp(ji,jj,jk) = fsp(ji,jj,jk) - bsp(ji,jj,jk) * xsp(ji,jj,jk)
1079               END DO
1080            END DO
1081         END DO
1082
1083      ELSE
1084           CALL ctl_stop( 'invalid polynomial type in cspline' )
1085      ENDIF
1086
1087
1088   END SUBROUTINE cspline
1089
1090
1091   FUNCTION interp1(x, xl, xr, fl, fr)  RESULT(f)
1092      !!----------------------------------------------------------------------
1093      !!                 ***  ROUTINE interp1  ***
1094      !!
1095      !! ** Purpose :   1-d linear interpolation
1096      !!
1097      !! ** Method  :
1098      !!                interpolation is straight forward
1099      !!                extrapolation is also permitted (no value limit)
1100      !!
1101      !!----------------------------------------------------------------------
1102      IMPLICIT NONE
1103      REAL(wp), INTENT(in) ::  x, xl, xr, fl, fr
1104      REAL(wp)             ::  f ! result of the interpolation (extrapolation)
1105      REAL(wp)             ::  zdeltx
1106      !!----------------------------------------------------------------------
1107
1108      zdeltx = xr - xl
1109      IF(abs(zdeltx) <= 10._wp * EPSILON(x)) THEN
1110        f = 0.5_wp * (fl + fr)
1111      ELSE
1112        f = ( (x - xl ) * fr - ( x - xr ) * fl ) / zdeltx
1113      ENDIF
1114
1115   END FUNCTION interp1
1116
1117   FUNCTION interp2(x, a, b, c, d)  RESULT(f)
1118      !!----------------------------------------------------------------------
1119      !!                 ***  ROUTINE interp1  ***
1120      !!
1121      !! ** Purpose :   1-d constrained cubic spline interpolation
1122      !!
1123      !! ** Method  :  cubic spline interpolation
1124      !!
1125      !!----------------------------------------------------------------------
1126      IMPLICIT NONE
1127      REAL(wp), INTENT(in) ::  x, a, b, c, d
1128      REAL(wp)             ::  f ! value from the interpolation
1129      !!----------------------------------------------------------------------
1130
1131      f = a + x* ( b + x * ( c + d * x ) )
1132
1133   END FUNCTION interp2
1134
1135
1136   FUNCTION interp3(x, a, b, c, d)  RESULT(f)
1137      !!----------------------------------------------------------------------
1138      !!                 ***  ROUTINE interp1  ***
1139      !!
1140      !! ** Purpose :   Calculate the first order of deriavtive of
1141      !!                a cubic spline function y=a+b*x+c*x^2+d*x^3
1142      !!
1143      !! ** Method  :   f=dy/dx=b+2*c*x+3*d*x^2
1144      !!
1145      !!----------------------------------------------------------------------
1146      IMPLICIT NONE
1147      REAL(wp), INTENT(in) ::  x, a, b, c, d
1148      REAL(wp)             ::  f ! value from the interpolation
1149      !!----------------------------------------------------------------------
1150
1151      f = b + x * ( 2._wp * c + 3._wp * d * x)
1152
1153   END FUNCTION interp3
1154
1155
1156   FUNCTION integ_spline(xl, xr, a, b, c, d)  RESULT(f)
1157      !!----------------------------------------------------------------------
1158      !!                 ***  ROUTINE interp1  ***
1159      !!
1160      !! ** Purpose :   1-d constrained cubic spline integration
1161      !!
1162      !! ** Method  :  integrate polynomial a+bx+cx^2+dx^3 from xl to xr
1163      !!
1164      !!----------------------------------------------------------------------
1165      IMPLICIT NONE
1166      REAL(wp), INTENT(in) ::  xl, xr, a, b, c, d
1167      REAL(wp)             ::  za1, za2, za3
1168      REAL(wp)             ::  f                   ! integration result
1169      !!----------------------------------------------------------------------
1170
1171      za1 = 0.5_wp * b
1172      za2 = c / 3.0_wp
1173      za3 = 0.25_wp * d
1174
1175      f  = xr * ( a + xr * ( za1 + xr * ( za2 + za3 * xr ) ) ) - &
1176         & xl * ( a + xl * ( za1 + xl * ( za2 + za3 * xl ) ) )
1177
1178   END FUNCTION integ_spline
1179
1180
1181   !!======================================================================
1182END MODULE dynhpg
1183
Note: See TracBrowser for help on using the repository browser.