xref: /petsc/include/petscvec.h (revision dfd57a172ac9fa6c7b5fe6de6ab5df85cefc2996) 
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,NORM_2=1,NORM_FROBENIUS=2,NORM_INFINITY=3,NORM_1_AND_2=4} NormType;
157 PETSC_EXTERN const char *const NormTypes[];
158 #define NORM_MAX NORM_INFINITY
159 
160 /*MC
161      NORM_1 - the one norm, ||v|| = sum_i | v_i |. ||A|| = max_j || v_*j ||, maximum column sum
162 
163    Level: beginner
164 
165 .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_2, NORM_FROBENIUS,
166            NORM_INFINITY, NORM_1_AND_2
167 
168 M*/
169 
170 /*MC
171      NORM_2 - the two norm, ||v|| = sqrt(sum_i |v_i|^2) (vectors only)
172 
173    Level: beginner
174 
175 .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_FROBENIUS,
176            NORM_INFINITY, NORM_1_AND_2
177 
178 M*/
179 
180 /*MC
181      NORM_FROBENIUS - ||A|| = sqrt(sum_ij |A_ij|^2), same as NORM_2 for vectors
182 
183    Level: beginner
184 
185 .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2,
186            NORM_INFINITY, NORM_1_AND_2
187 
188 M*/
189 
190 /*MC
191      NORM_INFINITY - ||v|| = max_i |v_i|. ||A|| = max_i || v_i* ||, maximum row sum
192 
193    Level: beginner
194 
195 .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2,
196            NORM_FROBENIUS, NORM_1_AND_2
197 
198 M*/
199 
200 /*MC
201      NORM_1_AND_2 - computes both the 1 and 2 norm of a vector
202 
203    Level: beginner
204 
205 .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2,
206            NORM_FROBENIUS, NORM_INFINITY
207 
208 M*/
209 
210 /*MC
211      NORM_MAX - see NORM_INFINITY
212 
213    Level: beginner
214 
215 M*/
216 
217 PETSC_EXTERN PetscErrorCode VecNorm(Vec,NormType,PetscReal *);
218 PETSC_EXTERN PetscErrorCode VecNormAvailable(Vec,NormType,PetscBool *,PetscReal *);
219 PETSC_EXTERN PetscErrorCode VecNormalize(Vec,PetscReal *);
220 PETSC_EXTERN PetscErrorCode VecSum(Vec,PetscScalar*);
221 PETSC_EXTERN PetscErrorCode VecMax(Vec,PetscInt*,PetscReal *);
222 PETSC_EXTERN PetscErrorCode VecMin(Vec,PetscInt*,PetscReal *);
223 PETSC_EXTERN PetscErrorCode VecScale(Vec,PetscScalar);
224 PETSC_EXTERN PetscErrorCode VecCopy(Vec,Vec);
225 PETSC_EXTERN PetscErrorCode VecSetRandom(Vec,PetscRandom);
226 PETSC_EXTERN PetscErrorCode VecSet(Vec,PetscScalar);
227 PETSC_EXTERN PetscErrorCode VecSetInf(Vec);
228 PETSC_EXTERN PetscErrorCode VecSwap(Vec,Vec);
229 PETSC_EXTERN PetscErrorCode VecAXPY(Vec,PetscScalar,Vec);
230 PETSC_EXTERN PetscErrorCode VecAXPBY(Vec,PetscScalar,PetscScalar,Vec);
231 PETSC_EXTERN PetscErrorCode VecMAXPY(Vec,PetscInt,const PetscScalar[],Vec[]);
232 PETSC_EXTERN PetscErrorCode VecAYPX(Vec,PetscScalar,Vec);
233 PETSC_EXTERN PetscErrorCode VecWAXPY(Vec,PetscScalar,Vec,Vec);
234 PETSC_EXTERN PetscErrorCode VecAXPBYPCZ(Vec,PetscScalar,PetscScalar,PetscScalar,Vec,Vec);
235 PETSC_EXTERN PetscErrorCode VecPointwiseMax(Vec,Vec,Vec);
236 PETSC_EXTERN PetscErrorCode VecPointwiseMaxAbs(Vec,Vec,Vec);
237 PETSC_EXTERN PetscErrorCode VecPointwiseMin(Vec,Vec,Vec);
238 PETSC_EXTERN PetscErrorCode VecPointwiseMult(Vec,Vec,Vec);
239 PETSC_EXTERN PetscErrorCode VecPointwiseDivide(Vec,Vec,Vec);
240 PETSC_EXTERN PetscErrorCode VecMaxPointwiseDivide(Vec,Vec,PetscReal*);
241 PETSC_EXTERN PetscErrorCode VecShift(Vec,PetscScalar);
242 PETSC_EXTERN PetscErrorCode VecReciprocal(Vec);
243 PETSC_EXTERN PetscErrorCode VecPermute(Vec, IS, PetscBool);
244 PETSC_EXTERN PetscErrorCode VecSqrtAbs(Vec);
245 PETSC_EXTERN PetscErrorCode VecLog(Vec);
246 PETSC_EXTERN PetscErrorCode VecExp(Vec);
247 PETSC_EXTERN PetscErrorCode VecAbs(Vec);
248 PETSC_EXTERN PetscErrorCode VecDuplicate(Vec,Vec*);
249 PETSC_EXTERN PetscErrorCode VecDuplicateVecs(Vec,PetscInt,Vec*[]);
250 PETSC_EXTERN PetscErrorCode VecDestroyVecs(PetscInt, Vec*[]);
251 PETSC_EXTERN PetscErrorCode VecStrideNormAll(Vec,NormType,PetscReal[]);
252 PETSC_EXTERN PetscErrorCode VecStrideMaxAll(Vec,PetscInt [],PetscReal []);
253 PETSC_EXTERN PetscErrorCode VecStrideMinAll(Vec,PetscInt [],PetscReal []);
254 PETSC_EXTERN PetscErrorCode VecStrideScaleAll(Vec,const PetscScalar[]);
255 PETSC_EXTERN PetscErrorCode VecUniqueEntries(Vec,PetscInt*,PetscScalar**);
256 
257 PETSC_EXTERN PetscErrorCode VecStrideNorm(Vec,PetscInt,NormType,PetscReal*);
258 PETSC_EXTERN PetscErrorCode VecStrideMax(Vec,PetscInt,PetscInt *,PetscReal *);
259 PETSC_EXTERN PetscErrorCode VecStrideMin(Vec,PetscInt,PetscInt *,PetscReal *);
260 PETSC_EXTERN PetscErrorCode VecStrideScale(Vec,PetscInt,PetscScalar);
261 PETSC_EXTERN PetscErrorCode VecStrideSet(Vec,PetscInt,PetscScalar);
262 
263 PETSC_EXTERN PetscErrorCode VecStrideGather(Vec,PetscInt,Vec,InsertMode);
264 PETSC_EXTERN PetscErrorCode VecStrideScatter(Vec,PetscInt,Vec,InsertMode);
265 PETSC_EXTERN PetscErrorCode VecStrideGatherAll(Vec,Vec[],InsertMode);
266 PETSC_EXTERN PetscErrorCode VecStrideScatterAll(Vec[],Vec,InsertMode);
267 
268 PETSC_EXTERN PetscErrorCode VecStrideSubSetScatter(Vec,PetscInt,const PetscInt[],const PetscInt[],Vec,InsertMode);
269 PETSC_EXTERN PetscErrorCode VecStrideSubSetGather(Vec,PetscInt,const PetscInt[],const PetscInt[],Vec,InsertMode);
270 
271 PETSC_EXTERN PetscErrorCode VecSetValues(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
272 PETSC_EXTERN PetscErrorCode VecGetValues(Vec,PetscInt,const PetscInt[],PetscScalar[]);
273 PETSC_EXTERN PetscErrorCode VecAssemblyBegin(Vec);
274 PETSC_EXTERN PetscErrorCode VecAssemblyEnd(Vec);
275 PETSC_EXTERN PetscErrorCode VecStashSetInitialSize(Vec,PetscInt,PetscInt);
276 PETSC_EXTERN PetscErrorCode VecStashView(Vec,PetscViewer);
277 PETSC_EXTERN PetscErrorCode VecStashViewFromOptions(Vec,PetscObject,const char[]);
278 PETSC_EXTERN PetscErrorCode VecStashGetInfo(Vec,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
279 
280 /*MC
281    VecSetValue - Set a single entry into a vector.
282 
283    Synopsis:
284    #include <petscvec.h>
285    PetscErrorCode VecSetValue(Vec v,PetscInt row,PetscScalar value, InsertMode mode);
286 
287    Not Collective
288 
289    Input Parameters:
290 +  v - the vector
291 .  row - the row location of the entry
292 .  value - the value to insert
293 -  mode - either INSERT_VALUES or ADD_VALUES
294 
295    Notes:
296    For efficiency one should use VecSetValues() and set several or
297    many values simultaneously if possible.
298 
299    These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd()
300    MUST be called after all calls to VecSetValue() have been completed.
301 
302    VecSetValue() uses 0-based indices in Fortran as well as in C.
303 
304    Level: beginner
305 
306 .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValueLocal()
307 M*/
308 PETSC_STATIC_INLINE PetscErrorCode VecSetValue(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValues(v,1,&i,&va,mode);}
309 
310 PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec,PetscInt);
311 PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec,PetscInt*);
312 PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
313 
314 /* Dynamic creation and loading functions */
315 PETSC_EXTERN PetscFunctionList VecList;
316 PETSC_EXTERN PetscErrorCode VecSetType(Vec,VecType);
317 PETSC_EXTERN PetscErrorCode VecGetType(Vec,VecType*);
318 PETSC_EXTERN PetscErrorCode VecRegister(const char[],PetscErrorCode (*)(Vec));
319 
320 PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter,Vec,Vec,InsertMode,ScatterMode);
321 PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter,Vec,Vec,InsertMode,ScatterMode);
322 PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter*);
323 PETSC_EXTERN PetscErrorCode VecScatterSetUp(VecScatter);
324 PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter,VecScatter *);
325 PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter,PetscViewer);
326 PETSC_EXTERN PetscErrorCode VecScatterViewFromOptions(VecScatter,PetscObject,const char[]);
327 PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter,PetscInt[],PetscInt[]);
328 PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter,PetscBool*);
329 
330 PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
331 PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
332 PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
333 PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
334 PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
335 PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
336 PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec,PetscInt,PetscInt,PetscScalar*[]);
337 PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec,PetscInt,PetscInt,PetscScalar*[]);
338 
339 PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
340 PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
341 PETSC_EXTERN PetscErrorCode VecRestoreArray4dWrite(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
342 PETSC_EXTERN PetscErrorCode VecGetArray3dWrite(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
343 PETSC_EXTERN PetscErrorCode VecRestoreArray3dWrite(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
344 PETSC_EXTERN PetscErrorCode VecGetArray2dWrite(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
345 PETSC_EXTERN PetscErrorCode VecRestoreArray2dWrite(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
346 PETSC_EXTERN PetscErrorCode VecGetArray1dWrite(Vec,PetscInt,PetscInt,PetscScalar*[]);
347 PETSC_EXTERN PetscErrorCode VecRestoreArray1dWrite(Vec,PetscInt,PetscInt,PetscScalar*[]);
348 
349 PETSC_EXTERN PetscErrorCode VecGetArray4dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
350 PETSC_EXTERN PetscErrorCode VecRestoreArray4dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
351 PETSC_EXTERN PetscErrorCode VecGetArray3dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
352 PETSC_EXTERN PetscErrorCode VecRestoreArray3dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
353 PETSC_EXTERN PetscErrorCode VecGetArray2dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
354 PETSC_EXTERN PetscErrorCode VecRestoreArray2dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
355 PETSC_EXTERN PetscErrorCode VecGetArray1dRead(Vec,PetscInt,PetscInt,PetscScalar*[]);
356 PETSC_EXTERN PetscErrorCode VecRestoreArray1dRead(Vec,PetscInt,PetscInt,PetscScalar*[]);
357 
358 PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec,const PetscScalar[]);
359 PETSC_EXTERN PetscErrorCode VecResetArray(Vec);
360 PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec,const PetscScalar[]);
361 
362 PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[],PetscInt,PetscScalar**[]);
363 PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[],PetscInt,PetscScalar**[]);
364 
365 PETSC_EXTERN PetscErrorCode VecView(Vec,PetscViewer);
366 PETSC_EXTERN PetscErrorCode VecEqual(Vec,Vec,PetscBool*);
367 PETSC_EXTERN PetscErrorCode VecLoad(Vec,PetscViewer);
368 
369 PETSC_EXTERN PetscErrorCode VecGetSize(Vec,PetscInt*);
370 PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec,PetscInt*);
371 PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec,PetscInt*,PetscInt*);
372 PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec,const PetscInt*[]);
373 
374 PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping);
375 PETSC_EXTERN PetscErrorCode VecSetValuesLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
376 
377 PETSC_EXTERN PetscErrorCode VecCUDAGetArray(Vec,PetscScalar**);
378 PETSC_EXTERN PetscErrorCode VecCUDARestoreArray(Vec,PetscScalar**);
379 
380 PETSC_EXTERN PetscErrorCode VecCUDAGetArrayRead(Vec,const PetscScalar**);
381 PETSC_EXTERN PetscErrorCode VecCUDARestoreArrayRead(Vec,const PetscScalar**);
382 
383 PETSC_EXTERN PetscErrorCode VecCUDAGetArrayWrite(Vec,PetscScalar**);
384 PETSC_EXTERN PetscErrorCode VecCUDARestoreArrayWrite(Vec,PetscScalar**);
385 
386 PETSC_EXTERN PetscErrorCode VecCUDAPlaceArray(Vec,const PetscScalar[]);
387 PETSC_EXTERN PetscErrorCode VecCUDAReplaceArray(Vec,const PetscScalar[]);
388 PETSC_EXTERN PetscErrorCode VecCUDAResetArray(Vec);
389 
390 PETSC_EXTERN PetscErrorCode VecHIPGetArray(Vec,PetscScalar**);
391 PETSC_EXTERN PetscErrorCode VecHIPRestoreArray(Vec,PetscScalar**);
392 
393 PETSC_EXTERN PetscErrorCode VecHIPGetArrayRead(Vec,const PetscScalar**);
394 PETSC_EXTERN PetscErrorCode VecHIPRestoreArrayRead(Vec,const PetscScalar**);
395 
396 PETSC_EXTERN PetscErrorCode VecHIPGetArrayWrite(Vec,PetscScalar**);
397 PETSC_EXTERN PetscErrorCode VecHIPRestoreArrayWrite(Vec,PetscScalar**);
398 
399 PETSC_EXTERN PetscErrorCode VecHIPPlaceArray(Vec,const PetscScalar[]);
400 PETSC_EXTERN PetscErrorCode VecHIPReplaceArray(Vec,const PetscScalar[]);
401 PETSC_EXTERN PetscErrorCode VecHIPResetArray(Vec);
402 
403 PETSC_EXTERN PetscErrorCode VecViennaCLGetCLContext(Vec, PETSC_UINTPTR_T*);
404 PETSC_EXTERN PetscErrorCode VecViennaCLGetCLQueue(Vec, PETSC_UINTPTR_T*);
405 PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemRead(Vec, PETSC_UINTPTR_T*);
406 PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemWrite(Vec, PETSC_UINTPTR_T*);
407 PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMemWrite(Vec);
408 PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMem(Vec, PETSC_UINTPTR_T*);
409 PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMem(Vec);
410 
411 /*MC
412    VecSetValueLocal - Set a single entry into a vector using the local numbering
413 
414    Synopsis:
415    #include <petscvec.h>
416    PetscErrorCode VecSetValueLocal(Vec v,PetscInt row,PetscScalar value, InsertMode mode);
417 
418    Not Collective
419 
420    Input Parameters:
421 +  v - the vector
422 .  row - the row location of the entry
423 .  value - the value to insert
424 -  mode - either INSERT_VALUES or ADD_VALUES
425 
426    Notes:
427    For efficiency one should use VecSetValues() and set several or
428    many values simultaneously if possible.
429 
430    These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd()
431    MUST be called after all calls to VecSetValues() have been completed.
432 
433    VecSetValues() uses 0-based indices in Fortran as well as in C.
434 
435    Level: beginner
436 
437 .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValue()
438 M*/
439 PETSC_STATIC_INLINE PetscErrorCode VecSetValueLocal(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValuesLocal(v,1,&i,&va,mode);}
440 
441 PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
442 PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping*);
443 
444 PETSC_EXTERN PetscErrorCode VecDotBegin(Vec,Vec,PetscScalar *);
445 PETSC_EXTERN PetscErrorCode VecDotEnd(Vec,Vec,PetscScalar *);
446 PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec,Vec,PetscScalar *);
447 PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec,Vec,PetscScalar *);
448 PETSC_EXTERN PetscErrorCode VecNormBegin(Vec,NormType,PetscReal *);
449 PETSC_EXTERN PetscErrorCode VecNormEnd(Vec,NormType,PetscReal *);
450 
451 PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]);
452 PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]);
453 PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]);
454 PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]);
455 PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm);
456 
457 PETSC_EXTERN PetscErrorCode VecBindToCPU(Vec,PetscBool);
458 PETSC_DEPRECATED_FUNCTION("Use VecBindToCPU (since v3.13)") PETSC_STATIC_INLINE PetscErrorCode VecPinToCPU(Vec v,PetscBool flg) {return VecBindToCPU(v,flg);}
459 PETSC_EXTERN PetscErrorCode VecSetPinnedMemoryMin(Vec,size_t);
460 PETSC_EXTERN PetscErrorCode VecGetPinnedMemoryMin(Vec,size_t *);
461 
462 PETSC_EXTERN PetscErrorCode VecGetOffloadMask(Vec,PetscOffloadMask *);
463 
464 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES,VEC_IGNORE_NEGATIVE_INDICES,VEC_SUBSET_OFF_PROC_ENTRIES} VecOption;
465 PETSC_EXTERN PetscErrorCode VecSetOption(Vec,VecOption,PetscBool);
466 
467 PETSC_EXTERN PetscErrorCode VecGetArray(Vec,PetscScalar**);
468 PETSC_EXTERN PetscErrorCode VecGetArrayWrite(Vec,PetscScalar**);
469 PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec,const PetscScalar**);
470 PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec,PetscScalar**);
471 PETSC_EXTERN PetscErrorCode VecRestoreArrayWrite(Vec,PetscScalar**);
472 PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec,const PetscScalar**);
473 PETSC_EXTERN PetscErrorCode VecGetLocalVector(Vec,Vec);
474 PETSC_EXTERN PetscErrorCode VecRestoreLocalVector(Vec,Vec);
475 PETSC_EXTERN PetscErrorCode VecGetLocalVectorRead(Vec,Vec);
476 PETSC_EXTERN PetscErrorCode VecRestoreLocalVectorRead(Vec,Vec);
477 PETSC_EXTERN PetscErrorCode VecGetArrayAndMemType(Vec,PetscScalar**,PetscMemType*);
478 PETSC_EXTERN PetscErrorCode VecRestoreArrayAndMemType(Vec,PetscScalar**);
479 PETSC_EXTERN PetscErrorCode VecGetArrayReadAndMemType(Vec,const PetscScalar**,PetscMemType*);
480 PETSC_EXTERN PetscErrorCode VecRestoreArrayReadAndMemType(Vec,const PetscScalar**);
481 
482 /*@C
483    VecGetArrayPair - Accesses a pair of pointers for two vectors that may be common. When not common the first is read only
484 
485    Logically Collective on x
486 
487    Input Parameters:
488 +  x - the vector
489 -  y - the second vector
490 
491    Output Parameters:
492 +  xv - location to put pointer to the first array
493 -  yv - location to put pointer to the second array
494 
495    Level: developer
496 
497    Not available from Fortran
498 
499 .seealso: VecGetArray(), VecGetArrayRead(), VecRestoreArrayPair()
500 
501 @*/
502 PETSC_STATIC_INLINE PetscErrorCode VecGetArrayPair(Vec x,Vec y,PetscScalar **xv,PetscScalar **yv)
503 {
504   PetscErrorCode ierr;
505 
506   PetscFunctionBegin;
507   ierr = VecGetArray(y,yv);CHKERRQ(ierr);
508   if (x != y) {
509     ierr = VecGetArrayRead(x,(const PetscScalar **)xv);CHKERRQ(ierr);
510   } else {
511     *xv = *yv;
512   }
513   PetscFunctionReturn(0);
514 }
515 
516 /*@C
517    VecRestoreArrayPair - Returns a pair of pointers for two vectors that may be common. When not common the first is read only
518 
519    Logically Collective on x
520 
521    Input Parameters:
522 +  x - the vector
523 -  y - the second vector
524 
525    Output Parameters:
526 +  xv - location to put pointer to the first array
527 -  yv - location to put pointer to the second array
528 
529    Level: developer
530 
531    Not available from Fortran
532 
533 .seealso: VecGetArray(), VecGetArrayRead(), VecGetArrayPair()
534 
535 @*/
536 PETSC_STATIC_INLINE PetscErrorCode VecRestoreArrayPair(Vec x,Vec y,PetscScalar **xv,PetscScalar **yv)
537 {
538   PetscErrorCode ierr;
539 
540   PetscFunctionBegin;
541   ierr = VecRestoreArray(y,yv);CHKERRQ(ierr);
542   if (x != y) {
543     ierr = VecRestoreArrayRead(x,(const PetscScalar **)xv);CHKERRQ(ierr);
544   }
545   PetscFunctionReturn(0);
546 }
547 
548 #if defined(PETSC_USE_DEBUG)
549 PETSC_EXTERN PetscErrorCode VecLockReadPush(Vec);
550 PETSC_EXTERN PetscErrorCode VecLockReadPop(Vec);
551 /* We also have a non-public VecLockWriteSet_Private() in vecimpl.h */
552 PETSC_EXTERN PetscErrorCode VecLockGet(Vec,PetscInt*);
553 PETSC_STATIC_INLINE PetscErrorCode VecSetErrorIfLocked(Vec x,PetscInt arg)
554 {
555   PetscInt       state;
556   PetscErrorCode ierr;
557 
558   PetscFunctionBegin;
559   ierr = VecLockGet(x,&state);CHKERRQ(ierr);
560   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);
561   PetscFunctionReturn(0);
562 }
563 /* The three are deprecated */
564 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use VecLockReadPush() (since version 3.11)") PetscErrorCode VecLockPush(Vec);
565 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use VecLockReadPop() (since version 3.11)")  PetscErrorCode VecLockPop(Vec);
566 #define VecLocked(x,arg) VecSetErrorIfLocked(x,arg) PETSC_DEPRECATED_MACRO("GCC warning \"Use VecSetErrorIfLocked() (since version 3.11)\"")
567 #else
568 #define VecLockReadPush(x)           0
569 #define VecLockReadPop(x)            0
570 #define VecLockGet(x,s)              *(s) = 0
571 #define VecSetErrorIfLocked(x,arg)   0
572 /* The three are deprecated */
573 #define VecLockPush(x)               0
574 #define VecLockPop(x)                0
575 #define VecLocked(x,arg)             0
576 #endif
577 
578 PETSC_EXTERN PetscErrorCode VecValidValues(Vec,PetscInt,PetscBool);
579 
580 /*
581     These numbers need to match the entries in
582   the function table in vecimpl.h
583 */
584 typedef enum { VECOP_DUPLICATE = 0, VECOP_VIEW = 33, VECOP_LOAD = 41, VECOP_VIEWNATIVE = 68, VECOP_LOADNATIVE = 69 } VecOperation;
585 PETSC_EXTERN PetscErrorCode VecSetOperation(Vec,VecOperation,void(*)(void));
586 
587 /*
588      Routines for dealing with ghosted vectors:
589   vectors with ghost elements at the end of the array.
590 */
591 PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec,PetscInt,const PetscInt[]);
592 PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*);
593 PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*);
594 PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*);
595 PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*);
596 PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec,Vec*);
597 PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec,Vec*);
598 PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec,Vec,PetscBool*);
599 PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec,InsertMode,ScatterMode);
600 PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec,InsertMode,ScatterMode);
601 
602 PETSC_EXTERN PetscErrorCode VecConjugate(Vec);
603 PETSC_EXTERN PetscErrorCode VecImaginaryPart(Vec);
604 PETSC_EXTERN PetscErrorCode VecRealPart(Vec);
605 
606 PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec,VecScatter*,Vec*);
607 PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec,VecScatter*,Vec*);
608 
609 PETSC_EXTERN PetscErrorCode ISComplementVec(IS,Vec,IS*);
610 PETSC_EXTERN PetscErrorCode VecPow(Vec, PetscScalar);
611 PETSC_EXTERN PetscErrorCode VecMedian(Vec, Vec, Vec, Vec);
612 PETSC_EXTERN PetscErrorCode VecWhichInactive(Vec, Vec, Vec, Vec, PetscBool, IS *);
613 PETSC_EXTERN PetscErrorCode VecWhichBetween(Vec, Vec, Vec, IS *);
614 PETSC_EXTERN PetscErrorCode VecWhichBetweenOrEqual(Vec, Vec, Vec, IS *);
615 PETSC_EXTERN PetscErrorCode VecWhichGreaterThan(Vec, Vec, IS *);
616 PETSC_EXTERN PetscErrorCode VecWhichLessThan(Vec, Vec, IS *);
617 PETSC_EXTERN PetscErrorCode VecWhichEqual(Vec, Vec, IS *);
618 PETSC_EXTERN PetscErrorCode VecISAXPY(Vec, IS, PetscScalar,Vec);
619 PETSC_EXTERN PetscErrorCode VecISCopy(Vec, IS, ScatterMode, Vec);
620 PETSC_EXTERN PetscErrorCode VecISSet(Vec,IS, PetscScalar);
621 PETSC_EXTERN PetscErrorCode VecBoundGradientProjection(Vec, Vec, Vec, Vec, Vec);
622 PETSC_EXTERN PetscErrorCode VecStepBoundInfo(Vec,Vec,Vec,Vec,PetscReal*, PetscReal*,PetscReal*);
623 PETSC_EXTERN PetscErrorCode VecStepMax(Vec, Vec, PetscReal *);
624 PETSC_EXTERN PetscErrorCode VecStepMaxBounded(Vec,Vec,Vec,Vec,PetscReal*);
625 
626 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec);
627 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec);
628 
629 /*S
630      Vecs - Collection of vectors where the data for the vectors is stored in
631             one contiguous memory
632 
633    Level: advanced
634 
635    Notes:
636     Temporary construct for handling multiply right hand side solves
637 
638     This is faked by storing a single vector that has enough array space for
639     n vectors
640 
641 S*/
642         struct _n_Vecs  {PetscInt n; Vec v;};
643 typedef struct _n_Vecs* Vecs;
644 PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs);
645 PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm,PetscInt,PetscInt,Vecs*);
646 PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,PetscScalar*,Vecs*);
647 PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs,Vecs*);
648 
649 #if defined(PETSC_HAVE_VIENNACL)
650 typedef struct _p_PetscViennaCLIndices* PetscViennaCLIndices;
651 PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesCreate(PetscInt, PetscInt*,PetscInt, PetscInt*,PetscViennaCLIndices*);
652 PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesDestroy(PetscViennaCLIndices*);
653 PETSC_EXTERN PetscErrorCode VecViennaCLCopyToGPUSome_Public(Vec,PetscViennaCLIndices);
654 PETSC_EXTERN PetscErrorCode VecViennaCLCopyFromGPUSome_Public(Vec,PetscViennaCLIndices);
655 PETSC_EXTERN PetscErrorCode VecCreateSeqViennaCL(MPI_Comm,PetscInt,Vec*);
656 PETSC_EXTERN PetscErrorCode VecCreateMPIViennaCL(MPI_Comm,PetscInt,PetscInt,Vec*);
657 #endif
658 #if defined(PETSC_HAVE_CUDA) || defined(PETSC_HAVE_HIP)
659 PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter,Vec);
660 PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter);
661 #endif
662 #if defined(PETSC_HAVE_CUDA)
663 PETSC_EXTERN PetscErrorCode VecCreateSeqCUDA(MPI_Comm,PetscInt,Vec*);
664 PETSC_EXTERN PetscErrorCode VecCreateSeqCUDAWithArray(MPI_Comm,PetscInt,PetscInt,const PetscScalar*,Vec*);
665 PETSC_EXTERN PetscErrorCode VecCreateSeqCUDAWithArrays(MPI_Comm,PetscInt,PetscInt,const PetscScalar*,const PetscScalar*,Vec*);
666 PETSC_EXTERN PetscErrorCode VecCreateMPICUDA(MPI_Comm,PetscInt,PetscInt,Vec*);
667 PETSC_EXTERN PetscErrorCode VecCreateMPICUDAWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar*,Vec*);
668 PETSC_EXTERN PetscErrorCode VecCreateMPICUDAWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar*,const PetscScalar*,Vec*);
669 #endif
670 #if defined(PETSC_HAVE_HIP)
671 PETSC_EXTERN PetscErrorCode VecCreateSeqHIP(MPI_Comm,PetscInt,Vec*);
672 PETSC_EXTERN PetscErrorCode VecCreateSeqHIPWithArray(MPI_Comm,PetscInt,PetscInt,const PetscScalar*,Vec*);
673 PETSC_EXTERN PetscErrorCode VecCreateSeqHIPWithArrays(MPI_Comm,PetscInt,PetscInt,const PetscScalar*,const PetscScalar*,Vec*);
674 PETSC_EXTERN PetscErrorCode VecCreateMPIHIP(MPI_Comm,PetscInt,PetscInt,Vec*);
675 PETSC_EXTERN PetscErrorCode VecCreateMPIHIPWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar*,Vec*);
676 PETSC_EXTERN PetscErrorCode VecCreateMPIHIPWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar*,const PetscScalar*,Vec*);
677 #endif
678 #if defined(PETSC_HAVE_KOKKOS_KERNELS)
679 PETSC_EXTERN PetscErrorCode VecCreateSeqKokkos(MPI_Comm,PetscInt,Vec*);
680 PETSC_EXTERN PetscErrorCode VecCreateSeqKokkosWithArray(MPI_Comm,PetscInt,PetscInt,const PetscScalar*,Vec*);
681 PETSC_EXTERN PetscErrorCode VecCreateMPIKokkos(MPI_Comm,PetscInt,PetscInt,Vec*);
682 PETSC_EXTERN PetscErrorCode VecCreateMPIKokkosWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar*,Vec*);
683 #endif
684 
685 PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec,PetscInt*,Vec**);
686 PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec,PetscInt,Vec*);
687 PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec,PetscInt,PetscInt*,Vec*);
688 PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec,PetscInt,Vec);
689 PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm,PetscInt,IS*,Vec*,Vec*);
690 PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec,PetscInt*);
691 
692 PETSC_EXTERN PetscErrorCode PetscOptionsGetVec(PetscOptions,const char[],const char[],Vec,PetscBool*);
693 PETSC_EXTERN PetscErrorCode VecChop(Vec,PetscReal);
694 
695 PETSC_EXTERN PetscErrorCode VecGetLayout(Vec,PetscLayout*);
696 PETSC_EXTERN PetscErrorCode VecSetLayout(Vec,PetscLayout);
697 
698 PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer);
699 PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar **);
700 PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, PetscScalar [], InsertMode);
701 PETSC_EXTERN PetscErrorCode PetscSectionVecNorm(PetscSection, PetscSection, Vec, NormType, PetscReal []);
702 
703 /*S
704   VecTagger - Object used to manage the tagging of a subset of indices based on the values of a vector.  The
705               motivating application is the selection of cells for refinement or coarsening based on vector containing
706               the values in an error indicator metric.
707 
708   Level: advanced
709 S*/
710 typedef struct _p_VecTagger *VecTagger;
711 
712 /*J
713   VecTaggerType - String with the name of a VecTagger type
714 
715   Level: advanced
716 J*/
717 typedef const char* VecTaggerType;
718 /* tag where the vector values are in a box of explicitly defined values */
719 #define VECTAGGERABSOLUTE   "absolute"
720 /* tag where the vector values are in a box of values relative to the set of all values in the vector */
721 #define VECTAGGERRELATIVE   "relative"
722 /* tag where the vector values are in a relative range of the *cumulative distribution* of values in the vector */
723 #define VECTAGGERCDF        "cdf"
724 /* tag a vector as the union of other tags */
725 #define VECTAGGEROR         "or"
726 /* tag a vector as the intersection of other tags */
727 #define VECTAGGERAND        "and"
728 
729 PETSC_EXTERN PetscClassId VEC_TAGGER_CLASSID;
730 PETSC_EXTERN PetscFunctionList VecTaggerList;
731 PETSC_EXTERN PetscErrorCode VecTaggerRegister(const char[],PetscErrorCode (*) (VecTagger));
732 
733 PETSC_EXTERN PetscErrorCode VecTaggerCreate(MPI_Comm,VecTagger *);
734 PETSC_EXTERN PetscErrorCode VecTaggerSetBlockSize(VecTagger,PetscInt);
735 PETSC_EXTERN PetscErrorCode VecTaggerGetBlockSize(VecTagger,PetscInt*);
736 PETSC_EXTERN PetscErrorCode VecTaggerSetType(VecTagger,VecTaggerType);
737 PETSC_EXTERN PetscErrorCode VecTaggerGetType(VecTagger,VecTaggerType *);
738 PETSC_EXTERN PetscErrorCode VecTaggerSetInvert(VecTagger,PetscBool);
739 PETSC_EXTERN PetscErrorCode VecTaggerGetInvert(VecTagger,PetscBool*);
740 PETSC_EXTERN PetscErrorCode VecTaggerSetFromOptions(VecTagger);
741 PETSC_EXTERN PetscErrorCode VecTaggerSetUp(VecTagger);
742 PETSC_EXTERN PetscErrorCode VecTaggerView(VecTagger,PetscViewer);
743 PETSC_EXTERN PetscErrorCode VecTaggerComputeIS(VecTagger,Vec,IS *);
744 PETSC_EXTERN PetscErrorCode VecTaggerDestroy(VecTagger *);
745 
746 /*S
747    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
748    such that real(min) <= real(z) <= real(max) and imag(min) <= imag(z) <= imag(max).  INF is an acceptable endpoint.
749 
750    Level: beginner
751 
752 .seealso: VecTaggerComputeIntervals()
753 S*/
754 typedef struct {
755   PetscScalar min;
756   PetscScalar max;
757 } VecTaggerBox;
758 PETSC_EXTERN PetscErrorCode VecTaggerComputeBoxes(VecTagger,Vec,PetscInt *,VecTaggerBox **);
759 
760 PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteSetBox(VecTagger,VecTaggerBox *);
761 PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteGetBox(VecTagger,const VecTaggerBox **);
762 
763 PETSC_EXTERN PetscErrorCode VecTaggerRelativeSetBox(VecTagger,VecTaggerBox *);
764 PETSC_EXTERN PetscErrorCode VecTaggerRelativeGetBox(VecTagger,const VecTaggerBox **);
765 
766 PETSC_EXTERN PetscErrorCode VecTaggerCDFSetBox(VecTagger,VecTaggerBox *);
767 PETSC_EXTERN PetscErrorCode VecTaggerCDFGetBox(VecTagger,const VecTaggerBox **);
768 
769 /*E
770   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.
771 
772   Level: advanced
773 .seealso: VecTaggerCDFSetMethod(), VecTaggerCDFMethods
774 E*/
775 typedef enum {VECTAGGER_CDF_GATHER,VECTAGGER_CDF_ITERATIVE,VECTAGGER_CDF_NUM_METHODS} VecTaggerCDFMethod;
776 PETSC_EXTERN const char *const VecTaggerCDFMethods[];
777 
778 PETSC_EXTERN PetscErrorCode VecTaggerCDFSetMethod(VecTagger,VecTaggerCDFMethod);
779 PETSC_EXTERN PetscErrorCode VecTaggerCDFGetMethod(VecTagger,VecTaggerCDFMethod*);
780 PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeSetTolerances(VecTagger,PetscInt,PetscReal,PetscReal);
781 PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeGetTolerances(VecTagger,PetscInt*,PetscReal*,PetscReal*);
782 
783 PETSC_EXTERN PetscErrorCode VecTaggerOrSetSubs(VecTagger,PetscInt,VecTagger*,PetscCopyMode);
784 PETSC_EXTERN PetscErrorCode VecTaggerOrGetSubs(VecTagger,PetscInt*,VecTagger**);
785 
786 PETSC_EXTERN PetscErrorCode VecTaggerAndSetSubs(VecTagger,PetscInt,VecTagger*,PetscCopyMode);
787 PETSC_EXTERN PetscErrorCode VecTaggerAndGetSubs(VecTagger,PetscInt*,VecTagger**);
788 
789 PETSC_EXTERN PetscErrorCode VecTaggerInitializePackage(void);
790 PETSC_EXTERN PetscErrorCode VecTaggerFinalizePackage(void);
791 
792 #endif
793