\hypertarget{structmom__kappa__shear_1_1kappa__shear__cs}{}\doxysection{mom\+\_\+kappa\+\_\+shear\+::kappa\+\_\+shear\+\_\+cs Type Reference}
\label{structmom__kappa__shear_1_1kappa__shear__cs}\index{mom\_kappa\_shear::kappa\_shear\_cs@{mom\_kappa\_shear::kappa\_shear\_cs}}


\doxysubsection{Detailed Description}
This control structure holds the parameters that regulate shear mixing. 

Definition at line 32 of file M\+O\+M\+\_\+kappa\+\_\+shear.\+F90.



Collaboration diagram for mom\+\_\+kappa\+\_\+shear\+::kappa\+\_\+shear\+\_\+cs\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{structmom__kappa__shear_1_1kappa__shear__cs__coll__graph}
\end{center}
\end{figure}
\doxysubsection*{Public variables and constants}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a491d4c0fb8ad0dc9be7d323f30d6084f}\label{structmom__kappa__shear_1_1kappa__shear__cs_a491d4c0fb8ad0dc9be7d323f30d6084f}} 
real \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a491d4c0fb8ad0dc9be7d323f30d6084f}{rino\+\_\+crit}}
\begin{DoxyCompactList}\small\item\em The critical shear Richardson number for shear-\/entrainment \mbox{[}nondim\mbox{]}. The theoretical value is 0.\+25. The values found by Jackson et al. are 0.\+25-\/0.\+35. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_ab6dffe0dd4034d809c1bbd9e014cba50}\label{structmom__kappa__shear_1_1kappa__shear__cs_ab6dffe0dd4034d809c1bbd9e014cba50}} 
real \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_ab6dffe0dd4034d809c1bbd9e014cba50}{shearmix\+\_\+rate}}
\begin{DoxyCompactList}\small\item\em A nondimensional rate scale for shear-\/driven entrainment \mbox{[}nondim\mbox{]}. The value given by Jackson et al. is 0.\+085-\/0.\+089. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a65226e799a40c10870c11b831052f6ed}\label{structmom__kappa__shear_1_1kappa__shear__cs_a65226e799a40c10870c11b831052f6ed}} 
real \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a65226e799a40c10870c11b831052f6ed}{fri\+\_\+curvature}}
\begin{DoxyCompactList}\small\item\em A constant giving the curvature of the function of the Richardson number that relates shear to sources in the kappa equation \mbox{[}nondim\mbox{]}. The values found by Jackson et al. are -\/0.\+97 -\/ -\/0.\+89. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a49b4f2a412de46ff7531583aec2f03b5}\label{structmom__kappa__shear_1_1kappa__shear__cs_a49b4f2a412de46ff7531583aec2f03b5}} 
real \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a49b4f2a412de46ff7531583aec2f03b5}{c\+\_\+n}}
\begin{DoxyCompactList}\small\item\em The coefficient for the decay of T\+KE due to stratification (i.\+e. proportional to N$\ast$tke) \mbox{[}nondim\mbox{]}. The values found by Jackson et al. are 0.\+24-\/0.\+28. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a0cfb5a78acd2f7d3fcea840b2edbdec7}\label{structmom__kappa__shear_1_1kappa__shear__cs_a0cfb5a78acd2f7d3fcea840b2edbdec7}} 
real \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a0cfb5a78acd2f7d3fcea840b2edbdec7}{c\+\_\+s}}
\begin{DoxyCompactList}\small\item\em The coefficient for the decay of T\+KE due to shear (i.\+e. proportional to $\vert$\+S$\vert$$\ast$tke) \mbox{[}nondim\mbox{]}. The values found by Jackson et al. are 0.\+14-\/0.\+12. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_af1f8f118ffcf3e664bab07d31681e65a}\label{structmom__kappa__shear_1_1kappa__shear__cs_af1f8f118ffcf3e664bab07d31681e65a}} 
real \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_af1f8f118ffcf3e664bab07d31681e65a}{lambda}}
\begin{DoxyCompactList}\small\item\em The coefficient for the buoyancy length scale in the kappa equation \mbox{[}nondim\mbox{]}. The values found by Jackson et al. are 0.\+82-\/0.\+81. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a7b0ae399d88d8bc12e028f10802e86e6}\label{structmom__kappa__shear_1_1kappa__shear__cs_a7b0ae399d88d8bc12e028f10802e86e6}} 
real \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a7b0ae399d88d8bc12e028f10802e86e6}{lambda2\+\_\+n\+\_\+s}}
\begin{DoxyCompactList}\small\item\em The square of the ratio of the coefficients of the buoyancy and shear scales in the diffusivity equation, 0 to eliminate the shear scale \mbox{[}nondim\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a8ccda2619491b65d5f99be96bb50c329}\label{structmom__kappa__shear_1_1kappa__shear__cs_a8ccda2619491b65d5f99be96bb50c329}} 
real \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a8ccda2619491b65d5f99be96bb50c329}{tke\+\_\+bg}}
\begin{DoxyCompactList}\small\item\em The background level of T\+KE \mbox{[}Z2 T-\/2 $\sim$$>$ m2 s-\/2\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a90af795e54b8483d7ba8c57a135dba69}\label{structmom__kappa__shear_1_1kappa__shear__cs_a90af795e54b8483d7ba8c57a135dba69}} 
real \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a90af795e54b8483d7ba8c57a135dba69}{kappa\+\_\+0}}
\begin{DoxyCompactList}\small\item\em The background diapycnal diffusivity \mbox{[}Z2 T-\/1 $\sim$$>$ m2 s-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_acf3ef7a870cbd10b9b7c630e414b036d}\label{structmom__kappa__shear_1_1kappa__shear__cs_acf3ef7a870cbd10b9b7c630e414b036d}} 
real \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_acf3ef7a870cbd10b9b7c630e414b036d}{kappa\+\_\+trunc}}
\begin{DoxyCompactList}\small\item\em Diffusivities smaller than this are rounded to 0 \mbox{[}Z2 T-\/1 $\sim$$>$ m2 s-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a85eb6ca200b51907b88e69b380477910}\label{structmom__kappa__shear_1_1kappa__shear__cs_a85eb6ca200b51907b88e69b380477910}} 
real \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a85eb6ca200b51907b88e69b380477910}{kappa\+\_\+tol\+\_\+err}}
\begin{DoxyCompactList}\small\item\em The fractional error in kappa that is tolerated \mbox{[}nondim\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_ae7500bc8991569fa645086735169e1d2}\label{structmom__kappa__shear_1_1kappa__shear__cs_ae7500bc8991569fa645086735169e1d2}} 
real \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_ae7500bc8991569fa645086735169e1d2}{prandtl\+\_\+turb}}
\begin{DoxyCompactList}\small\item\em Prandtl number used to convert Kd\+\_\+shear into viscosity \mbox{[}nondim\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_ac697fae6d49039b8815ceb94d77bb36b}\label{structmom__kappa__shear_1_1kappa__shear__cs_ac697fae6d49039b8815ceb94d77bb36b}} 
integer \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_ac697fae6d49039b8815ceb94d77bb36b}{nkml}}
\begin{DoxyCompactList}\small\item\em The number of layers in the mixed layer, as treated in this routine. If the pieces of the mixed layer are not to be treated collectively, nkml is set to 1. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a63413e965f0c1526d3a4170408451b23}\label{structmom__kappa__shear_1_1kappa__shear__cs_a63413e965f0c1526d3a4170408451b23}} 
integer \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a63413e965f0c1526d3a4170408451b23}{max\+\_\+rino\+\_\+it}}
\begin{DoxyCompactList}\small\item\em The maximum number of iterations that may be used to estimate the instantaneous shear-\/driven mixing. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a4e0784f28ce83cf8fb0abb017efa7b54}\label{structmom__kappa__shear_1_1kappa__shear__cs_a4e0784f28ce83cf8fb0abb017efa7b54}} 
integer \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a4e0784f28ce83cf8fb0abb017efa7b54}{max\+\_\+ks\+\_\+it}}
\begin{DoxyCompactList}\small\item\em The maximum number of iterations that may be used to estimate the time-\/averaged diffusivity. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a47697afaaacfcd22650db52f18e5c108}\label{structmom__kappa__shear_1_1kappa__shear__cs_a47697afaaacfcd22650db52f18e5c108}} 
logical \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a47697afaaacfcd22650db52f18e5c108}{dkdq\+\_\+iteration\+\_\+bug}}
\begin{DoxyCompactList}\small\item\em If true. use an older, dimensionally inconsistent estimate of the derivative of diffusivity with energy in the Newton\textquotesingle{}s method iteration. The bug causes undercorrections when dz $>$ 1m. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a92cbcfd11e5175094ec539343dc7b1e5}\label{structmom__kappa__shear_1_1kappa__shear__cs_a92cbcfd11e5175094ec539343dc7b1e5}} 
logical \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a92cbcfd11e5175094ec539343dc7b1e5}{ks\+\_\+at\+\_\+vertex}}
\begin{DoxyCompactList}\small\item\em If true, do the calculations of the shear-\/driven mixing at the cell vertices (i.\+e., the vorticity points). \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a1a668dc437b4b87e046fc088024833e8}\label{structmom__kappa__shear_1_1kappa__shear__cs_a1a668dc437b4b87e046fc088024833e8}} 
logical \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a1a668dc437b4b87e046fc088024833e8}{eliminate\+\_\+massless}}
\begin{DoxyCompactList}\small\item\em If true, massless layers are merged with neighboring massive layers in this calculation. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_abb014ae9f7ea06c2d945d4b722919007}\label{structmom__kappa__shear_1_1kappa__shear__cs_abb014ae9f7ea06c2d945d4b722919007}} 
real \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_abb014ae9f7ea06c2d945d4b722919007}{vel\+\_\+underflow}}
\begin{DoxyCompactList}\small\item\em Velocity components smaller than vel\+\_\+underflow are set to 0 \mbox{[}L T-\/1 $\sim$$>$ m s-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a393cff894673f6ddfa1061a83704d7de}\label{structmom__kappa__shear_1_1kappa__shear__cs_a393cff894673f6ddfa1061a83704d7de}} 
real \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a393cff894673f6ddfa1061a83704d7de}{kappa\+\_\+src\+\_\+max\+\_\+chg}}
\begin{DoxyCompactList}\small\item\em The maximum permitted increase in the kappa source within an iteration relative to the local source \mbox{[}nondim\mbox{]}. This must be greater than 1. The lower limit for the permitted fractional decrease is (1 -\/ 0.\+5/kappa\+\_\+src\+\_\+max\+\_\+chg). These limits could perhaps be made dynamic with an improved iterative solver. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_acddae8258b79338ca023a5580f99ad4f}\label{structmom__kappa__shear_1_1kappa__shear__cs_acddae8258b79338ca023a5580f99ad4f}} 
logical \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_acddae8258b79338ca023a5580f99ad4f}{psurf\+\_\+bug}}
\begin{DoxyCompactList}\small\item\em If true, do a simple average of the cell surface pressures to get a surface pressure at the corner if V\+E\+R\+T\+E\+X\+\_\+\+S\+H\+E\+AR=True. Otherwise mask out any land points in the average. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_ab5a52bd2fa971c30de85326cff330996}\label{structmom__kappa__shear_1_1kappa__shear__cs_ab5a52bd2fa971c30de85326cff330996}} 
logical \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_ab5a52bd2fa971c30de85326cff330996}{all\+\_\+layer\+\_\+tke\+\_\+bug}}
\begin{DoxyCompactList}\small\item\em If true, report back the latest estimate of T\+KE instead of the time average T\+KE when there is mass in all layers. Otherwise always report the time-\/averaged T\+KE, as is currently done when there are some massless layers. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a00cef31dabc4f98874669ebfe74acf21}\label{structmom__kappa__shear_1_1kappa__shear__cs_a00cef31dabc4f98874669ebfe74acf21}} 
logical \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a00cef31dabc4f98874669ebfe74acf21}{restrictive\+\_\+tolerance\+\_\+check}}
\begin{DoxyCompactList}\small\item\em If false, uses the less restrictive tolerance check to determine if a timestep is acceptable for the K\+S\+\_\+it outer iteration loop, as the code was originally written. True uses the more restrictive check. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a0e1484cd57989de6303cc1c24edb69a2}\label{structmom__kappa__shear_1_1kappa__shear__cs_a0e1484cd57989de6303cc1c24edb69a2}} 
logical \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a0e1484cd57989de6303cc1c24edb69a2}{debug}} = .false.
\begin{DoxyCompactList}\small\item\em If true, write verbose debugging messages. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a245452ab8c99a84ebbccc8ebb0f4c590}\label{structmom__kappa__shear_1_1kappa__shear__cs_a245452ab8c99a84ebbccc8ebb0f4c590}} 
type(\mbox{\hyperlink{structmom__diag__mediator_1_1diag__ctrl}{diag\+\_\+ctrl}}), pointer \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a245452ab8c99a84ebbccc8ebb0f4c590}{diag}} =$>$ N\+U\+LL()
\begin{DoxyCompactList}\small\item\em A structure that is used to regulate the timing of diagnostic output. \end{DoxyCompactList}\end{DoxyCompactItemize}
\textbf{ }\par
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a8238f2e205503820c866c5693834782d}\label{structmom__kappa__shear_1_1kappa__shear__cs_a8238f2e205503820c866c5693834782d}} 
integer \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a8238f2e205503820c866c5693834782d}{id\+\_\+kd\+\_\+shear}} = -\/1
\begin{DoxyCompactList}\small\item\em Diagnostic I\+Ds. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a60da5de0469d0d3353d8773eb6a47501}\label{structmom__kappa__shear_1_1kappa__shear__cs_a60da5de0469d0d3353d8773eb6a47501}} 
integer \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a60da5de0469d0d3353d8773eb6a47501}{id\+\_\+tke}} = -\/1
\begin{DoxyCompactList}\small\item\em Diagnostic I\+Ds. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a5066a683cd996d202d31c640e18e64c6}\label{structmom__kappa__shear_1_1kappa__shear__cs_a5066a683cd996d202d31c640e18e64c6}} 
integer \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a5066a683cd996d202d31c640e18e64c6}{id\+\_\+ild2}} = -\/1
\begin{DoxyCompactList}\small\item\em Diagnostic I\+Ds. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__kappa__shear_1_1kappa__shear__cs_a7b2ef906ba3b419cb511b1063bec8d88}\label{structmom__kappa__shear_1_1kappa__shear__cs_a7b2ef906ba3b419cb511b1063bec8d88}} 
integer \mbox{\hyperlink{structmom__kappa__shear_1_1kappa__shear__cs_a7b2ef906ba3b419cb511b1063bec8d88}{id\+\_\+dz\+\_\+int}} = -\/1
\begin{DoxyCompactList}\small\item\em Diagnostic I\+Ds. \end{DoxyCompactList}\end{DoxyCompactItemize}



\doxysubsection{Detailed Description}
This control structure holds the parameters that regulate shear mixing. 

Definition at line 32 of file M\+O\+M\+\_\+kappa\+\_\+shear.\+F90.



The documentation for this type was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
/home/cermak/src/\+M\+O\+M6.\+devrob/src/parameterizations/vertical/M\+O\+M\+\_\+kappa\+\_\+shear.\+F90\end{DoxyCompactItemize}
