Changeset 4015

Timestamp:

Nov 21, 2006, 11:17:29 AM (18 years ago)

Author:

ole

Message:

User manual

Location:

anuga_core/documentation/user_manual

Files:

• anuga_user_manual.tex (modified) (3 diffs)
• triangularmesh.jpg (added)

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -1262 +1262 @@
 \begin{figure}[h]
   \begin{center}
-    %\includegraphics[width=90mm, height=90mm]{triangularmesh.eps}
+    \includegraphics[width=90mm, height=90mm]{triangularmesh.jpg}
   \end{center}
 
@@ -2025 +2025 @@
 
   \end{funcdesc}
-
+  
+  
+
+  \begin{funcdesc}{get\_maximum\_value}{indices = None}
+  Module: \module{abstract\_2d\_finite\_volumes.quantity}
+
+  Return maximum value of quantity (on centroids)
+
+  Optional argument indices is the set of element ids that 
+  the operation applies to. If omitted all elements are considered.
+
+  Note, we do not seek the maximum at vertices as each vertex can
+  have multiple values - one for each triangle sharing it.            
+  \end{funcdesc}
+
+  
+
+  \begin{funcdesc}{get\_maximum\_location}{indices = None}
+  Module: \module{abstract\_2d\_finite\_volumes.quantity}
+
+  Return location of maximum value of quantity (on centroids)
+
+        Optional argument indices is the set of element ids that the operation applies to.
+
+        Usage:
+            x, y = get_maximum_location()
+
+
+        Notes:
+            We do not seek the maximum at vertices as each vertex can
+            have multiple values - one for each triangle sharing it.
+
+            If there are multiple cells with same maximum value, the
+            first cell encountered in the triangle array is returned.       
+        """
+
+        i = self.get_maximum_index(indices)
+        x, y = self.domain.get_centroid_coordinates()[i]
+
+        return x, y
+
+
+  
+  
+  
+  
+  
+  
+  
 
   \begin{funcdesc}{get\_integral}{}
@@ -2950 +2998 @@
 
 
+   
+   
+   
 
 \section{\module{shallow\_water} --- 2D triangular domains for finite-volume