VecSetErrorIfLocked

Raise an error if the Vec is currently locked for read or write access.

Synopsis

static inline PetscErrorCode VecSetErrorIfLocked(Vec x, PetscInt arg)

Not Collective; No Fortran Support

Input Parameters

• x - the Vec to test

• arg - the argument position of x in the calling routine, used in the error message

Note

This is intended as an internal check for routines that must have exclusive access to a Vec. A locked Vec typically indicates that another routine currently holds a read or write reference to it.

See Also

Vec, VecLockGet(), VecLockGetLocation(), VecLockReadPush(), VecLockReadPop(), VecLockWriteSet()

Level

developer

Location

include/petscvec.h

---

Index of all Vec routines
Table of Contents for all manual pages
Index of all manual pages