fipy.viewers.viewer¶

Classes

AbstractViewer(vars[, title])

Base class for FiPy Viewers

class fipy.viewers.viewer.AbstractViewer(vars, title=None, **kwlimits)¶

Bases: object

Base class for FiPy Viewers

Attention

This class is abstract. Always create one of its subclasses.

Create a AbstractViewer object.

Parameters:

vars (CellVariable or list) – the CellVariable objects to display.
title (str, optional) – displayed at the top of the Viewer window
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.

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 the only Variable, otherwise "".)

property vars¶: The Variable or list of Variable objects to display.

Last updated on Nov 20, 2024. Created using Sphinx 7.1.2.