From 64ccc0517bd3145a95e9d9415d734f5e0e2adbdd Mon Sep 17 00:00:00 2001 From: Paul Garlick Date: Fri, 25 Feb 2022 12:58:49 +0000 Subject: doc: Describe usage of the specificPoints.py script. * doc/fullswof-utils.texi: Add section. --- doc/fullswof-utils.texi | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) 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 -- cgit