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