.. Hydroflow documentation file, created by
   Pierre-Yves Gousenbourger on Wed Aug 2, 2023.
   modified by Nathan Delpierre on Wen Jan 17 2024

.. _mesh-module:

The Mesh class
====================

What it does
------------

The HydroflowMesh class is the mother of all Mesh classes. Other mesh classes build on this one.

We can distinguish two purposes for the mesh class:

- First: it can be used to interact with the selected mesh file. Basic informations can be retrieved concerning the mesh from the different properties of the class. Concerning these properties, there is no possibility to modify the values, which can be considered as a blackbox. 
- Secondly: the HydroflowMesh class is used  by the constructor of the HydroflowModel class to initialize the geometry of the physical problem. 

Documentation
-------------

.. autoclass:: watlab.watlab.Mesh
     :members:
     :undoc-members: