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(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*,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[],const char[],const char[],PetscErrorCode (*)(Vec)); 315 PETSC_EXTERN PetscErrorCode VecRegisterAll(const char []); 316 PETSC_EXTERN PetscErrorCode VecRegisterDestroy(void); 317 318 /*MC 319 VecRegisterDynamic - Adds a new vector component implementation 320 321 Synopsis: 322 #include "petscvec.h" 323 PetscErrorCode VecRegisterDynamic(const char *name, const char *path, const char *func_name, PetscErrorCode (*create_func)(Vec)) 324 325 Not Collective 326 327 Input Parameters: 328 + name - The name of a new user-defined creation routine 329 . path - The path (either absolute or relative) of the library containing this routine 330 . func_name - The name of routine to create method context 331 - create_func - The creation routine itself 332 333 Notes: 334 VecRegisterDynamic() may be called multiple times to add several user-defined vectors 335 336 If dynamic libraries are used, then the fourth input argument (routine_create) is ignored. 337 338 Sample usage: 339 .vb 340 VecRegisterDynamic("my_vec","/home/username/my_lib/lib/libO/solaris/libmy.a", "MyVectorCreate", MyVectorCreate); 341 .ve 342 343 Then, your vector type can be chosen with the procedural interface via 344 .vb 345 VecCreate(MPI_Comm, Vec *); 346 VecSetType(Vec,"my_vector_name"); 347 .ve 348 or at runtime via the option 349 .vb 350 -vec_type my_vector_name 351 .ve 352 353 Notes: $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 354 If your function is not being put into a shared library then use VecRegister() instead 355 356 Level: advanced 357 358 .keywords: Vec, register 359 .seealso: VecRegisterAll(), VecRegisterDestroy(), VecRegister() 360 M*/ 361 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 362 #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,0) 363 #else 364 #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,d) 365 #endif 366 367 368 PETSC_EXTERN PetscErrorCode VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 369 PETSC_EXTERN PetscErrorCode VecScatterCreateEmpty(MPI_Comm,VecScatter *); 370 PETSC_EXTERN PetscErrorCode VecScatterCreateLocal(VecScatter,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt); 371 PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter,Vec,Vec,InsertMode,ScatterMode); 372 PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter,Vec,Vec,InsertMode,ScatterMode); 373 PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter*); 374 PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter,VecScatter *); 375 PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter,PetscViewer); 376 PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter,PetscInt *,PetscInt*); 377 PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter,PetscBool *); 378 379 PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 380 PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 381 PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 382 PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 383 PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 384 PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 385 PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]); 386 PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]); 387 388 PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec,const PetscScalar[]); 389 PETSC_EXTERN PetscErrorCode VecResetArray(Vec); 390 PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec,const PetscScalar[]); 391 PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[],PetscInt,PetscScalar**[]); 392 PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[],PetscInt,PetscScalar**[]); 393 394 PETSC_EXTERN PetscErrorCode VecView(Vec,PetscViewer); 395 PETSC_EXTERN PetscErrorCode VecEqual(Vec,Vec,PetscBool *); 396 PETSC_EXTERN PetscErrorCode VecLoad(Vec, PetscViewer); 397 398 PETSC_EXTERN PetscErrorCode VecGetSize(Vec,PetscInt*); 399 PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec,PetscInt*); 400 PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec,PetscInt*,PetscInt*); 401 PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec,const PetscInt *[]); 402 403 PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping); 404 PETSC_EXTERN PetscErrorCode VecSetValuesLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 405 406 /*MC 407 VecSetValueLocal - Set a single entry into a vector using the local numbering 408 409 Synopsis: 410 #include "petscvec.h" 411 PetscErrorCode VecSetValueLocal(Vec v,PetscInt row,PetscScalar value, InsertMode mode); 412 413 Not Collective 414 415 Input Parameters: 416 + v - the vector 417 . row - the row location of the entry 418 . value - the value to insert 419 - mode - either INSERT_VALUES or ADD_VALUES 420 421 Notes: 422 For efficiency one should use VecSetValues() and set several or 423 many values simultaneously if possible. 424 425 These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd() 426 MUST be called after all calls to VecSetValues() have been completed. 427 428 VecSetValues() uses 0-based indices in Fortran as well as in C. 429 430 Level: beginner 431 432 .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValue() 433 M*/ 434 PETSC_STATIC_INLINE PetscErrorCode VecSetValueLocal(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValuesLocal(v,1,&i,&va,mode);} 435 436 PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping); 437 PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 438 PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping*); 439 PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping*); 440 441 PETSC_EXTERN PetscErrorCode VecDotBegin(Vec,Vec,PetscScalar *); 442 PETSC_EXTERN PetscErrorCode VecDotEnd(Vec,Vec,PetscScalar *); 443 PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec,Vec,PetscScalar *); 444 PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec,Vec,PetscScalar *); 445 PETSC_EXTERN PetscErrorCode VecNormBegin(Vec,NormType,PetscReal *); 446 PETSC_EXTERN PetscErrorCode VecNormEnd(Vec,NormType,PetscReal *); 447 448 PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]); 449 PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]); 450 PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]); 451 PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]); 452 PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm); 453 454 455 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES,VEC_IGNORE_NEGATIVE_INDICES} VecOption; 456 PETSC_EXTERN PetscErrorCode VecSetOption(Vec,VecOption,PetscBool ); 457 458 PETSC_EXTERN PetscErrorCode VecGetArray(Vec,PetscScalar**); 459 PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec,const PetscScalar**); 460 PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec,PetscScalar**); 461 PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec,const PetscScalar**); 462 PETSC_EXTERN PetscErrorCode VecValidValues_Private(Vec,PetscInt,PetscBool); 463 464 #if defined(PETSC_USE_DEBUG) 465 # define VecValidValues(x,argnum,begin) do { \ 466 PetscErrorCode _vecvalidvalues_ierr; \ 467 _vecvalidvalues_ierr = VecValidValues_Private((x),(argnum),(begin));CHKERRQ(_vecvalidvalues_ierr); \ 468 } while (0) 469 #else 470 # define VecValidValues(x,argnum,begin) do { } while (0) 471 #endif 472 473 PETSC_EXTERN PetscErrorCode VecContourScale(Vec,PetscReal,PetscReal); 474 475 /* 476 These numbers need to match the entries in 477 the function table in vecimpl.h 478 */ 479 typedef enum { VECOP_VIEW = 33, VECOP_LOAD = 41, VECOP_DUPLICATE = 0} VecOperation; 480 PETSC_EXTERN PetscErrorCode VecSetOperation(Vec,VecOperation,void(*)(void)); 481 482 /* 483 Routines for dealing with ghosted vectors: 484 vectors with ghost elements at the end of the array. 485 */ 486 PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec,PetscInt,const PetscInt[]); 487 PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 488 PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 489 PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 490 PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 491 PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec,Vec*); 492 PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec,Vec*); 493 PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec,Vec,PetscBool*); 494 PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 495 PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 496 497 PETSC_EXTERN PetscErrorCode VecConjugate(Vec); 498 499 PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec,VecScatter*,Vec*); 500 PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec,VecScatter*,Vec*); 501 502 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec); 503 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec); 504 505 /*S 506 Vecs - Collection of vectors where the data for the vectors is stored in 507 one contiguous memory 508 509 Level: advanced 510 511 Notes: 512 Temporary construct for handling multiply right hand side solves 513 514 This is faked by storing a single vector that has enough array space for 515 n vectors 516 517 Concepts: parallel decomposition 518 519 S*/ 520 struct _n_Vecs {PetscInt n; Vec v;}; 521 typedef struct _n_Vecs* Vecs; 522 PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs); 523 PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm,PetscInt,PetscInt,Vecs*); 524 PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,PetscScalar*,Vecs*); 525 PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs,Vecs*); 526 527 #if defined(PETSC_HAVE_CUSP) 528 typedef struct _p_PetscCUSPIndices* PetscCUSPIndices; 529 PETSC_EXTERN PetscErrorCode PetscCUSPIndicesCreate(PetscInt, PetscInt*,PetscInt, PetscInt*,PetscCUSPIndices*); 530 PETSC_EXTERN PetscErrorCode PetscCUSPIndicesDestroy(PetscCUSPIndices*); 531 PETSC_EXTERN PetscErrorCode VecCUSPCopyToGPUSome_Public(Vec,PetscCUSPIndices); 532 PETSC_EXTERN PetscErrorCode VecCUSPCopyFromGPUSome_Public(Vec,PetscCUSPIndices); 533 534 #if defined(PETSC_HAVE_TXPETSCGPU) 535 PETSC_EXTERN PetscErrorCode VecCUSPResetIndexBuffersFlagsGPU_Public(PetscCUSPIndices); 536 PETSC_EXTERN PetscErrorCode VecCUSPCopySomeToContiguousBufferGPU_Public(Vec,PetscCUSPIndices); 537 PETSC_EXTERN PetscErrorCode VecCUSPCopySomeFromContiguousBufferGPU_Public(Vec,PetscCUSPIndices); 538 PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter,Vec,ScatterMode); 539 PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter); 540 #endif 541 542 PETSC_EXTERN PetscErrorCode VecCreateSeqCUSP(MPI_Comm,PetscInt,Vec*); 543 PETSC_EXTERN PetscErrorCode VecCreateMPICUSP(MPI_Comm,PetscInt,PetscInt,Vec*); 544 #endif 545 546 PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec,PetscInt*,Vec**); 547 PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec,PetscInt,Vec*); 548 PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec,PetscInt,PetscInt*,Vec*); 549 PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec,PetscInt,Vec); 550 PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm,PetscInt,IS*,Vec*,Vec*); 551 PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec,PetscInt*); 552 553 PETSC_EXTERN PetscErrorCode PetscOptionsVec(const char[],const char[],const char[],Vec,PetscBool*); 554 PETSC_EXTERN PetscErrorCode VecChop(Vec,PetscReal); 555 556 PETSC_EXTERN PetscErrorCode VecGetLayout(Vec,PetscLayout*); 557 PETSC_EXTERN PetscErrorCode VecSetLayout(Vec,PetscLayout); 558 559 PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer); 560 PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar **); 561 PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, PetscScalar [], InsertMode); 562 563 #endif 564 565