Changeset 2497

Timestamp:

Mar 8, 2006, 4:38:03 PM (19 years ago)

Author:

ole

Message:

Updates from Wednesday meeting (Howard and Ole)

Location:

documentation/user_manual

Files:

• anuga_user_manual.tex (modified) (12 diffs)
• examples/runsydney.py (modified) (1 diff)

documentation/user_manual/anuga_user_manual.tex

@@ -404 +404 @@
 The final statement \nopagebreak[3]
 {\small \begin{verbatim}
-    for t in domain.evolve(yieldstep = 0.1, finaltime = 4.0):
-        domain.write_time()
+    for t in domain.evolve(yieldstep = 0.1, duration = 4.0):
+        print domain.timestepping_statistics()
 \end{verbatim}}
 
@@ -411 +411 @@
 `evolve' in accordance with the model embodied in the code, over a
 series of steps indicated by the values of \code{yieldstep} and
-\code{finaltime}, which can be altered as required.
+\code{duration}, which can be altered as required.
 The value of \code{yieldstep} controls the time interval between successive model outputs.
 Behind the scenes more time steps are generally taken.
@@ -497 +497 @@
 
 In its simplest form, \code{pmesh} creates the mesh within a single
-polygon whose vertices are at geographical locations specified by
-the user. The user specifies the \emph{resolution}---that is, the
-maximal area of a triangle used for triangulation---and mesh points
-are created inside the polygon through a random process. Figure XXX
-shows a simple example of this, in which the triangulation is
-carried out within a pentagon.
+polygon whose vertices are at geographical locations specified by the
+user. The user specifies the \emph{resolution}---that is, the maximal
+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 
+the triangulation is carried out within a pentagon.
+
+
+\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'},
@@ -517 +526 @@
 the user to specify a number of \emph{interior polygons}, which are
 triangulated separately, each according to a separately specified
-resolution. See Figure XXX.
+resolution. See Figure \ref{fig:interior meshes}.
+
+\begin{figure}[hbt] 
+
+
+ 
+  \caption{Interior meshes with individual resolution.}
+  \label{fig:interior meshes}  
+\end{figure} 
 
 In its general form, \code{pmesh} takes for its input a bounding
@@ -692 +709 @@
 import time t0 = time.time()
 
-for t in domain.evolve(yieldstep = 120, finaltime = 18000):
-    domain.write_time()
-    domain.write_boundary_statistics(tags = 'bottom')
+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()-t0)
@@ -715 +732 @@
     \item Boundary Conditions
     \item Forcing Functions
-    \item Diagnostics
+    \item Evolution
 \end{itemize}
 
@@ -790 +807 @@
 \end{funcdesc}
 
+
+\subsection{Setters and getters of class Domain}
+
+\begin{funcdesc} {set_name}{??}
+\end{funcdesc}
+
+\begin{funcdesc} {get_name}{??}
+\end{funcdesc}
+
+\begin{funcdesc} {set_datadir}{??}
+\end{funcdesc}
+
+\begin{funcdesc} {get_datadir}{??}
+\end{funcdesc}
+
+\begin{funcdesc} {set_time}{??}
+\end{funcdesc}
+
+\begin{funcdesc} {set_default_order}{??}
+\end{funcdesc}
+
+
 %%%%%%
 \section{Setting Quantities}
@@ -978 +1017 @@
 
 
+
+\begin{funcdesc} {get_boundary_tags}{??}
+\end{funcdesc}
+
 %%%
 \subsection{Predefined boundary conditions}
@@ -1052 +1095 @@
 
 
-\section{Diagnostics}
-
-  \begin{funcdesc}{write\_time}{???}
+\section{Evolution}
+
+  \begin{funcdesc}{evolve}{???}
 
   \end{funcdesc}
 
 
-  \begin{funcdesc}{write\_boundary\_statistics}{???}
+
+\subsection{Diagnostics}
+
+  \begin{funcdesc}{timestepping_statistics}{???}
 
   \end{funcdesc}
+
+
+  \begin{funcdesc}{boundary\_statistics}{???}
+
+  \end{funcdesc}
+  
+  
+  \begin{funcdesc}{get_quantity}{???}
+  Module: \code{pyvolution.domain}  
+  Allow access to individual quantities and their methods
+  
+  \end{funcdesc}  
+  
+  
+  \begin{funcdesc}{get_values}{???}
+  Module: \code{pyvolution.quantity}    
+  
+  Extract values for quantity as an array
+  
+  \end{funcdesc}    
+  
+  
+  \begin{funcdesc}{get_integral}{???}
+  Module: \code{pyvolution.quantity}    
+  
+  Return computed integral over entire domain for this quantity
+  
+  \end{funcdesc}      
+  
+  
+  
+  
+  
+  
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -1151 +1231 @@
 \code{pyvolution}
 \end{tabular}
+
+
+\subsection{Basic file conversions}
+
+  \begin{funcdesc}{sww2dem}{???}
+  Module: \code{pyvolution.data\_manager}    
+  
+  
+  \end{funcdesc}      
+
+  
+  \begin{funcdesc}{dem2pts}{???}
+  Module: \code{pyvolution.data_manager}    
+  
+  
+  \end{funcdesc}        
 
 %\[
@@ -1385 +1481 @@
 \section{geo_spatial_data}
 
+This describes a class that represents arbitrary point data in UTM 
+coordinates along with named attribute values.
+
+TBA
+
 \section{pmesh GUI}
 
@@ -1390 +1491 @@
 
 
-\section{utilities/numerical_tools} Could do now.
+\section{utilities/numerical_tools} Do now.
 
 \begin{itemize}

documentation/user_manual/examples/runsydney.py

@@ -135 +135 @@
 t0 = time.time()
 
-for t in domain.evolve(yieldstep = 120, finaltime = 18000): 
-    domain.write_time()
-    domain.write_boundary_statistics(tags = 'bottom')     
+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()-t0)