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