Changeset 4736

Timestamp:

Sep 24, 2007, 10:58:21 AM (18 years ago)

Author:

duncan

Message:

remove references to pmesh as the name for the graphical mesh generator.

File:

• anuga_core/documentation/user_manual/anuga_user_manual.tex (modified) (8 diffs)

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -106 +106 @@
 governing equation using a finite-volume method.
 
-\anuga also incorporates a mesh generator %, called \code{pmesh},
+\anuga also incorporates a mesh generator %, called \code{graphical
+                                %mesh generator},
 that
 allows the user to set up the geometry of the problem interactively as
@@ -930 +931 @@
 rectangular grid, the technique used for this example involves
 building mesh structures inside polygons specified by the user,
-using a mesh-generator referred to as \code{pmesh}.
-
-In its simplest form, \code{pmesh} creates the mesh within a single
+using a mesh-generator.
+
+In its simplest form, the mesh-generator creates the mesh within a single
 polygon whose vertices are at geographical locations specified by
 the user. The user specifies the \emph{resolution}---that is, the
@@ -954 +955 @@
 tags appropriate to the configuration being modelled.
 
-In addition, \code{pmesh} provides a way to adapt to geographic or
+In addition, the mesh-generator provides a way to adapt to geographic or
 other features in the landscape, whose presence may require an
 increase in resolution. This is done by allowing the user to specify
@@ -967 +968 @@
 %\end{figure}
 
-In its general form, \code{pmesh} takes for its input a bounding
+In its general form, the mesh-generator takes for its input a bounding
 polygon and (optionally) a list of interior polygons. The user
 specifies resolutions, both for the bounding polygon and for each of
-the interior polygons. Given this data, \code{pmesh} first creates a
+the interior polygons. Given this data, the mesh-generator first creates a
 triangular mesh with varying resolution.
 
@@ -1514 +1515 @@
 (maximal area for any triangle in the mesh) and the minimal angle
 allowable in any triangle. The user can specify a number of internal
-polygons within each of which a separate mesh is to be created,
-generally with a smaller resolution. \code{interior_regions} is a
-paired list containing the interior polygon and its resolution.
-Additionally, the user specifies a list of boundary tags, one for
-each edge of the bounding polygon.
+polygons within each of which the resolution of the mesh can be
+specified. \code{interior_regions} is a paired list containing the
+interior polygon and its resolution.  Additionally, the user specifies
+a list of boundary tags, one for each edge of the bounding polygon.
 
 \textbf{WARNING}. Note that the dictionary structure used for the
@@ -1958 +1958 @@
 This function is used to assign values to individual quantities given
 a regional tag.   It is similar to \code{set\_quantity}.
-For example, if in pmesh a regional tag of 'ditch' was
+For example, if in the mesh-generator a regional tag of 'ditch' was
 used, set\_region can be used to set elevation of this region to
 -10m. X is the constant or function to be applied to the quantity,
@@ -3605 +3605 @@
 
 
-\section{pmesh GUI}
+\section{Graphical Mesh Generator GUI}
 The program \code{graphical\_mesh\_generator.py} in the pmesh module 
 allows the user to set up the mesh of the problem interactively.
@@ -3611 +3611 @@
 automatically generated.
 
-Pmesh will let the user select various modes. The current allowable
-modes are vertex, segment, hole or region.  The mode describes what
-sort of object is added or selected in response to mouse clicks.  When
-changing modes any prior selected objects become deselected.
+Graphical Mesh Generator will let the user select various modes. The
+current allowable modes are vertex, segment, hole or region.  The mode
+describes what sort of object is added or selected in response to
+mouse clicks.  When changing modes any prior selected objects become
+deselected.
 
 In general the left mouse button will add an object and the right