Changeset 2780

Timestamp:

Apr 28, 2006, 3:37:51 PM (19 years ago)

Author:

howard

Message:

Added further material on file formats to Ch 5

File:

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

documentation/user_manual/anuga_user_manual.tex

@@ -1504 +1504 @@
 
 
-\subsection{Basic file conversions}
+
+
+\bigskip
+
+\subsection{SWW and TMS Formats}
+
+The SWW and TMS formats are both NetCDF formats, and are of key
+importance for \anuga.
+
+An SWW file is used for storing \anuga output.
+
+The contents of an SWW file may be viewed using the visualisation
+tool \code{swollen}, which creates an on-screen geometric
+representation. See section \ref{sec:swollen} (page
+\pageref{sec:swollen}) in Appendix \ref{ch:supportingtools} for more
+on \code{swollen}.
+
+Alternatively, there are tools, such as \code{ncdump}, that allow
+you to convert an NetCDF file into a readable format such as the
+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}.
+
+\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}
+
+
+
+\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 describes the outline of the mesh---the vertices and line
+segments that enclose the region in which the mesh is created---and
+the triangular mesh itself, which is specified by listing the
+triangles and their vertices, and the segments, which are those
+sides of the triangles that are associated with boundary conditions.
+
+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
+to be created, while a region is a labelled area used for defining
+properties of a mesh, such as friction values.
+
+A meshfile can also contain a georeference, which describes an
+offset to be applied to $x$ and $y$ values---eg to the vertices.
+
+
+\subsection{Formats for Storing Arbitrary Points and Attributes}
+
+
+\subsection{ArcView Formats}
+
+
+\subsection{Other Formats}
+
+\subsection{Basic File Conversions}
 
   \begin{funcdesc}{sww2dem}{basename_in, basename_out = None,
@@ -1523 +1594 @@
   Module: \module{pyvolution.data\_manager}
 
-
+  Takes data from an SWW file and converts it to DEM format (ASC or
+  ERS)
   \end{funcdesc}
 
@@ -1533 +1605 @@
   Module: \module{pyvolution.data\_manager}
 
-
+  Takes DEM data (a NetCDF file representation of data from a regular Digital
+  Elevation Model) and converts it to PTS format.
   \end{funcdesc}
 
-\bigskip
-
-\subsection{SWW and TMS Formats}
-
-The SWW and TMS formats are both NetCDF formats, and are of key
-importance for \anuga.
-
-The output from \anuga is stored in an SWW file. The contents may be
-viewed using the visualisation tool \code{swollen}, which creates an
-on-screen geometric representation. See section \ref{sec:swollen}
-(page \pageref{sec:swollen}) in Appendix \ref{ch:supporting_tools}
- for more on \code{swollen}.
-
-Alternatively, there are tools, such as \code{ncdump}, that allow
-you to convert an NetCDF file into a readable format such as the
-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}.
-
-\verbatiminput{examples/bedslopeexcerpt.cdl}
-
-
-
-\subsection{Meshfile Formats}
-
-A meshfile is a file of a specific format used for holding data that
-specifies 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 describes the outline of the mesh---the vertices and line
-segments that enclose the region in which the mesh is created---and
-the triangular mesh itself, which is specified by listing the
-triangles and their vertices, and the segments, which are those
-sides of the triangles that are associated with boundary conditions.
-
-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
-to be created, while a region is a labelled area used for defining
-properties of a mesh, such as friction values.
-
-A meshfile can also contain a georeference, which describes the
-offset of the x,y values eg, the offset of the vertices.
-
-
-\subsection{}
 
 
@@ -1649 +1675 @@
 
 \chapter{Supporting Tools}
-\label{ch:supporting_tools}
+\label{ch:supportingtools}
 
 This section describes a number of supporting tools, supplied with \anuga, that offer a