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