1 /* $Id: vec.h,v 1.57 1997/02/04 21:27:32 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 VecCreateMPIGhost(MPI_Comm,int,int,int,Vec*); 24 extern int VecCreate(MPI_Comm,int,Vec*); 25 26 extern int VecDestroy(Vec); 27 28 extern int VecDot(Vec,Vec,Scalar*); 29 extern int VecTDot(Vec,Vec,Scalar*); 30 extern int VecMDot(int,Vec,Vec*,Scalar*); 31 extern int VecMTDot(int,Vec,Vec*,Scalar*); 32 33 typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4} NormType; 34 #define NORM_MAX NORM_INFINITY 35 extern int VecNorm(Vec,NormType,double *); 36 extern int VecSum(Vec,Scalar*); 37 extern int VecMax(Vec,int*,double*); 38 extern int VecMin(Vec,int*,double*); 39 extern int VecScale(Scalar*,Vec); 40 extern int VecCopy(Vec,Vec); 41 extern int VecSetRandom(PetscRandom,Vec); 42 extern int VecSet(Scalar*,Vec); 43 extern int VecSwap(Vec,Vec); 44 extern int VecAXPY(Scalar*,Vec,Vec); 45 extern int VecAXPBY(Scalar*,Scalar *,Vec,Vec); 46 extern int VecMAXPY(int,Scalar*,Vec,Vec*); 47 extern int VecAYPX(Scalar*,Vec,Vec); 48 extern int VecWAXPY(Scalar*,Vec,Vec,Vec); 49 extern int VecPointwiseMult(Vec,Vec,Vec); 50 extern int VecPointwiseDivide(Vec,Vec,Vec); 51 extern int VecShift(Scalar*,Vec); 52 extern int VecReciprocal(Vec); 53 extern int VecAbs(Vec); 54 extern int VecDuplicate(Vec,Vec*); 55 extern int VecDuplicateVecs(Vec,int,Vec**); 56 extern int VecDestroyVecs(Vec*,int); 57 58 typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES} InsertMode; 59 extern int VecSetValues(Vec,int,int*,Scalar*,InsertMode); 60 extern int VecAssemblyBegin(Vec); 61 extern int VecAssemblyEnd(Vec); 62 #define VecSetValue(v,i,va,mode) \ 63 {int _ierr,_row = i; Scalar _va = va; \ 64 _ierr = VecSetValues(v,1,&_row,&_va,mode);CHKERRQ(_ierr); \ 65 } 66 67 typedef enum {SCATTER_FORWARD=0,SCATTER_REVERSE=1,SCATTER_FORWARD_LOCAL=2, 68 SCATTER_REVERSE_LOCAL=3,SCATTER_LOCAL=2} ScatterMode; 69 extern int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 70 extern int VecScatterPostRecvs(Vec,Vec,InsertMode,ScatterMode,VecScatter); 71 extern int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter); 72 extern int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter); 73 extern int VecScatterDestroy(VecScatter); 74 extern int VecScatterCopy(VecScatter,VecScatter *); 75 extern int VecScatterView(VecScatter,Viewer); 76 extern int VecScatterRemap(VecScatter,int *,int*); 77 78 extern int VecGetArray(Vec,Scalar**); 79 extern int VecRestoreArray(Vec,Scalar**); 80 extern int VecPlaceArray(Vec,Scalar*); 81 extern int VecGetArrays(Vec*,int,Scalar***); 82 extern int VecRestoreArrays(Vec*,int,Scalar***); 83 84 extern int VecValid(Vec,PetscTruth*); 85 extern int VecView(Vec,Viewer); 86 extern int VecEqual(Vec,Vec,PetscTruth*); 87 extern int VecLoad(Viewer,Vec*); 88 89 extern int VecGetSize(Vec,int*); 90 extern int VecGetType(Vec,VecType*,char**); 91 extern int VecGetLocalSize(Vec,int*); 92 extern int VecGetOwnershipRange(Vec,int*,int*); 93 94 extern int VecSetLocalToGlobalMapping(Vec, int,int *); 95 extern int VecSetValuesLocal(Vec,int,int*,Scalar*,InsertMode); 96 97 typedef enum {VEC_IGNORE_OFF_PROCESSOR_ENTRIES} VecOption; 98 extern int VecSetOption(Vec,VecOption); 99 100 #if defined(__DRAW_PACKAGE) 101 extern int DrawTensorContour(Draw,int,int,double *,double *,Vec); 102 #endif 103 104 #endif 105 106 107 108