Actual source code: petscvec.h

petsc-master 2020-09-18
Report Typos and Errors
  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: */

  7: #ifndef PETSCVEC_H
  8: #define PETSCVEC_H
  9: #include <petscis.h>
 10: #include <petscviewer.h>

 12: /*S
 13:      Vec - Abstract PETSc vector object

 15:    Level: beginner

 17: .seealso:  VecCreate(), VecType, VecSetType()
 18: S*/
 19: typedef struct _p_Vec*         Vec;

 21: /*S
 22:      VecScatter - Object used to manage communication of data
 23:        between vectors in parallel. Manages both scatters and gathers

 25:    Level: beginner

 27: .seealso:  VecScatterCreate(), VecScatterBegin(), VecScatterEnd()
 28: S*/
 29: typedef struct _p_VecScatter*  VecScatter;

 31: /*E
 32:   ScatterMode - Determines the direction of a scatter

 34:   Level: beginner

 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;

 40: /*MC
 41:     SCATTER_FORWARD - Scatters the values as dictated by the VecScatterCreate() call

 43:     Level: beginner

 45: .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_REVERSE, SCATTER_FORWARD_LOCAL,
 46:           SCATTER_REVERSE_LOCAL

 48: M*/

 50: /*MC
 51:     SCATTER_REVERSE - Moves the values in the opposite direction then the directions indicated in
 52:          in the VecScatterCreate()

 54:     Level: beginner

 56: .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_FORWARD, SCATTER_FORWARD_LOCAL,
 57:           SCATTER_REVERSE_LOCAL

 59: M*/

 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

 65:     Level: developer

 67: .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_REVERSE, SCATTER_FORWARD,
 68:           SCATTER_REVERSE_LOCAL

 70: M*/

 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

 77:     Level: developer

 79: .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_FORWARD, SCATTER_FORWARD_LOCAL,
 80:           SCATTER_REVERSE

 82: M*/

 84: /*J
 85:     VecType - String with the name of a PETSc vector

 87:    Level: beginner

 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 */

105: /*J
106:     VecScatterType - String with the name of a PETSc vector scatter type

108:    Level: beginner

110: .seealso: VecScatterSetType(), VecScatter, VecScatterCreate(), VecScatterDestroy()
111: J*/
112: typedef const char* VecScatterType;
113: #define VECSCATTERSEQ       "seq"
114: #define VECSCATTERMPI1      "mpi1"
115: #define VECSCATTERMPI3      "mpi3"     /* use MPI3 on-node shared memory */
116: #define VECSCATTERMPI3NODE  "mpi3node" /* use MPI3 on-node shared memory for vector type VECNODE */
117: #define VECSCATTERSF        "sf"       /* use StarForest */

119: /* Dynamic creation and loading functions */
120: PETSC_EXTERN PetscFunctionList VecScatterList;
121: PETSC_EXTERN PetscErrorCode VecScatterSetType(VecScatter, VecScatterType);
122: PETSC_EXTERN PetscErrorCode VecScatterGetType(VecScatter, VecScatterType *);
123: PETSC_EXTERN PetscErrorCode VecScatterSetFromOptions(VecScatter);
124: PETSC_EXTERN PetscErrorCode VecScatterRegister(const char[],PetscErrorCode (*)(VecScatter));
125: PETSC_EXTERN PetscErrorCode VecScatterCreate(Vec,IS,Vec,IS,VecScatter*);
126: PETSC_EXTERN PetscErrorCode VecScatterInitializePackage(void);
127: PETSC_EXTERN PetscErrorCode VecScatterFinalizePackage(void);

129: /* Logging support */
130: #define    REAL_FILE_CLASSID 1211213
131: #define    VEC_FILE_CLASSID 1211214
132: PETSC_EXTERN PetscClassId VEC_CLASSID;
133: PETSC_EXTERN PetscClassId VEC_SCATTER_CLASSID;


136: PETSC_EXTERN PetscErrorCode VecInitializePackage(void);
137: PETSC_EXTERN PetscErrorCode VecFinalizePackage(void);

139: PETSC_EXTERN PetscErrorCode VecCreate(MPI_Comm,Vec*);
140: PETSC_EXTERN PetscErrorCode VecCreateSeq(MPI_Comm,PetscInt,Vec*);
141: PETSC_EXTERN PetscErrorCode VecCreateMPI(MPI_Comm,PetscInt,PetscInt,Vec*);
142: PETSC_EXTERN PetscErrorCode VecCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,const PetscScalar[],Vec*);
143: PETSC_EXTERN PetscErrorCode VecCreateMPIWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar[],Vec*);
144: PETSC_EXTERN PetscErrorCode VecCreateShared(MPI_Comm,PetscInt,PetscInt,Vec*);
145: PETSC_EXTERN PetscErrorCode VecCreateNode(MPI_Comm,PetscInt,PetscInt,Vec*);

147: PETSC_EXTERN PetscErrorCode VecSetFromOptions(Vec);
148: PETSC_EXTERN PetscErrorCode VecViewFromOptions(Vec,PetscObject,const char[]);

