Documentation Status

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, and imgui or AntTweakBar. 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, try out our Maya plugin:

Author: Jan Bender, License: MIT

Build Instructions

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.

Python Installation Instruction

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: 2.7, 3.5, 3.6, 3.7, 3.8. 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

Documentation

Features

SPlisHSPlasH implements:

Pressure Solvers

The SPlisHSPlasH library implements the following pressure solvers:

Boundary Handling

The SPlisHSPlasH library implements the following boundary handling methods:

Viscosity

The SPlisHSPlasH library implements explicit viscosity methods:

and the implicit methods of the following publications:

Surface Tension

The SPlisHSPlasH library implements the surface tension methods of the following publications:

Vorticity

The SPlisHSPlasH library implements the vorticity methods of the following publications:

Drag Forces

The SPlisHSPlasH library implements the drag force computation of the following publications:

Elastic Forces

Multi-Phase Fluid Simulation

The SPlisHSPlasH library implements the following publication to realize multi-phase simulations:

Screenshots

Videos

The following videos were generated using the SPlisHSPlasH library:

A Micropolar Material Model for Turbulent SPH Fluids Density Maps for Improved SPH Boundary Handling
Video Video
Divergence-Free Smoothed Particle Hydrodynamics Divergence-Free SPH for Incompressible and Viscous Fluids
Video Video
A Physically Consistent Implicit Viscosity Solver for SPH Fluids Turbulent Micropolar SPH Fluids with Foam
Video Video
Volume Maps: An Implicit Boundary Representation for SPH
Video

References