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