petsc4py.PETSc.DeviceContext#

class petsc4py.PETSc.DeviceContext#

Bases: Object

DeviceContext object.

Represents an abstract handle to a device context.

See also

Device, PetscDeviceContext

Enumerations

`DeviceJoinMode`	The type of join to perform.
`StreamType`	The type of stream.

Methods Summary

`create`()	Create an empty DeviceContext.
`destroy`()	Destroy a device context.
`duplicate`()	Duplicate a the device context.
`fork`(n[, stream_type])	Create multiple device contexts which are all logically dependent on this one.
`getCurrent`()	Return the current device context.
`getDevice`()	Get the `Device` which this instance is attached to.
`getStreamType`()	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 `Device` which this `DeviceContext` is attached to.
`setFromOptions`([comm])	Configure the `DeviceContext` from the options database.
`setStreamType`(stream_type)	Set the `StreamType`.
`setUp`()	Set up the internal data structures for using the device context.
`synchronize`()	Synchronize a device context.
`waitFor`(other)	Make this instance wait for `other`.

Attributes Summary

`current`	The current global device context.
`device`	The device associated to the device context.
`stream_type`	The stream type.

Methods Documentation

create()#

Create an empty DeviceContext.

Not collective.

Source code at petsc4py/PETSc/Device.pyx:240

Return type:: Self

destroy()#

Destroy a device context.

Not collective.

See also

create, PetscDeviceContextDestroy

Source code at petsc4py/PETSc/Device.pyx:255

Return type:: Self

duplicate()#

Duplicate a the device context.

Not collective.

See also

create, PetscDeviceContextDuplicate

Source code at petsc4py/PETSc/Device.pyx:348

Return type:: DeviceContext

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:

list[DeviceContext]

Examples

The device contexts created must be destroyed using join.

>>> dctx = PETSc.DeviceContext().getCurrent()
>>> dctxs = dctx.fork(4)
>>> ... # perform computations
>>> # we can mix various join modes
>>> dctx.join(PETSc.DeviceContext.JoinMode.SYNC, dctxs[0:2])
>>> dctx.join(PETSc.DeviceContext.JoinMode.SYNC, dctxs[2:])
>>> ... # some more computations and joins
>>> # dctxs must be all destroyed with joinMode.DESTROY
>>> dctx.join(PETSc.DeviceContext.JoinMode.DESTROY, dctxs)

Source code at petsc4py/PETSc/Device.pyx:399

static getCurrent()#

Return the current device context.

Not collective.

Source code at petsc4py/PETSc/Device.pyx:519

Return type:: DeviceContext

getDevice()#

Get the Device which this instance is attached to.

Not collective.

Source code at petsc4py/PETSc/Device.pyx:302

Return type:: Device

getStreamType()#

Return the StreamType.

Not collective.

Source code at petsc4py/PETSc/Device.pyx:268

Return type:: str

idle()#

Return whether the underlying stream for the device context is idle.

Not collective.

Source code at petsc4py/PETSc/Device.pyx:363

Return type:: bool

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:

None

Source code at petsc4py/PETSc/Device.pyx:448

static setCurrent(dctx)#

Set the current device context.

Not collective.

Parameters:: dctx (DeviceContext | None) – The DeviceContext to set as current (or None to use the default context).
Return type:: None