Changeset 274 for inundation/ga/storm_surge/pyvolution/shallow_water.py

Timestamp:

Sep 6, 2004, 1:57:41 PM (20 years ago)

Author:

ole

Message:

Cleaned up distribute

File:

• inundation/ga/storm_surge/pyvolution/shallow_water.py (modified) (2 diffs)

inundation/ga/storm_surge/pyvolution/shallow_water.py

@@ -386 +386 @@
 
 def distribute_to_vertices_and_edges(domain):
-
-    protect_against_infintesimal_and_negative_heights(domain)    
-    if domain.order == 1:
-        extrapolate_first_order(domain)
-    elif domain.order == 2:
-        extrapolate_second_order(domain)
-    else:
-        raise 'Unknown order'
-    
-    #Compute edge values
+    """Distribution from centroids to vertices specific to the
+    shallow water wave
+    equation.
+
+    It will ensure that h (w-z) is always non-negative even in the
+    presence of steep bed-slopes by taking a weighted average between shallow 
+    and deep cases.
+    
+    In addition, all conserved quantities get distributed as per either a
+    constant (order==1) or a piecewise linear function (order==2).
+    
+    FIXME: more explanation about removal of artificial variability etc
+
+    Precondition:
+      All quantities defined at centroids and bed elevation defined at
+      vertices.
+
+    Postcondition
+      Conserved quantities defined at vertices
+    
+    """
+
+    #Remove very thin layers of water
+    protect_against_infintesimal_and_negative_heights(domain)
+
+    #Extrapolate all conserved quantities
+    for name in domain.conserved_quantities:
+        Q = domain.quantities[name]
+        if domain.order == 1:
+            Q.extrapolate_first_order()
+        elif domain.order == 2:
+            Q.extrapolate_second_order()
+            Q.limit()                                
+        else:
+            raise 'Unknown order'
+
+    #Take bed slevation into account when heights are small    
+    balance_deep_and_shallow(domain)
+    
+    #Compute edge values by interpolation
     for name in domain.conserved_quantities:
         Q = domain.quantities[name]
         Q.interpolate_from_vertices_to_edges()
                     
-    #domain.w.interpolate_from_vertices_to_edges()            
-    #domain.uh.interpolate_from_vertices_to_edges()            
-    #domain.vh.interpolate_from_vertices_to_edges()                    
     
 
@@ -443 +470 @@
     protect(domain.minimum_allowed_height, wc, zc, xmomc, ymomc)
     
-
-
-def extrapolate_first_order(domain):
-    """First order extrapolator function, specific
-    to the shallow water wave equation.
-    
-    It will ensure that h (w-z) is always non-negative even in the
-    presence of steep bed-slopes (see comment in code)
-    In addition, momemtums get distributed as constant values.
-
-    Precondition:
-      All quantities defined at centroids and bed elevation defined at
-      vertices.
-
-    Postcondition
-      Conserved quantities defined at vertices
-    """
-
-    #Shortcuts
-    wc = domain.quantities['level'].centroid_values
-    zc = domain.quantities['elevation'].centroid_values
-    xmomc = domain.quantities['xmomentum'].centroid_values
-    ymomc = domain.quantities['ymomentum'].centroid_values            
-    hc = wc - zc   #Water depths at centroids
-
-
-    #Update conserved quantities using straight first order
-    for name in domain.conserved_quantities:
-        Q = domain.quantities[name]
-        Q.extrapolate_first_order()
-
-
-
-
-    balance_deep_and_shallow(domain)
-
-
-    
-            
-        
-def extrapolate_second_order(domain):
-    """Second order limiter function, specific to the shallow water wave
-    equation.
-    
-    It will ensure that h (w-z) is always non-negative even in the
-    presence of steep bed-slopes (see comment in code)
-
-    A weighted average between shallow 
-    and deep cases is as in the first order case.
-    
-    In addition, all conserved quantities get distributed as per a
-    piecewise linear function.
-    FIXME: more explanation about removal of artificial variability etc
-
-    Precondition:
-      All quantities defined at centroids and bed elevation defined at
-      vertices.
-
-    Postcondition
-      Conserved quantities defined at vertices
-    
-    """
-    
-
-    #Update conserved quantities using straight second order with limiter
-    for name in domain.conserved_quantities:
-        Q = domain.quantities[name]
-        Q.extrapolate_second_order()
-        Q.limit()        
-
-    balance_deep_and_shallow(domain)
-
 
 def balance_deep_and_shallow(domain):