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 #ifndef PETSCVEC_H 7 #define PETSCVEC_H 8 9 #include <petscsys.h> 10 #include <petscsftypes.h> /* for VecScatter, VecScatterType */ 11 #include <petscis.h> 12 #include <petscdevicetypes.h> 13 #include <petscviewer.h> 14 15 /* SUBMANSEC = Vec */ 16 17 /*S 18 Vec - Abstract PETSc vector object 19 20 Level: beginner 21 22 .seealso: [](doc_vector), [](ch_vectors), `VecCreate()`, `VecType`, `VecSetType()` 23 S*/ 24 typedef struct _p_Vec *Vec; 25 26 /*E 27 ScatterMode - Determines the direction of a scatter 28 29 Values: 30 + `SCATTER_FORWARD` - Scatters the values as dictated by the `VecScatterCreate()` call 31 . `SCATTER_REVERSE` - Moves the values in the opposite direction than the directions indicated in the `VecScatterCreate()` call 32 . `SCATTER_FORWARD_LOCAL` - Scatters the values as dictated by the `VecScatterCreate()` call except NO MPI communication is done 33 - `SCATTER_REVERSE_LOCAL` - Moves the values in the opposite direction than the directions indicated in the `VecScatterCreate()` call 34 except NO MPI communication is done 35 36 Level: beginner 37 38 .seealso: [](ch_vectors), `VecScatter`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_FORWARD`, `SCATTER_REVERSE`, `SCATTER_FORWARD_LOCAL`, `SCATTER_REVERSE_LOCAL` 39 E*/ 40 typedef enum { 41 SCATTER_FORWARD = 0, 42 SCATTER_REVERSE = 1, 43 SCATTER_FORWARD_LOCAL = 2, 44 SCATTER_REVERSE_LOCAL = 3 45 } ScatterMode; 46 47 /*MC 48 SCATTER_FORWARD - Scatters the values as dictated by the `VecScatterCreate()` call 49 50 Level: beginner 51 52 .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_REVERSE`, `SCATTER_FORWARD_LOCAL`, 53 `SCATTER_REVERSE_LOCAL` 54 M*/ 55 56 /*MC 57 SCATTER_REVERSE - Moves the values in the opposite direction then the directions indicated in 58 in the `VecScatterCreate()` 59 60 Level: beginner 61 62 .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_FORWARD`, `SCATTER_FORWARD_LOCAL`, 63 `SCATTER_REVERSE_LOCAL` 64 M*/ 65 66 /*MC 67 SCATTER_FORWARD_LOCAL - Scatters the values as dictated by the `VecScatterCreate()` call except NO parallel communication 68 is done. Any variables that have be moved between processes are ignored 69 70 Level: developer 71 72 .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_REVERSE`, `SCATTER_FORWARD`, 73 `SCATTER_REVERSE_LOCAL` 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: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_FORWARD`, `SCATTER_FORWARD_LOCAL`, 84 `SCATTER_REVERSE` 85 M*/ 86 87 /*J 88 VecType - String with the name of a PETSc vector 89 90 Level: beginner 91 92 .seealso: [](doc_vector), [](ch_vectors), `VecSetType()`, `Vec`, `VecCreate()`, `VecDestroy()` 93 J*/ 94 typedef const char *VecType; 95 #define VECSEQ "seq" 96 #define VECMPI "mpi" 97 #define VECSTANDARD "standard" /* seq on one process and mpi on several */ 98 #define VECSHARED "shared" 99 #define VECSEQVIENNACL "seqviennacl" 100 #define VECMPIVIENNACL "mpiviennacl" 101 #define VECVIENNACL "viennacl" /* seqviennacl on one process and mpiviennacl on several */ 102 #define VECSEQCUDA "seqcuda" 103 #define VECMPICUDA "mpicuda" 104 #define VECCUDA "cuda" /* seqcuda on one process and mpicuda on several */ 105 #define VECSEQHIP "seqhip" 106 #define VECMPIHIP "mpihip" 107 #define VECHIP "hip" /* seqcuda on one process and mpicuda on several */ 108 #define VECNEST "nest" 109 #define VECSEQKOKKOS "seqkokkos" 110 #define VECMPIKOKKOS "mpikokkos" 111 #define VECKOKKOS "kokkos" /* seqkokkos on one process and mpikokkos on several */ 112 113 /* Dynamic creation and loading functions */ 114 PETSC_EXTERN PetscErrorCode VecScatterSetType(VecScatter, VecScatterType); 115 PETSC_EXTERN PetscErrorCode VecScatterGetType(VecScatter, VecScatterType *); 116 PETSC_EXTERN PetscErrorCode VecScatterSetFromOptions(VecScatter); 117 PETSC_EXTERN PetscErrorCode VecScatterRegister(const char[], PetscErrorCode (*)(VecScatter)); 118 PETSC_EXTERN PetscErrorCode VecScatterCreate(Vec, IS, Vec, IS, VecScatter *); 119 120 /* Logging support */ 121 #define REAL_FILE_CLASSID 1211213 122 #define VEC_FILE_CLASSID 1211214 123 PETSC_EXTERN PetscClassId VEC_CLASSID; 124 PETSC_EXTERN PetscClassId PETSCSF_CLASSID; 125 126 PETSC_EXTERN PetscErrorCode VecInitializePackage(void); 127 PETSC_EXTERN PetscErrorCode VecFinalizePackage(void); 128 129 PETSC_EXTERN PetscErrorCode VecCreate(MPI_Comm, Vec *); 130 PETSC_EXTERN PetscErrorCode VecCreateFromOptions(MPI_Comm, const char *, PetscInt, PetscInt, PetscInt, Vec *); 131 PETSC_EXTERN PetscErrorCode VecCreateSeq(MPI_Comm, PetscInt, Vec *); 132 PETSC_EXTERN PetscErrorCode VecCreateMPI(MPI_Comm, PetscInt, PetscInt, Vec *); 133 PETSC_EXTERN PetscErrorCode VecCreateSeqWithArray(MPI_Comm, PetscInt, PetscInt, const PetscScalar[], Vec *); 134 PETSC_EXTERN PetscErrorCode VecCreateMPIWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar[], Vec *); 135 PETSC_EXTERN PetscErrorCode VecCreateShared(MPI_Comm, PetscInt, PetscInt, Vec *); 136 137 PETSC_EXTERN PetscErrorCode VecSetFromOptions(Vec); 138 PETSC_EXTERN PetscErrorCode VecViewFromOptions(Vec, PetscObject, const char[]); 139 140 PETSC_EXTERN PetscErrorCode VecSetUp(Vec); 141 PETSC_EXTERN PetscErrorCode VecDestroy(Vec *); 142 PETSC_EXTERN PetscErrorCode VecZeroEntries(Vec); 143 PETSC_EXTERN PetscErrorCode VecSetOptionsPrefix(Vec, const char[]); 144 PETSC_EXTERN PetscErrorCode VecAppendOptionsPrefix(Vec, const char[]); 145 PETSC_EXTERN PetscErrorCode VecGetOptionsPrefix(Vec, const char *[]); 146 147 PETSC_EXTERN PetscErrorCode VecSetSizes(Vec, PetscInt, PetscInt); 148 149 PETSC_EXTERN PetscErrorCode VecDotNorm2(Vec, Vec, PetscScalar *, PetscReal *); 150 PETSC_EXTERN PetscErrorCode VecDot(Vec, Vec, PetscScalar *); 151 PETSC_EXTERN PetscErrorCode VecDotRealPart(Vec, Vec, PetscReal *); 152 PETSC_EXTERN PetscErrorCode VecTDot(Vec, Vec, PetscScalar *); 153 PETSC_EXTERN PetscErrorCode VecMDot(Vec, PetscInt, const Vec[], PetscScalar[]); 154 PETSC_EXTERN PetscErrorCode VecMTDot(Vec, PetscInt, const Vec[], PetscScalar[]); 155 PETSC_EXTERN PetscErrorCode VecGetSubVector(Vec, IS, Vec *); 156 PETSC_EXTERN PetscErrorCode VecRestoreSubVector(Vec, IS, Vec *); 157 PETSC_EXTERN PetscErrorCode VecConcatenate(PetscInt, const Vec[], Vec *, IS *[]); 158 159 /*E 160 NormType - determines what type of norm to compute 161 162 Values: 163 + `NORM_1` - the one norm, ||v|| = sum_i | v_i |. ||A|| = max_j || v_*j ||, maximum column sum 164 . `NORM_2` - the two norm, ||v|| = sqrt(sum_i |v_i|^2) (vectors only) 165 . `NORM_FROBENIUS` - ||A|| = sqrt(sum_ij |A_ij|^2), same as `NORM_2` for vectors 166 . `NORM_INFINITY` - ||v|| = max_i |v_i|. ||A|| = max_i || v_i* ||, maximum row sum 167 - `NORM_1_AND_2` - computes both the 1 and 2 norm of a vector 168 169 Level: beginner 170 171 Note: 172 The `v` above represents a `Vec` while the `A` represents a `Mat` 173 174 .seealso: [](ch_vectors), `Vec`, `Mat`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `MatNorm()`, `NORM_1`, 175 `NORM_2`, `NORM_FROBENIUS`, `NORM_INFINITY`, `NORM_1_AND_2` 176 E*/ 177 typedef enum { 178 NORM_1 = 0, 179 NORM_2 = 1, 180 NORM_FROBENIUS = 2, 181 NORM_INFINITY = 3, 182 NORM_1_AND_2 = 4 183 } NormType; 184 PETSC_EXTERN const char *const NormTypes[]; 185 #define NORM_MAX NORM_INFINITY 186 187 /*MC 188 NORM_1 - the one norm, ||v|| = sum_i | v_i |. ||A|| = max_j || v_*j ||, maximum column sum 189 190 Level: beginner 191 192 .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_2`, `NORM_FROBENIUS`, 193 `NORM_INFINITY`, `NORM_1_AND_2` 194 M*/ 195 196 /*MC 197 NORM_2 - the two norm, ||v|| = sqrt(sum_i |v_i|^2) (vectors only) 198 199 Level: beginner 200 201 .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_FROBENIUS`, 202 `NORM_INFINITY`, `NORM_1_AND_2` 203 M*/ 204 205 /*MC 206 NORM_FROBENIUS - ||A|| = sqrt(sum_ij |A_ij|^2), same as `NORM_2` for vectors 207 208 Level: beginner 209 210 .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`, 211 `NORM_INFINITY`, `NORM_1_AND_2` 212 M*/ 213 214 /*MC 215 NORM_INFINITY - ||v|| = max_i |v_i|. ||A|| = max_i || v_i* ||, maximum row sum 216 217 Level: beginner 218 219 .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`, 220 `NORM_FROBENIUS`, `NORM_1_AND_2` 221 M*/ 222 223 /*MC 224 NORM_1_AND_2 - computes both the 1 and 2 norm of a vector. The values are stored in two adjacent `PetscReal` memory locations 225 226 Level: beginner 227 228 .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`, 229 `NORM_FROBENIUS`, `NORM_INFINITY` 230 M*/ 231 232 /*MC 233 NORM_MAX - see `NORM_INFINITY` 234 235 Level: beginner 236 M*/ 237 238 /*E 239 ReductionType - determines what type of column reduction (one that is not a type of norm defined in `NormType`) to compute 240 241 Values: 242 + `REDUCTION_SUM_REALPART` - sum of real part of each matrix column 243 . `REDUCTION_SUM_IMAGINARYPART` - sum of imaginary part of each matrix column 244 . `REDUCTION_MEAN_REALPART` - arithmetic mean of real part of each matrix column 245 - `REDUCTION_MEAN_IMAGINARYPART` - arithmetic mean of imaginary part of each matrix column 246 247 Level: beginner 248 249 Developer Note: 250 The constants defined in `ReductionType` MUST BE DISTINCT from those defined in `NormType`. 251 This is because `MatGetColumnReductions()` is used to compute both norms and other types of reductions, 252 and the constants defined in both `NormType` and `ReductionType` are used to designate the desired operation. 253 254 .seealso: [](ch_vectors), `MatGetColumnReductions()`, `MatGetColumnNorms()`, `NormType`, `REDUCTION_SUM_REALPART`, 255 `REDUCTION_SUM_IMAGINARYPART`, `REDUCTION_MEAN_REALPART`, `REDUCTION_NORM_1`, `REDUCTION_NORM_2`, `REDUCTION_NORM_FROBENIUS`, `REDUCTION_NORM_INFINITY` 256 E*/ 257 typedef enum { 258 REDUCTION_SUM_REALPART = 10, 259 REDUCTION_MEAN_REALPART = 11, 260 REDUCTION_SUM_IMAGINARYPART = 12, 261 REDUCTION_MEAN_IMAGINARYPART = 13 262 } ReductionType; 263 264 /*MC 265 REDUCTION_SUM_REALPART - sum of real part of matrix column 266 267 Level: beginner 268 269 .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_SUM_IMAGINARYPART`, `REDUCTION_MEAN_REALPART`, `REDUCTION_NORM_1`, 270 `REDUCTION_NORM_2`, `REDUCTION_NORM_FROBENIUS`, `REDUCTION_NORM_INFINITY` 271 M*/ 272 273 /*MC 274 REDUCTION_SUM_IMAGINARYPART - sum of imaginary part of matrix column 275 276 Level: beginner 277 278 .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_SUM_REALPART`, `REDUCTION_MEAN_IMAGINARYPART`, `REDUCTION_NORM_1`, 279 `REDUCTION_NORM_2`, `REDUCTION_NORM_FROBENIUS`, `REDUCTION_NORM_INFINITY` 280 M*/ 281 282 /*MC 283 REDUCTION_MEAN_REALPART - arithmetic mean of real part of matrix column 284 285 Level: beginner 286 287 .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_MEAN_IMAGINARYPART`, `REDUCTION_SUM_REALPART`, `REDUCTION_NORM_1`, 288 `REDUCTION_NORM_2`, `REDUCTION_NORM_FROBENIUS`, `REDUCTION_NORM_INFINITY` 289 M*/ 290 291 /*MC 292 REDUCTION_MEAN_IMAGINARYPART - arithmetic mean of imaginary part of matrix column 293 294 Level: beginner 295 296 .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_MEAN_REALPART`, `REDUCTION_SUM_IMAGINARYPART`, `REDUCTION_NORM_1`, 297 `REDUCTION_NORM_2`, `REDUCTION_NORM_FROBENIUS`, `REDUCTION_NORM_INFINITY` 298 M*/ 299 300 PETSC_EXTERN PetscErrorCode VecNorm(Vec, NormType, PetscReal *); 301 PETSC_EXTERN PetscErrorCode VecNormAvailable(Vec, NormType, PetscBool *, PetscReal *); 302 PETSC_EXTERN PetscErrorCode VecNormalize(Vec, PetscReal *); 303 PETSC_EXTERN PetscErrorCode VecSum(Vec, PetscScalar *); 304 PETSC_EXTERN PetscErrorCode VecMean(Vec, PetscScalar *); 305 PETSC_EXTERN PetscErrorCode VecMax(Vec, PetscInt *, PetscReal *); 306 PETSC_EXTERN PetscErrorCode VecMin(Vec, PetscInt *, PetscReal *); 307 PETSC_EXTERN PetscErrorCode VecScale(Vec, PetscScalar); 308 PETSC_EXTERN PetscErrorCode VecCopy(Vec, Vec); 309 PETSC_EXTERN PetscErrorCode VecSetRandom(Vec, PetscRandom); 310 PETSC_EXTERN PetscErrorCode VecSet(Vec, PetscScalar); 311 PETSC_EXTERN PetscErrorCode VecSetInf(Vec); 312 PETSC_EXTERN PetscErrorCode VecSwap(Vec, Vec); 313 PETSC_EXTERN PetscErrorCode VecAXPY(Vec, PetscScalar, Vec); 314 PETSC_EXTERN PetscErrorCode VecAXPBY(Vec, PetscScalar, PetscScalar, Vec); 315 PETSC_EXTERN PetscErrorCode VecMAXPY(Vec, PetscInt, const PetscScalar[], Vec[]); 316 PETSC_EXTERN PetscErrorCode VecMAXPBY(Vec, PetscInt, const PetscScalar[], PetscScalar, Vec[]); 317 PETSC_EXTERN PetscErrorCode VecAYPX(Vec, PetscScalar, Vec); 318 PETSC_EXTERN PetscErrorCode VecWAXPY(Vec, PetscScalar, Vec, Vec); 319 PETSC_EXTERN PetscErrorCode VecAXPBYPCZ(Vec, PetscScalar, PetscScalar, PetscScalar, Vec, Vec); 320 PETSC_EXTERN PetscErrorCode VecPointwiseMax(Vec, Vec, Vec); 321 PETSC_EXTERN PetscErrorCode VecPointwiseMaxAbs(Vec, Vec, Vec); 322 PETSC_EXTERN PetscErrorCode VecPointwiseMin(Vec, Vec, Vec); 323 PETSC_EXTERN PetscErrorCode VecPointwiseMult(Vec, Vec, Vec); 324 PETSC_EXTERN PetscErrorCode VecPointwiseDivide(Vec, Vec, Vec); 325 PETSC_EXTERN PetscErrorCode VecMaxPointwiseDivide(Vec, Vec, PetscReal *); 326 PETSC_EXTERN PetscErrorCode VecShift(Vec, PetscScalar); 327 PETSC_EXTERN PetscErrorCode VecReciprocal(Vec); 328 PETSC_EXTERN PetscErrorCode VecPermute(Vec, IS, PetscBool); 329 PETSC_EXTERN PetscErrorCode VecSqrtAbs(Vec); 330 PETSC_EXTERN PetscErrorCode VecLog(Vec); 331 PETSC_EXTERN PetscErrorCode VecExp(Vec); 332 PETSC_EXTERN PetscErrorCode VecAbs(Vec); 333 PETSC_EXTERN PetscErrorCode VecDuplicate(Vec, Vec *); 334 PETSC_EXTERN PetscErrorCode VecDuplicateVecs(Vec, PetscInt, Vec *[]); 335 PETSC_EXTERN PetscErrorCode VecDestroyVecs(PetscInt, Vec *[]); 336 PETSC_EXTERN PetscErrorCode VecStrideNormAll(Vec, NormType, PetscReal[]); 337 PETSC_EXTERN PetscErrorCode VecStrideMaxAll(Vec, PetscInt[], PetscReal[]); 338 PETSC_EXTERN PetscErrorCode VecStrideMinAll(Vec, PetscInt[], PetscReal[]); 339 PETSC_EXTERN PetscErrorCode VecStrideScaleAll(Vec, const PetscScalar[]); 340 PETSC_EXTERN PetscErrorCode VecStrideSumAll(Vec, PetscScalar *); 341 PETSC_EXTERN PetscErrorCode VecUniqueEntries(Vec, PetscInt *, PetscScalar **); 342 343 PETSC_EXTERN PetscErrorCode VecStrideNorm(Vec, PetscInt, NormType, PetscReal *); 344 PETSC_EXTERN PetscErrorCode VecStrideMax(Vec, PetscInt, PetscInt *, PetscReal *); 345 PETSC_EXTERN PetscErrorCode VecStrideMin(Vec, PetscInt, PetscInt *, PetscReal *); 346 PETSC_EXTERN PetscErrorCode VecStrideScale(Vec, PetscInt, PetscScalar); 347 PETSC_EXTERN PetscErrorCode VecStrideSum(Vec, PetscInt, PetscScalar *); 348 PETSC_EXTERN PetscErrorCode VecStrideSet(Vec, PetscInt, PetscScalar); 349 350 PETSC_EXTERN PetscErrorCode VecStrideGather(Vec, PetscInt, Vec, InsertMode); 351 PETSC_EXTERN PetscErrorCode VecStrideScatter(Vec, PetscInt, Vec, InsertMode); 352 PETSC_EXTERN PetscErrorCode VecStrideGatherAll(Vec, Vec[], InsertMode); 353 PETSC_EXTERN PetscErrorCode VecStrideScatterAll(Vec[], Vec, InsertMode); 354 355 PETSC_EXTERN PetscErrorCode VecStrideSubSetScatter(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode); 356 PETSC_EXTERN PetscErrorCode VecStrideSubSetGather(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode); 357 358 PETSC_EXTERN PetscErrorCode VecSetValues(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode); 359 PETSC_EXTERN PetscErrorCode VecGetValues(Vec, PetscInt, const PetscInt[], PetscScalar[]); 360 PETSC_EXTERN PetscErrorCode VecAssemblyBegin(Vec); 361 PETSC_EXTERN PetscErrorCode VecAssemblyEnd(Vec); 362 PETSC_EXTERN PetscErrorCode VecStashSetInitialSize(Vec, PetscInt, PetscInt); 363 PETSC_EXTERN PetscErrorCode VecStashView(Vec, PetscViewer); 364 PETSC_EXTERN PetscErrorCode VecStashViewFromOptions(Vec, PetscObject, const char[]); 365 PETSC_EXTERN PetscErrorCode VecStashGetInfo(Vec, PetscInt *, PetscInt *, PetscInt *, PetscInt *); 366 367 PETSC_EXTERN PetscErrorCode VecSetPreallocationCOO(Vec, PetscCount, const PetscInt[]); 368 PETSC_EXTERN PetscErrorCode VecSetPreallocationCOOLocal(Vec, PetscCount, PetscInt[]); 369 PETSC_EXTERN PetscErrorCode VecSetValuesCOO(Vec, const PetscScalar[], InsertMode); 370 371 /*MC 372 VecSetValue - Set a single entry into a vector. 373 374 Synopsis: 375 #include <petscvec.h> 376 PetscErrorCode VecSetValue(Vec v,PetscInt row,PetscScalar value, InsertMode mode); 377 378 Not Collective 379 380 Input Parameters: 381 + v - the vector 382 . row - the row location of the entry 383 . value - the value to insert 384 - mode - either `INSERT_VALUES` or `ADD_VALUES` 385 386 Level: beginner 387 388 Notes: 389 For efficiency one should use `VecSetValues()` and set several or 390 many values simultaneously if possible. 391 392 These values may be cached, so `VecAssemblyBegin()` and `VecAssemblyEnd()` 393 MUST be called after all calls to `VecSetValue()` have been completed. 394 395 `VecSetValue()` uses 0-based indices in Fortran as well as in C. 396 397 .seealso: [](ch_vectors), `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `VecSetValuesBlockedLocal()`, `VecSetValueLocal()` 398 M*/ 399 static inline PetscErrorCode VecSetValue(Vec v, PetscInt i, PetscScalar va, InsertMode mode) 400 { 401 return VecSetValues(v, 1, &i, &va, mode); 402 } 403 404 PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec, PetscInt); 405 PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec, PetscInt *); 406 PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode); 407 408 /* Dynamic creation and loading functions */ 409 PETSC_EXTERN PetscFunctionList VecList; 410 PETSC_EXTERN PetscErrorCode VecSetType(Vec, VecType); 411 PETSC_EXTERN PetscErrorCode VecGetType(Vec, VecType *); 412 PETSC_EXTERN PetscErrorCode VecRegister(const char[], PetscErrorCode (*)(Vec)); 413 PETSC_EXTERN PetscErrorCode VecRegisterAll(void); 414 415 PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter, Vec, Vec, InsertMode, ScatterMode); 416 PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter, Vec, Vec, InsertMode, ScatterMode); 417 PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter *); 418 PETSC_EXTERN PetscErrorCode VecScatterSetUp(VecScatter); 419 PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter, VecScatter *); 420 PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter, PetscViewer); 421 PETSC_EXTERN PetscErrorCode VecScatterViewFromOptions(VecScatter, PetscObject, const char[]); 422 PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter, PetscInt[], PetscInt[]); 423 PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter, PetscBool *); 424 425 PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]); 426 PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]); 427 PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]); 428 PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]); 429 PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]); 430 PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]); 431 PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec, PetscInt, PetscInt, PetscScalar *[]); 432 PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec, PetscInt, PetscInt, PetscScalar *[]); 433 434 PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]); 435 PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]); 436 PETSC_EXTERN PetscErrorCode VecRestoreArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]); 437 PETSC_EXTERN PetscErrorCode VecGetArray3dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]); 438 PETSC_EXTERN PetscErrorCode VecRestoreArray3dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]); 439 PETSC_EXTERN PetscErrorCode VecGetArray2dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]); 440 PETSC_EXTERN PetscErrorCode VecRestoreArray2dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]); 441 PETSC_EXTERN PetscErrorCode VecGetArray1dWrite(Vec, PetscInt, PetscInt, PetscScalar *[]); 442 PETSC_EXTERN PetscErrorCode VecRestoreArray1dWrite(Vec, PetscInt, PetscInt, PetscScalar *[]); 443 444 PETSC_EXTERN PetscErrorCode VecGetArray4dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]); 445 PETSC_EXTERN PetscErrorCode VecRestoreArray4dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]); 446 PETSC_EXTERN PetscErrorCode VecGetArray3dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]); 447 PETSC_EXTERN PetscErrorCode VecRestoreArray3dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]); 448 PETSC_EXTERN PetscErrorCode VecGetArray2dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]); 449 PETSC_EXTERN PetscErrorCode VecRestoreArray2dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]); 450 PETSC_EXTERN PetscErrorCode VecGetArray1dRead(Vec, PetscInt, PetscInt, PetscScalar *[]); 451 PETSC_EXTERN PetscErrorCode VecRestoreArray1dRead(Vec, PetscInt, PetscInt, PetscScalar *[]); 452 453 PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec, const PetscScalar[]); 454 PETSC_EXTERN PetscErrorCode VecResetArray(Vec); 455 PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec, const PetscScalar[]); 456 457 PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[], PetscInt, PetscScalar **[]); 458 PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[], PetscInt, PetscScalar **[]); 459 460 PETSC_EXTERN PetscErrorCode VecView(Vec, PetscViewer); 461 PETSC_EXTERN PetscErrorCode VecViewNative(Vec, PetscViewer); 462 PETSC_EXTERN PetscErrorCode VecEqual(Vec, Vec, PetscBool *); 463 PETSC_EXTERN PetscErrorCode VecLoad(Vec, PetscViewer); 464 465 PETSC_EXTERN PetscErrorCode VecGetSize(Vec, PetscInt *); 466 PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec, PetscInt *); 467 PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec, PetscInt *, PetscInt *); 468 PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec, const PetscInt *[]); 469 470 PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping); 471 PETSC_EXTERN PetscErrorCode VecSetValuesLocal(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode); 472 473 PETSC_EXTERN PetscErrorCode VecViennaCLGetCLContext(Vec, PETSC_UINTPTR_T *); 474 PETSC_EXTERN PetscErrorCode VecViennaCLGetCLQueue(Vec, PETSC_UINTPTR_T *); 475 PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemRead(Vec, PETSC_UINTPTR_T *); 476 PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemWrite(Vec, PETSC_UINTPTR_T *); 477 PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMemWrite(Vec); 478 PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMem(Vec, PETSC_UINTPTR_T *); 479 PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMem(Vec); 480 481 /*MC 482 VecSetValueLocal - Set a single entry into a vector using the local numbering, see `VecSetValuesLocal()` 483 484 Synopsis: 485 #include <petscvec.h> 486 PetscErrorCode VecSetValueLocal(Vec v,PetscInt row,PetscScalar value, InsertMode mode); 487 488 Not Collective 489 490 Input Parameters: 491 + v - the vector 492 . row - the row location of the entry 493 . value - the value to insert 494 - mode - either `INSERT_VALUES` or `ADD_VALUES` 495 496 Level: beginner 497 498 Notes: 499 For efficiency one should use `VecSetValuesLocal()` and set several or 500 many values simultaneously if possible. 501 502 These values may be cached, so `VecAssemblyBegin()` and `VecAssemblyEnd()` 503 MUST be called after all calls to `VecSetValueLocal()` have been completed. 504 505 `VecSetValues()` uses 0-based indices in Fortran as well as in C. 506 507 .seealso: [](ch_vectors), `VecSetValuesLocal()`, `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `VecSetValuesBlockedLocal()`, `VecSetValue()` 508 M*/ 509 static inline PetscErrorCode VecSetValueLocal(Vec v, PetscInt i, PetscScalar va, InsertMode mode) 510 { 511 return VecSetValuesLocal(v, 1, &i, &va, mode); 512 } 513 514 /*MC 515 VecCheckAssembled - checks if values have been changed in the vector, by `VecSetValues()` or related routines, but it has not been assembled 516 517 Synopsis: 518 #include <petscvec.h> 519 VecCheckAssembled(Vec v); 520 521 Not Collective 522 523 Input Parameter: 524 . v - the vector to check 525 526 Level: developer 527 528 Note: 529 After calls to `VecSetValues()` and related routines on must call ``VecAssemblyBegin()` and `VecAssemblyEnd()` before using the vector 530 531 .seealso: [](ch_vectors), `Vec`, `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `MatAssemblyBegin()`, `MatAssemblyEnd()` 532 M*/ 533 #define VecCheckAssembled(v) PetscCheck(v->stash.insertmode == NOT_SET_VALUES, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Not for unassembled vector, did you call VecAssemblyBegin()/VecAssemblyEnd()?") 534 535 PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode); 536 PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping *); 537 538 PETSC_EXTERN PetscErrorCode VecDotBegin(Vec, Vec, PetscScalar *); 539 PETSC_EXTERN PetscErrorCode VecDotEnd(Vec, Vec, PetscScalar *); 540 PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec, Vec, PetscScalar *); 541 PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec, Vec, PetscScalar *); 542 PETSC_EXTERN PetscErrorCode VecNormBegin(Vec, NormType, PetscReal *); 543 PETSC_EXTERN PetscErrorCode VecNormEnd(Vec, NormType, PetscReal *); 544 PETSC_EXTERN PetscErrorCode VecErrorWeightedNorms(Vec, Vec, Vec, NormType, PetscReal, Vec, PetscReal, Vec, PetscReal, PetscReal *, PetscInt *, PetscReal *, PetscInt *, PetscReal *, PetscInt *); 545 546 PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec, PetscInt, const Vec[], PetscScalar[]); 547 PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec, PetscInt, const Vec[], PetscScalar[]); 548 PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec, PetscInt, const Vec[], PetscScalar[]); 549 PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec, PetscInt, const Vec[], PetscScalar[]); 550 PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm); 551 552 PETSC_EXTERN PetscErrorCode VecBindToCPU(Vec, PetscBool); 553 PETSC_DEPRECATED_FUNCTION(3, 13, 0, "VecBindToCPU()", ) static inline PetscErrorCode VecPinToCPU(Vec v, PetscBool flg) 554 { 555 return VecBindToCPU(v, flg); 556 } 557 PETSC_EXTERN PetscErrorCode VecBoundToCPU(Vec, PetscBool *); 558 PETSC_EXTERN PetscErrorCode VecSetBindingPropagates(Vec, PetscBool); 559 PETSC_EXTERN PetscErrorCode VecGetBindingPropagates(Vec, PetscBool *); 560 PETSC_EXTERN PetscErrorCode VecSetPinnedMemoryMin(Vec, size_t); 561 PETSC_EXTERN PetscErrorCode VecGetPinnedMemoryMin(Vec, size_t *); 562 563 PETSC_EXTERN PetscErrorCode VecGetOffloadMask(Vec, PetscOffloadMask *); 564 565 typedef enum { 566 VEC_IGNORE_OFF_PROC_ENTRIES, 567 VEC_IGNORE_NEGATIVE_INDICES, 568 VEC_SUBSET_OFF_PROC_ENTRIES 569 } VecOption; 570 PETSC_EXTERN PetscErrorCode VecSetOption(Vec, VecOption, PetscBool); 571 572 PETSC_EXTERN PetscErrorCode VecGetArray(Vec, PetscScalar **); 573 PETSC_EXTERN PetscErrorCode VecGetArrayWrite(Vec, PetscScalar **); 574 PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec, const PetscScalar **); 575 PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec, PetscScalar **); 576 PETSC_EXTERN PetscErrorCode VecRestoreArrayWrite(Vec, PetscScalar **); 577 PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec, const PetscScalar **); 578 PETSC_EXTERN PetscErrorCode VecCreateLocalVector(Vec, Vec *); 579 PETSC_EXTERN PetscErrorCode VecGetLocalVector(Vec, Vec); 580 PETSC_EXTERN PetscErrorCode VecRestoreLocalVector(Vec, Vec); 581 PETSC_EXTERN PetscErrorCode VecGetLocalVectorRead(Vec, Vec); 582 PETSC_EXTERN PetscErrorCode VecRestoreLocalVectorRead(Vec, Vec); 583 PETSC_EXTERN PetscErrorCode VecGetArrayAndMemType(Vec, PetscScalar **, PetscMemType *); 584 PETSC_EXTERN PetscErrorCode VecRestoreArrayAndMemType(Vec, PetscScalar **); 585 PETSC_EXTERN PetscErrorCode VecGetArrayReadAndMemType(Vec, const PetscScalar **, PetscMemType *); 586 PETSC_EXTERN PetscErrorCode VecRestoreArrayReadAndMemType(Vec, const PetscScalar **); 587 PETSC_EXTERN PetscErrorCode VecGetArrayWriteAndMemType(Vec, PetscScalar **, PetscMemType *); 588 PETSC_EXTERN PetscErrorCode VecRestoreArrayWriteAndMemType(Vec, PetscScalar **); 589 590 /*@C 591 VecGetArrayPair - Accesses a pair of pointers for two vectors that may be common. When not common the first pointer is read only 592 593 Logically Collective; No Fortran Support 594 595 Input Parameters: 596 + x - the vector 597 - y - the second vector 598 599 Output Parameters: 600 + xv - location to put pointer to the first array 601 - yv - location to put pointer to the second array 602 603 Level: developer 604 605 .seealso: [](ch_vectors), `VecGetArray()`, `VecGetArrayRead()`, `VecRestoreArrayPair()` 606 @*/ 607 static inline PetscErrorCode VecGetArrayPair(Vec x, Vec y, PetscScalar **xv, PetscScalar **yv) 608 { 609 PetscFunctionBegin; 610 PetscCall(VecGetArray(y, yv)); 611 if (x == y) *xv = *yv; 612 else PetscCall(VecGetArrayRead(x, (const PetscScalar **)xv)); 613 PetscFunctionReturn(PETSC_SUCCESS); 614 } 615 616 /*@C 617 VecRestoreArrayPair - Returns a pair of pointers for two vectors that may be common obtained with `VecGetArrayPair()` 618 619 Logically Collective; No Fortran Support 620 621 Input Parameters: 622 + x - the vector 623 . y - the second vector 624 . xv - location to put pointer to the first array 625 - yv - location to put pointer to the second array 626 627 Level: developer 628 629 .seealso: [](ch_vectors), `VecGetArray()`, `VecGetArrayRead()`, `VecGetArrayPair()` 630 @*/ 631 static inline PetscErrorCode VecRestoreArrayPair(Vec x, Vec y, PetscScalar **xv, PetscScalar **yv) 632 { 633 PetscFunctionBegin; 634 PetscCall(VecRestoreArray(y, yv)); 635 if (x != y) PetscCall(VecRestoreArrayRead(x, (const PetscScalar **)xv)); 636 PetscFunctionReturn(PETSC_SUCCESS); 637 } 638 639 #if PetscDefined(USE_DEBUG) 640 PETSC_EXTERN PetscErrorCode VecLockReadPush(Vec); 641 PETSC_EXTERN PetscErrorCode VecLockReadPop(Vec); 642 PETSC_EXTERN PetscErrorCode VecLockWriteSet(Vec, PetscBool); 643 PETSC_EXTERN PetscErrorCode VecLockGet(Vec, PetscInt *); 644 PETSC_EXTERN PetscErrorCode VecLockGetLocation(Vec, const char *[], const char *[], int *); 645 static inline PetscErrorCode VecSetErrorIfLocked(Vec x, PetscInt arg) 646 { 647 PetscInt state; 648 649 PetscFunctionBegin; 650 PetscCall(VecLockGet(x, &state)); 651 if (PetscUnlikely(state != 0)) { 652 const char *file, *func, *name; 653 int line; 654 655 PetscCall(VecLockGetLocation(x, &file, &func, &line)); 656 PetscCall(PetscObjectGetName((PetscObject)x, &name)); 657 SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Vector '%s' (argument #%" PetscInt_FMT ") was locked for %s access in %s() at %s:%d (line numbers only accurate to function begin)", name, arg, state > 0 ? "read-only" : "write-only", func ? func : "unknown_function", file ? file : "unknown file", line); 658 } 659 PetscFunctionReturn(PETSC_SUCCESS); 660 } 661 /* The three are deprecated */ 662 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 11, 0, "VecLockReadPush()", ) PetscErrorCode VecLockPush(Vec); 663 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 11, 0, "VecLockReadPop()", ) PetscErrorCode VecLockPop(Vec); 664 #define VecLocked(x, arg) VecSetErrorIfLocked(x, arg) PETSC_DEPRECATED_MACRO(3, 11, 0, "VecSetErrorIfLocked()", ) 665 #else 666 #define VecLockReadPush(x) PETSC_SUCCESS 667 #define VecLockReadPop(x) PETSC_SUCCESS 668 #define VecLockGet(x, s) (*(s) = 0, PETSC_SUCCESS) 669 #define VecSetErrorIfLocked(x, arg) PETSC_SUCCESS 670 #define VecLockWriteSet(x, flg) PETSC_SUCCESS 671 /* The three are deprecated */ 672 #define VecLockPush(x) PETSC_SUCCESS 673 #define VecLockPop(x) PETSC_SUCCESS 674 #define VecLocked(x, arg) PETSC_SUCCESS 675 #endif 676 677 /*E 678 VecOperation - Enumeration of overide-able methods in the `Vec` implementation function-table. 679 680 Values: 681 + `VECOP_DUPLICATE` - `VecDuplicate()` 682 . `VECOP_SET` - `VecSet()` 683 . `VECOP_VIEW` - `VecView()` 684 . `VECOP_LOAD` - `VecLoad()` 685 . `VECOP_VIEWNATIVE` - `VecViewNative()` 686 - `VECOP_LOADNATIVE` - `VecLoadNative()` 687 688 Level: advanced 689 690 Notes: 691 Some operations may serve as the implementation for other routines not listed above. For 692 example `VECOP_SET` can be used to simultaneously overriding the implementation used in 693 `VecSet()`, `VecSetInf()`, and `VecZeroEntries()`. 694 695 Entries to `VecOperation` are added as needed so if you do not see the operation listed which 696 you'd like to replace, please send mail to `petsc-maint@mcs.anl.gov`! 697 698 .seealso: [](ch_vectors), `Vec`, `VecSetOperation()` 699 E*/ 700 typedef enum { 701 VECOP_DUPLICATE = 0, 702 VECOP_SET = 10, 703 VECOP_VIEW = 33, 704 VECOP_LOAD = 41, 705 VECOP_VIEWNATIVE = 68, 706 VECOP_LOADNATIVE = 69 707 } VecOperation; 708 PETSC_EXTERN PetscErrorCode VecSetOperation(Vec, VecOperation, void (*)(void)); 709 710 /* 711 Routines for dealing with ghosted vectors: 712 vectors with ghost elements at the end of the array. 713 */ 714 PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec, PetscInt, const PetscInt[]); 715 PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Vec *); 716 PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscScalar[], Vec *); 717 PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Vec *); 718 PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscScalar[], Vec *); 719 PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec, Vec *); 720 PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec, Vec *); 721 PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec, Vec, PetscBool *); 722 PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec, InsertMode, ScatterMode); 723 PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec, InsertMode, ScatterMode); 724 725 PETSC_EXTERN PetscErrorCode VecConjugate(Vec); 726 PETSC_EXTERN PetscErrorCode VecImaginaryPart(Vec); 727 PETSC_EXTERN PetscErrorCode VecRealPart(Vec); 728 729 PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec, VecScatter *, Vec *); 730 PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec, VecScatter *, Vec *); 731 732 PETSC_EXTERN PetscErrorCode ISComplementVec(IS, Vec, IS *); 733 PETSC_EXTERN PetscErrorCode VecPow(Vec, PetscScalar); 734 PETSC_EXTERN PetscErrorCode VecMedian(Vec, Vec, Vec, Vec); 735 PETSC_EXTERN PetscErrorCode VecWhichInactive(Vec, Vec, Vec, Vec, PetscBool, IS *); 736 PETSC_EXTERN PetscErrorCode VecWhichBetween(Vec, Vec, Vec, IS *); 737 PETSC_EXTERN PetscErrorCode VecWhichBetweenOrEqual(Vec, Vec, Vec, IS *); 738 PETSC_EXTERN PetscErrorCode VecWhichGreaterThan(Vec, Vec, IS *); 739 PETSC_EXTERN PetscErrorCode VecWhichLessThan(Vec, Vec, IS *); 740 PETSC_EXTERN PetscErrorCode VecWhichEqual(Vec, Vec, IS *); 741 PETSC_EXTERN PetscErrorCode VecISAXPY(Vec, IS, PetscScalar, Vec); 742 PETSC_EXTERN PetscErrorCode VecISCopy(Vec, IS, ScatterMode, Vec); 743 PETSC_EXTERN PetscErrorCode VecISSet(Vec, IS, PetscScalar); 744 PETSC_EXTERN PetscErrorCode VecBoundGradientProjection(Vec, Vec, Vec, Vec, Vec); 745 PETSC_EXTERN PetscErrorCode VecStepBoundInfo(Vec, Vec, Vec, Vec, PetscReal *, PetscReal *, PetscReal *); 746 PETSC_EXTERN PetscErrorCode VecStepMax(Vec, Vec, PetscReal *); 747 PETSC_EXTERN PetscErrorCode VecStepMaxBounded(Vec, Vec, Vec, Vec, PetscReal *); 748 749 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec); 750 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec); 751 752 /*S 753 Vecs - Collection of vectors where the data for the vectors is stored in 754 one contiguous memory 755 756 Level: advanced 757 758 Notes: 759 Temporary construct for handling multiply right hand side solves 760 761 This is faked by storing a single vector that has enough array space for 762 n vectors 763 764 S*/ 765 struct _n_Vecs { 766 PetscInt n; 767 Vec v; 768 }; 769 typedef struct _n_Vecs *Vecs; 770 PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs); 771 PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm, PetscInt, PetscInt, Vecs *); 772 PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm, PetscInt, PetscInt, PetscScalar *, Vecs *); 773 PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs, Vecs *); 774 775 #if PetscDefined(HAVE_VIENNACL) 776 typedef struct _p_PetscViennaCLIndices *PetscViennaCLIndices; 777 PETSC_EXTERN PetscErrorCode VecViennaCLCopyToGPUSome_Public(Vec, PetscViennaCLIndices); 778 PETSC_EXTERN PetscErrorCode VecViennaCLCopyFromGPUSome_Public(Vec, PetscViennaCLIndices); 779 PETSC_EXTERN PetscErrorCode VecCreateSeqViennaCL(MPI_Comm, PetscInt, Vec *); 780 PETSC_EXTERN PetscErrorCode VecCreateMPIViennaCL(MPI_Comm, PetscInt, PetscInt, Vec *); 781 #endif 782 #if PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP) 783 PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter, Vec); 784 PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter); 785 #endif 786 #if PetscDefined(HAVE_KOKKOS_KERNELS) 787 PETSC_EXTERN PetscErrorCode VecCreateSeqKokkos(MPI_Comm, PetscInt, Vec *); 788 PETSC_EXTERN PetscErrorCode VecCreateSeqKokkosWithArray(MPI_Comm, PetscInt, PetscInt, const PetscScalar *, Vec *); 789 PETSC_EXTERN PetscErrorCode VecCreateMPIKokkos(MPI_Comm, PetscInt, PetscInt, Vec *); 790 PETSC_EXTERN PetscErrorCode VecCreateMPIKokkosWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar *, Vec *); 791 #endif 792 793 PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec, PetscInt *, Vec **); 794 PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec, PetscInt, Vec *); 795 PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec, PetscInt, PetscInt *, Vec *); 796 PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec, PetscInt, Vec); 797 PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm, PetscInt, IS *, Vec *, Vec *); 798 PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec, PetscInt *); 799 800 PETSC_EXTERN PetscErrorCode PetscOptionsGetVec(PetscOptions, const char[], const char[], Vec, PetscBool *); 801 PETSC_EXTERN PetscErrorCode VecFilter(Vec, PetscReal); 802 PETSC_DEPRECATED_FUNCTION(3, 20, 0, "VecFilter()", ) static inline PetscErrorCode VecChop(Vec v, PetscReal tol) 803 { 804 return VecFilter(v, tol); 805 } 806 807 PETSC_EXTERN PetscErrorCode VecGetLayout(Vec, PetscLayout *); 808 PETSC_EXTERN PetscErrorCode VecSetLayout(Vec, PetscLayout); 809 810 PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer); 811 PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar **); 812 PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, const PetscScalar[], InsertMode); 813 PETSC_EXTERN PetscErrorCode PetscSectionVecNorm(PetscSection, PetscSection, Vec, NormType, PetscReal[]); 814 815 /*S 816 VecTagger - Object used to manage the tagging of a subset of indices based on the values of a vector. The 817 motivating application is the selection of cells for refinement or coarsening based on vector containing 818 the values in an error indicator metric. 819 820 Values: 821 + `VECTAGGERABSOLUTE` - "absolute" values are in a interval (box for complex values) of explicitly defined values 822 . `VECTAGGERRELATIVE` - "relative" values are in a interval (box for complex values) of values relative to the set of all values in the vector 823 . `VECTAGGERCDF` - "cdf" values are in a relative range of the *cumulative distribution* of values in the vector 824 . `VECTAGGEROR` - "or" values are in the union of other tags 825 - `VECTAGGERAND` - "and" values are in the intersection of other tags 826 827 Level: advanced 828 829 Developer Note: 830 Why not use a `DMLabel` or similar object 831 832 .seealso: [](ch_vectors), `Vec`, `VecTaggerType`, `VecTaggerCreate()` 833 S*/ 834 typedef struct _p_VecTagger *VecTagger; 835 836 /*J 837 VecTaggerType - String with the name of a `VecTagger` type 838 839 Level: advanced 840 841 .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerCreate()` 842 J*/ 843 typedef const char *VecTaggerType; 844 #define VECTAGGERABSOLUTE "absolute" 845 #define VECTAGGERRELATIVE "relative" 846 #define VECTAGGERCDF "cdf" 847 #define VECTAGGEROR "or" 848 #define VECTAGGERAND "and" 849 850 PETSC_EXTERN PetscClassId VEC_TAGGER_CLASSID; 851 PETSC_EXTERN PetscFunctionList VecTaggerList; 852 PETSC_EXTERN PetscErrorCode VecTaggerRegister(const char[], PetscErrorCode (*)(VecTagger)); 853 PETSC_EXTERN PetscErrorCode VecTaggerRegisterAll(void); 854 855 PETSC_EXTERN PetscErrorCode VecTaggerCreate(MPI_Comm, VecTagger *); 856 PETSC_EXTERN PetscErrorCode VecTaggerSetBlockSize(VecTagger, PetscInt); 857 PETSC_EXTERN PetscErrorCode VecTaggerGetBlockSize(VecTagger, PetscInt *); 858 PETSC_EXTERN PetscErrorCode VecTaggerSetType(VecTagger, VecTaggerType); 859 PETSC_EXTERN PetscErrorCode VecTaggerGetType(VecTagger, VecTaggerType *); 860 PETSC_EXTERN PetscErrorCode VecTaggerSetInvert(VecTagger, PetscBool); 861 PETSC_EXTERN PetscErrorCode VecTaggerGetInvert(VecTagger, PetscBool *); 862 PETSC_EXTERN PetscErrorCode VecTaggerSetFromOptions(VecTagger); 863 PETSC_EXTERN PetscErrorCode VecTaggerSetUp(VecTagger); 864 PETSC_EXTERN PetscErrorCode VecTaggerView(VecTagger, PetscViewer); 865 PETSC_EXTERN PetscErrorCode VecTaggerComputeIS(VecTagger, Vec, IS *, PetscBool *); 866 PETSC_EXTERN PetscErrorCode VecTaggerDestroy(VecTagger *); 867 868 /*S 869 VecTaggerBox - A interval (box for complex numbers) range used to tag values. For real scalars, this is just a closed interval; for complex scalars, 870 the box is the closed region in the complex plane such that real(min) <= real(z) <= real(max) and imag(min) <= imag(z) <= imag(max). `INF` is an acceptable endpoint. 871 872 Level: beginner 873 874 .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerType`, `VecTaggerCreate()`, `VecTaggerComputeIntervals()` 875 S*/ 876 typedef struct { 877 PetscScalar min; 878 PetscScalar max; 879 } VecTaggerBox; 880 PETSC_EXTERN PetscErrorCode VecTaggerComputeBoxes(VecTagger, Vec, PetscInt *, VecTaggerBox **, PetscBool *); 881 882 PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteSetBox(VecTagger, VecTaggerBox *); 883 PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteGetBox(VecTagger, const VecTaggerBox **); 884 885 PETSC_EXTERN PetscErrorCode VecTaggerRelativeSetBox(VecTagger, VecTaggerBox *); 886 PETSC_EXTERN PetscErrorCode VecTaggerRelativeGetBox(VecTagger, const VecTaggerBox **); 887 888 PETSC_EXTERN PetscErrorCode VecTaggerCDFSetBox(VecTagger, VecTaggerBox *); 889 PETSC_EXTERN PetscErrorCode VecTaggerCDFGetBox(VecTagger, const VecTaggerBox **); 890 891 /*E 892 VecTaggerCDFMethod - Determines what method is used to compute absolute values from cumulative distribution values (e.g., what value is the preimage of .95 in the cdf). 893 894 Values: 895 + `VECTAGGER_CDF_GATHER` - gather results to rank 0, perform the computation and broadcast the result 896 - `VECTAGGER_CDF_ITERATIVE` - compute the results on all ranks iteratively using `MPI_Allreduce()` 897 898 Level: advanced 899 900 Note: 901 Relevant only in parallel: in serial it is directly computed. 902 903 .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerType`, `VecTaggerCreate()`, `VecTaggerCDFSetMethod()`, `VecTaggerCDFMethods` 904 E*/ 905 typedef enum { 906 VECTAGGER_CDF_GATHER, 907 VECTAGGER_CDF_ITERATIVE, 908 VECTAGGER_CDF_NUM_METHODS 909 } VecTaggerCDFMethod; 910 PETSC_EXTERN const char *const VecTaggerCDFMethods[]; 911 912 PETSC_EXTERN PetscErrorCode VecTaggerCDFSetMethod(VecTagger, VecTaggerCDFMethod); 913 PETSC_EXTERN PetscErrorCode VecTaggerCDFGetMethod(VecTagger, VecTaggerCDFMethod *); 914 PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeSetTolerances(VecTagger, PetscInt, PetscReal, PetscReal); 915 PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeGetTolerances(VecTagger, PetscInt *, PetscReal *, PetscReal *); 916 917 PETSC_EXTERN PetscErrorCode VecTaggerOrSetSubs(VecTagger, PetscInt, VecTagger *, PetscCopyMode); 918 PETSC_EXTERN PetscErrorCode VecTaggerOrGetSubs(VecTagger, PetscInt *, VecTagger **); 919 920 PETSC_EXTERN PetscErrorCode VecTaggerAndSetSubs(VecTagger, PetscInt, VecTagger *, PetscCopyMode); 921 PETSC_EXTERN PetscErrorCode VecTaggerAndGetSubs(VecTagger, PetscInt *, VecTagger **); 922 923 PETSC_EXTERN PetscErrorCode VecTaggerInitializePackage(void); 924 PETSC_EXTERN PetscErrorCode VecTaggerFinalizePackage(void); 925 926 #if PetscDefined(USE_DEBUG) 927 /* This is an internal debug-only routine that should not be used by users */ 928 PETSC_SINGLE_LIBRARY_INTERN PetscErrorCode VecValidValues_Internal(Vec, PetscInt, PetscBool); 929 #else 930 #define VecValidValues_Internal(...) PETSC_SUCCESS 931 #endif /* PETSC_USE_DEBUG */ 932 933 #define VEC_CUPM_NOT_CONFIGURED(impl) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP_SYS, "Must configure PETSc with " PetscStringize(impl) " support to use %s", PETSC_FUNCTION_NAME) 934 935 #if PetscDefined(HAVE_CUDA) 936 #define VEC_CUDA_DECL_OR_STUB(__decl__, ...) PETSC_EXTERN __decl__; 937 #else 938 #define VEC_CUDA_DECL_OR_STUB(__decl__, ...) \ 939 static inline __decl__ \ 940 { \ 941 __VA_ARGS__; \ 942 VEC_CUPM_NOT_CONFIGURED(cuda); \ 943 } 944 #endif /* PETSC_HAVE_CUDA */ 945 946 /* extra underscore here to make it line up with the cuda versions */ 947 #if PetscDefined(HAVE_HIP) 948 #define VEC_HIP__DECL_OR_STUB(__decl__, ...) PETSC_EXTERN __decl__; 949 #else 950 #define VEC_HIP__DECL_OR_STUB(__decl__, ...) \ 951 static inline __decl__ \ 952 { \ 953 __VA_ARGS__; \ 954 VEC_CUPM_NOT_CONFIGURED(hip); \ 955 } 956 #endif /* PETSC_HAVE_HIP */ 957 958 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateSeqCUDA(MPI_Comm a, PetscInt b, Vec *c), (void)a, (void)b, (void)c) 959 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateSeqHIP(MPI_Comm a, PetscInt b, Vec *c), (void)a, (void)b, (void)c) 960 961 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateSeqCUDAWithArray(MPI_Comm a, PetscInt b, PetscInt c, const PetscScalar *d, Vec *e), (void)a, (void)b, (void)c, (void)d, (void)e) 962 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateSeqHIPWithArray(MPI_Comm a, PetscInt b, PetscInt c, const PetscScalar *d, Vec *e), (void)a, (void)b, (void)c, (void)d, (void)e) 963 964 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateSeqCUDAWithArrays(MPI_Comm a, PetscInt b, PetscInt c, const PetscScalar *d, const PetscScalar *e, Vec *f), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f) 965 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateSeqHIPWithArrays(MPI_Comm a, PetscInt b, PetscInt c, const PetscScalar *d, const PetscScalar *e, Vec *f), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f) 966 967 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateMPICUDA(MPI_Comm a, PetscInt b, PetscInt c, Vec *d), (void)a, (void)b, (void)c, (void)d) 968 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateMPIHIP(MPI_Comm a, PetscInt b, PetscInt c, Vec *d), (void)a, (void)b, (void)c, (void)d) 969 970 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateMPICUDAWithArray(MPI_Comm a, PetscInt b, PetscInt c, PetscInt d, const PetscScalar *e, Vec *f), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f) 971 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateMPIHIPWithArray(MPI_Comm a, PetscInt b, PetscInt c, PetscInt d, const PetscScalar *e, Vec *f), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f) 972 973 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateMPICUDAWithArrays(MPI_Comm a, PetscInt b, PetscInt c, PetscInt d, const PetscScalar *e, const PetscScalar *f, Vec *g), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f, (void)g) 974 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateMPIHIPWithArrays(MPI_Comm a, PetscInt b, PetscInt c, PetscInt d, const PetscScalar *e, const PetscScalar *f, Vec *g), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f, (void)g) 975 976 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArray(Vec a, PetscScalar **b), (void)a, (void)b) 977 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArray(Vec a, PetscScalar **b), (void)a, (void)b) 978 979 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArray(Vec a, PetscScalar **b), (void)a, (void)b) 980 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArray(Vec a, PetscScalar **b), (void)a, (void)b) 981 982 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArrayRead(Vec a, const PetscScalar **b), (void)a, (void)b) 983 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArrayRead(Vec a, const PetscScalar **b), (void)a, (void)b) 984 985 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArrayRead(Vec a, const PetscScalar **b), (void)a, (void)b) 986 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArrayRead(Vec a, const PetscScalar **b), (void)a, (void)b) 987 988 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArrayWrite(Vec a, PetscScalar **b), (void)a, (void)b) 989 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArrayWrite(Vec a, PetscScalar **b), (void)a, (void)b) 990 991 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArrayWrite(Vec a, PetscScalar **b), (void)a, (void)b) 992 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArrayWrite(Vec a, PetscScalar **b), (void)a, (void)b) 993 994 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAPlaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b) 995 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPPlaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b) 996 997 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAReplaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b) 998 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPReplaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b) 999 1000 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAResetArray(Vec a), (void)a) 1001 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPResetArray(Vec a), (void)a) 1002 1003 #undef VEC_CUPM_NOT_CONFIGURED 1004 #undef VEC_CUDA_DECL_OR_STUB 1005 #undef VEC_HIP__DECL_OR_STUB 1006 1007 #endif 1008