PETSc version 3.16.5
Fix/Edit manual page

# PetscDeviceContextQueryIdle

Returns whether or not a PetscDeviceContext is idle

### Synopsis

    #include "petscdevice.h"
    PetscErrorCode PetscDeviceContextQueryIdle(PetscDeviceContext dctx, PetscBool *idle)

Not Collective, Asynchronous

### Input Parameter

| dctx | - The PetscDeviceContext object

### Output Parameter

| idle | - PETSC_TRUE if PetscDeviceContext has NO work, PETSC_FALSE if it has work

### Notes

This routine only refers a singular context and does NOT take any of its children into account. That is, if dctx is idle but has dependents who do have work, this routine still returns PETSC_TRUE.

Results of PetscDeviceContextQueryIdle() are cached on return, allowing this function to be called repeatedly in an efficient manner. When debug mode is enabled this cache is verified on every call to this routine, but is blindly believed when debugging is disabled.

### See Also

PetscDeviceContextCreate(), PetscDeviceContextWaitForContext(), PetscDeviceContextFork()

### Level

intermediate

### Location

src/sys/objects/device/interface/dcontext.cxx
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages