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 VecScatterCreateMPI1(Vec,IS,Vec,IS,VecScatter *); 324 PETSC_EXTERN PetscErrorCode VecScatterCreateEmpty(MPI_Comm,VecScatter *); 325 PETSC_EXTERN PetscErrorCode VecScatterCreateEmptyMPI1(MPI_Comm,VecScatter *); 326 PETSC_EXTERN PetscErrorCode VecScatterCreateLocal(VecScatter,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt); 327 PETSC_EXTERN PetscErrorCode VecScatterCreateLocalMPI1(VecScatter,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt); 328 PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter,Vec,Vec,InsertMode,ScatterMode); 329 PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter,Vec,Vec,InsertMode,ScatterMode); 330 PETSC_EXTERN PetscErrorCode VecScatterBeginMPI1(VecScatter,Vec,Vec,InsertMode,ScatterMode); 331 PETSC_EXTERN PetscErrorCode VecScatterEndMPI1(VecScatter,Vec,Vec,InsertMode,ScatterMode); 332 PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter*); 333 PETSC_EXTERN PetscErrorCode VecScatterDestroyMPI1(VecScatter*); 334 PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter,VecScatter *); 335 PETSC_EXTERN PetscErrorCode VecScatterCopyMPI1(VecScatter,VecScatter *); 336 PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter,PetscViewer); 337 PETSC_EXTERN PetscErrorCode VecScatterViewMPI1(VecScatter,PetscViewer); 338 PETSC_STATIC_INLINE PetscErrorCode VecScatterViewFromOptions(VecScatter A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);} 339 PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter,PetscInt *,PetscInt*); 340 PETSC_EXTERN PetscErrorCode VecScatterRemapMPI1(VecScatter,PetscInt *,PetscInt*); 341 PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter,PetscBool *); 342 PETSC_EXTERN PetscErrorCode VecScatterGetMergedMPI1(VecScatter,PetscBool *); 343 344 PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 345 PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 346 PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 347 PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 348 PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 349 PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 350 PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]); 351 PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]); 352 353 PETSC_EXTERN PetscErrorCode VecGetArray4dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 354 PETSC_EXTERN PetscErrorCode VecRestoreArray4dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 355 PETSC_EXTERN PetscErrorCode VecGetArray3dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 356 PETSC_EXTERN PetscErrorCode VecRestoreArray3dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 357 PETSC_EXTERN PetscErrorCode VecGetArray2dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 358 PETSC_EXTERN PetscErrorCode VecRestoreArray2dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 359 PETSC_EXTERN PetscErrorCode VecGetArray1dRead(Vec,PetscInt,PetscInt,PetscScalar *[]); 360 PETSC_EXTERN PetscErrorCode VecRestoreArray1dRead(Vec,PetscInt,PetscInt,PetscScalar *[]); 361 362 PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec,const PetscScalar[]); 363 PETSC_EXTERN PetscErrorCode VecResetArray(Vec); 364 PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec,const PetscScalar[]); 365 PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[],PetscInt,PetscScalar**[]); 366 PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[],PetscInt,PetscScalar**[]); 367 368 PETSC_EXTERN PetscErrorCode VecView(Vec,PetscViewer); 369 PETSC_EXTERN PetscErrorCode VecEqual(Vec,Vec,PetscBool *); 370 PETSC_EXTERN PetscErrorCode VecLoad(Vec, PetscViewer); 371 372 PETSC_EXTERN PetscErrorCode VecGetSize(Vec,PetscInt*); 373 PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec,PetscInt*); 374 PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec,PetscInt*,PetscInt*); 375 PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec,const PetscInt *[]); 376 377 PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping); 378 PETSC_EXTERN PetscErrorCode VecSetValuesLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 379 380 /*MC 381 VecSetValueLocal - Set a single entry into a vector using the local numbering 382 383 Synopsis: 384 #include <petscvec.h> 385 PetscErrorCode VecSetValueLocal(Vec v,PetscInt row,PetscScalar value, InsertMode mode); 386 387 Not Collective 388 389 Input Parameters: 390 + v - the vector 391 . row - the row location of the entry 392 . value - the value to insert 393 - mode - either INSERT_VALUES or ADD_VALUES 394 395 Notes: 396 For efficiency one should use VecSetValues() and set several or 397 many values simultaneously if possible. 398 399 These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd() 400 MUST be called after all calls to VecSetValues() have been completed. 401 402 VecSetValues() uses 0-based indices in Fortran as well as in C. 403 404 Level: beginner 405 406 .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValue() 407 M*/ 408 PETSC_STATIC_INLINE PetscErrorCode VecSetValueLocal(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValuesLocal(v,1,&i,&va,mode);} 409 410 PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 411 PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping*); 412 413 PETSC_EXTERN PetscErrorCode VecDotBegin(Vec,Vec,PetscScalar *); 414 PETSC_EXTERN PetscErrorCode VecDotEnd(Vec,Vec,PetscScalar *); 415 PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec,Vec,PetscScalar *); 416 PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec,Vec,PetscScalar *); 417 PETSC_EXTERN PetscErrorCode VecNormBegin(Vec,NormType,PetscReal *); 418 PETSC_EXTERN PetscErrorCode VecNormEnd(Vec,NormType,PetscReal *); 419 420 PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]); 421 PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]); 422 PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]); 423 PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]); 424 PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm); 425 426 427 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES,VEC_IGNORE_NEGATIVE_INDICES,VEC_SUBSET_OFF_PROC_ENTRIES} VecOption; 428 PETSC_EXTERN PetscErrorCode VecSetOption(Vec,VecOption,PetscBool ); 429 430 PETSC_EXTERN PetscErrorCode VecGetArray(Vec,PetscScalar**); 431 PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec,const PetscScalar**); 432 PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec,PetscScalar**); 433 PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec,const PetscScalar**); 434 PETSC_EXTERN PetscErrorCode VecGetLocalVector(Vec,Vec); 435 PETSC_EXTERN PetscErrorCode VecRestoreLocalVector(Vec,Vec); 436 PETSC_EXTERN PetscErrorCode VecGetLocalVectorRead(Vec,Vec); 437 PETSC_EXTERN PetscErrorCode VecRestoreLocalVectorRead(Vec,Vec); 438 439 /*@C 440 VecGetArrayPair - Accesses a pair of pointers for two vectors that may be common. When not common the first is read only 441 442 Logically Collective on Vec 443 444 Input Parameter: 445 + x - the vector 446 - y - the second vector 447 448 Output Parameter: 449 + xv - location to put pointer to the first array 450 - yv - location to put pointer to the second array 451 452 Level: developer 453 454 .seealso: VecGetArray(), VecGetArrayRead(), VecRestoreArrayPair() 455 456 @*/ 457 PETSC_STATIC_INLINE PetscErrorCode VecGetArrayPair(Vec x,Vec y,PetscScalar **xv,PetscScalar **yv) 458 { 459 PetscErrorCode ierr; 460 461 PetscFunctionBegin; 462 ierr = VecGetArray(y,yv);CHKERRQ(ierr); 463 if (x != y) { 464 ierr = VecGetArrayRead(x,(const PetscScalar **)xv);CHKERRQ(ierr); 465 } else { 466 *xv = *yv; 467 } 468 PetscFunctionReturn(0); 469 } 470 471 /*@C 472 VecRestoreArrayPair - Returns a pair of pointers for two vectors that may be common. When not common the first is read only 473 474 Logically Collective on Vec 475 476 Input Parameter: 477 + x - the vector 478 - y - the second vector 479 480 Output Parameter: 481 + xv - location to put pointer to the first array 482 - yv - location to put pointer to the second array 483 484 Level: developer 485 486 .seealso: VecGetArray(), VecGetArrayRead(), VecGetArrayPair() 487 488 @*/ 489 PETSC_STATIC_INLINE PetscErrorCode VecRestoreArrayPair(Vec x,Vec y,PetscScalar **xv,PetscScalar **yv) 490 { 491 PetscErrorCode ierr; 492 493 PetscFunctionBegin; 494 ierr = VecRestoreArray(y,yv);CHKERRQ(ierr); 495 if (x != y) { 496 ierr = VecRestoreArrayRead(x,(const PetscScalar **)xv);CHKERRQ(ierr); 497 } 498 PetscFunctionReturn(0); 499 } 500 501 #if defined(PETSC_USE_DEBUG) 502 PETSC_EXTERN PetscErrorCode VecLockGet(Vec,PetscInt*); 503 PETSC_EXTERN PetscErrorCode VecLockPush(Vec); 504 PETSC_EXTERN PetscErrorCode VecLockPop(Vec); 505 #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) 506 #else 507 #define VecLockGet(x,arg) *(arg) = 0 508 #define VecLockPush(x) 0 509 #define VecLockPop(x) 0 510 #define VecLocked(x,arg) 511 #endif 512 513 PETSC_EXTERN PetscErrorCode VecValidValues(Vec,PetscInt,PetscBool); 514 515 /* 516 These numbers need to match the entries in 517 the function table in vecimpl.h 518 */ 519 typedef enum { VECOP_DUPLICATE = 0, VECOP_VIEW = 33, VECOP_LOAD = 41, VECOP_VIEWNATIVE = 68, VECOP_LOADNATIVE = 69 } VecOperation; 520 PETSC_EXTERN PetscErrorCode VecSetOperation(Vec,VecOperation,void(*)(void)); 521 522 /* 523 Routines for dealing with ghosted vectors: 524 vectors with ghost elements at the end of the array. 525 */ 526 PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec,PetscInt,const PetscInt[]); 527 PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 528 PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 529 PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 530 PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 531 PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec,Vec*); 532 PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec,Vec*); 533 PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec,Vec,PetscBool*); 534 PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 535 PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 536 537 PETSC_EXTERN PetscErrorCode VecConjugate(Vec); 538 539 PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec,VecScatter*,Vec*); 540 PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec,VecScatter*,Vec*); 541 542 PETSC_EXTERN PetscErrorCode ISComplementVec(IS,Vec,IS*); 543 PETSC_EXTERN PetscErrorCode VecPow(Vec, PetscScalar); 544 PETSC_EXTERN PetscErrorCode VecMedian(Vec, Vec, Vec, Vec); 545 PETSC_EXTERN PetscErrorCode VecWhichBetween(Vec, Vec, Vec, IS *); 546 PETSC_EXTERN PetscErrorCode VecWhichBetweenOrEqual(Vec, Vec, Vec, IS *); 547 PETSC_EXTERN PetscErrorCode VecWhichGreaterThan(Vec, Vec, IS * ); 548 PETSC_EXTERN PetscErrorCode VecWhichLessThan(Vec, Vec, IS *); 549 PETSC_EXTERN PetscErrorCode VecWhichEqual(Vec, Vec, IS *); 550 PETSC_EXTERN PetscErrorCode VecISAXPY(Vec, IS, PetscScalar,Vec); 551 PETSC_EXTERN PetscErrorCode VecISSet(Vec,IS, PetscScalar); 552 PETSC_EXTERN PetscErrorCode VecBoundGradientProjection(Vec, Vec, Vec, Vec, Vec); 553 PETSC_EXTERN PetscErrorCode VecStepBoundInfo(Vec,Vec,Vec,Vec,PetscReal*, PetscReal*,PetscReal*); 554 PETSC_EXTERN PetscErrorCode VecStepMax(Vec, Vec, PetscReal *); 555 PETSC_EXTERN PetscErrorCode VecStepMaxBounded(Vec,Vec,Vec,Vec,PetscReal*); 556 557 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec); 558 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec); 559 560 /*S 561 Vecs - Collection of vectors where the data for the vectors is stored in 562 one contiguous memory 563 564 Level: advanced 565 566 Notes: 567 Temporary construct for handling multiply right hand side solves 568 569 This is faked by storing a single vector that has enough array space for 570 n vectors 571 572 Concepts: parallel decomposition 573 574 S*/ 575 struct _n_Vecs {PetscInt n; Vec v;}; 576 typedef struct _n_Vecs* Vecs; 577 PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs); 578 PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm,PetscInt,PetscInt,Vecs*); 579 PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,PetscScalar*,Vecs*); 580 PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs,Vecs*); 581 582 #if defined(PETSC_HAVE_CUSP) 583 typedef struct _p_PetscCUSPIndices* PetscCUSPIndices; 584 typedef struct _p_VecScatterCUSPIndices_StoS* VecScatterCUSPIndices_StoS; 585 typedef struct _p_VecScatterCUSPIndices_PtoP* VecScatterCUSPIndices_PtoP; 586 PETSC_EXTERN PetscErrorCode VecCUSPCopyToGPUSome_Public(Vec,PetscCUSPIndices); 587 PETSC_EXTERN PetscErrorCode VecCUSPCopyFromGPUSome_Public(Vec,PetscCUSPIndices); 588 PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter,Vec,ScatterMode); 589 PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter); 590 PETSC_EXTERN PetscErrorCode VecCreateSeqCUSP(MPI_Comm,PetscInt,Vec*); 591 PETSC_EXTERN PetscErrorCode VecCreateMPICUSP(MPI_Comm,PetscInt,PetscInt,Vec*); 592 #elif defined(PETSC_HAVE_VIENNACL) 593 typedef struct _p_PetscViennaCLIndices* PetscViennaCLIndices; 594 PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesCreate(PetscInt, PetscInt*,PetscInt, PetscInt*,PetscViennaCLIndices*); 595 PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesDestroy(PetscViennaCLIndices*); 596 PETSC_EXTERN PetscErrorCode VecViennaCLCopyToGPUSome_Public(Vec,PetscViennaCLIndices); 597 PETSC_EXTERN PetscErrorCode VecViennaCLCopyFromGPUSome_Public(Vec,PetscViennaCLIndices); 598 PETSC_EXTERN PetscErrorCode VecCreateSeqViennaCL(MPI_Comm,PetscInt,Vec*); 599 PETSC_EXTERN PetscErrorCode VecCreateMPIViennaCL(MPI_Comm,PetscInt,PetscInt,Vec*); 600 #elif defined(PETSC_HAVE_VECCUDA) 601 typedef struct _p_PetscCUDAIndices* PetscCUDAIndices; 602 typedef struct _p_VecScatterCUDAIndices_StoS* VecScatterCUDAIndices_StoS; 603 typedef struct _p_VecScatterCUDAIndices_PtoP* VecScatterCUDAIndices_PtoP; 604 PETSC_EXTERN PetscErrorCode VecCUDACopyToGPUSome_Public(Vec,PetscCUDAIndices); 605 PETSC_EXTERN PetscErrorCode VecCUDACopyFromGPUSome_Public(Vec,PetscCUDAIndices); 606 PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter,Vec,ScatterMode); 607 PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter); 608 PETSC_EXTERN PetscErrorCode VecCreateSeqCUDA(MPI_Comm,PetscInt,Vec*); 609 PETSC_EXTERN PetscErrorCode VecCreateSeqCUDAWithArray(MPI_Comm,PetscInt,PetscInt,const PetscScalar*,Vec*); 610 PETSC_EXTERN PetscErrorCode VecCreateMPICUDA(MPI_Comm,PetscInt,PetscInt,Vec*); 611 PETSC_EXTERN PetscErrorCode VecCreateMPICUDAWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar*,Vec*); 612 #endif 613 614 PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec,PetscInt*,Vec**); 615 PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec,PetscInt,Vec*); 616 PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec,PetscInt,PetscInt*,Vec*); 617 PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec,PetscInt,Vec); 618 PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm,PetscInt,IS*,Vec*,Vec*); 619 PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec,PetscInt*); 620 621 PETSC_EXTERN PetscErrorCode PetscOptionsGetVec(PetscOptions,const char[],const char[],Vec,PetscBool*); 622 PETSC_EXTERN PetscErrorCode VecChop(Vec,PetscReal); 623 624 PETSC_EXTERN PetscErrorCode VecGetLayout(Vec,PetscLayout*); 625 PETSC_EXTERN PetscErrorCode VecSetLayout(Vec,PetscLayout); 626 627 PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer); 628 PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar **); 629 PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, PetscScalar [], InsertMode); 630 PETSC_EXTERN PetscErrorCode PetscSectionVecNorm(PetscSection, PetscSection, Vec, NormType, PetscReal []); 631 632 PETSC_EXTERN PetscErrorCode PetscSFCreateFromZero(MPI_Comm,Vec,PetscSF*); 633 PETSC_EXTERN PetscErrorCode PetscSFCreateFromZeroMPI1(MPI_Comm,Vec,PetscSF*); 634 635 /*S 636 VecTagger - Object used to manage the tagging of a subset of indices based on the values of a vector. The 637 motivating application is the selection of cells for refinement or coarsening based on vector containing 638 the values in an error indicator metric. 639 640 Level: advanced 641 S*/ 642 typedef struct _p_VecTagger *VecTagger; 643 644 /*J 645 VecTaggerType - String with the name of a VecTagger type 646 647 Level: advanced 648 J*/ 649 typedef const char* VecTaggerType; 650 /* tag where the vector values are in a box of explicitly defined values */ 651 #define VECTAGGERABSOLUTE "absolute" 652 /* tag where the vector values are in a box of values relative to the set of all values in the vector */ 653 #define VECTAGGERRELATIVE "relative" 654 /* tag where the vector values are in a relative range of the *cumulative distribution* of values in the vector */ 655 #define VECTAGGERCDF "cdf" 656 /* tag a vector as the union of other tags */ 657 #define VECTAGGEROR "or" 658 /* tag a vector as the intersection of other tags */ 659 #define VECTAGGERAND "and" 660 661 PETSC_EXTERN PetscClassId VEC_TAGGER_CLASSID; 662 PETSC_EXTERN PetscFunctionList VecTaggerList; 663 PETSC_EXTERN PetscErrorCode VecTaggerRegister(const char[],PetscErrorCode (*) (VecTagger)); 664 665 PETSC_EXTERN PetscErrorCode VecTaggerCreate(MPI_Comm,VecTagger *); 666 PETSC_EXTERN PetscErrorCode VecTaggerSetBlockSize(VecTagger,PetscInt); 667 PETSC_EXTERN PetscErrorCode VecTaggerGetBlockSize(VecTagger,PetscInt*); 668 PETSC_EXTERN PetscErrorCode VecTaggerSetType(VecTagger,VecTaggerType); 669 PETSC_EXTERN PetscErrorCode VecTaggerGetType(VecTagger,VecTaggerType *); 670 PETSC_EXTERN PetscErrorCode VecTaggerSetInvert(VecTagger,PetscBool); 671 PETSC_EXTERN PetscErrorCode VecTaggerGetInvert(VecTagger,PetscBool*); 672 PETSC_EXTERN PetscErrorCode VecTaggerSetFromOptions(VecTagger); 673 PETSC_EXTERN PetscErrorCode VecTaggerSetUp(VecTagger); 674 PETSC_EXTERN PetscErrorCode VecTaggerView(VecTagger,PetscViewer); 675 PETSC_EXTERN PetscErrorCode VecTaggerComputeIS(VecTagger,Vec,IS *); 676 PETSC_EXTERN PetscErrorCode VecTaggerDestroy(VecTagger *); 677 678 /*S 679 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 680 such that real(min) <= real(z) <= real(max) and imag(min) <= imag(z) <= imag(max). INF is an acceptable endpoint. 681 682 Level: beginner 683 684 .seealso: VecTaggerComputeIntervals() 685 S*/ 686 typedef struct { 687 PetscScalar min; 688 PetscScalar max; 689 } VecTaggerBox; 690 PETSC_EXTERN PetscErrorCode VecTaggerComputeBoxes(VecTagger,Vec,PetscInt *,VecTaggerBox **); 691 692 693 PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteSetBox(VecTagger,VecTaggerBox *); 694 PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteGetBox(VecTagger,const VecTaggerBox **); 695 696 PETSC_EXTERN PetscErrorCode VecTaggerRelativeSetBox(VecTagger,VecTaggerBox *); 697 PETSC_EXTERN PetscErrorCode VecTaggerRelativeGetBox(VecTagger,const VecTaggerBox **); 698 699 PETSC_EXTERN PetscErrorCode VecTaggerCDFSetBox(VecTagger,VecTaggerBox *); 700 PETSC_EXTERN PetscErrorCode VecTaggerCDFGetBox(VecTagger,const VecTaggerBox **); 701 702 /*E 703 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. 704 705 Level: advanced 706 .seealso: VecTaggerCDFSetMethod(), VecTaggerCDFMethods 707 E*/ 708 typedef enum {VECTAGGER_CDF_GATHER,VECTAGGER_CDF_ITERATIVE,VECTAGGER_CDF_NUM_METHODS} VecTaggerCDFMethod; 709 PETSC_EXTERN const char *const VecTaggerCDFMethods[]; 710 711 PETSC_EXTERN PetscErrorCode VecTaggerCDFSetMethod(VecTagger,VecTaggerCDFMethod); 712 PETSC_EXTERN PetscErrorCode VecTaggerCDFGetMethod(VecTagger,VecTaggerCDFMethod*); 713 PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeSetTolerances(VecTagger,PetscInt,PetscReal,PetscReal); 714 PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeGetTolerances(VecTagger,PetscInt*,PetscReal*,PetscReal*); 715 716 PETSC_EXTERN PetscErrorCode VecTaggerOrSetSubs(VecTagger,PetscInt,VecTagger*,PetscCopyMode); 717 PETSC_EXTERN PetscErrorCode VecTaggerOrGetSubs(VecTagger,PetscInt*,VecTagger**); 718 719 PETSC_EXTERN PetscErrorCode VecTaggerAndSetSubs(VecTagger,PetscInt,VecTagger*,PetscCopyMode); 720 PETSC_EXTERN PetscErrorCode VecTaggerAndGetSubs(VecTagger,PetscInt*,VecTagger**); 721 722 PETSC_EXTERN PetscErrorCode VecTaggerInitializePackage(void); 723 PETSC_EXTERN PetscErrorCode VecTaggerFinalizePackage(void); 724 725 #endif 726 727