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.

zdftke.F90 in branches/2017/dev_r7881_HPC09_ZDF/NEMOGCM/NEMO/OPA_SRC/ZDF – NEMO

Context Navigation

source: branches/2017/dev_r7881_HPC09_ZDF/NEMOGCM/NEMO/OPA_SRC/ZDF/zdftke.F90 @ 7953

Last change on this file since 7953 was 7953, checked in by gm, 7 years ago
#1880 (HPC-09): add zdfphy (the ZDF manager) + remove all key_...
Property svn:keywords set to `Id`
File size: 46.2 KB

Rev	Line
[1531]	1	MODULE zdftke
[1239]	2	!!======================================================================
[1531]	3	!! * MODULE zdftke *
[1239]	4	!! Ocean physics: vertical mixing coefficient computed from the tke
	5	!! turbulent closure parameterization
	6	!!=====================================================================
[1492]	7	!! History : OPA ! 1991-03 (b. blanke) Original code
	8	!! 7.0 ! 1991-11 (G. Madec) bug fix
	9	!! 7.1 ! 1992-10 (G. Madec) new mixing length and eav
	10	!! 7.2 ! 1993-03 (M. Guyon) symetrical conditions
	11	!! 7.3 ! 1994-08 (G. Madec, M. Imbard) nn_pdl flag
	12	!! 7.5 ! 1996-01 (G. Madec) s-coordinates
	13	!! 8.0 ! 1997-07 (G. Madec) lbc
	14	!! 8.1 ! 1999-01 (E. Stretta) new option for the mixing length
	15	!! NEMO 1.0 ! 2002-06 (G. Madec) add tke_init routine
	16	!! - ! 2004-10 (C. Ethe ) 1D configuration
	17	!! 2.0 ! 2006-07 (S. Masson) distributed restart using iom
	18	!! 3.0 ! 2008-05 (C. Ethe, G.Madec) : update TKE physics:
	19	!! ! - tke penetration (wind steering)
	20	!! ! - suface condition for tke & mixing length
	21	!! ! - Langmuir cells
	22	!! - ! 2008-05 (J.-M. Molines, G. Madec) 2D form of avtb
	23	!! - ! 2008-06 (G. Madec) style + DOCTOR name for namelist parameters
	24	!! - ! 2008-12 (G. Reffray) stable discretization of the production term
	25	!! 3.2 ! 2009-06 (G. Madec, S. Masson) TKE restart compatible with key_cpl
	26	!! ! + cleaning of the parameters + bugs correction
[2528]	27	!! 3.3 ! 2010-10 (C. Ethe, G. Madec) reorganisation of initialisation phase
[5120]	28	!! 3.6 ! 2014-11 (P. Mathiot) add ice shelf capability
[7953]	29	!! 4.0 ! 2017-04 (G. Madec) Remove CPP keys
[1239]	30	!!----------------------------------------------------------------------
[7953]	31
[1239]	32	!!----------------------------------------------------------------------
[3625]	33	!! zdf_tke : update momentum and tracer Kz from a tke scheme
	34	!! tke_tke : tke time stepping: update tke at now time step (en)
	35	!! tke_avn : compute mixing length scale and deduce avm and avt
	36	!! zdf_tke_init : initialization, namelist read, and parameters control
	37	!! tke_rst : read/write tke restart in ocean restart file
[1239]	38	!!----------------------------------------------------------------------
[2528]	39	USE oce ! ocean: dynamics and active tracers variables
	40	USE phycst ! physical constants
	41	USE dom_oce ! domain: ocean
	42	USE domvvl ! domain: variable volume layer
[1492]	43	USE sbc_oce ! surface boundary condition: ocean
[2528]	44	USE zdf_oce ! vertical physics: ocean variables
	45	USE zdfmxl ! vertical physics: mixed layer
[1492]	46	USE lbclnk ! ocean lateral boundary conditions (or mpp link)
	47	USE prtctl ! Print control
	48	USE in_out_manager ! I/O manager
	49	USE iom ! I/O manager library
[2715]	50	USE lib_mpp ! MPP library
[3294]	51	USE wrk_nemo ! work arrays
	52	USE timing ! Timing
[3625]	53	USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
[5656]	54	#if defined key_agrif
	55	USE agrif_opa_interp
	56	USE agrif_opa_update
	57	#endif
[1239]	58
	59	IMPLICIT NONE
	60	PRIVATE
	61
[2528]	62	PUBLIC zdf_tke ! routine called in step module
	63	PUBLIC zdf_tke_init ! routine called in opa module
	64	PUBLIC tke_rst ! routine called in step module
[1239]	65
[4147]	66	! !! Namelist namzdf_tke
	67	LOGICAL :: ln_mxl0 ! mixing length scale surface value as function of wind stress or not
	68	INTEGER :: nn_mxl ! type of mixing length (=0/1/2/3)
	69	REAL(wp) :: rn_mxl0 ! surface min value of mixing length (kappaz_o=0.40.1 m) [m]
	70	INTEGER :: nn_pdl ! Prandtl number or not (ratio avt/avm) (=0/1)
	71	REAL(wp) :: rn_ediff ! coefficient for avt: avt=rn_ediffmxlsqrt(e)
	72	REAL(wp) :: rn_ediss ! coefficient of the Kolmogoroff dissipation
	73	REAL(wp) :: rn_ebb ! coefficient of the surface input of tke
	74	REAL(wp) :: rn_emin ! minimum value of tke [m2/s2]
	75	REAL(wp) :: rn_emin0 ! surface minimum value of tke [m2/s2]
	76	REAL(wp) :: rn_bshear ! background shear (>0) currently a numerical threshold (do not change it)
	77	INTEGER :: nn_etau ! type of depth penetration of surface tke (=0/1/2/3)
	78	INTEGER :: nn_htau ! type of tke profile of penetration (=0/1)
	79	REAL(wp) :: rn_efr ! fraction of TKE surface value which penetrates in the ocean
	80	LOGICAL :: ln_lc ! Langmuir cells (LC) as a source term of TKE or not
	81	REAL(wp) :: rn_lc ! coef to compute vertical velocity of Langmuir cells
[1239]	82
[4147]	83	REAL(wp) :: ri_cri ! critic Richardson number (deduced from rn_ediff and rn_ediss values)
	84	REAL(wp) :: rmxl_min ! minimum mixing length value (deduced from rn_ediff and rn_emin values) [m]
[2528]	85	REAL(wp) :: rhftau_add = 1.e-3_wp ! add offset applied to HF part of taum (nn_etau=3)
	86	REAL(wp) :: rhftau_scl = 1.0_wp ! scale factor applied to HF part of taum (nn_etau=3)
[1239]	87
[2715]	88	REAL(wp) , ALLOCATABLE, SAVE, DIMENSION(:,:) :: htau ! depth of tke penetration (nn_htau)
	89	REAL(wp) , ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: dissl ! now mixing lenght of dissipation
[5656]	90	REAL(wp) , ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: apdlr ! now mixing lenght of dissipation
[2715]	91	#if defined key_c1d
	92	! !! 1D cfg only ('key_c1d')
	93	REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e_dis, e_mix !: dissipation and mixing turbulent lengh scales
	94	REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e_pdl, e_ric !: prandl and local Richardson numbers
	95	#endif
[1492]	96
[1239]	97	!! * Substitutions
	98	# include "vectopt_loop_substitute.h90"
	99	!!----------------------------------------------------------------------
[5836]	100	!! NEMO/OPA 3.7 , NEMO Consortium (2015)
[2528]	101	!! $Id$
	102	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
[1239]	103	!!----------------------------------------------------------------------
	104	CONTAINS
	105
[2715]	106	INTEGER FUNCTION zdf_tke_alloc()
	107	!!----------------------------------------------------------------------
	108	!! * FUNCTION zdf_tke_alloc *
	109	!!----------------------------------------------------------------------
	110	ALLOCATE( &
	111	#if defined key_c1d
	112	& e_dis(jpi,jpj,jpk) , e_mix(jpi,jpj,jpk) , &
	113	& e_pdl(jpi,jpj,jpk) , e_ric(jpi,jpj,jpk) , &
	114	#endif
[5836]	115	& htau (jpi,jpj) , dissl(jpi,jpj,jpk) , &
	116	& apdlr(jpi,jpj,jpk) , STAT= zdf_tke_alloc )
[2715]	117	!
	118	IF( lk_mpp ) CALL mpp_sum ( zdf_tke_alloc )
	119	IF( zdf_tke_alloc /= 0 ) CALL ctl_warn('zdf_tke_alloc: failed to allocate arrays')
	120	!
	121	END FUNCTION zdf_tke_alloc
	122
	123
[1531]	124	SUBROUTINE zdf_tke( kt )
[1239]	125	!!----------------------------------------------------------------------
[1531]	126	!! * ROUTINE zdf_tke *
[1239]	127	!!
	128	!! ** Purpose : Compute the vertical eddy viscosity and diffusivity
[1492]	129	!! coefficients using a turbulent closure scheme (TKE).
[1239]	130	!!
[1492]	131	!! ** Method : The time evolution of the turbulent kinetic energy (tke)
	132	!! is computed from a prognostic equation :
	133	!! d(en)/dt = avm (d(u)/dz)**2 ! shear production
	134	!! + d( avm d(en)/dz )/dz ! diffusion of tke
	135	!! + avt N^2 ! stratif. destruc.
	136	!! - rn_ediss / emxl en**(2/3) ! Kolmogoroff dissipation
[1239]	137	!! with the boundary conditions:
[1695]	138	!! surface: en = max( rn_emin0, rn_ebb * taum )
[1239]	139	!! bottom : en = rn_emin
[1492]	140	!! The associated critical Richardson number is: ri_cri = 2/(2+rn_ediss/rn_ediff)
	141	!!
	142	!! The now Turbulent kinetic energy is computed using the following
	143	!! time stepping: implicit for vertical diffusion term, linearized semi
	144	!! implicit for kolmogoroff dissipation term, and explicit forward for
	145	!! both buoyancy and shear production terms. Therefore a tridiagonal
	146	!! linear system is solved. Note that buoyancy and shear terms are
	147	!! discretized in a energy conserving form (Bruchard 2002).
	148	!!
	149	!! The dissipative and mixing length scale are computed from en and
	150	!! the stratification (see tke_avn)
	151	!!
	152	!! The now vertical eddy vicosity and diffusivity coefficients are
	153	!! given by:
	154	!! avm = max( avtb, rn_ediff * zmxlm * en^1/2 )
	155	!! avt = max( avmb, pdl * avm )
[1239]	156	!! eav = max( avmb, avm )
[1492]	157	!! where pdl, the inverse of the Prandtl number is 1 if nn_pdl=0 and
	158	!! given by an empirical funtion of the localRichardson number if nn_pdl=1
[1239]	159	!!
	160	!! ** Action : compute en (now turbulent kinetic energy)
	161	!! update avt, avmu, avmv (before vertical eddy coef.)
	162	!!
	163	!! References : Gaspar et al., JGR, 1990,
	164	!! Blanke and Delecluse, JPO, 1991
	165	!! Mellor and Blumberg, JPO 2004
	166	!! Axell, JGR, 2002
[1492]	167	!! Bruchard OM 2002
[1239]	168	!!----------------------------------------------------------------------
[1492]	169	INTEGER, INTENT(in) :: kt ! ocean time step
	170	!!----------------------------------------------------------------------
[1481]	171	!
[5656]	172	#if defined key_agrif
	173	! interpolation parent grid => child grid for avm_k ( ex : at west border: update column 1 and 2)
	174	IF( .NOT.Agrif_Root() ) CALL Agrif_Tke
	175	#endif
	176	!
[3632]	177	IF( kt /= nit000 ) THEN ! restore before value to compute tke
[7753]	178	avt (:,:,:) = avt_k (:,:,:)
	179	avm (:,:,:) = avm_k (:,:,:)
	180	avmu(:,:,:) = avmu_k(:,:,:)
	181	avmv(:,:,:) = avmv_k(:,:,:)
[3632]	182	ENDIF
	183	!
[2528]	184	CALL tke_tke ! now tke (en)
[1492]	185	!
[2528]	186	CALL tke_avn ! now avt, avm, avmu, avmv
	187	!
[7753]	188	avt_k (:,:,:) = avt (:,:,:)
	189	avm_k (:,:,:) = avm (:,:,:)
	190	avmu_k(:,:,:) = avmu(:,:,:)
	191	avmv_k(:,:,:) = avmv(:,:,:)
[3632]	192	!
[5656]	193	#if defined key_agrif
	194	! Update child grid f => parent grid
	195	IF( .NOT.Agrif_Root() ) CALL Agrif_Update_Tke( kt ) ! children only
	196	#endif
	197	!
	198	END SUBROUTINE zdf_tke
[1239]	199
[1492]	200
[1481]	201	SUBROUTINE tke_tke
[1239]	202	!!----------------------------------------------------------------------
[1492]	203	!! * ROUTINE tke_tke *
	204	!!
	205	!! ** Purpose : Compute the now Turbulente Kinetic Energy (TKE)
	206	!!
	207	!! ** Method : - TKE surface boundary condition
[2528]	208	!! - source term due to Langmuir cells (Axell JGR 2002) (ln_lc=T)
[1492]	209	!! - source term due to shear (saved in avmu, avmv arrays)
	210	!! - Now TKE : resolution of the TKE equation by inverting
	211	!! a tridiagonal linear system by a "methode de chasse"
	212	!! - increase TKE due to surface and internal wave breaking
	213	!!
	214	!! ** Action : - en : now turbulent kinetic energy)
	215	!! - avmu, avmv : production of TKE by shear at u and v-points
	216	!! (= Kz dz[Ub] * dz[Un] )
[1239]	217	!! ---------------------------------------------------------------------
[1705]	218	INTEGER :: ji, jj, jk ! dummy loop arguments
[2528]	219	!!bfr INTEGER :: ikbu, ikbv, ikbum1, ikbvm1 ! temporary scalar
	220	!!bfr INTEGER :: ikbt, ikbumm1, ikbvmm1 ! temporary scalar
[1705]	221	REAL(wp) :: zrhoa = 1.22 ! Air density kg/m3
	222	REAL(wp) :: zcdrag = 1.5e-3 ! drag coefficient
	223	REAL(wp) :: zbbrau, zesh2 ! temporary scalars
	224	REAL(wp) :: zfact1, zfact2, zfact3 ! - -
	225	REAL(wp) :: ztx2 , zty2 , zcof ! - -
	226	REAL(wp) :: ztau , zdif ! - -
	227	REAL(wp) :: zus , zwlc , zind ! - -
	228	REAL(wp) :: zzd_up, zzd_lw ! - -
