Need help with CubbyFlow?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

utilForever
150 Stars 17 Forks MIT License 465 Commits 25 Opened issues

Description

Voxel-based fluid simulation engine for computer games

Services available

!
?

Need anything else?

Contributors list

# 84,468
Shell
computa...
hearths...
cpluspl...
429 commits
# 648,056
hearths...
cpluspl...
cpp17
computa...
2 commits
# 133,379
React
ecmascr...
webpack...
analysi...
2 commits
# 367,309
Jupyter...
bayesia...
julia-l...
cpp17
1 commit
# 184,380
vt100
unity3d
Unity
cpluspl...
1 commit

CubbyFlow

License Windows Ubuntu macOS Ubuntu - Codecov Build Status

codecov Codacy Badge Total alerts Language grade: C/C++ CodeFactor Discord

Quality Gate Status Lines of Code Maintainability Rating Reliability Rating Security Rating

CubbyFlow is voxel-based fluid simulation engine for computer games based on Jet framework that was created by Doyub Kim. The code is built on C++17 and can be compiled with commonly available compilers such as g++, clang++, or Microsoft Visual Studio. CubbyFlow currently supports macOS (10.12.6 or later), Ubuntu (17.04 or later), Windows (Visual Studio 2017 or later), and Windows Subsystem for Linux (WSL). Other untested platforms that support C++17 also should be able to build CubbyFlow.

Key Features

  • Basic math and geometry operations and data structures
  • Spatial query accelerators
  • SPH and PCISPH fluid simulators
  • Stable fluids-based smoke simulator
  • Level set-based liquid simulator
  • PIC, FLIP, and APIC fluid simulators
  • Upwind, ENO, and FMM level set solvers
  • Jacobi, Gauss-Seidel, SOR, MG, CG, ICCG, and MGPCG linear system solvers
  • Spherical, SPH, Zhu & Bridson, and Anisotropic kernel for points-to-surface converter
  • Converters between signed distance function and triangular mesh
  • C++ and Python API
  • Intel TBB, OpenMP, HPX and C++11 multi-threading backends

Every simulator has both 2-D and 3-D implementations.

Quick Start

You will need CMake to build the code. If you're using Windows, you need Visual Studio 2017 in addition to CMake.

First, clone the code:

git clone https://github.com/utilForever/CubbyFlow.git --recursive
cd CubbyFlow

C++ API

For macOS or Linux or Windows Subsystem for Linux (WSL):

mkdir build
cd build
cmake ..
make

For Windows:

mkdir build
cd build
cmake .. -G"Visual Studio 15 2017 Win64"
MSBuild CubbyFlow.sln /p:Configuration=Release

Now run some examples, such as:

bin/HybridLiquidSim

Python API

Build and install the package by running

pip install -U .

Docker

docker pull utilforever/cubbyflow:latest

Now run hybrid simulation example:

docker run -it utilforever/cubbyflow
[inside docker container]
/app/build/bin/HybridLiquidSim

More Instructions of Building the Code

To learn how to build, test, and install the SDK, please check out INSTALL.md.

Documentation

All the documentations for the framework can be found from the project website incluing the API reference.

Examples

Here are some of the example simulations generated using CubbyFlow framework. Corresponding example codes can be found under Examples. All images are rendered using Mitsuba renderer and the Mitsuba scene files can be found from the demo directory. Find out more demos from the project website.

PCISPH Simulation Example

PCISPH_dam_breaking

Level Set Simulation Example

Level-set_dam_breaking

FLIP Simulation Example

FLIP_dam_breaking

PIC Simulation Example

PIC_dam_breaking

APIC Simulation Example

APIC_dam_breaking

Level Set Example with Different Viscosity (high / low)

level_set_bunny_drop_high_viscosity level_set_bunny_drop_low_viscosity

Smoke Simulation with Different Advection Methods (Linear / Cubic-Spline)

rising_smoke_linear rising_smoke_cubic

Presentations

Articles

How To Contribute

Contributions are always welcome, either reporting issues/bugs or forking the repository and then issuing pull requests when you have completed some additional coding that you feel will be beneficial to the main project. If you are interested in contributing in a more dedicated capacity, then please contact me.

Contact

You can contact me via e-mail (utilForever at gmail.com). I am always happy to answer questions or help with any issues you might have, and please be sure to share any additional work or your creations with me, I love seeing what other people are making.

License

The class is licensed under the MIT License:

Copyright (c) 2018-2020 CubbyFlow Team

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.