Changeset 2921

Timestamp:

May 19, 2006, 11:12:27 AM (19 years ago)

Author:

sexton

Message:

including references to new polygon things

File:

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

documentation/user_manual/anuga_user_manual.tex

@@ -2097 +2097 @@
   Module: \code{utilities.polygon}
 
+  \begin{funcdesc}{polygon_area}{polygon}
+  Module: \code{utilities.polygon}
+
+  Returns area of arbitrary polygon (reference http://mathworld.wolfram.com/PolygonArea.html)
   \end{funcdesc}
 
-
+  \begin{funcdesc}{plot_polygons}{polygons, figname, verbose = False}
+  Module: \code{utilities.polygon}
+
+  Plots each polygon contained in input polygon list, e.g. [poly1, poly2, poly3].
+ Each polygon is closed for plotting purposes and subsequent plot saved to figname.
+  Returns list containing the minimum and maximum of $x$ and $y$, 
+  i.e. [$x_{min}, x_{max}, y_{min}, y_{max}$].
+  \end{funcdesc}
 
 \section{coordinate_transforms}