[2528]	229	!!bfr REAL(wp) :: zebot ! - -
[5836]	230	INTEGER , POINTER, DIMENSION(:,: ) :: imlc
	231	REAL(wp), POINTER, DIMENSION(:,: ) :: zhlc
	232	REAL(wp), POINTER, DIMENSION(:,:,:) :: zpelc, zdiag, zd_up, zd_lw, z3du, z3dv
[5656]	233	REAL(wp) :: zri ! local Richardson number
[1239]	234	!!--------------------------------------------------------------------
[1492]	235	!
[3294]	236	IF( nn_timing == 1 ) CALL timing_start('tke_tke')
	237	!
[5836]	238	CALL wrk_alloc( jpi,jpj, imlc ) ! integer
	239	CALL wrk_alloc( jpi,jpj, zhlc )
	240	CALL wrk_alloc( jpi,jpj,jpk, zpelc, zdiag, zd_up, zd_lw, z3du, z3dv )
[3294]	241	!
[1695]	242	zbbrau = rn_ebb / rau0 ! Local constant initialisation
[2528]	243	zfact1 = -.5_wp * rdt
	244	zfact2 = 1.5_wp * rdt * rn_ediss
	245	zfact3 = 0.5_wp * rn_ediss
[1492]	246	!
[5120]	247	!
[1492]	248	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	249	! ! Surface boundary condition on tke
	250	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[5120]	251	IF ( ln_isfcav ) THEN
	252	DO jj = 2, jpjm1 ! en(mikt(ji,jj)) = rn_emin
	253	DO ji = fs_2, fs_jpim1 ! vector opt.
[5836]	254	en(ji,jj,mikt(ji,jj)) = rn_emin * tmask(ji,jj,1)
[5120]	255	END DO
	256	END DO
	257	END IF
[1695]	258	DO jj = 2, jpjm1 ! en(1) = rn_ebb taum / rau0 (min value rn_emin0)
[1481]	259	DO ji = fs_2, fs_jpim1 ! vector opt.
[5120]	260	en(ji,jj,1) = MAX( rn_emin0, zbbrau * taum(ji,jj) ) * tmask(ji,jj,1)
[1481]	261	END DO
	262	END DO
[2528]	263
	264	!!bfr - start commented area
[1492]	265	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	266	! ! Bottom boundary condition on tke
	267	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[1719]	268	!
	269	!<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	270	! Tests to date have found the bottom boundary condition on tke to have very little effect.
	271	! The condition is coded here for completion but commented out until there is proof that the
	272	! computational cost is justified
	273	!<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	274	! en(bot) = (rn_ebb0/rau0)0.5sqrt(u_botfr^2+v_botfr^2) (min value rn_emin)
	275	!! DO jj = 2, jpjm1
	276	!! DO ji = fs_2, fs_jpim1 ! vector opt.
[2528]	277	!! ztx2 = bfrua(ji-1,jj) * ub(ji-1,jj,mbku(ji-1,jj)) + &
	278	!! bfrua(ji ,jj) * ub(ji ,jj,mbku(ji ,jj) )
	279	!! zty2 = bfrva(ji,jj ) * vb(ji,jj ,mbkv(ji,jj )) + &
	280	!! bfrva(ji,jj-1) * vb(ji,jj-1,mbkv(ji,jj-1) )
[1719]	281	!! zebot = 0.001875_wp * SQRT( ztx2 * ztx2 + zty2 * zty2 ) ! where 0.001875 = (rn_ebb0/rau0) * 0.5 = 3.75*0.5/1000.
[2528]	282	!! en (ji,jj,mbkt(ji,jj)+1) = MAX( zebot, rn_emin ) * tmask(ji,jj,1)
[1719]	283	!! END DO
	284	!! END DO
[2528]	285	!!bfr - end commented area
[1492]	286	!
	287	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[2528]	288	IF( ln_lc ) THEN ! Langmuir circulation source term added to tke (Axell JGR 2002)
[1492]	289	! !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[1239]	290	!
[1492]	291	! !* total energy produce by LC : cumulative sum over jk
[7753]	292	zpelc(:,:,1) = MAX( rn2b(:,:,1), 0._wp ) * gdepw_n(:,:,1) * e3w_n(:,:,1)
[1239]	293	DO jk = 2, jpk
[7753]	294	zpelc(:,:,jk) = zpelc(:,:,jk-1) + MAX( rn2b(:,:,jk), 0._wp ) * gdepw_n(:,:,jk) * e3w_n(:,:,jk)
[1239]	295	END DO
[1492]	296	! !* finite Langmuir Circulation depth
[1705]	297	zcof = 0.5 * 0.016 * 0.016 / ( zrhoa * zcdrag )
[7753]	298	imlc(:,:) = mbkt(:,:) + 1 ! Initialization to the number of w ocean point (=2 over land)
[1239]	299	DO jk = jpkm1, 2, -1
[1492]	300	DO jj = 1, jpj ! Last w-level at which zpelc>=0.5usus
	301	DO ji = 1, jpi ! with us=0.016*wind(starting from jpk-1)
[1705]	302	zus = zcof * taum(ji,jj)
[1239]	303	IF( zpelc(ji,jj,jk) > zus ) imlc(ji,jj) = jk
	304	END DO
	305	END DO
	306	END DO
[1492]	307	! ! finite LC depth
	308	DO jj = 1, jpj
[1239]	309	DO ji = 1, jpi
[6140]	310	zhlc(ji,jj) = gdepw_n(ji,jj,imlc(ji,jj))
[1239]	311	END DO
	312	END DO
[1705]	313	zcof = 0.016 / SQRT( zrhoa * zcdrag )
[1492]	314	DO jk = 2, jpkm1 !* TKE Langmuir circulation source term added to en
[1239]	315	DO jj = 2, jpjm1
	316	DO ji = fs_2, fs_jpim1 ! vector opt.
[1705]	317	zus = zcof * SQRT( taum(ji,jj) ) ! Stokes drift
[1492]	318	! ! vertical velocity due to LC
[6140]	319	zind = 0.5 - SIGN( 0.5, gdepw_n(ji,jj,jk) - zhlc(ji,jj) )
	320	zwlc = zind * rn_lc * zus * SIN( rpi * gdepw_n(ji,jj,jk) / zhlc(ji,jj) )
[1492]	321	! ! TKE Langmuir circulation source term
[7813]	322	en(ji,jj,jk) = en(ji,jj,jk) + rdt * MAX(0.,1._wp - 2.fr_i(ji,jj) ) ( zwlc * zwlc * zwlc ) &
[6497]	323	& / zhlc(ji,jj) * wmask(ji,jj,jk) * tmask(ji,jj,1)
[1239]	324	END DO
	325	END DO
	326	END DO
	327	!
	328	ENDIF
[1492]	329	!
	330	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	331	! ! Now Turbulent kinetic energy (output in en)
	332	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	333	! ! Resolution of a tridiagonal linear system by a "methode de chasse"
	334	! ! computation from level 2 to jpkm1 (e(1) already computed and e(jpk)=0 ).
	335	! ! zdiag : diagonal zd_up : upper diagonal zd_lw : lower diagonal
	336	!
	337	DO jk = 2, jpkm1 !* Shear production at uw- and vw-points (energy conserving form)
[5656]	338	DO jj = 1, jpjm1
	339	DO ji = 1, fs_jpim1 ! vector opt.
	340	z3du(ji,jj,jk) = 0.5 * ( avm(ji,jj,jk ) + avm(ji+1,jj,jk) ) &
	341	& * ( un(ji,jj,jk-1) - un(ji ,jj,jk) ) &
