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 108 109 /* Logging support */ 110 #define REAL_FILE_CLASSID 1211213 111 #define VEC_FILE_CLASSID 1211214 112 PETSC_EXTERN PetscClassId VEC_CLASSID; 113 PETSC_EXTERN PetscClassId VEC_SCATTER_CLASSID; 114 115 116 PETSC_EXTERN PetscErrorCode VecInitializePackage(void); 117 PETSC_EXTERN PetscErrorCode VecFinalizePackage(void); 118 119 PETSC_EXTERN PetscErrorCode VecCreate(MPI_Comm,Vec*); 120 PETSC_EXTERN PetscErrorCode VecCreateSeq(MPI_Comm,PetscInt,Vec*); 121 PETSC_EXTERN PetscErrorCode VecCreateMPI(MPI_Comm,PetscInt,PetscInt,Vec*); 122 PETSC_EXTERN PetscErrorCode VecCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,const PetscScalar[],Vec*); 123 PETSC_EXTERN PetscErrorCode VecCreateMPIWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar[],Vec*); 124 PETSC_EXTERN PetscErrorCode VecCreateShared(MPI_Comm,PetscInt,PetscInt,Vec*); 125 PETSC_EXTERN PetscErrorCode VecSetFromOptions(Vec); 126 PETSC_STATIC_INLINE PetscErrorCode VecViewFromOptions(Vec A,PetscObject B,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,B,name);} 127 128 PETSC_EXTERN PetscErrorCode VecSetUp(Vec); 129 PETSC_EXTERN PetscErrorCode VecDestroy(Vec*); 130 PETSC_EXTERN PetscErrorCode VecZeroEntries(Vec); 131 PETSC_EXTERN PetscErrorCode VecSetOptionsPrefix(Vec,const char[]); 132 PETSC_EXTERN PetscErrorCode VecAppendOptionsPrefix(Vec,const char[]); 133 PETSC_EXTERN PetscErrorCode VecGetOptionsPrefix(Vec,const char*[]); 134 135 PETSC_EXTERN PetscErrorCode VecSetSizes(Vec,PetscInt,PetscInt); 136 137 PETSC_EXTERN PetscErrorCode VecDotNorm2(Vec,Vec,PetscScalar*,PetscReal*); 138 PETSC_EXTERN PetscErrorCode VecDot(Vec,Vec,PetscScalar*); 139 PETSC_EXTERN PetscErrorCode VecDotRealPart(Vec,Vec,PetscReal*); 140 PETSC_EXTERN PetscErrorCode VecTDot(Vec,Vec,PetscScalar*); 141 PETSC_EXTERN PetscErrorCode VecMDot(Vec,PetscInt,const Vec[],PetscScalar[]); 142 PETSC_EXTERN PetscErrorCode VecMTDot(Vec,PetscInt,const Vec[],PetscScalar[]); 143 PETSC_EXTERN PetscErrorCode VecGetSubVector(Vec,IS,Vec*); 144 PETSC_EXTERN PetscErrorCode VecRestoreSubVector(Vec,IS,Vec*); 145 146 /*E 147 NormType - determines what type of norm to compute 148 149 Level: beginner 150 151 .seealso: VecNorm(), VecNormBegin(), VecNormEnd(), MatNorm() 152 E*/ 153 typedef enum {NORM_1=0,NORM_2=1,NORM_FROBENIUS=2,NORM_INFINITY=3,NORM_1_AND_2=4} NormType; 154 PETSC_EXTERN const char *const NormTypes[]; 155 #define NORM_MAX NORM_INFINITY 156 157 /*MC 158 NORM_1 - the one norm, ||v|| = sum_i | v_i |. ||A|| = max_j || v_*j ||, maximum column sum 159 160 Level: beginner 161 162 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_2, NORM_FROBENIUS, 163 NORM_INFINITY, NORM_1_AND_2 164 165 M*/ 166 167 /*MC 168 NORM_2 - the two norm, ||v|| = sqrt(sum_i |v_i|^2) (vectors only) 169 170 Level: beginner 171 172 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_FROBENIUS, 173 NORM_INFINITY, NORM_1_AND_2 174 175 M*/ 176 177 /*MC 178 NORM_FROBENIUS - ||A|| = sqrt(sum_ij |A_ij|^2), same as NORM_2 for vectors 179 180 Level: beginner 181 182 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2, 183 NORM_INFINITY, NORM_1_AND_2 184 185 M*/ 186 187 /*MC 188 NORM_INFINITY - ||v|| = max_i |v_i|. ||A|| = max_i || v_i* ||, maximum row sum 189 190 Level: beginner 191 192 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2, 193 NORM_FROBINIUS, NORM_1_AND_2 194 195 M*/ 196 197 /*MC 198 NORM_1_AND_2 - computes both the 1 and 2 norm of a vector 199 200 Level: beginner 201 202 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2, 203 NORM_FROBINIUS, NORM_INFINITY 204 205 M*/ 206 207 /*MC 208 NORM_MAX - see NORM_INFINITY 209 210 Level: beginner 211 212 M*/ 213 214 PETSC_EXTERN PetscErrorCode VecNorm(Vec,NormType,PetscReal *); 215 PETSC_EXTERN PetscErrorCode VecNormAvailable(Vec,NormType,PetscBool *,PetscReal *); 216 PETSC_EXTERN PetscErrorCode VecNormalize(Vec,PetscReal *); 217 PETSC_EXTERN PetscErrorCode VecSum(Vec,PetscScalar*); 218 PETSC_EXTERN PetscErrorCode VecMax(Vec,PetscInt*,PetscReal *); 219 PETSC_EXTERN PetscErrorCode VecMin(Vec,PetscInt*,PetscReal *); 220 PETSC_EXTERN PetscErrorCode VecScale(Vec,PetscScalar); 221 PETSC_EXTERN PetscErrorCode VecCopy(Vec,Vec); 222 PETSC_EXTERN PetscErrorCode VecSetRandom(Vec,PetscRandom); 223 PETSC_EXTERN PetscErrorCode VecSet(Vec,PetscScalar); 224 PETSC_EXTERN PetscErrorCode VecSetInf(Vec); 225 PETSC_EXTERN PetscErrorCode VecSwap(Vec,Vec); 226 PETSC_EXTERN PetscErrorCode VecAXPY(Vec,PetscScalar,Vec); 227 PETSC_EXTERN PetscErrorCode VecAXPBY(Vec,PetscScalar,PetscScalar,Vec); 228 PETSC_EXTERN PetscErrorCode VecMAXPY(Vec,PetscInt,const PetscScalar[],Vec[]); 229 PETSC_EXTERN PetscErrorCode VecAYPX(Vec,PetscScalar,Vec); 230 PETSC_EXTERN PetscErrorCode VecWAXPY(Vec,PetscScalar,Vec,Vec); 231 PETSC_EXTERN PetscErrorCode VecAXPBYPCZ(Vec,PetscScalar,PetscScalar,PetscScalar,Vec,Vec); 232 PETSC_EXTERN PetscErrorCode VecPointwiseMax(Vec,Vec,Vec); 233 PETSC_EXTERN PetscErrorCode VecPointwiseMaxAbs(Vec,Vec,Vec); 234 PETSC_EXTERN PetscErrorCode VecPointwiseMin(Vec,Vec,Vec); 235 PETSC_EXTERN PetscErrorCode VecPointwiseMult(Vec,Vec,Vec); 236 PETSC_EXTERN PetscErrorCode VecPointwiseDivide(Vec,Vec,Vec); 237 PETSC_EXTERN PetscErrorCode VecMaxPointwiseDivide(Vec,Vec,PetscReal*); 238 PETSC_EXTERN PetscErrorCode VecShift(Vec,PetscScalar); 239 PETSC_EXTERN PetscErrorCode VecReciprocal(Vec); 240 PETSC_EXTERN PetscErrorCode VecPermute(Vec, IS, PetscBool ); 241 PETSC_EXTERN PetscErrorCode VecSqrtAbs(Vec); 242 PETSC_EXTERN PetscErrorCode VecLog(Vec); 243 PETSC_EXTERN PetscErrorCode VecExp(Vec); 244 PETSC_EXTERN PetscErrorCode VecAbs(Vec); 245 PETSC_EXTERN PetscErrorCode VecDuplicate(Vec,Vec*); 246 PETSC_EXTERN PetscErrorCode VecDuplicateVecs(Vec,PetscInt,Vec*[]); 247 PETSC_EXTERN PetscErrorCode VecDestroyVecs(PetscInt, Vec*[]); 248 PETSC_EXTERN PetscErrorCode VecStrideNormAll(Vec,NormType,PetscReal[]); 249 PETSC_EXTERN PetscErrorCode VecStrideMaxAll(Vec,PetscInt [],PetscReal []); 250 PETSC_EXTERN PetscErrorCode VecStrideMinAll(Vec,PetscInt [],PetscReal []); 251 PETSC_EXTERN PetscErrorCode VecStrideScaleAll(Vec,const PetscScalar[]); 252 PETSC_EXTERN PetscErrorCode VecUniqueEntries(Vec,PetscInt*,PetscScalar**); 253 254 PETSC_EXTERN PetscErrorCode VecStrideNorm(Vec,PetscInt,NormType,PetscReal*); 255 PETSC_EXTERN PetscErrorCode VecStrideMax(Vec,PetscInt,PetscInt *,PetscReal *); 256 PETSC_EXTERN PetscErrorCode VecStrideMin(Vec,PetscInt,PetscInt *,PetscReal *); 257 PETSC_EXTERN PetscErrorCode VecStrideScale(Vec,PetscInt,PetscScalar); 258 PETSC_EXTERN PetscErrorCode VecStrideSet(Vec,PetscInt,PetscScalar); 259 260 261 PETSC_EXTERN PetscErrorCode VecStrideGather(Vec,PetscInt,Vec,InsertMode); 262 PETSC_EXTERN PetscErrorCode VecStrideScatter(Vec,PetscInt,Vec,InsertMode); 263 PETSC_EXTERN PetscErrorCode VecStrideGatherAll(Vec,Vec[],InsertMode); 264 PETSC_EXTERN PetscErrorCode VecStrideScatterAll(Vec[],Vec,InsertMode); 265 266 PETSC_EXTERN PetscErrorCode VecStrideSubSetScatter(Vec,PetscInt,const PetscInt[],const PetscInt[],Vec,InsertMode); 267 PETSC_EXTERN PetscErrorCode VecStrideSubSetGather(Vec,PetscInt,const PetscInt[],const PetscInt[],Vec,InsertMode); 268 269 PETSC_EXTERN PetscErrorCode VecSetValues(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 270 PETSC_EXTERN PetscErrorCode VecGetValues(Vec,PetscInt,const PetscInt[],PetscScalar[]); 271 PETSC_EXTERN PetscErrorCode VecAssemblyBegin(Vec); 272 PETSC_EXTERN PetscErrorCode VecAssemblyEnd(Vec); 273 PETSC_EXTERN PetscErrorCode VecStashSetInitialSize(Vec,PetscInt,PetscInt); 274 PETSC_EXTERN PetscErrorCode VecStashView(Vec,PetscViewer); 275 PETSC_EXTERN PetscErrorCode VecStashViewFromOptions(Vec,PetscObject,const char[]); 276 PETSC_EXTERN PetscErrorCode VecStashGetInfo(Vec,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 277 278 /*MC 279 VecSetValue - Set a single entry into a vector. 280 281 Synopsis: 282 #include <petscvec.h> 283 PetscErrorCode VecSetValue(Vec v,PetscInt row,PetscScalar value, InsertMode mode); 284 285 Not Collective 286 287 Input Parameters: 288 + v - the vector 289 . row - the row location of the entry 290 . value - the value to insert 291 - mode - either INSERT_VALUES or ADD_VALUES 292 293 Notes: 294 For efficiency one should use VecSetValues() and set several or 295 many values simultaneously if possible. 296 297 These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd() 298 MUST be called after all calls to VecSetValues() have been completed. 299 300 VecSetValues() uses 0-based indices in Fortran as well as in C. 301 302 Level: beginner 303 304 .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValueLocal() 305 M*/ 306 PETSC_STATIC_INLINE PetscErrorCode VecSetValue(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValues(v,1,&i,&va,mode);} 307 308 309 PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec,PetscInt); 310 PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec,PetscInt*); 311 PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 312 313 /* Dynamic creation and loading functions */ 314 PETSC_EXTERN PetscFunctionList VecList; 315 PETSC_EXTERN PetscErrorCode VecSetType(Vec, VecType); 316 PETSC_EXTERN PetscErrorCode VecGetType(Vec, VecType *); 317 PETSC_EXTERN PetscErrorCode VecRegister(const char[],PetscErrorCode (*)(Vec)); 318 319 PETSC_EXTERN PetscErrorCode VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 320 PETSC_EXTERN PetscErrorCode VecScatterCreateEmpty(MPI_Comm,VecScatter *); 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 /*@C 426 VecGetArrayPair - Accesses a pair of pointers for two vectors that may be common. When not common the first is read only 427 428 Logically Collective on Vec 429 430 Input Parameters: 431 + x - the vector 432 - y - the second vector 433 434 Output Parameters: 435 + xv - location to put pointer to the first array 436 - yv - location to put pointer to the second array 437 438 Level: developer 439 440 Not available from Fortran 441 442 .seealso: VecGetArray(), VecGetArrayRead(), VecRestoreArrayPair() 443 444 @*/ 445 PETSC_STATIC_INLINE PetscErrorCode VecGetArrayPair(Vec x,Vec y,PetscScalar **xv,PetscScalar **yv) 446 { 447 PetscErrorCode ierr; 448 449 PetscFunctionBegin; 450 ierr = VecGetArray(y,yv);CHKERRQ(ierr); 451 if (x != y) { 452 ierr = VecGetArrayRead(x,(const PetscScalar **)xv);CHKERRQ(ierr); 453 } else { 454 *xv = *yv; 455 } 456 PetscFunctionReturn(0); 457 } 458 459 /*@C 460 VecRestoreArrayPair - Returns a pair of pointers for two vectors that may be common. When not common the first is read only 461 462 Logically Collective on Vec 463 464 Input Parameters: 465 + x - the vector 466 - y - the second vector 467 468 Output Parameters: 469 + xv - location to put pointer to the first array 470 - yv - location to put pointer to the second array 471 472 Level: developer 473 474 Not available from Fortran 475 476 .seealso: VecGetArray(), VecGetArrayRead(), VecGetArrayPair() 477 478 @*/ 479 PETSC_STATIC_INLINE PetscErrorCode VecRestoreArrayPair(Vec x,Vec y,PetscScalar **xv,PetscScalar **yv) 480 { 481 PetscErrorCode ierr; 482 483 PetscFunctionBegin; 484 ierr = VecRestoreArray(y,yv);CHKERRQ(ierr); 485 if (x != y) { 486 ierr = VecRestoreArrayRead(x,(const PetscScalar **)xv);CHKERRQ(ierr); 487 } 488 PetscFunctionReturn(0); 489 } 490 491 #if defined(PETSC_USE_DEBUG) 492 PETSC_EXTERN PetscErrorCode VecLockGet(Vec,PetscInt*); 493 PETSC_EXTERN PetscErrorCode VecLockPush(Vec); 494 PETSC_EXTERN PetscErrorCode VecLockPop(Vec); 495 #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) 496 #else 497 #define VecLockGet(x,arg) *(arg) = 0 498 #define VecLockPush(x) 0 499 #define VecLockPop(x) 0 500 #define VecLocked(x,arg) 501 #endif 502 503 PETSC_EXTERN PetscErrorCode VecValidValues(Vec,PetscInt,PetscBool); 504 505 /* 506 These numbers need to match the entries in 507 the function table in vecimpl.h 508 */ 509 typedef enum { VECOP_DUPLICATE = 0, VECOP_VIEW = 33, VECOP_LOAD = 41, VECOP_VIEWNATIVE = 68, VECOP_LOADNATIVE = 69 } VecOperation; 510 PETSC_EXTERN PetscErrorCode VecSetOperation(Vec,VecOperation,void(*)(void)); 511 512 /* 513 Routines for dealing with ghosted vectors: 514 vectors with ghost elements at the end of the array. 515 */ 516 PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec,PetscInt,const PetscInt[]); 517 PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 518 PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 519 PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 520 PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 521 PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec,Vec*); 522 PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec,Vec*); 523 PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec,Vec,PetscBool*); 524 PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 525 PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 526 527 PETSC_EXTERN PetscErrorCode VecConjugate(Vec); 528 529 PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec,VecScatter*,Vec*); 530 PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec,VecScatter*,Vec*); 531 532 PETSC_EXTERN PetscErrorCode ISComplementVec(IS,Vec,IS*); 533 PETSC_EXTERN PetscErrorCode VecPow(Vec, PetscScalar); 534 PETSC_EXTERN PetscErrorCode VecMedian(Vec, Vec, Vec, Vec); 535 PETSC_EXTERN PetscErrorCode VecWhichInactive(Vec, Vec, Vec, Vec, PetscBool, IS *); 536 PETSC_EXTERN PetscErrorCode VecWhichBetween(Vec, Vec, Vec, IS *); 537 PETSC_EXTERN PetscErrorCode VecWhichBetweenOrEqual(Vec, Vec, Vec, IS *); 538 PETSC_EXTERN PetscErrorCode VecWhichGreaterThan(Vec, Vec, IS * ); 539 PETSC_EXTERN PetscErrorCode VecWhichLessThan(Vec, Vec, IS *); 540 PETSC_EXTERN PetscErrorCode VecWhichEqual(Vec, Vec, IS *); 541 PETSC_EXTERN PetscErrorCode VecISAXPY(Vec, IS, PetscScalar,Vec); 542 PETSC_EXTERN PetscErrorCode VecISCopy(Vec, IS, ScatterMode, Vec); 543 PETSC_EXTERN PetscErrorCode VecISSet(Vec,IS, PetscScalar); 544 PETSC_EXTERN PetscErrorCode VecBoundGradientProjection(Vec, Vec, Vec, Vec, Vec); 545 PETSC_EXTERN PetscErrorCode VecStepBoundInfo(Vec,Vec,Vec,Vec,PetscReal*, PetscReal*,PetscReal*); 546 PETSC_EXTERN PetscErrorCode VecStepMax(Vec, Vec, PetscReal *); 547 PETSC_EXTERN PetscErrorCode VecStepMaxBounded(Vec,Vec,Vec,Vec,PetscReal*); 548 549 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec); 550 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec); 551 552 /*S 553 Vecs - Collection of vectors where the data for the vectors is stored in 554 one contiguous memory 555 556 Level: advanced 557 558 Notes: 559 Temporary construct for handling multiply right hand side solves 560 561 This is faked by storing a single vector that has enough array space for 562 n vectors 563 564 Concepts: parallel decomposition 565 566 S*/ 567 struct _n_Vecs {PetscInt n; Vec v;}; 568 typedef struct _n_Vecs* Vecs; 569 PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs); 570 PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm,PetscInt,PetscInt,Vecs*); 571 PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,PetscScalar*,Vecs*); 572 PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs,Vecs*); 573 574 #if defined(PETSC_HAVE_VIENNACL) 575 typedef struct _p_PetscViennaCLIndices* PetscViennaCLIndices; 576 PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesCreate(PetscInt, PetscInt*,PetscInt, PetscInt*,PetscViennaCLIndices*); 577 PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesDestroy(PetscViennaCLIndices*); 578 PETSC_EXTERN PetscErrorCode VecViennaCLCopyToGPUSome_Public(Vec,PetscViennaCLIndices); 579 PETSC_EXTERN PetscErrorCode VecViennaCLCopyFromGPUSome_Public(Vec,PetscViennaCLIndices); 580 PETSC_EXTERN PetscErrorCode VecCreateSeqViennaCL(MPI_Comm,PetscInt,Vec*); 581 PETSC_EXTERN PetscErrorCode VecCreateMPIViennaCL(MPI_Comm,PetscInt,PetscInt,Vec*); 582 #endif 583 #if defined(PETSC_HAVE_VECCUDA) 584 typedef struct _p_PetscCUDAIndices* PetscCUDAIndices; 585 typedef struct _p_VecScatterCUDAIndices_StoS* VecScatterCUDAIndices_StoS; 586 typedef struct _p_VecScatterCUDAIndices_PtoP* VecScatterCUDAIndices_PtoP; 587 PETSC_EXTERN PetscErrorCode VecCUDACopyToGPUSome_Public(Vec,PetscCUDAIndices); 588 PETSC_EXTERN PetscErrorCode VecCUDACopyFromGPUSome_Public(Vec,PetscCUDAIndices); 589 PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter,Vec,ScatterMode); 590 PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter); 591 PETSC_EXTERN PetscErrorCode VecCreateSeqCUDA(MPI_Comm,PetscInt,Vec*); 592 PETSC_EXTERN PetscErrorCode VecCreateSeqCUDAWithArray(MPI_Comm,PetscInt,PetscInt,const PetscScalar*,Vec*); 593 PETSC_EXTERN PetscErrorCode VecCreateMPICUDA(MPI_Comm,PetscInt,PetscInt,Vec*); 594 PETSC_EXTERN PetscErrorCode VecCreateMPICUDAWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar*,Vec*); 595 #endif 596 597 PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec,PetscInt*,Vec**); 598 PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec,PetscInt,Vec*); 599 PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec,PetscInt,PetscInt*,Vec*); 600 PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec,PetscInt,Vec); 601 PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm,PetscInt,IS*,Vec*,Vec*); 602 PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec,PetscInt*); 603 604 PETSC_EXTERN PetscErrorCode PetscOptionsGetVec(PetscOptions,const char[],const char[],Vec,PetscBool*); 605 PETSC_EXTERN PetscErrorCode VecChop(Vec,PetscReal); 606 607 PETSC_EXTERN PetscErrorCode VecGetLayout(Vec,PetscLayout*); 608 PETSC_EXTERN PetscErrorCode VecSetLayout(Vec,PetscLayout); 609 610 PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer); 611 PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar **); 612 PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, PetscScalar [], InsertMode); 613 PETSC_EXTERN PetscErrorCode PetscSectionVecNorm(PetscSection, PetscSection, Vec, NormType, PetscReal []); 614 615 PETSC_EXTERN PetscErrorCode PetscSFCreateFromZero(MPI_Comm,Vec,PetscSF*); 616 617 /*S 618 VecTagger - Object used to manage the tagging of a subset of indices based on the values of a vector. The 619 motivating application is the selection of cells for refinement or coarsening based on vector containing 620 the values in an error indicator metric. 621 622 Level: advanced 623 S*/ 624 typedef struct _p_VecTagger *VecTagger; 625 626 /*J 627 VecTaggerType - String with the name of a VecTagger type 628 629 Level: advanced 630 J*/ 631 typedef const char* VecTaggerType; 632 /* tag where the vector values are in a box of explicitly defined values */ 633 #define VECTAGGERABSOLUTE "absolute" 634 /* tag where the vector values are in a box of values relative to the set of all values in the vector */ 635 #define VECTAGGERRELATIVE "relative" 636 /* tag where the vector values are in a relative range of the *cumulative distribution* of values in the vector */ 637 #define VECTAGGERCDF "cdf" 638 /* tag a vector as the union of other tags */ 639 #define VECTAGGEROR "or" 640 /* tag a vector as the intersection of other tags */ 641 #define VECTAGGERAND "and" 642 643 PETSC_EXTERN PetscClassId VEC_TAGGER_CLASSID; 644 PETSC_EXTERN PetscFunctionList VecTaggerList; 645 PETSC_EXTERN PetscErrorCode VecTaggerRegister(const char[],PetscErrorCode (*) (VecTagger)); 646 647 PETSC_EXTERN PetscErrorCode VecTaggerCreate(MPI_Comm,VecTagger *); 648 PETSC_EXTERN PetscErrorCode VecTaggerSetBlockSize(VecTagger,PetscInt); 649 PETSC_EXTERN PetscErrorCode VecTaggerGetBlockSize(VecTagger,PetscInt*); 650 PETSC_EXTERN PetscErrorCode VecTaggerSetType(VecTagger,VecTaggerType); 651 PETSC_EXTERN PetscErrorCode VecTaggerGetType(VecTagger,VecTaggerType *); 652 PETSC_EXTERN PetscErrorCode VecTaggerSetInvert(VecTagger,PetscBool); 653 PETSC_EXTERN PetscErrorCode VecTaggerGetInvert(VecTagger,PetscBool*); 654 PETSC_EXTERN PetscErrorCode VecTaggerSetFromOptions(VecTagger); 655 PETSC_EXTERN PetscErrorCode VecTaggerSetUp(VecTagger); 656 PETSC_EXTERN PetscErrorCode VecTaggerView(VecTagger,PetscViewer); 657 PETSC_EXTERN PetscErrorCode VecTaggerComputeIS(VecTagger,Vec,IS *); 658 PETSC_EXTERN PetscErrorCode VecTaggerDestroy(VecTagger *); 659 660 /*S 661 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 662 such that real(min) <= real(z) <= real(max) and imag(min) <= imag(z) <= imag(max). INF is an acceptable endpoint. 663 664 Level: beginner 665 666 .seealso: VecTaggerComputeIntervals() 667 S*/ 668 typedef struct { 669 PetscScalar min; 670 PetscScalar max; 671 } VecTaggerBox; 672 PETSC_EXTERN PetscErrorCode VecTaggerComputeBoxes(VecTagger,Vec,PetscInt *,VecTaggerBox **); 673 674 675 PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteSetBox(VecTagger,VecTaggerBox *); 676 PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteGetBox(VecTagger,const VecTaggerBox **); 677 678 PETSC_EXTERN PetscErrorCode VecTaggerRelativeSetBox(VecTagger,VecTaggerBox *); 679 PETSC_EXTERN PetscErrorCode VecTaggerRelativeGetBox(VecTagger,const VecTaggerBox **); 680 681 PETSC_EXTERN PetscErrorCode VecTaggerCDFSetBox(VecTagger,VecTaggerBox *); 682 PETSC_EXTERN PetscErrorCode VecTaggerCDFGetBox(VecTagger,const VecTaggerBox **); 683 684 /*E 685 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. 686 687 Level: advanced 688 .seealso: VecTaggerCDFSetMethod(), VecTaggerCDFMethods 689 E*/ 690 typedef enum {VECTAGGER_CDF_GATHER,VECTAGGER_CDF_ITERATIVE,VECTAGGER_CDF_NUM_METHODS} VecTaggerCDFMethod; 691 PETSC_EXTERN const char *const VecTaggerCDFMethods[]; 692 693 PETSC_EXTERN PetscErrorCode VecTaggerCDFSetMethod(VecTagger,VecTaggerCDFMethod); 694 PETSC_EXTERN PetscErrorCode VecTaggerCDFGetMethod(VecTagger,VecTaggerCDFMethod*); 695 PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeSetTolerances(VecTagger,PetscInt,PetscReal,PetscReal); 696 PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeGetTolerances(VecTagger,PetscInt*,PetscReal*,PetscReal*); 697 698 PETSC_EXTERN PetscErrorCode VecTaggerOrSetSubs(VecTagger,PetscInt,VecTagger*,PetscCopyMode); 699 PETSC_EXTERN PetscErrorCode VecTaggerOrGetSubs(VecTagger,PetscInt*,VecTagger**); 700 701 PETSC_EXTERN PetscErrorCode VecTaggerAndSetSubs(VecTagger,PetscInt,VecTagger*,PetscCopyMode); 702 PETSC_EXTERN PetscErrorCode VecTaggerAndGetSubs(VecTagger,PetscInt*,VecTagger**); 703 704 PETSC_EXTERN PetscErrorCode VecTaggerInitializePackage(void); 705 PETSC_EXTERN PetscErrorCode VecTaggerFinalizePackage(void); 706 707 #endif 708