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

Context Navigation

source: branches/2017/dev_merge_2017/NEMOGCM/NEMO/OPA_SRC/ZDF/zdftke.F90 @ 9440

Last change on this file since 9440 was 9440, checked in by acc, 6 years ago
Branch 2017/dev_merge_2017. Reorganisation of nemogcm.F90 and mppini.F90. Stage 5: Enhancement to prtctl and suppression of overlap option; see ticket #2070
Property svn:keywords set to `Id`
File size: 43.4 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
[9019]	29	!! 4.0 ! 2017-04 (G. Madec) remove CPP ddm key & avm at t-point only
	30	!! - ! 2017-05 (G. Madec) add top/bottom friction as boundary condition (ln_drg)
[1239]	31	!!----------------------------------------------------------------------
[9019]	32
[1239]	33	!!----------------------------------------------------------------------
[3625]	34	!! zdf_tke : update momentum and tracer Kz from a tke scheme
	35	!! tke_tke : tke time stepping: update tke at now time step (en)
	36	!! tke_avn : compute mixing length scale and deduce avm and avt
	37	!! zdf_tke_init : initialization, namelist read, and parameters control
	38	!! tke_rst : read/write tke restart in ocean restart file
[1239]	39	!!----------------------------------------------------------------------
[2528]	40	USE oce ! ocean: dynamics and active tracers variables
	41	USE phycst ! physical constants
	42	USE dom_oce ! domain: ocean
	43	USE domvvl ! domain: variable volume layer
[1492]	44	USE sbc_oce ! surface boundary condition: ocean
[9019]	45	USE zdfdrg ! vertical physics: top/bottom drag coef.
[2528]	46	USE zdfmxl ! vertical physics: mixed layer
[9019]	47	!
[1492]	48	USE in_out_manager ! I/O manager
	49	USE iom ! I/O manager library
[2715]	50	USE lib_mpp ! MPP library
[9019]	51	USE lbclnk ! ocean lateral boundary conditions (or mpp link)
	52	USE prtctl ! Print control
[3625]	53	USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
[1239]	54
	55	IMPLICIT NONE
	56	PRIVATE
	57
[2528]	58	PUBLIC zdf_tke ! routine called in step module
	59	PUBLIC zdf_tke_init ! routine called in opa module
	60	PUBLIC tke_rst ! routine called in step module
[1239]	61
[4147]	62	! !! Namelist namzdf_tke
	63	LOGICAL :: ln_mxl0 ! mixing length scale surface value as function of wind stress or not
	64	INTEGER :: nn_mxl ! type of mixing length (=0/1/2/3)
	65	REAL(wp) :: rn_mxl0 ! surface min value of mixing length (kappaz_o=0.40.1 m) [m]
	66	INTEGER :: nn_pdl ! Prandtl number or not (ratio avt/avm) (=0/1)
	67	REAL(wp) :: rn_ediff ! coefficient for avt: avt=rn_ediffmxlsqrt(e)
	68	REAL(wp) :: rn_ediss ! coefficient of the Kolmogoroff dissipation
	69	REAL(wp) :: rn_ebb ! coefficient of the surface input of tke
	70	REAL(wp) :: rn_emin ! minimum value of tke [m2/s2]
	71	REAL(wp) :: rn_emin0 ! surface minimum value of tke [m2/s2]
	72	REAL(wp) :: rn_bshear ! background shear (>0) currently a numerical threshold (do not change it)
[9019]	73	LOGICAL :: ln_drg ! top/bottom friction forcing flag
[4147]	74	INTEGER :: nn_etau ! type of depth penetration of surface tke (=0/1/2/3)
[9019]	75	INTEGER :: nn_htau ! type of tke profile of penetration (=0/1)
	76	REAL(wp) :: rn_efr ! fraction of TKE surface value which penetrates in the ocean
[4147]	77	LOGICAL :: ln_lc ! Langmuir cells (LC) as a source term of TKE or not
[9019]	78	REAL(wp) :: rn_lc ! coef to compute vertical velocity of Langmuir cells
[1239]	79
[4147]	80	REAL(wp) :: ri_cri ! critic Richardson number (deduced from rn_ediff and rn_ediss values)
	81	REAL(wp) :: rmxl_min ! minimum mixing length value (deduced from rn_ediff and rn_emin values) [m]
[2528]	82	REAL(wp) :: rhftau_add = 1.e-3_wp ! add offset applied to HF part of taum (nn_etau=3)
	83	REAL(wp) :: rhftau_scl = 1.0_wp ! scale factor applied to HF part of taum (nn_etau=3)
[1239]	84
[9019]	85	REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:) :: htau ! depth of tke penetration (nn_htau)
	86	REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: dissl ! now mixing lenght of dissipation
	87	REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: apdlr ! now mixing lenght of dissipation
[1492]	88
[1239]	89	!! * Substitutions
	90	# include "vectopt_loop_substitute.h90"
	91	!!----------------------------------------------------------------------
[5836]	92	!! NEMO/OPA 3.7 , NEMO Consortium (2015)
[2528]	93	!! $Id$
	94	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
[1239]	95	!!----------------------------------------------------------------------
	96	CONTAINS
	97
[2715]	98	INTEGER FUNCTION zdf_tke_alloc()
	99	!!----------------------------------------------------------------------
	100	!! * FUNCTION zdf_tke_alloc *
	101	!!----------------------------------------------------------------------
[9019]	102	ALLOCATE( htau(jpi,jpj) , dissl(jpi,jpj,jpk) , apdlr(jpi,jpj,jpk) , STAT= zdf_tke_alloc )
	103	!
[2715]	104	IF( lk_mpp ) CALL mpp_sum ( zdf_tke_alloc )
	105	IF( zdf_tke_alloc /= 0 ) CALL ctl_warn('zdf_tke_alloc: failed to allocate arrays')
	106	!
	107	END FUNCTION zdf_tke_alloc
	108
	109
[9019]	110	SUBROUTINE zdf_tke( kt, p_sh2, p_avm, p_avt )
[1239]	111	!!----------------------------------------------------------------------
[1531]	112	!! * ROUTINE zdf_tke *
[1239]	113	!!
	114	!! ** Purpose : Compute the vertical eddy viscosity and diffusivity
[1492]	115	!! coefficients using a turbulent closure scheme (TKE).
[1239]	116	!!
[1492]	117	!! ** Method : The time evolution of the turbulent kinetic energy (tke)
	118	!! is computed from a prognostic equation :
	119	!! d(en)/dt = avm (d(u)/dz)**2 ! shear production
	120	!! + d( avm d(en)/dz )/dz ! diffusion of tke
	121	!! + avt N^2 ! stratif. destruc.
	122	!! - rn_ediss / emxl en**(2/3) ! Kolmogoroff dissipation
[1239]	123	!! with the boundary conditions:
[1695]	124	!! surface: en = max( rn_emin0, rn_ebb * taum )
[1239]	125	!! bottom : en = rn_emin
[1492]	126	!! The associated critical Richardson number is: ri_cri = 2/(2+rn_ediss/rn_ediff)
	127	!!
	128	!! The now Turbulent kinetic energy is computed using the following
	129	!! time stepping: implicit for vertical diffusion term, linearized semi
	130	!! implicit for kolmogoroff dissipation term, and explicit forward for
	131	!! both buoyancy and shear production terms. Therefore a tridiagonal
	132	!! linear system is solved. Note that buoyancy and shear terms are
	133	!! discretized in a energy conserving form (Bruchard 2002).
	134	!!
	135	!! The dissipative and mixing length scale are computed from en and
	136	!! the stratification (see tke_avn)
	137	!!
	138	!! The now vertical eddy vicosity and diffusivity coefficients are
	139	!! given by:
	140	!! avm = max( avtb, rn_ediff * zmxlm * en^1/2 )
	141	!! avt = max( avmb, pdl * avm )
[1239]	142	!! eav = max( avmb, avm )
[1492]	143	!! where pdl, the inverse of the Prandtl number is 1 if nn_pdl=0 and
	144	!! given by an empirical funtion of the localRichardson number if nn_pdl=1
[1239]	145	!!
	146	!! ** Action : compute en (now turbulent kinetic energy)
[9019]	147	!! update avt, avm (before vertical eddy coef.)
[1239]	148	!!
	149	!! References : Gaspar et al., JGR, 1990,
	150	!! Blanke and Delecluse, JPO, 1991
	151	!! Mellor and Blumberg, JPO 2004
	152	!! Axell, JGR, 2002
[1492]	153	!! Bruchard OM 2002
[1239]	154	!!----------------------------------------------------------------------
[9019]	155	INTEGER , INTENT(in ) :: kt ! ocean time step
	156	REAL(wp), DIMENSION(:,:,:), INTENT(in ) :: p_sh2 ! shear production term
	157	REAL(wp), DIMENSION(:,:,:), INTENT(inout) :: p_avm, p_avt ! momentum and tracer Kz (w-points)
[1492]	158	!!----------------------------------------------------------------------
[1481]	159	!
[9019]	160	CALL tke_tke( gdepw_n, e3t_n, e3w_n, p_sh2, p_avm, p_avt ) ! now tke (en)
[5656]	161	!
[9019]	162	CALL tke_avn( gdepw_n, e3t_n, e3w_n, p_avm, p_avt ) ! now avt, avm, dissl
[3632]	163	!
[5656]	164	END SUBROUTINE zdf_tke
[1239]	165
[1492]	166
[9019]	167	SUBROUTINE tke_tke( pdepw, p_e3t, p_e3w, p_sh2, p_avm, p_avt )
[1239]	168	!!----------------------------------------------------------------------
[1492]	169	!! * ROUTINE tke_tke *
	170	!!
	171	!! ** Purpose : Compute the now Turbulente Kinetic Energy (TKE)
	172	!!
	173	!! ** Method : - TKE surface boundary condition
[2528]	174	!! - source term due to Langmuir cells (Axell JGR 2002) (ln_lc=T)
[9019]	175	!! - source term due to shear (= Kz dz[Ub] * dz[Un] )
[1492]	176	!! - Now TKE : resolution of the TKE equation by inverting
	177	!! a tridiagonal linear system by a "methode de chasse"
	178	!! - increase TKE due to surface and internal wave breaking
[9019]	179	!! NB: when sea-ice is present, both LC parameterization
	180	!! and TKE penetration are turned off when the ice fraction
	181	!! is smaller than 0.25
[1492]	182	!!
	183	!! ** Action : - en : now turbulent kinetic energy)
[1239]	184	!! ---------------------------------------------------------------------
[9019]	185	USE zdf_oce , ONLY : en ! ocean vertical physics
	186	!!
	187	REAL(wp), DIMENSION(:,:,:) , INTENT(in ) :: pdepw ! depth of w-points
	188	REAL(wp), DIMENSION(:,:,:) , INTENT(in ) :: p_e3t, p_e3w ! level thickness (t- & w-points)
	189	REAL(wp), DIMENSION(:,:,:) , INTENT(in ) :: p_sh2 ! shear production term
	190	REAL(wp), DIMENSION(:,:,:) , INTENT(in ) :: p_avm, p_avt ! vertical eddy viscosity & diffusivity (w-points)
	191	!
	192	INTEGER :: ji, jj, jk ! dummy loop arguments
	193	REAL(wp) :: zetop, zebot, zmsku, zmskv ! local scalars
	194	REAL(wp) :: zrhoa = 1.22 ! Air density kg/m3
	195	REAL(wp) :: zcdrag = 1.5e-3 ! drag coefficient
	196	REAL(wp) :: zbbrau, zri ! local scalars
	197	REAL(wp) :: zfact1, zfact2, zfact3 ! - -
	198	REAL(wp) :: ztx2 , zty2 , zcof ! - -
	199	REAL(wp) :: ztau , zdif ! - -
	200	REAL(wp) :: zus , zwlc , zind ! - -
	201	REAL(wp) :: zzd_up, zzd_lw ! - -
	202	INTEGER , DIMENSION(jpi,jpj) :: imlc
	203	REAL(wp), DIMENSION(jpi,jpj) :: zhlc
	204	REAL(wp), DIMENSION(jpi,jpj,jpk) :: zpelc, zdiag, zd_up, zd_lw
[1239]	205	!!--------------------------------------------------------------------
[1492]	206	!
[1695]	207	zbbrau = rn_ebb / rau0 ! Local constant initialisation
[2528]	208	zfact1 = -.5_wp * rdt
	209	zfact2 = 1.5_wp * rdt * rn_ediss
	210	zfact3 = 0.5_wp * rn_ediss
[1492]	211	!
	212	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[9019]	213	! ! Surface/top/bottom boundary condition on tke
[1492]	214	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[9019]	215
	216	DO jj = 2, jpjm1 ! en(1) = rn_ebb taum / rau0 (min value rn_emin0)
	217	DO ji = fs_2, fs_jpim1 ! vector opt.
	218	en(ji,jj,1) = MAX( rn_emin0, zbbrau * taum(ji,jj) ) * tmask(ji,jj,1)
	219	END DO
	220	END DO
[5120]	221	IF ( ln_isfcav ) THEN
	222	DO jj = 2, jpjm1 ! en(mikt(ji,jj)) = rn_emin
	223	DO ji = fs_2, fs_jpim1 ! vector opt.
[5836]	224	en(ji,jj,mikt(ji,jj)) = rn_emin * tmask(ji,jj,1)
[5120]	225	END DO
	226	END DO
[9019]	227	ENDIF
	228	!
[1492]	229	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	230	! ! Bottom boundary condition on tke
	231	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[1719]	232	!
[9019]	233	! en(bot) = (ebb0/rau0)0.5sqrt(u_botfr^2+v_botfr^2) (min value rn_emin)
	234	! where ebb0 does not includes surface wave enhancement (i.e. ebb0=3.75)
	235	! Note that stress averaged is done using an wet-only calculation of u and v at t-point like in zdfsh2
[1492]	236	!
[9019]	237	IF( ln_drg ) THEN !== friction used as top/bottom boundary condition on TKE
	238	!
	239	DO jj = 2, jpjm1 ! bottom friction
	240	DO ji = fs_2, fs_jpim1 ! vector opt.
	241	zmsku = ( 2. - umask(ji-1,jj,mbkt(ji,jj)) * umask(ji,jj,mbkt(ji,jj)) )
	242	zmskv = ( 2. - vmask(ji,jj-1,mbkt(ji,jj)) * vmask(ji,jj,mbkt(ji,jj)) )
	243	! ! where 0.001875 = (rn_ebb0/rau0) * 0.5 = 3.75*0.5/1000. (CAUTION CdU<0)
	244	zebot = - 0.001875_wp * rCdU_bot(ji,jj) * SQRT( ( zmsku( ub(ji,jj,mbkt(ji,jj))+ub(ji-1,jj,mbkt(ji,jj)) ) )*2 &
	245	& + ( zmskv( vb(ji,jj,mbkt(ji,jj))+vb(ji,jj-1,mbkt(ji,jj)) ) )*2 )
	246	en(ji,jj,mbkt(ji,jj)+1) = MAX( zebot, rn_emin ) * ssmask(ji,jj)
	247	END DO
	248	END DO
	249	IF( ln_isfcav ) THEN ! top friction
	250	DO jj = 2, jpjm1
	251	DO ji = fs_2, fs_jpim1 ! vector opt.
	252	zmsku = ( 2. - umask(ji-1,jj,mikt(ji,jj)) * umask(ji,jj,mikt(ji,jj)) )
	253	zmskv = ( 2. - vmask(ji,jj-1,mikt(ji,jj)) * vmask(ji,jj,mikt(ji,jj)) )
	254	! ! where 0.001875 = (rn_ebb0/rau0) * 0.5 = 3.75*0.5/1000. (CAUTION CdU<0)
	255	zetop = - 0.001875_wp * rCdU_top(ji,jj) * SQRT( ( zmsku( ub(ji,jj,mikt(ji,jj))+ub(ji-1,jj,mikt(ji,jj)) ) )*2 &
	256	& + ( zmskv( vb(ji,jj,mikt(ji,jj))+vb(ji,jj-1,mikt(ji,jj)) ) )*2 )
	257	en(ji,jj,mikt(ji,jj)) = MAX( zetop, rn_emin ) * (1._wp - tmask(ji,jj,1)) ! masked at ocean surface
	258	END DO
	259	END DO
	260	ENDIF
	261	!
	262	ENDIF
	263	!
[1492]	264	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[9019]	265	IF( ln_lc ) THEN ! Langmuir circulation source term added to tke ! (Axell JGR 2002)
[1492]	266	! !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[1239]	267	!
[1492]	268	! !* total energy produce by LC : cumulative sum over jk
[9019]	269	zpelc(:,:,1) = MAX( rn2b(:,:,1), 0._wp ) * pdepw(:,:,1) * p_e3w(:,:,1)
[1239]	270	DO jk = 2, jpk
[9019]	271	zpelc(:,:,jk) = zpelc(:,:,jk-1) + MAX( rn2b(:,:,jk), 0._wp ) * pdepw(:,:,jk) * p_e3w(:,:,jk)
[1239]	272	END DO
[1492]	273	! !* finite Langmuir Circulation depth
[1705]	274	zcof = 0.5 * 0.016 * 0.016 / ( zrhoa * zcdrag )
[7753]	275	imlc(:,:) = mbkt(:,:) + 1 ! Initialization to the number of w ocean point (=2 over land)
[1239]	276	DO jk = jpkm1, 2, -1
[1492]	277	DO jj = 1, jpj ! Last w-level at which zpelc>=0.5usus
	278	DO ji = 1, jpi ! with us=0.016*wind(starting from jpk-1)
[1705]	279	zus = zcof * taum(ji,jj)
[1239]	280	IF( zpelc(ji,jj,jk) > zus ) imlc(ji,jj) = jk
	281	END DO
	282	END DO
	283	END DO
[1492]	284	! ! finite LC depth
	285	DO jj = 1, jpj
[1239]	286	DO ji = 1, jpi
[9019]	287	zhlc(ji,jj) = pdepw(ji,jj,imlc(ji,jj))
[1239]	288	END DO
	289	END DO
[1705]	290	zcof = 0.016 / SQRT( zrhoa * zcdrag )
[1492]	291	DO jk = 2, jpkm1 !* TKE Langmuir circulation source term added to en
[1239]	292	DO jj = 2, jpjm1
	293	DO ji = fs_2, fs_jpim1 ! vector opt.
[1705]	294	zus = zcof * SQRT( taum(ji,jj) ) ! Stokes drift
[1492]	295	! ! vertical velocity due to LC
[9019]	296	zind = 0.5 - SIGN( 0.5, pdepw(ji,jj,jk) - zhlc(ji,jj) )
	297	zwlc = zind * rn_lc * zus * SIN( rpi * pdepw(ji,jj,jk) / zhlc(ji,jj) )
[1492]	298	! ! TKE Langmuir circulation source term
[9019]	299	en(ji,jj,jk) = en(ji,jj,jk) + rdt * MAX(0.,1._wp - 4.fr_i(ji,jj) ) ( zwlc * zwlc * zwlc ) &
[9190]	300	& / zhlc(ji,jj) * wmask(ji,jj,jk)
	301	!!gm & / zhlc(ji,jj) * wmask(ji,jj,jk) * tmask(ji,jj,1)
[1239]	302	END DO
	303	END DO
	304	END DO
	305	!
	306	ENDIF
[1492]	307	!
	308	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	309	! ! Now Turbulent kinetic energy (output in en)
	310	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	311	! ! Resolution of a tridiagonal linear system by a "methode de chasse"
	312	! ! computation from level 2 to jpkm1 (e(1) already computed and e(jpk)=0 ).
	313	! ! zdiag : diagonal zd_up : upper diagonal zd_lw : lower diagonal
	314	!
