https://github.com/yhesper/TaichiSimplicialFluid

Interactive surface flow toy implemented in Taichi
https://github.com/yhesper/TaichiSimplicialFluid

Last synced: about 2 months ago
JSON representation

Interactive surface flow toy implemented in Taichi

• Host: GitHub
• URL: https://github.com/yhesper/TaichiSimplicialFluid
• Owner: yhesper
• Created: 2022-06-30T09:34:17.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-22T00:22:46.000Z (about 2 years ago)
• Last Synced: 2024-08-02T11:23:56.164Z (5 months ago)
• Language: Python
• Size: 9.59 MB
• Stars: 66
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-taichi - TaichiSimplicialFluid - An interactive toy of surface flow implemented in Taichi. (Applications / **Simulation**)

README

        


 



Interactive Surface Flow in Taichi


 Welcome to my interactive toy of surface flow implemented in [Taichi Lang](https://github.com/taichi-dev/taichi). It creates a real-time fluid simulation on the surface of a triangle mesh manifold with genus 0 based on a slightly modified version of Elcott's [Simplicial Fluids](http://www.geometry.caltech.edu/pubs/ETKSD07.pdf). 

Here are some examples of what it does. It solves the Euler equations in real-time on the mesh surface, and use both colorful dyes and particles to visualize the fluid. I also wrote something over [here](https://yhesper.github.io/projects/2_project_simpfluid/) that briefly explained how my implementation differ from Elcott's algorithm. See below for [user guide](#user-guide). 

https://user-images.githubusercontent.com/35747011/177987263-e3ad4353-075d-43eb-9806-005d86a8f7e3.mp4

https://user-images.githubusercontent.com/35747011/177987322-9f8cdafb-2518-4e9f-9368-18332f417b48.mp4

---

### User Guide

Important: This program is based on [Taichi](https://docs.taichi.graphics/docs/), its [GGUI](https://docs.taichi-lang.org/docs/ggui) and [MeshTaichi extension](https://github.com/taichi-dev/meshtaichi) (See details in https://github.com/taichi-dev/meshtaichi). Please make sure your machine satisfies their requirements. Also make sure to install Taichi first!

#### How to Run

Install the latest Taichi and MeshTaichi extension by:

```

python3 -m pip install —U taichi meshtaichi_patcher

```

#### How to Play

Run with ```python3 fluid.py --model meshes/bunny.obj``` (or other obj files in ```meshes``` folder) with `--arch [cpu/cuda]` to select backend platforms.

* Hold your left mouse button to splat dye and splat force on to the system. 

* Press ```r``` to reset the simulation.

* Press ```p``` to pause.

* Press ```esc``` to exit.

* Press ```x``` to take a snap shot.

* Toggle ```c``` to disable or enable changing dye's color.

* Toggle ```v``` to disable or enable advecting particles to visualize the flow.

* Use ```w,a,s,d``` to move camera, and use your right mouse button to rotate camera.

#### Notes

The fluid is advected using an implicit scheme, which is stable. However, excessively adding forces still could result in a very unstable system. If you see ```"Warning: Does not meet Courant–Friedrichs–Lewy condition!"``` being printed out, it means that you have added too much energy to the system  in too short of a period time.

The mesh quality plays a huge part on the behavior of this program, and you should only run this program on meshes that are manifold with no holes.