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 VECSEQCUSP "seqcusp" 101 #define VECMPICUSP "mpicusp" 102 #define VECCUSP "cusp" /* seqcusp on one process and mpicusp on several */ 103 #define VECSEQVIENNACL "seqviennacl" 104 #define VECMPIVIENNACL "mpiviennacl" 105 #define VECVIENNACL "viennacl" /* seqviennacl on one process and mpiviennacl on several */ 106 #define VECSEQCUDA "seqcuda" 107 #define VECMPICUDA "mpicuda" 108 #define VECCUDA "cuda" /* seqcuda on one process and mpicuda on several */ 109 #define VECNEST "nest" 110 #define VECSEQPTHREAD "seqpthread" 111 #define VECMPIPTHREAD "mpipthread" 112 #define VECPTHREAD "pthread" /* seqpthread on one process and mpipthread on several */ 113 114 115 /* Logging support */ 116 #define VEC_FILE_CLASSID 1211214 117 PETSC_EXTERN PetscClassId VEC_CLASSID; 118 PETSC_EXTERN PetscClassId VEC_SCATTER_CLASSID; 119 120 121 PETSC_EXTERN PetscErrorCode VecInitializePackage(void); 122 PETSC_EXTERN PetscErrorCode VecFinalizePackage(void); 123 124 PETSC_EXTERN PetscErrorCode VecCreate(MPI_Comm,Vec*); 125 PETSC_EXTERN PetscErrorCode VecCreateSeq(MPI_Comm,PetscInt,Vec*); 126 PETSC_EXTERN PetscErrorCode VecCreateMPI(MPI_Comm,PetscInt,PetscInt,Vec*); 127 PETSC_EXTERN PetscErrorCode VecCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,const PetscScalar[],Vec*); 128 PETSC_EXTERN PetscErrorCode VecCreateMPIWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar[],Vec*); 129 PETSC_EXTERN PetscErrorCode VecCreateShared(MPI_Comm,PetscInt,PetscInt,Vec*); 130 PETSC_EXTERN PetscErrorCode VecSetFromOptions(Vec); 131 PETSC_STATIC_INLINE PetscErrorCode VecViewFromOptions(Vec A,PetscObject B,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,B,name);} 132 133 PETSC_EXTERN PetscErrorCode VecSetUp(Vec); 134 PETSC_EXTERN PetscErrorCode VecDestroy(Vec*); 135 PETSC_EXTERN PetscErrorCode VecZeroEntries(Vec); 136 PETSC_EXTERN PetscErrorCode VecSetOptionsPrefix(Vec,const char[]); 137 PETSC_EXTERN PetscErrorCode VecAppendOptionsPrefix(Vec,const char[]); 138 PETSC_EXTERN PetscErrorCode VecGetOptionsPrefix(Vec,const char*[]); 139 140 PETSC_EXTERN PetscErrorCode VecSetSizes(Vec,PetscInt,PetscInt); 141 142 PETSC_EXTERN PetscErrorCode VecDotNorm2(Vec,Vec,PetscScalar*,PetscReal*); 143 PETSC_EXTERN PetscErrorCode VecDot(Vec,Vec,PetscScalar*); 144 PETSC_EXTERN PetscErrorCode VecDotRealPart(Vec,Vec,PetscReal*); 145 PETSC_EXTERN PetscErrorCode VecTDot(Vec,Vec,PetscScalar*); 146 PETSC_EXTERN PetscErrorCode VecMDot(Vec,PetscInt,const Vec[],PetscScalar[]); 147 PETSC_EXTERN PetscErrorCode VecMTDot(Vec,PetscInt,const Vec[],PetscScalar[]); 148 PETSC_EXTERN PetscErrorCode VecGetSubVector(Vec,IS,Vec*); 149 PETSC_EXTERN PetscErrorCode VecRestoreSubVector(Vec,IS,Vec*); 150 151 /*E 152 NormType - determines what type of norm to compute 153 154 Level: beginner 155 156 .seealso: VecNorm(), VecNormBegin(), VecNormEnd(), MatNorm() 157 E*/ 158 typedef enum {NORM_1=0,NORM_2=1,NORM_FROBENIUS=2,NORM_INFINITY=3,NORM_1_AND_2=4} NormType; 159 PETSC_EXTERN const char *const NormTypes[]; 160 #define NORM_MAX NORM_INFINITY 161 162 /*MC 163 NORM_1 - the one norm, ||v|| = sum_i | v_i |. ||A|| = max_j || v_*j ||, maximum column sum 164 165 Level: beginner 166 167 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_2, NORM_FROBENIUS, 168 NORM_INFINITY, NORM_1_AND_2 169 170 M*/ 171 172 /*MC 173 NORM_2 - the two norm, ||v|| = sqrt(sum_i (v_i)^2) (vectors only) 174 175 Level: beginner 176 177 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_FROBENIUS, 178 NORM_INFINITY, NORM_1_AND_2 179 180 M*/ 181 182 /*MC 183 NORM_FROBENIUS - ||A|| = sqrt(sum_ij (A_ij)^2), same as NORM_2 for vectors 184 185 Level: beginner 186 187 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2, 188 NORM_INFINITY, NORM_1_AND_2 189 190 M*/ 191 192 /*MC 193 NORM_INFINITY - ||v|| = max_i |v_i|. ||A|| = max_i || v_i* ||, maximum row sum 194 195 Level: beginner 196 197 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2, 198 NORM_FROBINIUS, NORM_1_AND_2 199 200 M*/ 201 202 /*MC 203 NORM_1_AND_2 - computes both the 1 and 2 norm of a vector 204 205 Level: beginner 206 207 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2, 208 NORM_FROBINIUS, NORM_INFINITY 209 210 M*/ 211 212 /*MC 213 NORM_MAX - see NORM_INFINITY 214 215 Level: beginner 216 217 M*/ 218 219 PETSC_EXTERN PetscErrorCode VecNorm(Vec,NormType,PetscReal *); 220 PETSC_EXTERN PetscErrorCode VecNormAvailable(Vec,NormType,PetscBool *,PetscReal *); 221 PETSC_EXTERN PetscErrorCode VecNormalize(Vec,PetscReal *); 222 PETSC_EXTERN PetscErrorCode VecSum(Vec,PetscScalar*); 223 PETSC_EXTERN PetscErrorCode VecMax(Vec,PetscInt*,PetscReal *); 224 PETSC_EXTERN PetscErrorCode VecMin(Vec,PetscInt*,PetscReal *); 225 PETSC_EXTERN PetscErrorCode VecScale(Vec,PetscScalar); 226 PETSC_EXTERN PetscErrorCode VecCopy(Vec,Vec); 227 PETSC_EXTERN PetscErrorCode VecSetRandom(Vec,PetscRandom); 228 PETSC_EXTERN PetscErrorCode VecSet(Vec,PetscScalar); 229 PETSC_EXTERN PetscErrorCode VecSetInf(Vec); 230 PETSC_EXTERN PetscErrorCode VecSwap(Vec,Vec); 231 PETSC_EXTERN PetscErrorCode VecAXPY(Vec,PetscScalar,Vec); 232 PETSC_EXTERN PetscErrorCode VecAXPBY(Vec,PetscScalar,PetscScalar,Vec); 233 PETSC_EXTERN PetscErrorCode VecMAXPY(Vec,PetscInt,const PetscScalar[],Vec[]); 234 PETSC_EXTERN PetscErrorCode VecAYPX(Vec,PetscScalar,Vec); 235 PETSC_EXTERN PetscErrorCode VecWAXPY(Vec,PetscScalar,Vec,Vec); 236 PETSC_EXTERN PetscErrorCode VecAXPBYPCZ(Vec,PetscScalar,PetscScalar,PetscScalar,Vec,Vec); 237 PETSC_EXTERN PetscErrorCode VecPointwiseMax(Vec,Vec,Vec); 238 PETSC_EXTERN PetscErrorCode VecPointwiseMaxAbs(Vec,Vec,Vec); 239 PETSC_EXTERN PetscErrorCode VecPointwiseMin(Vec,Vec,Vec); 240 PETSC_EXTERN PetscErrorCode VecPointwiseMult(Vec,Vec,Vec); 241 PETSC_EXTERN PetscErrorCode VecPointwiseDivide(Vec,Vec,Vec); 242 PETSC_EXTERN PetscErrorCode VecMaxPointwiseDivide(Vec,Vec,PetscReal*); 243 PETSC_EXTERN PetscErrorCode VecShift(Vec,PetscScalar); 244 PETSC_EXTERN PetscErrorCode VecReciprocal(Vec); 245 PETSC_EXTERN PetscErrorCode VecPermute(Vec, IS, PetscBool ); 246 PETSC_EXTERN PetscErrorCode VecSqrtAbs(Vec); 247 PETSC_EXTERN PetscErrorCode VecLog(Vec); 248 PETSC_EXTERN PetscErrorCode VecExp(Vec); 249 PETSC_EXTERN PetscErrorCode VecAbs(Vec); 250 PETSC_EXTERN PetscErrorCode VecDuplicate(Vec,Vec*); 251 PETSC_EXTERN PetscErrorCode VecDuplicateVecs(Vec,PetscInt,Vec*[]); 252 PETSC_EXTERN PetscErrorCode VecDestroyVecs(PetscInt, Vec*[]); 253 PETSC_EXTERN PetscErrorCode VecStrideNormAll(Vec,NormType,PetscReal[]); 254 PETSC_EXTERN PetscErrorCode VecStrideMaxAll(Vec,PetscInt [],PetscReal []); 255 PETSC_EXTERN PetscErrorCode VecStrideMinAll(Vec,PetscInt [],PetscReal []); 256 PETSC_EXTERN PetscErrorCode VecStrideScaleAll(Vec,const PetscScalar[]); 257 PETSC_EXTERN PetscErrorCode VecUniqueEntries(Vec,PetscInt*,PetscScalar**); 258 259 PETSC_EXTERN PetscErrorCode VecStrideNorm(Vec,PetscInt,NormType,PetscReal*); 260 PETSC_EXTERN PetscErrorCode VecStrideMax(Vec,PetscInt,PetscInt *,PetscReal *); 261 PETSC_EXTERN PetscErrorCode VecStrideMin(Vec,PetscInt,PetscInt *,PetscReal *); 262 PETSC_EXTERN PetscErrorCode VecStrideScale(Vec,PetscInt,PetscScalar); 263 PETSC_EXTERN PetscErrorCode VecStrideSet(Vec,PetscInt,PetscScalar); 264 265 266 PETSC_EXTERN PetscErrorCode VecStrideGather(Vec,PetscInt,Vec,InsertMode); 267 PETSC_EXTERN PetscErrorCode VecStrideScatter(Vec,PetscInt,Vec,InsertMode); 268 PETSC_EXTERN PetscErrorCode VecStrideGatherAll(Vec,Vec[],InsertMode); 269 PETSC_EXTERN PetscErrorCode VecStrideScatterAll(Vec[],Vec,InsertMode); 270 271 PETSC_EXTERN PetscErrorCode VecStrideSubSetScatter(Vec,PetscInt,const PetscInt[],const PetscInt[],Vec,InsertMode); 272 PETSC_EXTERN PetscErrorCode VecStrideSubSetGather(Vec,PetscInt,const PetscInt[],const PetscInt[],Vec,InsertMode); 273 274 PETSC_EXTERN PetscErrorCode VecSetValues(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 275 PETSC_EXTERN PetscErrorCode VecGetValues(Vec,PetscInt,const PetscInt[],PetscScalar[]); 276 PETSC_EXTERN PetscErrorCode VecAssemblyBegin(Vec); 277 PETSC_EXTERN PetscErrorCode VecAssemblyEnd(Vec); 278 PETSC_EXTERN PetscErrorCode VecStashSetInitialSize(Vec,PetscInt,PetscInt); 279 PETSC_EXTERN PetscErrorCode VecStashView(Vec,PetscViewer); 280 PETSC_EXTERN PetscErrorCode VecStashViewFromOptions(Vec,PetscObject,const char[]); 281 PETSC_EXTERN PetscErrorCode VecStashGetInfo(Vec,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 282 283 /*MC 284 VecSetValue - Set a single entry into a vector. 285 286 Synopsis: 287 #include <petscvec.h> 288 PetscErrorCode VecSetValue(Vec v,PetscInt row,PetscScalar value, InsertMode mode); 289 290 Not Collective 291 292 Input Parameters: 293 + v - the vector 294 . row - the row location of the entry 295 . value - the value to insert 296 - mode - either INSERT_VALUES or ADD_VALUES 297 298 Notes: 299 For efficiency one should use VecSetValues() and set several or 300 many values simultaneously if possible. 301 302 These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd() 303 MUST be called after all calls to VecSetValues() have been completed. 304 305 VecSetValues() uses 0-based indices in Fortran as well as in C. 306 307 Level: beginner 308 309 .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValueLocal() 310 M*/ 311 PETSC_STATIC_INLINE PetscErrorCode VecSetValue(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValues(v,1,&i,&va,mode);} 312 313 314 PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec,PetscInt); 315 PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec,PetscInt*); 316 PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 317 318 /* Dynamic creation and loading functions */ 319 PETSC_EXTERN PetscFunctionList VecList; 320 PETSC_EXTERN PetscErrorCode VecSetType(Vec, VecType); 321 PETSC_EXTERN PetscErrorCode VecGetType(Vec, VecType *); 322 PETSC_EXTERN PetscErrorCode VecRegister(const char[],PetscErrorCode (*)(Vec)); 323 324 PETSC_EXTERN PetscErrorCode VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 325 PETSC_EXTERN PetscErrorCode VecScatterCreateEmpty(MPI_Comm,VecScatter *); 326 PETSC_EXTERN PetscErrorCode VecScatterCreateLocal(VecScatter,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt); 327 PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter,Vec,Vec,InsertMode,ScatterMode); 328 PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter,Vec,Vec,InsertMode,ScatterMode); 329 PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter*); 330 PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter,VecScatter *); 331 PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter,PetscViewer); 332 PETSC_STATIC_INLINE PetscErrorCode VecScatterViewFromOptions(VecScatter A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);} 333 PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter,PetscInt *,PetscInt*); 334 PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter,PetscBool *); 335 336 PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 337 PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 338 PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 339 PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 340 PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 341 PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 342 PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]); 343 PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]); 344 345 PETSC_EXTERN PetscErrorCode VecGetArray4dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 346 PETSC_EXTERN PetscErrorCode VecRestoreArray4dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 347 PETSC_EXTERN PetscErrorCode VecGetArray3dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 348 PETSC_EXTERN PetscErrorCode VecRestoreArray3dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 349 PETSC_EXTERN PetscErrorCode VecGetArray2dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 350 PETSC_EXTERN PetscErrorCode VecRestoreArray2dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 351 PETSC_EXTERN PetscErrorCode VecGetArray1dRead(Vec,PetscInt,PetscInt,PetscScalar *[]); 352 PETSC_EXTERN PetscErrorCode VecRestoreArray1dRead(Vec,PetscInt,PetscInt,PetscScalar *[]); 353 354 PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec,const PetscScalar[]); 355 PETSC_EXTERN PetscErrorCode VecResetArray(Vec); 356 PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec,const PetscScalar[]); 357 PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[],PetscInt,PetscScalar**[]); 358 PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[],PetscInt,PetscScalar**[]); 359 360 PETSC_EXTERN PetscErrorCode VecView(Vec,PetscViewer); 361 PETSC_EXTERN PetscErrorCode VecEqual(Vec,Vec,PetscBool *); 362 PETSC_EXTERN PetscErrorCode VecLoad(Vec, PetscViewer); 363 364 PETSC_EXTERN PetscErrorCode VecGetSize(Vec,PetscInt*); 365 PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec,PetscInt*); 366 PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec,PetscInt*,PetscInt*); 367 PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec,const PetscInt *[]); 368 369 PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping); 370 PETSC_EXTERN PetscErrorCode VecSetValuesLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 371 372 /*MC 373 VecSetValueLocal - Set a single entry into a vector using the local numbering 374 375 Synopsis: 376 #include <petscvec.h> 377 PetscErrorCode VecSetValueLocal(Vec v,PetscInt row,PetscScalar value, InsertMode mode); 378 379 Not Collective 380 381 Input Parameters: 382 + v - the vector 383 . row - the row location of the entry 384 . value - the value to insert 385 - mode - either INSERT_VALUES or ADD_VALUES 386 387 Notes: 388 For efficiency one should use VecSetValues() and set several or 389 many values simultaneously if possible. 390 391 These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd() 392 MUST be called after all calls to VecSetValues() have been completed. 393 394 VecSetValues() uses 0-based indices in Fortran as well as in C. 395 396 Level: beginner 397 398 .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValue() 399 M*/ 400 PETSC_STATIC_INLINE PetscErrorCode VecSetValueLocal(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValuesLocal(v,1,&i,&va,mode);} 401 402 PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 403 PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping*); 404 405 PETSC_EXTERN PetscErrorCode VecDotBegin(Vec,Vec,PetscScalar *); 406 PETSC_EXTERN PetscErrorCode VecDotEnd(Vec,Vec,PetscScalar *); 407 PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec,Vec,PetscScalar *); 408 PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec,Vec,PetscScalar *); 409 PETSC_EXTERN PetscErrorCode VecNormBegin(Vec,NormType,PetscReal *); 410 PETSC_EXTERN PetscErrorCode VecNormEnd(Vec,NormType,PetscReal *); 411 412 PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]); 413 PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]); 414 PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]); 415 PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]); 416 PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm); 417 418 419 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES,VEC_IGNORE_NEGATIVE_INDICES,VEC_SUBSET_OFF_PROC_ENTRIES} VecOption; 420 PETSC_EXTERN PetscErrorCode VecSetOption(Vec,VecOption,PetscBool ); 421 422 PETSC_EXTERN PetscErrorCode VecGetArray(Vec,PetscScalar**); 423 PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec,const PetscScalar**); 424 PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec,PetscScalar**); 425 PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec,const PetscScalar**); 426 PETSC_EXTERN PetscErrorCode VecGetLocalVector(Vec,Vec); 427 PETSC_EXTERN PetscErrorCode VecRestoreLocalVector(Vec,Vec); 428 PETSC_EXTERN PetscErrorCode VecGetLocalVectorRead(Vec,Vec); 429 PETSC_EXTERN PetscErrorCode VecRestoreLocalVectorRead(Vec,Vec); 430 /* 431 Accesses a pair of pointers for two vectors that may be common. When not common the first is read only 432 */ 433 PETSC_STATIC_INLINE PetscErrorCode VecGetArrayPair(Vec x,Vec y,PetscScalar **xv,PetscScalar **yv) 434 { 435 PetscErrorCode ierr; 436 437 PetscFunctionBegin; 438 ierr = VecGetArray(y,yv);CHKERRQ(ierr); 439 if (x != y) { 440 ierr = VecGetArrayRead(x,(const PetscScalar **)xv);CHKERRQ(ierr); 441 } else { 442 *xv = *yv; 443 } 444 PetscFunctionReturn(0); 445 } 446 PETSC_STATIC_INLINE PetscErrorCode VecRestoreArrayPair(Vec x,Vec y,PetscScalar **xv,PetscScalar **yv) 447 { 448 PetscErrorCode ierr; 449 450 PetscFunctionBegin; 451 ierr = VecRestoreArray(y,yv);CHKERRQ(ierr); 452 if (x != y) { 453 ierr = VecRestoreArrayRead(x,(const PetscScalar **)xv);CHKERRQ(ierr); 454 } 455 PetscFunctionReturn(0); 456 } 457 458 #if defined(PETSC_USE_DEBUG) 459 PETSC_EXTERN PetscErrorCode VecLockGet(Vec,PetscInt*); 460 PETSC_EXTERN PetscErrorCode VecLockPush(Vec); 461 PETSC_EXTERN PetscErrorCode VecLockPop(Vec); 462 #define VecLocked(x,arg) do {PetscInt _st; PetscErrorCode __ierr = VecLockGet(x,&_st); CHKERRQ(__ierr); if (_st > 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE," Vec is locked read only, argument # %d",arg);} while (0) 463 #else 464 #define VecLockGet(x,arg) *(arg) = 0 465 #define VecLockPush(x) 0 466 #define VecLockPop(x) 0 467 #define VecLocked(x,arg) 468 #endif 469 470 PETSC_EXTERN PetscErrorCode VecValidValues(Vec,PetscInt,PetscBool); 471 472 /* 473 These numbers need to match the entries in 474 the function table in vecimpl.h 475 */ 476 typedef enum { VECOP_DUPLICATE = 0, VECOP_VIEW = 33, VECOP_LOAD = 41, VECOP_VIEWNATIVE = 68, VECOP_LOADNATIVE = 69 } VecOperation; 477 PETSC_EXTERN PetscErrorCode VecSetOperation(Vec,VecOperation,void(*)(void)); 478 479 /* 480 Routines for dealing with ghosted vectors: 481 vectors with ghost elements at the end of the array. 482 */ 483 PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec,PetscInt,const PetscInt[]); 484 PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 485 PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 486 PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 487 PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 488 PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec,Vec*); 489 PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec,Vec*); 490 PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec,Vec,PetscBool*); 491 PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 492 PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 493 494 PETSC_EXTERN PetscErrorCode VecConjugate(Vec); 495 496 PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec,VecScatter*,Vec*); 497 PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec,VecScatter*,Vec*); 498 499 PETSC_EXTERN PetscErrorCode ISComplementVec(IS,Vec,IS*); 500 PETSC_EXTERN PetscErrorCode VecPow(Vec, PetscScalar); 501 PETSC_EXTERN PetscErrorCode VecMedian(Vec, Vec, Vec, Vec); 502 PETSC_EXTERN PetscErrorCode VecWhichBetween(Vec, Vec, Vec, IS *); 503 PETSC_EXTERN PetscErrorCode VecWhichBetweenOrEqual(Vec, Vec, Vec, IS *); 504 PETSC_EXTERN PetscErrorCode VecWhichGreaterThan(Vec, Vec, IS * ); 505 PETSC_EXTERN PetscErrorCode VecWhichLessThan(Vec, Vec, IS *); 506 PETSC_EXTERN PetscErrorCode VecWhichEqual(Vec, Vec, IS *); 507 PETSC_EXTERN PetscErrorCode VecISAXPY(Vec, IS, PetscScalar,Vec); 508 PETSC_EXTERN PetscErrorCode VecISSet(Vec,IS, PetscScalar); 509 PETSC_EXTERN PetscErrorCode VecBoundGradientProjection(Vec, Vec, Vec, Vec, Vec); 510 PETSC_EXTERN PetscErrorCode VecStepBoundInfo(Vec,Vec,Vec,Vec,PetscReal*, PetscReal*,PetscReal*); 511 PETSC_EXTERN PetscErrorCode VecStepMax(Vec, Vec, PetscReal *); 512 PETSC_EXTERN PetscErrorCode VecStepMaxBounded(Vec,Vec,Vec,Vec,PetscReal*); 513 514 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec); 515 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec); 516 517 /*S 518 Vecs - Collection of vectors where the data for the vectors is stored in 519 one contiguous memory 520 521 Level: advanced 522 523 Notes: 524 Temporary construct for handling multiply right hand side solves 525 526 This is faked by storing a single vector that has enough array space for 527 n vectors 528 529 Concepts: parallel decomposition 530 531 S*/ 532 struct _n_Vecs {PetscInt n; Vec v;}; 533 typedef struct _n_Vecs* Vecs; 534 PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs); 535 PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm,PetscInt,PetscInt,Vecs*); 536 PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,PetscScalar*,Vecs*); 537 PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs,Vecs*); 538 539 #if defined(PETSC_HAVE_CUSP) 540 typedef struct _p_PetscCUSPIndices* PetscCUSPIndices; 541 typedef struct _p_VecScatterCUSPIndices_StoS* VecScatterCUSPIndices_StoS; 542 typedef struct _p_VecScatterCUSPIndices_PtoP* VecScatterCUSPIndices_PtoP; 543 PETSC_EXTERN PetscErrorCode VecCUSPCopyToGPUSome_Public(Vec,PetscCUSPIndices); 544 PETSC_EXTERN PetscErrorCode VecCUSPCopyFromGPUSome_Public(Vec,PetscCUSPIndices); 545 PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter,Vec,ScatterMode); 546 PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter); 547 PETSC_EXTERN PetscErrorCode VecCreateSeqCUSP(MPI_Comm,PetscInt,Vec*); 548 PETSC_EXTERN PetscErrorCode VecCreateMPICUSP(MPI_Comm,PetscInt,PetscInt,Vec*); 549 #elif defined(PETSC_HAVE_VIENNACL) 550 typedef struct _p_PetscViennaCLIndices* PetscViennaCLIndices; 551 PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesCreate(PetscInt, PetscInt*,PetscInt, PetscInt*,PetscViennaCLIndices*); 552 PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesDestroy(PetscViennaCLIndices*); 553 PETSC_EXTERN PetscErrorCode VecViennaCLCopyToGPUSome_Public(Vec,PetscViennaCLIndices); 554 PETSC_EXTERN PetscErrorCode VecViennaCLCopyFromGPUSome_Public(Vec,PetscViennaCLIndices); 555 PETSC_EXTERN PetscErrorCode VecCreateSeqViennaCL(MPI_Comm,PetscInt,Vec*); 556 PETSC_EXTERN PetscErrorCode VecCreateMPIViennaCL(MPI_Comm,PetscInt,PetscInt,Vec*); 557 #elif defined(PETSC_HAVE_VECCUDA) 558 typedef struct _p_PetscCUDAIndices* PetscCUDAIndices; 559 typedef struct _p_VecScatterCUDAIndices_StoS* VecScatterCUDAIndices_StoS; 560 typedef struct _p_VecScatterCUDAIndices_PtoP* VecScatterCUDAIndices_PtoP; 561 PETSC_EXTERN PetscErrorCode VecCUDACopyToGPUSome_Public(Vec,PetscCUDAIndices); 562 PETSC_EXTERN PetscErrorCode VecCUDACopyFromGPUSome_Public(Vec,PetscCUDAIndices); 563 PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter,Vec,ScatterMode); 564 PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter); 565 PETSC_EXTERN PetscErrorCode VecCreateSeqCUDA(MPI_Comm,PetscInt,Vec*); 566 PETSC_EXTERN PetscErrorCode VecCreateMPICUDA(MPI_Comm,PetscInt,PetscInt,Vec*); 567 #endif 568 569 PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec,PetscInt*,Vec**); 570 PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec,PetscInt,Vec*); 571 PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec,PetscInt,PetscInt*,Vec*); 572 PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec,PetscInt,Vec); 573 PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm,PetscInt,IS*,Vec*,Vec*); 574 PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec,PetscInt*); 575 576 PETSC_EXTERN PetscErrorCode PetscOptionsGetVec(PetscOptions,const char[],const char[],Vec,PetscBool*); 577 PETSC_EXTERN PetscErrorCode VecChop(Vec,PetscReal); 578 579 PETSC_EXTERN PetscErrorCode VecGetLayout(Vec,PetscLayout*); 580 PETSC_EXTERN PetscErrorCode VecSetLayout(Vec,PetscLayout); 581 582 PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer); 583 PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar **); 584 PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, PetscScalar [], InsertMode); 585 PETSC_EXTERN PetscErrorCode PetscSectionVecNorm(PetscSection, PetscSection, Vec, NormType, PetscReal []); 586 587 PETSC_EXTERN PetscErrorCode PetscSFCreateFromZero(MPI_Comm,Vec,PetscSF*); 588 589 #endif 590 591