tfix `mandoc -Tlint` errors/warnings in man pages - 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 a032722560845b2f11dfebeb5576f2508d2f1b91
(DIR) parent 5bd5b0c8750a91f1b5a7bc083a98aa6e474eda46
(HTM) Author: Anders Damsgaard <anders@adamsgaard.dk>
Date: Sun, 24 Jan 2021 09:55:24 +0100
fix `mandoc -Tlint` errors/warnings in man pages
Diffstat:
M cngf-pf.1 | 33 ++++++++++++++++---------------
M max_depth_simple_shear.1 | 12 +++++++-----
M shear_flux.1 | 31 +++++++++++++++++--------------
3 files changed, 41 insertions(+), 35 deletions(-)
---
(DIR) diff --git a/cngf-pf.1 b/cngf-pf.1
t@@ -54,10 +54,11 @@
The
.Nm
utility simulates the coupled continuum dynamics of granular
-deformation and pore pressure. The simulation space is one-dimensional
-and undergoes confined, simple shear at a pretedermined velocity
-or friction ratio. The effective stress is modulated by pore-pressure
-dynamics when fluid dynamics are enabled.
+deformation and pore pressure.
+The simulation space is one-dimensional and undergoes confined,
+simple shear at a pretedermined velocity or friction ratio.
+The effective stress is modulated by pore-pressure dynamics when
+fluid dynamics are enabled.
.Pp
The arguments are as follows:
.Bl -tag -width Ds
t@@ -188,22 +189,22 @@ Show version information.
.It Fl Y Ar max-porosity
Granular material porosity [-] at inertia number I=1 in transient
simulations
-.Fl ( T )
+.Fl ( T )
(default 0.55).
.It Fl y Ar min-porosity
Minimum granular material porosity [-] in transient simulations
.Fl ( T )
(default 0.20).
-.Pp
+.sp
.El
The final simulation state is written to stdout, see
-.Sx OUTPUT FORMAT
+.Sx OUTPUT FORMAT
for a description of the data format.
.Sh OUTPUT FORMAT
The output consists of the following tab-delimited fields, with one
row per cell in the simulation domain:
.Pp
-.Bl -enum -compact
+.Bl -enum -width Ss -compact
.It
position [m]
.It
t@@ -224,15 +225,15 @@ inertia number [-]
shear stress [Pa]
.El
.Sh FILES
-If
+If
.Ar name
is set, the simulation state is written to files in the current
directory named in the format
.Pa <name>.outputDDDDD.txt .
Here, DDDDD is a integer counter starting from 00000, and incrementing
-by 1 for each new file. Each file contains the state at a single
-point in simulation time. The output format is specified in the
-section
+by 1 for each new file.
+Each file contains the state at a single point in simulation time.
+The output format is specified in the section
.Sx OUTPUT FORMAT ,
and output files are generated with the interval specified with
.Fl I Ar file-interval .
t@@ -240,14 +241,14 @@ and output files are generated with the interval specified with
.Nm
exits 0 on success, and >0 if a runtime error occurs:
.Pp
-.Bl -tag -compact
+.Bl -tag -width Ds -compact
.It 0
successful exit
.It 1
unspecified error
.It 2
.Xr pledge 2
-error (OpenBSD only)
+error
.It 10
transient solver error
.It 11
t@@ -266,8 +267,8 @@ Plot critical-state shear velocity as a function of depth:
.\" .Sh ERRORS
.\" For sections 2, 3, 4, and 9 errno settings only.
.Sh SEE ALSO
-.Xr gnuplot 1
-.Xr max_depth_simple_shear 1
+.Xr gnuplot 1 ,
+.Xr max_depth_simple_shear 1 ,
.Xr shear_flux 1
.Sh AUTHORS
.An Anders Damsgaard Aq Mt anders@adamsgaard.dk
(DIR) diff --git a/max_depth_simple_shear.1 b/max_depth_simple_shear.1
t@@ -25,8 +25,9 @@ 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 top.
+It is assumed that the granular layer has uniform thickness and
+porosity.
.Pp
The arguments mirror the sister program
.Xr cngf-pf 1
t@@ -79,20 +80,21 @@ skin depth [m]
.Nm
exits 0 on succes, and >0 if a runtime error occurs:
.Pp
-.Bl -tag -compact
+.Bl -tag -width Ds -compact
.It 0
successful exit
.It 1
unspecified error
.It 2
.Xr pledge 2
-error (OpenBSD only)
+error
.It 10
skin depth vs. depth error
.It 11
no stress minima found in search range
+.El
.Sh SEE ALSO
-.Xr cngf-pf 1
+.Xr cngf-pf 1 ,
.Xr shear_flux 1
.Sh AUTHORS
.An Anders Damsgaard Aq Mt anders@adamsgaard.dk
(DIR) diff --git a/shear_flux.1 b/shear_flux.1
t@@ -14,12 +14,25 @@ utility outputs the cumulative sediment shear flux from a profile
of positions and shear velocities.
.Nm
expects that the first column of input is a list of positions, and
-the second column is a list of shear velocities. All other columns
-are discarded. Input can be supplied through stdin or from a single
-file.
+the second column is a list of shear velocities.
+All other columns are discarded.
+Input can be supplied through stdin or from a single file.
.Pp
The output is the cumulative sediment flux with units square meters
per second (m^2/s).
+.Sh EXIT STATUS
+.Nm
+exits 0 on success, and >0 if a runtime error occurs:
+.Pp
+.Bl -tag -width Ds -compact
+.It 0
+successful exit
+.It 1
+unspecified error
+.It 2
+.Xr pledge 2
+error
+.El
.Sh EXAMPLES
The normal use is to pipe the output of
.Xr cngf-pf 1
t@@ -37,18 +50,8 @@ into
.Dl 0.0017711059751388718
.Dl 0.0017971161104479135
.Dl 0.0017971161104479135
-.Sh EXIT STATUS
-.Pp
-.Bl -tag -compact
-.It 0
-successful exit
-.It 1
-unspecified error
-.It 2
-.Xr pledge 2
-error (OpenBSD only)
.Sh SEE ALSO
-.Xr cngf-pf 1
+.Xr cngf-pf 1 ,
.Xr max_depth_simple_shear 1
.Sh AUTHORS
.An Anders Damsgaard Aq Mt anders@adamsgaard.dk