1 /* $Id: vec.h,v 1.78 1998/09/25 03:16:46 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 struct _p_Map* Map; 18 typedef struct _p_Vec* Vec; 19 typedef struct _p_VecScatter* VecScatter; 20 #define VEC_SEQ "seq" 21 #define VEC_MPI "mpi" 22 #define VEC_SHARED "shared" 23 typedef char* VecType; 24 25 extern int VecCreateSeq(MPI_Comm,int,Vec*); 26 extern int MapCreateMPI(MPI_Comm,int,int,Map*); 27 extern int VecCreateMPI(MPI_Comm,int,int,Vec*); 28 extern int VecCreateSeqWithArray(MPI_Comm,int,Scalar*,Vec*); 29 extern int VecCreateMPIWithArray(MPI_Comm,int,int,Scalar*,Vec*); 30 extern int VecCreateShared(MPI_Comm,int,int,Vec*); 31 extern int VecCreate(MPI_Comm,int,int,Vec*); 32 extern int VecCreateWithType(MPI_Comm,VecType,int,int,Vec*); 33 34 extern int VecDestroy(Vec); 35 36 extern int MapDestroy(Map); 37 extern int MapGetLocalSize(Map,int *); 38 extern int MapGetGlobalSize(Map,int *); 39 extern int MapGetLocalRange(Map,int *,int *); 40 extern int MapGetGlobalRange(Map,int **); 41 42 extern int VecDot(Vec,Vec,Scalar*); 43 extern int VecTDot(Vec,Vec,Scalar*); 44 extern int VecMDot(int,Vec,Vec*,Scalar*); 45 extern int VecMTDot(int,Vec,Vec*,Scalar*); 46 47 typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4,NORM_1_AND_2=5} NormType; 48 #define NORM_MAX NORM_INFINITY 49 extern int VecNorm(Vec,NormType,double *); 50 extern int VecSum(Vec,Scalar*); 51 extern int VecMax(Vec,int*,double*); 52 extern int VecMin(Vec,int*,double*); 53 extern int VecScale(Scalar*,Vec); 54 extern int VecCopy(Vec,Vec); 55 extern int VecSetRandom(PetscRandom,Vec); 56 extern int VecSet(Scalar*,Vec); 57 extern int VecSwap(Vec,Vec); 58 extern int VecAXPY(Scalar*,Vec,Vec); 59 extern int VecAXPBY(Scalar*,Scalar *,Vec,Vec); 60 extern int VecMAXPY(int,Scalar*,Vec,Vec*); 61 extern int VecAYPX(Scalar*,Vec,Vec); 62 extern int VecWAXPY(Scalar*,Vec,Vec,Vec); 63 extern int VecPointwiseMult(Vec,Vec,Vec); 64 extern int VecPointwiseDivide(Vec,Vec,Vec); 65 extern int VecShift(Scalar*,Vec); 66 extern int VecReciprocal(Vec); 67 extern int VecAbs(Vec); 68 extern int VecDuplicate(Vec,Vec*); 69 extern int VecDuplicateVecs(Vec,int,Vec**); 70 extern int VecDestroyVecs(Vec*,int); 71 extern int VecGetMap(Vec,Map*); 72 73 typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES} InsertMode; 74 extern int VecStrideNorm(Vec,int,NormType,double*); 75 extern int VecStrideGather(Vec,int,Vec,InsertMode); 76 extern int VecStrideScatter(Vec,int,Vec,InsertMode); 77 78 extern int VecSetValues(Vec,int,int*,Scalar*,InsertMode); 79 extern int VecAssemblyBegin(Vec); 80 extern int VecAssemblyEnd(Vec); 81 #define VecSetValue(v,i,va,mode) \ 82 {int _ierr,_row = i; Scalar _va = va; \ 83 _ierr = VecSetValues(v,1,&_row,&_va,mode);CHKERRQ(_ierr); \ 84 } 85 extern int VecSetBlockSize(Vec,int); 86 extern int VecSetValuesBlocked(Vec,int,int*,Scalar*,InsertMode); 87 88 extern int VecRegisterAllCalled; 89 extern int VecRegisterAll(char *); 90 extern int VecRegister_Private(char*,char*,char*,int(*)(MPI_Comm,int,int,Vec*)); 91 #if defined(USE_DYNAMIC_LIBRARIES) 92 #define VecRegister(a,b,c,d) VecRegister_Private(a,b,c,0) 93 #else 94 #define VecRegister(a,b,c,d) VecRegister_Private(a,b,c,d) 95 #endif 96 97 typedef enum {SCATTER_FORWARD=0,SCATTER_REVERSE=1,SCATTER_FORWARD_LOCAL=2, 98 SCATTER_REVERSE_LOCAL=3,SCATTER_LOCAL=2} ScatterMode; 99 extern int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 100 extern int VecScatterPostRecvs(Vec,Vec,InsertMode,ScatterMode,VecScatter); 101 extern int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter); 102 extern int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter); 103 extern int VecScatterDestroy(VecScatter); 104 extern int VecScatterCopy(VecScatter,VecScatter *); 105 extern int VecScatterView(VecScatter,Viewer); 106 extern int VecScatterRemap(VecScatter,int *,int*); 107 108 typedef enum {PIPELINE_DOWN=0,PIPELINE_UP=1} PipelineDirection; 109 typedef enum {PIPELINE_NONE=1, PIPELINE_SEQUENTIAL=2, 110 PIPELINE_REDBLACK=3, PIPELINE_MULTICOLOUR=4} PipelineType; 111 112 typedef struct _p_VecPipeline* VecPipeline; 113 114 extern int VecPipelineCreate(MPI_Comm comm,Vec xin,IS ix,Vec yin,IS iy,VecPipeline *newctx); 115 extern int VecPipelineSetType(VecPipeline ctx,PipelineType typ,PetscObject x); 116 extern int VecPipelineSetup(VecPipeline ctx); 117 extern int VecPipelineBegin(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline); 118 extern int VecPipelineEnd(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline); 119 extern int VecPipelineView(VecPipeline pipe,Viewer viewer); 120 extern int VecPipelineDestroy(VecPipeline ctx); 121 122 extern int VecGetArray(Vec,Scalar**); 123 extern int VecRestoreArray(Vec,Scalar**); 124 extern int VecPlaceArray(Vec,Scalar*); 125 extern int VecGetArrays(Vec*,int,Scalar***); 126 extern int VecRestoreArrays(Vec*,int,Scalar***); 127 128 extern int VecValid(Vec,PetscTruth*); 129 extern int VecView(Vec,Viewer); 130 extern int VecEqual(Vec,Vec,PetscTruth*); 131 extern int VecLoad(Viewer,Vec*); 132 133 extern int VecGetSize(Vec,int*); 134 extern int VecGetType(Vec,VecType*); 135 extern int VecGetLocalSize(Vec,int*); 136 extern int VecGetOwnershipRange(Vec,int*,int*); 137 138 extern int VecSetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping); 139 extern int VecSetValuesLocal(Vec,int,int*,Scalar*,InsertMode); 140 extern int VecSetLocalToGlobalMappingBlocked(Vec, ISLocalToGlobalMapping); 141 extern int VecSetValuesBlockedLocal(Vec,int,int*,Scalar*,InsertMode); 142 143 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES} VecOption; 144 extern int VecSetOption(Vec,VecOption); 145 146 extern int VecContourScale(Vec,double,double); 147 148 /* 149 Routines for dealing with ghosted vectors: 150 vectors with ghost elements at the end of the array. 151 */ 152 extern int VecCreateGhost(MPI_Comm,int,int,int,int*,Vec*); 153 extern int VecCreateGhostWithArray(MPI_Comm,int,int,int,int*,Scalar*,Vec*); 154 extern int VecGhostGetLocalForm(Vec,Vec*); 155 extern int VecGhostRestoreLocalForm(Vec,Vec*); 156 extern int VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 157 extern int VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 158 159 160 extern int DrawTensorContour(Draw,int,int,double *,double *,Vec); 161 162 #endif 163 164 165 166