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 /*S 12 Vec - Abstract PETSc vector object 13 14 Level: beginner 15 16 Concepts: field variables, unknowns, arrays 17 18 .seealso: VecCreate(), VecType, VecSetType() 19 S*/ 20 typedef struct _p_Vec* Vec; 21 22 /*S 23 VecScatter - Object used to manage communication of data 24 between vectors in parallel. Manages both scatters and gathers 25 26 Level: beginner 27 28 Concepts: scatter 29 30 .seealso: VecScatterCreate(), VecScatterBegin(), VecScatterEnd() 31 S*/ 32 typedef struct _p_VecScatter* VecScatter; 33 34 /*E 35 ScatterMode - Determines the direction of a scatter 36 37 Level: beginner 38 39 .seealso: VecScatter, VecScatterBegin(), VecScatterEnd() 40 E*/ 41 typedef enum {SCATTER_FORWARD=0, SCATTER_REVERSE=1, SCATTER_FORWARD_LOCAL=2, SCATTER_REVERSE_LOCAL=3, SCATTER_LOCAL=2} ScatterMode; 42 43 /*MC 44 SCATTER_FORWARD - Scatters the values as dictated by the VecScatterCreate() call 45 46 Level: beginner 47 48 .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_REVERSE, SCATTER_FORWARD_LOCAL, 49 SCATTER_REVERSE_LOCAL 50 51 M*/ 52 53 /*MC 54 SCATTER_REVERSE - Moves the values in the opposite direction then the directions indicated in 55 in the VecScatterCreate() 56 57 Level: beginner 58 59 .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_FORWARD, SCATTER_FORWARD_LOCAL, 60 SCATTER_REVERSE_LOCAL 61 62 M*/ 63 64 /*MC 65 SCATTER_FORWARD_LOCAL - Scatters the values as dictated by the VecScatterCreate() call except NO parallel communication 66 is done. Any variables that have be moved between processes are ignored 67 68 Level: developer 69 70 .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_REVERSE, SCATTER_FORWARD, 71 SCATTER_REVERSE_LOCAL 72 73 M*/ 74 75 /*MC 76 SCATTER_REVERSE_LOCAL - Moves the values in the opposite direction then the directions indicated in 77 in the VecScatterCreate() except NO parallel communication 78 is done. Any variables that have be moved between processes are ignored 79 80 Level: developer 81 82 .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_FORWARD, SCATTER_FORWARD_LOCAL, 83 SCATTER_REVERSE 84 85 M*/ 86 87 /*J 88 VecType - String with the name of a PETSc vector or the creation function 89 with an optional dynamic library name, for example 90 http://www.mcs.anl.gov/petsc/lib.a:myveccreate() 91 92 Level: beginner 93 94 .seealso: VecSetType(), Vec 95 J*/ 96 typedef const char* VecType; 97 #define VECSEQ "seq" 98 #define VECMPI "mpi" 99 #define VECSTANDARD "standard" /* seq on one process and mpi on several */ 100 #define VECSHARED "shared" 101 #define VECSIEVE "sieve" 102 #define VECSEQCUSP "seqcusp" 103 #define VECMPICUSP "mpicusp" 104 #define VECCUSP "cusp" /* seqcusp on one process and mpicusp on several */ 105 #define VECNEST "nest" 106 #define VECSEQPTHREAD "seqpthread" 107 #define VECMPIPTHREAD "mpipthread" 108 #define VECPTHREAD "pthread" /* seqpthread on one process and mpipthread on several */ 109 110 111 /* Logging support */ 112 #define VEC_FILE_CLASSID 1211214 113 PETSC_EXTERN PetscClassId VEC_CLASSID; 114 PETSC_EXTERN PetscClassId VEC_SCATTER_CLASSID; 115 116 117 PETSC_EXTERN PetscErrorCode VecInitializePackage(const char[]); 118 PETSC_EXTERN PetscErrorCode VecFinalizePackage(void); 119 120 PETSC_EXTERN PetscErrorCode VecCreate(MPI_Comm,Vec*); 121 PETSC_EXTERN PetscErrorCode VecCreateSeq(MPI_Comm,PetscInt,Vec*); 122 PETSC_EXTERN PetscErrorCode VecCreateMPI(MPI_Comm,PetscInt,PetscInt,Vec*); 123 PETSC_EXTERN PetscErrorCode VecCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,const PetscScalar[],Vec*); 124 PETSC_EXTERN PetscErrorCode VecCreateMPIWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar[],Vec*); 125 PETSC_EXTERN PetscErrorCode VecCreateShared(MPI_Comm,PetscInt,PetscInt,Vec*); 126 PETSC_EXTERN PetscErrorCode VecSetFromOptions(Vec); 127 PETSC_EXTERN PetscErrorCode VecViewFromOptions(Vec,const char[]); 128 129 PETSC_EXTERN PetscErrorCode VecSetUp(Vec); 130 PETSC_EXTERN PetscErrorCode VecDestroy(Vec*); 131 PETSC_EXTERN PetscErrorCode VecZeroEntries(Vec); 132 PETSC_EXTERN PetscErrorCode VecSetOptionsPrefix(Vec,const char[]); 133 PETSC_EXTERN PetscErrorCode VecAppendOptionsPrefix(Vec,const char[]); 134 PETSC_EXTERN PetscErrorCode VecGetOptionsPrefix(Vec,const char*[]); 135 136 PETSC_EXTERN PetscErrorCode VecSetSizes(Vec,PetscInt,PetscInt); 137 138 PETSC_EXTERN PetscErrorCode VecDotNorm2(Vec,Vec,PetscScalar*,PetscReal*); 139 PETSC_EXTERN PetscErrorCode VecDot(Vec,Vec,PetscScalar*); 140 PETSC_EXTERN PetscErrorCode VecDotRealPart(Vec,Vec,PetscReal*); 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 #include "petscvec.h" 278 PetscErrorCode VecSetValue(Vec v,PetscInt row,PetscScalar value, InsertMode mode); 279 280 Not Collective 281 282 Input Parameters: 283 + v - the vector 284 . row - the row location of the entry 285 . value - the value to insert 286 - mode - either INSERT_VALUES or ADD_VALUES 287 288 Notes: 289 For efficiency one should use VecSetValues() and set several or 290 many values simultaneously if possible. 291 292 These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd() 293 MUST be called after all calls to VecSetValues() have been completed. 294 295 VecSetValues() uses 0-based indices in Fortran as well as in C. 296 297 Level: beginner 298 299 .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValueLocal() 300 M*/ 301 PETSC_STATIC_INLINE PetscErrorCode VecSetValue(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValues(v,1,&i,&va,mode);} 302 303 304 PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec,PetscInt); 305 PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec,PetscInt*); 306 PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 307 308 /* Dynamic creation and loading functions */ 309 PETSC_EXTERN PetscFunctionList VecList; 310 PETSC_EXTERN PetscBool VecRegisterAllCalled; 311 PETSC_EXTERN PetscErrorCode VecSetType(Vec, VecType); 312 PETSC_EXTERN PetscErrorCode VecGetType(Vec, VecType *); 313 PETSC_EXTERN PetscErrorCode VecRegister(const char[],const char[],const char[],PetscErrorCode (*)(Vec)); 314 PETSC_EXTERN PetscErrorCode VecRegisterAll(const char []); 315 PETSC_EXTERN PetscErrorCode VecRegisterDestroy(void); 316 317 /*MC 318 VecRegisterDynamic - Adds a new vector component implementation 319 320 Synopsis: 321 #include "petscvec.h" 322 PetscErrorCode VecRegisterDynamic(const char *name, const char *path, const char *func_name, PetscErrorCode (*create_func)(Vec)) 323 324 Not Collective 325 326 Input Parameters: 327 + name - The name of a new user-defined creation routine 328 . path - The path (either absolute or relative) of the library containing this routine 329 . func_name - The name of routine to create method context 330 - create_func - The creation routine itself 331 332 Notes: 333 VecRegisterDynamic() may be called multiple times to add several user-defined vectors 334 335 If dynamic libraries are used, then the fourth input argument (routine_create) is ignored. 336 337 Sample usage: 338 .vb 339 VecRegisterDynamic("my_vec","/home/username/my_lib/lib/libO/solaris/libmy.a", "MyVectorCreate", MyVectorCreate); 340 .ve 341 342 Then, your vector type can be chosen with the procedural interface via 343 .vb 344 VecCreate(MPI_Comm, Vec *); 345 VecSetType(Vec,"my_vector_name"); 346 .ve 347 or at runtime via the option 348 .vb 349 -vec_type my_vector_name 350 .ve 351 352 Notes: $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 353 If your function is not being put into a shared library then use VecRegister() instead 354 355 Level: advanced 356 357 .keywords: Vec, register 358 .seealso: VecRegisterAll(), VecRegisterDestroy(), VecRegister() 359 M*/ 360 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 361 #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,0) 362 #else 363 #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,d) 364 #endif 365 366 367 PETSC_EXTERN PetscErrorCode VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 368 PETSC_EXTERN PetscErrorCode VecScatterCreateEmpty(MPI_Comm,VecScatter *); 369 PETSC_EXTERN PetscErrorCode VecScatterCreateLocal(VecScatter,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt); 370 PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter,Vec,Vec,InsertMode,ScatterMode); 371 PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter,Vec,Vec,InsertMode,ScatterMode); 372 PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter*); 373 PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter,VecScatter *); 374 PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter,PetscViewer); 375 PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter,PetscInt *,PetscInt*); 376 PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter,PetscBool *); 377 378 PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 379 PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 380 PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 381 PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 382 PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 383 PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 384 PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]); 385 PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]); 386 387 PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec,const PetscScalar[]); 388 PETSC_EXTERN PetscErrorCode VecResetArray(Vec); 389 PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec,const PetscScalar[]); 390 PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[],PetscInt,PetscScalar**[]); 391 PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[],PetscInt,PetscScalar**[]); 392 393 PETSC_EXTERN PetscErrorCode VecView(Vec,PetscViewer); 394 PETSC_EXTERN PetscErrorCode VecEqual(Vec,Vec,PetscBool *); 395 PETSC_EXTERN PetscErrorCode VecLoad(Vec, PetscViewer); 396 397 PETSC_EXTERN PetscErrorCode VecGetSize(Vec,PetscInt*); 398 PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec,PetscInt*); 399 PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec,PetscInt*,PetscInt*); 400 PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec,const PetscInt *[]); 401 402 PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping); 403 PETSC_EXTERN PetscErrorCode VecSetValuesLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 404 405 /*MC 406 VecSetValueLocal - Set a single entry into a vector using the local numbering 407 408 Synopsis: 409 #include "petscvec.h" 410 PetscErrorCode VecSetValueLocal(Vec v,PetscInt row,PetscScalar value, InsertMode mode); 411 412 Not Collective 413 414 Input Parameters: 415 + v - the vector 416 . row - the row location of the entry 417 . value - the value to insert 418 - mode - either INSERT_VALUES or ADD_VALUES 419 420 Notes: 421 For efficiency one should use VecSetValues() and set several or 422 many values simultaneously if possible. 423 424 These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd() 425 MUST be called after all calls to VecSetValues() have been completed. 426 427 VecSetValues() uses 0-based indices in Fortran as well as in C. 428 429 Level: beginner 430 431 .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValue() 432 M*/ 433 PETSC_STATIC_INLINE PetscErrorCode VecSetValueLocal(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValuesLocal(v,1,&i,&va,mode);} 434 435 PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping); 436 PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 437 PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping*); 438 PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping*); 439 440 PETSC_EXTERN PetscErrorCode VecDotBegin(Vec,Vec,PetscScalar *); 441 PETSC_EXTERN PetscErrorCode VecDotEnd(Vec,Vec,PetscScalar *); 442 PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec,Vec,PetscScalar *); 443 PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec,Vec,PetscScalar *); 444 PETSC_EXTERN PetscErrorCode VecNormBegin(Vec,NormType,PetscReal *); 445 PETSC_EXTERN PetscErrorCode VecNormEnd(Vec,NormType,PetscReal *); 446 447 PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]); 448 PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]); 449 PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]); 450 PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]); 451 PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm); 452 453 454 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES,VEC_IGNORE_NEGATIVE_INDICES} VecOption; 455 PETSC_EXTERN PetscErrorCode VecSetOption(Vec,VecOption,PetscBool ); 456 457 PETSC_EXTERN PetscErrorCode VecGetArray(Vec,PetscScalar**); 458 PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec,const PetscScalar**); 459 PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec,PetscScalar**); 460 PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec,const PetscScalar**); 461 PETSC_EXTERN PetscErrorCode VecValidValues_Private(Vec,PetscInt,PetscBool); 462 463 #if defined(PETSC_USE_DEBUG) 464 # define VecValidValues(x,argnum,begin) do { \ 465 PetscErrorCode _vecvalidvalues_ierr; \ 466 _vecvalidvalues_ierr = VecValidValues_Private((x),(argnum),(begin));CHKERRQ(_vecvalidvalues_ierr); \ 467 } while (0) 468 #else 469 # define VecValidValues(x,argnum,begin) do { } while (0) 470 #endif 471 472 PETSC_EXTERN PetscErrorCode VecContourScale(Vec,PetscReal,PetscReal); 473 474 /* 475 These numbers need to match the entries in 476 the function table in vecimpl.h 477 */ 478 typedef enum { VECOP_VIEW = 33, VECOP_LOAD = 41, VECOP_DUPLICATE = 0} VecOperation; 479 PETSC_EXTERN PetscErrorCode VecSetOperation(Vec,VecOperation,void(*)(void)); 480 481 /* 482 Routines for dealing with ghosted vectors: 483 vectors with ghost elements at the end of the array. 484 */ 485 PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec,PetscInt,const PetscInt[]); 486 PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 487 PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 488 PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 489 PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 490 PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec,Vec*); 491 PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec,Vec*); 492 PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec,Vec,PetscBool*); 493 PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 494 PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 495 496 PETSC_EXTERN PetscErrorCode VecConjugate(Vec); 497 498 PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec,VecScatter*,Vec*); 499 PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec,VecScatter*,Vec*); 500 501 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec); 502 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec); 503 504 /*S 505 Vecs - Collection of vectors where the data for the vectors is stored in 506 one contiguous memory 507 508 Level: advanced 509 510 Notes: 511 Temporary construct for handling multiply right hand side solves 512 513 This is faked by storing a single vector that has enough array space for 514 n vectors 515 516 Concepts: parallel decomposition 517 518 S*/ 519 struct _n_Vecs {PetscInt n; Vec v;}; 520 typedef struct _n_Vecs* Vecs; 521 PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs); 522 PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm,PetscInt,PetscInt,Vecs*); 523 PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,PetscScalar*,Vecs*); 524 PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs,Vecs*); 525 526 #if defined(PETSC_HAVE_CUSP) 527 typedef struct _p_PetscCUSPIndices* PetscCUSPIndices; 528 PETSC_EXTERN PetscErrorCode PetscCUSPIndicesCreate(PetscInt, PetscInt*,PetscInt, PetscInt*,PetscCUSPIndices*); 529 PETSC_EXTERN PetscErrorCode PetscCUSPIndicesDestroy(PetscCUSPIndices*); 530 PETSC_EXTERN PetscErrorCode VecCUSPCopyToGPUSome_Public(Vec,PetscCUSPIndices); 531 PETSC_EXTERN PetscErrorCode VecCUSPCopyFromGPUSome_Public(Vec,PetscCUSPIndices); 532 533 #if defined(PETSC_HAVE_TXPETSCGPU) 534 PETSC_EXTERN PetscErrorCode VecCUSPResetIndexBuffersFlagsGPU_Public(PetscCUSPIndices); 535 PETSC_EXTERN PetscErrorCode VecCUSPCopySomeToContiguousBufferGPU_Public(Vec,PetscCUSPIndices); 536 PETSC_EXTERN PetscErrorCode VecCUSPCopySomeFromContiguousBufferGPU_Public(Vec,PetscCUSPIndices); 537 PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter,Vec,ScatterMode); 538 PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter); 539 #endif 540 541 PETSC_EXTERN PetscErrorCode VecCreateSeqCUSP(MPI_Comm,PetscInt,Vec*); 542 PETSC_EXTERN PetscErrorCode VecCreateMPICUSP(MPI_Comm,PetscInt,PetscInt,Vec*); 543 #endif 544 545 PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec,PetscInt*,Vec**); 546 PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec,PetscInt,Vec*); 547 PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec,PetscInt,PetscInt*,Vec*); 548 PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec,PetscInt,Vec); 549 PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm,PetscInt,IS*,Vec*,Vec*); 550 PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec,PetscInt*); 551 552 PETSC_EXTERN PetscErrorCode PetscOptionsVec(const char[],const char[],const char[],Vec,PetscBool*); 553 PETSC_EXTERN PetscErrorCode VecChop(Vec,PetscReal); 554 555 PETSC_EXTERN PetscErrorCode VecGetLayout(Vec,PetscLayout*); 556 PETSC_EXTERN PetscErrorCode VecSetLayout(Vec,PetscLayout); 557 558 PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer); 559 PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar **); 560 PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, PetscScalar [], InsertMode); 561 562 #endif 563 564