Changeset 5288 for anuga_core/documentation/user_manual/anuga_user_manual.tex

Timestamp:

May 7, 2008, 4:01:52 PM (15 years ago)

Author:

ole

Message:

Implemeted and tested ticket:175 - flow_through_cross_section.
Also updated manual

File:

• anuga_core/documentation/user_manual/anuga_user_manual.tex (modified) (1 diff)

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -2580 +2580 @@
   See doc string for general function sww2timeseries for details.
 
+\end{funcdesc}
+
+
+\begin{funcdesc}{get\_flow\_through\_cross\_section}{filename, cross\_section, verbose=False}
+  Module: \module{shallow\_water.data\_manager}
+
+  Obtain flow $[m^2]$ perpendicular to specified cross section.
+
+  Inputs:
+  \begin{itemize} 
+        \item filename: Name of sww file containing ANUGA model output.
+        \item polyline: Representation of desired cross section - it may contain multiple
+          sections allowing for complex shapes. Assume absolute UTM coordinates.
+  \end{itemize} 
+
+  Output:
+  \begin{itemize}
+    \item time: All stored times in sww file
+    \item Q: Hydrograph of total flow across given segments for all stored times.
+  \end{itemize} 
+  
+  The normal flow is computed for each triangle intersected by the polyline and
+  added up.  Multiple segments at different angles are specified the normal flows
+  may partially cancel each other.
+  
+  Example to find flow through cross section:
+  
+  \begin{verbatim}  
+  cross_section = [[x, 0], [x, width]]
+  time, Q = get_flow_through_cross_section(filename,
+                                           cross_section,
+                                           verbose=False)
+  \end{verbatim} 
+
+
+  See doc string for general function get_maximum_inundation_data for details.
+  
 \end{funcdesc}