[9019]	315	IF( nn_pdl == 1 ) THEN !* Prandtl number = F( Ri )
[5656]	316	DO jk = 2, jpkm1
	317	DO jj = 2, jpjm1
[9019]	318	DO ji = 2, jpim1
	319	! ! local Richardson number
	320	zri = MAX( rn2b(ji,jj,jk), 0._wp ) * p_avm(ji,jj,jk) / ( p_sh2(ji,jj,jk) + rn_bshear )
	321	! ! inverse of Prandtl number
[5656]	322	apdlr(ji,jj,jk) = MAX( 0.1_wp, ri_cri / MAX( ri_cri , zri ) )
	323	END DO
	324	END DO
	325	END DO
	326	ENDIF
[5836]	327	!
[5120]	328	DO jk = 2, jpkm1 !* Matrix and right hand side in en
	329	DO jj = 2, jpjm1
	330	DO ji = fs_2, fs_jpim1 ! vector opt.
[1492]	331	zcof = zfact1 * tmask(ji,jj,jk)
[9019]	332	! ! A minimum of 2.e-5 m2/s is imposed on TKE vertical
	333	! ! eddy coefficient (ensure numerical stability)
	334	zzd_up = zcof * MAX( p_avm(ji,jj,jk+1) + p_avm(ji,jj,jk ) , 2.e-5_wp ) & ! upper diagonal
	335	& / ( p_e3t(ji,jj,jk ) * p_e3w(ji,jj,jk ) )
	336	zzd_lw = zcof * MAX( p_avm(ji,jj,jk ) + p_avm(ji,jj,jk-1) , 2.e-5_wp ) & ! lower diagonal
	337	& / ( p_e3t(ji,jj,jk-1) * p_e3w(ji,jj,jk ) )
[5656]	338	!
[1492]	339	zd_up(ji,jj,jk) = zzd_up ! Matrix (zdiag, zd_up, zd_lw)
	340	zd_lw(ji,jj,jk) = zzd_lw
[9019]	341	zdiag(ji,jj,jk) = 1._wp - zzd_lw - zzd_up + zfact2 * dissl(ji,jj,jk) * wmask(ji,jj,jk)
[1239]	342	!
[1492]	343	! ! right hand side in en
[9019]	344	en(ji,jj,jk) = en(ji,jj,jk) + rdt * ( p_sh2(ji,jj,jk) & ! shear
	345	& - p_avt(ji,jj,jk) * rn2(ji,jj,jk) & ! stratification
	346	& + zfact3 * dissl(ji,jj,jk) * en(ji,jj,jk) & ! dissipation
	347	& ) * wmask(ji,jj,jk)
[1239]	348	END DO
[5120]	349	END DO
	350	END DO
	351	! !* Matrix inversion from level 2 (tke prescribed at level 1)
	352	DO jk = 3, jpkm1 ! First recurrence : Dk = Dk - Lk * Uk-1 / Dk-1
	353	DO jj = 2, jpjm1
	354	DO ji = fs_2, fs_jpim1 ! vector opt.
[1492]	355	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]	356	END DO
[5120]	357	END DO
	358	END DO
[5836]	359	DO jj = 2, jpjm1 ! Second recurrence : Lk = RHSk - Lk / Dk-1 * Lk-1
[5120]	360	DO ji = fs_2, fs_jpim1 ! vector opt.
	361	zd_lw(ji,jj,2) = en(ji,jj,2) - zd_lw(ji,jj,2) * en(ji,jj,1) ! Surface boudary conditions on tke
	362	END DO
	363	END DO
	364	DO jk = 3, jpkm1
	365	DO jj = 2, jpjm1
	366	DO ji = fs_2, fs_jpim1 ! vector opt.
[1492]	367	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]	368	END DO
[5120]	369	END DO
	370	END DO
[5836]	371	DO jj = 2, jpjm1 ! thrid recurrence : Ek = ( Lk - Uk * Ek+1 ) / Dk
[5120]	372	DO ji = fs_2, fs_jpim1 ! vector opt.
[1492]	373	en(ji,jj,jpkm1) = zd_lw(ji,jj,jpkm1) / zdiag(ji,jj,jpkm1)
[5120]	374	END DO
	375	END DO
	376	DO jk = jpk-2, 2, -1
	377	DO jj = 2, jpjm1
	378	DO ji = fs_2, fs_jpim1 ! vector opt.
[1492]	379	en(ji,jj,jk) = ( zd_lw(ji,jj,jk) - zd_up(ji,jj,jk) * en(ji,jj,jk+1) ) / zdiag(ji,jj,jk)
[1239]	380	END DO
[5120]	381	END DO
	382	END DO
	383	DO jk = 2, jpkm1 ! set the minimum value of tke
	384	DO jj = 2, jpjm1
	385	DO ji = fs_2, fs_jpim1 ! vector opt.
	386	en(ji,jj,jk) = MAX( en(ji,jj,jk), rn_emin ) * wmask(ji,jj,jk)
[1239]	387	END DO
	388	END DO
	389	END DO
[9019]	390	!
[1492]	391	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	392	! ! TKE due to surface and internal wave breaking
	393	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[6140]	394	!!gm BUG : in the exp remove the depth of ssh !!!
[9019]	395	!!gm i.e. use gde3w in argument (pdepw)
[6140]	396
	397
[2528]	398	IF( nn_etau == 1 ) THEN !* penetration below the mixed layer (rn_efr fraction)
[1492]	399	DO jk = 2, jpkm1
[1239]	400	DO jj = 2, jpjm1
	401	DO ji = fs_2, fs_jpim1 ! vector opt.
