vtkViewer Package Documentation

This page contains the vtkViewer Package documentation.

The vtkViewer Package

fipy.viewers.vtkViewer.VTKViewer(vars, title=None, limits={}, **kwlimits)

Generic function for creating a MatplotlibViewer.

The VTKViewer factory will search the module tree and return an instance of the first VTKViewer it finds of the correct dimension and rank.

Parameters :

vars

a _MeshVariable or tuple of _MeshVariable objects to plot

title

displayed at the top of the Viewer window

limits : dict

a (deprecated) alternative to limit keyword arguments

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.

class fipy.viewers.vtkViewer.VTKCellViewer(vars, title=None, limits={}, **kwlimits)

Bases: fipy.viewers.vtkViewer.vtkViewer._VTKViewer

Renders CellVariable data in VTK format

Creates a VTKViewer

Parameters :

vars

a _MeshVariable or a tuple of them

title

displayed at the top of the Viewer window

limits : dict

a (deprecated) alternative to limit keyword arguments

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

displayed range of data. Any limit set to a (default) value of None will autoscale.

class fipy.viewers.vtkViewer.VTKFaceViewer(vars, title=None, limits={}, **kwlimits)

Bases: fipy.viewers.vtkViewer.vtkViewer._VTKViewer

Renders _MeshVariable data in VTK format

Creates a VTKViewer

Parameters :

vars

a _MeshVariable or a tuple of them

title

displayed at the top of the Viewer window

limits : dict

a (deprecated) alternative to limit keyword arguments

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

displayed range of data. Any limit set to a (default) value of None will autoscale.

The test Module

Test numeric implementation of the mesh

The vtkCellViewer Module

class fipy.viewers.vtkViewer.vtkCellViewer.VTKCellViewer(vars, title=None, limits={}, **kwlimits)

Bases: fipy.viewers.vtkViewer.vtkViewer._VTKViewer

Renders CellVariable data in VTK format

Creates a VTKViewer

Parameters :

vars

a _MeshVariable or a tuple of them

title

displayed at the top of the Viewer window

limits : dict

a (deprecated) alternative to limit keyword arguments

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

displayed range of data. Any limit set to a (default) value of None will autoscale.

The vtkFaceViewer Module

class fipy.viewers.vtkViewer.vtkFaceViewer.VTKFaceViewer(vars, title=None, limits={}, **kwlimits)

Bases: fipy.viewers.vtkViewer.vtkViewer._VTKViewer

Renders _MeshVariable data in VTK format

Creates a VTKViewer

Parameters :

vars

a _MeshVariable or a tuple of them

title

displayed at the top of the Viewer window

limits : dict

a (deprecated) alternative to limit keyword arguments

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

displayed range of data. Any limit set to a (default) value of None will autoscale.

The vtkViewer Module