aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPaul Garlick <pgarlick@tourbillion-technology.com>2020-07-24 16:07:02 +0100
committerPaul Garlick <pgarlick@tourbillion-technology.com>2020-07-24 16:07:02 +0100
commitb303568368aa9657a7b238d7fd53337eff22b4bd (patch)
treebbbef36f51c1b38f6617b8bae00d843bcacada0d /doc
parent330f1cdb6bd2ce49422f6ef2a08701fed08cc30a (diff)
downloadfullSWOF-utils-b303568368aa9657a7b238d7fd53337eff22b4bd.tar.gz
doc: Add example rating curve.
* doc/fullswof-utils.texi (Theory): Add figure. * images/rating_curve.png: New file.
Diffstat (limited to 'doc')
-rw-r--r--doc/fullswof-utils.texi17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/fullswof-utils.texi b/doc/fullswof-utils.texi
index b98e587..d00e999 100644
--- a/doc/fullswof-utils.texi
+++ b/doc/fullswof-utils.texi
@@ -438,6 +438,23 @@ are calculated. From these values the hydraulic radius is calculated,
allowing the conveyance to be determined. Finally, the discharge is
calculated from the conveyance.
+@float Figure,ratingCurve
+ @image{./images/rating_curve}
+ @caption{Rating curve for the right hand panel of the top boundary.}
+@end float
+
+An example rating curve is shown in @ref{ratingCurve}. The data for
+this curve was generated from the topography and boundary definition
+file provided in the @file{demo} directory.
+
+Together, the rating curves establish the connection between water level
+and discharge at the boundary. The @emph{makeBoundary} program
+identifies the panels that are filled and the panel that is part-filled.
+The discharge in the part-filled panel is set so that the sum of the
+discharge values is equal to the target flow. The last step is to
+interpolate the water level from the rating curve of the part-filled
+panel.
+
@node Demos, GNU Free Documentation License, Boundary Definition File, Top
@comment node-name, next, previous, up
@chapter Demos