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