Changeset 2693

Timestamp:

Apr 11, 2006, 2:32:10 PM (19 years ago)

Author:

duncan

Message:

added mesh stuff to the user interface

File:

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

documentation/user_manual/anuga_user_manual.tex

@@ -907 +907 @@
 the user specifies a list of boundary tags, one for each edge of the bounding
 polygon.
+\end{funcdesc}
+
+
+\begin{funcdesc}  {Mesh}{}
+Module: \code{pmesh.mesh}
+
+% Translate following into layman's language
+This function is used to create a Mesh instance.  This can then be
+used to build the outline of the mesh and then generate the
+mesh.
+\end{funcdesc}
+
+
+\begin{funcdesc}  {add_region_from_polygon}{self, polygon, tags=None,
+                                max_triangle_area=None, geo_reference=None}
+Module: \code{pmesh.mesh.Mesh}
+
+% Translate following into layman's language
+This method is used to add a region to a Mesh instance.  The region is
+described by the polygon passed in.  Additionally,
+the user specifies a list of boundary tags, one for each edge of the bounding
+polygon.
+\end{funcdesc}
+
+\begin{funcdesc}  {add_hole_from_polygon}{self, polygon, tags=None,
+    geo_reference=None}
+Module: \code{pmesh.mesh.Mesh}
+
+% Translate following into layman's language
+This method is used to add a region where the triagular mesh will not
+be generated to a Mesh instance.  The region is
+described by the polygon passed in.  Additionally,
+the user specifies a list of boundary tags, one for each edge of the bounding
+polygon.
+\end{funcdesc}
+
+\begin{funcdesc}  {generate_mesh}{self,
+                      maximum_triangle_area=None,
+                      minimum_triangle_angle=28.0,
+                      verbose=False}
+Module: \code{pmesh.mesh.Mesh}
+
+% Translate following into layman's language
+This method is used to generate the triagular mesh.  The  maximal area
+of any triangle in the mesh can be specified, along with the minimum
+angle of all triagles.
+\end{funcdesc}
+
+
+\begin{funcdesc}  {export_mesh_file}{self,ofile}
+Module: \code{pmesh.mesh.Mesh}
+
+% Translate following into layman's language
+This method is used to save the mesh to a file. \code{ofile} is the name of the mesh file to be writen,
+including the extension.  Use the extension \code{.msh} for the file to
+be in NetCDF format and \code{.tsh} for the file to be ASCII format.
 \end{funcdesc}