Changeset 7791

Timestamp:

Jun 6, 2010, 11:32:39 AM (15 years ago)

Author:

steve

Message:

Added some documentation

File:

• trunk/anuga_core/source/anuga/__init__.py (modified) (2 diffs)

trunk/anuga_core/source/anuga/__init__.py

@@ -100 +100 @@
 #-----------------------------
 def rectangular_cross_domain(*args, **kwargs):
+    """
+    Create a rectangular domain with triangulation made
+    up of m+1 by n+1 uniform rectangular cells divided
+    into 4 triangles in a cross pattern
+
+    Arguments
+    m:      number of cells in x direction
+    n:      number of cells in y direction
+    len1:   length of domain in x direction (left to right)
+            (default 1.0)
+    len2:   length of domain in y direction (bottom to top)
+            (default 1.0)
+    origin: tuple (x,y) specifying location of lower left corner
+            of domain (default (0,0))
+    """
     points, vertices, boundary = rectangular_cross(*args, **kwargs)
     return Domain(points, vertices, boundary)
@@ -107 +122 @@
 #----------------------------
 def create_domain_from_file(file):
+    """
+    Create a domain from a file
+    """
     return pmesh_to_domain_instance(file,Domain)