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

add some cpp classes to documentation

parent 7e50c539
......@@ -286,8 +286,8 @@ void kspace<be, dt>::ball_filter(
* Filter's Fourier space expression:
* \f[
* \hat{\phi^M_\ell}(k) =
* \exp(-\frac{(3.54 k \ell)^(122*(\ell)^(0.0836))}{2})
* \left( 1 + \frac{(k \eta/0.0636)^3.44}{1 + (k \eta/ 0.0621)^3.44} \right)^{1/2}
* \exp(-\frac{(3.54 k \ell)^{122 \ell^{0.0836}}}{2})
* \left( 1 + \frac{(k \eta/0.0636)^{3.44}}{1 + (k \eta/ 0.0621)^{3.44}} \right)^{1/2}
* \f]
*/
template <field_backend be,
......
......@@ -2,6 +2,22 @@
CPP
---
.. doxygenclass:: kspace
:project: TurTLE
:members:
.. doxygenclass:: field
:project: TurTLE
:members:
.. doxygenclass:: code_base
:project: TurTLE
:members:
.. doxygenclass:: direct_numerical_simulation
:project: TurTLE
:members:
.. doxygenclass:: NSVE
:project: TurTLE
:members:
......@@ -254,14 +254,14 @@ In brief the following takes place:
NavierStokes`` command.
2. reasonable DNS parameters are constructed from the command line
arguments.
4. ``c`` generates a parameter file ``<simname>.h5``, into which the
3. ``c`` generates a parameter file ``<simname>.h5``, into which the
various parameters are written.
``c`` also generates the various datasets that the backend code
will write into (statistics and other stuff).
3. ``c`` writes a C++ file that is compiled and linked against
4. ``c`` writes a C++ file that is compiled and linked against
``libbfps``.
4. ``c`` executes the C++ code using ``mpirun``.
5. the C++ code actually performs the DNS, and outputs various
5. ``c`` executes the C++ code using ``mpirun``.
6. the C++ code actually performs the DNS, and outputs various
results into the ``<simname>.h5`` file.
After the simulation is done, things are simpler.
......
......@@ -22,7 +22,7 @@ import os
sys.path.insert(0, os.path.abspath('..'))
breathe_projects = {
'C++ library' : os.path.abspath('../build/xml/'),
'TurTLE' : os.path.abspath('../build/xml/'),
}
# -- General configuration ------------------------------------------------
......
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