1 /* $Id: vec.h,v 1.72 1998/05/29 20:40:07 bsmith Exp bsmith $ */ 2 /* 3 Defines the vector component of PETSc. Vectors generally represent 4 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_H 9 #define __VEC_H 10 #include "is.h" 11 #include "sys.h" 12 13 #define VEC_COOKIE PETSC_COOKIE+3 14 #define MAP_COOKIE PETSC_COOKIE+22 15 #define VEC_SCATTER_COOKIE PETSC_COOKIE+4 16 17 typedef enum {VECSAME=-1, VECSEQ, VECMPI} VecType; 18 19 typedef struct _p_Map* Map; 20 typedef struct _p_Vec* Vec; 21 typedef struct _p_VecScatter* VecScatter; 22 23 extern int VecCreateSeq(MPI_Comm,int,Vec*); 24 extern int MapCreateMPI(MPI_Comm,int,int,Map*); 25 extern int VecCreateMPI(MPI_Comm,int,int,Vec*); 26 extern int VecCreateSeqWithArray(MPI_Comm,int,Scalar*,Vec*); 27 extern int VecCreateMPIWithArray(MPI_Comm,int,int,Scalar*,Vec*); 28 extern int VecCreateShared(MPI_Comm,int,int,Vec*); 29 extern int VecCreate(MPI_Comm,int,int,Vec*); 30 extern int VecCreateWithType(MPI_Comm,char *,int,int,Vec*); 31 32 extern int VecDestroy(Vec); 33 34 extern int MapDestroy(Map); 35 extern int MapGetLocalSize(Map,int *); 36 extern int MapGetGlobalSize(Map,int *); 37 extern int MapGetLocalRange(Map,int *,int *); 38 extern int MapGetGlobalRange(Map,int **); 39 40 extern int VecDot(Vec,Vec,Scalar*); 41 extern int VecTDot(Vec,Vec,Scalar*); 42 extern int VecMDot(int,Vec,Vec*,Scalar*); 43 extern int VecMTDot(int,Vec,Vec*,Scalar*); 44 45 typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4,NORM_1_AND_2=5} NormType; 46 #define NORM_MAX NORM_INFINITY 47 extern int VecNorm(Vec,NormType,double *); 48 extern int VecSum(Vec,Scalar*); 49 extern int VecMax(Vec,int*,double*); 50 extern int VecMin(Vec,int*,double*); 51 extern int VecScale(Scalar*,Vec); 52 extern int VecCopy(Vec,Vec); 53 extern int VecSetRandom(PetscRandom,Vec); 54 extern int VecSet(Scalar*,Vec); 55 extern int VecSwap(Vec,Vec); 56 extern int VecAXPY(Scalar*,Vec,Vec); 57 extern int VecAXPBY(Scalar*,Scalar *,Vec,Vec); 58 extern int VecMAXPY(int,Scalar*,Vec,Vec*); 59 extern int VecAYPX(Scalar*,Vec,Vec); 60 extern int VecWAXPY(Scalar*,Vec,Vec,Vec); 61 extern int VecPointwiseMult(Vec,Vec,Vec); 62 extern int VecPointwiseDivide(Vec,Vec,Vec); 63 extern int VecShift(Scalar*,Vec); 64 extern int VecReciprocal(Vec); 65 extern int VecAbs(Vec); 66 extern int VecDuplicate(Vec,Vec*); 67 extern int VecDuplicateVecs(Vec,int,Vec**); 68 extern int VecDestroyVecs(Vec*,int); 69 extern int VecGetMap(Vec,Map*); 70 71 typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES} InsertMode; 72 extern int VecSetValues(Vec,int,int*,Scalar*,InsertMode); 73 extern int VecAssemblyBegin(Vec); 74 extern int VecAssemblyEnd(Vec); 75 #define VecSetValue(v,i,va,mode) \ 76 {int _ierr,_row = i; Scalar _va = va; \ 77 _ierr = VecSetValues(v,1,&_row,&_va,mode);CHKERRQ(_ierr); \ 78 } 79 extern int VecSetBlockSize(Vec,int); 80 extern int VecSetValuesBlocked(Vec,int,int*,Scalar*,InsertMode); 81 82 extern int VecRegisterAllCalled; 83 extern int VecRegisterAll(char *); 84 extern int VecRegister_Private(char*,char*,char*,int(*)(MPI_Comm,int,int,Vec*)); 85 #if defined(USE_DYNAMIC_LIBRARIES) 86 #define VecRegister(a,b,c,d) VecRegister_Private(a,b,c,0) 87 #else 88 #define VecRegister(a,b,c,d) VecRegister_Private(a,b,c,d) 89 #endif 90 91 typedef enum {SCATTER_FORWARD=0,SCATTER_REVERSE=1,SCATTER_FORWARD_LOCAL=2, 92 SCATTER_REVERSE_LOCAL=3,SCATTER_LOCAL=2} ScatterMode; 93 extern int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 94 extern int VecScatterPostRecvs(Vec,Vec,InsertMode,ScatterMode,VecScatter); 95 extern int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter); 96 extern int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter); 97 extern int VecScatterDestroy(VecScatter); 98 extern int VecScatterCopy(VecScatter,VecScatter *); 99 extern int VecScatterView(VecScatter,Viewer); 100 extern int VecScatterRemap(VecScatter,int *,int*); 101 102 extern int VecGetArray(Vec,Scalar**); 103 extern int VecRestoreArray(Vec,Scalar**); 104 extern int VecPlaceArray(Vec,Scalar*); 105 extern int VecGetArrays(Vec*,int,Scalar***); 106 extern int VecRestoreArrays(Vec*,int,Scalar***); 107 108 extern int VecValid(Vec,PetscTruth*); 109 extern int VecView(Vec,Viewer); 110 extern int VecEqual(Vec,Vec,PetscTruth*); 111 extern int VecLoad(Viewer,Vec*); 112 113 extern int VecGetSize(Vec,int*); 114 extern int VecGetType(Vec,char**); 115 extern int VecGetLocalSize(Vec,int*); 116 extern int VecGetOwnershipRange(Vec,int*,int*); 117 118 extern int VecSetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping); 119 extern int VecSetValuesLocal(Vec,int,int*,Scalar*,InsertMode); 120 extern int VecSetLocalToGlobalMappingBlocked(Vec, ISLocalToGlobalMapping); 121 extern int VecSetValuesBlockedLocal(Vec,int,int*,Scalar*,InsertMode); 122 123 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES} VecOption; 124 extern int VecSetOption(Vec,VecOption); 125 126 extern int VecContourScale(Vec,double,double); 127 128 /* 129 Routines for dealing with ghosted vectors: 130 vectors with ghost elements at the end of the array. 131 */ 132 extern int VecCreateGhost(MPI_Comm,int,int,int,int*,Vec*); 133 extern int VecCreateGhostWithArray(MPI_Comm,int,int,int,int*,Scalar*,Vec*); 134 extern int VecGhostGetLocalRepresentation(Vec,Vec*); 135 extern int VecGhostRestoreLocalRepresentation(Vec,Vec*); 136 extern int VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 137 extern int VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 138 139 140 extern int DrawTensorContour(Draw,int,int,double *,double *,Vec); 141 142 #endif 143 144 145 146