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