petsc4py.PETSc.Object#
- class petsc4py.PETSc.Object#
Bases:
objectBase class wrapping a PETSc object.
See also
Methods Summary
appendOptionsPrefix(prefix)Append to the prefix used for searching for options in the database.
compose(name, obj)Associate a PETSc object using a key string.
decRef()Decrement the object reference count.
destroy()Destroy the object.
Clear all the option handlers.
getAttr(name)Return the attribute associated with a given name.
Return the class identifier of the object.
Return the class name of the object.
getComm()Return the communicator of the object.
getDict()Return the dictionary of attributes.
getId()Return the unique identifier of the object.
getName()Return the name of the object.
Return the prefix used for searching for options in the database.
Return the reference count of the object.
Return the PETSc object tab level.
getType()Return the object type name.
incRef()Increment the object reference count.
incrementTabLevel(tab[, parent])Increment the PETSc object tab level.
query(name)Query for the PETSc object associated with a key string.
setAttr(name, attr)Set an the attribute associated with a given name.
Configure the object from the options database.
setName(name)Associate a name to the object.
setOptionsHandler(handler)Set the callback for processing extra options.
setOptionsPrefix(prefix)Set the prefix used for searching for options in the database.
setTabLevel(level)Set the PETSc object tab level.
stateGet()Return the PETSc object state.
Increment the PETSc object state.
stateSet(state)Set the PETSc object state.
view([viewer])Display the object.
viewFromOptions(name[, objpre])View the object via command line options.
Attributes Summary
The class identifier.
The object communicator.
Fortran handle.
Handle for ctypes support.
The object identifier.
The class name.
The object name.
Options prefix.
Reference count.
Object type.
Methods Documentation
- appendOptionsPrefix(prefix)#
Append to the prefix used for searching for options in the database.
Logically collective.
- compose(name, obj)#
Associate a PETSc object using a key string.
Logically collective.
- Parameters:
- Return type:
See also
- decRef()#
Decrement the object reference count.
Logically collective.
See also
Source code at petsc4py/PETSc/Object.pyx:389
- Return type:
- destroy()#
Destroy the object.
Collective.
See also
Source code at petsc4py/PETSc/Object.pyx:81
- Return type:
- destroyOptionsHandlers()#
Clear all the option handlers.
Collective.
Source code at petsc4py/PETSc/Object.pyx:213
- Return type:
- getAttr(name)#
Return the attribute associated with a given name.
Not collective.
- getClassId()#
Return the class identifier of the object.
Not collective.
See also
Source code at petsc4py/PETSc/Object.pyx:270
- Return type:
- getClassName()#
Return the class name of the object.
Not collective.
See also
Source code at petsc4py/PETSc/Object.pyx:284
- Return type:
- getComm()#
Return the communicator of the object.
Not collective.
See also
Source code at petsc4py/PETSc/Object.pyx:228
- Return type:
- getDict()#
Return the dictionary of attributes.
Not collective.
Source code at petsc4py/PETSc/Object.pyx:436
- Return type:
- getId()#
Return the unique identifier of the object.
Not collective.
See also
Source code at petsc4py/PETSc/Object.pyx:313
- Return type:
- getName()#
Return the name of the object.
Not collective.
See also
Source code at petsc4py/PETSc/Object.pyx:242
- Return type:
- getOptionsPrefix()#
Return the prefix used for searching for options in the database.
Not collective.
Source code at petsc4py/PETSc/Object.pyx:124
- Return type:
- getRefCount()#
Return the reference count of the object.
Not collective.
See also
Source code at petsc4py/PETSc/Object.pyx:298
- Return type:
- getTabLevel()#
Return the PETSc object tab level.
Not collective.
See also
Source code at petsc4py/PETSc/Object.pyx:518
- Return type:
- getType()#
Return the object type name.
Not collective.
See also
Source code at petsc4py/PETSc/Object.pyx:94
- Return type:
- incRef()#
Increment the object reference count.
Logically collective.
See also
Source code at petsc4py/PETSc/Object.pyx:372
- Return type:
- incrementTabLevel(tab, parent=None)#
Increment the PETSc object tab level.
Logically collective.
See also
- query(name)#
Query for the PETSc object associated with a key string.
Not collective.
See also
- setAttr(name, attr)#
Set an the attribute associated with a given name.
Not collective.
- setFromOptions()#
Configure the object from the options database.
Collective.
Classes that do not implement
setFromOptionsuse this method that, in turn, callsPetscObjectSetFromOptions.Source code at petsc4py/PETSc/Object.pyx:152
- Return type:
- setName(name)#
Associate a name to the object.
Not collective.
See also
- setOptionsHandler(handler)#
Set the callback for processing extra options.
Logically collective.
- Parameters:
handler (PetscOptionsHandlerFunction | None) – The callback function, called at the end of a
setFromOptionsinvocation for the given class.- Return type:
- setOptionsPrefix(prefix)#
Set the prefix used for searching for options in the database.
Logically collective.
- setTabLevel(level)#
Set the PETSc object tab level.
Logically collective.
See also
- stateGet()#
Return the PETSc object state.
Not collective.
See also
Source code at petsc4py/PETSc/Object.pyx:462
- Return type:
- stateIncrease()#
Increment the PETSc object state.
Logically collective.
See also
Source code at petsc4py/PETSc/Object.pyx:450
- Return type:
- stateSet(state)#
Set the PETSc object state.
Logically collective.
See also
- view(viewer=None)#
Display the object.
Collective.
See also
- viewFromOptions(name, objpre=None)#
View the object via command line options.
Collective.
- Parameters:
- Return type:
Attributes Documentation
- classid#
The class identifier.
- comm#
The object communicator.
- fortran#
Fortran handle.
- handle#
Handle for ctypes support.
- id#
The object identifier.
- klass#
The class name.
- name#
The object name.
- prefix#
Options prefix.
- refcount#
Reference count.
- type#
Object type.