150: PETSC_EXTERN PetscErrorCode VecSetUp(Vec);
151: PETSC_EXTERN PetscErrorCode VecDestroy(Vec*);
152: PETSC_EXTERN PetscErrorCode VecZeroEntries(Vec);
153: PETSC_EXTERN PetscErrorCode VecSetOptionsPrefix(Vec,const char[]);
154: PETSC_EXTERN PetscErrorCode VecAppendOptionsPrefix(Vec,const char[]);
155: PETSC_EXTERN PetscErrorCode VecGetOptionsPrefix(Vec,const char*[]);

157: PETSC_EXTERN PetscErrorCode VecSetSizes(Vec,PetscInt,PetscInt);

159: PETSC_EXTERN PetscErrorCode VecDotNorm2(Vec,Vec,PetscScalar*,PetscReal*);
160: PETSC_EXTERN PetscErrorCode VecDot(Vec,Vec,PetscScalar*);
161: PETSC_EXTERN PetscErrorCode VecDotRealPart(Vec,Vec,PetscReal*);
162: PETSC_EXTERN PetscErrorCode VecTDot(Vec,Vec,PetscScalar*);
163: PETSC_EXTERN PetscErrorCode VecMDot(Vec,PetscInt,const Vec[],PetscScalar[]);
164: PETSC_EXTERN PetscErrorCode VecMTDot(Vec,PetscInt,const Vec[],PetscScalar[]);
165: PETSC_EXTERN PetscErrorCode VecGetSubVector(Vec,IS,Vec*);
166: PETSC_EXTERN PetscErrorCode VecRestoreSubVector(Vec,IS,Vec*);

168: /*E
169:     NormType - determines what type of norm to compute

171:     Level: beginner

173: .seealso: VecNorm(), VecNormBegin(), VecNormEnd(), MatNorm()
174: E*/
175: typedef enum {NORM_1=0,NORM_2=1,NORM_FROBENIUS=2,NORM_INFINITY=3,NORM_1_AND_2=4} NormType;
176: PETSC_EXTERN const char *const NormTypes[];
177: #define NORM_MAX NORM_INFINITY

179: /*MC
180:      NORM_1 - the one norm, ||v|| = sum_i | v_i |. ||A|| = max_j || v_*j ||, maximum column sum

182:    Level: beginner

184: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_2, NORM_FROBENIUS,
185:            NORM_INFINITY, NORM_1_AND_2

187: M*/

189: /*MC
190:      NORM_2 - the two norm, ||v|| = sqrt(sum_i |v_i|^2) (vectors only)

192:    Level: beginner

194: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_FROBENIUS,
195:            NORM_INFINITY, NORM_1_AND_2

197: M*/

199: /*MC
200:      NORM_FROBENIUS - ||A|| = sqrt(sum_ij |A_ij|^2), same as NORM_2 for vectors

202:    Level: beginner

204: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2,
205:            NORM_INFINITY, NORM_1_AND_2

207: M*/

209: /*MC
210:      NORM_INFINITY - ||v|| = max_i |v_i|. ||A|| = max_i || v_i* ||, maximum row sum

212:    Level: beginner

214: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2,
215:            NORM_FROBINIUS, NORM_1_AND_2

217: M*/

219: /*MC
220:      NORM_1_AND_2 - computes both the 1 and 2 norm of a vector

222:    Level: beginner

224: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2,
225:            NORM_FROBINIUS, NORM_INFINITY

227: M*/

229: /*MC
230:      NORM_MAX - see NORM_INFINITY

232:    Level: beginner

234: M*/

