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/test_moci_test_suite_namelist_read/NEMOGCM/NEMO/OPA_SRC/ZDF – NEMO

Context Navigation

source: branches/UKMO/test_moci_test_suite_namelist_read/NEMOGCM/NEMO/OPA_SRC/ZDF/zdftmx.F90 @ 9366

Last change on this file since 9366 was 9366, checked in by andmirek, 6 years ago
#2050 first version. Compiled OK in moci test suite
File size: 53.9 KB

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats: