Changeset 1748

Timestamp:

Aug 23, 2005, 5:23:25 PM (19 years ago)

Author:

ole

Message:

Work on new set_quantity

File:

• inundation/pyvolution/quantity.py (modified) (1 diff)

inundation/pyvolution/quantity.py

@@ -82 +82 @@
 
     #New leaner interface to setting values
-    #def set_quantity(self,
-    #                 numeric = None,  #List, numeric array or constant
-    #                 function = None, #Callable object: f(x,y) where x any are arrays 
-    #                 points = None, values = None, alpha = None, #Input for least squares
-    #                 filename, attribute_name,                   #Input from file
-    #                 location 
+    def set_quantity(self,
+                     numeric = None,  #List, numeric array or constant
+                     quantity = None, #Another quantity 
+                     function = None, #Callable object: f(x,y)  
+                     points = None, values = None, #Input for least squares
+                     filename = None, attribute_name = None, #Input from file
+                     alpha = None, 
+                     location = None,
+                     verbose = None):
+        
+        """Set values for quantity based on different sources.
+
+        numeric:
+        
+          Compatible list, Numeric array (see below) or constant
+
+        quantity:
+
+          Another quantity (compatible quantity, e.g. obtained as a
+          linear combination of quantities)
+
+
+        function:
+          Any callable object that takes two 1d arrays x and y
+          each of length N and returns an array also of length N.
+
+        points:
+          Nx2 array of data points for use with least squares fit
+          If points are present, an N array of attribute
+          values corresponding to
+          each data point must be present.
+
+        filename:
+          Name of pts file containing data points and attributes for
+          use with least squares.
+          If attribute_name is specified, any array matching that name
+          will be used. Otherwise the first available one will be used.
+          
+        alpha:
+          Smoothing parameter to be used with least squares fits.
+          See module least_squares for further details about alpha.
+               
+          
+          
+        location: Where values are to be stored.
+                  Permissible options are: vertices, edges, centroids
+                  Default is "vertices"
+
+        In case of location == 'centroids' the dimension values must
+        be a list of a Numerical array of length N, N being the number
+        of elements. Otherwise it must be of dimension Nx3
+
+        The values will be stored in elements following their
+        internal ordering.
+
+        If values are described a function, it will be evaluated at
+        specified points
+
+        If indexex is not 'unique vertices' Indexes is the set of element ids
+        that the operation applies to.
+        If indexex is 'unique vertices' Indexes is the set of vertex ids
+        that the operation applies to.
+
+
+        If selected location is vertices, values for centroid and edges
+        will be assigned interpolated values.
+        In any other case, only values for the specified locations
+        will be assigned and the others will be left undefined.
+        
+        """
+        pass
+
+    
+