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)(PetscOptionItems*,Vec);
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 (*getlocalvector)(Vec,Vec);
94: PetscErrorCode (*restorelocalvector)(Vec,Vec);
95: PetscErrorCode (*getlocalvectorread)(Vec,Vec);
96: PetscErrorCode (*restorelocalvectorread)(Vec,Vec);
97: PetscErrorCode (*bindtocpu)(Vec,PetscBool);
98: PetscErrorCode (*getarraywrite)(Vec,PetscScalar**);
99: PetscErrorCode (*restorearraywrite)(Vec,PetscScalar**);
100: PetscErrorCode (*getarrayandmemtype)(Vec,PetscScalar**,PetscMemType*);
101: PetscErrorCode (*restorearrayandmemtype)(Vec,PetscScalar**);
102: PetscErrorCode (*getarrayreadandmemtype)(Vec,const PetscScalar**,PetscMemType*);
103: PetscErrorCode (*restorearrayreadandmemtype)(Vec,const PetscScalar**);
104: PetscErrorCode (*getarraywriteandmemtype)(Vec,PetscScalar**,PetscMemType*);
105: PetscErrorCode (*restorearraywriteandmemtype)(Vec,PetscScalar**,PetscMemType*);
106: PetscErrorCode (*concatenate)(PetscInt,const Vec[],Vec*,IS*[]);
107: PetscErrorCode (*sum)(Vec,PetscScalar*);
108: };
110: /*
111: The stash is used to temporarily store inserted vec values that
112: belong to another processor. During the assembly phase the stashed
113: values are moved to the correct processor and
114: */
116: typedef struct {
117: PetscInt nmax; /* maximum stash size */
118: PetscInt umax; /* max stash size user wants */
119: PetscInt oldnmax; /* the nmax value used previously */
120: PetscInt n; /* stash size */
121: PetscInt bs; /* block size of the stash */
122: PetscInt reallocs; /* preserve the no of mallocs invoked */
123: PetscInt *idx; /* global row numbers in stash */
124: PetscScalar *array; /* array to hold stashed values */
125: /* The following variables are used for communication */
126: MPI_Comm comm;
127: PetscMPIInt size,rank;
128: PetscMPIInt tag1,tag2;
129: MPI_Request *send_waits; /* array of send requests */
130: MPI_Request *recv_waits; /* array of receive requests */
131: MPI_Status *send_status; /* array of send status */
132: PetscInt nsends,nrecvs; /* numbers of sends and receives */
133: PetscScalar *svalues,*rvalues; /* sending and receiving data */
134: PetscInt *sindices,*rindices;
135: PetscInt rmax; /* maximum message length */
136: PetscInt *nprocs; /* tmp data used both during scatterbegin and end */
137: PetscInt nprocessed; /* number of messages already processed */
138: PetscBool donotstash;
139: PetscBool ignorenegidx; /* ignore negative indices passed into VecSetValues/VetGetValues */
140: InsertMode insertmode;
141: PetscInt *bowners;
142: } VecStash;
144: struct _p_Vec {
145: PETSCHEADER(struct _VecOps);
146: PetscLayout map;
147: void *data; /* implementation-specific data */
148: PetscBool array_gotten;
149: VecStash stash,bstash; /* used for storing off-proc values during assembly */
150: PetscBool petscnative; /* means the ->data starts with VECHEADER and can use VecGetArrayFast()*/
151: PetscInt lock; /* lock state. vector can be free (=0), locked for read (>0) or locked for write(<0) */
152: PetscOffloadMask offloadmask; /* a mask which indicates where the valid vector data is (GPU, CPU or both) */
153: #if defined(PETSC_HAVE_DEVICE)
154: void *spptr; /* this is the special pointer to the array on the GPU */
155: PetscBool boundtocpu;
156: PetscBool bindingpropagates;
157: size_t minimum_bytes_pinned_memory; /* minimum data size in bytes for which pinned memory will be allocated */
158: PetscBool pinned_memory; /* PETSC_TRUE if the current host allocation has been made from pinned memory. */
159: #endif
160: char *defaultrandtype;
161: };
163: PETSC_EXTERN PetscLogEvent VEC_SetRandom;
164: PETSC_EXTERN PetscLogEvent VEC_View;
165: PETSC_EXTERN PetscLogEvent VEC_Max;
166: PETSC_EXTERN PetscLogEvent VEC_Min;
167: PETSC_EXTERN PetscLogEvent VEC_Dot;
168: PETSC_EXTERN PetscLogEvent VEC_MDot;
169: PETSC_EXTERN PetscLogEvent VEC_TDot;
170: PETSC_EXTERN PetscLogEvent VEC_MTDot;
171: PETSC_EXTERN PetscLogEvent VEC_Norm;
172: PETSC_EXTERN PetscLogEvent VEC_Normalize;
173: PETSC_EXTERN PetscLogEvent VEC_Scale;
174: PETSC_EXTERN PetscLogEvent VEC_Copy;
175: PETSC_EXTERN PetscLogEvent VEC_Set;
176: PETSC_EXTERN PetscLogEvent VEC_AXPY;
177: PETSC_EXTERN PetscLogEvent VEC_AYPX;
178: PETSC_EXTERN PetscLogEvent VEC_WAXPY;
179: PETSC_EXTERN PetscLogEvent VEC_MAXPY;
180: PETSC_EXTERN PetscLogEvent VEC_AssemblyEnd;
181: PETSC_EXTERN PetscLogEvent VEC_PointwiseMult;
182: PETSC_EXTERN PetscLogEvent VEC_SetValues;
183: PETSC_EXTERN PetscLogEvent VEC_Load;
184: PETSC_EXTERN PetscLogEvent VEC_ScatterBegin;
185: PETSC_EXTERN PetscLogEvent VEC_ScatterEnd;
186: PETSC_EXTERN PetscLogEvent VEC_ReduceArithmetic;
187: PETSC_EXTERN PetscLogEvent VEC_ReduceCommunication;
188: PETSC_EXTERN PetscLogEvent VEC_ReduceBegin;
189: PETSC_EXTERN PetscLogEvent VEC_ReduceEnd;
190: PETSC_EXTERN PetscLogEvent VEC_Swap;
191: PETSC_EXTERN PetscLogEvent VEC_AssemblyBegin;
192: PETSC_EXTERN PetscLogEvent VEC_DotNorm2;
193: PETSC_EXTERN PetscLogEvent VEC_AXPBYPCZ;
194: PETSC_EXTERN PetscLogEvent VEC_Ops;
195: PETSC_EXTERN PetscLogEvent VEC_ViennaCLCopyToGPU;
196: PETSC_EXTERN PetscLogEvent VEC_ViennaCLCopyFromGPU;
197: PETSC_EXTERN PetscLogEvent VEC_CUDACopyToGPU;
198: PETSC_EXTERN PetscLogEvent VEC_CUDACopyFromGPU;
199: PETSC_EXTERN PetscLogEvent VEC_CUDACopyToGPUSome;
200: PETSC_EXTERN PetscLogEvent VEC_CUDACopyFromGPUSome;
201: PETSC_EXTERN PetscLogEvent VEC_HIPCopyToGPU;
202: PETSC_EXTERN PetscLogEvent VEC_HIPCopyFromGPU;
203: PETSC_EXTERN PetscLogEvent VEC_HIPCopyToGPUSome;
204: PETSC_EXTERN PetscLogEvent VEC_HIPCopyFromGPUSome;
206: PETSC_EXTERN PetscErrorCode VecView_Seq(Vec,PetscViewer);
207: #if defined(PETSC_HAVE_VIENNACL)
208: PETSC_EXTERN PetscErrorCode VecViennaCLAllocateCheckHost(Vec v);
209: PETSC_EXTERN PetscErrorCode VecViennaCLCopyFromGPU(Vec v);
210: #endif
211: #if defined(PETSC_HAVE_CUDA)
212: PETSC_EXTERN PetscErrorCode VecCUDAAllocateCheckHost(Vec v);
213: PETSC_EXTERN PetscErrorCode VecCUDACopyFromGPU(Vec v);
214: #endif
215: #if defined(PETSC_HAVE_HIP)
216: PETSC_EXTERN PetscErrorCode VecHIPAllocateCheckHost(Vec v);
217: PETSC_EXTERN PetscErrorCode VecHIPCopyFromGPU(Vec v);
218: #endif
220: /*
221: Common header shared by array based vectors,
222: currently Vec_Seq and Vec_MPI
223: */
224: #define VECHEADER \
225: PetscScalar *array; \
226: PetscScalar *array_allocated; /* if the array was allocated by PETSc this is its pointer */ \
227: PetscScalar *unplacedarray; /* if one called VecPlaceArray(), this is where it stashed the original */
229: /* Lock a vector for exclusive read&write access */
230: #if defined(PETSC_USE_DEBUG)
231: PETSC_INTERN PetscErrorCode VecLockWriteSet_Private(Vec,PetscBool);
232: #else
233: #define VecLockWriteSet_Private(x,flg) 0
234: #endif
236: /* Get Root type of vector. e.g. VECSEQ -> VECSTANDARD, VECMPICUDA -> VECCUDA */
237: PETSC_EXTERN PetscErrorCode VecGetRootType_Private(Vec,VecType*);
239: /* Default obtain and release vectors; can be used by any implementation */
240: PETSC_EXTERN PetscErrorCode VecDuplicateVecs_Default(Vec,PetscInt,Vec*[]);
241: PETSC_EXTERN PetscErrorCode VecDestroyVecs_Default(PetscInt,Vec[]);
242: PETSC_EXTERN PetscErrorCode VecView_Binary(Vec,PetscViewer);
243: PETSC_EXTERN PetscErrorCode VecLoad_Binary(Vec,PetscViewer);
244: PETSC_EXTERN PetscErrorCode VecLoad_Default(Vec,PetscViewer);
246: PETSC_EXTERN PetscInt NormIds[7]; /* map from NormType to IDs used to cache/retreive values of norms */
248: PETSC_INTERN PetscErrorCode VecStashCreate_Private(MPI_Comm,PetscInt,VecStash*);
249: PETSC_INTERN PetscErrorCode VecStashDestroy_Private(VecStash*);
250: PETSC_EXTERN PetscErrorCode VecStashExpand_Private(VecStash*,PetscInt);
251: PETSC_INTERN PetscErrorCode VecStashScatterEnd_Private(VecStash*);
252: PETSC_INTERN PetscErrorCode VecStashSetInitialSize_Private(VecStash*,PetscInt);
253: PETSC_INTERN PetscErrorCode VecStashGetInfo_Private(VecStash*,PetscInt*,PetscInt*);
254: PETSC_INTERN PetscErrorCode VecStashScatterBegin_Private(VecStash*,PetscInt*);
255: PETSC_INTERN PetscErrorCode VecStashScatterGetMesg_Private(VecStash*,PetscMPIInt*,PetscInt**,PetscScalar**,PetscInt*);
256: PETSC_INTERN PetscErrorCode VecStashSortCompress_Private(VecStash*);
257: PETSC_INTERN PetscErrorCode VecStashGetOwnerList_Private(VecStash*,PetscLayout,PetscMPIInt*,PetscMPIInt**);
259: /*
260: VecStashValue_Private - inserts a single value into the stash.
262: Input Parameters:
263: stash - the stash
264: idx - the global of the inserted value
265: values - the value inserted
266: */
267: static inline PetscErrorCode VecStashValue_Private(VecStash *stash,PetscInt row,PetscScalar value)
268: {
269: /* Check and see if we have sufficient memory */
270: if (((stash)->n + 1) > (stash)->nmax) VecStashExpand_Private(stash,1);
271: (stash)->idx[(stash)->n] = row;
272: (stash)->array[(stash)->n] = value;
273: (stash)->n++;
274: return 0;
275: }
277: /*
278: VecStashValuesBlocked_Private - inserts 1 block of values into the stash.
280: Input Parameters:
281: stash - the stash
282: idx - the global block index
283: values - the values inserted
284: */
285: static inline PetscErrorCode VecStashValuesBlocked_Private(VecStash *stash,PetscInt row,PetscScalar *values)
286: {
287: PetscInt stash_bs = (stash)->bs;
288: PetscScalar *array;
290: if (((stash)->n+1) > (stash)->nmax) VecStashExpand_Private(stash,1);
291: array = (stash)->array + stash_bs*(stash)->n;
292: (stash)->idx[(stash)->n] = row;
293: PetscArraycpy(array,values,stash_bs);
294: (stash)->n++;
295: return 0;
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 VecReciprocal_Default(Vec);
301: PETSC_INTERN PetscErrorCode VecStrideSubSetGather_Default(Vec,PetscInt,const PetscInt[],const PetscInt[],Vec,InsertMode);
302: PETSC_INTERN PetscErrorCode VecStrideSubSetScatter_Default(Vec,PetscInt,const PetscInt[],const PetscInt[],Vec,InsertMode);
304: #if defined(PETSC_HAVE_MATLAB_ENGINE)
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) do { \
314: } while (0)
316: #define VecCheckSameSize(x,ar1,y,ar2) do { \
318: VecCheckSameLocalSize(x,ar1,y,ar2); \
319: } while (0)
321: #define VecCheckLocalSize(x,ar1,n) do { \
323: } while (0)
325: #define VecCheckSize(x,ar1,n,N) do { \
327: VecCheckLocalSize(x,ar1,n); \
328: } while (0)
330: typedef struct _VecTaggerOps *VecTaggerOps;
331: struct _VecTaggerOps {
332: PetscErrorCode (*create) (VecTagger);
333: PetscErrorCode (*destroy) (VecTagger);
334: PetscErrorCode (*setfromoptions) (PetscOptionItems*,VecTagger);
335: PetscErrorCode (*setup) (VecTagger);
336: PetscErrorCode (*view) (VecTagger,PetscViewer);
337: PetscErrorCode (*computeboxes) (VecTagger,Vec,PetscInt *,VecTaggerBox **,PetscBool *);
338: PetscErrorCode (*computeis) (VecTagger,Vec,IS *,PetscBool *);
339: };
340: struct _p_VecTagger {
341: PETSCHEADER(struct _VecTaggerOps);
342: void *data;
343: PetscInt blocksize;
344: PetscBool invert;
345: PetscBool setupcalled;
346: };
348: PETSC_EXTERN PetscBool VecTaggerRegisterAllCalled;
349: PETSC_EXTERN PetscErrorCode VecTaggerRegisterAll(void);
350: PETSC_EXTERN PetscErrorCode VecTaggerComputeIS_FromBoxes(VecTagger,Vec,IS*,PetscBool*);
351: PETSC_EXTERN PetscMPIInt Petsc_Reduction_keyval;
353: PETSC_INTERN PetscInt VecGetSubVectorSavedStateId;
354: PETSC_INTERN PetscErrorCode VecGetSubVectorContiguityAndBS_Private(Vec,IS,PetscBool*,PetscInt*,PetscInt*);
355: PETSC_INTERN PetscErrorCode VecGetSubVectorThroughVecScatter_Private(Vec,IS,PetscInt,Vec*);
357: #if defined(PETSC_HAVE_KOKKOS)
358: PETSC_INTERN PetscErrorCode VecCreateSeqKokkosWithArrays_Private(MPI_Comm,PetscInt,PetscInt,const PetscScalar*,const PetscScalar*,Vec*);
359: PETSC_INTERN PetscErrorCode VecCreateMPIKokkosWithArrays_Private(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar*,const PetscScalar*,Vec*);
360: #endif
362: #endif /* __VECIMPL_H */