Changeset 2745

Timestamp:

Apr 21, 2006, 3:07:29 PM (19 years ago)

Author:

howard

Message:

Fixed up heading names and levels (Jane's comments). Minor corrections from Jack Kelly's comments.

File:

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

documentation/user_manual/anuga_user_manual.tex

@@ -43 +43 @@
 %\settimeformat{xxivtime} % 24 hour Format
 \settimeformat{oclock} % Verbose
-\date{\today, \ \currenttime}   
+\date{\today, \ \currenttime}
 
 \ifhtml
-\date{\today} % latex2html does not know about datetime   
+\date{\today} % latex2html does not know about datetime
 \fi
 
@@ -211 +211 @@
 
 In outline, \file{bedslopephysical.py} performs the following steps:
-                   
+
 \begin{enumerate}
 
@@ -292 +292 @@
 This uses a Python class \class{Domain}, imported from
 \module{shallow\_water}, which is an extension of a more generic
-class of the same name in the module \refmodule{pyvolution.domain} 
+class of the same name in the module \refmodule{pyvolution.domain}
 (page \pageref{mod:pyvolution.domain}),
 and inherits
@@ -305 +305 @@
 
 
-\subsection{Specifying the Quantities}
+\subsection{Initial Conditions}
 
 The next task is to specify a number of quantities that we wish to
@@ -349 +349 @@
 \subsubsection{Friction}
 
-The assignment of the friction quantity demonstrates another way
-we can use \method{set\_quantity} to set quantities---namely,
-assign them to a constant numerical value:
+The assignment of the friction quantity demonstrates another way we
+can use \method{set\_quantity} to set quantities---namely, assign
+them to a constant numerical value:
 
 {\small \begin{verbatim}
@@ -381 +381 @@
 below the zero level.
 
-(Although it is not necessary for this example, it may be useful to digress here
-and mention a variant to this requirement, which allows us to illustrate
-another way to use \method{set\_quantity}---namely, incorporating an expression
-involving other quantities. Suppose, instead of setting a constant value
-for the stage, we wished
-to specify a constant value for the \emph{depth}. For such a case we
-need to specify that \code{stage} is
-everywhere obtained by adding that value to the value already
-specified for \code{elevation}. We would do this by means of the statements:
+(Although it is not necessary for this example, it may be useful to
+digress here and mention a variant to this requirement, which allows
+us to illustrate another way to use \method{set\_quantity}---namely,
+incorporating an expression involving other quantities. Suppose,
+instead of setting a constant value for the stage, we wished to
+specify a constant value for the \emph{depth}. For such a case we
+need to specify that \code{stage} is everywhere obtained by adding
+that value to the value already specified for \code{elevation}. We
+would do this by means of the statements:
 
 {\small \begin{verbatim}
@@ -399 +399 @@
 value of \code{elevation} already defined.
 
-The reader will probably appreciate that this capability to incorporate
-expressions into statements using \method{set\_quantity} greatly expands
-its power.)
-
-\subsubsection{Boundary Conditions}
+The reader will probably appreciate that this capability to
+incorporate expressions into statements using \method{set\_quantity}
+greatly expands its power.)
+
+\subsection{Boundary Conditions}
 
 The boundary conditions are specified as follows:
@@ -453 +453 @@
 boundaries are all reflective.
 
-The reader may wish to experiment by varying the choice of boundary types
-for one or more of the boundaries. In the case of \code{Bd} and \code{Bw},
-the three arguments in each case represent the
-
-{\small \begin{verbatim}
-    Bw = Time_boundary(domain=domain,
-                f=lambda t: [(0.1*sin(t*2*pi)), 0.0, 0.0])
-\end{verbatim}}
+The reader may wish to experiment by varying the choice of boundary
+types for one or more of the boundaries. In the case of \code{Bd}
+and \code{Bw}, the three arguments in each case represent the
+elevation, $x$-momentum and $y$-momentum, respectively.
+
+%{\small \begin{verbatim}
+%    Bw = Time_boundary(domain=domain,
+%                f=lambda t: [(0.1*sin(t*2*pi)), 0.0, 0.0])
+%\end{verbatim}}
 
 
@@ -495 +496 @@
 
 \begin{itemize}
-  \item{from a Windows command line} as in \file{python bedslopephysical.py}
+  \item{from a Windows command line} as in \codee{python bedslopephysical.py}
   \item{within the Python IDLE environment}
   \item{within emacs}
-  \item{from a Linux command line} as in \file{python bedslopephysical.py}
+  \item{from a Linux command line} as in \code{python bedslopephysical.py}
 \end{itemize}
 
@@ -539 +540 @@
 
 The following discussion builds on the concepts introduced through
-the \file{bedslopephysical.py} example and introduces a second example,
-\file{run\_sydney\_smf.py}, that follows the same basic outline, but
-incorporates more complex features and refers to a real-life
-scenario, rather than the artificial illustrative one used in
-\file{bedslopephysical.py}. The domain of interest surrounds the Sydney region,
-and predominantly covers Sydney Harbour. A hypothetical tsunami wave is
-generated by a submarine mass failure situated on the edge of the
-continental shelf.
+the \file{bedslopephysical.py} example and introduces a second
+example, \file{run\_sydney\_smf.py}, that follows the same basic
+outline, but incorporates more complex features and refers to a
+real-life scenario, rather than the artificial illustrative one used
+in \file{bedslopephysical.py}. The domain of interest surrounds the
+Sydney region, and predominantly covers Sydney Harbour. A
+hypothetical tsunami wave is generated by a submarine mass failure
+situated on the edge of the continental shelf.
 
 \subsection{Overview}
-As in the case of \file{bedslopephysical.py}, the actions carried out by the
-program can be organised according to this outline:
+As in the case of \file{bedslopephysical.py}, the actions carried
+out by the program can be organised according to this outline:
 
 \begin{enumerate}
@@ -586 +587 @@
 
 One obvious way that the present example differs from
-\file{bedslopephysical.py} is in the use of a more complex method to create
-the mesh. Instead of imposing a mesh structure on a rectangular
-grid, the technique used for this example involves building mesh
-structures inside polygons specified by the user, using a
-mesh-generator referred to as \code{pmesh}.
+\file{bedslopephysical.py} is in the use of a more complex method to
+create the mesh. Instead of imposing a mesh structure on a
+rectangular grid, the technique used for this example involves
+building mesh structures inside polygons specified by the user,
+using a mesh-generator referred to as \code{pmesh}.
 
 The following remarks may help the reader understand how
@@ -614 +615 @@
 Boundary tags are not restricted to \code{`left'}, \code{`right'},
 \code{`bottom'} and \code{`top'}, as in the case of
-\file{bedslopephysical.py}. Instead the user specifies a list of tags
-appropriate to the configuration being modelled.
+\file{bedslopephysical.py}. Instead the user specifies a list of
+tags appropriate to the configuration being modelled.
 
 While a mesh created inside a polygon offers more flexibility than
@@ -736 +737 @@
 
 
-\subsection{Specifying the Quantities}
+\subsection{Initial Conditions}
 Quantities for \file{run\_sydney\_smf.py} are set
 using similar methods to those in \file{bedslopephysical.py}. However,
@@ -873 +874 @@
 
 \begin{center}
-    \code{pmesh/mesh\_interface.py}
+%    \code{pmesh/mesh\_interface.py}
+    \code{pmesh}$\slash$\code{mesh\_interface.py}
 \end{center}
 
@@ -1147 +1149 @@
 a submarine slump or slide.
 
-The arguments include as a minimum, the slump or slide length, the water depth to the centre of sediment 
+The arguments include as a minimum, the slump or slide length, the water depth to the centre of sediment
 mass, and the bathymetric slope. Other slump or slide parameters can be included if they are known.
 \end{funcdesc}
@@ -1392 +1394 @@
   See \file{Analytical\_solution\_circular\_hydraulic\_jump.py} for an example of use.
   \end{funcdesc}
-  
-  
+
+
   \begin{funcdesc}{Geospatial_data}{???}
     Module: \module{geospatial_data.geo_spatial_data}
     Creates a georeferenced geospatial data object from either arrays or a file (pts or xya).
-  
+
     Objects of this class can be used with \method{set\_quantity}.
-  \end{funcdesc}  
-
-  
-  
-  
-  
+  \end{funcdesc}
+
+
+
+
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -1515 +1517 @@
 The following is an excerpt from a CDL representation of the output file \code{bedslope.sww}.
 
-\verbatiminput{examples/bedslopeexcerpt.cdl} 
+\verbatiminput{examples/bedslopeexcerpt.cdl}
 
 
@@ -1853 +1855 @@
 
 \subsubsection{Can I change values for any quantity during the simulation?}
-Yes, using \code{domain.set_quantity()} inside the domain.evolve loop you 
-can change values of any quantity. This is for example useful if you wish to 
+Yes, using \code{domain.set_quantity()} inside the domain.evolve loop you
+can change values of any quantity. This is for example useful if you wish to
 let the system settle for a while before assigning an initial condition. Another example would be changing the values for elevation to model e.g. erosion.
 
@@ -1861 +1863 @@
 
 \subsubsection{Why does a file\_function return a list of numbers when evaluated?}
-Currently, file\_function works by returning values for the conserved 
+Currently, file\_function works by returning values for the conserved
 quantities \code{stage}, \code{xmomentum} and \code{ymomentum} at a given point in time and space as a triplet. To access e.g.\ \code{stage} one must specify element 0 of the triplet returned by file\_function.
 
@@ -1875 +1877 @@
 
 \subsubsection{What sort of mesh resolution should I use?}
-The mesh resolution should be commensurate with your DEM - it does not make sense to put in place a mesh which is finer than your DEM. As an example, 
+The mesh resolution should be commensurate with your DEM - it does not make sense to put in place a mesh which is finer than your DEM. As an example,
 if your DEM is on a 25m grid, then the cell resolution should be of the order of 315$m^2$ (this represents half the area of the square grid). Ideally,
-you need a fine mesh over regions where the DEM changes rapidly, and other areas of significant interest, such as the coast. 
+you need a fine mesh over regions where the DEM changes rapidly, and other areas of significant interest, such as the coast.
 
 \subsubsection{How often should I store the output?}
 This will depend on what you are trying to answer with your model and how much memory you have available on your machine. If you need
-to look in detail at the evolution, then you will need to balance against your storage requirements and the duration of the simulation. 
+to look in detail at the evolution, then you will need to balance against your storage requirements and the duration of the simulation.
 If the sww file exceeds 1Gb, another sww file will be created until the end of the simulation. As an example, to store all the conserved
 quantities on a mesh with approximately 300000 triangles on a 2 min interval for 5 hours will result in approximately 350Mb sww file.
@@ -1919 +1921 @@
     \item \indexedbold{IDLE} - Development environment shipped with Python
 
-    \item \indexedbold{Manning friction coefficient} 
+    \item \indexedbold{Manning friction coefficient}
 
     \item \indexedbold{mesh}    - Triangulation of domain
@@ -1970 +1972 @@
     NOTE: More can be read in the module utilities/polygon.py ....
 
-    \item \indexedbold{easting} - A rectangular (x,y) coordinate measurement of distance east from a north-south reference line, 
+    \item \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 projection. Easting is a UTM (Universal Transverse Mercator) Coordinate.
 
-    \item \indexedbold{northing} - A rectangular (x,y) coordinate measurement of distance north from a north-south reference line, 
+    \item \indexedbold{northing} - A rectangular (x,y) coordinate measurement of distance north from a north-south reference line,
 usually a meridian used as the axis of origin within a map zone or projection. Northing is a UTM (Universal Transverse Mercator) Coordinate.
 
@@ -1979 +1981 @@
     \item \indexedbold{latitude} - The angular distance on a mericlear north and south of the equator, expressed in degrees and minutes.
 
-    \item \indexedbold{longitude} - The angular distance east or west, between the meridian of a particular place on Earth and that of the 
+    \item \indexedbold{longitude} - The angular distance east or west, between the meridian of a particular place on Earth and that of the
 Prime Meridian (located in Greenwich, England) expressed in degrees or time.
 
     \item \indexedbold{edge} - A triangulare cell within the computational mesh can be depicted as a set of vertices joined by lines (the edges).
 
-    \item \indexedbold{vertex} - A point at which edges meet. 
-
-    \item \indexedbold{finite volume} - The method evaluates the terms in the shallow water wave equationas fluxes at the surfaces of each 
-finite volume. Because the flux entering a given volume is identical to that leaving the adjacent volume, these methods are conservative. 
-Another advantage of the finite volume method is that it is easily formulated to allow for unstructured meshes. 
+    \item \indexedbold{vertex} - A point at which edges meet.
+
+    \item \indexedbold{finite volume} - The method evaluates the terms in the shallow water wave equationas fluxes at the surfaces of each
+finite volume. Because the flux entering a given volume is identical to that leaving the adjacent volume, these methods are conservative.
+Another advantage of the finite volume method is that it is easily formulated to allow for unstructured meshes.
 The method is used in many computational fluid dynamics packages.
 
 
-    \item \indexedbold{flux} - the amount of flow through the volume per unit time 
-
-    \item \indexedbold{Digital Elevation Model (DEM)} - DEMs are digital files consisting of points of elevations, 
-sampled systematically at equally spaced intervals. 
+    \item \indexedbold{flux} - the amount of flow through the volume per unit time
+
+    \item \indexedbold{Digital Elevation Model (DEM)} - DEMs are digital files consisting of points of elevations,
+sampled systematically at equally spaced intervals.