Actual source code: vecimpl.h


  2: /*
  3:    This private file should not be included in users' code.
  4:    Defines the fields shared by all vector implementations.

  6: */

  8: #ifndef __VECIMPL_H

 11: #include <petscvec.h>
 12: #include <petsc/private/petscimpl.h>

 14: PETSC_EXTERN PetscBool      VecRegisterAllCalled;
 15: PETSC_EXTERN PetscErrorCode VecRegisterAll(void);
 16: PETSC_EXTERN MPI_Op         MPIU_MAXLOC;
 17: PETSC_EXTERN MPI_Op         MPIU_MINLOC;

 19: /* ----------------------------------------------------------------------------*/

 21: typedef struct _VecOps *VecOps;
 22: struct _VecOps {
 23:   PetscErrorCode (*duplicate)(Vec, Vec *);                                          /* get single vector */
 24:   PetscErrorCode (*duplicatevecs)(Vec, PetscInt, Vec **);                           /* get array of vectors */
 25:   PetscErrorCode (*destroyvecs)(PetscInt, Vec[]);                                   /* free array of vectors */
 26:   PetscErrorCode (*dot)(Vec, Vec, PetscScalar *);                                   /* z = x^H * y */
 27:   PetscErrorCode (*mdot)(Vec, PetscInt, const Vec[], PetscScalar *);                /* z[j] = x dot y[j] */
 28:   PetscErrorCode (*norm)(Vec, NormType, PetscReal *);                               /* z = sqrt(x^H * x) */
 29:   PetscErrorCode (*tdot)(Vec, Vec, PetscScalar *);                                  /* x'*y */
 30:   PetscErrorCode (*mtdot)(Vec, PetscInt, const Vec[], PetscScalar *);               /* z[j] = x dot y[j] */
 31:   PetscErrorCode (*scale)(Vec, PetscScalar);                                        /* x = alpha * x   */
 32:   PetscErrorCode (*copy)(Vec, Vec);                                                 /* y = x */
 33:   PetscErrorCode (*set)(Vec, PetscScalar);                                          /* y = alpha  */
 34:   PetscErrorCode (*swap)(Vec, Vec);                                                 /* exchange x and y */
 35:   PetscErrorCode (*axpy)(Vec, PetscScalar, Vec);                                    /* y = y + alpha * x */
 36:   PetscErrorCode (*axpby)(Vec, PetscScalar, PetscScalar, Vec);                      /* y = alpha * x + beta * y*/
 37:   PetscErrorCode (*maxpy)(Vec, PetscInt, const PetscScalar *, Vec *);               /* y = y + alpha[j] x[j] */
 38:   PetscErrorCode (*aypx)(Vec, PetscScalar, Vec);                                    /* y = x + alpha * y */
 39:   PetscErrorCode (*waxpy)(Vec, PetscScalar, Vec, Vec);                              /* w = y + alpha * x */
 40:   PetscErrorCode (*axpbypcz)(Vec, PetscScalar, PetscScalar, PetscScalar, Vec, Vec); /* z = alpha * x + beta *y + gamma *z*/
 41:   PetscErrorCode (*pointwisemult)(Vec, Vec, Vec);                                   /* w = x .* y */
 42:   PetscErrorCode (*pointwisedivide)(Vec, Vec, Vec);                                 /* w = x ./ y */
 43:   PetscErrorCode (*setvalues)(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
 44:   PetscErrorCode (*assemblybegin)(Vec);            /* start global assembly */
 45:   PetscErrorCode (*assemblyend)(Vec);              /* end global assembly */
 46:   PetscErrorCode (*getarray)(Vec, PetscScalar **); /* get data array */
 47:   PetscErrorCode (*getsize)(Vec, PetscInt *);
 48:   PetscErrorCode (*getlocalsize)(Vec, PetscInt *);
 49:   PetscErrorCode (*restorearray)(Vec, PetscScalar **); /* restore data array */
 50:   PetscErrorCode (*max)(Vec, PetscInt *, PetscReal *); /* z = max(x); idx=index of max(x) */
 51:   PetscErrorCode (*min)(Vec, PetscInt *, PetscReal *); /* z = min(x); idx=index of min(x) */
 52:   PetscErrorCode (*setrandom)(Vec, PetscRandom);       /* set y[j] = random numbers */
 53:   PetscErrorCode (*setoption)(Vec, VecOption, PetscBool);
 54:   PetscErrorCode (*setvaluesblocked)(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
 55:   PetscErrorCode (*destroy)(Vec);
 56:   PetscErrorCode (*view)(Vec, PetscViewer);
 57:   PetscErrorCode (*placearray)(Vec, const PetscScalar *);   /* place data array */
 58:   PetscErrorCode (*replacearray)(Vec, const PetscScalar *); /* replace data array */
 59:   PetscErrorCode (*dot_local)(Vec, Vec, PetscScalar *);
 60:   PetscErrorCode (*tdot_local)(Vec, Vec, PetscScalar *);
 61:   PetscErrorCode (*norm_local)(Vec, NormType, PetscReal *);
 62:   PetscErrorCode (*mdot_local)(Vec, PetscInt, const Vec[], PetscScalar *);
 63:   PetscErrorCode (*mtdot_local)(Vec, PetscInt, const Vec[], PetscScalar *);
 64:   PetscErrorCode (*load)(Vec, PetscViewer);
 65:   PetscErrorCode (*reciprocal)(Vec);
 66:   PetscErrorCode (*conjugate)(Vec);
 67:   PetscErrorCode (*setlocaltoglobalmapping)(Vec, ISLocalToGlobalMapping);
 68:   PetscErrorCode (*setvalueslocal)(Vec, PetscInt, const PetscInt *, const PetscScalar *, InsertMode);
 69:   PetscErrorCode (*resetarray)(Vec); /* vector points to its original array, i.e. undoes any VecPlaceArray() */
 70:   PetscErrorCode (*setfromoptions)(Vec, PetscOptionItems *);
 71:   PetscErrorCode (*maxpointwisedivide)(Vec, Vec, PetscReal *); /* m = max abs(x ./ y) */
 72:   PetscErrorCode (*pointwisemax)(Vec, Vec, Vec);
 73:   PetscErrorCode (*pointwisemaxabs)(Vec, Vec, Vec);
 74:   PetscErrorCode (*pointwisemin)(Vec, Vec, Vec);
 75:   PetscErrorCode (*getvalues)(Vec, PetscInt, const PetscInt[], PetscScalar[]);
 76:   PetscErrorCode (*sqrt)(Vec);
 77:   PetscErrorCode (*abs)(Vec);
 78:   PetscErrorCode (*exp)(Vec);
 79:   PetscErrorCode (*log)(Vec);
 80:   PetscErrorCode (*shift)(Vec, PetscScalar);
 81:   PetscErrorCode (*create)(Vec);
 82:   PetscErrorCode (*stridegather)(Vec, PetscInt, Vec, InsertMode);
 83:   PetscErrorCode (*stridescatter)(Vec, PetscInt, Vec, InsertMode);
 84:   PetscErrorCode (*dotnorm2)(Vec, Vec, PetscScalar *, PetscScalar *);
 85:   PetscErrorCode (*getsubvector)(Vec, IS, Vec *);
 86:   PetscErrorCode (*restoresubvector)(Vec, IS, Vec *);
 87:   PetscErrorCode (*getarrayread)(Vec, const PetscScalar **);
 88:   PetscErrorCode (*restorearrayread)(Vec, const PetscScalar **);
 89:   PetscErrorCode (*stridesubsetgather)(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);
 90:   PetscErrorCode (*stridesubsetscatter)(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);
 91:   PetscErrorCode (*viewnative)(Vec, PetscViewer);
 92:   PetscErrorCode (*loadnative)(Vec, PetscViewer);
 93:   PetscErrorCode (*createlocalvector)(Vec, Vec *);
 94:   PetscErrorCode (*getlocalvector)(Vec, Vec);
 95:   PetscErrorCode (*restorelocalvector)(Vec, Vec);
 96:   PetscErrorCode (*getlocalvectorread)(Vec, Vec);
 97:   PetscErrorCode (*restorelocalvectorread)(Vec, Vec);
 98:   PetscErrorCode (*bindtocpu)(Vec, PetscBool);
 99:   PetscErrorCode (*getarraywrite)(Vec, PetscScalar **);
100:   PetscErrorCode (*restorearraywrite)(Vec, PetscScalar **);
101:   PetscErrorCode (*getarrayandmemtype)(Vec, PetscScalar **, PetscMemType *);
102:   PetscErrorCode (*restorearrayandmemtype)(Vec, PetscScalar **);
103:   PetscErrorCode (*getarrayreadandmemtype)(Vec, const PetscScalar **, PetscMemType *);
104:   PetscErrorCode (*restorearrayreadandmemtype)(Vec, const PetscScalar **);
105:   PetscErrorCode (*getarraywriteandmemtype)(Vec, PetscScalar **, PetscMemType *);
106:   PetscErrorCode (*restorearraywriteandmemtype)(Vec, PetscScalar **, PetscMemType *);
107:   PetscErrorCode (*concatenate)(PetscInt, const Vec[], Vec *, IS *[]);
108:   PetscErrorCode (*sum)(Vec, PetscScalar *);
109:   PetscErrorCode (*setpreallocationcoo)(Vec, PetscCount, const PetscInt[]);
110:   PetscErrorCode (*setvaluescoo)(Vec, const PetscScalar[], InsertMode);
111: };

113: #if defined(offsetof) && (defined(__cplusplus) || (PETSC_C_VERSION >= 23))
114: static_assert(offsetof(struct _VecOps, duplicate) == sizeof(void (*)(void)) * VECOP_DUPLICATE, "");
115: static_assert(offsetof(struct _VecOps, set) == sizeof(void (*)(void)) * VECOP_SET, "");
116: static_assert(offsetof(struct _VecOps, view) == sizeof(void (*)(void)) * VECOP_VIEW, "");
117: static_assert(offsetof(struct _VecOps, load) == sizeof(void (*)(void)) * VECOP_LOAD, "");
118: static_assert(offsetof(struct _VecOps, viewnative) == sizeof(void (*)(void)) * VECOP_VIEWNATIVE, "");
119: static_assert(offsetof(struct _VecOps, loadnative) == sizeof(void (*)(void)) * VECOP_LOADNATIVE, "");
120: #endif

122: /*
123:     The stash is used to temporarily store inserted vec values that
124:   belong to another processor. During the assembly phase the stashed
125:   values are moved to the correct processor and
126: */

128: typedef struct {
129:   PetscInt     nmax;     /* maximum stash size */
130:   PetscInt     umax;     /* max stash size user wants */
131:   PetscInt     oldnmax;  /* the nmax value used previously */
132:   PetscInt     n;        /* stash size */
133:   PetscInt     bs;       /* block size of the stash */
134:   PetscInt     reallocs; /* preserve the no of mallocs invoked */
135:   PetscInt    *idx;      /* global row numbers in stash */
136:   PetscScalar *array;    /* array to hold stashed values */
137:   /* The following variables are used for communication */
138:   MPI_Comm     comm;
139:   PetscMPIInt  size, rank;
140:   PetscMPIInt  tag1, tag2;
141:   MPI_Request *send_waits;        /* array of send requests */
142:   MPI_Request *recv_waits;        /* array of receive requests */
143:   MPI_Status  *send_status;       /* array of send status */
144:   PetscInt     nsends, nrecvs;    /* numbers of sends and receives */
145:   PetscScalar *svalues, *rvalues; /* sending and receiving data */
146:   PetscInt    *sindices, *rindices;
147:   PetscInt     rmax;       /* maximum message length */
148:   PetscInt    *nprocs;     /* tmp data used both during scatterbegin and end */
149:   PetscInt     nprocessed; /* number of messages already processed */
150:   PetscBool    donotstash;
151:   PetscBool    ignorenegidx; /* ignore negative indices passed into VecSetValues/VetGetValues */
152:   InsertMode   insertmode;
153:   PetscInt    *bowners;
154: } VecStash;

156: struct _p_Vec {
157:   PETSCHEADER(struct _VecOps);
158:   PetscLayout map;
159:   void       *data; /* implementation-specific data */
160:   PetscBool   array_gotten;
161:   VecStash    stash, bstash; /* used for storing off-proc values during assembly */
162:   PetscBool   petscnative;   /* means the ->data starts with VECHEADER and can use VecGetArrayFast()*/
163: #if PetscDefined(USE_DEBUG)
164:   PetscStack lockstack; /* the file,func,line of where locks are added */
165:   PetscInt   lock;      /* lock state. vector can be free (=0), locked for read (>0) or locked for write(<0) */
166: #endif
167:   PetscOffloadMask offloadmask; /* a mask which indicates where the valid vector data is (GPU, CPU or both) */
168: #if defined(PETSC_HAVE_DEVICE)
169:   void     *spptr; /* this is the special pointer to the array on the GPU */
170:   PetscBool boundtocpu;
171:   PetscBool bindingpropagates;
172:   size_t    minimum_bytes_pinned_memory; /* minimum data size in bytes for which pinned memory will be allocated */
173:   PetscBool pinned_memory;               /* PETSC_TRUE if the current host allocation has been made from pinned memory. */
174: #endif
175:   char *defaultrandtype;
176: };

178: PETSC_EXTERN PetscLogEvent VEC_SetRandom;
179: PETSC_EXTERN PetscLogEvent VEC_View;
180: PETSC_EXTERN PetscLogEvent VEC_Max;
181: PETSC_EXTERN PetscLogEvent VEC_Min;
182: PETSC_EXTERN PetscLogEvent VEC_Dot;
183: PETSC_EXTERN PetscLogEvent VEC_MDot;
184: PETSC_EXTERN PetscLogEvent VEC_TDot;
185: PETSC_EXTERN PetscLogEvent VEC_MTDot;
186: PETSC_EXTERN PetscLogEvent VEC_Norm;
187: PETSC_EXTERN PetscLogEvent VEC_Normalize;
188: PETSC_EXTERN PetscLogEvent VEC_Scale;
189: PETSC_EXTERN PetscLogEvent VEC_Copy;
190: PETSC_EXTERN PetscLogEvent VEC_Set;
191: PETSC_EXTERN PetscLogEvent VEC_AXPY;
192: PETSC_EXTERN PetscLogEvent VEC_AYPX;
193: PETSC_EXTERN PetscLogEvent VEC_WAXPY;
194: PETSC_EXTERN PetscLogEvent VEC_MAXPY;
195: PETSC_EXTERN PetscLogEvent VEC_AssemblyEnd;
196: PETSC_EXTERN PetscLogEvent VEC_PointwiseMult;
197: PETSC_EXTERN PetscLogEvent VEC_SetValues;
198: PETSC_EXTERN PetscLogEvent VEC_SetPreallocateCOO;
199: PETSC_EXTERN PetscLogEvent VEC_SetValuesCOO;
200: PETSC_EXTERN PetscLogEvent VEC_Load;
201: PETSC_EXTERN PetscLogEvent VEC_ScatterBegin;
202: PETSC_EXTERN PetscLogEvent VEC_ScatterEnd;
203: PETSC_EXTERN PetscLogEvent VEC_ReduceArithmetic;
204: PETSC_EXTERN PetscLogEvent VEC_ReduceCommunication;
205: PETSC_EXTERN PetscLogEvent VEC_ReduceBegin;
206: PETSC_EXTERN PetscLogEvent VEC_ReduceEnd;
207: PETSC_EXTERN PetscLogEvent VEC_Swap;
208: PETSC_EXTERN PetscLogEvent VEC_AssemblyBegin;
209: PETSC_EXTERN PetscLogEvent VEC_DotNorm2;
210: PETSC_EXTERN PetscLogEvent VEC_AXPBYPCZ;
211: PETSC_EXTERN PetscLogEvent VEC_Ops;
212: PETSC_EXTERN PetscLogEvent VEC_ViennaCLCopyToGPU;
213: PETSC_EXTERN PetscLogEvent VEC_ViennaCLCopyFromGPU;
214: PETSC_EXTERN PetscLogEvent VEC_CUDACopyToGPU;
215: PETSC_EXTERN PetscLogEvent VEC_CUDACopyFromGPU;
216: PETSC_EXTERN PetscLogEvent VEC_HIPCopyToGPU;
217: PETSC_EXTERN PetscLogEvent VEC_HIPCopyFromGPU;

219: PETSC_EXTERN PetscErrorCode VecView_Seq(Vec, PetscViewer);
220: #if defined(PETSC_HAVE_VIENNACL)
221: PETSC_EXTERN PetscErrorCode VecViennaCLAllocateCheckHost(Vec v);
222: PETSC_EXTERN PetscErrorCode VecViennaCLCopyFromGPU(Vec v);
223: #endif

225: /*
226:      Common header shared by array based vectors,
227:    currently Vec_Seq and Vec_MPI
228: */
229: #define VECHEADER \
230:   PetscScalar *array; \
231:   PetscScalar *array_allocated; /* if the array was allocated by PETSc this is its pointer */ \
232:   PetscScalar *unplacedarray;   /* if one called VecPlaceArray(), this is where it stashed the original */

234: /* Get Root type of vector. e.g. VECSEQ -> VECSTANDARD, VECMPICUDA -> VECCUDA */
235: PETSC_EXTERN PetscErrorCode VecGetRootType_Private(Vec, VecType *);

237: /* Default obtain and release vectors; can be used by any implementation */
238: PETSC_EXTERN PetscErrorCode VecDuplicateVecs_Default(Vec, PetscInt, Vec *[]);
239: PETSC_EXTERN PetscErrorCode VecDestroyVecs_Default(PetscInt, Vec[]);
240: PETSC_EXTERN PetscErrorCode VecView_Binary(Vec, PetscViewer);
241: PETSC_EXTERN PetscErrorCode VecLoad_Binary(Vec, PetscViewer);
242: PETSC_EXTERN PetscErrorCode VecLoad_Default(Vec, PetscViewer);

244: PETSC_EXTERN PetscInt NormIds[7]; /* map from NormType to IDs used to cache/retrieve values of norms */

246: PETSC_INTERN PetscErrorCode VecStashCreate_Private(MPI_Comm, PetscInt, VecStash *);
247: PETSC_INTERN PetscErrorCode VecStashDestroy_Private(VecStash *);
248: PETSC_EXTERN PetscErrorCode VecStashExpand_Private(VecStash *, PetscInt);
249: PETSC_INTERN PetscErrorCode VecStashScatterEnd_Private(VecStash *);
250: PETSC_INTERN PetscErrorCode VecStashSetInitialSize_Private(VecStash *, PetscInt);
251: PETSC_INTERN PetscErrorCode VecStashGetInfo_Private(VecStash *, PetscInt *, PetscInt *);
252: PETSC_INTERN PetscErrorCode VecStashScatterBegin_Private(VecStash *, PetscInt *);
253: PETSC_INTERN PetscErrorCode VecStashScatterGetMesg_Private(VecStash *, PetscMPIInt *, PetscInt **, PetscScalar **, PetscInt *);
254: PETSC_INTERN PetscErrorCode VecStashSortCompress_Private(VecStash *);
255: PETSC_INTERN PetscErrorCode VecStashGetOwnerList_Private(VecStash *, PetscLayout, PetscMPIInt *, PetscMPIInt **);

257: /*
258:   VecStashValue_Private - inserts a single value into the stash.

260:   Input Parameters:
261:   stash  - the stash
262:   idx    - the global of the inserted value
263:   values - the value inserted
264: */
265: static inline PetscErrorCode VecStashValue_Private(VecStash *stash, PetscInt row, PetscScalar value)
266: {
267:   /* Check and see if we have sufficient memory */
268:   PetscFunctionBegin;
269:   if (((stash)->n + 1) > (stash)->nmax) PetscCall(VecStashExpand_Private(stash, 1));
270:   (stash)->idx[(stash)->n]   = row;
271:   (stash)->array[(stash)->n] = value;
272:   (stash)->n++;
273:   PetscFunctionReturn(PETSC_SUCCESS);
274: }

276: /*
277:   VecStashValuesBlocked_Private - inserts 1 block of values into the stash.

279:   Input Parameters:
280:   stash  - the stash
281:   idx    - the global block index
282:   values - the values inserted
283: */
284: static inline PetscErrorCode VecStashValuesBlocked_Private(VecStash *stash, PetscInt row, PetscScalar *values)
285: {
286:   PetscInt     stash_bs = (stash)->bs;
287:   PetscScalar *array;

289:   PetscFunctionBegin;
290:   if (((stash)->n + 1) > (stash)->nmax) PetscCall(VecStashExpand_Private(stash, 1));
291:   array                    = (stash)->array + stash_bs * (stash)->n;
292:   (stash)->idx[(stash)->n] = row;
293:   PetscCall(PetscArraycpy(array, values, stash_bs));
294:   (stash)->n++;
295:   PetscFunctionReturn(PETSC_SUCCESS);
296: }

298: PETSC_INTERN PetscErrorCode VecStrideGather_Default(Vec, PetscInt, Vec, InsertMode);
299: PETSC_INTERN PetscErrorCode VecStrideScatter_Default(Vec, PetscInt, Vec, InsertMode);
300: PETSC_INTERN PetscErrorCode VecStrideSubSetGather_Default(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);
301: PETSC_INTERN PetscErrorCode VecStrideSubSetScatter_Default(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);

303: PETSC_SINGLE_LIBRARY_INTERN PetscErrorCode VecReciprocal_Default(Vec);
304: #if defined(PETSC_HAVE_MATLAB)
305: PETSC_EXTERN PetscErrorCode VecMatlabEnginePut_Default(PetscObject, void *);
306: PETSC_EXTERN PetscErrorCode VecMatlabEngineGet_Default(PetscObject, void *);
307: #endif

309: PETSC_EXTERN PetscErrorCode PetscSectionGetField_Internal(PetscSection, PetscSection, Vec, PetscInt, PetscInt, PetscInt, IS *, Vec *);
310: PETSC_EXTERN PetscErrorCode PetscSectionRestoreField_Internal(PetscSection, PetscSection, Vec, PetscInt, PetscInt, PetscInt, IS *, Vec *);

312: #define VecCheckSameLocalSize(x, ar1, y, ar2) \
313:   do { \
314:     PetscCheck((x)->map->n == (y)->map->n, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Incompatible vector local lengths parameter # %d local size %" PetscInt_FMT " != parameter # %d local size %" PetscInt_FMT, ar1, (x)->map->n, ar2, (y)->map->n); \
315:   } while (0)

317: #define VecCheckSameSize(x, ar1, y, ar2) \
318:   do { \
319:     PetscCheck((x)->map->N == (y)->map->N, PetscObjectComm((PetscObject)x), PETSC_ERR_ARG_INCOMP, "Incompatible vector global lengths parameter # %d global size %" PetscInt_FMT " != parameter # %d global size %" PetscInt_FMT, ar1, (x)->map->N, ar2, \
320:                (y)->map->N); \
321:     VecCheckSameLocalSize(x, ar1, y, ar2); \
322:   } while (0)

324: #define VecCheckLocalSize(x, ar1, n) \
325:   do { \
326:     PetscCheck((x)->map->n == (n), PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Incorrect vector local size: parameter # %d local size %" PetscInt_FMT " != %" PetscInt_FMT, ar1, (x)->map->n, n); \
327:   } while (0)

329: #define VecCheckSize(x, ar1, n, N) \
330:   do { \
331:     PetscCheck((x)->map->N == (N), PetscObjectComm((PetscObject)x), PETSC_ERR_ARG_INCOMP, "Incorrect vector global size: parameter # %d global size %" PetscInt_FMT " != %" PetscInt_FMT, ar1, (x)->map->N, N); \
332:     VecCheckLocalSize(x, ar1, n); \
333:   } while (0)

335: typedef struct _VecTaggerOps *VecTaggerOps;
336: struct _VecTaggerOps {
337:   PetscErrorCode (*create)(VecTagger);
338:   PetscErrorCode (*destroy)(VecTagger);
339:   PetscErrorCode (*setfromoptions)(VecTagger, PetscOptionItems *);
340:   PetscErrorCode (*setup)(VecTagger);
341:   PetscErrorCode (*view)(VecTagger, PetscViewer);
342:   PetscErrorCode (*computeboxes)(VecTagger, Vec, PetscInt *, VecTaggerBox **, PetscBool *);
343:   PetscErrorCode (*computeis)(VecTagger, Vec, IS *, PetscBool *);
344: };
345: struct _p_VecTagger {
346:   PETSCHEADER(struct _VecTaggerOps);
347:   void     *data;
348:   PetscInt  blocksize;
349:   PetscBool invert;
350:   PetscBool setupcalled;
351: };

353: PETSC_EXTERN PetscBool      VecTaggerRegisterAllCalled;
354: PETSC_EXTERN PetscErrorCode VecTaggerRegisterAll(void);
355: PETSC_EXTERN PetscErrorCode VecTaggerComputeIS_FromBoxes(VecTagger, Vec, IS *, PetscBool *);
356: PETSC_EXTERN PetscMPIInt    Petsc_Reduction_keyval;

358: PETSC_INTERN PetscInt       VecGetSubVectorSavedStateId;
359: PETSC_INTERN PetscErrorCode VecGetSubVectorContiguityAndBS_Private(Vec, IS, PetscBool *, PetscInt *, PetscInt *);
360: PETSC_INTERN PetscErrorCode VecGetSubVectorThroughVecScatter_Private(Vec, IS, PetscInt, Vec *);

362: #if PetscDefined(HAVE_CUDA)
363: PETSC_INTERN PetscErrorCode VecCreate_CUDA(Vec);
364: PETSC_INTERN PetscErrorCode VecCreate_SeqCUDA(Vec);
365: PETSC_INTERN PetscErrorCode VecCreate_MPICUDA(Vec);
366: PETSC_INTERN PetscErrorCode VecCUDAGetArrays_Private(Vec, const PetscScalar **, const PetscScalar **, PetscOffloadMask *);
367: #endif

369: #if PetscDefined(HAVE_HIP)
370: PETSC_INTERN PetscErrorCode VecCreate_HIP(Vec);
371: PETSC_INTERN PetscErrorCode VecCreate_SeqHIP(Vec);
372: PETSC_INTERN PetscErrorCode VecCreate_MPIHIP(Vec);
373: PETSC_INTERN PetscErrorCode VecHIPGetArrays_Private(Vec, const PetscScalar **, const PetscScalar **, PetscOffloadMask *);
374: #endif

376: #if defined(PETSC_HAVE_KOKKOS)
377: PETSC_INTERN PetscErrorCode VecCreateSeqKokkosWithArrays_Private(MPI_Comm, PetscInt, PetscInt, const PetscScalar *, const PetscScalar *, Vec *);
378: PETSC_INTERN PetscErrorCode VecCreateMPIKokkosWithArrays_Private(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar *, const PetscScalar *, Vec *);
379: #endif

381: /* std::upper_bound(): Given a sorted array, return index of the first element in range [first,last) whose value
382:    is greater than value, or last if there is no such element.
383: */
384: static inline PetscErrorCode PetscSortedIntUpperBound(PetscInt *array, PetscCount first, PetscCount last, PetscInt value, PetscCount *upper)
385: {
386:   PetscCount it, step, count = last - first;

388:   PetscFunctionBegin;
389:   while (count > 0) {
390:     it   = first;
391:     step = count / 2;
392:     it += step;
393:     if (!(value < array[it])) {
394:       first = ++it;
395:       count -= step + 1;
396:     } else count = step;
397:   }
398:   *upper = first;
399:   PetscFunctionReturn(PETSC_SUCCESS);
400: }

402: #endif /* __VECIMPL_H */