petsc4py.PETSc.Viewer#
- class petsc4py.PETSc.Viewer#
Bases:
ObjectViewer object.
Viewer is described in the
PETSc manual.Viewers can be called as functions where the argument specified is the PETSc object to be viewed. See the example below.
Examples
>>> from petsc4py import PETSc >>> u = PETSc.Vec().createWithArray([1,2]) >>> v = PETSc.Viewer() >>> v(u) Vec Object: 1 MPI process type: seq 1. 2.
See also
Enumerations
Window size.
Viewer file mode.
Viewer format.
Viewer type.
Methods Summary
ASCII(name[, comm])Return an ASCII viewer associated with the communicator.
BINARY([comm])Return the default
Type.BINARYviewer associated with the communicator.DRAW([comm])Return the default
Type.DRAWviewer associated with the communicator.STDERR([comm])Return the standard error viewer associated with the communicator.
STDOUT([comm])Return the standard output viewer associated with the communicator.
addASCIITab(tabs)Increment the ASCII tab level.
Reset graphics.
create([comm])Create a viewer.
createASCII(name[, mode, comm])Create a viewer of type
Type.ASCII.createBinary(name[, mode, comm])Create a viewer of type
Type.BINARY.createDraw([display, title, position, size, ...])Create a
Type.DRAWviewer.createHDF5(name[, mode, comm])Create a viewer of type
Type.HDF5.createMPIIO(name[, mode, comm])Create a viewer of type
Type.BINARYsupporting MPI-IO.createPython([context, comm])Create a
Type.PYTHONviewer.createVTK(name[, mode, comm])Create a viewer of type
Type.VTK.destroy()Destroy the viewer.
flush()Flush the viewer.
Return the ASCII tab level.
Return the file mode.
Return file name.
Return the format of the viewer.
Return the instance of the class implementing the required Python methods.
Return the fully qualified Python name of the class used by the viewer.
getSubViewer([comm])Return a viewer defined on a subcommunicator.
getType()Return the type of the viewer.
Disallow ASCII synchronized calls.
Pop an additional tab level pushed via
pushASCIITab.Pop format from the viewer.
printfASCII(msg)Print a message.
Print a synchronized message.
Allow ASCII synchronized calls.
Push an additional tab level.
pushFormat(format)Push format to the viewer.
restoreSubViewer(sub)Restore a viewer defined on a subcommunicator.
setASCIITab(tabs)Set ASCII tab level.
setDrawInfo([display, title, position, size])Set window information for a
Type.DRAWviewer.setFileMode(mode)Set file mode.
setFileName(name)Set file name.
Configure the object from the options database.
setPythonContext(context)Set the instance of the class implementing the required Python methods.
setPythonType(py_type)Set the fully qualified Python name of the class to be used.
setType(vwr_type)Set the type of the viewer.
setUp()Set up the internal data structures for using the viewer.
subtractASCIITab(tabs)Decrement the ASCII tab level.
useASCIITabs(flag)Enable/disable the use of ASCII tabs.
view([obj])View the viewer.
viewObjectPython(obj)View a generic
Object.Methods Documentation
- classmethod ASCII(name, comm=None)#
Return an ASCII viewer associated with the communicator.
Collective.
- Parameters:
name (str) – The filename.
comm (Comm | None) – MPI communicator, defaults to
Sys.getDefaultComm.
- Return type:
- classmethod BINARY(comm=None)#
Return the default
Type.BINARYviewer associated with the communicator.Collective.
- Parameters:
comm (Comm | None) – MPI communicator, defaults to
Sys.getDefaultComm.- Return type:
- classmethod DRAW(comm=None)#
Return the default
Type.DRAWviewer associated with the communicator.Collective.
- Parameters:
comm (Comm | None) – MPI communicator, defaults to
Sys.getDefaultComm.- Return type:
- classmethod STDERR(comm=None)#
Return the standard error viewer associated with the communicator.
Collective.
- Parameters:
comm (Comm | None) – MPI communicator, defaults to
Sys.getDefaultComm.- Return type:
- classmethod STDOUT(comm=None)#
Return the standard output viewer associated with the communicator.
Collective.
- Parameters:
comm (Comm | None) – MPI communicator, defaults to
Sys.getDefaultComm.- Return type:
- addASCIITab(tabs)#
Increment the ASCII tab level.
Collective.
See also
- clearDraw()#
Reset graphics.
Not collective.
See also
Source code at petsc4py/PETSc/Viewer.pyx:921
- Return type:
- create(comm=None)#
Create a viewer.
Collective.
- Parameters:
comm (Comm | None) – MPI communicator, defaults to
Sys.getDefaultComm.- Return type:
See also
- createASCII(name, mode=None, comm=None)#
Create a viewer of type
Type.ASCII.Collective.
- Parameters:
- Return type:
Self
- createBinary(name, mode=None, comm=None)#
Create a viewer of type
Type.BINARY.Collective.
- Parameters:
- Return type:
Self
See also
create,setType,setFileMode,setFileName,Sys.getDefaultComm
- createDraw(display=None, title=None, position=None, size=None, comm=None)#
Create a
Type.DRAWviewer.Collective.
- Parameters:
display (str | None) – The X display to use or
Nonefor the local machine.position (tuple[int, int] | None) – Screen coordinates of the upper left corner, or
Nonefor default.size (tuple[int, int] | int | None) – Window size or
Nonefor default.comm (Comm | None) – MPI communicator, defaults to
Sys.getDefaultComm.
- Return type:
See also
- createHDF5(name, mode=None, comm=None)#
Create a viewer of type
Type.HDF5.Collective.
- Parameters:
- Return type:
Self
See also
create,setType,setFileMode,setFileName,Sys.getDefaultComm
- createMPIIO(name, mode=None, comm=None)#
Create a viewer of type
Type.BINARYsupporting MPI-IO.Collective.
- Parameters:
- Return type:
Self
See also
create,setType,setFileMode,setFileName,Sys.getDefaultComm
- createPython(context=None, comm=None)#
Create a
Type.PYTHONviewer.Collective.
- Parameters:
context (Any) – An instance of the Python class implementing the required methods.
comm (Comm | None) – MPI communicator, defaults to
Sys.getDefaultComm.
- Return type:
See also
- createVTK(name, mode=None, comm=None)#
Create a viewer of type
Type.VTK.Collective.
- Parameters:
- Return type:
Self
See also
create,setType,setFileMode,setFileName,Sys.getDefaultComm
- destroy()#
Destroy the viewer.
Collective.
See also
Source code at petsc4py/PETSc/Viewer.pyx:166
- Return type:
- flush()#
Flush the viewer.
Collective.
See also
Source code at petsc4py/PETSc/Viewer.pyx:809
- Return type:
- getASCIITab()#
Return the ASCII tab level.
Not collective.
See also
Source code at petsc4py/PETSc/Viewer.pyx:676
- Return type:
- getFileMode()#
Return the file mode.
Not collective.
See also
Source code at petsc4py/PETSc/Viewer.pyx:833
- Return type:
- getFileName()#
Return file name.
Not collective.
See also
Source code at petsc4py/PETSc/Viewer.pyx:861
- Return type:
- getFormat()#
Return the format of the viewer.
Not collective.
See also
Source code at petsc4py/PETSc/Viewer.pyx:488
- Return type:
- getPythonContext()#
Return the instance of the class implementing the required Python methods.
Not collective.
See also
Source code at petsc4py/PETSc/Viewer.pyx:973
- Return type:
- getPythonType()#
Return the fully qualified Python name of the class used by the viewer.
Not collective.
Source code at petsc4py/PETSc/Viewer.pyx:1003
- Return type:
- getSubViewer(comm=None)#
Return a viewer defined on a subcommunicator.
Collective.
Notes
Users must call
restoreSubViewerwhen done.See also
- getType()#
Return the type of the viewer.
Not collective.
See also
Source code at petsc4py/PETSc/Viewer.pyx:449
- Return type:
- popASCIISynchronized()#
Disallow ASCII synchronized calls.
Collective.
Source code at petsc4py/PETSc/Viewer.pyx:729
- Return type:
- popASCIITab()#
Pop an additional tab level pushed via
pushASCIITab.Collective.
See also
Source code at petsc4py/PETSc/Viewer.pyx:754
- Return type:
- popFormat()#
Pop format from the viewer.
Collective.
See also
Source code at petsc4py/PETSc/Viewer.pyx:514
- Return type:
- printfASCII(msg)#
Print a message.
Collective.
See also
- printfASCIISynchronized(msg)#
Print a synchronized message.
Collective.
- pushASCIISynchronized()#
Allow ASCII synchronized calls.
Collective.
Source code at petsc4py/PETSc/Viewer.pyx:716
- Return type:
- pushASCIITab()#
Push an additional tab level.
Collective.
See also
Source code at petsc4py/PETSc/Viewer.pyx:742
- Return type:
- pushFormat(format)#
Push format to the viewer.
Collective.
See also
- restoreSubViewer(sub)#
Restore a viewer defined on a subcommunicator.
Collective.
- Parameters:
sub (Viewer) – The subviewer obtained from
getSubViewer.- Return type:
See also
- setASCIITab(tabs)#
Set ASCII tab level.
Collective.
See also
- setDrawInfo(display=None, title=None, position=None, size=None)#
Set window information for a
Type.DRAWviewer.Collective.
- setFileMode(mode)#
Set file mode.
Collective.
See also
- setFileName(name)#
Set file name.
Collective.
See also
- setFromOptions()#
Configure the object from the options database.
Collective.
Source code at petsc4py/PETSc/Viewer.pyx:463
- Return type:
- setPythonContext(context)#
Set the instance of the class implementing the required Python methods.
Logically collective.
See also
- setPythonType(py_type)#
Set the fully qualified Python name of the class to be used.
Collective.
- setType(vwr_type)#
Set the type of the viewer.
Logically collective.
See also
- setUp()#
Set up the internal data structures for using the viewer.
Collective.
See also
Source code at petsc4py/PETSc/Viewer.pyx:475
- Return type:
- subtractASCIITab(tabs)#
Decrement the ASCII tab level.
Collective.
See also
- useASCIITabs(flag)#
Enable/disable the use of ASCII tabs.
Collective.
See also
- view(obj=None)#
View the viewer.
Collective.
- Parameters:
obj (Viewer | Object | None) – A
Viewerinstance orNonefor the default viewer. If none of the above applies, it assumesobjis an instance ofObjectand it calls the generic view forobj.- Return type:
Notes
See also