Date: 2025-03-28T21:10:41+00:00

Actual source code: petscsys.h

      1: /*
      2:    This is the main PETSc include file (for C and C++).  It is included by all
      3:    other PETSc include files, so it almost never has to be specifically included.
      4:    Portions of this code are under:
      5:    Copyright (c) 2022 Advanced Micro Devices, Inc. All rights reserved.
      6: */
      7: #pragma once

      9: /* ========================================================================== */
     10: /*
     11:    petscconf.h is contained in ${PETSC_ARCH}/include/petscconf.h it is
     12:    found automatically by the compiler due to the -I${PETSC_DIR}/${PETSC_ARCH}/include that
     13:    PETSc's makefiles add to the compiler rules.
     14:    For --prefix installs the directory ${PETSC_ARCH} does not exist and petscconf.h is in the same
     15:    directory as the other PETSc include files.
     16: */
     17: #include <petscconf.h>
     18: #include <petscpkg_version.h>
     19: #include <petscconf_poison.h>
     20: #include <petscfix.h>
     21: #include <petscmacros.h>

     23: /* SUBMANSEC = Sys */

     25: #if defined(PETSC_DESIRE_FEATURE_TEST_MACROS)
     26:   /*
     27:    Feature test macros must be included before headers defined by IEEE Std 1003.1-2001
     28:    We only turn these in PETSc source files that require them by setting PETSC_DESIRE_FEATURE_TEST_MACROS
     29: */
     30:   #if defined(PETSC__POSIX_C_SOURCE_200112L) && !defined(_POSIX_C_SOURCE)
     31:     #define _POSIX_C_SOURCE 200112L
     32:   #endif
     33:   #if defined(PETSC__BSD_SOURCE) && !defined(_BSD_SOURCE)
     34:     #define _BSD_SOURCE
     35:   #endif
     36:   #if defined(PETSC__DEFAULT_SOURCE) && !defined(_DEFAULT_SOURCE)
     37:     #define _DEFAULT_SOURCE
     38:   #endif
     39:   #if defined(PETSC__GNU_SOURCE) && !defined(_GNU_SOURCE)
     40:     #define _GNU_SOURCE
     41:   #endif
     42: #endif

     44: #include <petscsystypes.h>

     46: /* ========================================================================== */

     48: /*
     49:     Defines the interface to MPI allowing the use of all MPI functions.

     51:     PETSc does not use the C++ binding of MPI at ALL. The following flag
     52:     makes sure the C++ bindings are not included. The C++ bindings REQUIRE
     53:     putting mpi.h before ANY C++ include files, we cannot control this
     54:     with all PETSc users. Users who want to use the MPI C++ bindings can include
     55:     mpicxx.h directly in their code
     56: */
     57: #if !defined(MPICH_SKIP_MPICXX)
     58:   #define MPICH_SKIP_MPICXX 1
     59: #endif
     60: #if !defined(OMPI_SKIP_MPICXX)
     61:   #define OMPI_SKIP_MPICXX 1
     62: #endif
     63: #if defined(PETSC_HAVE_MPIUNI)
     64: #include <petsc/mpiuni/mpi.h>
     65: #else
     66:   #include <mpi.h>
     67: #endif

     69: /*
     70:    Perform various sanity checks that the correct mpi.h is being included at compile time.
     71:    This usually happens because
     72:       * either an unexpected mpi.h is in the default compiler path (i.e. in /usr/include) or
     73:       * an extra include path -I/something (which contains the unexpected mpi.h) is being passed to the compiler
     74:    Note: with MPICH and OpenMPI, accept versions [x.y.z, x+1.0.0) as compatible
     75: */
     76: #if defined(PETSC_HAVE_MPIUNI)
     77:   #ifndef MPIUNI_H
     78:     #error "PETSc was configured with --with-mpi=0 but now appears to be compiling using a different mpi.h"
     79:   #endif
     80: #elif defined(PETSC_HAVE_I_MPI)
     81:   #if !defined(I_MPI_NUMVERSION)
     82:     #error "PETSc was configured with I_MPI but now appears to be compiling using a non-I_MPI mpi.h"
     83:   #elif I_MPI_NUMVERSION != PETSC_PKG_I_MPI_NUMVERSION
     84:     #error "PETSc was configured with one I_MPI mpi.h version but now appears to be compiling using a different I_MPI mpi.h version"
     85:   #endif
     86: #elif defined(PETSC_HAVE_MVAPICH2)
     87:   #if !defined(MVAPICH2_NUMVERSION)
     88:     #error "PETSc was configured with MVAPICH2 but now appears to be compiling using a non-MVAPICH2 mpi.h"
     89:   #elif MVAPICH2_NUMVERSION != PETSC_PKG_MVAPICH2_NUMVERSION
     90:     #error "PETSc was configured with one MVAPICH2 mpi.h version but now appears to be compiling using a different MVAPICH2 mpi.h version"
     91:   #endif
     92: #elif defined(PETSC_HAVE_MPICH)
     93:   #if !defined(MPICH_NUMVERSION) || defined(MVAPICH2_NUMVERSION) || defined(I_MPI_NUMVERSION)
     94:     #error "PETSc was configured with MPICH but now appears to be compiling using a non-MPICH mpi.h"
     95:   #elif PETSC_PKG_MPICH_VERSION_GT(MPICH_NUMVERSION / 10000000, MPICH_NUMVERSION / 100000 % 100, MPICH_NUMVERSION / 1000 % 100)
     96:     #error "PETSc was configured with one MPICH mpi.h version but now appears to be compiling using an older MPICH mpi.h version"
     97:   #elif PETSC_PKG_MPICH_VERSION_LT(MPICH_NUMVERSION / 10000000, 0, 0)
     98:     #error "PETSc was configured with one MPICH mpi.h version but now appears to be compiling using a newer major MPICH mpi.h version"
     99:   #endif
    100: #elif defined(PETSC_HAVE_OPENMPI)
    101:   #if !defined(OMPI_MAJOR_VERSION)
    102:     #error "PETSc was configured with Open MPI but now appears to be compiling using a non-Open MPI mpi.h"
    103:   #elif PETSC_PKG_OPENMPI_VERSION_GT(OMPI_MAJOR_VERSION, OMPI_MINOR_VERSION, OMPI_RELEASE_VERSION)
    104:     #error "PETSc was configured with one Open MPI mpi.h version but now appears to be compiling using an older Open MPI mpi.h version"
    105:   #elif PETSC_PKG_OPENMPI_VERSION_LT(OMPI_MAJOR_VERSION, 0, 0)
    106:     #error "PETSc was configured with one Open MPI mpi.h version but now appears to be compiling using a newer major Open MPI mpi.h version"
    107:   #endif
    108: #elif defined(PETSC_HAVE_MSMPI_VERSION)
    109:   #if !defined(MSMPI_VER)
    110:     #error "PETSc was configured with MSMPI but now appears to be compiling using a non-MSMPI mpi.h"
    111:   #elif (MSMPI_VER != PETSC_HAVE_MSMPI_VERSION)
    112:     #error "PETSc was configured with one MSMPI mpi.h version but now appears to be compiling using a different MSMPI mpi.h version"
    113:   #endif
    114: #elif defined(OMPI_MAJOR_VERSION) || defined(MPICH_NUMVERSION) || defined(MSMPI_VER)
    115:   #error "PETSc was configured with undetermined MPI - but now appears to be compiling using any of Open MPI, MS-MPI or a MPICH variant"
    116: #endif

    118: /*
    119:     Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler
    120:     see the top of mpicxx.h in the MPICH2 distribution.
    121: */
    122: #include <stdio.h>

    124: /* MSMPI on 32-bit Microsoft Windows requires this yukky hack - that breaks MPI standard compliance */
    125: #if !defined(MPIAPI)
    126:   #define MPIAPI
    127: #endif

    129: PETSC_EXTERN MPI_Datatype MPIU_ENUM PETSC_ATTRIBUTE_MPI_TYPE_TAG(PetscEnum);
    130: PETSC_EXTERN MPI_Datatype MPIU_BOOL PETSC_ATTRIBUTE_MPI_TYPE_TAG(PetscBool);

    132: /*MC
    133:    MPIU_INT - Portable MPI datatype corresponding to `PetscInt` independent of the precision of `PetscInt`

    135:    Level: beginner

    137:    Note:
    138:    In MPI calls that require an MPI datatype that matches a `PetscInt` or array of `PetscInt` values, pass this value.

    140: .seealso: `PetscReal`, `PetscScalar`, `PetscComplex`, `PetscInt`, `MPIU_COUNT`, `MPIU_REAL`, `MPIU_SCALAR`, `MPIU_COMPLEX`
    141: M*/

    143: PETSC_EXTERN MPI_Datatype MPIU_FORTRANADDR;

    145: #if defined(PETSC_USE_64BIT_INDICES)
    146:   #define MPIU_INT MPIU_INT64
    147: #else
    148:   #define MPIU_INT MPI_INT
    149: #endif

    151: /*MC
    152:    MPIU_COUNT - Portable MPI datatype corresponding to `PetscCount` independent of the precision of `PetscCount`

    154:    Level: beginner

    156:    Note:
    157:    In MPI calls that require an MPI datatype that matches a `PetscCount` or array of `PetscCount` values, pass this value.

    159:   Developer Note:
    160:   It seems `MPI_AINT` is unsigned so this may be the wrong choice here since `PetscCount` is signed

    162: .seealso: `PetscReal`, `PetscScalar`, `PetscComplex`, `PetscInt`, `MPIU_INT`, `MPIU_REAL`, `MPIU_SCALAR`, `MPIU_COMPLEX`
    163: M*/
    164: #define MPIU_COUNT MPI_AINT

    166: /*
    167:     For the rare cases when one needs to send a size_t object with MPI
    168: */
    169: PETSC_EXTERN MPI_Datatype MPIU_SIZE_T PETSC_ATTRIBUTE_MPI_TYPE_TAG(size_t);

    171: /*
    172:       You can use PETSC_STDOUT as a replacement of stdout. You can also change
    173:     the value of PETSC_STDOUT to redirect all standard output elsewhere
    174: */
    175: PETSC_EXTERN FILE *PETSC_STDOUT;

    177: /*
    178:       You can use PETSC_STDERR as a replacement of stderr. You can also change
    179:     the value of PETSC_STDERR to redirect all standard error elsewhere
    180: */
    181: PETSC_EXTERN FILE *PETSC_STDERR;

    183: /*
    184:   Handle inclusion when using clang compiler with CUDA support
    185:   __float128 is not available for the device
    186: */
    187: #if defined(__clang__) && (defined(__CUDA_ARCH__) || defined(__HIPCC__))
    188:   #define PETSC_SKIP_REAL___FLOAT128
    189: #endif

    191: /*
    192:     Declare extern C stuff after including external header files
    193: */

    195: PETSC_EXTERN PetscBool PETSC_RUNNING_ON_VALGRIND;
    196: /*
    197:     Defines elementary mathematics functions and constants.
    198: */
    199: #include <petscmath.h>

    201: /*MC
    202:     PETSC_IGNORE - same as `NULL`, means PETSc will ignore this argument

    204:    Level: beginner

    206:    Note:
    207:    Accepted by many PETSc functions to not set a parameter and instead use a default value

    209:    Fortran Note:
    210:    Use `PETSC_NULL_INTEGER`, `PETSC_NULL_DOUBLE_PRECISION` etc

    212: .seealso: `PETSC_DECIDE`, `PETSC_DEFAULT`, `PETSC_DETERMINE`
    213: M*/
    214: #define PETSC_IGNORE PETSC_NULLPTR
    215: #define PETSC_NULL   PETSC_DEPRECATED_MACRO(3, 19, 0, "PETSC_NULLPTR", ) PETSC_NULLPTR

    217: /*MC
    218:    PETSC_UNLIMITED - standard way of passing an integer or floating point parameter to indicate PETSc there is no bound on the value allowed

    220:    Level: beginner

    222:    Example Usage:
    223: .vb
    224:    KSPSetTolerances(ksp, PETSC_CURRENT, PETSC_CURRENT, PETSC_UNLIMITED, PETSC_UNLIMITED);
    225: .ve
    226:   indicates that the solver is allowed to take any number of iterations and will not stop early no matter how the residual gets.

    228:    Fortran Note:
    229:    Use `PETSC_UNLIMITED_INTEGER` or `PETSC_UNLIMITED_REAL`.

    231: .seealso: `PETSC_DEFAULT`, `PETSC_IGNORE`, `PETSC_DETERMINE`, `PETSC_DECIDE`
    232: M*/

    234: /*MC
    235:    PETSC_DECIDE - standard way of passing an integer or floating point parameter to indicate PETSc should determine an appropriate value

    237:    Level: beginner

    239:    Example Usage:
    240: .vb
    241:    VecSetSizes(ksp, PETSC_DECIDE, 10);
    242: .ve
    243:   indicates that the global size of the vector is 10 and the local size will be automatically determined so that the sum of the
    244:   local sizes is the global size, see `PetscSplitOwnership()`.

    246:    Fortran Note:
    247:    Use `PETSC_DECIDE_INTEGER` or `PETSC_DECIDE_REAL`.

    249: .seealso: `PETSC_DEFAULT`, `PETSC_IGNORE`, `PETSC_DETERMINE`, `PETSC_UNLIMITED'
    250: M*/

    252: /*MC
    253:    PETSC_DETERMINE - standard way of passing an integer or floating point parameter to indicate PETSc should determine an appropriate value

    255:    Level: beginner

    257:     Example Usage:
    258: .vb
    259:    VecSetSizes(ksp, 10, PETSC_DETERMINE);
    260: .ve
    261:   indicates that the local size of the vector is 10 and the global size will be automatically summing up all the local sizes.

    263:    Note:
    264:    Same as `PETSC_DECIDE`

    266:    Fortran Note:
    267:    Use `PETSC_DETERMINE_INTEGER` or `PETSC_DETERMINE_REAL`.

    269:    Developer Note:
    270:    I would like to use const `PetscInt` `PETSC_DETERMINE` = `PETSC_DECIDE`; but for
    271:    some reason this is not allowed by the standard even though `PETSC_DECIDE` is a constant value.

    273: .seealso: `PETSC_DECIDE`, `PETSC_DEFAULT`, `PETSC_IGNORE`, `VecSetSizes()`, `PETSC_UNLIMITED'
    274: M*/

    276: /*MC
    277:    PETSC_CURRENT - standard way of indicating to an object not to change the current value of the parameter in the object

    279:    Level: beginner

    281:    Note:
    282:    Use `PETSC_DECIDE` to use the value that was set by PETSc when the object's type was set

    284:    Fortran Note:
    285:    Use `PETSC_CURRENT_INTEGER` or `PETSC_CURRENT_REAL`.

    287: .seealso: `PETSC_DECIDE`, `PETSC_IGNORE`, `PETSC_DETERMINE`, `PETSC_DEFAULT`, `PETSC_UNLIMITED'
    288: M*/

    290: /*MC
    291:    PETSC_DEFAULT - deprecated, see `PETSC_CURRENT` and `PETSC_DETERMINE`

    293:    Level: beginner

    295:    Note:
    296:    The name is confusing since it tells the object to continue to use the value it is using, not the default value when the object's type was set.

    298:    Developer Note:
    299:    Unfortunately this was used for two different purposes in the past, to actually trigger the use of a default value or to continue the
    300:    use of currently set value (in, for example, `KSPSetTolerances()`.

    302: .seealso: `PETSC_DECIDE`, `PETSC_IGNORE`, `PETSC_DETERMINE`, `PETSC_CURRENT`, `PETSC_UNLIMITED'
    303: M*/

    305: /* These MUST be preprocessor defines! see https://gitlab.com/petsc/petsc/-/issues/1370 */
    306: #define PETSC_DECIDE    (-1)
    307: #define PETSC_DETERMINE PETSC_DECIDE
    308: #define PETSC_CURRENT   (-2)
    309: #define PETSC_UNLIMITED (-3)
    310: /*  PETSC_DEFAULT is deprecated in favor of PETSC_CURRENT for use in KSPSetTolerances() and similar functions */
    311: #define PETSC_DEFAULT PETSC_CURRENT

    313: /*MC
    314:    PETSC_COMM_WORLD - the equivalent of the `MPI_COMM_WORLD` communicator which represents all the processes that PETSc knows about.

    316:    Level: beginner

    318:    Notes:
    319:    By default `PETSC_COMM_WORLD` and `MPI_COMM_WORLD` are identical unless you wish to
    320:    run PETSc on ONLY a subset of `MPI_COMM_WORLD`. In that case create your new (smaller)
    321:    communicator, call it, say comm, and set `PETSC_COMM_WORLD` = comm BEFORE calling
    322:    `PetscInitialize()`, but after `MPI_Init()` has been called.

    324:    The value of `PETSC_COMM_WORLD` should never be used or accessed before `PetscInitialize()`
    325:    is called because it may not have a valid value yet.

    327: .seealso: `PETSC_COMM_SELF`
    328: M*/
    329: PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD;

    331: /*MC
    332:    PETSC_COMM_SELF - This is always `MPI_COMM_SELF`

    334:    Level: beginner

    336:    Note:
    337:    Do not USE/access or set this variable before `PetscInitialize()` has been called.

    339: .seealso: `PETSC_COMM_WORLD`
    340: M*/
    341: #define PETSC_COMM_SELF MPI_COMM_SELF

    343: /*MC
    344:    PETSC_MPI_THREAD_REQUIRED - the required threading support used if PETSc initializes MPI with `MPI_Init_thread()`.

    346:    No Fortran Support

    348:    Level: beginner

    350:    Note:
    351:    By default `PETSC_MPI_THREAD_REQUIRED` equals `MPI_THREAD_FUNNELED` when the MPI implementation provides `MPI_Init_thread()`, otherwise it equals `MPI_THREAD_SINGLE`

    353: .seealso: `PetscInitialize()`
    354: M*/
    355: PETSC_EXTERN PetscMPIInt PETSC_MPI_THREAD_REQUIRED;

    357: /*MC
    358:    PetscBeganMPI - indicates if PETSc initialized MPI using `MPI_Init()` during `PetscInitialize()` or if MPI was already initialized with `MPI_Init()`

    360:    Synopsis:
    361: #include <petscsys.h>
    362:    PetscBool PetscBeganMPI;

    364:    No Fortran Support

    366:    Level: developer

    368:    Note:
    369:    `MPI_Init()` can never be called after `PetscInitialize()`

    371: .seealso: `PetscInitialize()`, `PetscInitializeCalled`
    372: M*/
    373: PETSC_EXTERN PetscBool PetscBeganMPI;

    375: PETSC_EXTERN PetscBool PetscErrorHandlingInitialized;
    376: PETSC_EXTERN PetscBool PetscInitializeCalled;
    377: PETSC_EXTERN PetscBool PetscFinalizeCalled;
    378: PETSC_EXTERN PetscBool PetscViennaCLSynchronize;

    380: PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm), PetscErrorCode (*)(MPI_Comm));
    381: PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm, MPI_Comm *, int *);
    382: PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm *);
    383: PETSC_EXTERN PetscErrorCode PetscCommGetComm(MPI_Comm, MPI_Comm *);
    384: PETSC_EXTERN PetscErrorCode PetscCommRestoreComm(MPI_Comm, MPI_Comm *);

    386: #if defined(PETSC_HAVE_KOKKOS)
    387: PETSC_EXTERN PetscErrorCode PetscKokkosInitializeCheck(void); /* Initialize Kokkos if not yet. */
    388: #endif

    390: #if defined(PETSC_HAVE_NVSHMEM)
    391: PETSC_EXTERN PetscBool      PetscBeganNvshmem;
    392: PETSC_EXTERN PetscBool      PetscNvshmemInitialized;
    393: PETSC_EXTERN PetscErrorCode PetscNvshmemFinalize(void);
    394: #endif

    396: #if defined(PETSC_HAVE_ELEMENTAL)
    397: PETSC_EXTERN PetscErrorCode PetscElementalInitializePackage(void);
    398: PETSC_EXTERN PetscErrorCode PetscElementalInitialized(PetscBool *);
    399: PETSC_EXTERN PetscErrorCode PetscElementalFinalizePackage(void);
    400: #endif

    402: /*MC
    403:    PetscMalloc - Allocates memory for use with PETSc. One should use `PetscNew()`, `PetscMalloc1()` or `PetscCalloc1()` usually instead of `PetscMalloc()`

    405:    Synopsis:
    406: #include <petscsys.h>
    407:    PetscErrorCode PetscMalloc(size_t m,void **result)

    409:    Not Collective

    411:    Input Parameter:
    412: .  m - number of bytes to allocate

    414:    Output Parameter:
    415: .  result - memory allocated

    417:    Level: beginner

    419:    Notes:
    420:    Memory is always allocated at least double aligned

    422:    It is safe to allocate with an m of 0 and pass the resulting pointer (which may or may not be `NULL`) to `PetscFree()`.
    423:    However, the pointer should never be dereferenced or the program will crash.

    425:    Developer Note:
    426:    All the `PetscMallocN()` routines actually call `PetscMalloc()` behind the scenes.

    428:    Except for data structures that store information about the PETSc options database all memory allocated by PETSc is
    429:    obtained with `PetscMalloc()` or `PetscCalloc()`

    431: .seealso: `PetscFree()`, `PetscNew()`, `PetscCalloc()`
    432: M*/
    433: #define PetscMalloc(a, b) ((*PetscTrMalloc)((a), PETSC_FALSE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (void **)(b)))

    435: /*MC
    436:    PetscRealloc - Reallocates memory

    438:    Synopsis:
    439: #include <petscsys.h>
    440:    PetscErrorCode PetscRealloc(size_t m,void **result)

    442:    Not Collective

    444:    Input Parameters:
    445: +  m      - number of bytes to allocate
    446: -  result - previous memory

    448:    Output Parameter:
    449: .  result - new memory allocated

    451:    Level: developer

    453:    Notes:
    454:    `results` must have already been obtained with `PetscMalloc()`

    456:    Memory is always allocated at least double aligned

    458: .seealso: `PetscMalloc()`, `PetscFree()`, `PetscNew()`
    459: M*/
    460: #define PetscRealloc(a, b) ((*PetscTrRealloc)((a), __LINE__, PETSC_FUNCTION_NAME, __FILE__, (void **)(b)))

    462: /*MC
    463:    PetscAddrAlign - Rounds up an address to `PETSC_MEMALIGN` alignment

    465:    Synopsis:
    466: #include <petscsys.h>
    467:    void *PetscAddrAlign(void *addr)

    469:    Not Collective

    471:    Input Parameter:
    472: .  addr - address to align (any pointer type)

    474:    Level: developer

    476: .seealso: `PetscMallocAlign()`
    477: M*/
    478: #define PetscAddrAlign(a) ((void *)((((PETSC_UINTPTR_T)(a)) + (PETSC_MEMALIGN - 1)) & ~(PETSC_MEMALIGN - 1)))

    480: /*MC
    481:    PetscCalloc - Allocates a cleared (zeroed) memory region aligned to `PETSC_MEMALIGN`, similar to `PetscMalloc()`

    483:    Synopsis:
    484: #include <petscsys.h>
    485:    PetscErrorCode PetscCalloc(size_t m,void **result)

    487:    Not Collective

    489:    Input Parameter:
    490: .  m - number of bytes to allocate

    492:    Output Parameter:
    493: .  result - memory allocated

    495:    Level: beginner

    497:    Notes:
    498:    Memory is always allocated at least double aligned. This macro is useful in allocating memory pointed by void pointers

    500:    It is safe to allocate with an m of 0 and pass the resulting pointer (which may or may not be `NULL`) to `PetscFree()`.

    502:    However, the pointer should never be dereferenced or the program will crash.

    504:    Developer Note:
    505:    All `PetscCallocN()` routines call `PetscCalloc()` behind the scenes.

    507: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`
    508: M*/
    509: #define PetscCalloc(m, result) PetscMallocA(1, PETSC_TRUE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ((size_t)m), (result))

    511: /*MC
    512:    PetscMalloc1 - Allocates an array of memory aligned to `PETSC_MEMALIGN`

    514:    Synopsis:
    515: #include <petscsys.h>
    516:    PetscErrorCode PetscMalloc1(size_t m1,type **r1)

    518:    Not Collective

    520:    Input Parameter:
    521: .  m1 - number of elements to allocate  (may be zero)

    523:    Output Parameter:
    524: .  r1 - memory allocated

    526:    Level: beginner

    528:    Note:
    529:    This uses `sizeof()` of the memory type requested to determine the total memory to be allocated; therefore, you should not
    530:    multiply the number of elements requested by the `sizeof()` the type. For example, use
    531: .vb
    532:   PetscInt *id;
    533:   PetscMalloc1(10,&id);
    534: .ve
    535:        not
    536: .vb
    537:   PetscInt *id;
    538:   PetscMalloc1(10*sizeof(PetscInt),&id);
    539: .ve

    541:   Does not zero the memory allocated, use `PetscCalloc1()` to obtain memory that has been zeroed.

    543:   The `PetscMalloc[N]()` and `PetscCalloc[N]()` take an argument of type `size_t`! However, most codes use `value`, computed via `int` or `PetscInt` variables. This can overflow in
    544:   32bit `int` computation - while computation in 64bit `size_t` would not overflow!
    545:   It's best if any arithmetic that is done for size computations is done with `size_t` type - avoiding arithmetic overflow!

    547:   `PetscMalloc[N]()` and `PetscCalloc[N]()` attempt to work-around this by casting the first variable to `size_t`.
    548:   This works for most expressions, but not all, such as
    549: .vb
    550:   PetscInt *id, a, b;
    551:   PetscMalloc1(use_a_squared ? a * a * b : a * b, &id); // use_a_squared is cast to size_t, but a and b are still PetscInt
    552:   PetscMalloc1(a + b * b, &id); // a is cast to size_t, but b * b is performed at PetscInt precision first due to order-of-operations
    553: .ve

    555:   These expressions should either be avoided, or appropriately cast variables to `size_t`:
    556: .vb
    557:   PetscInt *id, a, b;
    558:   PetscMalloc1(use_a_squared ? (size_t)a * a * b : (size_t)a * b, &id); // Cast a to size_t before multiplication
    559:   PetscMalloc1(b * b + a, &id); // b is automatically cast to size_t and order-of-operations ensures size_t precision is maintained
    560: .ve

    562: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscCalloc1()`, `PetscMalloc2()`
    563: M*/
    564: #define PetscMalloc1(m1, r1) PetscMallocA(1, PETSC_FALSE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ((size_t)((size_t)m1) * sizeof(**(r1))), (r1))

    566: /*MC
    567:    PetscCalloc1 - Allocates a cleared (zeroed) array of memory aligned to `PETSC_MEMALIGN`

    569:    Synopsis:
    570: #include <petscsys.h>
    571:    PetscErrorCode PetscCalloc1(size_t m1,type **r1)

    573:    Not Collective

    575:    Input Parameter:
    576: .  m1 - number of elements to allocate in 1st chunk  (may be zero)

    578:    Output Parameter:
    579: .  r1 - memory allocated

    581:    Level: beginner

    583:    Note:
    584:    See `PetscMalloc1()` for more details on usage.

    586: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc1()`, `PetscCalloc2()`
    587: M*/
    588: #define PetscCalloc1(m1, r1) PetscMallocA(1, PETSC_TRUE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ((size_t)((size_t)m1) * sizeof(**(r1))), (r1))

    590: /*MC
    591:    PetscMalloc2 - Allocates 2 arrays of memory both aligned to `PETSC_MEMALIGN`

    593:    Synopsis:
    594: #include <petscsys.h>
    595:    PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2)

    597:    Not Collective

    599:    Input Parameters:
    600: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
    601: -  m2 - number of elements to allocate in 2nd chunk  (may be zero)

    603:    Output Parameters:
    604: +  r1 - memory allocated in first chunk
    605: -  r2 - memory allocated in second chunk

    607:    Level: developer

    609: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc1()`, `PetscCalloc2()`
    610: M*/
    611: #define PetscMalloc2(m1, r1, m2, r2) PetscMallocA(2, PETSC_FALSE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ((size_t)((size_t)m1) * sizeof(**(r1))), (r1), ((size_t)((size_t)m2) * sizeof(**(r2))), (r2))

    613: /*MC
    614:    PetscCalloc2 - Allocates 2 cleared (zeroed) arrays of memory both aligned to `PETSC_MEMALIGN`

    616:    Synopsis:
    617: #include <petscsys.h>
    618:    PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2)

    620:    Not Collective

    622:    Input Parameters:
    623: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
    624: -  m2 - number of elements to allocate in 2nd chunk  (may be zero)

    626:    Output Parameters:
    627: +  r1 - memory allocated in first chunk
    628: -  r2 - memory allocated in second chunk

    630:    Level: developer

    632: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscCalloc1()`, `PetscMalloc2()`
    633: M*/
    634: #define PetscCalloc2(m1, r1, m2, r2) PetscMallocA(2, PETSC_TRUE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ((size_t)((size_t)m1) * sizeof(**(r1))), (r1), ((size_t)((size_t)m2) * sizeof(**(r2))), (r2))

    636: /*MC
    637:    PetscMalloc3 - Allocates 3 arrays of memory, all aligned to `PETSC_MEMALIGN`

    639:    Synopsis:
    640: #include <petscsys.h>
    641:    PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)

    643:    Not Collective

    645:    Input Parameters:
    646: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
    647: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
    648: -  m3 - number of elements to allocate in 3rd chunk  (may be zero)

    650:    Output Parameters:
    651: +  r1 - memory allocated in first chunk
    652: .  r2 - memory allocated in second chunk
    653: -  r3 - memory allocated in third chunk

    655:    Level: developer

    657: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc3()`, `PetscFree3()`
    658: M*/
    659: #define PetscMalloc3(m1, r1, m2, r2, m3, r3) \
    660:   PetscMallocA(3, PETSC_FALSE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ((size_t)((size_t)m1) * sizeof(**(r1))), (r1), ((size_t)((size_t)m2) * sizeof(**(r2))), (r2), ((size_t)((size_t)m3) * sizeof(**(r3))), (r3))

    662: /*MC
    663:    PetscCalloc3 - Allocates 3 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN`

    665:    Synopsis:
    666: #include <petscsys.h>
    667:    PetscErrorCode PetscCalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)

    669:    Not Collective

    671:    Input Parameters:
    672: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
    673: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
    674: -  m3 - number of elements to allocate in 3rd chunk  (may be zero)

    676:    Output Parameters:
    677: +  r1 - memory allocated in first chunk
    678: .  r2 - memory allocated in second chunk
    679: -  r3 - memory allocated in third chunk

    681:    Level: developer

    683: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscCalloc2()`, `PetscMalloc3()`, `PetscFree3()`
    684: M*/
    685: #define PetscCalloc3(m1, r1, m2, r2, m3, r3) \
    686:   PetscMallocA(3, PETSC_TRUE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ((size_t)((size_t)m1) * sizeof(**(r1))), (r1), ((size_t)((size_t)m2) * sizeof(**(r2))), (r2), ((size_t)((size_t)m3) * sizeof(**(r3))), (r3))

    688: /*MC
    689:    PetscMalloc4 - Allocates 4 arrays of memory, all aligned to `PETSC_MEMALIGN`

    691:    Synopsis:
    692: #include <petscsys.h>
    693:    PetscErrorCode PetscMalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)

    695:    Not Collective

    697:    Input Parameters:
    698: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
    699: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
    700: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
    701: -  m4 - number of elements to allocate in 4th chunk  (may be zero)

    703:    Output Parameters:
    704: +  r1 - memory allocated in first chunk
    705: .  r2 - memory allocated in second chunk
    706: .  r3 - memory allocated in third chunk
    707: -  r4 - memory allocated in fourth chunk

    709:    Level: developer

    711: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc4()`, `PetscFree4()`
    712: M*/
    713: #define PetscMalloc4(m1, r1, m2, r2, m3, r3, m4, r4) \
    714:   PetscMallocA(4, PETSC_FALSE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ((size_t)((size_t)m1) * sizeof(**(r1))), (r1), ((size_t)((size_t)m2) * sizeof(**(r2))), (r2), ((size_t)((size_t)m3) * sizeof(**(r3))), (r3), ((size_t)((size_t)m4) * sizeof(**(r4))), (r4))

    716: /*MC
    717:    PetscCalloc4 - Allocates 4 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN`

    719:    Synopsis:
    720: #include <petscsys.h>
    721:    PetscErrorCode PetscCalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)

    723:    Not Collective

    725:    Input Parameters:
    726: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
    727: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
    728: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
    729: -  m4 - number of elements to allocate in 4th chunk  (may be zero)

    731:    Output Parameters:
    732: +  r1 - memory allocated in first chunk
    733: .  r2 - memory allocated in second chunk
    734: .  r3 - memory allocated in third chunk
    735: -  r4 - memory allocated in fourth chunk

    737:    Level: developer

    739: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc4()`, `PetscFree4()`
    740: M*/
    741: #define PetscCalloc4(m1, r1, m2, r2, m3, r3, m4, r4) \
    742:   PetscMallocA(4, PETSC_TRUE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ((size_t)((size_t)m1) * sizeof(**(r1))), (r1), ((size_t)((size_t)m2) * sizeof(**(r2))), (r2), ((size_t)((size_t)m3) * sizeof(**(r3))), (r3), ((size_t)((size_t)m4) * sizeof(**(r4))), (r4))

    744: /*MC
    745:    PetscMalloc5 - Allocates 5 arrays of memory, all aligned to `PETSC_MEMALIGN`

    747:    Synopsis:
    748: #include <petscsys.h>
    749:    PetscErrorCode PetscMalloc5(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5)

    751:    Not Collective

    753:    Input Parameters:
    754: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
    755: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
    756: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
    757: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
    758: -  m5 - number of elements to allocate in 5th chunk  (may be zero)

    760:    Output Parameters:
    761: +  r1 - memory allocated in first chunk
    762: .  r2 - memory allocated in second chunk
    763: .  r3 - memory allocated in third chunk
    764: .  r4 - memory allocated in fourth chunk
    765: -  r5 - memory allocated in fifth chunk

    767:    Level: developer

    769: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc5()`, `PetscFree5()`
    770: M*/
    771: #define PetscMalloc5(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5) \
    772:   PetscMallocA(5, PETSC_FALSE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ((size_t)((size_t)m1) * sizeof(**(r1))), (r1), ((size_t)((size_t)m2) * sizeof(**(r2))), (r2), ((size_t)((size_t)m3) * sizeof(**(r3))), (r3), ((size_t)((size_t)m4) * sizeof(**(r4))), (r4), ((size_t)((size_t)m5) * sizeof(**(r5))), (r5))

    774: /*MC
    775:    PetscCalloc5 - Allocates 5 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN`

    777:    Synopsis:
    778: #include <petscsys.h>
    779:    PetscErrorCode PetscCalloc5(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5)

    781:    Not Collective

    783:    Input Parameters:
    784: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
    785: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
    786: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
    787: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
    788: -  m5 - number of elements to allocate in 5th chunk  (may be zero)

    790:    Output Parameters:
    791: +  r1 - memory allocated in first chunk
    792: .  r2 - memory allocated in second chunk
    793: .  r3 - memory allocated in third chunk
    794: .  r4 - memory allocated in fourth chunk
    795: -  r5 - memory allocated in fifth chunk

    797:    Level: developer

    799: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc5()`, `PetscFree5()`
    800: M*/
    801: #define PetscCalloc5(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5) \
    802:   PetscMallocA(5, PETSC_TRUE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ((size_t)((size_t)m1) * sizeof(**(r1))), (r1), ((size_t)((size_t)m2) * sizeof(**(r2))), (r2), ((size_t)((size_t)m3) * sizeof(**(r3))), (r3), ((size_t)((size_t)m4) * sizeof(**(r4))), (r4), ((size_t)((size_t)m5) * sizeof(**(r5))), (r5))

    804: /*MC
    805:    PetscMalloc6 - Allocates 6 arrays of memory, all aligned to `PETSC_MEMALIGN`

    807:    Synopsis:
    808: #include <petscsys.h>
    809:    PetscErrorCode PetscMalloc6(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5,size_t m6,type **r6)

    811:    Not Collective

    813:    Input Parameters:
    814: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
    815: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
    816: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
    817: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
    818: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
    819: -  m6 - number of elements to allocate in 6th chunk  (may be zero)

    821:    Output Parameteasr:
    822: +  r1 - memory allocated in first chunk
    823: .  r2 - memory allocated in second chunk
    824: .  r3 - memory allocated in third chunk
    825: .  r4 - memory allocated in fourth chunk
    826: .  r5 - memory allocated in fifth chunk
    827: -  r6 - memory allocated in sixth chunk

    829:    Level: developer

    831: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc6()`, `PetscFree3()`, `PetscFree4()`, `PetscFree5()`, `PetscFree6()`
    832: M*/
    833: #define PetscMalloc6(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5, m6, r6) \
    834:   PetscMallocA(6, PETSC_FALSE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ((size_t)((size_t)m1) * sizeof(**(r1))), (r1), ((size_t)((size_t)m2) * sizeof(**(r2))), (r2), ((size_t)((size_t)m3) * sizeof(**(r3))), (r3), ((size_t)((size_t)m4) * sizeof(**(r4))), (r4), ((size_t)((size_t)m5) * sizeof(**(r5))), (r5), ((size_t)((size_t)m6) * sizeof(**(r6))), (r6))

    836: /*MC
    837:    PetscCalloc6 - Allocates 6 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN`

    839:    Synopsis:
    840: #include <petscsys.h>
    841:    PetscErrorCode PetscCalloc6(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5,size_t m6,type **r6)

    843:    Not Collective

    845:    Input Parameters:
    846: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
    847: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
    848: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
    849: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
    850: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
    851: -  m6 - number of elements to allocate in 6th chunk  (may be zero)

    853:    Output Parameters:
    854: +  r1 - memory allocated in first chunk
    855: .  r2 - memory allocated in second chunk
    856: .  r3 - memory allocated in third chunk
    857: .  r4 - memory allocated in fourth chunk
    858: .  r5 - memory allocated in fifth chunk
    859: -  r6 - memory allocated in sixth chunk

    861:    Level: developer

    863: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscMalloc6()`, `PetscFree6()`
    864: M*/
    865: #define PetscCalloc6(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5, m6, r6) \
    866:   PetscMallocA(6, PETSC_TRUE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ((size_t)((size_t)m1) * sizeof(**(r1))), (r1), ((size_t)((size_t)m2) * sizeof(**(r2))), (r2), ((size_t)((size_t)m3) * sizeof(**(r3))), (r3), ((size_t)((size_t)m4) * sizeof(**(r4))), (r4), ((size_t)((size_t)m5) * sizeof(**(r5))), (r5), ((size_t)((size_t)m6) * sizeof(**(r6))), (r6))

    868: /*MC
    869:    PetscMalloc7 - Allocates 7 arrays of memory, all aligned to `PETSC_MEMALIGN`

    871:    Synopsis:
    872: #include <petscsys.h>
    873:    PetscErrorCode PetscMalloc7(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5,size_t m6,type **r6,size_t m7,type **r7)

    875:    Not Collective

    877:    Input Parameters:
    878: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
    879: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
    880: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
    881: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
    882: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
    883: .  m6 - number of elements to allocate in 6th chunk  (may be zero)
    884: -  m7 - number of elements to allocate in 7th chunk  (may be zero)

    886:    Output Parameters:
    887: +  r1 - memory allocated in first chunk
    888: .  r2 - memory allocated in second chunk
    889: .  r3 - memory allocated in third chunk
    890: .  r4 - memory allocated in fourth chunk
    891: .  r5 - memory allocated in fifth chunk
    892: .  r6 - memory allocated in sixth chunk
    893: -  r7 - memory allocated in seventh chunk

    895:    Level: developer

    897: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc7()`, `PetscFree7()`
    898: M*/
    899: #define PetscMalloc7(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5, m6, r6, m7, r7) \
    900:   PetscMallocA(7, PETSC_FALSE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ((size_t)((size_t)m1) * sizeof(**(r1))), (r1), ((size_t)((size_t)m2) * sizeof(**(r2))), (r2), ((size_t)((size_t)m3) * sizeof(**(r3))), (r3), ((size_t)((size_t)m4) * sizeof(**(r4))), (r4), ((size_t)((size_t)m5) * sizeof(**(r5))), (r5), ((size_t)((size_t)m6) * sizeof(**(r6))), (r6), ((size_t)((size_t)m7) * sizeof(**(r7))), (r7))

    902: /*MC
    903:    PetscCalloc7 - Allocates 7 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN`

    905:    Synopsis:
    906: #include <petscsys.h>
    907:    PetscErrorCode PetscCalloc7(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4,size_t m5,type **r5,size_t m6,type **r6,size_t m7,type **r7)

    909:    Not Collective

    911:    Input Parameters:
    912: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
    913: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
    914: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
    915: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
    916: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
    917: .  m6 - number of elements to allocate in 6th chunk  (may be zero)
    918: -  m7 - number of elements to allocate in 7th chunk  (may be zero)

    920:    Output Parameters:
    921: +  r1 - memory allocated in first chunk
    922: .  r2 - memory allocated in second chunk
    923: .  r3 - memory allocated in third chunk
    924: .  r4 - memory allocated in fourth chunk
    925: .  r5 - memory allocated in fifth chunk
    926: .  r6 - memory allocated in sixth chunk
    927: -  r7 - memory allocated in seventh chunk

    929:    Level: developer

    931: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscMalloc7()`, `PetscFree7()`
    932: M*/
    933: #define PetscCalloc7(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5, m6, r6, m7, r7) \
    934:   PetscMallocA(7, PETSC_TRUE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ((size_t)((size_t)m1) * sizeof(**(r1))), (r1), ((size_t)((size_t)m2) * sizeof(**(r2))), (r2), ((size_t)((size_t)m3) * sizeof(**(r3))), (r3), ((size_t)((size_t)m4) * sizeof(**(r4))), (r4), ((size_t)((size_t)m5) * sizeof(**(r5))), (r5), ((size_t)((size_t)m6) * sizeof(**(r6))), (r6), ((size_t)((size_t)m7) * sizeof(**(r7))), (r7))

    936: /*MC
    937:    PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to `PETSC_MEMALIGN`

    939:    Synopsis:
    940: #include <petscsys.h>
    941:    PetscErrorCode PetscNew(type **result)

    943:    Not Collective

    945:    Output Parameter:
    946: .  result - memory allocated, sized to match pointer `type`

    948:    Level: beginner

    950:    Developer Note:
    951:    Calls `PetscCalloc()` with the appropriate memory size obtained from `type`

    953: .seealso: `PetscFree()`, `PetscMalloc()`, `PetscCall()`, `PetscCalloc1()`, `PetscMalloc1()`
    954: M*/
    955: #define PetscNew(b) PetscCalloc1(1, (b))

    957: #define PetscNewLog(o, b) PETSC_DEPRECATED_MACRO(3, 18, 0, "PetscNew()", ) PetscNew(b)

    959: /*MC
    960:    PetscFree - Frees memory

    962:    Synopsis:
    963: #include <petscsys.h>
    964:    PetscErrorCode PetscFree(void *memory)

    966:    Not Collective

    968:    Input Parameter:
    969: .   memory - memory to free (the pointer is ALWAYS set to `NULL` upon success)

    971:    Level: beginner

    973:    Notes:
    974:    Do not free memory obtained with `PetscMalloc2()`, `PetscCalloc2()` etc, they must be freed with `PetscFree2()` etc.

    976:    It is safe to call `PetscFree()` on a `NULL` pointer.

    978: .seealso: `PetscNew()`, `PetscMalloc()`, `PetscMalloc1()`, `PetscCalloc1()`
    979: M*/
    980: #define PetscFree(a) ((PetscErrorCode)((*PetscTrFree)((void *)(a), __LINE__, PETSC_FUNCTION_NAME, __FILE__) || ((a) = PETSC_NULLPTR, PETSC_SUCCESS)))

    982: /*MC
    983:    PetscFree2 - Frees 2 chunks of memory obtained with `PetscMalloc2()`

    985:    Synopsis:
    986: #include <petscsys.h>
    987:    PetscErrorCode PetscFree2(void *memory1,void *memory2)

    989:    Not Collective

    991:    Input Parameters:
    992: +   memory1 - memory to free
    993: -   memory2 - 2nd memory to free

    995:    Level: developer

    997:    Notes:
    998:     Memory must have been obtained with `PetscMalloc2()`

    1000:     The arguments need to be in the same order as they were in the call to `PetscMalloc2()`

    1002: .seealso: `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscFree()`
    1003: M*/
    1004: #define PetscFree2(m1, m2) PetscFreeA(2, __LINE__, PETSC_FUNCTION_NAME, __FILE__, &(m1), &(m2))

    1006: /*MC
    1007:    PetscFree3 - Frees 3 chunks of memory obtained with `PetscMalloc3()`

    1009:    Synopsis:
    1010: #include <petscsys.h>
    1011:    PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3)

    1013:    Not Collective

    1015:    Input Parameters:
    1016: +   memory1 - memory to free
    1017: .   memory2 - 2nd memory to free
    1018: -   memory3 - 3rd memory to free

    1020:    Level: developer

    1022:    Notes:
    1023:     Memory must have been obtained with `PetscMalloc3()`

    1025:     The arguments need to be in the same order as they were in the call to `PetscMalloc3()`

    1027: .seealso: `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscFree()`, `PetscMalloc3()`
    1028: M*/
    1029: #define PetscFree3(m1, m2, m3) PetscFreeA(3, __LINE__, PETSC_FUNCTION_NAME, __FILE__, &(m1), &(m2), &(m3))

    1031: /*MC
    1032:    PetscFree4 - Frees 4 chunks of memory obtained with `PetscMalloc4()`

    1034:    Synopsis:
    1035: #include <petscsys.h>
    1036:    PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4)

    1038:    Not Collective

    1040:    Input Parameters:
    1041: +   m1 - memory to free
    1042: .   m2 - 2nd memory to free
    1043: .   m3 - 3rd memory to free
    1044: -   m4 - 4th memory to free

    1046:    Level: developer

    1048:    Notes:
    1049:     Memory must have been obtained with `PetscMalloc4()`

    1051:     The arguments need to be in the same order as they were in the call to `PetscMalloc4()`

    1053: .seealso: `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscFree()`, `PetscMalloc3()`, `PetscMalloc4()`
    1054: M*/
    1055: #define PetscFree4(m1, m2, m3, m4) PetscFreeA(4, __LINE__, PETSC_FUNCTION_NAME, __FILE__, &(m1), &(m2), &(m3), &(m4))

    1057: /*MC
    1058:    PetscFree5 - Frees 5 chunks of memory obtained with `PetscMalloc5()`

    1060:    Synopsis:
    1061: #include <petscsys.h>
    1062:    PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5)

    1064:    Not Collective

    1066:    Input Parameters:
    1067: +   m1 - memory to free
    1068: .   m2 - 2nd memory to free
    1069: .   m3 - 3rd memory to free
    1070: .   m4 - 4th memory to free
    1071: -   m5 - 5th memory to free

    1073:    Level: developer

    1075:    Notes:
    1076:     Memory must have been obtained with `PetscMalloc5()`

    1078:     The arguments need to be in the same order as they were in the call to `PetscMalloc5()`

    1080: .seealso: `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscFree()`, `PetscMalloc3()`, `PetscMalloc4()`, `PetscMalloc5()`
    1081: M*/
    1082: #define PetscFree5(m1, m2, m3, m4, m5) PetscFreeA(5, __LINE__, PETSC_FUNCTION_NAME, __FILE__, &(m1), &(m2), &(m3), &(m4), &(m5))

    1084: /*MC
    1085:    PetscFree6 - Frees 6 chunks of memory obtained with `PetscMalloc6()`

    1087:    Synopsis:
    1088: #include <petscsys.h>
    1089:    PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6)

    1091:    Not Collective

    1093:    Input Parameters:
    1094: +   m1 - memory to free
    1095: .   m2 - 2nd memory to free
    1096: .   m3 - 3rd memory to free
    1097: .   m4 - 4th memory to free
    1098: .   m5 - 5th memory to free
    1099: -   m6 - 6th memory to free

    1101:    Level: developer

    1103:    Notes:
    1104:     Memory must have been obtained with `PetscMalloc6()`

    1106:     The arguments need to be in the same order as they were in the call to `PetscMalloc6()`

    1108: .seealso: `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscFree()`, `PetscMalloc3()`, `PetscMalloc4()`, `PetscMalloc5()`, `PetscMalloc6()`
    1109: M*/
    1110: #define PetscFree6(m1, m2, m3, m4, m5, m6) PetscFreeA(6, __LINE__, PETSC_FUNCTION_NAME, __FILE__, &(m1), &(m2), &(m3), &(m4), &(m5), &(m6))

    1112: /*MC
    1113:    PetscFree7 - Frees 7 chunks of memory obtained with `PetscMalloc7()`

    1115:    Synopsis:
    1116: #include <petscsys.h>
    1117:    PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7)

    1119:    Not Collective

    1121:    Input Parameters:
    1122: +   m1 - memory to free
    1123: .   m2 - 2nd memory to free
    1124: .   m3 - 3rd memory to free
    1125: .   m4 - 4th memory to free
    1126: .   m5 - 5th memory to free
    1127: .   m6 - 6th memory to free
    1128: -   m7 - 7th memory to free

    1130:    Level: developer

    1132:    Notes:
    1133:     Memory must have been obtained with `PetscMalloc7()`

    1135:     The arguments need to be in the same order as they were in the call to `PetscMalloc7()`

    1137: .seealso: `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscFree()`, `PetscMalloc3()`, `PetscMalloc4()`, `PetscMalloc5()`, `PetscMalloc6()`,
    1138:           `PetscMalloc7()`
    1139: M*/
    1140: #define PetscFree7(m1, m2, m3, m4, m5, m6, m7) PetscFreeA(7, __LINE__, PETSC_FUNCTION_NAME, __FILE__, &(m1), &(m2), &(m3), &(m4), &(m5), &(m6), &(m7))

    1142: PETSC_EXTERN PetscErrorCode PetscMallocA(int, PetscBool, int, const char *, const char *, size_t, void *, ...);
    1143: PETSC_EXTERN PetscErrorCode PetscFreeA(int, int, const char *, const char *, void *, ...);
    1144: PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t, PetscBool, int, const char[], const char[], void **);
    1145: PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void *, int, const char[], const char[]);
    1146: PETSC_EXTERN PetscErrorCode (*PetscTrRealloc)(size_t, int, const char[], const char[], void **);
    1147: PETSC_EXTERN PetscErrorCode PetscMallocSetCoalesce(PetscBool);
    1148: PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t, PetscBool, int, const char[], const char[], void **), PetscErrorCode (*)(void *, int, const char[], const char[]), PetscErrorCode (*)(size_t, int, const char[], const char[], void **));
    1149: PETSC_EXTERN PetscErrorCode PetscMallocClear(void);

    1151: /*
    1152:   Unlike PetscMallocSet and PetscMallocClear which overwrite the existing settings, these two functions save the previous choice of allocator, and should be used in pair.
    1153: */
    1154: PETSC_EXTERN PetscErrorCode PetscMallocSetDRAM(void);
    1155: PETSC_EXTERN PetscErrorCode PetscMallocResetDRAM(void);
    1156: #if defined(PETSC_HAVE_CUDA)
    1157: PETSC_EXTERN PetscErrorCode PetscMallocSetCUDAHost(void);
    1158: PETSC_EXTERN PetscErrorCode PetscMallocResetCUDAHost(void);
    1159: #endif
    1160: #if defined(PETSC_HAVE_HIP)
    1161: PETSC_EXTERN PetscErrorCode PetscMallocSetHIPHost(void);
    1162: PETSC_EXTERN PetscErrorCode PetscMallocResetHIPHost(void);
    1163: #endif

    1165: #define MPIU_PETSCLOGDOUBLE  MPI_DOUBLE
    1166: #define MPIU_2PETSCLOGDOUBLE MPI_2DOUBLE_PRECISION

    1168: /*
    1169:    Routines for tracing memory corruption/bleeding with default PETSc memory allocation
    1170: */
    1171: PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *);
    1172: PETSC_EXTERN PetscErrorCode PetscMallocView(FILE *);
    1173: PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *);
    1174: PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *);
    1175: PETSC_EXTERN PetscErrorCode PetscMallocPushMaximumUsage(int);
    1176: PETSC_EXTERN PetscErrorCode PetscMallocPopMaximumUsage(int, PetscLogDouble *);
    1177: PETSC_EXTERN PetscErrorCode PetscMallocSetDebug(PetscBool, PetscBool);
    1178: PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool *, PetscBool *, PetscBool *);
    1179: PETSC_EXTERN PetscErrorCode PetscMallocValidate(int, const char[], const char[]);
    1180: PETSC_EXTERN PetscErrorCode PetscMallocViewSet(PetscLogDouble);
    1181: PETSC_EXTERN PetscErrorCode PetscMallocViewGet(PetscBool *);
    1182: PETSC_EXTERN PetscErrorCode PetscMallocLogRequestedSizeSet(PetscBool);
    1183: PETSC_EXTERN PetscErrorCode PetscMallocLogRequestedSizeGet(PetscBool *);

    1185: PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType, MPI_Datatype *);
    1186: PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype, PetscDataType *);
    1187: PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType, size_t *);
    1188: PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char *, PetscDataType *, PetscBool *);

    1190: /*
    1191:    These are MPI operations for MPI_Allreduce() etc
    1192: */
    1193: PETSC_EXTERN MPI_Op MPIU_MAXSUM_OP;
    1194: #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
    1195: PETSC_EXTERN MPI_Op MPIU_SUM;
    1196: PETSC_EXTERN MPI_Op MPIU_MAX;
    1197: PETSC_EXTERN MPI_Op MPIU_MIN;
    1198: #else
    1199:   #define MPIU_SUM MPI_SUM
    1200:   #define MPIU_MAX MPI_MAX
    1201:   #define MPIU_MIN MPI_MIN
    1202: #endif
    1203: PETSC_EXTERN MPI_Op         Petsc_Garbage_SetIntersectOp;
    1204: PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm, const PetscInt[], PetscInt *, PetscInt *);

    1206: #if (defined(PETSC_HAVE_REAL___FLOAT128) && !defined(PETSC_SKIP_REAL___FLOAT128)) || (defined(PETSC_HAVE_REAL___FP16) && !defined(PETSC_SKIP_REAL___FP16))
    1207: /*MC
    1208:    MPIU_SUM___FP16___FLOAT128 - MPI_Op that acts as a replacement for `MPI_SUM` with
    1209:    custom `MPI_Datatype` `MPIU___FLOAT128`, `MPIU___COMPLEX128`, and `MPIU___FP16`.

    1211:    Level: advanced

    1213:    Developer Note:
    1214:    This should be unified with `MPIU_SUM`

    1216: .seealso: `MPIU_REAL`, `MPIU_SCALAR`, `MPIU_COMPLEX`
    1217: M*/
    1218: PETSC_EXTERN MPI_Op MPIU_SUM___FP16___FLOAT128;
    1219: #endif
    1220: PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm, const PetscInt[], PetscInt *, PetscInt *);

    1222: PETSC_EXTERN PetscErrorCode MPIULong_Send(void *, PetscInt, MPI_Datatype, PetscMPIInt, PetscMPIInt, MPI_Comm) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(1, 3);
    1223: PETSC_EXTERN PetscErrorCode MPIULong_Recv(void *, PetscInt, MPI_Datatype, PetscMPIInt, PetscMPIInt, MPI_Comm) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(1, 3);

    1225: /*
    1226:     Defines PETSc error handling.
    1227: */
    1228: #include <petscerror.h>

    1230: PETSC_EXTERN PetscBool   PetscCIEnabled;                    /* code is running in the PETSc test harness CI */
    1231: PETSC_EXTERN PetscBool   PetscCIEnabledPortableErrorOutput; /* error output is stripped to ensure portability of error messages across systems */
    1232: PETSC_EXTERN const char *PetscCIFilename(const char *);
    1233: PETSC_EXTERN int         PetscCILinenumber(int);

    1235: #define PETSC_SMALLEST_CLASSID ((PetscClassId)1211211)
    1236: PETSC_EXTERN PetscClassId   PETSC_LARGEST_CLASSID;
    1237: PETSC_EXTERN PetscClassId   PETSC_OBJECT_CLASSID;
    1238: PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[], PetscClassId *);
    1239: PETSC_EXTERN PetscErrorCode PetscObjectGetId(PetscObject, PetscObjectId *);
    1240: PETSC_EXTERN PetscErrorCode PetscObjectCompareId(PetscObject, PetscObjectId, PetscBool *);

    1242: /*
    1243:    Routines that get memory usage information from the OS
    1244: */
    1245: PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *);
    1246: PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *);
    1247: PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void);
    1248: PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]);

    1250: PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal);

    1252: /*
    1253:    Initialization of PETSc
    1254: */
    1255: PETSC_EXTERN PetscErrorCode PetscInitialize(int *, char ***, const char[], const char[]);
    1256: PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int, char **, const char[], const char[]);
    1257: PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void);
    1258: PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *);
    1259: PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *);
    1260: PETSC_EXTERN PetscErrorCode PetscFinalize(void);
    1261: PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void);
    1262: PETSC_EXTERN PetscErrorCode PetscGetArgs(int *, char ***);
    1263: PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***);
    1264: PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **);

    1266: PETSC_EXTERN PetscErrorCode PetscEnd(void);
    1267: PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void);
    1268: PETSC_EXTERN PetscErrorCode PetscSysFinalizePackage(void);

    1270: PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[], const char[]);
    1271: PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void);
    1272: PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void);
    1273: PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject, const char[]);

    1275: PETSC_EXTERN PetscErrorCode PetscMonitorCompare(PetscErrorCode (*)(void), void *, PetscErrorCode (*)(void **), PetscErrorCode (*)(void), void *, PetscErrorCode (*)(void **), PetscBool *);

    1277: /*
    1278:      These are so that in extern C code we can cast function pointers to non-extern C
    1279:    function pointers. Since the regular C++ code expects its function pointers to be C++
    1280: */

    1282: /*S
    1283:   PetscVoidFn - A prototype of a void (fn)(void) function

    1285:   Level: developer

    1287:   Notes:
    1288:   The deprecated `PetscVoidFunction` works as a replacement for `PetscVoidFn` *.

    1290:   The deprecated `PetscVoidStarFunction` works as a replacement for `PetscVoidFn` **.

    1292: .seealso: `PetscObject`, `PetscObjectDestroy()`
    1293: S*/
    1294: PETSC_EXTERN_TYPEDEF typedef void(PetscVoidFn)(void);

    1296: PETSC_EXTERN_TYPEDEF typedef PetscVoidFn  *PetscVoidFunction;
    1297: PETSC_EXTERN_TYPEDEF typedef PetscVoidFn **PetscVoidStarFunction;

    1299: /*S
    1300:   PetscErrorCodeFn - A prototype of a PetscErrorCode (fn)(void) function

    1302:   Level: developer

    1304:   Notes:
    1305:   The deprecated `PetscErrorCodeFunction` works as a replacement for `PetscErrorCodeFn` *.

    1307: .seealso: `PetscObject`, `PetscObjectDestroy()`
    1308: S*/
    1309: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode(PetscErrorCodeFn)(void);

    1311: PETSC_EXTERN_TYPEDEF typedef PetscErrorCodeFn *PetscErrorCodeFunction;

    1313: /*
    1314:     Functions that can act on any PETSc object.
    1315: */
    1316: PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject *);
    1317: PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject, MPI_Comm *);
    1318: PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject, PetscClassId *);
    1319: PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject, const char *[]);
    1320: PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject, const char *[]);
    1321: PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject, const char[]);
    1322: PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject, const char *[]);
    1323: PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject, PetscInt);
    1324: PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject, PetscInt *);
    1325: PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject, PetscObject, PetscInt);
    1326: PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject);
    1327: PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject, PetscInt *);
    1328: PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject);
    1329: PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject, PetscMPIInt *);
    1330: PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject, const char[], PetscObject);
    1331: PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject, const char[]);
    1332: PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject, const char[], PetscObject *);
    1333: PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject, const char[], void (*)(void));
    1334: #define PetscObjectComposeFunction(a, b, ...) PetscObjectComposeFunction_Private((a), (b), (PetscVoidFn *)(__VA_ARGS__))
    1335: PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject);
    1336: PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject);
    1337: PETSC_EXTERN PetscErrorCode PetscObjectSetPrintedOptions(PetscObject);
    1338: PETSC_EXTERN PetscErrorCode PetscObjectInheritPrintedOptions(PetscObject, PetscObject);
    1339: PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm, PetscMPIInt *);

    1341: /*MC
    1342:    PetscObjectParameterSetDefault - sets a parameter default value in a `PetscObject` to a new default value.
    1343:    If the current value matches the old default value, then the current value is also set to the new value.

    1345:    No Fortran Support

    1347:    Synopsis:
    1348: #include <petscsys.h>
    1349:    PetscBool PetscObjectParameterSetDefault(PetscObject obj, char* NAME, PetscReal value);

    1351:    Input Parameters:
    1352: +  obj - the `PetscObject`
    1353: .  NAME - the name of the parameter, unquoted
    1354: -  value - the new value

    1356:    Level: developer

    1358:    Notes:
    1359:    The defaults for an object are the values set when the object's type is set.

    1361:    This should only be used in object constructors, such as, `SNESCreate_NGS()`.

    1363:    This only works for parameters that are declared in the struct with `PetscObjectParameterDeclare()`

    1365: .seealso: `PetscObjectParameterDeclare()`, `PetscInitialize()`, `PetscFinalize()`, `PetscObject`, `SNESParametersInitialize()`
    1366: M*/
    1367: #define PetscObjectParameterSetDefault(obj, NAME, value) \
    1368:   do { \
    1369:     if (obj->NAME == obj->default_##NAME) obj->NAME = value; \
    1370:     obj->default_##NAME = value; \
    1371:   } while (0)

    1373: /*MC
    1374:    PetscObjectParameterDeclare - declares a parameter in a `PetscObject` and a location to store its default

    1376:    No Fortran Support

    1378:    Synopsis:
    1379: #include <petscsys.h>
    1380:    PetscBool PetscObjectParameterDeclare(type, char* NAME)

    1382:    Input Parameters:
    1383: +  type - the type of the parameter, for example `PetscInt`
    1384: -  NAME - the name of the parameter, unquoted

    1386:    Level: developer.

    1388: .seealso: `PetscObjectParameterSetDefault()`, `PetscInitialize()`, `PetscFinalize()`, `PetscObject`, `SNESParametersInitialize()`
    1389: M*/
    1390: #define PetscObjectParameterDeclare(type, NAME) type NAME, default_##NAME

    1392: #include <petscviewertypes.h>
    1393: #include <petscoptions.h>

    1395: PETSC_EXTERN PetscErrorCode PetscMallocTraceSet(PetscViewer, PetscBool, PetscLogDouble);
    1396: PETSC_EXTERN PetscErrorCode PetscMallocTraceGet(PetscBool *);

    1398: PETSC_EXTERN PetscErrorCode PetscObjectsListGetGlobalNumbering(MPI_Comm, PetscInt, PetscObject *, PetscInt *, PetscInt *);

    1400: PETSC_EXTERN PetscErrorCode PetscMemoryView(PetscViewer, const char[]);
    1401: PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject, PetscViewer);
    1402: PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject, PetscViewer);
    1403: #define PetscObjectQueryFunction(obj, name, fptr) PetscObjectQueryFunction_Private((obj), (name), (PetscVoidFn **)(fptr))
    1404: PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject, const char[], void (**)(void));
    1405: PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject, const char[]);
    1406: PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject, const char[]);
    1407: PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject, const char[]);
    1408: PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject, const char *[]);
    1409: PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject, const char[]);
    1410: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject);
    1411: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void);
    1412: PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject, PetscObject, const char[]);
    1413: PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject);
    1414: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject, const char[], PetscBool *);
    1415: PETSC_EXTERN PetscErrorCode PetscObjectObjectTypeCompare(PetscObject, PetscObject, PetscBool *);
    1416: PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompare(PetscObject, const char[], PetscBool *);
    1417: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject, PetscBool *, const char[], ...);
    1418: PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompareAny(PetscObject, PetscBool *, const char[], ...);
    1419: PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void));
    1420: PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void);

    1422: #if defined(PETSC_HAVE_SAWS)
    1423: PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void);
    1424: PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject);
    1425: PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject, PetscBool);
    1426: PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject);
    1427: PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject);
    1428: PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject);
    1429: PETSC_EXTERN void           PetscStackSAWsGrantAccess(void);
    1430: PETSC_EXTERN void           PetscStackSAWsTakeAccess(void);
    1431: PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void);
    1432: PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void);

    1434: #else
    1435:   #define PetscSAWsBlock()                  PETSC_SUCCESS
    1436:   #define PetscObjectSAWsViewOff(obj)       PETSC_SUCCESS
    1437:   #define PetscObjectSAWsSetBlock(obj, flg) PETSC_SUCCESS
    1438:   #define PetscObjectSAWsBlock(obj)         PETSC_SUCCESS
    1439:   #define PetscObjectSAWsGrantAccess(obj)   PETSC_SUCCESS
    1440:   #define PetscObjectSAWsTakeAccess(obj)    PETSC_SUCCESS
    1441:   #define PetscStackViewSAWs()              PETSC_SUCCESS
    1442:   #define PetscStackSAWsViewOff()           PETSC_SUCCESS
    1443:   #define PetscStackSAWsTakeAccess()
    1444:   #define PetscStackSAWsGrantAccess()

    1446: #endif

    1448: PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[], PetscDLMode, PetscDLHandle *);
    1449: PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *);
    1450: PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle, const char[], void **);
    1451: PETSC_EXTERN PetscErrorCode PetscDLAddr(void (*)(void), char **);
    1452: #ifdef PETSC_HAVE_CXX
    1453: PETSC_EXTERN PetscErrorCode PetscDemangleSymbol(const char *, char **);
    1454: #endif

    1456: PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void *, PetscStack **);

    1458: PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE *, PetscBool);
    1459: PETSC_EXTERN PetscErrorCode PetscObjectsView(PetscViewer);
    1460: PETSC_EXTERN PetscErrorCode PetscObjectsGetObject(const char *, PetscObject *, const char **);
    1461: PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList *);
    1462: PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList, const char[], PetscObject *);
    1463: PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList, PetscObject, char **, PetscBool *);
    1464: PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *, const char[], PetscObject);
    1465: PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *, const char[]);
    1466: PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList, PetscObjectList *);

    1468: /*
    1469:     Dynamic library lists. Lists of names of routines in objects or in dynamic
    1470:   link libraries that will be loaded as needed.
    1471: */

    1473: #define PetscFunctionListAdd(list, name, fptr) PetscFunctionListAdd_Private((list), (name), (PetscVoidFn *)(fptr))
    1474: PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList *, const char[], PetscVoidFn *);
    1475: PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList *);
    1476: PETSC_EXTERN PetscErrorCode PetscFunctionListClear(PetscFunctionList);
    1477: #define PetscFunctionListFind(list, name, fptr) PetscFunctionListFind_Private((list), (name), (PetscVoidFn **)(fptr))
    1478: PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList, const char[], PetscVoidFn **);
    1479: PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm, FILE *, const char[], const char[], const char[], const char[], PetscFunctionList, const char[], const char[]);
    1480: PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList, PetscFunctionList *);
    1481: PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList, PetscViewer);
    1482: PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList, const char ***, int *);
    1483: PETSC_EXTERN PetscErrorCode PetscFunctionListPrintNonEmpty(PetscFunctionList);
    1484: PETSC_EXTERN PetscErrorCode PetscFunctionListPrintAll(void);

    1486: PETSC_EXTERN PetscDLLibrary PetscDLLibrariesLoaded;
    1487: PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm, PetscDLLibrary *, const char[]);
    1488: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm, PetscDLLibrary *, const char[]);
    1489: PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm, PetscDLLibrary *, const char[], const char[], void **);
    1490: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary);
    1491: PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm, const char[], char *, size_t, PetscBool *);
    1492: PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm, const char[], PetscDLLibrary *);
    1493: PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary);

    1495: /*
    1496:      Useful utility routines
    1497: */
    1498: PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm, PetscInt *, PetscInt *);
    1499: PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm, PetscInt, PetscInt *, PetscInt *);
    1500: PETSC_EXTERN PetscErrorCode PetscSplitOwnershipEqual(MPI_Comm, PetscInt *, PetscInt *);
    1501: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm, PetscMPIInt);
    1502: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm, PetscMPIInt);
    1503: PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject);
    1504: PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE *);
    1505: PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxInt(MPI_Comm, const PetscInt[2], PetscInt[2]);
    1506: PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxReal(MPI_Comm, const PetscReal[2], PetscReal[2]);

    1508: /*MC
    1509:     PetscNot - negates a logical type value and returns result as a `PetscBool`

    1511:     Level: beginner

    1513:     Note:
    1514:     This is useful in cases like
    1515: .vb
    1516:      int        *a;
    1517:      PetscBool  flag = PetscNot(a)
    1518: .ve
    1519:      where !a would not return a `PetscBool` because we cannot provide a cast from int to `PetscBool` in C.

    1521: .seealso: `PetscBool`, `PETSC_TRUE`, `PETSC_FALSE`
    1522: M*/
    1523: #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)

    1525: /*MC
    1526:    PetscHelpPrintf - Prints help messages.

    1528:    Synopsis:
    1529: #include <petscsys.h>
    1530:      PetscErrorCode (*PetscHelpPrintf)(MPI_Comm comm, const char format[],args);

    1532:    Not Collective, only applies on MPI rank 0; No Fortran Support

    1534:    Input Parameters:
    1535: +  comm - the MPI communicator over which the help message is printed
    1536: .  format - the usual printf() format string
    1537: -  args - arguments to be printed

    1539:    Level: developer

    1541:    Notes:
    1542:    You can change how help messages are printed by replacing the function pointer with a function that does not simply write to stdout.

    1544:    To use, write your own function, for example,
    1545: .vb
    1546:    PetscErrorCode mypetschelpprintf(MPI_Comm comm,const char format[],....)
    1547:    {
    1548:      PetscFunctionReturn(PETSC_SUCCESS);
    1549:    }
    1550: .ve
    1551: then do the assignment
    1552: .vb
    1553:   PetscHelpPrintf = mypetschelpprintf;
    1554: .ve

    1556:   You can do the assignment before `PetscInitialize()`.

    1558:   The default routine used is called `PetscHelpPrintfDefault()`.

    1560: .seealso: `PetscFPrintf()`, `PetscSynchronizedPrintf()`, `PetscErrorPrintf()`, `PetscHelpPrintfDefault()`
    1561: M*/
    1562: PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);

    1564: /*
    1565:      Defines PETSc profiling.
    1566: */
    1567: #include <petsclog.h>

    1569: /*
    1570:       Simple PETSc parallel IO for ASCII printing
    1571: */
    1572: PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[], char[]);
    1573: PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm, const char[], const char[], FILE **);
    1574: PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm, FILE *);
    1575: PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm, FILE *, const char[], ...) PETSC_ATTRIBUTE_FORMAT(3, 4);
    1576: PETSC_EXTERN PetscErrorCode PetscFFlush(FILE *);
    1577: PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);
    1578: PETSC_EXTERN PetscErrorCode PetscSNPrintf(char *, size_t, const char[], ...) PETSC_ATTRIBUTE_FORMAT(3, 4);
    1579: PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char *, size_t, const char[], size_t *, ...) PETSC_ATTRIBUTE_FORMAT(3, 5);
    1580: PETSC_EXTERN PetscErrorCode PetscFormatRealArray(char[], size_t, const char *, PetscInt, const PetscReal[]);

    1582: PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char[], ...) PETSC_ATTRIBUTE_FORMAT(1, 2);
    1583: PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char[], ...) PETSC_ATTRIBUTE_FORMAT(1, 2);
    1584: PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);

    1586: PETSC_EXTERN PetscErrorCode PetscFormatConvertGetSize(const char *, size_t *);
    1587: PETSC_EXTERN PetscErrorCode PetscFormatConvert(const char *, char *);

    1589: PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm, const char[], const char[], const char[], FILE **);
    1590: PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm, FILE *);
    1591: PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]);

    1593: PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);
    1594: PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm, FILE *, const char[], ...) PETSC_ATTRIBUTE_FORMAT(3, 4);
    1595: PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm, FILE *);
    1596: PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm, FILE *, size_t, char[]);
    1597: PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm, const char[], const char[], FILE **);
    1598: PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char *[]);

    1600: PETSC_EXTERN PetscClassId   PETSC_CONTAINER_CLASSID;
    1601: PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer, void **);
    1602: PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer, void *);
    1603: PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer *);
    1604: PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm, PetscContainer *);
    1605: PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void *));
    1606: PETSC_EXTERN PetscErrorCode PetscContainerUserDestroyDefault(void *);
    1607: PETSC_EXTERN PetscErrorCode PetscObjectContainerCompose(PetscObject, const char *name, void *, PetscErrorCode (*)(void *));
    1608: PETSC_EXTERN PetscErrorCode PetscObjectContainerQuery(PetscObject, const char *, void **);

    1610: /*
    1611:    For use in debuggers
    1612: */
    1613: PETSC_EXTERN PetscMPIInt    PetscGlobalRank;
    1614: PETSC_EXTERN PetscMPIInt    PetscGlobalSize;
    1615: PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt, const PetscInt[], PetscViewer);
    1616: PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt, const PetscReal[], PetscViewer);
    1617: PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt, const PetscScalar[], PetscViewer);

    1619: /*
    1620:     Basic memory and string operations. These are usually simple wrappers
    1621:    around the basic Unix system calls, but a few of them have additional
    1622:    functionality and/or error checking.
    1623: */
    1624: #include <petscstring.h>

    1626: #include <stddef.h>
    1627: #include <stdlib.h>

    1629: #if defined(PETSC_CLANG_STATIC_ANALYZER)
    1630:   #define PetscPrefetchBlock(a, b, c, d)
    1631: #else
    1632:   /*MC
    1633:    PetscPrefetchBlock - Prefetches a block of memory

    1635:    Synopsis:
    1636: #include <petscsys.h>
    1637:     void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t)

    1639:    Not Collective

    1641:    Input Parameters:
    1642: +  a  - pointer to first element to fetch (any type but usually `PetscInt` or `PetscScalar`)
    1643: .  n  - number of elements to fetch
    1644: .  rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors)
    1645: -  t  - temporal locality (PETSC_PREFETCH_HINT_{NTA,T0,T1,T2}), see note

    1647:    Level: developer

    1649:    Notes:
    1650:    The last two arguments (`rw` and `t`) must be compile-time constants.

    1652:    Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality.  Not all architectures offer
    1653:    equivalent locality hints, but the following macros are always defined to their closest analogue.
    1654: +  `PETSC_PREFETCH_HINT_NTA` - Non-temporal.  Prefetches directly to L1, evicts to memory (skips higher level cache unless it was already there when prefetched).
    1655: .  `PETSC_PREFETCH_HINT_T0`  - Fetch to all levels of cache and evict to the closest level.  Use this when the memory will be reused regularly despite necessary eviction from L1.
    1656: .  `PETSC_PREFETCH_HINT_T1`  - Fetch to level 2 and higher (not L1).
    1657: -  `PETSC_PREFETCH_HINT_T2`  - Fetch to high-level cache only.  (On many systems, T0 and T1 are equivalent.)

    1659:    This function does nothing on architectures that do not support prefetch and never errors (even if passed an invalid
    1660:    address).

    1662: M*/
    1663:   #define PetscPrefetchBlock(a, n, rw, t) \
    1664:     do { \
    1665:       const char *_p = (const char *)(a), *_end = (const char *)((a) + (n)); \
    1666:       for (; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p, (rw), (t)); \
    1667:     } while (0)
    1668: #endif
    1669: /*
    1670:       Determine if some of the kernel computation routines use
    1671:    Fortran (rather than C) for the numerical calculations. On some machines
    1672:    and compilers (like complex numbers) the Fortran version of the routines
    1673:    is faster than the C/C++ versions. The flag --with-fortran-kernels
    1674:    should be used with ./configure to turn these on.
    1675: */
    1676: #if defined(PETSC_USE_FORTRAN_KERNELS)

    1678:   #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL)
    1679:     #define PETSC_USE_FORTRAN_KERNEL_MULTCRL
    1680:   #endif

    1682:   #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
    1683:     #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
    1684:   #endif

    1686:   #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
    1687:     #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
    1688:   #endif

    1690:   #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
    1691:     #define PETSC_USE_FORTRAN_KERNEL_MAXPY
    1692:   #endif

    1694:   #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
    1695:     #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
    1696:   #endif

    1698:   #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
    1699:     #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
    1700:   #endif

    1702:   #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
    1703:     #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
    1704:   #endif

    1706:   #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
    1707:     #define PETSC_USE_FORTRAN_KERNEL_MDOT
    1708:   #endif

    1710:   #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
    1711:     #define PETSC_USE_FORTRAN_KERNEL_XTIMESY
    1712:   #endif

    1714:   #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX)
    1715:     #define PETSC_USE_FORTRAN_KERNEL_AYPX
    1716:   #endif

    1718:   #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY)
    1719:     #define PETSC_USE_FORTRAN_KERNEL_WAXPY
    1720:   #endif

    1722: #endif

    1724: /*
    1725:     Macros for indicating code that should be compiled with a C interface,
    1726:    rather than a C++ interface. Any routines that are dynamically loaded
    1727:    (such as the PCCreate_XXX() routines) must be wrapped so that the name
    1728:    mangler does not change the functions symbol name. This just hides the
    1729:    ugly extern "C" {} wrappers.
    1730: */
    1731: #if defined(__cplusplus)
    1732:   #define EXTERN_C_BEGIN extern "C" {
    1733:   #define EXTERN_C_END   }
    1734: #else
    1735:   #define EXTERN_C_BEGIN
    1736:   #define EXTERN_C_END
    1737: #endif

    1739: /*MC
    1740:    MPI_Comm - the basic object used by MPI to determine which processes are involved in a
    1741:    communication

    1743:    Level: beginner

    1745:    Note:
    1746:    This manual page is a place-holder because MPICH does not have a manual page for `MPI_Comm`

    1748: .seealso: `PETSC_COMM_WORLD`, `PETSC_COMM_SELF`
    1749: M*/

    1751: #if defined(PETSC_HAVE_MPIIO)
    1752: PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File, void *, PetscMPIInt, MPI_Datatype, MPI_Status *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(2, 4);
    1753: PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File, void *, PetscMPIInt, MPI_Datatype, MPI_Status *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(2, 4);
    1754: PETSC_EXTERN PetscErrorCode MPIU_File_write_at(MPI_File, MPI_Offset, void *, PetscMPIInt, MPI_Datatype, MPI_Status *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 5);
    1755: PETSC_EXTERN PetscErrorCode MPIU_File_read_at(MPI_File, MPI_Offset, void *, PetscMPIInt, MPI_Datatype, MPI_Status *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 5);
    1756: PETSC_EXTERN PetscErrorCode MPIU_File_write_at_all(MPI_File, MPI_Offset, void *, PetscMPIInt, MPI_Datatype, MPI_Status *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 5);
    1757: PETSC_EXTERN PetscErrorCode MPIU_File_read_at_all(MPI_File, MPI_Offset, void *, PetscMPIInt, MPI_Datatype, MPI_Status *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 5);
    1758: #endif

    1760: #if defined(PETSC_HAVE_MPI_COUNT)
    1761: typedef MPI_Count MPIU_Count;
    1762: #else
    1763: typedef PetscInt64 MPIU_Count;
    1764: #endif

    1766: /*@C
    1767:    PetscIntCast - casts a `MPI_Count`, `PetscInt64`, `PetscCount`, or `size_t` to a `PetscInt` (which may be 32-bits in size), generates an
    1768:    error if the `PetscInt` is not large enough to hold the number.

    1770:    Not Collective; No Fortran Support

    1772:    Input Parameter:
    1773: .  a - the `PetscInt64` value

    1775:    Output Parameter:
    1776: .  b - the resulting `PetscInt` value, or `NULL` if the result is not needed

    1778:    Level: advanced

    1780:    Note:
    1781:    If integers needed for the applications are too large to fit in 32-bit ints you can ./configure using `--with-64-bit-indices` to make `PetscInt` use 64-bit integers

    1783: .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscMPIIntCast()`, `PetscBLASIntCast()`, `PetscIntMultError()`, `PetscIntSumError()`
    1784: @*/
    1785: static inline PetscErrorCode PetscIntCast(MPIU_Count a, PetscInt *b)
    1786: {
    1787:   PetscFunctionBegin;
    1788:   if (b) *b = 0; /* to prevent compilers erroneously suggesting uninitialized variable */
    1789:   PetscCheck(sizeof(MPIU_Count) <= sizeof(PetscInt) || (a <= (MPIU_Count)PETSC_INT_MAX && a >= (MPIU_Count)PETSC_INT_MIN), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%" PetscInt64_FMT " is too big for PetscInt, you may need to ./configure using --with-64-bit-indices", (PetscInt64)a);
    1790:   if (b) *b = (PetscInt)a;
    1791:   PetscFunctionReturn(PETSC_SUCCESS);
    1792: }

    1794: /*@C
    1795:    PetscBLASIntCast - casts a `MPI_Count`, `PetscInt`, `PetscCount` or `PetscInt64` to a `PetscBLASInt` (which may be 32-bits in size), generates an
    1796:    error if the `PetscBLASInt` is not large enough to hold the number.

    1798:    Not Collective; No Fortran Support

    1800:    Input Parameter:
    1801: .  a - the `PetscInt` value

    1803:    Output Parameter:
    1804: .  b - the resulting `PetscBLASInt` value, or `NULL` if the result is not needed

    1806:    Level: advanced

    1808:    Note:
    1809:    Errors if the integer is negative since PETSc calls to BLAS/LAPACK never need to cast negative integer inputs

    1811: .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscMPIIntCast()`, `PetscIntCast()`
    1812: @*/
    1813: static inline PetscErrorCode PetscBLASIntCast(MPIU_Count a, PetscBLASInt *b)
    1814: {
    1815:   PetscFunctionBegin;
    1816:   if (b) *b = 0; /* to prevent compilers erroneously suggesting uninitialized variable */
    1817:   PetscCheck(sizeof(MPIU_Count) <= sizeof(PetscBLASInt) || a <= (MPIU_Count)PETSC_BLAS_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%" PetscInt64_FMT " is too big for BLAS/LAPACK, which is restricted to 32-bit integers. Either you have an invalidly large integer error in your code or you must ./configure PETSc with --with-64-bit-blas-indices for the case you are running", (PetscInt64)a);
    1818:   PetscCheck(a >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Passing negative integer to BLAS/LAPACK routine");
    1819:   if (b) *b = (PetscBLASInt)a;
    1820:   PetscFunctionReturn(PETSC_SUCCESS);
    1821: }

    1823: /*@C
    1824:    PetscCuBLASIntCast - like `PetscBLASIntCast()`, but for `PetscCuBLASInt`.

    1826:    Not Collective; No Fortran Support

    1828:    Input Parameter:
    1829: .  a - the `PetscInt` value

    1831:    Output Parameter:
    1832: .  b - the resulting `PetscCuBLASInt` value, or `NULL` if the result is not needed

    1834:    Level: advanced

    1836:    Note:
    1837:    Errors if the integer is negative since PETSc calls to cuBLAS and friends never need to cast negative integer inputs

    1839: .seealso: `PetscCuBLASInt`, `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscMPIIntCast()`, `PetscIntCast()`
    1840: @*/
    1841: static inline PetscErrorCode PetscCuBLASIntCast(MPIU_Count a, PetscCuBLASInt *b)
    1842: {
    1843:   PetscFunctionBegin;
    1844:   if (b) *b = 0; /* to prevent compilers erroneously suggesting uninitialized variable */
    1845:   PetscCheck(sizeof(MPIU_Count) <= sizeof(PetscCuBLASInt) || a <= (MPIU_Count)PETSC_CUBLAS_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%" PetscInt64_FMT " is too big for cuBLAS, which is restricted to 32-bit integers.", (PetscInt64)a);
    1846:   PetscCheck(a >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Passing negative integer %" PetscInt64_FMT "to cuBLAS routine", (PetscInt64)a);
    1847:   if (b) *b = (PetscCuBLASInt)a;
    1848:   PetscFunctionReturn(PETSC_SUCCESS);
    1849: }

    1851: /*@C
    1852:    PetscHipBLASIntCast - like `PetscBLASIntCast()`, but for `PetscHipBLASInt`.

    1854:    Not Collective; No Fortran Support

    1856:    Input Parameter:
    1857: .  a - the `PetscInt` value

    1859:    Output Parameter:
    1860: .  b - the resulting `PetscHipBLASInt` value, or `NULL` if the result is not needed

    1862:    Level: advanced

    1864:    Note:
    1865:    Errors if the integer is negative since PETSc calls to hipBLAS and friends never need to cast negative integer inputs

    1867: .seealso: `PetscHipBLASInt`, `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscMPIIntCast()`, `PetscIntCast()`
    1868: @*/
    1869: static inline PetscErrorCode PetscHipBLASIntCast(MPIU_Count a, PetscHipBLASInt *b)
    1870: {
    1871:   PetscFunctionBegin;
    1872:   if (b) *b = 0; /* to prevent compilers erroneously suggesting uninitialized variable */
    1873:   PetscCheck(sizeof(MPIU_Count) <= sizeof(PetscHipBLASInt) || a <= (MPIU_Count)PETSC_HIPBLAS_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%" PetscInt64_FMT " is too big for hipBLAS, which is restricted to 32-bit integers.", (PetscInt64)a);
    1874:   PetscCheck(a >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Passing negative integer %" PetscInt64_FMT "to hipBLAS routine", (PetscInt64)a);
    1875:   if (b) *b = (PetscHipBLASInt)a;
    1876:   PetscFunctionReturn(PETSC_SUCCESS);
    1877: }

    1879: /*@C
    1880:    PetscMPIIntCast - casts a `MPI_Count`, `PetscInt`, `PetscCount`, or `PetscInt64` to a `PetscMPIInt` (which is always 32-bits in size), generates an
    1881:    error if the `PetscMPIInt` is not large enough to hold the number.

    1883:    Not Collective; No Fortran Support

    1885:    Input Parameter:
    1886: .  a - the `PetscInt` value

    1888:    Output Parameter:
    1889: .  b - the resulting `PetscMPIInt` value, or `NULL` if the result is not needed

    1891:    Level: advanced

    1893: .seealso: [](stylePetscCount), `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscIntCast()`
    1894: @*/
    1895: static inline PetscErrorCode PetscMPIIntCast(MPIU_Count a, PetscMPIInt *b)
    1896: {
    1897:   PetscFunctionBegin;
    1898:   if (b) *b = 0; /* to prevent compilers erroneously suggesting uninitialized variable */
    1899:   PetscCheck(a <= (MPIU_Count)PETSC_MPI_INT_MAX && a >= (MPIU_Count)PETSC_MPI_INT_MIN, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%" PetscInt64_FMT " is too big for MPI buffer length. Maximum supported value is %d", (PetscInt64)a, PETSC_MPI_INT_MAX);
    1900:   if (b) *b = (PetscMPIInt)a;
    1901:   PetscFunctionReturn(PETSC_SUCCESS);
    1902: }

    1904: /*MC
    1905:    PetscInt64Mult - Computes the product of two variables after casting them to `PetscInt64`.

    1907:    Not Collective; No Fortran Support

    1909:    Input Parameters:
    1910: +  a - the first variable
    1911: -  b - the second variable

    1913:    Level: advanced

    1915: .seealso: [](stylePetscCount), `PetscIntMultError()`, `PetscIntMultTruncate()`
    1916: M*/
    1917: #define PetscInt64Mult(a, b) (((PetscInt64)(a)) * ((PetscInt64)(b)))

    1919: /*@C
    1920:   PetscRealIntMultTruncate - Computes the product of a positive `PetscReal` and a positive
    1921:   `PetscInt` and truncates the value to slightly less than the maximal possible value.

    1923:   Not Collective; No Fortran Support

    1925:   Input Parameters:
    1926: + a - The `PetscReal` value
    1927: - b - The `PetscInt` value

    1929:   Level: advanced

    1931:   Notes:
    1932:   Returns the result as a `PetscInt` value.

    1934:   Use `PetscInt64Mult()` to compute the product of two `PetscInt` as a `PetscInt64`.

    1936:   Use `PetscIntMultTruncate()` to compute the product of two positive `PetscInt` and truncate
    1937:   to fit a `PetscInt`.

    1939:   Use `PetscIntMultError()` to compute the product of two `PetscInt` if you wish to generate an
    1940:   error if the result will not fit in a `PetscInt`.

    1942:   Developer Notes:
    1943:   We currently assume that `PetscInt` addition can never overflow, this is obviously wrong but
    1944:   requires many more checks.

    1946:   This is used where we compute approximate sizes for workspace and need to insure the
    1947:   workspace is index-able.

    1949: .seealso: `PetscReal`, `PetscInt`, `PetscInt64Mult()`, `PetscIntMultError()`, `PetscIntSumError()`
    1950: @*/
    1951: static inline PetscInt PetscRealIntMultTruncate(PetscReal a, PetscInt b)
    1952: {
    1953:   PetscInt64 r = (PetscInt64)(a * (PetscReal)b);
    1954:   if (r > PETSC_INT_MAX - 100) r = PETSC_INT_MAX - 100;
    1955:   return (PetscInt)r;
    1956: }

    1958: /*@C
    1959:    PetscIntMultTruncate - Computes the product of two positive `PetscInt` and truncates the value to slightly less than the maximal possible value

    1961:    Not Collective; No Fortran Support

    1963:    Input Parameters:
    1964: +  a - the `PetscInt` value
    1965: -  b - the second value

    1967:    Returns:
    1968:    The result as a `PetscInt` value

    1970:    Level: advanced

    1972:    Notes:
    1973:    Use `PetscInt64Mult()` to compute the product of two `PetscInt` as a `PetscInt64`

    1975:    Use `PetscRealIntMultTruncate()` to compute the product of a `PetscReal` and a `PetscInt` and truncate to fit a `PetscInt`

    1977:    Use `PetscIntMultError()` to compute the product of two `PetscInt` if you wish to generate an error if the result will not fit in a `PetscInt`

    1979:    Developer Notes:
    1980:    We currently assume that `PetscInt` addition can never overflow, this is obviously wrong but requires many more checks.

    1982:    This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.

    1984: .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscInt64Mult()`, `PetscIntMultError()`, `PetscIntSumError()`,
    1985:           `PetscIntSumTruncate()`
    1986: @*/
    1987: static inline PetscInt PetscIntMultTruncate(PetscInt a, PetscInt b)
    1988: {
    1989:   PetscInt64 r = PetscInt64Mult(a, b);
    1990:   if (r > PETSC_INT_MAX - 100) r = PETSC_INT_MAX - 100;
    1991:   return (PetscInt)r;
    1992: }

    1994: /*@C
    1995:    PetscIntSumTruncate - Computes the sum of two positive `PetscInt` and truncates the value to slightly less than the maximal possible value

    1997:    Not Collective; No Fortran Support

    1999:    Input Parameters:
    2000: +  a - the `PetscInt` value
    2001: -  b - the second value

    2003:    Returns:
    2004:    The result as a `PetscInt` value

    2006:    Level: advanced

    2008:    Notes:
    2009:    Use `PetscInt64Mult()` to compute the product of two `PetscInt` as a `PetscInt64`

    2011:    Use `PetscRealIntMultTruncate()` to compute the product of a `PetscReal` and a `PetscInt` and truncate to fit a `PetscInt`

    2013:    Use `PetscIntMultError()` to compute the product of two `PetscInt` if you wish to generate an error if the result will not fit in a `PetscInt`

    2015:    Developer Note:
    2016:    This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.

    2018: .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscInt64Mult()`, `PetscIntMultError()`
    2019: @*/
    2020: static inline PetscInt PetscIntSumTruncate(PetscInt a, PetscInt b)
    2021: {
    2022:   PetscInt64 r = ((PetscInt64)a) + ((PetscInt64)b);
    2023:   if (r > PETSC_INT_MAX - 100) r = PETSC_INT_MAX - 100;
    2024:   return (PetscInt)r;
    2025: }

    2027: /*@C
    2028:    PetscIntMultError - Computes the product of two positive `PetscInt` and generates an error with overflow.

    2030:    Not Collective; No Fortran Support

    2032:    Input Parameters:
    2033: +  a - the `PetscInt` value
    2034: -  b - the second value

    2036:    Output Parameter:
    2037: .  result - the result as a `PetscInt` value, or `NULL` if you do not want the result, you just want to check if it overflows

    2039:    Level: advanced

    2041:    Notes:
    2042:    Use `PetscInt64Mult()` to compute the product of two `PetscInt` and store in a `PetscInt64`

    2044:    Use `PetscIntMultTruncate()` to compute the product of two `PetscInt` and truncate it to fit in a `PetscInt`

    2046:    Developer Note:
    2047:    In most places in the source code we currently assume that `PetscInt` addition does not overflow, this is obviously wrong but requires many more checks.
    2048:    `PetscIntSumError()` can be used to check for this situation.

    2050: .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscInt64Mult()`, `PetscIntSumError()`
    2051: @*/
    2052: static inline PetscErrorCode PetscIntMultError(PetscInt a, PetscInt b, PetscInt *result)
    2053: {
    2054:   PetscInt64 r = PetscInt64Mult(a, b);

    2056:   PetscFunctionBegin;
    2057:   if (result) *result = (PetscInt)r;
    2058:   if (!PetscDefined(USE_64BIT_INDICES)) {
    2059:     PetscCheck(r <= PETSC_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_SUP, "Product of two integers %" PetscInt_FMT " %" PetscInt_FMT " overflow, either you have an invalidly large integer error in your code or you must ./configure PETSc with --with-64-bit-indices for the case you are running", a, b);
    2060:   }
    2061:   PetscFunctionReturn(PETSC_SUCCESS);
    2062: }

    2064: /*@C

    2066:    PetscIntSumError - Computes the sum of two positive `PetscInt` and generates an error with overflow.

    2068:    Not Collective; No Fortran Support

    2070:    Input Parameters:
    2071: +  a - the `PetscInt` value
    2072: -  b - the second value

    2074:    Output Parameter:
    2075: .  c - the result as a `PetscInt` value,  or `NULL` if you do not want the result, you just want to check if it overflows

    2077:    Level: advanced

    2079:    Notes:
    2080:    Use `PetscInt64Mult()` to compute the product of two 32-bit `PetscInt` and store in a `PetscInt64`

    2082:    Use `PetscIntMultTruncate()` to compute the product of two `PetscInt` and truncate it to fit in a `PetscInt`

    2084: .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscInt64Mult()`, `PetscIntMultError()`
    2085: @*/
    2086: static inline PetscErrorCode PetscIntSumError(PetscInt a, PetscInt b, PetscInt *result)
    2087: {
    2088:   PetscInt64 r = ((PetscInt64)a) + ((PetscInt64)b);

    2090:   PetscFunctionBegin;
    2091:   if (result) *result = (PetscInt)r;
    2092:   if (!PetscDefined(USE_64BIT_INDICES)) {
    2093:     PetscCheck(r <= PETSC_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_SUP, "Sum of two integers %" PetscInt_FMT " %" PetscInt_FMT " overflow, either you have an invalidly large integer error in your code or you must ./configure PETSc with --with-64-bit-indices for the case you are running", a, b);
    2094:   }
    2095:   PetscFunctionReturn(PETSC_SUCCESS);
    2096: }

    2098: /*
    2099:      The IBM include files define hz, here we hide it so that it may be used as a regular user variable.
    2100: */
    2101: #if defined(hz)
    2102:   #undef hz
    2103: #endif

    2105: #if defined(PETSC_HAVE_SYS_TYPES_H)
    2106:   #include <sys/types.h>
    2107: #endif

    2109: /*MC

    2111:     PETSC_VERSION - This manual page provides information about how PETSc documents and uses its version information. This information is available to both C/C++
    2112:                     and Fortran compilers when `petscsys.h` is included.

    2114:     The current PETSc version and the API for accessing it are defined in <A HREF="../include/petscversion.h.html">include/petscversion.html</A>

    2116:     The complete version number is given as the triple  PETSC_VERSION_MAJOR.PETSC_VERSION_MINOR.PETSC_VERSION_SUBMINOR (in short hand x.y.z)

    2118:     A change in the minor version number (y) indicates possible/likely changes in the PETSc API. Note this is different than with the semantic versioning convention
    2119:     where only a change in the major version number (x) indicates a change in the API.

    2121:     A subminor greater than zero indicates a patch release. Version x.y.z maintains source and binary compatibility with version x.y.w for all z and w

    2123:     Use the macros PETSC_VERSION_EQ(x,y,z), PETSC_VERSION_LT(x,y,z), PETSC_VERSION_LE(x,y,z), PETSC_VERSION_GT(x,y,z),
    2124:     PETSC_VERSION_GE(x,y,z) to determine if the current version is equal to, less than, less than or equal to, greater than or greater than or equal to a given
    2125:     version number (x.y.z).

    2127:     `PETSC_RELEASE_DATE` is the date the x.y version was released (i.e. the version before any patch releases)

    2129:     `PETSC_VERSION_DATE` is the date the x.y.z version was released

    2131:     `PETSC_VERSION_GIT` is the last git commit to the repository given in the form vx.y.z-wwwww

    2133:     `PETSC_VERSION_DATE_GIT` is the date of the last git commit to the repository

    2135:     `PETSC_VERSION_()` is deprecated and will eventually be removed.

    2137:     Level: intermediate
    2138: M*/

    2140: PETSC_EXTERN PetscErrorCode PetscGetArchType(char[], size_t);
    2141: PETSC_EXTERN PetscErrorCode PetscGetHostName(char[], size_t);
    2142: PETSC_EXTERN PetscErrorCode PetscGetUserName(char[], size_t);
    2143: PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[], size_t);
    2144: PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]);
    2145: PETSC_EXTERN PetscErrorCode PetscGetDate(char[], size_t);
    2146: PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t);
    2147: PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt *, PetscInt *, PetscInt *, PetscInt *);

    2149: PETSC_EXTERN PetscErrorCode PetscSortedInt(PetscCount, const PetscInt[], PetscBool *);
    2150: PETSC_EXTERN PetscErrorCode PetscSortedInt64(PetscCount, const PetscInt64[], PetscBool *);
    2151: PETSC_EXTERN PetscErrorCode PetscSortedMPIInt(PetscCount, const PetscMPIInt[], PetscBool *);
    2152: PETSC_EXTERN PetscErrorCode PetscSortedReal(PetscCount, const PetscReal[], PetscBool *);
    2153: PETSC_EXTERN PetscErrorCode PetscSortInt(PetscCount, PetscInt[]);
    2154: PETSC_EXTERN PetscErrorCode PetscSortInt64(PetscCount, PetscInt64[]);
    2155: PETSC_EXTERN PetscErrorCode PetscSortCount(PetscCount, PetscCount[]);
    2156: PETSC_EXTERN PetscErrorCode PetscSortReverseInt(PetscCount, PetscInt[]);
    2157: PETSC_EXTERN PetscErrorCode PetscSortedRemoveDupsInt(PetscInt *, PetscInt[]);
    2158: PETSC_EXTERN PetscErrorCode PetscSortedCheckDupsInt(PetscCount, const PetscInt[], PetscBool *);
    2159: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt *, PetscInt[]);
    2160: PETSC_EXTERN PetscErrorCode PetscCheckDupsInt(PetscInt, const PetscInt[], PetscBool *);
    2161: PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscCount, const PetscInt[], PetscInt *);
    2162: PETSC_EXTERN PetscErrorCode PetscFindMPIInt(PetscMPIInt, PetscCount, const PetscMPIInt[], PetscInt *);
    2163: PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt, const PetscInt[], PetscInt[]);
    2164: PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt, const char *[], PetscInt[]);
    2165: PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscCount, PetscInt[], PetscInt[]);
    2166: PETSC_EXTERN PetscErrorCode PetscSortIntWithCountArray(PetscCount, PetscInt[], PetscCount[]);
    2167: PETSC_EXTERN PetscErrorCode PetscSortIntWithMPIIntArray(PetscCount, PetscInt[], PetscMPIInt[]);
    2168: PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscCount, PetscInt[], PetscInt[], PetscInt[]);
    2169: PETSC_EXTERN PetscErrorCode PetscSortIntWithIntCountArrayPair(PetscCount, PetscInt[], PetscInt[], PetscCount[]);
    2170: PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscCount, PetscMPIInt[]);
    2171: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt *, PetscMPIInt[]);
    2172: PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscCount, PetscMPIInt[], PetscMPIInt[]);
    2173: PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithIntArray(PetscCount, PetscMPIInt[], PetscInt[]);
    2174: PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscCount, PetscInt[], PetscScalar[]);
    2175: PETSC_EXTERN PetscErrorCode PetscSortIntWithDataArray(PetscCount, PetscInt[], void *, size_t, void *);
    2176: PETSC_EXTERN PetscErrorCode PetscSortReal(PetscCount, PetscReal[]);
    2177: PETSC_EXTERN PetscErrorCode PetscSortRealWithArrayInt(PetscCount, PetscReal[], PetscInt[]);
    2178: PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt, const PetscReal[], PetscInt[]);
    2179: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt *, PetscReal[]);
    2180: PETSC_EXTERN PetscErrorCode PetscFindReal(PetscReal, PetscCount, const PetscReal[], PetscReal, PetscInt *);
    2181: PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt, PetscInt, PetscScalar[], PetscInt[]);
    2182: PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt, PetscInt, PetscReal[], PetscInt[]);
    2183: PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt, const PetscBool[], const PetscInt[], PetscInt *, PetscInt **, PetscInt **, PetscInt **, PetscInt **);
    2184: PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt, const PetscInt[], const PetscInt[], PetscInt, const PetscInt[], const PetscInt[], PetscInt *, PetscInt **, PetscInt **);
    2185: PETSC_EXTERN PetscErrorCode PetscMergeIntArray(PetscInt, const PetscInt[], PetscInt, const PetscInt[], PetscInt *, PetscInt **);
    2186: PETSC_EXTERN PetscErrorCode PetscMergeMPIIntArray(PetscInt, const PetscMPIInt[], PetscInt, const PetscMPIInt[], PetscInt *, PetscMPIInt **);
    2187: PETSC_EXTERN PetscErrorCode PetscParallelSortedInt(MPI_Comm, PetscInt, const PetscInt[], PetscBool *);

    2189: PETSC_EXTERN PetscErrorCode PetscTimSort(PetscInt, void *, size_t, int (*)(const void *, const void *, void *), void *);
    2190: PETSC_EXTERN PetscErrorCode PetscIntSortSemiOrdered(PetscInt, PetscInt[]);
    2191: PETSC_EXTERN PetscErrorCode PetscMPIIntSortSemiOrdered(PetscInt, PetscMPIInt[]);
    2192: PETSC_EXTERN PetscErrorCode PetscRealSortSemiOrdered(PetscInt, PetscReal[]);
    2193: PETSC_EXTERN PetscErrorCode PetscTimSortWithArray(PetscInt, void *, size_t, void *, size_t, int (*)(const void *, const void *, void *), void *);
    2194: PETSC_EXTERN PetscErrorCode PetscIntSortSemiOrderedWithArray(PetscInt, PetscInt[], PetscInt[]);
    2195: PETSC_EXTERN PetscErrorCode PetscMPIIntSortSemiOrderedWithArray(PetscInt, PetscMPIInt[], PetscMPIInt[]);
    2196: PETSC_EXTERN PetscErrorCode PetscRealSortSemiOrderedWithArrayInt(PetscInt, PetscReal[], PetscInt[]);

    2198: PETSC_EXTERN PetscErrorCode PetscSetDisplay(void);
    2199: PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[], size_t);

    2201: /*J
    2202:     PetscRandomType - String with the name of a PETSc randomizer

    2204:    Level: beginner

    2206:    Note:
    2207:    To use `PETSCSPRNG` or `PETSCRANDOM123` you must have ./configure PETSc
    2208:    with the option `--download-sprng` or `--download-random123`. We recommend the default provided with PETSc.

    2210: .seealso: `PetscRandomSetType()`, `PetscRandom`, `PetscRandomCreate()`
    2211: J*/
    2212: typedef const char *PetscRandomType;
    2213: #define PETSCRAND      "rand"
    2214: #define PETSCRAND48    "rand48"
    2215: #define PETSCSPRNG     "sprng"
    2216: #define PETSCRANDER48  "rander48"
    2217: #define PETSCRANDOM123 "random123"
    2218: #define PETSCCURAND    "curand"

    2220: /* Logging support */
    2221: PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID;

    2223: PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void);
    2224: PETSC_EXTERN PetscErrorCode PetscRandomFinalizePackage(void);

    2226: /* Dynamic creation and loading functions */
    2227: PETSC_EXTERN PetscFunctionList PetscRandomList;

    2229: PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[], PetscErrorCode (*)(PetscRandom));
    2230: PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType);
    2231: PETSC_EXTERN PetscErrorCode PetscRandomSetOptionsPrefix(PetscRandom, const char[]);
    2232: PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom);
    2233: PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType *);
    2234: PETSC_EXTERN PetscErrorCode PetscRandomViewFromOptions(PetscRandom, PetscObject, const char[]);
    2235: PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom, PetscViewer);

    2237: PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm, PetscRandom *);
    2238: PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom, PetscScalar *);
    2239: PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom, PetscReal *);
    2240: PETSC_EXTERN PetscErrorCode PetscRandomGetValues(PetscRandom, PetscInt, PetscScalar *);
    2241: PETSC_EXTERN PetscErrorCode PetscRandomGetValuesReal(PetscRandom, PetscInt, PetscReal *);
    2242: PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom, PetscScalar *, PetscScalar *);
    2243: PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom, PetscScalar, PetscScalar);
    2244: PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom, unsigned long);
    2245: PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom, unsigned long *);
    2246: PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom);
    2247: PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom *);

    2249: PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[], char[], size_t);
    2250: PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[], char[], size_t);
    2251: PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[], size_t);
    2252: PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[], char[]);
    2253: PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[], size_t);
    2254: PETSC_EXTERN PetscErrorCode PetscTestFile(const char[], char, PetscBool *);
    2255: PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[], char, PetscBool *);
    2256: PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]);
    2257: PETSC_EXTERN PetscErrorCode PetscMkdtemp(char[]);
    2258: PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]);

    2260: /*MC
    2261:    PetscBinaryBigEndian - indicates if values in memory are stored with big endian format

    2263:    Synopsis:
    2264: #include <petscsys.h>
    2265:    PetscBool PetscBinaryBigEndian(void);

    2267:    No Fortran Support

    2269:    Level: developer

    2271: .seealso: `PetscInitialize()`, `PetscFinalize()`, `PetscInitializeCalled`
    2272: M*/
    2273: static inline PetscBool PetscBinaryBigEndian(void)
    2274: {
    2275:   long _petsc_v = 1;
    2276:   return ((char *)&_petsc_v)[0] ? PETSC_FALSE : PETSC_TRUE;
    2277: }

    2279: PETSC_EXTERN PetscErrorCode PetscBinaryRead(int, void *, PetscCount, PetscInt *, PetscDataType);
    2280: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm, int, void *, PetscInt, PetscInt *, PetscDataType);
    2281: PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int, const void *, PetscCount, PetscDataType);
    2282: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm, int, const void *, PetscInt, PetscDataType);
    2283: PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[], PetscFileMode, int *);
    2284: PETSC_EXTERN PetscErrorCode PetscBinaryClose(int);
    2285: PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm, PetscBool *);
    2286: PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm, PetscBool *);
    2287: PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm, char[], size_t);
    2288: PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm, const char[], char[], size_t, PetscBool *);
    2289: PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm, const char[], char[], size_t, PetscBool *);
    2290: #if defined(PETSC_USE_SOCKET_VIEWER)
    2291: PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[], int, int *);
    2292: #endif

    2294: PETSC_EXTERN PetscErrorCode PetscBinarySeek(int, off_t, PetscBinarySeekType, off_t *);
    2295: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm, int, off_t, PetscBinarySeekType, off_t *);
    2296: PETSC_EXTERN PetscErrorCode PetscByteSwap(void *, PetscDataType, PetscCount);

    2298: PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]);
    2299: PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[], PetscBool);
    2300: PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void);
    2301: PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char *);
    2302: PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void);
    2303: PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void);
    2304: PETSC_EXTERN PetscErrorCode PetscWaitOnError(void);

    2306: PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm, const PetscMPIInt[], const PetscMPIInt[], PetscMPIInt *);
    2307: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm, PetscMPIInt, PetscMPIInt, const PetscMPIInt[], PetscMPIInt **, PetscMPIInt **);
    2308: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm, PetscMPIInt, PetscMPIInt, const PetscMPIInt[], const PetscMPIInt[], PetscMPIInt **, PetscMPIInt **, PetscMPIInt **);
    2309: PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm, PetscMPIInt, PetscMPIInt, const PetscMPIInt[], const PetscMPIInt[], PetscInt ***, MPI_Request **);
    2310: PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm, PetscMPIInt, PetscMPIInt, const PetscMPIInt[], const PetscMPIInt[], PetscScalar ***, MPI_Request **);
    2311: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm, PetscMPIInt, MPI_Datatype, PetscMPIInt, const PetscMPIInt *, const void *, PetscMPIInt *, PetscMPIInt **, void *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(6, 3);
    2312: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedF(MPI_Comm, PetscMPIInt, MPI_Datatype, PetscMPIInt, const PetscMPIInt[], const void *, PetscMPIInt *, PetscMPIInt **, void *, PetscMPIInt, PetscErrorCode (*send)(MPI_Comm, const PetscMPIInt[], PetscMPIInt, PetscMPIInt, void *, MPI_Request[], void *), PetscErrorCode (*recv)(MPI_Comm, const PetscMPIInt[], PetscMPIInt, void *, MPI_Request[], void *), void *ctx) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(6, 3);
    2313: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedFReq(MPI_Comm, PetscMPIInt, MPI_Datatype, PetscMPIInt, const PetscMPIInt[], const void *, PetscMPIInt *, PetscMPIInt **, void *, PetscMPIInt, MPI_Request **, MPI_Request **, PetscErrorCode (*send)(MPI_Comm, const PetscMPIInt[], PetscMPIInt, PetscMPIInt, void *, MPI_Request[], void *), PetscErrorCode (*recv)(MPI_Comm, const PetscMPIInt[], PetscMPIInt, void *, MPI_Request[], void *), void *ctx) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(6, 3);

    2315: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm, PetscBuildTwoSidedType);
    2316: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm, PetscBuildTwoSidedType *);

    2318: PETSC_EXTERN PetscErrorCode PetscSSEIsEnabled(MPI_Comm, PetscBool *, PetscBool *);

    2320: PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject);

    2322: struct _n_PetscSubcomm {
    2323:   MPI_Comm         parent;    /* parent communicator */
    2324:   MPI_Comm         dupparent; /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */
    2325:   MPI_Comm         child;     /* the sub-communicator */
    2326:   PetscMPIInt      n;         /* num of subcommunicators under the parent communicator */
    2327:   PetscMPIInt      color;     /* color of processors belong to this communicator */
    2328:   PetscMPIInt     *subsize;   /* size of subcommunicator[color] */
    2329:   PetscSubcommType type;
    2330:   char            *subcommprefix;
    2331: };

    2333: static inline MPI_Comm PetscSubcommParent(PetscSubcomm scomm)
    2334: {
    2335:   return scomm->parent;
    2336: }
    2337: static inline MPI_Comm PetscSubcommChild(PetscSubcomm scomm)
    2338: {
    2339:   return scomm->child;
    2340: }
    2341: static inline MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm)
    2342: {
    2343:   return scomm->dupparent;
    2344: }
    2345: PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm, PetscSubcomm *);
    2346: PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm *);
    2347: PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm, PetscInt);
    2348: PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm, PetscSubcommType);
    2349: PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm, PetscMPIInt, PetscMPIInt);
    2350: PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm, PetscViewer);
    2351: PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm);
    2352: PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm, const char[]);
    2353: PETSC_EXTERN PetscErrorCode PetscSubcommGetParent(PetscSubcomm, MPI_Comm *);
    2354: PETSC_EXTERN PetscErrorCode PetscSubcommGetContiguousParent(PetscSubcomm, MPI_Comm *);
    2355: PETSC_EXTERN PetscErrorCode PetscSubcommGetChild(PetscSubcomm, MPI_Comm *);

    2357: PETSC_EXTERN PetscErrorCode PetscHeapCreate(PetscInt, PetscHeap *);
    2358: PETSC_EXTERN PetscErrorCode PetscHeapAdd(PetscHeap, PetscInt, PetscInt);
    2359: PETSC_EXTERN PetscErrorCode PetscHeapPop(PetscHeap, PetscInt *, PetscInt *);
    2360: PETSC_EXTERN PetscErrorCode PetscHeapPeek(PetscHeap, PetscInt *, PetscInt *);
    2361: PETSC_EXTERN PetscErrorCode PetscHeapStash(PetscHeap, PetscInt, PetscInt);
    2362: PETSC_EXTERN PetscErrorCode PetscHeapUnstash(PetscHeap);
    2363: PETSC_EXTERN PetscErrorCode PetscHeapDestroy(PetscHeap *);
    2364: PETSC_EXTERN PetscErrorCode PetscHeapView(PetscHeap, PetscViewer);

    2366: PETSC_EXTERN PetscErrorCode PetscProcessPlacementView(PetscViewer);
    2367: PETSC_EXTERN PetscErrorCode PetscShmCommGet(MPI_Comm, PetscShmComm *);
    2368: PETSC_EXTERN PetscErrorCode PetscShmCommGlobalToLocal(PetscShmComm, PetscMPIInt, PetscMPIInt *);
    2369: PETSC_EXTERN PetscErrorCode PetscShmCommLocalToGlobal(PetscShmComm, PetscMPIInt, PetscMPIInt *);
    2370: PETSC_EXTERN PetscErrorCode PetscShmCommGetMpiShmComm(PetscShmComm, MPI_Comm *);

    2372: /* routines to better support OpenMP multithreading needs of some PETSc third party libraries */
    2373: PETSC_EXTERN PetscErrorCode PetscOmpCtrlCreate(MPI_Comm, PetscInt, PetscOmpCtrl *);
    2374: PETSC_EXTERN PetscErrorCode PetscOmpCtrlGetOmpComms(PetscOmpCtrl, MPI_Comm *, MPI_Comm *, PetscBool *);
    2375: PETSC_EXTERN PetscErrorCode PetscOmpCtrlDestroy(PetscOmpCtrl *);
    2376: PETSC_EXTERN PetscErrorCode PetscOmpCtrlBarrier(PetscOmpCtrl);
    2377: PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterBegin(PetscOmpCtrl);
    2378: PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterEnd(PetscOmpCtrl);

    2380: PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t, PetscCount, PetscSegBuffer *);
    2381: PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer *);
    2382: PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer, PetscCount, void *);
    2383: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer, void *);
    2384: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer, void *);
    2385: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer, void *);
    2386: PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer, PetscCount *);
    2387: PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer, PetscCount);

    2389: /*MC
    2390:   PetscSegBufferGetInts - access an array of `PetscInt` from a `PetscSegBuffer`

    2392:   Synopsis:
    2393: #include <petscsys.h>
    2394:   PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg, size_t count, PetscInt *PETSC_RESTRICT *slot);

    2396:   No Fortran Support

    2398:   Input Parameters:
    2399: + seg   - `PetscSegBuffer` buffer
    2400: - count - number of entries needed

    2402:   Output Parameter:
    2403: . buf - address of new buffer for contiguous data

    2405:   Level: intermediate

    2407:   Developer Note:
    2408:   Type-safe wrapper to encourage use of PETSC_RESTRICT. Does not use PetscFunctionBegin because the error handling
    2409:   prevents the compiler from completely erasing the stub. This is called in inner loops so it has to be as fast as
    2410:   possible.

    2412: .seealso: `PetscSegBuffer`, `PetscSegBufferGet()`, `PetscInitialize()`, `PetscFinalize()`, `PetscInitializeCalled`
    2413: M*/
    2414: static inline PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg, PetscCount count, PetscInt *PETSC_RESTRICT *slot)
    2415: {
    2416:   return PetscSegBufferGet(seg, count, (void **)slot);
    2417: }

    2419: extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton;
    2420: PETSC_EXTERN PetscErrorCode    PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted *);
    2421: PETSC_EXTERN PetscErrorCode    PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted *);
    2422: PETSC_EXTERN PetscErrorCode    PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted, const char *, const char *, PetscBool *);

    2424: #include <stdarg.h>
    2425: PETSC_EXTERN PetscErrorCode PetscVSNPrintf(char *, size_t, const char[], size_t *, va_list);
    2426: PETSC_EXTERN PetscErrorCode (*PetscVFPrintf)(FILE *, const char[], va_list);

    2428: PETSC_EXTERN PetscSegBuffer PetscCitationsList;

    2430: /*@
    2431:      PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used in the code.

    2433:      Not Collective; No Fortran Support

    2435:      Input Parameters:
    2436: +    cite - the bibtex item, formatted to displayed on multiple lines nicely
    2437: -    set - a boolean variable initially set to `PETSC_FALSE`; this is used to insure only a single registration of the citation

    2439:      Options Database Key:
    2440: .     -citations [filename]   - print out the bibtex entries for the given computation

    2442:      Level: intermediate
    2443: @*/
    2444: static inline PetscErrorCode PetscCitationsRegister(const char cit[], PetscBool *set)
    2445: {
    2446:   size_t len;
    2447:   char  *vstring;

    2449:   PetscFunctionBegin;
    2450:   if (set && *set) PetscFunctionReturn(PETSC_SUCCESS);
    2451:   PetscCall(PetscStrlen(cit, &len));
    2452:   PetscCall(PetscSegBufferGet(PetscCitationsList, (PetscCount)len, &vstring));
    2453:   PetscCall(PetscArraycpy(vstring, cit, len));
    2454:   if (set) *set = PETSC_TRUE;
    2455:   PetscFunctionReturn(PETSC_SUCCESS);
    2456: }

    2458: PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm, char[], char[], size_t);
    2459: PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm, const char[], char[], size_t);
    2460: PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm, const char[], const char[]);

    2462: PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm, char[], char[], size_t);
    2463: PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm, const char[], char[], char[], size_t);
    2464: PETSC_EXTERN PetscErrorCode PetscBoxUpload(MPI_Comm, const char[], const char[]);

    2466: PETSC_EXTERN PetscErrorCode PetscGlobusGetTransfers(MPI_Comm, const char[], char[], size_t);
    2467: PETSC_EXTERN PetscErrorCode PetscGlobusAuthorize(MPI_Comm, char[], size_t);
    2468: PETSC_EXTERN PetscErrorCode PetscGlobusUpload(MPI_Comm, const char[], const char[]);

    2470: PETSC_EXTERN PetscErrorCode PetscPullJSONValue(const char[], const char[], char[], size_t, PetscBool *);
    2471: PETSC_EXTERN PetscErrorCode PetscPushJSONValue(char[], const char[], const char[], size_t);

    2473: #if defined(PETSC_HAVE_MPI_PROCESS_SHARED_MEMORY)
    2474: PETSC_EXTERN PetscErrorCode MPIU_Win_allocate_shared(MPI_Aint, PetscMPIInt, MPI_Info, MPI_Comm, void *, MPI_Win *);
    2475: PETSC_EXTERN PetscErrorCode MPIU_Win_shared_query(MPI_Win, PetscMPIInt, MPI_Aint *, PetscMPIInt *, void *);
    2476: #endif

    2478: #if !defined(PETSC_HAVE_MPI_LARGE_COUNT)
    2479:   /*
    2480:    Cast PetscCount <a> to PetscMPIInt <b>, where <a> is likely used for the 'count' argument in MPI routines.
    2481:    It is similar to PetscMPIIntCast() except that here it returns an MPI error code.
    2482: */
    2483:   #define PetscMPIIntCast_Internal(a, b) \
    2484:     do { \
    2485:       *b = 0; \
    2486:       if (PetscUnlikely(a > (MPIU_Count)PETSC_MPI_INT_MAX)) return MPI_ERR_COUNT; \
    2487:       *b = (PetscMPIInt)a; \
    2488:     } while (0)

    2490: static inline PetscMPIInt MPIU_Get_count(MPI_Status *status, MPI_Datatype dtype, PetscCount *count)
    2491: {
    2492:   PetscMPIInt count2, err;

    2494:   *count = 0; /* to prevent incorrect warnings of uninitialized variables */
    2495:   err    = MPI_Get_count(status, dtype, &count2);
    2496:   *count = count2;
    2497:   return err;
    2498: }

    2500: static inline PetscMPIInt MPIU_Send(const void *buf, MPIU_Count count, MPI_Datatype dtype, PetscMPIInt dest, PetscMPIInt tag, MPI_Comm comm)
    2501: {
    2502:   PetscMPIInt count2, err;

    2504:   PetscMPIIntCast_Internal(count, &count2);
    2505:   err = MPI_Send((void *)buf, count2, dtype, dest, tag, comm);
    2506:   return err;
    2507: }

    2509: static inline PetscMPIInt MPIU_Send_init(const void *buf, MPIU_Count count, MPI_Datatype dtype, PetscMPIInt dest, PetscMPIInt tag, MPI_Comm comm, MPI_Request *request)
    2510: {
    2511:   PetscMPIInt count2, err;

    2513:   PetscMPIIntCast_Internal(count, &count2);
    2514:   err = MPI_Send_init((void *)buf, count2, dtype, dest, tag, comm, request);
    2515:   return err;
    2516: }

    2518: static inline PetscMPIInt MPIU_Isend(const void *buf, MPIU_Count count, MPI_Datatype dtype, PetscMPIInt dest, PetscMPIInt tag, MPI_Comm comm, MPI_Request *request)
    2519: {
    2520:   PetscMPIInt count2, err;

    2522:   PetscMPIIntCast_Internal(count, &count2);
    2523:   err = MPI_Isend((void *)buf, count2, dtype, dest, tag, comm, request);
    2524:   return err;
    2525: }

    2527: static inline PetscMPIInt MPIU_Recv(const void *buf, MPIU_Count count, MPI_Datatype dtype, PetscMPIInt source, PetscMPIInt tag, MPI_Comm comm, MPI_Status *status)
    2528: {
    2529:   PetscMPIInt count2, err;

    2531:   PetscMPIIntCast_Internal(count, &count2);
    2532:   err = MPI_Recv((void *)buf, count2, dtype, source, tag, comm, status);
    2533:   return err;
    2534: }

    2536: static inline PetscMPIInt MPIU_Recv_init(const void *buf, MPIU_Count count, MPI_Datatype dtype, PetscMPIInt source, PetscMPIInt tag, MPI_Comm comm, MPI_Request *request)
    2537: {
    2538:   PetscMPIInt count2, err;

    2540:   PetscMPIIntCast_Internal(count, &count2);
    2541:   err = MPI_Recv_init((void *)buf, count2, dtype, source, tag, comm, request);
    2542:   return err;
    2543: }

    2545: static inline PetscMPIInt MPIU_Irecv(const void *buf, MPIU_Count count, MPI_Datatype dtype, PetscMPIInt source, PetscMPIInt tag, MPI_Comm comm, MPI_Request *request)
    2546: {
    2547:   PetscMPIInt count2, err;

    2549:   PetscMPIIntCast_Internal(count, &count2);
    2550:   err = MPI_Irecv((void *)buf, count2, dtype, source, tag, comm, request);
    2551:   return err;
    2552: }

    2554: static inline PetscMPIInt MPIU_Reduce(const void *inbuf, void *outbuf, MPIU_Count count, MPI_Datatype dtype, MPI_Op op, PetscMPIInt root, MPI_Comm comm)
    2555: {
    2556:   PetscMPIInt count2, err;

    2558:   PetscMPIIntCast_Internal(count, &count2);
    2559:   err = MPI_Reduce((void *)inbuf, outbuf, count2, dtype, op, root, comm);
    2560:   return err;
    2561: }

    2563:   #if defined(PETSC_HAVE_MPI_REDUCE_LOCAL)
    2564: static inline PetscMPIInt MPIU_Reduce_local(const void *inbuf, void *inoutbuf, MPIU_Count count, MPI_Datatype dtype, MPI_Op op)
    2565: {
    2566:   PetscMPIInt count2, err;

    2568:   PetscMPIIntCast_Internal(count, &count2);
    2569:   err = MPI_Reduce_local((void *)inbuf, inoutbuf, count2, dtype, op);
    2570:   return err;
    2571: }
    2572:   #endif

    2574: #else

    2576:   /* on 32 bit systems MPI_Count maybe 64-bit while PetscCount is 32-bit */
    2577:   #define PetscCountCast_Internal(a, b) \
    2578:     do { \
    2579:       *b = 0; \
    2580:       if (PetscUnlikely(a > (MPI_Count)PETSC_COUNT_MAX)) return MPI_ERR_COUNT; \
    2581:       *b = (PetscMPIInt)a; \
    2582:     } while (0)

    2584: static inline PetscMPIInt MPIU_Get_count(MPI_Status *status, MPI_Datatype dtype, PetscCount *count)
    2585: {
    2586:   MPI_Count   count2;
    2587:   PetscMPIInt err;

    2589:   *count = 0; /* to prevent incorrect warnings of uninitialized variables */
    2590:   err    = MPI_Get_count_c(status, dtype, &count2);
    2591:   if (err) return err;
    2592:   PetscCountCast_Internal(count2, count);
    2593:   return MPI_SUCCESS;
    2594: }

    2596:   #define MPIU_Reduce(inbuf, outbuf, count, dtype, op, root, comm)      MPI_Reduce_c(inbuf, outbuf, (MPI_Count)(count), dtype, op, root, comm)
    2597:   #define MPIU_Send(buf, count, dtype, dest, tag, comm)                 MPI_Send_c(buf, (MPI_Count)(count), dtype, dest, tag, comm)
    2598:   #define MPIU_Send_init(buf, count, dtype, dest, tag, comm, request)   MPI_Send_init_c(buf, (MPI_Count)(count), dtype, dest, tag, comm, request)
    2599:   #define MPIU_Isend(buf, count, dtype, dest, tag, comm, request)       MPI_Isend_c(buf, (MPI_Count)(count), dtype, dest, tag, comm, request)
    2600:   #define MPIU_Recv(buf, count, dtype, source, tag, comm, status)       MPI_Recv_c(buf, (MPI_Count)(count), dtype, source, tag, comm, status)
    2601:   #define MPIU_Recv_init(buf, count, dtype, source, tag, comm, request) MPI_Recv_init_c(buf, (MPI_Count)(count), dtype, source, tag, comm, request)
    2602:   #define MPIU_Irecv(buf, count, dtype, source, tag, comm, request)     MPI_Irecv_c(buf, (MPI_Count)(count), dtype, source, tag, comm, request)
    2603:   #if defined(PETSC_HAVE_MPI_REDUCE_LOCAL)
    2604:     #define MPIU_Reduce_local(inbuf, inoutbuf, count, dtype, op) MPI_Reduce_local_c(inbuf, inoutbuf, (MPI_Count)(count), dtype, op)
    2605:   #endif
    2606: #endif

    2608: PETSC_EXTERN PetscMPIInt MPIU_Allreduce_Private(const void *, void *, MPIU_Count, MPI_Datatype, MPI_Op, MPI_Comm);

    2610: #if defined(PETSC_USE_DEBUG)
    2611: static inline unsigned int PetscStrHash(const char *str)
    2612: {
    2613:   unsigned int c, hash = 5381;

    2615:   while ((c = (unsigned int)*str++)) hash = ((hash << 5) + hash) + c; /* hash * 33 + c */
    2616:   return hash;
    2617: }
    2618: #endif

    2620: /*MC
    2621:   MPIU_Allreduce - A replacement for `MPI_Allreduce()` that (1) performs single-count `MPIU_INT` operations in `PetscInt64` to detect
    2622:                    integer overflows and (2) tries to determine if the call from all the MPI ranks occur in the
    2623:                    same place in the PETSc code. This helps to detect bugs where different MPI ranks follow different code paths
    2624:                    resulting in inconsistent and incorrect calls to `MPI_Allreduce()`.

    2626:   Synopsis:
    2627: #include <petscsys.h>
    2628:   PetscMPIInt MPIU_Allreduce(void *indata,void *outdata,PetscCount count,MPI_Datatype dtype, MPI_Op op, MPI_Comm comm);

    2630:   Collective

    2632:   Input Parameters:
    2633: + a     - pointer to the input data to be reduced
    2634: . count - the number of MPI data items in `a` and `b`
    2635: . dtype - the MPI datatype, for example `MPI_INT`
    2636: . op    - the MPI operation, for example `MPI_SUM`
    2637: - comm   - the MPI communicator on which the operation occurs

    2639:   Output Parameter:
    2640: . b - the reduced values

    2642:   Level: developer

    2644:   Note:
    2645:   Should be wrapped with `PetscCallMPI()` for error checking

    2647: .seealso: [](stylePetscCount), `MPI_Allreduce()`
    2648: M*/
    2649: #if defined(PETSC_USE_DEBUG)
    2650:   #define MPIU_Allreduce(a, b, c, d, e, fcomm) \
    2651:     PetscMacroReturnStandard( \
    2652:     PetscMPIInt a_b1[6], a_b2[6]; \
    2653:     int _mpiu_allreduce_c_int = (int)(c); \
    2654:     a_b1[0] = -(PetscMPIInt)__LINE__; \
    2655:     a_b1[1] = -a_b1[0]; \
    2656:     a_b1[2] = -(PetscMPIInt)PetscStrHash(PETSC_FUNCTION_NAME); \
    2657:     a_b1[3] = -a_b1[2]; \
    2658:     a_b1[4] = -(PetscMPIInt)(c); \
    2659:     a_b1[5] = -a_b1[4]; \
    2660:     \
    2661:     PetscCallMPI(MPI_Allreduce(a_b1, a_b2, 6, MPI_INT, MPI_MAX, fcomm)); \
    2662:     PetscCheck(-a_b2[0] == a_b2[1], (fcomm), PETSC_ERR_PLIB, "MPIU_Allreduce() called in different locations (code lines) on different processors"); \
    2663:     PetscCheck(-a_b2[2] == a_b2[3], (fcomm), PETSC_ERR_PLIB, "MPIU_Allreduce() called in different locations (functions) on different processors"); \
    2664:     PetscCheck(-a_b2[4] == a_b2[5], (fcomm), PETSC_ERR_PLIB, "MPIU_Allreduce() called with different counts %d on different processors", _mpiu_allreduce_c_int); \
    2665:     PetscCallMPI(MPIU_Allreduce_Private((a), (b), (c), (d), (e), (fcomm)));)
    2666: #else
    2667:   #define MPIU_Allreduce(a, b, c, d, e, fcomm) MPIU_Allreduce_Private((a), (b), (c), (d), (e), (fcomm))
    2668: #endif

    2670: #if defined(PETSC_HAVE_MPI_PROCESS_SHARED_MEMORY)
    2671: PETSC_EXTERN PetscErrorCode MPIU_Win_allocate_shared(MPI_Aint, PetscMPIInt, MPI_Info, MPI_Comm, void *, MPI_Win *);
    2672: PETSC_EXTERN PetscErrorCode MPIU_Win_shared_query(MPI_Win, PetscMPIInt, MPI_Aint *, PetscMPIInt *, void *);
    2673: #endif

    2675: /* this is a vile hack */
    2676: #if defined(PETSC_HAVE_NECMPI)
    2677:   #if !defined(PETSC_NECMPI_VERSION_MAJOR) || !defined(PETSC_NECMPI_VERSION_MINOR) || PETSC_NECMPI_VERSION_MAJOR < 2 || (PETSC_NECMPI_VERSION_MAJOR == 2 && PETSC_NECMPI_VERSION_MINOR < 18)
    2678:     #define MPI_Type_free(a) (*(a) = MPI_DATATYPE_NULL, 0);
    2679:   #endif
    2680: #endif

    2682: /*
    2683:     List of external packages and queries on it
    2684: */
    2685: PETSC_EXTERN PetscErrorCode PetscHasExternalPackage(const char[], PetscBool *);

    2687: /* this cannot go here because it may be in a different shared library */
    2688: PETSC_EXTERN PetscErrorCode PCMPIServerBegin(void);
    2689: PETSC_EXTERN PetscErrorCode PCMPIServerEnd(void);
    2690: PETSC_EXTERN PetscBool      PCMPIServerActive;
    2691: PETSC_EXTERN PetscBool      PCMPIServerInSolve;
    2692: PETSC_EXTERN PetscBool      PCMPIServerUseShmget;
    2693: PETSC_EXTERN PetscErrorCode PetscShmgetAllocateArray(size_t, size_t, void **);
    2694: PETSC_EXTERN PetscErrorCode PetscShmgetDeallocateArray(void **);
    2695: PETSC_EXTERN PetscErrorCode PetscShmgetMapAddresses(MPI_Comm, PetscInt, const void **, void **);
    2696: PETSC_EXTERN PetscErrorCode PetscShmgetUnmapAddresses(PetscInt, void **);
    2697: PETSC_EXTERN PetscErrorCode PetscShmgetAddressesFinalize(void);

    2699: typedef struct {
    2700:   PetscInt n;
    2701:   void    *addr[3];
    2702: } PCMPIServerAddresses;
    2703: PETSC_EXTERN PetscErrorCode PCMPIServerAddressesDestroy(void *);

    2705: #define PETSC_HAVE_FORTRAN PETSC_DEPRECATED_MACRO(3, 20, 0, "PETSC_USE_FORTRAN_BINDINGS", ) PETSC_USE_FORTRAN_BINDINGS

    2707: PETSC_EXTERN PetscErrorCode PetscBLASSetNumThreads(PetscInt);
    2708: PETSC_EXTERN PetscErrorCode PetscBLASGetNumThreads(PetscInt *);

    2710: /*MC
    2711:    PetscSafePointerPlusOffset - Checks that a pointer is not `NULL` before applying an offset

    2713:    Level: beginner

    2715:    Note:
    2716:    This is needed to avoid errors with undefined-behavior sanitizers such as
    2717:    UBSan, assuming PETSc has been configured with `-fsanitize=undefined` as part of the compiler flags
    2718: M*/
    2719: #define PetscSafePointerPlusOffset(ptr, offset) ((ptr) ? (ptr) + (offset) : NULL)