:orphan:

.. _examples-index:

Gallery of Examples
===================

First examples
--------------
This gallery consists of introductory examples to read and plot OpenFoam output files with Python.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example doesn&#x27;t do much, it just reads and makes a simple plot of OpenFoam field">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_0_field_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_plot_0_field.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">First example</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example doesn&#x27;t do much, it just reads and makes a simple plot of OpenFoam field in case of files without header (as for example the output of sampling library)">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_4_sampledfield_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_plot_4_sampledfield.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">output field of files without header (sampling)</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example reads and plots a series of postProcessing force">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_2_postprocforce_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_plot_2_postprocforce.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Time series of postProcessing force</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example doesn&#x27;t do much, it reads and makes a spatial average of OpenFoam fields">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_calc_0_avgfield_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_calc_0_avgfield.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Postprocessing example : Spatial average</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example reads and plots a series of postProcessing probe">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_3_postprocprobe_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_plot_3_postprocprobe.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Time series of postProcessing probe</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example reads and plots a time series of an OpenFoam scalar field">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_1_timeseries_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_plot_1_timeseries.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Time series of OpenFoam scalar field</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example reads and plots one postProcessing coefficient force and compute and plot the fft of the lift coefficient force">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_5_postprocforcefft_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_plot_5_postprocforcefft.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Time series of postProcessing coefficient force</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_0_field
   /auto_examples/plot_4_sampledfield
   /auto_examples/plot_2_postprocforce
   /auto_examples/calc_0_avgfield
   /auto_examples/plot_3_postprocprobe
   /auto_examples/plot_1_timeseries
   /auto_examples/plot_5_postprocforcefft


Examples for structured mesh
----------------------------
This gallery consists of examples for structured mesh.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example reads and plots a spatially averaged profile of the first component of an OpenFoam vector field from a structured mesh">

.. only:: html

  .. image:: /auto_examples/structured/images/thumb/sphx_glr_plot_0_averagedfield_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_structured_plot_0_averagedfield.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Spatially averaged profile</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example reads and plots a contour of the first component of an OpenFoam vector field from a structured mesh">

.. only:: html

  .. image:: /auto_examples/structured/images/thumb/sphx_glr_plot_1_contour_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_structured_plot_1_contour.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Contour from a slice in domain</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example reads and plots the first component of an OpenFoam vector field from a boundary (patch) of a structured mesh">

.. only:: html

  .. image:: /auto_examples/structured/images/thumb/sphx_glr_plot_2_boundary_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_structured_plot_2_boundary.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Contour and scatter from a boundary/patch</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


Examples for unstructured mesh
------------------------------
This gallery consists of examples for unstructured mesh.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example reads and plots a contour of an OpenFoam vector field from an unstructured mesh by triangulation WITHOUT interpolation on a structured grid">

.. only:: html

  .. image:: /auto_examples/unstructured/images/thumb/sphx_glr_plot_tricontourf_unstructured_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_unstructured_plot_tricontourf_unstructured.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Contour from an unstructured mesh (no interpolation)</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example reads and plots a contour of an OpenFoam vector field from an unstructured mesh by interpolation on a structured grid">

.. only:: html

  .. image:: /auto_examples/unstructured/images/thumb/sphx_glr_plot_contour_unstructured_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_unstructured_plot_contour_unstructured.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Contour and streamlines from an unstructured mesh</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to extract the cell volumes inside a given box">

.. only:: html

  .. image:: /auto_examples/unstructured/images/thumb/sphx_glr_plot_GetCellVolume_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_unstructured_plot_GetCellVolume.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Get the cell centroids and cell volumes of a given box</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use MeshVisu object to plot vectorised images of 2D planar meshes.">

.. only:: html

  .. image:: /auto_examples/unstructured/images/thumb/sphx_glr_plot_2D_mesh_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_unstructured_plot_2D_mesh.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Create vectorised visualisations of the mesh</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


Advanced examples
-----------------
This gallery consists of advanced examples.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to create a boundary data for turbulentDFSEM  inlet boundary condition. In addition, the script also plots the  profiles for verification. ">

.. only:: html

  .. image:: /auto_examples/advanced/images/thumb/sphx_glr_plot_generatedDFSEMdata_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_advanced_plot_generatedDFSEMdata.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Create and plot boundaryData for DFSEM from a 1D RANS simulation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to organize the results of a simulation into an OpenFoamSimu object that contains all the results of one simulation.">

.. only:: html

  .. image:: /auto_examples/advanced/images/thumb/sphx_glr_plot_using_openfoamsimu_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_advanced_plot_using_openfoamsimu.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">OpenFoamSimu to post-process simulation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to create a pointer list of profiles from an unstructured mesh and to extract the bed interface elevation. The results are plotted as a scatter plot.">

.. only:: html

  .. image:: /auto_examples/advanced/images/thumb/sphx_glr_plot_unstructured_simu_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_advanced_plot_unstructured_simu.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plot bed interface from unstructured mesh</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /auto_examples/structured/index.rst
   /auto_examples/unstructured/index.rst
   /auto_examples/advanced/index.rst


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: auto_examples_python.zip </auto_examples/auto_examples_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: auto_examples_jupyter.zip </auto_examples/auto_examples_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_