aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/fullswof-utils.texi41
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/fullswof-utils.texi b/doc/fullswof-utils.texi
index 0cac4a5..93da56b 100644
--- a/doc/fullswof-utils.texi
+++ b/doc/fullswof-utils.texi
@@ -145,6 +145,7 @@ ln -s /path/to/installation/directory/python/makeBoundary
@menu
* Runtime Dependencies::
+* Invoking makeBoundary::
@end menu
@@ -171,6 +172,46 @@ computation.
@end enumerate
@end table
+@node Invoking makeBoundary, , Runtime Dependencies, Usage
+@comment node-name, next, previous, up
+@section Invoking @command{makeBoundary}
+
+The @command{makeBoundary} program creates boundary condition files for
+the @emph{FullSWOF} solver. The command-line syntax is:
+
+@example
+makeBoundary @option{boundary}
+@end example
+
+where @option{boundary} is one of @code{top}, @code{bottom}, @code{left}
+and @code{right}.
+
+There are five types of boundary condition that are recognised by the
+solver:
+
+@table @asis
+@item case 1
+imposed height condition
+
+@item case 2
+wall condition
+
+@item case 3
+Neumann condition
+
+@item case 4
+periodic condition
+
+@item case 5
+imposed discharge condition
+@end table
+
+Cases 1 and 5 are implemented in @emph{makeBoundary}. A height value
+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.
+
+
@node GNU Free Documentation License, Index, Usage, Top
@appendix GNU Free Documentation License
@include fdl-1.3.texi