Actual source code: vecimpl.h
petsc-master 2020-11-30
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>
13: #include <petscviewer.h>
15: PETSC_EXTERN PetscBool VecRegisterAllCalled;
16: PETSC_EXTERN PetscErrorCode VecRegisterAll(void);
18: /* ----------------------------------------------------------------------------*/
20: typedef struct _VecOps *VecOps;
21: struct _VecOps {
22: PetscErrorCode (*duplicate)(Vec,Vec*); /* get single vector */
23: PetscErrorCode (*duplicatevecs)(Vec,PetscInt,Vec**); /* get array of vectors */
24: PetscErrorCode (*destroyvecs)(PetscInt,Vec[]); /* free array of vectors */
25: PetscErrorCode (*dot)(Vec,Vec,PetscScalar*); /* z = x^H * y */
26: PetscErrorCode (*mdot)(Vec,PetscInt,const Vec[],PetscScalar*); /* z[j] = x dot y[j] */
27: PetscErrorCode (*norm)(Vec,NormType,PetscReal*); /* z = sqrt(x^H * x) */
28: PetscErrorCode (*tdot)(Vec,Vec,PetscScalar*); /* x'*y */
29: PetscErrorCode (*mtdot)(Vec,PetscInt,const Vec[],PetscScalar*);/* z[j] = x dot y[j] */
30: PetscErrorCode (*scale)(Vec,PetscScalar); /* x = alpha * x */
31: PetscErrorCode (*copy)(Vec,Vec); /* y = x */
32: PetscErrorCode (*set)(Vec,PetscScalar); /* y = alpha */
33: PetscErrorCode (*swap)(Vec,Vec); /* exchange x and y */
34: PetscErrorCode (*axpy)(Vec,PetscScalar,Vec); /* y = y + alpha * x */
35: PetscErrorCode (*axpby)(Vec,PetscScalar,PetscScalar,Vec); /* y = alpha * x + beta * y*/
36: PetscErrorCode (*maxpy)(Vec,PetscInt,const PetscScalar*,Vec*); /* y = y + alpha[j] x[j] */
37: PetscErrorCode (*aypx)(Vec,PetscScalar,Vec); /* y = x + alpha * y */
38: PetscErrorCode (*waxpy)(Vec,PetscScalar,Vec,Vec); /* w = y + alpha * x */
39: PetscErrorCode (*axpbypcz)(Vec,PetscScalar,PetscScalar,PetscScalar,Vec,Vec); /* z = alpha * x + beta *y + gamma *z*/
40: PetscErrorCode (*pointwisemult)(Vec,Vec,Vec); /* w = x .* y */
41: PetscErrorCode (*pointwisedivide)(Vec,Vec,Vec); /* w = x ./ y */
42: PetscErrorCode (*setvalues)(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
43: PetscErrorCode (*assemblybegin)(Vec); /* start global assembly */
44: PetscErrorCode (*assemblyend)(Vec); /* end global assembly */
45: PetscErrorCode (*getarray)(Vec,PetscScalar**); /* get data array */
46: PetscErrorCode (*getsize)(Vec,PetscInt*);
47: PetscErrorCode (*getlocalsize)(Vec,PetscInt*);
48: PetscErrorCode (*restorearray)(Vec,PetscScalar**); /* restore data array */
49: PetscErrorCode (*max)(Vec,PetscInt*,PetscReal*); /* z = max(x); idx=index of max(x) */
50: PetscErrorCode (*min)(Vec,PetscInt*,PetscReal*); /* z = min(x); idx=index of min(x) */
51: PetscErrorCode (*setrandom)(Vec,PetscRandom); /* set y[j] = random numbers */
52: PetscErrorCode (*setoption)(Vec,VecOption,PetscBool);
53: PetscErrorCode (*setvaluesblocked)(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
54: PetscErrorCode (*destroy)(Vec);
55: PetscErrorCode (*view)(Vec,PetscViewer);
56: PetscErrorCode (*placearray)(Vec,const PetscScalar*); /* place data array */
57: PetscErrorCode (*replacearray)(Vec,const PetscScalar*); /* replace data array */
58: PetscErrorCode (*dot_local)(Vec,Vec,PetscScalar*);
59: PetscErrorCode (*tdot_local)(Vec,Vec,PetscScalar*);
60: PetscErrorCode (*norm_local)(Vec,NormType,PetscReal*);
61: PetscErrorCode (*mdot_local)(Vec,PetscInt,const Vec[],PetscScalar*);
62: PetscErrorCode (*mtdot_local)(Vec,PetscInt,const Vec[],PetscScalar*);
63: PetscErrorCode (*load)(Vec,PetscViewer);
64: PetscErrorCode (*reciprocal)(Vec);
65: PetscErrorCode (*conjugate)(Vec);
66: PetscErrorCode (*setlocaltoglobalmapping)(Vec,ISLocalToGlobalMapping);
67: PetscErrorCode (*setvalueslocal)(Vec,PetscInt,const PetscInt *,const PetscScalar *,InsertMode);
68: PetscErrorCode (*resetarray)(Vec); /* vector points to its original array, i.e. undoes any VecPlaceArray() */
69: PetscErrorCode (*setfromoptions)(PetscOptionItems*,Vec);
70: PetscErrorCode (*maxpointwisedivide)(Vec,Vec,PetscReal*); /* m = max abs(x ./ y) */
71: PetscErrorCode (*pointwisemax)(Vec,Vec,Vec);
72: PetscErrorCode (*pointwisemaxabs)(Vec,Vec,Vec);
73: PetscErrorCode (*pointwisemin)(Vec,Vec,Vec);
74: PetscErrorCode (*getvalues)(Vec,PetscInt,const PetscInt[],PetscScalar[]);
75: PetscErrorCode (*sqrt)(Vec);
76: PetscErrorCode (*abs)(Vec);
77: PetscErrorCode (*exp)(Vec);
78: PetscErrorCode (*log)(Vec);
79: PetscErrorCode (*shift)(Vec,PetscScalar);
80: PetscErrorCode (*create)(Vec);
81: PetscErrorCode (*stridegather)(Vec,PetscInt,Vec,InsertMode);
82: PetscErrorCode (*stridescatter)(Vec,PetscInt,Vec,InsertMode);
83: PetscErrorCode (*dotnorm2)(Vec,Vec,PetscScalar*,PetscScalar*);
84: PetscErrorCode (*getsubvector)(Vec,IS,Vec*);
85: PetscErrorCode (*restoresubvector)(Vec,IS,Vec*);
86: PetscErrorCode (*getarrayread)(Vec,const PetscScalar**);
87: PetscErrorCode (*restorearrayread)(Vec,const PetscScalar**);
88: PetscErrorCode (*stridesubsetgather)(Vec,PetscInt,const PetscInt[],const PetscInt[],Vec,InsertMode);
89: PetscErrorCode (*stridesubsetscatter)(Vec,PetscInt,const PetscInt[],const PetscInt[],Vec,InsertMode);
90: PetscErrorCode (*viewnative)(Vec,PetscViewer);
91: PetscErrorCode (*loadnative)(Vec,PetscViewer);
92: PetscErrorCode (*getlocalvector)(Vec,Vec);
93: PetscErrorCode (*restorelocalvector)(Vec,Vec);
94: PetscErrorCode (*getlocalvectorread)(Vec,Vec);
95: PetscErrorCode (*restorelocalvectorread)(Vec,Vec);
96: PetscErrorCode (*bindtocpu)(Vec,PetscBool);
97: PetscErrorCode (*getarraywrite)(Vec,PetscScalar**);
98: PetscErrorCode (*restorearraywrite)(Vec,PetscScalar**);
99: PetscErrorCode (*getarrayandmemtype)(Vec,PetscScalar**,PetscMemType*);
100: PetscErrorCode (*getarrayreadandmemtype)(Vec,const PetscScalar**,PetscMemType*);
101: PetscErrorCode (*restorearrayandmemtype)(Vec,PetscScalar**);
102: PetscErrorCode (*restorearrayreadandmemtype)(Vec,const PetscScalar**);
103: };
105: /*
106: The stash is used to temporarily store inserted vec values that
107: belong to another processor. During the assembly phase the stashed
108: values are moved to the correct processor and
109: */
111: typedef struct {
112: PetscInt nmax; /* maximum stash size */
113: PetscInt umax; /* max stash size user wants */
114: PetscInt oldnmax; /* the nmax value used previously */
115: PetscInt n; /* stash size */
116: PetscInt bs; /* block size of the stash */
117: PetscInt reallocs; /* preserve the no of mallocs invoked */
118: PetscInt *idx; /* global row numbers in stash */
119: PetscScalar *array; /* array to hold stashed values */
120: /* The following variables are used for communication */
121: MPI_Comm comm;
122: PetscMPIInt size,rank;
123: PetscMPIInt tag1,tag2;
124: MPI_Request *send_waits; /* array of send requests */
125: MPI_Request *recv_waits; /* array of receive requests */
126: MPI_Status *send_status; /* array of send status */
127: PetscInt nsends,nrecvs; /* numbers of sends and receives */
128: PetscScalar *svalues,*rvalues; /* sending and receiving data */
129: PetscInt *sindices,*rindices;
130: PetscInt rmax; /* maximum message length */
131: PetscInt *nprocs; /* tmp data used both during scatterbegin and end */
132: PetscInt nprocessed; /* number of messages already processed */
133: PetscBool donotstash;
134: PetscBool ignorenegidx; /* ignore negative indices passed into VecSetValues/VetGetValues */
135: InsertMode insertmode;
136: PetscInt *bowners;
137: } VecStash;
139: struct _p_Vec {
140: PETSCHEADER(struct _VecOps);
141: PetscLayout map;
142: void *data; /* implementation-specific data */
143: PetscBool array_gotten;
144: VecStash stash,bstash; /* used for storing off-proc values during assembly */
145: PetscBool petscnative; /* means the ->data starts with VECHEADER and can use VecGetArrayFast()*/
146: PetscInt lock; /* lock state. vector can be free (=0), locked for read (>0) or locked for write(<0) */
147: PetscOffloadMask offloadmask; /* a mask which indicates where the valid vector data is (GPU, CPU or both) */
148: #if defined(PETSC_HAVE_DEVICE)
149: void *spptr; /* this is the special pointer to the array on the GPU */
150: PetscBool boundtocpu;
151: size_t minimum_bytes_pinned_memory; /* minimum data size in bytes for which pinned memory will be allocated */
152: PetscBool pinned_memory; /* PETSC_TRUE if the current host allocation has been made from pinned memory. */
153: #endif
154: };
156: PETSC_EXTERN PetscLogEvent VEC_SetRandom;
157: PETSC_EXTERN PetscLogEvent VEC_View;
158: PETSC_EXTERN PetscLogEvent VEC_Max;
159: PETSC_EXTERN PetscLogEvent VEC_Min;
160: PETSC_EXTERN PetscLogEvent VEC_Dot;
161: PETSC_EXTERN PetscLogEvent VEC_MDot;
162: PETSC_EXTERN PetscLogEvent VEC_TDot;
163: PETSC_EXTERN PetscLogEvent VEC_MTDot;
164: PETSC_EXTERN PetscLogEvent VEC_Norm;
165: PETSC_EXTERN PetscLogEvent VEC_Normalize;
166: PETSC_EXTERN PetscLogEvent VEC_Scale;
167: PETSC_EXTERN PetscLogEvent VEC_Copy;
168: PETSC_EXTERN PetscLogEvent VEC_Set;
169: PETSC_EXTERN PetscLogEvent VEC_AXPY;
170: PETSC_EXTERN PetscLogEvent VEC_AYPX;
171: PETSC_EXTERN PetscLogEvent VEC_WAXPY;
172: PETSC_EXTERN PetscLogEvent VEC_MAXPY;
173: PETSC_EXTERN PetscLogEvent VEC_AssemblyEnd;
174: PETSC_EXTERN PetscLogEvent VEC_PointwiseMult;
175: PETSC_EXTERN PetscLogEvent VEC_SetValues;
176: PETSC_EXTERN PetscLogEvent VEC_Load;
177: PETSC_EXTERN PetscLogEvent VEC_ScatterBegin;
178: PETSC_EXTERN PetscLogEvent VEC_ScatterEnd;
179: PETSC_EXTERN PetscLogEvent VEC_ReduceArithmetic;
180: PETSC_EXTERN PetscLogEvent VEC_ReduceCommunication;
181: PETSC_EXTERN PetscLogEvent VEC_ReduceBegin;
182: PETSC_EXTERN PetscLogEvent VEC_ReduceEnd;
183: PETSC_EXTERN PetscLogEvent VEC_Swap;
184: PETSC_EXTERN PetscLogEvent VEC_AssemblyBegin;
185: PETSC_EXTERN PetscLogEvent VEC_DotNorm2;
186: PETSC_EXTERN PetscLogEvent VEC_AXPBYPCZ;
187: PETSC_EXTERN PetscLogEvent VEC_Ops;
188: PETSC_EXTERN PetscLogEvent VEC_ViennaCLCopyToGPU;
189: PETSC_EXTERN PetscLogEvent VEC_ViennaCLCopyFromGPU;
190: PETSC_EXTERN PetscLogEvent VEC_CUDACopyToGPU;
191: PETSC_EXTERN PetscLogEvent VEC_CUDACopyFromGPU;
192: PETSC_EXTERN PetscLogEvent VEC_CUDACopyToGPUSome;
193: PETSC_EXTERN PetscLogEvent VEC_CUDACopyFromGPUSome;
195: PETSC_EXTERN PetscErrorCode VecView_Seq(Vec,PetscViewer);
196: #if defined(PETSC_HAVE_VIENNACL)
197: PETSC_EXTERN PetscErrorCode VecViennaCLAllocateCheckHost(Vec v);
198: PETSC_EXTERN PetscErrorCode VecViennaCLCopyFromGPU(Vec v);
199: #endif
200: #if defined(PETSC_HAVE_CUDA)
201: PETSC_EXTERN PetscErrorCode VecCUDAAllocateCheckHost(Vec v);
202: PETSC_EXTERN PetscErrorCode VecCUDACopyFromGPU(Vec v);
203: #endif
206: /*
207: Common header shared by array based vectors,
208: currently Vec_Seq and Vec_MPI
209: */
210: #define VECHEADER \
211: PetscScalar *array; \
212: PetscScalar *array_allocated; /* if the array was allocated by PETSc this is its pointer */ \
213: PetscScalar *unplacedarray; /* if one called VecPlaceArray(), this is where it stashed the original */
215: /* Lock a vector for exclusive read&write access */
216: #if defined(PETSC_USE_DEBUG)
217: PETSC_INTERN PetscErrorCode VecLockWriteSet_Private(Vec,PetscBool);
218: #else
219: #define VecLockWriteSet_Private(x,flg) 0
220: #endif
222: /* Default obtain and release vectors; can be used by any implementation */
223: PETSC_EXTERN PetscErrorCode VecDuplicateVecs_Default(Vec,PetscInt,Vec *[]);
224: PETSC_EXTERN PetscErrorCode VecDestroyVecs_Default(PetscInt,Vec []);
225: PETSC_EXTERN PetscErrorCode VecView_Binary(Vec, PetscViewer);
226: PETSC_EXTERN PetscErrorCode VecLoad_Binary(Vec, PetscViewer);
227: PETSC_EXTERN PetscErrorCode VecLoad_Default(Vec, PetscViewer);
229: PETSC_EXTERN PetscInt NormIds[7]; /* map from NormType to IDs used to cache/retreive values of norms */
231: PETSC_INTERN PetscErrorCode VecStashCreate_Private(MPI_Comm,PetscInt,VecStash*);
232: PETSC_INTERN PetscErrorCode VecStashDestroy_Private(VecStash*);
233: PETSC_EXTERN PetscErrorCode VecStashExpand_Private(VecStash*,PetscInt);
234: PETSC_INTERN PetscErrorCode VecStashScatterEnd_Private(VecStash*);
235: PETSC_INTERN PetscErrorCode VecStashSetInitialSize_Private(VecStash*,PetscInt);
236: PETSC_INTERN PetscErrorCode VecStashGetInfo_Private(VecStash*,PetscInt*,PetscInt*);
237: PETSC_INTERN PetscErrorCode VecStashScatterBegin_Private(VecStash*,PetscInt*);
238: PETSC_INTERN PetscErrorCode VecStashScatterGetMesg_Private(VecStash*,PetscMPIInt*,PetscInt**,PetscScalar**,PetscInt*);
239: PETSC_INTERN PetscErrorCode VecStashSortCompress_Private(VecStash*);
240: PETSC_INTERN PetscErrorCode VecStashGetOwnerList_Private(VecStash*,PetscLayout,PetscMPIInt*,PetscMPIInt**);
242: /*
243: VecStashValue_Private - inserts a single value into the stash.
245: Input Parameters:
246: stash - the stash
247: idx - the global of the inserted value
248: values - the value inserted
249: */
250: PETSC_STATIC_INLINE PetscErrorCode VecStashValue_Private(VecStash *stash,PetscInt row,PetscScalar value)
251: {
253: /* Check and see if we have sufficient memory */
254: if (((stash)->n + 1) > (stash)->nmax) {
255: VecStashExpand_Private(stash,1);
256: }
257: (stash)->idx[(stash)->n] = row;
258: (stash)->array[(stash)->n] = value;
259: (stash)->n++;
260: return 0;
261: }
263: /*
264: VecStashValuesBlocked_Private - inserts 1 block of values into the stash.
266: Input Parameters:
267: stash - the stash
268: idx - the global block index
269: values - the values inserted
270: */
271: PETSC_STATIC_INLINE PetscErrorCode VecStashValuesBlocked_Private(VecStash *stash,PetscInt row,PetscScalar *values)
272: {
273: PetscInt jj,stash_bs=(stash)->bs;
274: PetscScalar *array;
276: if (((stash)->n+1) > (stash)->nmax) {
277: VecStashExpand_Private(stash,1);
278: }
279: array = (stash)->array + stash_bs*(stash)->n;
280: (stash)->idx[(stash)->n] = row;
281: for (jj=0; jj<stash_bs; jj++) { array[jj] = values[jj];}
282: (stash)->n++;
283: return 0;
284: }
286: PETSC_INTERN PetscErrorCode VecStrideGather_Default(Vec,PetscInt,Vec,InsertMode);
287: PETSC_INTERN PetscErrorCode VecStrideScatter_Default(Vec,PetscInt,Vec,InsertMode);
288: PETSC_INTERN PetscErrorCode VecReciprocal_Default(Vec);
289: PETSC_INTERN PetscErrorCode VecStrideSubSetGather_Default(Vec,PetscInt,const PetscInt[],const PetscInt[],Vec,InsertMode);
290: PETSC_INTERN PetscErrorCode VecStrideSubSetScatter_Default(Vec,PetscInt,const PetscInt[],const PetscInt[],Vec,InsertMode);
292: #if defined(PETSC_HAVE_MATLAB_ENGINE)
293: PETSC_EXTERN PetscErrorCode VecMatlabEnginePut_Default(PetscObject,void*);
294: PETSC_EXTERN PetscErrorCode VecMatlabEngineGet_Default(PetscObject,void*);
295: #endif
297: PETSC_EXTERN PetscErrorCode PetscSectionGetField_Internal(PetscSection, PetscSection, Vec, PetscInt, PetscInt, PetscInt, IS *, Vec *);
298: PETSC_EXTERN PetscErrorCode PetscSectionRestoreField_Internal(PetscSection, PetscSection, Vec, PetscInt, PetscInt, PetscInt, IS *, Vec *);
300: #define VecCheckSameLocalSize(x,ar1,y,ar2) do { \
301: if ((x)->map->n != (y)->map->n) SETERRQ4(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Incompatible vector local lengths parameter # %d local size %D != parameter # %d local size %D", ar1,(x)->map->n, ar2,(y)->map->n); \
302: } while (0)
304: #define VecCheckSameSize(x,ar1,y,ar2) do { \
305: if ((x)->map->N != (y)->map->N) SETERRQ4(PetscObjectComm((PetscObject)x),PETSC_ERR_ARG_INCOMP,"Incompatible vector global lengths parameter # %d global size %D != parameter # %d global size %D", ar1,(x)->map->N, ar2,(y)->map->N); \
306: VecCheckSameLocalSize(x,ar1,y,ar2); \
307: } while (0)
309: #define VecCheckLocalSize(x,ar1,n) do { \
310: if ((x)->map->n != n) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Incorrect vector local size: parameter # %d local size %D != %D",ar1,(x)->map->n,n); \
311: } while (0)
313: #define VecCheckSize(x,ar1,n,N) do { \
314: if ((x)->map->N != N) SETERRQ(PetscObjectComm((PetscObject)x),PETSC_ERR_ARG_INCOMP,"Incorrect vector global size: parameter # %d global size %D != %D",ar1,(x)->map->N, N); \
315: VecCheckLocalSize(x,ar1,n); \
316: } while (0)
318: typedef struct _VecTaggerOps *VecTaggerOps;
319: struct _VecTaggerOps {
320: PetscErrorCode (*create) (VecTagger);
321: PetscErrorCode (*destroy) (VecTagger);
322: PetscErrorCode (*setfromoptions) (PetscOptionItems*,VecTagger);
323: PetscErrorCode (*setup) (VecTagger);
324: PetscErrorCode (*view) (VecTagger,PetscViewer);
325: PetscErrorCode (*computeboxes) (VecTagger,Vec,PetscInt *,VecTaggerBox **);
326: PetscErrorCode (*computeis) (VecTagger,Vec,IS *);
327: };
328: struct _p_VecTagger {
329: PETSCHEADER(struct _VecTaggerOps);
330: void *data;
331: PetscInt blocksize;
332: PetscBool invert;
333: PetscBool setupcalled;
334: };
336: PETSC_EXTERN PetscBool VecTaggerRegisterAllCalled;
337: PETSC_EXTERN PetscErrorCode VecTaggerRegisterAll(void);
338: PETSC_EXTERN PetscErrorCode VecTaggerComputeIS_FromBoxes(VecTagger,Vec,IS*);
339: PETSC_EXTERN PetscMPIInt Petsc_Reduction_keyval;
341: #endif