236: PETSC_EXTERN PetscErrorCode VecNorm(Vec,NormType,PetscReal *);
237: PETSC_EXTERN PetscErrorCode VecNormAvailable(Vec,NormType,PetscBool *,PetscReal *);
238: PETSC_EXTERN PetscErrorCode VecNormalize(Vec,PetscReal *);
239: PETSC_EXTERN PetscErrorCode VecSum(Vec,PetscScalar*);
240: PETSC_EXTERN PetscErrorCode VecMax(Vec,PetscInt*,PetscReal *);
241: PETSC_EXTERN PetscErrorCode VecMin(Vec,PetscInt*,PetscReal *);
242: PETSC_EXTERN PetscErrorCode VecScale(Vec,PetscScalar);
243: PETSC_EXTERN PetscErrorCode VecCopy(Vec,Vec);
244: PETSC_EXTERN PetscErrorCode VecSetRandom(Vec,PetscRandom);
245: PETSC_EXTERN PetscErrorCode VecSet(Vec,PetscScalar);
246: PETSC_EXTERN PetscErrorCode VecSetInf(Vec);
247: PETSC_EXTERN PetscErrorCode VecSwap(Vec,Vec);
248: PETSC_EXTERN PetscErrorCode VecAXPY(Vec,PetscScalar,Vec);
249: PETSC_EXTERN PetscErrorCode VecAXPBY(Vec,PetscScalar,PetscScalar,Vec);
250: PETSC_EXTERN PetscErrorCode VecMAXPY(Vec,PetscInt,const PetscScalar[],Vec[]);
251: PETSC_EXTERN PetscErrorCode VecAYPX(Vec,PetscScalar,Vec);
252: PETSC_EXTERN PetscErrorCode VecWAXPY(Vec,PetscScalar,Vec,Vec);
253: PETSC_EXTERN PetscErrorCode VecAXPBYPCZ(Vec,PetscScalar,PetscScalar,PetscScalar,Vec,Vec);
254: PETSC_EXTERN PetscErrorCode VecPointwiseMax(Vec,Vec,Vec);
255: PETSC_EXTERN PetscErrorCode VecPointwiseMaxAbs(Vec,Vec,Vec);
256: PETSC_EXTERN PetscErrorCode VecPointwiseMin(Vec,Vec,Vec);
257: PETSC_EXTERN PetscErrorCode VecPointwiseMult(Vec,Vec,Vec);
258: PETSC_EXTERN PetscErrorCode VecPointwiseDivide(Vec,Vec,Vec);
259: PETSC_EXTERN PetscErrorCode VecMaxPointwiseDivide(Vec,Vec,PetscReal*);
260: PETSC_EXTERN PetscErrorCode VecShift(Vec,PetscScalar);
261: PETSC_EXTERN PetscErrorCode VecReciprocal(Vec);
262: PETSC_EXTERN PetscErrorCode VecPermute(Vec, IS, PetscBool);
263: PETSC_EXTERN PetscErrorCode VecSqrtAbs(Vec);
264: PETSC_EXTERN PetscErrorCode VecLog(Vec);
265: PETSC_EXTERN PetscErrorCode VecExp(Vec);
266: PETSC_EXTERN PetscErrorCode VecAbs(Vec);
267: PETSC_EXTERN PetscErrorCode VecDuplicate(Vec,Vec*);
268: PETSC_EXTERN PetscErrorCode VecDuplicateVecs(Vec,PetscInt,Vec*[]);
269: PETSC_EXTERN PetscErrorCode VecDestroyVecs(PetscInt, Vec*[]);
270: PETSC_EXTERN PetscErrorCode VecStrideNormAll(Vec,NormType,PetscReal[]);
271: PETSC_EXTERN PetscErrorCode VecStrideMaxAll(Vec,PetscInt [],PetscReal []);
272: PETSC_EXTERN PetscErrorCode VecStrideMinAll(Vec,PetscInt [],PetscReal []);
273: PETSC_EXTERN PetscErrorCode VecStrideScaleAll(Vec,const PetscScalar[]);
274: PETSC_EXTERN PetscErrorCode VecUniqueEntries(Vec,PetscInt*,PetscScalar**);

276: PETSC_EXTERN PetscErrorCode VecStrideNorm(Vec,PetscInt,NormType,PetscReal*);
277: PETSC_EXTERN PetscErrorCode VecStrideMax(Vec,PetscInt,PetscInt *,PetscReal *);
278: PETSC_EXTERN PetscErrorCode VecStrideMin(Vec,PetscInt,PetscInt *,PetscReal *);
279: PETSC_EXTERN PetscErrorCode VecStrideScale(Vec,PetscInt,PetscScalar);
280: PETSC_EXTERN PetscErrorCode VecStrideSet(Vec,PetscInt,PetscScalar);


283: PETSC_EXTERN PetscErrorCode VecStrideGather(Vec,PetscInt,Vec,InsertMode);
284: PETSC_EXTERN PetscErrorCode VecStrideScatter(Vec,PetscInt,Vec,InsertMode);
285: PETSC_EXTERN PetscErrorCode VecStrideGatherAll(Vec,Vec[],InsertMode);
286: PETSC_EXTERN PetscErrorCode VecStrideScatterAll(Vec[],Vec,InsertMode);

288: PETSC_EXTERN PetscErrorCode VecStrideSubSetScatter(Vec,PetscInt,const PetscInt[],const PetscInt[],Vec,InsertMode);
289: PETSC_EXTERN PetscErrorCode VecStrideSubSetGather(Vec,PetscInt,const PetscInt[],const PetscInt[],Vec,InsertMode);

291: PETSC_EXTERN PetscErrorCode VecSetValues(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
292: PETSC_EXTERN PetscErrorCode VecGetValues(Vec,PetscInt,const PetscInt[],PetscScalar[]);
293: PETSC_EXTERN PetscErrorCode VecAssemblyBegin(Vec);
294: PETSC_EXTERN PetscErrorCode VecAssemblyEnd(Vec);
295: PETSC_EXTERN PetscErrorCode VecStashSetInitialSize(Vec,PetscInt,PetscInt);
296: PETSC_EXTERN PetscErrorCode VecStashView(Vec,PetscViewer);
297: PETSC_EXTERN PetscErrorCode VecStashViewFromOptions(Vec,PetscObject,const char[]);
298: PETSC_EXTERN PetscErrorCode VecStashGetInfo(Vec,PetscInt*,PetscInt*,PetscInt*,PetscInt*);

300: /*MC
301:    VecSetValue - Set a single entry into a vector.

303:    Synopsis:
304: #include <petscvec.h>
305:    PetscErrorCode VecSetValue(Vec v,PetscInt row,PetscScalar value, InsertMode mode);

307:    Not Collective

309:    Input Parameters:
310: +  v - the vector
311: .  row - the row location of the entry
312: .  value - the value to insert
313: -  mode - either INSERT_VALUES or ADD_VALUES

315:    Notes:
316:    For efficiency one should use VecSetValues() and set several or
317:    many values simultaneously if possible.

319:    These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd()
320:    MUST be called after all calls to VecSetValue() have been completed.

322:    VecSetValue() uses 0-based indices in Fortran as well as in C.

324:    Level: beginner

326: .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValueLocal()
327: M*/
328: PETSC_STATIC_INLINE PetscErrorCode VecSetValue(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValues(v,1,&i,&va,mode);}


331: PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec,PetscInt);
332: PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec,PetscInt*);
333: PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);

335: /* Dynamic creation and loading functions */
336: PETSC_EXTERN PetscFunctionList VecList;
337: PETSC_EXTERN PetscErrorCode VecSetType(Vec,VecType);
338: PETSC_EXTERN PetscErrorCode VecGetType(Vec,VecType*);
339: PETSC_EXTERN PetscErrorCode VecRegister(const char[],PetscErrorCode (*)(Vec));

341: PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter,Vec,Vec,InsertMode,ScatterMode);
342: PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter,Vec,Vec,InsertMode,ScatterMode);
343: PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter*);
344: PETSC_EXTERN PetscErrorCode VecScatterSetUp(VecScatter);
345: PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter,VecScatter *);
346: PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter,PetscViewer);
347: PETSC_EXTERN PetscErrorCode VecScatterViewFromOptions(VecScatter,PetscObject,const char[]);
348: PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter,PetscInt[],PetscInt[]);
349: PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter,PetscBool*);

351: PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
352: PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
353: PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
354: PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
355: PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
356: PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
357: PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec,PetscInt,PetscInt,PetscScalar*[]);
358: PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec,PetscInt,PetscInt,PetscScalar*[]);

360: PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
361: PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
362: PETSC_EXTERN PetscErrorCode VecRestoreArray4dWrite(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
363: PETSC_EXTERN PetscErrorCode VecGetArray3dWrite(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
364: PETSC_EXTERN PetscErrorCode VecRestoreArray3dWrite(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
365: PETSC_EXTERN PetscErrorCode VecGetArray2dWrite(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
366: PETSC_EXTERN PetscErrorCode VecRestoreArray2dWrite(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
367: PETSC_EXTERN PetscErrorCode VecGetArray1dWrite(Vec,PetscInt,PetscInt,PetscScalar*[]);
368: PETSC_EXTERN PetscErrorCode VecRestoreArray1dWrite(Vec,PetscInt,PetscInt,PetscScalar*[]);

370: PETSC_EXTERN PetscErrorCode VecGetArray4dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
371: PETSC_EXTERN PetscErrorCode VecRestoreArray4dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
372: PETSC_EXTERN PetscErrorCode VecGetArray3dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
373: PETSC_EXTERN PetscErrorCode VecRestoreArray3dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
374: PETSC_EXTERN PetscErrorCode VecGetArray2dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
375: PETSC_EXTERN PetscErrorCode VecRestoreArray2dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
376: PETSC_EXTERN PetscErrorCode VecGetArray1dRead(Vec,PetscInt,PetscInt,PetscScalar*[]);
377: PETSC_EXTERN PetscErrorCode VecRestoreArray1dRead(Vec,PetscInt,PetscInt,PetscScalar*[]);

379: PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec,const PetscScalar[]);
380: PETSC_EXTERN PetscErrorCode VecResetArray(Vec);
381: PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec,const PetscScalar[]);

383: PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[],PetscInt,PetscScalar**[]);
384: PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[],PetscInt,PetscScalar**[]);

386: PETSC_EXTERN PetscErrorCode VecView(Vec,PetscViewer);
387: PETSC_EXTERN PetscErrorCode VecEqual(Vec,Vec,PetscBool*);
388: PETSC_EXTERN PetscErrorCode VecLoad(Vec,PetscViewer);

390: PETSC_EXTERN PetscErrorCode VecGetSize(Vec,PetscInt*);
391: PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec,PetscInt*);
392: PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec,PetscInt*,PetscInt*);
393: PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec,const PetscInt*[]);

395: PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping);
396: PETSC_EXTERN PetscErrorCode VecSetValuesLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);

398: PETSC_EXTERN PetscErrorCode VecCUDAGetArray(Vec,PetscScalar**);
399: PETSC_EXTERN PetscErrorCode VecCUDARestoreArray(Vec,PetscScalar**);

401: PETSC_EXTERN PetscErrorCode VecCUDAGetArrayRead(Vec,const PetscScalar**);
402: PETSC_EXTERN PetscErrorCode VecCUDARestoreArrayRead(Vec,const PetscScalar**);

404: PETSC_EXTERN PetscErrorCode VecCUDAGetArrayWrite(Vec,PetscScalar**);
405: PETSC_EXTERN PetscErrorCode VecCUDARestoreArrayWrite(Vec,PetscScalar**);

407: PETSC_EXTERN PetscErrorCode VecCUDAPlaceArray(Vec,const PetscScalar[]);
408: PETSC_EXTERN PetscErrorCode VecCUDAReplaceArray(Vec,const PetscScalar[]);
409: PETSC_EXTERN PetscErrorCode VecCUDAResetArray(Vec);

