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