pybFoam 0.1.4__tar.gz → 0.1.5__tar.gz

pybfoam-0.1.5/.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.5}/.gitignore

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

{pybfoam-0.1.4 → pybfoam-0.1.5}/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.5 LANGUAGES CXX)
 
 # Set C++ standard
 set(CMAKE_CXX_STANDARD 17)

{pybfoam-0.1.4 → pybfoam-0.1.5}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: pybFoam
-Version: 0.1.4
+Version: 0.1.5
 Summary: python bindings for OpenFOAM
 Keywords: OpenFOAM,simulation,CFD
-Author-Email: Henning Scheufler <henning.scheufler@dlr.de>
+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
@@ -18,9 +18,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/DLR-RY/pybFoam
-Project-URL: Repository, https://github.com/DLR-RY/pybFoam.git
-Project-URL: Issues, https://github.com/DLR-RY/pybFoam/issues
+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
@@ -38,7 +38,9 @@ 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-rtd-theme; 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
@@ -55,21 +57,10 @@ currently in the pre-alpha release state
 requires OpenFOAM of2012 or higher sourced and installed and python 3.7+ (conda is highly recommended) 
 
 ```
-./build-pybFoam.sh # will install conan zmq oftest
+pip install .
 ```
-## Testsuite
 
-oftest is automatically installed and is run with py.test
 
-```
-py.test
-```
-
-## Build Documentation (WIP)
+## Documentation
 
