minor: documentation formatting

This commit is contained in:
Stephen McQuay 2011-03-23 11:23:32 -06:00
parent c9e6759e97
commit 2941a255c7
3 changed files with 13 additions and 12 deletions

View File

@ -145,7 +145,8 @@ def get_error(phi, R, S, order = 2):
def run_baker(X, R, S, order=2):
"""
This is the main function to call to get an interpolation to X from the input meshes
This is the main function to call to get an interpolation to X from the
input meshes
X -- the destination point (2D)
X = [0,0]

View File

@ -80,8 +80,8 @@ class grid(object):
def create_mesh(self, indicies):
"""
this function takes a list of indicies, and then creates
and returns a grid object (collection of verts and q).
this function takes a list of indicies, and then creates and returns a
grid object (collection of verts and q).
note: the input is indicies, the grid contains verts
"""
@ -93,10 +93,10 @@ class grid(object):
"""
this returns two grid objects: R and S.
R is a grid object that is supposedly a containing simplex
around point X (TODO: it tends not to be)
R is a grid object that is supposedly a containing simplex around point X
S is S_j from baker's paper : some verts from all point that are not the simplex
S is S_j from baker's paper : some verts from all point that are not the
simplex
"""
log.debug("extra verts: %d" % extra_points)
log.debug("simplex size: %d" % simplex_size)
@ -215,10 +215,9 @@ class cell(object):
"""
X = point of interest
G = corrensponding grid object (G.verts)
because of the way i'm storing things,
a cell simply stores indicies, and so one
must pass in a reference to the grid object
containing real verts.
because of the way i'm storing things, a cell simply stores indicies, and
so one must pass in a reference to the grid object containing real verts.
this simply calls grid.simplex.contains
"""

View File

@ -4,8 +4,9 @@ TOL = 1e-8
def contains(X, R):
"""
tests if X (point) is in R (a simplex,
represented by a list of n-degree coordinates)
tests if X (point) is in R
R is a simplex, represented by a list of n-degree coordinates
it now correctly checks for 2/3-D verts