[5803]	342	& * ( ub(ji,jj,jk-1) - ub(ji ,jj,jk) ) * wumask(ji,jj,jk) &
[6140]	343	& / ( e3uw_n(ji,jj,jk) * e3uw_b(ji,jj,jk) )
[5656]	344	z3dv(ji,jj,jk) = 0.5 * ( avm(ji,jj,jk ) + avm(ji,jj+1,jk) ) &
	345	& * ( vn(ji,jj,jk-1) - vn(ji,jj ,jk) ) &
[5803]	346	& * ( vb(ji,jj,jk-1) - vb(ji,jj ,jk) ) * wvmask(ji,jj,jk) &
[6140]	347	& / ( e3vw_n(ji,jj,jk) * e3vw_b(ji,jj,jk) )
[1492]	348	END DO
	349	END DO
	350	END DO
	351	!
[5656]	352	IF( nn_pdl == 1 ) THEN !* Prandtl number case: compute apdlr
	353	! Note that zesh2 is also computed in the next loop.
	354	! We decided to compute it twice to keep code readability and avoid an IF case in the DO loops
	355	DO jk = 2, jpkm1
	356	DO jj = 2, jpjm1
	357	DO ji = fs_2, fs_jpim1 ! vector opt.
	358	! ! shear prod. at w-point weightened by mask
	359	zesh2 = ( z3du(ji-1,jj,jk) + z3du(ji,jj,jk) ) / MAX( 1._wp , umask(ji-1,jj,jk) + umask(ji,jj,jk) ) &
	360	& + ( z3dv(ji,jj-1,jk) + z3dv(ji,jj,jk) ) / MAX( 1._wp , vmask(ji,jj-1,jk) + vmask(ji,jj,jk) )
	361	! ! local Richardson number
	362	zri = MAX( rn2b(ji,jj,jk), 0._wp ) * avm(ji,jj,jk) / ( zesh2 + rn_bshear )
	363	apdlr(ji,jj,jk) = MAX( 0.1_wp, ri_cri / MAX( ri_cri , zri ) )
	364
	365	END DO
	366	END DO
	367	END DO
	368	!
	369	ENDIF
[5836]	370	!
[5120]	371	DO jk = 2, jpkm1 !* Matrix and right hand side in en
	372	DO jj = 2, jpjm1
	373	DO ji = fs_2, fs_jpim1 ! vector opt.
[1492]	374	zcof = zfact1 * tmask(ji,jj,jk)
[7953]	375	! ! A minimum of 2.e-5 m2/s is imposed on TKE vertical
	376	! ! eddy coefficient (ensure numerical stability)
	377	zzd_up = zcof * MAX( avm(ji,jj,jk+1) + avm(ji,jj,jk ) , 2.e-5_wp ) & ! upper diagonal
	378	& / ( e3t_n(ji,jj,jk ) * e3w_n(ji,jj,jk ) )
	379	zzd_lw = zcof * MAX( avm(ji,jj,jk ) + avm(ji,jj,jk-1) , 2.e-5_wp ) & ! lower diagonal
	380	& / ( e3t_n(ji,jj,jk-1) * e3w_n(ji,jj,jk ) )
	381	!
[5656]	382	! ! shear prod. at w-point weightened by mask
	383	zesh2 = ( z3du(ji-1,jj,jk) + z3du(ji,jj,jk) ) / MAX( 1._wp , umask(ji-1,jj,jk) + umask(ji,jj,jk) ) &
	384	& + ( z3dv(ji,jj-1,jk) + z3dv(ji,jj,jk) ) / MAX( 1._wp , vmask(ji,jj-1,jk) + vmask(ji,jj,jk) )
	385	!
[1492]	386	zd_up(ji,jj,jk) = zzd_up ! Matrix (zdiag, zd_up, zd_lw)
	387	zd_lw(ji,jj,jk) = zzd_lw
[2528]	388	zdiag(ji,jj,jk) = 1._wp - zzd_lw - zzd_up + zfact2 * dissl(ji,jj,jk) * tmask(ji,jj,jk)
[1239]	389	!
[1492]	390	! ! right hand side in en
[1481]	391	en(ji,jj,jk) = en(ji,jj,jk) + rdt * ( zesh2 - avt(ji,jj,jk) * rn2(ji,jj,jk) &
[4990]	392	& + zfact3 * dissl(ji,jj,jk) * en (ji,jj,jk) ) &
[5120]	393	& * wmask(ji,jj,jk)
[1239]	394	END DO
[5120]	395	END DO
	396	END DO
	397	! !* Matrix inversion from level 2 (tke prescribed at level 1)
	398	DO jk = 3, jpkm1 ! First recurrence : Dk = Dk - Lk * Uk-1 / Dk-1
	399	DO jj = 2, jpjm1
	400	DO ji = fs_2, fs_jpim1 ! vector opt.
[1492]	401	zdiag(ji,jj,jk) = zdiag(ji,jj,jk) - zd_lw(ji,jj,jk) * zd_up(ji,jj,jk-1) / zdiag(ji,jj,jk-1)
[1239]	402	END DO
[5120]	403	END DO
	404	END DO
[5836]	405	DO jj = 2, jpjm1 ! Second recurrence : Lk = RHSk - Lk / Dk-1 * Lk-1
[5120]	406	DO ji = fs_2, fs_jpim1 ! vector opt.
	407	zd_lw(ji,jj,2) = en(ji,jj,2) - zd_lw(ji,jj,2) * en(ji,jj,1) ! Surface boudary conditions on tke
	408	END DO
	409	END DO
	410	DO jk = 3, jpkm1
	411	DO jj = 2, jpjm1
	412	DO ji = fs_2, fs_jpim1 ! vector opt.
[1492]	413	zd_lw(ji,jj,jk) = en(ji,jj,jk) - zd_lw(ji,jj,jk) / zdiag(ji,jj,jk-1) *zd_lw(ji,jj,jk-1)
[1239]	414	END DO
[5120]	415	END DO
	416	END DO
[5836]	417	DO jj = 2, jpjm1 ! thrid recurrence : Ek = ( Lk - Uk * Ek+1 ) / Dk
[5120]	418	DO ji = fs_2, fs_jpim1 ! vector opt.
[1492]	419	en(ji,jj,jpkm1) = zd_lw(ji,jj,jpkm1) / zdiag(ji,jj,jpkm1)
[5120]	420	END DO
	421	END DO
	422	DO jk = jpk-2, 2, -1
	423	DO jj = 2, jpjm1
	424	DO ji = fs_2, fs_jpim1 ! vector opt.
[1492]	425	en(ji,jj,jk) = ( zd_lw(ji,jj,jk) - zd_up(ji,jj,jk) * en(ji,jj,jk+1) ) / zdiag(ji,jj,jk)
[1239]	426	END DO
[5120]	427	END DO
	428	END DO
	429	DO jk = 2, jpkm1 ! set the minimum value of tke
	430	DO jj = 2, jpjm1
	431	DO ji = fs_2, fs_jpim1 ! vector opt.
	432	en(ji,jj,jk) = MAX( en(ji,jj,jk), rn_emin ) * wmask(ji,jj,jk)
[1239]	433	END DO
	434	END DO
	435	END DO
	436
[1492]	437	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	438	! ! TKE due to surface and internal wave breaking
	439	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[6140]	440	!!gm BUG : in the exp remove the depth of ssh !!!
	441
	442
[2528]	443	IF( nn_etau == 1 ) THEN !* penetration below the mixed layer (rn_efr fraction)
[1492]	444	DO jk = 2, jpkm1
[1239]	445	DO jj = 2, jpjm1
	446	DO ji = fs_2, fs_jpim1 ! vector opt.
