Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
pybFoam 0.4.4 documentation
pybFoam 0.4.4 documentation

Tutorials

  • Read, modify, and write OpenFOAM dictionaries
  • Build and operate on a scalarField
  • Modify initial conditions of the cavity case
  • Run the cavity case and post-process its time directories

How-to guides

  • Run blockMesh and checkMesh from Python
  • Extract typed field entries from a dictionary
  • Compute finite-volume operators from Python
  • Modify a boundary condition value
  • Sample a field along a line
  • Sample a field on a plane
  • Sample a field on an isosurface
  • Build an incompressible turbulence model
  • Run pybFoam in parallel

Reference

  • API Reference
    • pybFoam
    • pybFoam.fvc
    • pybFoam.fvm
    • pybFoam.meshing
    • pybFoam.thermo
    • pybFoam.turbulence
    • pybFoam.runTimeTables
    • pybFoam.sampling
  • Installation
  • Build system
  • CLI tasks and pytest options
  • Supported versions

Explanation

  • Code organization
  • NumPy integration

Project

  • Contributing
  • Changelog
Back to top
View this page

API ReferenceΒΆ

Note

For the full machine-generated type signatures, see the shipped .pyi type stubs under src/pybFoam/ (e.g. src/pybFoam/__init__.pyi, pybFoam_core.pyi, sampling_bindings.pyi). Regenerate with ./scripts/generate_stubs.sh after a development install.

Modules

  • pybFoam
  • pybFoam.fvc
  • pybFoam.fvm
  • pybFoam.meshing
  • pybFoam.thermo
  • pybFoam.turbulence
  • pybFoam.runTimeTables
  • pybFoam.sampling
Next
pybFoam
Previous
Run pybFoam in parallel
Copyright © 2025, Henning Scheufler
Made with Sphinx and @pradyunsg's Furo