.. LBM Backend documentation master file, created by
   sphinx-quickstart on Sat Oct 31 21:17:44 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.
   Modified by Alan Lugarini on Jun 30.

Nassu docs
==========

**Nassu is a CFD (computational fluid-dynamics) solver.** 
It uses **LBM (lattice Boltzmann-method)** to run the simulation and its main philosophy is **you don't have to write a single line of code to run your simulation**.

.. tip::
   If you aren't familiarized with CFD or LBM we recommend :footcite:t:`Kruger2016-cv` as introduction.

^^^^^^^^^^^^^^^^
Related projects
^^^^^^^^^^^^^^^^

Some related projects to Nassu are

* `STL2LNAS <https://github.com/AeroSim-CFD/stl2lnas>`_: Converts STL files to LNAS (Lagrangian Nassu) format, file interpreted by Nassu solver

.. footbibliography::

.. toctree::
   :maxdepth: 1
   :caption: Theory
   :hidden:

   Introduction <theory/index.md>
   LBM <theory/LBM/index.rst>
   Boundary conditions <theory/BC/index.rst>
   IBM <theory/IBM/index.rst>
   LES <theory/LES/index.rst>
   Wall model <theory/wall_model/index.rst>
   Multiblock <theory/multiblock/index.rst>
   Turbulent flow <theory/turbulent_flow.rst>
   Surface coefficients <theory/coefficients.rst>
   Precursor simulation <theory/precursor.rst>

.. toctree::
   :maxdepth: 1
   :caption: Solver
   :hidden:

   Meshing<mesh/index.md>
   Modeling <modeling/index.rst>
   Validation Cases<validation/index.rst>
   Performance <performance/index.rst>
   Code <code/index.md>

.. toctree::
   :maxdepth: 1
   :caption: User Guide
   :hidden:

   Introduction<user_guide/intro.md>
   Technologies Used<user_guide/technologies.md>
   Installation and usage<user_guide/01_installation/index.md>
   Configuring simulations<user_guide/02_config/index.md>
   Post processing<user_guide/03_proc/index.md>
   Modeling cases<user_guide/04_modeling/index.md>
   Examples<user_guide/05_examples/index.md>

.. toctree::
   :maxdepth: 1
   :caption: Others
   :hidden:

   Release Notes <release_notes/index.md>
   License <license.rst>

.. Indices and tables
.. ==================

.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`