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 VecCreateSeq(MPI_Comm, PetscInt, Vec *); 131 PETSC_EXTERN PetscErrorCode VecCreateMPI(MPI_Comm, PetscInt, PetscInt, Vec *); 132 PETSC_EXTERN PetscErrorCode VecCreateSeqWithArray(MPI_Comm, PetscInt, PetscInt, const PetscScalar[], Vec *); 133 PETSC_EXTERN PetscErrorCode VecCreateMPIWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar[], Vec *); 134 PETSC_EXTERN PetscErrorCode VecCreateShared(MPI_Comm, PetscInt, PetscInt, Vec *); 135 PETSC_EXTERN PetscErrorCode VecCreateNode(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 VecAYPX(Vec, PetscScalar, Vec); 317 PETSC_EXTERN PetscErrorCode VecWAXPY(Vec, PetscScalar, Vec, Vec); 318 PETSC_EXTERN PetscErrorCode VecAXPBYPCZ(Vec, PetscScalar, PetscScalar, PetscScalar, Vec, Vec); 319 PETSC_EXTERN PetscErrorCode VecPointwiseMax(Vec, Vec, Vec); 320 PETSC_EXTERN PetscErrorCode VecPointwiseMaxAbs(Vec, Vec, Vec); 321 PETSC_EXTERN PetscErrorCode VecPointwiseMin(Vec, Vec, Vec); 322 PETSC_EXTERN PetscErrorCode VecPointwiseMult(Vec, Vec, Vec); 323 PETSC_EXTERN PetscErrorCode VecPointwiseDivide(Vec, Vec, Vec); 324 PETSC_EXTERN PetscErrorCode VecMaxPointwiseDivide(Vec, Vec, PetscReal *); 325 PETSC_EXTERN PetscErrorCode VecShift(Vec, PetscScalar); 326 PETSC_EXTERN PetscErrorCode VecReciprocal(Vec); 327 PETSC_EXTERN PetscErrorCode VecPermute(Vec, IS, PetscBool); 328 PETSC_EXTERN PetscErrorCode VecSqrtAbs(Vec); 329 PETSC_EXTERN PetscErrorCode VecLog(Vec); 330 PETSC_EXTERN PetscErrorCode VecExp(Vec); 331 PETSC_EXTERN PetscErrorCode VecAbs(Vec); 332 PETSC_EXTERN PetscErrorCode VecDuplicate(Vec, Vec *); 333 PETSC_EXTERN PetscErrorCode VecDuplicateVecs(Vec, PetscInt, Vec *[]); 334 PETSC_EXTERN PetscErrorCode VecDestroyVecs(PetscInt, Vec *[]); 335 PETSC_EXTERN PetscErrorCode VecStrideNormAll(Vec, NormType, PetscReal[]); 336 PETSC_EXTERN PetscErrorCode VecStrideMaxAll(Vec, PetscInt[], PetscReal[]); 337 PETSC_EXTERN PetscErrorCode VecStrideMinAll(Vec, PetscInt[], PetscReal[]); 338 PETSC_EXTERN PetscErrorCode VecStrideScaleAll(Vec, const PetscScalar[]); 339 PETSC_EXTERN PetscErrorCode VecStrideSumAll(Vec, PetscScalar *); 340 PETSC_EXTERN PetscErrorCode VecUniqueEntries(Vec, PetscInt *, PetscScalar **); 341 342 PETSC_EXTERN PetscErrorCode VecStrideNorm(Vec, PetscInt, NormType, PetscReal *); 343 PETSC_EXTERN PetscErrorCode VecStrideMax(Vec, PetscInt, PetscInt *, PetscReal *); 344 PETSC_EXTERN PetscErrorCode VecStrideMin(Vec, PetscInt, PetscInt *, PetscReal *); 345 PETSC_EXTERN PetscErrorCode VecStrideScale(Vec, PetscInt, PetscScalar); 346 PETSC_EXTERN PetscErrorCode VecStrideSum(Vec, PetscInt, PetscScalar *); 347 PETSC_EXTERN PetscErrorCode VecStrideSet(Vec, PetscInt, PetscScalar); 348 349 PETSC_EXTERN PetscErrorCode VecStrideGather(Vec, PetscInt, Vec, InsertMode); 350 PETSC_EXTERN PetscErrorCode VecStrideScatter(Vec, PetscInt, Vec, InsertMode); 351 PETSC_EXTERN PetscErrorCode VecStrideGatherAll(Vec, Vec[], InsertMode); 352 PETSC_EXTERN PetscErrorCode VecStrideScatterAll(Vec[], Vec, InsertMode); 353 354 PETSC_EXTERN PetscErrorCode VecStrideSubSetScatter(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode); 355 PETSC_EXTERN PetscErrorCode VecStrideSubSetGather(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode); 356 357 PETSC_EXTERN PetscErrorCode VecSetValues(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode); 358 PETSC_EXTERN PetscErrorCode VecGetValues(Vec, PetscInt, const PetscInt[], PetscScalar[]); 359 PETSC_EXTERN PetscErrorCode VecAssemblyBegin(Vec); 360 PETSC_EXTERN PetscErrorCode VecAssemblyEnd(Vec); 361 PETSC_EXTERN PetscErrorCode VecStashSetInitialSize(Vec, PetscInt, PetscInt); 362 PETSC_EXTERN PetscErrorCode VecStashView(Vec, PetscViewer); 363 PETSC_EXTERN PetscErrorCode VecStashViewFromOptions(Vec, PetscObject, const char[]); 364 PETSC_EXTERN PetscErrorCode VecStashGetInfo(Vec, PetscInt *, PetscInt *, PetscInt *, PetscInt *); 365 366 PETSC_EXTERN PetscErrorCode VecSetPreallocationCOO(Vec, PetscCount, const PetscInt[]); 367 PETSC_EXTERN PetscErrorCode VecSetPreallocationCOOLocal(Vec, PetscCount, PetscInt[]); 368 PETSC_EXTERN PetscErrorCode VecSetValuesCOO(Vec, const PetscScalar[], InsertMode); 369 370 /*MC 371 VecSetValue - Set a single entry into a vector. 372 373 Synopsis: 374 #include <petscvec.h> 375 PetscErrorCode VecSetValue(Vec v,PetscInt row,PetscScalar value, InsertMode mode); 376 377 Not Collective 378 379 Input Parameters: 380 + v - the vector 381 . row - the row location of the entry 382 . value - the value to insert 383 - mode - either `INSERT_VALUES` or `ADD_VALUES` 384 385 Level: beginner 386 387 Notes: 388 For efficiency one should use `VecSetValues()` and set several or 389 many values simultaneously if possible. 390 391 These values may be cached, so `VecAssemblyBegin()` and `VecAssemblyEnd()` 392 MUST be called after all calls to `VecSetValue()` have been completed. 393 394 `VecSetValue()` uses 0-based indices in Fortran as well as in C. 395 396 .seealso: [](ch_vectors), `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `VecSetValuesBlockedLocal()`, `VecSetValueLocal()` 397 M*/ 398 static inline PetscErrorCode VecSetValue(Vec v, PetscInt i, PetscScalar va, InsertMode mode) 399 { 400 return VecSetValues(v, 1, &i, &va, mode); 401 } 402 403 PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec, PetscInt); 404 PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec, PetscInt *); 405 PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode); 406 407 /* Dynamic creation and loading functions */ 408 PETSC_EXTERN PetscFunctionList VecList; 409 PETSC_EXTERN PetscErrorCode VecSetType(Vec, VecType); 410 PETSC_EXTERN PetscErrorCode VecGetType(Vec, VecType *); 411 PETSC_EXTERN PetscErrorCode VecRegister(const char[], PetscErrorCode (*)(Vec)); 412 413 PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter, Vec, Vec, InsertMode, ScatterMode); 414 PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter, Vec, Vec, InsertMode, ScatterMode); 415 PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter *); 416 PETSC_EXTERN PetscErrorCode VecScatterSetUp(VecScatter); 417 PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter, VecScatter *); 418 PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter, PetscViewer); 419 PETSC_EXTERN PetscErrorCode VecScatterViewFromOptions(VecScatter, PetscObject, const char[]); 420 PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter, PetscInt[], PetscInt[]); 421 PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter, PetscBool *); 422 423 PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]); 424 PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]); 425 PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]); 426 PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]); 427 PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]); 428 PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]); 429 PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec, PetscInt, PetscInt, PetscScalar *[]); 430 PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec, PetscInt, PetscInt, PetscScalar *[]); 431 432 PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]); 433 PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]); 434 PETSC_EXTERN PetscErrorCode VecRestoreArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]); 435 PETSC_EXTERN PetscErrorCode VecGetArray3dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]); 436 PETSC_EXTERN PetscErrorCode VecRestoreArray3dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]); 437 PETSC_EXTERN PetscErrorCode VecGetArray2dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]); 438 PETSC_EXTERN PetscErrorCode VecRestoreArray2dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]); 439 PETSC_EXTERN PetscErrorCode VecGetArray1dWrite(Vec, PetscInt, PetscInt, PetscScalar *[]); 440 PETSC_EXTERN PetscErrorCode VecRestoreArray1dWrite(Vec, PetscInt, PetscInt, PetscScalar *[]); 441 442 PETSC_EXTERN PetscErrorCode VecGetArray4dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]); 443 PETSC_EXTERN PetscErrorCode VecRestoreArray4dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]); 444 PETSC_EXTERN PetscErrorCode VecGetArray3dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]); 445 PETSC_EXTERN PetscErrorCode VecRestoreArray3dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]); 446 PETSC_EXTERN PetscErrorCode VecGetArray2dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]); 447 PETSC_EXTERN PetscErrorCode VecRestoreArray2dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]); 448 PETSC_EXTERN PetscErrorCode VecGetArray1dRead(Vec, PetscInt, PetscInt, PetscScalar *[]); 449 PETSC_EXTERN PetscErrorCode VecRestoreArray1dRead(Vec, PetscInt, PetscInt, PetscScalar *[]); 450 451 PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec, const PetscScalar[]); 452 PETSC_EXTERN PetscErrorCode VecResetArray(Vec); 453 PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec, const PetscScalar[]); 454 455 PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[], PetscInt, PetscScalar **[]); 456 PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[], PetscInt, PetscScalar **[]); 457 458 PETSC_EXTERN PetscErrorCode VecView(Vec, PetscViewer); 459 PETSC_EXTERN PetscErrorCode VecViewNative(Vec, PetscViewer); 460 PETSC_EXTERN PetscErrorCode VecEqual(Vec, Vec, PetscBool *); 461 PETSC_EXTERN PetscErrorCode VecLoad(Vec, PetscViewer); 462 463 PETSC_EXTERN PetscErrorCode VecGetSize(Vec, PetscInt *); 464 PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec, PetscInt *); 465 PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec, PetscInt *, PetscInt *); 466 PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec, const PetscInt *[]); 467 468 PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping); 469 PETSC_EXTERN PetscErrorCode VecSetValuesLocal(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode); 470 471 PETSC_EXTERN PetscErrorCode VecViennaCLGetCLContext(Vec, PETSC_UINTPTR_T *); 472 PETSC_EXTERN PetscErrorCode VecViennaCLGetCLQueue(Vec, PETSC_UINTPTR_T *); 473 PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemRead(Vec, PETSC_UINTPTR_T *); 474 PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemWrite(Vec, PETSC_UINTPTR_T *); 475 PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMemWrite(Vec); 476 PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMem(Vec, PETSC_UINTPTR_T *); 477 PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMem(Vec); 478 479 /*MC 480 VecSetValueLocal - Set a single entry into a vector using the local numbering, see `VecSetValuesLocal()` 481 482 Synopsis: 483 #include <petscvec.h> 484 PetscErrorCode VecSetValueLocal(Vec v,PetscInt row,PetscScalar value, InsertMode mode); 485 486 Not Collective 487 488 Input Parameters: 489 + v - the vector 490 . row - the row location of the entry 491 . value - the value to insert 492 - mode - either `INSERT_VALUES` or `ADD_VALUES` 493 494 Level: beginner 495 496 Notes: 497 For efficiency one should use `VecSetValuesLocal()` and set several or 498 many values simultaneously if possible. 499 500 These values may be cached, so `VecAssemblyBegin()` and `VecAssemblyEnd()` 501 MUST be called after all calls to `VecSetValueLocal()` have been completed. 502 503 `VecSetValues()` uses 0-based indices in Fortran as well as in C. 504 505 .seealso: [](ch_vectors), `VecSetValuesLocal()`, `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `VecSetValuesBlockedLocal()`, `VecSetValue()` 506 M*/ 507 static inline PetscErrorCode VecSetValueLocal(Vec v, PetscInt i, PetscScalar va, InsertMode mode) 508 { 509 return VecSetValuesLocal(v, 1, &i, &va, mode); 510 } 511 512 /*MC 513 VecCheckAssembled - checks if values have been changed in the vector, by `VecSetValues()` or related routines, but it has not been assembled 514 515 Synopsis: 516 #include <petscvec.h> 517 VecCheckAssembled(Vec v); 518 519 Not Collective 520 521 Input Parameter: 522 . v - the vector to check 523 524 Level: developer 525 526 Note: 527 After calls to `VecSetValues()` and related routines on must call ``VecAssemblyBegin()` and `VecAssemblyEnd()` before using the vector 528 529 .seealso: [](ch_vectors), `Vec`, `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `MatAssemblyBegin()`, `MatAssemblyEnd()` 530 M*/ 531 #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()?"); 532 533 PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode); 534 PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping *); 535 536 PETSC_EXTERN PetscErrorCode VecDotBegin(Vec, Vec, PetscScalar *); 537 PETSC_EXTERN PetscErrorCode VecDotEnd(Vec, Vec, PetscScalar *); 538 PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec, Vec, PetscScalar *); 539 PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec, Vec, PetscScalar *); 540 PETSC_EXTERN PetscErrorCode VecNormBegin(Vec, NormType, PetscReal *); 541 PETSC_EXTERN PetscErrorCode VecNormEnd(Vec, NormType, PetscReal *); 542 PETSC_EXTERN PetscErrorCode VecErrorWeightedNorms(Vec, Vec, Vec, NormType, PetscReal, Vec, PetscReal, Vec, PetscReal, PetscReal *, PetscInt *, PetscReal *, PetscInt *, PetscReal *, PetscInt *); 543 544 PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec, PetscInt, const Vec[], PetscScalar[]); 545 PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec, PetscInt, const Vec[], PetscScalar[]); 546 PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec, PetscInt, const Vec[], PetscScalar[]); 547 PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec, PetscInt, const Vec[], PetscScalar[]); 548 PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm); 549 550 PETSC_EXTERN PetscErrorCode VecBindToCPU(Vec, PetscBool); 551 PETSC_DEPRECATED_FUNCTION("Use VecBindToCPU (since v3.13)") static inline PetscErrorCode VecPinToCPU(Vec v, PetscBool flg) 552 { 553 return VecBindToCPU(v, flg); 554 } 555 PETSC_EXTERN PetscErrorCode VecBoundToCPU(Vec, PetscBool *); 556 PETSC_EXTERN PetscErrorCode VecSetBindingPropagates(Vec, PetscBool); 557 PETSC_EXTERN PetscErrorCode VecGetBindingPropagates(Vec, PetscBool *); 558 PETSC_EXTERN PetscErrorCode VecSetPinnedMemoryMin(Vec, size_t); 559 PETSC_EXTERN PetscErrorCode VecGetPinnedMemoryMin(Vec, size_t *); 560 561 PETSC_EXTERN PetscErrorCode VecGetOffloadMask(Vec, PetscOffloadMask *); 562 563 typedef enum { 564 VEC_IGNORE_OFF_PROC_ENTRIES, 565 VEC_IGNORE_NEGATIVE_INDICES, 566 VEC_SUBSET_OFF_PROC_ENTRIES 567 } VecOption; 568 PETSC_EXTERN PetscErrorCode VecSetOption(Vec, VecOption, PetscBool); 569 570 PETSC_EXTERN PetscErrorCode VecGetArray(Vec, PetscScalar **); 571 PETSC_EXTERN PetscErrorCode VecGetArrayWrite(Vec, PetscScalar **); 572 PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec, const PetscScalar **); 573 PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec, PetscScalar **); 574 PETSC_EXTERN PetscErrorCode VecRestoreArrayWrite(Vec, PetscScalar **); 575 PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec, const PetscScalar **); 576 PETSC_EXTERN PetscErrorCode VecCreateLocalVector(Vec, Vec *); 577 PETSC_EXTERN PetscErrorCode VecGetLocalVector(Vec, Vec); 578 PETSC_EXTERN PetscErrorCode VecRestoreLocalVector(Vec, Vec); 579 PETSC_EXTERN PetscErrorCode VecGetLocalVectorRead(Vec, Vec); 580 PETSC_EXTERN PetscErrorCode VecRestoreLocalVectorRead(Vec, Vec); 581 PETSC_EXTERN PetscErrorCode VecGetArrayAndMemType(Vec, PetscScalar **, PetscMemType *); 582 PETSC_EXTERN PetscErrorCode VecRestoreArrayAndMemType(Vec, PetscScalar **); 583 PETSC_EXTERN PetscErrorCode VecGetArrayReadAndMemType(Vec, const PetscScalar **, PetscMemType *); 584 PETSC_EXTERN PetscErrorCode VecRestoreArrayReadAndMemType(Vec, const PetscScalar **); 585 PETSC_EXTERN PetscErrorCode VecGetArrayWriteAndMemType(Vec, PetscScalar **, PetscMemType *); 586 PETSC_EXTERN PetscErrorCode VecRestoreArrayWriteAndMemType(Vec, PetscScalar **); 587 588 /*@C 589 VecGetArrayPair - Accesses a pair of pointers for two vectors that may be common. When not common the first pointer is read only 590 591 Logically Collective; No Fortran Support 592 593 Input Parameters: 594 + x - the vector 595 - y - the second vector 596 597 Output Parameters: 598 + xv - location to put pointer to the first array 599 - yv - location to put pointer to the second array 600 601 Level: developer 602 603 .seealso: [](ch_vectors), `VecGetArray()`, `VecGetArrayRead()`, `VecRestoreArrayPair()` 604 @*/ 605 static inline PetscErrorCode VecGetArrayPair(Vec x, Vec y, PetscScalar **xv, PetscScalar **yv) 606 { 607 PetscFunctionBegin; 608 PetscCall(VecGetArray(y, yv)); 609 if (x == y) *xv = *yv; 610 else PetscCall(VecGetArrayRead(x, (const PetscScalar **)xv)); 611 PetscFunctionReturn(PETSC_SUCCESS); 612 } 613 614 /*@C 615 VecRestoreArrayPair - Returns a pair of pointers for two vectors that may be common obtained with `VecGetArrayPair()` 616 617 Logically Collective; No Fortran Support 618 619 Input Parameters: 620 + x - the vector 621 . y - the second vector 622 . xv - location to put pointer to the first array 623 - yv - location to put pointer to the second array 624 625 Level: developer 626 627 .seealso: [](ch_vectors), `VecGetArray()`, `VecGetArrayRead()`, `VecGetArrayPair()` 628 @*/ 629 static inline PetscErrorCode VecRestoreArrayPair(Vec x, Vec y, PetscScalar **xv, PetscScalar **yv) 630 { 631 PetscFunctionBegin; 632 PetscCall(VecRestoreArray(y, yv)); 633 if (x != y) PetscCall(VecRestoreArrayRead(x, (const PetscScalar **)xv)); 634 PetscFunctionReturn(PETSC_SUCCESS); 635 } 636 637 #if PetscDefined(USE_DEBUG) 638 PETSC_EXTERN PetscErrorCode VecLockReadPush(Vec); 639 PETSC_EXTERN PetscErrorCode VecLockReadPop(Vec); 640 PETSC_EXTERN PetscErrorCode VecLockWriteSet(Vec, PetscBool); 641 PETSC_EXTERN PetscErrorCode VecLockGet(Vec, PetscInt *); 642 PETSC_EXTERN PetscErrorCode VecLockGetLocation(Vec, const char *[], const char *[], int *); 643 static inline PetscErrorCode VecSetErrorIfLocked(Vec x, PetscInt arg) 644 { 645 PetscInt state; 646 647 PetscFunctionBegin; 648 PetscCall(VecLockGet(x, &state)); 649 if (PetscUnlikely(state != 0)) { 650 const char *file, *func, *name; 651 int line; 652 653 PetscCall(VecLockGetLocation(x, &file, &func, &line)); 654 PetscCall(PetscObjectGetName((PetscObject)x, &name)); 655 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); 656 } 657 PetscFunctionReturn(PETSC_SUCCESS); 658 } 659 /* The three are deprecated */ 660 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use VecLockReadPush() (since version 3.11)") PetscErrorCode VecLockPush(Vec); 661 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use VecLockReadPop() (since version 3.11)") PetscErrorCode VecLockPop(Vec); 662 #define VecLocked(x, arg) VecSetErrorIfLocked(x, arg) PETSC_DEPRECATED_MACRO("GCC warning \"Use VecSetErrorIfLocked() (since version 3.11)\"") 663 #else 664 #define VecLockReadPush(x) PETSC_SUCCESS 665 #define VecLockReadPop(x) PETSC_SUCCESS 666 #define VecLockGet(x, s) (*(s) = 0, PETSC_SUCCESS) 667 #define VecSetErrorIfLocked(x, arg) PETSC_SUCCESS 668 #define VecLockWriteSet(x, flg) PETSC_SUCCESS 669 /* The three are deprecated */ 670 #define VecLockPush(x) PETSC_SUCCESS 671 #define VecLockPop(x) PETSC_SUCCESS 672 #define VecLocked(x, arg) PETSC_SUCCESS 673 #endif 674 675 /*E 676 VecOperation - Enumeration of overide-able methods in the `Vec` implementation function-table. 677 678 Values: 679 + `VECOP_DUPLICATE` - `VecDuplicate()` 680 . `VECOP_SET` - `VecSet()` 681 . `VECOP_VIEW` - `VecView()` 682 . `VECOP_LOAD` - `VecLoad()` 683 . `VECOP_VIEWNATIVE` - `VecViewNative()` 684 - `VECOP_LOADNATIVE` - `VecLoadNative()` 685 686 Level: advanced 687 688 Notes: 689 Some operations may serve as the implementation for other routines not listed above. For 690 example `VECOP_SET` can be used to simultaneously overriding the implementation used in 691 `VecSet()`, `VecSetInf()`, and `VecZeroEntries()`. 692 693 Entries to `VecOperation` are added as needed so if you do not see the operation listed which 694 you'd like to replace, please send mail to `petsc-maint@mcs.anl.gov`! 695 696 .seealso: [](ch_vectors), `Vec`, `VecSetOperation()` 697 E*/ 698 typedef enum { 699 VECOP_DUPLICATE = 0, 700 VECOP_SET = 10, 701 VECOP_VIEW = 33, 702 VECOP_LOAD = 41, 703 VECOP_VIEWNATIVE = 68, 704 VECOP_LOADNATIVE = 69 705 } VecOperation; 706 PETSC_EXTERN PetscErrorCode VecSetOperation(Vec, VecOperation, void (*)(void)); 707 708 /* 709 Routines for dealing with ghosted vectors: 710 vectors with ghost elements at the end of the array. 711 */ 712 PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec, PetscInt, const PetscInt[]); 713 PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Vec *); 714 PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscScalar[], Vec *); 715 PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Vec *); 716 PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscScalar[], Vec *); 717 PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec, Vec *); 718 PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec, Vec *); 719 PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec, Vec, PetscBool *); 720 PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec, InsertMode, ScatterMode); 721 PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec, InsertMode, ScatterMode); 722 723 PETSC_EXTERN PetscErrorCode VecConjugate(Vec); 724 PETSC_EXTERN PetscErrorCode VecImaginaryPart(Vec); 725 PETSC_EXTERN PetscErrorCode VecRealPart(Vec); 726 727 PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec, VecScatter *, Vec *); 728 PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec, VecScatter *, Vec *); 729 730 PETSC_EXTERN PetscErrorCode ISComplementVec(IS, Vec, IS *); 731 PETSC_EXTERN PetscErrorCode VecPow(Vec, PetscScalar); 732 PETSC_EXTERN PetscErrorCode VecMedian(Vec, Vec, Vec, Vec); 733 PETSC_EXTERN PetscErrorCode VecWhichInactive(Vec, Vec, Vec, Vec, PetscBool, IS *); 734 PETSC_EXTERN PetscErrorCode VecWhichBetween(Vec, Vec, Vec, IS *); 735 PETSC_EXTERN PetscErrorCode VecWhichBetweenOrEqual(Vec, Vec, Vec, IS *); 736 PETSC_EXTERN PetscErrorCode VecWhichGreaterThan(Vec, Vec, IS *); 737 PETSC_EXTERN PetscErrorCode VecWhichLessThan(Vec, Vec, IS *); 738 PETSC_EXTERN PetscErrorCode VecWhichEqual(Vec, Vec, IS *); 739 PETSC_EXTERN PetscErrorCode VecISAXPY(Vec, IS, PetscScalar, Vec); 740 PETSC_EXTERN PetscErrorCode VecISCopy(Vec, IS, ScatterMode, Vec); 741 PETSC_EXTERN PetscErrorCode VecISSet(Vec, IS, PetscScalar); 742 PETSC_EXTERN PetscErrorCode VecBoundGradientProjection(Vec, Vec, Vec, Vec, Vec); 743 PETSC_EXTERN PetscErrorCode VecStepBoundInfo(Vec, Vec, Vec, Vec, PetscReal *, PetscReal *, PetscReal *); 744 PETSC_EXTERN PetscErrorCode VecStepMax(Vec, Vec, PetscReal *); 745 PETSC_EXTERN PetscErrorCode VecStepMaxBounded(Vec, Vec, Vec, Vec, PetscReal *); 746 747 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec); 748 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec); 749 750 /*S 751 Vecs - Collection of vectors where the data for the vectors is stored in 752 one contiguous memory 753 754 Level: advanced 755 756 Notes: 757 Temporary construct for handling multiply right hand side solves 758 759 This is faked by storing a single vector that has enough array space for 760 n vectors 761 762 S*/ 763 struct _n_Vecs { 764 PetscInt n; 765 Vec v; 766 }; 767 typedef struct _n_Vecs *Vecs; 768 PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs); 769 PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm, PetscInt, PetscInt, Vecs *); 770 PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm, PetscInt, PetscInt, PetscScalar *, Vecs *); 771 PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs, Vecs *); 772 773 #if PetscDefined(HAVE_VIENNACL) 774 typedef struct _p_PetscViennaCLIndices *PetscViennaCLIndices; 775 PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesCreate(PetscInt, PetscInt *, PetscInt, PetscInt *, PetscViennaCLIndices *); 776 PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesDestroy(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 VecChop(Vec, PetscReal); 802 803 PETSC_EXTERN PetscErrorCode VecGetLayout(Vec, PetscLayout *); 804 PETSC_EXTERN PetscErrorCode VecSetLayout(Vec, PetscLayout); 805 806 PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer); 807 PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar **); 808 PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, PetscScalar[], InsertMode); 809 PETSC_EXTERN PetscErrorCode PetscSectionVecNorm(PetscSection, PetscSection, Vec, NormType, PetscReal[]); 810 811 /*S 812 VecTagger - Object used to manage the tagging of a subset of indices based on the values of a vector. The 813 motivating application is the selection of cells for refinement or coarsening based on vector containing 814 the values in an error indicator metric. 815 816 Values: 817 + `VECTAGGERABSOLUTE` - "absolute" values are in a interval (box for complex values) of explicitly defined values 818 . `VECTAGGERRELATIVE` - "relative" values are in a interval (box for complex values) of values relative to the set of all values in the vector 819 . `VECTAGGERCDF` - "cdf" values are in a relative range of the *cumulative distribution* of values in the vector 820 . `VECTAGGEROR` - "or" values are in the union of other tags 821 - `VECTAGGERAND` - "and" values are in the intersection of other tags 822 823 Level: advanced 824 825 Developer Note: 826 Why not use a `DMLabel` or similar object 827 828 .seealso: [](ch_vectors), `Vec`, `VecTaggerType`, `VecTaggerCreate()` 829 S*/ 830 typedef struct _p_VecTagger *VecTagger; 831 832 /*J 833 VecTaggerType - String with the name of a `VecTagger` type 834 835 Level: advanced 836 837 .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerCreate()` 838 J*/ 839 typedef const char *VecTaggerType; 840 #define VECTAGGERABSOLUTE "absolute" 841 #define VECTAGGERRELATIVE "relative" 842 #define VECTAGGERCDF "cdf" 843 #define VECTAGGEROR "or" 844 #define VECTAGGERAND "and" 845 846 PETSC_EXTERN PetscClassId VEC_TAGGER_CLASSID; 847 PETSC_EXTERN PetscFunctionList VecTaggerList; 848 PETSC_EXTERN PetscErrorCode VecTaggerRegister(const char[], PetscErrorCode (*)(VecTagger)); 849 850 PETSC_EXTERN PetscErrorCode VecTaggerCreate(MPI_Comm, VecTagger *); 851 PETSC_EXTERN PetscErrorCode VecTaggerSetBlockSize(VecTagger, PetscInt); 852 PETSC_EXTERN PetscErrorCode VecTaggerGetBlockSize(VecTagger, PetscInt *); 853 PETSC_EXTERN PetscErrorCode VecTaggerSetType(VecTagger, VecTaggerType); 854 PETSC_EXTERN PetscErrorCode VecTaggerGetType(VecTagger, VecTaggerType *); 855 PETSC_EXTERN PetscErrorCode VecTaggerSetInvert(VecTagger, PetscBool); 856 PETSC_EXTERN PetscErrorCode VecTaggerGetInvert(VecTagger, PetscBool *); 857 PETSC_EXTERN PetscErrorCode VecTaggerSetFromOptions(VecTagger); 858 PETSC_EXTERN PetscErrorCode VecTaggerSetUp(VecTagger); 859 PETSC_EXTERN PetscErrorCode VecTaggerView(VecTagger, PetscViewer); 860 PETSC_EXTERN PetscErrorCode VecTaggerComputeIS(VecTagger, Vec, IS *, PetscBool *); 861 PETSC_EXTERN PetscErrorCode VecTaggerDestroy(VecTagger *); 862 863 /*S 864 VecTaggerBox - A interval (box for complex numbers) range used to tag values. For real scalars, this is just a closed interval; for complex scalars, 865 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. 866 867 Level: beginner 868 869 .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerType`, `VecTaggerCreate()`, `VecTaggerComputeIntervals()` 870 S*/ 871 typedef struct { 872 PetscScalar min; 873 PetscScalar max; 874 } VecTaggerBox; 875 PETSC_EXTERN PetscErrorCode VecTaggerComputeBoxes(VecTagger, Vec, PetscInt *, VecTaggerBox **, PetscBool *); 876 877 PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteSetBox(VecTagger, VecTaggerBox *); 878 PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteGetBox(VecTagger, const VecTaggerBox **); 879 880 PETSC_EXTERN PetscErrorCode VecTaggerRelativeSetBox(VecTagger, VecTaggerBox *); 881 PETSC_EXTERN PetscErrorCode VecTaggerRelativeGetBox(VecTagger, const VecTaggerBox **); 882 883 PETSC_EXTERN PetscErrorCode VecTaggerCDFSetBox(VecTagger, VecTaggerBox *); 884 PETSC_EXTERN PetscErrorCode VecTaggerCDFGetBox(VecTagger, const VecTaggerBox **); 885 886 /*E 887 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). 888 889 Values: 890 + `VECTAGGER_CDF_GATHER` - gather results to rank 0, perform the computation and broadcast the result 891 - `VECTAGGER_CDF_ITERATIVE` - compute the results on all ranks iteratively using `MPI_Allreduce()` 892 893 Level: advanced 894 895 Note: 896 Relevant only in parallel: in serial it is directly computed. 897 898 .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerType`, `VecTaggerCreate()`, `VecTaggerCDFSetMethod()`, `VecTaggerCDFMethods` 899 E*/ 900 typedef enum { 901 VECTAGGER_CDF_GATHER, 902 VECTAGGER_CDF_ITERATIVE, 903 VECTAGGER_CDF_NUM_METHODS 904 } VecTaggerCDFMethod; 905 PETSC_EXTERN const char *const VecTaggerCDFMethods[]; 906 907 PETSC_EXTERN PetscErrorCode VecTaggerCDFSetMethod(VecTagger, VecTaggerCDFMethod); 908 PETSC_EXTERN PetscErrorCode VecTaggerCDFGetMethod(VecTagger, VecTaggerCDFMethod *); 909 PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeSetTolerances(VecTagger, PetscInt, PetscReal, PetscReal); 910 PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeGetTolerances(VecTagger, PetscInt *, PetscReal *, PetscReal *); 911 912 PETSC_EXTERN PetscErrorCode VecTaggerOrSetSubs(VecTagger, PetscInt, VecTagger *, PetscCopyMode); 913 PETSC_EXTERN PetscErrorCode VecTaggerOrGetSubs(VecTagger, PetscInt *, VecTagger **); 914 915 PETSC_EXTERN PetscErrorCode VecTaggerAndSetSubs(VecTagger, PetscInt, VecTagger *, PetscCopyMode); 916 PETSC_EXTERN PetscErrorCode VecTaggerAndGetSubs(VecTagger, PetscInt *, VecTagger **); 917 918 PETSC_EXTERN PetscErrorCode VecTaggerInitializePackage(void); 919 PETSC_EXTERN PetscErrorCode VecTaggerFinalizePackage(void); 920 921 #if PetscDefined(USE_DEBUG) 922 /* This is an internal debug-only routine that should not be used by users */ 923 PETSC_SINGLE_LIBRARY_INTERN PetscErrorCode VecValidValues_Internal(Vec, PetscInt, PetscBool); 924 #else 925 #define VecValidValues_Internal(...) PETSC_SUCCESS 926 #endif /* PETSC_USE_DEBUG */ 927 928 #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) 929 930 #if PetscDefined(HAVE_CUDA) 931 #define VEC_CUDA_DECL_OR_STUB(__decl__, ...) PETSC_EXTERN __decl__; 932 #else 933 #define VEC_CUDA_DECL_OR_STUB(__decl__, ...) \ 934 static inline __decl__ \ 935 { \ 936 __VA_ARGS__; \ 937 VEC_CUPM_NOT_CONFIGURED(cuda); \ 938 } 939 #endif /* PETSC_HAVE_CUDA */ 940 941 /* extra underscore here to make it line up with the cuda versions */ 942 #if PetscDefined(HAVE_HIP) 943 #define VEC_HIP__DECL_OR_STUB(__decl__, ...) PETSC_EXTERN __decl__; 944 #else 945 #define VEC_HIP__DECL_OR_STUB(__decl__, ...) \ 946 static inline __decl__ \ 947 { \ 948 __VA_ARGS__; \ 949 VEC_CUPM_NOT_CONFIGURED(hip); \ 950 } 951 #endif /* PETSC_HAVE_HIP */ 952 953 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateSeqCUDA(MPI_Comm a, PetscInt b, Vec *c), (void)a, (void)b, (void)c) 954 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateSeqHIP(MPI_Comm a, PetscInt b, Vec *c), (void)a, (void)b, (void)c) 955 956 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) 957 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) 958 959 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) 960 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) 961 962 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateMPICUDA(MPI_Comm a, PetscInt b, PetscInt c, Vec *d), (void)a, (void)b, (void)c, (void)d) 963 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateMPIHIP(MPI_Comm a, PetscInt b, PetscInt c, Vec *d), (void)a, (void)b, (void)c, (void)d) 964 965 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) 966 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) 967 968 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) 969 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) 970 971 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArray(Vec a, PetscScalar **b), (void)a, (void)b) 972 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArray(Vec a, PetscScalar **b), (void)a, (void)b) 973 974 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArray(Vec a, PetscScalar **b), (void)a, (void)b) 975 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArray(Vec a, PetscScalar **b), (void)a, (void)b) 976 977 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArrayRead(Vec a, const PetscScalar **b), (void)a, (void)b) 978 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArrayRead(Vec a, const PetscScalar **b), (void)a, (void)b) 979 980 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArrayRead(Vec a, const PetscScalar **b), (void)a, (void)b) 981 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArrayRead(Vec a, const PetscScalar **b), (void)a, (void)b) 982 983 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArrayWrite(Vec a, PetscScalar **b), (void)a, (void)b) 984 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArrayWrite(Vec a, PetscScalar **b), (void)a, (void)b) 985 986 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArrayWrite(Vec a, PetscScalar **b), (void)a, (void)b) 987 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArrayWrite(Vec a, PetscScalar **b), (void)a, (void)b) 988 989 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAPlaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b) 990 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPPlaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b) 991 992 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAReplaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b) 993 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPReplaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b) 994 995 VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAResetArray(Vec a), (void)a) 996 VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPResetArray(Vec a), (void)a) 997 998 #undef VEC_CUPM_NOT_CONFIGURED 999 #undef VEC_CUDA_DECL_OR_STUB 1000 #undef VEC_HIP__DECL_OR_STUB 1001 1002 #endif 1003