1 #if !defined(__PETSCSYSTYPES_H) 2 #define __PETSCSYSTYPES_H 3 4 #include <petscconf.h> 5 #include <petscfix.h> 6 7 /*MC 8 PetscErrorCode - datatype used for return error code from almost all PETSc functions 9 10 Level: beginner 11 12 .seealso: CHKERRQ, SETERRQ 13 M*/ 14 typedef int PetscErrorCode; 15 16 /*MC 17 18 PetscClassId - A unique id used to identify each PETSc class. 19 20 Notes: 21 Use PetscClassIdRegister() to obtain a new value for a new class being created. Usually 22 XXXInitializePackage() calls it for each class it defines. 23 24 Developer Notes: 25 Internal integer stored in the _p_PetscObject data structure. 26 These are all computed by an offset from the lowest one, PETSC_SMALLEST_CLASSID. 27 28 Level: developer 29 30 .seealso: PetscClassIdRegister(), PetscLogEventRegister(), PetscHeaderCreate() 31 M*/ 32 typedef int PetscClassId; 33 34 /*MC 35 PetscMPIInt - datatype used to represent 'int' parameters to MPI functions. 36 37 Level: intermediate 38 39 Notes: 40 usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but 41 standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt; it remains 32 bit. 42 43 PetscMPIIntCast(a,&b) checks if the given PetscInt a will fit in a PetscMPIInt, if not it 44 generates a PETSC_ERR_ARG_OUTOFRANGE error. 45 46 .seealso: PetscBLASInt, PetscInt, PetscMPIIntCast() 47 48 M*/ 49 typedef int PetscMPIInt; 50 51 /*MC 52 PetscEnum - datatype used to pass enum types within PETSc functions. 53 54 Level: intermediate 55 56 .seealso: PetscOptionsGetEnum(), PetscOptionsEnum(), PetscBagRegisterEnum() 57 M*/ 58 typedef enum { ENUM_DUMMY } PetscEnum; 59 60 typedef short PetscShort; 61 typedef char PetscChar; 62 typedef float PetscFloat; 63 64 /*MC 65 PetscInt - PETSc type that represents an integer, used primarily to 66 represent size of arrays and indexing into arrays. Its size can be configured with the option --with-64-bit-indices to be either 32-bit (default) or 64-bit. 67 68 Notes: 69 For MPI calls that require datatypes, use MPIU_INT as the datatype for PetscInt. It will automatically work correctly regardless of the size of PetscInt. 70 71 Level: beginner 72 73 .seealso: PetscBLASInt, PetscMPIInt, PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT 74 M*/ 75 76 #if defined(PETSC_HAVE_STDINT_H) 77 # include <stdint.h> 78 #endif 79 #if defined (PETSC_HAVE_INTTYPES_H) 80 # if !defined(__STDC_FORMAT_MACROS) 81 # define __STDC_FORMAT_MACROS /* required for using PRId64 from c++ */ 82 # endif 83 # include <inttypes.h> 84 # if !defined(PRId64) 85 # define PRId64 "ld" 86 # endif 87 #endif 88 89 #if defined(PETSC_HAVE_STDINT_H) && defined(PETSC_HAVE_INTTYPES_H) && defined(PETSC_HAVE_MPI_INT64_T) /* MPI_INT64_T is not guaranteed to be a macro */ 90 typedef int64_t PetscInt64; 91 #elif (PETSC_SIZEOF_LONG_LONG == 8) 92 typedef long long PetscInt64; 93 #elif defined(PETSC_HAVE___INT64) 94 typedef __int64 PetscInt64; 95 #else 96 # error "cannot determine PetscInt64 type" 97 #endif 98 99 #if defined(PETSC_USE_64BIT_INDICES) 100 typedef PetscInt64 PetscInt; 101 #else 102 typedef int PetscInt; 103 #endif 104 105 /*MC 106 PetscBLASInt - datatype used to represent 'int' parameters to BLAS/LAPACK functions. 107 108 Notes: 109 Usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but 110 standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt it remains 32 bit 111 (except on very rare BLAS/LAPACK implementations that support 64 bit integers see the note below). 112 113 PetscErrorCode PetscBLASIntCast(a,&b) checks if the given PetscInt a will fit in a PetscBLASInt, if not it 114 generates a PETSC_ERR_ARG_OUTOFRANGE error 115 116 Installation Notes: 117 The 64bit versions of MATLAB ship with BLAS and LAPACK that use 64 bit integers for sizes etc, 118 if you run ./configure with the option 119 --with-blaslapack-lib=[/Applications/MATLAB_R2010b.app/bin/maci64/libmwblas.dylib,/Applications/MATLAB_R2010b.app/bin/maci64/libmwlapack.dylib] 120 but you need to also use --known-64-bit-blas-indices. 121 122 MKL also ships with 64 bit integer versions of the BLAS and LAPACK, if you select those you must also ./configure with 123 --known-64-bit-blas-indices 124 125 OpenBLAS can also be built to use 64 bit integers. The ./configure options --download-openblas -download-openblas-64-bit-blas-indices 126 will build a 64 bit integer version 127 128 Developer Notes: 129 Eventually ./configure should automatically determine the size of the integers used by BLAS/LAPACK. 130 131 External packages such as hypre, ML, SuperLU etc do not provide any support for passing 64 bit integers to BLAS/LAPACK so cannot 132 be used with PETSc if you have set PetscBLASInt to long int. 133 134 Level: intermediate 135 136 .seealso: PetscMPIInt, PetscInt, PetscBLASIntCast() 137 138 M*/ 139 #if defined(PETSC_HAVE_64BIT_BLAS_INDICES) 140 typedef PetscInt64 PetscBLASInt; 141 #else 142 typedef int PetscBLASInt; 143 #endif 144 145 /*E 146 PetscBool - Logical variable. Actually an int in C and a logical in Fortran. 147 148 Level: beginner 149 150 Developer Note: 151 Why have PetscBool , why not use bool in C? The problem is that K and R C, C99 and C++ all have different mechanisms for 152 boolean values. It is not easy to have a simple macro that that will work properly in all circumstances with all three mechanisms. 153 154 .seealso: PETSC_TRUE, PETSC_FALSE, PetscNot() 155 E*/ 156 typedef enum { PETSC_FALSE,PETSC_TRUE } PetscBool; 157 158 /*MC 159 PetscReal - PETSc type that represents a real number version of PetscScalar 160 161 162 Notes: 163 For MPI calls that require datatypes, use MPIU_REAL as the datatype for PetscScalar and MPIU_SUM, MPIU_MAX, etc. for operations. 164 They will automatically work correctly regardless of the size of PetscReal. 165 166 See PetscScalar for details on how to ./configure the size of PetscReal. 167 168 Level: beginner 169 170 .seealso: PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT 171 M*/ 172 173 #if defined(PETSC_USE_REAL_SINGLE) 174 typedef float PetscReal; 175 #elif defined(PETSC_USE_REAL_DOUBLE) 176 typedef double PetscReal; 177 #elif defined(PETSC_USE_REAL___FLOAT128) 178 # if defined(__cplusplus) 179 extern "C" { 180 # endif 181 # include <quadmath.h> 182 # if defined(__cplusplus) 183 } 184 # endif 185 typedef __float128 PetscReal; 186 #elif defined(PETSC_USE_REAL___FP16) 187 typedef __fp16 PetscReal; 188 #endif /* PETSC_USE_REAL_* */ 189 190 /*MC 191 PetscComplex - PETSc type that represents a complex number with precision matching that of PetscReal. 192 193 Synopsis: 194 #include <petscsys.h> 195 PetscComplex number = 1. + 2.*PETSC_i; 196 197 Notes: 198 For MPI calls that require datatypes, use MPIU_COMPLEX as the datatype for PetscComplex and MPIU_SUM etc for operations. 199 They will automatically work correctly regardless of the size of PetscComplex. 200 201 See PetscScalar for details on how to ./configure the size of PetscReal 202 203 Complex numbers are automatically available if PETSc was able to find a working complex implementation 204 205 Level: beginner 206 207 .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT, PETSC_i 208 M*/ 209 210 #if defined(__cplusplus) && defined(PETSC_HAVE_CXX_COMPLEX) && !defined(PETSC_USE_REAL___FLOAT128) 211 # if !defined(PETSC_SKIP_COMPLEX) 212 /* C++ support of complex number */ 213 # define PETSC_HAVE_COMPLEX 1 214 # if defined(PETSC_HAVE_CUDA) && __CUDACC_VER_MAJOR__ > 6 215 /* complex headers in thrust only available in CUDA 7.0 and above */ 216 # define petsccomplexlib thrust 217 # include <thrust/complex.h> 218 # else 219 # define petsccomplexlib std 220 # include <complex> 221 # endif 222 # if defined(PETSC_USE_REAL_SINGLE) 223 typedef petsccomplexlib::complex<float> PetscComplex; 224 # elif defined(PETSC_USE_REAL_DOUBLE) 225 typedef petsccomplexlib::complex<double> PetscComplex; 226 # elif defined(PETSC_USE_REAL___FLOAT128) 227 typedef petsccomplexlib::complex<__float128> PetscComplex; /* Notstandard and not expected to work, use __complex128 */ 228 # endif /* PETSC_USE_REAL_ */ 229 # endif /* ! PETSC_SKIP_COMPLEX */ 230 #elif defined(PETSC_HAVE_C99_COMPLEX) && !defined(PETSC_USE_REAL___FP16) 231 # if !defined(PETSC_SKIP_COMPLEX) 232 # define PETSC_HAVE_COMPLEX 1 233 # include <complex.h> 234 # if defined(PETSC_USE_REAL_SINGLE) || defined(PETSC_USE_REAL___FP16) 235 typedef float _Complex PetscComplex; 236 # elif defined(PETSC_USE_REAL_DOUBLE) 237 typedef double _Complex PetscComplex; 238 # elif defined(PETSC_USE_REAL___FLOAT128) 239 typedef __complex128 PetscComplex; 240 # endif /* PETSC_USE_REAL_* */ 241 # endif /* !PETSC_SKIP_COMPLEX */ 242 #elif (defined(PETSC_USE_COMPLEX) && !defined(PETSC_SKIP_COMPLEX)) 243 # error "PETSc was configured --with-scalar-type=complex, but a language-appropriate complex library is not available" 244 #endif /* !PETSC_SKIP_COMPLEX */ 245 246 /*MC 247 PetscScalar - PETSc type that represents either a double precision real number, a double precision 248 complex number, a single precision real number, a __float128 real or complex or a __fp16 real - if the code is configured 249 with --with-scalar-type=real,complex --with-precision=single,double,__float128,__fp16 250 251 Notes: 252 For MPI calls that require datatypes, use MPIU_SCALAR as the datatype for PetscScalar and MPIU_SUM, MPIU_MAX etc for operations. They will automatically work correctly regardless of the size of PetscScalar. 253 254 Level: beginner 255 256 .seealso: PetscReal, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT, PetscRealPart(), PetscImaginaryPart() 257 M*/ 258 259 #if (defined(PETSC_USE_COMPLEX) && !defined(PETSC_SKIP_COMPLEX)) 260 typedef PetscComplex PetscScalar; 261 #else /* PETSC_USE_COMPLEX */ 262 typedef PetscReal PetscScalar; 263 #endif /* PETSC_USE_COMPLEX */ 264 265 /*E 266 PetscCopyMode - Determines how an array passed to certain functions is copied or retained 267 268 Level: beginner 269 270 $ PETSC_COPY_VALUES - the array values are copied into new space, the user is free to reuse or delete the passed in array 271 $ PETSC_OWN_POINTER - the array values are NOT copied, the object takes ownership of the array and will free it later, the user cannot change or 272 $ delete the array. The array MUST have been obtained with PetscMalloc(). Hence this mode cannot be used in Fortran. 273 $ PETSC_USE_POINTER - the array values are NOT copied, the object uses the array but does NOT take ownership of the array. The user cannot use 274 the array but the user must delete the array after the object is destroyed. 275 276 E*/ 277 typedef enum {PETSC_COPY_VALUES, PETSC_OWN_POINTER, PETSC_USE_POINTER} PetscCopyMode; 278 279 /*MC 280 PETSC_FALSE - False value of PetscBool 281 282 Level: beginner 283 284 Note: 285 Zero integer 286 287 .seealso: PetscBool, PETSC_TRUE 288 M*/ 289 290 /*MC 291 PETSC_TRUE - True value of PetscBool 292 293 Level: beginner 294 295 Note: 296 Nonzero integer 297 298 .seealso: PetscBool, PETSC_FALSE 299 M*/ 300 301 /*MC 302 PetscLogDouble - Used for logging times 303 304 Notes: 305 Contains double precision numbers that are not used in the numerical computations, but rather in logging, timing etc. 306 307 M*/ 308 typedef double PetscLogDouble; 309 310 /*E 311 PetscDataType - Used for handling different basic data types. 312 313 Level: beginner 314 315 Notes: 316 Use of this should be avoided if one can directly use MPI_Datatype instead. 317 318 Developer comment: 319 It would be nice if we could always just use MPI Datatypes, why can we not? 320 321 .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(), 322 PetscDataTypeGetSize() 323 324 E*/ 325 typedef enum {PETSC_INT = 0, PETSC_DOUBLE = 1, PETSC_COMPLEX = 2, PETSC_LONG = 3, PETSC_SHORT = 4, PETSC_FLOAT = 5, 326 PETSC_CHAR = 6, PETSC_BIT_LOGICAL = 7, PETSC_ENUM = 8, PETSC_BOOL = 9, PETSC___FLOAT128 = 10, 327 PETSC_OBJECT = 11, PETSC_FUNCTION = 12, PETSC_STRING = 13, PETSC___FP16 = 14, PETSC_STRUCT = 15, 328 PETSC_DATATYPE_UNKNOWN = 16} PetscDataType; 329 330 #if defined(PETSC_USE_COMPLEX) 331 # define PETSC_SCALAR PETSC_COMPLEX 332 #else 333 # if defined(PETSC_USE_REAL_SINGLE) 334 # define PETSC_SCALAR PETSC_FLOAT 335 # elif defined(PETSC_USE_REAL___FLOAT128) 336 # define PETSC_SCALAR PETSC___FLOAT128 337 # elif defined(PETSC_USE_REAL___FP16) 338 # define PETSC_SCALAR PETSC___FP16 339 # else 340 # define PETSC_SCALAR PETSC_DOUBLE 341 # endif 342 #endif 343 #if defined(PETSC_USE_REAL_SINGLE) 344 # define PETSC_REAL PETSC_FLOAT 345 #elif defined(PETSC_USE_REAL___FLOAT128) 346 # define PETSC_REAL PETSC___FLOAT128 347 #elif defined(PETSC_USE_REAL___FP16) 348 # define PETSC_REAL PETSC___FP16 349 #else 350 # define PETSC_REAL PETSC_DOUBLE 351 #endif 352 #define PETSC_FORTRANADDR PETSC_LONG 353 354 /*S 355 PetscToken - 'Token' used for managing tokenizing strings 356 357 Level: intermediate 358 359 .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy() 360 S*/ 361 typedef struct _p_PetscToken* PetscToken; 362 363 /*S 364 PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc 365 366 Level: beginner 367 368 Note: 369 This is the base class from which all PETSc objects are derived from. 370 371 .seealso: PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName(), PetscObjectReference(), PetscObjectDereference() 372 S*/ 373 typedef struct _p_PetscObject* PetscObject; 374 375 /*MC 376 PetscObjectId - unique integer Id for a PetscObject 377 378 Level: developer 379 380 Notes: 381 Unlike pointer values, object ids are never reused. 382 383 .seealso: PetscObjectState, PetscObjectGetId() 384 M*/ 385 #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */ 386 typedef int PetscObjectId; 387 #else 388 typedef PetscInt64 PetscObjectId; 389 #endif 390 391 /*MC 392 PetscObjectState - integer state for a PetscObject 393 394 Level: developer 395 396 Notes: 397 Object state is always-increasing and (for objects that track state) can be used to determine if an object has 398 changed since the last time you interacted with it. It is 64-bit so that it will not overflow for a very long time. 399 400 .seealso: PetscObjectId, PetscObjectStateGet(), PetscObjectStateIncrease(), PetscObjectStateSet() 401 M*/ 402 #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */ 403 typedef int PetscObjectState; 404 #else 405 typedef PetscInt64 PetscObjectState; 406 #endif 407 408 /*S 409 PetscFunctionList - Linked list of functions, possibly stored in dynamic libraries, accessed 410 by string name 411 412 Level: advanced 413 414 .seealso: PetscFunctionListAdd(), PetscFunctionListDestroy(), PetscOpFlist 415 S*/ 416 typedef struct _n_PetscFunctionList *PetscFunctionList; 417 418 /*E 419 PetscFileMode - Access mode for a file. 420 421 Level: beginner 422 423 $ FILE_MODE_READ - open a file at its beginning for reading 424 $ FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist) 425 $ FILE_MODE_APPEND - open a file at end for writing 426 $ FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing 427 $ FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end 428 429 .seealso: PetscViewerFileSetMode() 430 E*/ 431 typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode; 432 433 typedef void* PetscDLHandle; 434 typedef enum {PETSC_DL_DECIDE=0,PETSC_DL_NOW=1,PETSC_DL_LOCAL=2} PetscDLMode; 435 436 /*S 437 PetscObjectList - Linked list of PETSc objects, each accessable by string name 438 439 Level: developer 440 441 Notes: 442 Used by PetscObjectCompose() and PetscObjectQuery() 443 444 .seealso: PetscObjectListAdd(), PetscObjectListDestroy(), PetscObjectListFind(), PetscObjectCompose(), PetscObjectQuery(), PetscFunctionList 445 S*/ 446 typedef struct _n_PetscObjectList *PetscObjectList; 447 448 /*S 449 PetscDLLibrary - Linked list of dynamics libraries to search for functions 450 451 Level: advanced 452 453 .seealso: PetscDLLibraryOpen() 454 S*/ 455 typedef struct _n_PetscDLLibrary *PetscDLLibrary; 456 457 /*S 458 PetscContainer - Simple PETSc object that contains a pointer to any required data 459 460 Level: advanced 461 462 .seealso: PetscObject, PetscContainerCreate() 463 S*/ 464 typedef struct _p_PetscContainer* PetscContainer; 465 466 /*S 467 PetscRandom - Abstract PETSc object that manages generating random numbers 468 469 Level: intermediate 470 471 Concepts: random numbers 472 473 .seealso: PetscRandomCreate(), PetscRandomGetValue(), PetscRandomType 474 S*/ 475 typedef struct _p_PetscRandom* PetscRandom; 476 477 /* 478 In binary files variables are stored using the following lengths, 479 regardless of how they are stored in memory on any one particular 480 machine. Use these rather then sizeof() in computing sizes for 481 PetscBinarySeek(). 482 */ 483 #define PETSC_BINARY_INT_SIZE (32/8) 484 #define PETSC_BINARY_FLOAT_SIZE (32/8) 485 #define PETSC_BINARY_CHAR_SIZE (8/8) 486 #define PETSC_BINARY_SHORT_SIZE (16/8) 487 #define PETSC_BINARY_DOUBLE_SIZE (64/8) 488 #define PETSC_BINARY_SCALAR_SIZE sizeof(PetscScalar) 489 490 /*E 491 PetscBinarySeekType - argument to PetscBinarySeek() 492 493 Level: advanced 494 495 .seealso: PetscBinarySeek(), PetscBinarySynchronizedSeek() 496 E*/ 497 typedef enum {PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1,PETSC_BINARY_SEEK_END = 2} PetscBinarySeekType; 498 499 /*E 500 PetscBuildTwoSidedType - algorithm for setting up two-sided communication 501 502 $ PETSC_BUILDTWOSIDED_ALLREDUCE - classical algorithm using an MPI_Allreduce with 503 $ a buffer of length equal to the communicator size. Not memory-scalable due to 504 $ the large reduction size. Requires only MPI-1. 505 $ PETSC_BUILDTWOSIDED_IBARRIER - nonblocking algorithm based on MPI_Issend and MPI_Ibarrier. 506 $ Proved communication-optimal in Hoefler, Siebert, and Lumsdaine (2010). Requires MPI-3. 507 $ PETSC_BUILDTWOSIDED_REDSCATTER - similar to above, but use more optimized function 508 $ that only communicates the part of the reduction that is necessary. Requires MPI-2. 509 510 Level: developer 511 512 .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedSetType(), PetscCommBuildTwoSidedGetType() 513 E*/ 514 typedef enum { 515 PETSC_BUILDTWOSIDED_NOTSET = -1, 516 PETSC_BUILDTWOSIDED_ALLREDUCE = 0, 517 PETSC_BUILDTWOSIDED_IBARRIER = 1, 518 PETSC_BUILDTWOSIDED_REDSCATTER = 2 519 /* Updates here must be accompanied by updates in finclude/petscsys.h and the string array in mpits.c */ 520 } PetscBuildTwoSidedType; 521 522 /*E 523 InsertMode - Whether entries are inserted or added into vectors or matrices 524 525 Level: beginner 526 527 .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), 528 VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), 529 MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd() 530 E*/ 531 typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES, INSERT_ALL_VALUES, ADD_ALL_VALUES, INSERT_BC_VALUES, ADD_BC_VALUES} InsertMode; 532 533 /*MC 534 INSERT_VALUES - Put a value into a vector or matrix, overwrites any previous value 535 536 Level: beginner 537 538 .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), 539 VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), ADD_VALUES, 540 MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES 541 542 M*/ 543 544 /*MC 545 ADD_VALUES - Adds a value into a vector or matrix, if there previously was no value, just puts the 546 value into that location 547 548 Level: beginner 549 550 .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), 551 VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), INSERT_VALUES, 552 MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES 553 554 M*/ 555 556 /*MC 557 MAX_VALUES - Puts the maximum of the scattered/gathered value and the current value into each location 558 559 Level: beginner 560 561 .seealso: InsertMode, VecScatterBegin(), VecScatterEnd(), ADD_VALUES, INSERT_VALUES 562 563 M*/ 564 565 /*S 566 PetscSubcomm - A decomposition of an MPI communicator into subcommunicators 567 568 Notes: 569 After a call to PetscSubcommSetType(), PetscSubcommSetTypeGeneral(), or PetscSubcommSetFromOptions() one may call 570 $ PetscSubcommChild() returns the associated subcommunicator on this process 571 $ PetscSubcommContiguousParent() returns a parent communitor but with all child of the same subcommunicator having contiguous rank 572 573 Sample Usage: 574 PetscSubcommCreate() 575 PetscSubcommSetNumber() 576 PetscSubcommSetType(PETSC_SUBCOMM_INTERLACED); 577 ccomm = PetscSubcommChild() 578 PetscSubcommDestroy() 579 580 Level: advanced 581 582 Concepts: communicator, create 583 584 Notes: 585 $ PETSC_SUBCOMM_GENERAL - similar to MPI_Comm_split() each process sets the new communicator (color) they will belong to and the order within that communicator 586 $ PETSC_SUBCOMM_CONTIGUOUS - each new communicator contains a set of process with contiguous ranks in the original MPI communicator 587 $ PETSC_SUBCOMM_INTERLACED - each new communictor contains a set of processes equally far apart in rank from the others in that new communicator 588 589 Example: Consider a communicator with six processes split into 3 subcommunicators. 590 $ PETSC_SUBCOMM_CONTIGUOUS - the first communicator contains rank 0,1 the second rank 2,3 and the third rank 4,5 in the original ordering of the original communicator 591 $ PETSC_SUBCOMM_INTERLACED - the first communicator contains rank 0,3, the second 1,4 and the third 2,5 592 593 Developer Notes: 594 This is used in objects such as PCREDUNDANT to manage the subcommunicators on which the redundant computations 595 are performed. 596 597 598 .seealso: PetscSubcommCreate(), PetscSubcommSetNumber(), PetscSubcommSetType(), PetscSubcommView(), PetscSubcommSetFromOptions() 599 600 S*/ 601 typedef struct _n_PetscSubcomm* PetscSubcomm; 602 typedef enum {PETSC_SUBCOMM_GENERAL=0,PETSC_SUBCOMM_CONTIGUOUS=1,PETSC_SUBCOMM_INTERLACED=2} PetscSubcommType; 603 604 /*S 605 PetscHeap - A simple class for managing heaps 606 607 Level: intermediate 608 609 Concepts: random numbers 610 611 .seealso: PetscHeapCreate(), PetscHeapAdd(), PetscHeapPop(), PetscHeapPeek(), PetscHeapStash(), PetscHeapUnstash(), PetscHeapView(), PetscHeapDestroy() 612 S*/ 613 typedef struct _PetscHeap *PetscHeap; 614 615 typedef struct _n_PetscShmComm* PetscShmComm; 616 typedef struct _n_PetscOmpCtrl* PetscOmpCtrl; 617 618 /*S 619 PetscSegBuffer - a segmented extendable buffer 620 621 Level: developer 622 623 .seealso: PetscSegBufferCreate(), PetscSegBufferGet(), PetscSegBufferExtract(), PetscSegBufferDestroy() 624 S*/ 625 typedef struct _n_PetscSegBuffer *PetscSegBuffer; 626 627 typedef struct _n_PetscOptionsHelpPrinted *PetscOptionsHelpPrinted; 628 629 #endif 630