Actual source code: petscvec.h

petsc-3.4.4 2014-03-13
  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
  9: #include <petscis.h>
 10: #include <petscviewer.h>

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

 15:    Level: beginner

 17:   Concepts: field variables, unknowns, arrays

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

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

 27:    Level: beginner

 29:   Concepts: scatter

 31: .seealso:  VecScatterCreate(), VecScatterBegin(), VecScatterEnd()
 32: S*/
 33: typedef struct _p_VecScatter*  VecScatter;

 35: /*E
 36:   ScatterMode - Determines the direction of a scatter

 38:   Level: beginner

 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;

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

 47:     Level: beginner

 49: .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_REVERSE, SCATTER_FORWARD_LOCAL,
 50:           SCATTER_REVERSE_LOCAL

 52: M*/

 54: /*MC
 55:     SCATTER_REVERSE - Moves the values in the opposite direction then the directions indicated in
 56:          in the VecScatterCreate()

 58:     Level: beginner

 60: .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_FORWARD, SCATTER_FORWARD_LOCAL,
 61:           SCATTER_REVERSE_LOCAL

 63: M*/

 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

 69:     Level: developer

 71: .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_REVERSE, SCATTER_FORWARD,
 72:           SCATTER_REVERSE_LOCAL

 74: M*/

 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

 81:     Level: developer

 83: .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_FORWARD, SCATTER_FORWARD_LOCAL,
 84:           SCATTER_REVERSE

 86: M*/

 88: /*J
 89:     VecType - String with the name of a PETSc vector

 91:    Level: beginner

 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 VECSIEVE       "sieve"
101: #define VECSEQCUSP     "seqcusp"
102: #define VECMPICUSP     "mpicusp"
103: #define VECCUSP        "cusp"       /* seqcusp on one process and mpicusp on several */
104: #define VECNEST        "nest"
105: #define VECSEQPTHREAD  "seqpthread"
106: #define VECMPIPTHREAD  "mpipthread"
107: #define VECPTHREAD     "pthread"    /* seqpthread on one process and mpipthread on several */


110: /* Logging support */
111: #define    VEC_FILE_CLASSID 1211214
112: PETSC_EXTERN PetscClassId VEC_CLASSID;
113: PETSC_EXTERN PetscClassId VEC_SCATTER_CLASSID;


116: PETSC_EXTERN PetscErrorCode VecInitializePackage(void);
117: PETSC_EXTERN PetscErrorCode VecFinalizePackage(void);

119: PETSC_EXTERN PetscErrorCode VecCreate(MPI_Comm,Vec*);
120: PETSC_EXTERN PetscErrorCode VecCreateSeq(MPI_Comm,PetscInt,Vec*);
121: PETSC_EXTERN PetscErrorCode VecCreateMPI(MPI_Comm,PetscInt,PetscInt,Vec*);
122: PETSC_EXTERN PetscErrorCode VecCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,const PetscScalar[],Vec*);
123: PETSC_EXTERN PetscErrorCode VecCreateMPIWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar[],Vec*);
124: PETSC_EXTERN PetscErrorCode VecCreateShared(MPI_Comm,PetscInt,PetscInt,Vec*);
125: PETSC_EXTERN PetscErrorCode VecSetFromOptions(Vec);
126: PETSC_EXTERN PetscErrorCode VecViewFromOptions(Vec,const char[],const char[]);

128: PETSC_EXTERN PetscErrorCode VecSetUp(Vec);
129: PETSC_EXTERN PetscErrorCode VecDestroy(Vec*);
130: PETSC_EXTERN PetscErrorCode VecZeroEntries(Vec);
131: PETSC_EXTERN PetscErrorCode VecSetOptionsPrefix(Vec,const char[]);
132: PETSC_EXTERN PetscErrorCode VecAppendOptionsPrefix(Vec,const char[]);
133: PETSC_EXTERN PetscErrorCode VecGetOptionsPrefix(Vec,const char*[]);

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

