aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPaul Garlick <pgarlick@tourbillion-technology.com>2020-06-29 11:48:04 +0100
committerPaul Garlick <pgarlick@tourbillion-technology.com>2020-06-29 11:48:04 +0100
commit38c3e7b2e72371359e3b50c229556309c060b5c9 (patch)
tree00ae17213d2f72f3b22c89f4a44d075e21766c8d /doc
parenta7e6514dc6135d04a33e28fb1286fc7c1aa8cfae (diff)
downloadfullSWOF-utils-38c3e7b2e72371359e3b50c229556309c060b5c9.tar.gz
doc: Describe makeBoundary inputs and outputs.
* doc/fullswof-utils.texi (Invoking makeBoundary): Add 'Boundary Definition File' subsection.
Diffstat (limited to 'doc')
-rw-r--r--doc/fullswof-utils.texi32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/fullswof-utils.texi b/doc/fullswof-utils.texi
index 93da56b..fda74f3 100644
--- a/doc/fullswof-utils.texi
+++ b/doc/fullswof-utils.texi
@@ -211,6 +211,38 @@ and a discharge value are calculated for each cell along the boundary.
At grid cells where the calculated values are zero the wall boundary
condition, case 2, is applied.
+Each time @command{makeBoundary} runs it reads two input files and
+produces one output file. The first input file, named
+@file{topography.txt}, provides the height data. This file is also used
+by @emph{FullSWOF} to define the domain topography. The file may be
+saved in the current working directory or, alternatively, a symbolic
+link to a file in an external directory may be created. To create such
+a link use a command of the form:
+
+@example
+ln -s /path/to/topography/file topography.txt
+@end example
+
+The second input file is the @emph{boundary definition file}. This file
+specifies the boundary type, the global discharge across the boundary
+and the local gradient. Extra control parameters allow the global
+discharge to be split across separate regions. Surface roughness may be
+defined for the each region individually. @xref{Boundary Definition
+File} for details of the input parameters and the file format.
+
+@command{makeBoundary} generates an output file in the format required
+by the @emph{FullSWOF} solver. Depending on the value of the
+@option{boundary} command-line option, the filename of the output file
+is one of @file{BCTop.txt}, @file{BCBottom.txt}, @file{BCLeft.txt} or
+@file{BCRight.txt}.
+
+@menu
+* Boundary Definition File::
+@end menu
+
+@node Boundary Definition File, GNU Free Documentation License, Invoking makeBoundary, Invoking makeBoundary
+@comment node-name, next, previous, up
+@subsection Boundary Definition File
@node GNU Free Documentation License, Index, Usage, Top
@appendix GNU Free Documentation License