Changeset 2574

Timestamp:

Mar 22, 2006, 4:27:29 PM (17 years ago)

Author:

ole

Message:

From meeting with Howard

Location:

documentation/user_manual

Files:

• anuga_user_manual.tex (modified) (13 diffs)
• definitions.tex (modified) (1 diff)
• examples/bedslopephysical.py (moved) (moved from documentation/user_manual/examples/bedslope_physical.py)

documentation/user_manual/anuga_user_manual.tex

@@ -179 +179 @@
 the depth through the equation
 
-{\small \begin{verbatim}
-\code{stage} = \code{elevation} + \code{depth}
-\end{verbatim}}
+\begin{tabular}{rcrcl} 
+  \code{stage} &=& \code{elevation} &+& \code{depth}
+\end{tabular} 
+
 
 %\emph{[More details of the problem background]}
@@ -335 +336 @@
 
 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},
@@ -476 +482 @@
 
 
-%\begin{figure}[hbt] 
-
-%  \centerline{ \includegraphics[width=75mm, height=75mm]{examples/bedslope_start.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}
-%   }    
-  
-%  \caption{Bedslope example viewed with Swollen}
-%  \label{fig:bedslope2}
-%\end{figure} 
+\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/bedslopeduring.eps}
+    \includegraphics[width=75mm, height=75mm]{examples/bedslopeend.eps}
+   }    
+  
+  \caption{Bedslope example viewed with Swollen}
+  \label{fig:bedslope2}
+\end{figure} 
 
 
@@ -571 +577 @@
 
 
-%\begin{figure}[hbt] 
-
-
-  
-%  \caption{Mesh points are created inside the polygon}
-%  \label{fig:pentagon}  
-%\end{figure} 
+\begin{figure}[hbt] 
+
+
+  
+  \caption{Mesh points are created inside the polygon}
+  \label{fig:pentagon}  
+\end{figure} 
 
 Boundary tags are not restricted to \code{`left'}, \code{`right'},
@@ -594 +600 @@
 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} 
+  \caption{Interior meshes with individual resolution}
+  \label{fig:interior meshes}  
+\end{figure} 
 
 In its general form, \code{pmesh} takes for its input a bounding
@@ -931 +937 @@
 \code{pyvolution.quantity.set_values})
 
-This function is used to associate quantities with a domain. It is very flexible and can be
+This function is used to assign values to individual quantities for a domain. It is very flexible and can be
 used with many data types: a statement of the form \code{domain.set\_quantity{name, x}} can 
 be used to define a quantity having the name \code{name}, where the other argument \code{x} can 
@@ -937 +943 @@
 
 \begin{itemize}
-\item a number
-\item a list of numbers
-\item a Numeric array
-\item a function (e.g. see the samples introduced in Chapter 2) 
+\item a number in which case all vertices in the mesh gets that for the quantity in question.
+\item a list of numbers or a Numeric array ordered the same way as the mesh vertices.
+\item a function (e.g.\ see the samples introduced in Chapter 2) 
 \item an expression composed of other quantities and numbers, arrays, lists (for
 example, a linear combination of quantities)
 \item the name of a file from which the data can be read
-\item a geospatial dataset
+\item a geospatial dataset (See ?????)
 \end{itemize}
 
@@ -1412 +1417 @@
 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 XX and YY. To view an \code{sww} file with \code{swollen} in the 
+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}
@@ -1478 +1484 @@
 \end{tabular}
 
-\section{utilities/polygons} Could do now.
+\section{utilities/polygons}
 
   \begin{classdesc}{Polygon_function}{regions, default = 0.0, geo_reference = None}
@@ -1495 +1501 @@
   
   \begin{funcdesc}{populate_polygon}{polygon, number_of_points, seed = None, exclude = None}
-  \indexedcode{populate_polygon}
   Module: \code{utilities.polygon}  
   
@@ -1503 +1508 @@
   
   \begin{funcdesc}{point_in_polygon}{polygon, delta=1e-8}
-  \indexedcode{point_in_polygon}
   Module: \code{utilities.polygon}  
   
@@ -1512 +1516 @@
   
   \begin{funcdesc}{inside_polygon}{points, polygon, closed = True, verbose = False}
-  \indexedcode{inside_polygon}
   Module: \code{utilities.polygon}  
   
@@ -1526 +1529 @@
   
   \begin{funcdesc}{outside_polygon}{points, polygon, closed = True, verbose = False}
-  \indexedcode{outside_polygon}
   Module: \code{utilities.polygon}  
   

documentation/user_manual/definitions.tex

@@ -8 +8 @@
 \newcommand{\anuga}{\textbf{ANUGA}$^{\scriptscriptstyle \copyright}$ v1.0\ }
 %\newcommand{\anugav}[1]{\textbf{ANUGA}$^\copyright$ V#1\ }
+
+%Used with \code.
+%
+\newenvironment{displayedcode}
+   {\begin{tabular}{p{0.41cm}l}}
+   {\end{tabular}}