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