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