Changeset 3642

Timestamp:

Sep 21, 2006, 11:30:59 AM (18 years ago)

Author:

ole

Message:

Renamed minimum_sww_depth to minimum_storable_height

Files:

• anuga_core/documentation/user_manual/anuga_user_manual.tex (modified) (2 diffs)
• anuga_core/source/anuga/config.py (modified) (1 diff)
• anuga_core/source/anuga/shallow_water/data_manager.py (modified) (4 diffs)
• anuga_core/source/anuga/shallow_water/shallow_water_domain.py (modified) (4 diffs)
• anuga_core/source/anuga/shallow_water/test_data_manager.py (modified) (3 diffs)
• anuga_work/development/dam_2006/run_dam.py (modified) (1 diff)
• anuga_work/production/hobart_2006/run_hobart.py (modified) (1 diff)

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -1400 +1400 @@
 \end{methoddesc}
 
-\begin{methoddesc} {set\_minimum_sww_depth}{time=0.0}
+\begin{methoddesc} {set\_minimum_storable_height}{time=0.0}
     Module: \module{pyvolution.domain}
 
     Sets the minimum depth that will be recognised when writing
-        to an sww file. This is useful for removing thin water layers
-        that seems to be caused by friction creep.
+    to an sww file. This is useful for removing thin water layers
+    that seems to be caused by friction creep.
 \end{methoddesc}
 
@@ -1648 +1648 @@
 
 \begin{classdesc}{Reflective\_boundary}{Boundary}
-Module: \module{pyvolution.shallow\_water}
+Module: \module{shallow\_water}
 
 Reflective boundary returns same conserved quantities as those present in

anuga_core/source/anuga/config.py

@@ -106 +106 @@
 
 #Specific to shallow water W.E.
-minimum_allowed_height = 1.0e-3 #Water depth below which it is considered to be 0
+minimum_allowed_height = 1.0e-3 #Water depth below which it is considered to be 0 in the model
 maximum_allowed_speed = 100.0 #Maximal particle speed of water
 
-minimum_sww_depth = 0.0
+minimum_storable_height = 0.001 #Water depth below which it is *stored* as 0

anuga_core/source/anuga/shallow_water/data_manager.py

@@ -67 +67 @@
 from anuga.coordinate_transforms.geo_reference import Geo_reference
 from anuga.geospatial_data.geospatial_data import Geospatial_data
-from anuga.config import minimum_sww_depth
+from anuga.config import minimum_storable_height as default_minimum_storable_height
 
 def make_filename(s):
@@ -252 +252 @@
         Data_format.__init__(self, domain, 'sww', mode)
 
-        if hasattr(domain, 'minimum_sww_depth'):
-            self.minimum_sww_depth =  domain.minimum_sww_depth
+        if hasattr(domain, 'minimum_storable_height'):
+            self.minimum_storable_height =  domain.minimum_storable_height
         else:
-            self.minimum_sww_depth = minimum_sww_depth
+            self.minimum_storable_height = default_minimum_storable_height
 
         # NetCDF file definition
@@ -380 +380 @@
         from os import stat
 
-        minimum_sww_depth = 0.001
-        #minimum_sww_depth = 0.0  #FIXME pass in or read from domain
         from Numeric import choose
 
@@ -482 +480 @@
                     #print z[:]
                     #print A-z[:]
-                    A = choose( A-z[:] >= self.minimum_sww_depth,
-                                (z[:], A))
+                    A = choose(A-z[:] >= self.minimum_storable_height,
+                               (z[:], A))
                     stage[i,:] = A.astype(self.precision)
                 elif name == 'xmomentum':

anuga_core/source/anuga/shallow_water/shallow_water_domain.py

@@ -85 +85 @@
 
 from anuga.utilities.numerical_tools import gradient, mean
-from anuga.config import minimum_sww_depth
+from anuga.config import minimum_storable_height
 
 
@@ -148 +148 @@
         self.format = 'sww'
         self.set_store_vertices_uniquely(False)
-        self.minimum_sww_depth = minimum_sww_depth
+        self.minimum_storable_height = minimum_storable_height
         self.quantities_to_be_stored = ['stage','xmomentum','ymomentum']
 
@@ -165 +165 @@
 
 
-    def set_minimum_sww_depth(self, minimum_sww_depth):
+    def set_minimum_storable_height(self, minimum_storable_height):
         """
         Set the minimum depth that will be recognised when writing
@@ -173 +173 @@
         The minimum allowed sww depth is in meters.
         """
-        self.minimum_sww_depth = minimum_sww_depth
+        self.minimum_storable_height = minimum_storable_height
 
 

anuga_core/source/anuga/shallow_water/test_data_manager.py

@@ -459 +459 @@
 
 
-    def test_sww_minimum_sww_depth(self):
+    def test_sww_minimum_storable_height(self):
         """Test that sww information can be written correctly
         multiple timesteps using a different reduction operator (min)
@@ -472 +472 @@
         self.domain.smooth = True
         self.domain.reduction = min
-        self.domain.minimum_sww_depth = 100
+        self.domain.minimum_storable_height = 100
 
         sww = get_dataobject(self.domain)
@@ -4986 +4986 @@
 #-------------------------------------------------------------
 if __name__ == "__main__":
-    #suite = unittest.makeSuite(Test_Data_Manager,'test_sww_minimum_sww_depth')
+    #suite = unittest.makeSuite(Test_Data_Manager,'test_sww_minimum_storable_height')
     suite = unittest.makeSuite(Test_Data_Manager,'test')
     runner = unittest.TextTestRunner()

anuga_work/development/dam_2006/run_dam.py

@@ -71 +71 @@
     domain.set_datadir(project.outputtimedir)
     domain.set_quantities_to_be_stored(['stage', 'xmomentum', 'ymomentum'])
-    domain.set_minimum_sww_depth(0.01)
+    domain.set_minimum_storable_height(0.01)
     domain.set_store_vertices_uniquely(True)  # for writting to sww
 

anuga_work/production/hobart_2006/run_hobart.py

@@ -146 +146 @@
 domain.set_datadir(project.outputtimedir)
 domain.set_quantities_to_be_stored(['stage', 'xmomentum', 'ymomentum'])
-domain.set_minimum_sww_depth(0.01)
+domain.set_minimum_storable_height(0.01)
 domain.set_store_vertices_uniquely(True)  # for writting to sww