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