1 /* $Id: petscvec.h,v 1.124 2001/08/07 03:02:14 balay 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 typedef char* VecType; 70 71 EXTERN int VecCreateSeq(MPI_Comm,int,Vec*); 72 EXTERN int PetscMapCreateMPI(MPI_Comm,int,int,PetscMap*); 73 EXTERN int VecCreateMPI(MPI_Comm,int,int,Vec*); 74 EXTERN int VecCreateSeqWithArray(MPI_Comm,int,const PetscScalar[],Vec*); 75 EXTERN int VecCreateMPIWithArray(MPI_Comm,int,int,const PetscScalar[],Vec*); 76 EXTERN int VecCreateShared(MPI_Comm,int,int,Vec*); 77 EXTERN int VecCreate(MPI_Comm,int,int,Vec*); 78 EXTERN int VecSetType(Vec,VecType); 79 EXTERN int VecSetFromOptions(Vec); 80 81 EXTERN int VecDestroy(Vec); 82 83 EXTERN int PetscMapDestroy(PetscMap); 84 EXTERN int PetscMapGetLocalSize(PetscMap,int *); 85 EXTERN int PetscMapGetSize(PetscMap,int *); 86 EXTERN int PetscMapGetLocalRange(PetscMap,int *,int *); 87 EXTERN int PetscMapGetGlobalRange(PetscMap,int *[]); 88 89 EXTERN int VecDot(Vec,Vec,PetscScalar*); 90 EXTERN int VecTDot(Vec,Vec,PetscScalar*); 91 EXTERN int VecMDot(int,Vec,const Vec[],PetscScalar*); 92 EXTERN int VecMTDot(int,Vec,const Vec[],PetscScalar*); 93 94 /*E 95 NormType - determines what type of norm to compute 96 97 Level: beginner 98 99 .seealso: VecNorm(), VecNormBegin(), VecNormEnd(), MatNorm() 100 E*/ 101 typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4,NORM_1_AND_2=5} NormType; 102 #define NORM_MAX NORM_INFINITY 103 104 EXTERN int VecNorm(Vec,NormType,PetscReal *); 105 EXTERN int VecSum(Vec,PetscScalar*); 106 EXTERN int VecMax(Vec,int*,PetscReal *); 107 EXTERN int VecMin(Vec,int*,PetscReal *); 108 EXTERN int VecScale(const PetscScalar *a,Vec v); 109 EXTERN int VecCopy(Vec,Vec); 110 EXTERN int VecSetRandom(PetscRandom,Vec); 111 EXTERN int VecSet(const PetscScalar*,Vec); 112 EXTERN int VecSwap(Vec,Vec); 113 EXTERN int VecAXPY(const PetscScalar*,Vec,Vec); 114 EXTERN int VecAXPBY(const PetscScalar*,const PetscScalar *,Vec,Vec); 115 EXTERN int VecMAXPY(int,const PetscScalar*,Vec,Vec*); 116 EXTERN int VecAYPX(const PetscScalar*,Vec,Vec); 117 EXTERN int VecWAXPY(const PetscScalar*,Vec,Vec,Vec); 118 EXTERN int VecPointwiseMult(Vec,Vec,Vec); 119 EXTERN int VecPointwiseDivide(Vec,Vec,Vec); 120 EXTERN int VecShift(const PetscScalar*,Vec); 121 EXTERN int VecReciprocal(Vec); 122 EXTERN int VecAbs(Vec); 123 EXTERN int VecDuplicate(Vec,Vec*); 124 EXTERN int VecDuplicateVecs(Vec,int,Vec*[]); 125 EXTERN int VecDestroyVecs(const Vec[],int); 126 EXTERN int VecGetPetscMap(Vec,PetscMap*); 127 128 /*E 129 InsertMode - Whether entries are inserted or added into vectors or matrices 130 to continue to add values to it 131 132 Level: beginner 133 134 .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), 135 VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), 136 MatSetValuesBlockedLocal(), MatSetValuesLocal() 137 E*/ 138 typedef enum {NOT_SET_VALUES,INSERT_VALUES,ADD_VALUES,MAX_VALUES} InsertMode; 139 140 EXTERN int VecStrideNorm(Vec,int,NormType,PetscReal*); 141 EXTERN int VecStrideGather(Vec,int,Vec,InsertMode); 142 EXTERN int VecStrideScatter(Vec,int,Vec,InsertMode); 143 EXTERN int VecStrideMax(Vec,int,int *,PetscReal *); 144 EXTERN int VecStrideMin(Vec,int,int *,PetscReal *); 145 EXTERN int VecStrideGatherAll(Vec,Vec*,InsertMode); 146 EXTERN int VecStrideScatterAll(Vec*,Vec,InsertMode); 147 148 EXTERN int VecSetValues(Vec,int,const int[],const PetscScalar[],InsertMode); 149 EXTERN int VecAssemblyBegin(Vec); 150 EXTERN int VecAssemblyEnd(Vec); 151 EXTERN int VecSetStashInitialSize(Vec,int,int); 152 EXTERN int VecStashView(Vec,PetscViewer); 153 154 #define VecSetValue(v,i,va,mode) 0;\ 155 {int _ierr,_row = i; PetscScalar _va = va; \ 156 _ierr = VecSetValues(v,1,&_row,&_va,mode);CHKERRQ(_ierr); \ 157 } 158 EXTERN int VecSetBlockSize(Vec,int); 159 EXTERN int VecGetBlockSize(Vec,int*); 160 EXTERN int VecSetValuesBlocked(Vec,int,const int[],const PetscScalar[],InsertMode); 161 162 extern PetscTruth VecRegisterAllCalled; 163 EXTERN int VecRegisterAll(const char []); 164 EXTERN int VecRegister(const char[],const char[],const char[],int(*)(Vec)); 165 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 166 #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,0) 167 #else 168 #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,d) 169 #endif 170 171 172 /*E 173 ScatterMode - Determines the direction of a scatter 174 175 Level: beginner 176 177 .seealso: VecScatter, VecScatterBegin(), VecScatterEnd() 178 E*/ 179 typedef enum {SCATTER_FORWARD=0,SCATTER_REVERSE=1,SCATTER_FORWARD_LOCAL=2, 180 SCATTER_REVERSE_LOCAL=3,SCATTER_LOCAL=2} ScatterMode; 181 EXTERN int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 182 EXTERN int VecScatterPostRecvs(Vec,Vec,InsertMode,ScatterMode,VecScatter); 183 EXTERN int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter); 184 EXTERN int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter); 185 EXTERN int VecScatterDestroy(VecScatter); 186 EXTERN int VecScatterCopy(VecScatter,VecScatter *); 187 EXTERN int VecScatterView(VecScatter,PetscViewer); 188 EXTERN int VecScatterRemap(VecScatter,int *,int*); 189 190 typedef enum {PIPELINE_DOWN=0,PIPELINE_UP=1} PipelineDirection; 191 typedef enum {PIPELINE_NONE=1,PIPELINE_SEQUENTIAL=2, 192 PIPELINE_REDBLACK=3,PIPELINE_MULTICOLOR=4} PipelineType; 193 194 typedef struct _p_VecPipeline* VecPipeline; 195 196 EXTERN int VecPipelineCreate(MPI_Comm,Vec,IS,Vec,IS,VecPipeline *); 197 EXTERN int VecPipelineSetType(VecPipeline,PipelineType,PetscObject); 198 EXTERN int VecPipelineSetup(VecPipeline); 199 EXTERN int VecPipelineBegin(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline); 200 EXTERN int VecPipelineEnd(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline); 201 EXTERN int VecPipelineView(VecPipeline,PetscViewer); 202 EXTERN int VecPipelineDestroy(VecPipeline); 203 204 EXTERN int VecGetArray(Vec,PetscScalar*[]); 205 EXTERN int VecRestoreArray(Vec,PetscScalar*[]); 206 EXTERN int VecGetArray4d(Vec,int,int,int,int,int,int,int,int,PetscScalar****[]); 207 EXTERN int VecRestoreArray4d(Vec,int,int,int,int,int,int,int,int,PetscScalar****[]); 208 EXTERN int VecGetArray3d(Vec,int,int,int,int,int,int,PetscScalar***[]); 209 EXTERN int VecRestoreArray3d(Vec,int,int,int,int,int,int,PetscScalar***[]); 210 EXTERN int VecGetArray2d(Vec,int,int,int,int,PetscScalar**[]); 211 EXTERN int VecRestoreArray2d(Vec,int,int,int,int,PetscScalar**[]); 212 EXTERN int VecGetArray1d(Vec,int,int,PetscScalar *[]); 213 EXTERN int VecRestoreArray1d(Vec,int,int,PetscScalar *[]); 214 215 EXTERN int VecPlaceArray(Vec,const PetscScalar[]); 216 EXTERN int VecResetArray(Vec); 217 EXTERN int VecReplaceArray(Vec,const PetscScalar[]); 218 EXTERN int VecGetArrays(const Vec[],int,PetscScalar**[]); 219 EXTERN int VecRestoreArrays(const Vec[],int,PetscScalar**[]); 220 221 EXTERN int VecValid(Vec,PetscTruth*); 222 EXTERN int VecView(Vec,PetscViewer); 223 EXTERN int VecEqual(Vec,Vec,PetscTruth*); 224 EXTERN int VecLoad(PetscViewer,Vec*); 225 EXTERN int VecLoadIntoVector(PetscViewer,Vec); 226 227 EXTERN int VecGetSize(Vec,int*); 228 EXTERN int VecGetType(Vec,VecType*); 229 EXTERN int VecGetLocalSize(Vec,int*); 230 EXTERN int VecGetOwnershipRange(Vec,int*,int*); 231 232 EXTERN int VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping); 233 EXTERN int VecSetValuesLocal(Vec,int,const int[],const PetscScalar[],InsertMode); 234 EXTERN int VecSetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping); 235 EXTERN int VecSetValuesBlockedLocal(Vec,int,const int[],const PetscScalar[],InsertMode); 236 237 EXTERN int VecDotBegin(Vec,Vec,PetscScalar *); 238 EXTERN int VecDotEnd(Vec,Vec,PetscScalar *); 239 EXTERN int VecTDotBegin(Vec,Vec,PetscScalar *); 240 EXTERN int VecTDotEnd(Vec,Vec,PetscScalar *); 241 EXTERN int VecNormBegin(Vec,NormType,PetscReal *); 242 EXTERN int VecNormEnd(Vec,NormType,PetscReal *); 243 244 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES,VEC_TREAT_OFF_PROC_ENTRIES} VecOption; 245 EXTERN int VecSetOption(Vec,VecOption); 246 247 EXTERN int VecContourScale(Vec,PetscReal,PetscReal); 248 249 /* 250 These numbers need to match the entries in 251 the function table in src/vec/vecimpl.h 252 */ 253 typedef enum { VECOP_VIEW = 33, 254 VECOP_LOADINTOVECTOR = 40 255 } VecOperation; 256 EXTERN int VecSetOperation(Vec,VecOperation,void(*)()); 257 258 /* 259 Routines for dealing with ghosted vectors: 260 vectors with ghost elements at the end of the array. 261 */ 262 EXTERN int VecCreateGhost(MPI_Comm,int,int,int,const int[],Vec*); 263 EXTERN int VecCreateGhostWithArray(MPI_Comm,int,int,int,const int[],const PetscScalar[],Vec*); 264 EXTERN int VecCreateGhostBlock(MPI_Comm,int,int,int,int,const int[],Vec*); 265 EXTERN int VecCreateGhostBlockWithArray(MPI_Comm,int,int,int,int,const int[],const PetscScalar[],Vec*); 266 EXTERN int VecGhostGetLocalForm(Vec,Vec*); 267 EXTERN int VecGhostRestoreLocalForm(Vec,Vec*); 268 EXTERN int VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 269 EXTERN int VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 270 271 EXTERN int VecConjugate(Vec); 272 273 #endif 274 275 276 277 278 279 280 281 282 283