Changeset 2542 for documentation

Timestamp:

Mar 13, 2006, 10:43:13 PM (19 years ago)

Author:

steve

Message:

Small typos

File:

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

documentation/user_manual/anuga_user_manual.tex

@@ -171 +171 @@
 The present example represents a simple scenario and does not
 include any forcing terms, nor is the data taken from a file as it
-would be in many typical cases. 
+would be in many typical cases.
 
 The conserved quantities involved in the
 problem are water depth, $x$-momentum and $y$-momentum. Other quantities
-involved in the computation are the friction, stage (absolute height of water surface) 
+involved in the computation are the friction, stage (absolute height of water surface)
 and elevation, the last two being related to
 the depth through the equation
 
 {\small \begin{verbatim}
-\code{stage} = \code{elevation} + \code{depth}
+stage = elevation + depth
 \end{verbatim}}
 
@@ -335 +335 @@
 
 The stage (the height of the water surface) is related to the
-elevation and the depth at any time by the equation \[\code{stage} =
-\code{elevation} + \code{depth}\] 
+elevation and the depth at any time by the equation {\small
+\begin{verbatim}
+    stage = elevation + depth
+\end{verbatim}}
 
 For this example, we simply assign a constant value to \code{stage},
@@ -345 +347 @@
 \end{verbatim}}
 
-which specifies that the surface level is set to a height of $-0.4$, i.e. 0.4 units 
+which specifies that the surface level is set to a height of $-0.4$, i.e. 0.4 units
 below the zero level.
 
@@ -353 +355 @@
 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  
+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
@@ -363 +365 @@
 \end{verbatim}}
 
-That is, the value of \code{stage} is set to $\code{h} = 0.05$ plus the 
+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 incorporate 
+The reader will probably appreciate that this capability to incorporate
 expressions into statements using \code{set\_quantity} greatly expands
 its power.)
@@ -403 +405 @@
 
     \item[Dirichlet boundary]Specifies a fixed value at the
-boundary and assigns initial values to the $x$-momentum and $y$-momentum.  
+boundary and assigns initial values to the $x$-momentum and $y$-momentum.
 
     \item[Time boundary.]A Dirichlet boundary whose behaviour varies with time.
@@ -421 +423 @@
 
 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 
+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}
@@ -476 +478 @@
 
 
-\begin{figure}[hbt] 
-
-  \centerline{ \includegraphics[width=75mm, height=75mm]{examples/bedslope_start.eps}}
-  
+\begin{figure}[hbt]
+
+  \centerline{ \includegraphics[width=75mm, height=75mm]{examples/bedslopestart.eps}}
+
   \caption{Bedslope example viewed with Swollen}
   \label{fig:bedslopestart}
-\end{figure} 
-
-
-\begin{figure}[hbt] 
-
-  \centerline{ 
-    \includegraphics[width=75mm, height=75mm]{examples/bedslope_during.eps}
-    \includegraphics[width=75mm, height=75mm]{examples/bedslope_end.eps}
-   }    
-  
+\end{figure}
+
+
+\begin{figure}[hbt]
+
+  \centerline{
+    \includegraphics[width=75mm, height=75mm]{examples/bedslopeduring.eps}
+    \includegraphics[width=75mm, height=75mm]{examples/bedslopeend.eps}
+   }
+
   \caption{Bedslope example viewed with Swollen}
   \label{fig:bedslope2}
-\end{figure} 
+\end{figure}
 
 
@@ -511 +513 @@
 scenario, rather than the artificial illustrative one used in
 \code{bedslopephysical.py}. The domain of interest surrounds the Sydney region,
-and predominantly covers Sydney Harbour. A hypothetical tsunami wave is 
+and predominantly covers Sydney Harbour. A hypothetical tsunami wave is
 generated by a submarine mass failure situated on the edge of the
 continental shelf.
@@ -567 +569 @@
 area of a triangle used for triangulation---and mesh points are
 created inside the polygon through a random process. Figure
-\ref{fig:pentagon} shows a simple example of this, in which 
+\ref{fig:pentagon} shows a simple example of this, in which
 the triangulation is carried out within a pentagon.
 
 
-\begin{figure}[hbt] 
-
-
-  
+\begin{figure}[hbt]
+
+
+
   \caption{Mesh points are created inside the polygon}
-  \label{fig:pentagon}  
-\end{figure} 
+  \label{fig:pentagon}
+\end{figure}
 
 Boundary tags are not restricted to \code{`left'}, \code{`right'},
@@ -594 +596 @@
 resolution. See Figure \ref{fig:interior meshes}.
 
-\begin{figure}[hbt] 
-
-
- 
+\begin{figure}[hbt]
+
+
+
   \caption{Interior meshes with individual resolution}
-  \label{fig:interior meshes}  
-\end{figure} 
+  \label{fig:interior meshes}
+\end{figure}
 
 In its general form, \code{pmesh} takes for its input a bounding
@@ -631 +633 @@
 \code{meshname}.
 
-The statements 
+The statements
 
 {\small \begin{verbatim}
@@ -641 +643 @@
 are used to read in the specific polygons \code{project.harbour\_polygon\_2} and
 \code{botanybay\_polygon\_2} from \code{project.py} and assign a
-common resolution of 5000 to each. The statement 
+common resolution of 5000 to each. The statement
 
 {\small \begin{verbatim}
     create_mesh_from_regions(project.diffpolygonall,%
-                         boundary_tags= {'bottom': [0],% 
+                         boundary_tags= {'bottom': [0],%
                                          'right1': [1],%
                                          'right0': [2],%
@@ -654 +656 @@
                                          'left3': [7]},%
                          maximum_triangle_area=100000,%
-                         filename=meshname,%           
+                         filename=meshname,%
                          interior_regions=interior_regions)
 \end{verbatim}}
 
 is then used to create the mesh, taking the bounding polygon to be the polygon
-\code{diffpolygonall} specified in \code{project.py}. The 
-argument \code{boundary\_tags} assigns a dictionary, whose keys are the 
-names of the boundary tags used for the bounding polygon---\code{`bottom'}, 
-`right0', `right1', `right2', `top', `left1', `left2' and `left3'--- 
+\code{diffpolygonall} specified in \code{project.py}. The
+argument \code{boundary\_tags} assigns a dictionary, whose keys are the
+names of the boundary tags used for the bounding polygon---\code{`bottom'},
+`right0', `right1', `right2', `top', `left1', `left2' and `left3'---
 and whose values identify the indices of the segments associated with each of these
 tags. (The value associated with each boundary tag is a one-element list.)
@@ -695 +697 @@
 taken from \code{project.py}.
 
-{\small \begin{verbatim} 
+{\small \begin{verbatim}
     domain.set_name(project.basename)%
     domain.set_datadir(project.outputdir)%
@@ -718 +720 @@
 \code{slump\_tsunami}. This is similar to how we set elevation in
 \code{bedslopephysical.py} using a function---however, in this case the
-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 
+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. 
+location (origin) and the depth at that location.
 
 
@@ -739 +741 @@
 The elevation is specified by reading data from a file:
 
-{\small \begin{verbatim}%
-    domain.set_quantity('elevation',%
-                    filename = project.combineddemname + '.pts',%
-                    use_cache = True,%
-                    verbose = True)%
+{\small \begin{verbatim}
+    domain.set_quantity('elevation',
+                    filename = project.combineddemname + '.pts',
+                    use_cache = True,
+                    verbose = True)
 \end{verbatim}}
 
@@ -770 +772 @@
 \subsection{Boundary Conditions}
 
-Setting boundaries follows a similar pattern to the one used for 
-\code{bedslopephysical.py}, except that in this case we need to associate a 
+Setting boundaries follows a similar pattern to the one used for
+\code{bedslopephysical.py}, except that in this case we need to associate a
 boundary type with each of the
-boundary tag names introduced when we established the mesh. In place of the four 
-boundary types introduced for \code{bedslopephysical.py}, we use the reflective 
+boundary tag names introduced when we established the mesh. In place of the four
+boundary types introduced for \code{bedslopephysical.py}, we use the reflective
 boundary for each of the
 eight tagged segments:
@@ -792 +794 @@
 {\small \begin{verbatim}
     import time t0 = time.time()
-    
+
     for t in domain.evolve(yieldstep = 120, duration = 18000):
         print domain.timestepping_statistics()
         print domain.boundary_statistics(tags = 'bottom')
-    
+
     print 'That took %.2f seconds' %(time.time()
 \end{verbatim}}
@@ -917 +919 @@
 \section{Setting Quantities}
 
-\begin{funcdesc}{set\_quantity}{name, numeric = None, quantity = None, function = None, 
-                   geospatial_data = None, filename = None, attribute_name = None, 
+\begin{funcdesc}{set\_quantity}{name, numeric = None, quantity = None, function = None,
+                   geospatial_data = None, filename = None, attribute_name = None,
                    alpha = None, location = 'vertices', indices = None, verbose = False,
                    use_cache = False}
@@ -927 +929 @@
 Compatible list, Numeric array (see below) or constant. If callable
 it will treated as a function (see below) If instance of another
-Quantity it will be treated as such. If geo_spatial object it will
+Quantity it will be treated as such. If geo\_spatial object it will
 be treated as such
 
@@ -1201 +1203 @@
 
   \end{funcdesc}
-  
-  
+
+
   \begin{funcdesc}{statistics}{???}
 
     print domain.statistics() will provide basic structural statistics about e.g.\ mesh in the form of an area histogram
-  \end{funcdesc}  
-  
-  
+  \end{funcdesc}
+
+
   \begin{funcdesc}{get_quantity}{???}
-  Module: \code{pyvolution.domain}  
+  Module: \code{pyvolution.domain}
   Allow access to individual quantities and their methods
-  
-  \end{funcdesc}  
-  
-  
+
+  \end{funcdesc}
+
+
   \begin{funcdesc}{get_values}{???}
-  Module: \code{pyvolution.quantity}    
-  
+  Module: \code{pyvolution.quantity}
+
   Extract values for quantity as an array
-  
-  \end{funcdesc}    
-  
-  
+
+  \end{funcdesc}
+
+
   \begin{funcdesc}{get_integral}{???}
-  Module: \code{pyvolution.quantity}    
-  
+  Module: \code{pyvolution.quantity}
+
   Return computed integral over entire domain for this quantity
-  
-  \end{funcdesc}      
-  
-  
-\section{Other}  
-
-  \begin{funcdesc}{domain.create_quantity_from_expression}{???}  
-  
-  Handy for creating derived quantities on-the-fly.  
+
+  \end{funcdesc}
+
+
+\section{Other}
+
+  \begin{funcdesc}{domain.create_quantity_from_expression}{???}
+
+  Handy for creating derived quantities on-the-fly.
   See \code{Analytical\_solution\_circular\_hydraulic\_jump.py} for an example of use.
-  \end{funcdesc}        
+  \end{funcdesc}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -1333 +1335 @@
 
   \begin{funcdesc}{sww2dem}{???}
-  Module: \code{pyvolution.data\_manager}    
-  
-  
-  \end{funcdesc}      
-
-  
+  Module: \code{pyvolution.data\_manager}
+
+
+  \end{funcdesc}
+
+
   \begin{funcdesc}{dem2pts}{???}
-  Module: \code{pyvolution.data_manager}    
-  
-  
-  \end{funcdesc}        
+  Module: \code{pyvolution.data_manager}
+
+
+  \end{funcdesc}
 
 %\[
@@ -1578 +1580 @@
 \section{geo_spatial_data}
 
-This describes a class that represents arbitrary point data in UTM 
+This describes a class that represents arbitrary point data in UTM
 coordinates along with named attribute values.