README.md (1199B)
1 # cngf-pf 2 3 This project contains a 1d implementation of the Henann and Kamrin 4 2013[1] model under simple shear, with various extensions such as 5 diffusive fluid coupling and cohesion. The granular material is 6 assumed to be in the critical state with constant porosity. A 7 transient option with non-constant porosity is under development 8 (option -T). 9 10 ## Compiling and installing 11 Requirements are a C99-compatible compiler (e.g. `gcc` or `clang`). 12 Run `make` and `make install` to install the programs and their man 13 pages. 14 15 If you want to show debug output during runtime, compile with 16 `CFLAGS=-DDEBUG make`. 17 18 ## Performance 19 For optimal performance, especially with the TDMA solvers, it is recommended to compile with optimization flags: 20 ```sh 21 make CFLAGS="-O3 -march=native -flto" LDFLAGS="-flto" 22 ``` 23 24 ## Usage 25 See `man cngf-pf`, `man max_deformation_depth` and `man 26 shear_flux` for usage information. 27 28 ## Results 29 A paper with model results is publicly available[2]. 30 31 ## Author 32 Anders Damsgaard <anders@adamsgaard.dk> 33 https://src.adamsgaard.dk/cngf-pf 34 ISC licensed, see LICENSE for details. 35 36 ## References 37 [1]: https://doi.org/10.1073/pnas.1219153110 38 [2]: https://doi.org/10.1038/s43247-020-00074-7