aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPaul Garlick <pgarlick@tourbillion-technology.com>2022-02-25 12:58:49 +0000
committerPaul Garlick <pgarlick@tourbillion-technology.com>2022-02-25 12:58:49 +0000
commit64ccc0517bd3145a95e9d9415d734f5e0e2adbdd (patch)
tree3ca9fd52b227bf50e3aa1623f98cc5a8d9493c83 /doc
parent7d012e660a7bd41c25bc451d52239a6c342aef4a (diff)
downloadfullSWOF-utils-master.tar.gz
doc: Describe usage of the specificPoints.py script.HEADmaster
* doc/fullswof-utils.texi: Add section.
Diffstat (limited to 'doc')
-rw-r--r--doc/fullswof-utils.texi26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/fullswof-utils.texi b/doc/fullswof-utils.texi
index dec31dd..c0d978c 100644
--- a/doc/fullswof-utils.texi
+++ b/doc/fullswof-utils.texi
@@ -173,6 +173,7 @@ ln -s /path/to/installation/directory/fullswof-utils/makeBoundary
* Invoking boundaryProfile.py::
* Invoking makeBoundary::
* Invoking slope.py::
+* Invoking specificPoints.py::
@end menu
@@ -434,6 +435,31 @@ format.
Quit @command{slope.py}.
@end table
+@node Invoking specificPoints.py, Theory, Invoking slope.py, Usage
+@comment node-name, next, previous, up
+@section Invoking @command{specificPoints.py}
+
+After the solution procedure has finished the
+@command{specificPoints.py} script may be used to display the
+convergence history. The script may also be used to monitor the
+computation while it is underway.
+
+The script reads the @file{hu_specific_points.dat} file. This file
+contains the solution variables sampled at the monitoring point. The
+location of the monitoring point is specified in the
+@file{Inputs/parameters.txt} file.
+
+The script is executed from the @file{Outputs} directory. The
+command-line syntax is:
+
+@example
+./specificPoints.py
+@end example
+
+Water elevation at the monitoring point is plotted against simulated
+time. In order to re-read the file and update the plot press the
+@kbd{x} key.
+
@node Theory, Demos, Invoking slope.py, Top
@comment node-name, next, previous, up
@chapter Theory