137: PETSC_EXTERN PetscErrorCode VecDotNorm2(Vec,Vec,PetscScalar*,PetscReal*);
138: PETSC_EXTERN PetscErrorCode VecDot(Vec,Vec,PetscScalar*);
139: PETSC_EXTERN PetscErrorCode VecDotRealPart(Vec,Vec,PetscReal*);
140: PETSC_EXTERN PetscErrorCode VecTDot(Vec,Vec,PetscScalar*);
141: PETSC_EXTERN PetscErrorCode VecMDot(Vec,PetscInt,const Vec[],PetscScalar[]);
142: PETSC_EXTERN PetscErrorCode VecMTDot(Vec,PetscInt,const Vec[],PetscScalar[]);
143: PETSC_EXTERN PetscErrorCode VecGetSubVector(Vec,IS,Vec*);
144: PETSC_EXTERN PetscErrorCode VecRestoreSubVector(Vec,IS,Vec*);

146: /*E
147:     NormType - determines what type of norm to compute

149:     Level: beginner

151: .seealso: VecNorm(), VecNormBegin(), VecNormEnd(), MatNorm()
152: E*/
153: typedef enum {NORM_1=0,NORM_2=1,NORM_FROBENIUS=2,NORM_INFINITY=3,NORM_1_AND_2=4} NormType;
154: PETSC_EXTERN const char *const NormTypes[];
155: #define NORM_MAX NORM_INFINITY

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

160:    Level: beginner

162: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_2, NORM_FROBENIUS,
163:            NORM_INFINITY, NORM_1_AND_2

165: M*/

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

170:    Level: beginner

172: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_FROBENIUS,
173:            NORM_INFINITY, NORM_1_AND_2

175: M*/

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

180:    Level: beginner

182: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2,
183:            NORM_INFINITY, NORM_1_AND_2

185: M*/

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

190:    Level: beginner

192: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2,
193:            NORM_FROBINIUS, NORM_1_AND_2

195: M*/

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

200:    Level: beginner

202: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2,
203:            NORM_FROBINIUS, NORM_INFINITY

205: M*/

207: /*MC
208:      NORM_MAX - see NORM_INFINITY

210:    Level: beginner

212: M*/

214: PETSC_EXTERN PetscErrorCode VecNorm(Vec,NormType,PetscReal *);
215: PETSC_EXTERN PetscErrorCode VecNormAvailable(Vec,NormType,PetscBool *,PetscReal *);
216: PETSC_EXTERN PetscErrorCode VecNormalize(Vec,PetscReal *);
217: PETSC_EXTERN PetscErrorCode VecSum(Vec,PetscScalar*);
218: PETSC_EXTERN PetscErrorCode VecMax(Vec,PetscInt*,PetscReal *);
219: PETSC_EXTERN PetscErrorCode VecMin(Vec,PetscInt*,PetscReal *);
220: PETSC_EXTERN PetscErrorCode VecScale(Vec,PetscScalar);
221: PETSC_EXTERN PetscErrorCode VecCopy(Vec,Vec);
222: PETSC_EXTERN PetscErrorCode VecSetRandom(Vec,PetscRandom);
223: PETSC_EXTERN PetscErrorCode VecSet(Vec,PetscScalar);
224: PETSC_EXTERN PetscErrorCode VecSwap(Vec,Vec);
225: PETSC_EXTERN PetscErrorCode VecAXPY(Vec,PetscScalar,Vec);
226: PETSC_EXTERN PetscErrorCode VecAXPBY(Vec,PetscScalar,PetscScalar,Vec);
227: PETSC_EXTERN PetscErrorCode VecMAXPY(Vec,PetscInt,const PetscScalar[],Vec[]);
228: PETSC_EXTERN PetscErrorCode VecAYPX(Vec,PetscScalar,Vec);
229: PETSC_EXTERN PetscErrorCode VecWAXPY(Vec,PetscScalar,Vec,Vec);
230: PETSC_EXTERN PetscErrorCode VecAXPBYPCZ(Vec,PetscScalar,PetscScalar,PetscScalar,Vec,Vec);
231: PETSC_EXTERN PetscErrorCode VecPointwiseMax(Vec,Vec,Vec);
232: PETSC_EXTERN PetscErrorCode VecPointwiseMaxAbs(Vec,Vec,Vec);
233: PETSC_EXTERN PetscErrorCode VecPointwiseMin(Vec,Vec,Vec);
234: PETSC_EXTERN PetscErrorCode VecPointwiseMult(Vec,Vec,Vec);
235: PETSC_EXTERN PetscErrorCode VecPointwiseDivide(Vec,Vec,Vec);
236: PETSC_EXTERN PetscErrorCode VecMaxPointwiseDivide(Vec,Vec,PetscReal*);
237: PETSC_EXTERN PetscErrorCode VecShift(Vec,PetscScalar);
238: PETSC_EXTERN PetscErrorCode VecReciprocal(Vec);
239: PETSC_EXTERN PetscErrorCode VecPermute(Vec, IS, PetscBool );
240: PETSC_EXTERN PetscErrorCode VecSqrtAbs(Vec);
241: PETSC_EXTERN PetscErrorCode VecLog(Vec);
242: PETSC_EXTERN PetscErrorCode VecExp(Vec);
243: PETSC_EXTERN PetscErrorCode VecAbs(Vec);
244: PETSC_EXTERN PetscErrorCode VecDuplicate(Vec,Vec*);
245: PETSC_EXTERN PetscErrorCode VecDuplicateVecs(Vec,PetscInt,Vec*[]);
246: PETSC_EXTERN PetscErrorCode VecDestroyVecs(PetscInt, Vec*[]);
247: PETSC_EXTERN PetscErrorCode VecStrideNormAll(Vec,NormType,PetscReal[]);
248: PETSC_EXTERN PetscErrorCode VecStrideMaxAll(Vec,PetscInt [],PetscReal []);
249: PETSC_EXTERN PetscErrorCode VecStrideMinAll(Vec,PetscInt [],PetscReal []);
250: PETSC_EXTERN PetscErrorCode VecStrideScaleAll(Vec,const PetscScalar[]);

252: PETSC_EXTERN PetscErrorCode VecStrideNorm(Vec,PetscInt,NormType,PetscReal*);
253: PETSC_EXTERN PetscErrorCode VecStrideMax(Vec,PetscInt,PetscInt *,PetscReal *);
254: PETSC_EXTERN PetscErrorCode VecStrideMin(Vec,PetscInt,PetscInt *,PetscReal *);
255: PETSC_EXTERN PetscErrorCode VecStrideScale(Vec,PetscInt,PetscScalar);
256: PETSC_EXTERN PetscErrorCode VecStrideSet(Vec,PetscInt,PetscScalar);


259: PETSC_EXTERN PetscErrorCode VecStrideGather(Vec,PetscInt,Vec,InsertMode);
260: PETSC_EXTERN PetscErrorCode VecStrideScatter(Vec,PetscInt,Vec,InsertMode);
261: PETSC_EXTERN PetscErrorCode VecStrideGatherAll(Vec,Vec[],InsertMode);
262: PETSC_EXTERN PetscErrorCode VecStrideScatterAll(Vec[],Vec,InsertMode);

264: PETSC_EXTERN PetscErrorCode VecSetValues(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
265: PETSC_EXTERN PetscErrorCode VecGetValues(Vec,PetscInt,const PetscInt[],PetscScalar[]);
266: PETSC_EXTERN PetscErrorCode VecAssemblyBegin(Vec);
267: PETSC_EXTERN PetscErrorCode VecAssemblyEnd(Vec);
268: PETSC_EXTERN PetscErrorCode VecStashSetInitialSize(Vec,PetscInt,PetscInt);
269: PETSC_EXTERN PetscErrorCode VecStashView(Vec,PetscViewer);
270: PETSC_EXTERN PetscErrorCode VecStashGetInfo(Vec,PetscInt*,PetscInt*,PetscInt*,PetscInt*);

272: /*MC
273:    VecSetValue - Set a single entry into a vector.

275:    Synopsis:
276:    #include "petscvec.h"
277:    PetscErrorCode VecSetValue(Vec v,PetscInt row,PetscScalar value, InsertMode mode);

279:    Not Collective

281:    Input Parameters:
282: +  v - the vector
283: .  row - the row location of the entry
284: .  value - the value to insert
285: -  mode - either INSERT_VALUES or ADD_VALUES

287:    Notes:
288:    For efficiency one should use VecSetValues() and set several or
289:    many values simultaneously if possible.

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

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

296:    Level: beginner

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


303: PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec,PetscInt);
304: PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec,PetscInt*);
305: PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);

307: /* Dynamic creation and loading functions */
308: PETSC_EXTERN PetscFunctionList VecList;
309: PETSC_EXTERN PetscBool         VecRegisterAllCalled;
310: PETSC_EXTERN PetscErrorCode VecSetType(Vec, VecType);
311: PETSC_EXTERN PetscErrorCode VecGetType(Vec, VecType *);
312: PETSC_EXTERN PetscErrorCode VecRegister(const char[],PetscErrorCode (*)(Vec));
313: PETSC_EXTERN PetscErrorCode VecRegisterAll(void);

315: PETSC_EXTERN PetscErrorCode VecScatterCreate(Vec,IS,Vec,IS,VecScatter *);
316: PETSC_EXTERN PetscErrorCode VecScatterCreateEmpty(MPI_Comm,VecScatter *);
317: PETSC_EXTERN PetscErrorCode VecScatterCreateLocal(VecScatter,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt);
318: PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter,Vec,Vec,InsertMode,ScatterMode);
319: PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter,Vec,Vec,InsertMode,ScatterMode);
320: PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter*);
321: PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter,VecScatter *);
322: PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter,PetscViewer);
323: PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter,PetscInt *,PetscInt*);
324: PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter,PetscBool *);

