stream_api
index
/upload/ChomboVis-4.16.4-and-everything/ChomboVis-4.16.4/doc/stream_api.py

 
Classes
       
StreamApi

 
class StreamApi
    Streamlines -- paths of massless particles through vector fields
 
  Methods defined here:
getGlyphs(self)
Return a VtkGlyphs object on which you can set various aspects of the
glyph state -- setConstantColor(), setColoringComponent(), etc.
hideGlyphs(self)
Undo effect of showGlyphs().
hideTubes(self)
Hide the tubes drawn by showTubes().
setAlgorithm(self, algo_name)
Legal choices are 'Nothing', 'Fixed Step', 'Clipped Step', and
'Hedgehog'.
setColor(self, rgb)
Set the color of the streamlines.  Arg rgb is a tuple with components
ranging over [0.0,1.0].
setComponentMapU(self, component_name)
We call the vector field's components U, V and W.  This function
determines the component to be identified with the U component.
setComponentMapV(self, component_name)
We call the vector field's components U, V and W.  This function
determines the component to be identified with the V component.
setComponentMapW(self, component_name)
We call the vector field's components U, V and W.  This function
determines the component to be identified with the W component.
setDiffuse(self, x)
Sets the Vtk diffuse lighting parameter.  Sets ambient to 1-x.
Legal range for x is [0.0, 1.0].
setFieldThreshold(self, x)
A point in the field gets displayed if at least one of its u, v or w
components exceeds the field threshold.
setIntegrateBackward(self, on_off)
If arg on_off is 1, we integrate backward from the seed points.
setIntegrateForward(self, on_off)
If arg on_off is 1, we integrate forward from the seed points.
setLineWidth(self, w)
Set the width of the streamlines.
setMaxLevel(self, n)
Arg n is the greatest level of refinement, data from which is to be
taken into account in calculating streamlines.
setMaxPointsPerLine(self, n)
Sets the maximum number of points along which to pursue the numerical
integration.  Not to be confused with the number of seed points.
setRelativeStepsize(self, x)
Ratio of the integration step length taken, to the local cell spacing.
setSeedSize(self, w)
Set the size -- in pixels along the side -- of the squares that
indicate the seeds' positions.
setSeeds(self, n_seeds=None, length=None, xy_rotation=None, xz_rotation=None, x_translation=None, y_translation=None, z_translation=None)
Seeds are the points from which the numerical integrations begin.
Arg n_seeds is the number of seeds.
Arg length is the length of the rake as a fraction of the length of the
domain box's longest diagonal.
The other arguments set the seeds' position relative to their initial one,
which has them laid down along the length of one edge of the bounding box
 -- the edge parallel to the x axis, at which y=z=0.
setSpecular(self, x)
Sets the Vtk specular lighting parameter.
Legal range for x is [0.0, 1.0].
setTubeResolution(self, n)
Cross-section of tube is a regular n-gon.  This function sets n.
showGUI(self)
Pop up the streamlines control panel.
showGlyphs(self)
Place little pyramids where the stream seed points are.
showTubes(self)
Draw tubes around the streamlines.  Use setLineWidth() to control
their radius.
withdrawGUI(self)
Hide the streamlines control panel.