[6140]	447	en(ji,jj,jk) = en(ji,jj,jk) + rn_efr * en(ji,jj,1) * EXP( -gdepw_n(ji,jj,jk) / htau(ji,jj) ) &
[7813]	448	& * MAX(0.,1._wp - 2.fr_i(ji,jj) ) wmask(ji,jj,jk) * tmask(ji,jj,1)
[1239]	449	END DO
	450	END DO
[1492]	451	END DO
[2528]	452	ELSEIF( nn_etau == 2 ) THEN !* act only at the base of the mixed layer (jk=nmln) (rn_efr fraction)
[1492]	453	DO jj = 2, jpjm1
	454	DO ji = fs_2, fs_jpim1 ! vector opt.
	455	jk = nmln(ji,jj)
[6140]	456	en(ji,jj,jk) = en(ji,jj,jk) + rn_efr * en(ji,jj,1) * EXP( -gdepw_n(ji,jj,jk) / htau(ji,jj) ) &
[7813]	457	& * MAX(0.,1._wp - 2.fr_i(ji,jj) ) wmask(ji,jj,jk) * tmask(ji,jj,1)
[1239]	458	END DO
[1492]	459	END DO
[2528]	460	ELSEIF( nn_etau == 3 ) THEN !* penetration belox the mixed layer (HF variability)
[1705]	461	DO jk = 2, jpkm1
	462	DO jj = 2, jpjm1
	463	DO ji = fs_2, fs_jpim1 ! vector opt.
	464	ztx2 = utau(ji-1,jj ) + utau(ji,jj)
	465	zty2 = vtau(ji ,jj-1) + vtau(ji,jj)
[4990]	466	ztau = 0.5_wp * SQRT( ztx2 * ztx2 + zty2 * zty2 ) * tmask(ji,jj,1) ! module of the mean stress
[2528]	467	zdif = taum(ji,jj) - ztau ! mean of modulus - modulus of the mean
	468	zdif = rhftau_scl * MAX( 0._wp, zdif + rhftau_add ) ! apply some modifications...
[6140]	469	en(ji,jj,jk) = en(ji,jj,jk) + zbbrau * zdif * EXP( -gdepw_n(ji,jj,jk) / htau(ji,jj) ) &
[7813]	470	& * MAX(0.,1._wp - 2.fr_i(ji,jj) ) wmask(ji,jj,jk) * tmask(ji,jj,1)
[1705]	471	END DO
	472	END DO
	473	END DO
[1239]	474	ENDIF
[1492]	475	CALL lbc_lnk( en, 'W', 1. ) ! Lateral boundary conditions (sign unchanged)
	476	!
[5836]	477	CALL wrk_dealloc( jpi,jpj, imlc ) ! integer
	478	CALL wrk_dealloc( jpi,jpj, zhlc )
	479	CALL wrk_dealloc( jpi,jpj,jpk, zpelc, zdiag, zd_up, zd_lw, z3du, z3dv )
[2715]	480	!
[3294]	481	IF( nn_timing == 1 ) CALL timing_stop('tke_tke')
	482	!
[1239]	483	END SUBROUTINE tke_tke
	484
[1492]	485
	486	SUBROUTINE tke_avn
[1239]	487	!!----------------------------------------------------------------------
[1492]	488	!! * ROUTINE tke_avn *
[1239]	489	!!
[1492]	490	!! ** Purpose : Compute the vertical eddy viscosity and diffusivity
	491	!!
	492	!! ** Method : At this stage, en, the now TKE, is known (computed in
	493	!! the tke_tke routine). First, the now mixing lenth is
	494	!! computed from en and the strafification (N^2), then the mixings
	495	!! coefficients are computed.
	496	!! - Mixing length : a first evaluation of the mixing lengh
	497	!! scales is:
	498	!! mxl = sqrt(2*en) / N
	499	!! where N is the brunt-vaisala frequency, with a minimum value set
[2528]	500	!! to rmxl_min (rn_mxl0) in the interior (surface) ocean.
[1492]	501	!! The mixing and dissipative length scale are bound as follow :
	502	!! nn_mxl=0 : mxl bounded by the distance to surface and bottom.
	503	!! zmxld = zmxlm = mxl
	504	!! nn_mxl=1 : mxl bounded by the e3w and zmxld = zmxlm = mxl
	505	!! nn_mxl=2 : mxl bounded such that the vertical derivative of mxl is
	506	!! less than 1 (\|d/dz(mxl)\|<1) and zmxld = zmxlm = mxl
	507	!! nn_mxl=3 : mxl is bounded from the surface to the bottom usings
	508	!! \|d/dz(xml)\|<1 to obtain lup, and from the bottom to
	509	!! the surface to obtain ldown. the resulting length
	510	!! scales are:
	511	!! zmxld = sqrt( lup * ldown )
	512	!! zmxlm = min ( lup , ldown )
	513	!! - Vertical eddy viscosity and diffusivity:
	514	!! avm = max( avtb, rn_ediff * zmxlm * en^1/2 )
	515	!! avt = max( avmb, pdlr * avm )
	516	!! with pdlr=1 if nn_pdl=0, pdlr=1/pdl=F(Ri) otherwise.
	517	!!
	518	!! ** Action : - avt : now vertical eddy diffusivity (w-point)
	519	!! - avmu, avmv : now vertical eddy viscosity at uw- and vw-points
[1239]	520	!!----------------------------------------------------------------------
[2715]	521	INTEGER :: ji, jj, jk ! dummy loop indices
	522	REAL(wp) :: zrn2, zraug, zcoef, zav ! local scalars
[5836]	523	REAL(wp) :: zdku, zri, zsqen ! - -
[2715]	524	REAL(wp) :: zdkv, zemxl, zemlm, zemlp ! - -
[3294]	525	REAL(wp), POINTER, DIMENSION(:,:,:) :: zmpdl, zmxlm, zmxld
[1239]	526	!!--------------------------------------------------------------------
[3294]	527	!
	528	IF( nn_timing == 1 ) CALL timing_start('tke_avn')
[1239]	529
[3294]	530	CALL wrk_alloc( jpi,jpj,jpk, zmpdl, zmxlm, zmxld )
	531
[1492]	532	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	533	! ! Mixing length
	534	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	535	!
	536	! !* Buoyancy length scale: l=sqrt(2e/n*2)
	537	!
[5120]	538	! initialisation of interior minimum value (avoid a 2d loop with mikt)
[7753]	539	zmxlm(:,:,:) = rmxl_min
	540	zmxld(:,:,:) = rmxl_min
[5120]	541	!
[2528]	542	IF( ln_mxl0 ) THEN ! surface mixing length = F(stress) : l=vkarmn2.e5taum/(rau0*g)
[4990]	543	DO jj = 2, jpjm1
	544	DO ji = fs_2, fs_jpim1
[5120]	545	zraug = vkarmn * 2.e5_wp / ( rau0 * grav )
	546	zmxlm(ji,jj,1) = MAX( rn_mxl0, zraug * taum(ji,jj) * tmask(ji,jj,1) )
[4990]	547	END DO
	548	END DO
	549	ELSE
[7753]	550	zmxlm(:,:,1) = rn_mxl0
[1239]	551	ENDIF
	552	!
[5120]	553	DO jk = 2, jpkm1 ! interior value : l=sqrt(2*e/n^2)
	554	DO jj = 2, jpjm1
	555	DO ji = fs_2, fs_jpim1 ! vector opt.
