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.
zdftmx.F90 in branches/UKMO/dev_r5518_GO6_under_ice_relax_dr_hook/NEMOGCM/NEMO/OPA_SRC/ZDF – NEMO

source: branches/UKMO/dev_r5518_GO6_under_ice_relax_dr_hook/NEMOGCM/NEMO/OPA_SRC/ZDF/zdftmx.F90 @ 11738

Last change on this file since 11738 was 11738, checked in by marc, 5 years ago

The Dr Hook changes from my perl code.
File size: 55.8 KB
Line 
1MODULE zdftmx
2   !!========================================================================
3   !!                       ***  MODULE  zdftmx  ***
4   !! Ocean physics: vertical tidal mixing coefficient
5   !!========================================================================
6   !! History :  1.0  !  2004-04  (L. Bessieres, G. Madec)  Original code
7   !!             -   !  2006-08  (A. Koch-Larrouy) Indonesian strait
8   !!            3.3  !  2010-10  (C. Ethe, G. Madec) reorganisation of initialisation phase
9   !!----------------------------------------------------------------------
10#if defined key_zdftmx   ||   defined key_esopa
11   !!----------------------------------------------------------------------
12   !!   'key_zdftmx'                                  Tidal vertical mixing
13   !!----------------------------------------------------------------------
14   !!   zdf_tmx       : global     momentum & tracer Kz with tidal induced Kz
15   !!   tmx_itf       : Indonesian momentum & tracer Kz with tidal induced Kz
16   !!----------------------------------------------------------------------
17   USE oce            ! ocean dynamics and tracers variables
18   USE dom_oce        ! ocean space and time domain variables
19   USE zdf_oce        ! ocean vertical physics variables
20   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
21   USE eosbn2         ! ocean equation of state
22   USE phycst         ! physical constants
23   USE prtctl         ! Print control
24   USE in_out_manager ! I/O manager
25   USE iom            ! I/O Manager
26   USE lib_mpp        ! MPP library
27   USE wrk_nemo       ! work arrays
28   USE timing         ! Timing
29   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) 
30
31   USE yomhook, ONLY: lhook, dr_hook
32   USE parkind1, ONLY: jprb, jpim
33
34   IMPLICIT NONE
35   PRIVATE
36
37   PUBLIC   zdf_tmx         ! called in step module
38   PUBLIC   zdf_tmx_init    ! called in opa module
39   PUBLIC   zdf_tmx_alloc   ! called in nemogcm module
40
41   LOGICAL, PUBLIC, PARAMETER ::   lk_zdftmx = .TRUE.    !: tidal mixing flag
42
43   !                       !!* Namelist  namzdf_tmx : tidal mixing *
44   REAL(wp) ::  rn_htmx     ! vertical decay scale for turbulence (meters)
45   REAL(wp) ::  rn_n2min    ! threshold of the Brunt-Vaisala frequency (s-1)
46   REAL(wp) ::  rn_tfe      ! tidal dissipation efficiency (St Laurent et al. 2002)
47   REAL(wp) ::  rn_me       ! mixing efficiency (Osborn 1980)
48   LOGICAL  ::  ln_tmx_itf  ! Indonesian Through Flow (ITF): Koch-Larrouy et al. (2007) parameterization
49   REAL(wp) ::  rn_tfe_itf  ! ITF tidal dissipation efficiency (St Laurent et al. 2002)
50
51   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   en_tmx     ! energy available for tidal mixing (W/m2)
52   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   mask_itf   ! mask to use over Indonesian area
53   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   az_tmx     ! coefficient used to evaluate the tidal induced Kz
54
55   !! * Substitutions
56#  include "domzgr_substitute.h90"
57#  include "vectopt_loop_substitute.h90"
58   !!----------------------------------------------------------------------
59   !! NEMO/OPA 4.0 , NEMO Consortium (2011)
60   !! $Id$
61   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
62   !!----------------------------------------------------------------------
63CONTAINS
64
65   INTEGER FUNCTION zdf_tmx_alloc()
66   INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
67   INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
68   REAL(KIND=jprb)               :: zhook_handle
69
70   CHARACTER(LEN=*), PARAMETER :: RoutineName='ZDF_TMX_ALLOC'
71
72   IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
73
74      !!----------------------------------------------------------------------
75      !!                ***  FUNCTION zdf_tmx_alloc  ***
76      !!----------------------------------------------------------------------
77      ALLOCATE(en_tmx(jpi,jpj), mask_itf(jpi,jpj), az_tmx(jpi,jpj,jpk), STAT=zdf_tmx_alloc )
78      !
79      IF( lk_mpp             )   CALL mpp_sum ( zdf_tmx_alloc )
80      IF( zdf_tmx_alloc /= 0 )   CALL ctl_warn('zdf_tmx_alloc: failed to allocate arrays')
81   IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
82   END FUNCTION zdf_tmx_alloc
83
84
85   SUBROUTINE zdf_tmx( kt )
86      !!----------------------------------------------------------------------
87      !!                  ***  ROUTINE zdf_tmx  ***
88      !!                   
89      !! ** Purpose :   add to the vertical mixing coefficients the effect of
90      !!              tidal mixing (Simmons et al 2004).
91      !!
92      !! ** Method  : - tidal-induced vertical mixing is given by:
93      !!                  Kz_tides = az_tmx / max( rn_n2min, N^2 )
94      !!              where az_tmx is a coefficient that specified the 3D space
95      !!              distribution of the faction of tidal energy taht is used
96      !!              for mixing. Its expression is set in zdf_tmx_init routine,
97      !!              following Simmons et al. 2004.
98      !!                NB: a specific bounding procedure is performed on av_tide
99      !!              so that the input tidal energy is actually almost used. The
100      !!              basic maximum value is 60 cm2/s, but values of 300 cm2/s
101      !!              can be reached in area where bottom stratification is too
102      !!              weak.
103      !!
104      !!              - update av_tide in the Indonesian Through Flow area
105      !!              following Koch-Larrouy et al. (2007) parameterisation
106      !!              (see tmx_itf routine).
107      !!
108      !!              - update the model vertical eddy viscosity and diffusivity:
109      !!                     avt  = avt  +    av_tides
110      !!                     avm  = avm  +    av_tides
111      !!                     avmu = avmu + mi(av_tides)
112      !!                     avmv = avmv + mj(av_tides)
113      !!
114      !! ** Action  :   avt, avm, avmu, avmv   increased by tidal mixing
115      !!
116      !! References : Simmons et al. 2004, Ocean Modelling, 6, 3-4, 245-263.
117      !!              Koch-Larrouy et al. 2007, GRL.
118      !!----------------------------------------------------------------------
119      USE oce, zav_tide  =>   ua    ! use ua as workspace
120      !!
121      INTEGER, INTENT(in) ::   kt   ! ocean time-step
122      !!
123      INTEGER  ::   ji, jj, jk   ! dummy loop indices
124      REAL(wp) ::   ztpc         ! scalar workspace
125      REAL(wp), POINTER, DIMENSION(:,:) ::   zkz
126      INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
127      INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
128      REAL(KIND=jprb)               :: zhook_handle
129
130      CHARACTER(LEN=*), PARAMETER :: RoutineName='ZDF_TMX'
131
132      IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
133
134      !!----------------------------------------------------------------------
135      !
136      IF( nn_timing == 1 )  CALL timing_start('zdf_tmx')
137      !
138      CALL wrk_alloc( jpi,jpj, zkz )
139
140      !                          ! ----------------------- !
141      !                          !  Standard tidal mixing  !  (compute zav_tide)
142      !                          ! ----------------------- !
143      !                             !* First estimation (with n2 bound by rn_n2min) bounded by 60 cm2/s
144      zav_tide(:,:,:) = MIN(  60.e-4, az_tmx(:,:,:) / MAX( rn_n2min, rn2(:,:,:) )  )
145
146      zkz(:,:) = 0.e0               !* Associated potential energy consummed over the whole water column
147      DO jk = 2, jpkm1
148         zkz(:,:) = zkz(:,:) + fse3w(:,:,jk) * MAX( 0.e0, rn2(:,:,jk) ) * rau0 * zav_tide(:,:,jk) * wmask(:,:,jk)
149      END DO
150
151      DO jj = 1, jpj                !* Here zkz should be equal to en_tmx ==> multiply by en_tmx/zkz to recover en_tmx
152         DO ji = 1, jpi
153            IF( zkz(ji,jj) /= 0.e0 )   zkz(ji,jj) = en_tmx(ji,jj) / zkz(ji,jj)
154         END DO
155      END DO
156
157      DO jk = 2, jpkm1     !* Mutiply by zkz to recover en_tmx, BUT bound by 30/6 ==> zav_tide bound by 300 cm2/s
158         DO jj = 1, jpj                !* Here zkz should be equal to en_tmx ==> multiply by en_tmx/zkz to recover en_tmx
159            DO ji = 1, jpi
160               zav_tide(ji,jj,jk) = zav_tide(ji,jj,jk) * MIN( zkz(ji,jj), 30./6. ) * wmask(ji,jj,jk)  !kz max = 300 cm2/s
161            END DO
162         END DO
163      END DO
164
165      IF( kt == nit000 ) THEN       !* check at first time-step: diagnose the energy consumed by zav_tide
166         ztpc = 0.e0
167         DO jk= 1, jpk
168            DO jj= 1, jpj
169               DO ji= 1, jpi
170                  ztpc = ztpc + fse3w(ji,jj,jk) * e1t(ji,jj) * e2t(ji,jj)   &
171                     &         * MAX( 0.e0, rn2(ji,jj,jk) ) * zav_tide(ji,jj,jk) * tmask(ji,jj,jk) * tmask_i(ji,jj)
172               END DO
173            END DO
174         END DO
175         ztpc= rau0 / ( rn_tfe * rn_me ) * ztpc
176         IF(lwp) WRITE(numout,*) 
177         IF(lwp) WRITE(numout,*) '          N Total power consumption by av_tide    : ztpc = ', ztpc * 1.e-12 ,'TW'
178      ENDIF
179       
180      !                          ! ----------------------- !
181      !                          !    ITF  tidal mixing    !  (update zav_tide)
182      !                          ! ----------------------- !
183      IF( ln_tmx_itf )   CALL tmx_itf( kt, zav_tide )
184
185      !                          ! ----------------------- !
186      !                          !   Update  mixing coefs  !                         
187      !                          ! ----------------------- !
188      DO jk = 2, jpkm1              !* update momentum & tracer diffusivity with tidal mixing
189         DO jj = 1, jpj                !* Here zkz should be equal to en_tmx ==> multiply by en_tmx/zkz to recover en_tmx
190            DO ji = 1, jpi
191               avt(ji,jj,jk) = avt(ji,jj,jk) + zav_tide(ji,jj,jk) * wmask(ji,jj,jk)
192               avm(ji,jj,jk) = avm(ji,jj,jk) + zav_tide(ji,jj,jk) * wmask(ji,jj,jk)
193            END DO
194         END DO
195      END DO
196     
197      DO jk = 2, jpkm1              !* update momentum & tracer diffusivity with tidal mixing
198         DO jj = 2, jpjm1
199            DO ji = fs_2, fs_jpim1  ! vector opt.
200               avmu(ji,jj,jk) = avmu(ji,jj,jk) + 0.5 * ( zav_tide(ji,jj,jk) + zav_tide(ji+1,jj  ,jk) ) * wumask(ji,jj,jk)
201               avmv(ji,jj,jk) = avmv(ji,jj,jk) + 0.5 * ( zav_tide(ji,jj,jk) + zav_tide(ji  ,jj+1,jk) ) * wvmask(ji,jj,jk)
202            END DO
203         END DO
204      END DO
205      CALL lbc_lnk( avmu, 'U', 1. )   ;   CALL lbc_lnk( avmv, 'V', 1. )      ! lateral boundary condition
206
207      !                             !* output tidal mixing coefficient
208      CALL iom_put( "av_tide", zav_tide )
209
210      IF(ln_ctl)   CALL prt_ctl(tab3d_1=zav_tide , clinfo1=' tmx - av_tide: ', tab3d_2=avt, clinfo2=' avt: ', ovlap=1, kdim=jpk)
211      !
212      CALL wrk_dealloc( jpi,jpj, zkz )
213      !
214      IF( nn_timing == 1 )  CALL timing_stop('zdf_tmx')
215      !
216      IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
217   END SUBROUTINE zdf_tmx
218
219
220   SUBROUTINE tmx_itf( kt, pav )
221      !!----------------------------------------------------------------------
222      !!                  ***  ROUTINE tmx_itf  ***
223      !!                   
224      !! ** Purpose :   modify the vertical eddy diffusivity coefficients
225      !!              (pav) in the Indonesian Through Flow area (ITF).
226      !!
227      !! ** Method  : - Following Koch-Larrouy et al. (2007), in the ITF defined
228      !!                by msk_itf (read in a file, see tmx_init), the tidal
229      !!                mixing coefficient is computed with :
230      !!                  * q=1 (i.e. all the tidal energy remains trapped in
231      !!                         the area and thus is used for mixing)
232      !!                  * the vertical distribution of the tifal energy is a
233      !!                    proportional to N above the thermocline (d(N^2)/dz > 0)
234      !!                    and to N^2 below the thermocline (d(N^2)/dz < 0)
235      !!
236      !! ** Action  :   av_tide   updated in the ITF area (msk_itf)
237      !!
238      !! References :  Koch-Larrouy et al. 2007, GRL
239      !!----------------------------------------------------------------------
240      INTEGER , INTENT(in   )                         ::   kt   ! ocean time-step
241      REAL(wp), INTENT(inout), DIMENSION(jpi,jpj,jpk) ::   pav  ! Tidal mixing coef.
242      !!
243      INTEGER  ::   ji, jj, jk    ! dummy loop indices
244      REAL(wp) ::   zcoef, ztpc   ! temporary scalar
245      REAL(wp), DIMENSION(:,:)  , POINTER ::   zkz                        ! 2D workspace
246      REAL(wp), DIMENSION(:,:)  , POINTER ::   zsum1 , zsum2 , zsum       !  -      -
247      REAL(wp), DIMENSION(:,:,:), POINTER ::   zempba_3d_1, zempba_3d_2   ! 3D workspace
248      REAL(wp), DIMENSION(:,:,:), POINTER ::   zempba_3d  , zdn2dz        !  -      -
249      REAL(wp), DIMENSION(:,:,:), POINTER ::   zavt_itf                   !  -      -
250      INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
251      INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
252      REAL(KIND=jprb)               :: zhook_handle
253
254      CHARACTER(LEN=*), PARAMETER :: RoutineName='TMX_ITF'
255
256      IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
257
258      !!----------------------------------------------------------------------
259      !
260      IF( nn_timing == 1 )  CALL timing_start('tmx_itf')
261      !
262      CALL wrk_alloc( jpi,jpj, zkz, zsum1 , zsum2 , zsum )
263      CALL wrk_alloc( jpi,jpj,jpk, zempba_3d_1, zempba_3d_2, zempba_3d, zdn2dz, zavt_itf )
264
265      !                             ! compute the form function using N2 at each time step
266      zempba_3d_1(:,:,jpk) = 0.e0
267      zempba_3d_2(:,:,jpk) = 0.e0
268      DO jk = 1, jpkm1             
269         zdn2dz     (:,:,jk) = rn2(:,:,jk) - rn2(:,:,jk+1)           ! Vertical profile of dN2/dz
270!CDIR NOVERRCHK
271         zempba_3d_1(:,:,jk) = SQRT(  MAX( 0.e0, rn2(:,:,jk) )  )    !    -        -    of N
272         zempba_3d_2(:,:,jk) =        MAX( 0.e0, rn2(:,:,jk) )       !    -        -    of N^2
273      END DO
274      !
275      zsum (:,:) = 0.e0
276      zsum1(:,:) = 0.e0
277      zsum2(:,:) = 0.e0
278      DO jk= 2, jpk
279         zsum1(:,:) = zsum1(:,:) + zempba_3d_1(:,:,jk) * fse3w(:,:,jk) * tmask(:,:,jk) * tmask(:,:,jk-1)
280         zsum2(:,:) = zsum2(:,:) + zempba_3d_2(:,:,jk) * fse3w(:,:,jk) * tmask(:,:,jk) * tmask(:,:,jk-1)               
281      END DO
282      DO jj = 1, jpj
283         DO ji = 1, jpi
284            IF( zsum1(ji,jj) /= 0.e0 )   zsum1(ji,jj) = 1.e0 / zsum1(ji,jj)
285            IF( zsum2(ji,jj) /= 0.e0 )   zsum2(ji,jj) = 1.e0 / zsum2(ji,jj)               
286         END DO
287      END DO
288
289      DO jk= 1, jpk
290         DO jj = 1, jpj
291            DO ji = 1, jpi
292               zcoef = 0.5 - SIGN( 0.5, zdn2dz(ji,jj,jk) )       ! =0 if dN2/dz > 0, =1 otherwise
293               ztpc  = zempba_3d_1(ji,jj,jk) * zsum1(ji,jj) *        zcoef     &
294                  &  + zempba_3d_2(ji,jj,jk) * zsum2(ji,jj) * ( 1. - zcoef )
295               !
296               zempba_3d(ji,jj,jk) =               ztpc 
297               zsum     (ji,jj)    = zsum(ji,jj) + ztpc * fse3w(ji,jj,jk)
298            END DO
299         END DO
300       END DO
301       DO jj = 1, jpj
302          DO ji = 1, jpi
303             IF( zsum(ji,jj) > 0.e0 )   zsum(ji,jj) = 1.e0 / zsum(ji,jj)               
304          END DO
305       END DO
306
307      !                             ! first estimation bounded by 10 cm2/s (with n2 bounded by rn_n2min)
308      zcoef = rn_tfe_itf / ( rn_tfe * rau0 )
309      DO jk = 1, jpk
310         zavt_itf(:,:,jk) = MIN(  10.e-4, zcoef * en_tmx(:,:) * zsum(:,:) * zempba_3d(:,:,jk)   &
311            &                                      / MAX( rn_n2min, rn2(:,:,jk) ) * tmask(:,:,jk)  )
312      END DO           
313
314      zkz(:,:) = 0.e0               ! Associated potential energy consummed over the whole water column
315      DO jk = 2, jpkm1
316         zkz(:,:) = zkz(:,:) + fse3w(:,:,jk) * MAX( 0.e0, rn2(:,:,jk) ) * rau0 * zavt_itf(:,:,jk) * tmask(:,:,jk) * tmask(:,:,jk-1)
317      END DO
318
319      DO jj = 1, jpj                ! Here zkz should be equal to en_tmx ==> multiply by en_tmx/zkz to recover en_tmx
320         DO ji = 1, jpi
321            IF( zkz(ji,jj) /= 0.e0 )   zkz(ji,jj) = en_tmx(ji,jj) * rn_tfe_itf / rn_tfe / zkz(ji,jj)
322         END DO
323      END DO
324
325      DO jk = 2, jpkm1              ! Mutiply by zkz to recover en_tmx, BUT bound by 30/6 ==> zavt_itf bound by 300 cm2/s
326         zavt_itf(:,:,jk) = zavt_itf(:,:,jk) * MIN( zkz(:,:), 120./10. ) * tmask(:,:,jk) * tmask(:,:,jk-1)   ! kz max = 120 cm2/s
327      END DO
328
329      IF( kt == nit000 ) THEN       ! diagnose the nergy consumed by zavt_itf
330         ztpc = 0.e0
331         DO jk= 1, jpk
332            DO jj= 1, jpj
333               DO ji= 1, jpi
334                  ztpc = ztpc + e1t(ji,jj) * e2t(ji,jj) * fse3w(ji,jj,jk) * MAX( 0.e0, rn2(ji,jj,jk) )   &
335                     &                     * zavt_itf(ji,jj,jk) * tmask(ji,jj,jk) * tmask_i(ji,jj)
336               END DO
337            END DO
338         END DO
339         ztpc= rau0 * ztpc / ( rn_me * rn_tfe_itf )
340         IF(lwp) WRITE(numout,*) '          N Total power consumption by zavt_itf: ztpc = ', ztpc * 1.e-12 ,'TW'
341      ENDIF
342
343      !                             ! Update pav with the ITF mixing coefficient
344      DO jk = 2, jpkm1
345         pav(:,:,jk) = pav     (:,:,jk) * ( 1.e0 - mask_itf(:,:) )   &
346            &        + zavt_itf(:,:,jk) *          mask_itf(:,:) 
347      END DO
348      !
349      CALL wrk_dealloc( jpi,jpj, zkz, zsum1 , zsum2 , zsum )
350      CALL wrk_dealloc( jpi,jpj,jpk, zempba_3d_1, zempba_3d_2, zempba_3d, zdn2dz, zavt_itf )
351      !
352      IF( nn_timing == 1 )  CALL timing_stop('tmx_itf')
353      !
354      IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
355   END SUBROUTINE tmx_itf
356
357
358   SUBROUTINE zdf_tmx_init
359      !!----------------------------------------------------------------------
360      !!                  ***  ROUTINE zdf_tmx_init  ***
361      !!                     
362      !! ** Purpose :   Initialization of the vertical tidal mixing, Reading
363      !!              of M2 and K1 tidal energy in nc files
364      !!
365      !! ** Method  : - Read the namtmx namelist and check the parameters
366      !!
367      !!              - Read the input data in NetCDF files :
368      !!              M2 and K1 tidal energy. The total tidal energy, en_tmx,
369      !!              is the sum of M2, K1 and S2 energy where S2 is assumed
370      !!              to be: S2=(1/2)^2 * M2
371      !!              mask_itf, a mask array that determine where substituing
372      !!              the standard Simmons et al. (2005) formulation with the
373      !!              one of Koch_Larrouy et al. (2007).
374      !!
375      !!              - Compute az_tmx, a 3D coefficient that allows to compute
376      !!             the standard tidal-induced vertical mixing as follows:
377      !!                  Kz_tides = az_tmx / max( rn_n2min, N^2 )
378      !!             with az_tmx a bottom intensified coefficient is given by:
379      !!                 az_tmx(z) = en_tmx / ( rau0 * rn_htmx ) * EXP( -(H-z)/rn_htmx )
380      !!                                                  / ( 1. - EXP( - H   /rn_htmx ) )
381      !!             where rn_htmx the characteristic length scale of the bottom
382      !!             intensification, en_tmx the tidal energy, and H the ocean depth
383      !!
384      !! ** input   :   - Namlist namtmx
385      !!                - NetCDF file : M2_ORCA2.nc, K1_ORCA2.nc, and mask_itf.nc
386      !!
387      !! ** Action  : - Increase by 1 the nstop flag is setting problem encounter
388      !!              - defined az_tmx used to compute tidal-induced mixing
389      !!
390      !! References : Simmons et al. 2004, Ocean Modelling, 6, 3-4, 245-263.
391      !!              Koch-Larrouy et al. 2007, GRL.
392      !!----------------------------------------------------------------------
393      USE oce     ,         zav_tide =>  ua         ! ua used as workspace
394      !!
395      INTEGER  ::   ji, jj, jk   ! dummy loop indices
396      INTEGER  ::   inum         ! local integer
397      INTEGER  ::   ios
398      REAL(wp) ::   ztpc, ze_z   ! local scalars
399      REAL(wp), DIMENSION(:,:)  , POINTER ::  zem2, zek1   ! read M2 and K1 tidal energy
400      REAL(wp), DIMENSION(:,:)  , POINTER ::  zkz          ! total M2, K1 and S2 tidal energy
401      REAL(wp), DIMENSION(:,:)  , POINTER ::  zfact        ! used for vertical structure function
402      REAL(wp), DIMENSION(:,:)  , POINTER ::  zhdep        ! Ocean depth
403      REAL(wp), DIMENSION(:,:,:), POINTER ::  zpc      ! power consumption
404      !!
405      NAMELIST/namzdf_tmx/ rn_htmx, rn_n2min, rn_tfe, rn_me, ln_tmx_itf, rn_tfe_itf
406      INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
407      INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
408      REAL(KIND=jprb)               :: zhook_handle
409
410      CHARACTER(LEN=*), PARAMETER :: RoutineName='ZDF_TMX_INIT'
411
412      IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
413
414      !!----------------------------------------------------------------------
415      !
416      IF( nn_timing == 1 )  CALL timing_start('zdf_tmx_init')
417      !
418      CALL wrk_alloc( jpi,jpj, zem2, zek1, zkz, zfact, zhdep )
419      CALL wrk_alloc( jpi,jpj,jpk, zpc )
420     
421      REWIND( numnam_ref )              ! Namelist namzdf_tmx in reference namelist : Tidal Mixing
422      READ  ( numnam_ref, namzdf_tmx, IOSTAT = ios, ERR = 901)
423901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namzdf_tmx in reference namelist', lwp )
424
425      REWIND( numnam_cfg )              ! Namelist namzdf_tmx in configuration namelist : Tidal Mixing
426      READ  ( numnam_cfg, namzdf_tmx, IOSTAT = ios, ERR = 902 )
427902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namzdf_tmx in configuration namelist', lwp )
428      IF(lwm) WRITE ( numond, namzdf_tmx )
429
430      IF(lwp) THEN                   ! Control print
431         WRITE(numout,*)
432         WRITE(numout,*) 'zdf_tmx_init : tidal mixing'
433         WRITE(numout,*) '~~~~~~~~~~~~'
434         WRITE(numout,*) '   Namelist namzdf_tmx : set tidal mixing parameters'
435         WRITE(numout,*) '      Vertical decay scale for turbulence   = ', rn_htmx 
436         WRITE(numout,*) '      Brunt-Vaisala frequency threshold     = ', rn_n2min
437         WRITE(numout,*) '      Tidal dissipation efficiency          = ', rn_tfe
438         WRITE(numout,*) '      Mixing efficiency                     = ', rn_me
439         WRITE(numout,*) '      ITF specific parameterisation         = ', ln_tmx_itf
440         WRITE(numout,*) '      ITF tidal dissipation efficiency      = ', rn_tfe_itf
441      ENDIF
442
443      !                              ! allocate tmx arrays
444      IF( zdf_tmx_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'zdf_tmx_init : unable to allocate tmx arrays' )
445
446      IF( ln_tmx_itf ) THEN          ! read the Indonesian Through Flow mask
447         CALL iom_open('mask_itf',inum)
448         CALL iom_get (inum, jpdom_data, 'tmaskitf',mask_itf,1) !
449         CALL iom_close(inum)
450      ENDIF
451
452      ! read M2 tidal energy flux : W/m2  ( zem2 < 0 )
453      CALL iom_open('M2rowdrg',inum)
454      CALL iom_get (inum, jpdom_data, 'field',zem2,1) !
455      CALL iom_close(inum)
456
457      ! read K1 tidal energy flux : W/m2  ( zek1 < 0 )
458      CALL iom_open('K1rowdrg',inum)
459      CALL iom_get (inum, jpdom_data, 'field',zek1,1) !
460      CALL iom_close(inum)
461 
462      ! Total tidal energy ( M2, S2 and K1  with S2=(1/2)^2 * M2 )
463      ! only the energy available for mixing is taken into account,
464      ! (mixing efficiency tidal dissipation efficiency)
465      en_tmx(:,:) = - rn_tfe * rn_me * ( zem2(:,:) * 1.25 + zek1(:,:) ) * ssmask(:,:)
466
467!============
468!TG: Bug for VVL? Should this section be moved out of _init and be updated at every timestep?
469      ! Vertical structure (az_tmx)
470      DO jj = 1, jpj                ! part independent of the level
471         DO ji = 1, jpi
472            zhdep(ji,jj) = gdepw_0(ji,jj,mbkt(ji,jj)+1)       ! depth of the ocean
473            zfact(ji,jj) = rau0 * rn_htmx * ( 1. - EXP( -zhdep(ji,jj) / rn_htmx ) )
474            IF( zfact(ji,jj) /= 0 )   zfact(ji,jj) = en_tmx(ji,jj) / zfact(ji,jj)
475         END DO
476      END DO
477      DO jk= 1, jpk                 ! complete with the level-dependent part
478         DO jj = 1, jpj
479            DO ji = 1, jpi
480               az_tmx(ji,jj,jk) = zfact(ji,jj) * EXP( -( zhdep(ji,jj)-gdepw_0(ji,jj,jk) ) / rn_htmx ) * tmask(ji,jj,jk)
481            END DO
482         END DO
483      END DO
484!===========
485
486      IF( nprint == 1 .AND. lwp ) THEN
487         ! Control print
488         ! Total power consumption due to vertical mixing
489         ! zpc = rau0 * 1/rn_me * rn2 * zav_tide
490         zav_tide(:,:,:) = 0.e0
491         DO jk = 2, jpkm1
492            zav_tide(:,:,jk) = az_tmx(:,:,jk) / MAX( rn_n2min, rn2(:,:,jk) )
493         END DO
494
495         ztpc = 0.e0
496         zpc(:,:,:) = MAX(rn_n2min,rn2(:,:,:)) * zav_tide(:,:,:)
497         DO jk= 2, jpkm1
498            DO jj = 1, jpj
499               DO ji = 1, jpi
500                  ztpc = ztpc + fse3w(ji,jj,jk) * e1t(ji,jj) * e2t(ji,jj) * zpc(ji,jj,jk) * wmask(ji,jj,jk) * tmask_i(ji,jj)
501               END DO
502            END DO
503         END DO
504         ztpc= rau0 * 1/(rn_tfe * rn_me) * ztpc
505
506         WRITE(numout,*) 
507         WRITE(numout,*) '          Total power consumption of the tidally driven part of Kz : ztpc = ', ztpc * 1.e-12 ,'TW'
508
509
510         ! control print 2
511         zav_tide(:,:,:) = MIN( zav_tide(:,:,:), 60.e-4 )   
512         zkz(:,:) = 0.e0
513         DO jk = 2, jpkm1
514            DO jj = 1, jpj
515               DO ji = 1, jpi
516                  zkz(ji,jj) = zkz(ji,jj) + fse3w(ji,jj,jk) * MAX(0.e0, rn2(ji,jj,jk)) * rau0 * zav_tide(ji,jj,jk) * wmask(ji,jj,jk)
517               END DO
518            END DO
519         END DO
520         ! Here zkz should be equal to en_tmx ==> multiply by en_tmx/zkz
521         DO jj = 1, jpj
522            DO ji = 1, jpi
523               IF( zkz(ji,jj) /= 0.e0 )   THEN
524                   zkz(ji,jj) = en_tmx(ji,jj) / zkz(ji,jj)
525               ENDIF
526            END DO
527         END DO
528         ztpc = 1.e50
529         DO jj = 1, jpj
530            DO ji = 1, jpi
531               IF( zkz(ji,jj) /= 0.e0 )   THEN
532                   ztpc = Min( zkz(ji,jj), ztpc)
533               ENDIF
534            END DO
535         END DO
536         WRITE(numout,*) '          Min de zkz ', ztpc, ' Max = ', maxval(zkz(:,:) )
537
538         DO jk = 2, jpkm1
539            DO jj = 1, jpj
540               DO ji = 1, jpi
541                  zav_tide(ji,jj,jk) = zav_tide(ji,jj,jk) * MIN( zkz(ji,jj), 30./6. ) * wmask(ji,jj,jk)  !kz max = 300 cm2/s
542               END DO
543            END DO
544         END DO
545         ztpc = 0.e0
546         zpc(:,:,:) = Max(0.e0,rn2(:,:,:)) * zav_tide(:,:,:)
547         DO jk= 1, jpk
548            DO jj = 1, jpj
549               DO ji = 1, jpi
550                  ztpc = ztpc + fse3w(ji,jj,jk) * e1t(ji,jj) * e2t(ji,jj) * zpc(ji,jj,jk) * wmask(ji,jj,jk) * tmask_i(ji,jj)
551               END DO
552            END DO
553         END DO
554         ztpc= rau0 * 1/(rn_tfe * rn_me) * ztpc
555         WRITE(numout,*) '          2 Total power consumption of the tidally driven part of Kz : ztpc = ', ztpc * 1.e-12 ,'TW'
556
557         DO jk = 1, jpk
558            ze_z =                  SUM( e1t(:,:) * e2t(:,:) * zav_tide(:,:,jk)     * tmask_i(:,:) )   &
559               &     / MAX( 1.e-20, SUM( e1t(:,:) * e2t(:,:) * wmask (:,:,jk) * tmask_i(:,:) ) )
560            ztpc = 1.E50
561            DO jj = 1, jpj
562               DO ji = 1, jpi
563                  IF( zav_tide(ji,jj,jk) /= 0.e0 )   ztpc =Min( ztpc, zav_tide(ji,jj,jk) )
564               END DO
565            END DO
566            WRITE(numout,*) '            N2 min - jk= ', jk,'   ', ze_z * 1.e4,' cm2/s min= ',ztpc*1.e4,   &
567               &       'max= ', MAXVAL(zav_tide(:,:,jk) )*1.e4, ' cm2/s'
568         END DO
569
570         WRITE(numout,*) '          e_tide : ', SUM( e1t*e2t*en_tmx ) / ( rn_tfe * rn_me ) * 1.e-12, 'TW'
571         WRITE(numout,*) 
572         WRITE(numout,*) '          Initial profile of tidal vertical mixing'
573         DO jk = 1, jpk
574            DO jj = 1,jpj
575               DO ji = 1,jpi
576                  zkz(ji,jj) = az_tmx(ji,jj,jk) /MAX( rn_n2min, rn2(ji,jj,jk) )
577               END DO
578            END DO
579            ze_z =                  SUM( e1t(:,:) * e2t(:,:) * zkz(:,:)     * tmask_i(:,:) )   &
580               &     / MAX( 1.e-20, SUM( e1t(:,:) * e2t(:,:) * wmask (:,:,jk) * tmask_i(:,:) ) )
581            WRITE(numout,*) '                jk= ', jk,'   ', ze_z * 1.e4,' cm2/s'
582         END DO
583         DO jk = 1, jpk
584            zkz(:,:) = az_tmx(:,:,jk) /rn_n2min
585            ze_z =                  SUM( e1t(:,:) * e2t(:,:) * zkz(:,:)     * tmask_i(:,:) )   &
586               &     / MAX( 1.e-20, SUM( e1t(:,:) * e2t(:,:) * wmask (:,:,jk) * tmask_i(:,:) ) )
587            WRITE(numout,*) 
588            WRITE(numout,*) '          N2 min - jk= ', jk,'   ', ze_z * 1.e4,' cm2/s min= ',MINVAL(zkz)*1.e4,   &
589               &       'max= ', MAXVAL(zkz)*1.e4, ' cm2/s'
590         END DO
591         !
592      ENDIF
593      !
594      CALL wrk_dealloc( jpi,jpj, zem2, zek1, zkz, zfact, zhdep )
595      CALL wrk_dealloc( jpi,jpj,jpk, zpc )
596      !
597      IF( nn_timing == 1 )  CALL timing_stop('zdf_tmx_init')
598      !
599      IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
600   END SUBROUTINE zdf_tmx_init
601
602#elif defined key_zdftmx_new
603   !!----------------------------------------------------------------------
604   !!   'key_zdftmx_new'               Internal wave-driven vertical mixing
605   !!----------------------------------------------------------------------
606   !!   zdf_tmx       : global     momentum & tracer Kz with wave induced Kz
607   !!   zdf_tmx_init  : global     momentum & tracer Kz with wave induced Kz
608   !!----------------------------------------------------------------------
609   USE oce            ! ocean dynamics and tracers variables
610   USE dom_oce        ! ocean space and time domain variables
611   USE zdf_oce        ! ocean vertical physics variables
612   USE zdfddm         ! ocean vertical physics: double diffusive mixing
613   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
614   USE eosbn2         ! ocean equation of state
615   USE phycst         ! physical constants
616   USE prtctl         ! Print control
617   USE in_out_manager ! I/O manager
618   USE iom            ! I/O Manager
619   USE lib_mpp        ! MPP library
620   USE wrk_nemo       ! work arrays
621   USE timing         ! Timing
622   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) 
623
624   USE yomhook, ONLY: lhook, dr_hook
625   USE parkind1, ONLY: jprb, jpim
626
627   IMPLICIT NONE
628   PRIVATE
629
630   PUBLIC   zdf_tmx         ! called in step module
631   PUBLIC   zdf_tmx_init    ! called in nemogcm module
632   PUBLIC   zdf_tmx_alloc   ! called in nemogcm module
633
634   LOGICAL, PUBLIC, PARAMETER ::   lk_zdftmx = .TRUE.    !: wave-driven mixing flag
635
636   !                       !!* Namelist  namzdf_tmx : internal wave-driven mixing *
637   INTEGER  ::  nn_zpyc     ! pycnocline-intensified mixing energy proportional to N (=1) or N^2 (=2)
638   LOGICAL  ::  ln_mevar    ! variable (=T) or constant (=F) mixing efficiency
639   LOGICAL  ::  ln_tsdiff   ! account for differential T/S wave-driven mixing (=T) or not (=F)
640
641   REAL(wp) ::  r1_6 = 1._wp / 6._wp
642
643   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   ebot_tmx     ! power available from high-mode wave breaking (W/m2)
644   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   epyc_tmx     ! power available from low-mode, pycnocline-intensified wave breaking (W/m2)
645   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   ecri_tmx     ! power available from low-mode, critical slope wave breaking (W/m2)
646   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   hbot_tmx     ! WKB decay scale for high-mode energy dissipation (m)
647   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   hcri_tmx     ! decay scale for low-mode critical slope dissipation (m)
648   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   emix_tmx     ! local energy density available for mixing (W/kg)
649   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   bflx_tmx     ! buoyancy flux Kz * N^2 (W/kg)
650   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   pcmap_tmx    ! vertically integrated buoyancy flux (W/m2)
651   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   zav_ratio    ! S/T diffusivity ratio (only for ln_tsdiff=T)
652   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   zav_wave     ! Internal wave-induced diffusivity
653
654   !! * Substitutions
655#  include "zdfddm_substitute.h90"
656#  include "domzgr_substitute.h90"
657#  include "vectopt_loop_substitute.h90"
658   !!----------------------------------------------------------------------
659   !! NEMO/OPA 4.0 , NEMO Consortium (2016)
660   !! $Id$
661   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
662   !!----------------------------------------------------------------------
663CONTAINS
664
665   INTEGER FUNCTION zdf_tmx_alloc()
666   INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
667   INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
668   REAL(KIND=jprb)               :: zhook_handle
669
670   CHARACTER(LEN=*), PARAMETER :: RoutineName='ZDF_TMX_ALLOC'
671
672   IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
673
674      !!----------------------------------------------------------------------
675      !!                ***  FUNCTION zdf_tmx_alloc  ***
676      !!----------------------------------------------------------------------
677      ALLOCATE(     ebot_tmx(jpi,jpj),  epyc_tmx(jpi,jpj),  ecri_tmx(jpi,jpj)    ,   &
678      &             hbot_tmx(jpi,jpj),  hcri_tmx(jpi,jpj),  emix_tmx(jpi,jpj,jpk),   &
679      &         bflx_tmx(jpi,jpj,jpk), pcmap_tmx(jpi,jpj), zav_ratio(jpi,jpj,jpk),   & 
680      &         zav_wave(jpi,jpj,jpk), STAT=zdf_tmx_alloc     )
681      !
682      IF( lk_mpp             )   CALL mpp_sum ( zdf_tmx_alloc )
683      IF( zdf_tmx_alloc /= 0 )   CALL ctl_warn('zdf_tmx_alloc: failed to allocate arrays')
684   IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
685   END FUNCTION zdf_tmx_alloc
686
687
688   SUBROUTINE zdf_tmx( kt )
689      !!----------------------------------------------------------------------
690      !!                  ***  ROUTINE zdf_tmx  ***
691      !!                   
692      !! ** Purpose :   add to the vertical mixing coefficients the effect of
693      !!              breaking internal waves.
694      !!
695      !! ** Method  : - internal wave-driven vertical mixing is given by:
696      !!                  Kz_wave = min(  100 cm2/s, f(  Reb = emix_tmx /( Nu * N^2 )  )
697      !!              where emix_tmx is the 3D space distribution of the wave-breaking
698      !!              energy and Nu the molecular kinematic viscosity.
699      !!              The function f(Reb) is linear (constant mixing efficiency)
700      !!              if the namelist parameter ln_mevar = F and nonlinear if ln_mevar = T.
701      !!
702      !!              - Compute emix_tmx, the 3D power density that allows to compute
703      !!              Reb and therefrom the wave-induced vertical diffusivity.
704      !!              This is divided into three components:
705      !!                 1. Bottom-intensified low-mode dissipation at critical slopes
706      !!                     emix_tmx(z) = ( ecri_tmx / rau0 ) * EXP( -(H-z)/hcri_tmx )
707      !!                                   / ( 1. - EXP( - H/hcri_tmx ) ) * hcri_tmx
708      !!              where hcri_tmx is the characteristic length scale of the bottom
709      !!              intensification, ecri_tmx a map of available power, and H the ocean depth.
710      !!                 2. Pycnocline-intensified low-mode dissipation
711      !!                     emix_tmx(z) = ( epyc_tmx / rau0 ) * ( sqrt(rn2(z))^nn_zpyc )
712      !!                                   / SUM( sqrt(rn2(z))^nn_zpyc * e3w(z) )
713      !!              where epyc_tmx is a map of available power, and nn_zpyc
714      !!              is the chosen stratification-dependence of the internal wave
715      !!              energy dissipation.
716      !!                 3. WKB-height dependent high mode dissipation
717      !!                     emix_tmx(z) = ( ebot_tmx / rau0 ) * rn2(z) * EXP(-z_wkb(z)/hbot_tmx)
718      !!                                   / SUM( rn2(z) * EXP(-z_wkb(z)/hbot_tmx) * e3w(z) )
719      !!              where hbot_tmx is the characteristic length scale of the WKB bottom
720      !!              intensification, ebot_tmx is a map of available power, and z_wkb is the
721      !!              WKB-stretched height above bottom defined as
722      !!                    z_wkb(z) = H * SUM( sqrt(rn2(z'>=z)) * e3w(z'>=z) )
723      !!                                 / SUM( sqrt(rn2(z'))    * e3w(z')    )
724      !!
725      !!              - update the model vertical eddy viscosity and diffusivity:
726      !!                     avt  = avt  +    av_wave
727      !!                     avm  = avm  +    av_wave
728      !!                     avmu = avmu + mi(av_wave)
729      !!                     avmv = avmv + mj(av_wave)
730      !!
731      !!              - if namelist parameter ln_tsdiff = T, account for differential mixing:
732      !!                     avs  = avt  +    av_wave * diffusivity_ratio(Reb)
733      !!
734      !! ** Action  : - Define emix_tmx used to compute internal wave-induced mixing
735      !!              - avt, avs, avm, avmu, avmv increased by internal wave-driven mixing   
736      !!
737      !! References :  de Lavergne et al. 2015, JPO; 2016, in prep.
738      !!----------------------------------------------------------------------
739      INTEGER, INTENT(in) ::   kt   ! ocean time-step
740      !
741      INTEGER  ::   ji, jj, jk   ! dummy loop indices
742      REAL(wp) ::   ztpc         ! scalar workspace
743      REAL(wp), DIMENSION(:,:)  , POINTER ::  zfact     ! Used for vertical structure
744      REAL(wp), DIMENSION(:,:)  , POINTER ::  zhdep     ! Ocean depth
745      REAL(wp), DIMENSION(:,:,:), POINTER ::  zwkb      ! WKB-stretched height above bottom
746      REAL(wp), DIMENSION(:,:,:), POINTER ::  zweight   ! Weight for high mode vertical distribution
747      REAL(wp), DIMENSION(:,:,:), POINTER ::  znu_t     ! Molecular kinematic viscosity (T grid)
748      REAL(wp), DIMENSION(:,:,:), POINTER ::  znu_w     ! Molecular kinematic viscosity (W grid)
749      REAL(wp), DIMENSION(:,:,:), POINTER ::  zReb      ! Turbulence intensity parameter
750      INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
751      INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
752      REAL(KIND=jprb)               :: zhook_handle
753
754      CHARACTER(LEN=*), PARAMETER :: RoutineName='ZDF_TMX'
755
756      IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
757
758      !!----------------------------------------------------------------------
759      !
760      IF( nn_timing == 1 )   CALL timing_start('zdf_tmx')
761      !
762      CALL wrk_alloc( jpi,jpj,       zfact, zhdep )
763      CALL wrk_alloc( jpi,jpj,jpk,   zwkb, zweight, znu_t, znu_w, zReb )
764
765      !                          ! ----------------------------- !
766      !                          !  Internal wave-driven mixing  !  (compute zav_wave)
767      !                          ! ----------------------------- !
768      !                             
769      !                        !* Critical slope mixing: distribute energy over the time-varying ocean depth,
770      !                                                 using an exponential decay from the seafloor.
771      DO jj = 1, jpj                ! part independent of the level
772         DO ji = 1, jpi
773            zhdep(ji,jj) = fsdepw(ji,jj,mbkt(ji,jj)+1)       ! depth of the ocean
774            zfact(ji,jj) = rau0 * (  1._wp - EXP( -zhdep(ji,jj) / hcri_tmx(ji,jj) )  )
775            IF( zfact(ji,jj) /= 0 )   zfact(ji,jj) = ecri_tmx(ji,jj) / zfact(ji,jj)
776         END DO
777      END DO
778
779      DO jk = 2, jpkm1              ! complete with the level-dependent part
780         emix_tmx(:,:,jk) = zfact(:,:) * (  EXP( ( fsde3w(:,:,jk  ) - zhdep(:,:) ) / hcri_tmx(:,:) )                      &
781            &                             - EXP( ( fsde3w(:,:,jk-1) - zhdep(:,:) ) / hcri_tmx(:,:) )  ) * wmask(:,:,jk)   &
782            &                          / ( fsde3w(:,:,jk) - fsde3w(:,:,jk-1) )
783      END DO
784
785      !                        !* Pycnocline-intensified mixing: distribute energy over the time-varying
786      !                        !* ocean depth as proportional to sqrt(rn2)^nn_zpyc
787
788      SELECT CASE ( nn_zpyc )
789
790      CASE ( 1 )               ! Dissipation scales as N (recommended)
791
792         zfact(:,:) = 0._wp
793         DO jk = 2, jpkm1              ! part independent of the level
794            zfact(:,:) = zfact(:,:) + fse3w(:,:,jk) * SQRT(  MAX( 0._wp, rn2(:,:,jk) )  ) * wmask(:,:,jk)
795         END DO
796
797         DO jj = 1, jpj
798            DO ji = 1, jpi
799               IF( zfact(ji,jj) /= 0 )   zfact(ji,jj) = epyc_tmx(ji,jj) / ( rau0 * zfact(ji,jj) )
800            END DO
801         END DO
802
803         DO jk = 2, jpkm1              ! complete with the level-dependent part
804            emix_tmx(:,:,jk) = emix_tmx(:,:,jk) + zfact(:,:) * SQRT(  MAX( 0._wp, rn2(:,:,jk) )  ) * wmask(:,:,jk)
805         END DO
806
807      CASE ( 2 )               ! Dissipation scales as N^2
808
809         zfact(:,:) = 0._wp
810         DO jk = 2, jpkm1              ! part independent of the level
811            zfact(:,:) = zfact(:,:) + fse3w(:,:,jk) * MAX( 0._wp, rn2(:,:,jk) ) * wmask(:,:,jk)
812         END DO
813
814         DO jj= 1, jpj
815            DO ji = 1, jpi
816               IF( zfact(ji,jj) /= 0 )   zfact(ji,jj) = epyc_tmx(ji,jj) / ( rau0 * zfact(ji,jj) )
817            END DO
818         END DO
819
820         DO jk = 2, jpkm1              ! complete with the level-dependent part
821            emix_tmx(:,:,jk) = emix_tmx(:,:,jk) + zfact(:,:) * MAX( 0._wp, rn2(:,:,jk) ) * wmask(:,:,jk)
822         END DO
823
824      END SELECT
825
826      !                        !* WKB-height dependent mixing: distribute energy over the time-varying
827      !                        !* ocean depth as proportional to rn2 * exp(-z_wkb/rn_hbot)
828     
829      zwkb(:,:,:) = 0._wp
830      zfact(:,:) = 0._wp
831      DO jk = 2, jpkm1
832         zfact(:,:) = zfact(:,:) + fse3w(:,:,jk) * SQRT(  MAX( 0._wp, rn2(:,:,jk) )  ) * wmask(:,:,jk)
833         zwkb(:,:,jk) = zfact(:,:)
834      END DO
835
836      DO jk = 2, jpkm1
837         DO jj = 1, jpj
838            DO ji = 1, jpi
839               IF( zfact(ji,jj) /= 0 )   zwkb(ji,jj,jk) = zhdep(ji,jj) * ( zfact(ji,jj) - zwkb(ji,jj,jk) )   &
840                                            &           * tmask(ji,jj,jk) / zfact(ji,jj)
841            END DO
842         END DO
843      END DO
844      zwkb(:,:,1) = zhdep(:,:) * tmask(:,:,1)
845
846      zweight(:,:,:) = 0._wp
847      DO jk = 2, jpkm1
848         zweight(:,:,jk) = MAX( 0._wp, rn2(:,:,jk) ) * hbot_tmx(:,:) * wmask(:,:,jk)                    &
849            &   * (  EXP( -zwkb(:,:,jk) / hbot_tmx(:,:) ) - EXP( -zwkb(:,:,jk-1) / hbot_tmx(:,:) )  )
850      END DO
851
852      zfact(:,:) = 0._wp
853      DO jk = 2, jpkm1              ! part independent of the level
854         zfact(:,:) = zfact(:,:) + zweight(:,:,jk)
855      END DO
856
857      DO jj = 1, jpj
858         DO ji = 1, jpi
859            IF( zfact(ji,jj) /= 0 )   zfact(ji,jj) = ebot_tmx(ji,jj) / ( rau0 * zfact(ji,jj) )
860         END DO
861      END DO
862
863      DO jk = 2, jpkm1              ! complete with the level-dependent part
864         emix_tmx(:,:,jk) = emix_tmx(:,:,jk) + zweight(:,:,jk) * zfact(:,:) * wmask(:,:,jk)   &
865            &                                / ( fsde3w(:,:,jk) - fsde3w(:,:,jk-1) )
866      END DO
867
868
869      ! Calculate molecular kinematic viscosity
870      znu_t(:,:,:) = 1.e-4_wp * (  17.91_wp - 0.53810_wp * tsn(:,:,:,jp_tem) + 0.00694_wp * tsn(:,:,:,jp_tem) * tsn(:,:,:,jp_tem)  &
871         &                                  + 0.02305_wp * tsn(:,:,:,jp_sal)  ) * tmask(:,:,:) * r1_rau0
872      DO jk = 2, jpkm1
873         znu_w(:,:,jk) = 0.5_wp * ( znu_t(:,:,jk-1) + znu_t(:,:,jk) ) * wmask(:,:,jk)
874      END DO
875
876      ! Calculate turbulence intensity parameter Reb
877      DO jk = 2, jpkm1
878         zReb(:,:,jk) = emix_tmx(:,:,jk) / MAX( 1.e-20_wp, znu_w(:,:,jk) * rn2(:,:,jk) )
879      END DO
880
881      ! Define internal wave-induced diffusivity
882      DO jk = 2, jpkm1
883         zav_wave(:,:,jk) = znu_w(:,:,jk) * zReb(:,:,jk) * r1_6   ! This corresponds to a constant mixing efficiency of 1/6
884      END DO
885
886      IF( ln_mevar ) THEN              ! Variable mixing efficiency case : modify zav_wave in the
887         DO jk = 2, jpkm1              ! energetic (Reb > 480) and buoyancy-controlled (Reb <10.224 ) regimes
888            DO jj = 1, jpj
889               DO ji = 1, jpi
890                  IF( zReb(ji,jj,jk) > 480.00_wp ) THEN
891                     zav_wave(ji,jj,jk) = 3.6515_wp * znu_w(ji,jj,jk) * SQRT( zReb(ji,jj,jk) )
892                  ELSEIF( zReb(ji,jj,jk) < 10.224_wp ) THEN
893                     zav_wave(ji,jj,jk) = 0.052125_wp * znu_w(ji,jj,jk) * zReb(ji,jj,jk) * SQRT( zReb(ji,jj,jk) )
894                  ENDIF
895               END DO
896            END DO
897         END DO
898      ENDIF
899
900      DO jk = 2, jpkm1                 ! Bound diffusivity by molecular value and 100 cm2/s
901         zav_wave(:,:,jk) = MIN(  MAX( 1.4e-7_wp, zav_wave(:,:,jk) ), 1.e-2_wp  ) * wmask(:,:,jk)
902      END DO
903
904      IF( kt == nit000 ) THEN        !* Control print at first time-step: diagnose the energy consumed by zav_wave
905         ztpc = 0._wp
906         DO jk = 2, jpkm1
907            DO jj = 1, jpj
908               DO ji = 1, jpi
909                  ztpc = ztpc + fse3w(ji,jj,jk) * e1e2t(ji,jj)   &
910                     &         * MAX( 0._wp, rn2(ji,jj,jk) ) * zav_wave(ji,jj,jk) * wmask(ji,jj,jk) * tmask_i(ji,jj)
911               END DO
912            END DO
913         END DO
914         IF( lk_mpp )   CALL mpp_sum( ztpc )
915         ztpc = rau0 * ztpc ! Global integral of rauo * Kz * N^2 = power contributing to mixing
916 
917         IF(lwp) THEN
918            WRITE(numout,*)
919            WRITE(numout,*) 'zdf_tmx : Internal wave-driven mixing (tmx)'
920            WRITE(numout,*) '~~~~~~~ '
921            WRITE(numout,*)
922            WRITE(numout,*) '      Total power consumption by av_wave: ztpc =  ', ztpc * 1.e-12_wp, 'TW'
923         ENDIF
924      ENDIF
925
926      !                          ! ----------------------- !
927      !                          !   Update  mixing coefs  !                         
928      !                          ! ----------------------- !
929      !     
930      IF( ln_tsdiff ) THEN          !* Option for differential mixing of salinity and temperature
931         DO jk = 2, jpkm1              ! Calculate S/T diffusivity ratio as a function of Reb
932            DO jj = 1, jpj
933               DO ji = 1, jpi
934                  zav_ratio(ji,jj,jk) = ( 0.505_wp + 0.495_wp *                                                                  &
935                      &   TANH(    0.92_wp * (   LOG10(  MAX( 1.e-20_wp, zReb(ji,jj,jk) * 5._wp * r1_6 )  ) - 0.60_wp   )    )   &
936                      &                 ) * wmask(ji,jj,jk)
937               END DO
938            END DO
939         END DO
940         CALL iom_put( "av_ratio", zav_ratio )
941         DO jk = 2, jpkm1           !* update momentum & tracer diffusivity with wave-driven mixing
942            fsavs(:,:,jk) = avt(:,:,jk) + zav_wave(:,:,jk) * zav_ratio(:,:,jk)
943            avt  (:,:,jk) = avt(:,:,jk) + zav_wave(:,:,jk)
944            avm  (:,:,jk) = avm(:,:,jk) + zav_wave(:,:,jk)
945         END DO
946         !
947      ELSE                          !* update momentum & tracer diffusivity with wave-driven mixing
948         DO jk = 2, jpkm1
949            fsavs(:,:,jk) = avt(:,:,jk) + zav_wave(:,:,jk)
950            avt  (:,:,jk) = avt(:,:,jk) + zav_wave(:,:,jk)
951            avm  (:,:,jk) = avm(:,:,jk) + zav_wave(:,:,jk)
952         END DO
953      ENDIF
954
955      DO jk = 2, jpkm1              !* update momentum diffusivity at wu and wv points
956         DO jj = 2, jpjm1
957            DO ji = fs_2, fs_jpim1  ! vector opt.
958               avmu(ji,jj,jk) = avmu(ji,jj,jk) + 0.5_wp * ( zav_wave(ji,jj,jk) + zav_wave(ji+1,jj  ,jk) ) * wumask(ji,jj,jk)
959               avmv(ji,jj,jk) = avmv(ji,jj,jk) + 0.5_wp * ( zav_wave(ji,jj,jk) + zav_wave(ji  ,jj+1,jk) ) * wvmask(ji,jj,jk)
960            END DO
961         END DO
962      END DO
963      CALL lbc_lnk( avmu, 'U', 1. )   ;   CALL lbc_lnk( avmv, 'V', 1. )      ! lateral boundary condition
964
965      !                             !* output internal wave-driven mixing coefficient
966      CALL iom_put( "av_wave", zav_wave )
967                                    !* output useful diagnostics: N^2, Kz * N^2 (bflx_tmx),
968                                    !  vertical integral of rau0 * Kz * N^2 (pcmap_tmx), energy density (emix_tmx)
969      IF( iom_use("bflx_tmx") .OR. iom_use("pcmap_tmx") ) THEN
970         bflx_tmx(:,:,:) = MAX( 0._wp, rn2(:,:,:) ) * zav_wave(:,:,:)
971         pcmap_tmx(:,:) = 0._wp
972         DO jk = 2, jpkm1
973            pcmap_tmx(:,:) = pcmap_tmx(:,:) + fse3w(:,:,jk) * bflx_tmx(:,:,jk) * wmask(:,:,jk)
974         END DO
975         pcmap_tmx(:,:) = rau0 * pcmap_tmx(:,:)
976         CALL iom_put( "bflx_tmx", bflx_tmx )
977         CALL iom_put( "pcmap_tmx", pcmap_tmx )
978      ENDIF
979      CALL iom_put( "emix_tmx", emix_tmx )
980     
981      CALL wrk_dealloc( jpi,jpj,       zfact, zhdep )
982      CALL wrk_dealloc( jpi,jpj,jpk,   zwkb, zweight, znu_t, znu_w, zReb )
983
984      IF(ln_ctl)   CALL prt_ctl(tab3d_1=zav_wave , clinfo1=' tmx - av_wave: ', tab3d_2=avt, clinfo2=' avt: ', ovlap=1, kdim=jpk)
985      !
986      IF( nn_timing == 1 )   CALL timing_stop('zdf_tmx')
987      !
988      IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
989   END SUBROUTINE zdf_tmx
990
991
992   SUBROUTINE zdf_tmx_init
993      !!----------------------------------------------------------------------
994      !!                  ***  ROUTINE zdf_tmx_init  ***
995      !!                     
996      !! ** Purpose :   Initialization of the wave-driven vertical mixing, reading
997      !!              of input power maps and decay length scales in netcdf files.
998      !!
999      !! ** Method  : - Read the namzdf_tmx namelist and check the parameters
1000      !!
1001      !!              - Read the input data in NetCDF files :
1002      !!              power available from high-mode wave breaking (mixing_power_bot.nc)
1003      !!              power available from pycnocline-intensified wave-breaking (mixing_power_pyc.nc)
1004      !!              power available from critical slope wave-breaking (mixing_power_cri.nc)
1005      !!              WKB decay scale for high-mode wave-breaking (decay_scale_bot.nc)
1006      !!              decay scale for critical slope wave-breaking (decay_scale_cri.nc)
1007      !!
1008      !! ** input   : - Namlist namzdf_tmx
1009      !!              - NetCDF files : mixing_power_bot.nc, mixing_power_pyc.nc, mixing_power_cri.nc,
1010      !!              decay_scale_bot.nc decay_scale_cri.nc
1011      !!
1012      !! ** Action  : - Increase by 1 the nstop flag is setting problem encounter
1013      !!              - Define ebot_tmx, epyc_tmx, ecri_tmx, hbot_tmx, hcri_tmx
1014      !!
1015      !! References : de Lavergne et al. 2015, JPO; 2016, in prep.
1016      !!         
1017      !!----------------------------------------------------------------------
1018      INTEGER  ::   ji, jj, jk   ! dummy loop indices
1019      INTEGER  ::   inum         ! local integer
1020      INTEGER  ::   ios
1021      REAL(wp) ::   zbot, zpyc, zcri   ! local scalars
1022      !!
1023      NAMELIST/namzdf_tmx_new/ nn_zpyc, ln_mevar, ln_tsdiff
1024      INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
1025      INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
1026      REAL(KIND=jprb)               :: zhook_handle
1027
1028      CHARACTER(LEN=*), PARAMETER :: RoutineName='ZDF_TMX_INIT'
1029
1030      IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
1031
1032      !!----------------------------------------------------------------------
1033      !
1034      IF( nn_timing == 1 )  CALL timing_start('zdf_tmx_init')
1035      !
1036      REWIND( numnam_ref )              ! Namelist namzdf_tmx in reference namelist : Wave-driven mixing
1037      READ  ( numnam_ref, namzdf_tmx_new, IOSTAT = ios, ERR = 901)
1038901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namzdf_tmx in reference namelist', lwp )
1039      !
1040      REWIND( numnam_cfg )              ! Namelist namzdf_tmx in configuration namelist : Wave-driven mixing
1041      READ  ( numnam_cfg, namzdf_tmx_new, IOSTAT = ios, ERR = 902 )
1042902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namzdf_tmx in configuration namelist', lwp )
1043      IF(lwm) WRITE ( numond, namzdf_tmx_new )
1044      !
1045      IF(lwp) THEN                  ! Control print
1046         WRITE(numout,*)
1047         WRITE(numout,*) 'zdf_tmx_init : internal wave-driven mixing'
1048         WRITE(numout,*) '~~~~~~~~~~~~'
1049         WRITE(numout,*) '   Namelist namzdf_tmx_new : set wave-driven mixing parameters'
1050         WRITE(numout,*) '      Pycnocline-intensified diss. scales as N (=1) or N^2 (=2) = ', nn_zpyc
1051         WRITE(numout,*) '      Variable (T) or constant (F) mixing efficiency            = ', ln_mevar
1052         WRITE(numout,*) '      Differential internal wave-driven mixing (T) or not (F)   = ', ln_tsdiff
1053      ENDIF
1054     
1055      ! The new wave-driven mixing parameterization elevates avt and avm in the interior, and
1056      ! ensures that avt remains larger than its molecular value (=1.4e-7). Therefore, avtb should
1057      ! be set here to a very small value, and avmb to its (uniform) molecular value (=1.4e-6).
1058      avmb(:) = 1.4e-6_wp        ! viscous molecular value
1059      avtb(:) = 1.e-10_wp        ! very small diffusive minimum (background avt is specified in zdf_tmx)   
1060      avtb_2d(:,:) = 1.e0_wp     ! uniform
1061      IF(lwp) THEN                  ! Control print
1062         WRITE(numout,*)
1063         WRITE(numout,*) '   Force the background value applied to avm & avt in TKE to be everywhere ',   &
1064            &               'the viscous molecular value & a very small diffusive value, resp.'
1065      ENDIF
1066     
1067      IF( .NOT.lk_zdfddm )   CALL ctl_stop( 'STOP', 'zdf_tmx_init_new : key_zdftmx_new requires key_zdfddm' )
1068     
1069      !                             ! allocate tmx arrays
1070      IF( zdf_tmx_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'zdf_tmx_init : unable to allocate tmx arrays' )
1071      !
1072      !                             ! read necessary fields
1073      CALL iom_open('mixing_power_bot',inum)       ! energy flux for high-mode wave breaking [W/m2]
1074      CALL iom_get  (inum, jpdom_data, 'field', ebot_tmx, 1 ) 
1075      CALL iom_close(inum)
1076      !
1077      CALL iom_open('mixing_power_pyc',inum)       ! energy flux for pynocline-intensified wave breaking [W/m2]
1078      CALL iom_get  (inum, jpdom_data, 'field', epyc_tmx, 1 )
1079      CALL iom_close(inum)
1080      !
1081      CALL iom_open('mixing_power_cri',inum)       ! energy flux for critical slope wave breaking [W/m2]
1082      CALL iom_get  (inum, jpdom_data, 'field', ecri_tmx, 1 )
1083      CALL iom_close(inum)
1084      !
1085      CALL iom_open('decay_scale_bot',inum)        ! spatially variable decay scale for high-mode wave breaking [m]
1086      CALL iom_get  (inum, jpdom_data, 'field', hbot_tmx, 1 )
1087      CALL iom_close(inum)
1088      !
1089      CALL iom_open('decay_scale_cri',inum)        ! spatially variable decay scale for critical slope wave breaking [m]
1090      CALL iom_get  (inum, jpdom_data, 'field', hcri_tmx, 1 )
1091      CALL iom_close(inum)
1092
1093      ebot_tmx(:,:) = ebot_tmx(:,:) * ssmask(:,:)
1094      epyc_tmx(:,:) = epyc_tmx(:,:) * ssmask(:,:)
1095      ecri_tmx(:,:) = ecri_tmx(:,:) * ssmask(:,:)
1096
1097      ! Set once for all to zero the first and last vertical levels of appropriate variables
1098      emix_tmx (:,:, 1 ) = 0._wp
1099      emix_tmx (:,:,jpk) = 0._wp
1100      zav_ratio(:,:, 1 ) = 0._wp
1101      zav_ratio(:,:,jpk) = 0._wp
1102      zav_wave (:,:, 1 ) = 0._wp
1103      zav_wave (:,:,jpk) = 0._wp
1104
1105      zbot = glob_sum( e1e2t(:,:) * ebot_tmx(:,:) )
1106      zpyc = glob_sum( e1e2t(:,:) * epyc_tmx(:,:) )
1107      zcri = glob_sum( e1e2t(:,:) * ecri_tmx(:,:) )
1108      IF(lwp) THEN
1109         WRITE(numout,*) '      High-mode wave-breaking energy:             ', zbot * 1.e-12_wp, 'TW'
1110         WRITE(numout,*) '      Pycnocline-intensifed wave-breaking energy: ', zpyc * 1.e-12_wp, 'TW'
1111         WRITE(numout,*) '      Critical slope wave-breaking energy:        ', zcri * 1.e-12_wp, 'TW'
1112      ENDIF
1113      !
1114      IF( nn_timing == 1 )  CALL timing_stop('zdf_tmx_init')
1115      !
1116      IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
1117   END SUBROUTINE zdf_tmx_init
1118
1119#else
1120   !!----------------------------------------------------------------------
1121   !!   Default option          Dummy module                NO Tidal MiXing
1122   !!----------------------------------------------------------------------
1123   LOGICAL, PUBLIC, PARAMETER ::   lk_zdftmx = .FALSE.   !: tidal mixing flag
1124CONTAINS
1125   SUBROUTINE zdf_tmx_init           ! Dummy routine
1126   INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
1127   INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
1128   REAL(KIND=jprb)               :: zhook_handle
1129
1130   CHARACTER(LEN=*), PARAMETER :: RoutineName='ZDF_TMX_INIT'
1131
1132   IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
1133
1134      WRITE(*,*) 'zdf_tmx: You should not have seen this print! error?'
1135   IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
1136   END SUBROUTINE zdf_tmx_init
1137   SUBROUTINE zdf_tmx( kt )          ! Dummy routine
1138   INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
1139   INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
1140   REAL(KIND=jprb)               :: zhook_handle
1141
1142   CHARACTER(LEN=*), PARAMETER :: RoutineName='ZDF_TMX'
1143
1144   IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
1145
1146      WRITE(*,*) 'zdf_tmx: You should not have seen this print! error?', kt
1147   IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
1148   END SUBROUTINE zdf_tmx
1149#endif
1150
1151   !!======================================================================
1152END MODULE zdftmx
Note: See TracBrowser for help on using the repository browser.