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