Changeset 2612 for trunk

Timestamp:

06/23/2008 03:59:47 PM (7 months ago)

Author:

guyer

Message:

Unifying vector viewer tests

Location:

trunk/fipy/viewers

Files:

• gistViewer/gistVectorViewer.py (modified) (2 diffs)
• matplotlibViewer/matplotlibVectorViewer.py (modified) (6 diffs)
• viewer.py (modified) (7 diffs)

trunk/fipy/viewers/gistViewer/gistVectorViewer.py

@@ -7 +7 @@
  #  FILE: "gistViewer.py"
  #                                    created: 11/10/03 {2:48:25 PM} 
- #                                last update: 7/5/07 {9:30:57 AM} { 2:45:36 PM}
+ #                                last update: 6/23/08 {4:24:31 PM} { 2:45:36 PM}
  #  Author: Jonathan Guyer <guyer@nist.gov>
  #  Author: Daniel Wheeler <daniel.wheeler@nist.gov>
@@ -51 +51 @@
 
 class GistVectorViewer(GistViewer):
+    """Displays a vector plot of a 2D rank-1 `CellVariable` or
+    `FaceVariable` object using gist.
+    """
+
+    __doc__ += GistViewer._test2Dvector(viewer="GistVectorViewer")
+    __doc__ += GistViewer._test2DvectorIrregular(viewer="GistVectorViewer")
     
     def __init__(self, vars, limits=None, title = ''):
-        """
-            >>> from fipy import *
-            >>> mesh = Grid2D(nx=50, ny=100, dx=0.1, dy=0.01)
-            >>> x, y = mesh.getCellCenters()
-            >>> var = CellVariable(mesh=mesh, name=r"$sin(x y)$", value=numerix.sin(x * y))
-            >>> viewer = GistVectorViewer(vars=var.getGrad(), 
-            ...                           limits={'ymin':0.1, 'ymax':0.9},
-            ...                           title="GistVectorViewer test")
-            >>> viewer.plot()
-            >>> viewer._promptForOpinion()
-            >>> del viewer
-
-            >>> viewer = GistVectorViewer(vars=var.getFaceGrad(), 
-            ...                           limits={'ymin':0.1, 'ymax':0.9},
-            ...                           title="GistVectorViewer test")
-            >>> viewer.plot()
-            >>> viewer._promptForOpinion()
-            >>> del viewer
-            
-            >>> mesh = Tri2D(nx=50, ny=100, dx=0.1, dy=0.01)
-            >>> x, y = mesh.getCellCenters()
-            >>> var = CellVariable(mesh=mesh, name=r"$sin(x y)$", value=numerix.sin(x * y))
-            >>> viewer = GistVectorViewer(vars=var.getGrad(), 
-            ...                           limits={'ymin':0.1, 'ymax':0.9},
-            ...                           title="GistVectorViewer test")
-            >>> viewer.plot()
-            >>> viewer._promptForOpinion()
-            >>> del viewer
-
-            >>> viewer = GistVectorViewer(vars=var.getFaceGrad(), 
-            ...                           limits={'ymin':0.1, 'ymax':0.9, 'datamin':-0.9, 'datamax':2.0},
-            ...                           title="GistVectorViewer test")
-            >>> viewer.plot()
-            >>> viewer._promptForOpinion()
-            >>> del viewer
-
-        """
         GistViewer.__init__(self, vars=vars, limits=limits, title=title)
         

trunk/fipy/viewers/matplotlibViewer/matplotlibVectorViewer.py

@@ -7 +7 @@
  #  FILE: "matplotlibVectorViewer.py"
  #                                    created: 9/14/04 {2:48:25 PM} 
- #                                last update: 10/6/07 {8:08:02 PM} { 2:45:36 PM}
+ #                                last update: 6/23/08 {4:22:12 PM} { 2:45:36 PM}
  #  Author: Jonathan Guyer <guyer@nist.gov>
  #  Author: Daniel Wheeler <daniel.wheeler@nist.gov>
