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

.. _hydroflow-model-module:

The HydroflowModel class
========================

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

`HydroflowModel` builds a hydrodynamic physical model. This class controls the hydrodynamic simulation:

- set up of the appropriate initial and boundary conditions
- modification of the specific simulation properties such as CFL number, flux scheme, etc.

Whenever you use this class, it is essential to conclude your script by employing the `export_data()` function and
resolving your specified problem through the `solve()` function.

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

.. autoclass:: watlab.hydroflow.HydroflowModel
     :members:
     :undoc-members: