commit 35c8d2623bcb74b288d0451711b1be678e802f9e
parent a67f2e6117b50d1dfaf0d35e91bc612fd65be6b2
Author: Anders Damsgaard <anders@adamsgaard.dk>
Date: Tue, 25 Aug 2020 17:07:13 +0200
Rename main program from 1d_fd_simple_shear to cngf-pf
Diffstat:
8 files changed, 278 insertions(+), 278 deletions(-)
diff --git a/1d_fd_simple_shear.1 b/1d_fd_simple_shear.1
@@ -1,262 +0,0 @@
-.Dd $Mdocdate$
-.Dt 1D_FD_SIMPLE_SHEAR 1
-.Os
-.Sh NAME
-.Nm 1d_fd_simple_shear
-.Nd simulate granular flows with pore-pressure dynamics
-.\" .Sh LIBRARY
-.\" For sections 2, 3, and 9 only.
-.\" Not used in OpenBSD.
-.Sh SYNOPSIS
-.Nm
-.Op Fl A Ar grain-nonlocal-ampl
-.Op Fl a Ar fluid-pressure-ampl
-.Op Fl b Ar grain-rate-dependence
-.Op Fl C Ar fluid-compressibility
-.Op Fl c Ar grain-cohesion
-.Op Fl D Ar fluid-diffusivity
-.Op Fl d Ar grain-size
-.Op Fl e Ar end-time
-.Op Fl F
-.Op Fl f Ar applied-shear-friction
-.Op Fl g Ar gravity-accel
-.Op Fl H Ar fluid-pressure-phase
-.Op Fl h
-.Op Fl I Ar file-interval
-.Op Fl i Ar fluid-viscosity
-.Op Fl K Ar dilatancy-constant
-.Op Fl k Ar fluid-permeability
-.Op Fl L Ar length
-.Op Fl l Ar applied-shear-vel-limit
-.Op Fl m Ar grain-friction
-.Op Fl N
-.Op Fl n Ar normal-stress
-.Op Fl O Ar fluid-pressure-top
-.Op Fl o Ar origo
-.Op Fl P Ar grain-compressibility
-.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 S Ar fluid-pressure-pulse-shape
-.Op Fl s Ar applied-shear-vel
-.Op Fl T
-.Op Fl t Ar curr-time
-.Op Fl U Ar resolution
-.Op Fl u Ar fluid-pulse-time
-.Op Fl V Ar bot-vel
-.Op Fl v
-.Op Fl Y Ar max-porosity
-.Op Fl y Ar min-porosity
-.Op name
-.Sh DESCRIPTION
-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.
-.Pp
-The arguments are as follows:
-.Bl -tag -width Ds
-.It Fl A Ar grain-nonlocal-ampl
-Amplitude of granular non-locality [-] (default 0.4).
-.It Fl a Ar fluid-pressure-ampl
-Amplitude of fluid-pressure perturbations [Pa] (default 0).
-Only relevant with fluid dynamics enabled
-.Fl ( F ) .
-.It Fl b Ar grain-rate-dependence
-Granular rate dependence beyond yield [-], (default 0.9377).
-.It Fl C Ar fluid-compressibility
-Fluid adiabatic compressibility [Pa^-1] (default 3.9e-10).
-Only relevant with fluid dynamics enabled
-.Fl ( F ) .
-.It Fl c Ar grain-cohesion
-Granular material cohesion [Pa] (default 0).
-.It Fl D Ar fluid-diffusivity
-Fluid diffusion coefficient [m^2/s] (default -1). Overrides fluid
-permeability (-k), grain compressibility (-P), fluid compressibility
-(-C), and fluid viscosity (-i). Do not use for transient simulations
-(-T). Disabled when set to a negative value.
-.It Fl d Ar grain-size
-Granular material representative grain size [m] (default 0.04).
-.It Fl e Ar end-time
-Simulation end time [s] (default 1).
-.It Fl F
-Enable pore-space fluid dynamics.
-.It Fl f Ar applied-shear-friction
-Applied ratio between shear stress and normal stress at the top
-boundary [-] (default 0.45), overridden by
-.Fl s
-and
-.Fl l
-if these are set.
-.It Fl g Ar gravity-accel
-Gravity magnitude [m/s^2] (default 9.81).
-.It Fl H Ar fluid-pressure-phase
-Phase of fluid-pressure perturbations [s] (default 0).
-Only relevant with fluid dynamics enabled
-.Fl ( F ) .
-.It Fl h
-Show usage information.
-.It Fl I Ar file-interval
-Simulation time interval between writing output to disk [s] (default
-1.0).
-.It Fl i Ar fluid-viscosity
-Fluid dynamic viscosity [Pa*s] (1.787e-3).
-Only relevant with fluid dynamics enabled
-.Fl ( F ) .
-.It Fl K Ar dilatancy-constant
-Factor relating dilatancy and shear stress [TODO] (default 1.0).
-Only relevant with transient granular dynamics enabled
-.Fl ( T ) .
-.It Fl k Ar fluid-permeability
-Darcian intrinsic permeability of granular material [m^2] (default
-1.9e-15).
-Only relevant with fluid dynamics enabled
-.Fl ( F ) .
-.It Fl L Ar length
-Simulation domain length [m] (default 1).
-.It Fl l Ar applied-shear-vel-limit
-Upper limit to modeled shear velocity [m/s] (default nan), overrides
-.Fl f
-and
-.Fl s .
-.It Fl m Ar grain-friction
-Grain friction coefficient [-] (default 0.404026).
-.It Fl N
-Normalize output velocities to the range [0;1].
-.It Fl n Ar normal-stress
-Normal stress applied at the top boundary [Pa] (default 120e3).
-.It Fl O Ar fluid-pressure-top
-Fluid pressure applied at the top boundary [Pa] (default 0).
-Only relevant with fluid dynamics enabled
-.Fl ( F ) .
-.It Fl o Ar origo
-Simulation domain origo [m] (default 0).
-.It Fl P Ar grain-compressibility
-Granular material compressibility [Pa^-1] (default 1e-8).
-.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).
-Only relevant with fluid dynamics enabled
-.Fl ( F ) .
-.It Fl R Ar fluid-density
-Fluid density [kg/m^3] (default 1000).
-Only relevant with fluid dynamics enabled
-.Fl ( F ) .
-.It Fl r Ar grain-density
-Granular material density [kg/m^3] (default 2600).
-.It Fl S Ar fluid-pressure-pulse-shape
-Shape of pulse perturbations in fluid pressure at the top boundary.
-Valid options are
-.Ar triangular
-(default) or
-.Ar square .
-Only relevant with fluid dynamics enabled
-.Fl ( F ) .
-.It Fl s Ar applied-shear-vel
-Shear the material under constant velocity [m/s] instead of a friction value.
-Overrides
-.Fl f
-and is overridden by
-.Fl l .
-.It Fl T
-Enable transient granular properties.
-.It Fl t Ar curr-time
-Simulation start time [s] (default 0).
-.It Fl U Ar resolution
-Numerical resolution of simulation domain [-] (default nan). If
-not set, the cell size equals the grain size.
-.It Fl u Ar fluid-pulse-time
-Time of fluid-pressure pulse peak [s] (default nan).
-Only relevant with fluid dynamics enabled
-.Fl ( F ) .
-.It Fl V Ar bot-vel
-shear velocity at base [m/s] (default 0).
-.It Fl v
-Show version information.
-.It Fl Y Ar max-porosity
-Granular material porosity [-] at inertia number I=1 in transient
-simulations
-.Fl ( T )
-(default 0.55).
-.It Fl y Ar min-porosity
-Minimum granular material porosity [-] in transient simulations
-.Fl ( T )
-(default 0.20).
-.Pp
-.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, with one
-row per cell in the simulation domain:
-.Pp
-.Bl -enum -compact
-.It
-position [m]
-.It
-shear velocity [m/s]
-.It
-effective normal stress [Pa]
-.It
-fluid pressure [Pa]
-.It
-friction [-]
-.It
-shear strain rate [-]
-.It
-porosity [-]
-.It
-inertia number [-]
-.It
-shear stress [Pa]
-.El
-.Sh FILES
-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
-.Sx OUTPUT FORMAT ,
-and output files are generated with the interval specified with
-.Fl I Ar file-interval .
-.Sh EXIT STATUS
-.Nm
-exits 0 on success, and >0 if a runtime error occurs:
-.Pp
-.Bl -tag -compact
-.It 0
-successful exit
-.It 1
-unspecified error
-.It 2
-.Xr pledge 2
-error (OpenBSD only)
-.It 10
-transient solver error
-.It 11
-fluid solver error
-.It 12
-granular solver error
-.It 20
-time step error
-.El
-.\" .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 max_depth_simple_shear 1
-.Xr shear_flux 1
-.Sh AUTHORS
-.An Anders Damsgaard Aq Mt anders@adamsgaard.dk
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-NAME = 1d_fd_simple_shear
+NAME = cngf-pf
VERSION = 0.6.0
PREFIX ?= /usr/local
@@ -11,11 +11,11 @@ HDR = \
fluid.h\
simulation.h
BIN = \
- 1d_fd_simple_shear\
+ cngf-pf\
max_depth_simple_shear\
shear_flux
MAN1 = \
- 1d_fd_simple_shear.1\
+ cngf-pf.1\
max_depth_simple_shear.1\
shear_flux.1
DOC = \
@@ -34,9 +34,9 @@ all: ${BIN}
.c.o: ${HDR}
${CC} ${HERE_CFLAGS} ${GLOBALCONST} -o $@ -c $<
-1d_fd_simple_shear: 1d_fd_simple_shear.o arrays.o fluid.o simulation.o
+cngf-pf: cngf-pf.o arrays.o fluid.o simulation.o
${CC} ${HERE_LDFLAGS}\
- 1d_fd_simple_shear.o arrays.o fluid.o simulation.o\
+ cngf-pf.o arrays.o fluid.o simulation.o\
-o $@
max_depth_simple_shear: max_depth_simple_shear.o arrays.o fluid.o simulation.o ${HDR}
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# 1d_fd_simple_shear
+# cngf-pf
This project contains a 1d implementation of the Henann and Kamrin
2013[1] model under simple shear, with various extensions such as
@@ -13,7 +13,7 @@ Run `make` and `make install` to install the programs and their man
pages.
## Usage
-See `man 1d_fd_simple_shear`, `man max_deformation_depth` and `man
+See `man cngf-pf`, `man max_deformation_depth` and `man
shear_flux` for usage information.
## Results
@@ -21,7 +21,7 @@ A preprint with model results is publically available[2].
## Author
Anders Damsgaard <anders@adamsgaard.dk>
-https://src.adamsgaard.dk/1d_fd_simple_shear
+https://src.adamsgaard.dk/cngf-pf
ISC licensed, see LICENSE for details.
## References
diff --git a/cngf-pf.1 b/cngf-pf.1
@@ -0,0 +1,262 @@
+.Dd $Mdocdate$
+.Dt CNGF-PF 1
+.Os
+.Sh NAME
+.Nm cngf-pf
+.Nd simulate granular flows with pore-pressure dynamics
+.\" .Sh LIBRARY
+.\" For sections 2, 3, and 9 only.
+.\" Not used in OpenBSD.
+.Sh SYNOPSIS
+.Nm
+.Op Fl A Ar grain-nonlocal-ampl
+.Op Fl a Ar fluid-pressure-ampl
+.Op Fl b Ar grain-rate-dependence
+.Op Fl C Ar fluid-compressibility
+.Op Fl c Ar grain-cohesion
+.Op Fl D Ar fluid-diffusivity
+.Op Fl d Ar grain-size
+.Op Fl e Ar end-time
+.Op Fl F
+.Op Fl f Ar applied-shear-friction
+.Op Fl g Ar gravity-accel
+.Op Fl H Ar fluid-pressure-phase
+.Op Fl h
+.Op Fl I Ar file-interval
+.Op Fl i Ar fluid-viscosity
+.Op Fl K Ar dilatancy-constant
+.Op Fl k Ar fluid-permeability
+.Op Fl L Ar length
+.Op Fl l Ar applied-shear-vel-limit
+.Op Fl m Ar grain-friction
+.Op Fl N
+.Op Fl n Ar normal-stress
+.Op Fl O Ar fluid-pressure-top
+.Op Fl o Ar origo
+.Op Fl P Ar grain-compressibility
+.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 S Ar fluid-pressure-pulse-shape
+.Op Fl s Ar applied-shear-vel
+.Op Fl T
+.Op Fl t Ar curr-time
+.Op Fl U Ar resolution
+.Op Fl u Ar fluid-pulse-time
+.Op Fl V Ar bot-vel
+.Op Fl v
+.Op Fl Y Ar max-porosity
+.Op Fl y Ar min-porosity
+.Op name
+.Sh DESCRIPTION
+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.
+.Pp
+The arguments are as follows:
+.Bl -tag -width Ds
+.It Fl A Ar grain-nonlocal-ampl
+Amplitude of granular non-locality [-] (default 0.4).
+.It Fl a Ar fluid-pressure-ampl
+Amplitude of fluid-pressure perturbations [Pa] (default 0).
+Only relevant with fluid dynamics enabled
+.Fl ( F ) .
+.It Fl b Ar grain-rate-dependence
+Granular rate dependence beyond yield [-], (default 0.9377).
+.It Fl C Ar fluid-compressibility
+Fluid adiabatic compressibility [Pa^-1] (default 3.9e-10).
+Only relevant with fluid dynamics enabled
+.Fl ( F ) .
+.It Fl c Ar grain-cohesion
+Granular material cohesion [Pa] (default 0).
+.It Fl D Ar fluid-diffusivity
+Fluid diffusion coefficient [m^2/s] (default -1). Overrides fluid
+permeability (-k), grain compressibility (-P), fluid compressibility
+(-C), and fluid viscosity (-i). Do not use for transient simulations
+(-T). Disabled when set to a negative value.
+.It Fl d Ar grain-size
+Granular material representative grain size [m] (default 0.04).
+.It Fl e Ar end-time
+Simulation end time [s] (default 1).
+.It Fl F
+Enable pore-space fluid dynamics.
+.It Fl f Ar applied-shear-friction
+Applied ratio between shear stress and normal stress at the top
+boundary [-] (default 0.45), overridden by
+.Fl s
+and
+.Fl l
+if these are set.
+.It Fl g Ar gravity-accel
+Gravity magnitude [m/s^2] (default 9.81).
+.It Fl H Ar fluid-pressure-phase
+Phase of fluid-pressure perturbations [s] (default 0).
+Only relevant with fluid dynamics enabled
+.Fl ( F ) .
+.It Fl h
+Show usage information.
+.It Fl I Ar file-interval
+Simulation time interval between writing output to disk [s] (default
+1.0).
+.It Fl i Ar fluid-viscosity
+Fluid dynamic viscosity [Pa*s] (1.787e-3).
+Only relevant with fluid dynamics enabled
+.Fl ( F ) .
+.It Fl K Ar dilatancy-constant
+Factor relating dilatancy and shear stress [TODO] (default 1.0).
+Only relevant with transient granular dynamics enabled
+.Fl ( T ) .
+.It Fl k Ar fluid-permeability
+Darcian intrinsic permeability of granular material [m^2] (default
+1.9e-15).
+Only relevant with fluid dynamics enabled
+.Fl ( F ) .
+.It Fl L Ar length
+Simulation domain length [m] (default 1).
+.It Fl l Ar applied-shear-vel-limit
+Upper limit to modeled shear velocity [m/s] (default nan), overrides
+.Fl f
+and
+.Fl s .
+.It Fl m Ar grain-friction
+Grain friction coefficient [-] (default 0.404026).
+.It Fl N
+Normalize output velocities to the range [0;1].
+.It Fl n Ar normal-stress
+Normal stress applied at the top boundary [Pa] (default 120e3).
+.It Fl O Ar fluid-pressure-top
+Fluid pressure applied at the top boundary [Pa] (default 0).
+Only relevant with fluid dynamics enabled
+.Fl ( F ) .
+.It Fl o Ar origo
+Simulation domain origo [m] (default 0).
+.It Fl P Ar grain-compressibility
+Granular material compressibility [Pa^-1] (default 1e-8).
+.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).
+Only relevant with fluid dynamics enabled
+.Fl ( F ) .
+.It Fl R Ar fluid-density
+Fluid density [kg/m^3] (default 1000).
+Only relevant with fluid dynamics enabled
+.Fl ( F ) .
+.It Fl r Ar grain-density
+Granular material density [kg/m^3] (default 2600).
+.It Fl S Ar fluid-pressure-pulse-shape
+Shape of pulse perturbations in fluid pressure at the top boundary.
+Valid options are
+.Ar triangular
+(default) or
+.Ar square .
+Only relevant with fluid dynamics enabled
+.Fl ( F ) .
+.It Fl s Ar applied-shear-vel
+Shear the material under constant velocity [m/s] instead of a friction value.
+Overrides
+.Fl f
+and is overridden by
+.Fl l .
+.It Fl T
+Enable transient granular properties.
+.It Fl t Ar curr-time
+Simulation start time [s] (default 0).
+.It Fl U Ar resolution
+Numerical resolution of simulation domain [-] (default nan). If
+not set, the cell size equals the grain size.
+.It Fl u Ar fluid-pulse-time
+Time of fluid-pressure pulse peak [s] (default nan).
+Only relevant with fluid dynamics enabled
+.Fl ( F ) .
+.It Fl V Ar bot-vel
+shear velocity at base [m/s] (default 0).
+.It Fl v
+Show version information.
+.It Fl Y Ar max-porosity
+Granular material porosity [-] at inertia number I=1 in transient
+simulations
+.Fl ( T )
+(default 0.55).
+.It Fl y Ar min-porosity
+Minimum granular material porosity [-] in transient simulations
+.Fl ( T )
+(default 0.20).
+.Pp
+.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, with one
+row per cell in the simulation domain:
+.Pp
+.Bl -enum -compact
+.It
+position [m]
+.It
+shear velocity [m/s]
+.It
+effective normal stress [Pa]
+.It
+fluid pressure [Pa]
+.It
+friction [-]
+.It
+shear strain rate [-]
+.It
+porosity [-]
+.It
+inertia number [-]
+.It
+shear stress [Pa]
+.El
+.Sh FILES
+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
+.Sx OUTPUT FORMAT ,
+and output files are generated with the interval specified with
+.Fl I Ar file-interval .
+.Sh EXIT STATUS
+.Nm
+exits 0 on success, and >0 if a runtime error occurs:
+.Pp
+.Bl -tag -compact
+.It 0
+successful exit
+.It 1
+unspecified error
+.It 2
+.Xr pledge 2
+error (OpenBSD only)
+.It 10
+transient solver error
+.It 11
+fluid solver error
+.It 12
+granular solver error
+.It 20
+time step error
+.El
+.\" .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 max_depth_simple_shear 1
+.Xr shear_flux 1
+.Sh AUTHORS
+.An Anders Damsgaard Aq Mt anders@adamsgaard.dk
diff --git a/1d_fd_simple_shear.c b/cngf-pf.c
diff --git a/max_depth_simple_shear.1 b/max_depth_simple_shear.1
@@ -29,7 +29,7 @@ the top. It is assumed that the granular layer has uniform thickness
and porosity.
.Pp
The arguments mirror the sister program
-.Xr 1d_fd_simple_shear 1
+.Xr cngf-pf 1
and are as follows:
.Bl -tag -width Ds
.It Fl a Ar fluid-pressure-ampl
@@ -92,7 +92,7 @@ skin depth vs. depth error
.It 11
no stress minima found in search range
.Sh SEE ALSO
-.Xr 1d_fd_simple_shear 1
+.Xr cngf-pf 1
.Xr shear_flux 1
.Sh AUTHORS
.An Anders Damsgaard Aq Mt anders@adamsgaard.dk
diff --git a/shear_flux.1 b/shear_flux.1
@@ -22,17 +22,17 @@ The output is the cumulative sediment flux with units square meters
per second (m^2/s).
.Sh EXAMPLES
The normal use is to pipe the output of
-.Xr 1d_fd_simple_shear 1
+.Xr cngf-pf 1
into
.Nm :
.Pp
-.Dl $ 1d_fd_simple_shear -n 10e3 | shear_flux
+.Dl $ cngf-pf -n 10e3 | shear_flux
.Dl 6.1943203051999493e-06
.Pp
-.Dl $ 1d_fd_simple_shear -n 100e3 | shear_flux
+.Dl $ cngf-pf -n 100e3 | shear_flux
.Dl 0.0010127845066767284
.Pp
-.Dl $ 1d_fd_simple_shear -F -e 600 -I 200 sim
+.Dl $ cngf-pf -F -e 600 -I 200 sim
.Dl $ shear_flux sim.output*.txt
.Dl 0.0017711059751388718
.Dl 0.0017971161104479135
@@ -48,7 +48,7 @@ unspecified error
.Xr pledge 2
error (OpenBSD only)
.Sh SEE ALSO
-.Xr 1d_fd_simple_shear 1
+.Xr cngf-pf 1
.Xr max_depth_simple_shear 1
.Sh AUTHORS
.An Anders Damsgaard Aq Mt anders@adamsgaard.dk
diff --git a/test/Makefile b/test/Makefile
@@ -1,4 +1,4 @@
-BIN = ../1d_fd_simple_shear
+BIN = ../cngf-pf
BIN2 = ../max_depth_simple_shear
BIN3 = ../shear_flux