411: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLContext(Vec, PETSC_UINTPTR_T*);
412: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLQueue(Vec, PETSC_UINTPTR_T*);
413: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemRead(Vec, PETSC_UINTPTR_T*);
414: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemWrite(Vec, PETSC_UINTPTR_T*);
415: PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMemWrite(Vec);
416: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMem(Vec, PETSC_UINTPTR_T*);
417: PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMem(Vec);

419: /*MC
420:    VecSetValueLocal - Set a single entry into a vector using the local numbering

422:    Synopsis:
423: #include <petscvec.h>
424:    PetscErrorCode VecSetValueLocal(Vec v,PetscInt row,PetscScalar value, InsertMode mode);

426:    Not Collective

428:    Input Parameters:
429: +  v - the vector
430: .  row - the row location of the entry
431: .  value - the value to insert
432: -  mode - either INSERT_VALUES or ADD_VALUES

434:    Notes:
435:    For efficiency one should use VecSetValues() and set several or
436:    many values simultaneously if possible.

438:    These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd()
439:    MUST be called after all calls to VecSetValues() have been completed.

441:    VecSetValues() uses 0-based indices in Fortran as well as in C.

443:    Level: beginner

445: .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValue()
446: M*/
447: PETSC_STATIC_INLINE PetscErrorCode VecSetValueLocal(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValuesLocal(v,1,&i,&va,mode);}

449: PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
450: PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping*);

452: PETSC_EXTERN PetscErrorCode VecDotBegin(Vec,Vec,PetscScalar *);
453: PETSC_EXTERN PetscErrorCode VecDotEnd(Vec,Vec,PetscScalar *);
454: PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec,Vec,PetscScalar *);
455: PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec,Vec,PetscScalar *);
456: PETSC_EXTERN PetscErrorCode VecNormBegin(Vec,NormType,PetscReal *);
457: PETSC_EXTERN PetscErrorCode VecNormEnd(Vec,NormType,PetscReal *);

459: PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]);
460: PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]);
461: PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]);
462: PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]);
463: PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm);

465: PETSC_EXTERN PetscErrorCode VecBindToCPU(Vec,PetscBool);
466: PETSC_DEPRECATED_FUNCTION("Use VecBindToCPU (since v3.13)") PETSC_STATIC_INLINE PetscErrorCode VecPinToCPU(Vec v,PetscBool flg) {return VecBindToCPU(v,flg);}
467: PETSC_EXTERN PetscErrorCode VecSetPinnedMemoryMin(Vec,size_t);
468: PETSC_EXTERN PetscErrorCode VecGetPinnedMemoryMin(Vec,size_t *);

470: typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES,VEC_IGNORE_NEGATIVE_INDICES,VEC_SUBSET_OFF_PROC_ENTRIES} VecOption;
471: PETSC_EXTERN PetscErrorCode VecSetOption(Vec,VecOption,PetscBool);

473: PETSC_EXTERN PetscErrorCode VecGetArray(Vec,PetscScalar**);
474: PETSC_EXTERN PetscErrorCode VecGetArrayWrite(Vec,PetscScalar**);
475: PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec,const PetscScalar**);
476: PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec,PetscScalar**);
477: PETSC_EXTERN PetscErrorCode VecRestoreArrayWrite(Vec,PetscScalar**);
478: PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec,const PetscScalar**);
479: PETSC_EXTERN PetscErrorCode VecGetLocalVector(Vec,Vec);
480: PETSC_EXTERN PetscErrorCode VecRestoreLocalVector(Vec,Vec);
481: PETSC_EXTERN PetscErrorCode VecGetLocalVectorRead(Vec,Vec);
482: PETSC_EXTERN PetscErrorCode VecRestoreLocalVectorRead(Vec,Vec);

484: PETSC_EXTERN PetscErrorCode VecGetArrayInPlace(Vec,PetscScalar**);
485: PETSC_EXTERN PetscErrorCode VecRestoreArrayInPlace(Vec,PetscScalar**);
486: PETSC_EXTERN PetscErrorCode VecGetArrayReadInPlace(Vec,const PetscScalar**);
487: PETSC_EXTERN PetscErrorCode VecRestoreArrayReadInPlace(Vec,const PetscScalar**);

489: /*@C
490:    VecGetArrayPair - Accesses a pair of pointers for two vectors that may be common. When not common the first is read only

492:    Logically Collective on x

494:    Input Parameters:
495: +  x - the vector
496: -  y - the second vector

498:    Output Parameters:
499: +  xv - location to put pointer to the first array
500: -  yv - location to put pointer to the second array

502:    Level: developer

504:    Not available from Fortran

506: .seealso: VecGetArray(), VecGetArrayRead(), VecRestoreArrayPair()

508: @*/
509: PETSC_STATIC_INLINE PetscErrorCode VecGetArrayPair(Vec x,Vec y,PetscScalar **xv,PetscScalar **yv)
510: {

514:   VecGetArray(y,yv);
515:   if (x != y) {
516:     VecGetArrayRead(x,(const PetscScalar **)xv);
517:   } else {
518:     *xv = *yv;
519:   }
520:   return(0);
521: }

523: /*@C
524:    VecRestoreArrayPair - Returns a pair of pointers for two vectors that may be common. When not common the first is read only

526:    Logically Collective on x

528:    Input Parameters:
529: +  x - the vector
530: -  y - the second vector

532:    Output Parameters:
533: +  xv - location to put pointer to the first array
534: -  yv - location to put pointer to the second array

536:    Level: developer

538:    Not available from Fortran

540: .seealso: VecGetArray(), VecGetArrayRead(), VecGetArrayPair()

542: @*/
543: PETSC_STATIC_INLINE PetscErrorCode VecRestoreArrayPair(Vec x,Vec y,PetscScalar **xv,PetscScalar **yv)
544: {

548:   VecRestoreArray(y,yv);
549:   if (x != y) {
550:     VecRestoreArrayRead(x,(const PetscScalar **)xv);
551:   }
552:   return(0);
553: }

555: #if defined(PETSC_USE_DEBUG)
556: PETSC_EXTERN PetscErrorCode VecLockReadPush(Vec);
557: PETSC_EXTERN PetscErrorCode VecLockReadPop(Vec);
558: /* We also have a non-public VecLockWriteSet_Private() in vecimpl.h */
559: PETSC_EXTERN PetscErrorCode VecLockGet(Vec,PetscInt*);
560: PETSC_STATIC_INLINE PetscErrorCode VecSetErrorIfLocked(Vec x,PetscInt arg)
561: {
562:   PetscInt       state;

566:   VecLockGet(x,&state);
567:   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);
568:   return(0);
569: }
570: /* The three are deprecated */
571: PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use VecLockReadPush() (since version 3.11)") PetscErrorCode VecLockPush(Vec);
572: PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use VecLockReadPop() (since version 3.11)")  PetscErrorCode VecLockPop(Vec);
573: #define VecLocked(x,arg) VecSetErrorIfLocked(x,arg) PETSC_DEPRECATED_MACRO("GCC warning \"Use VecSetErrorIfLocked() (since version 3.11)\"")
574: #else
575: #define VecLockReadPush(x)           0
576: #define VecLockReadPop(x)            0
577: #define VecLockGet(x,s)              *(s) = 0
578: #define VecSetErrorIfLocked(x,arg)   0
579: /* The three are deprecated */
580: #define VecLockPush(x)               0
581: #define VecLockPop(x)                0
582: #define VecLocked(x,arg)             0
583: #endif

585: PETSC_EXTERN PetscErrorCode VecValidValues(Vec,PetscInt,PetscBool);

587: /*
588:     These numbers need to match the entries in
589:   the function table in vecimpl.h
590: */
591: typedef enum { VECOP_DUPLICATE = 0, VECOP_VIEW = 33, VECOP_LOAD = 41, VECOP_VIEWNATIVE = 68, VECOP_LOADNATIVE = 69 } VecOperation;
592: PETSC_EXTERN PetscErrorCode VecSetOperation(Vec,VecOperation,void(*)(void));

594: /*
595:      Routines for dealing with ghosted vectors:
596:   vectors with ghost elements at the end of the array.
597: */
598: PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec,PetscInt,const PetscInt[]);
599: PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*);
600: PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*);
601: PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*);
602: PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*);
603: PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec,Vec*);
604: PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec,Vec*);
605: PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec,Vec,PetscBool*);
606: PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec,InsertMode,ScatterMode);
607: PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec,InsertMode,ScatterMode);

609: PETSC_EXTERN PetscErrorCode VecConjugate(Vec);
610: PETSC_EXTERN PetscErrorCode VecImaginaryPart(Vec);
611: PETSC_EXTERN PetscErrorCode VecRealPart(Vec);

613: PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec,VecScatter*,Vec*);
614: PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec,VecScatter*,Vec*);

616: PETSC_EXTERN PetscErrorCode ISComplementVec(IS,Vec,IS*);
617: PETSC_EXTERN PetscErrorCode VecPow(Vec, PetscScalar);
618: PETSC_EXTERN PetscErrorCode VecMedian(Vec, Vec, Vec, Vec);
619: PETSC_EXTERN PetscErrorCode VecWhichInactive(Vec, Vec, Vec, Vec, PetscBool, IS *);
620: PETSC_EXTERN PetscErrorCode VecWhichBetween(Vec, Vec, Vec, IS *);
621: PETSC_EXTERN PetscErrorCode VecWhichBetweenOrEqual(Vec, Vec, Vec, IS *);
622: PETSC_EXTERN PetscErrorCode VecWhichGreaterThan(Vec, Vec, IS *);
623: PETSC_EXTERN PetscErrorCode VecWhichLessThan(Vec, Vec, IS *);
624: PETSC_EXTERN PetscErrorCode VecWhichEqual(Vec, Vec, IS *);
625: PETSC_EXTERN PetscErrorCode VecISAXPY(Vec, IS, PetscScalar,Vec);
626: PETSC_EXTERN PetscErrorCode VecISCopy(Vec, IS, ScatterMode, Vec);
627: PETSC_EXTERN PetscErrorCode VecISSet(Vec,IS, PetscScalar);
628: PETSC_EXTERN PetscErrorCode VecBoundGradientProjection(Vec, Vec, Vec, Vec, Vec);
629: PETSC_EXTERN PetscErrorCode VecStepBoundInfo(Vec,Vec,Vec,Vec,PetscReal*, PetscReal*,PetscReal*);
630: PETSC_EXTERN PetscErrorCode VecStepMax(Vec, Vec, PetscReal *);
631: PETSC_EXTERN PetscErrorCode VecStepMaxBounded(Vec,Vec,Vec,Vec,PetscReal*);

