mayaviViewer Package Documentation

This page contains the mayaviViewer Package documentation.

The mayaviClient Module

class fipy.viewers.mayaviViewer.mayaviClient.MayaviClient(vars, title=None, daemon_file=None, fps=1.0, **kwlimits)

Bases: fipy.viewers.viewer._Viewer

The MayaviClient uses the Mayavi_ python plotting package.

Create a MayaviClient.

Parameters :

vars

a CellVariable or tuple of CellVariable objects to plot

title

displayed at the top of the Viewer window

xmin, xmax, ymin, ymax, zmin, zmax, datamin, datamax

displayed range of data. A 1D Viewer will only use xmin and xmax, a 2D viewer will also use ymin and ymax, and so on. All viewers will use datamin and datamax. Any limit set to a (default) value of None will autoscale.

daemon_file

the path to the script to run the separate MayaVi viewer process. Defaults to “fipy/viewers/mayaviViewer/mayaviDaemon.py”

fps

frames per second to attempt to display

plot(filename=None)

The mayaviDaemon Module

A simple script that polls a data file for changes and then updates the mayavi pipeline automatically.

This script is based heavily on the poll_file.py exampe in the mayavi distribution.

This script is to be run like so:

$ mayavi2 -x mayaviDaemon.py <options>

Or:

$ python mayaviDaemon.py <options>

Run:

$ python mayaviDaemon.py --help

to see available options.

class fipy.viewers.mayaviViewer.mayaviDaemon.MayaviDaemon

Bases: mayavi.plugins.app.Mayavi

Given a file name and a mayavi2 data reader object, this class polls the file for any changes and automatically updates the mayavi pipeline.

clip_data(src)

parse_command_line(argv)

Parse command line options.

Parameters :

- argv : list of strings

The list of command line arguments.

poll_file()

run()

setup_source(fname)

Given a VTK file name fname, this creates a mayavi2 reader for it and adds it to the pipeline. It returns the reader created.

update_pipeline(source)

Override this to do something else if needed.

view_data()

Sets up the mayavi pipeline for the visualization.

fipy.viewers.mayaviViewer.mayaviDaemon.main(argv=None)

Simple helper to start up the mayavi application. This returns the running application.

The test Module

Test numeric implementation of the mesh