Changeset 2782

Timestamp:

Apr 28, 2006, 4:55:46 PM (19 years ago)

Author:

howard

Message:

Continued adding material on file formats and conversions to Ch 5

File:

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

documentation/user_manual/anuga_user_manual.tex

@@ -162 +162 @@
 
 \chapter{Getting Started}
+\label{ch:getstarted}
 
 This section is designed to assist the reader to get started with
@@ -1473 +1474 @@
 \end{center}
 
+The above table shows the file extensions used to identify the
+formats of files. However, typically, in referring to a format we
+capitalise the extension and omit the initial full stop---thus, we
+refer, for example, to `SWW files' or `PRJ files'.
+
 \bigskip
 
@@ -1513 +1519 @@
 importance for \anuga.
 
-An SWW file is used for storing \anuga output.
+An SWW file is used for storing \anuga output and therefore pertains
+to a set of points and a set of times at which a model is evaluated.
+It contains, in addition to dimension information, the following
+variables:
+
+\begin{itemize}
+    \item \code{x} and \code{y}: coordinates of the points, represented as Numeric arrays
+    \item \code{elevation}, a Numeric array storing bed-elevations
+    \item \code{volumes}, a list specifying the points at the vertices of each of the
+    triangles
+    \item \code{time}, a Numeric array containing times for model
+    evaluation
+\end{itemize}
+
 
 The contents of an SWW file may be viewed using the visualisation
@@ -1525 +1544 @@
 Class Definition Language (CDL). The following is an excerpt from a
 CDL representation of the output file \file{bedslope.sww} generated
-from running the simple example \filename{bedslopephysical.py}.
+from running the simple example \file{bedslopephysical.py} of
+Chapter \ref{ch:getstarted}.
 
 \verbatiminput{examples/bedslopeexcerpt.cdl}
 
-The data stored in an SWW file pertains to a specific set of points
-and timesteps and comprises the following:
-
-\begin{enumerate}
-    \item Dimension information, stored as a number of constants.
-    \item Variables \code{x} and \code{y}, storing coordinates of
-    the points, represented as Numeric arrays.
-    \item A variable \code{elevation}, storing bed-elevations at the
-    points, also as a Numeric array.
-    \item A variable \code{volumes}
-    \item A variable \code{time},
-\end{enumerate}
-
+A TMS file is used to store time series...
 
 
 \subsection{Meshfile Formats}
 
-A meshfile is a file that has a specific format suited to data used
-to specify a mesh suitable for use with \anuga. A meshfile can have
-one of two formats: it can be either a TSH file, which is an ASCII
-file, or an MSH file, which is a NetCDF file.
+A meshfile is a file that has a specific format suited to specifying
+mesh data for \anuga. A meshfile can have one of two formats: it can
+be either a TSH file, which is an ASCII file, or an MSH file, which
+is a NetCDF file.
 
 A meshfile describes the outline of the mesh---the vertices and line
@@ -1559 +1567 @@
 In addition, a meshfile may contain `holes' and/or `regions'. A hole
 or region is defined by specifying a point and a number of segments
-that enclose the point. A hole represents an area where no mesh is
+that enclose that point. A hole represents an area where no mesh is
 to be created, while a region is a labelled area used for defining
 properties of a mesh, such as friction values.
@@ -1569 +1577 @@
 \subsection{Formats for Storing Arbitrary Points and Attributes}
 
+An XYA file is used to store data representing arbitrary numerical
+attributes associated with a set of points.
+
+The format for a .xya file is:
+\begin{verbatim}
+            1st line:     [attribute names]
+            other lines:  x y [attributes]
+
+            for example:
+            elevation, friction
+            0.6, 0.7, 4.9, 0.3
+            1.9, 2.8, 5, 0.3
+            2.7, 2.4, 5.2, 0.3
+
+        The first two columns are always implicitly assumed to be x, y coordinates.
+        Use the same delimiter for the attribute names and the data
+
+        An xya file can optionally end with
+            #geo reference
+            56
+            466600.0
+            8644444.0
+
+        When the 1st # is the zone,
+        2nd # the xllcorner and
+        3rd # the yllcorner
+\end{verbatim}
 
 \subsection{ArcView Formats}