commit 231ab304381ef266046dffb7a26abc5833c32c7b
parent 2baf087eedbc58ed7e34f7c8bc5a3bfe6477aa46
Author: Anders Damsgaard <anders@adamsgaard.dk>
Date: Fri, 30 Aug 2019 11:15:37 +0200
Improve help text and document output format
Diffstat:
M | main.c | | | 18 | +++++++++++++++++- |
1 file changed, 17 insertions(+), 1 deletion(-)
diff --git a/main.c b/main.c
@@ -58,7 +58,23 @@ usage(void)
" -H, --fluid-pressure-phase VAL fluid pressure at +z edge [Pa] (default %g)\n"
" -t, --time VAL simulation start time [s] (default %g)\n"
" -T, --time-end VAL simulation end time [s] (default %g)\n"
- " -I, --file-interval VAL interval between output files [s] (default %g)\n",
+ " -I, --file-interval VAL interval between output files [s] (default %g)\n"
+ "\n"
+ "The output (stdout or output files) consists of the following "
+ "tab-delimited\nfields, with one row per cell:\n"
+ " 1. z_position [m]\n"
+ " 2. x_velocity [m/s]\n"
+ " 3. normal_stress [Pa]\n"
+ " 4. friction [-]\n"
+ " 5. strain_rate [1/s]\n\n"
+ "With --fluid enabled:\n"
+ " 1. z_position [m]\n"
+ " 2. x_velocity [m/s]\n"
+ " 3. effective_normal_stress [Pa]\n"
+ " 4. fluid_pressure [Pa]\n"
+ " 5. friction [-]\n"
+ " 6. strain_rate [1/s]\n"
+ ,
__func__, PROGNAME,
sim.G,
sim.P_wall,