Changeset 2600

Timestamp:

Mar 27, 2006, 6:55:32 AM (18 years ago)

Author:

howard

Message:

Added material on evolve, plus a few other minor changes

File:

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

documentation/user_manual/anuga_user_manual.tex

@@ -216 +216 @@
 that describes each step of the program and explains it significance.
 
-\verbatiminput{examples/bedslopephysical.py}
+%\verbatiminput{examples/bedslopephysical.py}
+\verbatiminput{examples/bedslope.py}
 
 \subsection{Establishing the Mesh}
@@ -484 +485 @@
 \begin{figure}[hbt] 
 
-  \centerline{ \includegraphics[width=75mm, height=75mm]{examples/bedslopestart.eps}}
+%  \centerline{ \includegraphics[width=75mm, height=75mm]{examples/bedslopestart.eps}}
   
   \caption{Bedslope example viewed with Swollen}
@@ -494 +495 @@
 
   \centerline{ 
-    \includegraphics[width=75mm, height=75mm]{examples/bedslopeduring.eps}
-    \includegraphics[width=75mm, height=75mm]{examples/bedslopeend.eps}
+%    \includegraphics[width=75mm, height=75mm]{examples/bedslopeduring.eps}
+%    \includegraphics[width=75mm, height=75mm]{examples/bedslopeend.eps}
    }    
   
@@ -1132 +1133 @@
 \section{Evolution}
 
-  \begin{funcdesc}{evolve}{???}
+  \begin{funcdesc}{evolve}{yieldstep = None, finaltime = None, duration = None, skip_initial_step = False}
+  
+  Module: pyvolution.domain
+  
+  This function (a method of \code{domain}) is invoked once all the preliminary steps have been 
+  taken, and causes the model to progress through a successive steps in its evolution, during
+  which quantities are progressively recalculated and the domain may be modified. The user specifies
+  the time period over which the evolution is to take place, by specifying values (in seconds) for either
+  \code{duration} or \code{finaltime}, as well as the interval in seconds after which results are to be 
+  stored and statistics output.  
+  
+  You can include \code{evolve} in a statement of the type:
+  
+  {\small \begin{verbatim}
+      for t in domain.evolve(yieldstep, finaltime):
+          <Do something with domain and t>
+  \end{verbatim}}
 
   \end{funcdesc}