1 /* $Id: petscvec.h,v 1.127 2001/09/11 16:31:30 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 __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 /*S 18 PetscMap - Abstract PETSc object that defines the layout of vector and 19 matrices across processors 20 21 Level: advanced 22 23 Notes: 24 Does not play a role in the PETSc design, can be ignored 25 26 Concepts: parallel decomposition 27 28 .seealso: PetscMapCreateMPI() 29 S*/ 30 typedef struct _p_PetscMap* PetscMap; 31 32 /*S 33 Vec - Abstract PETSc vector object 34 35 Level: beginner 36 37 Concepts: field variables, unknowns, arrays 38 39 .seealso: VecCreate(), VecType, VecSetType() 40 S*/ 41 typedef struct _p_Vec* Vec; 42 43 /*S 44 VecScatter - Object used to manage communication of data 45 between vectors in parallel. Manages both scatters and gathers 46 47 Level: beginner 48 49 Concepts: scatter 50 51 .seealso: VecScatterCreate(), VecScatterBegin(), VecScatterEnd() 52 S*/ 53 typedef struct _p_VecScatter* VecScatter; 54 55 /*E 56 VecType - String with the name of a PETSc vector or the creation function 57 with an optional dynamic library name, for example 58 http://www.mcs.anl.gov/petsc/lib.a:myveccreate() 59 60 Level: beginner 61 62 .seealso: VecSetType(), Vec 63 E*/ 64 #define VEC_SEQ "seq" 65 #define VEC_MPI "mpi" 66 #define VEC_FETI "feti" 67 #define VEC_SHARED "shared" 68 #define VEC_ESI "esi" 69 #define VEC_PETSCESI "petscesi" 70 #define VEC_CCAESI "ccaesi" 71 typedef char* VecType; 72 73 EXTERN int VecCreateSeq(MPI_Comm,int,Vec*); 74 EXTERN int PetscMapCreateMPI(MPI_Comm,int,int,PetscMap*); 75 EXTERN int VecCreateMPI(MPI_Comm,int,int,Vec*); 76 EXTERN int VecCreateSeqWithArray(MPI_Comm,int,const PetscScalar[],Vec*); 77 EXTERN int VecCreateMPIWithArray(MPI_Comm,int,int,const PetscScalar[],Vec*); 78 EXTERN int VecCreateShared(MPI_Comm,int,int,Vec*); 79 EXTERN int VecCreate(MPI_Comm,int,int,Vec*); 80 EXTERN int VecSetType(Vec,VecType); 81 EXTERN int VecSetFromOptions(Vec); 82 83 EXTERN int VecDestroy(Vec); 84 85 EXTERN int PetscMapDestroy(PetscMap); 86 EXTERN int PetscMapGetLocalSize(PetscMap,int *); 87 EXTERN int PetscMapGetSize(PetscMap,int *); 88 EXTERN int PetscMapGetLocalRange(PetscMap,int *,int *); 89 EXTERN int PetscMapGetGlobalRange(PetscMap,int *[]); 90 91 EXTERN int VecDot(Vec,Vec,PetscScalar*); 92 EXTERN int VecTDot(Vec,Vec,PetscScalar*); 93 EXTERN int VecMDot(int,Vec,const Vec[],PetscScalar*); 94 EXTERN int VecMTDot(int,Vec,const Vec[],PetscScalar*); 95 96 /*E 97 NormType - determines what type of norm to compute 98 99 Level: beginner 100 101 .seealso: VecNorm(), VecNormBegin(), VecNormEnd(), MatNorm() 102 E*/ 103 typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4,NORM_1_AND_2=5} NormType; 104 #define NORM_MAX NORM_INFINITY 105 106 EXTERN int VecNorm(Vec,NormType,PetscReal *); 107 EXTERN int VecSum(Vec,PetscScalar*); 108 EXTERN int VecMax(Vec,int*,PetscReal *); 109 EXTERN int VecMin(Vec,int*,PetscReal *); 110 EXTERN int VecScale(const PetscScalar *a,Vec v); 111 EXTERN int VecCopy(Vec,Vec); 112 EXTERN int VecSetRandom(PetscRandom,Vec); 113 EXTERN int VecSet(const PetscScalar*,Vec); 114 EXTERN int VecSwap(Vec,Vec); 115 EXTERN int VecAXPY(const PetscScalar*,Vec,Vec); 116 EXTERN int VecAXPBY(const PetscScalar*,const PetscScalar *,Vec,Vec); 117 EXTERN int VecMAXPY(int,const PetscScalar*,Vec,Vec*); 118 EXTERN int VecAYPX(const PetscScalar*,Vec,Vec); 119 EXTERN int VecWAXPY(const PetscScalar*,Vec,Vec,Vec); 120 EXTERN int VecPointwiseMult(Vec,Vec,Vec); 121 EXTERN int VecPointwiseDivide(Vec,Vec,Vec); 122 EXTERN int VecShift(const PetscScalar*,Vec); 123 EXTERN int VecReciprocal(Vec); 124 EXTERN int VecAbs(Vec); 125 EXTERN int VecDuplicate(Vec,Vec*); 126 EXTERN int VecDuplicateVecs(Vec,int,Vec*[]); 127 EXTERN int VecDestroyVecs(const Vec[],int); 128 EXTERN int VecGetPetscMap(Vec,PetscMap*); 129 130 /*E 131 InsertMode - Whether entries are inserted or added into vectors or matrices 132 to continue to add values to it 133 134 Level: beginner 135 136 .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), 137 VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), 138 MatSetValuesBlockedLocal(), MatSetValuesLocal() 139 E*/ 140 typedef enum {NOT_SET_VALUES,INSERT_VALUES,ADD_VALUES,MAX_VALUES} InsertMode; 141 142 EXTERN int VecStrideNorm(Vec,int,NormType,PetscReal*); 143 EXTERN int VecStrideGather(Vec,int,Vec,InsertMode); 144 EXTERN int VecStrideScatter(Vec,int,Vec,InsertMode); 145 EXTERN int VecStrideMax(Vec,int,int *,PetscReal *); 146 EXTERN int VecStrideMin(Vec,int,int *,PetscReal *); 147 EXTERN int VecStrideGatherAll(Vec,Vec*,InsertMode); 148 EXTERN int VecStrideScatterAll(Vec*,Vec,InsertMode); 149 150 EXTERN int VecSetValues(Vec,int,const int[],const PetscScalar[],InsertMode); 151 EXTERN int VecAssemblyBegin(Vec); 152 EXTERN int VecAssemblyEnd(Vec); 153 EXTERN int VecSetStashInitialSize(Vec,int,int); 154 EXTERN int VecStashView(Vec,PetscViewer); 155 156 #define VecSetValue(v,i,va,mode) 0;\ 157 {int _ierr,_row = i; PetscScalar _va = va; \ 158 _ierr = VecSetValues(v,1,&_row,&_va,mode);CHKERRQ(_ierr); \ 159 } 160 EXTERN int VecSetBlockSize(Vec,int); 161 EXTERN int VecGetBlockSize(Vec,int*); 162 EXTERN int VecSetValuesBlocked(Vec,int,const int[],const PetscScalar[],InsertMode); 163 164 extern PetscTruth VecRegisterAllCalled; 165 EXTERN int VecRegisterAll(const char []); 166 EXTERN int VecRegister(const char[],const char[],const char[],int(*)(Vec)); 167 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 168 #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,0) 169 #else 170 #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,d) 171 #endif 172 173 174 /*E 175 ScatterMode - Determines the direction of a scatter 176 177 Level: beginner 178 179 .seealso: VecScatter, VecScatterBegin(), VecScatterEnd() 180 E*/ 181 typedef enum {SCATTER_FORWARD=0,SCATTER_REVERSE=1,SCATTER_FORWARD_LOCAL=2, 182 SCATTER_REVERSE_LOCAL=3,SCATTER_LOCAL=2} ScatterMode; 183 EXTERN int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 184 EXTERN int VecScatterPostRecvs(Vec,Vec,InsertMode,ScatterMode,VecScatter); 185 EXTERN int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter); 186 EXTERN int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter); 187 EXTERN int VecScatterDestroy(VecScatter); 188 EXTERN int VecScatterCopy(VecScatter,VecScatter *); 189 EXTERN int VecScatterView(VecScatter,PetscViewer); 190 EXTERN int VecScatterRemap(VecScatter,int *,int*); 191 192 typedef enum {PIPELINE_DOWN=0,PIPELINE_UP=1} PipelineDirection; 193 typedef enum {PIPELINE_NONE=1,PIPELINE_SEQUENTIAL=2, 194 PIPELINE_REDBLACK=3,PIPELINE_MULTICOLOR=4} PipelineType; 195 196 typedef struct _p_VecPipeline* VecPipeline; 197 198 EXTERN int VecPipelineCreate(MPI_Comm,Vec,IS,Vec,IS,VecPipeline *); 199 EXTERN int VecPipelineSetType(VecPipeline,PipelineType,PetscObject); 200 EXTERN int VecPipelineSetup(VecPipeline); 201 EXTERN int VecPipelineBegin(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline); 202 EXTERN int VecPipelineEnd(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline); 203 EXTERN int VecPipelineView(VecPipeline,PetscViewer); 204 EXTERN int VecPipelineDestroy(VecPipeline); 205 206 EXTERN int VecGetArray(Vec,PetscScalar*[]); 207 EXTERN int VecRestoreArray(Vec,PetscScalar*[]); 208 EXTERN int VecGetArray4d(Vec,int,int,int,int,int,int,int,int,PetscScalar****[]); 209 EXTERN int VecRestoreArray4d(Vec,int,int,int,int,int,int,int,int,PetscScalar****[]); 210 EXTERN int VecGetArray3d(Vec,int,int,int,int,int,int,PetscScalar***[]); 211 EXTERN int VecRestoreArray3d(Vec,int,int,int,int,int,int,PetscScalar***[]); 212 EXTERN int VecGetArray2d(Vec,int,int,int,int,PetscScalar**[]); 213 EXTERN int VecRestoreArray2d(Vec,int,int,int,int,PetscScalar**[]); 214 EXTERN int VecGetArray1d(Vec,int,int,PetscScalar *[]); 215 EXTERN int VecRestoreArray1d(Vec,int,int,PetscScalar *[]); 216 217 EXTERN int VecPlaceArray(Vec,const PetscScalar[]); 218 EXTERN int VecResetArray(Vec); 219 EXTERN int VecReplaceArray(Vec,const PetscScalar[]); 220 EXTERN int VecGetArrays(const Vec[],int,PetscScalar**[]); 221 EXTERN int VecRestoreArrays(const Vec[],int,PetscScalar**[]); 222 223 EXTERN int VecValid(Vec,PetscTruth*); 224 EXTERN int VecView(Vec,PetscViewer); 225 EXTERN int VecEqual(Vec,Vec,PetscTruth*); 226 EXTERN int VecLoad(PetscViewer,Vec*); 227 EXTERN int VecLoadIntoVector(PetscViewer,Vec); 228 229 EXTERN int VecGetSize(Vec,int*); 230 EXTERN int VecGetType(Vec,VecType*); 231 EXTERN int VecGetLocalSize(Vec,int*); 232 EXTERN int VecGetOwnershipRange(Vec,int*,int*); 233 234 EXTERN int VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping); 235 EXTERN int VecSetValuesLocal(Vec,int,const int[],const PetscScalar[],InsertMode); 236 EXTERN int VecSetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping); 237 EXTERN int VecSetValuesBlockedLocal(Vec,int,const int[],const PetscScalar[],InsertMode); 238 239 EXTERN int VecDotBegin(Vec,Vec,PetscScalar *); 240 EXTERN int VecDotEnd(Vec,Vec,PetscScalar *); 241 EXTERN int VecTDotBegin(Vec,Vec,PetscScalar *); 242 EXTERN int VecTDotEnd(Vec,Vec,PetscScalar *); 243 EXTERN int VecNormBegin(Vec,NormType,PetscReal *); 244 EXTERN int VecNormEnd(Vec,NormType,PetscReal *); 245 246 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES,VEC_TREAT_OFF_PROC_ENTRIES} VecOption; 247 EXTERN int VecSetOption(Vec,VecOption); 248 249 EXTERN int VecContourScale(Vec,PetscReal,PetscReal); 250 251 /* 252 These numbers need to match the entries in 253 the function table in src/vec/vecimpl.h 254 */ 255 typedef enum { VECOP_VIEW = 32, 256 VECOP_LOADINTOVECTOR = 38 257 } VecOperation; 258 EXTERN int VecSetOperation(Vec,VecOperation,void(*)()); 259 260 /* 261 Routines for dealing with ghosted vectors: 262 vectors with ghost elements at the end of the array. 263 */ 264 EXTERN int VecCreateGhost(MPI_Comm,int,int,int,const int[],Vec*); 265 EXTERN int VecCreateGhostWithArray(MPI_Comm,int,int,int,const int[],const PetscScalar[],Vec*); 266 EXTERN int VecCreateGhostBlock(MPI_Comm,int,int,int,int,const int[],Vec*); 267 EXTERN int VecCreateGhostBlockWithArray(MPI_Comm,int,int,int,int,const int[],const PetscScalar[],Vec*); 268 EXTERN int VecGhostGetLocalForm(Vec,Vec*); 269 EXTERN int VecGhostRestoreLocalForm(Vec,Vec*); 270 EXTERN int VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 271 EXTERN int VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 272 273 EXTERN int VecConjugate(Vec); 274 275 #endif 276 277 278 279 280 281 282 283 284 285