Changeset 2793

Timestamp:

May 3, 2006, 1:46:17 PM (18 years ago)

Author:

ole

Message:

Renaming and comments

File:

• inundation/pyvolution/domain.py (modified) (4 diffs)

inundation/pyvolution/domain.py

@@ -21 +21 @@
 
 
-    #FIXME (Ole): I would like this interface to automatically work out
-    #whether input is mesh data or a filename (as in set_quantity).
-    #That way the user need not remember the keyword arguments.
-    # DONE (DSG): It does mean that coordinates sometimes means mesh_filename
-    # though
-    def __init__(self, coordinates=None,
-                 vertices=None,
+    def __init__(self, source=None,
+                 triangles=None,
                  boundary=None,
                  conserved_quantities=None, other_quantities=None,
@@ -33 +28 @@
                  use_inscribed_circle=False,
                  mesh_filename=None):
-        if type(coordinates) == types.StringType:
-            mesh_filename = coordinates
+        """Instantiate generic computational Domain.
+        Input:
+          source:    Either a mesh filename or coordinates of mesh vertices. If it is a
+                     filename values specified for triangles will be overridden.
+          triangles: Mesh connectivity (see mesh.py for more information)
+          boundary:  See mesh.py for more information
+
+          conserved_quantities: List of quantity names entering the conservation equations
+          other_quantities:     List of other quantity names
+
+          tagged_elements:
+          ...
+
+          
+        """
+
+        # Determine whether source is a mesh filename or coordinates
+        if type(source) == types.StringType:
+            mesh_filename = source
+        else:
+            coordinates = source
+
+
+        # In case a filename has been specified, extract content    
         if mesh_filename is not None:
-            coordinates, vertices, boundary, vertex_quantity_dict \
-                                ,tagged_elements, geo_reference = \
-                                pmesh_to_domain(file_name=mesh_filename)
-
-        Mesh.__init__(self, coordinates, vertices, boundary,
+            coordinates, triangles, boundary, vertex_quantity_dict, \
+                         tagged_elements, geo_reference = \
+                         pmesh_to_domain(file_name=mesh_filename)
+
+            
+        # Initialise underlying mesh structure    
+        Mesh.__init__(self, coordinates, triangles, boundary,
                       tagged_elements, geo_reference, use_inscribed_circle)
 
@@ -46 +65 @@
         from quantity import Quantity, Conserved_quantity
 
-        #List of quantity names entering
-        #the conservation equations
-        #(Must be a subset of quantities)
+        # List of quantity names entering
+        # the conservation equations
         if conserved_quantities is None:
             self.conserved_quantities = []
@@ -54 +72 @@
             self.conserved_quantities = conserved_quantities
 
+        # List of other quantity names
         if other_quantities is None:
             self.other_quantities = []