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

.. _model-module:

The WatlabModel class
=====================

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

The Model class is the one you really want to interact with when building your physical Model. 
The aim of this class is to control the simulation : 

- Selecting appropriate initial and boundary conditions
- Modifying general simulation properties such as name, ending time, etc.
- Selecting the amount of output file you want to produce

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.watlab.WatlabModel
     :members:
     :undoc-members: