pybFoam 0.1.4__tar.gz → 0.1.6__tar.gz

pybfoam-0.1.6/.github/workflows/pages.yaml

@@ -0,0 +1,40 @@
+name: Deploy Docs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up OpenFOAM
+        uses: gerlero/setup-openfoam@v1
+        with:
+          openfoam-version: 2412
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          uv sync --extra all
+
+      - name: Build docs
+        run: |
+          cd docs
+          uv run make html
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/_build/html
+          publish_branch: gh-pages
+          force_orphan: true

{pybfoam-0.1.4 → pybfoam-0.1.6}/.gitignore

@@ -136,3 +136,4 @@ __pycache__
 dist/
 build/
 _skbuild/
+docs/_build

pybfoam-0.1.6/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+
+## [0.1.6] 
+
+### Added
+- Initial implementation of sampling module with pybind11 bindings
+- Support for sampledSurface types (plane, patch, cutting plane, iso-surface)
+- Interpolation schemes (cell, cellPoint, cellPointFace)
+- Line sampling functionality (uniform, cloud, polyLine, circle)
+- Integration tests for surface and set sampling
+
+### Changed
+- Updated build system to use scikit-build-core
+- Improved CMake configuration for OpenFOAM library detection
+
+---
+
+## [-0.1.5]
+
+### Added
+- Python bindings for OpenFOAM core functionality
+- Field access and manipulation (volScalarField, volVectorField, volTensorField)
+- Finite volume operators (fvc, fvm)
+- Mesh access (fvMesh, polyMesh)
+- Time management
+- Dictionary I/O
+- Basic turbulence model support
+- NumPy buffer protocol integration for zero-copy field access
+
+### Known Issues
+- Memory leaks in `selectTimes` function (requires RAII fix)
+- Incorrect return value policies in some bindings
+- Missing negative index checks in field accessors
+
+---

{pybfoam-0.1.4 → pybfoam-0.1.6}/CMakeLists.txt

@@ -5,7 +5,7 @@ if(POLICY CMP0169)
     cmake_policy(SET CMP0169 OLD)
 endif()
 
-project(pybFoam VERSION 0.1.4 LANGUAGES CXX)
+project(pybFoam VERSION 0.1.6 LANGUAGES CXX)
 
 # Set C++ standard
 set(CMAKE_CXX_STANDARD 17)

pybfoam-0.1.6/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.4
+Name: pybFoam
+Version: 0.1.6
+Summary: python bindings for OpenFOAM
+Keywords: OpenFOAM,simulation,CFD
+Author-Email: Henning Scheufler <henning.scheufler@web.de>
+License-Expression: GPL-3.0-or-later
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Project-URL: Homepage, https://github.com/HenningScheufler/pybFoam
+Project-URL: Repository, https://github.com/HenningScheufler/pybFoam.git
+Project-URL: Issues, https://github.com/HenningScheufler/pybFoam/issues
+Requires-Python: >=3.8
+Requires-Dist: numpy>=1.20
+Requires-Dist: pybind11>=2.6.0
+Requires-Dist: pydantic
+Requires-Dist: pyyaml
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-xdist; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: cmake>=3.18; extra == "dev"
+Requires-Dist: pybind11-stubgen>=2.5; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=4.0; extra == "docs"
+Requires-Dist: sphinx-sitemap; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: sphinxcontrib-mermaid; extra == "docs"
+Provides-Extra: all
+Requires-Dist: pybFoam[dev,docs]; extra == "all"
+Description-Content-Type: text/markdown
+
+# pybFoam
+
+Python bindings for OpenFOAM - enabling direct manipulation of OpenFOAM cases, fields, and meshes from Python.
+
+Currently in the pre-alpha release state.
+
+---
+
+## Features
+
+- **Direct Python access to OpenFOAM data structures**: Time, fvMesh, fields
+- **Finite volume operators**: fvc (calculus), fvm (matrix operations)
+- **Turbulence and thermodynamic models**: Access to OpenFOAM turbulence and thermo libraries
+- **Sampling and post-processing**: Surface sampling, line sampling, interpolation
+- **Pydantic configuration models**: Type-safe dictionary construction for sampling surfaces
+- **NumPy integration**: Zero-copy access to OpenFOAM field data via buffer protocol
+
+---
+
+## Requirements
+
+- **OpenFOAM**: v2012 or higher (sourced and installed)
+- **Python**: 3.8 or higher
+- **CMake**: 3.18 or higher
+- **C++ Compiler**: C++17 compatible (GCC 7+, Clang 5+)
+- **Build tools**: pybind11, scikit-build-core
+- **Python packages**: numpy, pydantic
+
+---
+
+## Installation
+
+### Prerequisites
+
+1. Source your OpenFOAM environment:
+   ```bash
+   source /path/to/OpenFOAM/etc/bashrc
+   ```
+
+2. (Recommended) Create a virtual environment:
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate
+   ```
+
+### Install from source
+
+```bash
+pip install .
+```
+
+For development:
+```bash
+pip install -e . --no-build-isolation
+```
+
+---
+
+## Quick Start
+
+### Basic Usage
+
+```python
+import pybFoam as pf
+
+# Create OpenFOAM time and mesh
+time = pf.createTime()
+mesh = pf.fvMesh(time)
+
+# Access fields
+p = pf.volScalarField.read_field(mesh, "p")
+U = pf.volVectorField.read_field(mesh, "U")
+
+# Compute gradients using finite volume calculus
+grad_p = pf.fvc.grad(p)
+div_U = pf.fvc.div(U)
+
+# Convert to NumPy arrays for analysis
+import numpy as np
+p_array = np.asarray(p["internalField"])
+print(f"Pressure range: {p_array.min():.3f} to {p_array.max():.3f}")
+```
+
+### Sampling Surfaces
+
+```python
+from pybFoam.sampling import SampledPlaneConfig, sampledSurface, interpolationScalar
+from pybFoam import Word
+
+# Create a sampling plane using Pydantic config
+plane_config = SampledPlaneConfig(
+    point=[0.5, 0.5, 0.0],
+    normal=[1.0, 0.0, 0.0]
+)
+
+# Create the surface
+plane = sampledSurface.New(Word("myPlane"), mesh, plane_config.to_foam_dict())
+plane.update()
+
+# Interpolate field onto surface
+interp = interpolationScalar.New(Word("cellPoint"), p)
+sampled_values = interp.sampleOnFaces(plane)
+```
+
+### Dictionary I/O with Pydantic
+
+```python
+from pybFoam.io import IOModelBase
+from pydantic import Field
+
+class TransportProperties(IOModelBase):
+    nu: float = Field(..., description="Kinematic viscosity")
+    
+    class Config:
+        foam_file_name = "transportProperties"
+
+# Read from OpenFOAM dictionary
+props = TransportProperties.from_file("constant/transportProperties")
+print(f"Viscosity: {props.nu}")
+
+# Modify and write back
+props.nu = 1e-5
+props.to_file("constant/transportProperties")
+```
+
+---
+
+## Examples
+
+See the `tests/` directory for more examples:
+- **Basic field operations**: `tests/pybind/test_primitives.py`
+- **Finite volume operators**: `tests/pybind/test_fvc.py`, `tests/pybind/test_fvm.py`
+- **Surface sampling**: `tests/pybind/test_surface_sampling.py`
+- **Line sampling**: `tests/pybind/test_set_sampling.py`
+- **Solver example**: `tests/cavity/icoFoam.py`
+
+---
+
+## Testing
+
+Run the test suite:
+
+```bash
+pytest tests/
+```
+
+Run specific test categories:
+```bash
+pytest tests/pybind/          # C++ binding tests
+pytest tests/test_sampling_models.py  # Pydantic config tests
+```
+
+---
+
+## Documentation
+
+Full documentation is available at: [https://henningscheufler.github.io/pybFoam/](https://henningscheufler.github.io/pybFoam/index.html)
+
+---
+
+### Development Setup
+
+1. Clone the repository
+2. Install development dependencies:
+   ```bash
+   pip install -e ".[dev]"
+   ```
+3. Run tests before committing:
+   ```bash
+   pytest tests/
+   ```
+
+---
+
+## License
+
+See [LICENSE](LICENSE) file for details.
+
+---
+
+

pybfoam-0.1.6/README.md

@@ -0,0 +1,181 @@
+# pybFoam
+
+Python bindings for OpenFOAM - enabling direct manipulation of OpenFOAM cases, fields, and meshes from Python.
+
+Currently in the pre-alpha release state.
+
+---
+
+## Features
+
+- **Direct Python access to OpenFOAM data structures**: Time, fvMesh, fields
+- **Finite volume operators**: fvc (calculus), fvm (matrix operations)
+- **Turbulence and thermodynamic models**: Access to OpenFOAM turbulence and thermo libraries
+- **Sampling and post-processing**: Surface sampling, line sampling, interpolation
+- **Pydantic configuration models**: Type-safe dictionary construction for sampling surfaces
+- **NumPy integration**: Zero-copy access to OpenFOAM field data via buffer protocol
+
+---
+
+## Requirements
+
+- **OpenFOAM**: v2012 or higher (sourced and installed)
+- **Python**: 3.8 or higher
+- **CMake**: 3.18 or higher
+- **C++ Compiler**: C++17 compatible (GCC 7+, Clang 5+)
+- **Build tools**: pybind11, scikit-build-core
+- **Python packages**: numpy, pydantic
+
+---
+
+## Installation
+
+### Prerequisites
+
+1. Source your OpenFOAM environment:
+   ```bash
+   source /path/to/OpenFOAM/etc/bashrc
+   ```
+
+2. (Recommended) Create a virtual environment:
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate
+   ```
+
+### Install from source
+
+```bash
+pip install .
+```
+
+For development:
+```bash
+pip install -e . --no-build-isolation
+```
+
+---
+
+## Quick Start
+
+### Basic Usage
+
+```python
+import pybFoam as pf
+
+# Create OpenFOAM time and mesh
+time = pf.createTime()
+mesh = pf.fvMesh(time)
+
+# Access fields
+p = pf.volScalarField.read_field(mesh, "p")
+U = pf.volVectorField.read_field(mesh, "U")
+
+# Compute gradients using finite volume calculus
+grad_p = pf.fvc.grad(p)
+div_U = pf.fvc.div(U)
+
+# Convert to NumPy arrays for analysis
+import numpy as np
+p_array = np.asarray(p["internalField"])
+print(f"Pressure range: {p_array.min():.3f} to {p_array.max():.3f}")
+```
+
+### Sampling Surfaces
+
+```python
+from pybFoam.sampling import SampledPlaneConfig, sampledSurface, interpolationScalar
+from pybFoam import Word
+
+# Create a sampling plane using Pydantic config
+plane_config = SampledPlaneConfig(
+    point=[0.5, 0.5, 0.0],
+    normal=[1.0, 0.0, 0.0]
+)
+
+# Create the surface
+plane = sampledSurface.New(Word("myPlane"), mesh, plane_config.to_foam_dict())
+plane.update()
+
+# Interpolate field onto surface
+interp = interpolationScalar.New(Word("cellPoint"), p)
+sampled_values = interp.sampleOnFaces(plane)
+```
+
+### Dictionary I/O with Pydantic
+
+```python
+from pybFoam.io import IOModelBase
+from pydantic import Field
+
+class TransportProperties(IOModelBase):
+    nu: float = Field(..., description="Kinematic viscosity")
+    
+    class Config:
+        foam_file_name = "transportProperties"
+
+# Read from OpenFOAM dictionary
+props = TransportProperties.from_file("constant/transportProperties")
+print(f"Viscosity: {props.nu}")
+
+# Modify and write back
+props.nu = 1e-5
+props.to_file("constant/transportProperties")
+```
+
+---
+
+## Examples
+
+See the `tests/` directory for more examples:
+- **Basic field operations**: `tests/pybind/test_primitives.py`
+- **Finite volume operators**: `tests/pybind/test_fvc.py`, `tests/pybind/test_fvm.py`
+- **Surface sampling**: `tests/pybind/test_surface_sampling.py`
+- **Line sampling**: `tests/pybind/test_set_sampling.py`
+- **Solver example**: `tests/cavity/icoFoam.py`
+
+---
+
+## Testing
+
+Run the test suite:
+
+```bash
+pytest tests/
+```
+
+Run specific test categories:
+```bash
+pytest tests/pybind/          # C++ binding tests
+pytest tests/test_sampling_models.py  # Pydantic config tests
+```
+
+---
+
+## Documentation
+
+Full documentation is available at: [https://henningscheufler.github.io/pybFoam/](https://henningscheufler.github.io/pybFoam/index.html)
+
+---
+
+### Development Setup
+
+1. Clone the repository
+2. Install development dependencies:
+   ```bash
+   pip install -e ".[dev]"
+   ```
+3. Run tests before committing:
+   ```bash
+   pytest tests/
+   ```
+
+---
+
+## License
+
+See [LICENSE](LICENSE) file for details.
+
+---
+
+

{pybfoam-0.1.4 → pybfoam-0.1.6}/cmake/FindOpenFOAM.cmake

@@ -228,6 +228,26 @@ if(NOT TARGET OpenFOAM::lagrangian)
     target_link_directories(OpenFOAM::lagrangian INTERFACE "${FOAM_LIBBIN}")
 endif()
 
+# ============================================================================
+# Create OpenFOAM::sampling target
+# ============================================================================
+if(NOT TARGET OpenFOAM::sampling)
+    add_library(OpenFOAM::sampling INTERFACE IMPORTED)
+    
+    target_include_directories(OpenFOAM::sampling INTERFACE
+        "${FOAM_SRC}/sampling/lnInclude"
+        "${FOAM_SRC}/sampling/sampledSurface/sampledSurface"
+    )
+    
+    target_link_libraries(OpenFOAM::sampling INTERFACE 
+        sampling
+        OpenFOAM::finiteVolume
+        OpenFOAM::meshTools
+        OpenFOAM::core
+    )
+    target_link_directories(OpenFOAM::sampling INTERFACE "${FOAM_LIBBIN}")
+endif()
+
 # ============================================================================
 # Create OpenFOAM::api target (combines all libraries)
 # ============================================================================
@@ -243,6 +263,7 @@ if(NOT TARGET OpenFOAM::api)
         OpenFOAM::transport
         OpenFOAM::fileFormats
         OpenFOAM::lagrangian
+        OpenFOAM::sampling
     )
 endif()
 
