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