petsc4py.PETSc.DeviceContext#
- class petsc4py.PETSc.DeviceContext#
Bases:
ObjectDeviceContext object.
Represents an abstract handle to a device context.
See also
Enumerations
The type of join to perform.
The type of stream.
Methods Summary
create()Create an empty DeviceContext.
Duplicate a the device context.
fork(n[, stream_type])Create multiple device contexts which are all logically dependent on this one.
Return the current device context.
Get the
Devicewhich this instance is attached to.Return the
StreamType.idle()Return whether the underlying stream for the device context is idle.
join(join_mode, py_sub_ctxs)Join a set of device contexts on this one.
setCurrent(dctx)Set the current device context.
setDevice(device)Set the
Devicewhich thisDeviceContextis attached to.setFromOptions([comm])Configure the
DeviceContextfrom the options database.setStreamType(stream_type)Set the
StreamType.setUp()Set up the internal data structures for using the device context.
Synchronize a device context.
waitFor(other)Make this instance wait for
other.Attributes Summary
The current global device context.
The device associated to the device context.
The stream type.
Methods Documentation
- classmethod create()#
Create an empty DeviceContext.
Not collective.
See also
Source code at petsc4py/PETSc/Device.pyx:239
- Return type:
- duplicate()#
Duplicate a the device context.
Not collective.
See also
Source code at petsc4py/PETSc/Device.pyx:336
- Return type:
- fork(n, stream_type=None)#
Create multiple device contexts which are all logically dependent on this one.
Not collective.
- Parameters:
n (int) – The number of device contexts to create.
stream_type (StreamType | str | None) – The type of stream of the forked device context.
- Return type:
See also
- static getCurrent()#
Return the current device context.
Not collective.
See also
Source code at petsc4py/PETSc/Device.pyx:487
- Return type:
- getDevice()#
Get the
Devicewhich this instance is attached to.Not collective.
See also
Source code at petsc4py/PETSc/Device.pyx:289
- Return type:
- getStreamType()#
Return the
StreamType.Not collective.
Source code at petsc4py/PETSc/Device.pyx:255
- Return type:
- idle()#
Return whether the underlying stream for the device context is idle.
Not collective.
See also
Source code at petsc4py/PETSc/Device.pyx:351
- Return type:
- join(join_mode, py_sub_ctxs)#
Join a set of device contexts on this one.
Not collective.
- Parameters:
join_mode (DeviceJoinMode | str) – The type of join to perform.
py_sub_ctxs (list[DeviceContext]) – The list of device contexts to join.
- Return type:
See also
- static setCurrent(dctx)#
Set the current device context.
Not collective.
- Parameters:
dctx (DeviceContext | None) – The
DeviceContextto set as current (orNoneto use the default context).- Return type:
See also
- setDevice(device)#
Set the
Devicewhich thisDeviceContextis attached to.Collective.
See also
- setFromOptions(comm=None)#
Configure the
DeviceContextfrom the options database.Collective.
- Parameters:
comm (Comm | None) – MPI communicator, defaults to
Sys.getDefaultComm.- Return type:
- setStreamType(stream_type)#
Set the
StreamType.Not collective.
- Parameters:
stream_type (StreamType | str) – The type of stream to set
- Return type:
- setUp()#
Set up the internal data structures for using the device context.
Not collective.
See also
Source code at petsc4py/PETSc/Device.pyx:324
- Return type:
- synchronize()#
Synchronize a device context.
Not collective.
Notes
The underlying stream is considered idle after this routine returns, i.e.
idlewill returnTrue.See also
Source code at petsc4py/PETSc/Device.pyx:451
- Return type:
- waitFor(other)#
Make this instance wait for
other.Not collective.
- Parameters:
other (DeviceContext | None) – The other
DeviceContextto wait for- Return type:
See also
Attributes Documentation
- current#
The current global device context.
- device#
The device associated to the device context.
- stream_type#
The stream type.