1 /* $Id: vec.h,v 1.77 1998/07/22 15:25:57 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 VecStrideNorm(Vec,int,NormType,double*); 73 extern int VecStrideGather(Vec,int,Vec,InsertMode); 74 extern int VecStrideScatter(Vec,int,Vec,InsertMode); 75 76 extern int VecSetValues(Vec,int,int*,Scalar*,InsertMode); 77 extern int VecAssemblyBegin(Vec); 78 extern int VecAssemblyEnd(Vec); 79 #define VecSetValue(v,i,va,mode) \ 80 {int _ierr,_row = i; Scalar _va = va; \ 81 _ierr = VecSetValues(v,1,&_row,&_va,mode);CHKERRQ(_ierr); \ 82 } 83 extern int VecSetBlockSize(Vec,int); 84 extern int VecSetValuesBlocked(Vec,int,int*,Scalar*,InsertMode); 85 86 extern int VecRegisterAllCalled; 87 extern int VecRegisterAll(char *); 88 extern int VecRegister_Private(char*,char*,char*,int(*)(MPI_Comm,int,int,Vec*)); 89 #if defined(USE_DYNAMIC_LIBRARIES) 90 #define VecRegister(a,b,c,d) VecRegister_Private(a,b,c,0) 91 #else 92 #define VecRegister(a,b,c,d) VecRegister_Private(a,b,c,d) 93 #endif 94 95 typedef enum {SCATTER_FORWARD=0,SCATTER_REVERSE=1,SCATTER_FORWARD_LOCAL=2, 96 SCATTER_REVERSE_LOCAL=3,SCATTER_LOCAL=2} ScatterMode; 97 extern int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 98 extern int VecScatterPostRecvs(Vec,Vec,InsertMode,ScatterMode,VecScatter); 99 extern int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter); 100 extern int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter); 101 extern int VecScatterDestroy(VecScatter); 102 extern int VecScatterCopy(VecScatter,VecScatter *); 103 extern int VecScatterView(VecScatter,Viewer); 104 extern int VecScatterRemap(VecScatter,int *,int*); 105 106 typedef enum {PIPELINE_DOWN=0,PIPELINE_UP=1} PipelineDirection; 107 typedef enum {PIPELINE_NONE=1, PIPELINE_SEQUENTIAL=2, 108 PIPELINE_REDBLACK=3, PIPELINE_MULTICOLOUR=4} PipelineType; 109 110 typedef struct _p_VecPipeline* VecPipeline; 111 112 extern int VecPipelineCreate(MPI_Comm comm,Vec xin,IS ix,Vec yin,IS iy,VecPipeline *newctx); 113 extern int VecPipelineSetType(VecPipeline ctx,PipelineType typ,PetscObject x); 114 extern int VecPipelineSetup(VecPipeline ctx); 115 extern int VecPipelineBegin(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline); 116 extern int VecPipelineEnd(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline); 117 extern int VecPipelineView(VecPipeline pipe,Viewer viewer); 118 extern int VecPipelineDestroy(VecPipeline ctx); 119 120 extern int VecGetArray(Vec,Scalar**); 121 extern int VecRestoreArray(Vec,Scalar**); 122 extern int VecPlaceArray(Vec,Scalar*); 123 extern int VecGetArrays(Vec*,int,Scalar***); 124 extern int VecRestoreArrays(Vec*,int,Scalar***); 125 126 extern int VecValid(Vec,PetscTruth*); 127 extern int VecView(Vec,Viewer); 128 extern int VecEqual(Vec,Vec,PetscTruth*); 129 extern int VecLoad(Viewer,Vec*); 130 131 extern int VecGetSize(Vec,int*); 132 extern int VecGetType(Vec,char**); 133 extern int VecGetLocalSize(Vec,int*); 134 extern int VecGetOwnershipRange(Vec,int*,int*); 135 136 extern int VecSetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping); 137 extern int VecSetValuesLocal(Vec,int,int*,Scalar*,InsertMode); 138 extern int VecSetLocalToGlobalMappingBlocked(Vec, ISLocalToGlobalMapping); 139 extern int VecSetValuesBlockedLocal(Vec,int,int*,Scalar*,InsertMode); 140 141 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES} VecOption; 142 extern int VecSetOption(Vec,VecOption); 143 144 extern int VecContourScale(Vec,double,double); 145 146 /* 147 Routines for dealing with ghosted vectors: 148 vectors with ghost elements at the end of the array. 149 */ 150 extern int VecCreateGhost(MPI_Comm,int,int,int,int*,Vec*); 151 extern int VecCreateGhostWithArray(MPI_Comm,int,int,int,int*,Scalar*,Vec*); 152 extern int VecGhostGetLocalForm(Vec,Vec*); 153 extern int VecGhostRestoreLocalForm(Vec,Vec*); 154 extern int VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 155 extern int VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 156 157 158 extern int DrawTensorContour(Draw,int,int,double *,double *,Vec); 159 160 #endif 161 162 163 164