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