fipy.viewers.vtkViewer package

Submodules

fipy.viewers.vtkViewer.test module

Test numeric implementation of the mesh

fipy.viewers.vtkViewer.vtkCellViewer module

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

Bases: VTKViewer

Renders CellVariable data in VTK format

Creates a VTKViewer

Parameters:

• vars (CellVariable or FaceVariable or list) – the MeshVariable objects to display.

• title (str, optional) – displayed at the top of the Viewer window

• limits (dict, optional) – a (deprecated) alternative to limit keyword arguments

• xmin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• xmax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• ymin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• ymax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• zmin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• zmax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• datamin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• datamax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

property limits

plot(filename=None)

Update the display of the viewed variables.

Parameters:

filename (str) – If not None, the name of a file to save the image into.

plotMesh(filename=None)

Display a representation of the mesh

Parameters:

filename (str) – If not None, the name of a file to save the image into.

setLimits(limits={}, **kwlimits)

Update the limits.

Parameters:

• limits (dict, optional) – a (deprecated) alternative to limit keyword arguments

• xmin (float, optional) – 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.

• xmax (float, optional) – 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.

• ymin (float, optional) – 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.

• ymax (float, optional) – 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.

• zmin (float, optional) – 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.

• zmax (float, optional) – 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.

• datamin (float, optional) – 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.

• datamax (float, optional) – 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.

property title

The text appearing at the top center.

(default: if len(self.vars) == 1, the name of self.vars[0], otherwise "".)

property vars

The Variable or list of Variable objects to display.

fipy.viewers.vtkViewer.vtkFaceViewer module

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

Bases: VTKViewer

Renders _MeshVariable data in VTK format

Creates a VTKViewer

Parameters:

• vars (CellVariable or FaceVariable or list) – the MeshVariable objects to display.

• title (str, optional) – displayed at the top of the Viewer window

• limits (dict, optional) – a (deprecated) alternative to limit keyword arguments

• xmin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• xmax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• ymin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• ymax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• zmin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• zmax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• datamin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• datamax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

property limits

plot(filename=None)

Update the display of the viewed variables.

Parameters:

filename (str) – If not None, the name of a file to save the image into.

plotMesh(filename=None)

Display a representation of the mesh

Parameters:

filename (str) – If not None, the name of a file to save the image into.

setLimits(limits={}, **kwlimits)

Update the limits.

Parameters:

• limits (dict, optional) – a (deprecated) alternative to limit keyword arguments

• xmin (float, optional) – 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.

• xmax (float, optional) – 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.

• ymin (float, optional) – 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.

• ymax (float, optional) – 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.

• zmin (float, optional) – 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.

• zmax (float, optional) – 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.

• datamin (float, optional) – 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.

• datamax (float, optional) – 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.

property title

The text appearing at the top center.

(default: if len(self.vars) == 1, the name of self.vars[0], otherwise "".)

property vars

The Variable or list of Variable objects to display.

fipy.viewers.vtkViewer.vtkViewer module

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

Bases: AbstractViewer

Renders _MeshVariable data in VTK format

Creates a VTKViewer

Parameters:

• vars (CellVariable or FaceVariable or list) – the MeshVariable objects to display.

• title (str, optional) – displayed at the top of the Viewer window

• limits (dict, optional) – a (deprecated) alternative to limit keyword arguments

• xmin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• xmax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• ymin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• ymax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• zmin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• zmax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• datamin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• datamax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

property limits

plot(filename=None)

Update the display of the viewed variables.

Parameters:

filename (str) – If not None, the name of a file to save the image into.

plotMesh(filename=None)

Display a representation of the mesh

Parameters:

filename (str) – If not None, the name of a file to save the image into.

setLimits(limits={}, **kwlimits)

Update the limits.

Parameters:

• limits (dict, optional) – a (deprecated) alternative to limit keyword arguments

• xmin (float, optional) – 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.

• xmax (float, optional) – 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.

• ymin (float, optional) – 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.

• ymax (float, optional) – 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.

• zmin (float, optional) – 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.

• zmax (float, optional) – 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.

• datamin (float, optional) – 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.

• datamax (float, optional) – 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.

property title

The text appearing at the top center.

(default: if len(self.vars) == 1, the name of self.vars[0], otherwise "".)

property vars

The Variable or list of Variable objects to display.

Module contents

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

Bases: VTKViewer

Renders CellVariable data in VTK format

Creates a VTKViewer

Parameters:

• vars (CellVariable or FaceVariable or list) – the MeshVariable objects to display.

• title (str, optional) – displayed at the top of the Viewer window

• limits (dict, optional) – a (deprecated) alternative to limit keyword arguments

• xmin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• xmax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• ymin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• ymax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• zmin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• zmax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• datamin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• datamax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

property limits

plot(filename=None)

Update the display of the viewed variables.

Parameters:

filename (str) – If not None, the name of a file to save the image into.

plotMesh(filename=None)

Display a representation of the mesh

Parameters:

filename (str) – If not None, the name of a file to save the image into.

setLimits(limits={}, **kwlimits)

Update the limits.

Parameters:

• limits (dict, optional) – a (deprecated) alternative to limit keyword arguments

• xmin (float, optional) – 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.

• xmax (float, optional) – 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.

• ymin (float, optional) – 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.

• ymax (float, optional) – 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.

• zmin (float, optional) – 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.

• zmax (float, optional) – 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.

• datamin (float, optional) – 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.

• datamax (float, optional) – 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.

property title

The text appearing at the top center.

(default: if len(self.vars) == 1, the name of self.vars[0], otherwise "".)

property vars

The Variable or list of Variable objects to display.

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

Bases: VTKViewer

Renders _MeshVariable data in VTK format

Creates a VTKViewer

Parameters:

• vars (CellVariable or FaceVariable or list) – the MeshVariable objects to display.

• title (str, optional) – displayed at the top of the Viewer window

• limits (dict, optional) – a (deprecated) alternative to limit keyword arguments

• xmin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• xmax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• ymin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• ymax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• zmin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• zmax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• datamin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• datamax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

property limits

plot(filename=None)

Update the display of the viewed variables.

Parameters:

filename (str) – If not None, the name of a file to save the image into.

plotMesh(filename=None)

Display a representation of the mesh

Parameters:

filename (str) – If not None, the name of a file to save the image into.

setLimits(limits={}, **kwlimits)

Update the limits.

Parameters:

• limits (dict, optional) – a (deprecated) alternative to limit keyword arguments

• xmin (float, optional) – 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.

• xmax (float, optional) – 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.

• ymin (float, optional) – 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.

• ymax (float, optional) – 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.

• zmin (float, optional) – 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.

• zmax (float, optional) – 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.

• datamin (float, optional) – 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.

• datamax (float, optional) – 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.

property title

The text appearing at the top center.

(default: if len(self.vars) == 1, the name of self.vars[0], otherwise "".)

property vars

The Variable or list of Variable objects to display.

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

Generic function for creating a VTKViewer.

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 (CellVariable or FaceVariable or list) – the MeshVariable objects to display.

• title (str, optional) – displayed at the top of the Viewer window

• limits (dict, optional) – a (deprecated) alternative to limit keyword arguments

• xmin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• xmax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• ymin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• ymax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• zmin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• zmax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• datamin (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

• datamax (float, optional) – displayed range of data. Any limit set to a (default) value of None will autoscale.

Last updated on Jun 27, 2023. Created using Sphinx 6.2.1.