Provide some documentation for what _faceToCellDistanceRatio is and

why it's scalar. Addresses #475
usnistgov · Dec 27, 2015 · 3f73d02 · 3f73d02
1 parent b542e0c
commit 3f73d02
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/fipy/meshes/uniformGrid1D.py b/fipy/meshes/uniformGrid1D.py
@@ -248,6 +248,11 @@ def _cellVolumes(self):
 
     @property
     def _faceToCellDistanceRatio(self):
+        """how far face is from first to second cell
+        
+        distance from center of face to center of first cell divided by distance
+        between cell centers
+        """
         distances = numerix.ones(self.numberOfFaces, 'd')
         distances *= 0.5
         if len(distances) > 0:

diff --git a/fipy/meshes/uniformGrid2D.py b/fipy/meshes/uniformGrid2D.py
@@ -344,6 +344,11 @@ def _cellDistances(self):
 
     @property
     def _faceToCellDistanceRatio(self):
+        """how far face is from first to second cell
+        
+        distance from center of face to center of first cell divided by distance
+        between cell centers
+        """
         faceToCellDistanceRatios = numerix.zeros(self.numberOfFaces, 'd')
         faceToCellDistanceRatios[:] = 0.5
         faceToCellDistanceRatios[:self.nx] = 1.

diff --git a/fipy/meshes/uniformGrid3D.py b/fipy/meshes/uniformGrid3D.py
@@ -258,6 +258,11 @@ def _cellDistances(self):
 
     @property
     def _faceToCellDistanceRatio(self):
+        """how far face is from first to second cell
+        
+        distance from center of face to center of first cell divided by distance
+        between cell centers
+        """
         XYdis = numerix.zeros((self.nx, self.ny, self.nz + 1),'d')
         XYdis[:] = 0.5
         XYdis[..., 0] = 1