Changeset 3076

Timestamp:

Jun 5, 2006, 12:40:52 PM (18 years ago)

Author:

howard

Message:

Added material on class Mesh to chap 4

File:

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

documentation/user_manual/anuga_user_manual.tex

@@ -83 +83 @@
 
 \begin{abstract}
-\label{abstract}
+\label{def:anuga}
 
 \noindent \anuga\index{\anuga} is a hydrodynamic modelling tool that
@@ -147 +147 @@
 requirements, as described in this manual, and to understand the
 basic terminology of object-oriented programming.
-
-\section{Structure of This Manual}
-
-FIXME (Ole): Isn't this superseded by the contents section?
-
-This manual is structured as follows:
-
-\begin{itemize}
-  \item Background (What \anuga does)
-  \item A \emph{Getting Started} section
-  \item A detailed description of the public interface
-  \item \anuga 's overall architecture, components and file formats
-  \item Assumptions
-\end{itemize}
-
 
 \pagebreak
@@ -1068 +1053 @@
 \section{Mesh Generation}
 \refmodindex[pmesh.meshinterface]{pmesh.mesh\_interface}\label{sec:meshgeneration}
+
+\begin{classdesc}  {Mesh}{userSegments=None,
+                 userVertices=None,
+                 holes=None,
+                 regions=None,
+                 geo_reference=None}
+Module: \module{pmesh.mesh}
+
+A class used to store a representation of a two-dimensional
+triangular mesh. The user may initialise the class by specifying
+lists of segments and/or vertices, using the parameters
+\code{userSegments} and \code{userVertices}, and may also specify
+lists of regions and/or holes, using the parameters \code{regions}
+and \code{holes}.
+\end{classdesc}
+
 \begin{funcdesc}  {create\_mesh\_from\_regions}{bounding_polygon,
                              boundary_tags,
@@ -1089 +1090 @@
 
 
-\begin{funcdesc}  {Mesh}{userSegments=None,
-                 userVertices=None,
-                 holes=None,
-                 regions=None,
-                 geo_reference=None}
-Module: \module{pmesh.mesh}
-
-% Translate following into layman's language
-An instance of the class \class{Mesh} is used to store .  This can
-then be used to build the outline of the mesh and then generate the
-mesh.
+\begin{funcdesc} {add_region}{}
+
+\end{funcdesc}
+
+\begin{funcdesc} {add_hole}{}
+
 \end{funcdesc}
 
@@ -1105 +1101 @@
 \begin{funcdesc}  {add_region_from_polygon}{self, polygon, tags=None,
                                 max_triangle_area=None, geo_reference=None}
-Module: \module{pmesh.mesh.Mesh}
+Module: \module{pmesh.mesh}  Class: \class{Mesh}
 
 % Translate following into layman's language
@@ -1176 +1172 @@
 Module: \refmodule{pyvolution.domain}
 
-
+This class is used to create an instance of a data structure used to
+store and manipulate data associated with a mesh. The mesh is
+specified either by assigning the name of a meshfile to
+\code{source} or by 
 \end{classdesc}
 
@@ -2198 +2197 @@
     file_name = None}
 
+
+
 Create instance from data points and associated attributes
 
@@ -2344 +2345 @@
 \chapter{Glossary}
 
-\begin{tabular}{|l|p{10cm}|c|}   \hline
+\begin{tabular}{|l p{10cm}| c|}  \hline
+    \emph{Term} & \emph{Definition} & \emph{Page}\\  \hline
+
     \indexedbold{\anuga} & Name of software (joint development between ANU and
-    GA) &\\
+    GA) & \pageref{def:anuga}\\
 
     \indexedbold{domain} & The domain of a function is the set of all input values to the
@@ -2403 +2406 @@
     z) &\\
 
-    \indexedbold{ymomentum}  & conserved quantity & \\ \hline
-
-    \end{tabular}
-
-    \begin{tabular}{|l|p{10cm}|c|}   \hline
+    \indexedbold{ymomentum}  & conserved quantity & \\
+
+
 
     \indexedbold{resolution} &  The maximal area of a triangular cell in a
@@ -2422 +2423 @@
 
     NOTE: More can be read in the module utilities/polygon.py .... &
-    \\
-
+    \\  \hline
+
+    \end{tabular}
+
+    \begin{tabular}{|l p{10cm}|c|}   \hline
+
+    \emph{Term} & \emph{Definition} & \emph{Page}\\  \hline
     \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