Changeset 4258 for anuga_core/documentation

Timestamp:

Feb 14, 2007, 3:03:11 PM (18 years ago)

Author:

ole

Message:

Added set_minimum_allowed_height and updated user manual.
Played with Brad's dam break example.

File:

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

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -1726 +1726 @@
     \code{config.py}.
 \end{methoddesc}
+
+
+\begin{methoddesc} {set\_minimum_allowed_height}{}
+    Module: \module{shallow\_water.shallow\_water\_domain}
+
+    Set the minimum depth (in meters) that will be recognised in 
+    the numerical scheme (including limiters and flux computations)
+    
+    Default value is $10^{-3}$ m, but by setting this to a greater value, 
+    e.g.\ for large scale simulations, the computation time can be 
+    significantly reduced. 
+\end{methoddesc}
+
 
 \begin{methoddesc} {set\_minimum_storable_height}{}