[1239]	556	zrn2 = MAX( rn2(ji,jj,jk), rsmall )
[5836]	557	zmxlm(ji,jj,jk) = MAX( rmxl_min, SQRT( 2._wp * en(ji,jj,jk) / zrn2 ) )
[1239]	558	END DO
	559	END DO
	560	END DO
[1492]	561	!
	562	! !* Physical limits for the mixing length
	563	!
[7753]	564	zmxld(:,:, 1 ) = zmxlm(:,:,1) ! surface set to the minimum value
	565	zmxld(:,:,jpk) = rmxl_min ! last level set to the minimum value
[1492]	566	!
[1239]	567	SELECT CASE ( nn_mxl )
	568	!
[5836]	569	!!gm Not sure of that coding for ISF....
[6140]	570	! where wmask = 0 set zmxlm == e3w_n
[1239]	571	CASE ( 0 ) ! bounded by the distance to surface and bottom
[5120]	572	DO jk = 2, jpkm1
	573	DO jj = 2, jpjm1
	574	DO ji = fs_2, fs_jpim1 ! vector opt.
[6140]	575	zemxl = MIN( gdepw_n(ji,jj,jk) - gdepw_n(ji,jj,mikt(ji,jj)), zmxlm(ji,jj,jk), &
	576	& gdepw_n(ji,jj,mbkt(ji,jj)+1) - gdepw_n(ji,jj,jk) )
[5120]	577	! wmask prevent zmxlm = 0 if jk = mikt(ji,jj)
[6140]	578	zmxlm(ji,jj,jk) = zemxl * wmask(ji,jj,jk) + MIN(zmxlm(ji,jj,jk),e3w_n(ji,jj,jk)) * (1 - wmask(ji,jj,jk))
	579	zmxld(ji,jj,jk) = zemxl * wmask(ji,jj,jk) + MIN(zmxlm(ji,jj,jk),e3w_n(ji,jj,jk)) * (1 - wmask(ji,jj,jk))
[1239]	580	END DO
	581	END DO
	582	END DO
	583	!
	584	CASE ( 1 ) ! bounded by the vertical scale factor
[5120]	585	DO jk = 2, jpkm1
	586	DO jj = 2, jpjm1
	587	DO ji = fs_2, fs_jpim1 ! vector opt.
[6140]	588	zemxl = MIN( e3w_n(ji,jj,jk), zmxlm(ji,jj,jk) )
[1239]	589	zmxlm(ji,jj,jk) = zemxl
	590	zmxld(ji,jj,jk) = zemxl
	591	END DO
	592	END DO
	593	END DO
	594	!
	595	CASE ( 2 ) ! \|dk[xml]\| bounded by e3t :
[5120]	596	DO jk = 2, jpkm1 ! from the surface to the bottom :
	597	DO jj = 2, jpjm1
	598	DO ji = fs_2, fs_jpim1 ! vector opt.
[6140]	599	zmxlm(ji,jj,jk) = MIN( zmxlm(ji,jj,jk-1) + e3t_n(ji,jj,jk-1), zmxlm(ji,jj,jk) )
[1239]	600	END DO
[5120]	601	END DO
	602	END DO
	603	DO jk = jpkm1, 2, -1 ! from the bottom to the surface :
	604	DO jj = 2, jpjm1
	605	DO ji = fs_2, fs_jpim1 ! vector opt.
[6140]	606	zemxl = MIN( zmxlm(ji,jj,jk+1) + e3t_n(ji,jj,jk+1), zmxlm(ji,jj,jk) )
[1239]	607	zmxlm(ji,jj,jk) = zemxl
	608	zmxld(ji,jj,jk) = zemxl
	609	END DO
	610	END DO
	611	END DO
	612	!
	613	CASE ( 3 ) ! lup and ldown, \|dk[xml]\| bounded by e3t :
[5120]	614	DO jk = 2, jpkm1 ! from the surface to the bottom : lup
	615	DO jj = 2, jpjm1
	616	DO ji = fs_2, fs_jpim1 ! vector opt.
[6140]	617	zmxld(ji,jj,jk) = MIN( zmxld(ji,jj,jk-1) + e3t_n(ji,jj,jk-1), zmxlm(ji,jj,jk) )
[1239]	618	END DO
[5120]	619	END DO
	620	END DO
	621	DO jk = jpkm1, 2, -1 ! from the bottom to the surface : ldown
	622	DO jj = 2, jpjm1
	623	DO ji = fs_2, fs_jpim1 ! vector opt.
[6140]	624	zmxlm(ji,jj,jk) = MIN( zmxlm(ji,jj,jk+1) + e3t_n(ji,jj,jk+1), zmxlm(ji,jj,jk) )
[1239]	625	END DO
	626	END DO
	627	END DO
	628	DO jk = 2, jpkm1
	629	DO jj = 2, jpjm1
	630	DO ji = fs_2, fs_jpim1 ! vector opt.
	631	zemlm = MIN ( zmxld(ji,jj,jk), zmxlm(ji,jj,jk) )
	632	zemlp = SQRT( zmxld(ji,jj,jk) * zmxlm(ji,jj,jk) )
	633	zmxlm(ji,jj,jk) = zemlm
	634	zmxld(ji,jj,jk) = zemlp
	635	END DO
	636	END DO
	637	END DO
	638	!
	639	END SELECT
[1492]	640	!
[1239]	641	# if defined key_c1d
[7753]	642	e_dis(:,:,:) = zmxld(:,:,:) ! c1d configuration : save mixing and dissipation turbulent length scales
	643	e_mix(:,:,:) = zmxlm(:,:,:)
[1239]	644	# endif
	645
[1492]	646	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	647	! ! Vertical eddy viscosity and diffusivity (avmu, avmv, avt)
	648	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	649	DO jk = 1, jpkm1 !* vertical eddy viscosity & diffivity at w-points
[1239]	650	DO jj = 2, jpjm1
	651	DO ji = fs_2, fs_jpim1 ! vector opt.
	652	zsqen = SQRT( en(ji,jj,jk) )
	653	zav = rn_ediff * zmxlm(ji,jj,jk) * zsqen
[5120]	654	avm (ji,jj,jk) = MAX( zav, avmb(jk) ) * wmask(ji,jj,jk)
	655	avt (ji,jj,jk) = MAX( zav, avtb_2d(ji,jj) * avtb(jk) ) * wmask(ji,jj,jk)
[1239]	656	dissl(ji,jj,jk) = zsqen / zmxld(ji,jj,jk)
	657	END DO
	658	END DO
	659	END DO
[1492]	660	CALL lbc_lnk( avm, 'W', 1. ) ! Lateral boundary conditions (sign unchanged)
	661	!
[5120]	662	DO jk = 2, jpkm1 !* vertical eddy viscosity at wu- and wv-points
	663	DO jj = 2, jpjm1
	664	DO ji = fs_2, fs_jpim1 ! vector opt.
	665	avmu(ji,jj,jk) = 0.5 * ( avm(ji,jj,jk) + avm(ji+1,jj ,jk) ) * wumask(ji,jj,jk)
	666	avmv(ji,jj,jk) = 0.5 * ( avm(ji,jj,jk) + avm(ji ,jj+1,jk) ) * wvmask(ji,jj,jk)
[4990]	667	END DO
[1239]	668	END DO
	669	END DO
	670	CALL lbc_lnk( avmu, 'U', 1. ) ; CALL lbc_lnk( avmv, 'V', 1. ) ! Lateral boundary conditions
[1492]	671	!
	672	IF( nn_pdl == 1 ) THEN !* Prandtl number case: update avt
[5120]	673	DO jk = 2, jpkm1
	674	DO jj = 2, jpjm1
	675	DO ji = fs_2, fs_jpim1 ! vector opt.
[5656]	676	avt(ji,jj,jk) = MAX( apdlr(ji,jj,jk) * avt(ji,jj,jk), avtb_2d(ji,jj) * avtb(jk) ) * tmask(ji,jj,jk)
[1492]	677	# if defined key_c1d
[5656]	678	e_pdl(ji,jj,jk) = apdlr(ji,jj,jk) * wmask(ji,jj,jk) ! c1d configuration : save masked Prandlt number
[5836]	679	!!gm bug NO zri here....
	680	!!gm remove the specific diag for c1d !
[5656]	681	e_ric(ji,jj,jk) = zri * wmask(ji,jj,jk) ! c1d config. : save Ri
[1239]	682	# endif
	683	END DO
	684	END DO
	685	END DO
	686	ENDIF
	687	CALL lbc_lnk( avt, 'W', 1. ) ! Lateral boundary conditions on avt (sign unchanged)
	688
	689	IF(ln_ctl) THEN
	690	CALL prt_ctl( tab3d_1=en , clinfo1=' tke - e: ', tab3d_2=avt, clinfo2=' t: ', ovlap=1, kdim=jpk)
	691	CALL prt_ctl( tab3d_1=avmu, clinfo1=' tke - u: ', mask1=umask, &
	692	& tab3d_2=avmv, clinfo2= ' v: ', mask2=vmask, ovlap=1, kdim=jpk )
	693	ENDIF
	694	!
[3294]	695	CALL wrk_dealloc( jpi,jpj,jpk, zmpdl, zmxlm, zmxld )
	696	!
	697	IF( nn_timing == 1 ) CALL timing_stop('tke_avn')
	698	!
[1492]	699	END SUBROUTINE tke_avn
[1239]	700
[1492]	701
[2528]	702	SUBROUTINE zdf_tke_init
[1239]	703	!!----------------------------------------------------------------------
[2528]	704	!! * ROUTINE zdf_tke_init *
[1239]	705	!!
	706	!! ** Purpose : Initialization of the vertical eddy diffivity and
[1492]	707	!! viscosity when using a tke turbulent closure scheme
[1239]	708	!!
[1601]	709	!! ** Method : Read the namzdf_tke namelist and check the parameters
[1492]	710	!! called at the first timestep (nit000)
[1239]	711	!!
[1601]	712	!! ** input : Namlist namzdf_tke
[1239]	713	!!
	714	!! ** Action : Increase by 1 the nstop flag is setting problem encounter
	715	!!----------------------------------------------------------------------
	716	INTEGER :: ji, jj, jk ! dummy loop indices
[4147]	717	INTEGER :: ios
[1239]	718	!!
[2528]	719	NAMELIST/namzdf_tke/ rn_ediff, rn_ediss , rn_ebb , rn_emin , &
	720	& rn_emin0, rn_bshear, nn_mxl , ln_mxl0 , &
	721	& rn_mxl0 , nn_pdl , ln_lc , rn_lc , &
	722	& nn_etau , nn_htau , rn_efr
[1239]	723	!!----------------------------------------------------------------------
[2715]	724	!
[4147]	725	REWIND( numnam_ref ) ! Namelist namzdf_tke in reference namelist : Turbulent Kinetic Energy
	726	READ ( numnam_ref, namzdf_tke, IOSTAT = ios, ERR = 901)
	727	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namzdf_tke in reference namelist', lwp )
	728
	729	REWIND( numnam_cfg ) ! Namelist namzdf_tke in configuration namelist : Turbulent Kinetic Energy
	730	READ ( numnam_cfg, namzdf_tke, IOSTAT = ios, ERR = 902 )
	731	902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namzdf_tke in configuration namelist', lwp )
[4624]	732	IF(lwm) WRITE ( numond, namzdf_tke )
[2715]	733	!
[2528]	734	ri_cri = 2._wp / ( 2._wp + rn_ediss / rn_ediff ) ! resulting critical Richardson number
[2715]	735	!
[1492]	736	IF(lwp) THEN !* Control print
[1239]	737	WRITE(numout,*)
[2528]	738	WRITE(numout,*) 'zdf_tke_init : tke turbulent closure scheme - initialisation'
	739	WRITE(numout,*) '~~~~~~~~~~~~'
[1601]	740	WRITE(numout,*) ' Namelist namzdf_tke : set tke mixing parameters'
[1705]	741	WRITE(numout,*) ' coef. to compute avt rn_ediff = ', rn_ediff
	742	WRITE(numout,*) ' Kolmogoroff dissipation coef. rn_ediss = ', rn_ediss
	743	WRITE(numout,*) ' tke surface input coef. rn_ebb = ', rn_ebb
	744	WRITE(numout,*) ' minimum value of tke rn_emin = ', rn_emin
	745	WRITE(numout,*) ' surface minimum value of tke rn_emin0 = ', rn_emin0
	746	WRITE(numout,*) ' background shear (>0) rn_bshear = ', rn_bshear
	747	WRITE(numout,*) ' mixing length type nn_mxl = ', nn_mxl
	748	WRITE(numout,*) ' prandl number flag nn_pdl = ', nn_pdl
	749	WRITE(numout,*) ' surface mixing length = F(stress) or not ln_mxl0 = ', ln_mxl0
[2528]	750	WRITE(numout,*) ' surface mixing length minimum value rn_mxl0 = ', rn_mxl0
	751	WRITE(numout,*) ' flag to take into acc. Langmuir circ. ln_lc = ', ln_lc
	752	WRITE(numout,*) ' coef to compute verticla velocity of LC rn_lc = ', rn_lc
[1705]	753	WRITE(numout,*) ' test param. to add tke induced by wind nn_etau = ', nn_etau
	754	WRITE(numout,*) ' flag for computation of exp. tke profile nn_htau = ', nn_htau
	755	WRITE(numout,*) ' fraction of en which pene. the thermocline rn_efr = ', rn_efr
[1239]	756	WRITE(numout,*)
[1601]	757	WRITE(numout,*) ' critical Richardson nb with your parameters ri_cri = ', ri_cri
[7953]	758	WRITE(numout,*)
[1239]	759	ENDIF
[2715]	760	!
[7953]	761	IF( ln_zdftmx ) THEN ! Internal wave driven mixing
	762	! ! specific values of rn_emin & rmxl_min are used
	763	rn_emin = 1.e-10_wp
	764	rmxl_min = 1.e-03_wp
	765	IF(lwp) WRITE(numout,*) ' Internal wave-driven mixing case: force rn_emin = 1.e-10 and rmxl_min = 1.e-3 '
	766	ELSE
	767	rmxl_min = 1.e-6_wp / ( rn_ediff * SQRT( rn_emin ) ) ! resulting minimum length to recover molecular viscosity
	768	IF(lwp) WRITE(numout,*) ' minimum mixing length with your parameters rmxl_min = ', rmxl_min
	769	ENDIF
	770	!
[2715]	771	! ! allocate tke arrays
	772	IF( zdf_tke_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'zdf_tke_init : unable to allocate arrays' )
	773	!
