Python API Reference¶
This section documents the DNDSR Python package, which wraps the C++ core
via pybind11 and provides high-level utilities for mesh I/O and solver setup.
The reference is generated from a combination of:
.pyistub files (produced bypybind11-stubgenfrom the compiled modules)Pure-Python wrapper docstrings
sphinx.ext.autodocruntime introspection (when the package is importable)
Note
To build this reference with full autodoc support:
Build and install the pybind11 modules:
cmake --build build -t dnds_pybind11 geom_pybind11 cfv_pybind11 eulerP_pybind11 -j32cmake --install build --component pyInstall the package:
pip install -e .Build docs:
cmake --build build -t docs
Overview by Module¶
Module |
Purpose |
Key Classes / Functions |
|---|---|---|
|
MPI, arrays, serialization |
|
|
Mesh I/O and topology |
|
|
Finite volume and reconstruction |
|
|
GPU-enabled solver evaluator |
|
TODO: Expand each module section below with detailed class and method documentation as the stub generation pipeline matures.