Skip to content

Commit c6e5247

Browse files
authored
Update README.md
1 parent 9f36e72 commit c6e5247

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,40 @@ Reactive Deposition of Brownian Particles. [arXiv:2204.01173 [cond-mat]](https:/
1414
| <img src="https://raw.githubusercontent.com/drdrjacobs/reactive_deposition_sim/master/images/dendritic_transition.png" width="600" height="803"> |
1515
|:--:|
1616
| The compact-to-dendritic transition in the reactive deposition of Brownian particles at $\log_{10} \mathrm{Da} = -2.12$. Color schemes vary depending on the panel, as indicated in the descriptions. Panels (a) and (b) depict two-dimensional deposition. The $N$ particles in these panels are rendered with a radius twice that of the actual radius for clarity. The $i$-th band of color moving outwards from the center corresponds to the structure after $i N / 5$ particles have been deposited. (a) Initially, the cluster displays a compact morphology. (b) However, upon reaching a critical radius, it spontaneously forms dendritic branches. (c) Main Panel: During three-dimensional deposition, a similar dendritic morphology emerges at large length scales. Particles are colored based on their distance from the origin. Inset: A two-dimensional slice through the initial compact 3D cluster, $N = 1 \times 10^{6}$. The color scheme follows a continuous gradient based on the deposition order. |
17+
18+
# Dependencies
19+
20+
- [Boost](https://www.boost.org/)
21+
- [Eigen](https://eigen.tuxfamily.org/index.php?title=Main_Page): Template library for linear algebra.
22+
23+
# Usage
24+
25+
### Config File
26+
27+
First generate a config file for Make starting from `example_config.mk`:
28+
29+
```cp example_config.mk config.mk```
30+
31+
Change `BOOST_PATH` and `EIGEN_INC_PATH` in `config.mk` to point to your installations of Boost and Eigen.
32+
33+
### Compile
34+
35+
Create the build directories:
36+
37+
```mkdir obj2d obj3d bin```
38+
39+
And compile with:
40+
41+
```make```
42+
43+
This will generete two executables, `bin/ga_simulation_2d` for running two-dimensional simulations and `bin/ga_simulation_3d` for running three-dimensional simulations.
44+
45+
### Run
46+
47+
Finally, modify the `params.txt` file to specify physical system you would like to simulate. You can now run with:
48+
49+
```./bin/ga_simulation_2d```
50+
51+
After, the simulation finishes, it will output a `frame_NNN.xyz` file (where `NNN` is the number of particles) that lists the positions off all the particles in the cluster. This file can be vizualized with [Ovito](https://www.ovito.org/).
52+
53+

0 commit comments

Comments
 (0)