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 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 #define VecType char* 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(const char[]); 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 VecSetUp(Vec); 129 PETSC_EXTERN PetscErrorCode VecDestroy(Vec*); 130 PETSC_EXTERN PetscErrorCode VecZeroEntries(Vec); 131 PETSC_EXTERN PetscErrorCode VecSetOptionsPrefix(Vec,const char[]); 132 PETSC_EXTERN PetscErrorCode VecAppendOptionsPrefix(Vec,const char[]); 133 PETSC_EXTERN PetscErrorCode VecGetOptionsPrefix(Vec,const char*[]); 134 135 PETSC_EXTERN PetscErrorCode VecSetSizes(Vec,PetscInt,PetscInt); 136 137 PETSC_EXTERN PetscErrorCode VecDotNorm2(Vec,Vec,PetscScalar*,PetscScalar*); 138 PETSC_EXTERN PetscErrorCode VecDot(Vec,Vec,PetscScalar*); 139 PETSC_EXTERN PetscErrorCode VecTDot(Vec,Vec,PetscScalar*); 140 PETSC_EXTERN PetscErrorCode VecMDot(Vec,PetscInt,const Vec[],PetscScalar[]); 141 PETSC_EXTERN PetscErrorCode VecMTDot(Vec,PetscInt,const Vec[],PetscScalar[]); 142 PETSC_EXTERN PetscErrorCode VecGetSubVector(Vec,IS,Vec*); 143 PETSC_EXTERN PetscErrorCode VecRestoreSubVector(Vec,IS,Vec*); 144 145 /*E 146 NormType - determines what type of norm to compute 147 148 Level: beginner 149 150 .seealso: VecNorm(), VecNormBegin(), VecNormEnd(), MatNorm() 151 E*/ 152 typedef enum {NORM_1=0,NORM_2=1,NORM_FROBENIUS=2,NORM_INFINITY=3,NORM_1_AND_2=4} NormType; 153 PETSC_EXTERN const char *NormTypes[]; 154 #define NORM_MAX NORM_INFINITY 155 156 /*MC 157 NORM_1 - the one norm, ||v|| = sum_i | v_i |. ||A|| = max_j || v_*j ||, maximum column sum 158 159 Level: beginner 160 161 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_2, NORM_FROBENIUS, 162 NORM_INFINITY, NORM_1_AND_2 163 164 M*/ 165 166 /*MC 167 NORM_2 - the two norm, ||v|| = sqrt(sum_i (v_i)^2) (vectors only) 168 169 Level: beginner 170 171 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_FROBENIUS, 172 NORM_INFINITY, NORM_1_AND_2 173 174 M*/ 175 176 /*MC 177 NORM_FROBENIUS - ||A|| = sqrt(sum_ij (A_ij)^2), same as NORM_2 for vectors 178 179 Level: beginner 180 181 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2, 182 NORM_INFINITY, NORM_1_AND_2 183 184 M*/ 185 186 /*MC 187 NORM_INFINITY - ||v|| = max_i |v_i|. ||A|| = max_i || v_i* ||, maximum row sum 188 189 Level: beginner 190 191 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2, 192 NORM_FROBINIUS, NORM_1_AND_2 193 194 M*/ 195 196 /*MC 197 NORM_1_AND_2 - computes both the 1 and 2 norm of a vector 198 199 Level: beginner 200 201 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2, 202 NORM_FROBINIUS, NORM_INFINITY 203 204 M*/ 205 206 /*MC 207 NORM_MAX - see NORM_INFINITY 208 209 Level: beginner 210 211 M*/ 212 213 PETSC_EXTERN PetscErrorCode VecNorm(Vec,NormType,PetscReal *); 214 PETSC_EXTERN PetscErrorCode VecNormAvailable(Vec,NormType,PetscBool *,PetscReal *); 215 PETSC_EXTERN PetscErrorCode VecNormalize(Vec,PetscReal *); 216 PETSC_EXTERN PetscErrorCode VecSum(Vec,PetscScalar*); 217 PETSC_EXTERN PetscErrorCode VecMax(Vec,PetscInt*,PetscReal *); 218 PETSC_EXTERN PetscErrorCode VecMin(Vec,PetscInt*,PetscReal *); 219 PETSC_EXTERN PetscErrorCode VecScale(Vec,PetscScalar); 220 PETSC_EXTERN PetscErrorCode VecCopy(Vec,Vec); 221 PETSC_EXTERN PetscErrorCode VecSetRandom(Vec,PetscRandom); 222 PETSC_EXTERN PetscErrorCode VecSet(Vec,PetscScalar); 223 PETSC_EXTERN PetscErrorCode VecSwap(Vec,Vec); 224 PETSC_EXTERN PetscErrorCode VecAXPY(Vec,PetscScalar,Vec); 225 PETSC_EXTERN PetscErrorCode VecAXPBY(Vec,PetscScalar,PetscScalar,Vec); 226 PETSC_EXTERN PetscErrorCode VecMAXPY(Vec,PetscInt,const PetscScalar[],Vec[]); 227 PETSC_EXTERN PetscErrorCode VecAYPX(Vec,PetscScalar,Vec); 228 PETSC_EXTERN PetscErrorCode VecWAXPY(Vec,PetscScalar,Vec,Vec); 229 PETSC_EXTERN PetscErrorCode VecAXPBYPCZ(Vec,PetscScalar,PetscScalar,PetscScalar,Vec,Vec); 230 PETSC_EXTERN PetscErrorCode VecPointwiseMax(Vec,Vec,Vec); 231 PETSC_EXTERN PetscErrorCode VecPointwiseMaxAbs(Vec,Vec,Vec); 232 PETSC_EXTERN PetscErrorCode VecPointwiseMin(Vec,Vec,Vec); 233 PETSC_EXTERN PetscErrorCode VecPointwiseMult(Vec,Vec,Vec); 234 PETSC_EXTERN PetscErrorCode VecPointwiseDivide(Vec,Vec,Vec); 235 PETSC_EXTERN PetscErrorCode VecMaxPointwiseDivide(Vec,Vec,PetscReal*); 236 PETSC_EXTERN PetscErrorCode VecShift(Vec,PetscScalar); 237 PETSC_EXTERN PetscErrorCode VecReciprocal(Vec); 238 PETSC_EXTERN PetscErrorCode VecPermute(Vec, IS, PetscBool ); 239 PETSC_EXTERN PetscErrorCode VecSqrtAbs(Vec); 240 PETSC_EXTERN PetscErrorCode VecLog(Vec); 241 PETSC_EXTERN PetscErrorCode VecExp(Vec); 242 PETSC_EXTERN PetscErrorCode VecAbs(Vec); 243 PETSC_EXTERN PetscErrorCode VecDuplicate(Vec,Vec*); 244 PETSC_EXTERN PetscErrorCode VecDuplicateVecs(Vec,PetscInt,Vec*[]); 245 PETSC_EXTERN PetscErrorCode VecDestroyVecs(PetscInt, Vec*[]); 246 PETSC_EXTERN PetscErrorCode VecStrideNormAll(Vec,NormType,PetscReal[]); 247 PETSC_EXTERN PetscErrorCode VecStrideMaxAll(Vec,PetscInt [],PetscReal []); 248 PETSC_EXTERN PetscErrorCode VecStrideMinAll(Vec,PetscInt [],PetscReal []); 249 PETSC_EXTERN PetscErrorCode VecStrideScaleAll(Vec,const PetscScalar[]); 250 251 PETSC_EXTERN PetscErrorCode VecStrideNorm(Vec,PetscInt,NormType,PetscReal*); 252 PETSC_EXTERN PetscErrorCode VecStrideMax(Vec,PetscInt,PetscInt *,PetscReal *); 253 PETSC_EXTERN PetscErrorCode VecStrideMin(Vec,PetscInt,PetscInt *,PetscReal *); 254 PETSC_EXTERN PetscErrorCode VecStrideScale(Vec,PetscInt,PetscScalar); 255 PETSC_EXTERN PetscErrorCode VecStrideSet(Vec,PetscInt,PetscScalar); 256 257 258 PETSC_EXTERN PetscErrorCode VecStrideGather(Vec,PetscInt,Vec,InsertMode); 259 PETSC_EXTERN PetscErrorCode VecStrideScatter(Vec,PetscInt,Vec,InsertMode); 260 PETSC_EXTERN PetscErrorCode VecStrideGatherAll(Vec,Vec[],InsertMode); 261 PETSC_EXTERN PetscErrorCode VecStrideScatterAll(Vec[],Vec,InsertMode); 262 263 PETSC_EXTERN PetscErrorCode VecSetValues(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 264 PETSC_EXTERN PetscErrorCode VecGetValues(Vec,PetscInt,const PetscInt[],PetscScalar[]); 265 PETSC_EXTERN PetscErrorCode VecAssemblyBegin(Vec); 266 PETSC_EXTERN PetscErrorCode VecAssemblyEnd(Vec); 267 PETSC_EXTERN PetscErrorCode VecStashSetInitialSize(Vec,PetscInt,PetscInt); 268 PETSC_EXTERN PetscErrorCode VecStashView(Vec,PetscViewer); 269 PETSC_EXTERN PetscErrorCode VecStashGetInfo(Vec,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 270 271 /*MC 272 VecSetValue - Set a single entry into a vector. 273 274 Synopsis: 275 PetscErrorCode VecSetValue(Vec v,int row,PetscScalar value, InsertMode mode); 276 277 Not Collective 278 279 Input Parameters: 280 + v - the vector 281 . row - the row location of the entry 282 . value - the value to insert 283 - mode - either INSERT_VALUES or ADD_VALUES 284 285 Notes: 286 For efficiency one should use VecSetValues() and set several or 287 many values simultaneously if possible. 288 289 These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd() 290 MUST be called after all calls to VecSetValues() have been completed. 291 292 VecSetValues() uses 0-based indices in Fortran as well as in C. 293 294 Level: beginner 295 296 .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValueLocal() 297 M*/ 298 PETSC_STATIC_INLINE PetscErrorCode VecSetValue(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValues(v,1,&i,&va,mode);} 299 300 301 PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec,PetscInt); 302 PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec,PetscInt*); 303 PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 304 305 /* Dynamic creation and loading functions */ 306 PETSC_EXTERN PetscFList VecList; 307 PETSC_EXTERN PetscBool VecRegisterAllCalled; 308 PETSC_EXTERN PetscErrorCode VecSetType(Vec, const VecType); 309 PETSC_EXTERN PetscErrorCode VecGetType(Vec, const VecType *); 310 PETSC_EXTERN PetscErrorCode VecRegister(const char[],const char[],const char[],PetscErrorCode (*)(Vec)); 311 PETSC_EXTERN PetscErrorCode VecRegisterAll(const char []); 312 PETSC_EXTERN PetscErrorCode VecRegisterDestroy(void); 313 314 /*MC 315 VecRegisterDynamic - Adds a new vector component implementation 316 317 Synopsis: 318 PetscErrorCode VecRegisterDynamic(const char *name, const char *path, const char *func_name, PetscErrorCode (*create_func)(Vec)) 319 320 Not Collective 321 322 Input Parameters: 323 + name - The name of a new user-defined creation routine 324 . path - The path (either absolute or relative) of the library containing this routine 325 . func_name - The name of routine to create method context 326 - create_func - The creation routine itself 327 328 Notes: 329 VecRegisterDynamic() may be called multiple times to add several user-defined vectors 330 331 If dynamic libraries are used, then the fourth input argument (routine_create) is ignored. 332 333 Sample usage: 334 .vb 335 VecRegisterDynamic("my_vec","/home/username/my_lib/lib/libO/solaris/libmy.a", "MyVectorCreate", MyVectorCreate); 336 .ve 337 338 Then, your vector type can be chosen with the procedural interface via 339 .vb 340 VecCreate(MPI_Comm, Vec *); 341 VecSetType(Vec,"my_vector_name"); 342 .ve 343 or at runtime via the option 344 .vb 345 -vec_type my_vector_name 346 .ve 347 348 Notes: $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 349 If your function is not being put into a shared library then use VecRegister() instead 350 351 Level: advanced 352 353 .keywords: Vec, register 354 .seealso: VecRegisterAll(), VecRegisterDestroy(), VecRegister() 355 M*/ 356 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 357 #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,0) 358 #else 359 #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,d) 360 #endif 361 362 363 PETSC_EXTERN PetscErrorCode VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 364 PETSC_EXTERN PetscErrorCode VecScatterCreateEmpty(MPI_Comm,VecScatter *); 365 PETSC_EXTERN PetscErrorCode VecScatterCreateLocal(VecScatter,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt); 366 PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter,Vec,Vec,InsertMode,ScatterMode); 367 PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter,Vec,Vec,InsertMode,ScatterMode); 368 PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter*); 369 PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter,VecScatter *); 370 PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter,PetscViewer); 371 PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter,PetscInt *,PetscInt*); 372 PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter,PetscBool *); 373 374 PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 375 PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 376 PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 377 PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 378 PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 379 PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 380 PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]); 381 PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]); 382 383 PETSC_EXTERN PetscErrorCode VecTransplantPlaceArray(Vec,Vec); 384 PETSC_EXTERN PetscErrorCode VecTransplantResetArray(Vec,Vec); 385 PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec,const PetscScalar[]); 386 PETSC_EXTERN PetscErrorCode VecResetArray(Vec); 387 PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec,const PetscScalar[]); 388 PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[],PetscInt,PetscScalar**[]); 389 PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[],PetscInt,PetscScalar**[]); 390 391 PETSC_EXTERN PetscErrorCode VecView(Vec,PetscViewer); 392 PETSC_EXTERN PetscErrorCode VecViewFromOptions(Vec, const char *); 393 PETSC_EXTERN PetscErrorCode VecEqual(Vec,Vec,PetscBool *); 394 PETSC_EXTERN PetscErrorCode VecLoad(Vec, PetscViewer); 395 396 PETSC_EXTERN PetscErrorCode VecGetSize(Vec,PetscInt*); 397 PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec,PetscInt*); 398 PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec,PetscInt*,PetscInt*); 399 PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec,const PetscInt *[]); 400 401 PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping); 402 PETSC_EXTERN PetscErrorCode VecSetValuesLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 403 404 /*MC 405 VecSetValueLocal - Set a single entry into a vector using the local numbering 406 407 Synopsis: 408 PetscErrorCode VecSetValueLocal(Vec v,int row,PetscScalar value, InsertMode mode); 409 410 Not Collective 411 412 Input Parameters: 413 + v - the vector 414 . row - the row location of the entry 415 . value - the value to insert 416 - mode - either INSERT_VALUES or ADD_VALUES 417 418 Notes: 419 For efficiency one should use VecSetValues() and set several or 420 many values simultaneously if possible. 421 422 These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd() 423 MUST be called after all calls to VecSetValues() have been completed. 424 425 VecSetValues() uses 0-based indices in Fortran as well as in C. 426 427 Level: beginner 428 429 .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValue() 430 M*/ 431 PETSC_STATIC_INLINE PetscErrorCode VecSetValueLocal(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValuesLocal(v,1,&i,&va,mode);} 432 433 PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping); 434 PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 435 PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping*); 436 PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping*); 437 438 PETSC_EXTERN PetscErrorCode VecDotBegin(Vec,Vec,PetscScalar *); 439 PETSC_EXTERN PetscErrorCode VecDotEnd(Vec,Vec,PetscScalar *); 440 PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec,Vec,PetscScalar *); 441 PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec,Vec,PetscScalar *); 442 PETSC_EXTERN PetscErrorCode VecNormBegin(Vec,NormType,PetscReal *); 443 PETSC_EXTERN PetscErrorCode VecNormEnd(Vec,NormType,PetscReal *); 444 445 PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]); 446 PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]); 447 PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]); 448 PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]); 449 PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm); 450 451 452 #if defined(PETSC_USE_DEBUG) 453 #define VecValidValues(vec,argnum,input) do { \ 454 PetscErrorCode _ierr; \ 455 PetscInt _n,_i; \ 456 const PetscScalar *_x; \ 457 \ 458 if (vec->petscnative || vec->ops->getarray) { \ 459 _ierr = VecGetLocalSize(vec,&_n);CHKERRQ(_ierr); \ 460 _ierr = VecGetArrayRead(vec,&_x);CHKERRQ(_ierr); \ 461 for (_i=0; _i<_n; _i++) { \ 462 if (input) { \ 463 if (PetscIsInfOrNanScalar(_x[_i])) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_FP,"Vec entry at local location %D is not-a-number or infinite at beginning of function: Parameter number %d",_i,argnum); \ 464 } else { \ 465 if (PetscIsInfOrNanScalar(_x[_i])) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_FP,"Vec entry at local location %D is not-a-number or infinite at end of function: Parameter number %d",_i,argnum); \ 466 } \ 467 } \ 468 _ierr = VecRestoreArrayRead(vec,&_x);CHKERRQ(_ierr); \ 469 } \ 470 } while (0) 471 #else 472 #define VecValidValues(vec,argnum,input) 473 #endif 474 475 476 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES,VEC_IGNORE_NEGATIVE_INDICES} VecOption; 477 PETSC_EXTERN PetscErrorCode VecSetOption(Vec,VecOption,PetscBool ); 478 479 /* 480 Expose VecGetArray()/VecRestoreArray() to users. Allows this to work without any function 481 call overhead on any 'native' Vecs. 482 */ 483 484 #include "petsc-private/vecimpl.h" 485 486 PETSC_EXTERN PetscErrorCode VecContourScale(Vec,PetscReal,PetscReal); 487 488 /* 489 These numbers need to match the entries in 490 the function table in vecimpl.h 491 */ 492 typedef enum { VECOP_VIEW = 33, VECOP_LOAD = 41, VECOP_DUPLICATE = 0} VecOperation; 493 PETSC_EXTERN PetscErrorCode VecSetOperation(Vec,VecOperation,void(*)(void)); 494 495 /* 496 Routines for dealing with ghosted vectors: 497 vectors with ghost elements at the end of the array. 498 */ 499 PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec,PetscInt,const PetscInt[]); 500 PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 501 PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 502 PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 503 PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 504 PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec,Vec*); 505 PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec,Vec*); 506 PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 507 PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 508 509 PETSC_EXTERN PetscErrorCode VecConjugate(Vec); 510 511 PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec,VecScatter*,Vec*); 512 PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec,VecScatter*,Vec*); 513 514 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec); 515 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec); 516 517 /*S 518 Vecs - Collection of vectors where the data for the vectors is stored in 519 one contiguous memory 520 521 Level: advanced 522 523 Notes: 524 Temporary construct for handling multiply right hand side solves 525 526 This is faked by storing a single vector that has enough array space for 527 n vectors 528 529 Concepts: parallel decomposition 530 531 S*/ 532 struct _n_Vecs {PetscInt n; Vec v;}; 533 typedef struct _n_Vecs* Vecs; 534 #define VecsDestroy(x) (VecDestroy(&(x)->v) || PetscFree(x)) 535 #define VecsCreateSeq(comm,p,m,x) (PetscNew(struct _n_Vecs,x) || VecCreateSeq(comm,p*m,&(*(x))->v) || (-1 == ((*(x))->n = (m)))) 536 #define VecsCreateSeqWithArray(comm,p,m,a,x) (PetscNew(struct _n_Vecs,x) || VecCreateSeqWithArray(comm,1,p*m,a,&(*(x))->v) || (-1 == ((*(x))->n = (m)))) 537 #define VecsDuplicate(x,y) (PetscNew(struct _n_Vecs,y) || VecDuplicate(x->v,&(*(y))->v) || (-1 == ((*(y))->n = (x)->n))) 538 539 #if defined(PETSC_HAVE_CUSP) 540 typedef struct _p_PetscCUSPIndices* PetscCUSPIndices; 541 PETSC_EXTERN PetscErrorCode PetscCUSPIndicesCreate(PetscInt, PetscInt*,PetscInt, PetscInt*,PetscCUSPIndices*); 542 PETSC_EXTERN PetscErrorCode PetscCUSPIndicesDestroy(PetscCUSPIndices*); 543 PETSC_EXTERN PetscErrorCode VecCUSPCopyToGPUSome_Public(Vec,PetscCUSPIndices); 544 PETSC_EXTERN PetscErrorCode VecCUSPCopyFromGPUSome_Public(Vec,PetscCUSPIndices); 545 546 #if defined(PETSC_HAVE_TXPETSCGPU) 547 PETSC_EXTERN PetscErrorCode VecCUSPResetIndexBuffersFlagsGPU_Public(PetscCUSPIndices); 548 PETSC_EXTERN PetscErrorCode VecCUSPCopySomeToContiguousBufferGPU_Public(Vec,PetscCUSPIndices); 549 PETSC_EXTERN PetscErrorCode VecCUSPCopySomeFromContiguousBufferGPU_Public(Vec,PetscCUSPIndices); 550 PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter,Vec,ScatterMode); 551 PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter); 552 #endif 553 554 PETSC_EXTERN PetscErrorCode VecCreateSeqCUSP(MPI_Comm,PetscInt,Vec*); 555 PETSC_EXTERN PetscErrorCode VecCreateMPICUSP(MPI_Comm,PetscInt,PetscInt,Vec*); 556 #endif 557 558 #if defined(PETSC_HAVE_PTHREADCLASSES) 559 PETSC_EXTERN PetscErrorCode VecSetNThreads(Vec,PetscInt); 560 PETSC_EXTERN PetscErrorCode VecGetNThreads(Vec,PetscInt*); 561 PETSC_EXTERN PetscErrorCode VecGetThreadOwnershipRange(Vec,PetscInt,PetscInt*,PetscInt*); 562 PETSC_EXTERN PetscErrorCode VecSetThreadAffinities(Vec,const PetscInt[]); 563 PETSC_EXTERN PetscErrorCode VecCreateSeqPThread(MPI_Comm,PetscInt,PetscInt,PetscInt[],Vec*); 564 PETSC_EXTERN PetscErrorCode VecCreateMPIPThread(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],Vec*); 565 #endif 566 567 PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec,PetscInt*,Vec**); 568 PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec,PetscInt,Vec*); 569 PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec,PetscInt,PetscInt*,Vec*); 570 PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec,PetscInt,Vec); 571 PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm,PetscInt,IS*,Vec*,Vec*); 572 PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec,PetscInt*); 573 574 #endif 575 576