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