How-to guides

Task-focused recipes. Read any of these independently — each solves one specific problem. They assume you’ve worked through at least the first tutorial. All examples run against the damBreak case shipped at examples/damBreak/; pyOFTools.clone_example() copies it to a tmp directory, then each script runs Allrun to generate the mesh and initialise the alpha field before driving the workflow.

Prerequisites:

  • OpenFOAM v2406+ sourced.

  • blockMesh and pyoftools on PATH (the latter is the pyOFTools CLI, installed with the package).

  • pybFoam and pyOFTools installed.

Measure the interface area of a VOF free surface

Measure the interface area of a VOF free surface

Extract solver residuals to a CSV

Extract solver residuals to a CSV

Compute a volume integral

Compute a volume integral

Compute a surface integral over a patch

Compute a surface integral over a patch

Sample a field along a line

Sample a field along a line

Sample a field on a cutting plane

Sample a field on a cutting plane

Write a custom aggregator node

Write a custom aggregator node

Gallery generated by Sphinx-Gallery