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