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: #ifndef PETSCVEC_H
7: #define PETSCVEC_H
9: #include <petscsys.h>
10: #include <petscsftypes.h>
11: #include <petscis.h>
12: #include <petscdevicetypes.h>
13: #include <petscviewer.h>
15: /* SUBMANSEC = Vec */
17: /*S
18: Vec - Abstract PETSc vector object
20: Level: beginner
22: .seealso: `VecCreate()`, `VecType`, `VecSetType()`
23: S*/
24: typedef struct _p_Vec *Vec;
26: /*E
27: ScatterMode - Determines the direction of a scatter
29: Level: beginner
31: .seealso: `VecScatter`, `VecScatterBegin()`, `VecScatterEnd()`
32: E*/
33: typedef enum {
34: SCATTER_FORWARD = 0,
35: SCATTER_REVERSE = 1,
36: SCATTER_FORWARD_LOCAL = 2,
37: SCATTER_REVERSE_LOCAL = 3,
38: SCATTER_LOCAL = 2
39: } ScatterMode;
41: /*MC
42: SCATTER_FORWARD - Scatters the values as dictated by the `VecScatterCreate()` call
44: Level: beginner
46: .seealso: `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_REVERSE`, `SCATTER_FORWARD_LOCAL`,
47: `SCATTER_REVERSE_LOCAL`
49: M*/
51: /*MC
52: SCATTER_REVERSE - Moves the values in the opposite direction then the directions indicated in
53: in the `VecScatterCreate()`
55: Level: beginner
57: .seealso: `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_FORWARD`, `SCATTER_FORWARD_LOCAL`,
58: `SCATTER_REVERSE_LOCAL`
60: M*/
62: /*MC
63: SCATTER_FORWARD_LOCAL - Scatters the values as dictated by the `VecScatterCreate()` call except NO parallel communication
64: is done. Any variables that have be moved between processes are ignored
66: Level: developer
68: .seealso: `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_REVERSE`, `SCATTER_FORWARD`,
69: `SCATTER_REVERSE_LOCAL`
71: M*/
73: /*MC
74: SCATTER_REVERSE_LOCAL - Moves the values in the opposite direction then the directions indicated in
75: in the `VecScatterCreate()` except NO parallel communication
76: is done. Any variables that have be moved between processes are ignored
78: Level: developer
80: .seealso: `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_FORWARD`, `SCATTER_FORWARD_LOCAL`,
81: `SCATTER_REVERSE`
83: M*/
85: /*J
86: VecType - String with the name of a PETSc vector
88: Level: beginner
90: .seealso: `VecSetType()`, `Vec`, `VecCreate()`, `VecDestroy()`
91: J*/
92: typedef const char *VecType;
93: #define VECSEQ "seq"
94: #define VECMPI "mpi"
95: #define VECSTANDARD "standard" /* seq on one process and mpi on several */
96: #define VECSHARED "shared"
97: #define VECSEQVIENNACL "seqviennacl"
98: #define VECMPIVIENNACL "mpiviennacl"
99: #define VECVIENNACL "viennacl" /* seqviennacl on one process and mpiviennacl on several */
100: #define VECSEQCUDA "seqcuda"
101: #define VECMPICUDA "mpicuda"
102: #define VECCUDA "cuda" /* seqcuda on one process and mpicuda on several */
103: #define VECSEQHIP "seqhip"
104: #define VECMPIHIP "mpihip"
105: #define VECHIP "hip" /* seqcuda on one process and mpicuda on several */
106: #define VECNEST "nest"
107: #define VECSEQKOKKOS "seqkokkos"
108: #define VECMPIKOKKOS "mpikokkos"
109: #define VECKOKKOS "kokkos" /* seqkokkos on one process and mpikokkos on several */
111: /* Dynamic creation and loading functions */
112: PETSC_EXTERN PetscErrorCode VecScatterSetType(VecScatter, VecScatterType);
113: PETSC_EXTERN PetscErrorCode VecScatterGetType(VecScatter, VecScatterType *);
114: PETSC_EXTERN PetscErrorCode VecScatterSetFromOptions(VecScatter);
115: PETSC_EXTERN PetscErrorCode VecScatterRegister(const char[], PetscErrorCode (*)(VecScatter));
116: PETSC_EXTERN PetscErrorCode VecScatterCreate(Vec, IS, Vec, IS, VecScatter *);
118: /* Logging support */
119: #define REAL_FILE_CLASSID 1211213
120: #define VEC_FILE_CLASSID 1211214
121: PETSC_EXTERN PetscClassId VEC_CLASSID;
122: PETSC_EXTERN PetscClassId PETSCSF_CLASSID;
124: PETSC_EXTERN PetscErrorCode VecInitializePackage(void);
125: PETSC_EXTERN PetscErrorCode VecFinalizePackage(void);
127: PETSC_EXTERN PetscErrorCode VecCreate(MPI_Comm, Vec *);
128: PETSC_EXTERN PetscErrorCode VecCreateSeq(MPI_Comm, PetscInt, Vec *);
129: PETSC_EXTERN PetscErrorCode VecCreateMPI(MPI_Comm, PetscInt, PetscInt, Vec *);
130: PETSC_EXTERN PetscErrorCode VecCreateSeqWithArray(MPI_Comm, PetscInt, PetscInt, const PetscScalar[], Vec *);
131: PETSC_EXTERN PetscErrorCode VecCreateMPIWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar[], Vec *);
132: PETSC_EXTERN PetscErrorCode VecCreateShared(MPI_Comm, PetscInt, PetscInt, Vec *);
133: PETSC_EXTERN PetscErrorCode VecCreateNode(MPI_Comm, PetscInt, PetscInt, Vec *);
135: PETSC_EXTERN PetscErrorCode VecSetFromOptions(Vec);
136: PETSC_EXTERN PetscErrorCode VecViewFromOptions(Vec, PetscObject, const char[]);
138: PETSC_EXTERN PetscErrorCode VecSetUp(Vec);
139: PETSC_EXTERN PetscErrorCode VecDestroy(Vec *);
140: PETSC_EXTERN PetscErrorCode VecZeroEntries(Vec);
141: PETSC_EXTERN PetscErrorCode VecSetOptionsPrefix(Vec, const char[]);
142: PETSC_EXTERN PetscErrorCode VecAppendOptionsPrefix(Vec, const char[]);
143: PETSC_EXTERN PetscErrorCode VecGetOptionsPrefix(Vec, const char *[]);
145: PETSC_EXTERN PetscErrorCode VecSetSizes(Vec, PetscInt, PetscInt);
147: PETSC_EXTERN PetscErrorCode VecDotNorm2(Vec, Vec, PetscScalar *, PetscReal *);
148: PETSC_EXTERN PetscErrorCode VecDot(Vec, Vec, PetscScalar *);
149: PETSC_EXTERN PetscErrorCode VecDotRealPart(Vec, Vec, PetscReal *);
150: PETSC_EXTERN PetscErrorCode VecTDot(Vec, Vec, PetscScalar *);
151: PETSC_EXTERN PetscErrorCode VecMDot(Vec, PetscInt, const Vec[], PetscScalar[]);
152: PETSC_EXTERN PetscErrorCode VecMTDot(Vec, PetscInt, const Vec[], PetscScalar[]);
153: PETSC_EXTERN PetscErrorCode VecGetSubVector(Vec, IS, Vec *);
154: PETSC_EXTERN PetscErrorCode VecRestoreSubVector(Vec, IS, Vec *);
155: PETSC_EXTERN PetscErrorCode VecConcatenate(PetscInt, const Vec[], Vec *, IS *[]);
157: /*E
158: NormType - determines what type of norm to compute
160: Level: beginner
162: .seealso: `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `MatNorm()`
163: E*/
164: typedef enum {
165: NORM_1 = 0,
166: NORM_2 = 1,
167: NORM_FROBENIUS = 2,
168: NORM_INFINITY = 3,
169: NORM_1_AND_2 = 4
170: } NormType;
171: PETSC_EXTERN const char *const NormTypes[];
172: #define NORM_MAX NORM_INFINITY
174: /*MC
175: NORM_1 - the one norm, ||v|| = sum_i | v_i |. ||A|| = max_j || v_*j ||, maximum column sum
177: Level: beginner
179: .seealso: `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_2`, `NORM_FROBENIUS`,
180: `NORM_INFINITY`, `NORM_1_AND_2`
182: M*/
184: /*MC
185: NORM_2 - the two norm, ||v|| = sqrt(sum_i |v_i|^2) (vectors only)
187: Level: beginner
189: .seealso: `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_FROBENIUS`,
190: `NORM_INFINITY`, `NORM_1_AND_2`
192: M*/
194: /*MC
195: NORM_FROBENIUS - ||A|| = sqrt(sum_ij |A_ij|^2), same as `NORM_2` for vectors
197: Level: beginner
199: .seealso: `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`,
200: `NORM_INFINITY`, `NORM_1_AND_2`
202: M*/
204: /*MC
205: NORM_INFINITY - ||v|| = max_i |v_i|. ||A|| = max_i || v_i* ||, maximum row sum
207: Level: beginner
209: .seealso: `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`,
210: `NORM_FROBENIUS`, `NORM_1_AND_2`
212: M*/
214: /*MC
215: NORM_1_AND_2 - computes both the 1 and 2 norm of a vector
217: Level: beginner
219: .seealso: `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`,
220: `NORM_FROBENIUS`, `NORM_INFINITY`
222: M*/
224: /*MC
225: NORM_MAX - see `NORM_INFINITY`
227: Level: beginner
229: M*/
231: /*E
232: ReductionType - determines what type of column reduction (one that is not a type of norm defined in `NormType`) to compute
234: Level: beginner
236: .seealso: `MatGetColumnReductions()`, `MatGetColumnNorms()`, `NormType`
237: E*/
238: /* NOTE: The integer constants defined in ReductionType MUST BE DISTINCT from those defined in NormType.
239: * This is because MatGetColumnReductions() is used to compute both norms and other types of reductions,
240: * and the constants defined in both NormType and ReductionType are used to designate the desired operation. */
241: typedef enum {
242: REDUCTION_SUM_REALPART = 10,
243: REDUCTION_MEAN_REALPART = 11,
244: REDUCTION_SUM_IMAGINARYPART = 12,
245: REDUCTION_MEAN_IMAGINARYPART = 13
246: } ReductionType;
248: /*MC
249: REDUCTION_SUM_REALPART - sum of real part of matrix column
251: Level: beginner
253: .seealso: `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_SUM_IMAGINARYPART`, `REDUCTION_MEAN_REALPART`, `REDUCTION_NORM_1`,
254: `REDUCTION_NORM_2`, `REDUCTION_NORM_FROBENIUS`, `REDUCTION_NORM_INFINITY`
256: M*/
258: /*MC
259: REDUCTION_SUM_IMAGINARYPART - sum of imaginary part of matrix column
261: Level: beginner
263: .seealso: `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_SUM_REALPART`, `REDUCTION_MEAN_IMAGINARYPART`, `REDUCTION_NORM_1`,
264: `REDUCTION_NORM_2`, `REDUCTION_NORM_FROBENIUS`, `REDUCTION_NORM_INFINITY`
266: M*/
268: /*MC
269: REDUCTION_MEAN_REALPART - arithmetic mean of real part of matrix column
271: Level: beginner
273: .seealso: `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_MEAN_IMAGINARYPART`, `REDUCTION_SUM_REALPART`, `REDUCTION_NORM_1`,
274: `REDUCTION_NORM_2`, `REDUCTION_NORM_FROBENIUS`, `REDUCTION_NORM_INFINITY`
276: M*/
278: /*MC
279: REDUCTION_MEAN_IMAGINARYPART - arithmetic mean of imaginary part of matrix column
281: Level: beginner
283: .seealso: `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_MEAN_REALPART`, `REDUCTION_SUM_IMAGINARYPART`, `REDUCTION_NORM_1`,
284: `REDUCTION_NORM_2`, `REDUCTION_NORM_FROBENIUS`, `REDUCTION_NORM_INFINITY`
286: M*/
288: PETSC_EXTERN PetscErrorCode VecNorm(Vec, NormType, PetscReal *);
289: PETSC_EXTERN PetscErrorCode VecNormAvailable(Vec, NormType, PetscBool *, PetscReal *);
290: PETSC_EXTERN PetscErrorCode VecNormalize(Vec, PetscReal *);
291: PETSC_EXTERN PetscErrorCode VecSum(Vec, PetscScalar *);
292: PETSC_EXTERN PetscErrorCode VecMean(Vec, PetscScalar *);
293: PETSC_EXTERN PetscErrorCode VecMax(Vec, PetscInt *, PetscReal *);
294: PETSC_EXTERN PetscErrorCode VecMin(Vec, PetscInt *, PetscReal *);
295: PETSC_EXTERN PetscErrorCode VecScale(Vec, PetscScalar);
296: PETSC_EXTERN PetscErrorCode VecCopy(Vec, Vec);
297: PETSC_EXTERN PetscErrorCode VecSetRandom(Vec, PetscRandom);
298: PETSC_EXTERN PetscErrorCode VecSet(Vec, PetscScalar);
299: PETSC_EXTERN PetscErrorCode VecSetInf(Vec);
300: PETSC_EXTERN PetscErrorCode VecSwap(Vec, Vec);
301: PETSC_EXTERN PetscErrorCode VecAXPY(Vec, PetscScalar, Vec);
302: PETSC_EXTERN PetscErrorCode VecAXPBY(Vec, PetscScalar, PetscScalar, Vec);
303: PETSC_EXTERN PetscErrorCode VecMAXPY(Vec, PetscInt, const PetscScalar[], Vec[]);
304: PETSC_EXTERN PetscErrorCode VecAYPX(Vec, PetscScalar, Vec);
305: PETSC_EXTERN PetscErrorCode VecWAXPY(Vec, PetscScalar, Vec, Vec);
306: PETSC_EXTERN PetscErrorCode VecAXPBYPCZ(Vec, PetscScalar, PetscScalar, PetscScalar, Vec, Vec);
307: PETSC_EXTERN PetscErrorCode VecPointwiseMax(Vec, Vec, Vec);
308: PETSC_EXTERN PetscErrorCode VecPointwiseMaxAbs(Vec, Vec, Vec);
309: PETSC_EXTERN PetscErrorCode VecPointwiseMin(Vec, Vec, Vec);
310: PETSC_EXTERN PetscErrorCode VecPointwiseMult(Vec, Vec, Vec);
311: PETSC_EXTERN PetscErrorCode VecPointwiseDivide(Vec, Vec, Vec);
312: PETSC_EXTERN PetscErrorCode VecMaxPointwiseDivide(Vec, Vec, PetscReal *);
313: PETSC_EXTERN PetscErrorCode VecShift(Vec, PetscScalar);
314: PETSC_EXTERN PetscErrorCode VecReciprocal(Vec);
315: PETSC_EXTERN PetscErrorCode VecPermute(Vec, IS, PetscBool);
316: PETSC_EXTERN PetscErrorCode VecSqrtAbs(Vec);
317: PETSC_EXTERN PetscErrorCode VecLog(Vec);
318: PETSC_EXTERN PetscErrorCode VecExp(Vec);
319: PETSC_EXTERN PetscErrorCode VecAbs(Vec);
320: PETSC_EXTERN PetscErrorCode VecDuplicate(Vec, Vec *);
321: PETSC_EXTERN PetscErrorCode VecDuplicateVecs(Vec, PetscInt, Vec *[]);
322: PETSC_EXTERN PetscErrorCode VecDestroyVecs(PetscInt, Vec *[]);
323: PETSC_EXTERN PetscErrorCode VecStrideNormAll(Vec, NormType, PetscReal[]);
324: PETSC_EXTERN PetscErrorCode VecStrideMaxAll(Vec, PetscInt[], PetscReal[]);
325: PETSC_EXTERN PetscErrorCode VecStrideMinAll(Vec, PetscInt[], PetscReal[]);
326: PETSC_EXTERN PetscErrorCode VecStrideScaleAll(Vec, const PetscScalar[]);
327: PETSC_EXTERN PetscErrorCode VecStrideSumAll(Vec, PetscScalar *);
328: PETSC_EXTERN PetscErrorCode VecUniqueEntries(Vec, PetscInt *, PetscScalar **);
330: PETSC_EXTERN PetscErrorCode VecStrideNorm(Vec, PetscInt, NormType, PetscReal *);
331: PETSC_EXTERN PetscErrorCode VecStrideMax(Vec, PetscInt, PetscInt *, PetscReal *);
332: PETSC_EXTERN PetscErrorCode VecStrideMin(Vec, PetscInt, PetscInt *, PetscReal *);
333: PETSC_EXTERN PetscErrorCode VecStrideScale(Vec, PetscInt, PetscScalar);
334: PETSC_EXTERN PetscErrorCode VecStrideSum(Vec, PetscInt, PetscScalar *);
335: PETSC_EXTERN PetscErrorCode VecStrideSet(Vec, PetscInt, PetscScalar);
337: PETSC_EXTERN PetscErrorCode VecStrideGather(Vec, PetscInt, Vec, InsertMode);
338: PETSC_EXTERN PetscErrorCode VecStrideScatter(Vec, PetscInt, Vec, InsertMode);
339: PETSC_EXTERN PetscErrorCode VecStrideGatherAll(Vec, Vec[], InsertMode);
340: PETSC_EXTERN PetscErrorCode VecStrideScatterAll(Vec[], Vec, InsertMode);
342: PETSC_EXTERN PetscErrorCode VecStrideSubSetScatter(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);
343: PETSC_EXTERN PetscErrorCode VecStrideSubSetGather(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);
345: PETSC_EXTERN PetscErrorCode VecSetValues(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
346: PETSC_EXTERN PetscErrorCode VecGetValues(Vec, PetscInt, const PetscInt[], PetscScalar[]);
347: PETSC_EXTERN PetscErrorCode VecAssemblyBegin(Vec);
348: PETSC_EXTERN PetscErrorCode VecAssemblyEnd(Vec);
349: PETSC_EXTERN PetscErrorCode VecStashSetInitialSize(Vec, PetscInt, PetscInt);
350: PETSC_EXTERN PetscErrorCode VecStashView(Vec, PetscViewer);
351: PETSC_EXTERN PetscErrorCode VecStashViewFromOptions(Vec, PetscObject, const char[]);
352: PETSC_EXTERN PetscErrorCode VecStashGetInfo(Vec, PetscInt *, PetscInt *, PetscInt *, PetscInt *);
354: PETSC_EXTERN PetscErrorCode VecSetPreallocationCOO(Vec, PetscCount, const PetscInt[]);
355: PETSC_EXTERN PetscErrorCode VecSetPreallocationCOOLocal(Vec, PetscCount, PetscInt[]);
356: PETSC_EXTERN PetscErrorCode VecSetValuesCOO(Vec, const PetscScalar[], InsertMode);
358: /*MC
359: VecSetValue - Set a single entry into a vector.
361: Synopsis:
362: #include <petscvec.h>
363: PetscErrorCode VecSetValue(Vec v,PetscInt row,PetscScalar value, InsertMode mode);
365: Not Collective
367: Input Parameters:
368: + v - the vector
369: . row - the row location of the entry
370: . value - the value to insert
371: - mode - either `INSERT_VALUES` or `ADD_VALUES`
373: Notes:
374: For efficiency one should use `VecSetValues()` and set several or
375: many values simultaneously if possible.
377: These values may be cached, so `VecAssemblyBegin()` and `VecAssemblyEnd()`
378: MUST be called after all calls to `VecSetValue()` have been completed.
380: `VecSetValue()` uses 0-based indices in Fortran as well as in C.
382: Level: beginner
384: .seealso: `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `VecSetValuesBlockedLocal()`, `VecSetValueLocal()`
385: M*/
386: static inline PetscErrorCode VecSetValue(Vec v, PetscInt i, PetscScalar va, InsertMode mode)
387: {
388: return VecSetValues(v, 1, &i, &va, mode);
389: }
391: PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec, PetscInt);
392: PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec, PetscInt *);
393: PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
395: /* Dynamic creation and loading functions */
396: PETSC_EXTERN PetscFunctionList VecList;
397: PETSC_EXTERN PetscErrorCode VecSetType(Vec, VecType);
398: PETSC_EXTERN PetscErrorCode VecGetType(Vec, VecType *);
399: PETSC_EXTERN PetscErrorCode VecRegister(const char[], PetscErrorCode (*)(Vec));
401: PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter, Vec, Vec, InsertMode, ScatterMode);
402: PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter, Vec, Vec, InsertMode, ScatterMode);
403: PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter *);
404: PETSC_EXTERN PetscErrorCode VecScatterSetUp(VecScatter);
405: PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter, VecScatter *);
406: PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter, PetscViewer);
407: PETSC_EXTERN PetscErrorCode VecScatterViewFromOptions(VecScatter, PetscObject, const char[]);
408: PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter, PetscInt[], PetscInt[]);
409: PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter, PetscBool *);
411: PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
412: PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
413: PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
414: PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
415: PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
416: PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
417: PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec, PetscInt, PetscInt, PetscScalar *[]);
418: PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec, PetscInt, PetscInt, PetscScalar *[]);
420: PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
421: PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
422: PETSC_EXTERN PetscErrorCode VecRestoreArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
423: PETSC_EXTERN PetscErrorCode VecGetArray3dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
424: PETSC_EXTERN PetscErrorCode VecRestoreArray3dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
425: PETSC_EXTERN PetscErrorCode VecGetArray2dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
426: PETSC_EXTERN PetscErrorCode VecRestoreArray2dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
427: PETSC_EXTERN PetscErrorCode VecGetArray1dWrite(Vec, PetscInt, PetscInt, PetscScalar *[]);
428: PETSC_EXTERN PetscErrorCode VecRestoreArray1dWrite(Vec, PetscInt, PetscInt, PetscScalar *[]);
430: PETSC_EXTERN PetscErrorCode VecGetArray4dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
431: PETSC_EXTERN PetscErrorCode VecRestoreArray4dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
432: PETSC_EXTERN PetscErrorCode VecGetArray3dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
433: PETSC_EXTERN PetscErrorCode VecRestoreArray3dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
434: PETSC_EXTERN PetscErrorCode VecGetArray2dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
435: PETSC_EXTERN PetscErrorCode VecRestoreArray2dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
436: PETSC_EXTERN PetscErrorCode VecGetArray1dRead(Vec, PetscInt, PetscInt, PetscScalar *[]);
437: PETSC_EXTERN PetscErrorCode VecRestoreArray1dRead(Vec, PetscInt, PetscInt, PetscScalar *[]);
439: PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec, const PetscScalar[]);
440: PETSC_EXTERN PetscErrorCode VecResetArray(Vec);
441: PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec, const PetscScalar[]);
443: PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[], PetscInt, PetscScalar **[]);
444: PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[], PetscInt, PetscScalar **[]);
446: PETSC_EXTERN PetscErrorCode VecView(Vec, PetscViewer);
447: PETSC_EXTERN PetscErrorCode VecViewNative(Vec, PetscViewer);
448: PETSC_EXTERN PetscErrorCode VecEqual(Vec, Vec, PetscBool *);
449: PETSC_EXTERN PetscErrorCode VecLoad(Vec, PetscViewer);
451: PETSC_EXTERN PetscErrorCode VecGetSize(Vec, PetscInt *);
452: PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec, PetscInt *);
453: PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec, PetscInt *, PetscInt *);
454: PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec, const PetscInt *[]);
456: PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping);
457: PETSC_EXTERN PetscErrorCode VecSetValuesLocal(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
459: PETSC_EXTERN PetscErrorCode VecCUDAGetArray(Vec, PetscScalar **);
460: PETSC_EXTERN PetscErrorCode VecCUDARestoreArray(Vec, PetscScalar **);
462: PETSC_EXTERN PetscErrorCode VecCUDAGetArrayRead(Vec, const PetscScalar **);
463: PETSC_EXTERN PetscErrorCode VecCUDARestoreArrayRead(Vec, const PetscScalar **);
465: PETSC_EXTERN PetscErrorCode VecCUDAGetArrayWrite(Vec, PetscScalar **);
466: PETSC_EXTERN PetscErrorCode VecCUDARestoreArrayWrite(Vec, PetscScalar **);
468: PETSC_EXTERN PetscErrorCode VecCUDAPlaceArray(Vec, const PetscScalar[]);
469: PETSC_EXTERN PetscErrorCode VecCUDAReplaceArray(Vec, const PetscScalar[]);
470: PETSC_EXTERN PetscErrorCode VecCUDAResetArray(Vec);
472: PETSC_EXTERN PetscErrorCode VecHIPGetArray(Vec, PetscScalar **);
473: PETSC_EXTERN PetscErrorCode VecHIPRestoreArray(Vec, PetscScalar **);
475: PETSC_EXTERN PetscErrorCode VecHIPGetArrayRead(Vec, const PetscScalar **);
476: PETSC_EXTERN PetscErrorCode VecHIPRestoreArrayRead(Vec, const PetscScalar **);
478: PETSC_EXTERN PetscErrorCode VecHIPGetArrayWrite(Vec, PetscScalar **);
479: PETSC_EXTERN PetscErrorCode VecHIPRestoreArrayWrite(Vec, PetscScalar **);
481: PETSC_EXTERN PetscErrorCode VecHIPPlaceArray(Vec, const PetscScalar[]);
482: PETSC_EXTERN PetscErrorCode VecHIPReplaceArray(Vec, const PetscScalar[]);
483: PETSC_EXTERN PetscErrorCode VecHIPResetArray(Vec);
485: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLContext(Vec, PETSC_UINTPTR_T *);
486: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLQueue(Vec, PETSC_UINTPTR_T *);
487: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemRead(Vec, PETSC_UINTPTR_T *);
488: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemWrite(Vec, PETSC_UINTPTR_T *);
489: PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMemWrite(Vec);
490: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMem(Vec, PETSC_UINTPTR_T *);
491: PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMem(Vec);
493: /*MC
494: VecSetValueLocal - Set a single entry into a vector using the local numbering
496: Synopsis:
497: #include <petscvec.h>
498: PetscErrorCode VecSetValueLocal(Vec v,PetscInt row,PetscScalar value, InsertMode mode);
500: Not Collective
502: Input Parameters:
503: + v - the vector
504: . row - the row location of the entry
505: . value - the value to insert
506: - mode - either `INSERT_VALUES` or `ADD_VALUES`
508: Notes:
509: For efficiency one should use `VecSetValues()` and set several or
510: many values simultaneously if possible.
512: These values may be cached, so `VecAssemblyBegin()` and `VecAssemblyEnd()`
513: MUST be called after all calls to `VecSetValues()` have been completed.
515: `VecSetValues()` uses 0-based indices in Fortran as well as in C.
517: Level: beginner
519: .seealso: `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `VecSetValuesBlockedLocal()`, `VecSetValue()`
520: M*/
521: static inline PetscErrorCode VecSetValueLocal(Vec v, PetscInt i, PetscScalar va, InsertMode mode)
522: {
523: return VecSetValuesLocal(v, 1, &i, &va, mode);
524: }
526: PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
527: PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping *);
529: PETSC_EXTERN PetscErrorCode VecDotBegin(Vec, Vec, PetscScalar *);
530: PETSC_EXTERN PetscErrorCode VecDotEnd(Vec, Vec, PetscScalar *);
531: PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec, Vec, PetscScalar *);
532: PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec, Vec, PetscScalar *);
533: PETSC_EXTERN PetscErrorCode VecNormBegin(Vec, NormType, PetscReal *);
534: PETSC_EXTERN PetscErrorCode VecNormEnd(Vec, NormType, PetscReal *);
536: PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec, PetscInt, const Vec[], PetscScalar[]);
537: PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec, PetscInt, const Vec[], PetscScalar[]);
538: PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec, PetscInt, const Vec[], PetscScalar[]);
539: PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec, PetscInt, const Vec[], PetscScalar[]);
540: PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm);
542: PETSC_EXTERN PetscErrorCode VecBindToCPU(Vec, PetscBool);
543: PETSC_DEPRECATED_FUNCTION("Use VecBindToCPU (since v3.13)") static inline PetscErrorCode VecPinToCPU(Vec v, PetscBool flg)
544: {
545: return VecBindToCPU(v, flg);
546: }
547: PETSC_EXTERN PetscErrorCode VecBoundToCPU(Vec, PetscBool *);
548: PETSC_EXTERN PetscErrorCode VecSetBindingPropagates(Vec, PetscBool);
549: PETSC_EXTERN PetscErrorCode VecGetBindingPropagates(Vec, PetscBool *);
550: PETSC_EXTERN PetscErrorCode VecSetPinnedMemoryMin(Vec, size_t);
551: PETSC_EXTERN PetscErrorCode VecGetPinnedMemoryMin(Vec, size_t *);
553: PETSC_EXTERN PetscErrorCode VecGetOffloadMask(Vec, PetscOffloadMask *);
555: typedef enum {
556: VEC_IGNORE_OFF_PROC_ENTRIES,
557: VEC_IGNORE_NEGATIVE_INDICES,
558: VEC_SUBSET_OFF_PROC_ENTRIES
559: } VecOption;
560: PETSC_EXTERN PetscErrorCode VecSetOption(Vec, VecOption, PetscBool);
562: PETSC_EXTERN PetscErrorCode VecGetArray(Vec, PetscScalar **);
563: PETSC_EXTERN PetscErrorCode VecGetArrayWrite(Vec, PetscScalar **);
564: PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec, const PetscScalar **);
565: PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec, PetscScalar **);
566: PETSC_EXTERN PetscErrorCode VecRestoreArrayWrite(Vec, PetscScalar **);
567: PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec, const PetscScalar **);
568: PETSC_EXTERN PetscErrorCode VecCreateLocalVector(Vec, Vec *);
569: PETSC_EXTERN PetscErrorCode VecGetLocalVector(Vec, Vec);
570: PETSC_EXTERN PetscErrorCode VecRestoreLocalVector(Vec, Vec);
571: PETSC_EXTERN PetscErrorCode VecGetLocalVectorRead(Vec, Vec);
572: PETSC_EXTERN PetscErrorCode VecRestoreLocalVectorRead(Vec, Vec);
573: PETSC_EXTERN PetscErrorCode VecGetArrayAndMemType(Vec, PetscScalar **, PetscMemType *);
574: PETSC_EXTERN PetscErrorCode VecRestoreArrayAndMemType(Vec, PetscScalar **);
575: PETSC_EXTERN PetscErrorCode VecGetArrayReadAndMemType(Vec, const PetscScalar **, PetscMemType *);
576: PETSC_EXTERN PetscErrorCode VecRestoreArrayReadAndMemType(Vec, const PetscScalar **);
577: PETSC_EXTERN PetscErrorCode VecGetArrayWriteAndMemType(Vec, PetscScalar **, PetscMemType *);
578: PETSC_EXTERN PetscErrorCode VecRestoreArrayWriteAndMemType(Vec, PetscScalar **);
580: /*@C
581: VecGetArrayPair - Accesses a pair of pointers for two vectors that may be common. When not common the first is read only
583: Logically Collective
585: Input Parameters:
586: + x - the vector
587: - y - the second vector
589: Output Parameters:
590: + xv - location to put pointer to the first array
591: - yv - location to put pointer to the second array
593: Level: developer
595: Not available from Fortran
597: .seealso: `VecGetArray()`, `VecGetArrayRead()`, `VecRestoreArrayPair()`
599: @*/
600: static inline PetscErrorCode VecGetArrayPair(Vec x, Vec y, PetscScalar **xv, PetscScalar **yv)
601: {
602: VecGetArray(y, yv);
603: if (x == y) *xv = *yv;
604: else VecGetArrayRead(x, (const PetscScalar **)xv);
605: return 0;
606: }
608: /*@C
609: VecRestoreArrayPair - Returns a pair of pointers for two vectors that may be common. When not common the first is read only
611: Logically Collective
613: Input Parameters:
614: + x - the vector
615: - y - the second vector
617: Output Parameters:
618: + xv - location to put pointer to the first array
619: - yv - location to put pointer to the second array
621: Level: developer
623: Not available from Fortran
625: .seealso: `VecGetArray()`, `VecGetArrayRead()`, `VecGetArrayPair()`
627: @*/
628: static inline PetscErrorCode VecRestoreArrayPair(Vec x, Vec y, PetscScalar **xv, PetscScalar **yv)
629: {
630: VecRestoreArray(y, yv);
631: if (x != y) VecRestoreArrayRead(x, (const PetscScalar **)xv);
632: return 0;
633: }
635: #if defined(PETSC_USE_DEBUG)
636: PETSC_EXTERN PetscErrorCode VecLockReadPush(Vec);
637: PETSC_EXTERN PetscErrorCode VecLockReadPop(Vec);
638: PETSC_EXTERN PetscErrorCode VecLockWriteSet(Vec, PetscBool);
639: PETSC_EXTERN PetscErrorCode VecLockGet(Vec, PetscInt *);
640: PETSC_EXTERN PetscErrorCode VecLockGetLocation(Vec, const char *[], const char *[], int *);
641: static inline PetscErrorCode VecSetErrorIfLocked(Vec x, PetscInt arg)
642: {
643: PetscInt state;
645: VecLockGet(x, &state);
646: if (PetscUnlikely(state != 0)) {
647: const char *file, *func, *name;
648: int line;
650: VecLockGetLocation(x, &file, &func, &line);
651: PetscObjectGetName((PetscObject)x, &name);
652: 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 ? line : 0);
653: }
654: return 0;
655: }
656: /* The three are deprecated */
657: PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use VecLockReadPush() (since version 3.11)") PetscErrorCode VecLockPush(Vec);
658: PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use VecLockReadPop() (since version 3.11)") PetscErrorCode VecLockPop(Vec);
659: #define VecLocked(x, arg) VecSetErrorIfLocked(x, arg) PETSC_DEPRECATED_MACRO("GCC warning \"Use VecSetErrorIfLocked() (since version 3.11)\"")
660: #else
661: #define VecLockReadPush(x) 0
662: #define VecLockReadPop(x) 0
663: #define VecLockGet(x, s) *(s) = 0
664: #define VecSetErrorIfLocked(x, arg) 0
665: #define VecLockWriteSet(x, flg) 0
666: /* The three are deprecated */
667: #define VecLockPush(x) 0
668: #define VecLockPop(x) 0
669: #define VecLocked(x, arg) 0
670: #endif
672: /*
673: These numbers need to match the entries in
674: the function table in vecimpl.h
675: */
676: typedef enum {
677: VECOP_DUPLICATE = 0,
678: VECOP_VIEW = 33,
679: VECOP_LOAD = 41,
680: VECOP_VIEWNATIVE = 68,
681: VECOP_LOADNATIVE = 69
682: } VecOperation;
683: PETSC_EXTERN PetscErrorCode VecSetOperation(Vec, VecOperation, void (*)(void));
685: /*
686: Routines for dealing with ghosted vectors:
687: vectors with ghost elements at the end of the array.
688: */
689: PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec, PetscInt, const PetscInt[]);
690: PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Vec *);
691: PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscScalar[], Vec *);
692: PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Vec *);
693: PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscScalar[], Vec *);
694: PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec, Vec *);
695: PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec, Vec *);
696: PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec, Vec, PetscBool *);
697: PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec, InsertMode, ScatterMode);
698: PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec, InsertMode, ScatterMode);
700: PETSC_EXTERN PetscErrorCode VecConjugate(Vec);
701: PETSC_EXTERN PetscErrorCode VecImaginaryPart(Vec);
702: PETSC_EXTERN PetscErrorCode VecRealPart(Vec);
704: PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec, VecScatter *, Vec *);
705: PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec, VecScatter *, Vec *);
707: PETSC_EXTERN PetscErrorCode ISComplementVec(IS, Vec, IS *);
708: PETSC_EXTERN PetscErrorCode VecPow(Vec, PetscScalar);
709: PETSC_EXTERN PetscErrorCode VecMedian(Vec, Vec, Vec, Vec);
710: PETSC_EXTERN PetscErrorCode VecWhichInactive(Vec, Vec, Vec, Vec, PetscBool, IS *);
711: PETSC_EXTERN PetscErrorCode VecWhichBetween(Vec, Vec, Vec, IS *);
712: PETSC_EXTERN PetscErrorCode VecWhichBetweenOrEqual(Vec, Vec, Vec, IS *);
713: PETSC_EXTERN PetscErrorCode VecWhichGreaterThan(Vec, Vec, IS *);
714: PETSC_EXTERN PetscErrorCode VecWhichLessThan(Vec, Vec, IS *);
715: PETSC_EXTERN PetscErrorCode VecWhichEqual(Vec, Vec, IS *);
716: PETSC_EXTERN PetscErrorCode VecISAXPY(Vec, IS, PetscScalar, Vec);
717: PETSC_EXTERN PetscErrorCode VecISCopy(Vec, IS, ScatterMode, Vec);
718: PETSC_EXTERN PetscErrorCode VecISSet(Vec, IS, PetscScalar);
719: PETSC_EXTERN PetscErrorCode VecBoundGradientProjection(Vec, Vec, Vec, Vec, Vec);
720: PETSC_EXTERN PetscErrorCode VecStepBoundInfo(Vec, Vec, Vec, Vec, PetscReal *, PetscReal *, PetscReal *);
721: PETSC_EXTERN PetscErrorCode VecStepMax(Vec, Vec, PetscReal *);
722: PETSC_EXTERN PetscErrorCode VecStepMaxBounded(Vec, Vec, Vec, Vec, PetscReal *);
724: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec);
725: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec);
727: /*S
728: Vecs - Collection of vectors where the data for the vectors is stored in
729: one contiguous memory
731: Level: advanced
733: Notes:
734: Temporary construct for handling multiply right hand side solves
736: This is faked by storing a single vector that has enough array space for
737: n vectors
739: S*/
740: struct _n_Vecs {
741: PetscInt n;
742: Vec v;
743: };
744: typedef struct _n_Vecs *Vecs;
745: PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs);
746: PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm, PetscInt, PetscInt, Vecs *);
747: PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm, PetscInt, PetscInt, PetscScalar *, Vecs *);
748: PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs, Vecs *);
750: #if defined(PETSC_HAVE_VIENNACL)
751: typedef struct _p_PetscViennaCLIndices *PetscViennaCLIndices;
752: PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesCreate(PetscInt, PetscInt *, PetscInt, PetscInt *, PetscViennaCLIndices *);
753: PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesDestroy(PetscViennaCLIndices *);
754: PETSC_EXTERN PetscErrorCode VecViennaCLCopyToGPUSome_Public(Vec, PetscViennaCLIndices);
755: PETSC_EXTERN PetscErrorCode VecViennaCLCopyFromGPUSome_Public(Vec, PetscViennaCLIndices);
756: PETSC_EXTERN PetscErrorCode VecCreateSeqViennaCL(MPI_Comm, PetscInt, Vec *);
757: PETSC_EXTERN PetscErrorCode VecCreateMPIViennaCL(MPI_Comm, PetscInt, PetscInt, Vec *);
758: #endif
759: #if defined(PETSC_HAVE_CUDA) || defined(PETSC_HAVE_HIP)
760: PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter, Vec);
761: PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter);
762: #endif
763: #if defined(PETSC_HAVE_CUDA)
764: PETSC_EXTERN PetscErrorCode VecCreateSeqCUDA(MPI_Comm, PetscInt, Vec *);
765: PETSC_EXTERN PetscErrorCode VecCreateSeqCUDAWithArray(MPI_Comm, PetscInt, PetscInt, const PetscScalar *, Vec *);
766: PETSC_EXTERN PetscErrorCode VecCreateSeqCUDAWithArrays(MPI_Comm, PetscInt, PetscInt, const PetscScalar *, const PetscScalar *, Vec *);
767: PETSC_EXTERN PetscErrorCode VecCreateMPICUDA(MPI_Comm, PetscInt, PetscInt, Vec *);
768: PETSC_EXTERN PetscErrorCode VecCreateMPICUDAWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar *, Vec *);
769: PETSC_EXTERN PetscErrorCode VecCreateMPICUDAWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar *, const PetscScalar *, Vec *);
770: #endif
771: #if defined(PETSC_HAVE_HIP)
772: PETSC_EXTERN PetscErrorCode VecCreateSeqHIP(MPI_Comm, PetscInt, Vec *);
773: PETSC_EXTERN PetscErrorCode VecCreateSeqHIPWithArray(MPI_Comm, PetscInt, PetscInt, const PetscScalar *, Vec *);
774: PETSC_EXTERN PetscErrorCode VecCreateSeqHIPWithArrays(MPI_Comm, PetscInt, PetscInt, const PetscScalar *, const PetscScalar *, Vec *);
775: PETSC_EXTERN PetscErrorCode VecCreateMPIHIP(MPI_Comm, PetscInt, PetscInt, Vec *);
776: PETSC_EXTERN PetscErrorCode VecCreateMPIHIPWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar *, Vec *);
777: PETSC_EXTERN PetscErrorCode VecCreateMPIHIPWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar *, const PetscScalar *, Vec *);
778: #endif
779: #if defined(PETSC_HAVE_KOKKOS_KERNELS)
780: PETSC_EXTERN PetscErrorCode VecCreateSeqKokkos(MPI_Comm, PetscInt, Vec *);
781: PETSC_EXTERN PetscErrorCode VecCreateSeqKokkosWithArray(MPI_Comm, PetscInt, PetscInt, const PetscScalar *, Vec *);
782: PETSC_EXTERN PetscErrorCode VecCreateMPIKokkos(MPI_Comm, PetscInt, PetscInt, Vec *);
783: PETSC_EXTERN PetscErrorCode VecCreateMPIKokkosWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar *, Vec *);
784: #endif
786: PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec, PetscInt *, Vec **);
787: PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec, PetscInt, Vec *);
788: PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec, PetscInt, PetscInt *, Vec *);
789: PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec, PetscInt, Vec);
790: PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm, PetscInt, IS *, Vec *, Vec *);
791: PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec, PetscInt *);
793: PETSC_EXTERN PetscErrorCode PetscOptionsGetVec(PetscOptions, const char[], const char[], Vec, PetscBool *);
794: PETSC_EXTERN PetscErrorCode VecChop(Vec, PetscReal);
796: PETSC_EXTERN PetscErrorCode VecGetLayout(Vec, PetscLayout *);
797: PETSC_EXTERN PetscErrorCode VecSetLayout(Vec, PetscLayout);
799: PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer);
800: PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar **);
801: PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, PetscScalar[], InsertMode);
802: PETSC_EXTERN PetscErrorCode PetscSectionVecNorm(PetscSection, PetscSection, Vec, NormType, PetscReal[]);
804: /*S
805: VecTagger - Object used to manage the tagging of a subset of indices based on the values of a vector. The
806: motivating application is the selection of cells for refinement or coarsening based on vector containing
807: the values in an error indicator metric.
809: Level: advanced
811: Developer Note:
812: Why not use a `DMLabel` or similar object
814: S*/
815: typedef struct _p_VecTagger *VecTagger;
817: /*J
818: VecTaggerType - String with the name of a `VecTagger` type
820: Level: advanced
821: J*/
822: typedef const char *VecTaggerType;
823: /* tag where the vector values are in a box of explicitly defined values */
824: #define VECTAGGERABSOLUTE "absolute"
825: /* tag where the vector values are in a box of values relative to the set of all values in the vector */
826: #define VECTAGGERRELATIVE "relative"
827: /* tag where the vector values are in a relative range of the *cumulative distribution* of values in the vector */
828: #define VECTAGGERCDF "cdf"
829: /* tag a vector as the union of other tags */
830: #define VECTAGGEROR "or"
831: /* tag a vector as the intersection of other tags */
832: #define VECTAGGERAND "and"
834: PETSC_EXTERN PetscClassId VEC_TAGGER_CLASSID;
835: PETSC_EXTERN PetscFunctionList VecTaggerList;
836: PETSC_EXTERN PetscErrorCode VecTaggerRegister(const char[], PetscErrorCode (*)(VecTagger));
838: PETSC_EXTERN PetscErrorCode VecTaggerCreate(MPI_Comm, VecTagger *);
839: PETSC_EXTERN PetscErrorCode VecTaggerSetBlockSize(VecTagger, PetscInt);
840: PETSC_EXTERN PetscErrorCode VecTaggerGetBlockSize(VecTagger, PetscInt *);
841: PETSC_EXTERN PetscErrorCode VecTaggerSetType(VecTagger, VecTaggerType);
842: PETSC_EXTERN PetscErrorCode VecTaggerGetType(VecTagger, VecTaggerType *);
843: PETSC_EXTERN PetscErrorCode VecTaggerSetInvert(VecTagger, PetscBool);
844: PETSC_EXTERN PetscErrorCode VecTaggerGetInvert(VecTagger, PetscBool *);
845: PETSC_EXTERN PetscErrorCode VecTaggerSetFromOptions(VecTagger);
846: PETSC_EXTERN PetscErrorCode VecTaggerSetUp(VecTagger);
847: PETSC_EXTERN PetscErrorCode VecTaggerView(VecTagger, PetscViewer);
848: PETSC_EXTERN PetscErrorCode VecTaggerComputeIS(VecTagger, Vec, IS *, PetscBool *);
849: PETSC_EXTERN PetscErrorCode VecTaggerDestroy(VecTagger *);
851: /*S
852: VecTaggerBox - A box range used to tag values. For real scalars, this is just a closed interval; for complex scalars, the box is the closed region in the complex plane
853: such that real(min) <= real(z) <= real(max) and imag(min) <= imag(z) <= imag(max). INF is an acceptable endpoint.
855: Level: beginner
857: .seealso: `VecTaggerComputeIntervals()`
858: S*/
859: typedef struct {
860: PetscScalar min;
861: PetscScalar max;
862: } VecTaggerBox;
863: PETSC_EXTERN PetscErrorCode VecTaggerComputeBoxes(VecTagger, Vec, PetscInt *, VecTaggerBox **, PetscBool *);
865: PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteSetBox(VecTagger, VecTaggerBox *);
866: PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteGetBox(VecTagger, const VecTaggerBox **);
868: PETSC_EXTERN PetscErrorCode VecTaggerRelativeSetBox(VecTagger, VecTaggerBox *);
869: PETSC_EXTERN PetscErrorCode VecTaggerRelativeGetBox(VecTagger, const VecTaggerBox **);
871: PETSC_EXTERN PetscErrorCode VecTaggerCDFSetBox(VecTagger, VecTaggerBox *);
872: PETSC_EXTERN PetscErrorCode VecTaggerCDFGetBox(VecTagger, const VecTaggerBox **);
874: /*E
875: 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).
876: Relevant only in parallel: in serial it is directly computed.
878: Level: advanced
880: .seealso: `VecTaggerCDFSetMethod()`, `VecTaggerCDFMethods`
881: E*/
882: typedef enum {
883: VECTAGGER_CDF_GATHER,
884: VECTAGGER_CDF_ITERATIVE,
885: VECTAGGER_CDF_NUM_METHODS
886: } VecTaggerCDFMethod;
887: PETSC_EXTERN const char *const VecTaggerCDFMethods[];
889: PETSC_EXTERN PetscErrorCode VecTaggerCDFSetMethod(VecTagger, VecTaggerCDFMethod);
890: PETSC_EXTERN PetscErrorCode VecTaggerCDFGetMethod(VecTagger, VecTaggerCDFMethod *);
891: PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeSetTolerances(VecTagger, PetscInt, PetscReal, PetscReal);
892: PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeGetTolerances(VecTagger, PetscInt *, PetscReal *, PetscReal *);
894: PETSC_EXTERN PetscErrorCode VecTaggerOrSetSubs(VecTagger, PetscInt, VecTagger *, PetscCopyMode);
895: PETSC_EXTERN PetscErrorCode VecTaggerOrGetSubs(VecTagger, PetscInt *, VecTagger **);
897: PETSC_EXTERN PetscErrorCode VecTaggerAndSetSubs(VecTagger, PetscInt, VecTagger *, PetscCopyMode);
898: PETSC_EXTERN PetscErrorCode VecTaggerAndGetSubs(VecTagger, PetscInt *, VecTagger **);
900: PETSC_EXTERN PetscErrorCode VecTaggerInitializePackage(void);
901: PETSC_EXTERN PetscErrorCode VecTaggerFinalizePackage(void);
903: #if PetscDefined(USE_DEBUG)
904: /* This is an internal debug-only routine that should not be used by users */
905: PETSC_SINGLE_LIBRARY_INTERN PetscErrorCode VecValidValues_Internal(Vec, PetscInt, PetscBool);
906: #else
907: #define VecValidValues_Internal(...) 0
908: #endif /* PETSC_USE_DEBUG */
910: #endif