Actual source code: petscvec.h
1: /*
2: Defines the vector component of PETSc. Vectors generally represent
3: degrees of freedom for finite element/finite difference functions
4: on a grid. They have more mathematical structure than simple arrays.
5: */
6: #pragma once
8: #include <petscsys.h>
9: #include <petscsftypes.h>
10: #include <petscis.h>
11: #include <petscdevicetypes.h>
12: #include <petscviewer.h>
14: /* SUBMANSEC = Vec */
16: /*S
17: Vec - Abstract PETSc vector object. Used for holding solutions and right-hand sides for linear systems, nonlinear systems, and time integrators
19: Level: beginner
21: Note:
22: Internally the actual vector representation is generally a simple array but most PETSc code can work on other representations through this abstraction
24: .seealso: [](doc_vector), [](ch_vectors), `VecCreate()`, `VecType`, `VecSetType()`
25: S*/
26: typedef struct _p_Vec *Vec;
28: /*E
29: ScatterMode - Determines the direction of a scatter in `VecScatterBegin()` and `VecScatterEnd()`
31: Values:
32: + `SCATTER_FORWARD` - Scatters the values as dictated by the `VecScatterCreate()` call
33: . `SCATTER_REVERSE` - Moves the values in the opposite direction than the directions indicated in the `VecScatterCreate()` call
34: . `SCATTER_FORWARD_LOCAL` - Scatters the values as dictated by the `VecScatterCreate()` call except NO MPI communication is done
35: - `SCATTER_REVERSE_LOCAL` - Moves the values in the opposite direction than the directions indicated in the `VecScatterCreate()` call
36: except NO MPI communication is done
38: Level: beginner
40: .seealso: [](ch_vectors), `VecScatter`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_FORWARD`, `SCATTER_REVERSE`, `SCATTER_FORWARD_LOCAL`, `SCATTER_REVERSE_LOCAL`
41: E*/
42: typedef enum {
43: SCATTER_FORWARD = 0,
44: SCATTER_REVERSE = 1,
45: SCATTER_FORWARD_LOCAL = 2,
46: SCATTER_REVERSE_LOCAL = 3
47: } ScatterMode;
49: /*MC
50: SCATTER_FORWARD - Scatters the values as dictated by the `VecScatterCreate()` call during `VecScatterBegin()` and `VecScatterEnd()`
52: Level: beginner
54: .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_REVERSE`, `SCATTER_FORWARD_LOCAL`,
55: `SCATTER_REVERSE_LOCAL`
56: M*/
58: /*MC
59: SCATTER_REVERSE - Moves the values in the opposite direction than the directions indicated
60: in the `VecScatterCreate()` during `VecScatterBegin()` and `VecScatterEnd()`
62: Level: beginner
64: .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_FORWARD`, `SCATTER_FORWARD_LOCAL`,
65: `SCATTER_REVERSE_LOCAL`
66: M*/
68: /*MC
69: SCATTER_FORWARD_LOCAL - Scatters the values as dictated by the `VecScatterCreate()` during `VecScatterBegin()` and `VecScatterEnd()` call except NO parallel communication
70: is done. Any variables that have be moved between processes are ignored
72: Level: developer
74: .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_REVERSE`, `SCATTER_FORWARD`,
75: `SCATTER_REVERSE_LOCAL`
76: M*/
78: /*MC
79: SCATTER_REVERSE_LOCAL - Moves the values in the opposite direction than the directions indicated
80: in the `VecScatterCreate()` during `VecScatterBegin()` and `VecScatterEnd()` except NO parallel communication
81: is done. Any variables that have be moved between processes are ignored
83: Level: developer
85: .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_FORWARD`, `SCATTER_FORWARD_LOCAL`,
86: `SCATTER_REVERSE`
87: M*/
89: /*J
90: VecType - String with the name of a PETSc vector, `Vec`, type
92: Level: beginner
94: .seealso: [](doc_vector), [](ch_vectors), `VecSetType()`, `Vec`, `VecCreate()`, `VecDestroy()`
95: J*/
96: typedef const char *VecType;
97: #define VECSEQ "seq"
98: #define VECMPI "mpi"
99: #define VECSTANDARD "standard" /* seq on one process and mpi on multiple */
100: #define VECSHARED "shared"
101: #define VECSEQVIENNACL "seqviennacl"
102: #define VECMPIVIENNACL "mpiviennacl"
103: #define VECVIENNACL "viennacl" /* seqviennacl on one process and mpiviennacl on multiple */
104: #define VECSEQCUDA "seqcuda"
105: #define VECMPICUDA "mpicuda"
106: #define VECCUDA "cuda" /* seqcuda on one process and mpicuda on multiple */
107: #define VECSEQHIP "seqhip"
108: #define VECMPIHIP "mpihip"
109: #define VECHIP "hip" /* seqhip on one process and mpihip on multiple */
110: #define VECNEST "nest"
111: #define VECSEQKOKKOS "seqkokkos"
112: #define VECMPIKOKKOS "mpikokkos"
113: #define VECKOKKOS "kokkos" /* seqkokkos on one process and mpikokkos on multiple */
115: /* Dynamic creation and loading functions */
116: PETSC_EXTERN PetscErrorCode VecScatterSetType(VecScatter, VecScatterType);
117: PETSC_EXTERN PetscErrorCode VecScatterGetType(VecScatter, VecScatterType *);
118: PETSC_EXTERN PetscErrorCode VecScatterSetFromOptions(VecScatter);
119: PETSC_EXTERN PetscErrorCode VecScatterRegister(const char[], PetscErrorCode (*)(VecScatter));
120: PETSC_EXTERN PetscErrorCode VecScatterCreate(Vec, IS, Vec, IS, VecScatter *);
122: /* Logging support */
123: #define REAL_FILE_CLASSID 1211213
124: #define VEC_FILE_CLASSID 1211214
125: PETSC_EXTERN PetscClassId VEC_CLASSID;
126: PETSC_EXTERN PetscClassId PETSCSF_CLASSID;
128: PETSC_EXTERN PetscErrorCode VecInitializePackage(void);
129: PETSC_EXTERN PetscErrorCode VecFinalizePackage(void);
131: PETSC_EXTERN PetscErrorCode VecCreate(MPI_Comm, Vec *);
132: PETSC_EXTERN PetscErrorCode VecCreateFromOptions(MPI_Comm, const char *, PetscInt, PetscInt, PetscInt, Vec *);
133: PETSC_EXTERN PetscErrorCode VecCreateSeq(MPI_Comm, PetscInt, Vec *);
134: PETSC_EXTERN PetscErrorCode VecCreateMPI(MPI_Comm, PetscInt, PetscInt, Vec *);
135: PETSC_EXTERN PetscErrorCode VecCreateSeqWithArray(MPI_Comm, PetscInt, PetscInt, const PetscScalar[], Vec *);
136: PETSC_EXTERN PetscErrorCode VecCreateMPIWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar[], Vec *);
137: PETSC_EXTERN PetscErrorCode VecCreateSeqWithArrayAndMemType(MPI_Comm, PetscMemType, PetscInt, PetscInt, const PetscScalar[], Vec *);
138: PETSC_EXTERN PetscErrorCode VecCreateMPIWithArrayAndMemType(MPI_Comm, PetscMemType, PetscInt, PetscInt, PetscInt, const PetscScalar[], Vec *);
139: PETSC_EXTERN PetscErrorCode VecCreateShared(MPI_Comm, PetscInt, PetscInt, Vec *);
141: PETSC_EXTERN PetscErrorCode VecSetFromOptions(Vec);
142: PETSC_EXTERN PetscErrorCode VecViewFromOptions(Vec, PetscObject, const char[]);
144: PETSC_EXTERN PetscErrorCode VecSetUp(Vec);
145: PETSC_EXTERN PetscErrorCode VecDestroy(Vec *);
146: PETSC_EXTERN PetscErrorCode VecZeroEntries(Vec);
147: PETSC_EXTERN PetscErrorCode VecSetOptionsPrefix(Vec, const char[]);
148: PETSC_EXTERN PetscErrorCode VecAppendOptionsPrefix(Vec, const char[]);
149: PETSC_EXTERN PetscErrorCode VecGetOptionsPrefix(Vec, const char *[]);
150: PETSC_EXTERN PetscErrorCode VecGetState(Vec, PetscObjectState *);
152: PETSC_EXTERN PetscErrorCode VecSetSizes(Vec, PetscInt, PetscInt);
154: PETSC_EXTERN PetscErrorCode VecDotNorm2(Vec, Vec, PetscScalar *, PetscReal *);
155: PETSC_EXTERN PetscErrorCode VecDot(Vec, Vec, PetscScalar *);
156: PETSC_EXTERN PetscErrorCode VecDotRealPart(Vec, Vec, PetscReal *);
157: PETSC_EXTERN PetscErrorCode VecTDot(Vec, Vec, PetscScalar *);
158: PETSC_EXTERN PetscErrorCode VecMDot(Vec, PetscInt, const Vec[], PetscScalar[]);
159: PETSC_EXTERN PetscErrorCode VecMTDot(Vec, PetscInt, const Vec[], PetscScalar[]);
160: PETSC_EXTERN PetscErrorCode VecGetSubVector(Vec, IS, Vec *);
161: PETSC_EXTERN PetscErrorCode VecRestoreSubVector(Vec, IS, Vec *);
162: PETSC_EXTERN PetscErrorCode VecConcatenate(PetscInt, const Vec[], Vec *, IS *[]);
164: /*E
165: NormType - determines what type of norm to compute with `VecNorm()`, `VecNormBegin()`/`VecNormEnd()` and `MatNorm()`.
167: Values:
168: + `NORM_1` - the one norm, $||v|| = \sum_i | v_i |$. $||A|| = \max_j || A_{*j} ||$, maximum column sum
169: . `NORM_2` - the two norm, $||v|| = sqrt(\sum_i |v_i|^2)$ (vectors only)
170: . `NORM_FROBENIUS` - $||A|| = sqrt(\sum_{ij} |A_{ij}|^2)$, same as `NORM_2` for vectors
171: . `NORM_INFINITY` - $||v|| = \max_i |v_i|$. $||A|| = \max_i || A_{i*} ||_1$, maximum row sum
172: - `NORM_1_AND_2` - computes both the 1 and 2 norm of a vector. The values are stored in two adjacent `PetscReal` memory locations
174: Level: beginner
176: Note:
177: The `v` above represents a `Vec` while the `A` represents a `Mat`
179: .seealso: [](ch_vectors), `Vec`, `Mat`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `MatNorm()`, `NORM_1`,
180: `NORM_2`, `NORM_FROBENIUS`, `NORM_INFINITY`, `NORM_1_AND_2`, `ReductionType`
181: E*/
182: typedef enum {
183: NORM_1 = 0,
184: NORM_2 = 1,
185: NORM_FROBENIUS = 2,
186: NORM_INFINITY = 3,
187: NORM_1_AND_2 = 4
188: } NormType;
189: PETSC_EXTERN const char *const NormTypes[];
190: #define NORM_MAX NORM_INFINITY
192: /*MC
193: NORM_1 - the one norm, $||v|| = \sum_i | v_i |$. $||A|| = \max_j || A_{*,j} ||$, maximum column sum
195: Level: beginner
197: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_2`, `NORM_FROBENIUS`,
198: `NORM_INFINITY`, `NORM_1_AND_2`
199: M*/
201: /*MC
202: NORM_2 - the two norm, $||v|| = \sqrt{\sum_i |v_i|^2}$ (vectors only)
204: Level: beginner
206: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_FROBENIUS`,
207: `NORM_INFINITY`, `NORM_1_AND_2`
208: M*/
210: /*MC
211: NORM_FROBENIUS - $||A|| = \sqrt{\sum_{i,j} |A_{i,j}|^2}$, same as `NORM_2` for vectors
213: Level: beginner
215: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`,
216: `NORM_INFINITY`, `NORM_1_AND_2`
217: M*/
219: /*MC
220: NORM_INFINITY - $||v|| = \max_i |v_i|$. $||A|| = \max_i || A_{i,*} ||_1$, maximum row sum
222: Level: beginner
224: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`,
225: `NORM_FROBENIUS`, `NORM_1_AND_2`
226: M*/
228: /*MC
229: NORM_1_AND_2 - computes both the 1 and 2 norm of a vector. The values are stored in two adjacent `PetscReal` memory locations
231: Level: beginner
233: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`,
234: `NORM_FROBENIUS`, `NORM_INFINITY`
235: M*/
237: /*MC
238: NORM_MAX - see `NORM_INFINITY`
240: Level: beginner
241: M*/
243: /*E
244: ReductionType - determines what type of column reduction (one that is not a type of norm defined in `NormType`) to obtain with `MatGetColumnReductions()`
246: Values:
247: + `REDUCTION_SUM_REALPART` - sum of real part of each matrix column
248: . `REDUCTION_SUM_IMAGINARYPART` - sum of imaginary part of each matrix column
249: . `REDUCTION_MEAN_REALPART` - arithmetic mean of real part of each matrix column
250: - `REDUCTION_MEAN_IMAGINARYPART` - arithmetic mean of imaginary part of each matrix column
252: Level: beginner
254: Developer Note:
255: The constants defined in `ReductionType` MUST BE DISTINCT from those defined in `NormType`.
256: This is because `MatGetColumnReductions()` is used to compute both norms and other types of reductions,
257: and the constants defined in both `NormType` and `ReductionType` are used to designate the desired operation.
259: .seealso: [](ch_vectors), `MatGetColumnReductions()`, `MatGetColumnNorms()`, `NormType`, `REDUCTION_SUM_REALPART`,
260: `REDUCTION_SUM_IMAGINARYPART`, `REDUCTION_MEAN_REALPART`, `REDUCTION_MEAN_IMAGINARYPART`
261: E*/
262: typedef enum {
263: REDUCTION_SUM_REALPART = 10,
264: REDUCTION_MEAN_REALPART = 11,
265: REDUCTION_SUM_IMAGINARYPART = 12,
266: REDUCTION_MEAN_IMAGINARYPART = 13
267: } ReductionType;
269: /*E
270: VecSignMode - How `VecPointwiseSign()` should handle zero value
272: Values:
273: + `VEC_SIGN_ZERO_TO_ZERO` - `-0.0` and `0.0` map to `0.0`
274: . `VEC_SIGN_ZERO_TO_SIGNED_ZERO` - `-0.0` maps to `-0.0` and `0.0` maps to `0.0`
275: - `VEC_SIGN_ZERO_TO_SIGNED_UNIT` - `-0.0` maps to `-1.0` and `0.0` maps to `1.0`
277: Level: advanced
279: .seealso: [](ch_vectors), `VecPointwiseSign()`
280: E*/
281: typedef enum {
282: VEC_SIGN_ZERO_TO_ZERO,
283: VEC_SIGN_ZERO_TO_SIGNED_ZERO,
284: VEC_SIGN_ZERO_TO_SIGNED_UNIT,
285: } VecSignMode;
287: /*MC
288: REDUCTION_SUM_REALPART - sum of real part of a matrix column to obtain with `MatGetColumnReductions()`
290: Level: beginner
292: .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_SUM_IMAGINARYPART`, `REDUCTION_MEAN_REALPART`
293: M*/
295: /*MC
296: REDUCTION_SUM_IMAGINARYPART - sum of imaginary part of matrix column to obtain with `MatGetColumnReductions()`
298: Level: beginner
300: .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_SUM_REALPART`, `REDUCTION_MEAN_IMAGINARYPART`
301: M*/
303: /*MC
304: REDUCTION_MEAN_REALPART - arithmetic mean of real part of matrix column to obtain with `MatGetColumnReductions()`
306: Level: beginner
308: .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_MEAN_IMAGINARYPART`, `REDUCTION_SUM_REALPART`
309: M*/
311: /*MC
312: REDUCTION_MEAN_IMAGINARYPART - arithmetic mean of imaginary part of matrix column to obtain with `MatGetColumnReductions()`
314: Level: beginner
316: .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_MEAN_REALPART`, `REDUCTION_SUM_IMAGINARYPART`
317: M*/
319: PETSC_EXTERN PetscErrorCode VecNorm(Vec, NormType, PetscReal *);
320: PETSC_EXTERN PetscErrorCode VecNormAvailable(Vec, NormType, PetscBool *, PetscReal *);
321: PETSC_EXTERN PetscErrorCode VecFlag(Vec, PetscInt);
322: PETSC_EXTERN PetscErrorCode VecNormalize(Vec, PetscReal *);
323: PETSC_EXTERN PetscErrorCode VecSum(Vec, PetscScalar *);
324: PETSC_EXTERN PetscErrorCode VecMean(Vec, PetscScalar *);
325: PETSC_EXTERN PetscErrorCode VecMax(Vec, PetscInt *, PetscReal *);
326: PETSC_EXTERN PetscErrorCode VecMin(Vec, PetscInt *, PetscReal *);
327: PETSC_EXTERN PetscErrorCode VecScale(Vec, PetscScalar);
328: PETSC_EXTERN PetscErrorCode VecCopy(Vec, Vec);
329: PETSC_EXTERN PetscErrorCode VecSetRandom(Vec, PetscRandom);
330: PETSC_EXTERN PetscErrorCode VecSetRandomGaussian(Vec, PetscRandom, PetscReal, PetscReal);
331: PETSC_EXTERN PetscErrorCode VecSet(Vec, PetscScalar);
332: PETSC_EXTERN PetscErrorCode VecSetStdBasis(Vec, PetscInt);
333: PETSC_DEPRECATED_FUNCTION(3, 22, 0, "VecFlag()", ) static inline PetscErrorCode VecSetInf(Vec xin)
334: {
335: return VecFlag(xin, 1);
336: }
337: PETSC_EXTERN PetscErrorCode VecSwap(Vec, Vec);
338: PETSC_EXTERN PetscErrorCode VecAXPY(Vec, PetscScalar, Vec);
339: PETSC_EXTERN PetscErrorCode VecAXPBY(Vec, PetscScalar, PetscScalar, Vec);
340: PETSC_EXTERN PetscErrorCode VecMAXPY(Vec, PetscInt, const PetscScalar[], Vec[]);
341: PETSC_EXTERN PetscErrorCode VecMAXPBY(Vec, PetscInt, const PetscScalar[], PetscScalar, Vec[]);
342: PETSC_EXTERN PetscErrorCode VecAYPX(Vec, PetscScalar, Vec);
343: PETSC_EXTERN PetscErrorCode VecWAXPY(Vec, PetscScalar, Vec, Vec);
344: PETSC_EXTERN PetscErrorCode VecAXPBYPCZ(Vec, PetscScalar, PetscScalar, PetscScalar, Vec, Vec);
345: PETSC_EXTERN PetscErrorCode VecPointwiseMax(Vec, Vec, Vec);
346: PETSC_EXTERN PetscErrorCode VecPointwiseMaxAbs(Vec, Vec, Vec);
347: PETSC_EXTERN PetscErrorCode VecPointwiseMin(Vec, Vec, Vec);
348: PETSC_EXTERN PetscErrorCode VecPointwiseMult(Vec, Vec, Vec);
349: PETSC_EXTERN PetscErrorCode VecPointwiseDivide(Vec, Vec, Vec);
350: PETSC_EXTERN PetscErrorCode VecPointwiseSign(Vec, Vec, VecSignMode);
351: PETSC_EXTERN PetscErrorCode VecMaxPointwiseDivide(Vec, Vec, PetscReal *);
352: PETSC_EXTERN PetscErrorCode VecShift(Vec, PetscScalar);
353: PETSC_EXTERN PetscErrorCode VecReciprocal(Vec);
354: PETSC_EXTERN PetscErrorCode VecPermute(Vec, IS, PetscBool);
355: PETSC_EXTERN PetscErrorCode VecSqrtAbs(Vec);
356: PETSC_EXTERN PetscErrorCode VecLog(Vec);
357: PETSC_EXTERN PetscErrorCode VecExp(Vec);
358: PETSC_EXTERN PetscErrorCode VecAbs(Vec);
359: PETSC_EXTERN PetscErrorCode VecDuplicate(Vec, Vec *);
360: PETSC_EXTERN PetscErrorCode VecDuplicateVecs(Vec, PetscInt, Vec *[]);
361: PETSC_EXTERN PetscErrorCode VecDestroyVecs(PetscInt, Vec *[]);
362: PETSC_EXTERN PetscErrorCode VecStrideNormAll(Vec, NormType, PetscReal[]);
363: PETSC_EXTERN PetscErrorCode VecStrideMaxAll(Vec, PetscInt[], PetscReal[]);
364: PETSC_EXTERN PetscErrorCode VecStrideMinAll(Vec, PetscInt[], PetscReal[]);
365: PETSC_EXTERN PetscErrorCode VecStrideScaleAll(Vec, const PetscScalar[]);
366: PETSC_EXTERN PetscErrorCode VecStrideSumAll(Vec, PetscScalar *);
367: PETSC_EXTERN PetscErrorCode VecUniqueEntries(Vec, PetscInt *, PetscScalar *[]);
369: PETSC_EXTERN PetscErrorCode VecStrideNorm(Vec, PetscInt, NormType, PetscReal *);
370: PETSC_EXTERN PetscErrorCode VecStrideMax(Vec, PetscInt, PetscInt *, PetscReal *);
371: PETSC_EXTERN PetscErrorCode VecStrideMin(Vec, PetscInt, PetscInt *, PetscReal *);
372: PETSC_EXTERN PetscErrorCode VecStrideScale(Vec, PetscInt, PetscScalar);
373: PETSC_EXTERN PetscErrorCode VecStrideSum(Vec, PetscInt, PetscScalar *);
374: PETSC_EXTERN PetscErrorCode VecStrideSet(Vec, PetscInt, PetscScalar);
376: PETSC_EXTERN PetscErrorCode VecStrideGather(Vec, PetscInt, Vec, InsertMode);
377: PETSC_EXTERN PetscErrorCode VecStrideScatter(Vec, PetscInt, Vec, InsertMode);
378: PETSC_EXTERN PetscErrorCode VecStrideGatherAll(Vec, Vec[], InsertMode);
379: PETSC_EXTERN PetscErrorCode VecStrideScatterAll(Vec[], Vec, InsertMode);
381: PETSC_EXTERN PetscErrorCode VecStrideSubSetScatter(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);
382: PETSC_EXTERN PetscErrorCode VecStrideSubSetGather(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);
384: PETSC_EXTERN PetscErrorCode VecSetValues(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
385: PETSC_EXTERN PetscErrorCode VecGetValues(Vec, PetscInt, const PetscInt[], PetscScalar[]);
386: PETSC_EXTERN PetscErrorCode VecAssemblyBegin(Vec);
387: PETSC_EXTERN PetscErrorCode VecAssemblyEnd(Vec);
388: PETSC_EXTERN PetscErrorCode VecStashSetInitialSize(Vec, PetscInt, PetscInt);
389: PETSC_EXTERN PetscErrorCode VecStashView(Vec, PetscViewer);
390: PETSC_EXTERN PetscErrorCode VecStashViewFromOptions(Vec, PetscObject, const char[]);
391: PETSC_EXTERN PetscErrorCode VecStashGetInfo(Vec, PetscInt *, PetscInt *, PetscInt *, PetscInt *);
393: PETSC_EXTERN PetscErrorCode VecSetPreallocationCOO(Vec, PetscCount, const PetscInt[]);
394: PETSC_EXTERN PetscErrorCode VecSetPreallocationCOOLocal(Vec, PetscCount, PetscInt[]);
395: PETSC_EXTERN PetscErrorCode VecSetValuesCOO(Vec, const PetscScalar[], InsertMode);
397: /*@
398: VecSetValue - Set a single entry into a PETSc vector, `Vec`.
400: Not Collective
402: Input Parameters:
403: + v - the vector
404: . row - the row location of the entry
405: . value - the value to insert
406: - mode - either `INSERT_VALUES` or `ADD_VALUES`
408: Level: beginner
410: Notes:
411: For efficiency one should use `VecSetValues()` and set several or
412: many values simultaneously if possible.
414: These values may be cached, so `VecAssemblyBegin()` and `VecAssemblyEnd()`
415: MUST be called after all calls to `VecSetValue()` have been completed.
417: `VecSetValue()` uses 0-based indices in Python, C, and Fortran
419: .seealso: [](ch_vectors), `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `VecSetValuesBlockedLocal()`, `VecSetValueLocal()`
420: @*/
421: static inline PetscErrorCode VecSetValue(Vec v, PetscInt i, PetscScalar va, InsertMode mode)
422: {
423: return VecSetValues(v, 1, &i, &va, mode);
424: }
426: PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec, PetscInt);
427: PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec, PetscInt *);
428: PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
430: /* Dynamic creation and loading functions */
431: PETSC_EXTERN PetscFunctionList VecList;
432: PETSC_EXTERN PetscErrorCode VecSetType(Vec, VecType);
433: PETSC_EXTERN PetscErrorCode VecGetType(Vec, VecType *);
434: PETSC_EXTERN PetscErrorCode VecRegister(const char[], PetscErrorCode (*)(Vec));
435: PETSC_EXTERN PetscErrorCode VecRegisterAll(void);
437: PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter, Vec, Vec, InsertMode, ScatterMode);
438: PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter, Vec, Vec, InsertMode, ScatterMode);
439: PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter *);
440: PETSC_EXTERN PetscErrorCode VecScatterSetUp(VecScatter);
441: PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter, VecScatter *);
442: PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter, PetscViewer);
443: PETSC_EXTERN PetscErrorCode VecScatterViewFromOptions(VecScatter, PetscObject, const char[]);
444: PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter, PetscInt[], PetscInt[]);
445: PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter, PetscBool *);
447: PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
448: PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
449: PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
450: PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
451: PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
452: PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
453: PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec, PetscInt, PetscInt, PetscScalar *[]);
454: PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec, PetscInt, PetscInt, PetscScalar *[]);
456: PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
457: PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
458: PETSC_EXTERN PetscErrorCode VecRestoreArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
459: PETSC_EXTERN PetscErrorCode VecGetArray3dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
460: PETSC_EXTERN PetscErrorCode VecRestoreArray3dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
461: PETSC_EXTERN PetscErrorCode VecGetArray2dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
462: PETSC_EXTERN PetscErrorCode VecRestoreArray2dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
463: PETSC_EXTERN PetscErrorCode VecGetArray1dWrite(Vec, PetscInt, PetscInt, PetscScalar *[]);
464: PETSC_EXTERN PetscErrorCode VecRestoreArray1dWrite(Vec, PetscInt, PetscInt, PetscScalar *[]);
466: PETSC_EXTERN PetscErrorCode VecGetArray4dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
467: PETSC_EXTERN PetscErrorCode VecRestoreArray4dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
468: PETSC_EXTERN PetscErrorCode VecGetArray3dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
469: PETSC_EXTERN PetscErrorCode VecRestoreArray3dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
470: PETSC_EXTERN PetscErrorCode VecGetArray2dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
471: PETSC_EXTERN PetscErrorCode VecRestoreArray2dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
472: PETSC_EXTERN PetscErrorCode VecGetArray1dRead(Vec, PetscInt, PetscInt, PetscScalar *[]);
473: PETSC_EXTERN PetscErrorCode VecRestoreArray1dRead(Vec, PetscInt, PetscInt, PetscScalar *[]);
475: PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec, const PetscScalar[]);
476: PETSC_EXTERN PetscErrorCode VecResetArray(Vec);
477: PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec, const PetscScalar[]);
479: PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[], PetscInt, PetscScalar **[]);
480: PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[], PetscInt, PetscScalar **[]);
482: PETSC_EXTERN PetscErrorCode VecView(Vec, PetscViewer);
483: PETSC_EXTERN PetscErrorCode VecViewNative(Vec, PetscViewer);
484: PETSC_EXTERN PetscErrorCode VecEqual(Vec, Vec, PetscBool *);
485: PETSC_EXTERN PetscErrorCode VecLoad(Vec, PetscViewer);
487: PETSC_EXTERN PetscErrorCode VecGetSize(Vec, PetscInt *);
488: PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec, PetscInt *);
489: PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec, PetscInt *, PetscInt *);
490: PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec, const PetscInt *[]);
492: PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping);
493: PETSC_EXTERN PetscErrorCode VecSetValuesLocal(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
495: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLContext(Vec, PETSC_UINTPTR_T *);
496: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLQueue(Vec, PETSC_UINTPTR_T *);
497: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemRead(Vec, PETSC_UINTPTR_T *);
498: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemWrite(Vec, PETSC_UINTPTR_T *);
499: PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMemWrite(Vec);
500: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMem(Vec, PETSC_UINTPTR_T *);
501: PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMem(Vec);
503: /*@
504: VecSetValueLocal - Set a single entry into a vector using the local numbering of the vector, see `VecSetValuesLocal()`
506: Not Collective
508: Input Parameters:
509: + v - the vector
510: . row - the local row location of the entry
511: . value - the value to insert
512: - mode - either `INSERT_VALUES` or `ADD_VALUES`
514: Level: beginner
516: Notes:
517: For efficiency one should use `VecSetValuesLocal()` and set several or
518: many values simultaneously if possible.
520: These values may be cached, so `VecAssemblyBegin()` and `VecAssemblyEnd()`
521: MUST be called after all calls to `VecSetValueLocal()` have been completed.
523: See `VecSetLocalToGlobalMapping()` for how the local numbering is defined
525: `VecSetValueLocal()` uses 0-based indices in Fortran as well as in C.
527: .seealso: [](ch_vectors), `VecSetValuesLocal()`, `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `VecSetValuesBlockedLocal()`, `VecSetValue()`,
528: `VecSetLocalToGlobalMapping()`
529: @*/
530: static inline PetscErrorCode VecSetValueLocal(Vec v, PetscInt i, PetscScalar va, InsertMode mode)
531: {
532: return VecSetValuesLocal(v, 1, &i, &va, mode);
533: }
535: /*MC
536: VecCheckAssembled - checks if values have been changed in the vector, by `VecSetValues()` or related routines, but it has not been assembled
538: Synopsis:
539: #include <petscvec.h>
540: VecCheckAssembled(Vec v);
542: Not Collective
544: Input Parameter:
545: . v - the vector to check
547: Level: developer
549: Note:
550: After calls to `VecSetValues()` and related routines one must call `VecAssemblyBegin()` and `VecAssemblyEnd()` before using the vector
552: .seealso: [](ch_vectors), `Vec`, `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `MatAssemblyBegin()`, `MatAssemblyEnd()`
553: M*/
554: #define VecCheckAssembled(v) PetscCheck((v)->stash.insertmode == NOT_SET_VALUES, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Not for unassembled vector, did you call VecAssemblyBegin()/VecAssemblyEnd()?")
556: PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
557: PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping *);
559: PETSC_EXTERN PetscErrorCode VecDotBegin(Vec, Vec, PetscScalar *);
560: PETSC_EXTERN PetscErrorCode VecDotEnd(Vec, Vec, PetscScalar *);
561: PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec, Vec, PetscScalar *);
562: PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec, Vec, PetscScalar *);
563: PETSC_EXTERN PetscErrorCode VecNormBegin(Vec, NormType, PetscReal *);
564: PETSC_EXTERN PetscErrorCode VecNormEnd(Vec, NormType, PetscReal *);
565: PETSC_EXTERN PetscErrorCode VecErrorWeightedNorms(Vec, Vec, Vec, NormType, PetscReal, Vec, PetscReal, Vec, PetscReal, PetscReal *, PetscInt *, PetscReal *, PetscInt *, PetscReal *, PetscInt *);
567: PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec, PetscInt, const Vec[], PetscScalar[]);
568: PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec, PetscInt, const Vec[], PetscScalar[]);
569: PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec, PetscInt, const Vec[], PetscScalar[]);
570: PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec, PetscInt, const Vec[], PetscScalar[]);
571: PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm);
573: PETSC_EXTERN PetscErrorCode VecBindToCPU(Vec, PetscBool);
574: PETSC_DEPRECATED_FUNCTION(3, 13, 0, "VecBindToCPU()", ) static inline PetscErrorCode VecPinToCPU(Vec v, PetscBool flg)
575: {
576: return VecBindToCPU(v, flg);
577: }
578: PETSC_EXTERN PetscErrorCode VecBoundToCPU(Vec, PetscBool *);
579: PETSC_EXTERN PetscErrorCode VecSetBindingPropagates(Vec, PetscBool);
580: PETSC_EXTERN PetscErrorCode VecGetBindingPropagates(Vec, PetscBool *);
581: PETSC_EXTERN PetscErrorCode VecSetPinnedMemoryMin(Vec, size_t);
582: PETSC_EXTERN PetscErrorCode VecGetPinnedMemoryMin(Vec, size_t *);
584: PETSC_EXTERN PetscErrorCode VecGetOffloadMask(Vec, PetscOffloadMask *);
586: /*E
587: VecOption - Options that may be set for a vector regarding entries passed to `VecSetValues()` and related routines
589: Values:
590: + `VEC_IGNORE_OFF_PROC_ENTRIES` - causes `VecSetValues()` to ignore entries destined to be stored on a separate processor.
591: This can be used to eliminate the global reduction in `VecAssemblyBegin()` if you know that
592: you have only used `VecSetValues()` to set local elements
593: . `VEC_IGNORE_NEGATIVE_INDICES` - means you can pass negative indices in `ix` in calls to `VecSetValues()` or `VecGetValues()`.
594: These rows are simply ignored.
595: - `VEC_SUBSET_OFF_PROC_ENTRIES` - causes `VecAssemblyBegin()` to assume that the off-process entries will always be a subset
596: (possibly equal) of the off-process entries set on the first assembly which had a true
597: `VEC_SUBSET_OFF_PROC_ENTRIES` and the vector has not changed this flag afterwards. If this
598: assembly is not such first assembly, then this assembly can reuse the communication pattern
599: setup in that first assembly, thus avoiding a global reduction. Subsequent assemblies setting
600: off-process values should use the same `InsertMode` as the first assembly.
602: Level: beginner
604: .seealso: [](ch_matrices), `Vec`, `MatSetOption()`, `VecSetOption()`, `VecSetValues()`, `VecAssemblyBegin()`
605: E*/
606: typedef enum {
607: VEC_IGNORE_OFF_PROC_ENTRIES,
608: VEC_IGNORE_NEGATIVE_INDICES,
609: VEC_SUBSET_OFF_PROC_ENTRIES
610: } VecOption;
612: PETSC_EXTERN PetscErrorCode VecSetOption(Vec, VecOption, PetscBool);
614: PETSC_EXTERN PetscErrorCode VecGetArray(Vec, PetscScalar *[]);
615: PETSC_EXTERN PetscErrorCode VecGetArrayWrite(Vec, PetscScalar *[]);
616: PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec, const PetscScalar *[]);
617: PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec, PetscScalar *[]);
618: PETSC_EXTERN PetscErrorCode VecRestoreArrayWrite(Vec, PetscScalar *[]);
619: PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec, const PetscScalar *[]);
620: PETSC_EXTERN PetscErrorCode VecCreateLocalVector(Vec, Vec *);
621: PETSC_EXTERN PetscErrorCode VecGetLocalVector(Vec, Vec);
622: PETSC_EXTERN PetscErrorCode VecRestoreLocalVector(Vec, Vec);
623: PETSC_EXTERN PetscErrorCode VecGetLocalVectorRead(Vec, Vec);
624: PETSC_EXTERN PetscErrorCode VecRestoreLocalVectorRead(Vec, Vec);
625: PETSC_EXTERN PetscErrorCode VecGetArrayAndMemType(Vec, PetscScalar *[], PetscMemType *);
626: PETSC_EXTERN PetscErrorCode VecRestoreArrayAndMemType(Vec, PetscScalar *[]);
627: PETSC_EXTERN PetscErrorCode VecGetArrayReadAndMemType(Vec, const PetscScalar *[], PetscMemType *);
628: PETSC_EXTERN PetscErrorCode VecRestoreArrayReadAndMemType(Vec, const PetscScalar *[]);
629: PETSC_EXTERN PetscErrorCode VecGetArrayWriteAndMemType(Vec, PetscScalar *[], PetscMemType *);
630: PETSC_EXTERN PetscErrorCode VecRestoreArrayWriteAndMemType(Vec, PetscScalar *[]);
632: /*@
633: VecGetArrayPair - Accesses a pair of pointers for two vectors that may be common. When the vectors are not the same the first pointer is read only
635: Logically Collective; No Fortran Support
637: Input Parameters:
638: + x - the vector
639: - y - the second vector
641: Output Parameters:
642: + xv - location to put pointer to the first array
643: - yv - location to put pointer to the second array
645: Level: developer
647: .seealso: [](ch_vectors), `VecGetArray()`, `VecGetArrayRead()`, `VecRestoreArrayPair()`
648: @*/
649: static inline PetscErrorCode VecGetArrayPair(Vec x, Vec y, PetscScalar *xv[], PetscScalar *yv[])
650: {
651: PetscFunctionBegin;
652: PetscCall(VecGetArray(y, yv));
653: if (x == y) *xv = *yv;
654: else PetscCall(VecGetArrayRead(x, (const PetscScalar **)xv));
655: PetscFunctionReturn(PETSC_SUCCESS);
656: }
658: /*@
659: VecRestoreArrayPair - Returns a pair of pointers for two vectors that may be common obtained with `VecGetArrayPair()`
661: Logically Collective; No Fortran Support
663: Input Parameters:
664: + x - the vector
665: . y - the second vector
666: . xv - location to put pointer to the first array
667: - yv - location to put pointer to the second array
669: Level: developer
671: .seealso: [](ch_vectors), `VecGetArray()`, `VecGetArrayRead()`, `VecGetArrayPair()`
672: @*/
673: static inline PetscErrorCode VecRestoreArrayPair(Vec x, Vec y, PetscScalar *xv[], PetscScalar *yv[])
674: {
675: PetscFunctionBegin;
676: PetscCall(VecRestoreArray(y, yv));
677: if (x != y) PetscCall(VecRestoreArrayRead(x, (const PetscScalar **)xv));
678: PetscFunctionReturn(PETSC_SUCCESS);
679: }
681: PETSC_EXTERN PetscErrorCode VecLockReadPush(Vec);
682: PETSC_EXTERN PetscErrorCode VecLockReadPop(Vec);
683: PETSC_EXTERN PetscErrorCode VecLockWriteSet(Vec, PetscBool);
684: PETSC_EXTERN PetscErrorCode VecLockGet(Vec, PetscInt *);
685: PETSC_EXTERN PetscErrorCode VecLockGetLocation(Vec, const char *[], const char *[], int *);
687: /*@
688: VecSetErrorIfLocked - Raise an error if the `Vec` is currently locked for read or write access.
690: Not Collective; No Fortran Support
692: Input Parameters:
693: + x - the `Vec` to test
694: - arg - the argument position of `x` in the calling routine, used in the error message
696: Level: developer
698: Note:
699: This is intended as an internal check for routines that must have exclusive access to a `Vec`.
700: A locked `Vec` typically indicates that another routine currently holds a read or write reference to it.
702: .seealso: `Vec`, `VecLockGet()`, `VecLockGetLocation()`, `VecLockReadPush()`, `VecLockReadPop()`, `VecLockWriteSet()`
703: @*/
704: static inline PetscErrorCode VecSetErrorIfLocked(Vec x, PetscInt arg)
705: {
706: PetscInt state;
708: PetscFunctionBegin;
709: PetscCall(VecLockGet(x, &state));
710: if (PetscUnlikely(state != 0)) {
711: const char *file, *func, *name;
712: int line;
714: PetscCall(VecLockGetLocation(x, &file, &func, &line));
715: PetscCall(PetscObjectGetName((PetscObject)x, &name));
716: SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Vector '%s' (argument #%" PetscInt_FMT ") was locked for %s access in %s() at %s:%d (line numbers only accurate to function begin)", name, arg, state > 0 ? "read-only" : "write-only", func ? func : "unknown_function", file ? file : "unknown file", line);
717: }
718: PetscFunctionReturn(PETSC_SUCCESS);
719: }
721: /* The three are deprecated */
722: PETSC_DEPRECATED_FUNCTION(3, 11, 0, "VecLockReadPush()", ) static inline PetscErrorCode VecLockPush(Vec v)
723: {
724: return VecLockReadPush(v);
725: }
727: PETSC_DEPRECATED_FUNCTION(3, 11, 0, "VecLockReadPop()", ) static inline PetscErrorCode VecLockPop(Vec v)
728: {
729: return VecLockReadPop(v);
730: }
732: /*MC
733: VecLocked - Deprecated alias for `VecSetErrorIfLocked()`; raises an error if the `Vec` is currently locked for read
735: Synopsis:
736: #include <petscvec.h>
737: PetscErrorCode VecLocked(Vec x, int arg)
739: Not Collective; No Fortran Support
741: Input Parameters:
742: + x - the `Vec` to test
743: - arg - the argument position of `x` in the caller (used in the error message)
745: Level: deprecated
747: Note:
748: Use `VecSetErrorIfLocked()` in new code; this macro is retained only for backwards compatibility.
750: .seealso: `Vec`, `VecSetErrorIfLocked()`, `VecLockReadPush()`, `VecLockReadPop()`
751: M*/
752: #define VecLocked(x, arg) VecSetErrorIfLocked(x, arg) PETSC_DEPRECATED_MACRO(3, 11, 0, "VecSetErrorIfLocked()", )
754: /*E
755: VecOperation - Enumeration of overide-able methods in the `Vec` implementation function-table.
757: Values:
758: + `VECOP_DUPLICATE` - `VecDuplicate()`
759: . `VECOP_SET` - `VecSet()`
760: . `VECOP_VIEW` - `VecView()`
761: . `VECOP_LOAD` - `VecLoad()`
762: . `VECOP_VIEWNATIVE` - `VecViewNative()`
763: - `VECOP_LOADNATIVE` - `VecLoadNative()`
765: Level: advanced
767: Notes:
768: Some operations may serve as the implementation for other routines not listed above. For
769: example `VECOP_SET` can be used to simultaneously overriding the implementation used in
770: `VecSet()`, `VecFlag()`, and `VecZeroEntries()`.
772: Entries to `VecOperation` are added as needed so if you do not see the operation listed which
773: you'd like to replace, please send mail to `petsc-maint@mcs.anl.gov`!
775: .seealso: [](ch_vectors), `Vec`, `VecSetOperation()`
776: E*/
777: typedef enum {
778: VECOP_DUPLICATE = 0,
779: VECOP_SET = 10,
780: VECOP_VIEW = 33,
781: VECOP_LOAD = 41,
782: VECOP_VIEWNATIVE = 68,
783: VECOP_LOADNATIVE = 69
784: } VecOperation;
785: PETSC_EXTERN PetscErrorCode VecSetOperation(Vec, VecOperation, PetscErrorCodeFn *);
787: /*
788: Routines for dealing with ghosted vectors:
789: vectors with ghost elements at the end of the array.
790: */
791: PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec, PetscInt, const PetscInt[]);
792: PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Vec *);
793: PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscScalar[], Vec *);
794: PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Vec *);
795: PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscScalar[], Vec *);
796: PETSC_EXTERN PetscErrorCode VecGhostGetGhostIS(Vec, IS *);
797: PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec, Vec *);
798: PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec, Vec *);
799: PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec, Vec, PetscBool *);
800: PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec, InsertMode, ScatterMode);
801: PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec, InsertMode, ScatterMode);
803: PETSC_EXTERN PetscErrorCode VecConjugate(Vec);
804: PETSC_EXTERN PetscErrorCode VecImaginaryPart(Vec);
805: PETSC_EXTERN PetscErrorCode VecRealPart(Vec);
807: PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec, VecScatter *, Vec *);
808: PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec, VecScatter *, Vec *);
810: /* These vector calls were included from TAO. They miss vtable entries and GPU implementation */
811: PETSC_EXTERN PetscErrorCode ISComplementVec(IS, Vec, IS *);
812: PETSC_EXTERN PetscErrorCode VecPow(Vec, PetscScalar);
813: PETSC_EXTERN PetscErrorCode VecMedian(Vec, Vec, Vec, Vec);
814: PETSC_EXTERN PetscErrorCode VecWhichInactive(Vec, Vec, Vec, Vec, PetscBool, IS *);
815: PETSC_EXTERN PetscErrorCode VecWhichBetween(Vec, Vec, Vec, IS *);
816: PETSC_EXTERN PetscErrorCode VecWhichBetweenOrEqual(Vec, Vec, Vec, IS *);
817: PETSC_EXTERN PetscErrorCode VecWhichGreaterThan(Vec, Vec, IS *);
818: PETSC_EXTERN PetscErrorCode VecWhichLessThan(Vec, Vec, IS *);
819: PETSC_EXTERN PetscErrorCode VecWhichEqual(Vec, Vec, IS *);
820: PETSC_EXTERN PetscErrorCode VecISAXPY(Vec, IS, PetscScalar, Vec);
821: PETSC_EXTERN PetscErrorCode VecISCopy(Vec, IS, ScatterMode, Vec);
822: PETSC_EXTERN PetscErrorCode VecISSet(Vec, IS, PetscScalar);
823: PETSC_EXTERN PetscErrorCode VecISShift(Vec, IS, PetscScalar);
824: PETSC_EXTERN PetscErrorCode VecBoundGradientProjection(Vec, Vec, Vec, Vec, Vec);
825: PETSC_EXTERN PetscErrorCode VecStepBoundInfo(Vec, Vec, Vec, Vec, PetscReal *, PetscReal *, PetscReal *);
826: PETSC_EXTERN PetscErrorCode VecStepMax(Vec, Vec, PetscReal *);
827: PETSC_EXTERN PetscErrorCode VecStepMaxBounded(Vec, Vec, Vec, Vec, PetscReal *);
829: struct _n_Vecs {
830: PetscInt n;
831: Vec v;
832: };
833: /*S
834: Vecs - Collection of `Vec`s where the storage for the vectors is held in a single contiguous block of memory
836: Level: advanced
838: Notes:
839: Temporary construct for handling multiple right-hand side solves.
841: This is faked by storing a single `Vec` whose array is sized to hold `n` vectors back to back.
843: .seealso: `Vec`, `VecsCreateSeq()`, `VecsCreateSeqWithArray()`, `VecsDuplicate()`, `VecsDestroy()`
844: S*/
845: typedef struct _n_Vecs *Vecs;
846: PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs);
847: PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm, PetscInt, PetscInt, Vecs *);
848: PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm, PetscInt, PetscInt, PetscScalar *, Vecs *);
849: PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs, Vecs *);
851: #if PetscDefined(HAVE_VIENNACL)
852: /*S
853: PetscViennaCLIndices - Opaque handle to an index buffer used by PETSc's ViennaCL `VECVIENNACL` vector backend to perform partial scatters between CPU and GPU memory
855: Level: developer
857: .seealso: `Vec`, `VECVIENNACL`, `VecCreateSeqViennaCL()`
858: S*/
859: typedef struct _n_PetscViennaCLIndices *PetscViennaCLIndices;
860: PETSC_EXTERN PetscErrorCode VecCreateSeqViennaCL(MPI_Comm, PetscInt, Vec *);
861: #endif
862: #if PetscDefined(HAVE_KOKKOS_KERNELS)
863: PETSC_EXTERN PetscErrorCode VecCreateSeqKokkos(MPI_Comm, PetscInt, Vec *);
864: PETSC_EXTERN PetscErrorCode VecCreateSeqKokkosWithArray(MPI_Comm, PetscInt, PetscInt, const PetscScalar *, Vec *);
865: PETSC_EXTERN PetscErrorCode VecCreateMPIKokkosWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar *, Vec *);
866: PETSC_EXTERN PetscErrorCode VecKokkosPlaceArray(Vec, PetscScalar *);
867: PETSC_EXTERN PetscErrorCode VecKokkosResetArray(Vec);
868: #endif
870: PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec, PetscInt *, Vec *[]);
871: PETSC_EXTERN PetscErrorCode VecNestGetSubVecsRead(Vec, PetscInt *, Vec *[]);
872: PETSC_EXTERN PetscErrorCode VecNestRestoreSubVecsRead(Vec, PetscInt *, Vec *[]);
873: PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec, PetscInt, Vec *);
874: PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec, PetscInt, PetscInt *, Vec *);
875: PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec, PetscInt, Vec);
876: PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm, PetscInt, IS *, Vec *, Vec *);
877: PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec, PetscInt *);
879: PETSC_EXTERN PetscErrorCode PetscOptionsGetVec(PetscOptions, const char[], const char[], Vec, PetscBool *);
880: PETSC_EXTERN PetscErrorCode VecFilter(Vec, PetscReal);
881: PETSC_DEPRECATED_FUNCTION(3, 20, 0, "VecFilter()", ) static inline PetscErrorCode VecChop(Vec v, PetscReal tol)
882: {
883: return VecFilter(v, tol);
884: }
886: PETSC_EXTERN PetscErrorCode VecGetLayout(Vec, PetscLayout *);
887: PETSC_EXTERN PetscErrorCode VecSetLayout(Vec, PetscLayout);
889: PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer);
890: PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar *[]);
891: PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, const PetscScalar[], InsertMode);
892: PETSC_EXTERN PetscErrorCode PetscSectionVecNorm(PetscSection, PetscSection, Vec, NormType, PetscReal[]);
894: /*S
895: VecTagger - Object used to manage the tagging of a subset of indices based on the values of a vector. The
896: motivating application is the selection of cells for refinement or coarsening based on vector containing
897: the values in an error indicator metric.
899: Values:
900: + `VECTAGGERABSOLUTE` - "absolute" values are in a interval (box for complex values) of explicitly defined values
901: . `VECTAGGERRELATIVE` - "relative" values are in a interval (box for complex values) of values relative to the set of all values in the vector
902: . `VECTAGGERCDF` - "cdf" values are in a relative range of the *cumulative distribution* of values in the vector
903: . `VECTAGGEROR` - "or" values are in the union of other tags
904: - `VECTAGGERAND` - "and" values are in the intersection of other tags
906: Level: advanced
908: Developer Note:
909: Why not use a `DMLabel` or similar object
911: .seealso: [](ch_vectors), `Vec`, `VecTaggerType`, `VecTaggerCreate()`
912: S*/
913: typedef struct _p_VecTagger *VecTagger;
915: /*J
916: VecTaggerType - String with the name of a `VecTagger` type
918: Level: advanced
920: .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerCreate()`
921: J*/
922: typedef const char *VecTaggerType;
923: #define VECTAGGERABSOLUTE "absolute"
924: #define VECTAGGERRELATIVE "relative"
925: #define VECTAGGERCDF "cdf"
926: #define VECTAGGEROR "or"
927: #define VECTAGGERAND "and"
929: PETSC_EXTERN PetscClassId VEC_TAGGER_CLASSID;
930: PETSC_EXTERN PetscFunctionList VecTaggerList;
931: PETSC_EXTERN PetscErrorCode VecTaggerRegister(const char[], PetscErrorCode (*)(VecTagger));
932: PETSC_EXTERN PetscErrorCode VecTaggerRegisterAll(void);
934: PETSC_EXTERN PetscErrorCode VecTaggerCreate(MPI_Comm, VecTagger *);
935: PETSC_EXTERN PetscErrorCode VecTaggerSetBlockSize(VecTagger, PetscInt);
936: PETSC_EXTERN PetscErrorCode VecTaggerGetBlockSize(VecTagger, PetscInt *);
937: PETSC_EXTERN PetscErrorCode VecTaggerSetType(VecTagger, VecTaggerType);
938: PETSC_EXTERN PetscErrorCode VecTaggerGetType(VecTagger, VecTaggerType *);
939: PETSC_EXTERN PetscErrorCode VecTaggerSetInvert(VecTagger, PetscBool);
940: PETSC_EXTERN PetscErrorCode VecTaggerGetInvert(VecTagger, PetscBool *);
941: PETSC_EXTERN PetscErrorCode VecTaggerSetFromOptions(VecTagger);
942: PETSC_EXTERN PetscErrorCode VecTaggerSetUp(VecTagger);
943: PETSC_EXTERN PetscErrorCode VecTaggerView(VecTagger, PetscViewer);
944: PETSC_EXTERN PetscErrorCode VecTaggerComputeIS(VecTagger, Vec, IS *, PetscBool *);
945: PETSC_EXTERN PetscErrorCode VecTaggerDestroy(VecTagger *);
947: /*S
948: VecTaggerBox - A interval (box for complex numbers) range used to tag values. For real scalars, this is just a closed interval; for complex scalars,
949: the box is the closed region in the complex plane such that real(min) <= real(z) <= real(max) and imag(min) <= imag(z) <= imag(max). `INF` is an acceptable endpoint.
951: Level: beginner
953: .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerType`, `VecTaggerCreate()`, `VecTaggerComputeIntervals()`
954: S*/
955: typedef struct {
956: PetscScalar min;
957: PetscScalar max;
958: } VecTaggerBox;
959: PETSC_EXTERN PetscErrorCode VecTaggerComputeBoxes(VecTagger, Vec, PetscInt *, VecTaggerBox *[], PetscBool *);
961: PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteSetBox(VecTagger, VecTaggerBox *);
962: PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteGetBox(VecTagger, const VecTaggerBox *[]);
964: PETSC_EXTERN PetscErrorCode VecTaggerRelativeSetBox(VecTagger, VecTaggerBox *);
965: PETSC_EXTERN PetscErrorCode VecTaggerRelativeGetBox(VecTagger, const VecTaggerBox *[]);
967: PETSC_EXTERN PetscErrorCode VecTaggerCDFSetBox(VecTagger, VecTaggerBox *);
968: PETSC_EXTERN PetscErrorCode VecTaggerCDFGetBox(VecTagger, const VecTaggerBox *[]);
970: /*E
971: VecTaggerCDFMethod - Determines what method is used to compute absolute values from cumulative distribution values (e.g., what value is the preimage of .95 in the cdf).
973: Values:
974: + `VECTAGGER_CDF_GATHER` - gather the data to MPI rank 0, perform the computation and broadcast the result
975: - `VECTAGGER_CDF_ITERATIVE` - compute the results on all ranks iteratively using `MPI_Allreduce()`
977: Level: advanced
979: Note:
980: Relevant only in parallel: in serial it is directly computed.
982: Developer Note:
983: In PETSc enums of this type are referred to with the term type, not method.
985: .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerType`, `VecTaggerCreate()`, `VecTaggerCDFSetMethod()`
986: E*/
987: typedef enum {
988: VECTAGGER_CDF_GATHER,
989: VECTAGGER_CDF_ITERATIVE,
990: VECTAGGER_CDF_NUM_METHODS
991: } VecTaggerCDFMethod;
992: PETSC_EXTERN const char *const VecTaggerCDFMethods[];
994: PETSC_EXTERN PetscErrorCode VecTaggerCDFSetMethod(VecTagger, VecTaggerCDFMethod);
995: PETSC_EXTERN PetscErrorCode VecTaggerCDFGetMethod(VecTagger, VecTaggerCDFMethod *);
996: PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeSetTolerances(VecTagger, PetscInt, PetscReal, PetscReal);
997: PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeGetTolerances(VecTagger, PetscInt *, PetscReal *, PetscReal *);
999: PETSC_EXTERN PetscErrorCode VecTaggerOrSetSubs(VecTagger, PetscInt, VecTagger *, PetscCopyMode);
1000: PETSC_EXTERN PetscErrorCode VecTaggerOrGetSubs(VecTagger, PetscInt *, VecTagger *[]);
1002: PETSC_EXTERN PetscErrorCode VecTaggerAndSetSubs(VecTagger, PetscInt, VecTagger *, PetscCopyMode);
1003: PETSC_EXTERN PetscErrorCode VecTaggerAndGetSubs(VecTagger, PetscInt *, VecTagger *[]);
1005: PETSC_EXTERN PetscErrorCode VecTaggerInitializePackage(void);
1006: PETSC_EXTERN PetscErrorCode VecTaggerFinalizePackage(void);
1008: PETSC_EXTERN PetscErrorCode VecFischer(Vec, Vec, Vec, Vec, Vec);
1009: PETSC_EXTERN PetscErrorCode VecSFischer(Vec, Vec, Vec, Vec, PetscReal, Vec);
1011: #if PetscDefined(USE_DEBUG)
1012: /* This is an internal debug-only routine that should not be used by users */
1013: PETSC_SINGLE_LIBRARY_INTERN PetscErrorCode VecValidValues_Internal(Vec, PetscInt, PetscBool);
1014: #else
1015: #define VecValidValues_Internal(...) PETSC_SUCCESS
1016: #endif /* PETSC_USE_DEBUG */
1018: #define VEC_CUPM_NOT_CONFIGURED(impl) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP_SYS, "Must configure PETSc with " PetscStringize(impl) " support to use %s", PETSC_FUNCTION_NAME)
1020: #if PetscDefined(HAVE_CUDA)
1021: #define VEC_CUDA_DECL_OR_STUB(__decl__, ...) PETSC_EXTERN __decl__;
1022: #else
1023: #define VEC_CUDA_DECL_OR_STUB(__decl__, ...) \
1024: static inline __decl__ \
1025: { \
1026: __VA_ARGS__; \
1027: VEC_CUPM_NOT_CONFIGURED(cuda); \
1028: }
1029: #endif /* PETSC_HAVE_CUDA */
1031: /* extra underscore here to make it line up with the cuda versions */
1032: #if PetscDefined(HAVE_HIP)
1033: #define VEC_HIP__DECL_OR_STUB(__decl__, ...) PETSC_EXTERN __decl__;
1034: #else
1035: #define VEC_HIP__DECL_OR_STUB(__decl__, ...) \
1036: static inline __decl__ \
1037: { \
1038: __VA_ARGS__; \
1039: VEC_CUPM_NOT_CONFIGURED(hip); \
1040: }
1041: #endif /* PETSC_HAVE_HIP */
1043: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateSeqCUDA(MPI_Comm a, PetscInt b, Vec *c), (void)a, (void)b, (void)c)
1044: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateSeqHIP(MPI_Comm a, PetscInt b, Vec *c), (void)a, (void)b, (void)c)
1046: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateSeqCUDAWithArray(MPI_Comm a, PetscInt b, PetscInt c, const PetscScalar *d, Vec *e), (void)a, (void)b, (void)c, (void)d, (void)e)
1047: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateSeqHIPWithArray(MPI_Comm a, PetscInt b, PetscInt c, const PetscScalar *d, Vec *e), (void)a, (void)b, (void)c, (void)d, (void)e)
1049: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateSeqCUDAWithArrays(MPI_Comm a, PetscInt b, PetscInt c, const PetscScalar *d, const PetscScalar *e, Vec *f), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f)
1050: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateSeqHIPWithArrays(MPI_Comm a, PetscInt b, PetscInt c, const PetscScalar *d, const PetscScalar *e, Vec *f), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f)
1052: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateMPICUDA(MPI_Comm a, PetscInt b, PetscInt c, Vec *d), (void)a, (void)b, (void)c, (void)d)
1053: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateMPIHIP(MPI_Comm a, PetscInt b, PetscInt c, Vec *d), (void)a, (void)b, (void)c, (void)d)
1055: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateMPICUDAWithArray(MPI_Comm a, PetscInt b, PetscInt c, PetscInt d, const PetscScalar *e, Vec *f), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f)
1056: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateMPIHIPWithArray(MPI_Comm a, PetscInt b, PetscInt c, PetscInt d, const PetscScalar *e, Vec *f), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f)
1058: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateMPICUDAWithArrays(MPI_Comm a, PetscInt b, PetscInt c, PetscInt d, const PetscScalar *e, const PetscScalar *f, Vec *g), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f, (void)g)
1059: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateMPIHIPWithArrays(MPI_Comm a, PetscInt b, PetscInt c, PetscInt d, const PetscScalar *e, const PetscScalar *f, Vec *g), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f, (void)g)
1061: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArray(Vec a, PetscScalar *b[]), (void)a, (void)b)
1062: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArray(Vec a, PetscScalar *b[]), (void)a, (void)b)
1064: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArray(Vec a, PetscScalar *b[]), (void)a, (void)b)
1065: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArray(Vec a, PetscScalar *b[]), (void)a, (void)b)
1067: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArrayRead(Vec a, const PetscScalar *b[]), (void)a, (void)b)
1068: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArrayRead(Vec a, const PetscScalar *b[]), (void)a, (void)b)
1070: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArrayRead(Vec a, const PetscScalar *b[]), (void)a, (void)b)
1071: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArrayRead(Vec a, const PetscScalar *b[]), (void)a, (void)b)
1073: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArrayWrite(Vec a, PetscScalar *b[]), (void)a, (void)b)
1074: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArrayWrite(Vec a, PetscScalar *b[]), (void)a, (void)b)
1076: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArrayWrite(Vec a, PetscScalar *b[]), (void)a, (void)b)
1077: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArrayWrite(Vec a, PetscScalar *b[]), (void)a, (void)b)
1079: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAPlaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b)
1080: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPPlaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b)
1082: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAReplaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b)
1083: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPReplaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b)
1085: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAResetArray(Vec a), (void)a)
1086: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPResetArray(Vec a), (void)a)
1088: #undef VEC_CUPM_NOT_CONFIGURED
1089: #undef VEC_CUDA_DECL_OR_STUB
1090: #undef VEC_HIP__DECL_OR_STUB