1 /* $Id: petscvec.h,v 1.127 2001/09/11 16:31:30 bsmith Exp $ */ 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 /*S 14 PetscMap - Abstract PETSc object that defines the layout of vector and 15 matrices across processors 16 17 Level: advanced 18 19 Notes: 20 Does not play a role in the PETSc design, can be ignored 21 22 Concepts: parallel decomposition 23 24 .seealso: PetscMapCreateMPI() 25 S*/ 26 typedef struct _p_PetscMap* PetscMap; 27 28 #define MAP_SEQ "seq" 29 #define MAP_MPI "mpi" 30 typedef char *PetscMapType; 31 32 #define MAP_SER_MPI_BINARY "mpi_binary" 33 typedef char *PetscMapSerializeType; 34 35 /* Logging support */ 36 extern int MAP_COOKIE; 37 38 EXTERN int PetscMapCreate(MPI_Comm,PetscMap*); 39 EXTERN int PetscMapCreateMPI(MPI_Comm,int,int,PetscMap*); 40 EXTERN int PetscMapSerialize(MPI_Comm,PetscMap *,PetscViewer,PetscTruth); 41 EXTERN int PetscMapSetType(PetscMap,PetscMapType); 42 EXTERN int PetscMapGetType(PetscMap,PetscMapType *); 43 EXTERN int PetscMapSetSerializeType(PetscMap,PetscMapSerializeType); 44 EXTERN int PetscMapGetSerializeType(PetscMap,PetscMapSerializeType *); 45 EXTERN int PetscMapSetFromOptions(PetscMap); 46 EXTERN int PetscMapPrintHelp(PetscMap); 47 EXTERN int PetscMapDestroy(PetscMap); 48 49 EXTERN int PetscMapSetLocalSize(PetscMap,int); 50 EXTERN int PetscMapGetLocalSize(PetscMap,int *); 51 EXTERN int PetscMapSetSize(PetscMap,int); 52 EXTERN int PetscMapGetSize(PetscMap,int *); 53 EXTERN int PetscMapGetLocalRange(PetscMap,int *,int *); 54 EXTERN int PetscMapGetGlobalRange(PetscMap,int *[]); 55 56 /* Dynamic creation and loading functions */ 57 extern PetscFList PetscMapList; 58 extern PetscTruth PetscMapRegisterAllCalled; 59 EXTERN int PetscMapSetType(PetscMap, PetscMapType); 60 EXTERN int PetscMapGetType(PetscMap, PetscMapType *); 61 EXTERN int PetscMapRegister(const char[],const char[],const char[],int(*)(PetscMap)); 62 EXTERN int PetscMapRegisterAll(const char []); 63 EXTERN int PetscMapRegisterDestroy(void); 64 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 65 #define PetscMapRegisterDynamic(a,b,c,d) PetscMapRegister(a,b,c,0) 66 #else 67 #define PetscMapRegisterDynamic(a,b,c,d) PetscMapRegister(a,b,c,d) 68 #endif 69 70 extern PetscFList PetscMapSerializeList; 71 extern PetscTruth PetscMapSerializeRegisterAllCalled; 72 EXTERN int PetscMapSetSerializeType(PetscMap, PetscMapSerializeType); 73 EXTERN int PetscMapGetSerializeType(PetscMap, PetscMapSerializeType *); 74 EXTERN int PetscMapSerializeRegister(const char [], const char [], const char [], int (*)(MPI_Comm, PetscMap *, PetscViewer, PetscTruth)); 75 EXTERN int PetscMapSerializeRegisterAll(const char []); 76 EXTERN int PetscMapSerializeRegisterDestroy(void); 77 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 78 #define PetscMapSerializeRegisterDynamic(a,b,c,d) PetscMapSerializeRegister(a,b,c,0) 79 #else 80 #define PetscMapSerializeRegisterDynamic(a,b,c,d) PetscMapSerializeRegister(a,b,c,d) 81 #endif 82 83 /*S 84 Vec - Abstract PETSc vector object 85 86 Level: beginner 87 88 Concepts: field variables, unknowns, arrays 89 90 .seealso: VecCreate(), VecType, VecSetType() 91 S*/ 92 typedef struct _p_Vec* Vec; 93 94 /*S 95 VecScatter - Object used to manage communication of data 96 between vectors in parallel. Manages both scatters and gathers 97 98 Level: beginner 99 100 Concepts: scatter 101 102 .seealso: VecScatterCreate(), VecScatterBegin(), VecScatterEnd() 103 S*/ 104 typedef struct _p_VecScatter* VecScatter; 105 106 /*E 107 VecType - String with the name of a PETSc vector or the creation function 108 with an optional dynamic library name, for example 109 http://www.mcs.anl.gov/petsc/lib.a:myveccreate() 110 111 Level: beginner 112 113 .seealso: VecSetType(), Vec 114 E*/ 115 #define VECSEQ "seq" 116 #define VECMPI "mpi" 117 #define VECFETI "feti" 118 #define VECSHARED "shared" 119 #define VECESI "esi" 120 #define VECPETSCESI "petscesi" 121 typedef char* VecType; 122 123 #define VEC_SER_SEQ_BINARY "seq_binary" 124 #define VEC_SER_MPI_BINARY "mpi_binary" 125 typedef char *VecSerializeType; 126 127 /* Logging support */ 128 extern int VEC_COOKIE; 129 extern int VEC_SCATTER_COOKIE; 130 extern int VEC_View, VEC_Max, VEC_Min, VEC_DotBarrier, VEC_Dot, VEC_MDotBarrier, VEC_MDot, VEC_TDot, VEC_MTDot, VEC_NormBarrier; 131 extern int VEC_Norm, VEC_Scale, VEC_Copy, VEC_Set, VEC_AXPY, VEC_AYPX, VEC_WAXPY, VEC_MAXPY, VEC_Swap, VEC_AssemblyBegin; 132 extern int VEC_AssemblyEnd, VEC_PointwiseMult, VEC_SetValues, VEC_Load, VEC_ScatterBarrier, VEC_ScatterBegin, VEC_ScatterEnd; 133 extern int VEC_SetRandom, VEC_ReduceArithmetic, VEC_ReduceBarrier, VEC_ReduceCommunication; 134 135 EXTERN int VecInitializePackage(char *); 136 137 EXTERN int VecCreate(MPI_Comm,Vec *); 138 EXTERN int VecCreateSeq(MPI_Comm,int,Vec*); 139 EXTERN int VecCreateMPI(MPI_Comm,int,int,Vec*); 140 EXTERN int VecCreateSeqWithArray(MPI_Comm,int,const PetscScalar[],Vec*); 141 EXTERN int VecCreateMPIWithArray(MPI_Comm,int,int,const PetscScalar[],Vec*); 142 EXTERN int VecCreateShared(MPI_Comm,int,int,Vec*); 143 EXTERN int VecSerialize(MPI_Comm,Vec *,PetscViewer,PetscTruth); 144 EXTERN int VecSetType(Vec,VecType); 145 EXTERN int VecGetType(Vec,VecType *); 146 EXTERN int VecSetSerializeType(Vec,VecSerializeType); 147 EXTERN int VecGetSerializeType(Vec,VecSerializeType *); 148 EXTERN int VecSetFromOptions(Vec); 149 EXTERN int VecPrintHelp(Vec); 150 EXTERN int VecDestroy(Vec); 151 152 EXTERN int VecSetSizes(Vec,int,int); 153 154 EXTERN int VecDot(Vec,Vec,PetscScalar*); 155 EXTERN int VecTDot(Vec,Vec,PetscScalar*); 156 EXTERN int VecMDot(int,Vec,const Vec[],PetscScalar*); 157 EXTERN int VecMTDot(int,Vec,const Vec[],PetscScalar*); 158 159 /*E 160 NormType - determines what type of norm to compute 161 162 Level: beginner 163 164 .seealso: VecNorm(), VecNormBegin(), VecNormEnd(), MatNorm() 165 E*/ 166 typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4,NORM_1_AND_2=5} NormType; 167 #define NORM_MAX NORM_INFINITY 168 169 EXTERN int VecNorm(Vec,NormType,PetscReal *); 170 EXTERN int VecSum(Vec,PetscScalar*); 171 EXTERN int VecMax(Vec,int*,PetscReal *); 172 EXTERN int VecMin(Vec,int*,PetscReal *); 173 EXTERN int VecScale(const PetscScalar *a,Vec v); 174 EXTERN int VecCopy(Vec,Vec); 175 EXTERN int VecSetRandom(PetscRandom,Vec); 176 EXTERN int VecSet(const PetscScalar*,Vec); 177 EXTERN int VecSwap(Vec,Vec); 178 EXTERN int VecAXPY(const PetscScalar*,Vec,Vec); 179 EXTERN int VecAXPBY(const PetscScalar*,const PetscScalar *,Vec,Vec); 180 EXTERN int VecMAXPY(int,const PetscScalar*,Vec,Vec*); 181 EXTERN int VecAYPX(const PetscScalar*,Vec,Vec); 182 EXTERN int VecWAXPY(const PetscScalar*,Vec,Vec,Vec); 183 EXTERN int VecPointwiseMult(Vec,Vec,Vec); 184 EXTERN int VecPointwiseDivide(Vec,Vec,Vec); 185 EXTERN int VecShift(const PetscScalar*,Vec); 186 EXTERN int VecReciprocal(Vec); 187 EXTERN int VecPermute(Vec, IS, PetscTruth); 188 EXTERN int VecSqrt(Vec); 189 EXTERN int VecAbs(Vec); 190 EXTERN int VecDuplicate(Vec,Vec*); 191 EXTERN int VecDuplicateVecs(Vec,int,Vec*[]); 192 EXTERN int VecDestroyVecs(const Vec[],int); 193 EXTERN int VecGetPetscMap(Vec,PetscMap*); 194 195 EXTERN int VecStrideNorm(Vec,int,NormType,PetscReal*); 196 EXTERN int VecStrideGather(Vec,int,Vec,InsertMode); 197 EXTERN int VecStrideScatter(Vec,int,Vec,InsertMode); 198 EXTERN int VecStrideMax(Vec,int,int *,PetscReal *); 199 EXTERN int VecStrideMin(Vec,int,int *,PetscReal *); 200 EXTERN int VecStrideGatherAll(Vec,Vec*,InsertMode); 201 EXTERN int VecStrideScatterAll(Vec*,Vec,InsertMode); 202 203 EXTERN int VecSetValues(Vec,int,const int[],const PetscScalar[],InsertMode); 204 EXTERN int VecAssemblyBegin(Vec); 205 EXTERN int VecAssemblyEnd(Vec); 206 EXTERN int VecSetStashInitialSize(Vec,int,int); 207 EXTERN int VecStashView(Vec,PetscViewer); 208 209 #define VecSetValue(v,i,va,mode) 0;\ 210 {int _ierr,_row = i; PetscScalar _va = va; \ 211 _ierr = VecSetValues(v,1,&_row,&_va,mode);CHKERRQ(_ierr); \ 212 } 213 EXTERN int VecSetBlockSize(Vec,int); 214 EXTERN int VecGetBlockSize(Vec,int*); 215 EXTERN int VecSetValuesBlocked(Vec,int,const int[],const PetscScalar[],InsertMode); 216 217 /* Dynamic creation and loading functions */ 218 extern PetscFList VecList; 219 extern PetscTruth VecRegisterAllCalled; 220 EXTERN int VecSetType(Vec, VecType); 221 EXTERN int VecGetType(Vec, VecType *); 222 EXTERN int VecRegister(const char[],const char[],const char[],int(*)(Vec)); 223 EXTERN int VecRegisterAll(const char []); 224 EXTERN int VecRegisterDestroy(void); 225 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 226 #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,0) 227 #else 228 #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,d) 229 #endif 230 231 extern PetscFList VecSerializeList; 232 extern PetscTruth VecSerializeRegisterAllCalled; 233 EXTERN int VecSetSerializeType(Vec, VecSerializeType); 234 EXTERN int VecGetSerializeType(Vec, VecSerializeType *); 235 EXTERN int VecSerializeRegister(const char [], const char [], const char [], int (*)(MPI_Comm, Vec *, PetscViewer, PetscTruth)); 236 EXTERN int VecSerializeRegisterAll(const char []); 237 EXTERN int VecSerializeRegisterDestroy(void); 238 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 239 #define VecSerializeRegisterDynamic(a,b,c,d) VecSerializeRegister(a,b,c,0) 240 #else 241 #define VecSerializeRegisterDynamic(a,b,c,d) VecSerializeRegister(a,b,c,d) 242 #endif 243 244 EXTERN int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 245 EXTERN int VecScatterPostRecvs(Vec,Vec,InsertMode,ScatterMode,VecScatter); 246 EXTERN int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter); 247 EXTERN int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter); 248 EXTERN int VecScatterDestroy(VecScatter); 249 EXTERN int VecScatterCopy(VecScatter,VecScatter *); 250 EXTERN int VecScatterView(VecScatter,PetscViewer); 251 EXTERN int VecScatterRemap(VecScatter,int *,int*); 252 253 typedef enum {PIPELINE_DOWN=0,PIPELINE_UP=1} PipelineDirection; 254 typedef enum {PIPELINE_NONE=1,PIPELINE_SEQUENTIAL=2, 255 PIPELINE_REDBLACK=3,PIPELINE_MULTICOLOR=4} PipelineType; 256 257 typedef struct _p_VecPipeline* VecPipeline; 258 259 EXTERN int VecPipelineCreate(MPI_Comm,Vec,IS,Vec,IS,VecPipeline *); 260 EXTERN int VecPipelineSetType(VecPipeline,PipelineType,PetscObject); 261 EXTERN int VecPipelineSetup(VecPipeline); 262 EXTERN int VecPipelineBegin(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline); 263 EXTERN int VecPipelineEnd(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline); 264 EXTERN int VecPipelineView(VecPipeline,PetscViewer); 265 EXTERN int VecPipelineDestroy(VecPipeline); 266 267 EXTERN int VecGetArray(Vec,PetscScalar*[]); 268 EXTERN int VecRestoreArray(Vec,PetscScalar*[]); 269 EXTERN int VecGetArray4d(Vec,int,int,int,int,int,int,int,int,PetscScalar****[]); 270 EXTERN int VecRestoreArray4d(Vec,int,int,int,int,int,int,int,int,PetscScalar****[]); 271 EXTERN int VecGetArray3d(Vec,int,int,int,int,int,int,PetscScalar***[]); 272 EXTERN int VecRestoreArray3d(Vec,int,int,int,int,int,int,PetscScalar***[]); 273 EXTERN int VecGetArray2d(Vec,int,int,int,int,PetscScalar**[]); 274 EXTERN int VecRestoreArray2d(Vec,int,int,int,int,PetscScalar**[]); 275 EXTERN int VecGetArray1d(Vec,int,int,PetscScalar *[]); 276 EXTERN int VecRestoreArray1d(Vec,int,int,PetscScalar *[]); 277 278 EXTERN int VecPlaceArray(Vec,const PetscScalar[]); 279 EXTERN int VecResetArray(Vec); 280 EXTERN int VecReplaceArray(Vec,const PetscScalar[]); 281 EXTERN int VecGetArrays(const Vec[],int,PetscScalar**[]); 282 EXTERN int VecRestoreArrays(const Vec[],int,PetscScalar**[]); 283 284 EXTERN int VecValid(Vec,PetscTruth*); 285 EXTERN int VecView(Vec,PetscViewer); 286 EXTERN int VecEqual(Vec,Vec,PetscTruth*); 287 EXTERN int VecLoad(PetscViewer,Vec*); 288 EXTERN int VecLoadIntoVector(PetscViewer,Vec); 289 290 EXTERN int VecGetSize(Vec,int*); 291 EXTERN int VecGetLocalSize(Vec,int*); 292 EXTERN int VecGetType(Vec,VecType*); 293 EXTERN int VecGetOwnershipRange(Vec,int*,int*); 294 295 EXTERN int VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping); 296 EXTERN int VecSetValuesLocal(Vec,int,const int[],const PetscScalar[],InsertMode); 297 EXTERN int VecSetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping); 298 EXTERN int VecSetValuesBlockedLocal(Vec,int,const int[],const PetscScalar[],InsertMode); 299 300 EXTERN int VecDotBegin(Vec,Vec,PetscScalar *); 301 EXTERN int VecDotEnd(Vec,Vec,PetscScalar *); 302 EXTERN int VecTDotBegin(Vec,Vec,PetscScalar *); 303 EXTERN int VecTDotEnd(Vec,Vec,PetscScalar *); 304 EXTERN int VecNormBegin(Vec,NormType,PetscReal *); 305 EXTERN int VecNormEnd(Vec,NormType,PetscReal *); 306 307 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES,VEC_TREAT_OFF_PROC_ENTRIES} VecOption; 308 EXTERN int VecSetOption(Vec,VecOption); 309 310 EXTERN int VecContourScale(Vec,PetscReal,PetscReal); 311 312 /* 313 These numbers need to match the entries in 314 the function table in src/vec/vecimpl.h 315 */ 316 typedef enum { VECOP_VIEW = 32, 317 VECOP_LOADINTOVECTOR = 38 318 } VecOperation; 319 EXTERN int VecSetOperation(Vec,VecOperation,void(*)(void)); 320 321 /* 322 Routines for dealing with ghosted vectors: 323 vectors with ghost elements at the end of the array. 324 */ 325 EXTERN int VecCreateGhost(MPI_Comm,int,int,int,const int[],Vec*); 326 EXTERN int VecCreateGhostWithArray(MPI_Comm,int,int,int,const int[],const PetscScalar[],Vec*); 327 EXTERN int VecCreateGhostBlock(MPI_Comm,int,int,int,int,const int[],Vec*); 328 EXTERN int VecCreateGhostBlockWithArray(MPI_Comm,int,int,int,int,const int[],const PetscScalar[],Vec*); 329 EXTERN int VecGhostGetLocalForm(Vec,Vec*); 330 EXTERN int VecGhostRestoreLocalForm(Vec,Vec*); 331 EXTERN int VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 332 EXTERN int VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 333 334 EXTERN int VecConjugate(Vec); 335 336 EXTERN int VecConvertMPIToSeqAll(Vec vin,Vec *vout); 337 EXTERN int VecConvertMPIToMPIZero(Vec vin,Vec *vout); 338 339 340 EXTERN int VecESISetType(Vec,char*); 341 EXTERN int VecESISetFromOptions(Vec); 342 343 #endif 344 345 346 347 348 349 350 351 352 353