633: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec);
634: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec);

636: /*S
637:      Vecs - Collection of vectors where the data for the vectors is stored in
638:             one contiguous memory

640:    Level: advanced

642:    Notes:
643:     Temporary construct for handling multiply right hand side solves

645:     This is faked by storing a single vector that has enough array space for
646:     n vectors

648: S*/
649:         struct _n_Vecs  {PetscInt n; Vec v;};
650: typedef struct _n_Vecs* Vecs;
651: PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs);
652: PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm,PetscInt,PetscInt,Vecs*);
653: PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,PetscScalar*,Vecs*);
654: PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs,Vecs*);

656: #if defined(PETSC_HAVE_VIENNACL)
657: typedef struct _p_PetscViennaCLIndices* PetscViennaCLIndices;
658: PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesCreate(PetscInt, PetscInt*,PetscInt, PetscInt*,PetscViennaCLIndices*);
659: PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesDestroy(PetscViennaCLIndices*);
660: PETSC_EXTERN PetscErrorCode VecViennaCLCopyToGPUSome_Public(Vec,PetscViennaCLIndices);
661: PETSC_EXTERN PetscErrorCode VecViennaCLCopyFromGPUSome_Public(Vec,PetscViennaCLIndices);
662: PETSC_EXTERN PetscErrorCode VecCreateSeqViennaCL(MPI_Comm,PetscInt,Vec*);
663: PETSC_EXTERN PetscErrorCode VecCreateMPIViennaCL(MPI_Comm,PetscInt,PetscInt,Vec*);
664: #endif
665: #if defined(PETSC_HAVE_CUDA)
666: typedef struct _p_PetscCUDAIndices* PetscCUDAIndices;
667: typedef struct _p_VecScatterCUDAIndices_StoS* VecScatterCUDAIndices_StoS;
668: typedef struct _p_VecScatterCUDAIndices_PtoP* VecScatterCUDAIndices_PtoP;
669: PETSC_EXTERN PetscErrorCode VecCUDACopyToGPUSome_Public(Vec,PetscCUDAIndices,ScatterMode);
670: PETSC_EXTERN PetscErrorCode VecCUDACopyFromGPUSome_Public(Vec,PetscCUDAIndices,ScatterMode);
671: PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter,Vec);
672: PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter);
673: PETSC_EXTERN PetscErrorCode VecCreateSeqCUDA(MPI_Comm,PetscInt,Vec*);
674: PETSC_EXTERN PetscErrorCode VecCreateSeqCUDAWithArray(MPI_Comm,PetscInt,PetscInt,const PetscScalar*,Vec*);
675: PETSC_EXTERN PetscErrorCode VecCreateSeqCUDAWithArrays(MPI_Comm,PetscInt,PetscInt,const PetscScalar*,const PetscScalar*,Vec*);
676: PETSC_EXTERN PetscErrorCode VecCreateMPICUDA(MPI_Comm,PetscInt,PetscInt,Vec*);
677: PETSC_EXTERN PetscErrorCode VecCreateMPICUDAWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar*,Vec*);
678: PETSC_EXTERN PetscErrorCode VecCreateMPICUDAWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar*,const PetscScalar*,Vec*);
679: #endif

681: PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec,PetscInt*,Vec**);
682: PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec,PetscInt,Vec*);
683: PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec,PetscInt,PetscInt*,Vec*);
684: PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec,PetscInt,Vec);
685: PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm,PetscInt,IS*,Vec*,Vec*);
686: PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec,PetscInt*);

688: PETSC_EXTERN PetscErrorCode PetscOptionsGetVec(PetscOptions,const char[],const char[],Vec,PetscBool*);
689: PETSC_EXTERN PetscErrorCode VecChop(Vec,PetscReal);

691: PETSC_EXTERN PetscErrorCode VecGetLayout(Vec,PetscLayout*);
692: PETSC_EXTERN PetscErrorCode VecSetLayout(Vec,PetscLayout);

694: PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer);
695: PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar **);
696: PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, PetscScalar [], InsertMode);
697: PETSC_EXTERN PetscErrorCode PetscSectionVecNorm(PetscSection, PetscSection, Vec, NormType, PetscReal []);

699: /*S
700:   VecTagger - Object used to manage the tagging of a subset of indices based on the values of a vector.  The
701:               motivating application is the selection of cells for refinement or coarsening based on vector containing
702:               the values in an error indicator metric.

704:   Level: advanced
705: S*/
706: typedef struct _p_VecTagger *VecTagger;

