%% $Id$
%% This file was automatically generated by Pencil::DocExtractor,
%% so think twice before you modify it.
%%
%% Source files:
%%   cdata.f90
%%   hydro.f90
%%   density.f90
%%   entropy.f90
%%   magnetic.f90
%%   anelastic.f90
%%   entropy_anelastic.f90
%%   hydro_marked.f90
%%   hydro_potential.f90
%%   magnetic_shearboxJ.f90
%%   viscosity.f90

% ---------------------------------------------------------------- %
\begin{longtable}{lp{0.7\textwidth}}
\toprule
  \multicolumn{1}{c}{\emph{Variable}} & {\emph{Meaning}} \\
\midrule
  \multicolumn{2}{c}{Module \file{cdata.f90}} \\
\midrule
  \var{rcylmphi}  & cylindrical radius
                    $\varpi = \sqrt{x^2+y^2}$
                    (useful for debugging
                    azimuthal averages) \\
  \var{phimphi}   & azimuthal angle
                    $\varphi = \arctan\frac{y}{x}$
                    (useful for debugging) \\
  \var{zmphi}     & $z$-coordinate
                    (useful for debugging) \\
  \var{rmphi}     & spherical radius
                    $r=\sqrt{\varpi^2+z^2}$
                    (useful for debugging) \\
\midrule
  \multicolumn{2}{c}{Module \file{hydro.f90}} \\
\midrule
  \var{urmphi}    & $\left<u_\varpi\right>_\varphi$
                    [cyl.\ polar coords
                    $(\varpi,\varphi,z)$] \\
  \var{upmphi}    & $\left<u_\varphi\right>_\varphi$ \\
  \var{uzmphi}    & $\left<u_z\right>_\varphi$ \\
  \var{rurmphi}   & $\left<\rho u_\varpi\right>_\varphi$ \\
  \var{rupmphi}   & $\left<\rho u_\varphi\right>_\varphi$ \\
  \var{ruzmphi}   & $\left<\rho u_z\right>_\varphi$ \\
  \var{ur2mphi}   & $\left<u_\varpi^2\right>_\varphi$ \\
  \var{up2mphi}   & $\left<u_\varphi^2\right>_\varphi$ \\
  \var{uz2mphi}   & $\left<u_z^2\right>_\varphi$ \\
  \var{urupmphi}  & $\left<u_\varpi u_\varphi\right>_\varphi$ \\
  \var{uruzmphi}  & $\left<u_\varpi u_z \right>_\varphi$ \\
  \var{upuzmphi}  & $\left<u_\varphi u_z \right>_\varphi$ \\
  \var{rurupmphi} & $\left<\rho u_\varpi u_\varphi\right>_\varphi$ \\
  \var{ruruzmphi} & $\left<\rho u_\varpi u_z \right>_\varphi$ \\
  \var{rupuzmphi} & $\left<\rho u_\varphi u_z \right>_\varphi$ \\
  \var{ursphmphi} & $\left<u_r\right>_\varphi$ \\
  \var{uthmphi}   & $\left<u_\vartheta\right>_\varphi$ \\
  \var{rursphmphi} & $\left<\rho u_r\right>_\varphi$ \\
  \var{ruthmphi}  & $\left<\rho u_\vartheta\right>_\varphi$ \\
  \var{uumphi}    & shorthand for \var{urmphi},
                    \var{upmphi} and \var{uzmphi}
                    together \\
  \var{uusphmphi} & shorthand for \var{ursphmphi},
                    \var{uthmphi} and \var{upmphi}
                    together \\
  \var{u2mphi}    & $\left<\uv^2\right>_\varphi$ \\
  \var{fkinrsphmphi} & $\left<{1\over2}\varrho\uv^2
                    u_r\right>_{\varphi}$ \\
\midrule
  \multicolumn{2}{c}{Module \file{density.f90}} \\
\midrule
  \var{lnrhomphi} & $\left<\ln\varrho\right>_\varphi$ \\
  \var{rhomphi}   & $\left<\varrho\right>_\varphi$ \\
\midrule
  \multicolumn{2}{c}{Module \file{entropy.f90}} \\
\midrule
  \var{ssmphi}    & $\left<s\right>_\varphi$ \\
  \var{ss2mphi}   & $\left<s^2\right>_\varphi$ \\
  \var{cs2mphi}   & $\left<c^2_s\right>_\varphi$ \\
  \var{TTmphi}    & $\left<T\right>_\varphi$ \\
  \var{ppmphi}    & $\left<p\right>_\varphi$ \\
  \var{dcoolmphi} & divergence of combined heating and cooling fluxes \\
  \var{divcoolmphi} & divergence of cooling flux \\
  \var{divheatmphi} & divergence of heating flux \\
  \var{fradrsphmphi_kramers} & $F_{\rm rad}$ ($\varphi$-averaged,
                    from Kramers' opacity) \\
  \var{fradrsphmphi_Kconst} & $F_{\rm rad}$ ($\varphi$-averaged,
                    for K-const) \\
  \var{fconvrsphmphi} & $\left<c_p \varrho u_r T \right>_\varphi$ \\
  \var{fconvthsphmphi} & $\left<c_p \varrho u_\theta T \right>_\varphi$ \\
  \var{fconvpsphmphi} & $\left<c_p \varrho u_\phi T \right>_\varphi$ \\
  \var{ursphTTmphi} & $\left<u_r T \right>_\varphi$ \\
  \var{fturbrsphmphi} & $F_{\rm SGS}$ ($\varphi$-averaged SGS diffusion
                    for star-in-a-box simulations) \\
\midrule
  \multicolumn{2}{c}{Module \file{magnetic.f90}} \\
\midrule
  \var{jbmphi}    & $\left<\Jv\cdot\Bv\right>_\varphi$ \\
  \var{brmphi}    & $\left<B_\varpi\right>_\varphi$
                    [cyl.\ polar coords
                    $(\varpi,\varphi,z)$] \\
  \var{bpmphi}    & $\left<B_\varphi\right>_\varphi$ \\
  \var{bzmphi}    & $\left<B_z\right>_\varphi$ \\
  \var{br2mphi}   & $\left<B^2_\varpi\right>_\varphi$ \\
  \var{bp2mphi}   & $\left<B^2_\varphi\right>_\varphi$ \\
  \var{bz2mphi}   & $\left<B^2_z\right>_\varphi$ \\
  \var{bbmphi}    & shorthand for \var{brmphi},
                    \var{bpmphi} and \var{bzmphi}
                    together \\
  \var{bbsphmphi} & shorthand for \var{brsphmphi},
                    \var{bthmphi} and \var{bpmphi}
                    together \\
  \var{b2mphi}    & $\left<\Bv^2\right>_\varphi$ \\
  \var{brsphmphi} & $\left<B_r\right>_\varphi$ \\
  \var{bthmphi}   & $\left<B_\vartheta\right>_\varphi$ \\
  \var{brbpmphi}  & $\left<B_\varpi B_\varphi\right>_\varphi$ \\
  \var{brbzmphi}  & $\left<B_\varpi B_z \right>_\varphi$ \\
  \var{bpbzmphi}  & $\left<B_\varphi B_z \right>_\varphi$ \\
\midrule
  \multicolumn{2}{c}{Module \file{anelastic.f90}} \\
\midrule
  \var{lnrhomphi} & $\left<\ln\varrho\right>_\varphi$ \\
  \var{rhomphi}   & $\left<\varrho\right>_\varphi$ \\
\midrule
  \multicolumn{2}{c}{Module \file{entropy_anelastic.f90}} \\
\midrule
  \var{ssmphi}    & $\left<s\right>_\varphi$ \\
  \var{cs2mphi}   & $\left<c^2_s\right>_\varphi$ \\
\midrule
  \multicolumn{2}{c}{Module \file{hydro_marked.f90}} \\
\midrule
  \var{urmphi}    & $\left<u_\varpi\right>_\varphi$
                    [cyl.\ polar coords
                    $(\varpi,\varphi,z)$] \\
  \var{upmphi}    & $\left<u_\varphi\right>_\varphi$ \\
  \var{uzmphi}    & $\left<u_z\right>_\varphi$ \\
  \var{rurmphi}   & $\left<\rho u_\varpi\right>_\varphi$ \\
  \var{rupmphi}   & $\left<\rho u_\varphi\right>_\varphi$ \\
  \var{ruzmphi}   & $\left<\rho u_z\right>_\varphi$ \\
  \var{ur2mphi}   & $\left<u_\varpi^2\right>_\varphi$ \\
  \var{up2mphi}   & $\left<u_\varphi^2\right>_\varphi$ \\
  \var{uz2mphi}   & $\left<u_z^2\right>_\varphi$ \\
  \var{urupmphi}  & $\left<u_\varpi u_\varphi\right>_\varphi$ \\
  \var{uruzmphi}  & $\left<u_\varpi u_z \right>_\varphi$ \\
  \var{upuzmphi}  & $\left<u_\varphi u_z \right>_\varphi$ \\
  \var{rurupmphi} & $\left<\rho u_\varpi u_\varphi\right>_\varphi$ \\
  \var{ruruzmphi} & $\left<\rho u_\varpi u_z \right>_\varphi$ \\
  \var{rupuzmphi} & $\left<\rho u_\varphi u_z \right>_\varphi$ \\
  \var{ursphmphi} & $\left<u_r\right>_\varphi$ \\
  \var{uthmphi}   & $\left<u_\vartheta\right>_\varphi$ \\
  \var{rursphmphi} & $\left<\rho u_r\right>_\varphi$ \\
  \var{ruthmphi}  & $\left<\rho u_\vartheta\right>_\varphi$ \\
  \var{uumphi}    & shorthand for \var{urmphi},
                    \var{upmphi} and \var{uzmphi}
                    together \\
  \var{uusphmphi} & shorthand for \var{ursphmphi},
                    \var{uthmphi} and \var{upmphi}
                    together \\
  \var{u2mphi}    & $\left<\uv^2\right>_\varphi$ \\
  \var{fkinrsphmphi} & $\left<{1\over2}\varrho\uv^2
                    u_r\right>_{\varphi}$ \\
\midrule
  \multicolumn{2}{c}{Module \file{hydro_potential.f90}} \\
\midrule
  \var{urmphi}    & $\left<u_\varpi\right>_\varphi$
                    [cyl.\ polar coords
                    $(\varpi,\varphi,z)$] \\
  \var{upmphi}    & $\left<u_\varphi\right>_\varphi$ \\
  \var{uzmphi}    & $\left<u_z\right>_\varphi$ \\
  \var{ursphmphi} & $\left<u_r\right>_\varphi$ \\
  \var{uthmphi}   & $\left<u_\vartheta\right>_\varphi$ \\
  \var{uumphi}    & shorthand for \var{urmphi},
                    \var{upmphi} and \var{uzmphi}
                    together \\
  \var{uusphmphi} & shorthand for \var{ursphmphi},
                    \var{uthmphi} and \var{upmphi}
                    together \\
  \var{u2mphi}    & $\left<\uv^2\right>_\varphi$ \\
\midrule
  \multicolumn{2}{c}{Module \file{magnetic_shearboxJ.f90}} \\
\midrule
  \var{jbmphi}    & $\left<\Jv\cdot\Bv\right>_\varphi$ \\
  \var{brmphi}    & $\left<B_\varpi\right>_\varphi$
                    [cyl.\ polar coords
                    $(\varpi,\varphi,z)$] \\
  \var{bpmphi}    & $\left<B_\varphi\right>_\varphi$ \\
  \var{bzmphi}    & $\left<B_z\right>_\varphi$ \\
  \var{bbmphi}    & shorthand for \var{brmphi},
                    \var{bpmphi} and \var{bzmphi}
                    together \\
  \var{bbsphmphi} & shorthand for \var{brsphmphi},
                    \var{bthmphi} and \var{bpmphi}
                    together \\
  \var{b2mphi}    & $\left<\Bv^2\right>_\varphi$ \\
  \var{brsphmphi} & $\left<B_r\right>_\varphi$ \\
  \var{bthmphi}   & $\left<B_\vartheta\right>_\varphi$ \\
\midrule
  \multicolumn{2}{c}{Module \file{viscosity.f90}} \\
\midrule
  \var{fviscrsphmphi} & $\left<2\nu\varrho u_i
                    \mathcal{S}_{ir} \right>_\varphi$
                    ($r$-xomponent of viscous flux) \\
%
\bottomrule
\end{longtable}

