Changeset 4369

Timestamp:

Apr 13, 2007, 2:37:45 PM (18 years ago)

Author:

ole

Message:

Added blurb about track_speeds diagnostics in documentation.

File:

• anuga_core/documentation/user_manual/anuga_user_manual.tex (modified) (1 diff)

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -2255 +2255 @@
 
   Here the numbers in \code{steps=12 (12)} indicate the number of steps taken and
-  the number of first-order steps, respectively.
+  the number of first-order steps, respectively.\\
+  
+  The optional keyword argument \code{track_speeds=True} will 
+  generate a histogram of speeds generated by each triangle. The 
+  speeds relate to the size of the timesteps used by ANUGA and 
+  this diagnostics may help pinpoint problem areas where excessive speeds 
+  are generated.  
+  
   \end{funcdesc}