@@ -267,6 +288,7 @@ set(OPENFOAM_INCLUDE_DIRS
     "${FOAM_SRC}/fileFormats/lnInclude"
     "${FOAM_SRC}/surfMesh/lnInclude"
     "${FOAM_SRC}/lagrangian/basic/lnInclude"
+    "${FOAM_SRC}/sampling/lnInclude"
 )
 
 set(OPENFOAM_LIBRARY_DIRS "${FOAM_LIBBIN}")
@@ -286,6 +308,7 @@ set(OPENFOAM_LIBRARIES
     fileFormats
     surfMesh
     lagrangian
+    sampling
 )
 
 # ============================================================================

pybfoam-0.1.6/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pybfoam-0.1.6/docs/README.md

@@ -0,0 +1,4 @@
+# pybFoam Documentation
+
+This folder contains the Sphinx documentation sources for pybFoam.
+Build with `sphinx-build -b html . _build/html`.

pybfoam-0.1.6/docs/api.rst

@@ -0,0 +1,6 @@
+API Reference
+=============
+
+.. .. automodule:: pybFoam
+..    :members:
+..    :undoc-members:

pybfoam-0.1.6/docs/changelog.rst

@@ -0,0 +1,6 @@
+.. _changelog:
+
+Changelog
+=========
+
+See the GitHub releases page for a full changelog.

