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