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