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 VECSIEVE "sieve" 101 #define VECSEQCUSP "seqcusp" 102 #define VECMPICUSP "mpicusp" 103 #define VECCUSP "cusp" /* seqcusp on one process and mpicusp on several */ 104 #define VECSEQVIENNACL "seqviennacl" 105 #define VECMPIVIENNACL "mpiviennacl" 106 #define VECVIENNACL "viennacl" /* seqviennacl on one process and mpiviennacl on several */ 107 #define VECNEST "nest" 108 #define VECSEQPTHREAD "seqpthread" 109 #define VECMPIPTHREAD "mpipthread" 110 #define VECPTHREAD "pthread" /* seqpthread on one process and mpipthread on several */ 111 112 113 /* Logging support */ 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,const char prefix[],const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,prefix,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 VecSwap(Vec,Vec); 228 PETSC_EXTERN PetscErrorCode VecAXPY(Vec,PetscScalar,Vec); 229 PETSC_EXTERN PetscErrorCode VecAXPBY(Vec,PetscScalar,PetscScalar,Vec); 230 PETSC_EXTERN PetscErrorCode VecMAXPY(Vec,PetscInt,const PetscScalar[],Vec[]); 231 PETSC_EXTERN PetscErrorCode VecAYPX(Vec,PetscScalar,Vec); 232 PETSC_EXTERN PetscErrorCode VecWAXPY(Vec,PetscScalar,Vec,Vec); 233 PETSC_EXTERN PetscErrorCode VecAXPBYPCZ(Vec,PetscScalar,PetscScalar,PetscScalar,Vec,Vec); 234 PETSC_EXTERN PetscErrorCode VecPointwiseMax(Vec,Vec,Vec); 235 PETSC_EXTERN PetscErrorCode VecPointwiseMaxAbs(Vec,Vec,Vec); 236 PETSC_EXTERN PetscErrorCode VecPointwiseMin(Vec,Vec,Vec); 237 PETSC_EXTERN PetscErrorCode VecPointwiseMult(Vec,Vec,Vec); 238 PETSC_EXTERN PetscErrorCode VecPointwiseDivide(Vec,Vec,Vec); 239 PETSC_EXTERN PetscErrorCode VecMaxPointwiseDivide(Vec,Vec,PetscReal*); 240 PETSC_EXTERN PetscErrorCode VecShift(Vec,PetscScalar); 241 PETSC_EXTERN PetscErrorCode VecReciprocal(Vec); 242 PETSC_EXTERN PetscErrorCode VecPermute(Vec, IS, PetscBool ); 243 PETSC_EXTERN PetscErrorCode VecSqrtAbs(Vec); 244 PETSC_EXTERN PetscErrorCode VecLog(Vec); 245 PETSC_EXTERN PetscErrorCode VecExp(Vec); 246 PETSC_EXTERN PetscErrorCode VecAbs(Vec); 247 PETSC_EXTERN PetscErrorCode VecDuplicate(Vec,Vec*); 248 PETSC_EXTERN PetscErrorCode VecDuplicateVecs(Vec,PetscInt,Vec*[]); 249 PETSC_EXTERN PetscErrorCode VecDestroyVecs(PetscInt, Vec*[]); 250 PETSC_EXTERN PetscErrorCode VecStrideNormAll(Vec,NormType,PetscReal[]); 251 PETSC_EXTERN PetscErrorCode VecStrideMaxAll(Vec,PetscInt [],PetscReal []); 252 PETSC_EXTERN PetscErrorCode VecStrideMinAll(Vec,PetscInt [],PetscReal []); 253 PETSC_EXTERN PetscErrorCode VecStrideScaleAll(Vec,const PetscScalar[]); 254 PETSC_EXTERN PetscErrorCode VecUniqueEntries(Vec,PetscInt*,PetscScalar**); 255 256 PETSC_EXTERN PetscErrorCode VecStrideNorm(Vec,PetscInt,NormType,PetscReal*); 257 PETSC_EXTERN PetscErrorCode VecStrideMax(Vec,PetscInt,PetscInt *,PetscReal *); 258 PETSC_EXTERN PetscErrorCode VecStrideMin(Vec,PetscInt,PetscInt *,PetscReal *); 259 PETSC_EXTERN PetscErrorCode VecStrideScale(Vec,PetscInt,PetscScalar); 260 PETSC_EXTERN PetscErrorCode VecStrideSet(Vec,PetscInt,PetscScalar); 261 262 263 PETSC_EXTERN PetscErrorCode VecStrideGather(Vec,PetscInt,Vec,InsertMode); 264 PETSC_EXTERN PetscErrorCode VecStrideScatter(Vec,PetscInt,Vec,InsertMode); 265 PETSC_EXTERN PetscErrorCode VecStrideGatherAll(Vec,Vec[],InsertMode); 266 PETSC_EXTERN PetscErrorCode VecStrideScatterAll(Vec[],Vec,InsertMode); 267 268 PETSC_EXTERN PetscErrorCode VecSetValues(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 269 PETSC_EXTERN PetscErrorCode VecGetValues(Vec,PetscInt,const PetscInt[],PetscScalar[]); 270 PETSC_EXTERN PetscErrorCode VecAssemblyBegin(Vec); 271 PETSC_EXTERN PetscErrorCode VecAssemblyEnd(Vec); 272 PETSC_EXTERN PetscErrorCode VecStashSetInitialSize(Vec,PetscInt,PetscInt); 273 PETSC_EXTERN PetscErrorCode VecStashView(Vec,PetscViewer); 274 PETSC_EXTERN PetscErrorCode VecStashViewFromOptions(Vec,const char[],const char[]); 275 PETSC_EXTERN PetscErrorCode VecStashGetInfo(Vec,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 276 277 /*MC 278 VecSetValue - Set a single entry into a vector. 279 280 Synopsis: 281 #include "petscvec.h" 282 PetscErrorCode VecSetValue(Vec v,PetscInt row,PetscScalar value, InsertMode mode); 283 284 Not Collective 285 286 Input Parameters: 287 + v - the vector 288 . row - the row location of the entry 289 . value - the value to insert 290 - mode - either INSERT_VALUES or ADD_VALUES 291 292 Notes: 293 For efficiency one should use VecSetValues() and set several or 294 many values simultaneously if possible. 295 296 These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd() 297 MUST be called after all calls to VecSetValues() have been completed. 298 299 VecSetValues() uses 0-based indices in Fortran as well as in C. 300 301 Level: beginner 302 303 .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValueLocal() 304 M*/ 305 PETSC_STATIC_INLINE PetscErrorCode VecSetValue(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValues(v,1,&i,&va,mode);} 306 307 308 PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec,PetscInt); 309 PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec,PetscInt*); 310 PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 311 312 /* Dynamic creation and loading functions */ 313 PETSC_EXTERN PetscFunctionList VecList; 314 PETSC_EXTERN 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_STATIC_INLINE PetscErrorCode VecScatterViewFromOptions(VecScatter A,const char prefix[],const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,prefix,name);} 329 PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter,PetscInt *,PetscInt*); 330 PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter,PetscBool *); 331 332 PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 333 PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]); 334 PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 335 PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]); 336 PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 337 PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]); 338 PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]); 339 PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]); 340 341 PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec,const PetscScalar[]); 342 PETSC_EXTERN PetscErrorCode VecResetArray(Vec); 343 PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec,const PetscScalar[]); 344 PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[],PetscInt,PetscScalar**[]); 345 PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[],PetscInt,PetscScalar**[]); 346 347 PETSC_EXTERN PetscErrorCode VecView(Vec,PetscViewer); 348 PETSC_EXTERN PetscErrorCode VecEqual(Vec,Vec,PetscBool *); 349 PETSC_EXTERN PetscErrorCode VecLoad(Vec, PetscViewer); 350 351 PETSC_EXTERN PetscErrorCode VecGetSize(Vec,PetscInt*); 352 PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec,PetscInt*); 353 PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec,PetscInt*,PetscInt*); 354 PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec,const PetscInt *[]); 355 356 PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping); 357 PETSC_EXTERN PetscErrorCode VecSetValuesLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 358 359 /*MC 360 VecSetValueLocal - Set a single entry into a vector using the local numbering 361 362 Synopsis: 363 #include "petscvec.h" 364 PetscErrorCode VecSetValueLocal(Vec v,PetscInt row,PetscScalar value, InsertMode mode); 365 366 Not Collective 367 368 Input Parameters: 369 + v - the vector 370 . row - the row location of the entry 371 . value - the value to insert 372 - mode - either INSERT_VALUES or ADD_VALUES 373 374 Notes: 375 For efficiency one should use VecSetValues() and set several or 376 many values simultaneously if possible. 377 378 These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd() 379 MUST be called after all calls to VecSetValues() have been completed. 380 381 VecSetValues() uses 0-based indices in Fortran as well as in C. 382 383 Level: beginner 384 385 .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValue() 386 M*/ 387 PETSC_STATIC_INLINE PetscErrorCode VecSetValueLocal(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValuesLocal(v,1,&i,&va,mode);} 388 389 PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping); 390 PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 391 PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping*); 392 PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping*); 393 394 PETSC_EXTERN PetscErrorCode VecDotBegin(Vec,Vec,PetscScalar *); 395 PETSC_EXTERN PetscErrorCode VecDotEnd(Vec,Vec,PetscScalar *); 396 PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec,Vec,PetscScalar *); 397 PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec,Vec,PetscScalar *); 398 PETSC_EXTERN PetscErrorCode VecNormBegin(Vec,NormType,PetscReal *); 399 PETSC_EXTERN PetscErrorCode VecNormEnd(Vec,NormType,PetscReal *); 400 401 PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]); 402 PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]); 403 PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]); 404 PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]); 405 PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm); 406 407 408 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES,VEC_IGNORE_NEGATIVE_INDICES} VecOption; 409 PETSC_EXTERN PetscErrorCode VecSetOption(Vec,VecOption,PetscBool ); 410 411 PETSC_EXTERN PetscErrorCode VecGetArray(Vec,PetscScalar**); 412 PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec,const PetscScalar**); 413 PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec,PetscScalar**); 414 PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec,const PetscScalar**); 415 416 PETSC_EXTERN PetscErrorCode VecValidValues(Vec,PetscInt,PetscBool); 417 418 PETSC_EXTERN PetscErrorCode VecContourScale(Vec,PetscReal,PetscReal); 419 420 /* 421 These numbers need to match the entries in 422 the function table in vecimpl.h 423 */ 424 typedef enum { VECOP_VIEW = 33, VECOP_LOAD = 41, VECOP_DUPLICATE = 0} VecOperation; 425 PETSC_EXTERN PetscErrorCode VecSetOperation(Vec,VecOperation,void(*)(void)); 426 427 /* 428 Routines for dealing with ghosted vectors: 429 vectors with ghost elements at the end of the array. 430 */ 431 PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec,PetscInt,const PetscInt[]); 432 PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 433 PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 434 PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*); 435 PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*); 436 PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec,Vec*); 437 PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec,Vec*); 438 PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec,Vec,PetscBool*); 439 PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 440 PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 441 442 PETSC_EXTERN PetscErrorCode VecConjugate(Vec); 443 444 PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec,VecScatter*,Vec*); 445 PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec,VecScatter*,Vec*); 446 447 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec); 448 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec); 449 450 /*S 451 Vecs - Collection of vectors where the data for the vectors is stored in 452 one contiguous memory 453 454 Level: advanced 455 456 Notes: 457 Temporary construct for handling multiply right hand side solves 458 459 This is faked by storing a single vector that has enough array space for 460 n vectors 461 462 Concepts: parallel decomposition 463 464 S*/ 465 struct _n_Vecs {PetscInt n; Vec v;}; 466 typedef struct _n_Vecs* Vecs; 467 PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs); 468 PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm,PetscInt,PetscInt,Vecs*); 469 PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,PetscScalar*,Vecs*); 470 PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs,Vecs*); 471 472 #if defined(PETSC_HAVE_CUSP) 473 typedef struct _p_PetscCUSPIndices* PetscCUSPIndices; 474 typedef struct _p_VecScatterCUSPIndices_StoS* VecScatterCUSPIndices_StoS; 475 typedef struct _p_VecScatterCUSPIndices_PtoP* VecScatterCUSPIndices_PtoP; 476 PETSC_EXTERN PetscErrorCode VecCUSPCopyToGPUSome_Public(Vec,PetscCUSPIndices); 477 PETSC_EXTERN PetscErrorCode VecCUSPCopyFromGPUSome_Public(Vec,PetscCUSPIndices); 478 PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter,Vec,ScatterMode); 479 PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter); 480 PETSC_EXTERN PetscErrorCode VecCreateSeqCUSP(MPI_Comm,PetscInt,Vec*); 481 PETSC_EXTERN PetscErrorCode VecCreateMPICUSP(MPI_Comm,PetscInt,PetscInt,Vec*); 482 #endif 483 484 #if defined(PETSC_HAVE_VIENNACL) 485 typedef struct _p_PetscViennaCLIndices* PetscViennaCLIndices; 486 PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesCreate(PetscInt, PetscInt*,PetscInt, PetscInt*,PetscViennaCLIndices*); 487 PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesDestroy(PetscViennaCLIndices*); 488 PETSC_EXTERN PetscErrorCode VecViennaCLCopyToGPUSome_Public(Vec,PetscViennaCLIndices); 489 PETSC_EXTERN PetscErrorCode VecViennaCLCopyFromGPUSome_Public(Vec,PetscViennaCLIndices); 490 PETSC_EXTERN PetscErrorCode VecCreateSeqViennaCL(MPI_Comm,PetscInt,Vec*); 491 PETSC_EXTERN PetscErrorCode VecCreateMPIViennaCL(MPI_Comm,PetscInt,PetscInt,Vec*); 492 #endif 493 494 PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec,PetscInt*,Vec**); 495 PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec,PetscInt,Vec*); 496 PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec,PetscInt,PetscInt*,Vec*); 497 PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec,PetscInt,Vec); 498 PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm,PetscInt,IS*,Vec*,Vec*); 499 PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec,PetscInt*); 500 501 PETSC_EXTERN PetscErrorCode PetscOptionsVec(const char[],const char[],const char[],Vec,PetscBool*); 502 PETSC_EXTERN PetscErrorCode VecChop(Vec,PetscReal); 503 504 PETSC_EXTERN PetscErrorCode VecGetLayout(Vec,PetscLayout*); 505 PETSC_EXTERN PetscErrorCode VecSetLayout(Vec,PetscLayout); 506 507 PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer); 508 PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar **); 509 PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, PetscScalar [], InsertMode); 510 511 #endif 512 513