doc: Describe makeBoundary control parameters.

* doc/fullswof-utils.texi (Boundary Definition File): Add description of
parameters.

1 files changed, 49 insertions, 0 deletions

diff --git a/doc/fullswof-utils.texi b/doc/fullswof-utils.texi
index fda74f3..1132a86 100644
--- a/doc/fullswof-utils.texi
+++ b/doc/fullswof-utils.texi
@@ -244,6 +244,55 @@ is one of @file{BCTop.txt}, @file{BCBottom.txt}, @file{BCLeft.txt} or
 @comment  node-name,  next,  previous,  up
 @subsection Boundary Definition File
 
+The @emph{boundary definition file} contains a list of parameters that
+control the operation of the @emph{makeBoundary} program.  The
+parameters are defined in the file as a sequence of ``key-value'' pairs.
+The key is the name of the variable.  Each key has an associated value.
+Each value is either a boolean (``True'' or ``False'') signifier, an
+integer or floating point number, or a list of integers or floating
+point numbers.  Keys and values are defined on the same line, separated
+by a colon.
+
+The keys are defined as follows:
+
+@table @asis
+@item type
+boundary type (1=imposed height, 2=wall, 3=Neumann, 4=periodic,
+5=imposed discharge)
+
+@item plotting
+enable plotting (True or False)
+
+@item printing
+enable printing (True or False)
+
+@item slope
+local gradient
+
+@item target_flow
+imposed discharge (flow across boundary /@math{m@sup{3}/s})
+
+@item markers
+panel marker co-ordinates (comma-separated list of distances /m)
+
+@item panel
+fill order (comma-separated list of panel indices)
+
+@item ztol
+channel overtopping tolerance (/m)
+
+@item n_co
+Manning's n coefficients (comma-separated list, ordered by panel index)
+
+@item numH
+number of height intervals
+@end table
+
+
+
+Comment lines are allowed in the boundary definition file.  Lines that
+start with the @samp{#} character are treated as comments.
+
 @node GNU Free Documentation License, Index, Usage, Top
 @appendix GNU Free Documentation License
 @include fdl-1.3.texi