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 NEMO/trunk/src/OCE/ZDF – NEMO

Context Navigation

source: NEMO/trunk/src/OCE/ZDF/zdftke.F90 @ 13295

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

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

Download in other formats: