:orphan:

Tutorials
=========

A single learning arc, end-to-end, through the envisaged pyOFTools workflow:
set up initial conditions, instrument the run with an in-situ post-processor,
grow the post-processor with more monitors, then run the solver live and
plot what it produced. Each tutorial builds on the previous one — work
through them in order.

All five run against the ``damBreak`` case shipped at ``examples/damBreak/``;
:func:`pyOFTools.clone_example` copies it to a tmp directory so the on-disk
baseline stays pristine.

Prerequisites
-------------

- OpenFOAM v2406+ sourced (``source $FOAM_INST_DIR/etc/bashrc``).
- pybFoam and pyOFTools installed.
- The ``libembeddingPython.so`` plug-in available — required for
  :doc:`example_05_live_run_and_plot`, optional for the rest.


.. raw:: html

  <div id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Before a solver can do anything useful, the case needs initial fields. pyOFTools ships a small CLI — pyoftools setFields — that runs a Python (or JSON) spec to populate 0/ fields, using the same Box / Sphere / &amp; / | / ~ selectors you&#x27;ll use later for post-processing. That symmetry is the point: one geometric language for both ends of the run.">

.. only:: html

  .. image:: /auto_tutorials/images/thumb/sphx_glr_example_01_setfields_thumb.png
    :alt:

  :doc:`/auto_tutorials/example_01_setfields`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Set initial conditions with pyoftools setFields</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is the shape pyOFTools is built for: a Python object that the running solver calls on every write step. You declare aggregates with PostProcessorBase + @Table, and the framework handles file lifecycle and CSV layout.">

.. only:: html

  .. image:: /auto_tutorials/images/thumb/sphx_glr_example_02_first_postprocessor_thumb.png
    :alt:

  :doc:`/auto_tutorials/example_02_first_postprocessor`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Your first in-situ post-processor</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The post-processor doesn&#x27;t care whether the reducer feeds on volume cells, a sampled plane, or an iso-surface — it routes whatever the function returns through the same write step. This tutorial adds two surface-derived @Table outputs to the class we&#x27;ve been building:">

.. only:: html

  .. image:: /auto_tutorials/images/thumb/sphx_glr_example_04_surface_monitors_thumb.png
    :alt:

  :doc:`/auto_tutorials/example_04_surface_monitors`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Surface monitors alongside volume ones</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="So far we drove execute / write by hand to keep tutorials self-contained. The whole point of pyOFTools, though, is that the running solver calls them for you. This tutorial closes the loop:">

.. only:: html

  .. image:: /auto_tutorials/images/thumb/sphx_glr_example_05_live_run_and_plot_thumb.png
    :alt:

  :doc:`/auto_tutorials/example_05_live_run_and_plot`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Run live with the solver, then plot</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="One PostProcessorBase holds as many @Table outputs as you like. Each decorated function is an independent pipeline — they share the mesh and the write schedule, nothing else.">

.. only:: html

  .. image:: /auto_tutorials/images/thumb/sphx_glr_example_03_profiles_and_selectors_thumb.png
    :alt:

  :doc:`/auto_tutorials/example_03_profiles_and_selectors`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">More monitors in the same post-processor</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_tutorials/example_01_setfields
   /auto_tutorials/example_02_first_postprocessor
   /auto_tutorials/example_04_surface_monitors
   /auto_tutorials/example_05_live_run_and_plot
   /auto_tutorials/example_03_profiles_and_selectors



.. only:: html

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

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