[1492]	774	! !* Check of some namelist values
[4990]	775	IF( nn_mxl < 0 .OR. nn_mxl > 3 ) CALL ctl_stop( 'bad flag: nn_mxl is 0, 1 or 2 ' )
	776	IF( nn_pdl < 0 .OR. nn_pdl > 1 ) CALL ctl_stop( 'bad flag: nn_pdl is 0 or 1 ' )
	777	IF( nn_htau < 0 .OR. nn_htau > 1 ) CALL ctl_stop( 'bad flag: nn_htau is 0, 1 or 2 ' )
[5407]	778	IF( nn_etau == 3 .AND. .NOT. ln_cpl ) CALL ctl_stop( 'nn_etau == 3 : HF taum only known in coupled mode' )
[1239]	779
[2528]	780	IF( ln_mxl0 ) THEN
	781	IF(lwp) WRITE(numout,*) ' use a surface mixing length = F(stress) : set rn_mxl0 = rmxl_min'
	782	rn_mxl0 = rmxl_min
	783	ENDIF
	784
[1492]	785	IF( nn_etau == 2 ) CALL zdf_mxl( nit000 ) ! Initialization of nmln
[1239]	786
[1492]	787	! !* depth of penetration of surface tke
	788	IF( nn_etau /= 0 ) THEN
[1601]	789	SELECT CASE( nn_htau ) ! Choice of the depth of penetration
[2528]	790	CASE( 0 ) ! constant depth penetration (here 10 meters)
[7753]	791	htau(:,:) = 10._wp
[2528]	792	CASE( 1 ) ! F(latitude) : 0.5m to 30m poleward of 40 degrees
[7753]	793	htau(:,:) = MAX( 0.5_wp, MIN( 30._wp, 45._wp* ABS( SIN( rpi/180._wp * gphit(:,:) ) ) ) )
[1492]	794	END SELECT
	795	ENDIF
	796	! !* set vertical eddy coef. to the background value
[1239]	797	DO jk = 1, jpk
[7753]	798	avt (:,:,jk) = avtb(jk) * wmask (:,:,jk)
	799	avm (:,:,jk) = avmb(jk) * wmask (:,:,jk)
	800	avmu(:,:,jk) = avmb(jk) * wumask(:,:,jk)
	801	avmv(:,:,jk) = avmb(jk) * wvmask(:,:,jk)
[1239]	802	END DO
[7753]	803	dissl(:,:,:) = 1.e-12_wp
[2715]	804	!
	805	CALL tke_rst( nit000, 'READ' ) !* read or initialize all required files
[1239]	806	!
[2528]	807	END SUBROUTINE zdf_tke_init
[1239]	808
	809
[1531]	810	SUBROUTINE tke_rst( kt, cdrw )
[1239]	811	!!---------------------------------------------------------------------
[1531]	812	!! * ROUTINE tke_rst *
[1239]	813	!!
	814	!! ** Purpose : Read or write TKE file (en) in restart file
	815	!!
	816	!! ** Method : use of IOM library
	817	!! if the restart does not contain TKE, en is either
[1537]	818	!! set to rn_emin or recomputed
[1239]	819	!!----------------------------------------------------------------------
[2715]	820	INTEGER , INTENT(in) :: kt ! ocean time-step
	821	CHARACTER(len=*), INTENT(in) :: cdrw ! "READ"/"WRITE" flag
[1239]	822	!
[7753]	823	INTEGER :: jit, jk ! dummy loop indices
[2715]	824	INTEGER :: id1, id2, id3, id4, id5, id6 ! local integers
[1239]	825	!!----------------------------------------------------------------------
	826	!
[1481]	827	IF( TRIM(cdrw) == 'READ' ) THEN ! Read/initialise
	828	! ! ---------------
	829	IF( ln_rstart ) THEN !* Read the restart file
	830	id1 = iom_varid( numror, 'en' , ldstop = .FALSE. )
	831	id2 = iom_varid( numror, 'avt' , ldstop = .FALSE. )
	832	id3 = iom_varid( numror, 'avm' , ldstop = .FALSE. )
	833	id4 = iom_varid( numror, 'avmu' , ldstop = .FALSE. )
	834	id5 = iom_varid( numror, 'avmv' , ldstop = .FALSE. )
	835	id6 = iom_varid( numror, 'dissl', ldstop = .FALSE. )
	836	!
	837	IF( id1 > 0 ) THEN ! 'en' exists
[1239]	838	CALL iom_get( numror, jpdom_autoglo, 'en', en )
[1481]	839	IF( MIN( id2, id3, id4, id5, id6 ) > 0 ) THEN ! all required arrays exist
	840	CALL iom_get( numror, jpdom_autoglo, 'avt' , avt )
	841	CALL iom_get( numror, jpdom_autoglo, 'avm' , avm )
	842	CALL iom_get( numror, jpdom_autoglo, 'avmu' , avmu )
	843	CALL iom_get( numror, jpdom_autoglo, 'avmv' , avmv )
	844	CALL iom_get( numror, jpdom_autoglo, 'dissl', dissl )
[1492]	845	ELSE ! one at least array is missing
	846	CALL tke_avn ! compute avt, avm, avmu, avmv and dissl (approximation)
[1481]	847	ENDIF
	848	ELSE ! No TKE array found: initialisation
	849	IF(lwp) WRITE(numout,*) ' ===>>>> : previous run without tke scheme, en computed by iterative loop'
[7753]	850	en (:,:,:) = rn_emin * tmask(:,:,:)
[1492]	851	CALL tke_avn ! recompute avt, avm, avmu, avmv and dissl (approximation)
[5112]	852	!
[7753]	853	avt_k (:,:,:) = avt (:,:,:)
	854	avm_k (:,:,:) = avm (:,:,:)
	855	avmu_k(:,:,:) = avmu(:,:,:)
	856	avmv_k(:,:,:) = avmv(:,:,:)
[5112]	857	!
[1531]	858	DO jit = nit000 + 1, nit000 + 10 ; CALL zdf_tke( jit ) ; END DO
[1239]	859	ENDIF
[1481]	860	ELSE !* Start from rest
[7753]	861	en(:,:,:) = rn_emin * tmask(:,:,:)
[1481]	862	DO jk = 1, jpk ! set the Kz to the background value
[7753]	863	avt (:,:,jk) = avtb(jk) * wmask (:,:,jk)
	864	avm (:,:,jk) = avmb(jk) * wmask (:,:,jk)
	865	avmu(:,:,jk) = avmb(jk) * wumask(:,:,jk)
	866	avmv(:,:,jk) = avmb(jk) * wvmask(:,:,jk)
[1481]	867	END DO
[1239]	868	ENDIF
[1481]	869	!
	870	ELSEIF( TRIM(cdrw) == 'WRITE' ) THEN ! Create restart file
	871	! ! -------------------
[1531]	872	IF(lwp) WRITE(numout,*) '---- tke-rst ----'
[3632]	873	CALL iom_rstput( kt, nitrst, numrow, 'en' , en )
	874	CALL iom_rstput( kt, nitrst, numrow, 'avt' , avt_k )
	875	CALL iom_rstput( kt, nitrst, numrow, 'avm' , avm_k )
	876	CALL iom_rstput( kt, nitrst, numrow, 'avmu' , avmu_k )
	877	CALL iom_rstput( kt, nitrst, numrow, 'avmv' , avmv_k )
	878	CALL iom_rstput( kt, nitrst, numrow, 'dissl', dissl )
[1481]	879	!
[1239]	880	ENDIF
	881	!
[1531]	882	END SUBROUTINE tke_rst
[1239]	883
	884	!!======================================================================
[1531]	885	END MODULE zdftke

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

Download in other formats: