Changeset 767

Timestamp:

Jan 21, 2005, 12:07:59 PM (20 years ago)

Author:

ole

Message:

Clean up and comments

Location:

inundation/ga/storm_surge/pyvolution

Files:

• shallow_water.py (modified) (6 diffs)
• shallow_water_ext.c (modified) (1 diff)
• test_shallow_water.py (modified) (1 diff)

inundation/ga/storm_surge/pyvolution/shallow_water.py

@@ -6 +6 @@
 consisting of methods specific to the Shallow Water Wave Equation
 
-FIXME: Write equations here!
-
-
-Conserved quantities are w (water level or stage), uh (x momentum)
-and vh (y momentum).
+
+U_t + E_x + G_y = S
+
+where
+
+U = [w, uh, vh]
+E = [uh, u^2h + gh^2/2, uvh]
+G = [vh, uvh, v^2h + gh^2/2]
+S represents source terms forcing the system
+(e.g. gravity, friction, wind stress, ...)
+
+
+The quantities are
+
+symbol    variable name    explanation 
+z         elevation        elevation of bed on which flow is modelled
+h         height           water height above z
+w         stage            water level, w = z+h
+u                          speed in the x direction
+v                          speed in the y direction
+uh        xmomentum        momentum in the x direction 
+vh        ymomentum        momentum in the y direction
+
+eta                        mannings friction coefficient
+nu                         wind stress coefficient
+
+The conserved quantities are w, uh, vh
+
+
+For details see e.g.
+Christopher Zoppou and Stephen Roberts,
+Catastrophic Collapse of Water Supply Reservoirs in Urban Areas,
+Journal of Hydraulic Engineering, vol. 127, No. 7 July 1999
+
 
 
@@ -81 +110 @@
         level = self.quantities['level']
         bed = self.quantities['elevation']        
-
-        #msg = 'All water levels must be greater than the bed elevation'
-        #assert alltrue( greater_equal(
-        #    level.vertex_values, bed.vertex_values )), msg
-        # 
-        #assert alltrue( greater_equal(
-        #    level.edge_values, bed.edge_values )), msg
-        # 
-        #assert alltrue( greater_equal(
-        #    level.centroid_values, bed.centroid_values )), msg        
 
 
@@ -220 +239 @@
     """
 
-    #FIXME: Needs to be tested
-
     from Numeric import zeros, Float
     
@@ -233 +250 @@
         raise 'Normal vector must be an Numeric array'
 
-    #FIXME: Put this test into C-extension as well
     assert l == 2, 'Normal vector must have 2 components'
-
+    
  
     n1 = normal[0]
@@ -423 +439 @@
         Ymom.explicit_update[k] = flux[2]
 
-    #print 'FLUX l', Level.explicit_update
-    #print 'FLUX x', Xmom.explicit_update
-    #print 'FLUX y', Ymom.explicit_update    
     
     domain.timestep = timestep    
@@ -563 +576 @@
             xmomc[k] = ymomc[k] = 0.0
         
-        #FIXME: Delete    
-        #From 'newstyle
-        #if hc[k] < domain.minimum_allowed_height:        
-        #     if hc[k] < 0.0:
-        #            #Control level and height
-        #            wc[k] = zc[k]
-        #
-        #        #Control momentum
-        #        xmomc[k] = ymomc[k] = 0.0
-        #else:
-            
 
 

inundation/ga/storm_surge/pyvolution/shallow_water_ext.c

@@ -431 +431 @@
   normal = (PyArrayObject *) 
     PyArray_ContiguousFromObject(Normal, PyArray_DOUBLE, 0, 0);
-  
+
+  
+  if (normal -> dimensions[0] != 2) {
+    PyErr_SetString(PyExc_RuntimeError, "Normal vector must have 2 components");
+    return NULL;
+  }
+
   //Allocate space for return vector r (don't DECREF) 
   dimensions[0] = 3;

inundation/ga/storm_surge/pyvolution/test_shallow_water.py

@@ -94 +94 @@
         assert allclose(w, q)
 
-
+        #Check error check
+        try:
+            rotate(r, array([1,1,1]) )
+        except:
+            pass
+        else:
+            raise 'Should have raised an exception'
 
     def test_flux_zero_case(self):