Changeset 2300 for inundation/pyvolution/shallow_water.py

Timestamp:

Jan 30, 2006, 9:47:34 AM (19 years ago)

Author:

ole

Message:

Implemented set_quantities_to_be_stored and used it in bedslope.py

File:

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

inundation/pyvolution/shallow_water.py

@@ -89 +89 @@
 
         #Stored output
-        self.store = False
+        self.store = True
         self.format = 'sww'
         self.smooth = True
@@ -101 +101 @@
 
 
+    def set_quantities_to_be_stored(self, q):
+        """Specify which quantities will be stored in the sww file.
+
+        q must be either:
+          - the name of a quantity
+          - a list of quantity names
+          - None
+
+        In the two first cases, the named quantities will be stored at each yieldstep
+        (This is in addition to the quantities elevation and friction)  
+        If q is None, storage will be switche off altogether.
+        """
+
+
+        if q is None:
+            self.quantities_to_be_stored = []            
+            self.store = False
+            return
+
+        if isinstance(q, basestring):
+            q = [q] # Turn argument into a list
+
+        #Check correcness    
+        for quantity_name in q:
+            msg = 'Quantity %s is not a valid conserved quantity' %quantity_name
+            assert quantity_name in self.conserved_quantities, msg 
+        
+        self.quantities_to_be_stored = q
+        
 
     def initialise_visualiser(self,scale_z=1.0,rect=None):