SPlisHSPlasH is an open-source library for the physically-based simulation of fluids.
MIT License
SPlisHSPlasH is an open-source library for the physically-based simulation of fluids. The simulation in this library is based on the Smoothed Particle Hydrodynamics (SPH) method which is a popular meshless Lagrangian approach to simulate complex fluid effects. The SPH formalism allows an efficient computation of a certain quantity of a fluid particle by considering only a finite set of neighboring particles. One of the most important research topics in the field of SPH methods is the simulation of incompressible fluids. SPlisHSPlasH implements current state-of-the-art pressure solvers (WCSPH, PCISPH, PBF, IISPH, DFSPH, PF) to simulate incompressibility. Moreover, the library provides different methods to simulate viscosity, surface tension and vorticity.
The library uses the following external libraries: Eigen, json, partio, zlib, cxxopts, tinyexpr, toojpeg, pybind, glfw, hapPLY, nfd, and imgui. All external dependencies are included.
Furthermore we use our own libraries:
SPlisHSPlasH can export the particle data in the partio and vtk format. If you want to import partio files in Maya or Blender, try out our plugins:
Author: Jan Bender
The SPlisHSPlasH library code is licensed under the MIT license. See LICENSE for details.
External dependencies are covered by separate licensing terms. See the extern folder for the code and respective licensing terms of each dependency.
On our GitHub discussions page you can ask questions, discuss about simulation topics, and share ideas.
This project is based on CMake. Simply generate project, Makefiles, etc. using CMake and compile the project with a compiler of your choice that supports C++11. The code was tested with the following configurations:
Note: Please use a 64-bit target on a 64-bit operating system. 32-bit builds on a 64-bit OS are not supported.
For Windows and Linux targets there exists prebuilt python wheel files which can be installed using
pip install pysplishsplash
These are available for Python versions 3.6-3.10. See also here: pySPlisHSPlasH. If you do not meet these conditions please refer to the build instructions and to the python binding Getting started guide.
The command line simulator is available by running one of the following
splash
splash --help
SPlisHSPlasH implements:
A list of all implemented simulation methods can be found here: https://splishsplash.physics-simulation.org/features
https://splishsplash.physics-simulation.org/gallery
To cite SPlisHSPlasH you can use this BibTeX entry:
@software{SPlisHSPlasH_Library,
author = {Bender, Jan and others},
license = {MIT},
title = {{SPlisHSPlasH Library}},
url = {https://github.com/InteractiveComputerGraphics/SPlisHSPlasH},
}