pybFoam 0.1.5__tar.gz → 0.1.6__tar.gz

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.5 → pybfoam-0.1.6}/CMakeLists.txt

@@ -5,7 +5,7 @@ if(POLICY CMP0169)
     cmake_policy(SET CMP0169 OLD)
 endif()
 
-project(pybFoam VERSION 0.1.5 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.5 → 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.5 → pybfoam-0.1.6}/docs/conf.py

@@ -9,7 +9,7 @@
 project = "pybFoam"
 copyright = "2025, Henning Scheufler"
 author = "Henning Scheufler"
-release = "0.1.5"
+release = "0.1.6"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

{pybfoam-0.1.5 → pybfoam-0.1.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pybFoam"
-version = "0.1.5"
+version = "0.1.6"
 authors = [
     {name = "Henning Scheufler", email = "henning.scheufler@web.de"},
 ]

{pybfoam-0.1.5 → pybfoam-0.1.6}/src/pybFoam/CMakeLists.txt

@@ -8,6 +8,7 @@ add_subdirectory(fvm)
 add_subdirectory(thermo)
 add_subdirectory(turbulence)
 add_subdirectory(aggregation)
+add_subdirectory(sampling)
 
 # Create a Python module that includes all components
 set(PYBFOAM_PYTHON_FILES

pybfoam-0.1.6/src/pybFoam/_version.py

@@ -0,0 +1 @@
+__version__ = "0.1.6"

{pybfoam-0.1.5 → pybfoam-0.1.6}/src/pybFoam/pybFoam_core/bind_mesh.cpp

@@ -89,19 +89,11 @@ void bindMesh(pybind11::module &m)
     namespace py = pybind11;
 
     m.def("selectTimes", &Foam::selectTimes);
+    m.def("createMesh", &Foam::createMesh, py::return_value_policy::take_ownership,
+        "Create a mesh from a Time object");
 
     py::class_<Foam::argList>(m, "argList")
         .def(py::init(&Foam::makeArgList), py::return_value_policy::take_ownership)
-        // .def(py::init<const Foam::argList&, const Foam::HashTable<Foam::string>&, bool, bool, bool>())
-        // .def("check", &Foam::argList::check)
-        // .def("checkRootCase", &Foam::argList::checkRootCase)
-        // .def("printCompat", &Foam::argList::printCompat)
-        // .def("printNotes", &Foam::argList::printNotes)
-        // .def("printUsage", &Foam::argList::printUsage)
-        // .def("printMan", &Foam::argList::printMan)
-        // .def("displayDoc", &Foam::argList::displayDoc)
-        // .def("checkArgs", &Foam::argList::argsMandatory)
-        // .def("setCheckArgs", &Foam::argList::argsMandatory, py::arg("check"))
         ;
 
     py::class_<Foam::Time>(m, "Time")

{pybfoam-0.1.5 → pybfoam-0.1.6}/src/pybFoam/pybFoam_core/bind_primitives.cpp

@@ -104,6 +104,9 @@ void bindPrimitives(pybind11::module& m)
         .def("__str__",[](const Foam::word& self){
             return std::string(self);
         })
+        .def("__repr__",[](const Foam::word& self){
+            return std::string(self);
+        })
         ;
 
 

pybfoam-0.1.6/src/pybFoam/sampling/CMakeLists.txt

@@ -0,0 +1,50 @@
+# sampling module CMakeLists.txt
+
+set(SAMPLING_SOURCES
+    bind_sampling.cpp
+    sampling.cpp
+)
+
+set(SAMPLING_HEADERS
+    bind_sampling.hpp
+)
+
+# Create the pybind11 module
+pybind11_add_module(_sampling ${SAMPLING_SOURCES})
+
+# Set target properties
+set_target_properties(_sampling PROPERTIES
+    CXX_VISIBILITY_PRESET "hidden"
+    VISIBILITY_INLINES_HIDDEN ON
+)
+
+# Link OpenFOAM libraries - order matters!
+target_link_libraries(_sampling PRIVATE
+    OpenFOAM::finiteVolume
+    OpenFOAM::meshTools
+    OpenFOAM::core
+)
+
+# Explicitly link the sampling library
+target_link_directories(_sampling PRIVATE "${FOAM_LIBBIN}")
+target_link_libraries(_sampling PRIVATE -lsampling)
+
+# Add include directories specific to this module
+target_include_directories(_sampling PRIVATE
+    ${CMAKE_CURRENT_SOURCE_DIR}
+    "${FOAM_SRC}/sampling/lnInclude"
+)
+
+# Install the module
+if(DEFINED SKBUILD)
+    # scikit-build-core manages the installation
+    install(TARGETS _sampling
+        LIBRARY DESTINATION pybFoam
+        COMPONENT python
+    )
+else()
+    # Standalone build - install to Python site-packages
+    install(TARGETS _sampling
+        LIBRARY DESTINATION "${Python_SITELIB}/pybFoam"
+    )
+endif()

pybfoam-0.1.6/src/pybFoam/sampling/__init__.py

@@ -0,0 +1,74 @@
+"""pybFoam.sampling package exports for convenience.
+
+Keep the public API small: import configs in the package namespace so
+`from pybFoam.sampling import SampledPlaneConfig, UniformSetConfig` works in examples/tests.
+"""
+from __future__ import annotations
+
+
+from pybFoam._sampling import *  # noqa: F403
+
+from .surface_configs import (
+    SampledSurfaceBaseConfig,
+    SampledPlaneConfig,
+    SampledPatchConfig,
+    SampledCuttingPlaneConfig,
+    SampledCuttingSurfaceConfig,
+    SampledIsoSurfaceConfig,
+    SampledMeshedSurfaceConfig,
+    SampledFaceZoneConfig,
+    SampledPatchInternalFieldConfig,
+    SampledThresholdCellFacesConfig,
+    SampledDistanceSurfaceConfig,
+    sampled_surface_from,
+)
+
+from .set_configs import (
+    SampledSetBaseConfig,
+    UniformSetConfig,
+    CloudSetConfig,
+    PolyLineSetConfig,
+    CircleSetConfig,
+    ArraySetConfig,
+    FaceOnlySetConfig,
+    MidPointSetConfig,
+    MidPointAndFaceSetConfig,
+    CellCentreSetConfig,
+    PatchCloudSetConfig,
+    PatchSeedSetConfig,
+    sampled_set_from,
+)
+
+from .utils import dict_to_foam
+
+__all__ = [
+    # SampledSurface configs
+    "SampledSurfaceBaseConfig",
+    "SampledPlaneConfig",
+    "SampledPatchConfig",
+    "SampledCuttingPlaneConfig",
+    "SampledCuttingSurfaceConfig",
+    "SampledIsoSurfaceConfig",
+    "SampledMeshedSurfaceConfig",
+    "SampledFaceZoneConfig",
+    "SampledPatchInternalFieldConfig",
+    "SampledThresholdCellFacesConfig",
+    "SampledDistanceSurfaceConfig",
+    # SampledSet configs
+    "SampledSetBaseConfig",
+    "UniformSetConfig",
+    "CloudSetConfig",
+    "PolyLineSetConfig",
+    "CircleSetConfig",
+    "ArraySetConfig",
+    "FaceOnlySetConfig",
+    "MidPointSetConfig",
+    "MidPointAndFaceSetConfig",
+    "CellCentreSetConfig",
+    "PatchCloudSetConfig",
+    "PatchSeedSetConfig",
+    # Helper functions
+    "sampled_surface_from",
+    "sampled_set_from",
+    "dict_to_foam",
+]