Skip to main content

A Fully differentiable SPH Solver.

Project description

diffSPH is an open-source Smoothed Particle Hydrodynamics simulation framework built for adjoint problem solving and machine learning applications. diffSPH is written mostly in Python using PyTorch but also supports C++/CUDA extensions. The fundamentally differentiable nature of diffSPH make it a versatile basis for many different applications of SPH. Stay tunes for more details on the applications and design of diffSPH! This is the solver at https://diffsph.fluids.dev/ .

Installation

The only major requirement for this solver is our companion software that handles the neighbor searching and related topics, which you can find more about here. Other than that the solver is straightforward to setup and can also be used in Google colab

conda create --name sphEnv python=3.12
conda activate sphEnv
conda install -c anaconda ipykernel -y
conda install nvidia/label/cuda-12.8.1::cuda-toolkit cudnn
pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu128
git clone https://https://github.com/wi-re/torchCompactRadius
cd torchCompactRadius
python setup.py develop
cd ..
https://github.com/tum-pbs/diffSPH
cd diffSPH
pip install -e .

Examples

Compressible Flows

Rayleigh-Taylor Instability Kevin-Helmholtz Instability Sod-Shock Tube Sedov Blastwave

More examples can be found under examples/compressible

Weakly Compressibe Flows

Taylor Green Vortex Rotating Square Patch Lid-Driven Cavity
Driven Square Flow Past Cylinder Dam Break

More examples can be found under examples/weaklyCompressible

Incompressible Flows:

Taylor Green Vortex

Other Examples

diffSPH can also be used to simulate a variety of other PDEs such as the wave equation

Wave Equation 2D

Inverse Problems

diffSPH is meant as a framework for differentiable problem solving and supports all the common tasks in adjoint optimization and machine learning, including:

Loss-based Physics Parameter Optimization Shape Optimization Solver In The Loop

Features

diffSPH comes with a large variety of SPH schemes already builtin and can be easily extended to include more solver schemes and SPH properties:

  • $\delta$-SPH and $\delta^+$-SPH for weakly compressible simulations
  • IISPH and DFSPH for incompressible simulations
  • CompSPH, CRKSPH, PESPH and the classic Monaghan scheme for compressible simulations
  • mDBC boundary conditions for rigid bodies
  • Inlets and Oulets with buffer zones
  • Periodic BCs using minimum image conventions
  • Neumann and Dirichlet BCs
  • grad-H, kernel renormalization and CRK correction schemes
  • $\delta^+$ and implicit particle shifting
  • Monaghan and Owen schemes for adaptive particle support radii
  • Balsara, Morris, Rosswog, Cullen Dehnen artificial viscosity switches
  • Sub particle scale turbulence modelling
  • Differentiable generation of initial conditions using SDFs
  • Hierarchical and compact hashing based neighbor searching
  • Verlet lists for neighborhood searches
  • Most Common SPH Kernel Functions (Wendland, B-Spline, Poly6) used across the fields

pip install toml scipy numba tqdm h5py matplotlib ipywidgets ipympl imageio scikit-image

Time Integration

diffSPH comes builtin with a large number of temporal integration schemes which we validated against a dampened harmonic oscillator with a hidden state variable:

$$ \begin{aligned} \hat{k} &= k + \alpha e\ \frac{dx}{dt} &= u&\ m \frac{du}{dt} &= -\hat{k} x &- c u\ \frac{de}{dt} &= \beta \text{sgn}(u) u^2 &- \gamma e \end{aligned} $$

Physical Problem Integrator Accuracy

Datasets

There have been a variety of datasets already generated with diffSPH, including:

SFBC Test Case II Periodic BCs
No-Slip Free-Slip

Publications

So far diffSPH has been used in the following publications:

  • Symmetric Fourier Basis Convolutions for Learning Lagrangian Fluid Simulations, R. Winchenbach, N. Thuerey, International Conference on Learning Representations 2024 https://arxiv.org/abs/2403.16680

Workshop Papers:

  • MoriNet: A Machine Learning-based Mori-Zwanzig Perspective on Weakly Compressible SPH, R. Winchenbach and N. Thuerey, 2025 International SPHERIC Workshop Barcelona, Spain (pdf available under publications)
  • Physically-Motivated Machine Learning Models for Lagrangian Fluid Mechanics, R. Winchenbach and N.Thuerey, 2024 International SPHERIC Workshop Berlin, Germany (presentation and more information available here https://fluids.dev/spheric2024/)
  • Cross-Validation of SPH-based Machine Learning Models using the Taylor-Green Vortex Case - R. Winchenbach and N. Thuerey - Particle Methods and Applications Conference 2024 Santa Fe, USA (presentation and more information available here: https://pmac.fluids.dev)
  • A Hybrid Framework for Fluid Flow Simulations: Combining SPH with Machine Learning - R. Winchenbach and N. Thuerey - 2023 International SPHERIC Workshop Rhodes, Greece (pdf available under publications)

Acknoledgement

This work has been in parts funded by the DFG Individual Research Grant TH 2034/1-2.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

diffsph-0.1.4.tar.gz (251.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

diffsph-0.1.4-py3-none-any.whl (314.8 kB view details)

Uploaded Python 3

File details

Details for the file diffsph-0.1.4.tar.gz.

File metadata

  • Download URL: diffsph-0.1.4.tar.gz
  • Upload date:
  • Size: 251.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for diffsph-0.1.4.tar.gz
Algorithm Hash digest
SHA256 038a72ab16aa52a6c847ab8dba735be2416e5a06a7e558c0418f501d753455f5
MD5 eafb5f2f628c2a610193a5c98fd672c5
BLAKE2b-256 02e620016130e6efe52d1fc70a265b795b2b11c201532308ad9a05f0f2f2d109

See more details on using hashes here.

File details

Details for the file diffsph-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: diffsph-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 314.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for diffsph-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b132eee8bacf8b8a58077aae494c0ea0bfec23b013049c8fd8beb3546159fcbb
MD5 427033aa86767546872862b7ff346b0c
BLAKE2b-256 60f8e8a388a12584cbc014e4220c76178b06037631467b1bc9d2086b1c74f46e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page