@@ -51 +51 @@
 
 class MatplotlibVectorViewer(MatplotlibViewer):
-    """
-    Displays a vector plot of a 2D rank-1 `CellVariable` or
+    """Displays a vector plot of a 2D rank-1 `CellVariable` or
     `FaceVariable` object using Matplotlib_
 
@@ -58 +57 @@
 
     """
+    
+    __doc__ += MatplotlibViewer._test2Dvector(viewer="MatplotlibVectorViewer")
+    __doc__ += """
+    
+            >>> for sparsity in arange(5000, 0, -500):
+            ...     viewer.quiver(sparsity=sparsity)
+            ...     viewer.plot()
+            >>> viewer._promptForOpinion()
+        
+    """
+    __doc__ += MatplotlibViewer._test2DvectorIrregular(viewer="MatplotlibVectorViewer")
 
     def __init__(self, vars, limits=None, title=None, scale=None, sparsity=None):
-        """
-        Creates a `Matplotlib2DViewer`.
-        
-            >>> from fipy import *
-            >>> from fipy.tools.numerix import *
-            >>> mesh = Grid2D(nx=50, ny=100, dx=0.1, dy=0.01)
-            >>> x, y = mesh.getCellCenters()
-            >>> xyVar = CellVariable(mesh=mesh, name="x y", value=x * y)
-            >>> k = Variable(name="k")
-            >>> viewer = MatplotlibVectorViewer(vars=sin(k * xyVar).getGrad(), 
-            ...                                 # limits={'ymin':0.1, 'ymax':0.9},
-            ...                                 title="MatplotlibVectorViewer test")
-            >>> for kval in numerix.arange(0,10,1):
-            ...     k.setValue(kval)
-            ...     viewer.plot()
-            >>> viewer._promptForOpinion()
-            >>> del viewer
-
-            >>> viewer = MatplotlibVectorViewer(vars=sin(k * xyVar).getFaceGrad(), 
-            ...                                 # limits={'ymin':0.1, 'ymax':0.9},
-            ...                                 title="MatplotlibVectorViewer test")
-            >>> for kval in numerix.arange(0,10,1):
-            ...     k.setValue(kval)
-            ...     viewer.plot()
-            >>> viewer._promptForOpinion()
-            >>> del viewer
-
-            >>> viewer = MatplotlibVectorViewer(vars=sin(k * xyVar).getFaceGrad(), 
-            ...                                 # limits={'ymin':0.1, 'ymax':0.9},
-            ...                                 title="MatplotlibVectorViewer test",
-            ...                                 sparsity=1000)
-            >>> for kval in numerix.arange(0,10,1):
-            ...     k.setValue(kval)
-            ...     viewer.plot()
-            >>> viewer._promptForOpinion()
-            >>> del viewer
+        """Creates a `Matplotlib2DViewer`.
 
         :Parameters:
@@ -110 +85 @@
         MatplotlibViewer.__init__(self, vars = vars, limits = limits, title = title)
 
+        self.quiver(sparsity=sparsity, scale=scale)
+        self.colorbar = False
+        
+        self._plot()
+        
+    def quiver(self, sparsity=None, scale=None):
         var = self.vars[0]
         mesh = var.getMesh()
@@ -135 +116 @@
         import pylab
         
-        self.quiver = pylab.quiver(X, Y, U, V, scale=scale)
-        self.colorbar = False
-        
-        self._plot()
-        
+        pylab.ion()
+        pylab.cla()
+        self._quiver = pylab.quiver(X, Y, U, V, scale=scale)
+        pylab.ioff()
+
     def _getSuitableVars(self, vars):
         from fipy.meshes.numMesh.mesh2D import Mesh2D
@@ -163 +144 @@
         V = numerix.take(V, self.indices)
 
-        self.quiver.set_UVC(U, V)
+        self._quiver.set_UVC(U, V)
         
         import pylab

trunk/fipy/viewers/viewer.py

@@ -169 +169 @@
             >>> x, = mesh.getCellCenters()
             >>> xVar = CellVariable(mesh=mesh, name="x", value=x)
-            >>> k = Variable(name="k")
+            >>> k = Variable(name="k", value=0)
             >>> viewer = %(viewer)s(vars=(sin(k * xVar), cos(k * xVar / pi)), 
             ...                 limits={'xmin':10, 'xmax':90, 'datamin':-0.9, 'datamax':2.0},
@@ -177 +177 @@
             ...     viewer.plot()
             >>> viewer._promptForOpinion()
-            >>> del viewer
         """ % kwargs
     _test1D = staticmethod(_test1D)
@@ -187 +186 @@
             >>> x, y = mesh.getCellCenters()
             >>> xyVar = CellVariable(mesh=mesh, name="x y", value=x * y)
-            >>> k = Variable(name="k")
+            >>> k = Variable(name="k", value=0)
             >>> viewer = %(viewer)s(vars=sin(k * xyVar), 
             ...                 limits={'ymin':0.1, 'ymax':0.9, 'datamin':-0.9, 'datamax':2.0},
@@ -195 +194 @@
             ...     viewer.plot()
             >>> viewer._promptForOpinion()
-            >>> del viewer
         """ % kwargs
     _test2Dbase = staticmethod(_test2Dbase)
@@ -211 +209 @@
     _test2Dirregular = staticmethod(_test2Dirregular)
 
+    def _test2DvectorBase(**kwargs):
+        return """
+            >>> from fipy import *
+            >>> mesh = %(mesh)s
+            >>> x, y = mesh.getCellCenters()
+            >>> xyVar = CellVariable(mesh=mesh, name="x y", value=x * y)
+            >>> k = Variable(name="k", value=0)
+            >>> viewer = %(viewer)s(vars=sin(k * xyVar).getGrad(), 
+            ...                 title="%(viewer)s test")
+            >>> for kval in range(10):
+            ...     k.setValue(kval)
+            ...     viewer.plot()
+            >>> viewer._promptForOpinion()
+
+            >>> viewer = %(viewer)s(vars=sin(k * xyVar).getFaceGrad(), 
+            ...                 title="%(viewer)s test")
+            >>> for kval in range(10):
+            ...     k.setValue(kval)
+            ...     viewer.plot()
+            >>> viewer._promptForOpinion()
+        """ % kwargs
+    _test2DvectorBase = staticmethod(_test2DvectorBase)
+
+    def _test2Dvector(**kwargs):
+        return Viewer._test2DvectorBase(mesh="Grid2D(nx=50, ny=100, dx=0.1, dy=0.01)",
+                                        **kwargs)
+    _test2Dvector = staticmethod(_test2Dvector)
+
+    def _test2DvectorIrregular(**kwargs):
+        """"""
+        return Viewer._test2DvectorBase(mesh="""(Grid2D(nx=5, ny=10, dx=0.1, dy=0.1)
+            ...         + (Tri2D(nx=5, ny=5, dx=0.1, dy=0.1) 
+            ...          + ((0.5,), (0.2,))))""", **kwargs)
+    _test2DvectorIrregular = staticmethod(_test2DvectorIrregular)
+
     
     def _test3D(**kwargs):
@@ -218 +251 @@
             >>> x, y, z = mesh.getCellCenters()
             >>> xyzVar = CellVariable(mesh=mesh, name=r"x y z", value=x * y * z)
-            >>> k = Variable(name="k")
+            >>> k = Variable(name="k", value=0)
             >>> viewer = %(viewer)s(vars=sin(k * xyzVar), 
             ...                     limits={'ymin':0.1, 'ymax':0.9, 'datamin':-0.9, 'datamax':2.0},
@@ -226 +259 @@
             ...     viewer.plot()
             >>> viewer._promptForOpinion()
-            >>> del viewer
         """ % kwargs
     _test3D = staticmethod(_test3D)