Changeset 2324

Timestamp:

Feb 2, 2006, 3:18:01 PM (19 years ago)

Author:

duncan

Message:

comments, removing dead code, variable name changes

File:

• inundation/pyvolution/pmesh2domain.py (modified) (6 diffs)

inundation/pyvolution/pmesh2domain.py

@@ -7 +7 @@
 """
 
-# FXME (DSG-DSG): Combine with function pmesh_to_domain_instance
 def pmesh_instance_to_domain_instance(mesh,
-                                      DomainClass,
-                                      setting_function=None):
+                                      DomainClass):
     """
     """
@@ -18 +16 @@
     vertex_coordinates, vertices, tag_dict, vertex_quantity_dict \
                         ,tagged_elements_dict, geo_reference = \
-                pmesh_to_domain(mesh_instance=mesh,
-                                setting_function=setting_function)
+                _pmesh_to_domain(mesh_instance=mesh)
 
 
@@ -39 +36 @@
     return domain
 
-def pmesh_to_domain_instance(fileName, DomainClass, setting_function = None):
+def pmesh_to_domain_instance(file_name, DomainClass):
     """
+    Converts a mesh file(.tsh or .msh), to a Domain instance.
+
+    file_name is the name of the mesh file to convert, including the extension
+
+    DomainClass is the Class that will be returned.
+    It must be a subclass of Domain, with the same interface as domain.
+    
     """
     #FIXME: If this is part of the public interface it needs a good docstring!
@@ -49 +53 @@
     vertex_coordinates, vertices, tag_dict, vertex_quantity_dict \
                         ,tagged_elements_dict, geo_reference = \
-                pmesh_to_domain(fileName=fileName,
-                                setting_function=setting_function)
+                _pmesh_to_domain(file_name=file_name)
 
 
@@ -86 +89 @@
 
 
-def pmesh_to_domain(fileName=None,
-                    mesh_instance=None,
-                    setting_function=None):
+def _pmesh_to_domain(file_name=None,
+                    mesh_instance=None):
     """
     convert a pmesh dictionary to a list of Volumes.
@@ -105 +107 @@
     from load_mesh.loadASCII import import_mesh_file
 
-    if fileName is None:
+    if file_name is None:
         mesh_dict = mesh_instance.Mesh2IODict()
     else:
-        mesh_dict = import_mesh_file(fileName)
+        mesh_dict = import_mesh_file(file_name)
     #print "mesh_dict",mesh_dict
     vertex_coordinates = mesh_dict['vertices']