Examples
========

This section contains practical examples demonstrating how to use ZEFIR for various
potential flow simulations.

Tutorial Examples
-----------------

The following examples are available in the ``docs/examples/`` directory:

- **uniform_flow.py** - Basic uniform flow visualization
- **source_sink.py** - Source and sink pair
- **flow_around_cylinder.py** - Classic flow around a circular cylinder
- **corner_flow.py** - Power law corner flows for various angles
- **von_karman_vortex_street.py** - Counter-rotating vortex pair

Running Examples
----------------

To run any example, simply execute the Python script:

.. code-block:: bash

   python docs/examples/flow_around_cylinder.py

All examples require ``matplotlib`` for visualization.

Example Categories
------------------

**Elementary Flows**
   - ``uniform_flow.py`` - Basic uniform flow
   - ``source_sink.py`` - Source and sink pair

**Combined Flows**
   - ``flow_around_cylinder.py`` - Uniform flow + doublet
   - ``von_karman_vortex_street.py`` - Vortex pair

**Special Flows**
   - ``corner_flow.py`` - Power law corner flows

Each example includes:
- Complete source code
- Explanation of the physics
- Visualization of the flow field
- Comments for customization

Viewing Examples
----------------

The example Python scripts can be viewed directly in the repository:

.. code-block:: bash

   # View on GitLab
   https://gitlab.com/gbegou/zefir/-/tree/main/docs/examples

Or browse the local ``docs/examples/`` directory.