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.
zpshde_crs.F90 in branches/2015/dev_r5003_MERCATOR6_CRS/NEMOGCM/NEMO/OPA_SRC/TRA – NEMO

source: branches/2015/dev_r5003_MERCATOR6_CRS/NEMOGCM/NEMO/OPA_SRC/TRA/zpshde_crs.F90 @ 5105

Last change on this file since 5105 was 5105, checked in by cbricaud, 9 years ago

bug correction
  • Property svn:executable set to *
File size: 12.8 KB
Line 
1MODULE zpshde_crs
2   !!======================================================================
3   !!                       ***  MODULE zpshde   ***
4   !! z-coordinate + partial step : Horizontal Derivative at ocean bottom level
5   !!======================================================================
6   !! History :  OPA  !  2002-04  (A. Bozec)  Original code
7   !!   NEMO     1.0  !  2002-08  (G. Madec E. Durand)  Optimization and Free form
8   !!             -   !  2004-03  (C. Ethe)  adapted for passive tracers
9   !!            3.3  !  2010-05  (C. Ethe, G. Madec)  merge TRC-TRA
10   !!======================================================================
11   
12   !!----------------------------------------------------------------------
13   !!   zps_hde      :  Horizontal DErivative of T, S and rd at the last
14   !!                   ocean level (Z-coord. with Partial Steps)
15   !!----------------------------------------------------------------------
16   USE oce             ! ocean: dynamics and tracers variables
17   USE dom_oce         ! domain: ocean variables
18   USE phycst          ! physical constants
19   USE eosbn2_crs          ! ocean equation of state
20   USE in_out_manager  ! I/O manager
21   USE crslbclnk          ! lateral boundary conditions (or mpp link)
22   USE lib_mpp         ! MPP library
23   USE wrk_nemo        ! Memory allocation
24   USE timing          ! Timing
25   USE crs
26   
27
28   IMPLICIT NONE
29   PRIVATE
30
31   PUBLIC   zps_hde_crs    ! routine called by step.F90
32
33   !! * Substitutions
34#  include "domzgr_substitute.h90"
35#  include "vectopt_loop_substitute.h90"
36   !!----------------------------------------------------------------------
37   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
38   !! $Id: zpshde.F90 3294 2012-01-28 16:44:18Z rblod $
39   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
40   !!----------------------------------------------------------------------
41CONTAINS
42
43   SUBROUTINE zps_hde_crs( kt, kjpt, pta, pgtu, pgtv,   &
44                                 prd, pgru, pgrv    )
45      !!----------------------------------------------------------------------
46      !!                     ***  ROUTINE zps_hde  ***
47      !!                   
48      !! ** Purpose :   Compute the horizontal derivative of T, S and rho
49      !!      at u- and v-points with a linear interpolation for z-coordinate
50      !!      with partial steps.
51      !!
52      !! ** Method  :   In z-coord with partial steps, scale factors on last
53      !!      levels are different for each grid point, so that T, S and rd
54      !!      points are not at the same depth as in z-coord. To have horizontal
55      !!      gradients again, we interpolate T and S at the good depth :
56      !!      Linear interpolation of T, S   
57      !!         Computation of di(tb) and dj(tb) by vertical interpolation:
58      !!          di(t) = t~ - t(i,j,k) or t(i+1,j,k) - t~
59      !!          dj(t) = t~ - t(i,j,k) or t(i,j+1,k) - t~
60      !!         This formulation computes the two cases:
61      !!                 CASE 1                   CASE 2 
62      !!         k-1  ___ ___________   k-1   ___ ___________
63      !!                    Ti  T~                  T~  Ti+1
64      !!                  _____                        _____
65      !!         k        |   |Ti+1     k           Ti |   |
66      !!                  |   |____                ____|   |
67      !!              ___ |   |   |           ___  |   |   |
68      !!                 
69      !!      case 1->   e3w(i+1) >= e3w(i) ( and e3w(j+1) >= e3w(j) ) then
70      !!          t~ = t(i+1,j  ,k) + (e3w(i+1) - e3w(i)) * dk(Ti+1)/e3w(i+1)
71      !!        ( t~ = t(i  ,j+1,k) + (e3w(j+1) - e3w(j)) * dk(Tj+1)/e3w(j+1)  )
72      !!          or
73      !!      case 2->   e3w(i+1) <= e3w(i) ( and e3w(j+1) <= e3w(j) ) then
74      !!          t~ = t(i,j,k) + (e3w(i) - e3w(i+1)) * dk(Ti)/e3w(i )
75      !!        ( t~ = t(i,j,k) + (e3w(j) - e3w(j+1)) * dk(Tj)/e3w(j ) )
76      !!          Idem for di(s) and dj(s)         
77      !!
78      !!      For rho, we call eos_insitu_2d which will compute rd~(t~,s~) at
79      !!      the good depth zh from interpolated T and S for the different
80      !!      formulation of the equation of state (eos).
81      !!      Gradient formulation for rho :
82      !!          di(rho) = rd~ - rd(i,j,k) or rd(i+1,j,k) - rd~
83      !!
84      !! ** Action  : - pgtu, pgtv: horizontal gradient of tracer at u- & v-points
85      !!              - pgru, pgrv: horizontal gradient of rho (if present) at u- & v-points
86      !!----------------------------------------------------------------------
87      !
88      INTEGER                              , INTENT(in   )           ::  kt          ! ocean time-step index
89      INTEGER                              , INTENT(in   )           ::  kjpt        ! number of tracers
90      REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(in   )           ::  pta         ! 4D tracers fields
91      REAL(wp), DIMENSION(jpi,jpj,    kjpt), INTENT(  out)           ::  pgtu, pgtv  ! hor. grad. of ptra at u- & v-pts
92      REAL(wp), DIMENSION(jpi,jpj,jpk     ), INTENT(in   ), OPTIONAL ::  prd         ! 3D density anomaly fields
93      REAL(wp), DIMENSION(jpi,jpj         ), INTENT(  out), OPTIONAL ::  pgru, pgrv  ! hor. grad. of prd at u- & v-pts
94      !
95      INTEGER  ::   ji, jj, jn      ! Dummy loop indices
96      INTEGER  ::   iku, ikv, ikum1, ikvm1   ! partial step level (ocean bottom level) at u- and v-points
97      REAL(wp) ::  ze3wu, ze3wv, zmaxu, zmaxv  ! temporary scalars
98  !cc    REAL(wp), POINTER, DIMENSION(:,:  ) ::  zri, zrj, zhi, zhj
99  !cc    REAL(wp), POINTER, DIMENSION(:,:,:) ::  zti, zte    ! interpolated value of tracer
100      REAL(wp), ALLOCATABLE, DIMENSION(:,:  ) ::  zri, zrj, zhi, zhj
101      REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) ::  zti, zte    ! interpolated value of tracer
102
103      !!----------------------------------------------------------------------
104      !
105      IF( nn_timing == 1 )  CALL timing_start( 'zps_hde')
106      !
107!!      CALL wrk_alloc( jpi, jpj,       zri, zrj, zhi, zhj )
108!!      CALL wrk_alloc( jpi, jpj, kjpt, zti, zte           )
109      ALLOCATE( zri(jpi_crs,jpj_crs) , zrj(jpi_crs,jpj_crs), zte(jpi_crs ,jpj_crs ,kjpt), &
110         &      zhi(jpi_crs,jpj_crs) , zhj(jpi_crs,jpj_crs), zti(jpi_crs ,jpj_crs ,kjpt))
111      !
112      DO jn = 1, kjpt      !==   Interpolation of tracers at the last ocean level   ==!
113         !
114# if defined key_vectopt_loop
115         jj = 1
116         DO ji = 1, jpij-jpi   ! vector opt. (forced unrolled)
117# else
118         DO jj = 1, jpjm1
119            DO ji = 1, jpim1
120# endif
121               iku = mbku_crs(ji,jj)   ;   ikum1 = MAX( iku - 1 , 1 )    ! last and before last ocean level at u- & v-points
122               ikv = mbkv_crs(ji,jj)   ;   ikvm1 = MAX( ikv - 1 , 1 )    ! if level first is a p-step, ik.m1=1
123          !     ze3wu = e3w_crs(ji+1,jj  ,iku) - e3w_crs(ji,jj,iku)
124          !     ze3wv = e3w_crs(ji  ,jj+1,ikv) - e3w_crs(ji,jj,ikv)
125               ze3wu = e3w_max_crs(ji+1,jj  ,iku) - e3w_max_crs(ji,jj,iku)
126               ze3wv = e3w_max_crs(ji  ,jj+1,ikv) - e3w_max_crs(ji,jj,ikv)
127               !
128               ! i- direction
129               IF( ze3wu >= 0._wp ) THEN      ! case 1
130                  !cbr zmaxu =  ze3wu / e3w_max_crs(ji+1,jj,iku) 
131                  zmaxu =  ze3wu
132                  IF( e3w_max_crs(ji+1,jj,iku) .NE. 0._wp ) zmaxu = zmaxu / e3w_max_crs(ji+1,jj,iku)
133                 !    zmaxu =  ze3wu / e3w_crs(ji+1,jj,iku)
134                  ! interpolated values of tracers
135                  zti(ji,jj,jn) = pta(ji+1,jj,iku,jn) + zmaxu * ( pta(ji+1,jj,ikum1,jn) - pta(ji+1,jj,iku,jn) )
136                  ! gradient of  tracers
137                  pgtu(ji,jj,jn) = umask_crs(ji,jj,1) * ( zti(ji,jj,jn) - pta(ji,jj,iku,jn) )
138               ELSE                           ! case 2
139                  !cbr zmaxu = -ze3wu / e3w_max_crs(ji,jj,iku)
140                  zmaxu =  -ze3wu
141                  IF( e3w_max_crs(ji,jj,iku) .NE. 0._wp ) zmaxu = zmaxu / e3w_max_crs(ji,jj,iku)
142                 !    zmaxu = -ze3wu / e3w_crs(ji,jj,iku)
143                  ! interpolated values of tracers
144                  zti(ji,jj,jn) = pta(ji,jj,iku,jn) + zmaxu * ( pta(ji,jj,ikum1,jn) - pta(ji,jj,iku,jn) )
145                  ! gradient of tracers
146                  pgtu(ji,jj,jn) = umask_crs(ji,jj,1) * ( pta(ji+1,jj,iku,jn) - zti(ji,jj,jn) )
147               ENDIF
148               !
149               ! j- direction
150               IF( ze3wv >= 0._wp ) THEN      ! case 1
151                  !cbr zmaxv =  ze3wv / e3w_max_crs(ji,jj+1,ikv)
152                  zmaxv =  ze3wv
153                  IF( e3w_max_crs(ji,jj+1,ikv) .NE. 0._wp ) zmaxv =  zmaxv / e3w_max_crs(ji,jj+1,ikv)
154               !      zmaxv =  ze3wv / e3w_crs(ji,jj+1,ikv)
155                  ! interpolated values of tracers
156                  zte(ji,jj,jn) = pta(ji,jj+1,ikv,jn) + zmaxv * ( pta(ji,jj+1,ikvm1,jn) - pta(ji,jj+1,ikv,jn) )
157                  ! gradient of tracers
158                  pgtv(ji,jj,jn) = vmask_crs(ji,jj,1) * ( zte(ji,jj,jn) - pta(ji,jj,ikv,jn) )
159               ELSE                           ! case 2
160                  !cbr zmaxv =  -ze3wv / e3w_max_crs(ji,jj,ikv)
161                  zmaxv =  -ze3wv
162                  IF( e3w_max_crs(ji,jj,ikv) .NE. 0._wp )zmaxv = zmaxv / e3w_max_crs(ji,jj,ikv)
163                !     zmaxv = -ze3wv / e3w_crs(ji,jj,ikv)
164                  ! interpolated values of tracers
165                  zte(ji,jj,jn) = pta(ji,jj,ikv,jn) + zmaxv * ( pta(ji,jj,ikvm1,jn) - pta(ji,jj,ikv,jn) )
166                  ! gradient of tracers
167                  pgtv(ji,jj,jn) = vmask_crs(ji,jj,1) * ( pta(ji,jj+1,ikv,jn) - zte(ji,jj,jn) )
168               ENDIF
169
170# if ! defined key_vectopt_loop
171            END DO
172# endif
173         END DO
174         CALL crs_lbc_lnk( pgtu(:,:,jn), 'U', -1. )   ;   CALL crs_lbc_lnk( pgtv(:,:,jn), 'V', -1. )   ! Lateral boundary cond.
175         !
176      END DO
177!WRITE(numout,*) ' test24 ', e3w_max_crs
178      ! horizontal derivative of density anomalies (rd)
179      IF( PRESENT( prd ) ) THEN         ! depth of the partial step level
180# if defined key_vectopt_loop
181         jj = 1
182         DO ji = 1, jpij-jpi   ! vector opt. (forced unrolled)
183# else
184         DO jj = 1, jpjm1
185            DO ji = 1, jpim1
186# endif
187               iku = mbku_crs(ji,jj)
188               ikv = mbkv_crs(ji,jj)
189   !cc             ze3wu  = e3w_max_crs(ji+1,jj  ,iku) - e3w_max_crs(ji,jj,iku)   !gradiant horizontal pas de max
190               ze3wu  = e3w_crs(ji+1,jj  ,iku) - e3w_crs(ji,jj,iku)
191       !cc        ze3wv  = e3w_max_crs(ji  ,jj+1,ikv) - e3w_max_crs(ji,jj,ikv)
192               ze3wv  = e3w_crs(ji  ,jj+1,ikv) - e3w_crs(ji,jj,ikv)
193               IF( ze3wu >= 0._wp ) THEN   ;   zhi(ji,jj) = gdept_crs(ji  ,jj,iku)     ! i-direction: case 1
194               ELSE                        ;   zhi(ji,jj) = gdept_crs(ji+1,jj,iku)     ! -     -      case 2
195               ENDIF
196               IF( ze3wv >= 0._wp ) THEN   ;   zhj(ji,jj) = gdept_crs(ji,jj  ,ikv)     ! j-direction: case 1
197               ELSE                        ;   zhj(ji,jj) = gdept_crs(ji,jj+1,ikv)     ! -     -      case 2
198               ENDIF
199# if ! defined key_vectopt_loop
200            END DO
201# endif
202         END DO
203         CALL eos_crs( zti, zhi, zri ) 
204         CALL eos_crs( zte, zhj, zrj )
205         ! Gradient of density at the last level
206# if defined key_vectopt_loop
207         jj = 1
208         DO ji = 1, jpij-jpi   ! vector opt. (forced unrolled)
209# else
210         DO jj = 1, jpjm1
211            DO ji = 1, jpim1
212# endif
213               iku = mbku_crs(ji,jj)
214               ikv = mbkv_crs(ji,jj)
215      !         ze3wu  = e3w_max_crs(ji+1,jj  ,iku) - e3w_max_crs(ji,jj,iku)         gradient horizontal
216                ze3wu  = e3w_crs(ji+1,jj  ,iku) - e3w_crs(ji,jj,iku)
217      !         ze3wv  = e3w_max_crs(ji  ,jj+1,ikv) - e3w_max_crs(ji,jj,ikv)         gradient horizontal
218                ze3wv  = e3w_crs(ji  ,jj+1,ikv) - e3w_crs(ji,jj,ikv)
219               IF( ze3wu >= 0._wp ) THEN   ;   pgru(ji,jj) = umask_crs(ji,jj,1) * ( zri(ji  ,jj) - prd(ji,jj,iku) )   ! i: 1
220               ELSE                        ;   pgru(ji,jj) = umask_crs(ji,jj,1) * ( prd(ji+1,jj,iku) - zri(ji,jj) )   ! i: 2
221               ENDIF
222               IF( ze3wv >= 0._wp ) THEN   ;   pgrv(ji,jj) = vmask_crs(ji,jj,1) * ( zrj(ji,jj  ) - prd(ji,jj,ikv) )   ! j: 1
223               ELSE                        ;   pgrv(ji,jj) = vmask_crs(ji,jj,1) * ( prd(ji,jj+1,ikv) - zrj(ji,jj) )   ! j: 2
224               ENDIF
225# if ! defined key_vectopt_loop
226            END DO
227# endif
228         END DO
229
230
231         CALL crs_lbc_lnk( pgru , 'U', -1. )   ;   CALL crs_lbc_lnk( pgrv , 'V', -1. )   ! Lateral boundary conditions
232         !
233      END IF
234      !
235      !!ccCALL wrk_dealloc( jpi, jpj,       zri, zrj, zhi, zhj )
236      !!ccCALL wrk_dealloc( jpi, jpj, kjpt, zti, zte           )
237      DEALLOCATE( zri , zrj, zte, zhi, zhj, zti)
238      !
239      IF( nn_timing == 1 )  CALL timing_stop( 'zps_hde')
240      !
241   END SUBROUTINE zps_hde_crs
242
243   !!======================================================================
244END MODULE zpshde_crs
Note: See TracBrowser for help on using the repository browser.