-The documentation is based on the [Jekyll Documentation Theme](https://idratherbewriting.com/documentation-theme-jekyll/)
-
-```
-cd docs
-jekyll serve
-```
+The documentation is found [here](https://henningscheufler.github.io/pybFoam/index.html)

pybfoam-0.1.5/README.md

@@ -0,0 +1,19 @@
+# pybFoam
+
+python bindings for OpenFOAM
+
+currently in the pre-alpha release state
+
+
+## Installation
+
+requires OpenFOAM of2012 or higher sourced and installed and python 3.7+ (conda is highly recommended) 
+
+```
+pip install .
+```
+
+
+## Documentation
+
+The documentation is found [here](https://henningscheufler.github.io/pybFoam/index.html)

pybfoam-0.1.5/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.5/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.5/docs/api.rst

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

pybfoam-0.1.5/docs/changelog.rst

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

pybfoam-0.1.5/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.5"
+
+# -- 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.5/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.5/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.5/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.

pybfoam-0.1.5/docs/introduction.rst

@@ -0,0 +1,26 @@
+.. _introduction:
+
+Introduction
+============
+
+
+pybFoam is an open-source Python library for pre- and post-processing of OpenFOAM simulation data. It is designed to simplify the workflow of extracting, processing, and analyzing simulation results.
+
+Key Features
+------------
+- Seamless integration with OpenFOAM for reading and writing data
+- Modular workflow system for chaining data processing steps
+- Built-in aggregators (Sum, Mean, etc.) and support for custom nodes
+- Export results to CSV and other formats for further analysis
+- Compatible with multiple Python and OpenFOAM versions
+
+Supported Versions
+------------------
+- OpenFOAM: 2406, 2412, 2506 (as tested in CI)
+- Python: 3.9, 3.10, 3.11, 3.12, 3.13
+
+License and Authorship
+----------------------
+- License: [GPL]
+- Author: Henning Scheufler
+- Contributors: [see GitHub repository]

pybfoam-0.1.5/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

pybfoam-0.1.5/docs/usage.rst

@@ -0,0 +1,9 @@
+Usage
+=====
+
+Example usage:
+
+.. code-block:: python
+
+   import pybFoam
+   # Load mesh, access fields, run aggregation, etc.

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

@@ -1,8 +1,8 @@
 [project]
 name = "pybFoam"
-version = "0.1.4"
+version = "0.1.5"
 authors = [
-    {name = "Henning Scheufler", email = "henning.scheufler@dlr.de"},
+    {name = "Henning Scheufler", email = "henning.scheufler@web.de"},
 ]
 description = "python bindings for OpenFOAM"
 readme = "README.md"
@@ -45,16 +45,18 @@ dev = [
 ]
 docs = [
     "sphinx>=4.0",
-    "sphinx-rtd-theme",
+    "sphinx-sitemap",
+    "furo",
+    "sphinxcontrib-mermaid"
 ]
 all = [
     "pybFoam[dev,docs]",
 ]
 
 [project.urls]
-Homepage = "https://github.com/DLR-RY/pybFoam"
-Repository = "https://github.com/DLR-RY/pybFoam.git"
-Issues = "https://github.com/DLR-RY/pybFoam/issues"
+Homepage = "https://github.com/HenningScheufler/pybFoam"
+Repository = "https://github.com/HenningScheufler/pybFoam.git"
+Issues = "https://github.com/HenningScheufler/pybFoam/issues"
 
 [tool.setuptools]
 include-package-data = true

pybfoam-0.1.5/src/pybFoam/_version.py

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

{pybfoam-0.1.4 → pybfoam-0.1.5}/src/pybFoam/pybFoam_core/bind_control.cpp

@@ -53,7 +53,11 @@ void bindControl(pybind11::module& m)
 
     py::class_<simpleControl>(m, "simpleControl")
         .def(py::init<fvMesh&, const word&>(), py::arg("mesh"), py::arg("dictName") = word("SIMPLE"))
-        // .def("correct", &simpleControl::correct)
+        .def("correctNonOrthogonal", &simpleControl::correctNonOrthogonal)
+        .def("momentumPredictor", &simpleControl::momentumPredictor)
+        .def("finalNonOrthogonalIter", &simpleControl::finalNonOrthogonalIter)
+        .def("nNonOrthCorr", &simpleControl::nNonOrthCorr)
+        .def("loop", &simpleControl::loop)
         ;
 }
 

{pybfoam-0.1.4 → pybfoam-0.1.5}/src/pybFoam/pybFoam_core/bind_fields.cpp

@@ -195,6 +195,7 @@ void Foam::bindFields(py::module& m)
         ;
 
     py::class_<List<label>>(m, "labelList")
+        .def(py::init<label, label > ())
         .def(py::init<List<label> > ())
         .def(py::init([](std::vector<label> vec) {
             List<label> f(vec.size());

{pybfoam-0.1.4 → pybfoam-0.1.5}/src/pybFoam/pybFoam_core/bind_geo_fields.cpp

@@ -238,6 +238,21 @@ auto declare_geofields(py::module &m, std::string className) {
     {
         self = vf2;
     })
+    .def("relax", []
+    (
+        Foam::GeometricField<Type, PatchField, GeoMesh>& self
+    )
+    {
+        self.relax();
+    })
+    .def("relax", []
+    (
+        Foam::GeometricField<Type, PatchField, GeoMesh>& self,
+        Foam::scalar relaxFactor
+    )
+    {
+        self.relax(relaxFactor);
+    })
 
     ;
 

{pybfoam-0.1.4 → pybfoam-0.1.5}/tests/pybind/test_primitives.py

@@ -142,6 +142,15 @@ def test_vectorField():
     vf_1 = vectorField([vector(1,1,1) for i in range(0,6)])
     assert (vf_1 == np.ones([6,3])).all()
 
+    # scalar product
+    vf_5 = vectorField([vector(1,2,3) for i in range(0,6)])
+    vf_6 = vectorField([vector(1,1,1) for i in range(0,6)])
+
+    assert (np.asarray(vf_6 & vf_5) == np.array([6,6,6,6,6,6])).all()
+
+    # assert (np.asarray(vector(1,1,1) & vf_5) == np.array([6,6,6,6,6,6])).all() # not supported
+    assert (np.asarray(vf_5 & vector(1,1,1)) == np.array([6,6,6,6,6,6])).all()
+
 
 def test_tensorField():
 

pybfoam-0.1.4/README.md

@@ -1,30 +0,0 @@
-# pybFoam
-
-python bindings for OpenFOAM
-
-currently in the pre-alpha release state
-
-
-## Installation
-
-requires OpenFOAM of2012 or higher sourced and installed and python 3.7+ (conda is highly recommended) 
-
-```
-./build-pybFoam.sh # will install conan zmq oftest
-```
-## Testsuite
-
-oftest is automatically installed and is run with py.test
-
-```
-py.test
-```
-
-## Build Documentation (WIP)
-
-The documentation is based on the [Jekyll Documentation Theme](https://idratherbewriting.com/documentation-theme-jekyll/)
-
-```
-cd docs
-jekyll serve
-```

pybfoam-0.1.4/docs/404.md

@@ -1,6 +0,0 @@
----
-title: "Page Not Found"
-search: exclude
----  
-
-Sorry, but the page you were trying to view does not exist. Try searching for it or looking at the URL to see if it looks correct.

pybfoam-0.1.4/docs/LICENSE

@@ -1,13 +0,0 @@
-Copyright 2021 DLR
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    https://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

pybfoam-0.1.4/docs/LICENSE-BSD-NAVGOCO.txt

@@ -1,27 +0,0 @@
-/* This license pertains to the Navgoco jQuery component used for the sidebar. */
-
-Copyright (c) 2013, Christodoulos Tsoulloftas, http://www.komposta.net
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
-
-   * Redistributions of source code must retain the above copyright notice,
-      this list of conditions and the following disclaimer.
-   * Redistributions in binary form must reproduce the above copyright notice,
-      this list of conditions and the following disclaimer in the documentation
-      and/or other materials provided with the distribution.
-   * Neither the name of the <Christodoulos Tsoulloftas> nor the names of its
-      contributors may be used to endorse or promote products derived from this
-      software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
- ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
-OF THE POSSIBILITY OF SUCH DAMAGE.

pybfoam-0.1.4/docs/_config.yml

@@ -1,117 +0,0 @@
-repository: DLR-RY/ECI4FOAM
-
-output: web
-# this property is useful for conditional filtering of content that is separate from the PDF.
-
-topnav_title: External Coupling Interface for FOAM
-# this appears on the top navigation bar next to the home button
-
-site_title: External Coupling Interface for FOAM
-# this appears in the html browser tab for the site title (seen mostly by search engines, not users)
-
-company_name: Copyright 2021 DLR
-# this appears in the footer
-
-github_editme_path: DLR-RY/ECI4FOAM/blob/master/doc
-# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank.
-
-# gitlab_editme_path: DLR-RY/ECI4FOAM/blob/master/doc
-# if you're using GitLab, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank.
-
-google_analytics: UA-66296557-1
-# if you have google-analytics ID, put it in. if not, edit this value to blank.
-
-host: 127.0.0.1
-# the preview server used. Leave as is.
-
-port: 4000
-# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. in that case, use another port such as 4006.
-
-exclude:
-  - .idea/
-  - .gitignore
-  - vendor
-# these are the files and directories that jekyll will exclude from the build
-
-feedback_subject_line: ECI4FOAM
-
-feedback_email: test@gmail.com
-# used as a contact email for the Feedback link in the top navigation bar
-
-# feedback_disable: true
-# if you uncomment the previous line, the Feedback link gets removed
-
-# feedback_text: "Need help?"
-# if you uncomment the previous line, it changes the Feedback text
-
-# feedback_link: "http://helpy.io/"
-# if you uncomment the previous line, it changes where the feedback link points to
-
-highlighter: rouge
-# library used for syntax highlighting
-
-markdown: kramdown
-kramdown:
- input: GFM
- auto_ids: true
- hard_wrap: false
- syntax_highlighter: rouge
-
-# filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways
-
-collections:
-  tooltips:
-    output: false
-# collections are declared here. this renders the content in _tooltips and processes it, but doesn't output it as actual files in the output unless you change output to true
-
-defaults:
-  -
-    scope:
-      path: ""
-      type: "pages"
-    values:
-      layout: "page"
-      comments: false
-      # if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property
-      search: true
-      sidebar: home_sidebar
-      topnav: topnav
-  -
-    scope:
-      path: ""
-      type: "tooltips"
-    values:
-      layout: "page"
-      search: true
-      tooltip: true
-
-  -
-    scope:
-      path: ""
-      type: "posts"
-    values:
-      layout: "post"
-      comments: false
-      # if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property
-      search: true
-      sidebar: home_sidebar
-      topnav: topnav
-
-# these are defaults used for the frontmatter for these file types
-
-sidebars:
-- home_sidebar
-- doc_sidebar
-
-description: "Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features."
-# the description is used in the feed.xml file
-
-# needed for sitemap.xml file only
-# url: DLR-RY.github.io
-# baseurl: /ECI4FOAM/docs
-
-
-github: [metadata]
-
-
-# Copyright 2021 company_name