708: /*J
709:   VecTaggerType - String with the name of a VecTagger type

711:   Level: advanced
712: J*/
713: typedef const char* VecTaggerType;
714: /* tag where the vector values are in a box of explicitly defined values */
715: #define VECTAGGERABSOLUTE   "absolute"
716: /* tag where the vector values are in a box of values relative to the set of all values in the vector */
717: #define VECTAGGERRELATIVE   "relative"
718: /* tag where the vector values are in a relative range of the *cumulative distribution* of values in the vector */
719: #define VECTAGGERCDF        "cdf"
720: /* tag a vector as the union of other tags */
721: #define VECTAGGEROR         "or"
722: /* tag a vector as the intersection of other tags */
723: #define VECTAGGERAND        "and"

725: PETSC_EXTERN PetscClassId VEC_TAGGER_CLASSID;
726: PETSC_EXTERN PetscFunctionList VecTaggerList;
727: PETSC_EXTERN PetscErrorCode VecTaggerRegister(const char[],PetscErrorCode (*) (VecTagger));

729: PETSC_EXTERN PetscErrorCode VecTaggerCreate(MPI_Comm,VecTagger *);
730: PETSC_EXTERN PetscErrorCode VecTaggerSetBlockSize(VecTagger,PetscInt);
731: PETSC_EXTERN PetscErrorCode VecTaggerGetBlockSize(VecTagger,PetscInt*);
732: PETSC_EXTERN PetscErrorCode VecTaggerSetType(VecTagger,VecTaggerType);
733: PETSC_EXTERN PetscErrorCode VecTaggerGetType(VecTagger,VecTaggerType *);
734: PETSC_EXTERN PetscErrorCode VecTaggerSetInvert(VecTagger,PetscBool);
735: PETSC_EXTERN PetscErrorCode VecTaggerGetInvert(VecTagger,PetscBool*);
736: PETSC_EXTERN PetscErrorCode VecTaggerSetFromOptions(VecTagger);
737: PETSC_EXTERN PetscErrorCode VecTaggerSetUp(VecTagger);
738: PETSC_EXTERN PetscErrorCode VecTaggerView(VecTagger,PetscViewer);
739: PETSC_EXTERN PetscErrorCode VecTaggerComputeIS(VecTagger,Vec,IS *);
740: PETSC_EXTERN PetscErrorCode VecTaggerDestroy(VecTagger *);

742: /*S
743:    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
744:    such that real(min) <= real(z) <= real(max) and imag(min) <= imag(z) <= imag(max).  INF is an acceptable endpoint.

746:    Level: beginner

748: .seealso: VecTaggerComputeIntervals()
749: S*/
750: typedef struct {
751:   PetscScalar min;
752:   PetscScalar max;
753: } VecTaggerBox;
754: PETSC_EXTERN PetscErrorCode VecTaggerComputeBoxes(VecTagger,Vec,PetscInt *,VecTaggerBox **);


757: PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteSetBox(VecTagger,VecTaggerBox *);
758: PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteGetBox(VecTagger,const VecTaggerBox **);

760: PETSC_EXTERN PetscErrorCode VecTaggerRelativeSetBox(VecTagger,VecTaggerBox *);
761: PETSC_EXTERN PetscErrorCode VecTaggerRelativeGetBox(VecTagger,const VecTaggerBox **);

763: PETSC_EXTERN PetscErrorCode VecTaggerCDFSetBox(VecTagger,VecTaggerBox *);
764: PETSC_EXTERN PetscErrorCode VecTaggerCDFGetBox(VecTagger,const VecTaggerBox **);

766: /*E
767:   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.

769:   Level: advanced
770: .seealso: VecTaggerCDFSetMethod(), VecTaggerCDFMethods
771: E*/
772: typedef enum {VECTAGGER_CDF_GATHER,VECTAGGER_CDF_ITERATIVE,VECTAGGER_CDF_NUM_METHODS} VecTaggerCDFMethod;
773: PETSC_EXTERN const char *const VecTaggerCDFMethods[];

775: PETSC_EXTERN PetscErrorCode VecTaggerCDFSetMethod(VecTagger,VecTaggerCDFMethod);
776: PETSC_EXTERN PetscErrorCode VecTaggerCDFGetMethod(VecTagger,VecTaggerCDFMethod*);
777: PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeSetTolerances(VecTagger,PetscInt,PetscReal,PetscReal);
778: PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeGetTolerances(VecTagger,PetscInt*,PetscReal*,PetscReal*);

780: PETSC_EXTERN PetscErrorCode VecTaggerOrSetSubs(VecTagger,PetscInt,VecTagger*,PetscCopyMode);
781: PETSC_EXTERN PetscErrorCode VecTaggerOrGetSubs(VecTagger,PetscInt*,VecTagger**);

783: PETSC_EXTERN PetscErrorCode VecTaggerAndSetSubs(VecTagger,PetscInt,VecTagger*,PetscCopyMode);
784: PETSC_EXTERN PetscErrorCode VecTaggerAndGetSubs(VecTagger,PetscInt*,VecTagger**);

786: PETSC_EXTERN PetscErrorCode VecTaggerInitializePackage(void);
787: PETSC_EXTERN PetscErrorCode VecTaggerFinalizePackage(void);

789: #endif