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