1 /* $Id: vec.h,v 1.52 1996/08/05 03:53:16 bsmith Exp bsmith $ */ 2 /* 3 This defines the abstract vector component of PETSc. 4 */ 5 6 #ifndef __VEC_PACKAGE 7 #define __VEC_PACKAGE 8 #include "is.h" 9 #include "sys.h" 10 11 #define VEC_COOKIE PETSC_COOKIE+3 12 #define VEC_SCATTER_COOKIE PETSC_COOKIE+4 13 14 typedef enum { VECSAME=-1, VECSEQ, VECMPI } VecType; 15 16 typedef struct _Vec* Vec; 17 typedef struct _VecScatter* VecScatter; 18 19 20 extern int VecCreateSeq(MPI_Comm,int,Vec*); 21 extern int VecCreateMPI(MPI_Comm,int,int,Vec*); 22 extern int VecCreate(MPI_Comm,int,Vec*); 23 24 extern int VecDestroy(Vec); 25 26 extern int VecDot(Vec,Vec,Scalar*); 27 extern int VecTDot(Vec,Vec,Scalar*); 28 extern int VecMDot(int,Vec,Vec*,Scalar*); 29 extern int VecMTDot(int,Vec,Vec*,Scalar*); 30 31 typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4} NormType; 32 #define NORM_MAX NORM_INFINITY 33 extern int VecNorm(Vec,NormType,double *); 34 extern int VecSum(Vec,Scalar*); 35 extern int VecMax(Vec,int*,double*); 36 extern int VecMin(Vec,int*,double*); 37 extern int VecScale(Scalar*,Vec); 38 extern int VecCopy(Vec,Vec); 39 extern int VecSetRandom(PetscRandom,Vec); 40 extern int VecSet(Scalar*,Vec); 41 extern int VecSwap(Vec,Vec); 42 extern int VecAXPY(Scalar*,Vec,Vec); 43 extern int VecAXPBY(Scalar*,Scalar *,Vec,Vec); 44 extern int VecMAXPY(int,Scalar*,Vec,Vec*); 45 extern int VecAYPX(Scalar*,Vec,Vec); 46 extern int VecWAXPY(Scalar*,Vec,Vec,Vec); 47 extern int VecPointwiseMult(Vec,Vec,Vec); 48 extern int VecPointwiseDivide(Vec,Vec,Vec); 49 extern int VecShift(Scalar*,Vec); 50 extern int VecReciprocal(Vec); 51 extern int VecAbs(Vec); 52 extern int VecDuplicate(Vec,Vec*); 53 extern int VecDuplicateVecs(Vec,int,Vec**); 54 extern int VecDestroyVecs(Vec*,int); 55 56 57 typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES} InsertMode; 58 extern int VecSetValues(Vec,int,int*,Scalar*,InsertMode); 59 extern int VecAssemblyBegin(Vec); 60 extern int VecAssemblyEnd(Vec); 61 62 typedef enum {SCATTER_REVERSE=1,SCATTER_ALL=8} ScatterMode; 63 extern int VecScatterPostRecvs(Vec,Vec,InsertMode,ScatterMode,VecScatter); 64 extern int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter); 65 extern int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter); 66 extern int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 67 extern int VecScatterDestroy(VecScatter); 68 extern int VecScatterCopy(VecScatter,VecScatter *); 69 extern int VecScatterView(VecScatter,Viewer); 70 71 extern int VecScatterRemap(VecScatter,int *,int*); 72 73 extern int VecGetArray(Vec,Scalar**); 74 extern int VecRestoreArray(Vec,Scalar**); 75 extern int VecPlaceArray(Vec,Scalar*); 76 extern int VecGetArrays(Vec*,int,Scalar***); 77 extern int VecRestoreArrays(Vec*,int,Scalar***); 78 extern int VecValid(Vec,PetscTruth*); 79 extern int VecView(Vec,Viewer); 80 extern int VecLoad(Viewer,Vec*); 81 extern int VecEqual( Vec,Vec,PetscTruth*); 82 83 extern int VecGetSize(Vec,int*); 84 extern int VecGetType(Vec,VecType*,char**); 85 extern int VecGetLocalSize(Vec,int*); 86 extern int VecGetOwnershipRange(Vec,int*,int*); 87 88 extern int VecSetLocalToGlobalMapping(Vec, int,int *); 89 extern int VecSetValuesLocal(Vec,int,int*,Scalar*,InsertMode); 90 91 typedef enum { VEC_IGNORE_OFF_PROCESSOR_ENTRIES} VecOption; 92 extern int VecSetOption(Vec,VecOption); 93 94 #if defined(__DRAW_PACKAGE) 95 extern int DrawTensorContour(Draw,int,int,double *,double *,Vec); 96 #endif 97 98 #endif 99 100 101 102