Changeset 2747

Timestamp:

Apr 21, 2006, 4:47:26 PM (19 years ago)

Author:

howard

Message:

Minor additions to Chap 4

File:

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

documentation/user_manual/anuga_user_manual.tex

@@ -239 +239 @@
 significance.
 
-%\verbatiminput{examples/bedslopephysical.py}
-\verbatiminput{examples/bedslope.py}
+\verbatiminput{examples/bedslopephysical.py}
+%\verbatiminput{examples/bedslope.py}
 
 \subsection{Establishing the Mesh}
@@ -496 +496 @@
 
 \begin{itemize}
-  \item{from a Windows command line} as in \codee{python bedslopephysical.py}
+  \item{from a Windows command line} as in \code{python bedslopephysical.py}
   \item{within the Python IDLE environment}
   \item{within emacs}
@@ -1008 +1008 @@
 
 
-\subsection{Setters and getters of class Domain}
+\subsection{Key Methods of Domain}
 
 \begin{funcdesc} {set\_name}{name}
@@ -1066 +1066 @@
 
 %%%%%%
-\section{Setting Quantities}
+\section{Initial Conditions}
 
 \begin{funcdesc}{set\_quantity}{name,
@@ -1354 +1354 @@
 \subsection{Diagnostics}
 
-  \begin{funcdesc}{timestepping_statistics}{???}
+  \begin{funcdesc}{timestepping_statistics}{}
+  Module: \module{pyvolution.domain}
+
 
   \end{funcdesc}
 
 
-  \begin{funcdesc}{boundary\_statistics}{???}
+  \begin{funcdesc}{boundary\_statistics}{quantities = None, tags = None}
+  Module: \module{pyvolution.domain}
+
 
   \end{funcdesc}
 
 
-  \begin{funcdesc}{get_quantity}{???}
+  \begin{funcdesc}{get_quantity}{name, location='vertices', indices = None}
   Module: \module{pyvolution.domain}
   Allow access to individual quantities and their methods
@@ -1371 +1375 @@
 
 
-  \begin{funcdesc}{get_values}{???}
+  \begin{funcdesc}{get_values}{location='vertices', indices = None}
   Module: \module{pyvolution.quantity}
 
@@ -1379 +1383 @@
 
 
-  \begin{funcdesc}{get_integral}{???}
+  \begin{funcdesc}{get_integral}{}
   Module: \module{pyvolution.quantity}
 
@@ -1498 +1502 @@
 \subsection{Basic file conversions}
 
-  \begin{funcdesc}{sww2dem}{???}
+  \begin{funcdesc}{sww2dem}{basename_in, basename_out = None,
+            quantity = None,
+            timestep = None,
+            reduction = None,
+            cellsize = 10,
+            NODATA_value = -9999,
+            easting_min = None,
+            easting_max = None,
+            northing_min = None,
+            northing_max = None,
+            expand_search = False, #To avoid intractable situations (This will be fixed when least_squares gets redesigned)
+            verbose = False,
+            origin = None,
+            datum = 'WGS84',
+        format = 'ers'}
   Module: \module{pyvolution.data\_manager}
 
@@ -1506 +1524 @@
 
   \begin{funcdesc}{dem2pts}{???}
-  Module: \module{pyvolution.data_manager}
+  Module: \module{pyvolution.data\_manager}