API Reference
=============

.. note::

   Auto-generated API documentation requires pybFoam and OpenFOAM to be installed.
   If sections below are empty, build the docs in an environment with OpenFOAM sourced.

postprocessor
-------------

.. automodule:: pyOFTools.postprocessor
   :members:
   :undoc-members:

builders
--------

.. automodule:: pyOFTools.builders
   :members:
   :undoc-members:

aggregators
-----------

.. automodule:: pyOFTools.aggregators
   :members:
   :undoc-members:

binning
-------

.. automodule:: pyOFTools.binning
   :members:
   :undoc-members:

spatial_selectors
-----------------

.. automodule:: pyOFTools.spatial_selectors
   :members:
   :undoc-members:

workflow
--------

.. automodule:: pyOFTools.workflow
   :members:
   :undoc-members:

node
----

.. automodule:: pyOFTools.node
   :members:
   :undoc-members:

datasets
--------

.. automodule:: pyOFTools.datasets
   :members:
   :undoc-members:

surfaces
--------

.. automodule:: pyOFTools.surfaces
   :members:
   :undoc-members:

sets
----

.. automodule:: pyOFTools.sets
   :members:
   :undoc-members:

interpolation
-------------

.. automodule:: pyOFTools.interpolation
   :members:
   :undoc-members:

set_interpolation
-----------------

.. automodule:: pyOFTools.set_interpolation
   :members:
   :undoc-members:

geometry
--------

.. automodule:: pyOFTools.geometry
   :members:
   :undoc-members:

residuals
---------

.. automodule:: pyOFTools.residuals
   :members:
   :undoc-members:

tables
------

.. automodule:: pyOFTools.tables
   :members:
   :undoc-members:

.. automodule:: pyOFTools.tables.table
   :members:
   :undoc-members:

.. automodule:: pyOFTools.tables.csvWriter
   :members:
   :undoc-members: