1 /* $Id: vec.h,v 1.56 1997/02/03 06:03:27 bsmith Exp bsmith $ */ 2 /* 3 This defines the abstract vector component of PETSc. Vectors generally 4 represent degrees of freedom for finite element/finite difference functions 5 on a grid. They have more mathematical structure then simple arrays. 6 */ 7 8 #ifndef __VEC_PACKAGE 9 #define __VEC_PACKAGE 10 #include "is.h" 11 #include "sys.h" 12 13 #define VEC_COOKIE PETSC_COOKIE+3 14 #define VEC_SCATTER_COOKIE PETSC_COOKIE+4 15 16 typedef enum {VECSAME=-1, VECSEQ, VECMPI} VecType; 17 18 typedef struct _Vec* Vec; 19 typedef struct _VecScatter* VecScatter; 20 21 extern int VecCreateSeq(MPI_Comm,int,Vec*); 22 extern int VecCreateMPI(MPI_Comm,int,int,Vec*); 23 extern int VecCreate(MPI_Comm,int,Vec*); 24 25 extern int VecDestroy(Vec); 26 27 extern int VecDot(Vec,Vec,Scalar*); 28 extern int VecTDot(Vec,Vec,Scalar*); 29 extern int VecMDot(int,Vec,Vec*,Scalar*); 30 extern int VecMTDot(int,Vec,Vec*,Scalar*); 31 32 typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4} NormType; 33 #define NORM_MAX NORM_INFINITY 34 extern int VecNorm(Vec,NormType,double *); 35 extern int VecSum(Vec,Scalar*); 36 extern int VecMax(Vec,int*,double*); 37 extern int VecMin(Vec,int*,double*); 38 extern int VecScale(Scalar*,Vec); 39 extern int VecCopy(Vec,Vec); 40 extern int VecSetRandom(PetscRandom,Vec); 41 extern int VecSet(Scalar*,Vec); 42 extern int VecSwap(Vec,Vec); 43 extern int VecAXPY(Scalar*,Vec,Vec); 44 extern int VecAXPBY(Scalar*,Scalar *,Vec,Vec); 45 extern int VecMAXPY(int,Scalar*,Vec,Vec*); 46 extern int VecAYPX(Scalar*,Vec,Vec); 47 extern int VecWAXPY(Scalar*,Vec,Vec,Vec); 48 extern int VecPointwiseMult(Vec,Vec,Vec); 49 extern int VecPointwiseDivide(Vec,Vec,Vec); 50 extern int VecShift(Scalar*,Vec); 51 extern int VecReciprocal(Vec); 52 extern int VecAbs(Vec); 53 extern int VecDuplicate(Vec,Vec*); 54 extern int VecDuplicateVecs(Vec,int,Vec**); 55 extern int VecDestroyVecs(Vec*,int); 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 #define VecSetValue(v,i,va,mode) \ 62 {int _ierr,_row = i; Scalar _va = va; \ 63 _ierr = VecSetValues(v,1,&_row,&_va,mode);CHKERRQ(_ierr); \ 64 } 65 66 typedef enum {SCATTER_FORWARD=0,SCATTER_REVERSE=1,SCATTER_FORWARD_LOCAL=2, 67 SCATTER_REVERSE_LOCAL=3,SCATTER_LOCAL=2} ScatterMode; 68 extern int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 69 extern int VecScatterPostRecvs(Vec,Vec,InsertMode,ScatterMode,VecScatter); 70 extern int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter); 71 extern int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter); 72 extern int VecScatterDestroy(VecScatter); 73 extern int VecScatterCopy(VecScatter,VecScatter *); 74 extern int VecScatterView(VecScatter,Viewer); 75 extern int VecScatterRemap(VecScatter,int *,int*); 76 77 extern int VecGetArray(Vec,Scalar**); 78 extern int VecRestoreArray(Vec,Scalar**); 79 extern int VecPlaceArray(Vec,Scalar*); 80 extern int VecGetArrays(Vec*,int,Scalar***); 81 extern int VecRestoreArrays(Vec*,int,Scalar***); 82 83 extern int VecValid(Vec,PetscTruth*); 84 extern int VecView(Vec,Viewer); 85 extern int VecEqual(Vec,Vec,PetscTruth*); 86 extern int VecLoad(Viewer,Vec*); 87 88 extern int VecGetSize(Vec,int*); 89 extern int VecGetType(Vec,VecType*,char**); 90 extern int VecGetLocalSize(Vec,int*); 91 extern int VecGetOwnershipRange(Vec,int*,int*); 92 93 extern int VecSetLocalToGlobalMapping(Vec, int,int *); 94 extern int VecSetValuesLocal(Vec,int,int*,Scalar*,InsertMode); 95 96 typedef enum {VEC_IGNORE_OFF_PROCESSOR_ENTRIES} VecOption; 97 extern int VecSetOption(Vec,VecOption); 98 99 #if defined(__DRAW_PACKAGE) 100 extern int DrawTensorContour(Draw,int,int,double *,double *,Vec); 101 #endif 102 103 #endif 104 105 106 107