Changeset 2779

Timestamp:

Apr 28, 2006, 2:08:58 PM (19 years ago)

Author:

howard

Message:

Some material on file formats added to Chapter 5

File:

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

documentation/user_manual/anuga_user_manual.tex

@@ -267 +267 @@
 
    \item a list \code{points} of length $N$, where $N = (m + 1)(n + 1)$,
-comprising the coordinates $(x, y)$ of each of the $N$ mesh points,
+comprising the coordinates \code{(x, y)} of each of the $N$ mesh
+points,
 
    \item a list \code{vertices} of length $2mn$ (each entry specifies the three
@@ -392 +393 @@
 
 {\small \begin{verbatim}
-    h = 0.00 # Constant depth
-    domain.set_quantity('stage', -.4)
-\end{verbatim}}
-
-That is, the value of \code{stage} is set to $\code{h} = 0.00$ plus the
-value of \code{elevation} already defined.
+    h = 0.05 # Constant depth
+    domain.set_quantity('stage', expression = 'elevation + %f' %h)
+\end{verbatim}}
+
+That is, the value of \code{stage} is set to $\code{h} = 0.05$ plus
+the value of \code{elevation} already defined.
 
 The reader will probably appreciate that this capability to
@@ -489 +490 @@
 contains stage and momentum information and can be used with the
 \code{swollen} visualisation package to generate a visual display.
+See Section \ref{sec:file formats} (page \pageref{sec:file formats})
+for more on NetCDF and other file formats.
 
 
@@ -754 +757 @@
 function is both more complex and more interesting.
 
-The function returns the water displacement for all \code{x}
-and \code{y} in the domain. The water displacement is a ?? function that depends
-on the characteristics of the slump (length, thickness, slope, etc), its
-location (origin) and the depth at that location.
+The function returns the water displacement for all \code{x} and
+\code{y} in the domain. The water displacement is a double Gaussian
+function that depends on the characteristics of the slump (length,
+thickness, slope, etc), its location (origin) and the depth at that
+location.
 
 
@@ -1512 +1516 @@
             northing_min = None,
             northing_max = None,
-            expand_search = False, #To avoid intractable situations (This will be fixed when least_squares gets redesigned)
+            expand_search = False,
             verbose = False,
             origin = None,
             datum = 'WGS84',
-        format = 'ers'}
+            format = 'ers'}
   Module: \module{pyvolution.data\_manager}
 
@@ -1523 +1527 @@
 
 
-  \begin{funcdesc}{dem2pts}{???}
+  \begin{funcdesc}{dem2pts}{basename_in, basename_out=None,
+            easting_min=None, easting_max=None,
+            northing_min=None, northing_max=None,
+            use_cache=False, verbose=False}
   Module: \module{pyvolution.data\_manager}
 
@@ -1531 +1538 @@
 \bigskip
 
-\subsection{Samples}
-
-The following is an excerpt from a CDL representation of the output file \code{bedslope.sww}.
+\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{}
 
 
@@ -1602 +1649 @@
 
 \chapter{Supporting Tools}
+\label{ch:supporting_tools}
 
 This section describes a number of supporting tools, supplied with \anuga, that offer a
@@ -1658 +1706 @@
 
 \section{swollen}
-The output generated by \anuga may be viewed by means of the visualisation tool \code{swollen},
-which takes the \code{sww} file output by \anuga and creates a visual representation of the data.
-Examples may be seen in Figures \ref{fig:bedslopestart} and \ref{fig:bedslope2}.
-To view an \code{sww} file with \code{swollen} in the
-Windows environment, you can simply drag the icon representing the file over an icon on the desktop
-for the \code{swollen} executable file (or a shortcut to it). Alternatively, you can operate \code{swollen}
-from the command line, in both Windows and Linux environments.
+\label{sec:swollen}
+ The output generated by \anuga may be viewed by
+means of the visualisation tool \code{swollen}, which takes the
+\code{sww} file output by \anuga and creates a visual representation
+of the data. Examples may be seen in Figures \ref{fig:bedslopestart}
+and \ref{fig:bedslope2}. To view an \code{sww} file with
+\code{swollen} in the Windows environment, you can simply drag the
+icon representing the file over an icon on the desktop for the
+\code{swollen} executable file (or a shortcut to it). Alternatively,
+you can operate \code{swollen} from the command line, in both
+Windows and Linux environments.
 
 On successful operation, you will see an interactive moving-picture display. You can use keys and the mouse