1 /* $Id: vec.h,v 1.35 1995/10/11 17:59:04 curfman 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 _VecScatter* VecScatter; 29 30 extern int VecCreateSeq(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 {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES} 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 {SCATTER_REVERSE=1,SCATTER_DOWN=2,SCATTER_UP=4,SCATTER_ALL=8, 66 SCATTER_ALL_REVERSE=9} ScatterMode; 67 68 extern int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter); 69 extern int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter); 70 extern int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 71 extern int VecScatterDestroy(VecScatter); 72 extern int VecScatterCopy(VecScatter,VecScatter *); 73 extern int VecScatterView(VecScatter,Viewer); 74 75 typedef enum {PIPELINE_DOWN=0,PIPELINE_UP=1} PipelineMode; 76 77 extern int VecPipelineBegin(Vec,Vec,InsertMode,PipelineMode,VecScatter); 78 extern int VecPipelineEnd(Vec,Vec,InsertMode,PipelineMode,VecScatter); 79 80 extern int VecShift(Scalar *,Vec); 81 extern int VecGetArray(Vec,Scalar**); 82 extern int VecRestoreArray(Vec,Scalar**); 83 extern int VecGetArrays(Vec*,int,Scalar***); 84 extern int VecRestoreArrays(Vec*,int,Scalar***); 85 extern int VecValidVector(Vec); 86 extern int VecView(Vec,Viewer); 87 extern int VecLoad(Viewer,Vec*); 88 89 extern int VecGetSize(Vec,int *); 90 extern int VecGetLocalSize(Vec,int *); 91 extern int VecGetOwnershipRange(Vec,int*,int*); 92 93 /* utility routines */ 94 extern int VecReciprocal(Vec); 95 extern int VecAbs(Vec); 96 97 #if defined(__DRAW_PACKAGE) 98 extern int DrawTensorContour(DrawCtx,int,int,double *,double *,Vec); 99 #endif 100 101 #endif 102 103 104