Changeset 6131

Timestamp:

Jan 9, 2009, 3:12:32 PM (16 years ago)

Author:

ole

Message:

Documented add_quantity and csv2building_polygons

Location:

anuga_core

Files:

• documentation/user_manual/anuga_user_manual.tex (modified) (3 diffs)
• source/anuga/abstract_2d_finite_volumes/test_quantity.py (modified) (2 diffs)
• source/anuga/culvert_flows/culvert_class.py (modified) (1 diff)

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -1991 +1991 @@
     function = None,
     geospatial_data = None,
+    expression = None,    
     filename = None,
     attribute_name = None,
@@ -2049 +2050 @@
 
 \end{methoddesc}
+
+
+
+
+\begin{methoddesc}{add\_quantity}{name,
+    numeric = None,
+    quantity = None,
+    function = None,
+    geospatial_data = None,
+    expression = None,
+    filename = None,
+    attribute_name = None,
+    alpha = None,
+    location = 'vertices',
+    indices = None,
+    verbose = False,
+    use_cache = False}
+  Module: \module{abstract\_2d\_finite\_volumes.domain}
+  (see also \module{abstract\_2d\_finite\_volumes.domain.set\_quantity})
+
+\label{add quantity}
+This function is used to \emph{add} values to individual quantities for a
+domain. It has the same syntax as \code{domain.set\_quantity(name, x)}.
+
+A typical use of this function is to add structures to an existing elevation model:
+
+{\small
+\begin{verbatim} 
+    # Create digital elevation model from points file
+    domain.set_quantity('elevation', 
+                        filename = 'elevation_file.pts,
+                        verbose = True)
+
+    # Add buildings from file
+    building_polygons, building_heights = csv2building_polygons(building_file)
+
+    B = []
+    for key in building_polygons:
+        poly = building_polygons[key]
+        elev = building_heights[key]
+        B.append((poly, elev))
+
+    domain.add_quantity('elevation', Polygon_function(B, default=0.0))
+
+\end{verbatim}}
+
+\end{methoddesc}
+
+
 
 
@@ -3272 +3322 @@
   \end{funcdesc}
 
+  
+  
+  
+\begin{funcdesc}{csv2building\_polygons}{file\_name, floor\_height=3}
+
+Module: \module{shallow\_water.data\_manager}
+
+Convert CSV files of the form:
+{\small
+\begin{verbatim} 
+    easting,northing,id,floors
+    422664.22,870785.46,2,0
+    422672.48,870780.14,2,0
+    422668.17,870772.62,2,0
+    422660.35,870777.17,2,0
+    422664.22,870785.46,2,0
+    422661.30,871215.06,3,1
+    422667.50,871215.70,3,1
+    422668.30,871204.86,3,1
+    422662.21,871204.33,3,1
+    422661.30,871215.06,3,1
+\end{verbatim} }
+
+to a dictionary of polygons with id as key.
+The associated number of floors are converted to m above MSL and 
+returned as a separate dictionary also keyed by id.
+    
+Optional parameter floor_height is the height of each building story.
+
+These can e.g. be converted to a Polygon\_function for use with add\_quantity
+as shown on page \pageref{add quantity}.
+\end{funcdesc}
+
+  
+  
 
 

anuga_core/source/anuga/abstract_2d_finite_volumes/test_quantity.py

@@ -326 +326 @@
         quantity = Quantity(self.mesh4)
 
-        #Try constants first
+        # Try constants first
         const = 5
         quantity.set_values(const, location = 'vertices')
@@ -333 +333 @@
         assert allclose(quantity.get_integral(), self.mesh4.get_area() * const)
 
-        #Try with a linear function
+        # Try with a linear function
         def f(x, y):
             return x+y

anuga_core/source/anuga/culvert_flows/culvert_class.py

@@ -415 +415 @@
         self.last_update = time
 
+            
+        if hasattr(self, 'log_filename'):
+            log_filename = self.log_filename
             
         # Compute stage and energy at the