tUpdate help text in README - cngf-pf - continuum model for granular flows with pore-pressure dynamics (renamed from 1d_fd_simple_shear)
(HTM) git clone git://src.adamsgaard.dk/cngf-pf
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
(DIR) commit 5aca72fd4967063ab5f250ec7f6b24f053737135
(DIR) parent 130f86a441865b5b7e84fd62a710a9bd0ccb80f7
(HTM) Author: Anders Damsgaard <anders@adamsgaard.dk>
Date: Mon, 8 Jul 2019 13:06:50 +0200
Update help text in README
Diffstat:
M README.md | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
---
(DIR) diff --git a/README.md b/README.md
t@@ -15,8 +15,11 @@ The majority of simulation parameters can be adjusted from the command line:
```
usage: 1d_fd_simple_shear [OPTIONS] [NAME]
runs a simulation and outputs state in files prefixed with NAME.
-If NAME is not specified, the default value 'unnamed' is used.
-optional arguments:
+If NAME is not specified, intermediate output are not written.
+
+Optional arguments:
+ -v, --version show version information
+ -h, --help show this message
-N, --normalize normalize output velocity
-G, --gravity VAL gravity magnitude [m/s^2] (default 9.81)
-P, --normal-stress VAL normal stress on top [Pa] (default 120000)
t@@ -25,12 +28,15 @@ optional arguments:
-A, --nonlocal-amplitude VAL amplitude of nonlocality [-] (default 0.4)
-b, --rate-dependence VAL rate dependence beyond yield [-] (default 0.9377)
-f, --friction-coefficient VAL grain friction coefficient [-] (default 0.366614)
+ -C, --cohesion VAL grain cohesion [Pa] (default 0)
-p, --porosity VAL porosity fraction [-] (default 0.25)
-d, --grain-size VAL representative grain size [m] (default 0.04)
-r, --density VAL grain material density [kg/m^3] (default 2600)
-n, --resolution VAL number of cells in domain [-] (default 100)
-o, --origo VAL coordinate system origo [m] (default 0)
-L, --length VAL domain length [m] (default 0.7)
+
+Optional arguments only relevant with transient (fluid) simulation:
-F, --fluid enable pore fluid computations
-c, --fluid-compressibility VAL fluid compressibility [Pa^-1] (default 4.5e-10)
-i, --fluid-viscosity VAL fluid viscosity [Pa*s] (default 0.001)
t@@ -43,8 +49,6 @@ optional arguments:
-t, --time VAL simulation start time [s] (default 0)
-T, --time-end VAL simulation end time [s] (default 1)
-I, --file-interval VAL interval between output files [s] (default 0.1)
- -v, --version show version information
- -h, --help show this message
```
## Results