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