tAdd man page for max_depth_simple_shear(1) - cngf-pf - continuum model for gra… | |
git clone git://src.adamsgaard.dk/cngf-pf | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit 6c6715388e3ed8cc034e65fea742d51bb375260d | |
parent fd5acc03c3640c28c5b50724a76abc4b9ae5a81e | |
Author: Anders Damsgaard <[email protected]> | |
Date: Fri, 6 Mar 2020 10:25:02 +0100 | |
Add man page for max_depth_simple_shear(1) | |
Diffstat: | |
M Makefile | 3 ++- | |
A max_depth_simple_shear.1 | 85 +++++++++++++++++++++++++++++… | |
2 files changed, 87 insertions(+), 1 deletion(-) | |
--- | |
diff --git a/Makefile b/Makefile | |
t@@ -14,7 +14,8 @@ BIN = \ | |
1d_fd_simple_shear\ | |
max_depth_simple_shear | |
MAN1 = \ | |
- 1d_fd_simple_shear.1 | |
+ 1d_fd_simple_shear.1\ | |
+ max_depth_simple_shear.1 | |
DOC = \ | |
README.md\ | |
LICENSE | |
diff --git a/max_depth_simple_shear.1 b/max_depth_simple_shear.1 | |
t@@ -0,0 +1,85 @@ | |
+.Dd $Mdocdate$ | |
+.Dt MAX_DEPTH_SIMPLE_SHEAR 1 | |
+.Os | |
+.Sh NAME | |
+.Nm max_depth_simple_shear | |
+.Nd deformation characteristics from fluid perturbation | |
+.Sh SYNOPSIS | |
+.Nm | |
+.Op Fl a Ar fluid-pressure-ampl | |
+.Op Fl C Ar fluid-compressibility | |
+.Op Fl g Ar gravity-accel | |
+.Op Fl h | |
+.Op Fl i Ar fluid-viscosity | |
+.Op Fl k Ar fluid-permeability | |
+.Op Fl O Ar fluid-pressure-top | |
+.Op Fl p Ar grain-porosity | |
+.Op Fl q Ar fluid-pressure-freq | |
+.Op Fl R Ar fluid-density | |
+.Op Fl r Ar grain-density | |
+.Op Fl v | |
+.Op name | |
+.Sh DESCRIPTION | |
+The | |
+.Nm | |
+utility outputs the maximum expected deformation depth in a sheared | |
+granular system with sinusoidal fluid-pressure perturbations from | |
+the top. It is assumed that the granular layer has uniform thickness | |
+and porosity. | |
+ | |
+The arguments mirror the sister program | |
+.Xr 1d_fd_simple_shear 1 | |
+and are as follows: | |
+.Bl -tag -width Ds | |
+.It Fl a Ar fluid-pressure-ampl | |
+Amplitude of fluid-pressure perturbations [Pa] (default 0). | |
+.It Fl C Ar fluid-compressibility | |
+Fluid adiabatic compressibility [Pa^-1] (default 3.9e-10). | |
+.It Fl g Ar gravity-accel | |
+Gravity magnitude [m/s^2] (default 9.81). | |
+.It Fl h | |
+Show usage information. | |
+.It Fl i Ar fluid-viscosity | |
+Fluid dynamic viscosity [Pa*s] (1.787e-3). | |
+.It Fl k Ar fluid-permeability | |
+Darcian intrinsic permeability of granular material [m^2] (default | |
+1.9e-15). | |
+.It Fl O Ar fluid-pressure-top | |
+Fluid pressure applied at the top boundary [Pa] (default 0). | |
+.It Fl p Ar grain-porosity | |
+Granular material porosity [-] (default 0.25). | |
+.It Fl q Ar fluid-pressure-freq | |
+Frequency of fluid-pressure perturbations [s^-1] (default 1). | |
+.It Fl R Ar fluid-density | |
+Fluid density [kg/m^3] (default 1000). | |
+.It Fl r Ar grain-density | |
+Granular material density [kg/m^3] (default 2600). | |
+.It Fl v | |
+Show version information. | |
+.It Fl Y Ar max-porosity | |
+.El | |
+ | |
+The final simulation state is written to stdout, see | |
+.Sx OUTPUT FORMAT | |
+for a description of the data format. | |
+.Sh OUTPUT FORMAT | |
+The output consists of the following tab-delimited fields: | |
+ | |
+.Bl -enum -compact | |
+.It | |
+maximum deformation depth [m] | |
+.It | |
+skin depth [m] | |
+.El | |
+.Sh EXIT STATUS | |
+.Nm | |
+exits 0 on succes, and >0 if an error occurs. | |
+.\" .Sh EXAMPLES | |
+.\" .Sh DIAGNOSTICS | |
+.\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only. | |
+.\" .Sh ERRORS | |
+.\" For sections 2, 3, 4, and 9 errno settings only. | |
+.Sh SEE ALSO | |
+.Xr 1d_fd_simple_shear 1 | |
+.Sh AUTHORS | |
+.An Anders Damsgaard Aq Mt [email protected] |