Changeset 4705 for anuga_core/documentation/user_manual/anuga_user_manual.tex

Timestamp:

Sep 5, 2007, 5:17:30 PM (16 years ago)

Author:

ole

Message:

Some documentation of ticket:192 plus storage of restricting polygon and time_interval for extrema computations.

File:

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

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -2314 +2314 @@
   \end{funcdesc}
 
-
+  
+  \begin{funcdesc}{set\_quantities\_to\_be\_monitored}{}
+  Module: \module{abstract\_2d\_finite\_volumes.domain}
+
+  Selects quantities and derived quantities for which extrema attained at internal timesteps 
+  will be collected.
+  
+  Information can be tracked in the evolve loop by printing \code{quantity\_statistics} and 
+  collected data will be stored in the sww file.
+
+  Optional parameters \code{polygon} and \code{time\_interval} may be specified to restrict the 
+  extremum computation.
+  \end{funcdesc}  
+    
+  \begin{funcdesc}{quantity\_statistics}{}
+  Module: \module{abstract\_2d\_finite\_volumes.domain}
+
+  Reports on extrema attained by selected quantities.
+  
+  Returns a string of the following type for each
+  timestep:
+
+  \begin{verbatim} 
+  Monitored quantities at time 1.0000:
+    stage-elevation:
+      values since time = 0.00 in [0.00000000, 0.30000000]
+      minimum attained at time = 0.00000000, location = (0.16666667, 0.33333333)
+      maximum attained at time = 0.00000000, location = (0.83333333, 0.16666667)
+    ymomentum:
+      values since time = 0.00 in [0.00000000, 0.06241221]
+      minimum attained at time = 0.00000000, location = (0.33333333, 0.16666667)
+      maximum attained at time = 0.22472667, location = (0.83333333, 0.66666667)
+    xmomentum:
+      values since time = 0.00 in [-0.06062178, 0.47886313]
+      minimum attained at time = 0.00000000, location = (0.16666667, 0.33333333)
+      maximum attained at time = 0.35103646, location = (0.83333333, 0.16666667)
+  \end{verbatim}     
+
+  The quantities (and derived quantities) listed here must be selected at model 
+  initialisation using the method \code{domain.set_quantities_to_be_monitored}.\\
+   
+  The optional keyword argument \code{precision='\%.4f'} will
+  determine the precision used for floating point values in the output.
+  This diagnostics helps track extrema attained by the selected quantities 
+  at every internal timestep.
+
+  These values are also stored in the sww file for post processing.
+
+  \end{funcdesc}
+  
+
+  
   \begin{funcdesc}{get\_values}{location='vertices', indices = None}
   Module: \module{abstract\_2d\_finite\_volumes.quantity}