tUpdate README and add link to transient fork - cngf-pf - continuum model for g… | |
git clone git://src.adamsgaard.dk/cngf-pf | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit d7784f92664ba94b5c19934fc6f585b268b8d54d | |
parent fac32c7a7febb4dcc3aea5968ee0255046f60ccc | |
Author: Anders Damsgaard <[email protected]> | |
Date: Fri, 8 Nov 2019 11:20:18 +0100 | |
Update README and add link to transient fork | |
Diffstat: | |
M README.md | 16 ++++++++++------ | |
1 file changed, 10 insertions(+), 6 deletions(-) | |
--- | |
diff --git a/README.md b/README.md | |
t@@ -1,14 +1,18 @@ | |
# 1d_fd_simple_shear | |
-[![pipeline status](https://gitlab.com/admesg/1d_fd_simple_shear/badges/master… | |
This project contains a 1d implementation of the [Henann and Kamrin | |
-2013](https://doi.org/10.1073/pnas.1219153110) model under simple shear, with | |
-various extensions such as diffusive fluid coupling and cohesion. | |
+2013](https://doi.org/10.1073/pnas.1219153110) model under | |
+simple shear, with various extensions such as diffusive | |
+fluid coupling and cohesion. The granular material is | |
+assumed to be in the critical state with constant porosity. See | |
+[1d_fd_simple_shear_transient](https://src.adamsgaard.dk/1d_fd_simple_shear_tr… | |
+for a second version with variable porosity and strength. | |
## How to run | |
-The implementation in C requires a C99-compatible compiler (e.g. `gcc` or | |
-`clang`). Visualization requires `gnuplot`. To run, simply run `make` in this | |
-directory and an output PNG figure is generated. | |
+The implementation in C requires a C99-compatible compiler (e.g. `gcc` | |
+or `clang`). Visualization requires `gnuplot`. Tests can be run with | |
+`make test`, and examples (found in the `examples/` directory) can be | |
+run with `make examples`. | |
### Advanced usage | |
The majority of simulation parameters can be adjusted from the command line: |