1 /* 2 Defines the vector component of PETSc. Vectors generally represent 3 degrees of freedom for finite element/finite difference functions 4 on a grid. They have more mathematical structure then simple arrays. 5 */ 6 7 #ifndef __PETSCVEC_H 8 #define __PETSCVEC_H 9 #include <petscis.h> 10 #include <petscviewer.h> 11 12 /*S 13 Vec - Abstract PETSc vector object 14 15 Level: beginner 16 17 Concepts: field variables, unknowns, arrays 18 19 .seealso: VecCreate(), VecType, VecSetType() 20 S*/ 21 typedef struct _p_Vec* Vec; 22 23 /*S 24 VecScatter - Object used to manage communication of data 25 between vectors in parallel. Manages both scatters and gathers 26 27 Level: beginner 28 29 Concepts: scatter 30 31 .seealso: VecScatterCreate(), VecScatterBegin(), VecScatterEnd() 32 S*/ 33 typedef struct _p_VecScatter* VecScatter; 34 35 /*E 36 ScatterMode - Determines the direction of a scatter 37 38 Level: beginner 39 40 .seealso: VecScatter, VecScatterBegin(), VecScatterEnd() 41 E*/ 42 typedef enum {SCATTER_FORWARD=0, SCATTER_REVERSE=1, SCATTER_FORWARD_LOCAL=2, SCATTER_REVERSE_LOCAL=3, SCATTER_LOCAL=2} ScatterMode; 43 44 /*MC 45 SCATTER_FORWARD - Scatters the values as dictated by the VecScatterCreate() call 46 47 Level: beginner 48 49 .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_REVERSE, SCATTER_FORWARD_LOCAL, 50 SCATTER_REVERSE_LOCAL 51 52 M*/ 53 54 /*MC 55 SCATTER_REVERSE - Moves the values in the opposite direction then the directions indicated in 56 in the VecScatterCreate() 57 58 Level: beginner 59 60 .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_FORWARD, SCATTER_FORWARD_LOCAL, 61 SCATTER_REVERSE_LOCAL 62 63 M*/ 64 65 /*MC 66 SCATTER_FORWARD_LOCAL - Scatters the values as dictated by the VecScatterCreate() call except NO parallel communication 67 is done. Any variables that have be moved between processes are ignored 68 69 Level: developer 70 71 .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_REVERSE, SCATTER_FORWARD, 72 SCATTER_REVERSE_LOCAL 73 74 M*/ 75 76 /*MC 77 SCATTER_REVERSE_LOCAL - Moves the values in the opposite direction then the directions indicated in 78 in the VecScatterCreate() except NO parallel communication 79 is done. Any variables that have be moved between processes are ignored 80 81 Level: developer 82 83 .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_FORWARD, SCATTER_FORWARD_LOCAL, 84 SCATTER_REVERSE 85 86 M*/ 87 88 /*J 89 VecType - String with the name of a PETSc vector or the creation function 90 with an optional dynamic library name, for example 91 http://www.mcs.anl.gov/petsc/lib.a:myveccreate() 92 93 Level: beginner 94 95 .seealso: VecSetType(), Vec 96 J*/ 97 typedef const char* VecType; 98 #define VECSEQ "seq" 99 #define VECMPI "mpi" 100 #define VECSTANDARD "standard" /* seq on one process and mpi on several */ 101 #define VECSHARED "shared" 102 #define VECSIEVE "sieve" 103 #define VECSEQCUSP "seqcusp" 104 #define VECMPICUSP "mpicusp" 105 #define VECCUSP "cusp" /* seqcusp on one process and mpicusp on several */ 106 #define VECNEST "nest" 107 #define VECSEQPTHREAD "seqpthread" 108 #define VECMPIPTHREAD "mpipthread" 109 #define VECPTHREAD "pthread" /* seqpthread on one process and mpipthread on several */ 110 111 112 /* Logging support */ 113 #define VEC_FILE_CLASSID 1211214 114 PETSC_EXTERN PetscClassId VEC_CLASSID; 115 PETSC_EXTERN PetscClassId VEC_SCATTER_CLASSID; 116 117 118 PETSC_EXTERN PetscErrorCode VecInitializePackage(void); 119 PETSC_EXTERN PetscErrorCode VecFinalizePackage(void); 120 121 PETSC_EXTERN PetscErrorCode VecCreate(MPI_Comm,Vec*); 122 PETSC_EXTERN PetscErrorCode VecCreateSeq(MPI_Comm,PetscInt,Vec*); 123 PETSC_EXTERN PetscErrorCode VecCreateMPI(MPI_Comm,PetscInt,PetscInt,Vec*); 124 PETSC_EXTERN PetscErrorCode VecCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,const PetscScalar[],Vec*); 125 PETSC_EXTERN PetscErrorCode VecCreateMPIWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar[],Vec*); 126 PETSC_EXTERN PetscErrorCode VecCreateShared(MPI_Comm,PetscInt,PetscInt,Vec*); 127 PETSC_EXTERN PetscErrorCode VecSetFromOptions(Vec); 128 PETSC_EXTERN PetscErrorCode VecViewFromOptions(Vec,const char[]); 129 130 PETSC_EXTERN PetscErrorCode VecSetUp(Vec); 131 PETSC_EXTERN PetscErrorCode VecDestroy(Vec*); 132 PETSC_EXTERN PetscErrorCode VecZeroEntries(Vec); 133 PETSC_EXTERN PetscErrorCode VecSetOptionsPrefix(Vec,const char[]); 134 PETSC_EXTERN PetscErrorCode VecAppendOptionsPrefix(Vec,const char[]); 135 PETSC_EXTERN PetscErrorCode VecGetOptionsPrefix(Vec,const char*[]); 136 137 PETSC_EXTERN PetscErrorCode VecSetSizes(Vec,PetscInt,PetscInt); 138 139 PETSC_EXTERN PetscErrorCode VecDotNorm2(Vec,Vec,PetscScalar*,PetscReal*); 140 PETSC_EXTERN PetscErrorCode VecDot(Vec,Vec,PetscScalar*); 141 PETSC_EXTERN PetscErrorCode VecDotRealPart(Vec,Vec,PetscReal*); 142 PETSC_EXTERN PetscErrorCode VecTDot(Vec,Vec,PetscScalar*); 143 PETSC_EXTERN PetscErrorCode VecMDot(Vec,PetscInt,const Vec[],PetscScalar[]); 144 PETSC_EXTERN PetscErrorCode VecMTDot(Vec,PetscInt,const Vec[],PetscScalar[]); 145 PETSC_EXTERN PetscErrorCode VecGetSubVector(Vec,IS,Vec*); 146 PETSC_EXTERN PetscErrorCode VecRestoreSubVector(Vec,IS,Vec*); 147 148 /*E 149 NormType - determines what type of norm to compute 150 151 Level: beginner 152 153 .seealso: VecNorm(), VecNormBegin(), VecNormEnd(), MatNorm() 154 E*/ 155 typedef enum {NORM_1=0,NORM_2=1,NORM_FROBENIUS=2,NORM_INFINITY=3,NORM_1_AND_2=4} NormType; 156 PETSC_EXTERN const char *const NormTypes[]; 157 #define NORM_MAX NORM_INFINITY 158 159 /*MC 160 NORM_1 - the one norm, ||v|| = sum_i | v_i |. ||A|| = max_j || v_*j ||, maximum column sum 161 162 Level: beginner 163 164 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_2, NORM_FROBENIUS, 165 NORM_INFINITY, NORM_1_AND_2 166 167 M*/ 168 169 /*MC 170 NORM_2 - the two norm, ||v|| = sqrt(sum_i (v_i)^2) (vectors only) 171 172 Level: beginner 173 174 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_FROBENIUS, 175 NORM_INFINITY, NORM_1_AND_2 176 177 M*/ 178 179 /*MC 180 NORM_FROBENIUS - ||A|| = sqrt(sum_ij (A_ij)^2), same as NORM_2 for vectors 181 182 Level: beginner 183 184 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2, 185 NORM_INFINITY, NORM_1_AND_2 186 187 M*/ 188 189 /*MC 190 NORM_INFINITY - ||v|| = max_i |v_i|. ||A|| = max_i || v_i* ||, maximum row sum 191 192 Level: beginner 193 194 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2, 195 NORM_FROBINIUS, NORM_1_AND_2 196 197 M*/ 198 199 /*MC 200 NORM_1_AND_2 - computes both the 1 and 2 norm of a vector 201 202 Level: beginner 203 204 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2, 205 NORM_FROBINIUS, NORM_INFINITY 206 207 M*/ 208 209 /*MC 210 NORM_MAX - see NORM_INFINITY 211 212 Level: beginner 213 214 M*/ 215 216 PETSC_EXTERN PetscErrorCode VecNorm(Vec,NormType,PetscReal *); 217 PETSC_EXTERN PetscErrorCode VecNormAvailable(Vec,NormType,PetscBool *,PetscReal *); 218 PETSC_EXTERN PetscErrorCode VecNormalize(Vec,PetscReal *); 219 PETSC_EXTERN PetscErrorCode VecSum(Vec,PetscScalar*); 220 PETSC_EXTERN PetscErrorCode VecMax(Vec,PetscInt*,PetscReal *); 221 PETSC_EXTERN PetscErrorCode VecMin(Vec,PetscInt*,PetscReal *); 222 PETSC_EXTERN PetscErrorCode VecScale(Vec,PetscScalar); 223 PETSC_EXTERN PetscErrorCode VecCopy(Vec,Vec); 224 PETSC_EXTERN PetscErrorCode VecSetRandom(Vec,PetscRandom); 225 PETSC_EXTERN PetscErrorCode VecSet(Vec,PetscScalar); 226 PETSC_EXTERN PetscErrorCode VecSwap(Vec,Vec); 227 PETSC_EXTERN PetscErrorCode VecAXPY(Vec,PetscScalar,Vec); 228 PETSC_EXTERN PetscErrorCode VecAXPBY(Vec,PetscScalar,PetscScalar,Vec); 229 PETSC_EXTERN PetscErrorCode VecMAXPY(Vec,PetscInt,const PetscScalar[],Vec[]); 230 PETSC_EXTERN PetscErrorCode VecAYPX(Vec,PetscScalar,Vec); 231 PETSC_EXTERN PetscErrorCode VecWAXPY(Vec,PetscScalar,Vec,Vec); 232 PETSC_EXTERN PetscErrorCode VecAXPBYPCZ(Vec,PetscScalar,PetscScalar,PetscScalar,Vec,Vec); 233 PETSC_EXTERN PetscErrorCode VecPointwiseMax(Vec,Vec,Vec); 234 PETSC_EXTERN PetscErrorCode VecPointwiseMaxAbs(Vec,Vec,Vec); 235 PETSC_EXTERN PetscErrorCode VecPointwiseMin(Vec,Vec,Vec); 236 PETSC_EXTERN PetscErrorCode VecPointwiseMult(Vec,Vec,Vec); 237 PETSC_EXTERN PetscErrorCode VecPointwiseDivide(Vec,Vec,Vec); 238 PETSC_EXTERN PetscErrorCode VecMaxPointwiseDivide(Vec,Vec,PetscReal*); 239 PETSC_EXTERN PetscErrorCode VecShift(Vec,PetscScalar); 240 PETSC_EXTERN PetscErrorCode VecReciprocal(Vec); 241 PETSC_EXTERN PetscErrorCode VecPermute(Vec, IS, PetscBool ); 242 PETSC_EXTERN PetscErrorCode VecSqrtAbs(Vec); 243 PETSC_EXTERN PetscErrorCode VecLog(Vec); 244 PETSC_EXTERN PetscErrorCode VecExp(Vec); 245 PETSC_EXTERN PetscErrorCode VecAbs(Vec); 246 PETSC_EXTERN PetscErrorCode VecDuplicate(Vec,Vec*); 247 PETSC_EXTERN PetscErrorCode VecDuplicateVecs(Vec,PetscInt,Vec*[]); 248 PETSC_EXTERN PetscErrorCode VecDestroyVecs(PetscInt, Vec*[]); 249 PETSC_EXTERN PetscErrorCode VecStrideNormAll(Vec,NormType,PetscReal[]); 250 PETSC_EXTERN PetscErrorCode VecStrideMaxAll(Vec,PetscInt [],PetscReal []); 251 PETSC_EXTERN PetscErrorCode VecStrideMinAll(Vec,PetscInt [],PetscReal []); 252 PETSC_EXTERN PetscErrorCode VecStrideScaleAll(Vec,const PetscScalar[]); 253 254 PETSC_EXTERN PetscErrorCode VecStrideNorm(Vec,PetscInt,NormType,PetscReal*); 255 PETSC_EXTERN PetscErrorCode VecStrideMax(Vec,PetscInt,PetscInt *,PetscReal *); 256 PETSC_EXTERN PetscErrorCode VecStrideMin(Vec,PetscInt,PetscInt *,PetscReal *); 257 PETSC_EXTERN PetscErrorCode VecStrideScale(Vec,PetscInt,PetscScalar); 258 PETSC_EXTERN PetscErrorCode VecStrideSet(Vec,PetscInt,PetscScalar); 259 260 261 PETSC_EXTERN PetscErrorCode VecStrideGather(Vec,PetscInt,Vec,InsertMode); 262 PETSC_EXTERN PetscErrorCode VecStrideScatter(Vec,PetscInt,Vec,InsertMode); 263 PETSC_EXTERN PetscErrorCode VecStrideGatherAll(Vec,Vec[],InsertMode); 264 PETSC_EXTERN PetscErrorCode VecStrideScatterAll(Vec[],Vec,InsertMode); 265 266 PETSC_EXTERN PetscErrorCode VecSetValues(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 267 PETSC_EXTERN PetscErrorCode VecGetValues(Vec,PetscInt,const PetscInt[],PetscScalar[]); 268 PETSC_EXTERN PetscErrorCode VecAssemblyBegin(Vec); 269 PETSC_EXTERN PetscErrorCode VecAssemblyEnd(Vec); 270 PETSC_EXTERN PetscErrorCode VecStashSetInitialSize(Vec,PetscInt,PetscInt); 271 PETSC_EXTERN PetscErrorCode VecStashView(Vec,PetscViewer); 272 PETSC_EXTERN PetscErrorCode VecStashGetInfo(Vec,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 273 274 /*MC 275 VecSetValue - Set a single entry into a vector. 276 277 Synopsis: 278 #include "petscvec.h" 279 PetscErrorCode VecSetValue(Vec v,PetscInt row,PetscScalar value, InsertMode mode); 280 281 Not Collective 282 283 Input Parameters: 284 + v - the vector 285 . row - the row location of the entry 286 . value - the value to insert 287 - mode - either INSERT_VALUES or ADD_VALUES 288 289 Notes: 290 For efficiency one should use VecSetValues() and set several or 291 many values simultaneously if possible. 292 293 These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd() 294 MUST be called after all calls to VecSetValues() have been completed. 295 296 VecSetValues() uses 0-based indices in Fortran as well as in C. 297 298 Level: beginner 299 300 .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValueLocal() 301 M*/ 302 PETSC_STATIC_INLINE PetscErrorCode VecSetValue(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValues(v,1,&i,&va,mode);} 303 304 305 PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec,PetscInt); 306 PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec,PetscInt*); 307 PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 308 309 /* Dynamic creation and loading functions */ 310 PETSC_EXTERN PetscFunctionList VecList; 311 PETSC_EXTERN PetscBool VecRegisterAllCalled; 312 PETSC_EXTERN PetscErrorCode VecSetType(Vec, VecType); 313 PETSC_EXTERN PetscErrorCode VecGetType(Vec, VecType *); 314 PETSC_EXTERN PetscErrorCode VecRegister(const char[],PetscErrorCode (*)(Vec)); 315 PETSC_EXTERN PetscErrorCode VecRegisterAll(void); 316 PETSC_EXTERN PetscErrorCode VecRegisterDestroy(void); 317 318 PETSC_EXTERN PetscErrorCode VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 319 PETSC_EXTERN PetscErrorCode VecScatterCreateEmpty(MPI_Comm,VecScatter *); 320 PETSC_EXTERN PetscErrorCode VecScatterCreateLocal(VecScatter,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt); 321 PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter,Vec,Vec,InsertMode,ScatterMode); 322 PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter,Vec,Vec,InsertMode,ScatterMode); 323 PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter*); 324 PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter,VecScatter *); 325 PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter,PetscViewer); 326 PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter,PetscInt *,PetscInt*); 327 PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter,PetscBool *); 328 329 PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 330 PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 331 PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 332 PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 333 PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 334 PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 335 PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]); 336 PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]); 337 338 PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec,const PetscScalar[]); 339 PETSC_EXTERN PetscErrorCode VecResetArray(Vec); 340 PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec,const PetscScalar[]); 341 PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[],PetscInt,PetscScalar**[]); 342 PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[],PetscInt,PetscScalar**[]); 343 344 PETSC_EXTERN PetscErrorCode VecView(Vec,PetscViewer); 345 PETSC_EXTERN PetscErrorCode VecEqual(Vec,Vec,PetscBool *); 346 PETSC_EXTERN PetscErrorCode VecLoad(Vec, PetscViewer); 347 348 PETSC_EXTERN PetscErrorCode VecGetSize(Vec,PetscInt*); 349 PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec,PetscInt*); 350 PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec,PetscInt*,PetscInt*); 351 PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec,const PetscInt *[]); 352 353 PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping); 354 PETSC_EXTERN PetscErrorCode VecSetValuesLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 355 356 /*MC 357 VecSetValueLocal - Set a single entry into a vector using the local numbering 358 359 Synopsis: 360 #include "petscvec.h" 361 PetscErrorCode VecSetValueLocal(Vec v,PetscInt row,PetscScalar value, InsertMode mode); 362 363 Not Collective 364 365 Input Parameters: 366 + v - the vector 367 . row - the row location of the entry 368 . value - the value to insert 369 - mode - either INSERT_VALUES or ADD_VALUES 370 371 Notes: 372 For efficiency one should use VecSetValues() and set several or 373 many values simultaneously if possible. 374 375 These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd() 376 MUST be called after all calls to VecSetValues() have been completed. 377 378 VecSetValues() uses 0-based indices in Fortran as well as in C. 379 380 Level: beginner 381 382 .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValue() 383 M*/ 384 PETSC_STATIC_INLINE PetscErrorCode VecSetValueLocal(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValuesLocal(v,1,&i,&va,mode);} 385 386 PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping); 387 PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 388 PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping*); 389 PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping*); 390 391 PETSC_EXTERN PetscErrorCode VecDotBegin(Vec,Vec,PetscScalar *); 392 PETSC_EXTERN PetscErrorCode VecDotEnd(Vec,Vec,PetscScalar *); 393 PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec,Vec,PetscScalar *); 394 PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec,Vec,PetscScalar *); 395 PETSC_EXTERN PetscErrorCode VecNormBegin(Vec,NormType,PetscReal *); 396 PETSC_EXTERN PetscErrorCode VecNormEnd(Vec,NormType,PetscReal *); 397 398 PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]); 399 PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]); 400 PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]); 401 PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]); 402 PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm); 403 404 405 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES,VEC_IGNORE_NEGATIVE_INDICES} VecOption; 406 PETSC_EXTERN PetscErrorCode VecSetOption(Vec,VecOption,PetscBool ); 407 408 PETSC_EXTERN PetscErrorCode VecGetArray(Vec,PetscScalar**); 409 PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec,const PetscScalar**); 410 PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec,PetscScalar**); 411 PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec,const PetscScalar**); 412 413 PETSC_EXTERN PetscErrorCode VecValidValues(Vec,PetscInt,PetscBool); 414 415 PETSC_EXTERN PetscErrorCode VecContourScale(Vec,PetscReal,PetscReal); 416 417 /* 418 These numbers need to match the entries in 419 the function table in vecimpl.h 420 */ 421 typedef enum { VECOP_VIEW = 33, VECOP_LOAD = 41, VECOP_DUPLICATE = 0} VecOperation; 422 PETSC_EXTERN PetscErrorCode VecSetOperation(Vec,VecOperation,void(*)(void)); 423 424 /* 425 Routines for dealing with ghosted vectors: 426 vectors with ghost elements at the end of the array. 427 */ 428 PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec,PetscInt,const PetscInt[]); 429 PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 430 PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 431 PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 432 PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 433 PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec,Vec*); 434 PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec,Vec*); 435 PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec,Vec,PetscBool*); 436 PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 437 PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 438 439 PETSC_EXTERN PetscErrorCode VecConjugate(Vec); 440 441 PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec,VecScatter*,Vec*); 442 PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec,VecScatter*,Vec*); 443 444 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec); 445 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec); 446 447 /*S 448 Vecs - Collection of vectors where the data for the vectors is stored in 449 one contiguous memory 450 451 Level: advanced 452 453 Notes: 454 Temporary construct for handling multiply right hand side solves 455 456 This is faked by storing a single vector that has enough array space for 457 n vectors 458 459 Concepts: parallel decomposition 460 461 S*/ 462 struct _n_Vecs {PetscInt n; Vec v;}; 463 typedef struct _n_Vecs* Vecs; 464 PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs); 465 PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm,PetscInt,PetscInt,Vecs*); 466 PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,PetscScalar*,Vecs*); 467 PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs,Vecs*); 468 469 #if defined(PETSC_HAVE_CUSP) 470 typedef struct _p_PetscCUSPIndices* PetscCUSPIndices; 471 PETSC_EXTERN PetscErrorCode PetscCUSPIndicesCreate(PetscInt, PetscInt*,PetscInt, PetscInt*,PetscCUSPIndices*); 472 PETSC_EXTERN PetscErrorCode PetscCUSPIndicesDestroy(PetscCUSPIndices*); 473 PETSC_EXTERN PetscErrorCode VecCUSPCopyToGPUSome_Public(Vec,PetscCUSPIndices); 474 PETSC_EXTERN PetscErrorCode VecCUSPCopyFromGPUSome_Public(Vec,PetscCUSPIndices); 475 476 #if defined(PETSC_HAVE_TXPETSCGPU) 477 PETSC_EXTERN PetscErrorCode VecCUSPResetIndexBuffersFlagsGPU_Public(PetscCUSPIndices); 478 PETSC_EXTERN PetscErrorCode VecCUSPCopySomeToContiguousBufferGPU_Public(Vec,PetscCUSPIndices); 479 PETSC_EXTERN PetscErrorCode VecCUSPCopySomeFromContiguousBufferGPU_Public(Vec,PetscCUSPIndices); 480 PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter,Vec,ScatterMode); 481 PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter); 482 #endif 483 484 PETSC_EXTERN PetscErrorCode VecCreateSeqCUSP(MPI_Comm,PetscInt,Vec*); 485 PETSC_EXTERN PetscErrorCode VecCreateMPICUSP(MPI_Comm,PetscInt,PetscInt,Vec*); 486 #endif 487 488 PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec,PetscInt*,Vec**); 489 PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec,PetscInt,Vec*); 490 PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec,PetscInt,PetscInt*,Vec*); 491 PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec,PetscInt,Vec); 492 PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm,PetscInt,IS*,Vec*,Vec*); 493 PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec,PetscInt*); 494 495 PETSC_EXTERN PetscErrorCode PetscOptionsVec(const char[],const char[],const char[],Vec,PetscBool*); 496 PETSC_EXTERN PetscErrorCode VecChop(Vec,PetscReal); 497 498 PETSC_EXTERN PetscErrorCode VecGetLayout(Vec,PetscLayout*); 499 PETSC_EXTERN PetscErrorCode VecSetLayout(Vec,PetscLayout); 500 501 PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer); 502 PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar **); 503 PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, PetscScalar [], InsertMode); 504 505 #endif 506 507