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

source: branches/2014/dev_r4650_UKMO2_ice_shelves/NEMOGCM/NEMO/OPA_SRC/DYN/dynhpg.F90 @ 4666

Last change on this file since 4666 was 4666, checked in by mathiot, 10 years ago

#1331 : add ISOMIP config files + ice shelf code
  • Property svn:keywords set to Id
File size: 62.0 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 eosbn2          ! compute density
40   USE wrk_nemo        ! Memory Allocation
41   USE timing          ! Timing
42
43   IMPLICIT NONE
44   PRIVATE
45
46   PUBLIC   dyn_hpg        ! routine called by step module
47   PUBLIC   dyn_hpg_init   ! routine called by opa module
48
49   !                                    !!* Namelist namdyn_hpg : hydrostatic pressure gradient
50   LOGICAL , PUBLIC ::   ln_hpg_zco      !: z-coordinate - full steps
51   LOGICAL , PUBLIC ::   ln_hpg_zps      !: z-coordinate - partial steps (interpolation)
52   LOGICAL , PUBLIC ::   ln_hpg_sco      !: s-coordinate (standard jacobian formulation)
53   LOGICAL , PUBLIC ::   ln_hpg_djc      !: s-coordinate (Density Jacobian with Cubic polynomial)
54   LOGICAL , PUBLIC ::   ln_hpg_prj      !: s-coordinate (Pressure Jacobian scheme)
55   LOGICAL , PUBLIC ::   ln_dynhpg_imp   !: semi-implicite hpg flag
56
57   INTEGER , PUBLIC ::   nhpg  =  0   ! = 0 to 7, type of pressure gradient scheme used ! (deduced from ln_hpg_... flags) (PUBLIC for TAM)
58
59   !! * Substitutions
60#  include "domzgr_substitute.h90"
61#  include "vectopt_loop_substitute.h90"
62   !!----------------------------------------------------------------------
63   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
64   !! $Id$
65   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
66   !!----------------------------------------------------------------------
67CONTAINS
68
69   SUBROUTINE dyn_hpg( kt )
70      !!---------------------------------------------------------------------
71      !!                  ***  ROUTINE dyn_hpg  ***
72      !!
73      !! ** Method  :   Call the hydrostatic pressure gradient routine
74      !!              using the scheme defined in the namelist
75      !!
76      !! ** Action : - Update (ua,va) with the now hydrastatic pressure trend
77      !!             - Save the trend (l_trddyn=T)
78      !!----------------------------------------------------------------------
79      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
80      REAL(wp), POINTER, DIMENSION(:,:,:) ::  ztrdu, ztrdv
81      !!----------------------------------------------------------------------
82      !
83      IF( nn_timing == 1 )  CALL timing_start('dyn_hpg')
84      !
85      IF( l_trddyn ) THEN                    ! Temporary saving of ua and va trends (l_trddyn)
86         CALL wrk_alloc( jpi,jpj,jpk, ztrdu, ztrdv )
87         ztrdu(:,:,:) = ua(:,:,:)
88         ztrdv(:,:,:) = va(:,:,:)
89      ENDIF
90      !
91      SELECT CASE ( nhpg )      ! Hydrostatic pressure gradient computation
92      CASE (  0 )   ;   CALL hpg_zco    ( kt )      ! z-coordinate
93      CASE (  1 )   ;   CALL hpg_zps    ( kt )      ! z-coordinate plus partial steps (interpolation)
94      CASE (  2 )   ;   CALL hpg_sco    ( kt )      ! s-coordinate (standard jacobian formulation)
95      CASE (  3 )   ;   CALL hpg_djc    ( kt )      ! s-coordinate (Density Jacobian with Cubic polynomial)
96      CASE (  4 )   ;   CALL hpg_prj    ( kt )      ! s-coordinate (Pressure Jacobian 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         CALL wrk_dealloc( jpi,jpj,jpk, ztrdu, ztrdv )
104      ENDIF
105      !
106      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' hpg  - Ua: ', mask1=umask,   &
107         &                       tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
108      !
109      IF( nn_timing == 1 )  CALL timing_stop('dyn_hpg')
110      !
111   END SUBROUTINE dyn_hpg
112
113
114   SUBROUTINE dyn_hpg_init
115      !!----------------------------------------------------------------------
116      !!                 ***  ROUTINE dyn_hpg_init  ***
117      !!
118      !! ** Purpose :   initializations for the hydrostatic pressure gradient
119      !!              computation and consistency control
120      !!
121      !! ** Action  :   Read the namelist namdyn_hpg and check the consistency
122      !!      with the type of vertical coordinate used (zco, zps, sco)
123      !!----------------------------------------------------------------------
124      INTEGER ::   ioptio = 0      ! temporary integer
125      INTEGER ::   ios             ! Local integer output status for namelist read
126      !!
127      NAMELIST/namdyn_hpg/ ln_hpg_zco, ln_hpg_zps, ln_hpg_sco,     &
128         &                 ln_hpg_djc, ln_hpg_prj, ln_dynhpg_imp
129      !!----------------------------------------------------------------------
130      !
131      REWIND( numnam_ref )              ! Namelist namdyn_hpg in reference namelist : Hydrostatic pressure gradient
132      READ  ( numnam_ref, namdyn_hpg, IOSTAT = ios, ERR = 901)
133901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namdyn_hpg in reference namelist', lwp )
134
135      REWIND( numnam_cfg )              ! Namelist namdyn_hpg in configuration namelist : Hydrostatic pressure gradient
136      READ  ( numnam_cfg, namdyn_hpg, IOSTAT = ios, ERR = 902 )
137902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namdyn_hpg in configuration namelist', lwp )
138      WRITE ( numond, namdyn_hpg )
139      !
140      IF(lwp) THEN                   ! Control print
141         WRITE(numout,*)
142         WRITE(numout,*) 'dyn_hpg_init : hydrostatic pressure gradient initialisation'
143         WRITE(numout,*) '~~~~~~~~~~~~'
144         WRITE(numout,*) '   Namelist namdyn_hpg : choice of hpg scheme'
145         WRITE(numout,*) '      z-coord. - full steps                             ln_hpg_zco    = ', ln_hpg_zco
146         WRITE(numout,*) '      z-coord. - partial steps (interpolation)          ln_hpg_zps    = ', ln_hpg_zps
147         WRITE(numout,*) '      s-coord. (standard jacobian formulation)          ln_hpg_sco    = ', ln_hpg_sco
148         WRITE(numout,*) '      s-coord. (Density Jacobian: Cubic polynomial)     ln_hpg_djc    = ', ln_hpg_djc
149         WRITE(numout,*) '      s-coord. (Pressure Jacobian: Cubic polynomial)    ln_hpg_prj    = ', ln_hpg_prj
150         WRITE(numout,*) '      time stepping: centered (F) or semi-implicit (T)  ln_dynhpg_imp = ', ln_dynhpg_imp
151      ENDIF
152      !
153      IF( ln_hpg_djc )   &
154         &   CALL ctl_stop('dyn_hpg_init : Density Jacobian: Cubic polynominal method &
155                           & currently disabled (bugs under investigation). Please select &
156                           & either  ln_hpg_sco or  ln_hpg_prj instead')
157      !
158      IF( lk_vvl .AND. .NOT. (ln_hpg_sco.OR.ln_hpg_prj) )   &
159         &   CALL ctl_stop('dyn_hpg_init : variable volume key_vvl requires:&
160                           & the standard jacobian formulation hpg_sco or &
161                           & the pressure jacobian formulation hpg_prj')
162      !
163      !                               ! Set nhpg from ln_hpg_... flags
164      IF( ln_hpg_zco )   nhpg = 0
165      IF( ln_hpg_zps )   nhpg = 1
166      IF( ln_hpg_sco )   nhpg = 2
167      IF( ln_hpg_djc )   nhpg = 3
168      IF( ln_hpg_prj )   nhpg = 4
169      !
170      !                               ! Consistency check
171      ioptio = 0
172      IF( ln_hpg_zco )   ioptio = ioptio + 1
173      IF( ln_hpg_zps )   ioptio = ioptio + 1
174      IF( ln_hpg_sco )   ioptio = ioptio + 1
175      IF( ln_hpg_djc )   ioptio = ioptio + 1
176      IF( ln_hpg_prj )   ioptio = ioptio + 1
177      IF( ioptio /= 1 )   CALL ctl_stop( 'NO or several hydrostatic pressure gradient options used' )
178      !
179   END SUBROUTINE dyn_hpg_init
180
181
182   SUBROUTINE hpg_zco( kt )
183      !!---------------------------------------------------------------------
184      !!                  ***  ROUTINE hpg_zco  ***
185      !!
186      !! ** Method  :   z-coordinate case, levels are horizontal surfaces.
187      !!      The now hydrostatic pressure gradient at a given level, jk,
188      !!      is computed by taking the vertical integral of the in-situ
189      !!      density gradient along the model level from the suface to that
190      !!      level:    zhpi = grav .....
191      !!                zhpj = grav .....
192      !!      add it to the general momentum trend (ua,va).
193      !!            ua = ua - 1/e1u * zhpi
194      !!            va = va - 1/e2v * zhpj
195      !!
196      !! ** Action : - Update (ua,va) with the now hydrastatic pressure trend
197      !!----------------------------------------------------------------------
198      INTEGER, INTENT(in) ::   kt    ! ocean time-step index
199      !!
200      INTEGER  ::   ji, jj, jk       ! dummy loop indices
201      REAL(wp) ::   zcoef0, zcoef1   ! temporary scalars
202      REAL(wp), POINTER, DIMENSION(:,:,:) ::  zhpi, zhpj
203      !!----------------------------------------------------------------------
204      !
205      CALL wrk_alloc( jpi,jpj,jpk, zhpi, zhpj )
206      !
207      IF( kt == nit000 ) THEN
208         IF(lwp) WRITE(numout,*)
209         IF(lwp) WRITE(numout,*) 'dyn:hpg_zco : hydrostatic pressure gradient trend'
210         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   z-coordinate case '
211      ENDIF
212
213      zcoef0 = - grav * 0.5_wp      ! Local constant initialization
214
215      ! Surface value
216      DO jj = 2, jpjm1
217         DO ji = fs_2, fs_jpim1   ! vector opt.
218            zcoef1 = zcoef0 * fse3w(ji,jj,1)
219            ! hydrostatic pressure gradient
220            zhpi(ji,jj,1) = zcoef1 * ( rhd(ji+1,jj,1) - rhd(ji,jj,1) ) / e1u(ji,jj)
221            zhpj(ji,jj,1) = zcoef1 * ( rhd(ji,jj+1,1) - rhd(ji,jj,1) ) / e2v(ji,jj)
222            ! add to the general momentum trend
223            ua(ji,jj,1) = ua(ji,jj,1) + zhpi(ji,jj,1)
224            va(ji,jj,1) = va(ji,jj,1) + zhpj(ji,jj,1)
225         END DO
226      END DO
227
228      !
229      ! interior value (2=<jk=<jpkm1)
230      DO jk = 2, jpkm1
231         DO jj = 2, jpjm1
232            DO ji = fs_2, fs_jpim1   ! vector opt.
233               zcoef1 = zcoef0 * fse3w(ji,jj,jk)
234               ! hydrostatic pressure gradient
235               zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1)   &
236                  &           + zcoef1 * (  ( rhd(ji+1,jj,jk)+rhd(ji+1,jj,jk-1) )   &
237                  &                       - ( rhd(ji  ,jj,jk)+rhd(ji  ,jj,jk-1) )  ) / e1u(ji,jj)
238
239               zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1)   &
240                  &           + zcoef1 * (  ( rhd(ji,jj+1,jk)+rhd(ji,jj+1,jk-1) )   &
241                  &                       - ( rhd(ji,jj,  jk)+rhd(ji,jj  ,jk-1) )  ) / e2v(ji,jj)
242               ! add to the general momentum trend
243               ua(ji,jj,jk) = ua(ji,jj,jk) + zhpi(ji,jj,jk)
244               va(ji,jj,jk) = va(ji,jj,jk) + zhpj(ji,jj,jk)
245            END DO
246         END DO
247      END DO
248      !
249      CALL wrk_dealloc( jpi,jpj,jpk, zhpi, zhpj )
250      !
251   END SUBROUTINE hpg_zco
252
253
254   SUBROUTINE hpg_zps( kt )
255      !!---------------------------------------------------------------------
256      !!                 ***  ROUTINE hpg_zps  ***
257      !!
258      !! ** Method  :   z-coordinate plus partial steps case.  blahblah...
259      !!
260      !! ** Action  : - Update (ua,va) with the now hydrastatic pressure trend
261      !!----------------------------------------------------------------------
262      INTEGER, INTENT(in) ::   kt    ! ocean time-step index
263      !!
264      INTEGER  ::   ji, jj, jk                       ! dummy loop indices
265      INTEGER  ::   iku, ikv                         ! temporary integers
266      REAL(wp) ::   zcoef0, zcoef1, zcoef2, zcoef3   ! temporary scalars
267      REAL(wp), POINTER, DIMENSION(:,:,:) ::  zhpi, zhpj
268      !!----------------------------------------------------------------------
269      !
270      CALL wrk_alloc( jpi,jpj,jpk, zhpi, zhpj )
271      !
272      IF( kt == nit000 ) THEN
273         IF(lwp) WRITE(numout,*)
274         IF(lwp) WRITE(numout,*) 'dyn:hpg_zps : hydrostatic pressure gradient trend'
275         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   z-coordinate with partial steps - vector optimization'
276      ENDIF
277
278
279      ! Local constant initialization
280      zcoef0 = - grav * 0.5_wp
281
282      !  Surface value (also valid in partial step case)
283      DO jj = 2, jpjm1
284         DO ji = fs_2, fs_jpim1   ! vector opt.
285            zcoef1 = zcoef0 * fse3w(ji,jj,1)
286            ! hydrostatic pressure gradient
287            zhpi(ji,jj,1) = zcoef1 * ( rhd(ji+1,jj  ,1) - rhd(ji,jj,1) ) / e1u(ji,jj)
288            zhpj(ji,jj,1) = zcoef1 * ( rhd(ji  ,jj+1,1) - rhd(ji,jj,1) ) / e2v(ji,jj)
289            ! add to the general momentum trend
290            ua(ji,jj,1) = ua(ji,jj,1) + zhpi(ji,jj,1)
291            va(ji,jj,1) = va(ji,jj,1) + zhpj(ji,jj,1)
292         END DO
293      END DO
294
295
296      ! interior value (2=<jk=<jpkm1)
297      DO jk = 2, jpkm1
298         DO jj = 2, jpjm1
299            DO ji = fs_2, fs_jpim1   ! vector opt.
300               zcoef1 = zcoef0 * fse3w(ji,jj,jk)
301               ! hydrostatic pressure gradient
302               zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1)   &
303                  &           + zcoef1 * (  ( rhd(ji+1,jj,jk) + rhd(ji+1,jj,jk-1) )   &
304                  &                       - ( rhd(ji  ,jj,jk) + rhd(ji  ,jj,jk-1) )  ) / e1u(ji,jj)
305
306               zhpj(ji,jj,jk) = zhpj(ji,jj,jk-1)   &
307                  &           + zcoef1 * (  ( rhd(ji,jj+1,jk) + rhd(ji,jj+1,jk-1) )   &
308                  &                       - ( rhd(ji,jj,  jk) + rhd(ji,jj  ,jk-1) )  ) / e2v(ji,jj)
309               ! add to the general momentum trend
310               ua(ji,jj,jk) = ua(ji,jj,jk) + zhpi(ji,jj,jk)
311               va(ji,jj,jk) = va(ji,jj,jk) + zhpj(ji,jj,jk)
312            END DO
313         END DO
314      END DO
315
316
317      ! partial steps correction at the last level  (use gru & grv computed in zpshde.F90)
318# if defined key_vectopt_loop
319         jj = 1
320         DO ji = jpi+2, jpij-jpi-1   ! vector opt. (forced unrolling)
321# else
322      DO jj = 2, jpjm1
323         DO ji = 2, jpim1
324# endif
325            iku = mbku(ji,jj)
326            ikv = mbkv(ji,jj)
327            zcoef2 = zcoef0 * MIN( fse3w(ji,jj,iku), fse3w(ji+1,jj  ,iku) )
328            zcoef3 = zcoef0 * MIN( fse3w(ji,jj,ikv), fse3w(ji  ,jj+1,ikv) )
329            IF( iku > 1 ) THEN            ! on i-direction (level 2 or more)
330               ua  (ji,jj,iku) = ua(ji,jj,iku) - zhpi(ji,jj,iku)         ! subtract old value
331               zhpi(ji,jj,iku) = zhpi(ji,jj,iku-1)                   &   ! compute the new one
332                  &            + zcoef2 * ( rhd(ji+1,jj,iku-1) - rhd(ji,jj,iku-1) + gru(ji,jj) ) / e1u(ji,jj)
333               ua  (ji,jj,iku) = ua(ji,jj,iku) + zhpi(ji,jj,iku)         ! add the new one to the general momentum trend
334            ENDIF
335            IF( ikv > 1 ) THEN            ! on j-direction (level 2 or more)
336               va  (ji,jj,ikv) = va(ji,jj,ikv) - zhpj(ji,jj,ikv)         ! subtract old value
337               zhpj(ji,jj,ikv) = zhpj(ji,jj,ikv-1)                   &   ! compute the new one
338                  &            + zcoef3 * ( rhd(ji,jj+1,ikv-1) - rhd(ji,jj,ikv-1) + grv(ji,jj) ) / e2v(ji,jj)
339               va  (ji,jj,ikv) = va(ji,jj,ikv) + zhpj(ji,jj,ikv)         ! add the new one to the general momentum trend
340            ENDIF
341# if ! defined key_vectopt_loop
342         END DO
343# endif
344      END DO
345      !
346      CALL wrk_dealloc( jpi,jpj,jpk, zhpi, zhpj )
347      !
348   END SUBROUTINE hpg_zps
349
350
351   SUBROUTINE hpg_sco( kt )
352      !!---------------------------------------------------------------------
353      !!                  ***  ROUTINE hpg_sco  ***
354      !!
355      !! ** Method  :   s-coordinate case. Jacobian scheme.
356      !!      The now hydrostatic pressure gradient at a given level, jk,
357      !!      is computed by taking the vertical integral of the in-situ
358      !!      density gradient along the model level from the suface to that
359      !!      level. s-coordinates (ln_sco): a corrective term is added
360      !!      to the horizontal pressure gradient :
361      !!         zhpi = grav .....  + 1/e1u mi(rhd) di[ grav dep3w ]
362      !!         zhpj = grav .....  + 1/e2v mj(rhd) dj[ grav dep3w ]
363      !!      add it to the general momentum trend (ua,va).
364      !!         ua = ua - 1/e1u * zhpi
365      !!         va = va - 1/e2v * zhpj
366      !!
367      !! ** Action : - Update (ua,va) with the now hydrastatic pressure trend
368      !!----------------------------------------------------------------------
369      INTEGER, INTENT(in) ::   kt    ! ocean time-step index
370      !!
371      INTEGER  ::   ji, jj, jk, iku, ikv, ikt, iktp1i, iktp1j                 ! dummy loop indices
372      REAL(wp) ::   zcoef0, zuap, zvap, znad, ze3wu, ze3wv, zuapint, zvapint, zhpjint, zhpiint, zdzwt, zdzwtjp1, zdzwtip1             ! temporary scalars
373      REAL(wp), POINTER, DIMENSION(:,:,:)   ::  zhpi, zhpj, zrhd
374      REAL(wp), POINTER, DIMENSION(:,:,:)   ::  ztstop
375      REAL(wp), POINTER, DIMENSION(:,:)     ::  ze3w, zp, zrhdtop_isf, zrhdtop_oce, ziceload, zdept, zpshpi, zpshpj
376      !!----------------------------------------------------------------------
377      !
378      CALL wrk_alloc( jpi,jpj, 2, ztstop) 
379      CALL wrk_alloc( jpi,jpj,jpk, zhpi, zhpj, zrhd)
380      CALL wrk_alloc( jpi,jpj, ze3w, zp, zrhdtop_isf, zrhdtop_oce, ziceload, zdept, zpshpi, zpshpj) 
381      !
382     IF( kt == nit000 ) THEN
383         IF(lwp) WRITE(numout,*)
384         IF(lwp) WRITE(numout,*) 'dyn:hpg_sco : hydrostatic pressure gradient trend'
385         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   s-coordinate case, OPA original scheme used'
386      ENDIF
387
388      ! Local constant initialization
389      zcoef0 = - grav * 0.5_wp
390      ! To use density and not density anomaly
391!      IF ( lk_vvl ) THEN   ;     znad = 1._wp          ! Variable volume
392!      ELSE                 ;     znad = 0._wp         ! Fixed volume
393!      ENDIF
394      znad=1._wp
395      ! iniitialised to 0. zhpi zhpi
396      zhpi(:,:,:)=0._wp ; zhpj(:,:,:)=0._wp
397
398      ztstop(:,:,1)=-1.9_wp ; ztstop(:,:,2)=34.4_wp
399      zrhd = rhd
400      DO jk = 1, jpk
401           zdept(:,:)=gdept_1d(jk)
402           CALL eos(ztstop(:,:,:),zdept(:,:),rhd(:,:,jk))
403      END DO
404      WHERE ( tmask(:,:,:) == 1._wp)
405        rhd(:,:,:) = zrhd(:,:,:)
406      END WHERE
407     
408
409      CALL eos(ztstop,icedep,zrhdtop_isf)
410
411      DO ji=1,jpi
412        DO jj=1,jpj
413          ikt=mikt(ji,jj)
414          ztstop(ji,jj,1)=tsn(ji,jj,ikt,1)
415          ztstop(ji,jj,2)=tsn(ji,jj,ikt,2)
416        END DO
417      END DO
418      CALL eos(ztstop,icedep,zrhdtop_oce)
419      !
420      ! Surface value + ice shelf gradient
421      ! compute pressure (used to compute hpgi/j for all the level from 1 to miku/v)
422      ziceload = 0._wp
423      DO jj = 1, jpj
424         DO ji = 1, jpi   ! vector opt.
425            ikt=mikt(ji,jj)
426            ziceload(ji,jj) = ziceload(ji,jj) + (znad + rhd(ji,jj,1) ) * fse3w(ji,jj,1) * (1._wp - tmask(ji,jj,1))
427            DO jk=2,ikt-1
428               ziceload(ji,jj) = ziceload(ji,jj) + (2._wp * znad + rhd(ji,jj,jk-1) + rhd(ji,jj,jk)) * fse3w(ji,jj,jk) &
429                  &                              * (1._wp - tmask(ji,jj,jk))
430            END DO
431            IF (ikt .GE. 2) ziceload(ji,jj) = ziceload(ji,jj) + (2._wp * znad + zrhdtop_isf(ji,jj) + rhd(ji,jj,ikt-1)) &
432                               &                              * ( fsdepw(ji,jj,ikt) - gdept_1d(ikt-1) )
433         END DO
434      END DO
435      ! compute zp from first level to first wet cell (blue and purple area)
436      DO jj = 2, jpjm1
437         DO ji = fs_2, fs_jpim1   ! vector opt.
438            ikt=mikt(ji,jj) ; iktp1i=mikt(ji+1,jj); iktp1j=mikt(ji,jj+1)
439            ! hydrostatic pressure gradient along s-surfaces and ice shelf pressure
440            ! we assume ISF is in isostatic equilibrium with a density equal to the reference density
441            zhpi(ji,jj,1) = zcoef0 / e1u(ji,jj) * ( 0.5_wp * fse3w(ji+1,jj  ,iktp1i)                                    &
442               &                                  * ( 2._wp * znad + rhd(ji+1,jj  ,iktp1i) + zrhdtop_oce(ji+1,jj  ) )   &
443               &                                  - 0.5_wp * fse3w(ji  ,jj  ,ikt   )                                    &
444               &                                  * ( 2._wp * znad + rhd(ji  ,jj  ,ikt   ) + zrhdtop_oce(ji  ,jj  ) )   &
445               &                                  + ( ziceload(ji+1,jj) - ziceload(ji,jj))                              ) 
446            zhpj(ji,jj,1) = zcoef0 / e2v(ji,jj) * ( 0.5_wp * fse3w(ji  ,jj+1,iktp1j)                                    &
447               &                                  * ( 2._wp * znad + rhd(ji  ,jj+1,iktp1j) + zrhdtop_oce(ji  ,jj+1) )   &
448               &                                  - 0.5_wp * fse3w(ji  ,jj  ,ikt   )                                    & 
449               &                                  * ( 2._wp * znad + rhd(ji  ,jj  ,ikt   ) + zrhdtop_oce(ji  ,jj  ) )   &
450               &                                  + ( ziceload(ji,jj+1) - ziceload(ji,jj) )                             ) 
451            ! s-coordinate pressure gradient correction
452            zuap = -zcoef0 * ( rhd   (ji+1,jj,1) + rhd   (ji,jj,1) + 2._wp * znad )   &
453               &           * ( fsde3w(ji+1,jj,1) - fsde3w(ji,jj,1) ) / e1u(ji,jj)
454            zvap = -zcoef0 * ( rhd   (ji,jj+1,1) + rhd   (ji,jj,1) + 2._wp * znad )   &
455               &           * ( fsde3w(ji,jj+1,1) - fsde3w(ji,jj,1) ) / e2v(ji,jj)
456            ! add to the general momentum trend
457            ua(ji,jj,1) = ua(ji,jj,1) + (zhpi(ji,jj,1) + zuap) * umask(ji,jj,1)
458            va(ji,jj,1) = va(ji,jj,1) + (zhpj(ji,jj,1) + zvap) * vmask(ji,jj,1)
459         END DO
460      END DO
461      !
462      DO jj = 2, jpjm1
463         DO ji = fs_2, fs_jpim1   ! vector opt.
464            iku = miku(ji,jj) ; 
465            zpshpi(ji,jj)=0.0_wp ; zpshpj(ji,jj)=0.0_wp
466            ze3wu  = fse3w(ji+1,jj,iku+1)-fse3w(ji,jj,iku+1) 
467            ! u direction
468            IF ( iku .GT. 1 ) THEN
469               ! case iku
470               zhpi(ji,jj,iku)   =  zcoef0 / e1u(ji,jj) * ze3wu                                            &
471                      &                                 * ( rhd    (ji+1,jj,iku) + rhd   (ji,jj,iku)       &
472                      &                                   + SIGN(1._wp,ze3wu) * grui(ji,jj) + 2._wp * znad )
473 
474               IF (mbku(ji,jj) == iku + 1) zpshpi(ji,jj)  = zhpi(ji,jj,iku)
475               zuap              = -zcoef0 * ( arui(ji,jj) + 2._wp * znad ) * gzui(ji,jj) / e1u(ji,jj)
476               ! zhpi will be added in interior loop and zuapint will be removed in the interior loop
477               ua(ji,jj,iku)     = ua(ji,jj,iku) + zuap
478
479               ! zhpi will be added in interior loop and zuapint will be removed in the interior loop
480               ! case iku + 1 (remove the zphi term added in the interior loop)
481               zhpiint        =  zcoef0 / e1u(ji,jj)                                                             &   
482                  &           * (  fse3w(ji+1,jj  ,iku+1) * ( (rhd(ji+1,jj,iku+1) + znad)                          &
483                  &                                         + (rhd(ji+1,jj,iku  ) + znad) ) * tmask(ji+1,jj,iku)   &
484                  &              - fse3w(ji  ,jj  ,iku+1) * ( (rhd(ji  ,jj,iku+1) + znad)                          &
485                  &                                         + (rhd(ji  ,jj,iku  ) + znad) ) * tmask(ji  ,jj,iku)   )
486               zhpi(ji,jj,iku+1) =  zcoef0 / e1u(ji,jj) * ge3rui(ji,jj) - zhpiint 
487            END IF
488            ! v direction
489            ikv = mikv(ji,jj)
490            !ze3wv  = 0.5 * (e3w_0(ikv+1) / e3t_0(ikv)) * ( fse3t(ji,jj+1,ikv)-fse3t(ji,jj,ikv) )
491            ze3wv  = fse3w(ji,jj+1,ikv+1)-fse3w(ji,jj,ikv+1) 
492            IF ( ikv .GT. 1 ) THEN
493               ! case ikv
494         !      ze3wv             =  - (fsde3w(ji,jj+1,ikv) - fsde3w(ji,jj,ikv) )
495               zhpj(ji,jj,ikv)   =  zcoef0 / e2v(ji,jj) * ze3wv                                            &
496                     &                                  * ( rhd(ji,jj+1,ikv) + rhd   (ji,jj,ikv)           &
497                     &                                    + SIGN(1._wp,ze3wv) * grvi(ji,jj) + 2._wp * znad )
498
499               zvap              = -zcoef0 * ( arvi(ji,jj) + 2._wp * znad ) * gzvi(ji,jj) / e2v(ji,jj)
500               ! zhpi will be added in interior loop and zvapint will be removed in the interior loop
501               va(ji,jj,ikv)      = va(ji,jj,ikv) + zvap
502               IF (mbkv(ji,jj) == ikv + 1)  zpshpj(ji,jj)  =  zhpj(ji,jj,ikv) 
503               ! zhpi will be added in interior loop and zvapint will be removed in the interior loop
504               ! case ikv + 1 (remove the zphj term added in the interior loop)
505               zhpjint        =  zcoef0 / e2v(ji,jj)                                                            &
506                  &           * (  fse3w(ji  ,jj+1,ikv+1) * ( (rhd(ji,jj+1,ikv+1) + znad)                         &
507                  &                                       + (rhd(ji,jj+1,ikv  ) + znad) ) * tmask(ji,jj+1,ikv)  &
508                  &              - fse3w(ji  ,jj  ,ikv+1) * ( (rhd(ji,jj  ,ikv+1) + znad)                         &
509                  &                                       + (rhd(ji,jj  ,ikv  ) + znad) ) * tmask(ji,jj  ,ikv)  )
510               zhpj(ji,jj,ikv+1) =  zcoef0 / e2v(ji,jj) * ge3rvi(ji,jj) - zhpjint
511            END IF
512         END DO
513      END DO
514
515      ! interior value (2=<jk=<jpkm1)
516      DO jj = 2, jpjm1
517         DO ji = fs_2, fs_jpim1   ! vector opt.
518            iku=miku(ji,jj); ikv=mikv(ji,jj)
519            DO jk = 2, jpkm1
520               ! hydrostatic pressure gradient along s-surfaces
521               ! s-coordinate pressure gradient correction
522               zhpi(ji,jj,jk) = zhpi(ji,jj,jk) + zhpi(ji,jj,jk-1)                                                              &
523                  &                            + zcoef0 / e1u(ji,jj)                                                           &
524                  &                                     * ( fse3w(ji+1,jj  ,jk) * ( (rhd(ji+1,jj,jk  ) + znad)                 &
525                  &                                                     + (rhd(ji+1,jj,jk-1) + znad) ) * tmask(ji+1,jj,jk-1)   &
526                  &                                       - fse3w(ji  ,jj  ,jk) * ( (rhd(ji  ,jj,jk  ) + znad)                 &
527                  &                                                     + (rhd(ji  ,jj,jk-1) + znad) ) * tmask(ji  ,jj,jk-1)   ) 
528               ! corrective term               
529               zuap = - zcoef0 * ( rhd   (ji+1,jj  ,jk) + rhd   (ji,jj,jk) + 2._wp * znad )   &
530                  &            * ( fsde3w(ji+1,jj  ,jk) - fsde3w(ji,jj,jk) ) / e1u(ji,jj) * umask(ji,jj,jk-1)
531               ua(ji,jj,jk) = ua(ji,jj,jk) + ( zhpi(ji,jj,jk) + zuap) * umask(ji,jj,jk)
532
533               zhpj(ji,jj,jk) = zhpj(ji,jj,jk) + zhpj(ji,jj,jk-1)                                                              &
534                  &                            + zcoef0 / e2v(ji,jj)                                                           &
535                  &                                     * ( fse3w(ji  ,jj+1,jk) * ( (rhd(ji,jj+1,jk  ) + znad)                 &
536                  &                                                     + (rhd(ji,jj+1,jk-1) + znad) ) * tmask(ji,jj+1,jk-1)   &
537                  &                                       - fse3w(ji  ,jj  ,jk) * ( (rhd(ji,jj  ,jk  ) + znad)                 &
538                  &                                                     + (rhd(ji,jj  ,jk-1) + znad) ) * tmask(ji,jj  ,jk-1)   )
539               !
540               zvap = - zcoef0 * ( rhd   (ji  ,jj+1,jk) + rhd   (ji,jj,jk) + 2._wp * znad )   &
541                  &            * ( fsde3w(ji  ,jj+1,jk) - fsde3w(ji,jj,jk) ) / e2v(ji,jj) * vmask(ji,jj,jk-1)
542               ! add to the general momentum trend
543               va(ji,jj,jk) = va(ji,jj,jk) + ( zhpj(ji,jj,jk) + zvap ) * vmask(ji,jj,jk)
544            END DO
545         END DO
546      END DO
547     
548      ! partial steps correction at the last level  (use gru & grv computed in zpshde.F90)
549# if defined key_vectopt_loop
550         jj = 1
551         DO ji = jpi+2, jpij-jpi-1   ! vector opt. (forced unrolling)
552# else
553      DO jj = 2, jpjm1
554         DO ji = 2, jpim1
555# endif
556            iku = mbku(ji,jj)
557            ikv = mbkv(ji,jj)
558
559            IF (iku .GT. 1) THEN
560               ! remove old value (interior case)
561               zuap            = -zcoef0 * ( rhd   (ji+1,jj  ,iku) + rhd   (ji,jj,iku) + 2._wp * znad )   &
562                     &                   * ( fsde3w(ji+1,jj  ,iku) - fsde3w(ji,jj,iku) ) / e1u(ji,jj)
563               ua(ji,jj,iku)   = ua(ji,jj,iku) - zhpi(ji,jj,iku) - zuap
564               ! put new value
565               zuap            = -zcoef0 * ( aru(ji,jj) + 2._wp * znad ) * gzu(ji,jj)  / e1u(ji,jj)
566               zhpi(ji,jj,iku) =  zhpi(ji,jj,iku-1) + zcoef0 / e1u(ji,jj) * ge3ru(ji,jj) - zpshpi(ji,jj) 
567               ua(ji,jj,iku)   =  ua(ji,jj,iku) + zhpi(ji,jj,iku) + zuap
568            END IF
569            ! v direction
570            IF (ikv .GT. 1) THEN
571               ! remove old value (interior case)
572               zvap            = -zcoef0 * ( rhd   (ji  ,jj+1,ikv) + rhd   (ji,jj,ikv) + 2._wp * znad )   &
573                     &                   * ( fsde3w(ji  ,jj+1,ikv) - fsde3w(ji,jj,ikv) )   / e2v(ji,jj)
574               va(ji,jj,ikv)   = va(ji,jj,ikv) - zhpj(ji,jj,ikv) - zvap
575               ! put new value
576               zvap            = -zcoef0 * ( arv(ji,jj) + 2._wp * znad ) * gzv(ji,jj)     / e2v(ji,jj)
577               zhpj(ji,jj,ikv) =  zhpj(ji,jj,ikv-1) + zcoef0 / e2v(ji,jj) * ge3rv(ji,jj) - zpshpj(ji,jj)   
578               va(ji,jj,ikv)   =  va(ji,jj,ikv) + zhpj(ji,jj,ikv) + zvap
579            END IF
580# if ! defined key_vectopt_loop
581         END DO
582# endif
583      END DO
584
585
586      rhd = zrhd
587      !
588      CALL wrk_dealloc( jpi,jpj,2, ztstop)
589      CALL wrk_dealloc( jpi,jpj,jpk, zhpi, zhpj, zrhd)
590      CALL wrk_dealloc( jpi,jpj, ze3w, zp, zrhdtop_isf, zrhdtop_oce, ziceload, zdept, zpshpi, zpshpj)
591      !
592   END SUBROUTINE hpg_sco
593
594   SUBROUTINE hpg_djc( kt )
595      !!---------------------------------------------------------------------
596      !!                  ***  ROUTINE hpg_djc  ***
597      !!
598      !! ** Method  :   Density Jacobian with Cubic polynomial scheme
599      !!
600      !! Reference: Shchepetkin and McWilliams, J. Geophys. Res., 108(C3), 3090, 2003
601      !!----------------------------------------------------------------------
602      INTEGER, INTENT(in) ::   kt    ! ocean time-step index
603      !!
604      INTEGER  ::   ji, jj, jk          ! dummy loop indices
605      REAL(wp) ::   zcoef0, zep, cffw   ! temporary scalars
606      REAL(wp) ::   z1_10, cffu, cffx   !    "         "
607      REAL(wp) ::   z1_12, cffv, cffy   !    "         "
608      REAL(wp), POINTER, DIMENSION(:,:,:) ::  zhpi, zhpj
609      REAL(wp), POINTER, DIMENSION(:,:,:) ::  dzx, dzy, dzz, dzu, dzv, dzw
610      REAL(wp), POINTER, DIMENSION(:,:,:) ::  drhox, drhoy, drhoz, drhou, drhov, drhow
611      REAL(wp), POINTER, DIMENSION(:,:,:) ::  rho_i, rho_j, rho_k
612      !!----------------------------------------------------------------------
613      !
614      CALL wrk_alloc( jpi, jpj, jpk, dzx  , dzy  , dzz  , dzu  , dzv  , dzw   )
615      CALL wrk_alloc( jpi, jpj, jpk, drhox, drhoy, drhoz, drhou, drhov, drhow )
616      CALL wrk_alloc( jpi, jpj, jpk, rho_i, rho_j, rho_k,  zhpi,  zhpj        )
617      !
618
619      IF( kt == nit000 ) THEN
620         IF(lwp) WRITE(numout,*)
621         IF(lwp) WRITE(numout,*) 'dyn:hpg_djc : hydrostatic pressure gradient trend'
622         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   s-coordinate case, density Jacobian with cubic polynomial scheme'
623      ENDIF
624
625      ! Local constant initialization
626      zcoef0 = - grav * 0.5_wp
627      z1_10  = 1._wp / 10._wp
628      z1_12  = 1._wp / 12._wp
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._wp * drhoz(ji  ,jj  ,jk) * drhoz(ji,jj,jk-1)
661
662               cffu = 2._wp * drhox(ji+1,jj  ,jk) * drhox(ji,jj,jk  )
663               cffx = 2._wp * dzx  (ji+1,jj  ,jk) * dzx  (ji,jj,jk  )
664
665               cffv = 2._wp * drhoy(ji  ,jj+1,jk) * drhoy(ji,jj,jk  )
666               cffy = 2._wp * dzy  (ji  ,jj+1,jk) * dzy  (ji,jj,jk  )
667
668               IF( cffw > zep) THEN
669                  drhow(ji,jj,jk) = 2._wp *   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._wp
673               ENDIF
674
675               dzw(ji,jj,jk) = 2._wp *   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._wp *   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._wp
683               ENDIF
684
685               IF( cffx > zep ) THEN
686                  dzu(ji,jj,jk) = 2._wp *   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._wp
690               ENDIF
691
692               IF( cffv > zep ) THEN
693                  drhov(ji,jj,jk) = 2._wp *   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._wp
697               ENDIF
698
699               IF( cffy > zep ) THEN
700                  dzv(ji,jj,jk) = 2._wp *   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._wp
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_wp * ( drhoz(:,:, 2 ) - drhoz(:,:,  1  ) ) - 0.5_wp * drhow(:,:,  2  )
714      drhou(:,:, 1 ) = 1.5_wp * ( drhox(:,:, 2 ) - drhox(:,:,  1  ) ) - 0.5_wp * drhou(:,:,  2  )
715      drhov(:,:, 1 ) = 1.5_wp * ( drhoy(:,:, 2 ) - drhoy(:,:,  1  ) ) - 0.5_wp * drhov(:,:,  2  )
716
717      drhow(:,:,jpk) = 1.5_wp * ( drhoz(:,:,jpk) - drhoz(:,:,jpkm1) ) - 0.5_wp * drhow(:,:,jpkm1)
718      drhou(:,:,jpk) = 1.5_wp * ( drhox(:,:,jpk) - drhox(:,:,jpkm1) ) - 0.5_wp * drhou(:,:,jpkm1)
719      drhov(:,:,jpk) = 1.5_wp * ( drhoy(:,:,jpk) - drhoy(:,:,jpkm1) ) - 0.5_wp * 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_wp * ( 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      CALL wrk_dealloc( jpi, jpj, jpk, dzx  , dzy  , dzz  , dzu  , dzv  , dzw   )
815      CALL wrk_dealloc( jpi, jpj, jpk, drhox, drhoy, drhoz, drhou, drhov, drhow )
816      CALL wrk_dealloc( jpi, jpj, jpk, rho_i, rho_j, rho_k,  zhpi,  zhpj        )
817      !
818   END SUBROUTINE hpg_djc
819
820
821   SUBROUTINE hpg_prj( kt )
822      !!---------------------------------------------------------------------
823      !!                  ***  ROUTINE hpg_prj  ***
824      !!
825      !! ** Method  :   s-coordinate case.
826      !!      A Pressure-Jacobian horizontal pressure gradient method
827      !!      based on the constrained cubic-spline interpolation for
828      !!      all vertical coordinate systems
829      !!
830      !! ** Action : - Update (ua,va) with the now hydrastatic pressure trend
831      !!             - Save the trend (l_trddyn=T)
832      !!
833      !!----------------------------------------------------------------------
834      INTEGER, PARAMETER  :: polynomial_type = 1    ! 1: cubic spline, 2: linear
835      INTEGER, INTENT(in) ::   kt                   ! ocean time-step index
836      !!
837      INTEGER  ::   ji, jj, jk, jkk                 ! dummy loop indices
838      REAL(wp) ::   zcoef0, znad                    ! temporary scalars
839      !!
840      !! The local variables for the correction term
841      INTEGER  :: jk1, jis, jid, jjs, jjd
842      REAL(wp) :: zuijk, zvijk, zpwes, zpwed, zpnss, zpnsd, zdeps
843      REAL(wp) :: zrhdt1
844      REAL(wp) :: zdpdx1, zdpdx2, zdpdy1, zdpdy2
845      REAL(wp), POINTER, DIMENSION(:,:,:) ::   zdept, zrhh
846      REAL(wp), POINTER, DIMENSION(:,:,:) ::   zhpi, zu, zv, fsp, xsp, asp, bsp, csp, dsp
847      !!----------------------------------------------------------------------
848      !
849      CALL wrk_alloc( jpi,jpj,jpk, zhpi, zu, zv, fsp, xsp, asp, bsp, csp, dsp )
850      CALL wrk_alloc( jpi,jpj,jpk, zdept, zrhh )
851      !
852      IF( kt == nit000 ) THEN
853         IF(lwp) WRITE(numout,*)
854         IF(lwp) WRITE(numout,*) 'dyn:hpg_prj : hydrostatic pressure gradient trend'
855         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   s-coordinate case, cubic spline pressure Jacobian'
856      ENDIF
857
858      !!----------------------------------------------------------------------
859      ! Local constant initialization
860      zcoef0 = - grav
861      znad = 0.0_wp
862      IF( lk_vvl ) znad = 1._wp
863
864      ! Clean 3-D work arrays
865      zhpi(:,:,:) = 0._wp
866      zrhh(:,:,:) = rhd(:,:,:)
867
868      ! Preparing vertical density profile "zrhh(:,:,:)" for hybrid-sco coordinate
869      DO jj = 1, jpj
870        DO ji = 1, jpi
871          jk = mbathy(ji,jj)
872          IF( jk <= 0 ) THEN; zrhh(ji,jj,:) = 0._wp
873          ELSE IF(jk == 1) THEN; zrhh(ji,jj, jk+1:jpk) = rhd(ji,jj,jk)
874          ELSE IF(jk < jpkm1) THEN
875             DO jkk = jk+1, jpk
876                zrhh(ji,jj,jkk) = interp1(fsde3w(ji,jj,jkk),   fsde3w(ji,jj,jkk-1), &
877                                         fsde3w(ji,jj,jkk-2), rhd(ji,jj,jkk-1), rhd(ji,jj,jkk-2))
878             END DO
879          ENDIF
880        END DO
881      END DO
882
883      ! Transfer the depth of "T(:,:,:)" to vertical coordinate "zdept(:,:,:)"
884      DO jj = 1, jpj;   DO ji = 1, jpi
885          zdept(ji,jj,1) = 0.5_wp * fse3w(ji,jj,1) - sshn(ji,jj) * znad
886      END DO        ;   END DO
887
888      DO jk = 2, jpk;   DO jj = 1, jpj;   DO ji = 1, jpi
889          zdept(ji,jj,jk) = zdept(ji,jj,jk-1) + fse3w(ji,jj,jk)
890      END DO        ;   END DO        ;   END DO
891
892      fsp(:,:,:) = zrhh(:,:,:)
893      xsp(:,:,:) = zdept(:,:,:)
894
895      ! Construct the vertical density profile with the
896      ! constrained cubic spline interpolation
897      ! rho(z) = asp + bsp*z + csp*z^2 + dsp*z^3
898      CALL cspline(fsp,xsp,asp,bsp,csp,dsp,polynomial_type)
899
900      ! Integrate the hydrostatic pressure "zhpi(:,:,:)" at "T(ji,jj,1)"
901      DO jj = 2, jpj
902        DO ji = 2, jpi
903          zrhdt1 = zrhh(ji,jj,1) - interp3(zdept(ji,jj,1),asp(ji,jj,1), &
904                                         bsp(ji,jj,1),   csp(ji,jj,1), &
905                                         dsp(ji,jj,1) ) * 0.25_wp * fse3w(ji,jj,1)
906
907          ! assuming linear profile across the top half surface layer
908          zhpi(ji,jj,1) =  0.5_wp * fse3w(ji,jj,1) * zrhdt1
909        END DO
910      END DO
911
912      ! Calculate the pressure "zhpi(:,:,:)" at "T(ji,jj,2:jpkm1)"
913      DO jk = 2, jpkm1
914        DO jj = 2, jpj
915          DO ji = 2, jpi
916            zhpi(ji,jj,jk) = zhpi(ji,jj,jk-1) +                          &
917                             integ_spline(zdept(ji,jj,jk-1), zdept(ji,jj,jk),&
918                                    asp(ji,jj,jk-1),    bsp(ji,jj,jk-1), &
919                                    csp(ji,jj,jk-1),    dsp(ji,jj,jk-1))
920          END DO
921        END DO
922      END DO
923
924      ! Z coordinate of U(ji,jj,1:jpkm1) and V(ji,jj,1:jpkm1)
925      DO jj = 2, jpjm1
926        DO ji = 2, jpim1
927          zu(ji,jj,1) = - ( fse3u(ji,jj,1) - sshn(ji,jj) * znad)    ! probable bug: changed from sshu_n for ztilde compilation
928          zv(ji,jj,1) = - ( fse3v(ji,jj,1) - sshn(ji,jj) * znad)    ! probable bug: changed from sshv_n for ztilde compilation
929        END DO
930      END DO
931
932      DO jk = 2, jpkm1
933        DO jj = 2, jpjm1
934          DO ji = 2, jpim1
935            zu(ji,jj,jk) = zu(ji,jj,jk-1)- fse3u(ji,jj,jk)
936            zv(ji,jj,jk) = zv(ji,jj,jk-1)- fse3v(ji,jj,jk)
937          END DO
938        END DO
939      END DO
940
941      DO jk = 1, jpkm1
942        DO jj = 2, jpjm1
943          DO ji = 2, jpim1
944            zu(ji,jj,jk) = zu(ji,jj,jk) + 0.5_wp * fse3u(ji,jj,jk)
945            zv(ji,jj,jk) = zv(ji,jj,jk) + 0.5_wp * fse3v(ji,jj,jk)
946          END DO
947        END DO
948      END DO
949
950      DO jk = 1, jpkm1
951        DO jj = 2, jpjm1
952          DO ji = 2, jpim1
953            zu(ji,jj,jk) = min(zu(ji,jj,jk), max(-zdept(ji,jj,jk), -zdept(ji+1,jj,jk)))
954            zu(ji,jj,jk) = max(zu(ji,jj,jk), min(-zdept(ji,jj,jk), -zdept(ji+1,jj,jk)))
955            zv(ji,jj,jk) = min(zv(ji,jj,jk), max(-zdept(ji,jj,jk), -zdept(ji,jj+1,jk)))
956            zv(ji,jj,jk) = max(zv(ji,jj,jk), min(-zdept(ji,jj,jk), -zdept(ji,jj+1,jk)))
957          END DO
958        END DO
959      END DO
960
961
962      DO jk = 1, jpkm1
963        DO jj = 2, jpjm1
964          DO ji = 2, jpim1
965            zpwes = 0._wp; zpwed = 0._wp
966            zpnss = 0._wp; zpnsd = 0._wp
967            zuijk = zu(ji,jj,jk)
968            zvijk = zv(ji,jj,jk)
969
970            !!!!!     for u equation
971            IF( jk <= mbku(ji,jj) ) THEN
972               IF( -zdept(ji+1,jj,jk) >= -zdept(ji,jj,jk) ) THEN
973                 jis = ji + 1; jid = ji
974               ELSE
975                 jis = ji;     jid = ji +1
976               ENDIF
977
978               ! integrate the pressure on the shallow side
979               jk1 = jk
980               DO WHILE ( -zdept(jis,jj,jk1) > zuijk )
981                 IF( jk1 == mbku(ji,jj) ) THEN
982                   zuijk = -zdept(jis,jj,jk1)
983                   EXIT
984                 ENDIF
985                 zdeps = MIN(zdept(jis,jj,jk1+1), -zuijk)
986                 zpwes = zpwes +                                    &
987                      integ_spline(zdept(jis,jj,jk1), zdeps,            &
988                             asp(jis,jj,jk1),    bsp(jis,jj,jk1), &
989                             csp(jis,jj,jk1),    dsp(jis,jj,jk1))
990                 jk1 = jk1 + 1
991               END DO
992
993               ! integrate the pressure on the deep side
994               jk1 = jk
995               DO WHILE ( -zdept(jid,jj,jk1) < zuijk )
996                 IF( jk1 == 1 ) THEN
997                   zdeps = zdept(jid,jj,1) + MIN(zuijk, sshn(jid,jj)*znad)
998                   zrhdt1 = zrhh(jid,jj,1) - interp3(zdept(jid,jj,1), asp(jid,jj,1), &
999                                                     bsp(jid,jj,1),   csp(jid,jj,1), &
1000                                                     dsp(jid,jj,1)) * zdeps
1001                   zpwed  = zpwed + 0.5_wp * (zrhh(jid,jj,1) + zrhdt1) * zdeps
1002                   EXIT
1003                 ENDIF
1004                 zdeps = MAX(zdept(jid,jj,jk1-1), -zuijk)
1005                 zpwed = zpwed +                                        &
1006                        integ_spline(zdeps,              zdept(jid,jj,jk1), &
1007                               asp(jid,jj,jk1-1), bsp(jid,jj,jk1-1),  &
1008                               csp(jid,jj,jk1-1), dsp(jid,jj,jk1-1) )
1009                 jk1 = jk1 - 1
1010               END DO
1011
1012               ! update the momentum trends in u direction
1013
1014               zdpdx1 = zcoef0 / e1u(ji,jj) * (zhpi(ji+1,jj,jk) - zhpi(ji,jj,jk))
1015               IF( lk_vvl ) THEN
1016                 zdpdx2 = zcoef0 / e1u(ji,jj) * &
1017                         ( REAL(jis-jid, wp) * (zpwes + zpwed) + (sshn(ji+1,jj)-sshn(ji,jj)) )
1018                ELSE
1019                 zdpdx2 = zcoef0 / e1u(ji,jj) * REAL(jis-jid, wp) * (zpwes + zpwed)
1020               ENDIF
1021
1022               ua(ji,jj,jk) = ua(ji,jj,jk) + (zdpdx1 + zdpdx2) * &
1023               &           umask(ji,jj,jk) * tmask(ji,jj,jk) * tmask(ji+1,jj,jk)
1024            ENDIF
1025
1026            !!!!!     for v equation
1027            IF( jk <= mbkv(ji,jj) ) THEN
1028               IF( -zdept(ji,jj+1,jk) >= -zdept(ji,jj,jk) ) THEN
1029                 jjs = jj + 1; jjd = jj
1030               ELSE
1031                 jjs = jj    ; jjd = jj + 1
1032               ENDIF
1033
1034               ! integrate the pressure on the shallow side
1035               jk1 = jk
1036               DO WHILE ( -zdept(ji,jjs,jk1) > zvijk )
1037                 IF( jk1 == mbkv(ji,jj) ) THEN
1038                   zvijk = -zdept(ji,jjs,jk1)
1039                   EXIT
1040                 ENDIF
1041                 zdeps = MIN(zdept(ji,jjs,jk1+1), -zvijk)
1042                 zpnss = zpnss +                                      &
1043                        integ_spline(zdept(ji,jjs,jk1), zdeps,            &
1044                               asp(ji,jjs,jk1),    bsp(ji,jjs,jk1), &
1045                               csp(ji,jjs,jk1),    dsp(ji,jjs,jk1) )
1046                 jk1 = jk1 + 1
1047               END DO
1048
1049               ! integrate the pressure on the deep side
1050               jk1 = jk
1051               DO WHILE ( -zdept(ji,jjd,jk1) < zvijk )
1052                 IF( jk1 == 1 ) THEN
1053                   zdeps = zdept(ji,jjd,1) + MIN(zvijk, sshn(ji,jjd)*znad)
1054                   zrhdt1 = zrhh(ji,jjd,1) - interp3(zdept(ji,jjd,1), asp(ji,jjd,1), &
1055                                                     bsp(ji,jjd,1),   csp(ji,jjd,1), &
1056                                                     dsp(ji,jjd,1) ) * zdeps
1057                   zpnsd  = zpnsd + 0.5_wp * (zrhh(ji,jjd,1) + zrhdt1) * zdeps
1058                   EXIT
1059                 ENDIF
1060                 zdeps = MAX(zdept(ji,jjd,jk1-1), -zvijk)
1061                 zpnsd = zpnsd +                                        &
1062                        integ_spline(zdeps,              zdept(ji,jjd,jk1), &
1063                               asp(ji,jjd,jk1-1), bsp(ji,jjd,jk1-1), &
1064                               csp(ji,jjd,jk1-1), dsp(ji,jjd,jk1-1) )
1065                 jk1 = jk1 - 1
1066               END DO
1067
1068
1069               ! update the momentum trends in v direction
1070
1071               zdpdy1 = zcoef0 / e2v(ji,jj) * (zhpi(ji,jj+1,jk) - zhpi(ji,jj,jk))
1072               IF( lk_vvl ) THEN
1073                   zdpdy2 = zcoef0 / e2v(ji,jj) * &
1074                           ( REAL(jjs-jjd, wp) * (zpnss + zpnsd) + (sshn(ji,jj+1)-sshn(ji,jj)) )
1075               ELSE
1076                   zdpdy2 = zcoef0 / e2v(ji,jj) * REAL(jjs-jjd, wp) * (zpnss + zpnsd )
1077               ENDIF
1078
1079               va(ji,jj,jk) = va(ji,jj,jk) + (zdpdy1 + zdpdy2)*&
1080               &              vmask(ji,jj,jk)*tmask(ji,jj,jk)*tmask(ji,jj+1,jk)
1081            ENDIF
1082
1083
1084           END DO
1085        END DO
1086      END DO
1087      !
1088      CALL wrk_dealloc( jpi,jpj,jpk, zhpi, zu, zv, fsp, xsp, asp, bsp, csp, dsp )
1089      CALL wrk_dealloc( jpi,jpj,jpk, zdept, zrhh )
1090      !
1091   END SUBROUTINE hpg_prj
1092
1093   SUBROUTINE cspline(fsp, xsp, asp, bsp, csp, dsp, polynomial_type)
1094      !!----------------------------------------------------------------------
1095      !!                 ***  ROUTINE cspline  ***
1096      !!
1097      !! ** Purpose :   constrained cubic spline interpolation
1098      !!
1099      !! ** Method  :   f(x) = asp + bsp*x + csp*x^2 + dsp*x^3
1100      !! Reference: CJC Kruger, Constrained Cubic Spline Interpoltation
1101      !!
1102      !!----------------------------------------------------------------------
1103      IMPLICIT NONE
1104      REAL(wp), DIMENSION(:,:,:), INTENT(in)  :: fsp, xsp           ! value and coordinate
1105      REAL(wp), DIMENSION(:,:,:), INTENT(out) :: asp, bsp, csp, dsp ! coefficients of
1106                                                                    ! the interpoated function
1107      INTEGER, INTENT(in) :: polynomial_type                        ! 1: cubic spline
1108                                                                    ! 2: Linear
1109
1110      ! Local Variables
1111      INTEGER  ::   ji, jj, jk                 ! dummy loop indices
1112      INTEGER  ::   jpi, jpj, jpkm1
1113      REAL(wp) ::   zdf1, zdf2, zddf1, zddf2, ztmp1, ztmp2, zdxtmp
1114      REAL(wp) ::   zdxtmp1, zdxtmp2, zalpha
1115      REAL(wp) ::   zdf(size(fsp,3))
1116      !!----------------------------------------------------------------------
1117
1118      jpi   = size(fsp,1)
1119      jpj   = size(fsp,2)
1120      jpkm1 = size(fsp,3) - 1
1121
1122
1123      IF (polynomial_type == 1) THEN     ! Constrained Cubic Spline
1124         DO ji = 1, jpi
1125            DO jj = 1, jpj
1126           !!Fritsch&Butland's method, 1984 (preferred, but more computation)
1127           !    DO jk = 2, jpkm1-1
1128           !       zdxtmp1 = xsp(ji,jj,jk)   - xsp(ji,jj,jk-1)
1129           !       zdxtmp2 = xsp(ji,jj,jk+1) - xsp(ji,jj,jk)
1130           !       zdf1    = ( fsp(ji,jj,jk)   - fsp(ji,jj,jk-1) ) / zdxtmp1
1131           !       zdf2    = ( fsp(ji,jj,jk+1) - fsp(ji,jj,jk)   ) / zdxtmp2
1132           !
1133           !       zalpha = ( zdxtmp1 + 2._wp * zdxtmp2 ) / ( zdxtmp1 + zdxtmp2 ) / 3._wp
1134           !
1135           !       IF(zdf1 * zdf2 <= 0._wp) THEN
1136           !           zdf(jk) = 0._wp
1137           !       ELSE
1138           !         zdf(jk) = zdf1 * zdf2 / ( ( 1._wp - zalpha ) * zdf1 + zalpha * zdf2 )
1139           !       ENDIF
1140           !    END DO
1141
1142           !!Simply geometric average
1143               DO jk = 2, jpkm1-1
1144                  zdf1 = (fsp(ji,jj,jk) - fsp(ji,jj,jk-1)) / (xsp(ji,jj,jk) - xsp(ji,jj,jk-1))
1145                  zdf2 = (fsp(ji,jj,jk+1) - fsp(ji,jj,jk)) / (xsp(ji,jj,jk+1) - xsp(ji,jj,jk))
1146
1147                  IF(zdf1 * zdf2 <= 0._wp) THEN
1148                     zdf(jk) = 0._wp
1149                  ELSE
1150                     zdf(jk) = 2._wp * zdf1 * zdf2 / (zdf1 + zdf2)
1151                  ENDIF
1152               END DO
1153
1154               zdf(1)     = 1.5_wp * ( fsp(ji,jj,2) - fsp(ji,jj,1) ) / &
1155                          &          ( xsp(ji,jj,2) - xsp(ji,jj,1) ) -  0.5_wp * zdf(2)
1156               zdf(jpkm1) = 1.5_wp * ( fsp(ji,jj,jpkm1) - fsp(ji,jj,jpkm1-1) ) / &
1157                          &          ( xsp(ji,jj,jpkm1) - xsp(ji,jj,jpkm1-1) ) - &
1158                          & 0.5_wp * zdf(jpkm1 - 1)
1159
1160               DO jk = 1, jpkm1 - 1
1161                 zdxtmp = xsp(ji,jj,jk+1) - xsp(ji,jj,jk)
1162                 ztmp1  = (zdf(jk+1) + 2._wp * zdf(jk)) / zdxtmp
1163                 ztmp2  =  6._wp * (fsp(ji,jj,jk+1) - fsp(ji,jj,jk)) / zdxtmp / zdxtmp
1164                 zddf1  = -2._wp * ztmp1 + ztmp2
1165                 ztmp1  = (2._wp * zdf(jk+1) + zdf(jk)) / zdxtmp
1166                 zddf2  =  2._wp * ztmp1 - ztmp2
1167
1168                 dsp(ji,jj,jk) = (zddf2 - zddf1) / 6._wp / zdxtmp
1169                 csp(ji,jj,jk) = ( xsp(ji,jj,jk+1) * zddf1 - xsp(ji,jj,jk)*zddf2 ) / 2._wp / zdxtmp
1170                 bsp(ji,jj,jk) = ( fsp(ji,jj,jk+1) - fsp(ji,jj,jk) ) / zdxtmp - &
1171                               & csp(ji,jj,jk) * ( xsp(ji,jj,jk+1) + xsp(ji,jj,jk) ) - &
1172                               & dsp(ji,jj,jk) * ((xsp(ji,jj,jk+1) + xsp(ji,jj,jk))**2 - &
1173                               &                   xsp(ji,jj,jk+1) * xsp(ji,jj,jk))
1174                 asp(ji,jj,jk) = fsp(ji,jj,jk) - xsp(ji,jj,jk) * (bsp(ji,jj,jk) + &
1175                               &                (xsp(ji,jj,jk) * (csp(ji,jj,jk) + &
1176                               &                 dsp(ji,jj,jk) * xsp(ji,jj,jk))))
1177               END DO
1178            END DO
1179         END DO
1180
1181      ELSE IF (polynomial_type == 2) THEN     ! Linear
1182         DO ji = 1, jpi
1183            DO jj = 1, jpj
1184               DO jk = 1, jpkm1-1
1185                  zdxtmp =xsp(ji,jj,jk+1) - xsp(ji,jj,jk)
1186                  ztmp1 = fsp(ji,jj,jk+1) - fsp(ji,jj,jk)
1187
1188                  dsp(ji,jj,jk) = 0._wp
1189                  csp(ji,jj,jk) = 0._wp
1190                  bsp(ji,jj,jk) = ztmp1 / zdxtmp
1191                  asp(ji,jj,jk) = fsp(ji,jj,jk) - bsp(ji,jj,jk) * xsp(ji,jj,jk)
1192               END DO
1193            END DO
1194         END DO
1195
1196      ELSE
1197           CALL ctl_stop( 'invalid polynomial type in cspline' )
1198      ENDIF
1199
1200
1201   END SUBROUTINE cspline
1202
1203
1204   FUNCTION interp1(x, xl, xr, fl, fr)  RESULT(f)
1205      !!----------------------------------------------------------------------
1206      !!                 ***  ROUTINE interp1  ***
1207      !!
1208      !! ** Purpose :   1-d linear interpolation
1209      !!
1210      !! ** Method  :
1211      !!                interpolation is straight forward
1212      !!                extrapolation is also permitted (no value limit)
1213      !!
1214      !!----------------------------------------------------------------------
1215      IMPLICIT NONE
1216      REAL(wp), INTENT(in) ::  x, xl, xr, fl, fr
1217      REAL(wp)             ::  f ! result of the interpolation (extrapolation)
1218      REAL(wp)             ::  zdeltx
1219      !!----------------------------------------------------------------------
1220
1221      zdeltx = xr - xl
1222      IF(abs(zdeltx) <= 10._wp * EPSILON(x)) THEN
1223        f = 0.5_wp * (fl + fr)
1224      ELSE
1225        f = ( (x - xl ) * fr - ( x - xr ) * fl ) / zdeltx
1226      ENDIF
1227
1228   END FUNCTION interp1
1229
1230   FUNCTION interp2(x, a, b, c, d)  RESULT(f)
1231      !!----------------------------------------------------------------------
1232      !!                 ***  ROUTINE interp1  ***
1233      !!
1234      !! ** Purpose :   1-d constrained cubic spline interpolation
1235      !!
1236      !! ** Method  :  cubic spline interpolation
1237      !!
1238      !!----------------------------------------------------------------------
1239      IMPLICIT NONE
1240      REAL(wp), INTENT(in) ::  x, a, b, c, d
1241      REAL(wp)             ::  f ! value from the interpolation
1242      !!----------------------------------------------------------------------
1243
1244      f = a + x* ( b + x * ( c + d * x ) )
1245
1246   END FUNCTION interp2
1247
1248
1249   FUNCTION interp3(x, a, b, c, d)  RESULT(f)
1250      !!----------------------------------------------------------------------
1251      !!                 ***  ROUTINE interp1  ***
1252      !!
1253      !! ** Purpose :   Calculate the first order of deriavtive of
1254      !!                a cubic spline function y=a+b*x+c*x^2+d*x^3
1255      !!
1256      !! ** Method  :   f=dy/dx=b+2*c*x+3*d*x^2
1257      !!
1258      !!----------------------------------------------------------------------
1259      IMPLICIT NONE
1260      REAL(wp), INTENT(in) ::  x, a, b, c, d
1261      REAL(wp)             ::  f ! value from the interpolation
1262      !!----------------------------------------------------------------------
1263
1264      f = b + x * ( 2._wp * c + 3._wp * d * x)
1265
1266   END FUNCTION interp3
1267
1268
1269   FUNCTION integ_spline(xl, xr, a, b, c, d)  RESULT(f)
1270      !!----------------------------------------------------------------------
1271      !!                 ***  ROUTINE interp1  ***
1272      !!
1273      !! ** Purpose :   1-d constrained cubic spline integration
1274      !!
1275      !! ** Method  :  integrate polynomial a+bx+cx^2+dx^3 from xl to xr
1276      !!
1277      !!----------------------------------------------------------------------
1278      IMPLICIT NONE
1279      REAL(wp), INTENT(in) ::  xl, xr, a, b, c, d
1280      REAL(wp)             ::  za1, za2, za3
1281      REAL(wp)             ::  f                   ! integration result
1282      !!----------------------------------------------------------------------
1283
1284      za1 = 0.5_wp * b
1285      za2 = c / 3.0_wp
1286      za3 = 0.25_wp * d
1287
1288      f  = xr * ( a + xr * ( za1 + xr * ( za2 + za3 * xr ) ) ) - &
1289         & xl * ( a + xl * ( za1 + xl * ( za2 + za3 * xl ) ) )
1290
1291   END FUNCTION integ_spline
1292
1293
1294   !!======================================================================
1295END MODULE dynhpg
1296
Note: See TracBrowser for help on using the repository browser.