Metadata-Version: 2.5
Name: gridfoam
Version: 0.3.0
Summary: Differentiable Fluid Solver of Hierarchical Grid
Author: RICOS Co. Ltd.
Maintainer-email: Daichi Ishida <ishida@ricos.co.jp>
Classifier: Programming Language :: Python
Classifier: Programming Language :: Rust
Requires-Python: <3.13,>=3.12
Requires-Dist: beartype
Requires-Dist: fluxel-cfd<0.3.0,>=0.2.0
Requires-Dist: graphlow>=0.1.0
Requires-Dist: jaxtyping
Requires-Dist: phlower-tensor>=0.1.0
Requires-Dist: pyamg>=5.3.0
Requires-Dist: pydantic>=2.11.7
Requires-Dist: pyvista>=0.44.2
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: scipy>=1.17.1
Provides-Extra: cpu
Requires-Dist: torch>=2.5.1; extra == 'cpu'
Requires-Dist: torchvision>=0.20.1; extra == 'cpu'
Provides-Extra: cu118
Requires-Dist: torch>=2.5.1; extra == 'cu118'
Requires-Dist: torchvision>=0.20.1; extra == 'cu118'
Provides-Extra: cu124
Requires-Dist: torch>=2.5.1; extra == 'cu124'
Requires-Dist: torchvision>=0.20.1; extra == 'cu124'
Description-Content-Type: text/markdown

# Gridfoam: Differentiable Fluid Solver of Hierarchical Grid

gridfoam is a differentiable finite-volume solver for incompressible flow on
Fluxel hierarchical grids. It provides SIMPLE, PISO, and PIMPLE algorithms,
immersed boundaries, and PyTorch gradients through linear solves.

Start with the [CPU cavity quickstart](docs/source/user_guide/quickstart.rst).
See [configuration](docs/source/user_guide/configuration.rst) for YAML settings
and [running cases](docs/source/user_guide/running_cases.rst) for bundled examples.

- [`examples/`](examples/) contains runnable flow, motion, and optimization cases.
- [`assets/`](assets/README.md) contains reusable Jinja configuration templates.
- [`experiments/`](experiments/README.md) contains numerical and OpenFOAM comparisons.
- [`tests/profile/`](tests/profile/README.md) contains CPU/CUDA performance tools.

For development, see the [setup guide](docs/source/contributor_guide/development_setup.rst)
and [data contracts](docs/source/contributor_guide/architecture/data_contracts.rst).
Build the HTML documentation with `make document`; the result is in `docs/build/`.
