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 then 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
19: Level: beginner
21: .seealso: [](doc_vector), [](ch_vectors), `VecCreate()`, `VecType`, `VecSetType()`
22: S*/
23: typedef struct _p_Vec *Vec;
25: /*E
26: ScatterMode - Determines the direction of a scatter
28: Values:
29: + `SCATTER_FORWARD` - Scatters the values as dictated by the `VecScatterCreate()` call
30: . `SCATTER_REVERSE` - Moves the values in the opposite direction than the directions indicated in the `VecScatterCreate()` call
31: . `SCATTER_FORWARD_LOCAL` - Scatters the values as dictated by the `VecScatterCreate()` call except NO MPI communication is done
32: - `SCATTER_REVERSE_LOCAL` - Moves the values in the opposite direction than the directions indicated in the `VecScatterCreate()` call
33: except NO MPI communication is done
35: Level: beginner
37: .seealso: [](ch_vectors), `VecScatter`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_FORWARD`, `SCATTER_REVERSE`, `SCATTER_FORWARD_LOCAL`, `SCATTER_REVERSE_LOCAL`
38: E*/
39: typedef enum {
40: SCATTER_FORWARD = 0,
41: SCATTER_REVERSE = 1,
42: SCATTER_FORWARD_LOCAL = 2,
43: SCATTER_REVERSE_LOCAL = 3
44: } ScatterMode;
46: /*MC
47: SCATTER_FORWARD - Scatters the values as dictated by the `VecScatterCreate()` call
49: Level: beginner
51: .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_REVERSE`, `SCATTER_FORWARD_LOCAL`,
52: `SCATTER_REVERSE_LOCAL`
53: M*/
55: /*MC
56: SCATTER_REVERSE - Moves the values in the opposite direction then the directions indicated in
57: in the `VecScatterCreate()`
59: Level: beginner
61: .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_FORWARD`, `SCATTER_FORWARD_LOCAL`,
62: `SCATTER_REVERSE_LOCAL`
63: M*/
65: /*MC
66: SCATTER_FORWARD_LOCAL - Scatters the values as dictated by the `VecScatterCreate()` call except NO parallel communication
67: is done. Any variables that have be moved between processes are ignored
69: Level: developer
71: .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_REVERSE`, `SCATTER_FORWARD`,
72: `SCATTER_REVERSE_LOCAL`
73: M*/
75: /*MC
76: SCATTER_REVERSE_LOCAL - Moves the values in the opposite direction then the directions indicated in
77: in the `VecScatterCreate()` except NO parallel communication
78: is done. Any variables that have be moved between processes are ignored
80: Level: developer
82: .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_FORWARD`, `SCATTER_FORWARD_LOCAL`,
83: `SCATTER_REVERSE`
84: M*/
86: /*J
87: VecType - String with the name of a PETSc vector
89: Level: beginner
91: .seealso: [](doc_vector), [](ch_vectors), `VecSetType()`, `Vec`, `VecCreate()`, `VecDestroy()`
92: J*/
93: typedef const char *VecType;
94: #define VECSEQ "seq"
95: #define VECMPI "mpi"
96: #define VECSTANDARD "standard" /* seq on one process and mpi on several */
97: #define VECSHARED "shared"
98: #define VECSEQVIENNACL "seqviennacl"
99: #define VECMPIVIENNACL "mpiviennacl"
100: #define VECVIENNACL "viennacl" /* seqviennacl on one process and mpiviennacl on several */
101: #define VECSEQCUDA "seqcuda"
102: #define VECMPICUDA "mpicuda"
103: #define VECCUDA "cuda" /* seqcuda on one process and mpicuda on several */
104: #define VECSEQHIP "seqhip"
105: #define VECMPIHIP "mpihip"
106: #define VECHIP "hip" /* seqcuda on one process and mpicuda on several */
107: #define VECNEST "nest"
108: #define VECSEQKOKKOS "seqkokkos"
109: #define VECMPIKOKKOS "mpikokkos"
110: #define VECKOKKOS "kokkos" /* seqkokkos on one process and mpikokkos on several */
112: /* Dynamic creation and loading functions */
113: PETSC_EXTERN PetscErrorCode VecScatterSetType(VecScatter, VecScatterType);
114: PETSC_EXTERN PetscErrorCode VecScatterGetType(VecScatter, VecScatterType *);
115: PETSC_EXTERN PetscErrorCode VecScatterSetFromOptions(VecScatter);
116: PETSC_EXTERN PetscErrorCode VecScatterRegister(const char[], PetscErrorCode (*)(VecScatter));
117: PETSC_EXTERN PetscErrorCode VecScatterCreate(Vec, IS, Vec, IS, VecScatter *);
119: /* Logging support */
120: #define REAL_FILE_CLASSID 1211213
121: #define VEC_FILE_CLASSID 1211214
122: PETSC_EXTERN PetscClassId VEC_CLASSID;
123: PETSC_EXTERN PetscClassId PETSCSF_CLASSID;
125: PETSC_EXTERN PetscErrorCode VecInitializePackage(void);
126: PETSC_EXTERN PetscErrorCode VecFinalizePackage(void);
128: PETSC_EXTERN PetscErrorCode VecCreate(MPI_Comm, Vec *);
129: PETSC_EXTERN PetscErrorCode VecCreateFromOptions(MPI_Comm, const char *, PetscInt, PetscInt, PetscInt, Vec *);
130: PETSC_EXTERN PetscErrorCode VecCreateSeq(MPI_Comm, PetscInt, Vec *);
131: PETSC_EXTERN PetscErrorCode VecCreateMPI(MPI_Comm, PetscInt, PetscInt, Vec *);
132: PETSC_EXTERN PetscErrorCode VecCreateSeqWithArray(MPI_Comm, PetscInt, PetscInt, const PetscScalar[], Vec *);
133: PETSC_EXTERN PetscErrorCode VecCreateMPIWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar[], Vec *);
134: PETSC_EXTERN PetscErrorCode VecCreateShared(MPI_Comm, PetscInt, PetscInt, Vec *);
136: PETSC_EXTERN PetscErrorCode VecSetFromOptions(Vec);
137: PETSC_EXTERN PetscErrorCode VecViewFromOptions(Vec, PetscObject, const char[]);
139: PETSC_EXTERN PetscErrorCode VecSetUp(Vec);
140: PETSC_EXTERN PetscErrorCode VecDestroy(Vec *);
141: PETSC_EXTERN PetscErrorCode VecZeroEntries(Vec);
142: PETSC_EXTERN PetscErrorCode VecSetOptionsPrefix(Vec, const char[]);
143: PETSC_EXTERN PetscErrorCode VecAppendOptionsPrefix(Vec, const char[]);
144: PETSC_EXTERN PetscErrorCode VecGetOptionsPrefix(Vec, const char *[]);
146: PETSC_EXTERN PetscErrorCode VecSetSizes(Vec, PetscInt, PetscInt);
148: PETSC_EXTERN PetscErrorCode VecDotNorm2(Vec, Vec, PetscScalar *, PetscReal *);
149: PETSC_EXTERN PetscErrorCode VecDot(Vec, Vec, PetscScalar *);
150: PETSC_EXTERN PetscErrorCode VecDotRealPart(Vec, Vec, PetscReal *);
151: PETSC_EXTERN PetscErrorCode VecTDot(Vec, Vec, PetscScalar *);
152: PETSC_EXTERN PetscErrorCode VecMDot(Vec, PetscInt, const Vec[], PetscScalar[]);
153: PETSC_EXTERN PetscErrorCode VecMTDot(Vec, PetscInt, const Vec[], PetscScalar[]);
154: PETSC_EXTERN PetscErrorCode VecGetSubVector(Vec, IS, Vec *);
155: PETSC_EXTERN PetscErrorCode VecRestoreSubVector(Vec, IS, Vec *);
156: PETSC_EXTERN PetscErrorCode VecConcatenate(PetscInt, const Vec[], Vec *, IS *[]);
158: /*E
159: NormType - determines what type of norm to compute
161: Values:
162: + `NORM_1` - the one norm, ||v|| = sum_i | v_i |. ||A|| = max_j || v_*j ||, maximum column sum
163: . `NORM_2` - the two norm, ||v|| = sqrt(sum_i |v_i|^2) (vectors only)
164: . `NORM_FROBENIUS` - ||A|| = sqrt(sum_ij |A_ij|^2), same as `NORM_2` for vectors
165: . `NORM_INFINITY` - ||v|| = max_i |v_i|. ||A|| = max_i || v_i* ||, maximum row sum
166: - `NORM_1_AND_2` - computes both the 1 and 2 norm of a vector
168: Level: beginner
170: Note:
171: The `v` above represents a `Vec` while the `A` represents a `Mat`
173: .seealso: [](ch_vectors), `Vec`, `Mat`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `MatNorm()`, `NORM_1`,
174: `NORM_2`, `NORM_FROBENIUS`, `NORM_INFINITY`, `NORM_1_AND_2`
175: E*/
176: typedef enum {
177: NORM_1 = 0,
178: NORM_2 = 1,
179: NORM_FROBENIUS = 2,
180: NORM_INFINITY = 3,
181: NORM_1_AND_2 = 4
182: } NormType;
183: PETSC_EXTERN const char *const NormTypes[];
184: #define NORM_MAX NORM_INFINITY
186: /*MC
187: NORM_1 - the one norm, ||v|| = sum_i | v_i |. ||A|| = max_j || v_*j ||, maximum column sum
189: Level: beginner
191: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_2`, `NORM_FROBENIUS`,
192: `NORM_INFINITY`, `NORM_1_AND_2`
193: M*/
195: /*MC
196: NORM_2 - the two norm, ||v|| = sqrt(sum_i |v_i|^2) (vectors only)
198: Level: beginner
200: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_FROBENIUS`,
201: `NORM_INFINITY`, `NORM_1_AND_2`
202: M*/
204: /*MC
205: NORM_FROBENIUS - ||A|| = sqrt(sum_ij |A_ij|^2), same as `NORM_2` for vectors
207: Level: beginner
209: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`,
210: `NORM_INFINITY`, `NORM_1_AND_2`
211: M*/
213: /*MC
214: NORM_INFINITY - ||v|| = max_i |v_i|. ||A|| = max_i || v_i* ||, maximum row sum
216: Level: beginner
218: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`,
219: `NORM_FROBENIUS`, `NORM_1_AND_2`
220: M*/
222: /*MC
223: NORM_1_AND_2 - computes both the 1 and 2 norm of a vector. The values are stored in two adjacent `PetscReal` memory locations
225: Level: beginner
227: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`,
228: `NORM_FROBENIUS`, `NORM_INFINITY`
229: M*/
231: /*MC
232: NORM_MAX - see `NORM_INFINITY`
234: Level: beginner
235: M*/
237: /*E
238: ReductionType - determines what type of column reduction (one that is not a type of norm defined in `NormType`) to compute
240: Values:
241: + `REDUCTION_SUM_REALPART` - sum of real part of each matrix column
242: . `REDUCTION_SUM_IMAGINARYPART` - sum of imaginary part of each matrix column
243: . `REDUCTION_MEAN_REALPART` - arithmetic mean of real part of each matrix column
244: - `REDUCTION_MEAN_IMAGINARYPART` - arithmetic mean of imaginary part of each matrix column
246: Level: beginner
248: Developer Note:
249: The constants defined in `ReductionType` MUST BE DISTINCT from those defined in `NormType`.
250: This is because `MatGetColumnReductions()` is used to compute both norms and other types of reductions,
251: and the constants defined in both `NormType` and `ReductionType` are used to designate the desired operation.
253: .seealso: [](ch_vectors), `MatGetColumnReductions()`, `MatGetColumnNorms()`, `NormType`, `REDUCTION_SUM_REALPART`,
254: `REDUCTION_SUM_IMAGINARYPART`, `REDUCTION_MEAN_REALPART`, `REDUCTION_NORM_1`, `REDUCTION_NORM_2`, `REDUCTION_NORM_FROBENIUS`, `REDUCTION_NORM_INFINITY`
255: E*/
256: typedef enum {
257: REDUCTION_SUM_REALPART = 10,
258: REDUCTION_MEAN_REALPART = 11,
259: REDUCTION_SUM_IMAGINARYPART = 12,
260: REDUCTION_MEAN_IMAGINARYPART = 13
261: } ReductionType;
263: /*MC
264: REDUCTION_SUM_REALPART - sum of real part of matrix column
266: Level: beginner
268: .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_SUM_IMAGINARYPART`, `REDUCTION_MEAN_REALPART`, `REDUCTION_NORM_1`,
269: `REDUCTION_NORM_2`, `REDUCTION_NORM_FROBENIUS`, `REDUCTION_NORM_INFINITY`
270: M*/
272: /*MC
273: REDUCTION_SUM_IMAGINARYPART - sum of imaginary part of matrix column
275: Level: beginner
277: .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_SUM_REALPART`, `REDUCTION_MEAN_IMAGINARYPART`, `REDUCTION_NORM_1`,
278: `REDUCTION_NORM_2`, `REDUCTION_NORM_FROBENIUS`, `REDUCTION_NORM_INFINITY`
279: M*/
281: /*MC
282: REDUCTION_MEAN_REALPART - arithmetic mean of real part of matrix column
284: Level: beginner
286: .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_MEAN_IMAGINARYPART`, `REDUCTION_SUM_REALPART`, `REDUCTION_NORM_1`,
287: `REDUCTION_NORM_2`, `REDUCTION_NORM_FROBENIUS`, `REDUCTION_NORM_INFINITY`
288: M*/
290: /*MC
291: REDUCTION_MEAN_IMAGINARYPART - arithmetic mean of imaginary part of matrix column
293: Level: beginner
295: .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_MEAN_REALPART`, `REDUCTION_SUM_IMAGINARYPART`, `REDUCTION_NORM_1`,
296: `REDUCTION_NORM_2`, `REDUCTION_NORM_FROBENIUS`, `REDUCTION_NORM_INFINITY`
297: M*/
299: PETSC_EXTERN PetscErrorCode VecNorm(Vec, NormType, PetscReal *);
300: PETSC_EXTERN PetscErrorCode VecNormAvailable(Vec, NormType, PetscBool *, PetscReal *);
301: PETSC_EXTERN PetscErrorCode VecNormalize(Vec, PetscReal *);
302: PETSC_EXTERN PetscErrorCode VecSum(Vec, PetscScalar *);
303: PETSC_EXTERN PetscErrorCode VecMean(Vec, PetscScalar *);
304: PETSC_EXTERN PetscErrorCode VecMax(Vec, PetscInt *, PetscReal *);
305: PETSC_EXTERN PetscErrorCode VecMin(Vec, PetscInt *, PetscReal *);
306: PETSC_EXTERN PetscErrorCode VecScale(Vec, PetscScalar);
307: PETSC_EXTERN PetscErrorCode VecCopy(Vec, Vec);
308: PETSC_EXTERN PetscErrorCode VecSetRandom(Vec, PetscRandom);
309: PETSC_EXTERN PetscErrorCode VecSet(Vec, PetscScalar);
310: PETSC_EXTERN PetscErrorCode VecSetInf(Vec);
311: PETSC_EXTERN PetscErrorCode VecSwap(Vec, Vec);
312: PETSC_EXTERN PetscErrorCode VecAXPY(Vec, PetscScalar, Vec);
313: PETSC_EXTERN PetscErrorCode VecAXPBY(Vec, PetscScalar, PetscScalar, Vec);
314: PETSC_EXTERN PetscErrorCode VecMAXPY(Vec, PetscInt, const PetscScalar[], Vec[]);
315: PETSC_EXTERN PetscErrorCode VecMAXPBY(Vec, PetscInt, const PetscScalar[], PetscScalar, Vec[]);
316: PETSC_EXTERN PetscErrorCode VecAYPX(Vec, PetscScalar, Vec);
317: PETSC_EXTERN PetscErrorCode VecWAXPY(Vec, PetscScalar, Vec, Vec);
318: PETSC_EXTERN PetscErrorCode VecAXPBYPCZ(Vec, PetscScalar, PetscScalar, PetscScalar, Vec, Vec);
319: PETSC_EXTERN PetscErrorCode VecPointwiseMax(Vec, Vec, Vec);
320: PETSC_EXTERN PetscErrorCode VecPointwiseMaxAbs(Vec, Vec, Vec);
321: PETSC_EXTERN PetscErrorCode VecPointwiseMin(Vec, Vec, Vec);
322: PETSC_EXTERN PetscErrorCode VecPointwiseMult(Vec, Vec, Vec);
323: PETSC_EXTERN PetscErrorCode VecPointwiseDivide(Vec, Vec, Vec);
324: PETSC_EXTERN PetscErrorCode VecMaxPointwiseDivide(Vec, Vec, PetscReal *);
325: PETSC_EXTERN PetscErrorCode VecShift(Vec, PetscScalar);
326: PETSC_EXTERN PetscErrorCode VecReciprocal(Vec);
327: PETSC_EXTERN PetscErrorCode VecPermute(Vec, IS, PetscBool);
328: PETSC_EXTERN PetscErrorCode VecSqrtAbs(Vec);
329: PETSC_EXTERN PetscErrorCode VecLog(Vec);
330: PETSC_EXTERN PetscErrorCode VecExp(Vec);
331: PETSC_EXTERN PetscErrorCode VecAbs(Vec);
332: PETSC_EXTERN PetscErrorCode VecDuplicate(Vec, Vec *);
333: PETSC_EXTERN PetscErrorCode VecDuplicateVecs(Vec, PetscInt, Vec *[]);
334: PETSC_EXTERN PetscErrorCode VecDestroyVecs(PetscInt, Vec *[]);
335: PETSC_EXTERN PetscErrorCode VecStrideNormAll(Vec, NormType, PetscReal[]);
336: PETSC_EXTERN PetscErrorCode VecStrideMaxAll(Vec, PetscInt[], PetscReal[]);
337: PETSC_EXTERN PetscErrorCode VecStrideMinAll(Vec, PetscInt[], PetscReal[]);
338: PETSC_EXTERN PetscErrorCode VecStrideScaleAll(Vec, const PetscScalar[]);
339: PETSC_EXTERN PetscErrorCode VecStrideSumAll(Vec, PetscScalar *);
340: PETSC_EXTERN PetscErrorCode VecUniqueEntries(Vec, PetscInt *, PetscScalar **);
342: PETSC_EXTERN PetscErrorCode VecStrideNorm(Vec, PetscInt, NormType, PetscReal *);
343: PETSC_EXTERN PetscErrorCode VecStrideMax(Vec, PetscInt, PetscInt *, PetscReal *);
344: PETSC_EXTERN PetscErrorCode VecStrideMin(Vec, PetscInt, PetscInt *, PetscReal *);
345: PETSC_EXTERN PetscErrorCode VecStrideScale(Vec, PetscInt, PetscScalar);
346: PETSC_EXTERN PetscErrorCode VecStrideSum(Vec, PetscInt, PetscScalar *);
347: PETSC_EXTERN PetscErrorCode VecStrideSet(Vec, PetscInt, PetscScalar);
349: PETSC_EXTERN PetscErrorCode VecStrideGather(Vec, PetscInt, Vec, InsertMode);
350: PETSC_EXTERN PetscErrorCode VecStrideScatter(Vec, PetscInt, Vec, InsertMode);
351: PETSC_EXTERN PetscErrorCode VecStrideGatherAll(Vec, Vec[], InsertMode);
352: PETSC_EXTERN PetscErrorCode VecStrideScatterAll(Vec[], Vec, InsertMode);
354: PETSC_EXTERN PetscErrorCode VecStrideSubSetScatter(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);
355: PETSC_EXTERN PetscErrorCode VecStrideSubSetGather(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);
357: PETSC_EXTERN PetscErrorCode VecSetValues(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
358: PETSC_EXTERN PetscErrorCode VecGetValues(Vec, PetscInt, const PetscInt[], PetscScalar[]);
359: PETSC_EXTERN PetscErrorCode VecAssemblyBegin(Vec);
360: PETSC_EXTERN PetscErrorCode VecAssemblyEnd(Vec);
361: PETSC_EXTERN PetscErrorCode VecStashSetInitialSize(Vec, PetscInt, PetscInt);
362: PETSC_EXTERN PetscErrorCode VecStashView(Vec, PetscViewer);
363: PETSC_EXTERN PetscErrorCode VecStashViewFromOptions(Vec, PetscObject, const char[]);
364: PETSC_EXTERN PetscErrorCode VecStashGetInfo(Vec, PetscInt *, PetscInt *, PetscInt *, PetscInt *);
366: PETSC_EXTERN PetscErrorCode VecSetPreallocationCOO(Vec, PetscCount, const PetscInt[]);
367: PETSC_EXTERN PetscErrorCode VecSetPreallocationCOOLocal(Vec, PetscCount, PetscInt[]);
368: PETSC_EXTERN PetscErrorCode VecSetValuesCOO(Vec, const PetscScalar[], InsertMode);
370: /*MC
371: VecSetValue - Set a single entry into a vector.
373: Synopsis:
374: #include <petscvec.h>
375: PetscErrorCode VecSetValue(Vec v,PetscInt row,PetscScalar value, InsertMode mode);
377: Not Collective
379: Input Parameters:
380: + v - the vector
381: . row - the row location of the entry
382: . value - the value to insert
383: - mode - either `INSERT_VALUES` or `ADD_VALUES`
385: Level: beginner
387: Notes:
388: For efficiency one should use `VecSetValues()` and set several or
389: many values simultaneously if possible.
391: These values may be cached, so `VecAssemblyBegin()` and `VecAssemblyEnd()`
392: MUST be called after all calls to `VecSetValue()` have been completed.
394: `VecSetValue()` uses 0-based indices in Fortran as well as in C.
396: .seealso: [](ch_vectors), `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `VecSetValuesBlockedLocal()`, `VecSetValueLocal()`
397: M*/
398: static inline PetscErrorCode VecSetValue(Vec v, PetscInt i, PetscScalar va, InsertMode mode)
399: {
400: return VecSetValues(v, 1, &i, &va, mode);
401: }
403: PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec, PetscInt);
404: PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec, PetscInt *);
405: PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
407: /* Dynamic creation and loading functions */
408: PETSC_EXTERN PetscFunctionList VecList;
409: PETSC_EXTERN PetscErrorCode VecSetType(Vec, VecType);
410: PETSC_EXTERN PetscErrorCode VecGetType(Vec, VecType *);
411: PETSC_EXTERN PetscErrorCode VecRegister(const char[], PetscErrorCode (*)(Vec));
412: PETSC_EXTERN PetscErrorCode VecRegisterAll(void);
414: PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter, Vec, Vec, InsertMode, ScatterMode);
415: PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter, Vec, Vec, InsertMode, ScatterMode);
416: PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter *);
417: PETSC_EXTERN PetscErrorCode VecScatterSetUp(VecScatter);
418: PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter, VecScatter *);
419: PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter, PetscViewer);
420: PETSC_EXTERN PetscErrorCode VecScatterViewFromOptions(VecScatter, PetscObject, const char[]);
421: PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter, PetscInt[], PetscInt[]);
422: PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter, PetscBool *);
424: PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
425: PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
426: PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
427: PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
428: PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
429: PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
430: PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec, PetscInt, PetscInt, PetscScalar *[]);
431: PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec, PetscInt, PetscInt, PetscScalar *[]);
433: PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
434: PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
435: PETSC_EXTERN PetscErrorCode VecRestoreArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
436: PETSC_EXTERN PetscErrorCode VecGetArray3dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
437: PETSC_EXTERN PetscErrorCode VecRestoreArray3dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
438: PETSC_EXTERN PetscErrorCode VecGetArray2dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
439: PETSC_EXTERN PetscErrorCode VecRestoreArray2dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
440: PETSC_EXTERN PetscErrorCode VecGetArray1dWrite(Vec, PetscInt, PetscInt, PetscScalar *[]);
441: PETSC_EXTERN PetscErrorCode VecRestoreArray1dWrite(Vec, PetscInt, PetscInt, PetscScalar *[]);
443: PETSC_EXTERN PetscErrorCode VecGetArray4dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
444: PETSC_EXTERN PetscErrorCode VecRestoreArray4dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
445: PETSC_EXTERN PetscErrorCode VecGetArray3dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
446: PETSC_EXTERN PetscErrorCode VecRestoreArray3dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
447: PETSC_EXTERN PetscErrorCode VecGetArray2dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
448: PETSC_EXTERN PetscErrorCode VecRestoreArray2dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
449: PETSC_EXTERN PetscErrorCode VecGetArray1dRead(Vec, PetscInt, PetscInt, PetscScalar *[]);
450: PETSC_EXTERN PetscErrorCode VecRestoreArray1dRead(Vec, PetscInt, PetscInt, PetscScalar *[]);
452: PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec, const PetscScalar[]);
453: PETSC_EXTERN PetscErrorCode VecResetArray(Vec);
454: PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec, const PetscScalar[]);
456: PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[], PetscInt, PetscScalar **[]);
457: PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[], PetscInt, PetscScalar **[]);
459: PETSC_EXTERN PetscErrorCode VecView(Vec, PetscViewer);
460: PETSC_EXTERN PetscErrorCode VecViewNative(Vec, PetscViewer);
461: PETSC_EXTERN PetscErrorCode VecEqual(Vec, Vec, PetscBool *);
462: PETSC_EXTERN PetscErrorCode VecLoad(Vec, PetscViewer);
464: PETSC_EXTERN PetscErrorCode VecGetSize(Vec, PetscInt *);
465: PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec, PetscInt *);
466: PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec, PetscInt *, PetscInt *);
467: PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec, const PetscInt *[]);
469: PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping);
470: PETSC_EXTERN PetscErrorCode VecSetValuesLocal(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
472: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLContext(Vec, PETSC_UINTPTR_T *);
473: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLQueue(Vec, PETSC_UINTPTR_T *);
474: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemRead(Vec, PETSC_UINTPTR_T *);
475: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemWrite(Vec, PETSC_UINTPTR_T *);
476: PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMemWrite(Vec);
477: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMem(Vec, PETSC_UINTPTR_T *);
478: PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMem(Vec);
480: /*MC
481: VecSetValueLocal - Set a single entry into a vector using the local numbering, see `VecSetValuesLocal()`
483: Synopsis:
484: #include <petscvec.h>
485: PetscErrorCode VecSetValueLocal(Vec v,PetscInt row,PetscScalar value, InsertMode mode);
487: Not Collective
489: Input Parameters:
490: + v - the vector
491: . row - the row location of the entry
492: . value - the value to insert
493: - mode - either `INSERT_VALUES` or `ADD_VALUES`
495: Level: beginner
497: Notes:
498: For efficiency one should use `VecSetValuesLocal()` and set several or
499: many values simultaneously if possible.
501: These values may be cached, so `VecAssemblyBegin()` and `VecAssemblyEnd()`
502: MUST be called after all calls to `VecSetValueLocal()` have been completed.
504: `VecSetValues()` uses 0-based indices in Fortran as well as in C.
506: .seealso: [](ch_vectors), `VecSetValuesLocal()`, `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `VecSetValuesBlockedLocal()`, `VecSetValue()`
507: M*/
508: static inline PetscErrorCode VecSetValueLocal(Vec v, PetscInt i, PetscScalar va, InsertMode mode)
509: {
510: return VecSetValuesLocal(v, 1, &i, &va, mode);
511: }
513: /*MC
514: VecCheckAssembled - checks if values have been changed in the vector, by `VecSetValues()` or related routines, but it has not been assembled
516: Synopsis:
517: #include <petscvec.h>
518: VecCheckAssembled(Vec v);
520: Not Collective
522: Input Parameter:
523: . v - the vector to check
525: Level: developer
527: Note:
528: After calls to `VecSetValues()` and related routines on must call ``VecAssemblyBegin()` and `VecAssemblyEnd()` before using the vector
530: .seealso: [](ch_vectors), `Vec`, `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `MatAssemblyBegin()`, `MatAssemblyEnd()`
531: M*/
532: #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()?")
534: PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
535: PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping *);
537: PETSC_EXTERN PetscErrorCode VecDotBegin(Vec, Vec, PetscScalar *);
538: PETSC_EXTERN PetscErrorCode VecDotEnd(Vec, Vec, PetscScalar *);
539: PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec, Vec, PetscScalar *);
540: PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec, Vec, PetscScalar *);
541: PETSC_EXTERN PetscErrorCode VecNormBegin(Vec, NormType, PetscReal *);
542: PETSC_EXTERN PetscErrorCode VecNormEnd(Vec, NormType, PetscReal *);
543: PETSC_EXTERN PetscErrorCode VecErrorWeightedNorms(Vec, Vec, Vec, NormType, PetscReal, Vec, PetscReal, Vec, PetscReal, PetscReal *, PetscInt *, PetscReal *, PetscInt *, PetscReal *, PetscInt *);
545: PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec, PetscInt, const Vec[], PetscScalar[]);
546: PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec, PetscInt, const Vec[], PetscScalar[]);
547: PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec, PetscInt, const Vec[], PetscScalar[]);
548: PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec, PetscInt, const Vec[], PetscScalar[]);
549: PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm);
551: PETSC_EXTERN PetscErrorCode VecBindToCPU(Vec, PetscBool);
552: PETSC_DEPRECATED_FUNCTION(3, 13, 0, "VecBindToCPU()", ) static inline PetscErrorCode VecPinToCPU(Vec v, PetscBool flg)
553: {
554: return VecBindToCPU(v, flg);
555: }
556: PETSC_EXTERN PetscErrorCode VecBoundToCPU(Vec, PetscBool *);
557: PETSC_EXTERN PetscErrorCode VecSetBindingPropagates(Vec, PetscBool);
558: PETSC_EXTERN PetscErrorCode VecGetBindingPropagates(Vec, PetscBool *);
559: PETSC_EXTERN PetscErrorCode VecSetPinnedMemoryMin(Vec, size_t);
560: PETSC_EXTERN PetscErrorCode VecGetPinnedMemoryMin(Vec, size_t *);
562: PETSC_EXTERN PetscErrorCode VecGetOffloadMask(Vec, PetscOffloadMask *);
564: typedef enum {
565: VEC_IGNORE_OFF_PROC_ENTRIES,
566: VEC_IGNORE_NEGATIVE_INDICES,
567: VEC_SUBSET_OFF_PROC_ENTRIES
568: } VecOption;
569: PETSC_EXTERN PetscErrorCode VecSetOption(Vec, VecOption, PetscBool);
571: PETSC_EXTERN PetscErrorCode VecGetArray(Vec, PetscScalar **);
572: PETSC_EXTERN PetscErrorCode VecGetArrayWrite(Vec, PetscScalar **);
573: PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec, const PetscScalar **);
574: PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec, PetscScalar **);
575: PETSC_EXTERN PetscErrorCode VecRestoreArrayWrite(Vec, PetscScalar **);
576: PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec, const PetscScalar **);
577: PETSC_EXTERN PetscErrorCode VecCreateLocalVector(Vec, Vec *);
578: PETSC_EXTERN PetscErrorCode VecGetLocalVector(Vec, Vec);
579: PETSC_EXTERN PetscErrorCode VecRestoreLocalVector(Vec, Vec);
580: PETSC_EXTERN PetscErrorCode VecGetLocalVectorRead(Vec, Vec);
581: PETSC_EXTERN PetscErrorCode VecRestoreLocalVectorRead(Vec, Vec);
582: PETSC_EXTERN PetscErrorCode VecGetArrayAndMemType(Vec, PetscScalar **, PetscMemType *);
583: PETSC_EXTERN PetscErrorCode VecRestoreArrayAndMemType(Vec, PetscScalar **);
584: PETSC_EXTERN PetscErrorCode VecGetArrayReadAndMemType(Vec, const PetscScalar **, PetscMemType *);
585: PETSC_EXTERN PetscErrorCode VecRestoreArrayReadAndMemType(Vec, const PetscScalar **);
586: PETSC_EXTERN PetscErrorCode VecGetArrayWriteAndMemType(Vec, PetscScalar **, PetscMemType *);
587: PETSC_EXTERN PetscErrorCode VecRestoreArrayWriteAndMemType(Vec, PetscScalar **);
589: /*@C
590: VecGetArrayPair - Accesses a pair of pointers for two vectors that may be common. When not common the first pointer is read only
592: Logically Collective; No Fortran Support
594: Input Parameters:
595: + x - the vector
596: - y - the second vector
598: Output Parameters:
599: + xv - location to put pointer to the first array
600: - yv - location to put pointer to the second array
602: Level: developer
604: .seealso: [](ch_vectors), `VecGetArray()`, `VecGetArrayRead()`, `VecRestoreArrayPair()`
605: @*/
606: static inline PetscErrorCode VecGetArrayPair(Vec x, Vec y, PetscScalar **xv, PetscScalar **yv)
607: {
608: PetscFunctionBegin;
609: PetscCall(VecGetArray(y, yv));
610: if (x == y) *xv = *yv;
611: else PetscCall(VecGetArrayRead(x, (const PetscScalar **)xv));
612: PetscFunctionReturn(PETSC_SUCCESS);
613: }
615: /*@C
616: VecRestoreArrayPair - Returns a pair of pointers for two vectors that may be common obtained with `VecGetArrayPair()`
618: Logically Collective; No Fortran Support
620: Input Parameters:
621: + x - the vector
622: . y - the second vector
623: . xv - location to put pointer to the first array
624: - yv - location to put pointer to the second array
626: Level: developer
628: .seealso: [](ch_vectors), `VecGetArray()`, `VecGetArrayRead()`, `VecGetArrayPair()`
629: @*/
630: static inline PetscErrorCode VecRestoreArrayPair(Vec x, Vec y, PetscScalar **xv, PetscScalar **yv)
631: {
632: PetscFunctionBegin;
633: PetscCall(VecRestoreArray(y, yv));
634: if (x != y) PetscCall(VecRestoreArrayRead(x, (const PetscScalar **)xv));
635: PetscFunctionReturn(PETSC_SUCCESS);
636: }
638: #if PetscDefined(USE_DEBUG)
639: PETSC_EXTERN PetscErrorCode VecLockReadPush(Vec);
640: PETSC_EXTERN PetscErrorCode VecLockReadPop(Vec);
641: PETSC_EXTERN PetscErrorCode VecLockWriteSet(Vec, PetscBool);
642: PETSC_EXTERN PetscErrorCode VecLockGet(Vec, PetscInt *);
643: PETSC_EXTERN PetscErrorCode VecLockGetLocation(Vec, const char *[], const char *[], int *);
644: static inline PetscErrorCode VecSetErrorIfLocked(Vec x, PetscInt arg)
645: {
646: PetscInt state;
648: PetscFunctionBegin;
649: PetscCall(VecLockGet(x, &state));
650: if (PetscUnlikely(state != 0)) {
651: const char *file, *func, *name;
652: int line;
654: PetscCall(VecLockGetLocation(x, &file, &func, &line));
655: PetscCall(PetscObjectGetName((PetscObject)x, &name));
656: 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);
657: }
658: PetscFunctionReturn(PETSC_SUCCESS);
659: }
660: /* The three are deprecated */
661: PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 11, 0, "VecLockReadPush()", ) PetscErrorCode VecLockPush(Vec);
662: PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 11, 0, "VecLockReadPop()", ) PetscErrorCode VecLockPop(Vec);
663: #define VecLocked(x, arg) VecSetErrorIfLocked(x, arg) PETSC_DEPRECATED_MACRO(3, 11, 0, "VecSetErrorIfLocked()", )
664: #else
665: #define VecLockReadPush(x) PETSC_SUCCESS
666: #define VecLockReadPop(x) PETSC_SUCCESS
667: #define VecLockGet(x, s) (*(s) = 0, PETSC_SUCCESS)
668: #define VecSetErrorIfLocked(x, arg) PETSC_SUCCESS
669: #define VecLockWriteSet(x, flg) PETSC_SUCCESS
670: /* The three are deprecated */
671: #define VecLockPush(x) PETSC_SUCCESS
672: #define VecLockPop(x) PETSC_SUCCESS
673: #define VecLocked(x, arg) PETSC_SUCCESS
674: #endif
676: /*E
677: VecOperation - Enumeration of overide-able methods in the `Vec` implementation function-table.
679: Values:
680: + `VECOP_DUPLICATE` - `VecDuplicate()`
681: . `VECOP_SET` - `VecSet()`
682: . `VECOP_VIEW` - `VecView()`
683: . `VECOP_LOAD` - `VecLoad()`
684: . `VECOP_VIEWNATIVE` - `VecViewNative()`
685: - `VECOP_LOADNATIVE` - `VecLoadNative()`
687: Level: advanced
689: Notes:
690: Some operations may serve as the implementation for other routines not listed above. For
691: example `VECOP_SET` can be used to simultaneously overriding the implementation used in
692: `VecSet()`, `VecSetInf()`, and `VecZeroEntries()`.
694: Entries to `VecOperation` are added as needed so if you do not see the operation listed which
695: you'd like to replace, please send mail to `petsc-maint@mcs.anl.gov`!
697: .seealso: [](ch_vectors), `Vec`, `VecSetOperation()`
698: E*/
699: typedef enum {
700: VECOP_DUPLICATE = 0,
701: VECOP_SET = 10,
702: VECOP_VIEW = 33,
703: VECOP_LOAD = 41,
704: VECOP_VIEWNATIVE = 68,
705: VECOP_LOADNATIVE = 69
706: } VecOperation;
707: PETSC_EXTERN PetscErrorCode VecSetOperation(Vec, VecOperation, void (*)(void));
709: /*
710: Routines for dealing with ghosted vectors:
711: vectors with ghost elements at the end of the array.
712: */
713: PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec, PetscInt, const PetscInt[]);
714: PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Vec *);
715: PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscScalar[], Vec *);
716: PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Vec *);
717: PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscScalar[], Vec *);
718: PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec, Vec *);
719: PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec, Vec *);
720: PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec, Vec, PetscBool *);
721: PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec, InsertMode, ScatterMode);
722: PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec, InsertMode, ScatterMode);
724: PETSC_EXTERN PetscErrorCode VecConjugate(Vec);
725: PETSC_EXTERN PetscErrorCode VecImaginaryPart(Vec);
726: PETSC_EXTERN PetscErrorCode VecRealPart(Vec);
728: PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec, VecScatter *, Vec *);
729: PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec, VecScatter *, Vec *);
731: PETSC_EXTERN PetscErrorCode ISComplementVec(IS, Vec, IS *);
732: PETSC_EXTERN PetscErrorCode VecPow(Vec, PetscScalar);
733: PETSC_EXTERN PetscErrorCode VecMedian(Vec, Vec, Vec, Vec);
734: PETSC_EXTERN PetscErrorCode VecWhichInactive(Vec, Vec, Vec, Vec, PetscBool, IS *);
735: PETSC_EXTERN PetscErrorCode VecWhichBetween(Vec, Vec, Vec, IS *);
736: PETSC_EXTERN PetscErrorCode VecWhichBetweenOrEqual(Vec, Vec, Vec, IS *);
737: PETSC_EXTERN PetscErrorCode VecWhichGreaterThan(Vec, Vec, IS *);
738: PETSC_EXTERN PetscErrorCode VecWhichLessThan(Vec, Vec, IS *);
739: PETSC_EXTERN PetscErrorCode VecWhichEqual(Vec, Vec, IS *);
740: PETSC_EXTERN PetscErrorCode VecISAXPY(Vec, IS, PetscScalar, Vec);
741: PETSC_EXTERN PetscErrorCode VecISCopy(Vec, IS, ScatterMode, Vec);
742: PETSC_EXTERN PetscErrorCode VecISSet(Vec, IS, PetscScalar);
743: PETSC_EXTERN PetscErrorCode VecBoundGradientProjection(Vec, Vec, Vec, Vec, Vec);
744: PETSC_EXTERN PetscErrorCode VecStepBoundInfo(Vec, Vec, Vec, Vec, PetscReal *, PetscReal *, PetscReal *);
745: PETSC_EXTERN PetscErrorCode VecStepMax(Vec, Vec, PetscReal *);
746: PETSC_EXTERN PetscErrorCode VecStepMaxBounded(Vec, Vec, Vec, Vec, PetscReal *);
748: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec);
749: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec);
751: /*S
752: Vecs - Collection of vectors where the data for the vectors is stored in
753: one contiguous memory
755: Level: advanced
757: Notes:
758: Temporary construct for handling multiply right hand side solves
760: This is faked by storing a single vector that has enough array space for
761: n vectors
763: S*/
764: struct _n_Vecs {
765: PetscInt n;
766: Vec v;
767: };
768: typedef struct _n_Vecs *Vecs;
769: PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs);
770: PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm, PetscInt, PetscInt, Vecs *);
771: PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm, PetscInt, PetscInt, PetscScalar *, Vecs *);
772: PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs, Vecs *);
774: #if PetscDefined(HAVE_VIENNACL)
775: typedef struct _p_PetscViennaCLIndices *PetscViennaCLIndices;
776: PETSC_EXTERN PetscErrorCode VecViennaCLCopyToGPUSome_Public(Vec, PetscViennaCLIndices);
777: PETSC_EXTERN PetscErrorCode VecViennaCLCopyFromGPUSome_Public(Vec, PetscViennaCLIndices);
778: PETSC_EXTERN PetscErrorCode VecCreateSeqViennaCL(MPI_Comm, PetscInt, Vec *);
779: PETSC_EXTERN PetscErrorCode VecCreateMPIViennaCL(MPI_Comm, PetscInt, PetscInt, Vec *);
780: #endif
781: #if PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)
782: PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter, Vec);
783: PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter);
784: #endif
785: #if PetscDefined(HAVE_KOKKOS_KERNELS)
786: PETSC_EXTERN PetscErrorCode VecCreateSeqKokkos(MPI_Comm, PetscInt, Vec *);
787: PETSC_EXTERN PetscErrorCode VecCreateSeqKokkosWithArray(MPI_Comm, PetscInt, PetscInt, const PetscScalar *, Vec *);
788: PETSC_EXTERN PetscErrorCode VecCreateMPIKokkos(MPI_Comm, PetscInt, PetscInt, Vec *);
789: PETSC_EXTERN PetscErrorCode VecCreateMPIKokkosWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar *, Vec *);
790: #endif
792: PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec, PetscInt *, Vec **);
793: PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec, PetscInt, Vec *);
794: PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec, PetscInt, PetscInt *, Vec *);
795: PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec, PetscInt, Vec);
796: PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm, PetscInt, IS *, Vec *, Vec *);
797: PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec, PetscInt *);
799: PETSC_EXTERN PetscErrorCode PetscOptionsGetVec(PetscOptions, const char[], const char[], Vec, PetscBool *);
800: PETSC_EXTERN PetscErrorCode VecFilter(Vec, PetscReal);
801: PETSC_DEPRECATED_FUNCTION(3, 20, 0, "VecFilter()", ) static inline PetscErrorCode VecChop(Vec v, PetscReal tol)
802: {
803: return VecFilter(v, tol);
804: }
806: PETSC_EXTERN PetscErrorCode VecGetLayout(Vec, PetscLayout *);
807: PETSC_EXTERN PetscErrorCode VecSetLayout(Vec, PetscLayout);
809: PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer);
810: PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar **);
811: PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, const PetscScalar[], InsertMode);
812: PETSC_EXTERN PetscErrorCode PetscSectionVecNorm(PetscSection, PetscSection, Vec, NormType, PetscReal[]);
814: /*S
815: VecTagger - Object used to manage the tagging of a subset of indices based on the values of a vector. The
816: motivating application is the selection of cells for refinement or coarsening based on vector containing
817: the values in an error indicator metric.
819: Values:
820: + `VECTAGGERABSOLUTE` - "absolute" values are in a interval (box for complex values) of explicitly defined values
821: . `VECTAGGERRELATIVE` - "relative" values are in a interval (box for complex values) of values relative to the set of all values in the vector
822: . `VECTAGGERCDF` - "cdf" values are in a relative range of the *cumulative distribution* of values in the vector
823: . `VECTAGGEROR` - "or" values are in the union of other tags
824: - `VECTAGGERAND` - "and" values are in the intersection of other tags
826: Level: advanced
828: Developer Note:
829: Why not use a `DMLabel` or similar object
831: .seealso: [](ch_vectors), `Vec`, `VecTaggerType`, `VecTaggerCreate()`
832: S*/
833: typedef struct _p_VecTagger *VecTagger;
835: /*J
836: VecTaggerType - String with the name of a `VecTagger` type
838: Level: advanced
840: .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerCreate()`
841: J*/
842: typedef const char *VecTaggerType;
843: #define VECTAGGERABSOLUTE "absolute"
844: #define VECTAGGERRELATIVE "relative"
845: #define VECTAGGERCDF "cdf"
846: #define VECTAGGEROR "or"
847: #define VECTAGGERAND "and"
849: PETSC_EXTERN PetscClassId VEC_TAGGER_CLASSID;
850: PETSC_EXTERN PetscFunctionList VecTaggerList;
851: PETSC_EXTERN PetscErrorCode VecTaggerRegister(const char[], PetscErrorCode (*)(VecTagger));
852: PETSC_EXTERN PetscErrorCode VecTaggerRegisterAll(void);
854: PETSC_EXTERN PetscErrorCode VecTaggerCreate(MPI_Comm, VecTagger *);
855: PETSC_EXTERN PetscErrorCode VecTaggerSetBlockSize(VecTagger, PetscInt);
856: PETSC_EXTERN PetscErrorCode VecTaggerGetBlockSize(VecTagger, PetscInt *);
857: PETSC_EXTERN PetscErrorCode VecTaggerSetType(VecTagger, VecTaggerType);
858: PETSC_EXTERN PetscErrorCode VecTaggerGetType(VecTagger, VecTaggerType *);
859: PETSC_EXTERN PetscErrorCode VecTaggerSetInvert(VecTagger, PetscBool);
860: PETSC_EXTERN PetscErrorCode VecTaggerGetInvert(VecTagger, PetscBool *);
861: PETSC_EXTERN PetscErrorCode VecTaggerSetFromOptions(VecTagger);
862: PETSC_EXTERN PetscErrorCode VecTaggerSetUp(VecTagger);
863: PETSC_EXTERN PetscErrorCode VecTaggerView(VecTagger, PetscViewer);
864: PETSC_EXTERN PetscErrorCode VecTaggerComputeIS(VecTagger, Vec, IS *, PetscBool *);
865: PETSC_EXTERN PetscErrorCode VecTaggerDestroy(VecTagger *);
867: /*S
868: VecTaggerBox - A interval (box for complex numbers) range used to tag values. For real scalars, this is just a closed interval; for complex scalars,
869: 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.
871: Level: beginner
873: .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerType`, `VecTaggerCreate()`, `VecTaggerComputeIntervals()`
874: S*/
875: typedef struct {
876: PetscScalar min;
877: PetscScalar max;
878: } VecTaggerBox;
879: PETSC_EXTERN PetscErrorCode VecTaggerComputeBoxes(VecTagger, Vec, PetscInt *, VecTaggerBox **, PetscBool *);
881: PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteSetBox(VecTagger, VecTaggerBox *);
882: PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteGetBox(VecTagger, const VecTaggerBox **);
884: PETSC_EXTERN PetscErrorCode VecTaggerRelativeSetBox(VecTagger, VecTaggerBox *);
885: PETSC_EXTERN PetscErrorCode VecTaggerRelativeGetBox(VecTagger, const VecTaggerBox **);
887: PETSC_EXTERN PetscErrorCode VecTaggerCDFSetBox(VecTagger, VecTaggerBox *);
888: PETSC_EXTERN PetscErrorCode VecTaggerCDFGetBox(VecTagger, const VecTaggerBox **);
890: /*E
891: 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).
893: Values:
894: + `VECTAGGER_CDF_GATHER` - gather results to rank 0, perform the computation and broadcast the result
895: - `VECTAGGER_CDF_ITERATIVE` - compute the results on all ranks iteratively using `MPI_Allreduce()`
897: Level: advanced
899: Note:
900: Relevant only in parallel: in serial it is directly computed.
902: .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerType`, `VecTaggerCreate()`, `VecTaggerCDFSetMethod()`, `VecTaggerCDFMethods`
903: E*/
904: typedef enum {
905: VECTAGGER_CDF_GATHER,
906: VECTAGGER_CDF_ITERATIVE,
907: VECTAGGER_CDF_NUM_METHODS
908: } VecTaggerCDFMethod;
909: PETSC_EXTERN const char *const VecTaggerCDFMethods[];
911: PETSC_EXTERN PetscErrorCode VecTaggerCDFSetMethod(VecTagger, VecTaggerCDFMethod);
912: PETSC_EXTERN PetscErrorCode VecTaggerCDFGetMethod(VecTagger, VecTaggerCDFMethod *);
913: PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeSetTolerances(VecTagger, PetscInt, PetscReal, PetscReal);
914: PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeGetTolerances(VecTagger, PetscInt *, PetscReal *, PetscReal *);
916: PETSC_EXTERN PetscErrorCode VecTaggerOrSetSubs(VecTagger, PetscInt, VecTagger *, PetscCopyMode);
917: PETSC_EXTERN PetscErrorCode VecTaggerOrGetSubs(VecTagger, PetscInt *, VecTagger **);
919: PETSC_EXTERN PetscErrorCode VecTaggerAndSetSubs(VecTagger, PetscInt, VecTagger *, PetscCopyMode);
920: PETSC_EXTERN PetscErrorCode VecTaggerAndGetSubs(VecTagger, PetscInt *, VecTagger **);
922: PETSC_EXTERN PetscErrorCode VecTaggerInitializePackage(void);
923: PETSC_EXTERN PetscErrorCode VecTaggerFinalizePackage(void);
925: #if PetscDefined(USE_DEBUG)
926: /* This is an internal debug-only routine that should not be used by users */
927: PETSC_SINGLE_LIBRARY_INTERN PetscErrorCode VecValidValues_Internal(Vec, PetscInt, PetscBool);
928: #else
929: #define VecValidValues_Internal(...) PETSC_SUCCESS
930: #endif /* PETSC_USE_DEBUG */
932: #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)
934: #if PetscDefined(HAVE_CUDA)
935: #define VEC_CUDA_DECL_OR_STUB(__decl__, ...) PETSC_EXTERN __decl__;
936: #else
937: #define VEC_CUDA_DECL_OR_STUB(__decl__, ...) \
938: static inline __decl__ \
939: { \
940: __VA_ARGS__; \
941: VEC_CUPM_NOT_CONFIGURED(cuda); \
942: }
943: #endif /* PETSC_HAVE_CUDA */
945: /* extra underscore here to make it line up with the cuda versions */
946: #if PetscDefined(HAVE_HIP)
947: #define VEC_HIP__DECL_OR_STUB(__decl__, ...) PETSC_EXTERN __decl__;
948: #else
949: #define VEC_HIP__DECL_OR_STUB(__decl__, ...) \
950: static inline __decl__ \
951: { \
952: __VA_ARGS__; \
953: VEC_CUPM_NOT_CONFIGURED(hip); \
954: }
955: #endif /* PETSC_HAVE_HIP */
957: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateSeqCUDA(MPI_Comm a, PetscInt b, Vec *c), (void)a, (void)b, (void)c)
958: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateSeqHIP(MPI_Comm a, PetscInt b, Vec *c), (void)a, (void)b, (void)c)
960: 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)
961: 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)
963: 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)
964: 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)
966: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateMPICUDA(MPI_Comm a, PetscInt b, PetscInt c, Vec *d), (void)a, (void)b, (void)c, (void)d)
967: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateMPIHIP(MPI_Comm a, PetscInt b, PetscInt c, Vec *d), (void)a, (void)b, (void)c, (void)d)
969: 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)
970: 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)
972: 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)
973: 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)
975: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArray(Vec a, PetscScalar **b), (void)a, (void)b)
976: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArray(Vec a, PetscScalar **b), (void)a, (void)b)
978: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArray(Vec a, PetscScalar **b), (void)a, (void)b)
979: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArray(Vec a, PetscScalar **b), (void)a, (void)b)
981: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArrayRead(Vec a, const PetscScalar **b), (void)a, (void)b)
982: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArrayRead(Vec a, const PetscScalar **b), (void)a, (void)b)
984: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArrayRead(Vec a, const PetscScalar **b), (void)a, (void)b)
985: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArrayRead(Vec a, const PetscScalar **b), (void)a, (void)b)
987: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArrayWrite(Vec a, PetscScalar **b), (void)a, (void)b)
988: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArrayWrite(Vec a, PetscScalar **b), (void)a, (void)b)
990: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArrayWrite(Vec a, PetscScalar **b), (void)a, (void)b)
991: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArrayWrite(Vec a, PetscScalar **b), (void)a, (void)b)
993: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAPlaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b)
994: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPPlaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b)
996: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAReplaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b)
997: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPReplaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b)
999: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAResetArray(Vec a), (void)a)
1000: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPResetArray(Vec a), (void)a)
1002: #undef VEC_CUPM_NOT_CONFIGURED
1003: #undef VEC_CUDA_DECL_OR_STUB
1004: #undef VEC_HIP__DECL_OR_STUB