Skip to content

Commit 8f3c7e0

Browse files
committed
Updated documentation and README
1 parent 03164f1 commit 8f3c7e0

File tree

4 files changed

+12
-3
lines changed

4 files changed

+12
-3
lines changed

README.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# WaterSim: optimised implementation of a FLIP algorithm
22

3-
<img height="250" src="https://gitlab.inf.ethz.ch/COURSE-ASL/asl21/team32/-/raw/ad459c11b081bf09a87802cb96c4803e54b58cf1/docs/dam-break-low-res.png"></img>
4-
<img height="250" src="https://gitlab.inf.ethz.ch/COURSE-ASL/asl21/team32/-/raw/master/docs/dam-break-high-res.png"></img>
3+
![Low-resolution simulation](docs/dam-break-low-res.png)
4+
![High-resolution simulation](docs/dam-break-high-res.png)
55

66
Fluid simulation via FLIP (Fluid Implicit Particle) Method.
77

@@ -12,7 +12,7 @@ Original authors: Silvia Nauer, Mikael Stellio, Sean Bone.
1212

1313
Optimizations by: Christoph Amevor, Felix Illes, Mikael Stellio, Sean Bone.
1414

15-
Images: Visualization of speedup of the optimized version (bottom) over the original implementation (top) by comparison of simulations of different sizes requiring an equal amount of run time.
15+
Images: comparison of the visual improvements gained by optimising the algorithm. The bottom simulation has higher resolution, but took about the same time to compute as the top one, which was simulated with the unoptimised code.
1616

1717
# Cloning with submodules
1818

@@ -183,3 +183,12 @@ If/when we get back to this project, there's some things we'd like to implement
183183
- Some kind of open-boundary conditions, allowing waves and splashes to disappear out of the simulation instead of being forced to remain in the box
184184
- Particle sources/sinks
185185
- Grid-aligned stationary solids
186+
187+
188+
# References
189+
190+
See the `docs` folder for some useful PDFs.
191+
192+
- C. Amevor, S. Bone, F. Illes, M. Stellio, "Optimisation of a FLIP algorithm", report for the Advanced Systems Lab lecture at ETH Zürich, spring semester 2021.
193+
- R. Bridson, "FLUID SIMULATION", SIGGRAPH 2007 Course Notes. [Available online](https://www.cs.ubc.ca/~rbridson/fluidsimulation/fluids_notes.pdf).
194+
- D. Englesson, J. Kilby, J. Ek, "Fluid Simulation Using Implicit Particles", report for the Advanced Game Programming lecture at Linköpings universitet, December 2011. [Available online](http://danenglesson.com/flipfluid.html).

docs/FLIP_paper.pdf

-2.36 MB
Binary file not shown.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)