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 or the creation function 90 with an optional dynamic library name, for example 91 http://www.mcs.anl.gov/petsc/lib.a:myveccreate() 92 93 Level: beginner 94 95 .seealso: VecSetType(), Vec 96 J*/ 97 typedef const char* VecType; 98 #define VECSEQ "seq" 99 #define VECMPI "mpi" 100 #define VECSTANDARD "standard" /* seq on one process and mpi on several */ 101 #define VECSHARED "shared" 102 #define VECSIEVE "sieve" 103 #define VECSEQCUSP "seqcusp" 104 #define VECMPICUSP "mpicusp" 105 #define VECCUSP "cusp" /* seqcusp on one process and mpicusp on several */ 106 #define VECSEQVIENNACL "seqviennacl" 107 #define VECMPIVIENNACL "mpiviennacl" 108 #define VECVIENNACL "viennacl" /* seqviennacl on one process and mpiviennacl on several */ 109 #define VECNEST "nest" 110 #define VECSEQPTHREAD "seqpthread" 111 #define VECMPIPTHREAD "mpipthread" 112 #define VECPTHREAD "pthread" /* seqpthread on one process and mpipthread on several */ 113 114 115 /* Logging support */ 116 #define VEC_FILE_CLASSID 1211214 117 PETSC_EXTERN PetscClassId VEC_CLASSID; 118 PETSC_EXTERN PetscClassId VEC_SCATTER_CLASSID; 119 120 121 PETSC_EXTERN PetscErrorCode VecInitializePackage(void); 122 PETSC_EXTERN PetscErrorCode VecFinalizePackage(void); 123 124 PETSC_EXTERN PetscErrorCode VecCreate(MPI_Comm,Vec*); 125 PETSC_EXTERN PetscErrorCode VecCreateSeq(MPI_Comm,PetscInt,Vec*); 126 PETSC_EXTERN PetscErrorCode VecCreateMPI(MPI_Comm,PetscInt,PetscInt,Vec*); 127 PETSC_EXTERN PetscErrorCode VecCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,const PetscScalar[],Vec*); 128 PETSC_EXTERN PetscErrorCode VecCreateMPIWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar[],Vec*); 129 PETSC_EXTERN PetscErrorCode VecCreateShared(MPI_Comm,PetscInt,PetscInt,Vec*); 130 PETSC_EXTERN PetscErrorCode VecSetFromOptions(Vec); 131 PETSC_EXTERN PetscErrorCode VecViewFromOptions(Vec,const char[],const char[]); 132 133 PETSC_EXTERN PetscErrorCode VecSetUp(Vec); 134 PETSC_EXTERN PetscErrorCode VecDestroy(Vec*); 135 PETSC_EXTERN PetscErrorCode VecZeroEntries(Vec); 136 PETSC_EXTERN PetscErrorCode VecSetOptionsPrefix(Vec,const char[]); 137 PETSC_EXTERN PetscErrorCode VecAppendOptionsPrefix(Vec,const char[]); 138 PETSC_EXTERN PetscErrorCode VecGetOptionsPrefix(Vec,const char*[]); 139 140 PETSC_EXTERN PetscErrorCode VecSetSizes(Vec,PetscInt,PetscInt); 141 142 PETSC_EXTERN PetscErrorCode VecDotNorm2(Vec,Vec,PetscScalar*,PetscReal*); 143 PETSC_EXTERN PetscErrorCode VecDot(Vec,Vec,PetscScalar*); 144 PETSC_EXTERN PetscErrorCode VecDotRealPart(Vec,Vec,PetscReal*); 145 PETSC_EXTERN PetscErrorCode VecTDot(Vec,Vec,PetscScalar*); 146 PETSC_EXTERN PetscErrorCode VecMDot(Vec,PetscInt,const Vec[],PetscScalar[]); 147 PETSC_EXTERN PetscErrorCode VecMTDot(Vec,PetscInt,const Vec[],PetscScalar[]); 148 PETSC_EXTERN PetscErrorCode VecGetSubVector(Vec,IS,Vec*); 149 PETSC_EXTERN PetscErrorCode VecRestoreSubVector(Vec,IS,Vec*); 150 151 /*E 152 NormType - determines what type of norm to compute 153 154 Level: beginner 155 156 .seealso: VecNorm(), VecNormBegin(), VecNormEnd(), MatNorm() 157 E*/ 158 typedef enum {NORM_1=0,NORM_2=1,NORM_FROBENIUS=2,NORM_INFINITY=3,NORM_1_AND_2=4} NormType; 159 PETSC_EXTERN const char *const NormTypes[]; 160 #define NORM_MAX NORM_INFINITY 161 162 /*MC 163 NORM_1 - the one norm, ||v|| = sum_i | v_i |. ||A|| = max_j || v_*j ||, maximum column sum 164 165 Level: beginner 166 167 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_2, NORM_FROBENIUS, 168 NORM_INFINITY, NORM_1_AND_2 169 170 M*/ 171 172 /*MC 173 NORM_2 - the two norm, ||v|| = sqrt(sum_i (v_i)^2) (vectors only) 174 175 Level: beginner 176 177 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_FROBENIUS, 178 NORM_INFINITY, NORM_1_AND_2 179 180 M*/ 181 182 /*MC 183 NORM_FROBENIUS - ||A|| = sqrt(sum_ij (A_ij)^2), same as NORM_2 for vectors 184 185 Level: beginner 186 187 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2, 188 NORM_INFINITY, NORM_1_AND_2 189 190 M*/ 191 192 /*MC 193 NORM_INFINITY - ||v|| = max_i |v_i|. ||A|| = max_i || v_i* ||, maximum row sum 194 195 Level: beginner 196 197 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2, 198 NORM_FROBINIUS, NORM_1_AND_2 199 200 M*/ 201 202 /*MC 203 NORM_1_AND_2 - computes both the 1 and 2 norm of a vector 204 205 Level: beginner 206 207 .seealso: NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2, 208 NORM_FROBINIUS, NORM_INFINITY 209 210 M*/ 211 212 /*MC 213 NORM_MAX - see NORM_INFINITY 214 215 Level: beginner 216 217 M*/ 218 219 PETSC_EXTERN PetscErrorCode VecNorm(Vec,NormType,PetscReal *); 220 PETSC_EXTERN PetscErrorCode VecNormAvailable(Vec,NormType,PetscBool *,PetscReal *); 221 PETSC_EXTERN PetscErrorCode VecNormalize(Vec,PetscReal *); 222 PETSC_EXTERN PetscErrorCode VecSum(Vec,PetscScalar*); 223 PETSC_EXTERN PetscErrorCode VecMax(Vec,PetscInt*,PetscReal *); 224 PETSC_EXTERN PetscErrorCode VecMin(Vec,PetscInt*,PetscReal *); 225 PETSC_EXTERN PetscErrorCode VecScale(Vec,PetscScalar); 226 PETSC_EXTERN PetscErrorCode VecCopy(Vec,Vec); 227 PETSC_EXTERN PetscErrorCode VecSetRandom(Vec,PetscRandom); 228 PETSC_EXTERN PetscErrorCode VecSet(Vec,PetscScalar); 229 PETSC_EXTERN PetscErrorCode VecSwap(Vec,Vec); 230 PETSC_EXTERN PetscErrorCode VecAXPY(Vec,PetscScalar,Vec); 231 PETSC_EXTERN PetscErrorCode VecAXPBY(Vec,PetscScalar,PetscScalar,Vec); 232 PETSC_EXTERN PetscErrorCode VecMAXPY(Vec,PetscInt,const PetscScalar[],Vec[]); 233 PETSC_EXTERN PetscErrorCode VecAYPX(Vec,PetscScalar,Vec); 234 PETSC_EXTERN PetscErrorCode VecWAXPY(Vec,PetscScalar,Vec,Vec); 235 PETSC_EXTERN PetscErrorCode VecAXPBYPCZ(Vec,PetscScalar,PetscScalar,PetscScalar,Vec,Vec); 236 PETSC_EXTERN PetscErrorCode VecPointwiseMax(Vec,Vec,Vec); 237 PETSC_EXTERN PetscErrorCode VecPointwiseMaxAbs(Vec,Vec,Vec); 238 PETSC_EXTERN PetscErrorCode VecPointwiseMin(Vec,Vec,Vec); 239 PETSC_EXTERN PetscErrorCode VecPointwiseMult(Vec,Vec,Vec); 240 PETSC_EXTERN PetscErrorCode VecPointwiseDivide(Vec,Vec,Vec); 241 PETSC_EXTERN PetscErrorCode VecMaxPointwiseDivide(Vec,Vec,PetscReal*); 242 PETSC_EXTERN PetscErrorCode VecShift(Vec,PetscScalar); 243 PETSC_EXTERN PetscErrorCode VecReciprocal(Vec); 244 PETSC_EXTERN PetscErrorCode VecPermute(Vec, IS, PetscBool ); 245 PETSC_EXTERN PetscErrorCode VecSqrtAbs(Vec); 246 PETSC_EXTERN PetscErrorCode VecLog(Vec); 247 PETSC_EXTERN PetscErrorCode VecExp(Vec); 248 PETSC_EXTERN PetscErrorCode VecAbs(Vec); 249 PETSC_EXTERN PetscErrorCode VecDuplicate(Vec,Vec*); 250 PETSC_EXTERN PetscErrorCode VecDuplicateVecs(Vec,PetscInt,Vec*[]); 251 PETSC_EXTERN PetscErrorCode VecDestroyVecs(PetscInt, Vec*[]); 252 PETSC_EXTERN PetscErrorCode VecStrideNormAll(Vec,NormType,PetscReal[]); 253 PETSC_EXTERN PetscErrorCode VecStrideMaxAll(Vec,PetscInt [],PetscReal []); 254 PETSC_EXTERN PetscErrorCode VecStrideMinAll(Vec,PetscInt [],PetscReal []); 255 PETSC_EXTERN PetscErrorCode VecStrideScaleAll(Vec,const 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 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 VecStashGetInfo(Vec,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 276 277 /*MC 278 VecSetValue - Set a single entry into a vector. 279 280 Synopsis: 281 #include "petscvec.h" 282 PetscErrorCode VecSetValue(Vec v,PetscInt row,PetscScalar value, InsertMode mode); 283 284 Not Collective 285 286 Input Parameters: 287 + v - the vector 288 . row - the row location of the entry 289 . value - the value to insert 290 - mode - either INSERT_VALUES or ADD_VALUES 291 292 Notes: 293 For efficiency one should use VecSetValues() and set several or 294 many values simultaneously if possible. 295 296 These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd() 297 MUST be called after all calls to VecSetValues() have been completed. 298 299 VecSetValues() uses 0-based indices in Fortran as well as in C. 300 301 Level: beginner 302 303 .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValueLocal() 304 M*/ 305 PETSC_STATIC_INLINE PetscErrorCode VecSetValue(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValues(v,1,&i,&va,mode);} 306 307 308 PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec,PetscInt); 309 PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec,PetscInt*); 310 PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 311 312 /* Dynamic creation and loading functions */ 313 PETSC_EXTERN PetscFunctionList VecList; 314 PETSC_EXTERN PetscBool VecRegisterAllCalled; 315 PETSC_EXTERN PetscErrorCode VecSetType(Vec, VecType); 316 PETSC_EXTERN PetscErrorCode VecGetType(Vec, VecType *); 317 PETSC_EXTERN PetscErrorCode VecRegister(const char[],PetscErrorCode (*)(Vec)); 318 PETSC_EXTERN PetscErrorCode VecRegisterAll(void); 319 320 PETSC_EXTERN PetscErrorCode VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 321 PETSC_EXTERN PetscErrorCode VecScatterCreateEmpty(MPI_Comm,VecScatter *); 322 PETSC_EXTERN PetscErrorCode VecScatterCreateLocal(VecScatter,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt); 323 PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter,Vec,Vec,InsertMode,ScatterMode); 324 PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter,Vec,Vec,InsertMode,ScatterMode); 325 PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter*); 326 PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter,VecScatter *); 327 PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter,PetscViewer); 328 PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter,PetscInt *,PetscInt*); 329 PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter,PetscBool *); 330 331 PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 332 PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 333 PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 334 PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 335 PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 336 PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 337 PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]); 338 PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]); 339 340 PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec,const PetscScalar[]); 341 PETSC_EXTERN PetscErrorCode VecResetArray(Vec); 342 PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec,const PetscScalar[]); 343 PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[],PetscInt,PetscScalar**[]); 344 PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[],PetscInt,PetscScalar**[]); 345 346 PETSC_EXTERN PetscErrorCode VecView(Vec,PetscViewer); 347 PETSC_EXTERN PetscErrorCode VecEqual(Vec,Vec,PetscBool *); 348 PETSC_EXTERN PetscErrorCode VecLoad(Vec, PetscViewer); 349 350 PETSC_EXTERN PetscErrorCode VecGetSize(Vec,PetscInt*); 351 PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec,PetscInt*); 352 PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec,PetscInt*,PetscInt*); 353 PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec,const PetscInt *[]); 354 355 PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping); 356 PETSC_EXTERN PetscErrorCode VecSetValuesLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 357 358 /*MC 359 VecSetValueLocal - Set a single entry into a vector using the local numbering 360 361 Synopsis: 362 #include "petscvec.h" 363 PetscErrorCode VecSetValueLocal(Vec v,PetscInt row,PetscScalar value, InsertMode mode); 364 365 Not Collective 366 367 Input Parameters: 368 + v - the vector 369 . row - the row location of the entry 370 . value - the value to insert 371 - mode - either INSERT_VALUES or ADD_VALUES 372 373 Notes: 374 For efficiency one should use VecSetValues() and set several or 375 many values simultaneously if possible. 376 377 These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd() 378 MUST be called after all calls to VecSetValues() have been completed. 379 380 VecSetValues() uses 0-based indices in Fortran as well as in C. 381 382 Level: beginner 383 384 .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValue() 385 M*/ 386 PETSC_STATIC_INLINE PetscErrorCode VecSetValueLocal(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValuesLocal(v,1,&i,&va,mode);} 387 388 PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping); 389 PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 390 PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping*); 391 PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping*); 392 393 PETSC_EXTERN PetscErrorCode VecDotBegin(Vec,Vec,PetscScalar *); 394 PETSC_EXTERN PetscErrorCode VecDotEnd(Vec,Vec,PetscScalar *); 395 PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec,Vec,PetscScalar *); 396 PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec,Vec,PetscScalar *); 397 PETSC_EXTERN PetscErrorCode VecNormBegin(Vec,NormType,PetscReal *); 398 PETSC_EXTERN PetscErrorCode VecNormEnd(Vec,NormType,PetscReal *); 399 400 PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]); 401 PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]); 402 PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]); 403 PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]); 404 PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm); 405 406 407 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES,VEC_IGNORE_NEGATIVE_INDICES} VecOption; 408 PETSC_EXTERN PetscErrorCode VecSetOption(Vec,VecOption,PetscBool ); 409 410 PETSC_EXTERN PetscErrorCode VecGetArray(Vec,PetscScalar**); 411 PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec,const PetscScalar**); 412 PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec,PetscScalar**); 413 PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec,const PetscScalar**); 414 415 PETSC_EXTERN PetscErrorCode VecValidValues(Vec,PetscInt,PetscBool); 416 417 PETSC_EXTERN PetscErrorCode VecContourScale(Vec,PetscReal,PetscReal); 418 419 /* 420 These numbers need to match the entries in 421 the function table in vecimpl.h 422 */ 423 typedef enum { VECOP_VIEW = 33, VECOP_LOAD = 41, VECOP_DUPLICATE = 0} VecOperation; 424 PETSC_EXTERN PetscErrorCode VecSetOperation(Vec,VecOperation,void(*)(void)); 425 426 /* 427 Routines for dealing with ghosted vectors: 428 vectors with ghost elements at the end of the array. 429 */ 430 PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec,PetscInt,const PetscInt[]); 431 PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 432 PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 433 PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 434 PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 435 PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec,Vec*); 436 PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec,Vec*); 437 PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec,Vec,PetscBool*); 438 PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 439 PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 440 441 PETSC_EXTERN PetscErrorCode VecConjugate(Vec); 442 443 PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec,VecScatter*,Vec*); 444 PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec,VecScatter*,Vec*); 445 446 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec); 447 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec); 448 449 /*S 450 Vecs - Collection of vectors where the data for the vectors is stored in 451 one contiguous memory 452 453 Level: advanced 454 455 Notes: 456 Temporary construct for handling multiply right hand side solves 457 458 This is faked by storing a single vector that has enough array space for 459 n vectors 460 461 Concepts: parallel decomposition 462 463 S*/ 464 struct _n_Vecs {PetscInt n; Vec v;}; 465 typedef struct _n_Vecs* Vecs; 466 PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs); 467 PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm,PetscInt,PetscInt,Vecs*); 468 PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,PetscScalar*,Vecs*); 469 PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs,Vecs*); 470 471 #if defined(PETSC_HAVE_CUSP) 472 typedef struct _p_PetscCUSPIndices* PetscCUSPIndices; 473 PETSC_EXTERN PetscErrorCode PetscCUSPIndicesCreate(PetscInt, PetscInt*,PetscInt, PetscInt*,PetscCUSPIndices*); 474 PETSC_EXTERN PetscErrorCode PetscCUSPIndicesDestroy(PetscCUSPIndices*); 475 PETSC_EXTERN PetscErrorCode VecCUSPCopyToGPUSome_Public(Vec,PetscCUSPIndices); 476 PETSC_EXTERN PetscErrorCode VecCUSPCopyFromGPUSome_Public(Vec,PetscCUSPIndices); 477 478 #if defined(PETSC_HAVE_TXPETSCGPU) 479 PETSC_EXTERN PetscErrorCode VecCUSPResetIndexBuffersFlagsGPU_Public(PetscCUSPIndices); 480 PETSC_EXTERN PetscErrorCode VecCUSPCopySomeToContiguousBufferGPU_Public(Vec,PetscCUSPIndices); 481 PETSC_EXTERN PetscErrorCode VecCUSPCopySomeFromContiguousBufferGPU_Public(Vec,PetscCUSPIndices); 482 PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter,Vec,ScatterMode); 483 PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter); 484 #endif 485 486 PETSC_EXTERN PetscErrorCode VecCreateSeqCUSP(MPI_Comm,PetscInt,Vec*); 487 PETSC_EXTERN PetscErrorCode VecCreateMPICUSP(MPI_Comm,PetscInt,PetscInt,Vec*); 488 #endif 489 490 #if defined(PETSC_HAVE_VIENNACL) 491 typedef struct _p_PetscViennaCLIndices* PetscViennaCLIndices; 492 PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesCreate(PetscInt, PetscInt*,PetscInt, PetscInt*,PetscViennaCLIndices*); 493 PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesDestroy(PetscViennaCLIndices*); 494 PETSC_EXTERN PetscErrorCode VecViennaCLCopyToGPUSome_Public(Vec,PetscViennaCLIndices); 495 PETSC_EXTERN PetscErrorCode VecViennaCLCopyFromGPUSome_Public(Vec,PetscViennaCLIndices); 496 PETSC_EXTERN PetscErrorCode VecCreateSeqViennaCL(MPI_Comm,PetscInt,Vec*); 497 PETSC_EXTERN PetscErrorCode VecCreateMPIViennaCL(MPI_Comm,PetscInt,PetscInt,Vec*); 498 #endif 499 500 PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec,PetscInt*,Vec**); 501 PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec,PetscInt,Vec*); 502 PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec,PetscInt,PetscInt*,Vec*); 503 PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec,PetscInt,Vec); 504 PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm,PetscInt,IS*,Vec*,Vec*); 505 PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec,PetscInt*); 506 507 PETSC_EXTERN PetscErrorCode PetscOptionsVec(const char[],const char[],const char[],Vec,PetscBool*); 508 PETSC_EXTERN PetscErrorCode VecChop(Vec,PetscReal); 509 510 PETSC_EXTERN PetscErrorCode VecGetLayout(Vec,PetscLayout*); 511 PETSC_EXTERN PetscErrorCode VecSetLayout(Vec,PetscLayout); 512 513 PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer); 514 PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar **); 515 PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, PetscScalar [], InsertMode); 516 517 #endif 518 519