Actual source code: petscvec.h
1: /* $Id: petscvec.h,v 1.127 2001/09/11 16:31:30 bsmith Exp $ */
2: /*
3: Defines the vector component of PETSc. Vectors generally represent
4: degrees of freedom for finite element/finite difference functions
5: on a grid. They have more mathematical structure then simple arrays.
6: */
8: #ifndef __PETSCVEC_H
10: #include petscis.h
11: #include petscsys.h
13: /*S
14: PetscMap - Abstract PETSc object that defines the layout of vector and
15: matrices across processors
17: Level: advanced
19: Notes:
20: Does not play a role in the PETSc design, can be ignored
22: Concepts: parallel decomposition
24: .seealso: PetscMapCreateMPI()
25: S*/
26: typedef struct _p_PetscMap* PetscMap;
28: #define MAP_SEQ "seq"
29: #define MAP_MPI "mpi"
30: typedef char *PetscMapType;
32: #define MAP_SER_MPI_BINARY "mpi_binary"
33: typedef char *PetscMapSerializeType;
35: /* Logging support */
36: extern int MAP_COOKIE;
38: EXTERN int PetscMapCreate(MPI_Comm,PetscMap*);
39: EXTERN int PetscMapCreateMPI(MPI_Comm,int,int,PetscMap*);
40: EXTERN int PetscMapSerialize(MPI_Comm,PetscMap *,PetscViewer,PetscTruth);
41: EXTERN int PetscMapSetFromOptions(PetscMap);
42: EXTERN int PetscMapPrintHelp(PetscMap);
43: EXTERN int PetscMapDestroy(PetscMap);
45: EXTERN int PetscMapSetLocalSize(PetscMap,int);
46: EXTERN int PetscMapGetLocalSize(PetscMap,int *);
47: EXTERN int PetscMapSetSize(PetscMap,int);
48: EXTERN int PetscMapGetSize(PetscMap,int *);
49: EXTERN int PetscMapGetLocalRange(PetscMap,int *,int *);
50: EXTERN int PetscMapGetGlobalRange(PetscMap,int *[]);
52: /* Dynamic creation and loading functions */
53: extern PetscFList PetscMapList;
54: extern PetscTruth PetscMapRegisterAllCalled;
55: EXTERN int PetscMapSetType(PetscMap, PetscMapType);
56: EXTERN int PetscMapGetType(PetscMap, PetscMapType *);
57: EXTERN int PetscMapRegister(const char[],const char[],const char[],int(*)(PetscMap));
58: EXTERN int PetscMapRegisterAll(const char []);
59: EXTERN int PetscMapRegisterDestroy(void);
60: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
61: #define PetscMapRegisterDynamic(a,b,c,d) PetscMapRegister(a,b,c,0)
62: #else
63: #define PetscMapRegisterDynamic(a,b,c,d) PetscMapRegister(a,b,c,d)
64: #endif
66: extern PetscFList PetscMapSerializeList;
67: extern PetscTruth PetscMapSerializeRegisterAllCalled;
68: EXTERN int PetscMapSetSerializeType(PetscMap, PetscMapSerializeType);
69: EXTERN int PetscMapGetSerializeType(PetscMap, PetscMapSerializeType *);
70: EXTERN int PetscMapSerializeRegister(const char [], const char [], const char [], int (*)(MPI_Comm, PetscMap *, PetscViewer, PetscTruth));
71: EXTERN int PetscMapSerializeRegisterAll(const char []);
72: EXTERN int PetscMapSerializeRegisterDestroy(void);
73: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
74: #define PetscMapSerializeRegisterDynamic(a,b,c,d) PetscMapSerializeRegister(a,b,c,0)
75: #else
76: #define PetscMapSerializeRegisterDynamic(a,b,c,d) PetscMapSerializeRegister(a,b,c,d)
77: #endif
79: /*S
80: Vec - Abstract PETSc vector object
82: Level: beginner
84: Concepts: field variables, unknowns, arrays
86: .seealso: VecCreate(), VecType, VecSetType()
87: S*/
88: typedef struct _p_Vec* Vec;
90: /*S
91: VecScatter - Object used to manage communication of data
92: between vectors in parallel. Manages both scatters and gathers
94: Level: beginner
96: Concepts: scatter
98: .seealso: VecScatterCreate(), VecScatterBegin(), VecScatterEnd()
99: S*/
100: typedef struct _p_VecScatter* VecScatter;
102: /*E
103: VecType - String with the name of a PETSc vector or the creation function
104: with an optional dynamic library name, for example
105: http://www.mcs.anl.gov/petsc/lib.a:myveccreate()
107: Level: beginner
109: .seealso: VecSetType(), Vec
110: E*/
111: #define VECSEQ "seq"
112: #define VECMPI "mpi"
113: #define VECFETI "feti"
114: #define VECSHARED "shared"
115: #define VECESI "esi"
116: #define VECPETSCESI "petscesi"
117: typedef char* VecType;
119: #define VEC_SER_SEQ_BINARY "seq_binary"
120: #define VEC_SER_MPI_BINARY "mpi_binary"
121: typedef char *VecSerializeType;
123: /* Logging support */
124: #define VEC_FILE_COOKIE 1211214
125: extern int VEC_COOKIE;
126: extern int VEC_SCATTER_COOKIE;
127: extern int VEC_View, VEC_Max, VEC_Min, VEC_DotBarrier, VEC_Dot, VEC_MDotBarrier, VEC_MDot, VEC_TDot, VEC_MTDot, VEC_NormBarrier;
128: extern int VEC_Norm, VEC_Scale, VEC_Copy, VEC_Set, VEC_AXPY, VEC_AYPX, VEC_WAXPY, VEC_MAXPY, VEC_Swap, VEC_AssemblyBegin;
129: extern int VEC_AssemblyEnd, VEC_PointwiseMult, VEC_SetValues, VEC_Load, VEC_ScatterBarrier, VEC_ScatterBegin, VEC_ScatterEnd;
130: extern int VEC_SetRandom, VEC_ReduceArithmetic, VEC_ReduceBarrier, VEC_ReduceCommunication;
132: EXTERN int VecInitializePackage(char *);
134: EXTERN int VecCreate(MPI_Comm,Vec *);
135: EXTERN int VecCreateSeq(MPI_Comm,int,Vec*);
136: EXTERN int VecCreateMPI(MPI_Comm,int,int,Vec*);
137: EXTERN int VecCreateSeqWithArray(MPI_Comm,int,const PetscScalar[],Vec*);
138: EXTERN int VecCreateMPIWithArray(MPI_Comm,int,int,const PetscScalar[],Vec*);
139: EXTERN int VecCreateShared(MPI_Comm,int,int,Vec*);
140: EXTERN int VecSerialize(MPI_Comm,Vec *,PetscViewer,PetscTruth);
141: EXTERN int VecSetFromOptions(Vec);
142: EXTERN int VecPrintHelp(Vec);
143: EXTERN int VecDestroy(Vec);
145: EXTERN int VecSetSizes(Vec,int,int);
147: EXTERN int VecDot(Vec,Vec,PetscScalar*);
148: EXTERN int VecTDot(Vec,Vec,PetscScalar*);
149: EXTERN int VecMDot(int,Vec,const Vec[],PetscScalar*);
150: EXTERN int VecMTDot(int,Vec,const Vec[],PetscScalar*);
152: /*E
153: NormType - determines what type of norm to compute
155: Level: beginner
157: .seealso: VecNorm(), VecNormBegin(), VecNormEnd(), MatNorm()
158: E*/
159: typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4,NORM_1_AND_2=5} NormType;
160: #define NORM_MAX NORM_INFINITY
162: EXTERN int VecNorm(Vec,NormType,PetscReal *);
163: EXTERN int VecSum(Vec,PetscScalar*);
164: EXTERN int VecMax(Vec,int*,PetscReal *);
165: EXTERN int VecMin(Vec,int*,PetscReal *);
166: EXTERN int VecScale(const PetscScalar *a,Vec v);
167: EXTERN int VecCopy(Vec,Vec);
168: EXTERN int VecSetRandom(PetscRandom,Vec);
169: EXTERN int VecSet(const PetscScalar*,Vec);
170: EXTERN int VecSwap(Vec,Vec);
171: EXTERN int VecAXPY(const PetscScalar*,Vec,Vec);
172: EXTERN int VecAXPBY(const PetscScalar*,const PetscScalar *,Vec,Vec);
173: EXTERN int VecMAXPY(int,const PetscScalar*,Vec,Vec*);
174: EXTERN int VecAYPX(const PetscScalar*,Vec,Vec);
175: EXTERN int VecWAXPY(const PetscScalar*,Vec,Vec,Vec);
176: EXTERN int VecPointwiseMult(Vec,Vec,Vec);
177: EXTERN int VecPointwiseDivide(Vec,Vec,Vec);
178: EXTERN int VecShift(const PetscScalar*,Vec);
179: EXTERN int VecReciprocal(Vec);
180: EXTERN int VecPermute(Vec, IS, PetscTruth);
181: EXTERN int VecSqrt(Vec);
182: EXTERN int VecAbs(Vec);
183: EXTERN int VecDuplicate(Vec,Vec*);
184: EXTERN int VecDuplicateVecs(Vec,int,Vec*[]);
185: EXTERN int VecDestroyVecs(const Vec[],int);
186: EXTERN int VecGetPetscMap(Vec,PetscMap*);
188: EXTERN int VecStrideNorm(Vec,int,NormType,PetscReal*);
189: EXTERN int VecStrideGather(Vec,int,Vec,InsertMode);
190: EXTERN int VecStrideScatter(Vec,int,Vec,InsertMode);
191: EXTERN int VecStrideMax(Vec,int,int *,PetscReal *);
192: EXTERN int VecStrideMin(Vec,int,int *,PetscReal *);
193: EXTERN int VecStrideGatherAll(Vec,Vec*,InsertMode);
194: EXTERN int VecStrideScatterAll(Vec*,Vec,InsertMode);
196: EXTERN int VecSetValues(Vec,int,const int[],const PetscScalar[],InsertMode);
197: EXTERN int VecAssemblyBegin(Vec);
198: EXTERN int VecAssemblyEnd(Vec);
199: EXTERN int VecSetStashInitialSize(Vec,int,int);
200: EXTERN int VecStashView(Vec,PetscViewer);
202: #define VecSetValue(v,i,va,mode) 0;
203: {int _ierr,_row = i; PetscScalar _va = va;
204: _VecSetValues(v,1,&_row,&_va,mode);CHKERRQ(_ierr);
205: }
206: EXTERN int VecSetBlockSize(Vec,int);
207: EXTERN int VecGetBlockSize(Vec,int*);
208: EXTERN int VecSetValuesBlocked(Vec,int,const int[],const PetscScalar[],InsertMode);
210: /* Dynamic creation and loading functions */
211: extern PetscFList VecList;
212: extern PetscTruth VecRegisterAllCalled;
213: EXTERN int VecSetType(Vec, VecType);
214: EXTERN int VecGetType(Vec, VecType *);
215: EXTERN int VecRegister(const char[],const char[],const char[],int(*)(Vec));
216: EXTERN int VecRegisterAll(const char []);
217: EXTERN int VecRegisterDestroy(void);
218: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
219: #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,0)
220: #else
221: #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,d)
222: #endif
224: extern PetscFList VecSerializeList;
225: extern PetscTruth VecSerializeRegisterAllCalled;
226: EXTERN int VecSetSerializeType(Vec, VecSerializeType);
227: EXTERN int VecGetSerializeType(Vec, VecSerializeType *);
228: EXTERN int VecSerializeRegister(const char [], const char [], const char [], int (*)(MPI_Comm, Vec *, PetscViewer, PetscTruth));
229: EXTERN int VecSerializeRegisterAll(const char []);
230: EXTERN int VecSerializeRegisterDestroy(void);
231: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
232: #define VecSerializeRegisterDynamic(a,b,c,d) VecSerializeRegister(a,b,c,0)
233: #else
234: #define VecSerializeRegisterDynamic(a,b,c,d) VecSerializeRegister(a,b,c,d)
235: #endif
237: EXTERN int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *);
238: EXTERN int VecScatterPostRecvs(Vec,Vec,InsertMode,ScatterMode,VecScatter);
239: EXTERN int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter);
240: EXTERN int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter);
241: EXTERN int VecScatterDestroy(VecScatter);
242: EXTERN int VecScatterCopy(VecScatter,VecScatter *);
243: EXTERN int VecScatterView(VecScatter,PetscViewer);
244: EXTERN int VecScatterRemap(VecScatter,int *,int*);
246: typedef enum {PIPELINE_DOWN=0,PIPELINE_UP=1} PipelineDirection;
247: typedef enum {PIPELINE_NONE=1,PIPELINE_SEQUENTIAL=2,
248: PIPELINE_REDBLACK=3,PIPELINE_MULTICOLOR=4} PipelineType;
250: typedef struct _p_VecPipeline* VecPipeline;
252: EXTERN int VecPipelineCreate(MPI_Comm,Vec,IS,Vec,IS,VecPipeline *);
253: EXTERN int VecPipelineSetType(VecPipeline,PipelineType,PetscObject);
254: EXTERN int VecPipelineSetup(VecPipeline);
255: EXTERN int VecPipelineBegin(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline);
256: EXTERN int VecPipelineEnd(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline);
257: EXTERN int VecPipelineView(VecPipeline,PetscViewer);
258: EXTERN int VecPipelineDestroy(VecPipeline);
260: EXTERN int VecGetArray(Vec,PetscScalar*[]);
261: EXTERN int VecRestoreArray(Vec,PetscScalar*[]);
262: EXTERN int VecGetArray4d(Vec,int,int,int,int,int,int,int,int,PetscScalar****[]);
263: EXTERN int VecRestoreArray4d(Vec,int,int,int,int,int,int,int,int,PetscScalar****[]);
264: EXTERN int VecGetArray3d(Vec,int,int,int,int,int,int,PetscScalar***[]);
265: EXTERN int VecRestoreArray3d(Vec,int,int,int,int,int,int,PetscScalar***[]);
266: EXTERN int VecGetArray2d(Vec,int,int,int,int,PetscScalar**[]);
267: EXTERN int VecRestoreArray2d(Vec,int,int,int,int,PetscScalar**[]);
268: EXTERN int VecGetArray1d(Vec,int,int,PetscScalar *[]);
269: EXTERN int VecRestoreArray1d(Vec,int,int,PetscScalar *[]);
271: EXTERN int VecPlaceArray(Vec,const PetscScalar[]);
272: EXTERN int VecResetArray(Vec);
273: EXTERN int VecReplaceArray(Vec,const PetscScalar[]);
274: EXTERN int VecGetArrays(const Vec[],int,PetscScalar**[]);
275: EXTERN int VecRestoreArrays(const Vec[],int,PetscScalar**[]);
277: EXTERN int VecValid(Vec,PetscTruth*);
278: EXTERN int VecView(Vec,PetscViewer);
279: EXTERN int VecViewFromOptions(Vec, char *);
280: EXTERN int VecEqual(Vec,Vec,PetscTruth*);
281: EXTERN int VecLoad(PetscViewer,Vec*);
282: EXTERN int VecLoadIntoVector(PetscViewer,Vec);
284: EXTERN int VecGetSize(Vec,int*);
285: EXTERN int VecGetLocalSize(Vec,int*);
286: EXTERN int VecGetOwnershipRange(Vec,int*,int*);
288: EXTERN int VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping);
289: EXTERN int VecSetValuesLocal(Vec,int,const int[],const PetscScalar[],InsertMode);
290: EXTERN int VecSetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping);
291: EXTERN int VecSetValuesBlockedLocal(Vec,int,const int[],const PetscScalar[],InsertMode);
293: EXTERN int VecDotBegin(Vec,Vec,PetscScalar *);
294: EXTERN int VecDotEnd(Vec,Vec,PetscScalar *);
295: EXTERN int VecTDotBegin(Vec,Vec,PetscScalar *);
296: EXTERN int VecTDotEnd(Vec,Vec,PetscScalar *);
297: EXTERN int VecNormBegin(Vec,NormType,PetscReal *);
298: EXTERN int VecNormEnd(Vec,NormType,PetscReal *);
300: typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES,VEC_TREAT_OFF_PROC_ENTRIES} VecOption;
301: EXTERN int VecSetOption(Vec,VecOption);
303: EXTERN int VecContourScale(Vec,PetscReal,PetscReal);
305: /*
306: These numbers need to match the entries in
307: the function table in src/vec/vecimpl.h
308: */
309: typedef enum { VECOP_VIEW = 32,
310: VECOP_LOADINTOVECTOR = 38
311: } VecOperation;
312: EXTERN int VecSetOperation(Vec,VecOperation,void(*)(void));
314: /*
315: Routines for dealing with ghosted vectors:
316: vectors with ghost elements at the end of the array.
317: */
318: EXTERN int VecCreateGhost(MPI_Comm,int,int,int,const int[],Vec*);
319: EXTERN int VecCreateGhostWithArray(MPI_Comm,int,int,int,const int[],const PetscScalar[],Vec*);
320: EXTERN int VecCreateGhostBlock(MPI_Comm,int,int,int,int,const int[],Vec*);
321: EXTERN int VecCreateGhostBlockWithArray(MPI_Comm,int,int,int,int,const int[],const PetscScalar[],Vec*);
322: EXTERN int VecGhostGetLocalForm(Vec,Vec*);
323: EXTERN int VecGhostRestoreLocalForm(Vec,Vec*);
324: EXTERN int VecGhostUpdateBegin(Vec,InsertMode,ScatterMode);
325: EXTERN int VecGhostUpdateEnd(Vec,InsertMode,ScatterMode);
327: EXTERN int VecConjugate(Vec);
329: EXTERN int VecConvertMPIToSeqAll(Vec vin,Vec *vout);
330: EXTERN int VecConvertMPIToMPIZero(Vec vin,Vec *vout);
333: EXTERN int VecESISetType(Vec,char*);
334: EXTERN int VecESISetFromOptions(Vec);
336: EXTERN int PetscViewerMathematicaGetVector(PetscViewer, Vec);
337: EXTERN int PetscViewerMathematicaPutVector(PetscViewer, Vec);
339: #endif