Commit a252b5e3 authored by Cristian Lalescu's avatar Cristian Lalescu
Browse files

fixes latexpdf documentation

Latex wasn't working because the README contains a link to an image that
cannot be converted. So I asked that the image only appears in html.
There were also some strange problems with the markdown math syntax, so
I switched to full LaTeX which seems to be working.
parent a17d41a5
.. image:: https://gitlab.mpcdf.mpg.de/mjr/bfps/badges/develop/build.svg
:target: https://gitlab.mpcdf.mpg.de/mjr/bfps/commits/develop
.. only:: html
.. image:: https://gitlab.mpcdf.mpg.de/mjr/bfps/badges/develop/build.svg
:target: https://gitlab.mpcdf.mpg.de/mjr/bfps/commits/develop
=========================================
Turbulence Tools: Lagrangian and Eulerian
......
......@@ -352,25 +352,33 @@ void kspace<be, dt>::Gauss_filter(
* a Gaussian filter and a sharp real space spherical filter.
*
* Filter expressions in real space are as follows:
* \f{eqnarray*}{
* \phi^b_\ell(r) &=&
* \frac{1}{\ell^3}\frac{6}{\pi} H(\ell/2 - r) \\
* \phi^g_\ell(r) &=&
* \f[
* \phi^b_\ell(r) =
* \frac{1}{\ell^3}\frac{6}{\pi} H(\ell/2 - r)
* \f]
* \f[
* \phi^g_\ell(r) =
* \frac{1}{\sigma_\ell^3}\frac{1}{(2\pi)^{3/2}}
* \exp\left(-\frac{1}{2}\left(\frac{r}{\sigma_\ell}\right)^2\right) \\
* \phi^s_\ell(r) &=&
* \exp\left(-\frac{1}{2}\left(\frac{r}{\sigma_\ell}\right)^2\right)
* \f]
* \f[
* \phi^s_\ell(r) =
* \frac{1}{2 \pi^2 r^3}
* \left(\sin k_\ell r - k_\ell r \cos k_\ell r\right)
* \f}
* \f]
* and the corresponding expressions in Fourier space are:
* \f{eqnarray*}{
* \hat{\phi^b_\ell}(k) &=&
* \f[
* \hat{\phi^b_\ell}(k) =
* \frac{3}{2(k\ell/2)^3}
* \left(2\sin (k \ell/2) - k \ell \cos (k \ell/2)\right) \\
* \hat{\phi^g_\ell}(k) &=&
* \exp\left(-\frac{1}{2}k^2 \sigma_\ell^2\right) \\
* \hat{\phi^s_\ell}(k) &=& H(k_\ell - k)
* \f}
* \left(2\sin (k \ell/2) - k \ell \cos (k \ell/2)\right)
* \f]
* \f[
* \hat{\phi^g_\ell}(k) =
* \exp\left(-\frac{1}{2}k^2 \sigma_\ell^2\right)
* \f]
* \f[
* \hat{\phi^s_\ell}(k) = H(k_\ell - k)
* \f]
*
* \f$ k_\ell \f$ is given as a parameter, and then we use
* \f[
......@@ -425,7 +433,7 @@ int kspace<be, dt>::filter(
* a Gaussian filter and a sharp real space spherical filter.
*
* Filter expressions in real space are as follows:
* \f{eqnarray*}{
* \begin{eqnarray*}
* \phi^b_\ell(r) &=&
* \frac{1}{\ell^3}\frac{6}{\pi} H(\ell/2 - r) \\
* \phi^g_\ell(r) &=&
......@@ -434,16 +442,16 @@ int kspace<be, dt>::filter(
* \phi^s_\ell(r) &=&
* \frac{1}{2 \pi^2 r^3}
* \left(\sin k_\ell r - k_\ell r \cos k_\ell r\right)
* \f}
* \end{eqnarray*}
* and the corresponding expressions in Fourier space are:
* \f{eqnarray*}{
* \begin{eqnarray*}
* \hat{\phi^b_\ell}(k) &=&
* \frac{3}{2(k\ell/2)^3}
* \left(2\sin (k \ell/2) - k \ell \cos (k \ell/2)\right) \\
* \hat{\phi^g_\ell}(k) &=&
* \exp\left(-\frac{1}{2}k^2 \sigma_\ell^2\right) \\
* \hat{\phi^s_\ell}(k) &=& H(k_\ell - k)
* \f}
* \end{eqnarray*}
*
* \f$\sigma_\ell\f$ and \f$k_\ell\f$ are calibrated such that the energy of
* the large scales is approximately the same (within the inertial range)
......
......@@ -225,7 +225,7 @@ latex_elements = {
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
'preamble': '\usepackage{amssymb,amsmath,amsfonts}',
# Latex figure (float) alignment
#'figure_align': 'htbp',
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment