commit 48c532102f67dafa1402ede944f084ea11d9d1d9
parent 957c062f6dd340902a9812224bb06ae759d624f4
Author: Anders Damsgaard <anders@adamsgaard.dk>
Date: Sat, 11 May 2019 13:35:40 -0500
Show updated help text in README
Diffstat:
| M | README.md | | | 51 | ++++++++++++++++++++++++++------------------------- |
1 file changed, 26 insertions(+), 25 deletions(-)
diff --git a/README.md b/README.md
@@ -15,34 +15,35 @@ 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:
-N, --normalize normalize output velocity
- -G, --gravity VAL gravity magnitude [m/s^2]
- -P, --normal-stress VAL normal stress on top [Pa]
- -m, --stress-ratio VAL applied stress ratio [-]
- -V, --velocity-bottom VAL base velocity at bottom [m/s]
- -A, --nonlocal-amplitude VAL amplitude of nonlocality [-]
- -b, --rate-dependence VAL rate dependence beyond yield [-]
- -f, --friction-coefficient VAL grain friction coefficient [-]
- -p, --porosity VAL porosity fraction [-]
- -d, --grain-size VAL representative grain size [m]
- -r, --density VAL grain material density [kg/m^3]
- -n, --resolution VAL number of cells in domain [-]
- -o, --origo VAL coordinate system origo [m]
- -L, --length VAL domain length [m]
+ -G, --gravity VAL gravity magnitude [m/s^2] (default 9.81)
+ -P, --normal-stress VAL normal stress on top [Pa] (default 120000)
+ -m, --stress-ratio VAL applied stress ratio [-] (default 0.4)
+ -V, --velocity-bottom VAL base velocity at bottom [m/s] (default 0)
+ -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)
+ -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)
-F, --fluid enable pore fluid computations
- -c, --fluid-compressibility VAL fluid compressibility [Pa^-1]
- -i, --fluid-viscosity VAL fluid viscosity [Pa*s]
- -R, --fluid-density VAL fluid density [kg/m^3]
- -k, --fluid-permeability VAL fluid intrinsic permeability [m^2]
- -O, --fluid-pressure-top VAL fluid pressure at +z edge [Pa]
- -a, --fluid-pressure-ampl VAL amplitude of pressure variations [Pa]
- -q, --fluid-pressure-freq VAL frequency of pressure variations [s^-1]
- -H, --fluid-pressure-phase VAL fluid pressure at +z edge [Pa]
- -t, --time VAL simulation start time [s]
- -T, --time-end VAL simulation end time [s]
- -D, --time-step VAL computational time step length [s]
- -I, --file-interval VAL interval between output files [s]
+ -c, --fluid-compressibility VAL fluid compressibility [Pa^-1] (default 4.5e-10)
+ -i, --fluid-viscosity VAL fluid viscosity [Pa*s] (default 0.001)
+ -R, --fluid-density VAL fluid density [kg/m^3] (default 1000)
+ -k, --fluid-permeability VAL fluid intrinsic permeability [m^2] (default 1.9e-15)
+ -O, --fluid-pressure-top VAL fluid pressure at +z edge [Pa] (default 0)
+ -a, --fluid-pressure-ampl VAL amplitude of pressure variations [Pa] (default 0)
+ -q, --fluid-pressure-freq VAL frequency of pressure variations [s^-1] (default 1)
+ -H, --fluid-pressure-phase VAL fluid pressure at +z edge [Pa] (default 0)
+ -t, --time VAL simulation start time [s] (default 0)
+ -T, --time-end VAL simulation end time [s] (default 1)
+ -D, --time-step VAL computational time step length [s] (default 2)
+ -I, --file-interval VAL interval between output files [s] (default 0.1)
-v, --version show version information
-h, --help show this message
```
