Context Navigation

zdftmx.F90

Last change on this file was 5879, checked in by snguyen, 3 years ago

Modified Makefile to add configuration PALEOIPSLCM5A2-VLR while retaining IPSLCM5A2-VLR as default configuration for compilation. Moved NEMO SOURCES of IPSLCM5A2-VLR to SOURCES/NEMO/STANDARD and created SOURCES/NEMO/PALEO for PALEOIPSLCM5A2-VLR configuration. Created paleolmdz in Makefile to compile LMDZ sources in SOURCES/LMDZ/PALEO. Added experiments IPSLCM/paleo and LMDZOR/paleo. Added file_def_nemo-lim2_paleo.xml file_def_histmth_lmdz_paleo.xml file_def_nemo-opa_paleo.xml file_def_nemo-pisces_rivers_paleo.xml file_def_nemo-pisces_paleo.xml file_def_orchidee_paleo.xml namelist_ORCA2_cfg_paleo namelist_pisces_ORCA2_cfg_paleo to GENERAL/PARAM for paleo configurations. Set day_step=720 in GENERAL/PARAM/gcm.def_96x95 for paleo configurations. Modified GENERAL/DRIVER/opa9.driver to use namelist_ORCA2_cfg_paleo for paleo configurations.

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

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

Context Navigation

source: CONFIG/UNIFORM/v6/IPSLCM5A2/SOURCES/NEMO/PALEO/zdftmx.F90

Download in other formats: