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