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 notes 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 ./configure automatically determines the size of the integers used by BLAS/LAPACK except when --with-batch is used 118 in that situation one must know (by some other means) if the integers used by BLAS/LAPACK are 64 bit and if so pass the flag --known-64-bit-blas-indice 119 120 MATLAB ships with BLAS and LAPACK that use 64 bit integers, for example if you run ./configure with, the option 121 --with-blaslapack-lib=[/Applications/MATLAB_R2010b.app/bin/maci64/libmwblas.dylib,/Applications/MATLAB_R2010b.app/bin/maci64/libmwlapack.dylib] 122 123 MKL ships with both 32 and 64 bit integer versions of the BLAS and LAPACK. If you pass the flag -with-64-bit-blas-indices PETSc will link 124 against the 64 bit version, otherwise it use the 32 bit version 125 126 OpenBLAS can be built to use 64 bit integers. The ./configure options --download-openblas -with-64-bit-blas-indices will build a 64 bit integer version 127 128 External packages such as hypre, ML, SuperLU etc do not provide any support for passing 64 bit integers to BLAS/LAPACK so cannot 129 be used with PETSc when PETSc links against 64 bit integer BLAS/LAPACK. ./configure will generate an error if you attempt to link PETSc against any of 130 these external libraries while using 64 bit integer BLAS/LAPACK. 131 132 Level: intermediate 133 134 .seealso: PetscMPIInt, PetscInt, PetscBLASIntCast() 135 136 M*/ 137 #if defined(PETSC_HAVE_64BIT_BLAS_INDICES) 138 typedef PetscInt64 PetscBLASInt; 139 #else 140 typedef int PetscBLASInt; 141 #endif 142 143 /*MC 144 PetscCuBLASInt - datatype used to represent 'int' parameters to cuBLAS/cuSOLVER functions. 145 146 Notes: 147 As of this writing PetscCuBLASInt is always the system `int`. 148 149 PetscErrorCode PetscCuBLASIntCast(a,&b) checks if the given PetscInt a will fit in a PetscCuBLASInt, if not it 150 generates a PETSC_ERR_ARG_OUTOFRANGE error 151 152 Level: intermediate 153 154 .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscCuBLASIntCast() 155 156 M*/ 157 typedef int PetscCuBLASInt; 158 159 /*E 160 PetscBool - Logical variable. Actually an int in C and a logical in Fortran. 161 162 Level: beginner 163 164 Developer Note: 165 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 166 boolean values. It is not easy to have a simple macro that that will work properly in all circumstances with all three mechanisms. 167 168 .seealso: PETSC_TRUE, PETSC_FALSE, PetscNot() 169 E*/ 170 typedef enum { PETSC_FALSE,PETSC_TRUE } PetscBool; 171 172 /*MC 173 PetscReal - PETSc type that represents a real number version of PetscScalar 174 175 Notes: 176 For MPI calls that require datatypes, use MPIU_REAL as the datatype for PetscScalar and MPIU_SUM, MPIU_MAX, etc. for operations. 177 They will automatically work correctly regardless of the size of PetscReal. 178 179 See PetscScalar for details on how to ./configure the size of PetscReal. 180 181 Level: beginner 182 183 .seealso: PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT 184 M*/ 185 186 #if defined(PETSC_USE_REAL_SINGLE) 187 typedef float PetscReal; 188 #elif defined(PETSC_USE_REAL_DOUBLE) 189 typedef double PetscReal; 190 #elif defined(PETSC_USE_REAL___FLOAT128) 191 # if defined(__cplusplus) 192 extern "C" { 193 # endif 194 # include <quadmath.h> 195 # if defined(__cplusplus) 196 } 197 # endif 198 typedef __float128 PetscReal; 199 #elif defined(PETSC_USE_REAL___FP16) 200 typedef __fp16 PetscReal; 201 #endif /* PETSC_USE_REAL_* */ 202 203 /*MC 204 PetscComplex - PETSc type that represents a complex number with precision matching that of PetscReal. 205 206 Synopsis: 207 #include <petscsys.h> 208 PetscComplex number = 1. + 2.*PETSC_i; 209 210 Notes: 211 For MPI calls that require datatypes, use MPIU_COMPLEX as the datatype for PetscComplex and MPIU_SUM etc for operations. 212 They will automatically work correctly regardless of the size of PetscComplex. 213 214 See PetscScalar for details on how to ./configure the size of PetscReal 215 216 Complex numbers are automatically available if PETSc was able to find a working complex implementation 217 218 219 Petsc has a 'fix' for complex numbers to support expressions such as std::complex<PetscReal> + PetscInt, which are not supported by the standard 220 C++ library, but are convenient for petsc users. If the C++ compiler is able to compile code in petsccxxcomplexfix.h (This is checked by 221 configure), we include petsccxxcomplexfix.h to provide this convenience. 222 223 If the fix causes conflicts, or one really does not want this fix for a particular C++ file, one can define PETSC_SKIP_CXX_COMPLEX_FIX 224 at the beginning of the C++ file to skip the fix. 225 226 Level: beginner 227 228 .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT, PETSC_i 229 M*/ 230 #if !defined(PETSC_SKIP_COMPLEX) 231 # if defined(PETSC_CLANGUAGE_CXX) 232 # if !defined(PETSC_USE_REAL___FP16) && !defined(PETSC_USE_REAL___FLOAT128) 233 # if defined(__cplusplus) && defined(PETSC_HAVE_CXX_COMPLEX) /* enable complex for library code */ 234 # define PETSC_HAVE_COMPLEX 1 235 # elif !defined(__cplusplus) && defined(PETSC_HAVE_C99_COMPLEX) && defined(PETSC_HAVE_CXX_COMPLEX) /* User code only - conditional on libary code complex support */ 236 # define PETSC_HAVE_COMPLEX 1 237 # endif 238 # endif 239 # else /* !PETSC_CLANGUAGE_CXX */ 240 # if !defined(PETSC_USE_REAL___FP16) 241 # if !defined(__cplusplus) && defined(PETSC_HAVE_C99_COMPLEX) /* enable complex for library code */ 242 # define PETSC_HAVE_COMPLEX 1 243 # elif defined(__cplusplus) && defined(PETSC_HAVE_C99_COMPLEX) && defined(PETSC_HAVE_CXX_COMPLEX) /* User code only - conditional on libary code complex support */ 244 # define PETSC_HAVE_COMPLEX 1 245 # endif 246 # endif 247 # endif /* PETSC_CLANGUAGE_CXX */ 248 #endif /* !PETSC_SKIP_COMPLEX */ 249 250 #if defined(PETSC_HAVE_COMPLEX) 251 #if defined(__cplusplus) /* C++ complex support */ 252 /* Locate a C++ complex template library */ 253 #if defined(PETSC_DESIRE_KOKKOS_COMPLEX) /* Defined in petscvec_kokkos.hpp for *.kokkos.cxx files */ 254 #define petsccomplexlib Kokkos 255 #include <Kokkos_Complex.hpp> 256 #elif defined(PETSC_HAVE_CUDA) 257 #define petsccomplexlib thrust 258 #include <thrust/complex.h> 259 #else 260 #define petsccomplexlib std 261 #include <complex> 262 #endif 263 264 /* Define PetscComplex based on the precision */ 265 #if defined(PETSC_USE_REAL_SINGLE) 266 typedef petsccomplexlib::complex<float> PetscComplex; 267 #elif defined(PETSC_USE_REAL_DOUBLE) 268 typedef petsccomplexlib::complex<double> PetscComplex; 269 #elif defined(PETSC_USE_REAL___FLOAT128) 270 typedef petsccomplexlib::complex<__float128> PetscComplex; /* Notstandard and not expected to work, use __complex128 */ 271 #endif 272 273 /* Include a PETSc C++ complex 'fix'. Check PetscComplex manual page for details */ 274 #if defined(PETSC_HAVE_CXX_COMPLEX_FIX) && !defined(PETSC_SKIP_CXX_COMPLEX_FIX) 275 #include <petsccxxcomplexfix.h> 276 #endif 277 #else /* c99 complex support */ 278 #include <complex.h> 279 #if defined(PETSC_USE_REAL_SINGLE) || defined(PETSC_USE_REAL___FP16) 280 typedef float _Complex PetscComplex; 281 #elif defined(PETSC_USE_REAL_DOUBLE) 282 typedef double _Complex PetscComplex; 283 #elif defined(PETSC_USE_REAL___FLOAT128) 284 typedef __complex128 PetscComplex; 285 #endif /* PETSC_USE_REAL_* */ 286 #endif /* !__cplusplus */ 287 #endif /* PETSC_HAVE_COMPLEX */ 288 289 /*MC 290 PetscScalar - PETSc type that represents either a double precision real number, a double precision 291 complex number, a single precision real number, a __float128 real or complex or a __fp16 real - if the code is configured 292 with --with-scalar-type=real,complex --with-precision=single,double,__float128,__fp16 293 294 Notes: 295 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. 296 297 Level: beginner 298 299 .seealso: PetscReal, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT, PetscRealPart(), PetscImaginaryPart() 300 M*/ 301 302 #if defined(PETSC_USE_COMPLEX) && defined(PETSC_HAVE_COMPLEX) 303 typedef PetscComplex PetscScalar; 304 #else /* PETSC_USE_COMPLEX */ 305 typedef PetscReal PetscScalar; 306 #endif /* PETSC_USE_COMPLEX */ 307 308 /*E 309 PetscCopyMode - Determines how an array or PetscObject passed to certain functions is copied or retained by the aggregate PetscObject 310 311 Level: beginner 312 313 For the array input: 314 $ PETSC_COPY_VALUES - the array values are copied into new space, the user is free to reuse or delete the passed in array 315 $ 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 316 $ delete the array. The array MUST have been obtained with PetscMalloc(). Hence this mode cannot be used in Fortran. 317 $ 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 318 $ the array but the user must delete the array after the object is destroyed. 319 320 For the PetscObject input: 321 $ PETSC_COPY_VALUES - the input PetscObject is cloned into the aggregate PetscObject; the user is free to reuse/modify the input PetscObject without side effects. 322 $ PETSC_OWN_POINTER - the input PetscObject is referenced by pointer (with reference count), thus should not be modified by the user. (Modification may cause errors or unintended side-effects in this or a future version of PETSc.) 323 For either case above, the input PetscObject should be destroyed by the user when no longer needed (the aggregate object increases its reference count). 324 $ PETSC_USE_POINTER - invalid for PetscObject inputs. 325 326 E*/ 327 typedef enum {PETSC_COPY_VALUES, PETSC_OWN_POINTER, PETSC_USE_POINTER} PetscCopyMode; 328 329 /*MC 330 PETSC_FALSE - False value of PetscBool 331 332 Level: beginner 333 334 Note: 335 Zero integer 336 337 .seealso: PetscBool, PETSC_TRUE 338 M*/ 339 340 /*MC 341 PETSC_TRUE - True value of PetscBool 342 343 Level: beginner 344 345 Note: 346 Nonzero integer 347 348 .seealso: PetscBool, PETSC_FALSE 349 M*/ 350 351 /*MC 352 PetscLogDouble - Used for logging times 353 354 Notes: 355 Contains double precision numbers that are not used in the numerical computations, but rather in logging, timing etc. 356 357 Level: developer 358 359 M*/ 360 typedef double PetscLogDouble; 361 362 /*E 363 PetscDataType - Used for handling different basic data types. 364 365 Level: beginner 366 367 Notes: 368 Use of this should be avoided if one can directly use MPI_Datatype instead. 369 370 PETSC_INT is the datatype for a PetscInt, regardless of whether it is 4 or 8 bytes. 371 PETSC_REAL, PETSC_COMPLEX and PETSC_SCALAR are the datatypes for PetscReal, PetscComplex and PetscScalar, regardless of their sizes. 372 373 Developer comment: 374 It would be nice if we could always just use MPI Datatypes, why can we not? 375 376 If you change any values in PetscDatatype make sure you update their usage in 377 share/petsc/matlab/PetscBagRead.m and share/petsc/matlab/@PetscOpenSocket/read/write.m 378 379 TODO: Add PETSC_INT32 and remove use of improper PETSC_ENUM 380 381 .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(), 382 PetscDataTypeGetSize() 383 384 E*/ 385 typedef enum {PETSC_DATATYPE_UNKNOWN = 0, 386 PETSC_DOUBLE = 1, PETSC_COMPLEX = 2, PETSC_LONG = 3, PETSC_SHORT = 4, PETSC_FLOAT = 5, 387 PETSC_CHAR = 6, PETSC_BIT_LOGICAL = 7, PETSC_ENUM = 8, PETSC_BOOL = 9, PETSC___FLOAT128 = 10, 388 PETSC_OBJECT = 11, PETSC_FUNCTION = 12, PETSC_STRING = 13, PETSC___FP16 = 14, PETSC_STRUCT = 15, 389 PETSC_INT = 16, PETSC_INT64 = 17} PetscDataType; 390 391 #if defined(PETSC_USE_REAL_SINGLE) 392 # define PETSC_REAL PETSC_FLOAT 393 #elif defined(PETSC_USE_REAL_DOUBLE) 394 # define PETSC_REAL PETSC_DOUBLE 395 #elif defined(PETSC_USE_REAL___FLOAT128) 396 # define PETSC_REAL PETSC___FLOAT128 397 #elif defined(PETSC_USE_REAL___FP16) 398 # define PETSC_REAL PETSC___FP16 399 #else 400 # define PETSC_REAL PETSC_DOUBLE 401 #endif 402 403 #if defined(PETSC_USE_COMPLEX) 404 # define PETSC_SCALAR PETSC_COMPLEX 405 #else 406 # define PETSC_SCALAR PETSC_REAL 407 #endif 408 409 #define PETSC_FORTRANADDR PETSC_LONG 410 411 /*S 412 PetscToken - 'Token' used for managing tokenizing strings 413 414 Level: intermediate 415 416 .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy() 417 S*/ 418 typedef struct _p_PetscToken* PetscToken; 419 420 /*S 421 PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc 422 423 Level: beginner 424 425 Note: 426 This is the base class from which all PETSc objects are derived from. 427 428 .seealso: PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName(), PetscObjectReference(), PetscObjectDereference() 429 S*/ 430 typedef struct _p_PetscObject* PetscObject; 431 432 /*MC 433 PetscObjectId - unique integer Id for a PetscObject 434 435 Level: developer 436 437 Notes: 438 Unlike pointer values, object ids are never reused. 439 440 .seealso: PetscObjectState, PetscObjectGetId() 441 M*/ 442 typedef PetscInt64 PetscObjectId; 443 444 /*MC 445 PetscObjectState - integer state for a PetscObject 446 447 Level: developer 448 449 Notes: 450 Object state is always-increasing and (for objects that track state) can be used to determine if an object has 451 changed since the last time you interacted with it. It is 64-bit so that it will not overflow for a very long time. 452 453 .seealso: PetscObjectId, PetscObjectStateGet(), PetscObjectStateIncrease(), PetscObjectStateSet() 454 M*/ 455 typedef PetscInt64 PetscObjectState; 456 457 /*S 458 PetscFunctionList - Linked list of functions, possibly stored in dynamic libraries, accessed 459 by string name 460 461 Level: advanced 462 463 .seealso: PetscFunctionListAdd(), PetscFunctionListDestroy() 464 S*/ 465 typedef struct _n_PetscFunctionList *PetscFunctionList; 466 467 /*E 468 PetscFileMode - Access mode for a file. 469 470 Level: beginner 471 472 $ FILE_MODE_UNDEFINED - initial invalid value 473 $ FILE_MODE_READ - open a file at its beginning for reading 474 $ FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist) 475 $ FILE_MODE_APPEND - open a file at end for writing 476 $ FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing 477 $ FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end 478 479 .seealso: PetscViewerFileSetMode() 480 E*/ 481 typedef enum {FILE_MODE_UNDEFINED=-1, FILE_MODE_READ=0, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode; 482 483 typedef void* PetscDLHandle; 484 typedef enum {PETSC_DL_DECIDE=0,PETSC_DL_NOW=1,PETSC_DL_LOCAL=2} PetscDLMode; 485 486 /*S 487 PetscObjectList - Linked list of PETSc objects, each accessible by string name 488 489 Level: developer 490 491 Notes: 492 Used by PetscObjectCompose() and PetscObjectQuery() 493 494 .seealso: PetscObjectListAdd(), PetscObjectListDestroy(), PetscObjectListFind(), PetscObjectCompose(), PetscObjectQuery(), PetscFunctionList 495 S*/ 496 typedef struct _n_PetscObjectList *PetscObjectList; 497 498 /*S 499 PetscDLLibrary - Linked list of dynamics libraries to search for functions 500 501 Level: advanced 502 503 .seealso: PetscDLLibraryOpen() 504 S*/ 505 typedef struct _n_PetscDLLibrary *PetscDLLibrary; 506 507 /*S 508 PetscContainer - Simple PETSc object that contains a pointer to any required data 509 510 Level: advanced 511 512 .seealso: PetscObject, PetscContainerCreate() 513 S*/ 514 typedef struct _p_PetscContainer* PetscContainer; 515 516 /*S 517 PetscRandom - Abstract PETSc object that manages generating random numbers 518 519 Level: intermediate 520 521 .seealso: PetscRandomCreate(), PetscRandomGetValue(), PetscRandomType 522 S*/ 523 typedef struct _p_PetscRandom* PetscRandom; 524 525 /* 526 In binary files variables are stored using the following lengths, 527 regardless of how they are stored in memory on any one particular 528 machine. Use these rather then sizeof() in computing sizes for 529 PetscBinarySeek(). 530 */ 531 #define PETSC_BINARY_INT_SIZE (32/8) 532 #define PETSC_BINARY_FLOAT_SIZE (32/8) 533 #define PETSC_BINARY_CHAR_SIZE (8/8) 534 #define PETSC_BINARY_SHORT_SIZE (16/8) 535 #define PETSC_BINARY_DOUBLE_SIZE (64/8) 536 #define PETSC_BINARY_SCALAR_SIZE sizeof(PetscScalar) 537 538 /*E 539 PetscBinarySeekType - argument to PetscBinarySeek() 540 541 Level: advanced 542 543 .seealso: PetscBinarySeek(), PetscBinarySynchronizedSeek() 544 E*/ 545 typedef enum {PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1,PETSC_BINARY_SEEK_END = 2} PetscBinarySeekType; 546 547 /*E 548 PetscBuildTwoSidedType - algorithm for setting up two-sided communication 549 550 $ PETSC_BUILDTWOSIDED_ALLREDUCE - classical algorithm using an MPI_Allreduce with 551 $ a buffer of length equal to the communicator size. Not memory-scalable due to 552 $ the large reduction size. Requires only MPI-1. 553 $ PETSC_BUILDTWOSIDED_IBARRIER - nonblocking algorithm based on MPI_Issend and MPI_Ibarrier. 554 $ Proved communication-optimal in Hoefler, Siebert, and Lumsdaine (2010). Requires MPI-3. 555 $ PETSC_BUILDTWOSIDED_REDSCATTER - similar to above, but use more optimized function 556 $ that only communicates the part of the reduction that is necessary. Requires MPI-2. 557 558 Level: developer 559 560 .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedSetType(), PetscCommBuildTwoSidedGetType() 561 E*/ 562 typedef enum { 563 PETSC_BUILDTWOSIDED_NOTSET = -1, 564 PETSC_BUILDTWOSIDED_ALLREDUCE = 0, 565 PETSC_BUILDTWOSIDED_IBARRIER = 1, 566 PETSC_BUILDTWOSIDED_REDSCATTER = 2 567 /* Updates here must be accompanied by updates in finclude/petscsys.h and the string array in mpits.c */ 568 } PetscBuildTwoSidedType; 569 570 /* NOTE: If you change this, you must also change the values in src/vec/f90-mod/petscvec.h */ 571 /*E 572 InsertMode - Whether entries are inserted or added into vectors or matrices 573 574 Level: beginner 575 576 .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), 577 VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), 578 MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd() 579 E*/ 580 typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES, MIN_VALUES, INSERT_ALL_VALUES, ADD_ALL_VALUES, INSERT_BC_VALUES, ADD_BC_VALUES} InsertMode; 581 582 /*MC 583 INSERT_VALUES - Put a value into a vector or matrix, overwrites any previous value 584 585 Level: beginner 586 587 .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), 588 VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), ADD_VALUES, 589 MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES 590 591 M*/ 592 593 /*MC 594 ADD_VALUES - Adds a value into a vector or matrix, if there previously was no value, just puts the 595 value into that location 596 597 Level: beginner 598 599 .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), 600 VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), INSERT_VALUES, 601 MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES 602 603 M*/ 604 605 /*MC 606 MAX_VALUES - Puts the maximum of the scattered/gathered value and the current value into each location 607 608 Level: beginner 609 610 .seealso: InsertMode, VecScatterBegin(), VecScatterEnd(), ADD_VALUES, INSERT_VALUES 611 612 M*/ 613 614 /*MC 615 MIN_VALUES - Puts the minimal of the scattered/gathered value and the current value into each location 616 617 Level: beginner 618 619 .seealso: InsertMode, VecScatterBegin(), VecScatterEnd(), ADD_VALUES, INSERT_VALUES 620 621 M*/ 622 623 /*S 624 PetscSubcomm - A decomposition of an MPI communicator into subcommunicators 625 626 Notes: 627 After a call to PetscSubcommSetType(), PetscSubcommSetTypeGeneral(), or PetscSubcommSetFromOptions() one may call 628 $ PetscSubcommChild() returns the associated subcommunicator on this process 629 $ PetscSubcommContiguousParent() returns a parent communitor but with all child of the same subcommunicator having contiguous rank 630 631 Sample Usage: 632 PetscSubcommCreate() 633 PetscSubcommSetNumber() 634 PetscSubcommSetType(PETSC_SUBCOMM_INTERLACED); 635 ccomm = PetscSubcommChild() 636 PetscSubcommDestroy() 637 638 Level: advanced 639 640 Notes: 641 $ 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 642 $ PETSC_SUBCOMM_CONTIGUOUS - each new communicator contains a set of process with contiguous ranks in the original MPI communicator 643 $ PETSC_SUBCOMM_INTERLACED - each new communictor contains a set of processes equally far apart in rank from the others in that new communicator 644 645 Example: Consider a communicator with six processes split into 3 subcommunicators. 646 $ 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 647 $ PETSC_SUBCOMM_INTERLACED - the first communicator contains rank 0,3, the second 1,4 and the third 2,5 648 649 Developer Notes: 650 This is used in objects such as PCREDUNDANT to manage the subcommunicators on which the redundant computations 651 are performed. 652 653 .seealso: PetscSubcommCreate(), PetscSubcommSetNumber(), PetscSubcommSetType(), PetscSubcommView(), PetscSubcommSetFromOptions() 654 655 S*/ 656 typedef struct _n_PetscSubcomm* PetscSubcomm; 657 typedef enum {PETSC_SUBCOMM_GENERAL=0,PETSC_SUBCOMM_CONTIGUOUS=1,PETSC_SUBCOMM_INTERLACED=2} PetscSubcommType; 658 659 /*S 660 PetscHeap - A simple class for managing heaps 661 662 Level: intermediate 663 664 .seealso: PetscHeapCreate(), PetscHeapAdd(), PetscHeapPop(), PetscHeapPeek(), PetscHeapStash(), PetscHeapUnstash(), PetscHeapView(), PetscHeapDestroy() 665 S*/ 666 typedef struct _PetscHeap *PetscHeap; 667 668 typedef struct _n_PetscShmComm* PetscShmComm; 669 typedef struct _n_PetscOmpCtrl* PetscOmpCtrl; 670 671 /*S 672 PetscSegBuffer - a segmented extendable buffer 673 674 Level: developer 675 676 .seealso: PetscSegBufferCreate(), PetscSegBufferGet(), PetscSegBufferExtract(), PetscSegBufferDestroy() 677 S*/ 678 typedef struct _n_PetscSegBuffer *PetscSegBuffer; 679 680 typedef struct _n_PetscOptionsHelpPrinted *PetscOptionsHelpPrinted; 681 682 /*E 683 PetscMemType - Memory type of a pointer 684 685 Level: beginner 686 687 Developer Note: 688 Encoding of the bitmask in binary: xxxxyyyz 689 z = 0: Host memory 690 z = 1: Device memory 691 yyy = 000: CUDA-related memory 692 yyy = 001: HIP-related memory 693 xxxxyyy1 = 0000,0001: CUDA memory 694 xxxxyyy1 = 0001,0001: CUDA NVSHMEM memory 695 xxxxyyy1 = 0000,0011: HIP memory 696 697 Other types of memory, e.g., CUDA managed memory, can be added when needed. 698 699 .seealso: VecGetArrayAndMemType(), PetscSFBcastWithMemTypeBegin(), PetscSFReduceWithMemTypeBegin() 700 E*/ 701 typedef enum {PETSC_MEMTYPE_HOST=0, PETSC_MEMTYPE_DEVICE=0x01, PETSC_MEMTYPE_CUDA=0x01, PETSC_MEMTYPE_NVSHMEM=0x11,PETSC_MEMTYPE_HIP=0x03} PetscMemType; 702 703 #define PetscMemTypeHost(m) (((m) & 0x1) == PETSC_MEMTYPE_HOST) 704 #define PetscMemTypeDevice(m) (((m) & 0x1) == PETSC_MEMTYPE_DEVICE) 705 #define PetscMemTypeCUDA(m) (((m) & 0xF) == PETSC_MEMTYPE_CUDA) 706 #define PetscMemTypeHIP(m) (((m) & 0xF) == PETSC_MEMTYPE_HIP) 707 #define PetscMemTypeNVSHMEM(m) ((m) == PETSC_MEMTYPE_NVSHMEM) 708 709 #endif 710