[9019]	402	en(ji,jj,jk) = en(ji,jj,jk) + rn_efr * en(ji,jj,1) * EXP( -pdepw(ji,jj,jk) / htau(ji,jj) ) &
[9190]	403	& * MAX(0.,1._wp - 4.fr_i(ji,jj) ) wmask(ji,jj,jk)
	404	!!gm & * MAX(0.,1._wp - 4.fr_i(ji,jj) ) wmask(ji,jj,jk) * tmask(ji,jj,1)
	405	!!gm multiplication by surface tmask useless (already includes in MAX( 0, 1-4*fr_i )
[1239]	406	END DO
	407	END DO
[1492]	408	END DO
[2528]	409	ELSEIF( nn_etau == 2 ) THEN !* act only at the base of the mixed layer (jk=nmln) (rn_efr fraction)
[1492]	410	DO jj = 2, jpjm1
	411	DO ji = fs_2, fs_jpim1 ! vector opt.
	412	jk = nmln(ji,jj)
[9019]	413	en(ji,jj,jk) = en(ji,jj,jk) + rn_efr * en(ji,jj,1) * EXP( -pdepw(ji,jj,jk) / htau(ji,jj) ) &
[9190]	414	& * MAX(0.,1._wp - 4.fr_i(ji,jj) ) wmask(ji,jj,jk)
	415	!!gm & * MAX(0.,1._wp - 4.fr_i(ji,jj) ) wmask(ji,jj,jk) * tmask(ji,jj,1)
[1239]	416	END DO
[1492]	417	END DO
[2528]	418	ELSEIF( nn_etau == 3 ) THEN !* penetration belox the mixed layer (HF variability)
[1705]	419	DO jk = 2, jpkm1
	420	DO jj = 2, jpjm1
	421	DO ji = fs_2, fs_jpim1 ! vector opt.
	422	ztx2 = utau(ji-1,jj ) + utau(ji,jj)
	423	zty2 = vtau(ji ,jj-1) + vtau(ji,jj)
[4990]	424	ztau = 0.5_wp * SQRT( ztx2 * ztx2 + zty2 * zty2 ) * tmask(ji,jj,1) ! module of the mean stress
[2528]	425	zdif = taum(ji,jj) - ztau ! mean of modulus - modulus of the mean
	426	zdif = rhftau_scl * MAX( 0._wp, zdif + rhftau_add ) ! apply some modifications...
[9019]	427	en(ji,jj,jk) = en(ji,jj,jk) + zbbrau * zdif * EXP( -pdepw(ji,jj,jk) / htau(ji,jj) ) &
[9190]	428	& * MAX(0.,1._wp - 4.fr_i(ji,jj) ) wmask(ji,jj,jk)
	429	!!gm & * MAX(0.,1._wp - 4.fr_i(ji,jj) ) wmask(ji,jj,jk) * tmask(ji,jj,1)
[1705]	430	END DO
	431	END DO
	432	END DO
[1239]	433	ENDIF
[1492]	434	!
[1239]	435	END SUBROUTINE tke_tke
	436
[1492]	437
[9019]	438	SUBROUTINE tke_avn( pdepw, p_e3t, p_e3w, p_avm, p_avt )
[1239]	439	!!----------------------------------------------------------------------
[1492]	440	!! * ROUTINE tke_avn *
[1239]	441	!!
[1492]	442	!! ** Purpose : Compute the vertical eddy viscosity and diffusivity
	443	!!
	444	!! ** Method : At this stage, en, the now TKE, is known (computed in
	445	!! the tke_tke routine). First, the now mixing lenth is
	446	!! computed from en and the strafification (N^2), then the mixings
	447	!! coefficients are computed.
	448	!! - Mixing length : a first evaluation of the mixing lengh
	449	!! scales is:
	450	!! mxl = sqrt(2*en) / N
	451	!! where N is the brunt-vaisala frequency, with a minimum value set
[2528]	452	!! to rmxl_min (rn_mxl0) in the interior (surface) ocean.
[1492]	453	!! The mixing and dissipative length scale are bound as follow :
	454	!! nn_mxl=0 : mxl bounded by the distance to surface and bottom.
	455	!! zmxld = zmxlm = mxl
	456	!! nn_mxl=1 : mxl bounded by the e3w and zmxld = zmxlm = mxl
	457	!! nn_mxl=2 : mxl bounded such that the vertical derivative of mxl is
	458	!! less than 1 (\|d/dz(mxl)\|<1) and zmxld = zmxlm = mxl
	459	!! nn_mxl=3 : mxl is bounded from the surface to the bottom usings
	460	!! \|d/dz(xml)\|<1 to obtain lup, and from the bottom to
	461	!! the surface to obtain ldown. the resulting length
	462	!! scales are:
	463	!! zmxld = sqrt( lup * ldown )
	464	!! zmxlm = min ( lup , ldown )
	465	!! - Vertical eddy viscosity and diffusivity:
	466	!! avm = max( avtb, rn_ediff * zmxlm * en^1/2 )
	467	!! avt = max( avmb, pdlr * avm )
	468	!! with pdlr=1 if nn_pdl=0, pdlr=1/pdl=F(Ri) otherwise.
	469	!!
[9019]	470	!! ** Action : - avt, avm : now vertical eddy diffusivity and viscosity (w-point)
[1239]	471	!!----------------------------------------------------------------------
[9019]	472	USE zdf_oce , ONLY : en, avtb, avmb, avtb_2d ! ocean vertical physics
	473	!!
	474	REAL(wp), DIMENSION(:,:,:), INTENT(in ) :: pdepw ! depth (w-points)
	475	REAL(wp), DIMENSION(:,:,:), INTENT(in ) :: p_e3t, p_e3w ! level thickness (t- & w-points)
	476	REAL(wp), DIMENSION(:,:,:), INTENT( out) :: p_avm, p_avt ! vertical eddy viscosity & diffusivity (w-points)
	477	!
[2715]	478	INTEGER :: ji, jj, jk ! dummy loop indices
[9019]	479	REAL(wp) :: zrn2, zraug, zcoef, zav ! local scalars
	480	REAL(wp) :: zdku, zdkv, zsqen ! - -
	481	REAL(wp) :: zemxl, zemlm, zemlp ! - -
	482	REAL(wp), DIMENSION(jpi,jpj,jpk) :: zmxlm, zmxld ! 3D workspace
[1239]	483	!!--------------------------------------------------------------------
[3294]	484	!
[1492]	485	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	486	! ! Mixing length
	487	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	488	!
	489	! !* Buoyancy length scale: l=sqrt(2e/n*2)
	490	!
[5120]	491	! initialisation of interior minimum value (avoid a 2d loop with mikt)
[7753]	492	zmxlm(:,:,:) = rmxl_min
	493	zmxld(:,:,:) = rmxl_min
[5120]	494	!
[2528]	495	IF( ln_mxl0 ) THEN ! surface mixing length = F(stress) : l=vkarmn2.e5taum/(rau0*g)
[9019]	496	zraug = vkarmn * 2.e5_wp / ( rau0 * grav )
[4990]	497	DO jj = 2, jpjm1
	498	DO ji = fs_2, fs_jpim1
[5120]	499	zmxlm(ji,jj,1) = MAX( rn_mxl0, zraug * taum(ji,jj) * tmask(ji,jj,1) )
[4990]	500	END DO
	501	END DO
	502	ELSE
[7753]	503	zmxlm(:,:,1) = rn_mxl0
[1239]	504	ENDIF
	505	!
[5120]	506	DO jk = 2, jpkm1 ! interior value : l=sqrt(2*e/n^2)
	507	DO jj = 2, jpjm1
	508	DO ji = fs_2, fs_jpim1 ! vector opt.
[1239]	509	zrn2 = MAX( rn2(ji,jj,jk), rsmall )
[5836]	510	zmxlm(ji,jj,jk) = MAX( rmxl_min, SQRT( 2._wp * en(ji,jj,jk) / zrn2 ) )
[1239]	511	END DO
	512	END DO
	513	END DO
[1492]	514	!
	515	! !* Physical limits for the mixing length
	516	!
[7753]	517	zmxld(:,:, 1 ) = zmxlm(:,:,1) ! surface set to the minimum value
	518	zmxld(:,:,jpk) = rmxl_min ! last level set to the minimum value
[1492]	519	!
[1239]	520	SELECT CASE ( nn_mxl )
	521	!
[5836]	522	!!gm Not sure of that coding for ISF....
[9019]	523	! where wmask = 0 set zmxlm == p_e3w
[1239]	524	CASE ( 0 ) ! bounded by the distance to surface and bottom
[5120]	525	DO jk = 2, jpkm1
	526	DO jj = 2, jpjm1
	527	DO ji = fs_2, fs_jpim1 ! vector opt.
[9019]	528	zemxl = MIN( pdepw(ji,jj,jk) - pdepw(ji,jj,mikt(ji,jj)), zmxlm(ji,jj,jk), &
	529	& pdepw(ji,jj,mbkt(ji,jj)+1) - pdepw(ji,jj,jk) )
[5120]	530	! wmask prevent zmxlm = 0 if jk = mikt(ji,jj)
[9019]	531	zmxlm(ji,jj,jk) = zemxl * wmask(ji,jj,jk) + MIN( zmxlm(ji,jj,jk) , p_e3w(ji,jj,jk) ) * (1 - wmask(ji,jj,jk))
	532	zmxld(ji,jj,jk) = zemxl * wmask(ji,jj,jk) + MIN( zmxlm(ji,jj,jk) , p_e3w(ji,jj,jk) ) * (1 - wmask(ji,jj,jk))
[1239]	533	END DO
	534	END DO
	535	END DO
	536	!
	537	CASE ( 1 ) ! bounded by the vertical scale factor
[5120]	538	DO jk = 2, jpkm1
	539	DO jj = 2, jpjm1
	540	DO ji = fs_2, fs_jpim1 ! vector opt.
[9019]	541	zemxl = MIN( p_e3w(ji,jj,jk), zmxlm(ji,jj,jk) )
[1239]	542	zmxlm(ji,jj,jk) = zemxl
	543	zmxld(ji,jj,jk) = zemxl
	544	END DO
	545	END DO
	546	END DO
	547	!
	548	CASE ( 2 ) ! \|dk[xml]\| bounded by e3t :
[5120]	549	DO jk = 2, jpkm1 ! from the surface to the bottom :
	550	DO jj = 2, jpjm1
	551	DO ji = fs_2, fs_jpim1 ! vector opt.
[9019]	552	zmxlm(ji,jj,jk) = MIN( zmxlm(ji,jj,jk-1) + p_e3t(ji,jj,jk-1), zmxlm(ji,jj,jk) )
[1239]	553	END DO
[5120]	554	END DO
	555	END DO
	556	DO jk = jpkm1, 2, -1 ! from the bottom to the surface :
	557	DO jj = 2, jpjm1
	558	DO ji = fs_2, fs_jpim1 ! vector opt.
[9019]	559	zemxl = MIN( zmxlm(ji,jj,jk+1) + p_e3t(ji,jj,jk+1), zmxlm(ji,jj,jk) )
[1239]	560	zmxlm(ji,jj,jk) = zemxl
	561	zmxld(ji,jj,jk) = zemxl
	562	END DO
	563	END DO
	564	END DO
	565	!
	566	CASE ( 3 ) ! lup and ldown, \|dk[xml]\| bounded by e3t :
[5120]	567	DO jk = 2, jpkm1 ! from the surface to the bottom : lup
	568	DO jj = 2, jpjm1
	569	DO ji = fs_2, fs_jpim1 ! vector opt.
[9019]	570	zmxld(ji,jj,jk) = MIN( zmxld(ji,jj,jk-1) + p_e3t(ji,jj,jk-1), zmxlm(ji,jj,jk) )
[1239]	571	END DO
[5120]	572	END DO
	573	END DO
	574	DO jk = jpkm1, 2, -1 ! from the bottom to the surface : ldown
	575	DO jj = 2, jpjm1
	576	DO ji = fs_2, fs_jpim1 ! vector opt.
[9019]	577	zmxlm(ji,jj,jk) = MIN( zmxlm(ji,jj,jk+1) + p_e3t(ji,jj,jk+1), zmxlm(ji,jj,jk) )
[1239]	578	END DO
	579	END DO
	580	END DO
	581	DO jk = 2, jpkm1
	582	DO jj = 2, jpjm1
	583	DO ji = fs_2, fs_jpim1 ! vector opt.
	584	zemlm = MIN ( zmxld(ji,jj,jk), zmxlm(ji,jj,jk) )
	585	zemlp = SQRT( zmxld(ji,jj,jk) * zmxlm(ji,jj,jk) )
	586	zmxlm(ji,jj,jk) = zemlm
	587	zmxld(ji,jj,jk) = zemlp
	588	END DO
	589	END DO
	590	END DO
	591	!
	592	END SELECT
[1492]	593	!
	594	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[9019]	595	! ! Vertical eddy viscosity and diffusivity (avm and avt)
[1492]	596	! !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
	597	DO jk = 1, jpkm1 !* vertical eddy viscosity & diffivity at w-points
[1239]	598	DO jj = 2, jpjm1
	599	DO ji = fs_2, fs_jpim1 ! vector opt.
	600	zsqen = SQRT( en(ji,jj,jk) )
	601	zav = rn_ediff * zmxlm(ji,jj,jk) * zsqen
[9019]	602	p_avm(ji,jj,jk) = MAX( zav, avmb(jk) ) * wmask(ji,jj,jk)
	603	p_avt(ji,jj,jk) = MAX( zav, avtb_2d(ji,jj) * avtb(jk) ) * wmask(ji,jj,jk)
[1239]	604	dissl(ji,jj,jk) = zsqen / zmxld(ji,jj,jk)
	605	END DO
	606	END DO
	607	END DO
[1492]	608	!
	609	!
	610	IF( nn_pdl == 1 ) THEN !* Prandtl number case: update avt
[5120]	611	DO jk = 2, jpkm1
	612	DO jj = 2, jpjm1
	613	DO ji = fs_2, fs_jpim1 ! vector opt.
[9019]	614	p_avt(ji,jj,jk) = MAX( apdlr(ji,jj,jk) * p_avt(ji,jj,jk), avtb_2d(ji,jj) * avtb(jk) ) * tmask(ji,jj,jk)
[1239]	615	END DO
	616	END DO
	617	END DO
	618	ENDIF
[9019]	619	!
[1239]	620	IF(ln_ctl) THEN
[9440]	621	CALL prt_ctl( tab3d_1=en , clinfo1=' tke - e: ', tab3d_2=p_avt, clinfo2=' t: ', kdim=jpk)
	622	CALL prt_ctl( tab3d_1=p_avm, clinfo1=' tke - m: ', kdim=jpk )
[1239]	623	ENDIF
	624	!
[1492]	625	END SUBROUTINE tke_avn
[1239]	626
[1492]	627
[2528]	628	SUBROUTINE zdf_tke_init
[1239]	629	!!----------------------------------------------------------------------
[2528]	630	!! * ROUTINE zdf_tke_init *
[1239]	631	!!
	632	!! ** Purpose : Initialization of the vertical eddy diffivity and
[1492]	633	!! viscosity when using a tke turbulent closure scheme
[1239]	634	!!
[1601]	635	!! ** Method : Read the namzdf_tke namelist and check the parameters
[1492]	636	!! called at the first timestep (nit000)
[1239]	637	!!
[1601]	638	!! ** input : Namlist namzdf_tke
[1239]	639	!!
	640	!! ** Action : Increase by 1 the nstop flag is setting problem encounter
	641	!!----------------------------------------------------------------------
[9019]	642	USE zdf_oce , ONLY : ln_zdfiwm ! Internal Wave Mixing flag
	643	!!
[1239]	644	INTEGER :: ji, jj, jk ! dummy loop indices
[4147]	645	INTEGER :: ios
[1239]	646	!!
[9019]	647	NAMELIST/namzdf_tke/ rn_ediff, rn_ediss , rn_ebb , rn_emin , &
	648	& rn_emin0, rn_bshear, nn_mxl , ln_mxl0 , &
	649	& rn_mxl0 , nn_pdl , ln_drg , ln_lc , rn_lc, &
[2528]	650	& nn_etau , nn_htau , rn_efr
[1239]	651	!!----------------------------------------------------------------------
[2715]	652	!
[4147]	653	REWIND( numnam_ref ) ! Namelist namzdf_tke in reference namelist : Turbulent Kinetic Energy
	654	READ ( numnam_ref, namzdf_tke, IOSTAT = ios, ERR = 901)
	655	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namzdf_tke in reference namelist', lwp )
	656
	657	REWIND( numnam_cfg ) ! Namelist namzdf_tke in configuration namelist : Turbulent Kinetic Energy
	658	READ ( numnam_cfg, namzdf_tke, IOSTAT = ios, ERR = 902 )
[9104]	659	902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namzdf_tke in configuration namelist', lwp )
[4624]	660	IF(lwm) WRITE ( numond, namzdf_tke )
[2715]	661	!
[2528]	662	ri_cri = 2._wp / ( 2._wp + rn_ediss / rn_ediff ) ! resulting critical Richardson number
[2715]	663	!
[1492]	664	IF(lwp) THEN !* Control print
[1239]	665	WRITE(numout,*)
[2528]	666	WRITE(numout,*) 'zdf_tke_init : tke turbulent closure scheme - initialisation'
	667	WRITE(numout,*) '~~~~~~~~~~~~'
[1601]	668	WRITE(numout,*) ' Namelist namzdf_tke : set tke mixing parameters'
[1705]	669	WRITE(numout,*) ' coef. to compute avt rn_ediff = ', rn_ediff
	670	WRITE(numout,*) ' Kolmogoroff dissipation coef. rn_ediss = ', rn_ediss
	671	WRITE(numout,*) ' tke surface input coef. rn_ebb = ', rn_ebb
	672	WRITE(numout,*) ' minimum value of tke rn_emin = ', rn_emin
	673	WRITE(numout,*) ' surface minimum value of tke rn_emin0 = ', rn_emin0
[9019]	674	WRITE(numout,*) ' prandl number flag nn_pdl = ', nn_pdl
[1705]	675	WRITE(numout,*) ' background shear (>0) rn_bshear = ', rn_bshear
	676	WRITE(numout,*) ' mixing length type nn_mxl = ', nn_mxl
[9019]	677	WRITE(numout,*) ' surface mixing length = F(stress) or not ln_mxl0 = ', ln_mxl0
	678	WRITE(numout,*) ' surface mixing length minimum value rn_mxl0 = ', rn_mxl0
	679	WRITE(numout,*) ' top/bottom friction forcing flag ln_drg = ', ln_drg
	680	WRITE(numout,*) ' Langmuir cells parametrization ln_lc = ', ln_lc
	681	WRITE(numout,*) ' coef to compute vertical velocity of LC rn_lc = ', rn_lc
[1705]	682	WRITE(numout,*) ' test param. to add tke induced by wind nn_etau = ', nn_etau
[9019]	683	WRITE(numout,*) ' type of tke penetration profile nn_htau = ', nn_htau
	684	WRITE(numout,*) ' fraction of TKE that penetrates rn_efr = ', rn_efr
	685	IF( ln_drg ) THEN
[9169]	686	WRITE(numout,*)
[9019]	687	WRITE(numout,*) ' Namelist namdrg_top/_bot: used values:'
	688	WRITE(numout,*) ' top ocean cavity roughness (m) rn_z0(_top)= ', r_z0_top
	689	WRITE(numout,*) ' Bottom seafloor roughness (m) rn_z0(_bot)= ', r_z0_bot
	690	ENDIF
	691	WRITE(numout,*)
[9190]	692	WRITE(numout,*) ' ==>>> critical Richardson nb with your parameters ri_cri = ', ri_cri
[9019]	693	WRITE(numout,*)
[1239]	694	ENDIF
[2715]	695	!
[9019]	696	IF( ln_zdfiwm ) THEN ! Internal wave-driven mixing
	697	rn_emin = 1.e-10_wp ! specific values of rn_emin & rmxl_min are used
	698	rmxl_min = 1.e-03_wp ! associated avt minimum = molecular salt diffusivity (10^-9 m2/s)
[9190]	699	IF(lwp) WRITE(numout,*) ' ==>>> Internal wave-driven mixing case: force rn_emin = 1.e-10 and rmxl_min = 1.e-3'
[9019]	700	ELSE ! standard case : associated avt minimum = molecular viscosity (10^-6 m2/s)
	701	rmxl_min = 1.e-6_wp / ( rn_ediff * SQRT( rn_emin ) ) ! resulting minimum length to recover molecular viscosity
[9190]	702	IF(lwp) WRITE(numout,*) ' ==>>> minimum mixing length with your parameters rmxl_min = ', rmxl_min
[9019]	703	ENDIF
	704	!
[2715]	705	! ! allocate tke arrays
	706	IF( zdf_tke_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'zdf_tke_init : unable to allocate arrays' )
	707	!
[1492]	708	! !* Check of some namelist values
[4990]	709	IF( nn_mxl < 0 .OR. nn_mxl > 3 ) CALL ctl_stop( 'bad flag: nn_mxl is 0, 1 or 2 ' )
	710	IF( nn_pdl < 0 .OR. nn_pdl > 1 ) CALL ctl_stop( 'bad flag: nn_pdl is 0 or 1 ' )
	711	IF( nn_htau < 0 .OR. nn_htau > 1 ) CALL ctl_stop( 'bad flag: nn_htau is 0, 1 or 2 ' )
[5407]	712	IF( nn_etau == 3 .AND. .NOT. ln_cpl ) CALL ctl_stop( 'nn_etau == 3 : HF taum only known in coupled mode' )
[9019]	713	!
[2528]	714	IF( ln_mxl0 ) THEN
[9169]	715	IF(lwp) WRITE(numout,*)
[9190]	716	IF(lwp) WRITE(numout,*) ' ==>>> use a surface mixing length = F(stress) : set rn_mxl0 = rmxl_min'
[2528]	717	rn_mxl0 = rmxl_min
	718	ENDIF
	719
[1492]	720	IF( nn_etau == 2 ) CALL zdf_mxl( nit000 ) ! Initialization of nmln
[1239]	721
[1492]	722	! !* depth of penetration of surface tke
	723	IF( nn_etau /= 0 ) THEN
[1601]	724	SELECT CASE( nn_htau ) ! Choice of the depth of penetration
[2528]	725	CASE( 0 ) ! constant depth penetration (here 10 meters)
[7753]	726	htau(:,:) = 10._wp
[2528]	727	CASE( 1 ) ! F(latitude) : 0.5m to 30m poleward of 40 degrees
[7753]	728	htau(:,:) = MAX( 0.5_wp, MIN( 30._wp, 45._wp* ABS( SIN( rpi/180._wp * gphit(:,:) ) ) ) )
[1492]	729	END SELECT
	730	ENDIF
[9019]	731	! !* read or initialize all required files
	732	CALL tke_rst( nit000, 'READ' ) ! (en, avt_k, avm_k, dissl)
[1239]	733	!
[9367]	734	IF( lwxios ) THEN
	735	CALL iom_set_rstw_var_active('en')
	736	CALL iom_set_rstw_var_active('avt_k')
	737	CALL iom_set_rstw_var_active('avm_k')
	738	CALL iom_set_rstw_var_active('dissl')
	739	ENDIF
[2528]	740	END SUBROUTINE zdf_tke_init
[1239]	741
	742
[1531]	743	SUBROUTINE tke_rst( kt, cdrw )
[9019]	744	!!---------------------------------------------------------------------
	745	!! * ROUTINE tke_rst *
	746	!!
	747	!! ** Purpose : Read or write TKE file (en) in restart file
	748	!!
	749	!! ** Method : use of IOM library
	750	!! if the restart does not contain TKE, en is either
	751	!! set to rn_emin or recomputed
	752	!!----------------------------------------------------------------------
	753	USE zdf_oce , ONLY : en, avt_k, avm_k ! ocean vertical physics
	754	!!
	755	INTEGER , INTENT(in) :: kt ! ocean time-step
	756	CHARACTER(len=*), INTENT(in) :: cdrw ! "READ"/"WRITE" flag
	757	!
	758	INTEGER :: jit, jk ! dummy loop indices
	759	INTEGER :: id1, id2, id3, id4 ! local integers
	760	!!----------------------------------------------------------------------
	761	!
	762	IF( TRIM(cdrw) == 'READ' ) THEN ! Read/initialise
	763	! ! ---------------
	764	IF( ln_rstart ) THEN !* Read the restart file
	765	id1 = iom_varid( numror, 'en' , ldstop = .FALSE. )
	766	id2 = iom_varid( numror, 'avt_k', ldstop = .FALSE. )
	767	id3 = iom_varid( numror, 'avm_k', ldstop = .FALSE. )
	768	id4 = iom_varid( numror, 'dissl', ldstop = .FALSE. )
	769	!
	770	IF( MIN( id1, id2, id3, id4 ) > 0 ) THEN ! fields exist
[9367]	771	CALL iom_get( numror, jpdom_autoglo, 'en' , en , ldxios = lrxios )
	772	CALL iom_get( numror, jpdom_autoglo, 'avt_k', avt_k, ldxios = lrxios )
	773	CALL iom_get( numror, jpdom_autoglo, 'avm_k', avm_k, ldxios = lrxios )
	774	CALL iom_get( numror, jpdom_autoglo, 'dissl', dissl, ldxios = lrxios )
[9019]	775	ELSE ! start TKE from rest
[9169]	776	IF(lwp) WRITE(numout,*)
[9190]	777	IF(lwp) WRITE(numout,*) ' ==>>> previous run without TKE scheme, set en to background values'
[9019]	778	en (:,:,:) = rn_emin * wmask(:,:,:)
	779	dissl(:,:,:) = 1.e-12_wp
	780	! avt_k, avm_k already set to the background value in zdf_phy_init
	781	ENDIF
	782	ELSE !* Start from rest
[9169]	783	IF(lwp) WRITE(numout,*)
[9190]	784	IF(lwp) WRITE(numout,*) ' ==>>> start from rest: set en to the background value'
[9019]	785	en (:,:,:) = rn_emin * wmask(:,:,:)
	786	dissl(:,:,:) = 1.e-12_wp
	787	! avt_k, avm_k already set to the background value in zdf_phy_init
	788	ENDIF
	789	!
	790	ELSEIF( TRIM(cdrw) == 'WRITE' ) THEN ! Create restart file
	791	! ! -------------------
[9169]	792	IF(lwp) WRITE(numout,*) '---- tke_rst ----'
[9367]	793	IF( lwxios ) CALL iom_swap( cwxios_context )
	794	CALL iom_rstput( kt, nitrst, numrow, 'en' , en , ldxios = lwxios )
	795	CALL iom_rstput( kt, nitrst, numrow, 'avt_k', avt_k, ldxios = lwxios )
	796	CALL iom_rstput( kt, nitrst, numrow, 'avm_k', avm_k, ldxios = lwxios )
	797	CALL iom_rstput( kt, nitrst, numrow, 'dissl', dissl, ldxios = lwxios )
	798	IF( lwxios ) CALL iom_swap( cxios_context )
[9019]	799	!
	800	ENDIF
	801	!
[1531]	802	END SUBROUTINE tke_rst
[1239]	803
	804	!!======================================================================
[1531]	805	END MODULE zdftke

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

Download in other formats: