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 <petscviewertypes.h>
13: /* SUBMANSEC = Vec */
15: /*S
16: Vec - Abstract PETSc vector object. Used for holding solutions and right-hand sides for linear systems, nonlinear systems, and time integrators
18: Level: beginner
20: Note:
21: Internally the actual vector representation is generally a simple array but most PETSc code can work on other representations through this abstraction
23: .seealso: [](doc_vector), [](ch_vectors), `VecCreate()`, `VecType`, `VecSetType()`
24: S*/
25: typedef struct _p_Vec *Vec;
27: /*S
28: VecState - Snapshot of the state of a `Vec`
30: Level: developer
32: Note:
33: A `VecState` records the object id and state of a `Vec`.
35: .seealso: [](ch_vectors), `Vec`, `VecGetState()`, `VecStateCompare()`, `VecStateCompareUpdate()`, `VecStateInvalidate()`, `PetscObjectGetId()`, `PetscObjectStateGet()`
36: S*/
37: typedef struct {
38: PetscObjectId id;
39: PetscObjectState state;
40: } VecState;
42: /*E
43: ScatterMode - Determines the direction of a scatter in `VecScatterBegin()` and `VecScatterEnd()`
45: Values:
46: + `SCATTER_FORWARD` - Scatters the values as dictated by the `VecScatterCreate()` call
47: . `SCATTER_REVERSE` - Moves the values in the opposite direction than the directions indicated in the `VecScatterCreate()` call
48: . `SCATTER_FORWARD_LOCAL` - Scatters the values as dictated by the `VecScatterCreate()` call except NO MPI communication is done
49: - `SCATTER_REVERSE_LOCAL` - Moves the values in the opposite direction than the directions indicated in the `VecScatterCreate()` call
50: except NO MPI communication is done
52: Level: beginner
54: .seealso: [](ch_vectors), `VecScatter`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_FORWARD`, `SCATTER_REVERSE`, `SCATTER_FORWARD_LOCAL`, `SCATTER_REVERSE_LOCAL`
55: E*/
56: typedef enum {
57: SCATTER_FORWARD = 0,
58: SCATTER_REVERSE = 1,
59: SCATTER_FORWARD_LOCAL = 2,
60: SCATTER_REVERSE_LOCAL = 3
61: } ScatterMode;
63: /*MC
64: SCATTER_FORWARD - Scatters the values as dictated by the `VecScatterCreate()` call during `VecScatterBegin()` and `VecScatterEnd()`
66: Level: beginner
68: .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_REVERSE`, `SCATTER_FORWARD_LOCAL`,
69: `SCATTER_REVERSE_LOCAL`
70: M*/
72: /*MC
73: SCATTER_REVERSE - Moves the values in the opposite direction than the directions indicated
74: in the `VecScatterCreate()` during `VecScatterBegin()` and `VecScatterEnd()`
76: Level: beginner
78: .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_FORWARD`, `SCATTER_FORWARD_LOCAL`,
79: `SCATTER_REVERSE_LOCAL`
80: M*/
82: /*MC
83: SCATTER_FORWARD_LOCAL - Scatters the values as dictated by the `VecScatterCreate()` during `VecScatterBegin()` and `VecScatterEnd()` call except NO parallel communication
84: is done. Any variables that have be moved between processes are ignored
86: Level: developer
88: .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_REVERSE`, `SCATTER_FORWARD`,
89: `SCATTER_REVERSE_LOCAL`
90: M*/
92: /*MC
93: SCATTER_REVERSE_LOCAL - Moves the values in the opposite direction than the directions indicated
94: in the `VecScatterCreate()` during `VecScatterBegin()` and `VecScatterEnd()` except NO parallel communication
95: is done. Any variables that have be moved between processes are ignored
97: Level: developer
99: .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_FORWARD`, `SCATTER_FORWARD_LOCAL`,
100: `SCATTER_REVERSE`
101: M*/
103: /*J
104: VecType - String with the name of a PETSc vector, `Vec`, type
106: Level: beginner
108: .seealso: [](doc_vector), [](ch_vectors), `VecSetType()`, `Vec`, `VecCreate()`, `VecDestroy()`
109: J*/
110: typedef const char *VecType;
111: #define VECSEQ "seq"
112: #define VECMPI "mpi"
113: #define VECSTANDARD "standard" /* seq on one process and mpi on multiple */
114: #define VECSHARED "shared"
115: #define VECSEQVIENNACL "seqviennacl"
116: #define VECMPIVIENNACL "mpiviennacl"
117: #define VECVIENNACL "viennacl" /* seqviennacl on one process and mpiviennacl on multiple */
118: #define VECSEQCUDA "seqcuda"
119: #define VECMPICUDA "mpicuda"
120: #define VECCUDA "cuda" /* seqcuda on one process and mpicuda on multiple */
121: #define VECSEQHIP "seqhip"
122: #define VECMPIHIP "mpihip"
123: #define VECHIP "hip" /* seqhip on one process and mpihip on multiple */
124: #define VECNEST "nest"
125: #define VECSEQKOKKOS "seqkokkos"
126: #define VECMPIKOKKOS "mpikokkos"
127: #define VECKOKKOS "kokkos" /* seqkokkos on one process and mpikokkos on multiple */
129: /* Dynamic creation and loading functions */
130: PETSC_EXTERN PetscErrorCode VecScatterSetType(VecScatter, VecScatterType);
131: PETSC_EXTERN PetscErrorCode VecScatterGetType(VecScatter, VecScatterType *);
132: PETSC_EXTERN PetscErrorCode VecScatterSetFromOptions(VecScatter);
133: PETSC_EXTERN PetscErrorCode VecScatterRegister(const char[], PetscErrorCode (*)(VecScatter));
134: PETSC_EXTERN PetscErrorCode VecScatterCreate(Vec, IS, Vec, IS, VecScatter *);
136: /* Logging support */
137: #define REAL_FILE_CLASSID 1211213
138: #define VEC_FILE_CLASSID 1211214
139: PETSC_EXTERN PetscClassId VEC_CLASSID;
140: PETSC_EXTERN PetscClassId PETSCSF_CLASSID;
142: PETSC_EXTERN PetscErrorCode VecInitializePackage(void);
143: PETSC_EXTERN PetscErrorCode VecFinalizePackage(void);
145: PETSC_EXTERN PetscErrorCode VecCreate(MPI_Comm, Vec *);
146: PETSC_EXTERN PetscErrorCode VecCreateFromOptions(MPI_Comm, const char *, PetscInt, PetscInt, PetscInt, Vec *);
147: PETSC_EXTERN PetscErrorCode VecCreateSeq(MPI_Comm, PetscInt, Vec *);
148: PETSC_EXTERN PetscErrorCode VecCreateMPI(MPI_Comm, PetscInt, PetscInt, Vec *);
149: PETSC_EXTERN PetscErrorCode VecCreateSeqWithArray(MPI_Comm, PetscInt, PetscInt, const PetscScalar[], Vec *);
150: PETSC_EXTERN PetscErrorCode VecCreateMPIWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar[], Vec *);
151: PETSC_EXTERN PetscErrorCode VecCreateSeqWithArrayAndMemType(MPI_Comm, PetscMemType, PetscInt, PetscInt, const PetscScalar[], Vec *);
152: PETSC_EXTERN PetscErrorCode VecCreateMPIWithArrayAndMemType(MPI_Comm, PetscMemType, PetscInt, PetscInt, PetscInt, const PetscScalar[], Vec *);
153: PETSC_EXTERN PetscErrorCode VecCreateShared(MPI_Comm, PetscInt, PetscInt, Vec *);
155: PETSC_EXTERN PetscErrorCode VecSetFromOptions(Vec);
156: PETSC_EXTERN PetscErrorCode VecViewFromOptions(Vec, PetscObject, const char[]);
158: PETSC_EXTERN PetscErrorCode VecSetUp(Vec);
159: PETSC_EXTERN PetscErrorCode VecDestroy(Vec *);
160: PETSC_EXTERN PetscErrorCode VecZeroEntries(Vec);
161: PETSC_EXTERN PetscErrorCode VecSetOptionsPrefix(Vec, const char[]);
162: PETSC_EXTERN PetscErrorCode VecAppendOptionsPrefix(Vec, const char[]);
163: PETSC_EXTERN PetscErrorCode VecGetOptionsPrefix(Vec, const char *[]);
164: PETSC_EXTERN PetscErrorCode VecGetState(Vec, VecState *);
165: PETSC_EXTERN PetscErrorCode VecStateCompare(VecState, VecState, PetscBool *);
166: PETSC_EXTERN PetscErrorCode VecStateCompareUpdate(Vec, VecState *, PetscBool *);
167: /*MC
168: VecStateInvalidate - Invalidates a vector state snapshot
170: Synopsis:
171: #include <petscvec.h>
172: PetscErrorCode VecStateInvalidate(VecState state)
174: Not Collective
176: Input/Output Parameter:
177: . state - the vector state
179: Level: developer
181: .seealso: [](ch_vectors), `Vec`, `VecState`, `VecGetState()`, `VecStateCompare()`, `VecStateCompareUpdate()`
182: M*/
183: #define VecStateInvalidate(s) ((s).id = 0, (s).state = -1, PETSC_SUCCESS)
185: PETSC_EXTERN PetscErrorCode VecSetSizes(Vec, PetscInt, PetscInt);
187: PETSC_EXTERN PetscErrorCode VecDotNorm2(Vec, Vec, PetscScalar *, PetscReal *);
188: PETSC_EXTERN PetscErrorCode VecDot(Vec, Vec, PetscScalar *);
189: PETSC_EXTERN PetscErrorCode VecDotRealPart(Vec, Vec, PetscReal *);
190: PETSC_EXTERN PetscErrorCode VecTDot(Vec, Vec, PetscScalar *);
191: PETSC_EXTERN PetscErrorCode VecMDot(Vec, PetscInt, const Vec[], PetscScalar[]);
192: PETSC_EXTERN PetscErrorCode VecMTDot(Vec, PetscInt, const Vec[], PetscScalar[]);
193: PETSC_EXTERN PetscErrorCode VecGetSubVector(Vec, IS, Vec *);
194: PETSC_EXTERN PetscErrorCode VecRestoreSubVector(Vec, IS, Vec *);
195: PETSC_EXTERN PetscErrorCode VecConcatenate(PetscInt, const Vec[], Vec *, IS *[]);
197: /*E
198: NormType - determines what type of norm to compute with `VecNorm()`, `VecNormBegin()`/`VecNormEnd()` and `MatNorm()`.
200: Values:
201: + `NORM_1` - the one norm, $\|v\| = \sum_i | v_i |$. $\|A\| = \max_j \| A_{*,j} \|$, maximum column sum
202: . `NORM_2` - the two norm, $\|v\| = \sqrt{\sum_i |v_i|^2}$ (vectors only)
203: . `NORM_FROBENIUS` - $\|A\| = \sqrt{\sum_{i,j} |A_{i,j}|^2}$, same as `NORM_2` for vectors
204: . `NORM_INFINITY` - $\|v\| = \max_i |v_i|$. $\|A\| = \max_i \| A_{i,*} \|_1$, maximum row sum
205: - `NORM_1_AND_2` - computes both the 1 and 2 norm of a vector. The values are stored in two adjacent `PetscReal` memory locations
207: Level: beginner
209: Note:
210: The `v` above represents a `Vec` while the `A` represents a `Mat`
212: .seealso: [](ch_vectors), `Vec`, `Mat`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `MatNorm()`, `NORM_1`,
213: `NORM_2`, `NORM_FROBENIUS`, `NORM_INFINITY`, `NORM_1_AND_2`, `ReductionType`
214: E*/
215: typedef enum {
216: NORM_1 = 0,
217: NORM_2 = 1,
218: NORM_FROBENIUS = 2,
219: NORM_INFINITY = 3,
220: NORM_1_AND_2 = 4
221: } NormType;
222: PETSC_EXTERN const char *const NormTypes[];
223: #define NORM_MAX NORM_INFINITY
225: /*MC
226: NORM_1 - the one norm, $\|v\| = \sum_i | v_i |$. $\|A\| = \max_j \| A_{*,j} \|$, maximum column sum
228: Level: beginner
230: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_2`, `NORM_FROBENIUS`,
231: `NORM_INFINITY`, `NORM_1_AND_2`
232: M*/
234: /*MC
235: NORM_2 - the two norm, $\|v\| = \sqrt{\sum_i |v_i|^2}$ (vectors only)
237: Level: beginner
239: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_FROBENIUS`,
240: `NORM_INFINITY`, `NORM_1_AND_2`
241: M*/
243: /*MC
244: NORM_FROBENIUS - $\|A\| = \sqrt{\sum_{i,j} |A_{i,j}|^2}$, same as `NORM_2` for vectors
246: Level: beginner
248: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`,
249: `NORM_INFINITY`, `NORM_1_AND_2`
250: M*/
252: /*MC
253: NORM_INFINITY - $\|v\| = \max_i |v_i|$. $\|A\| = \max_i \| A_{i,*} \|_1$, maximum row sum
255: Level: beginner
257: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`,
258: `NORM_FROBENIUS`, `NORM_1_AND_2`
259: M*/
261: /*MC
262: NORM_1_AND_2 - computes both the 1 and 2 norm of a vector. The values are stored in two adjacent `PetscReal` memory locations
264: Level: beginner
266: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`,
267: `NORM_FROBENIUS`, `NORM_INFINITY`
268: M*/
270: /*MC
271: NORM_MAX - see `NORM_INFINITY`
273: Level: beginner
274: M*/
276: /*E
277: ReductionType - determines what type of column reduction (one that is not a type of norm defined in `NormType`) to obtain with `MatGetColumnReductions()`
279: Values:
280: + `REDUCTION_SUM_REALPART` - sum of real part of each matrix column
281: . `REDUCTION_SUM_IMAGINARYPART` - sum of imaginary part of each matrix column
282: . `REDUCTION_MEAN_REALPART` - arithmetic mean of real part of each matrix column
283: - `REDUCTION_MEAN_IMAGINARYPART` - arithmetic mean of imaginary part of each matrix column
285: Level: beginner
287: Developer Note:
288: The constants defined in `ReductionType` MUST BE DISTINCT from those defined in `NormType`.
289: This is because `MatGetColumnReductions()` is used to compute both norms and other types of reductions,
290: and the constants defined in both `NormType` and `ReductionType` are used to designate the desired operation.
292: .seealso: [](ch_vectors), `MatGetColumnReductions()`, `MatGetColumnNorms()`, `NormType`, `REDUCTION_SUM_REALPART`,
293: `REDUCTION_SUM_IMAGINARYPART`, `REDUCTION_MEAN_REALPART`, `REDUCTION_MEAN_IMAGINARYPART`
294: E*/
295: typedef enum {
296: REDUCTION_SUM_REALPART = 10,
297: REDUCTION_MEAN_REALPART = 11,
298: REDUCTION_SUM_IMAGINARYPART = 12,
299: REDUCTION_MEAN_IMAGINARYPART = 13
300: } ReductionType;
302: /*E
303: VecSignMode - How `VecPointwiseSign()` should handle zero value
305: Values:
306: + `VEC_SIGN_ZERO_TO_ZERO` - `-0.0` and `0.0` map to `0.0`
307: . `VEC_SIGN_ZERO_TO_SIGNED_ZERO` - `-0.0` maps to `-0.0` and `0.0` maps to `0.0`
308: - `VEC_SIGN_ZERO_TO_SIGNED_UNIT` - `-0.0` maps to `-1.0` and `0.0` maps to `1.0`
310: Level: advanced
312: .seealso: [](ch_vectors), `VecPointwiseSign()`
313: E*/
314: typedef enum {
315: VEC_SIGN_ZERO_TO_ZERO,
316: VEC_SIGN_ZERO_TO_SIGNED_ZERO,
317: VEC_SIGN_ZERO_TO_SIGNED_UNIT,
318: } VecSignMode;
320: /*MC
321: REDUCTION_SUM_REALPART - sum of real part of a matrix column to obtain with `MatGetColumnReductions()`
323: Level: beginner
325: .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_SUM_IMAGINARYPART`, `REDUCTION_MEAN_REALPART`
326: M*/
328: /*MC
329: REDUCTION_SUM_IMAGINARYPART - sum of imaginary part of matrix column to obtain with `MatGetColumnReductions()`
331: Level: beginner
333: .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_SUM_REALPART`, `REDUCTION_MEAN_IMAGINARYPART`
334: M*/
336: /*MC
337: REDUCTION_MEAN_REALPART - arithmetic mean of real part of matrix column to obtain with `MatGetColumnReductions()`
339: Level: beginner
341: .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_MEAN_IMAGINARYPART`, `REDUCTION_SUM_REALPART`
342: M*/
344: /*MC
345: REDUCTION_MEAN_IMAGINARYPART - arithmetic mean of imaginary part of matrix column to obtain with `MatGetColumnReductions()`
347: Level: beginner
349: .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_MEAN_REALPART`, `REDUCTION_SUM_IMAGINARYPART`
350: M*/
352: PETSC_EXTERN PetscErrorCode VecNorm(Vec, NormType, PetscReal *);
353: PETSC_EXTERN PetscErrorCode VecNormAvailable(Vec, NormType, PetscBool *, PetscReal *);
354: PETSC_EXTERN PetscErrorCode VecFlag(Vec, PetscInt);
355: PETSC_EXTERN PetscErrorCode VecNormalize(Vec, PetscReal *);
356: PETSC_EXTERN PetscErrorCode VecSum(Vec, PetscScalar *);
357: PETSC_EXTERN PetscErrorCode VecMean(Vec, PetscScalar *);
358: PETSC_EXTERN PetscErrorCode VecMax(Vec, PetscInt *, PetscReal *);
359: PETSC_EXTERN PetscErrorCode VecMin(Vec, PetscInt *, PetscReal *);
360: PETSC_EXTERN PetscErrorCode VecScale(Vec, PetscScalar);
361: PETSC_EXTERN PetscErrorCode VecCopy(Vec, Vec);
362: PETSC_EXTERN PetscErrorCode VecSetRandom(Vec, PetscRandom);
363: PETSC_EXTERN PetscErrorCode VecSetRandomGaussian(Vec, PetscRandom, PetscReal, PetscReal);
364: PETSC_EXTERN PetscErrorCode VecSet(Vec, PetscScalar);
365: PETSC_EXTERN PetscErrorCode VecSetStdBasis(Vec, PetscInt);
366: PETSC_DEPRECATED_FUNCTION(3, 22, 0, "VecFlag()", ) static inline PetscErrorCode VecSetInf(Vec xin)
367: {
368: return VecFlag(xin, 1);
369: }
370: PETSC_EXTERN PetscErrorCode VecSwap(Vec, Vec);
371: PETSC_EXTERN PetscErrorCode VecAXPY(Vec, PetscScalar, Vec);
372: PETSC_EXTERN PetscErrorCode VecAXPBY(Vec, PetscScalar, PetscScalar, Vec);
373: PETSC_EXTERN PetscErrorCode VecMAXPY(Vec, PetscInt, const PetscScalar[], Vec[]);
374: PETSC_EXTERN PetscErrorCode VecMAXPBY(Vec, PetscInt, const PetscScalar[], PetscScalar, Vec[]);
375: PETSC_EXTERN PetscErrorCode VecAYPX(Vec, PetscScalar, Vec);
376: PETSC_EXTERN PetscErrorCode VecWAXPY(Vec, PetscScalar, Vec, Vec);
377: PETSC_EXTERN PetscErrorCode VecAXPBYPCZ(Vec, PetscScalar, PetscScalar, PetscScalar, Vec, Vec);
378: PETSC_EXTERN PetscErrorCode VecPointwiseMax(Vec, Vec, Vec);
379: PETSC_EXTERN PetscErrorCode VecPointwiseMaxAbs(Vec, Vec, Vec);
380: PETSC_EXTERN PetscErrorCode VecPointwiseMin(Vec, Vec, Vec);
381: PETSC_EXTERN PetscErrorCode VecPointwiseMult(Vec, Vec, Vec);
382: PETSC_EXTERN PetscErrorCode VecPointwiseDivide(Vec, Vec, Vec);
383: PETSC_EXTERN PetscErrorCode VecPointwiseSign(Vec, Vec, VecSignMode);
384: PETSC_EXTERN PetscErrorCode VecMaxPointwiseDivide(Vec, Vec, PetscReal *);
385: PETSC_EXTERN PetscErrorCode VecShift(Vec, PetscScalar);
386: PETSC_EXTERN PetscErrorCode VecReciprocal(Vec);
387: PETSC_EXTERN PetscErrorCode VecPermute(Vec, IS, PetscBool);
388: PETSC_EXTERN PetscErrorCode VecSqrtAbs(Vec);
389: PETSC_EXTERN PetscErrorCode VecLog(Vec);
390: PETSC_EXTERN PetscErrorCode VecExp(Vec);
391: PETSC_EXTERN PetscErrorCode VecAbs(Vec);
392: PETSC_EXTERN PetscErrorCode VecDuplicate(Vec, Vec *);
393: PETSC_EXTERN PetscErrorCode VecDuplicateVecs(Vec, PetscInt, Vec *[]);
394: PETSC_EXTERN PetscErrorCode VecDestroyVecs(PetscInt, Vec *[]);
395: PETSC_EXTERN PetscErrorCode VecStrideNormAll(Vec, NormType, PetscReal[]);
396: PETSC_EXTERN PetscErrorCode VecStrideMaxAll(Vec, PetscInt[], PetscReal[]);
397: PETSC_EXTERN PetscErrorCode VecStrideMinAll(Vec, PetscInt[], PetscReal[]);
398: PETSC_EXTERN PetscErrorCode VecStrideScaleAll(Vec, const PetscScalar[]);
399: PETSC_EXTERN PetscErrorCode VecStrideSumAll(Vec, PetscScalar *);
400: PETSC_EXTERN PetscErrorCode VecUniqueEntries(Vec, PetscInt *, PetscScalar *[]);
402: PETSC_EXTERN PetscErrorCode VecStrideNorm(Vec, PetscInt, NormType, PetscReal *);
403: PETSC_EXTERN PetscErrorCode VecStrideMax(Vec, PetscInt, PetscInt *, PetscReal *);
404: PETSC_EXTERN PetscErrorCode VecStrideMin(Vec, PetscInt, PetscInt *, PetscReal *);
405: PETSC_EXTERN PetscErrorCode VecStrideScale(Vec, PetscInt, PetscScalar);
406: PETSC_EXTERN PetscErrorCode VecStrideSum(Vec, PetscInt, PetscScalar *);
407: PETSC_EXTERN PetscErrorCode VecStrideSet(Vec, PetscInt, PetscScalar);
409: PETSC_EXTERN PetscErrorCode VecStrideGather(Vec, PetscInt, Vec, InsertMode);
410: PETSC_EXTERN PetscErrorCode VecStrideScatter(Vec, PetscInt, Vec, InsertMode);
411: PETSC_EXTERN PetscErrorCode VecStrideGatherAll(Vec, Vec[], InsertMode);
412: PETSC_EXTERN PetscErrorCode VecStrideScatterAll(Vec[], Vec, InsertMode);
414: PETSC_EXTERN PetscErrorCode VecStrideSubSetScatter(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);
415: PETSC_EXTERN PetscErrorCode VecStrideSubSetGather(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);
417: PETSC_EXTERN PetscErrorCode VecSetValues(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
418: PETSC_EXTERN PetscErrorCode VecGetValues(Vec, PetscInt, const PetscInt[], PetscScalar[]);
419: PETSC_EXTERN PetscErrorCode VecAssemblyBegin(Vec);
420: PETSC_EXTERN PetscErrorCode VecAssemblyEnd(Vec);
421: PETSC_EXTERN PetscErrorCode VecStashSetInitialSize(Vec, PetscInt, PetscInt);
422: PETSC_EXTERN PetscErrorCode VecStashView(Vec, PetscViewer);
423: PETSC_EXTERN PetscErrorCode VecStashViewFromOptions(Vec, PetscObject, const char[]);
424: PETSC_EXTERN PetscErrorCode VecStashGetInfo(Vec, PetscInt *, PetscInt *, PetscInt *, PetscInt *);
426: PETSC_EXTERN PetscErrorCode VecSetPreallocationCOO(Vec, PetscCount, const PetscInt[]);
427: PETSC_EXTERN PetscErrorCode VecSetPreallocationCOOLocal(Vec, PetscCount, PetscInt[]);
428: PETSC_EXTERN PetscErrorCode VecSetValuesCOO(Vec, const PetscScalar[], InsertMode);
430: /*@
431: VecSetValue - Set a single entry into a PETSc vector, `Vec`.
433: Not Collective
435: Input Parameters:
436: + v - the vector
437: . row - the row location of the entry
438: . value - the value to insert
439: - mode - either `INSERT_VALUES` or `ADD_VALUES`
441: Level: beginner
443: Notes:
444: For efficiency one should use `VecSetValues()` and set several or
445: many values simultaneously if possible.
447: These values may be cached, so `VecAssemblyBegin()` and `VecAssemblyEnd()`
448: MUST be called after all calls to `VecSetValue()` have been completed.
450: `VecSetValue()` uses 0-based indices in Python, C, and Fortran
452: .seealso: [](ch_vectors), `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `VecSetValuesBlockedLocal()`, `VecSetValueLocal()`
453: @*/
454: static inline PetscErrorCode VecSetValue(Vec v, PetscInt i, PetscScalar va, InsertMode mode)
455: {
456: return VecSetValues(v, 1, &i, &va, mode);
457: }
459: PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec, PetscInt);
460: PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec, PetscInt *);
461: PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
463: /* Dynamic creation and loading functions */
464: PETSC_EXTERN PetscFunctionList VecList;
465: PETSC_EXTERN PetscErrorCode VecSetType(Vec, VecType);
466: PETSC_EXTERN PetscErrorCode VecGetType(Vec, VecType *);
467: PETSC_EXTERN PetscErrorCode VecRegister(const char[], PetscErrorCode (*)(Vec));
468: PETSC_EXTERN PetscErrorCode VecRegisterAll(void);
470: PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter, Vec, Vec, InsertMode, ScatterMode);
471: PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter, Vec, Vec, InsertMode, ScatterMode);
472: PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter *);
473: PETSC_EXTERN PetscErrorCode VecScatterSetUp(VecScatter);
474: PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter, VecScatter *);
475: PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter, PetscViewer);
476: PETSC_EXTERN PetscErrorCode VecScatterViewFromOptions(VecScatter, PetscObject, const char[]);
477: PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter, PetscInt[], PetscInt[]);
478: PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter, PetscBool *);
480: PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
481: PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
482: PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
483: PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
484: PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
485: PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
486: PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec, PetscInt, PetscInt, PetscScalar *[]);
487: PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec, PetscInt, PetscInt, PetscScalar *[]);
489: PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
490: PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
491: PETSC_EXTERN PetscErrorCode VecRestoreArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
492: PETSC_EXTERN PetscErrorCode VecGetArray3dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
493: PETSC_EXTERN PetscErrorCode VecRestoreArray3dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
494: PETSC_EXTERN PetscErrorCode VecGetArray2dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
495: PETSC_EXTERN PetscErrorCode VecRestoreArray2dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
496: PETSC_EXTERN PetscErrorCode VecGetArray1dWrite(Vec, PetscInt, PetscInt, PetscScalar *[]);
497: PETSC_EXTERN PetscErrorCode VecRestoreArray1dWrite(Vec, PetscInt, PetscInt, PetscScalar *[]);
499: PETSC_EXTERN PetscErrorCode VecGetArray4dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
500: PETSC_EXTERN PetscErrorCode VecRestoreArray4dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
501: PETSC_EXTERN PetscErrorCode VecGetArray3dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
502: PETSC_EXTERN PetscErrorCode VecRestoreArray3dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
503: PETSC_EXTERN PetscErrorCode VecGetArray2dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
504: PETSC_EXTERN PetscErrorCode VecRestoreArray2dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
505: PETSC_EXTERN PetscErrorCode VecGetArray1dRead(Vec, PetscInt, PetscInt, PetscScalar *[]);
506: PETSC_EXTERN PetscErrorCode VecRestoreArray1dRead(Vec, PetscInt, PetscInt, PetscScalar *[]);
508: PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec, const PetscScalar[]);
509: PETSC_EXTERN PetscErrorCode VecResetArray(Vec);
510: PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec, const PetscScalar[]);
512: PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[], PetscInt, PetscScalar **[]);
513: PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[], PetscInt, PetscScalar **[]);
515: PETSC_EXTERN PetscErrorCode VecView(Vec, PetscViewer);
516: PETSC_EXTERN PetscErrorCode VecViewNative(Vec, PetscViewer);
517: PETSC_EXTERN PetscErrorCode VecEqual(Vec, Vec, PetscBool *);
518: PETSC_EXTERN PetscErrorCode VecLoad(Vec, PetscViewer);
520: PETSC_EXTERN PetscErrorCode VecGetSize(Vec, PetscInt *);
521: PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec, PetscInt *);
522: PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec, PetscInt *, PetscInt *);
523: PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec, const PetscInt *[]);
525: PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping);
526: PETSC_EXTERN PetscErrorCode VecSetValuesLocal(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
528: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLContext(Vec, PETSC_UINTPTR_T *);
529: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLQueue(Vec, PETSC_UINTPTR_T *);
530: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemRead(Vec, PETSC_UINTPTR_T *);
531: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemWrite(Vec, PETSC_UINTPTR_T *);
532: PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMemWrite(Vec);
533: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMem(Vec, PETSC_UINTPTR_T *);
534: PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMem(Vec);
536: /*@
537: VecSetValueLocal - Set a single entry into a vector using the local numbering of the vector, see `VecSetValuesLocal()`
539: Not Collective
541: Input Parameters:
542: + v - the vector
543: . row - the local row location of the entry
544: . value - the value to insert
545: - mode - either `INSERT_VALUES` or `ADD_VALUES`
547: Level: beginner
549: Notes:
550: For efficiency one should use `VecSetValuesLocal()` and set several or
551: many values simultaneously if possible.
553: These values may be cached, so `VecAssemblyBegin()` and `VecAssemblyEnd()`
554: MUST be called after all calls to `VecSetValueLocal()` have been completed.
556: See `VecSetLocalToGlobalMapping()` for how the local numbering is defined
558: `VecSetValueLocal()` uses 0-based indices in Fortran as well as in C.
560: .seealso: [](ch_vectors), `VecSetValuesLocal()`, `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `VecSetValuesBlockedLocal()`, `VecSetValue()`,
561: `VecSetLocalToGlobalMapping()`
562: @*/
563: static inline PetscErrorCode VecSetValueLocal(Vec v, PetscInt i, PetscScalar va, InsertMode mode)
564: {
565: return VecSetValuesLocal(v, 1, &i, &va, mode);
566: }
568: /*MC
569: VecCheckAssembled - checks if values have been changed in the vector, by `VecSetValues()` or related routines, but it has not been assembled
571: Synopsis:
572: #include <petscvec.h>
573: VecCheckAssembled(Vec v);
575: Not Collective
577: Input Parameter:
578: . v - the vector to check
580: Level: developer
582: Note:
583: After calls to `VecSetValues()` and related routines one must call `VecAssemblyBegin()` and `VecAssemblyEnd()` before using the vector
585: .seealso: [](ch_vectors), `Vec`, `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `MatAssemblyBegin()`, `MatAssemblyEnd()`
586: M*/
587: #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()?")
589: PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
590: PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping *);
592: PETSC_EXTERN PetscErrorCode VecDotBegin(Vec, Vec, PetscScalar *);
593: PETSC_EXTERN PetscErrorCode VecDotEnd(Vec, Vec, PetscScalar *);
594: PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec, Vec, PetscScalar *);
595: PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec, Vec, PetscScalar *);
596: PETSC_EXTERN PetscErrorCode VecNormBegin(Vec, NormType, PetscReal *);
597: PETSC_EXTERN PetscErrorCode VecNormEnd(Vec, NormType, PetscReal *);
598: PETSC_EXTERN PetscErrorCode VecErrorWeightedNorms(Vec, Vec, Vec, NormType, PetscReal, Vec, PetscReal, Vec, PetscReal, PetscReal *, PetscInt *, PetscReal *, PetscInt *, PetscReal *, PetscInt *);
600: PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec, PetscInt, const Vec[], PetscScalar[]);
601: PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec, PetscInt, const Vec[], PetscScalar[]);
602: PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec, PetscInt, const Vec[], PetscScalar[]);
603: PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec, PetscInt, const Vec[], PetscScalar[]);
604: PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm);
606: PETSC_EXTERN PetscErrorCode VecBindToCPU(Vec, PetscBool);
607: PETSC_DEPRECATED_FUNCTION(3, 13, 0, "VecBindToCPU()", ) static inline PetscErrorCode VecPinToCPU(Vec v, PetscBool flg)
608: {
609: return VecBindToCPU(v, flg);
610: }
611: PETSC_EXTERN PetscErrorCode VecBoundToCPU(Vec, PetscBool *);
612: PETSC_EXTERN PetscErrorCode VecSetBindingPropagates(Vec, PetscBool);
613: PETSC_EXTERN PetscErrorCode VecGetBindingPropagates(Vec, PetscBool *);
614: PETSC_EXTERN PetscErrorCode VecSetPinnedMemoryMin(Vec, size_t);
615: PETSC_EXTERN PetscErrorCode VecGetPinnedMemoryMin(Vec, size_t *);
617: PETSC_EXTERN PetscErrorCode VecGetOffloadMask(Vec, PetscOffloadMask *);
619: /*E
620: VecOption - Options that may be set for a vector regarding entries passed to `VecSetValues()` and related routines
622: Values:
623: + `VEC_IGNORE_OFF_PROC_ENTRIES` - causes `VecSetValues()` to ignore entries destined to be stored on a separate processor.
624: This can be used to eliminate the global reduction in `VecAssemblyBegin()` if you know that
625: you have only used `VecSetValues()` to set local elements
626: . `VEC_IGNORE_NEGATIVE_INDICES` - means you can pass negative indices in `ix` in calls to `VecSetValues()` or `VecGetValues()`.
627: These rows are simply ignored.
628: - `VEC_SUBSET_OFF_PROC_ENTRIES` - causes `VecAssemblyBegin()` to assume that the off-process entries will always be a subset
629: (possibly equal) of the off-process entries set on the first assembly which had a true
630: `VEC_SUBSET_OFF_PROC_ENTRIES` and the vector has not changed this flag afterwards. If this
631: assembly is not such first assembly, then this assembly can reuse the communication pattern
632: setup in that first assembly, thus avoiding a global reduction. Subsequent assemblies setting
633: off-process values should use the same `InsertMode` as the first assembly.
635: Level: beginner
637: .seealso: [](ch_matrices), `Vec`, `MatSetOption()`, `VecSetOption()`, `VecSetValues()`, `VecAssemblyBegin()`
638: E*/
639: typedef enum {
640: VEC_IGNORE_OFF_PROC_ENTRIES,
641: VEC_IGNORE_NEGATIVE_INDICES,
642: VEC_SUBSET_OFF_PROC_ENTRIES
643: } VecOption;
645: PETSC_EXTERN PetscErrorCode VecSetOption(Vec, VecOption, PetscBool);
647: PETSC_EXTERN PetscErrorCode VecGetArray(Vec, PetscScalar *[]);
648: PETSC_EXTERN PetscErrorCode VecGetArrayWrite(Vec, PetscScalar *[]);
649: PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec, const PetscScalar *[]);
650: PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec, PetscScalar *[]);
651: PETSC_EXTERN PetscErrorCode VecRestoreArrayWrite(Vec, PetscScalar *[]);
652: PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec, const PetscScalar *[]);
653: PETSC_EXTERN PetscErrorCode VecCreateLocalVector(Vec, Vec *);
654: PETSC_EXTERN PetscErrorCode VecGetLocalVector(Vec, Vec);
655: PETSC_EXTERN PetscErrorCode VecRestoreLocalVector(Vec, Vec);
656: PETSC_EXTERN PetscErrorCode VecGetLocalVectorRead(Vec, Vec);
657: PETSC_EXTERN PetscErrorCode VecRestoreLocalVectorRead(Vec, Vec);
658: PETSC_EXTERN PetscErrorCode VecGetArrayAndMemType(Vec, PetscScalar *[], PetscMemType *);
659: PETSC_EXTERN PetscErrorCode VecRestoreArrayAndMemType(Vec, PetscScalar *[]);
660: PETSC_EXTERN PetscErrorCode VecGetArrayReadAndMemType(Vec, const PetscScalar *[], PetscMemType *);
661: PETSC_EXTERN PetscErrorCode VecRestoreArrayReadAndMemType(Vec, const PetscScalar *[]);
662: PETSC_EXTERN PetscErrorCode VecGetArrayWriteAndMemType(Vec, PetscScalar *[], PetscMemType *);
663: PETSC_EXTERN PetscErrorCode VecRestoreArrayWriteAndMemType(Vec, PetscScalar *[]);
665: /*@
666: 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
668: Logically Collective; No Fortran Support
670: Input Parameters:
671: + x - the vector
672: - y - the second vector
674: Output Parameters:
675: + xv - location to put pointer to the first array
676: - yv - location to put pointer to the second array
678: Level: developer
680: .seealso: [](ch_vectors), `VecGetArray()`, `VecGetArrayRead()`, `VecRestoreArrayPair()`
681: @*/
682: static inline PetscErrorCode VecGetArrayPair(Vec x, Vec y, PetscScalar *xv[], PetscScalar *yv[])
683: {
684: PetscFunctionBegin;
685: PetscCall(VecGetArray(y, yv));
686: if (x == y) *xv = *yv;
687: else PetscCall(VecGetArrayRead(x, (const PetscScalar **)xv));
688: PetscFunctionReturn(PETSC_SUCCESS);
689: }
691: /*@
692: VecRestoreArrayPair - Returns a pair of pointers for two vectors that may be common obtained with `VecGetArrayPair()`
694: Logically Collective; No Fortran Support
696: Input Parameters:
697: + x - the vector
698: . y - the second vector
699: . xv - location to put pointer to the first array
700: - yv - location to put pointer to the second array
702: Level: developer
704: .seealso: [](ch_vectors), `VecGetArray()`, `VecGetArrayRead()`, `VecGetArrayPair()`
705: @*/
706: static inline PetscErrorCode VecRestoreArrayPair(Vec x, Vec y, PetscScalar *xv[], PetscScalar *yv[])
707: {
708: PetscFunctionBegin;
709: PetscCall(VecRestoreArray(y, yv));
710: if (x != y) PetscCall(VecRestoreArrayRead(x, (const PetscScalar **)xv));
711: PetscFunctionReturn(PETSC_SUCCESS);
712: }
714: PETSC_EXTERN PetscErrorCode VecLockReadPush(Vec);
715: PETSC_EXTERN PetscErrorCode VecLockReadPop(Vec);
716: PETSC_EXTERN PetscErrorCode VecLockWriteSet(Vec, PetscBool);
717: PETSC_EXTERN PetscErrorCode VecLockGet(Vec, PetscInt *);
718: PETSC_EXTERN PetscErrorCode VecLockGetLocation(Vec, const char *[], const char *[], int *);
720: /*@
721: VecSetErrorIfLocked - Raise an error if the `Vec` is currently locked for read or write access.
723: Not Collective; No Fortran Support
725: Input Parameters:
726: + x - the `Vec` to test
727: - arg - the argument position of `x` in the calling routine, used in the error message
729: Level: developer
731: Note:
732: This is intended as an internal check for routines that must have exclusive access to a `Vec`.
733: A locked `Vec` typically indicates that another routine currently holds a read or write reference to it.
735: .seealso: `Vec`, `VecLockGet()`, `VecLockGetLocation()`, `VecLockReadPush()`, `VecLockReadPop()`, `VecLockWriteSet()`
736: @*/
737: static inline PetscErrorCode VecSetErrorIfLocked(Vec x, PetscInt arg)
738: {
739: PetscInt state;
741: PetscFunctionBegin;
742: PetscCall(VecLockGet(x, &state));
743: if (PetscUnlikely(state != 0)) {
744: const char *file, *func, *name;
745: int line;
747: PetscCall(VecLockGetLocation(x, &file, &func, &line));
748: PetscCall(PetscObjectGetName((PetscObject)x, &name));
749: 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);
750: }
751: PetscFunctionReturn(PETSC_SUCCESS);
752: }
754: /* The three are deprecated */
755: PETSC_DEPRECATED_FUNCTION(3, 11, 0, "VecLockReadPush()", ) static inline PetscErrorCode VecLockPush(Vec v)
756: {
757: return VecLockReadPush(v);
758: }
760: PETSC_DEPRECATED_FUNCTION(3, 11, 0, "VecLockReadPop()", ) static inline PetscErrorCode VecLockPop(Vec v)
761: {
762: return VecLockReadPop(v);
763: }
765: /*MC
766: VecLocked - Deprecated alias for `VecSetErrorIfLocked()`; raises an error if the `Vec` is currently locked for read
768: Synopsis:
769: #include <petscvec.h>
770: PetscErrorCode VecLocked(Vec x, int arg)
772: Not Collective; No Fortran Support
774: Input Parameters:
775: + x - the `Vec` to test
776: - arg - the argument position of `x` in the caller (used in the error message)
778: Level: deprecated
780: Note:
781: Use `VecSetErrorIfLocked()` in new code; this macro is retained only for backwards compatibility.
783: .seealso: `Vec`, `VecSetErrorIfLocked()`, `VecLockReadPush()`, `VecLockReadPop()`
784: M*/
785: #define VecLocked(x, arg) VecSetErrorIfLocked(x, arg) PETSC_DEPRECATED_MACRO(3, 11, 0, "VecSetErrorIfLocked()", )
787: /*E
788: VecOperation - Enumeration of overide-able methods in the `Vec` implementation function-table.
790: Values:
791: + `VECOP_DUPLICATE` - `VecDuplicate()`
792: . `VECOP_SET` - `VecSet()`
793: . `VECOP_VIEW` - `VecView()`
794: . `VECOP_LOAD` - `VecLoad()`
795: . `VECOP_VIEWNATIVE` - `VecViewNative()`
796: - `VECOP_LOADNATIVE` - `VecLoadNative()`
798: Level: advanced
800: Notes:
801: Some operations may serve as the implementation for other routines not listed above. For
802: example `VECOP_SET` can be used to simultaneously overriding the implementation used in
803: `VecSet()`, `VecFlag()`, and `VecZeroEntries()`.
805: Entries to `VecOperation` are added as needed so if you do not see the operation listed which
806: you'd like to replace, please send mail to `petsc-maint@mcs.anl.gov`!
808: .seealso: [](ch_vectors), `Vec`, `VecSetOperation()`
809: E*/
810: typedef enum {
811: VECOP_DUPLICATE = 0,
812: VECOP_SET = 10,
813: VECOP_VIEW = 33,
814: VECOP_LOAD = 41,
815: VECOP_VIEWNATIVE = 68,
816: VECOP_LOADNATIVE = 69
817: } VecOperation;
818: PETSC_EXTERN PetscErrorCode VecSetOperation(Vec, VecOperation, PetscErrorCodeFn *);
820: /*
821: Routines for dealing with ghosted vectors:
822: vectors with ghost elements at the end of the array.
823: */
824: PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec, PetscInt, const PetscInt[]);
825: PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Vec *);
826: PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscScalar[], Vec *);
827: PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Vec *);
828: PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscScalar[], Vec *);
829: PETSC_EXTERN PetscErrorCode VecGhostGetGhostIS(Vec, IS *);
830: PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec, Vec *);
831: PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec, Vec *);
832: PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec, Vec, PetscBool *);
833: PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec, InsertMode, ScatterMode);
834: PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec, InsertMode, ScatterMode);
836: PETSC_EXTERN PetscErrorCode VecConjugate(Vec);
837: PETSC_EXTERN PetscErrorCode VecImaginaryPart(Vec);
838: PETSC_EXTERN PetscErrorCode VecRealPart(Vec);
840: PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec, VecScatter *, Vec *);
841: PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec, VecScatter *, Vec *);
843: /* These vector calls were included from TAO. They miss vtable entries and GPU implementation */
844: PETSC_EXTERN PetscErrorCode ISComplementVec(IS, Vec, IS *);
845: PETSC_EXTERN PetscErrorCode VecPow(Vec, PetscScalar);
846: PETSC_EXTERN PetscErrorCode VecMedian(Vec, Vec, Vec, Vec);
847: PETSC_EXTERN PetscErrorCode VecWhichInactive(Vec, Vec, Vec, Vec, PetscBool, IS *);
848: PETSC_EXTERN PetscErrorCode VecWhichBetween(Vec, Vec, Vec, IS *);
849: PETSC_EXTERN PetscErrorCode VecWhichBetweenOrEqual(Vec, Vec, Vec, IS *);
850: PETSC_EXTERN PetscErrorCode VecWhichGreaterThan(Vec, Vec, IS *);
851: PETSC_EXTERN PetscErrorCode VecWhichLessThan(Vec, Vec, IS *);
852: PETSC_EXTERN PetscErrorCode VecWhichEqual(Vec, Vec, IS *);
853: PETSC_EXTERN PetscErrorCode VecISAXPY(Vec, IS, PetscScalar, Vec);
854: PETSC_EXTERN PetscErrorCode VecISCopy(Vec, IS, ScatterMode, Vec);
855: PETSC_EXTERN PetscErrorCode VecISSet(Vec, IS, PetscScalar);
856: PETSC_EXTERN PetscErrorCode VecISShift(Vec, IS, PetscScalar);
857: PETSC_EXTERN PetscErrorCode VecBoundGradientProjection(Vec, Vec, Vec, Vec, Vec);
858: PETSC_EXTERN PetscErrorCode VecStepBoundInfo(Vec, Vec, Vec, Vec, PetscReal *, PetscReal *, PetscReal *);
859: PETSC_EXTERN PetscErrorCode VecStepMax(Vec, Vec, PetscReal *);
860: PETSC_EXTERN PetscErrorCode VecStepMaxBounded(Vec, Vec, Vec, Vec, PetscReal *);
862: struct _n_Vecs {
863: PetscInt n;
864: Vec v;
865: };
866: /*S
867: Vecs - Collection of `Vec`s where the storage for the vectors is held in a single contiguous block of memory
869: Level: advanced
871: Notes:
872: Temporary construct for handling multiple right-hand side solves.
874: This is faked by storing a single `Vec` whose array is sized to hold `n` vectors back to back.
876: .seealso: `Vec`, `VecsCreateSeq()`, `VecsCreateSeqWithArray()`, `VecsDuplicate()`, `VecsDestroy()`
877: S*/
878: typedef struct _n_Vecs *Vecs;
879: PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs);
880: PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm, PetscInt, PetscInt, Vecs *);
881: PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm, PetscInt, PetscInt, PetscScalar *, Vecs *);
882: PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs, Vecs *);
884: #if PetscDefined(HAVE_VIENNACL)
885: /*S
886: PetscViennaCLIndices - Opaque handle to an index buffer used by PETSc's ViennaCL `VECVIENNACL` vector backend to perform partial scatters between CPU and GPU memory
888: Level: developer
890: .seealso: `Vec`, `VECVIENNACL`, `VecCreateSeqViennaCL()`
891: S*/
892: typedef struct _n_PetscViennaCLIndices *PetscViennaCLIndices;
893: PETSC_EXTERN PetscErrorCode VecCreateSeqViennaCL(MPI_Comm, PetscInt, Vec *);
894: #endif
895: #if PetscDefined(HAVE_KOKKOS_KERNELS)
896: PETSC_EXTERN PetscErrorCode VecCreateSeqKokkos(MPI_Comm, PetscInt, Vec *);
897: PETSC_EXTERN PetscErrorCode VecCreateSeqKokkosWithArray(MPI_Comm, PetscInt, PetscInt, const PetscScalar *, Vec *);
898: PETSC_EXTERN PetscErrorCode VecCreateMPIKokkosWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar *, Vec *);
899: PETSC_EXTERN PetscErrorCode VecKokkosPlaceArray(Vec, PetscScalar *);
900: PETSC_EXTERN PetscErrorCode VecKokkosResetArray(Vec);
901: #endif
903: PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec, PetscInt *, Vec *[]);
904: PETSC_EXTERN PetscErrorCode VecNestGetSubVecsRead(Vec, PetscInt *, Vec *[]);
905: PETSC_EXTERN PetscErrorCode VecNestRestoreSubVecsRead(Vec, PetscInt *, Vec *[]);
906: PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec, PetscInt, Vec *);
907: PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec, PetscInt, PetscInt *, Vec *);
908: PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec, PetscInt, Vec);
909: PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm, PetscInt, IS *, Vec *, Vec *);
910: PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec, PetscInt *);
912: PETSC_EXTERN PetscErrorCode PetscOptionsGetVec(PetscOptions, const char[], const char[], Vec, PetscBool *);
913: PETSC_EXTERN PetscErrorCode VecFilter(Vec, PetscReal);
914: PETSC_DEPRECATED_FUNCTION(3, 20, 0, "VecFilter()", ) static inline PetscErrorCode VecChop(Vec v, PetscReal tol)
915: {
916: return VecFilter(v, tol);
917: }
919: PETSC_EXTERN PetscErrorCode VecGetLayout(Vec, PetscLayout *);
920: PETSC_EXTERN PetscErrorCode VecSetLayout(Vec, PetscLayout);
922: PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer);
923: PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar *[]);
924: PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, const PetscScalar[], InsertMode);
925: PETSC_EXTERN PetscErrorCode PetscSectionVecNorm(PetscSection, PetscSection, Vec, NormType, PetscReal[]);
927: /*S
928: VecTagger - Object used to manage the tagging of a subset of indices based on the values of a vector. The
929: motivating application is the selection of cells for refinement or coarsening based on vector containing
930: the values in an error indicator metric.
932: Values:
933: + `VECTAGGERABSOLUTE` - "absolute" values are in a interval (box for complex values) of explicitly defined values
934: . `VECTAGGERRELATIVE` - "relative" values are in a interval (box for complex values) of values relative to the set of all values in the vector
935: . `VECTAGGERCDF` - "cdf" values are in a relative range of the *cumulative distribution* of values in the vector
936: . `VECTAGGEROR` - "or" values are in the union of other tags
937: - `VECTAGGERAND` - "and" values are in the intersection of other tags
939: Level: advanced
941: Developer Note:
942: Why not use a `DMLabel` or similar object
944: .seealso: [](ch_vectors), `Vec`, `VecTaggerType`, `VecTaggerCreate()`
945: S*/
946: typedef struct _p_VecTagger *VecTagger;
948: /*J
949: VecTaggerType - String with the name of a `VecTagger` type
951: Level: advanced
953: .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerCreate()`
954: J*/
955: typedef const char *VecTaggerType;
956: #define VECTAGGERABSOLUTE "absolute"
957: #define VECTAGGERRELATIVE "relative"
958: #define VECTAGGERCDF "cdf"
959: #define VECTAGGEROR "or"
960: #define VECTAGGERAND "and"
962: PETSC_EXTERN PetscClassId VEC_TAGGER_CLASSID;
963: PETSC_EXTERN PetscFunctionList VecTaggerList;
964: PETSC_EXTERN PetscErrorCode VecTaggerRegister(const char[], PetscErrorCode (*)(VecTagger));
965: PETSC_EXTERN PetscErrorCode VecTaggerRegisterAll(void);
967: PETSC_EXTERN PetscErrorCode VecTaggerCreate(MPI_Comm, VecTagger *);
968: PETSC_EXTERN PetscErrorCode VecTaggerSetBlockSize(VecTagger, PetscInt);
969: PETSC_EXTERN PetscErrorCode VecTaggerGetBlockSize(VecTagger, PetscInt *);
970: PETSC_EXTERN PetscErrorCode VecTaggerSetType(VecTagger, VecTaggerType);
971: PETSC_EXTERN PetscErrorCode VecTaggerGetType(VecTagger, VecTaggerType *);
972: PETSC_EXTERN PetscErrorCode VecTaggerSetInvert(VecTagger, PetscBool);
973: PETSC_EXTERN PetscErrorCode VecTaggerGetInvert(VecTagger, PetscBool *);
974: PETSC_EXTERN PetscErrorCode VecTaggerSetFromOptions(VecTagger);
975: PETSC_EXTERN PetscErrorCode VecTaggerSetUp(VecTagger);
976: PETSC_EXTERN PetscErrorCode VecTaggerView(VecTagger, PetscViewer);
977: PETSC_EXTERN PetscErrorCode VecTaggerComputeIS(VecTagger, Vec, IS *, PetscBool *);
978: PETSC_EXTERN PetscErrorCode VecTaggerDestroy(VecTagger *);
980: /*S
981: VecTaggerBox - A interval (box for complex numbers) range used to tag values. For real scalars, this is just a closed interval; for complex scalars,
982: 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.
984: Level: beginner
986: .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerType`, `VecTaggerCreate()`, `VecTaggerComputeIntervals()`
987: S*/
988: typedef struct {
989: PetscScalar min;
990: PetscScalar max;
991: } VecTaggerBox;
992: PETSC_EXTERN PetscErrorCode VecTaggerComputeBoxes(VecTagger, Vec, PetscInt *, VecTaggerBox *[], PetscBool *);
994: PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteSetBox(VecTagger, VecTaggerBox *);
995: PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteGetBox(VecTagger, const VecTaggerBox *[]);
997: PETSC_EXTERN PetscErrorCode VecTaggerRelativeSetBox(VecTagger, VecTaggerBox *);
998: PETSC_EXTERN PetscErrorCode VecTaggerRelativeGetBox(VecTagger, const VecTaggerBox *[]);
1000: PETSC_EXTERN PetscErrorCode VecTaggerCDFSetBox(VecTagger, VecTaggerBox *);
1001: PETSC_EXTERN PetscErrorCode VecTaggerCDFGetBox(VecTagger, const VecTaggerBox *[]);
1003: /*E
1004: 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).
1006: Values:
1007: + `VECTAGGER_CDF_GATHER` - gather the data to MPI rank 0, perform the computation and broadcast the result
1008: - `VECTAGGER_CDF_ITERATIVE` - compute the results on all ranks iteratively using `MPI_Allreduce()`
1010: Level: advanced
1012: Note:
1013: Relevant only in parallel: in serial it is directly computed.
1015: Developer Note:
1016: In PETSc enums of this type are referred to with the term type, not method.
1018: .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerType`, `VecTaggerCreate()`, `VecTaggerCDFSetMethod()`
1019: E*/
1020: typedef enum {
1021: VECTAGGER_CDF_GATHER,
1022: VECTAGGER_CDF_ITERATIVE,
1023: VECTAGGER_CDF_NUM_METHODS
1024: } VecTaggerCDFMethod;
1025: PETSC_EXTERN const char *const VecTaggerCDFMethods[];
1027: PETSC_EXTERN PetscErrorCode VecTaggerCDFSetMethod(VecTagger, VecTaggerCDFMethod);
1028: PETSC_EXTERN PetscErrorCode VecTaggerCDFGetMethod(VecTagger, VecTaggerCDFMethod *);
1029: PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeSetTolerances(VecTagger, PetscInt, PetscReal, PetscReal);
1030: PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeGetTolerances(VecTagger, PetscInt *, PetscReal *, PetscReal *);
1032: PETSC_EXTERN PetscErrorCode VecTaggerOrSetSubs(VecTagger, PetscInt, VecTagger *, PetscCopyMode);
1033: PETSC_EXTERN PetscErrorCode VecTaggerOrGetSubs(VecTagger, PetscInt *, VecTagger *[]);
1035: PETSC_EXTERN PetscErrorCode VecTaggerAndSetSubs(VecTagger, PetscInt, VecTagger *, PetscCopyMode);
1036: PETSC_EXTERN PetscErrorCode VecTaggerAndGetSubs(VecTagger, PetscInt *, VecTagger *[]);
1038: PETSC_EXTERN PetscErrorCode VecTaggerInitializePackage(void);
1039: PETSC_EXTERN PetscErrorCode VecTaggerFinalizePackage(void);
1041: PETSC_EXTERN PetscErrorCode VecFischer(Vec, Vec, Vec, Vec, Vec);
1042: PETSC_EXTERN PetscErrorCode VecSFischer(Vec, Vec, Vec, Vec, PetscReal, Vec);
1044: #if PetscDefined(USE_DEBUG)
1045: /* This is an internal debug-only routine that should not be used by users */
1046: PETSC_SINGLE_LIBRARY_INTERN PetscErrorCode VecValidValues_Internal(Vec, PetscInt, PetscBool);
1047: #else
1048: #define VecValidValues_Internal(...) PETSC_SUCCESS
1049: #endif /* PETSC_USE_DEBUG */
1051: #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)
1053: #if PetscDefined(HAVE_CUDA)
1054: #define VEC_CUDA_DECL_OR_STUB(__decl__, ...) PETSC_EXTERN __decl__;
1055: #else
1056: #define VEC_CUDA_DECL_OR_STUB(__decl__, ...) \
1057: static inline __decl__ \
1058: { \
1059: __VA_ARGS__; \
1060: VEC_CUPM_NOT_CONFIGURED(cuda); \
1061: }
1062: #endif /* PETSC_HAVE_CUDA */
1064: /* extra underscore here to make it line up with the cuda versions */
1065: #if PetscDefined(HAVE_HIP)
1066: #define VEC_HIP__DECL_OR_STUB(__decl__, ...) PETSC_EXTERN __decl__;
1067: #else
1068: #define VEC_HIP__DECL_OR_STUB(__decl__, ...) \
1069: static inline __decl__ \
1070: { \
1071: __VA_ARGS__; \
1072: VEC_CUPM_NOT_CONFIGURED(hip); \
1073: }
1074: #endif /* PETSC_HAVE_HIP */
1076: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateSeqCUDA(MPI_Comm a, PetscInt b, Vec *c), (void)a, (void)b, (void)c)
1077: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateSeqHIP(MPI_Comm a, PetscInt b, Vec *c), (void)a, (void)b, (void)c)
1079: 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)
1080: 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)
1082: 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)
1083: 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)
1085: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateMPICUDA(MPI_Comm a, PetscInt b, PetscInt c, Vec *d), (void)a, (void)b, (void)c, (void)d)
1086: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateMPIHIP(MPI_Comm a, PetscInt b, PetscInt c, Vec *d), (void)a, (void)b, (void)c, (void)d)
1088: 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)
1089: 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)
1091: 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)
1092: 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)
1094: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArray(Vec a, PetscScalar *b[]), (void)a, (void)b)
1095: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArray(Vec a, PetscScalar *b[]), (void)a, (void)b)
1097: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArray(Vec a, PetscScalar *b[]), (void)a, (void)b)
1098: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArray(Vec a, PetscScalar *b[]), (void)a, (void)b)
1100: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArrayRead(Vec a, const PetscScalar *b[]), (void)a, (void)b)
1101: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArrayRead(Vec a, const PetscScalar *b[]), (void)a, (void)b)
1103: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArrayRead(Vec a, const PetscScalar *b[]), (void)a, (void)b)
1104: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArrayRead(Vec a, const PetscScalar *b[]), (void)a, (void)b)
1106: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArrayWrite(Vec a, PetscScalar *b[]), (void)a, (void)b)
1107: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArrayWrite(Vec a, PetscScalar *b[]), (void)a, (void)b)
1109: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArrayWrite(Vec a, PetscScalar *b[]), (void)a, (void)b)
1110: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArrayWrite(Vec a, PetscScalar *b[]), (void)a, (void)b)
1112: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAPlaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b)
1113: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPPlaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b)
1115: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAReplaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b)
1116: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPReplaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b)
1118: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAResetArray(Vec a), (void)a)
1119: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPResetArray(Vec a), (void)a)
1121: #undef VEC_CUPM_NOT_CONFIGURED
1122: #undef VEC_CUDA_DECL_OR_STUB
1123: #undef VEC_HIP__DECL_OR_STUB