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