1 /* 2 This defines the abstract vector component. These are patterned 3 after the Level-1 Blas, but with some additions that have proved 4 useful. These include routines to allocate and free vectors. 5 6 Note that the routines that are normally thought of as returning a 7 value (e.g., dot, norm) return their value through an argument. 8 This allows these routines to be used with other datatype, such 9 as float and dcomplex. 10 11 All vectors should be declared as a Vec. All vector routines begin 12 with Vec. 13 14 15 */ 16 17 #ifndef __VEC_PACKAGE 18 #define __VEC_PACKAGE 19 #include "is.h" 20 21 #define VEC_COOKIE PETSC_COOKIE+3 22 #define VEC_SCATTER_COOKIE PETSC_COOKIE+4 23 24 25 typedef struct _Vec* Vec; 26 typedef struct _VecScatterCtx* VecScatterCtx; 27 28 extern int VecCreateSequential(MPI_Comm,int,Vec *); 29 extern int VecCreateMPI(MPI_Comm,int,int,Vec *); 30 extern int VecCreateInitialVector(MPI_Comm,int,Vec *); 31 32 extern int VecDot(Vec, Vec, Scalar*); 33 extern int VecTDot(Vec, Vec, Scalar*); 34 extern int VecMDot(int, Vec ,Vec*,Scalar*); 35 extern int VecMTDot(int, Vec ,Vec*,Scalar*); 36 extern int VecNorm(Vec, double*); 37 extern int VecASum(Vec, double*); 38 extern int VecSum(Vec,Scalar*); 39 extern int VecAMax(Vec, int *, double*); 40 extern int VecMax(Vec, int *, double*); 41 extern int VecMin(Vec, int *, double*); 42 extern int VecScale(Scalar*, Vec); 43 extern int VecCopy(Vec, Vec); 44 extern int VecSet(Scalar*, Vec); 45 extern int VecSwap(Vec, Vec); 46 extern int VecAXPY(Scalar*, Vec, Vec); 47 extern int VecMAXPY(int, Scalar*, Vec ,Vec*); 48 extern int VecAYPX(Scalar*, Vec, Vec); 49 extern int VecWAXPY(Scalar*, Vec, Vec, Vec); 50 extern int VecPMult(Vec, Vec, Vec); 51 extern int VecPDiv(Vec, Vec, Vec); 52 extern int VecCreate(Vec,Vec *); 53 extern int VecDestroy(Vec); 54 extern int VecGetVecs(Vec, int,Vec **); 55 extern int VecFreeVecs(Vec*,int); 56 57 typedef enum {NOTSETVALUES, INSERTVALUES, AddValues} InsertMode; 58 59 extern int VecSetValues(Vec, int, int *,Scalar*,InsertMode); 60 extern int VecAssemblyBegin(Vec); 61 extern int VecAssemblyEnd(Vec); 62 63 typedef enum {ScatterReverse=1,ScatterDown=2,ScatterUp=4,ScatterAll=8, 64 ScatterAllReverse=9} ScatterMode; 65 66 extern int VecScatterBegin(Vec,IS,Vec,IS,InsertMode,ScatterMode,VecScatterCtx); 67 extern int VecScatterEnd(Vec,IS,Vec,IS,InsertMode,ScatterMode,VecScatterCtx); 68 extern int VecScatterCtxCreate(Vec,IS,Vec,IS,VecScatterCtx *); 69 extern int VecScatterCtxDestroy(VecScatterCtx); 70 extern int VecScatterCtxCopy(VecScatterCtx,VecScatterCtx *); 71 72 typedef enum {PipelineDown=0,PipelineUp=1} PipelineMode; 73 74 extern int VecPipelineBegin(Vec,IS,Vec,IS,InsertMode,PipelineMode,VecScatterCtx); 75 extern int VecPipelineEnd(Vec,IS,Vec,IS,InsertMode,PipelineMode,VecScatterCtx); 76 77 extern int VecGetArray(Vec,Scalar**); 78 extern int VecRestoreArray(Vec,Scalar**); 79 extern int VecValidVector(Vec); 80 extern int VecView(Vec, Viewer); 81 82 extern int VecGetSize(Vec,int *); 83 extern int VecGetLocalSize(Vec,int *); 84 extern int VecGetOwnershipRange(Vec,int*,int*); 85 86 /* utility routines */ 87 extern int VecReciprocal(Vec); 88 89 #endif 90 91 92