pybfoam-0.1.6/docs/conf.py

@@ -0,0 +1,57 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "pybFoam"
+copyright = "2025, Henning Scheufler"
+author = "Henning Scheufler"
+release = "0.1.6"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinxcontrib.mermaid",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.ifconfig",
+    "sphinx.ext.viewcode",
+    "sphinx_sitemap",
+    "sphinx.ext.inheritance_diagram",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "furo"
+html_theme_options = {
+    "canonical_url": "",
+    "analytics_id": "",  #  Provided by Google in your dashboard
+    "display_version": True,
+    "prev_next_buttons_location": "bottom",
+    "style_external_links": False,
+    "logo_only": False,
+    # Toc options
+    "collapse_navigation": True,
+    "sticky_navigation": True,
+    "navigation_depth": 4,
+    "includehidden": True,
+    "titles_only": False,
+    "sidebar_hide_name": False,
+    "navigation_with_keys": True,
+}
+
+html_static_path = ["_static"]
+
+html_baseurl = "https://henning.github.io/pybFoam/"

pybfoam-0.1.6/docs/contributing.rst

@@ -0,0 +1,9 @@
+Contributing
+============
+
+Contributions are welcome! Please open issues or pull requests on GitHub.
+
+1. Fork the repository
+2. Create a feature branch
+3. Commit your changes
+4. Open a pull request

pybfoam-0.1.6/docs/index.rst

@@ -0,0 +1,24 @@
+.. pybFoam documentation master file, created by
+   sphinx-quickstart on Sun Sep  7 12:02:25 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+pybFoam Documentation
+=====================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents
+
+   installation
+   usage
+   api
+   contributing
+   changelog
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

pybfoam-0.1.6/docs/installation.rst

@@ -0,0 +1,13 @@
+.. _installation:
+
+
+Installation
+============
+
+Install pybFoam with pip:
+
+.. code-block:: bash
+
+   pip install pybFoam
+
+See the README.md for OpenFOAM requirements and build instructions.