Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
taehoon-yoon authored Feb 28, 2023
1 parent bd04a38 commit 6f8ffbe
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,18 @@
### First Phase (set-up phase)
- If you run the `run_simulation.py`, you will see the following window.
<img src="./image/png/phase1.png">
[Fig.2 Phase1]

This is the phase where you can edit the SPH particle system. For example, you can change the width, height and depth of fluid blocks. Further you can add more fluid blocks and decide whether to include static rigid body(dragon sculpture) for simulation.

- Axis description and definition of `(x0, y0, z0)` and `(x1, y1, z1)`

<img src="./image/png/front-view.png" height="300"> &nbsp; &nbsp; &nbsp;
<img src="./image/png/side-view.png" height="300"> &nbsp; &nbsp; &nbsp;
<img src="./image/png/front-view.png" height="300">
[Fig3. Axis description]

<img src="./image/png/side-view.png" height="300">
[Fig4. `(x0, y0, z0)` and `(x1, y1, z1)`]


- Widget Option Description

Expand All @@ -37,6 +42,8 @@ This is the phase where you can edit the SPH particle system. For example, you c

`x0_{}, y0_{}, z0_{}` : Fluid block { } start point. Since by default there is only one fluid block, there exists only `x0_1, y0_1, z0_1` . If you add more fluid block by `Add Fluid Block` , then there will be more slider bar to adjust the position of fluid block. Eacn slider range from minimal possible point (`origin` + some margin) to maximal possible point ( `(x1, y1, z1)` - some margin).

`x1_{}, y1_{}, z1_{}` : Fluid block { } end point. You can find the definition of `(x0, y0, z0)` and `(x1, y1, z1)` in the upper left image. (marked as green) Eacn slider range from minimal possible point ( `(x0, y0, z0)` + some margin) to maximal possible point ( `maxium boundary point` (black line vertex) - some margin).
`x1_{}, y1_{}, z1_{}` : Fluid block { } end point. You can find the definition of `(x0, y0, z0)` and `(x1, y1, z1)` in the [Fig. 3]. (marked as green) Eacn slider range from minimal possible point ( `(x0, y0, z0)` + some margin) to maximal possible point ( `maxium boundary point` (black line vertex) - some margin).

### :warning: WARNING :warning: : Due to GPU memory problem, when you want to change the value of `(x0, y0, z0)` and `(x1, y1, z1)` you must **click** the point you want that value to be located not sliding the bar. Please consult the following gif.

### :warning: WARNING :warning: : Due to GPU memory problem, when you want to change the value of `(x0, y0, z0)` and `(x1, y1, z1)` you must **click** the point you want that value to be located not sliding the bar. Consult to the following gif.
<img src="./image/phase1-manual.gif">

0 comments on commit 6f8ffbe

Please sign in to comment.