\hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs}{}\section{mom\+\_\+bkgnd\+\_\+mixing\+:\+:bkgnd\+\_\+mixing\+\_\+cs Type Reference}
\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs}\index{mom\+\_\+bkgnd\+\_\+mixing\+::bkgnd\+\_\+mixing\+\_\+cs@{mom\+\_\+bkgnd\+\_\+mixing\+::bkgnd\+\_\+mixing\+\_\+cs}}


\subsection{Detailed Description}
Control structure including parameters for this module. 

Definition at line 37 of file M\+O\+M\+\_\+bkgnd\+\_\+mixing.\+F90.



Collaboration diagram for mom\+\_\+bkgnd\+\_\+mixing\+:\+:bkgnd\+\_\+mixing\+\_\+cs\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs__coll__graph}
\end{center}
\end{figure}
\subsection*{Public variables and constants}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a3aaf756acab2747ec8c7a130b07ad487}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a3aaf756acab2747ec8c7a130b07ad487}} 
real \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a3aaf756acab2747ec8c7a130b07ad487}{bryan\+\_\+lewis\+\_\+c1}
\begin{DoxyCompactList}\small\item\em The vertical diffusivity values for Bryan-\/\+Lewis profile at $\vert$z$\vert$=D \mbox{[}m2 s-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a1e8bb83f9d183bed7569521c0d0e07eb}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a1e8bb83f9d183bed7569521c0d0e07eb}} 
real \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a1e8bb83f9d183bed7569521c0d0e07eb}{bryan\+\_\+lewis\+\_\+c2}
\begin{DoxyCompactList}\small\item\em The amplitude of variation in diffusivity for the Bryan-\/\+Lewis diffusivity profile \mbox{[}m2 s-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_add1a13ba613032b203296adb5e0b2742}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_add1a13ba613032b203296adb5e0b2742}} 
real \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_add1a13ba613032b203296adb5e0b2742}{bryan\+\_\+lewis\+\_\+c3}
\begin{DoxyCompactList}\small\item\em The inverse length scale for transition region in the Bryan-\/\+Lewis diffusivity profile \mbox{[}m-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_aeaa54fb78130c6216403c39580fc1771}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_aeaa54fb78130c6216403c39580fc1771}} 
real \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_aeaa54fb78130c6216403c39580fc1771}{bryan\+\_\+lewis\+\_\+c4}
\begin{DoxyCompactList}\small\item\em The depth where diffusivity is Bryan\+\_\+\+Lewis\+\_\+bl1 in the Bryan-\/\+Lewis profile \mbox{[}m\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a9c886ccfd44d9df64345cb536565cccf}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a9c886ccfd44d9df64345cb536565cccf}} 
real \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a9c886ccfd44d9df64345cb536565cccf}{bckgrnd\+\_\+vdc1}
\begin{DoxyCompactList}\small\item\em Background diffusivity (Ledwell) when horiz\+\_\+varying\+\_\+background=.true. \mbox{[}Z2 T-\/1 $\sim$$>$ m2 s-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a51adfbbfdbc48c4ced4dedcd02e7d329}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a51adfbbfdbc48c4ced4dedcd02e7d329}} 
real \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a51adfbbfdbc48c4ced4dedcd02e7d329}{bckgrnd\+\_\+vdc\+\_\+eq}
\begin{DoxyCompactList}\small\item\em Equatorial diffusivity (Gregg) when horiz\+\_\+varying\+\_\+background=.true. \mbox{[}Z2 T-\/1 $\sim$$>$ m2 s-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a01e002dda2a6292d8cc2a9dd341bd34c}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a01e002dda2a6292d8cc2a9dd341bd34c}} 
real \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a01e002dda2a6292d8cc2a9dd341bd34c}{bckgrnd\+\_\+vdc\+\_\+psim}
\begin{DoxyCompactList}\small\item\em Max. P\+SI induced diffusivity (Mac\+Kinnon) when horiz\+\_\+varying\+\_\+background=.true. \mbox{[}Z2 T-\/1 $\sim$$>$ m2 s-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a52cdcf60a7a64969ade76ce16b29b687}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a52cdcf60a7a64969ade76ce16b29b687}} 
real \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a52cdcf60a7a64969ade76ce16b29b687}{bckgrnd\+\_\+vdc\+\_\+banda}
\begin{DoxyCompactList}\small\item\em Banda Sea diffusivity (Gordon) when horiz\+\_\+varying\+\_\+background=.true. \mbox{[}Z2 T-\/1 $\sim$$>$ m2 s-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a64f0060d1be1eb8b018729c3611fa5a7}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a64f0060d1be1eb8b018729c3611fa5a7}} 
real \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a64f0060d1be1eb8b018729c3611fa5a7}{kd\+\_\+min}
\begin{DoxyCompactList}\small\item\em minimum diapycnal diffusivity \mbox{[}Z2 T-\/1 $\sim$$>$ m2 s-\/1\mbox{]} \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a2d5de2b41d9cd985caa9558caceb5770}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a2d5de2b41d9cd985caa9558caceb5770}} 
real \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a2d5de2b41d9cd985caa9558caceb5770}{kd}
\begin{DoxyCompactList}\small\item\em interior diapycnal diffusivity \mbox{[}Z2 T-\/1 $\sim$$>$ m2 s-\/1\mbox{]} \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a7d8e742ba2e49ff8433950e09cc6161d}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a7d8e742ba2e49ff8433950e09cc6161d}} 
real \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a7d8e742ba2e49ff8433950e09cc6161d}{omega}
\begin{DoxyCompactList}\small\item\em The Earth\textquotesingle{}s rotation rate \mbox{[}T-\/1 $\sim$$>$ s-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a51bc5a6d31ec5ae2cac496e24df675eb}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a51bc5a6d31ec5ae2cac496e24df675eb}} 
real \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a51bc5a6d31ec5ae2cac496e24df675eb}{n0\+\_\+2omega}
\begin{DoxyCompactList}\small\item\em ratio of the typical Buoyancy frequency to twice the Earth\textquotesingle{}s rotation period, used with the Henyey scaling from the mixing \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_ab0a66ba4bf7a6b3172e2bbe5d46b2c19}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_ab0a66ba4bf7a6b3172e2bbe5d46b2c19}} 
real \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_ab0a66ba4bf7a6b3172e2bbe5d46b2c19}{prandtl\+\_\+bkgnd}
\begin{DoxyCompactList}\small\item\em Turbulent Prandtl number used to convert vertical background diffusivity into viscosity. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_acd5409e247af2aacc00dc9e1f8246c8b}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_acd5409e247af2aacc00dc9e1f8246c8b}} 
real \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_acd5409e247af2aacc00dc9e1f8246c8b}{kd\+\_\+tanh\+\_\+lat\+\_\+scale}
\begin{DoxyCompactList}\small\item\em A nondimensional scaling for the range of diffusivities with Kd\+\_\+tanh\+\_\+lat\+\_\+fn. Valid values are in the range of -\/2 to 2; 0.\+4 reproduces C\+M2M. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_af3e76df1c8ae29abaf58681b1d61ac31}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_af3e76df1c8ae29abaf58681b1d61ac31}} 
real \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_af3e76df1c8ae29abaf58681b1d61ac31}{kdml}
\begin{DoxyCompactList}\small\item\em mixed layer diapycnal diffusivity \mbox{[}Z2 T-\/1 $\sim$$>$ m2 s-\/1\mbox{]} when bulkmixedlayer==.false. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a7ee7c3feb11492feab87a8654183a072}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a7ee7c3feb11492feab87a8654183a072}} 
real \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a7ee7c3feb11492feab87a8654183a072}{hmix}
\begin{DoxyCompactList}\small\item\em mixed layer thickness \mbox{[}Z $\sim$$>$ m\mbox{]} when bulkmixedlayer==.false. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a9509e0fa629d7670dfecc29ed61f66c7}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a9509e0fa629d7670dfecc29ed61f66c7}} 
logical \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a9509e0fa629d7670dfecc29ed61f66c7}{kd\+\_\+tanh\+\_\+lat\+\_\+fn}
\begin{DoxyCompactList}\small\item\em If true, use the tanh dependence of Kd\+\_\+sfc on latitude, like G\+F\+DL C\+M2.\+1/\+C\+M2M. There is no physical justification for this form, and it can not be used with Henyey\+\_\+\+I\+G\+W\+\_\+background. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a15f393cf36db0a4c001bb448abd39c86}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a15f393cf36db0a4c001bb448abd39c86}} 
logical \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a15f393cf36db0a4c001bb448abd39c86}{bryan\+\_\+lewis\+\_\+diffusivity}
\begin{DoxyCompactList}\small\item\em If true, background vertical diffusivity uses Bryan-\/\+Lewis (1979) like tanh profile. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a112f83534d1311c55a6a223f565e04dd}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a112f83534d1311c55a6a223f565e04dd}} 
logical \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a112f83534d1311c55a6a223f565e04dd}{horiz\+\_\+varying\+\_\+background}
\begin{DoxyCompactList}\small\item\em If true, apply vertically uniform, latitude-\/dependent background diffusivity, as described in Danabasoglu et al., 2012. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_ab8a696067674b3d95f4505d304d45a72}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_ab8a696067674b3d95f4505d304d45a72}} 
logical \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_ab8a696067674b3d95f4505d304d45a72}{henyey\+\_\+igw\+\_\+background}
\begin{DoxyCompactList}\small\item\em If true, use a simplified variant of the Henyey et al, J\+GR (1986) latitudinal scaling for the background diapycnal diffusivity, which gives a marked decrease in the diffusivity near the equator. The simplification here is to assume that the in-\/situ stratification is the same as the reference stratificaiton. \end{DoxyCompactList}\item 
logical \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a0b5588eacdf8ce4addf2764c7857bd6a}{henyey\+\_\+igw\+\_\+background\+\_\+new}
\begin{DoxyCompactList}\small\item\em same as Henyey\+\_\+\+I\+G\+W\+\_\+background but incorporate the effect of stratification on T\+KE dissipation, e = f/f\+\_\+0 $\ast$ acosh(N/f) / acosh(N\+\_\+0/f\+\_\+0) $\ast$ e\+\_\+0 where e is the T\+KE dissipation, and N\+\_\+0 and f\+\_\+0 are the reference buoyancy frequency and inertial frequencies respectively. e\+\_\+0 is the reference dissipation at (N\+\_\+0,f\+\_\+0). In the previous version, N=N\+\_\+0. Additionally, the squared inverse relationship between diapycnal diffusivities and stratification is included\+: \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_addc454e7e9c8f5cf76bd3e0d9f0ff64a}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_addc454e7e9c8f5cf76bd3e0d9f0ff64a}} 
logical \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_addc454e7e9c8f5cf76bd3e0d9f0ff64a}{bulkmixedlayer}
\begin{DoxyCompactList}\small\item\em If true, a refined bulk mixed layer scheme is used. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a840f2f2b88bfd37d09bc622bd1e34c11}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a840f2f2b88bfd37d09bc622bd1e34c11}} 
logical \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a840f2f2b88bfd37d09bc622bd1e34c11}{kd\+\_\+via\+\_\+kdml\+\_\+bug}
\begin{DoxyCompactList}\small\item\em If true and K\+D\+ML /= KD and a number of other higher precedence options are not used, the background diffusivity is set incorrectly using a bug that was introduced in March, 2018. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_aa64fd0d97f7872e6bd321bc8d5db6b96}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_aa64fd0d97f7872e6bd321bc8d5db6b96}} 
logical \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_aa64fd0d97f7872e6bd321bc8d5db6b96}{debug}
\begin{DoxyCompactList}\small\item\em If true, turn on debugging in this module. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a12953b89295677c2d7ae76a1ab85f0ea}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a12953b89295677c2d7ae76a1ab85f0ea}} 
type(diag\+\_\+ctrl), pointer \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a12953b89295677c2d7ae76a1ab85f0ea}{diag} =$>$ N\+U\+LL()
\begin{DoxyCompactList}\small\item\em A structure that regulates diagnostic output. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a50d3cc749f0833cc12715f6cec3a16b9}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a50d3cc749f0833cc12715f6cec3a16b9}} 
character(len=40) \hyperlink{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a50d3cc749f0833cc12715f6cec3a16b9}{bkgnd\+\_\+scheme\+\_\+str} = \char`\"{}none\char`\"{}
\begin{DoxyCompactList}\small\item\em Background scheme identifier. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Control structure including parameters for this module. 

Definition at line 37 of file M\+O\+M\+\_\+bkgnd\+\_\+mixing.\+F90.



\subsection{Variables and constants}
\mbox{\Hypertarget{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a0b5588eacdf8ce4addf2764c7857bd6a}\label{structmom__bkgnd__mixing_1_1bkgnd__mixing__cs_a0b5588eacdf8ce4addf2764c7857bd6a}} 
\index{mom\+\_\+bkgnd\+\_\+mixing\+::bkgnd\+\_\+mixing\+\_\+cs@{mom\+\_\+bkgnd\+\_\+mixing\+::bkgnd\+\_\+mixing\+\_\+cs}!henyey\+\_\+igw\+\_\+background\+\_\+new@{henyey\+\_\+igw\+\_\+background\+\_\+new}}
\index{henyey\+\_\+igw\+\_\+background\+\_\+new@{henyey\+\_\+igw\+\_\+background\+\_\+new}!mom\+\_\+bkgnd\+\_\+mixing\+::bkgnd\+\_\+mixing\+\_\+cs@{mom\+\_\+bkgnd\+\_\+mixing\+::bkgnd\+\_\+mixing\+\_\+cs}}
\subsubsection{\texorpdfstring{henyey\+\_\+igw\+\_\+background\+\_\+new}{henyey\_igw\_background\_new}}
{\footnotesize\ttfamily logical mom\+\_\+bkgnd\+\_\+mixing\+::bkgnd\+\_\+mixing\+\_\+cs\+::henyey\+\_\+igw\+\_\+background\+\_\+new}



same as Henyey\+\_\+\+I\+G\+W\+\_\+background but incorporate the effect of stratification on T\+KE dissipation, e = f/f\+\_\+0 $\ast$ acosh(N/f) / acosh(N\+\_\+0/f\+\_\+0) $\ast$ e\+\_\+0 where e is the T\+KE dissipation, and N\+\_\+0 and f\+\_\+0 are the reference buoyancy frequency and inertial frequencies respectively. e\+\_\+0 is the reference dissipation at (N\+\_\+0,f\+\_\+0). In the previous version, N=N\+\_\+0. Additionally, the squared inverse relationship between diapycnal diffusivities and stratification is included\+: 

kd = e/\+N$^\wedge$2

where kd is the diapycnal diffusivity. This approach assumes that work done against gravity is uniformly distributed throughout the column. Whereas, kd=kd\+\_\+0$\ast$e, as in the original version, concentrates buoyancy work in regions of strong stratification. 

Definition at line 82 of file M\+O\+M\+\_\+bkgnd\+\_\+mixing.\+F90.


\begin{DoxyCode}
82   \textcolor{keywordtype}{logical} :: henyey\_igw\_background\_new\textcolor{comment}{ !< same as Henyey\_IGW\_background}
\end{DoxyCode}


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\+\_\+bkgnd\+\_\+mixing.\+F90\end{DoxyCompactItemize}
