.. Freshkiss3D documentation master file

******************************************************************************
Freshkiss3D
******************************************************************************
**FREe Surface Hydrodynamics using KInetic SchemeS in 3D**

Freshkiss3D is a software solving the 3D hydrostatic and incompressible Navier-Stokes 
equations with free surface and variable density. It uses stable and robust numerical 
methods developed by the Inria team ANGE_ to simulate a wide variety of hydrodynamic flows
like `hydrological disasters`_ such as tsunamis and floods, `hydrodynamics-biology coupled flows`_
with species convection-diffusion, Lagrangian particle tracking or `geophysical flows`_
such as thermohaline stratification.
Find more about Freshkiss3D's numerical methods in :ref:`references`.

.. figure:: _static/images/intro_bis.png
    :width: 900px
    :align: center

    Examples of simulations carried out with Freshkiss3D.

Freshkiss3D comes with a high level :ref:`api` built around a compiled core written 
in Cython_ to combine flexibility with efficiency and allow users to build and 
solve complex hydrodynamic problems. Freshkiss3D generate outputs in VTK_ format compatible
with post-processing tool like ParaView_.


Installation
================================================================================

Freshkiss3D is available for Linux distributions and Mac OS X / M1.
Visit the :ref:`Building_from_sources` section for more information on how to get
the code, install it and run it. 

Documentation
================================================================================

To get started with Freshkiss3D, read the :ref:`Building_from_sources` section
and :ref:`gallery_of_examples` section which
contains basic Python scripts and tutorials using Freshkiss3D's :ref:`api`.
For more information on the mathematical models and 
numerical methods used in Freshkiss3D see the :ref:`references` section. 

.. raw:: html

    <video style="display:block; margin: 0 auto;" controls autoplay src="_static/videos/water_drop_rain_mesh.mp4" width="600" ></video>
    <center> <i>Water drop simulation showing free-surface and mesh motion</i> </center> 

\

Table of Contents
================================================================================

.. toctree::
   :maxdepth: 2

   applications
   get_started
   models
   gallery
   ressources
   api/index

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

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

.. _ANGE: https://team.inria.fr/ange/
.. _Python: https://www.python.org/
.. _Cython: http://cython.org/
.. _VTK: https://www.vtk.org/
.. _ParaView: https://www.paraview.org/
.. _`hydrological disasters`: http://freshkiss3d.gforge.inria.fr/applications.html#i-hydrological-disasters
.. _`geophysical flows`: http://freshkiss3d.gforge.inria.fr/applications.html#iii-geophysical-flows
.. _`hydrodynamics-biology coupled flows`: http://freshkiss3d.gforge.inria.fr/applications.html#ii-hydrodynamics-biology-coupled-flows