Changeset 7791


Ignore:
Timestamp:
Jun 6, 2010, 11:32:39 AM (10 years ago)
Author:
steve
Message:

Added some documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/anuga_core/source/anuga/__init__.py

    r7780 r7791  
    100100#-----------------------------
    101101def rectangular_cross_domain(*args, **kwargs):
     102    """
     103    Create a rectangular domain with triangulation made
     104    up of m+1 by n+1 uniform rectangular cells divided
     105    into 4 triangles in a cross pattern
     106
     107    Arguments
     108    m:      number of cells in x direction
     109    n:      number of cells in y direction
     110    len1:   length of domain in x direction (left to right)
     111            (default 1.0)
     112    len2:   length of domain in y direction (bottom to top)
     113            (default 1.0)
     114    origin: tuple (x,y) specifying location of lower left corner
     115            of domain (default (0,0))
     116    """
    102117    points, vertices, boundary = rectangular_cross(*args, **kwargs)
    103118    return Domain(points, vertices, boundary)
     
    107122#----------------------------
    108123def create_domain_from_file(file):
     124    """
     125    Create a domain from a file
     126    """
    109127    return pmesh_to_domain_instance(file,Domain)
    110128
Note: See TracChangeset for help on using the changeset viewer.