Changeset 5673 for anuga_core/documentation/user_manual/anuga_user_manual.tex

Timestamp:

Aug 22, 2008, 11:56:30 AM (16 years ago)

Author:

duncan

Message:

update to add_points_and_segments

File:

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

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -1468 +1468 @@
 
 
-The variables \code{points}, \code{vertices} and \code{boundary}
+The variables \code{points}, \code{triangles} and \code{boundary}
 represent the data displayed in Figure \ref{fig:simplemesh} as
 follows. The list \code{points} stores the coordinates of the
@@ -1498 +1498 @@
 \end{table}
 
-The list \code{vertices} specifies the triangles that make up the
+The list \code{triangles} specifies the triangles that make up the
 mesh. It does this by specifying, for each triangle, the indices
 (the numbers shown in the first column above) that correspond to the
-three points at its vertices, taken in an anti-clockwise order
+three points at the triangles vertices, taken in an anti-clockwise order
 around the triangle. Thus, in the example shown in Figure
-\ref{fig:simplemesh}, the variable \code{vertices} contains the
-entries shown in Table \ref{tab:vertices}. The starting point is
+\ref{fig:simplemesh}, the variable \code{triangles} contains the
+entries shown in Table \ref{tab:triangles}. The starting point is
 arbitrary so triangle $(0,1,3)$ is considered the same as $(1,3,0)$
 and $(3,0,1)$.
@@ -1512 +1512 @@
   \begin{center}
     \begin{tabular}{|c|ccc|} \hline
-      index & \multicolumn{3}{c|}{\code{vertices}}\\ \hline
+      index & \multicolumn{3}{c|}{\code{points}}\\ \hline
       0 & 0 & 1 & 3\\
       1 & 1 & 2 & 4\\
@@ -1526 +1526 @@
   \end{center}
 
-  \caption{Vertices for mesh in Figure \protect \ref{fig:simplemesh}}
-  \label{tab:vertices}
+  \caption{Triangles for mesh in Figure \protect \ref{fig:simplemesh}}
+  \label{tab:triangles}
 \end{table}
 
@@ -1626 +1626 @@
 
 This method is used to build the mesh outline. It adds points and
-segments connecting the points.  A tag for each segment can optionally
-be added.
+segments connecting the points.  Points is a list of points. Segments
+is a list of segments.  Each segment is defined by the start and end
+of the line by it's point index, e.g. use \code{segments =
+[[0,1],[1,2]]} to make a polyline between points 0, 1 and 2. A tag for
+each segment can optionally be added.
 
 \end{methoddesc}