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