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