Changeset 3061

Timestamp:

Jun 2, 2006, 4:57:45 PM (18 years ago)

Author:

howard

Message:

Corrected further small errors and added material on polygons

File:

• documentation/user_manual/anuga_user_manual.tex (modified) (11 diffs)

documentation/user_manual/anuga_user_manual.tex

@@ -774 +774 @@
 the user to specify a number of \emph{interior polygons}, which are
 triangulated separately, each according to a separately specified
-resolution. See Figure \ref{fig:interior meshes}.
+resolution. See Figure \ref{fig:interior meshes}. It is also
+possible to specify one or more `holes'---that is, areas bounded by
+polygons in which no triangulation is required.
 
 \begin{figure}[hbt]
@@ -1149 +1151 @@
 
 %%%%%%
-\section{Initialising Domain}
+\section{Initialising the Domain}
+
+%Include description of the class Domain and the module domain.
+
+\declaremodule{standard}{pyvolution.domain}
+
+\begin{classdesc} {Domain} {source=None,
+                 triangles=None,
+                 boundary=None,
+                 conserved_quantities=None,
+                 other_quantities=None,
+                 tagged_elements=None,
+                 geo_reference=None,
+                 use_inscribed_circle=False,
+                 mesh_filename=None,
+                 use_cache=False,
+                 verbose=False,
+                 full_send_dict=None,
+                 ghost_recv_dict=None,
+                 processor=0,
+                 numproc=1}
+Module: \refmodule{pyvolution.domain}
+
+
+\end{classdesc}
 
 \begin{funcdesc}  {pmesh\_to\_domain\_instance}{file_name, DomainClass, use_cache = False, verbose = False}
@@ -1376 +1402 @@
 
 %%%
-\begin{funcdesc}{set\_region}{functions}
-[Low priority. Will be merged into set\_quantity]
-
-Module:\module{pyvolution.domain}
-\end{funcdesc}
+%\begin{funcdesc}{set\_region}{functions}
+%[Low priority. Will be merged into set\_quantity]
+
+%Module:\module{pyvolution.domain}
+%\end{funcdesc}
 
 
@@ -1944 +1970 @@
   If the function definition changes after a result has been cached, this will be
   detected by examining the functions \code{bytecode (co_code, co_consts,
-  func_defualts, co_argcount)} and the function will be recomputed.
+  func_defaults, co_argcount)} and the function will be recomputed.
 
   Options are set by means of the function \code{set_option(key, value)},
@@ -2044 +2070 @@
 \section{utilities/polygons}
 
+  \declaremodule{standard}{utilities.polygon}
+  \refmodindex{utilities.polygon}
+
   \begin{classdesc}{Polygon_function}{regions, default = 0.0, geo_reference = None}
   Module: \code{utilities.polygon}
 
   Creates a callable object that returns one of a specified list of values when
-  evaluated at a point, depending on which polygon, from a specified list of polygons, the
+  evaluated at a point \code{x, y}, depending on which polygon, from a specified list of polygons, the
   point belongs to. The parameter \code{regions} is a list of pairs
   \code{(P, v)}, where each \code{P} is a polygon and each \code{v}
@@ -2057 +2086 @@
   point lies in more than one polygon, the return value is taken to
   be the value for whichever of these polygon appears later in the
-  list. 
-  [ CAN WE ALSO CALL IT AT A VECTOR x, y (WHERE x, y ARE LISTS)? ]
+  list.
+  %FIXME (Howard): CAN x, y BE VECTORS?
+
   \end{classdesc}
 
@@ -2087 +2117 @@
   Module: \code{utilities.polygon}
 
-  Used to test whether a single point---or the members of a list of points---
-  are inside the specified polygon. If the first argument is a single point,
-  returns \code{True} if the point is inside the polygon, or \code{False}
-  otherwise. If the first argument is a list of points, returns a Numeric
+  Used to test whether the members of a list of points
+  are inside the specified polygon. Returns a Numeric
   array comprising the indices of the points in the list that lie inside the polygon.
   (If none of the points are inside, returns \code{zeros((0,), 'l')}.)
@@ -2103 +2131 @@
   \end{funcdesc}
 
+  \begin{funcdesc}{is_inside_polygon}{point, polygon, closed=True, verbose=False}
+  Module: \code{utilities.polygon}
+
+  Returns \code{True} if \code{point} is inside \code{polygon} or
+  \code{False} otherwise. Points on the edges of the polygon are regarded as inside if
+  \code{closed} is set to \code{True} or omitted; otherwise they are regarded as outside.
+  \end{funcdesc}
+
+  \begin{funcdesc}{is_outside_polygon}{point, polygon, closed=True, verbose=False}
+  Module: \code{utilities.polygon}
+
+  Exactly like \code{is_outside_polygon}, but with the words `inside' and `outside' interchanged.
+  \end{funcdesc}
+
   \begin{funcdesc}{point_on_line}{x, y, x0, y0, x1, y1}
   Module: \code{utilities.polygon}
@@ -2132 +2174 @@
 \section{coordinate_transforms}
 
-\section{geo_spatial_data}
+\section{geospatial_data}
 
 This describes a class that represents arbitrary point data in UTM
 coordinates along with named attribute values.
 
-TBA
+\declaremodule{geospatial_data}
+
+\begin{classdesc}{Geospatial_data}{data_points = None,
+                 attributes = None,
+                 geo_reference = None,
+                 default_attribute_name = None,
+                 file_name = None}
+
+Create instance from data points and associated attributes
+
+
+        data_points: x,y coordinates in metres. Type must be either a
+        sequence of 2-tuples or an Mx2 Numeric array of floats.
+
+        attributes: Associated values for each data point. The type
+        must be either a list or an array of length M or a dictionary
+        of lists (or arrays) of length M. In the latter case the keys
+        in the dictionary represent the attribute names, in the former
+        the attribute will get the default name 'attribute'.
+
+        geo_reference: Object representing the origin of the data
+        points. It contains UTM zone, easting and northing and data
+        points are assumed to be relative to this origin.
+        If geo_reference is None, the default geo ref object is used
+
+        default_attribute_name: Name of default attribute to be used with
+        get_attribute_values. The idea is that the dataset can be
+        equipped with information about which attribute to return.
+        If None, the default is the 'first'
+
+        file_name: Name of input NetCDF file or xya file. NetCDF file must
+        have dimensions "points" etc.
+        XYA file is a CVS file with lats(x), longs(y) and elevation(a).
+        first line must be attribute name eg elevation
+
+\end{classdesc}
 
 \section{pmesh GUI}
@@ -2256 +2333 @@
 \chapter{Glossary}
 
-\begin{itemize}
-    \item \indexedbold{\anuga} Name of software (joint development between ANU and GA)
-
-    \item \indexedbold{domain} The domain of a function is the set of all input values to the function.
-
-    \item \indexedbold{Dirichlet boundary} - A Dirichlet boundary condition imposed on a differential equation
- which specifies the values the solution is to take on the boundary of the domain.
-
-    \item \indexedbold{elevation} - refers to bathymetry and topography
-
-    \item \indexedbold{bathymetry} - offshore elevation
-
-    \item \indexedbold{topography} - onshore elevation
-
-    \item \indexedbold{evolution} - integration of the shallow water wave equations over time
-
-    \item \indexedbold{forcing term}
-
-    \item \indexedbold{IDLE} - Development environment shipped with Python
-
-    \item \indexedbold{Manning friction coefficient}
-
-    \item \indexedbold{mesh}    - Triangulation of domain
-
-    \item \indexedbold{meshfile}  [generic word for either .tsh or
-    .msh file]
-
-    \item \indexedbold{points file}  [generic word for either .pts or
-    .xya file]
-
-    \item \indexedbold{grid} - evenly spaced mesh
-
-    \item \indexedbold{NetCDF}
-
-    \item \indexedbold{pmesh} does this really need to be here? it's a class/module?
-
-    \item \indexedbold{pyvolution} does this really need to be here? it's a class/module?
-
-    \item \indexedbold{conserved quantity} conserved (stage, x and y momentum)
-
-    \item \indexedbold{reflective boundary}
-
-    \item \indexedbold{smoothing} is this really needed?
-
-    \item \indexedbold{stage}
-
-%    \item \indexedbold{try this}
-
-    \item \indexedbold{swollen} - visualisation tool
-
-    \item \indexedbold{time boundary} - defined in the manual (flog from there)
-
-    \item \indexedbold{transmissive boundary} - defined in the manual (flog from there)
-
-    \item \indexedbold{xmomentum} - conserved quantity (note, two-dimensional SWW equations say only x and y and NOT z)
-
-    \item \indexedbold{ymomentum}  - conserved quantity
-
-    \item \indexedbold{resolution} -  The maximal area of a triangular cell in a mesh
-
-    \item \indexedbold{polygon} - A sequence of points in the plane. (Arbitrary polygons can be created
+\begin{tabular}{|l|p{4cm}|c|}   \hline
+    \indexedbold{\anuga} & Name of software (joint development between ANU and
+    GA) &\\
+
+    \indexedbold{domain} & The domain of a function is the set of all input values to the
+    function.&\\
+
+    \indexedbold{Dirichlet boundary} & A Dirichlet boundary condition imposed on a differential equation
+ which specifies the values the solution is to take on the boundary of the
+ domain.&\\
+
+    \indexedbold{elevation} & refers to bathymetry and topography&\\
+
+    \indexedbold{bathymetry} & offshore elevation &\\
+
+    \indexedbold{topography} & onshore elevation &\\
+
+    \indexedbold{evolution} & integration of the shallow water wave equations
+    over time &\\
+
+    \indexedbold{forcing term} & &\\
+
+    \indexedbold{IDLE} & Development environment shipped with
+    Python &\\
+
+    \indexedbold{Manning friction coefficient} & &\\
+
+    \indexedbold{mesh} & Triangulation of domain & &\\
+
+    \indexedbold{meshfile} & [generic word for either .tsh or
+    .msh file] & \\
+
+    \indexedbold{points file} & [generic word for either .pts or
+    .xya file] & \\
+
+    \indexedbold{grid} & evenly spaced mesh & \\
+
+    \indexedbold{NetCDF} & &\\
+
+    \indexedbold{conserved quantity} & conserved (stage, x and y
+    momentum) & \\
+
+    \indexedbold{reflective boundary} & &\\
+
+    \indexedbold{stage} & &\\
+
+%    \indexedbold{try this}
+
+    \indexedbold{swollen} & visualisation tool &\\
+
+    \indexedbold{time boundary} & defined in the manual (flog from
+    there)&\\
+
+    \indexedbold{transmissive boundary} & defined in the manual (flog from
+    there)&\\
+
+    \indexedbold{xmomentum} & conserved quantity (note, two-dimensional SWW equations say only x and y and NOT
+    z) &\\
+
+    \indexedbold{ymomentum}  & conserved quantity & \\
+
+    \indexedbold{resolution} &  The maximal area of a triangular cell in a
+    mesh & \\
+
+    \indexedbold{polygon} & A sequence of points in the plane. (Arbitrary polygons can be created
     in this way.)
     \anuga represents a polygon in one of two ways. One way is to represent it as a
@@ -2325 +2406 @@
     $N \times 2$ Numeric array, where $N$ is the number of points.
 
-    NOTE: More can be read in the module utilities/polygon.py ....
-
-    \item \indexedbold{easting} - A rectangular (x,y) coordinate measurement of distance east from a north-south reference line,
-usually a meridian used as the axis of origin within a map zone or projection. Easting is a UTM (Universal Transverse Mercator) Coordinate.
-
-    \item \indexedbold{northing} - A rectangular (x,y) coordinate measurement of distance north from a north-south reference line,
-usually a meridian used as the axis of origin within a map zone or projection. Northing is a UTM (Universal Transverse Mercator) Coordinate.
-
-
-    \item \indexedbold{latitude} - The angular distance on a mericlear north and south of the equator, expressed in degrees and minutes.
-
-    \item \indexedbold{longitude} - The angular distance east or west, between the meridian of a particular place on Earth and that of the
-Prime Meridian (located in Greenwich, England) expressed in degrees or time.
-
-    \item \indexedbold{edge} - A triangular cell within the computational mesh can be depicted as a set of vertices joined by lines (the edges).
-
-    \item \indexedbold{vertex} - A point at which edges meet.
-
-    \item \indexedbold{finite volume} - The method evaluates the terms in the shallow water wave equation as fluxes at the surfaces of each
-finite volume. Because the flux entering a given volume is identical to that leaving the adjacent volume, these methods are conservative.
-Another advantage of the finite volume method is that it is easily formulated to allow for unstructured meshes.
-The method is used in many computational fluid dynamics packages.
-
-
-    \item \indexedbold{flux} - the amount of flow through the volume per unit time
-
-    \item \indexedbold{Digital Elevation Model (DEM)} - DEMs are digital files consisting of points of elevations,
-sampled systematically at equally spaced intervals.
-
-
-\end{itemize}
+    NOTE: More can be read in the module utilities/polygon.py .... &
+    \\
+
+    \indexedbold{easting} & A rectangular (x,y) coordinate measurement of distance east from a north-south reference line,
+usually a meridian used as the axis of origin within a map zone or
+projection. Easting is a UTM (Universal Transverse Mercator)
+Coordinate. & \\
+
+    \indexedbold{northing} & A rectangular (x,y) coordinate measurement of distance north from a north-south reference line,
+usually a meridian used as the axis of origin within a map zone or
+projection. Northing is a UTM (Universal Transverse Mercator)
+Coordinate. & \\
+
+
+    \indexedbold{latitude} & The angular distance on a mericlear north and south of the equator, expressed in degrees and
+    minutes. & \\
+
+    \indexedbold{longitude} & The angular distance east or west, between the meridian of a particular place on Earth and that of the
+Prime Meridian (located in Greenwich, England) expressed in degrees
+or time.& \\
+
+    \indexedbold{edge} & A triangular cell within the computational mesh can be depicted as a set of vertices joined by lines (the
+    edges). & \\
+
+    \indexedbold{vertex} & A point at which edges meet. & \\
+
+    \indexedbold{finite volume} & The method evaluates the terms in the shallow water wave equation as fluxes at the surfaces of each
+finite volume. Because the flux entering a given volume is identical
+to that leaving the adjacent volume, these methods are conservative.
+Another advantage of the finite volume method is that it is easily
+formulated to allow for unstructured meshes. The method is used in
+many computational fluid dynamics packages. & \\
+
+
+    \indexedbold{flux} & the amount of flow through the volume per unit
+    time & \\
+
+    \indexedbold{Digital Elevation Model (DEM)} & DEMs are digital files consisting of points of elevations,
+sampled systematically at equally spaced intervals.& \\  \hline
+
+
+\end{tabular}
 
 %The \code{\e appendix} markup need not be repeated for additional