326: PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
327: PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
328: PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
329: PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
330: PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
331: PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
332: PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]);
333: PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]);

335: PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec,const PetscScalar[]);
336: PETSC_EXTERN PetscErrorCode VecResetArray(Vec);
337: PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec,const PetscScalar[]);
338: PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[],PetscInt,PetscScalar**[]);
339: PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[],PetscInt,PetscScalar**[]);

341: PETSC_EXTERN PetscErrorCode VecView(Vec,PetscViewer);
342: PETSC_EXTERN PetscErrorCode VecEqual(Vec,Vec,PetscBool *);
343: PETSC_EXTERN PetscErrorCode VecLoad(Vec, PetscViewer);

345: PETSC_EXTERN PetscErrorCode VecGetSize(Vec,PetscInt*);
346: PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec,PetscInt*);
347: PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec,PetscInt*,PetscInt*);
348: PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec,const PetscInt *[]);

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

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

356:    Synopsis:
357:    #include "petscvec.h"
358:    PetscErrorCode VecSetValueLocal(Vec v,PetscInt row,PetscScalar value, InsertMode mode);

360:    Not Collective

362:    Input Parameters:
363: +  v - the vector
364: .  row - the row location of the entry
365: .  value - the value to insert
366: -  mode - either INSERT_VALUES or ADD_VALUES

368:    Notes:
369:    For efficiency one should use VecSetValues() and set several or
370:    many values simultaneously if possible.

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

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

377:    Level: beginner

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

383: PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping);
384: PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
385: PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping*);
386: PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping*);

388: PETSC_EXTERN PetscErrorCode VecDotBegin(Vec,Vec,PetscScalar *);
389: PETSC_EXTERN PetscErrorCode VecDotEnd(Vec,Vec,PetscScalar *);
390: PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec,Vec,PetscScalar *);
391: PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec,Vec,PetscScalar *);
392: PETSC_EXTERN PetscErrorCode VecNormBegin(Vec,NormType,PetscReal *);
393: PETSC_EXTERN PetscErrorCode VecNormEnd(Vec,NormType,PetscReal *);

395: PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]);
396: PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]);
397: PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]);
398: PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]);
399: PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm);


402: typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES,VEC_IGNORE_NEGATIVE_INDICES} VecOption;
403: PETSC_EXTERN PetscErrorCode VecSetOption(Vec,VecOption,PetscBool );

405: PETSC_EXTERN PetscErrorCode VecGetArray(Vec,PetscScalar**);
406: PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec,const PetscScalar**);
407: PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec,PetscScalar**);
408: PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec,const PetscScalar**);

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

412: PETSC_EXTERN PetscErrorCode VecContourScale(Vec,PetscReal,PetscReal);

414: /*
415:     These numbers need to match the entries in
416:   the function table in vecimpl.h
417: */
418: typedef enum { VECOP_VIEW = 33, VECOP_LOAD = 41, VECOP_DUPLICATE = 0} VecOperation;
419: PETSC_EXTERN PetscErrorCode VecSetOperation(Vec,VecOperation,void(*)(void));

421: /*
422:      Routines for dealing with ghosted vectors:
423:   vectors with ghost elements at the end of the array.
424: */
425: PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec,PetscInt,const PetscInt[]);
426: PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*);
427: PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*);
428: PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*);
429: PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*);
430: PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec,Vec*);
431: PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec,Vec*);
432: PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec,Vec,PetscBool*);
433: PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec,InsertMode,ScatterMode);
434: PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec,InsertMode,ScatterMode);

436: PETSC_EXTERN PetscErrorCode VecConjugate(Vec);

438: PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec,VecScatter*,Vec*);
439: PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec,VecScatter*,Vec*);

441: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec);
442: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec);

444: /*S
445:      Vecs - Collection of vectors where the data for the vectors is stored in
446:             one contiguous memory

448:    Level: advanced

450:    Notes:
451:     Temporary construct for handling multiply right hand side solves

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

456:   Concepts: parallel decomposition

458: S*/
459:         struct _n_Vecs  {PetscInt n; Vec v;};
460: typedef struct _n_Vecs* Vecs;
461: PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs);
462: PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm,PetscInt,PetscInt,Vecs*);
463: PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,PetscScalar*,Vecs*);
464: PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs,Vecs*);

466: #if defined(PETSC_HAVE_CUSP)
467: typedef struct _p_PetscCUSPIndices* PetscCUSPIndices;
468: PETSC_EXTERN PetscErrorCode PetscCUSPIndicesCreate(PetscInt, PetscInt*,PetscInt, PetscInt*,PetscCUSPIndices*);
469: PETSC_EXTERN PetscErrorCode PetscCUSPIndicesDestroy(PetscCUSPIndices*);
470: PETSC_EXTERN PetscErrorCode VecCUSPCopyToGPUSome_Public(Vec,PetscCUSPIndices);
471: PETSC_EXTERN PetscErrorCode VecCUSPCopyFromGPUSome_Public(Vec,PetscCUSPIndices);

473: #if defined(PETSC_HAVE_TXPETSCGPU)
474: PETSC_EXTERN PetscErrorCode VecCUSPResetIndexBuffersFlagsGPU_Public(PetscCUSPIndices);
475: PETSC_EXTERN PetscErrorCode VecCUSPCopySomeToContiguousBufferGPU_Public(Vec,PetscCUSPIndices);
476: PETSC_EXTERN PetscErrorCode VecCUSPCopySomeFromContiguousBufferGPU_Public(Vec,PetscCUSPIndices);
477: PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter,Vec,ScatterMode);
478: PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter);
479: #endif

481: PETSC_EXTERN PetscErrorCode VecCreateSeqCUSP(MPI_Comm,PetscInt,Vec*);
482: PETSC_EXTERN PetscErrorCode VecCreateMPICUSP(MPI_Comm,PetscInt,PetscInt,Vec*);
483: #endif

485: PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec,PetscInt*,Vec**);
486: PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec,PetscInt,Vec*);
487: PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec,PetscInt,PetscInt*,Vec*);
488: PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec,PetscInt,Vec);
489: PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm,PetscInt,IS*,Vec*,Vec*);
490: PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec,PetscInt*);

492: PETSC_EXTERN PetscErrorCode PetscOptionsVec(const char[],const char[],const char[],Vec,PetscBool*);
493: PETSC_EXTERN PetscErrorCode VecChop(Vec,PetscReal);

495: PETSC_EXTERN PetscErrorCode VecGetLayout(Vec,PetscLayout*);
496: PETSC_EXTERN PetscErrorCode VecSetLayout(Vec,PetscLayout);

498: PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer);
499: PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar **);
500: PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, PetscScalar [], InsertMode);

502: #endif