1 /* $Id: petscvec.h,v 1.107 2000/05/04 16:27:19 bsmith Exp balay $ */ 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 __PETSCVEC_H 9 #define __PETSCVEC_H 10 #include "petscis.h" 11 #include "petscsys.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,const Scalar[],Vec*); 29 extern int VecCreateMPIWithArray(MPI_Comm,int,int,const Scalar[],Vec*); 30 extern int VecCreateShared(MPI_Comm,int,int,Vec*); 31 extern int VecCreate(MPI_Comm,int,int,Vec*); 32 extern int VecSetType(Vec,VecType); 33 extern int VecSetFromOptions(Vec); 34 extern int VecPrintHelp(Vec); 35 36 extern int VecDestroy(Vec); 37 38 extern int MapDestroy(Map); 39 extern int MapGetLocalSize(Map,int *); 40 extern int MapGetSize(Map,int *); 41 extern int MapGetLocalRange(Map,int *,int *); 42 extern int MapGetGlobalRange(Map,int *[]); 43 44 extern int VecDot(Vec,Vec,Scalar*); 45 extern int VecTDot(Vec,Vec,Scalar*); 46 extern int VecMDot(int,Vec,const Vec[],Scalar*); 47 extern int VecMTDot(int,Vec,const Vec[],Scalar*); 48 49 typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4,NORM_1_AND_2=5} NormType; 50 #define NORM_MAX NORM_INFINITY 51 extern int VecNorm(Vec,NormType,double *); 52 extern int VecSum(Vec,Scalar*); 53 extern int VecMax(Vec,int*,double*); 54 extern int VecMin(Vec,int*,double*); 55 extern int VecScale(const Scalar*,Vec); 56 extern int VecCopy(Vec,Vec); 57 extern int VecSetRandom(PetscRandom,Vec); 58 extern int VecSet(const Scalar*,Vec); 59 extern int VecSwap(Vec,Vec); 60 extern int VecAXPY(const Scalar*,Vec,Vec); 61 extern int VecAXPBY(const Scalar*,const Scalar *,Vec,Vec); 62 extern int VecMAXPY(int,const Scalar*,Vec,Vec*); 63 extern int VecAYPX(const Scalar*,Vec,Vec); 64 extern int VecWAXPY(const Scalar*,Vec,Vec,Vec); 65 extern int VecPointwiseMult(Vec,Vec,Vec); 66 extern int VecPointwiseDivide(Vec,Vec,Vec); 67 extern int VecShift(const Scalar*,Vec); 68 extern int VecReciprocal(Vec); 69 extern int VecAbs(Vec); 70 extern int VecDuplicate(Vec,Vec*); 71 extern int VecDuplicateVecs(Vec,int,Vec*[]); 72 extern int VecDestroyVecs(const Vec[],int); 73 extern int VecGetMap(Vec,Map*); 74 75 typedef enum {NOT_SET_VALUES,INSERT_VALUES,ADD_VALUES,MAX_VALUES} InsertMode; 76 77 extern int VecStrideNorm(Vec,int,NormType,double*); 78 extern int VecStrideGather(Vec,int,Vec,InsertMode); 79 extern int VecStrideScatter(Vec,int,Vec,InsertMode); 80 extern int VecStrideMax(Vec,int,int *,double *); 81 extern int VecStrideMin(Vec,int,int *,double *); 82 extern int VecStrideGatherAll(Vec,Vec*,InsertMode); 83 extern int VecStrideScatterAll(Vec*,Vec,InsertMode); 84 85 extern int VecSetValues(Vec,int,const int[],const Scalar[],InsertMode); 86 extern int VecAssemblyBegin(Vec); 87 extern int VecAssemblyEnd(Vec); 88 extern int VecSetStashInitialSize(Vec,int,int); 89 extern int VecStashView(Vec,Viewer); 90 91 #define VecSetValue(v,i,va,mode) \ 92 {int _ierr,_row = i; Scalar _va = va; \ 93 _ierr = VecSetValues(v,1,&_row,&_va,mode);CHKERRQ(_ierr); \ 94 } 95 extern int VecSetBlockSize(Vec,int); 96 extern int VecGetBlockSize(Vec,int*); 97 extern int VecSetValuesBlocked(Vec,int,const int[],const Scalar[],InsertMode); 98 99 extern PetscTruth VecRegisterAllCalled; 100 extern int VecRegisterAll(const char []); 101 extern int VecRegister(const char[],const char[],const char[],int(*)(Vec)); 102 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 103 #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,0) 104 #else 105 #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,d) 106 #endif 107 108 typedef enum {SCATTER_FORWARD=0,SCATTER_REVERSE=1,SCATTER_FORWARD_LOCAL=2, 109 SCATTER_REVERSE_LOCAL=3,SCATTER_LOCAL=2} ScatterMode; 110 extern int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 111 extern int VecScatterPostRecvs(Vec,Vec,InsertMode,ScatterMode,VecScatter); 112 extern int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter); 113 extern int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter); 114 extern int VecScatterDestroy(VecScatter); 115 extern int VecScatterCopy(VecScatter,VecScatter *); 116 extern int VecScatterView(VecScatter,Viewer); 117 extern int VecScatterRemap(VecScatter,int *,int*); 118 119 typedef enum {PIPELINE_DOWN=0,PIPELINE_UP=1} PipelineDirection; 120 typedef enum {PIPELINE_NONE=1,PIPELINE_SEQUENTIAL=2, 121 PIPELINE_REDBLACK=3,PIPELINE_MULTICOLOR=4} PipelineType; 122 123 typedef struct _p_VecPipeline* VecPipeline; 124 125 extern int VecPipelineCreate(MPI_Comm,Vec,IS,Vec,IS,VecPipeline *); 126 extern int VecPipelineSetType(VecPipeline,PipelineType,PetscObject); 127 extern int VecPipelineSetup(VecPipeline); 128 extern int VecPipelineBegin(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline); 129 extern int VecPipelineEnd(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline); 130 extern int VecPipelineView(VecPipeline,Viewer); 131 extern int VecPipelineDestroy(VecPipeline); 132 133 extern int VecGetArray(Vec,Scalar*[]); 134 extern int VecRestoreArray(Vec,Scalar*[]); 135 extern int VecGetArray4d(Vec,int,int,int,int,int,int,int,int,Scalar**[]); 136 extern int VecRestoreArray4d(Vec,int,int,int,int,int,int,int,int,Scalar**[]); 137 extern int VecGetArray3d(Vec,int,int,int,int,int,int,Scalar**[]); 138 extern int VecRestoreArray3d(Vec,int,int,int,int,int,int,Scalar**[]); 139 extern int VecGetArray2d(Vec,int,int,int,int,Scalar**[]); 140 extern int VecRestoreArray2d(Vec,int,int,int,int,Scalar**[]); 141 extern int VecGetArray1d(Vec,int,int,Scalar *[]); 142 extern int VecRestoreArray1d(Vec,int,int,Scalar *[]); 143 144 extern int VecPlaceArray(Vec,const Scalar[]); 145 extern int VecReplaceArray(Vec,const Scalar[]); 146 extern int VecGetArrays(const Vec[],int,Scalar**[]); 147 extern int VecRestoreArrays(const Vec[],int,Scalar**[]); 148 149 extern int VecValid(Vec,PetscTruth*); 150 extern int VecView(Vec,Viewer); 151 extern int VecEqual(Vec,Vec,PetscTruth*); 152 extern int VecLoad(Viewer,Vec*); 153 extern int VecLoadIntoVector(Viewer,Vec); 154 155 extern int VecGetSize(Vec,int*); 156 extern int VecGetType(Vec,VecType*); 157 extern int VecGetLocalSize(Vec,int*); 158 extern int VecGetOwnershipRange(Vec,int*,int*); 159 160 extern int VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping); 161 extern int VecSetValuesLocal(Vec,int,const int[],const Scalar[],InsertMode); 162 extern int VecSetLocalToGlobalMappingBlocked(Vec,ISLocalToGlobalMapping); 163 extern int VecSetValuesBlockedLocal(Vec,int,const int[],const Scalar[],InsertMode); 164 165 extern int VecDotBegin(Vec,Vec,Scalar *); 166 extern int VecDotEnd(Vec,Vec,Scalar *); 167 extern int VecTDotBegin(Vec,Vec,Scalar *); 168 extern int VecTDotEnd(Vec,Vec,Scalar *); 169 extern int VecNormBegin(Vec,NormType,double *); 170 extern int VecNormEnd(Vec,NormType,double *); 171 172 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES} VecOption; 173 extern int VecSetOption(Vec,VecOption); 174 175 extern int VecContourScale(Vec,double,double); 176 177 /* 178 These numbers need to match the entries in 179 the function table in src/vec/vecimpl.h 180 */ 181 typedef enum { VECOP_VIEW = 33, 182 VECOP_LOADINTOVECTOR = 40 183 } VecOperation; 184 extern int VecSetOperation(Vec,VecOperation,void*); /* */ 185 186 /* 187 Routines for dealing with ghosted vectors: 188 vectors with ghost elements at the end of the array. 189 */ 190 extern int VecCreateGhost(MPI_Comm,int,int,int,const int[],Vec*); 191 extern int VecCreateGhostWithArray(MPI_Comm,int,int,int,const int[],const Scalar[],Vec*); 192 extern int VecCreateGhostBlock(MPI_Comm,int,int,int,int,const int[],Vec*); 193 extern int VecCreateGhostBlockWithArray(MPI_Comm,int,int,int,int,const int[],const Scalar[],Vec*); 194 extern int VecGhostGetLocalForm(Vec,Vec*); 195 extern int VecGhostRestoreLocalForm(Vec,Vec*); 196 extern int VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 197 extern int VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 198 199 200 201 #endif 202 203 204 205