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: /*MC
 10:    PeOP - indicates an argument to a PETSc function is optional and one can pass `NULL` instead. This is used by the Fortran API generator

 12:    Level: developer

 14:    Example:
 15: .vb
 16:    PetscErrorCode XXXX(Vec v, PeOp PetscObject obj, PeOp PetscInt *idx, PeOp PetscInt *array[])
 17: .ve

 19:    Notes:
 20:    This is not part of the PETSc public API and should only be used in PETSc source code.

 22:    Put this in the function declaration in front of each variable that is optional

 24:    Developer Note:
 25:    Shortened form of PETSc optional

 27: .seealso: `PeNS`, `PeNSS`, `PeCtx`, `PetscInitialize()`
 28: M*/
 29: #define PeOp

 31: /*MC
 32:    PeNS - indicates a function that does not use the PETSc standard arguments which make it easy to generate automatic language stubs for other languages

 34:    Level: developer

 36:    Notes:
 37:    This is not part of the PETSc public API and should only be used in PETSc source code.

 39:    Put this at the end of the function declaration closing parenthesis

 41:    Developer Note:
 42:    Shortened form of PETSc non-standard

 44: .seealso: `PeOp`, `PeNSS`, `PeCtx`, `PetscInitialize()`
 45: M*/
 46: #define PeNS

 48: /*MC
 49:    PeNSS - indicates a function that needs a special treatment in the C-side stub when generating the binding for other languages

 51:    Level: developer

 53:    Notes:
 54:    This is not part of the PETSc public API and should only be used in PETSc source code.

 56:    Put this at the end of the function declaration closing parenthesis

 58:    It is similar to PeNS; in Fortran it will generate the Fortran interface definition automatically but not the C stub, which should be added manually under the appropriate `ftn-custom` directory

 60:    Developer Note:
 61:    Shortened form of PETSc non-standard stub

 63: .seealso: `PeOp`, `PeNS`, `PeCtx`, `PetscInitialize()`
 64: M*/
 65: #define PeNSS

 67: /* ========================================================================== */
 68: /*
 69:    petscconf.h is contained in ${PETSC_ARCH}/include/petscconf.h it is
 70:    found automatically by the compiler due to the -I${PETSC_DIR}/${PETSC_ARCH}/include that
 71:    PETSc's makefiles add to the compiler rules.
 72:    For --prefix installs the directory ${PETSC_ARCH} does not exist and petscconf.h is in the same
 73:    directory as the other PETSc include files.
 74: */
 75: #include <petscconf.h>
 76: #include <petscpkg_version.h>
 77: #include <petscconf_poison.h>
 78: #include <petscfix.h>
 79: #include <petscmacros.h>

 81: /* SUBMANSEC = Sys */

 83: #if defined(PETSC_DESIRE_FEATURE_TEST_MACROS)
 84:   /*
 85:    Feature test macros must be included before headers defined by IEEE Std 1003.1-2001
 86:    We only turn these in PETSc source files that require them by setting PETSC_DESIRE_FEATURE_TEST_MACROS
 87: */
 88:   #if defined(PETSC__POSIX_C_SOURCE_200112L) && !defined(_POSIX_C_SOURCE)
 89:     #define _POSIX_C_SOURCE 200112L
 90:   #endif
 91:   #if defined(PETSC__BSD_SOURCE) && !defined(_BSD_SOURCE)
 92:     #define _BSD_SOURCE
 93:   #endif
 94:   #if defined(PETSC__DEFAULT_SOURCE) && !defined(_DEFAULT_SOURCE)
 95:     #define _DEFAULT_SOURCE
 96:   #endif
 97:   #if defined(PETSC__GNU_SOURCE) && !defined(_GNU_SOURCE)
 98:     #define _GNU_SOURCE
 99:   #endif
100: #endif

102: #include <petscsystypes.h>

104: /* ========================================================================== */

106: /*
107:     Defines the interface to MPI allowing the use of all MPI functions.

109:     PETSc does not use the C++ binding of MPI at ALL. The following flag
110:     makes sure the C++ bindings are not included. The C++ bindings REQUIRE
111:     putting mpi.h before ANY C++ include files, we cannot control this
112:     with all PETSc users. Users who want to use the MPI C++ bindings can include
113:     mpicxx.h directly in their code
114: */
115: #if !defined(MPICH_SKIP_MPICXX)
116:   #define MPICH_SKIP_MPICXX 1
117: #endif
118: #if !defined(OMPI_SKIP_MPICXX)
119:   #define OMPI_SKIP_MPICXX 1
120: #endif
121: #if defined(PETSC_HAVE_MPIUNI)
122: #include <petsc/mpiuni/mpi.h>
123: #else
124:   #include <mpi.h>
125: #endif

127: /*
128:    Perform various sanity checks that the correct mpi.h is being included at compile time.
129:    This usually happens because
130:       * either an unexpected mpi.h is in the default compiler path (i.e. in /usr/include) or
131:       * an extra include path -I/something (which contains the unexpected mpi.h) is being passed to the compiler
132:    Note: with MPICH and OpenMPI, accept versions [x.y.z, x+1.0.0) as compatible
133: */
134: #if defined(PETSC_HAVE_MPIUNI)
135:   #ifndef MPIUNI_H
136:     #error "PETSc was configured with --with-mpi=0 but now appears to be compiling using a different mpi.h"
137:   #endif
138: #elif defined(PETSC_HAVE_I_MPI)
139:   #if !defined(I_MPI_NUMVERSION)
140:     #error "PETSc was configured with I_MPI but now appears to be compiling using a non-I_MPI mpi.h"
141:   #elif I_MPI_NUMVERSION != PETSC_PKG_I_MPI_NUMVERSION
142:     #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"
143:   #endif
144: #elif defined(PETSC_HAVE_MVAPICH2)
145:   #if !defined(MVAPICH2_NUMVERSION)
146:     #error "PETSc was configured with MVAPICH2 but now appears to be compiling using a non-MVAPICH2 mpi.h"
147:   #elif MVAPICH2_NUMVERSION != PETSC_PKG_MVAPICH2_NUMVERSION
148:     #error "PETSc was configured with one MVAPICH2 mpi.h version but now appears to be compiling using a different MVAPICH2 mpi.h version"
149:   #endif
150: #elif defined(PETSC_HAVE_MPICH)
151:   #if !defined(MPICH_NUMVERSION) || defined(MVAPICH2_NUMVERSION) || defined(I_MPI_NUMVERSION)
152:     #error "PETSc was configured with MPICH but now appears to be compiling using a non-MPICH mpi.h"
153:   #elif PETSC_PKG_MPICH_VERSION_GT(MPICH_NUMVERSION / 10000000, MPICH_NUMVERSION / 100000 % 100, MPICH_NUMVERSION / 1000 % 100)
154:     #error "PETSc was configured with one MPICH mpi.h version but now appears to be compiling using an older MPICH mpi.h version"
155:   #elif PETSC_PKG_MPICH_VERSION_LT(MPICH_NUMVERSION / 10000000, 0, 0)
156:     #error "PETSc was configured with one MPICH mpi.h version but now appears to be compiling using a newer major MPICH mpi.h version"
157:   #endif
158: #elif defined(PETSC_HAVE_OPENMPI)
159:   #if !defined(OMPI_MAJOR_VERSION)
160:     #error "PETSc was configured with Open MPI but now appears to be compiling using a non-Open MPI mpi.h"
161:   #elif PETSC_PKG_OPENMPI_VERSION_GT(OMPI_MAJOR_VERSION, OMPI_MINOR_VERSION, OMPI_RELEASE_VERSION)
162:     #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"
163:   #elif PETSC_PKG_OPENMPI_VERSION_LT(OMPI_MAJOR_VERSION, 0, 0)
164:     #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"
165:   #endif
166: #elif defined(PETSC_HAVE_MSMPI_VERSION)
167:   #if !defined(MSMPI_VER)
168:     #error "PETSc was configured with MSMPI but now appears to be compiling using a non-MSMPI mpi.h"
169:   #elif (MSMPI_VER != PETSC_HAVE_MSMPI_VERSION)
170:     #error "PETSc was configured with one MSMPI mpi.h version but now appears to be compiling using a different MSMPI mpi.h version"
171:   #endif
172: #elif defined(OMPI_MAJOR_VERSION) || defined(MPICH_NUMVERSION) || defined(MSMPI_VER)
173:   #error "PETSc was configured with undetermined MPI - but now appears to be compiling using any of Open MPI, MS-MPI or a MPICH variant"
174: #endif

176: /*
177:     Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler
178:     see the top of mpicxx.h in the MPICH2 distribution.
179: */
180: #include <stdio.h>

182: /* MSMPI on 32-bit Microsoft Windows requires this yukky hack - that breaks MPI standard compliance */
183: #if !defined(MPIAPI)
184:   #define MPIAPI
185: #endif

187: PETSC_EXTERN MPI_Datatype MPIU_ENUM PETSC_ATTRIBUTE_MPI_TYPE_TAG(PetscEnum);
188: #define MPIU_BOOL MPI_C_BOOL PETSC_DEPRECATED_MACRO(3, 24, 0, "MPI_C_BOOL", )

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

193:    Level: beginner

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

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

201: PETSC_EXTERN MPI_Datatype MPIU_FORTRANADDR;

203: #if defined(PETSC_USE_64BIT_INDICES)
204:   #define MPIU_INT MPIU_INT64
205: #else
206:   #define MPIU_INT MPI_INT
207: #endif

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

212:    Level: beginner

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

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

220: .seealso: `PetscReal`, `PetscScalar`, `PetscComplex`, `PetscInt`, `MPIU_INT`, `MPIU_REAL`, `MPIU_SCALAR`, `MPIU_COMPLEX`
221: M*/
222: #define MPIU_COUNT MPI_AINT

224: /*
225:     For the rare cases when one needs to send a size_t object with MPI
226: */
227: PETSC_EXTERN MPI_Datatype MPIU_SIZE_T PETSC_ATTRIBUTE_MPI_TYPE_TAG(size_t);

229: /*
230:       You can use PETSC_STDOUT as a replacement of stdout. You can also change
231:     the value of PETSC_STDOUT to redirect all standard output elsewhere
232: */
233: PETSC_EXTERN FILE *PETSC_STDOUT;

235: /*
236:       You can use PETSC_STDERR as a replacement of stderr. You can also change
237:     the value of PETSC_STDERR to redirect all standard error elsewhere
238: */
239: PETSC_EXTERN FILE *PETSC_STDERR;

241: /*
242:   Handle inclusion when using clang compiler with CUDA support
243:   __float128 is not available for the device
244: */
245: #if defined(__clang__) && (defined(__CUDA_ARCH__) || defined(__HIPCC__))
246:   #define PETSC_SKIP_REAL___FLOAT128
247: #endif

249: /*
250:     Declare extern C stuff after including external header files
251: */

253: PETSC_EXTERN PetscBool PETSC_RUNNING_ON_VALGRIND;
254: /*
255:     Defines elementary mathematics functions and constants.
256: */
257: #include <petscmath.h>

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

262:    Level: beginner

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

267:    Fortran Note:
268:    Use `PETSC_NULL_INTEGER`, `PETSC_NULL_SCALAR` etc

270: .seealso: `PETSC_DECIDE`, `PETSC_DEFAULT`, `PETSC_DETERMINE`
271: M*/
272: #define PETSC_IGNORE PETSC_NULLPTR
273: #define PETSC_NULL   PETSC_DEPRECATED_MACRO(3, 19, 0, "PETSC_NULLPTR", ) PETSC_NULLPTR

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

278:    Level: beginner

280:    Example Usage:
281: .vb
282:    KSPSetTolerances(ksp, PETSC_CURRENT, PETSC_CURRENT, PETSC_UNLIMITED, PETSC_UNLIMITED);
283: .ve
284:   indicates that the solver is allowed to take any number of iterations and will not stop early no matter how the residual gets.

286:    Fortran Note:
287:    Use `PETSC_UNLIMITED_INTEGER` or `PETSC_UNLIMITED_REAL`.

289: .seealso: `PETSC_DEFAULT`, `PETSC_IGNORE`, `PETSC_DETERMINE`, `PETSC_DECIDE`
290: M*/

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

295:    Level: beginner

297:    Example Usage:
298: .vb
299:    VecSetSizes(ksp, PETSC_DECIDE, 10);
300: .ve
301:   indicates that the global size of the vector is 10 and the local size will be automatically determined so that the sum of the
302:   local sizes is the global size, see `PetscSplitOwnership()`.

304:    Fortran Note:
305:    Use `PETSC_DECIDE_INTEGER` or `PETSC_DECIDE_REAL`.

307: .seealso: `PETSC_DEFAULT`, `PETSC_IGNORE`, `PETSC_DETERMINE`, `PETSC_UNLIMITED'
308: M*/

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

313:    Level: beginner

315:     Example Usage:
316: .vb
317:    VecSetSizes(ksp, 10, PETSC_DETERMINE);
318: .ve
319:   indicates that the local size of the vector is 10 and the global size will be automatically summing up all the local sizes.

321:    Note:
322:    Same as `PETSC_DECIDE`

324:    Fortran Note:
325:    Use `PETSC_DETERMINE_INTEGER` or `PETSC_DETERMINE_REAL`.

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

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

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

337:    Level: beginner

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

342:    Fortran Note:
343:    Use `PETSC_CURRENT_INTEGER` or `PETSC_CURRENT_REAL`.

345: .seealso: `PETSC_DECIDE`, `PETSC_IGNORE`, `PETSC_DETERMINE`, `PETSC_DEFAULT`, `PETSC_UNLIMITED'
346: M*/

348: /*MC
349:    PETSC_DEFAULT - deprecated, see `PETSC_CURRENT` and `PETSC_DETERMINE`

351:    Level: beginner

353:    Note:
354:    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.

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

360: .seealso: `PETSC_DECIDE`, `PETSC_IGNORE`, `PETSC_DETERMINE`, `PETSC_CURRENT`, `PETSC_UNLIMITED'
361: M*/

363: /* These MUST be preprocessor defines! see https://gitlab.com/petsc/petsc/-/issues/1370 */
364: #define PETSC_DECIDE    (-1)
365: #define PETSC_DETERMINE PETSC_DECIDE
366: #define PETSC_CURRENT   (-2)
367: #define PETSC_UNLIMITED (-3)
368: /*  PETSC_DEFAULT is deprecated in favor of PETSC_CURRENT for use in KSPSetTolerances() and similar functions */
369: #define PETSC_DEFAULT PETSC_CURRENT

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

374:    Level: beginner

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

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

385: .seealso: `PETSC_COMM_SELF`
386: M*/
387: PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD;

389: /*MC
390:    PETSC_COMM_SELF - This is always `MPI_COMM_SELF`

392:    Level: beginner

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

397: .seealso: `PETSC_COMM_WORLD`
398: M*/
399: #define PETSC_COMM_SELF MPI_COMM_SELF

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

404:    No Fortran Support

406:    Level: beginner

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

411: .seealso: `PetscInitialize()`
412: M*/
413: PETSC_EXTERN PetscMPIInt PETSC_MPI_THREAD_REQUIRED;

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

418:    Synopsis:
419: #include <petscsys.h>
420:    PetscBool PetscBeganMPI;

422:    No Fortran Support

424:    Level: developer

426:    Note:
427:    `MPI_Init()` can never be called after `PetscInitialize()`

429: .seealso: `PetscInitialize()`, `PetscInitializeCalled`
430: M*/
431: PETSC_EXTERN PetscBool PetscBeganMPI;

433: PETSC_EXTERN PetscBool PetscErrorHandlingInitialized;
434: PETSC_EXTERN PetscBool PetscInitializeCalled;
435: PETSC_EXTERN PetscBool PetscFinalizeCalled;
436: PETSC_EXTERN PetscBool PetscViennaCLSynchronize;

438: PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm), PetscErrorCode (*)(MPI_Comm));
439: PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm, MPI_Comm *, int *);
440: PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm *);
441: PETSC_EXTERN PetscErrorCode PetscCommGetComm(MPI_Comm, MPI_Comm *);
442: PETSC_EXTERN PetscErrorCode PetscCommRestoreComm(MPI_Comm, MPI_Comm *);

444: #if defined(PETSC_HAVE_KOKKOS)
445: PETSC_EXTERN PetscErrorCode PetscKokkosInitializeCheck(void); /* Initialize Kokkos if not yet. */
446: #endif

448: #if defined(PETSC_HAVE_NVSHMEM)
449: PETSC_EXTERN PetscBool      PetscBeganNvshmem;
450: PETSC_EXTERN PetscBool      PetscNvshmemInitialized;
451: PETSC_EXTERN PetscErrorCode PetscNvshmemFinalize(void);
452: #endif

454: #if defined(PETSC_HAVE_ELEMENTAL)
455: PETSC_EXTERN PetscErrorCode PetscElementalInitializePackage(void);
456: PETSC_EXTERN PetscErrorCode PetscElementalInitialized(PetscBool *);
457: PETSC_EXTERN PetscErrorCode PetscElementalFinalizePackage(void);
458: #endif

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

463:    Synopsis:
464: #include <petscsys.h>
465:    PetscErrorCode PetscMalloc(size_t m,void **result)

467:    Not Collective

469:    Input Parameter:
470: .  m - number of bytes to allocate

472:    Output Parameter:
473: .  result - memory allocated

475:    Level: beginner

477:    Notes:
478:    Memory is always allocated at least double aligned

480:    It is safe to allocate with an m of 0 and pass the resulting pointer to `PetscFree()`.
481:    However, the pointer should never be dereferenced or the program will crash.

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

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

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

493: /*MC
494:    PetscRealloc - Reallocates memory

496:    Synopsis:
497: #include <petscsys.h>
498:    PetscErrorCode PetscRealloc(size_t m,void **result)

500:    Not Collective

502:    Input Parameters:
503: +  m      - number of bytes to allocate
504: -  result - previous memory

506:    Output Parameter:
507: .  result - new memory allocated

509:    Level: developer

511:    Notes:
512:    `results` must have already been obtained with `PetscMalloc()`

514:    Memory is always allocated at least double aligned

516: .seealso: `PetscMalloc()`, `PetscFree()`, `PetscNew()`
517: M*/
518: #define PetscRealloc(a, b) ((*PetscTrRealloc)((a), __LINE__, PETSC_FUNCTION_NAME, __FILE__, (void **)(b)))

520: /*MC
521:    PetscAddrAlign - Rounds up an address to `PETSC_MEMALIGN` alignment

523:    Synopsis:
524: #include <petscsys.h>
525:    void *PetscAddrAlign(void *addr)

527:    Not Collective

529:    Input Parameter:
530: .  addr - address to align (any pointer type)

532:    Level: developer

534: .seealso: `PetscMallocAlign()`
535: M*/
536: #define PetscAddrAlign(a) ((void *)((((PETSC_UINTPTR_T)(a)) + (PETSC_MEMALIGN - 1)) & ~(PETSC_MEMALIGN - 1)))

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

541:    Synopsis:
542: #include <petscsys.h>
543:    PetscErrorCode PetscCalloc(size_t m,void **result)

545:    Not Collective

547:    Input Parameter:
548: .  m - number of bytes to allocate

550:    Output Parameter:
551: .  result - memory allocated

553:    Level: beginner

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

558:    It is safe to allocate with an m of 0 and pass the resulting pointer to `PetscFree()`.

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

562:    Developer Note:
563:    All `PetscCallocN()` routines call `PetscCalloc()` behind the scenes.

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

569: /*MC
570:    PetscMalloc1 - Allocates an array of memory aligned to `PETSC_MEMALIGN`

572:    Synopsis:
573: #include <petscsys.h>
574:    PetscErrorCode PetscMalloc1(size_t m1,type **r1)

576:    Not Collective

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

581:    Output Parameter:
582: .  r1 - memory allocated

584:    Level: beginner

586:    Note:
587:    This uses `sizeof()` of the memory type requested to determine the total memory to be allocated; therefore, you should not
588:    multiply the number of elements requested by the `sizeof()` the type. For example, use
589: .vb
590:   PetscInt *id;
591:   PetscMalloc1(10,&id);
592: .ve
593:        not
594: .vb
595:   PetscInt *id;
596:   PetscMalloc1(10*sizeof(PetscInt),&id);
597: .ve

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

601:   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
602:   32bit `int` computation - while computation in 64bit `size_t` would not overflow!
603:   It's best if any arithmetic that is done for size computations is done with `size_t` type - avoiding arithmetic overflow!

605:   `PetscMalloc[N]()` and `PetscCalloc[N]()` attempt to work-around this by casting the first variable to `size_t`.
606:   This works for most expressions, but not all, such as
607: .vb
608:   PetscInt *id, a, b;
609:   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
610:   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
611: .ve

613:   These expressions should either be avoided, or appropriately cast variables to `size_t`:
614: .vb
615:   PetscInt *id, a, b;
616:   PetscMalloc1(use_a_squared ? (size_t)a * a * b : (size_t)a * b, &id); // Cast a to size_t before multiplication
617:   PetscMalloc1(b * b + a, &id); // b is automatically cast to size_t and order-of-operations ensures size_t precision is maintained
618: .ve

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

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

627:    Synopsis:
628: #include <petscsys.h>
629:    PetscErrorCode PetscCalloc1(size_t m1,type **r1)

631:    Not Collective

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

636:    Output Parameter:
637: .  r1 - memory allocated

639:    Level: beginner

641:    Note:
642:    See `PetscMalloc1()` for more details on usage.

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

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

651:    Synopsis:
652: #include <petscsys.h>
653:    PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2)

655:    Not Collective

657:    Input Parameters:
658: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
659: -  m2 - number of elements to allocate in 2nd chunk  (may be zero)

661:    Output Parameters:
662: +  r1 - memory allocated in first chunk
663: -  r2 - memory allocated in second chunk

665:    Level: developer

667: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc1()`, `PetscCalloc2()`
668: M*/
669: #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))

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

674:    Synopsis:
675: #include <petscsys.h>
676:    PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2)

678:    Not Collective

680:    Input Parameters:
681: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
682: -  m2 - number of elements to allocate in 2nd chunk  (may be zero)

684:    Output Parameters:
685: +  r1 - memory allocated in first chunk
686: -  r2 - memory allocated in second chunk

688:    Level: developer

690: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscCalloc1()`, `PetscMalloc2()`
691: M*/
692: #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))

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

697:    Synopsis:
698: #include <petscsys.h>
699:    PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)

701:    Not Collective

703:    Input Parameters:
704: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
705: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
706: -  m3 - number of elements to allocate in 3rd chunk  (may be zero)

708:    Output Parameters:
709: +  r1 - memory allocated in first chunk
710: .  r2 - memory allocated in second chunk
711: -  r3 - memory allocated in third chunk

713:    Level: developer

715: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc3()`, `PetscFree3()`
716: M*/
717: #define PetscMalloc3(m1, r1, m2, r2, m3, r3) \
718:   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))

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

723:    Synopsis:
724: #include <petscsys.h>
725:    PetscErrorCode PetscCalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)

727:    Not Collective

729:    Input Parameters:
730: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
731: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
732: -  m3 - number of elements to allocate in 3rd chunk  (may be zero)

734:    Output Parameters:
735: +  r1 - memory allocated in first chunk
736: .  r2 - memory allocated in second chunk
737: -  r3 - memory allocated in third chunk

739:    Level: developer

741: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscCalloc2()`, `PetscMalloc3()`, `PetscFree3()`
742: M*/
743: #define PetscCalloc3(m1, r1, m2, r2, m3, r3) \
744:   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))

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

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

753:    Not Collective

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

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

767:    Level: developer

769: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc4()`, `PetscFree4()`
770: M*/
771: #define PetscMalloc4(m1, r1, m2, r2, m3, r3, m4, r4) \
772:   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))

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

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

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)

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

795:    Level: developer

797: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc4()`, `PetscFree4()`
798: M*/
799: #define PetscCalloc4(m1, r1, m2, r2, m3, r3, m4, r4) \
800:   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))

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

805:    Synopsis:
806: #include <petscsys.h>
807:    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)

809:    Not Collective

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

818:    Output Parameters:
819: +  r1 - memory allocated in first chunk
820: .  r2 - memory allocated in second chunk
821: .  r3 - memory allocated in third chunk
822: .  r4 - memory allocated in fourth chunk
823: -  r5 - memory allocated in fifth chunk

825:    Level: developer

827: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc5()`, `PetscFree5()`
828: M*/
829: #define PetscMalloc5(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5) \
830:   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))

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

835:    Synopsis:
836: #include <petscsys.h>
837:    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)

839:    Not Collective

841:    Input Parameters:
842: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
843: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
844: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
845: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
846: -  m5 - number of elements to allocate in 5th chunk  (may be zero)

848:    Output Parameters:
849: +  r1 - memory allocated in first chunk
850: .  r2 - memory allocated in second chunk
851: .  r3 - memory allocated in third chunk
852: .  r4 - memory allocated in fourth chunk
853: -  r5 - memory allocated in fifth chunk

855:    Level: developer

857: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc5()`, `PetscFree5()`
858: M*/
859: #define PetscCalloc5(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5) \
860:   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))

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

865:    Synopsis:
866: #include <petscsys.h>
867:    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)

869:    Not Collective

871:    Input Parameters:
872: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
873: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
874: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
875: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
876: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
877: -  m6 - number of elements to allocate in 6th chunk  (may be zero)

879:    Output Parameteasr:
880: +  r1 - memory allocated in first chunk
881: .  r2 - memory allocated in second chunk
882: .  r3 - memory allocated in third chunk
883: .  r4 - memory allocated in fourth chunk
884: .  r5 - memory allocated in fifth chunk
885: -  r6 - memory allocated in sixth chunk

887:    Level: developer

889: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc6()`, `PetscFree3()`, `PetscFree4()`, `PetscFree5()`, `PetscFree6()`
890: M*/
891: #define PetscMalloc6(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5, m6, r6) \
892:   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))

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

897:    Synopsis:
898: #include <petscsys.h>
899:    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)

901:    Not Collective

903:    Input Parameters:
904: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
905: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
906: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
907: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
908: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
909: -  m6 - number of elements to allocate in 6th chunk  (may be zero)

911:    Output Parameters:
912: +  r1 - memory allocated in first chunk
913: .  r2 - memory allocated in second chunk
914: .  r3 - memory allocated in third chunk
915: .  r4 - memory allocated in fourth chunk
916: .  r5 - memory allocated in fifth chunk
917: -  r6 - memory allocated in sixth chunk

919:    Level: developer

921: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscMalloc6()`, `PetscFree6()`
922: M*/
923: #define PetscCalloc6(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5, m6, r6) \
924:   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))

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

929:    Synopsis:
930: #include <petscsys.h>
931:    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)

933:    Not Collective

935:    Input Parameters:
936: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
937: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
938: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
939: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
940: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
941: .  m6 - number of elements to allocate in 6th chunk  (may be zero)
942: -  m7 - number of elements to allocate in 7th chunk  (may be zero)

944:    Output Parameters:
945: +  r1 - memory allocated in first chunk
946: .  r2 - memory allocated in second chunk
947: .  r3 - memory allocated in third chunk
948: .  r4 - memory allocated in fourth chunk
949: .  r5 - memory allocated in fifth chunk
950: .  r6 - memory allocated in sixth chunk
951: -  r7 - memory allocated in seventh chunk

953:    Level: developer

955: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscCalloc7()`, `PetscFree7()`
956: M*/
957: #define PetscMalloc7(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5, m6, r6, m7, r7) \
958:   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))

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

963:    Synopsis:
964: #include <petscsys.h>
965:    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)

967:    Not Collective

969:    Input Parameters:
970: +  m1 - number of elements to allocate in 1st chunk  (may be zero)
971: .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
972: .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
973: .  m4 - number of elements to allocate in 4th chunk  (may be zero)
974: .  m5 - number of elements to allocate in 5th chunk  (may be zero)
975: .  m6 - number of elements to allocate in 6th chunk  (may be zero)
976: -  m7 - number of elements to allocate in 7th chunk  (may be zero)

978:    Output Parameters:
979: +  r1 - memory allocated in first chunk
980: .  r2 - memory allocated in second chunk
981: .  r3 - memory allocated in third chunk
982: .  r4 - memory allocated in fourth chunk
983: .  r5 - memory allocated in fifth chunk
984: .  r6 - memory allocated in sixth chunk
985: -  r7 - memory allocated in seventh chunk

987:    Level: developer

989: .seealso: `PetscFree()`, `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscMalloc7()`, `PetscFree7()`
990: M*/
991: #define PetscCalloc7(m1, r1, m2, r2, m3, r3, m4, r4, m5, r5, m6, r6, m7, r7) \
992:   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))

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

997:    Synopsis:
998: #include <petscsys.h>
999:    PetscErrorCode PetscNew(type **result)

1001:    Not Collective

1003:    Output Parameter:
1004: .  result - memory allocated, sized to match pointer `type`

1006:    Level: beginner

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

1011: .seealso: `PetscFree()`, `PetscMalloc()`, `PetscCall()`, `PetscCalloc1()`, `PetscMalloc1()`
1012: M*/
1013: #define PetscNew(b) PetscCalloc1(1, (b))

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

1017: /*MC
1018:    PetscFree - Frees memory

1020:    Synopsis:
1021: #include <petscsys.h>
1022:    PetscErrorCode PetscFree(void *memory)

1024:    Not Collective

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

1029:    Level: beginner

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

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

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

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

1043:    Synopsis:
1044: #include <petscsys.h>
1045:    PetscErrorCode PetscFree2(void *memory1,void *memory2)

1047:    Not Collective

1049:    Input Parameters:
1050: +   memory1 - memory to free
1051: -   memory2 - 2nd memory to free

1053:    Level: developer

1055:    Notes:
1056:     Memory must have been obtained with `PetscMalloc2()`

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

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

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

1067:    Synopsis:
1068: #include <petscsys.h>
1069:    PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3)

1071:    Not Collective

1073:    Input Parameters:
1074: +   memory1 - memory to free
1075: .   memory2 - 2nd memory to free
1076: -   memory3 - 3rd memory to free

1078:    Level: developer

1080:    Notes:
1081:     Memory must have been obtained with `PetscMalloc3()`

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

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

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

1092:    Synopsis:
1093: #include <petscsys.h>
1094:    PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4)

1096:    Not Collective

1098:    Input Parameters:
1099: +   m1 - memory to free
1100: .   m2 - 2nd memory to free
1101: .   m3 - 3rd memory to free
1102: -   m4 - 4th memory to free

1104:    Level: developer

1106:    Notes:
1107:     Memory must have been obtained with `PetscMalloc4()`

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

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

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

1118:    Synopsis:
1119: #include <petscsys.h>
1120:    PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5)

1122:    Not Collective

1124:    Input Parameters:
1125: +   m1 - memory to free
1126: .   m2 - 2nd memory to free
1127: .   m3 - 3rd memory to free
1128: .   m4 - 4th memory to free
1129: -   m5 - 5th memory to free

1131:    Level: developer

1133:    Notes:
1134:     Memory must have been obtained with `PetscMalloc5()`

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

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

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

1145:    Synopsis:
1146: #include <petscsys.h>
1147:    PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6)

1149:    Not Collective

1151:    Input Parameters:
1152: +   m1 - memory to free
1153: .   m2 - 2nd memory to free
1154: .   m3 - 3rd memory to free
1155: .   m4 - 4th memory to free
1156: .   m5 - 5th memory to free
1157: -   m6 - 6th memory to free

1159:    Level: developer

1161:    Notes:
1162:     Memory must have been obtained with `PetscMalloc6()`

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

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

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

1173:    Synopsis:
1174: #include <petscsys.h>
1175:    PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7)

1177:    Not Collective

1179:    Input Parameters:
1180: +   m1 - memory to free
1181: .   m2 - 2nd memory to free
1182: .   m3 - 3rd memory to free
1183: .   m4 - 4th memory to free
1184: .   m5 - 5th memory to free
1185: .   m6 - 6th memory to free
1186: -   m7 - 7th memory to free

1188:    Level: developer

1190:    Notes:
1191:     Memory must have been obtained with `PetscMalloc7()`

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

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

1200: PETSC_EXTERN PetscErrorCode PetscMallocA(int, PetscBool, int, const char *, const char *, size_t, void *, ...);
1201: PETSC_EXTERN PetscErrorCode PetscFreeA(int, int, const char *, const char *, void *, ...);
1202: PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t, PetscBool, int, const char[], const char[], void **);
1203: PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void *, int, const char[], const char[]);
1204: PETSC_EXTERN PetscErrorCode (*PetscTrRealloc)(size_t, int, const char[], const char[], void **);
1205: PETSC_EXTERN PetscErrorCode PetscMallocSetCoalesce(PetscBool);
1206: 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 **));
1207: PETSC_EXTERN PetscErrorCode PetscMallocClear(void);

1209: /*
1210:   Unlike PetscMallocSet and PetscMallocClear which overwrite the existing settings, these two functions save the previous choice of allocator, and should be used in pair.
1211: */
1212: PETSC_EXTERN PetscErrorCode PetscMallocSetDRAM(void);
1213: PETSC_EXTERN PetscErrorCode PetscMallocResetDRAM(void);
1214: #if defined(PETSC_HAVE_CUDA)
1215: PETSC_EXTERN PetscErrorCode PetscMallocSetCUDAHost(void);
1216: PETSC_EXTERN PetscErrorCode PetscMallocResetCUDAHost(void);
1217: #endif
1218: #if defined(PETSC_HAVE_HIP)
1219: PETSC_EXTERN PetscErrorCode PetscMallocSetHIPHost(void);
1220: PETSC_EXTERN PetscErrorCode PetscMallocResetHIPHost(void);
1221: #endif

1223: #define MPIU_PETSCLOGDOUBLE  MPI_DOUBLE
1224: #define MPIU_2PETSCLOGDOUBLE MPI_2DOUBLE_PRECISION

1226: /*
1227:    Routines for tracing memory corruption/bleeding with default PETSc memory allocation
1228: */
1229: PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *);
1230: PETSC_EXTERN PetscErrorCode PetscMallocView(FILE *);
1231: PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *);
1232: PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *);
1233: PETSC_EXTERN PetscErrorCode PetscMallocPushMaximumUsage(int);
1234: PETSC_EXTERN PetscErrorCode PetscMallocPopMaximumUsage(int, PetscLogDouble *);
1235: PETSC_EXTERN PetscErrorCode PetscMallocSetDebug(PetscBool, PetscBool);
1236: PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool *, PetscBool *, PetscBool *);
1237: PETSC_EXTERN PetscErrorCode PetscMallocValidate(int, const char[], const char[]);
1238: PETSC_EXTERN PetscErrorCode PetscMallocViewSet(PetscLogDouble);
1239: PETSC_EXTERN PetscErrorCode PetscMallocViewGet(PetscBool *);
1240: PETSC_EXTERN PetscErrorCode PetscMallocLogRequestedSizeSet(PetscBool);
1241: PETSC_EXTERN PetscErrorCode PetscMallocLogRequestedSizeGet(PetscBool *);

1243: PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType, MPI_Datatype *);
1244: PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype, PetscDataType *);
1245: PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType, size_t *);
1246: PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char *, PetscDataType *, PetscBool *);

1248: /*
1249:    These are MPI operations for MPI_Allreduce() etc
1250: */
1251: PETSC_EXTERN MPI_Op MPIU_MAXSUM_OP;
1252: #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1253: PETSC_EXTERN MPI_Op MPIU_SUM;
1254: PETSC_EXTERN MPI_Op MPIU_MAX;
1255: PETSC_EXTERN MPI_Op MPIU_MIN;
1256: #else
1257:   #define MPIU_SUM MPI_SUM
1258:   #define MPIU_MAX MPI_MAX
1259:   #define MPIU_MIN MPI_MIN
1260: #endif
1261: PETSC_EXTERN MPI_Op         Petsc_Garbage_SetIntersectOp;
1262: PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm, const PetscInt[], PetscInt *, PetscInt *);

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

1269:    Level: advanced

1271:    Developer Note:
1272:    This should be unified with `MPIU_SUM`

1274: .seealso: `MPIU_REAL`, `MPIU_SCALAR`, `MPIU_COMPLEX`
1275: M*/
1276: PETSC_EXTERN MPI_Op MPIU_SUM___FP16___FLOAT128;
1277: #endif

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

1284: /*S
1285:   PetscVoidFn - A prototype of a `void fn(void)` function

1287:   Level: advanced

1289:   Notes:
1290:   `PetscVoidFn *` plays the role of `void *` for function pointers in the PETSc API that do not return an error code.
1291:   It is used where a function pointer is needed but it is not possible to use the full prototype of the function.

1293:   `PetscErrorCodeFn` is similar to `PetscVoidFn` but should be used when the function returns a `PetscErrorCode`

1295:   The deprecated `PetscVoidFunction` works as a replacement for `PetscVoidFn` *.

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

1299: .seealso: `PetscErrorCodeFn`, `PetscObject`, `PetscObjectDestroy()`
1300: S*/
1301: PETSC_EXTERN_TYPEDEF typedef void PetscVoidFn(void);

1303: PETSC_EXTERN_TYPEDEF typedef PetscVoidFn  *PetscVoidFunction;
1304: PETSC_EXTERN_TYPEDEF typedef PetscVoidFn **PetscVoidStarFunction;

1306: /*S
1307:   PetscErrorCodeFn - a function typedef that represents abstractly a function that returns a PETSc error code
1308:   and takes any number of arguments. Since C/C++ has no way to express this concept, it is implemented as `void (fn)(void)`.

1310:   Level: advanced

1312:   Notes:
1313:   `PetscErrorCodeFn *` plays the role of `void *` for function pointers in the PETSc API that return an error code.
1314:   It is used where a function pointer is needed but it is not possible to use the full prototype of the function,
1315:   for example `VecSetOperation()`.

1317:   `PetscVoidFn` is similar to `PetscErrorCodeFn` but should be used when the function does not return a `PetscErrorCode`.

1319:   The deprecated `PetscErrorCodeFunction` works as a replacement for `PetscErrorCodeFn` *.

1321:   Developer Notes:
1322:   This function type is equivalent to `PetscVoidFn`*.

1324:   At the C/C++ syntax level this construct adds nothing of value to the PETSc source code. It provides a way, at the abstract
1325:   PETSc API level, to indicate specifically functions that return PETSc error codes as opposed to any C/C++ function.

1327: .seealso: `PetscVoidFn`, `PetscObject`, `PetscObjectDestroy()`, `VecSetOperation()`
1328: S*/
1329: PETSC_EXTERN_TYPEDEF typedef void PetscErrorCodeFn(void);

1331: PETSC_EXTERN_TYPEDEF typedef PetscErrorCodeFn *PetscErrorCodeFunction;

1333: /*S
1334:   PetscCtxDestroyFn - A prototype of a `PetscErrorCode (*)(void **)` function that is used to free user contexts

1336:   Level: intermediate

1338:   Note:
1339:   Used in the prototype of functions such as `DMSetApplicationContextDestroy()`

1341: .seealso: `PetscObject`, `PetscCtxDestroyDefault()`, `PetscObjectDestroy()`, `DMSetApplicationContextDestroy()`
1342: S*/
1343: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode PetscCtxDestroyFn(void **);

1345: PETSC_EXTERN PetscCtxDestroyFn PetscCtxDestroyDefault;

1347: /*
1348:     Defines PETSc error handling.
1349: */
1350: #include <petscerror.h>

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

1357: #define PETSC_SMALLEST_CLASSID 1211211
1358: PETSC_EXTERN PetscClassId   PETSC_LARGEST_CLASSID;
1359: PETSC_EXTERN PetscClassId   PETSC_OBJECT_CLASSID;
1360: PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[], PetscClassId *);
1361: PETSC_EXTERN PetscErrorCode PetscObjectGetId(PetscObject, PetscObjectId *);
1362: PETSC_EXTERN PetscErrorCode PetscObjectCompareId(PetscObject, PetscObjectId, PetscBool *);

1364: /*
1365:    Routines that get memory usage information from the OS
1366: */
1367: PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *);
1368: PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *);
1369: PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void);
1370: PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]);

1372: PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal);

1374: /*
1375:    Initialization of PETSc
1376: */
1377: PETSC_EXTERN PetscErrorCode PetscInitialize(int *, char ***, const char[], const char[]);
1378: PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int, char *[], const char[], const char[]);
1379: PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void);
1380: PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *);
1381: PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *);
1382: PETSC_EXTERN PetscErrorCode PetscFinalize(void);
1383: PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void);
1384: PETSC_EXTERN PetscErrorCode PetscGetArgs(int *, char ***);
1385: PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***);
1386: PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **);

1388: PETSC_EXTERN PetscErrorCode PetscEnd(void);
1389: PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void);
1390: PETSC_EXTERN PetscErrorCode PetscSysFinalizePackage(void);

1392: PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[], const char[]);
1393: PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void);
1394: PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void);
1395: PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject, const char[]);

1397: PETSC_EXTERN PetscErrorCode PetscMonitorCompare(PetscErrorCode (*)(void), void *, PetscCtxDestroyFn *, PetscErrorCode (*)(void), void *, PetscCtxDestroyFn *, PetscBool *);

1399: /*
1400:     Functions that can act on any PETSc object.
1401: */
1402: PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject *);
1403: PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject, MPI_Comm *);
1404: PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject, PetscClassId *);
1405: PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject, const char *[]);
1406: PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject, const char *[]);
1407: PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject, const char[]);
1408: PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject, const char *[]);
1409: PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject, PetscInt);
1410: PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject, PetscInt *);
1411: PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject, PetscObject, PetscInt);
1412: PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject);
1413: PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject, PetscInt *);
1414: PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject);
1415: PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject, PetscMPIInt *);
1416: PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject, const char[], PetscObject);
1417: PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject, const char[]);
1418: PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject, const char[], PetscObject *);
1419: PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject, const char[], PetscErrorCodeFn *);
1420: #define PetscObjectComposeFunction(a, b, ...) PetscObjectComposeFunction_Private((a), (b), (PetscErrorCodeFn *)(__VA_ARGS__))
1421: PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject);
1422: PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject);
1423: PETSC_EXTERN PetscErrorCode PetscObjectSetPrintedOptions(PetscObject);
1424: PETSC_EXTERN PetscErrorCode PetscObjectInheritPrintedOptions(PetscObject, PetscObject);
1425: PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm, PetscMPIInt *);

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

1431:    No Fortran Support

1433:    Synopsis:
1434: #include <petscsys.h>
1435:    PetscBool PetscObjectParameterSetDefault(PetscObject obj, char* NAME, PetscReal value);

1437:    Input Parameters:
1438: +  obj - the `PetscObject`
1439: .  NAME - the name of the parameter, unquoted
1440: -  value - the new value

1442:    Level: developer

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

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

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

1451: .seealso: `PetscObjectParameterDeclare()`, `PetscInitialize()`, `PetscFinalize()`, `PetscObject`, `SNESParametersInitialize()`
1452: M*/
1453: #define PetscObjectParameterSetDefault(obj, NAME, value) \
1454:   do { \
1455:     if (obj->NAME == obj->default_##NAME) obj->NAME = value; \
1456:     obj->default_##NAME = value; \
1457:   } while (0)

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

1462:    No Fortran Support

1464:    Synopsis:
1465: #include <petscsys.h>
1466:    PetscBool PetscObjectParameterDeclare(type, char* NAME)

1468:    Input Parameters:
1469: +  type - the type of the parameter, for example `PetscInt`
1470: -  NAME - the name of the parameter, unquoted

1472:    Level: developer.

1474: .seealso: `PetscObjectParameterSetDefault()`, `PetscInitialize()`, `PetscFinalize()`, `PetscObject`, `SNESParametersInitialize()`
1475: M*/
1476: #define PetscObjectParameterDeclare(type, NAME)    type NAME, default_##NAME
1477: #define PetscObjectParameterDeclarePtr(type, NAME) type *NAME, *default_##NAME

1479: #include <petscviewertypes.h>
1480: #include <petscoptions.h>

1482: PETSC_EXTERN PetscErrorCode PetscMallocTraceSet(PetscViewer, PetscBool, PetscLogDouble);
1483: PETSC_EXTERN PetscErrorCode PetscMallocTraceGet(PetscBool *);

1485: PETSC_EXTERN PetscErrorCode PetscObjectsListGetGlobalNumbering(MPI_Comm, PetscInt, PetscObject[], PetscInt *, PetscInt *);

1487: PETSC_EXTERN PetscErrorCode PetscMemoryView(PetscViewer, const char[]);
1488: PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject, PetscViewer);
1489: PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject, PetscViewer);
1490: #define PetscObjectQueryFunction(obj, name, fptr) PetscObjectQueryFunction_Private((obj), (name), (PetscErrorCodeFn **)(fptr))
1491: PETSC_EXTERN PetscErrorCode PetscObjectHasFunction(PetscObject, const char[], PetscBool *);
1492: PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject, const char[], PetscErrorCodeFn **);
1493: PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject, const char[]);
1494: PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject, const char[]);
1495: PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject, const char[]);
1496: PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject, const char *[]);
1497: PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject, const char[]);
1498: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject);
1499: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void);
1500: PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject, PetscObject, const char[]);
1501: PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject);
1502: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject, const char[], PetscBool *);
1503: PETSC_EXTERN PetscErrorCode PetscObjectObjectTypeCompare(PetscObject, PetscObject, PetscBool *);
1504: PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompare(PetscObject, const char[], PetscBool *);
1505: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject, PetscBool *, const char[], ...);
1506: PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompareAny(PetscObject, PetscBool *, const char[], ...);
1507: PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void));
1508: PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void);

1510: #if defined(PETSC_HAVE_SAWS)
1511: PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void);
1512: PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject);
1513: PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject, PetscBool);
1514: PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject);
1515: PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject);
1516: PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject);
1517: PETSC_EXTERN void           PetscStackSAWsGrantAccess(void);
1518: PETSC_EXTERN void           PetscStackSAWsTakeAccess(void);
1519: PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void);
1520: PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void);

1522: #else
1523:   #define PetscSAWsBlock()                  PETSC_SUCCESS
1524:   #define PetscObjectSAWsViewOff(obj)       PETSC_SUCCESS
1525:   #define PetscObjectSAWsSetBlock(obj, flg) PETSC_SUCCESS
1526:   #define PetscObjectSAWsBlock(obj)         PETSC_SUCCESS
1527:   #define PetscObjectSAWsGrantAccess(obj)   PETSC_SUCCESS
1528:   #define PetscObjectSAWsTakeAccess(obj)    PETSC_SUCCESS
1529:   #define PetscStackViewSAWs()              PETSC_SUCCESS
1530:   #define PetscStackSAWsViewOff()           PETSC_SUCCESS
1531:   #define PetscStackSAWsTakeAccess()
1532:   #define PetscStackSAWsGrantAccess()

1534: #endif

1536: PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[], PetscDLMode, PetscDLHandle *);
1537: PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *);
1538: PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle, const char[], void **);
1539: PETSC_EXTERN PetscErrorCode PetscDLAddr(PetscVoidFn *, char *[]);
1540: #ifdef PETSC_HAVE_CXX
1541: PETSC_EXTERN PetscErrorCode PetscDemangleSymbol(const char *, char *[]);
1542: #endif

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

1546: PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE *, PetscBool);
1547: PETSC_EXTERN PetscErrorCode PetscObjectsView(PetscViewer);
1548: PETSC_EXTERN PetscErrorCode PetscObjectsGetObject(const char *, PetscObject *, const char *[]);
1549: PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList *);
1550: PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList, const char[], PetscObject *);
1551: PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList, PetscObject, const char *[], PetscBool *);
1552: PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *, const char[], PetscObject);
1553: PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *, const char[]);
1554: PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList, PetscObjectList *);

1556: /*
1557:     Dynamic library lists. Lists of names of routines in objects or in dynamic
1558:   link libraries that will be loaded as needed.
1559: */

1561: #define PetscFunctionListAdd(list, name, fptr) PetscFunctionListAdd_Private((list), (name), (PetscErrorCodeFn *)(fptr))
1562: PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList *, const char[], PetscErrorCodeFn *);
1563: PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList *);
1564: PETSC_EXTERN PetscErrorCode PetscFunctionListClear(PetscFunctionList);
1565: #define PetscFunctionListFind(list, name, fptr) PetscFunctionListFind_Private((list), (name), (PetscErrorCodeFn **)(fptr))
1566: PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList, const char[], PetscErrorCodeFn **);
1567: PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm, FILE *, const char[], const char[], const char[], const char[], PetscFunctionList, const char[], const char[]);
1568: PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList, PetscFunctionList *);
1569: PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList, PetscViewer);
1570: PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList, const char ***, int *);
1571: PETSC_EXTERN PetscErrorCode PetscFunctionListPrintNonEmpty(PetscFunctionList);
1572: PETSC_EXTERN PetscErrorCode PetscFunctionListPrintAll(void);

1574: PETSC_EXTERN PetscDLLibrary PetscDLLibrariesLoaded;
1575: PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm, PetscDLLibrary *, const char[]);
1576: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm, PetscDLLibrary *, const char[]);
1577: PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm, PetscDLLibrary *, const char[], const char[], void **);
1578: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary);
1579: PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm, const char[], char *, size_t, PetscBool *);
1580: PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm, const char[], PetscDLLibrary *);
1581: PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary);

1583: /*
1584:      Useful utility routines
1585: */
1586: PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm, PetscInt *, PetscInt *);
1587: PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm, PetscInt, PetscInt *, PetscInt *);
1588: PETSC_EXTERN PetscErrorCode PetscSplitOwnershipEqual(MPI_Comm, PetscInt *, PetscInt *);
1589: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm, PetscMPIInt);
1590: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm, PetscMPIInt);
1591: PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject);
1592: PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE *);
1593: PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxInt(MPI_Comm, const PetscInt[2], PetscInt[2]);
1594: PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxReal(MPI_Comm, const PetscReal[2], PetscReal[2]);

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

1599:     Level: beginner

1601:     Note:
1602:     This is useful in cases like
1603: .vb
1604:      int        *a;
1605:      PetscBool  flag = PetscNot(a)
1606: .ve
1607:      where !a would not return a `PetscBool` because we cannot provide a cast from int to `PetscBool` in C.

1609: .seealso: `PetscBool`, `PETSC_TRUE`, `PETSC_FALSE`
1610: M*/
1611: #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)

1613: /*MC
1614:    PetscHelpPrintf - Prints help messages.

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

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

1622:    Input Parameters:
1623: +  comm - the MPI communicator over which the help message is printed
1624: .  format - the usual printf() format string
1625: -  args - arguments to be printed

1627:    Level: developer

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

1632:    To use, write your own function, for example,
1633: .vb
1634:    PetscErrorCode mypetschelpprintf(MPI_Comm comm,const char format[],....)
1635:    {
1636:      PetscFunctionReturn(PETSC_SUCCESS);
1637:    }
1638: .ve
1639: then do the assignment
1640: .vb
1641:   PetscHelpPrintf = mypetschelpprintf;
1642: .ve

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

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

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

1652: /*
1653:      Defines PETSc profiling.
1654: */
1655: #include <petsclog.h>

1657: /*
1658:       Simple PETSc parallel IO for ASCII printing
1659: */
1660: PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[], char[]);
1661: PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm, const char[], const char[], FILE **);
1662: PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm, FILE *);
1663: PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm, FILE *, const char[], ...) PETSC_ATTRIBUTE_FORMAT(3, 4);
1664: PETSC_EXTERN PetscErrorCode PetscFFlush(FILE *);
1665: PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);
1666: PETSC_EXTERN PetscErrorCode PetscSNPrintf(char *, size_t, const char[], ...) PETSC_ATTRIBUTE_FORMAT(3, 4);
1667: PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char *, size_t, const char[], size_t *, ...) PETSC_ATTRIBUTE_FORMAT(3, 5);
1668: PETSC_EXTERN PetscErrorCode PetscFormatRealArray(char[], size_t, const char *, PetscInt, const PetscReal[]);

1670: PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char[], ...) PETSC_ATTRIBUTE_FORMAT(1, 2);
1671: PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char[], ...) PETSC_ATTRIBUTE_FORMAT(1, 2);
1672: PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);

1674: PETSC_EXTERN PetscErrorCode PetscFormatConvertGetSize(const char *, size_t *);
1675: PETSC_EXTERN PetscErrorCode PetscFormatConvert(const char *, char *);

1677: PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm, const char[], const char[], const char[], FILE **);
1678: PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm, FILE *);
1679: PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]);

1681: PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);
1682: PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm, FILE *, const char[], ...) PETSC_ATTRIBUTE_FORMAT(3, 4);
1683: PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm, FILE *);
1684: PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm, FILE *, size_t, char[]);
1685: PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm, const char[], const char[], FILE **);
1686: PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char *[]);

1688: /*MC
1689:    PeCtx - indicates an argument that returns a pointer to a user defined C struct (or Fortran derived type)

1691:    Level: developer

1693:    Notes:
1694:    This is not part of the PETSc public API and should only be used in PETSc source code.

1696:    This should not be used for functions that return PETSc objects, or pointers to arrays of unknown type. Thus it is used for, for example,
1697:    `KSPGetApplicationContext()` but not used for `DMNetworkGetComponent()`

1699:    For pointers to arrays of unknown type and for functions that return PETSc internal objects that are opaque to users, such
1700:    as `KSPMonitorDynamicToleranceCreate()` a `void **` should be used.

1702:    Fortran Note:
1703:    Should only be used with user defined Fortran datatypes
1704: .vb
1705:    type(tUserType), pointer :: ctx
1706: .ve

1708:    Developer Note:
1709:    Put this in function declaration for the argument type instead of `void *`, or `void **`.

1711:    C compilers generate a warning or error if one passes a pointer to a pointer to a specific type (instead of `void`), for example,
1712: .vb
1713:    extern calledfunction(void **);
1714:    SomeCtx *ctx;
1715:    calledfunction(&ctx);   << warning that it is passing a pointer to a pointer to a SomeCtx instead of a void **
1716: .ve
1717:    By using the common practice of prototyping the function as
1718: .vb
1719:    extern calledfunction(void *);
1720: .ve
1721:    the warning message is averted. `PeCtx` is used in PETSc source code so that the getAPI() code processor knows the argument is
1722:    actually handled internally as `void **` so it can generate correct bindings for other languages.

1724: .seealso: `PeOp`, `PeNS`, `PetscInitialize()`
1725: M*/
1726: typedef void *PeCtx;

1728: PETSC_EXTERN PetscClassId   PETSC_CONTAINER_CLASSID;
1729: PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer, void *);
1730: PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer, void *);
1731: PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer *);
1732: PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm, PetscContainer *);
1733: PETSC_EXTERN PetscErrorCode PetscContainerSetCtxDestroy(PetscContainer, PetscCtxDestroyFn *);
1734: PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 23, 0, "PetscContainerSetCtxDestroy()", ) PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void *));
1735: PETSC_EXTERN PetscErrorCode PetscObjectContainerCompose(PetscObject, const char *name, void *, PetscCtxDestroyFn *);
1736: PETSC_EXTERN PetscErrorCode PetscObjectContainerQuery(PetscObject, const char *, PeCtx);

1738: PETSC_DEPRECATED_FUNCTION(3, 23, 0, "PetscCtxDestroyDefault()", ) static inline PetscErrorCode PetscContainerCtxDestroyDefault(void **a)
1739: {
1740:   return PetscCtxDestroyDefault(a);
1741: }

1743: /*
1744:    For use in debuggers
1745: */
1746: PETSC_EXTERN PetscMPIInt    PetscGlobalRank;
1747: PETSC_EXTERN PetscMPIInt    PetscGlobalSize;
1748: PETSC_EXTERN PetscErrorCode PetscIntViewNumColumns(PetscInt, PetscInt, const PetscInt[], PetscViewer);
1749: PETSC_EXTERN PetscErrorCode PetscRealViewNumColumns(PetscInt, PetscInt, const PetscReal[], PetscViewer);
1750: PETSC_EXTERN PetscErrorCode PetscScalarViewNumColumns(PetscInt, PetscInt, const PetscScalar[], PetscViewer);
1751: PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt, const PetscInt[], PetscViewer);
1752: PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt, const PetscReal[], PetscViewer);
1753: PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt, const PetscScalar[], PetscViewer);

1755: /*
1756:     Basic memory and string operations. These are usually simple wrappers
1757:    around the basic Unix system calls, but a few of them have additional
1758:    functionality and/or error checking.
1759: */
1760: #include <petscstring.h>

1762: #include <stddef.h>
1763: #include <stdlib.h>

1765: #if defined(PETSC_CLANG_STATIC_ANALYZER)
1766:   #define PetscPrefetchBlock(a, b, c, d)
1767: #else
1768:   /*MC
1769:    PetscPrefetchBlock - Prefetches a block of memory

1771:    Synopsis:
1772: #include <petscsys.h>
1773:     void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t)

1775:    Not Collective

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

1783:    Level: developer

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

1788:    Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality.  Not all architectures offer
1789:    equivalent locality hints, but the following macros are always defined to their closest analogue.
1790: +  `PETSC_PREFETCH_HINT_NTA` - Non-temporal.  Prefetches directly to L1, evicts to memory (skips higher level cache unless it was already there when prefetched).
1791: .  `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.
1792: .  `PETSC_PREFETCH_HINT_T1`  - Fetch to level 2 and higher (not L1).
1793: -  `PETSC_PREFETCH_HINT_T2`  - Fetch to high-level cache only.  (On many systems, T0 and T1 are equivalent.)

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

1798: M*/
1799:   #define PetscPrefetchBlock(a, n, rw, t) \
1800:     do { \
1801:       const char *_p = (const char *)(a), *_end = (const char *)((a) + (n)); \
1802:       for (; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p, (rw), (t)); \
1803:     } while (0)
1804: #endif
1805: /*
1806:       Determine if some of the kernel computation routines use
1807:    Fortran (rather than C) for the numerical calculations. On some machines
1808:    and compilers (like complex numbers) the Fortran version of the routines
1809:    is faster than the C/C++ versions. The flag --with-fortran-kernels
1810:    should be used with ./configure to turn these on.
1811: */
1812: #if defined(PETSC_USE_FORTRAN_KERNELS)

1814:   #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL)
1815:     #define PETSC_USE_FORTRAN_KERNEL_MULTCRL
1816:   #endif

1818:   #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
1819:     #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
1820:   #endif

1822:   #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
1823:     #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
1824:   #endif

1826:   #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
1827:     #define PETSC_USE_FORTRAN_KERNEL_MAXPY
1828:   #endif

1830:   #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
1831:     #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
1832:   #endif

1834:   #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
1835:     #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
1836:   #endif

1838:   #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
1839:     #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
1840:   #endif

1842:   #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
1843:     #define PETSC_USE_FORTRAN_KERNEL_MDOT
1844:   #endif

1846:   #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
1847:     #define PETSC_USE_FORTRAN_KERNEL_XTIMESY
1848:   #endif

1850:   #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX)
1851:     #define PETSC_USE_FORTRAN_KERNEL_AYPX
1852:   #endif

1854:   #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY)
1855:     #define PETSC_USE_FORTRAN_KERNEL_WAXPY
1856:   #endif

1858: #endif

1860: /*
1861:     Macros for indicating code that should be compiled with a C interface,
1862:    rather than a C++ interface. Any routines that are dynamically loaded
1863:    (such as the PCCreate_XXX() routines) must be wrapped so that the name
1864:    mangler does not change the functions symbol name. This just hides the
1865:    ugly extern "C" {} wrappers.
1866: */
1867: #if defined(__cplusplus)
1868:   #define EXTERN_C_BEGIN extern "C" {
1869:   #define EXTERN_C_END   }
1870: #else
1871:   #define EXTERN_C_BEGIN
1872:   #define EXTERN_C_END
1873: #endif

1875: /*MC
1876:    MPI_Comm - the basic object used by MPI to determine which processes are involved in a
1877:    communication

1879:    Level: beginner

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

1884: .seealso: `PETSC_COMM_WORLD`, `PETSC_COMM_SELF`
1885: M*/

1887: #if defined(PETSC_HAVE_MPIIO)
1888: PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File, void *, PetscMPIInt, MPI_Datatype, MPI_Status *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(2, 4);
1889: PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File, void *, PetscMPIInt, MPI_Datatype, MPI_Status *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(2, 4);
1890: 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);
1891: 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);
1892: 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);
1893: 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);
1894: #endif

1896: #if defined(PETSC_HAVE_MPI_COUNT)
1897: typedef MPI_Count MPIU_Count;
1898: #else
1899: typedef PetscInt64 MPIU_Count;
1900: #endif

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

1906:    Not Collective; No Fortran Support

1908:    Input Parameter:
1909: .  a - the `PetscInt64` value

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

1914:    Level: advanced

1916:    Note:
1917:    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

1919: .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscMPIIntCast()`, `PetscBLASIntCast()`, `PetscCIntCast()`, `PetscIntMultError()`, `PetscIntSumError()`
1920: @*/
1921: static inline PetscErrorCode PetscIntCast(MPIU_Count a, PetscInt *b)
1922: {
1923:   PetscFunctionBegin;
1924:   if (b) *b = 0; /* to prevent compilers erroneously suggesting uninitialized variable */
1925:   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);
1926:   if (b) *b = (PetscInt)a;
1927:   PetscFunctionReturn(PETSC_SUCCESS);
1928: }

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

1934:    Not Collective; No Fortran Support

1936:    Input Parameter:
1937: .  a - the `PetscInt` value

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

1942:    Level: advanced

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

1947: .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscMPIIntCast()`, `PetscCIntCast()`, `PetscIntCast()`
1948: @*/
1949: static inline PetscErrorCode PetscBLASIntCast(MPIU_Count a, PetscBLASInt *b)
1950: {
1951:   PetscFunctionBegin;
1952:   if (b) *b = 0; /* to prevent compilers erroneously suggesting uninitialized variable */
1953:   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);
1954:   PetscCheck(a >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Passing negative integer to BLAS/LAPACK routine");
1955:   if (b) *b = (PetscBLASInt)a;
1956:   PetscFunctionReturn(PETSC_SUCCESS);
1957: }

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

1962:    Not Collective; No Fortran Support

1964:    Input Parameter:
1965: .  a - the `PetscInt` value

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

1970:    Level: advanced

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

1975: .seealso: `PetscCuBLASInt`, `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscMPIIntCast()`, `PetscCIntCast()`, `PetscIntCast()`
1976: @*/
1977: static inline PetscErrorCode PetscCuBLASIntCast(MPIU_Count a, PetscCuBLASInt *b)
1978: {
1979:   PetscFunctionBegin;
1980:   if (b) *b = 0; /* to prevent compilers erroneously suggesting uninitialized variable */
1981:   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);
1982:   PetscCheck(a >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Passing negative integer %" PetscInt64_FMT "to cuBLAS routine", (PetscInt64)a);
1983:   if (b) *b = (PetscCuBLASInt)a;
1984:   PetscFunctionReturn(PETSC_SUCCESS);
1985: }

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

1990:    Not Collective; No Fortran Support

1992:    Input Parameter:
1993: .  a - the `PetscInt` value

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

1998:    Level: advanced

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

2003: .seealso: `PetscHipBLASInt`, `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscMPIIntCast()`, `PetscCIntCast()`, `PetscIntCast()`
2004: @*/
2005: static inline PetscErrorCode PetscHipBLASIntCast(MPIU_Count a, PetscHipBLASInt *b)
2006: {
2007:   PetscFunctionBegin;
2008:   if (b) *b = 0; /* to prevent compilers erroneously suggesting uninitialized variable */
2009:   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);
2010:   PetscCheck(a >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Passing negative integer %" PetscInt64_FMT "to hipBLAS routine", (PetscInt64)a);
2011:   if (b) *b = (PetscHipBLASInt)a;
2012:   PetscFunctionReturn(PETSC_SUCCESS);
2013: }

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

2019:    Not Collective; No Fortran Support

2021:    Input Parameter:
2022: .  a - the `PetscInt` value

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

2027:    Level: advanced

2029: .seealso: [](stylePetscCount), `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscIntCast()`
2030: @*/
2031: static inline PetscErrorCode PetscMPIIntCast(MPIU_Count a, PetscMPIInt *b)
2032: {
2033:   PetscFunctionBegin;
2034:   if (b) *b = 0; /* to prevent compilers erroneously suggesting uninitialized variable */
2035:   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);
2036:   if (b) *b = (PetscMPIInt)a;
2037:   PetscFunctionReturn(PETSC_SUCCESS);
2038: }

2040: /*@C
2041:    PetscCIntCast - casts a `MPI_Count`, `PetscInt`, `PetscCount`, or `PetscInt64` to a `int`, generates an error if the `int` is not large enough to hold the number.

2043:    Not Collective; No Fortran Support

2045:    Input Parameter:
2046: .  a - the `PetscInt` value

2048:    Output Parameter:
2049: .  b - the resulting `int` value, or `NULL` if the result is not needed

2051:    Level: advanced

2053: .seealso: [](stylePetscCount), `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscMPIIntCast()`, `PetscBLASIntCast()`, `PetscIntCast()`
2054: @*/
2055: static inline PetscErrorCode PetscCIntCast(MPIU_Count a, int *b)
2056: {
2057:   PetscFunctionBegin;
2058:   if (b) *b = 0; /* to prevent compilers erroneously suggesting uninitialized variable */
2059:   PetscCheck(a <= INT_MAX && a >= INT_MIN, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%" PetscInt64_FMT " is too big to be casted to an int. Maximum supported value is %d", (PetscInt64)a, INT_MAX);
2060:   if (b) *b = (int)a;
2061:   PetscFunctionReturn(PETSC_SUCCESS);
2062: }

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

2067:    Not Collective; No Fortran Support

2069:    Input Parameters:
2070: +  a - the first variable
2071: -  b - the second variable

2073:    Level: advanced

2075: .seealso: [](stylePetscCount), `PetscIntMultError()`, `PetscIntMultTruncate()`
2076: M*/
2077: #if defined(PETSC_USE_64BIT_INDICES)
2078:   #define PetscInt64Mult(a, b) ((a) * (b))
2079: #else
2080:   #define PetscInt64Mult(a, b) (((PetscInt64)(a)) * ((PetscInt64)(b)))
2081: #endif

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

2087:   Not Collective; No Fortran Support

2089:   Input Parameters:
2090: + a - The `PetscReal` value
2091: - b - The `PetscInt` value

2093:   Level: advanced

2095:   Notes:
2096:   Returns the result as a `PetscInt` value.

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

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

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

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

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

2113: .seealso: `PetscReal`, `PetscInt`, `PetscInt64Mult()`, `PetscIntMultError()`, `PetscIntSumError()`
2114: @*/
2115: static inline PetscInt PetscRealIntMultTruncate(PetscReal a, PetscInt b)
2116: {
2117:   PetscInt64 r = (PetscInt64)(a * (PetscReal)b);
2118:   if (r > PETSC_INT_MAX - 100) r = PETSC_INT_MAX - 100;
2119: #if defined(PETSC_USE_64BIT_INDICES)
2120:   return r;
2121: #else
2122:   return (PetscInt)r;
2123: #endif
2124: }

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

2129:    Not Collective; No Fortran Support

2131:    Input Parameters:
2132: +  a - the `PetscInt` value
2133: -  b - the second value

2135:    Returns:
2136:    The result as a `PetscInt` value

2138:    Level: advanced

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

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

2145:    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`

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

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

2152: .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscInt64Mult()`, `PetscIntMultError()`, `PetscIntSumError()`,
2153:           `PetscIntSumTruncate()`
2154: @*/
2155: static inline PetscInt PetscIntMultTruncate(PetscInt a, PetscInt b)
2156: {
2157:   PetscInt64 r = PetscInt64Mult(a, b);
2158:   if (r > PETSC_INT_MAX - 100) r = PETSC_INT_MAX - 100;
2159: #if defined(PETSC_USE_64BIT_INDICES)
2160:   return r;
2161: #else
2162:   return (PetscInt)r;
2163: #endif
2164: }

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

2169:    Not Collective; No Fortran Support

2171:    Input Parameters:
2172: +  a - the `PetscInt` value
2173: -  b - the second value

2175:    Returns:
2176:    The result as a `PetscInt` value

2178:    Level: advanced

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

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

2185:    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`

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

2190: .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscInt64Mult()`, `PetscIntMultError()`
2191: @*/
2192: static inline PetscInt PetscIntSumTruncate(PetscInt a, PetscInt b)
2193: {
2194:   PetscInt64 r = a;

2196:   r += b;
2197:   if (r > PETSC_INT_MAX - 100) r = PETSC_INT_MAX - 100;
2198: #if defined(PETSC_USE_64BIT_INDICES)
2199:   return r;
2200: #else
2201:   return (PetscInt)r;
2202: #endif
2203: }

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

2208:    Not Collective; No Fortran Support

2210:    Input Parameters:
2211: +  a - the `PetscInt` value
2212: -  b - the second value

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

2217:    Level: advanced

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

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

2224:    Developer Note:
2225:    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.
2226:    `PetscIntSumError()` can be used to check for this situation.

2228: .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscInt64Mult()`, `PetscIntSumError()`
2229: @*/
2230: static inline PetscErrorCode PetscIntMultError(PetscInt a, PetscInt b, PetscInt *result)
2231: {
2232:   PetscInt64 r = PetscInt64Mult(a, b);

2234:   PetscFunctionBegin;
2235: #if defined(PETSC_USE_64BIT_INDICES)
2236:   if (result) *result = r;
2237: #else
2238:   if (result) *result = (PetscInt)r;
2239: #endif
2240:   if (!PetscDefined(USE_64BIT_INDICES)) {
2241:     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);
2242:   }
2243:   PetscFunctionReturn(PETSC_SUCCESS);
2244: }

2246: /*@C

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

2250:    Not Collective; No Fortran Support

2252:    Input Parameters:
2253: +  a - the `PetscInt` value
2254: -  b - the second value

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

2259:    Level: advanced

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

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

2266: .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscInt64Mult()`, `PetscIntMultError()`
2267: @*/
2268: static inline PetscErrorCode PetscIntSumError(PetscInt a, PetscInt b, PetscInt *result)
2269: {
2270:   PetscInt64 r = a;

2272:   PetscFunctionBegin;
2273:   r += b;
2274: #if defined(PETSC_USE_64BIT_INDICES)
2275:   if (result) *result = r;
2276: #else
2277:   if (result) *result = (PetscInt)r;
2278: #endif
2279:   if (!PetscDefined(USE_64BIT_INDICES)) {
2280:     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);
2281:   }
2282:   PetscFunctionReturn(PETSC_SUCCESS);
2283: }

2285: /*
2286:      The IBM include files define hz, here we hide it so that it may be used as a regular user variable.
2287: */
2288: #if defined(hz)
2289:   #undef hz
2290: #endif

2292: #if defined(PETSC_HAVE_SYS_TYPES_H)
2293:   #include <sys/types.h>
2294: #endif

2296: /*MC

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

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

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

2305:     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
2306:     where only a change in the major version number (x) indicates a change in the API.

2308:     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

2310:     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),
2311:     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
2312:     version number (x.y.z).

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

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

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

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

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

2324:     Level: intermediate
2325: M*/

2327: PETSC_EXTERN PetscErrorCode PetscGetArchType(char[], size_t);
2328: PETSC_EXTERN PetscErrorCode PetscGetHostName(char[], size_t);
2329: PETSC_EXTERN PetscErrorCode PetscGetUserName(char[], size_t);
2330: PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[], size_t);
2331: PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]);
2332: PETSC_EXTERN PetscErrorCode PetscGetDate(char[], size_t);
2333: PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t);
2334: PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt *, PetscInt *, PetscInt *, PetscInt *);

2336: PETSC_EXTERN PetscErrorCode PetscSortedInt(PetscCount, const PetscInt[], PetscBool *);
2337: PETSC_EXTERN PetscErrorCode PetscSortedInt64(PetscCount, const PetscInt64[], PetscBool *);
2338: PETSC_EXTERN PetscErrorCode PetscSortedMPIInt(PetscCount, const PetscMPIInt[], PetscBool *);
2339: PETSC_EXTERN PetscErrorCode PetscSortedReal(PetscCount, const PetscReal[], PetscBool *);
2340: PETSC_EXTERN PetscErrorCode PetscSortInt(PetscCount, PetscInt[]);
2341: PETSC_EXTERN PetscErrorCode PetscSortInt64(PetscCount, PetscInt64[]);
2342: PETSC_EXTERN PetscErrorCode PetscSortCount(PetscCount, PetscCount[]);
2343: PETSC_EXTERN PetscErrorCode PetscSortReverseInt(PetscCount, PetscInt[]);
2344: PETSC_EXTERN PetscErrorCode PetscSortedRemoveDupsInt(PetscInt *, PetscInt[]);
2345: PETSC_EXTERN PetscErrorCode PetscSortedCheckDupsInt(PetscCount, const PetscInt[], PetscBool *);
2346: PETSC_EXTERN PetscErrorCode PetscSortedCheckDupsCount(PetscCount, const PetscCount[], PetscBool *);
2347: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt *, PetscInt[]);
2348: PETSC_EXTERN PetscErrorCode PetscCheckDupsInt(PetscInt, const PetscInt[], PetscBool *);
2349: PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscCount, const PetscInt[], PetscInt *);
2350: PETSC_EXTERN PetscErrorCode PetscFindMPIInt(PetscMPIInt, PetscCount, const PetscMPIInt[], PetscInt *);
2351: PETSC_EXTERN PetscErrorCode PetscFindCount(PetscCount, PetscCount, const PetscCount[], PetscCount *);
2352: PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt, const PetscInt[], PetscInt[]);
2353: PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt, const char *[], PetscInt[]);
2354: PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscCount, PetscInt[], PetscInt[]);
2355: PETSC_EXTERN PetscErrorCode PetscSortIntWithCountArray(PetscCount, PetscInt[], PetscCount[]);
2356: PETSC_EXTERN PetscErrorCode PetscSortIntWithMPIIntArray(PetscCount, PetscInt[], PetscMPIInt[]);
2357: PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscCount, PetscInt[], PetscInt[], PetscInt[]);
2358: PETSC_EXTERN PetscErrorCode PetscSortIntWithIntCountArrayPair(PetscCount, PetscInt[], PetscInt[], PetscCount[]);
2359: PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscCount, PetscMPIInt[]);
2360: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt *, PetscMPIInt[]);
2361: PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscCount, PetscMPIInt[], PetscMPIInt[]);
2362: PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithIntArray(PetscCount, PetscMPIInt[], PetscInt[]);
2363: PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscCount, PetscInt[], PetscScalar[]);
2364: PETSC_EXTERN PetscErrorCode PetscSortIntWithDataArray(PetscCount, PetscInt[], void *, size_t, void *);
2365: PETSC_EXTERN PetscErrorCode PetscSortReal(PetscCount, PetscReal[]);
2366: PETSC_EXTERN PetscErrorCode PetscSortRealWithArrayInt(PetscCount, PetscReal[], PetscInt[]);
2367: PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt, const PetscReal[], PetscInt[]);
2368: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt *, PetscReal[]);
2369: PETSC_EXTERN PetscErrorCode PetscFindReal(PetscReal, PetscCount, const PetscReal[], PetscReal, PetscInt *);
2370: PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt, PetscInt, PetscScalar[], PetscInt[]);
2371: PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt, PetscInt, PetscReal[], PetscInt[]);
2372: PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt, const PetscBool[], const PetscInt[], PetscInt *, PetscInt *[], PetscInt *[], PetscInt *[], PetscInt *[]);
2373: PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt, const PetscInt[], const PetscInt[], PetscInt, const PetscInt[], const PetscInt[], PetscInt *, PetscInt *[], PetscInt *[]);
2374: PETSC_EXTERN PetscErrorCode PetscMergeIntArray(PetscInt, const PetscInt[], PetscInt, const PetscInt[], PetscInt *, PetscInt *[]);
2375: PETSC_EXTERN PetscErrorCode PetscMergeMPIIntArray(PetscInt, const PetscMPIInt[], PetscInt, const PetscMPIInt[], PetscInt *, PetscMPIInt *[]);
2376: PETSC_EXTERN PetscErrorCode PetscParallelSortedInt(MPI_Comm, PetscInt, const PetscInt[], PetscBool *);

2378: PETSC_EXTERN PetscErrorCode PetscTimSort(PetscInt, void *, size_t, int (*)(const void *, const void *, void *), void *);
2379: PETSC_EXTERN PetscErrorCode PetscIntSortSemiOrdered(PetscInt, PetscInt[]);
2380: PETSC_EXTERN PetscErrorCode PetscMPIIntSortSemiOrdered(PetscInt, PetscMPIInt[]);
2381: PETSC_EXTERN PetscErrorCode PetscRealSortSemiOrdered(PetscInt, PetscReal[]);
2382: PETSC_EXTERN PetscErrorCode PetscTimSortWithArray(PetscInt, void *, size_t, void *, size_t, int (*)(const void *, const void *, void *), void *);
2383: PETSC_EXTERN PetscErrorCode PetscIntSortSemiOrderedWithArray(PetscInt, PetscInt[], PetscInt[]);
2384: PETSC_EXTERN PetscErrorCode PetscMPIIntSortSemiOrderedWithArray(PetscInt, PetscMPIInt[], PetscMPIInt[]);
2385: PETSC_EXTERN PetscErrorCode PetscRealSortSemiOrderedWithArrayInt(PetscInt, PetscReal[], PetscInt[]);

2387: PETSC_EXTERN PetscErrorCode PetscSetDisplay(void);
2388: PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[], size_t);

2390: /*J
2391:     PetscRandomType - String with the name of a PETSc randomizer

2393:    Level: beginner

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

2399: .seealso: `PetscRandomSetType()`, `PetscRandom`, `PetscRandomCreate()`
2400: J*/
2401: typedef const char *PetscRandomType;
2402: #define PETSCRAND      "rand"
2403: #define PETSCRAND48    "rand48"
2404: #define PETSCSPRNG     "sprng"
2405: #define PETSCRANDER48  "rander48"
2406: #define PETSCRANDOM123 "random123"
2407: #define PETSCCURAND    "curand"

2409: /* Logging support */
2410: PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID;

2412: PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void);
2413: PETSC_EXTERN PetscErrorCode PetscRandomFinalizePackage(void);

2415: /* Dynamic creation and loading functions */
2416: PETSC_EXTERN PetscFunctionList PetscRandomList;

2418: PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[], PetscErrorCode (*)(PetscRandom));
2419: PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType);
2420: PETSC_EXTERN PetscErrorCode PetscRandomSetOptionsPrefix(PetscRandom, const char[]);
2421: PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom);
2422: PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType *);
2423: PETSC_EXTERN PetscErrorCode PetscRandomViewFromOptions(PetscRandom, PetscObject, const char[]);
2424: PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom, PetscViewer);

2426: PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm, PetscRandom *);
2427: PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom, PetscScalar *);
2428: PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom, PetscReal *);
2429: PETSC_EXTERN PetscErrorCode PetscRandomGetValues(PetscRandom, PetscInt, PetscScalar *);
2430: PETSC_EXTERN PetscErrorCode PetscRandomGetValuesReal(PetscRandom, PetscInt, PetscReal *);
2431: PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom, PetscScalar *, PetscScalar *);
2432: PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom, PetscScalar, PetscScalar);
2433: PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom, PetscInt64);
2434: PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom, PetscInt64 *);
2435: PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom);
2436: PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom *);

2438: PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[], char[], size_t);
2439: PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[], char[], size_t);
2440: PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[], size_t);
2441: PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[], char[]);
2442: PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[], size_t);
2443: PETSC_EXTERN PetscErrorCode PetscTestFile(const char[], char, PetscBool *);
2444: PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[], char, PetscBool *);
2445: PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]);
2446: PETSC_EXTERN PetscErrorCode PetscMkdtemp(char[]);
2447: PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]);

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

2452:    Synopsis:
2453: #include <petscsys.h>
2454:    PetscBool PetscBinaryBigEndian(void);

2456:    No Fortran Support

2458:    Level: developer

2460: .seealso: `PetscInitialize()`, `PetscFinalize()`, `PetscInitializeCalled`
2461: M*/
2462: static inline PetscBool PetscBinaryBigEndian(void)
2463: {
2464:   long _petsc_v = 1;
2465:   return ((char *)&_petsc_v)[0] ? PETSC_FALSE : PETSC_TRUE;
2466: }

2468: PETSC_EXTERN PetscErrorCode PetscBinaryRead(int, void *, PetscCount, PetscInt *, PetscDataType);
2469: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm, int, void *, PetscInt, PetscInt *, PetscDataType);
2470: PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int, const void *, PetscCount, PetscDataType);
2471: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm, int, const void *, PetscInt, PetscDataType);
2472: PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[], PetscFileMode, int *);
2473: PETSC_EXTERN PetscErrorCode PetscBinaryClose(int);
2474: PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm, PetscBool *);
2475: PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm, PetscBool *);
2476: PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm, char[], size_t);
2477: PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm, const char[], char[], size_t, PetscBool *);
2478: PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm, const char[], char[], size_t, PetscBool *);
2479: #if defined(PETSC_USE_SOCKET_VIEWER)
2480: PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[], int, int *);
2481: #endif

2483: PETSC_EXTERN PetscErrorCode PetscBinarySeek(int, off_t, PetscBinarySeekType, off_t *);
2484: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm, int, off_t, PetscBinarySeekType, off_t *);
2485: PETSC_EXTERN PetscErrorCode PetscByteSwap(void *, PetscDataType, PetscCount);

2487: PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]);
2488: PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[], PetscBool);
2489: PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void);
2490: PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char *);
2491: PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void);
2492: PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void);
2493: PETSC_EXTERN PetscErrorCode PetscWaitOnError(void);

2495: PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm, const PetscMPIInt[], const PetscMPIInt[], PetscMPIInt *);
2496: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm, PetscMPIInt, PetscMPIInt, const PetscMPIInt[], PetscMPIInt *[], PetscMPIInt *[]);
2497: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm, PetscMPIInt, PetscMPIInt, const PetscMPIInt[], const PetscMPIInt[], PetscMPIInt *[], PetscMPIInt *[], PetscMPIInt *[]);
2498: PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm, PetscMPIInt, PetscMPIInt, const PetscMPIInt[], const PetscMPIInt[], PetscInt ***, MPI_Request **);
2499: PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm, PetscMPIInt, PetscMPIInt, const PetscMPIInt[], const PetscMPIInt[], PetscScalar ***, MPI_Request **);
2500: 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);
2501: 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);
2502: 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);

2504: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm, PetscBuildTwoSidedType);
2505: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm, PetscBuildTwoSidedType *);

2507: PETSC_DEPRECATED_FUNCTION(3, 24, 0, "PetscSSEIsEnabled()", ) static inline PetscErrorCode PetscSSEIsEnabled(PETSC_UNUSED MPI_Comm comm, PetscBool *lflag, PetscBool *gflag)
2508: {
2509:   if (lflag) *lflag = PETSC_FALSE;
2510:   if (gflag) *gflag = PETSC_FALSE;
2511:   return PETSC_SUCCESS;
2512: }

2514: PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject);

2516: struct _n_PetscSubcomm {
2517:   MPI_Comm         parent;    /* parent communicator */
2518:   MPI_Comm         dupparent; /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */
2519:   MPI_Comm         child;     /* the sub-communicator */
2520:   PetscMPIInt      n;         /* num of subcommunicators under the parent communicator */
2521:   PetscMPIInt      color;     /* color of processors belong to this communicator */
2522:   PetscMPIInt     *subsize;   /* size of subcommunicator[color] */
2523:   PetscSubcommType type;
2524:   char            *subcommprefix;
2525: };

2527: static inline MPI_Comm PetscSubcommParent(PetscSubcomm scomm)
2528: {
2529:   return scomm->parent;
2530: }
2531: static inline MPI_Comm PetscSubcommChild(PetscSubcomm scomm)
2532: {
2533:   return scomm->child;
2534: }
2535: static inline MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm)
2536: {
2537:   return scomm->dupparent;
2538: }
2539: PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm, PetscSubcomm *);
2540: PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm *);
2541: PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm, PetscInt);
2542: PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm, PetscSubcommType);
2543: PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm, PetscMPIInt, PetscMPIInt);
2544: PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm, PetscViewer);
2545: PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm);
2546: PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm, const char[]);
2547: PETSC_EXTERN PetscErrorCode PetscSubcommGetParent(PetscSubcomm, MPI_Comm *);
2548: PETSC_EXTERN PetscErrorCode PetscSubcommGetContiguousParent(PetscSubcomm, MPI_Comm *);
2549: PETSC_EXTERN PetscErrorCode PetscSubcommGetChild(PetscSubcomm, MPI_Comm *);

2551: PETSC_EXTERN PetscErrorCode PetscHeapCreate(PetscInt, PetscHeap *);
2552: PETSC_EXTERN PetscErrorCode PetscHeapAdd(PetscHeap, PetscInt, PetscInt);
2553: PETSC_EXTERN PetscErrorCode PetscHeapPop(PetscHeap, PetscInt *, PetscInt *);
2554: PETSC_EXTERN PetscErrorCode PetscHeapPeek(PetscHeap, PetscInt *, PetscInt *);
2555: PETSC_EXTERN PetscErrorCode PetscHeapStash(PetscHeap, PetscInt, PetscInt);
2556: PETSC_EXTERN PetscErrorCode PetscHeapUnstash(PetscHeap);
2557: PETSC_EXTERN PetscErrorCode PetscHeapDestroy(PetscHeap *);
2558: PETSC_EXTERN PetscErrorCode PetscHeapView(PetscHeap, PetscViewer);

2560: PETSC_EXTERN PetscErrorCode PetscProcessPlacementView(PetscViewer);
2561: PETSC_EXTERN PetscErrorCode PetscShmCommGet(MPI_Comm, PetscShmComm *);
2562: PETSC_EXTERN PetscErrorCode PetscShmCommGlobalToLocal(PetscShmComm, PetscMPIInt, PetscMPIInt *);
2563: PETSC_EXTERN PetscErrorCode PetscShmCommLocalToGlobal(PetscShmComm, PetscMPIInt, PetscMPIInt *);
2564: PETSC_EXTERN PetscErrorCode PetscShmCommGetMpiShmComm(PetscShmComm, MPI_Comm *);

2566: /* routines to better support OpenMP multithreading needs of some PETSc third party libraries */
2567: PETSC_EXTERN PetscErrorCode PetscOmpCtrlCreate(MPI_Comm, PetscInt, PetscOmpCtrl *);
2568: PETSC_EXTERN PetscErrorCode PetscOmpCtrlGetOmpComms(PetscOmpCtrl, MPI_Comm *, MPI_Comm *, PetscBool *);
2569: PETSC_EXTERN PetscErrorCode PetscOmpCtrlDestroy(PetscOmpCtrl *);
2570: PETSC_EXTERN PetscErrorCode PetscOmpCtrlBarrier(PetscOmpCtrl);
2571: PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterBegin(PetscOmpCtrl);
2572: PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterEnd(PetscOmpCtrl);

2574: PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t, PetscCount, PetscSegBuffer *);
2575: PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer *);
2576: PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer, PetscCount, void *);
2577: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer, void *);
2578: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer, void *);
2579: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer, void *);
2580: PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer, PetscCount *);
2581: PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer, PetscCount);

2583: /*MC
2584:   PetscSegBufferGetInts - access an array of `PetscInt` from a `PetscSegBuffer`

2586:   Synopsis:
2587: #include <petscsys.h>
2588:   PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg, size_t count, PetscInt *PETSC_RESTRICT *slot);

2590:   No Fortran Support

2592:   Input Parameters:
2593: + seg   - `PetscSegBuffer` buffer
2594: - count - number of entries needed

2596:   Output Parameter:
2597: . buf - address of new buffer for contiguous data

2599:   Level: intermediate

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

2606: .seealso: `PetscSegBuffer`, `PetscSegBufferGet()`, `PetscInitialize()`, `PetscFinalize()`, `PetscInitializeCalled`
2607: M*/
2608: static inline PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg, PetscCount count, PetscInt *PETSC_RESTRICT *slot)
2609: {
2610:   return PetscSegBufferGet(seg, count, (void **)slot);
2611: }

2613: extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton;
2614: PETSC_EXTERN PetscErrorCode    PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted *);
2615: PETSC_EXTERN PetscErrorCode    PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted *);
2616: PETSC_EXTERN PetscErrorCode    PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted, const char *, const char *, PetscBool *);

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

2622: PETSC_EXTERN PetscSegBuffer PetscCitationsList;

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

2627:      Not Collective; No Fortran Support

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

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

2636:      Level: intermediate
2637: @*/
2638: static inline PetscErrorCode PetscCitationsRegister(const char cit[], PetscBool *set)
2639: {
2640:   size_t len;
2641:   char  *vstring;

2643:   PetscFunctionBegin;
2644:   if (set && *set) PetscFunctionReturn(PETSC_SUCCESS);
2645:   PetscCall(PetscStrlen(cit, &len));
2646:   PetscCall(PetscSegBufferGet(PetscCitationsList, (PetscCount)len, &vstring));
2647:   PetscCall(PetscArraycpy(vstring, cit, len));
2648:   if (set) *set = PETSC_TRUE;
2649:   PetscFunctionReturn(PETSC_SUCCESS);
2650: }

2652: PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm, char[], char[], size_t);
2653: PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm, const char[], char[], size_t);
2654: PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm, const char[], const char[]);

2656: PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm, char[], char[], size_t);
2657: PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm, const char[], char[], char[], size_t);
2658: PETSC_EXTERN PetscErrorCode PetscBoxUpload(MPI_Comm, const char[], const char[]);

2660: PETSC_EXTERN PetscErrorCode PetscGlobusGetTransfers(MPI_Comm, const char[], char[], size_t);
2661: PETSC_EXTERN PetscErrorCode PetscGlobusAuthorize(MPI_Comm, char[], size_t);
2662: PETSC_EXTERN PetscErrorCode PetscGlobusUpload(MPI_Comm, const char[], const char[]);

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

2667: #if !defined(PETSC_HAVE_MPI_LARGE_COUNT)
2668:   /*
2669:    Cast PetscCount <a> to PetscMPIInt <b>, where <a> is likely used for the 'count' argument in MPI routines.
2670:    It is similar to PetscMPIIntCast() except that here it returns an MPI error code.
2671: */
2672:   #define PetscMPIIntCast_Internal(a, b) \
2673:     do { \
2674:       *b = 0; \
2675:       if (PetscUnlikely(a > (MPIU_Count)PETSC_MPI_INT_MAX)) return MPI_ERR_COUNT; \
2676:       *b = (PetscMPIInt)a; \
2677:     } while (0)

2679: static inline PetscMPIInt MPIU_Get_count(MPI_Status *status, MPI_Datatype dtype, PetscCount *count)
2680: {
2681:   PetscMPIInt count2, err;

2683:   *count = 0; /* to prevent incorrect warnings of uninitialized variables */
2684:   err    = MPI_Get_count(status, dtype, &count2);
2685:   *count = count2;
2686:   return err;
2687: }

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

2693:   PetscMPIIntCast_Internal(count, &count2);
2694:   err = MPI_Send((void *)buf, count2, dtype, dest, tag, comm);
2695:   return err;
2696: }

2698: 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)
2699: {
2700:   PetscMPIInt count2, err;

2702:   PetscMPIIntCast_Internal(count, &count2);
2703:   err = MPI_Send_init((void *)buf, count2, dtype, dest, tag, comm, request);
2704:   return err;
2705: }

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

2711:   PetscMPIIntCast_Internal(count, &count2);
2712:   err = MPI_Isend((void *)buf, count2, dtype, dest, tag, comm, request);
2713:   return err;
2714: }

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

2720:   PetscMPIIntCast_Internal(count, &count2);
2721:   err = MPI_Recv((void *)buf, count2, dtype, source, tag, comm, status);
2722:   return err;
2723: }

2725: 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)
2726: {
2727:   PetscMPIInt count2, err;

2729:   PetscMPIIntCast_Internal(count, &count2);
2730:   err = MPI_Recv_init((void *)buf, count2, dtype, source, tag, comm, request);
2731:   return err;
2732: }

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

2738:   PetscMPIIntCast_Internal(count, &count2);
2739:   err = MPI_Irecv((void *)buf, count2, dtype, source, tag, comm, request);
2740:   return err;
2741: }

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

2747:   PetscMPIIntCast_Internal(count, &count2);
2748:   err = MPI_Reduce((void *)inbuf, outbuf, count2, dtype, op, root, comm);
2749:   return err;
2750: }

2752:   #if defined(PETSC_HAVE_MPI_REDUCE_LOCAL)
2753: static inline PetscMPIInt MPIU_Reduce_local(const void *inbuf, void *inoutbuf, MPIU_Count count, MPI_Datatype dtype, MPI_Op op)
2754: {
2755:   PetscMPIInt count2, err;

2757:   PetscMPIIntCast_Internal(count, &count2);
2758:   err = MPI_Reduce_local((void *)inbuf, inoutbuf, count2, dtype, op);
2759:   return err;
2760: }
2761:   #endif

2763:   #if !defined(PETSC_USE_64BIT_INDICES)
2764:     #define MPIU_Scatterv(sendbuf, sendcounts, displs, sendtype, recvbuf, recvcount, recvtype, root, comm) MPI_Scatterv(sendbuf, sendcounts, displs, sendtype, recvbuf, recvcount, recvtype, root, comm)
2765:     #define MPIU_Gatherv(sendbuf, sendcount, sendtype, recvbuf, recvcounts, displs, recvtype, root, comm)  MPI_Gatherv(sendbuf, sendcount, sendtype, recvbuf, recvcounts, displs, recvtype, root, comm)
2766:   #else
2767:     #define MPIU_Scatterv(sendbuf, sendcount, displs, sendtype, recvbuf, recvcount, recvtype, root, comm) \
2768:       ((void)PetscError(comm, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_SUP, PETSC_ERROR_INITIAL, "Must have MPI 4 support for MPI_Scatterv_c() for this functionality, upgrade your MPI"), MPI_ERR_COUNT)
2769:     #define MPIU_Gatherv(sendbuf, sendcount, sendtype, recvbuf, recvcounts, displs, recvtype, root, comm) \
2770:       ((void)PetscError(comm, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_SUP, PETSC_ERROR_INITIAL, "Must have MPI 4 support for MPI_Scatterv_c() for this functionality, upgrade your MPI"), MPI_ERR_COUNT)
2771:   #endif

2773: #else

2775:   /* on 32 bit systems MPI_Count maybe 64-bit while PetscCount is 32-bit */
2776:   #define PetscCountCast_Internal(a, b) \
2777:     do { \
2778:       *b = 0; \
2779:       if (PetscUnlikely(a > (MPI_Count)PETSC_COUNT_MAX)) return MPI_ERR_COUNT; \
2780:       *b = (PetscMPIInt)a; \
2781:     } while (0)

2783: static inline PetscMPIInt MPIU_Get_count(MPI_Status *status, MPI_Datatype dtype, PetscCount *count)
2784: {
2785:   MPI_Count   count2;
2786:   PetscMPIInt err;

2788:   *count = 0; /* to prevent incorrect warnings of uninitialized variables */
2789:   err    = MPI_Get_count_c(status, dtype, &count2);
2790:   if (err) return err;
2791:   PetscCountCast_Internal(count2, count);
2792:   return MPI_SUCCESS;
2793: }

2795:   #define MPIU_Reduce(inbuf, outbuf, count, dtype, op, root, comm)      MPI_Reduce_c(inbuf, outbuf, (MPI_Count)(count), dtype, op, root, comm)
2796:   #define MPIU_Send(buf, count, dtype, dest, tag, comm)                 MPI_Send_c(buf, (MPI_Count)(count), dtype, dest, tag, comm)
2797:   #define MPIU_Send_init(buf, count, dtype, dest, tag, comm, request)   MPI_Send_init_c(buf, (MPI_Count)(count), dtype, dest, tag, comm, request)
2798:   #define MPIU_Isend(buf, count, dtype, dest, tag, comm, request)       MPI_Isend_c(buf, (MPI_Count)(count), dtype, dest, tag, comm, request)
2799:   #define MPIU_Recv(buf, count, dtype, source, tag, comm, status)       MPI_Recv_c(buf, (MPI_Count)(count), dtype, source, tag, comm, status)
2800:   #define MPIU_Recv_init(buf, count, dtype, source, tag, comm, request) MPI_Recv_init_c(buf, (MPI_Count)(count), dtype, source, tag, comm, request)
2801:   #define MPIU_Irecv(buf, count, dtype, source, tag, comm, request)     MPI_Irecv_c(buf, (MPI_Count)(count), dtype, source, tag, comm, request)
2802:   #if defined(PETSC_HAVE_MPI_REDUCE_LOCAL)
2803:     #define MPIU_Reduce_local(inbuf, inoutbuf, count, dtype, op) MPI_Reduce_local_c(inbuf, inoutbuf, (MPI_Count)(count), dtype, op)
2804:   #endif

2806: /*MC
2807:   MPIU_Scatterv - A replacement for `MPI_Scatterv()` that can be called with `PetscInt` types when PETSc is built for either 32-bit indices or 64-bit indices.

2809:   Synopsis:
2810: #include <petscsys.h>
2811:   PetscMPIInt MPIU_Scatterv(const void *sendbuf, const PetscInt sendcounts[], const PetscInt displs[], MPI_Datatype sendtype, void *recvbuf, PetscInt recvcount, MPI_Datatype recvtype, PetscMPIInt root, MPI_Comm comm)

2813:   Collective

2815:   Input Parameters:
2816: + sendbuf    - address of send buffer
2817: . sendcounts - non-negative `PetscInt` array (of length `comm` group size) specifying the number of elements to send to each MPI process
2818: . displs     - `PetscInt` array (of length `comm` group size). Entry i specifies the displacement (relative to `sendbuf`) from which to take the outgoing data to process i
2819: . sendtype   - data type of `sendbuf` elements
2820: . recvcount  - number of elements in `recvbuf` (non-negative integer)
2821: . recvtype   - data type of `recvbuf` elements
2822: . root       - Rank of the MPI root process, which will dispatch the data to scatter
2823: - comm       - `MPI_Comm` communicator

2825:   Output Parameter:
2826: . recvbuf - the resulting scattered values on this MPI process

2828:   Level: developer

2830:   Notes:
2831:   Should be wrapped with `PetscCallMPI()` for error checking

2833:   This is different than most of the `MPIU_` wrappers in that all the count arguments are in `PetscInt`

2835: .seealso: [](stylePetscCount), `MPI_Allreduce()`, `MPIU_Gatherv()`
2836: M*/

2838:   #if !defined(PETSC_USE_64BIT_INDICES)
2839:     #define MPIU_Scatterv(sendbuf, sendcounts, displs, sendtype, recvbuf, recvcount, recvtype, root, comm) MPI_Scatterv(sendbuf, sendcounts, displs, sendtype, recvbuf, recvcount, recvtype, root, comm)
2840:     #define MPIU_Gatherv(sendbuf, sendcount, sendtype, recvbuf, recvcounts, displs, recvtype, root, comm)  MPI_Gatherv(sendbuf, sendcount, sendtype, recvbuf, recvcounts, displs, recvtype, root, comm)
2841:   #else
2842:     #define MPIU_Scatterv(sendbuf, sendcounts, displs, sendtype, recvbuf, recvcount, recvtype, root, comm) MPI_Scatterv_c(sendbuf, (const MPI_Count *)(sendcounts), (const MPI_Aint *)(displs), sendtype, recvbuf, recvcount, recvtype, root, comm)
2843:     #define MPIU_Gatherv(sendbuf, sendcount, sendtype, recvbuf, recvcounts, displs, recvtype, root, comm)  MPI_Gatherv_c(sendbuf, sendcount, sendtype, recvbuf, (const MPI_Count *)(recvcounts), (const MPI_Aint *)(displs), recvtype, root, comm)
2844:   #endif

2846: #endif

2848: PETSC_EXTERN PetscMPIInt    MPIU_Allreduce_Private(const void *, void *, MPIU_Count, MPI_Datatype, MPI_Op, MPI_Comm);
2849: PETSC_EXTERN PetscErrorCode PetscCheckAllreduceSameLineAndCount_Private(MPI_Comm, const char *, PetscMPIInt, PetscMPIInt);

2851: #if defined(PETSC_USE_DEBUG)
2852: static inline unsigned int PetscStrHash(const char *str)
2853: {
2854:   unsigned int c, hash = 5381;

2856:   while ((c = (unsigned int)*str++)) hash = ((hash << 5) + hash) + c; /* hash * 33 + c */
2857:   return hash;
2858: }
2859: #endif

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

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

2871:   Collective

2873:   Input Parameters:
2874: + a     - pointer to the input data to be reduced
2875: . count - the number of MPI data items in `a` and `b`
2876: . dtype - the MPI datatype, for example `MPI_INT`
2877: . op    - the MPI operation, for example `MPI_SUM`
2878: - comm   - the MPI communicator on which the operation occurs

2880:   Output Parameter:
2881: . b - the reduced values

2883:   Level: developer

2885:   Note:
2886:   Should be wrapped with `PetscCallMPI()` for error checking

2888: .seealso: [](stylePetscCount), `MPI_Allreduce()`
2889: M*/
2890: #if defined(PETSC_USE_DEBUG)
2891:   #define MPIU_Allreduce(a, b, count, dtype, op, comm) \
2892:     PetscMacroReturnStandard( \
2893:     PetscCall(PetscCheckAllreduceSameLineAndCount_Private((comm), __FILE__, (PetscMPIInt)__LINE__, (PetscMPIInt)(count))); \
2894:     PetscCallMPI(MPIU_Allreduce_Private((a), (b), (count), (dtype), (op), (comm)));)
2895: #else
2896:   #define MPIU_Allreduce(a, b, count, dtype, op, comm) MPIU_Allreduce_Private((a), (b), (count), (dtype), (op), (comm))
2897: #endif

2899: /* this is a vile hack */
2900: #if defined(PETSC_HAVE_NECMPI)
2901:   #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)
2902:     #define MPI_Type_free(a) (*(a) = MPI_DATATYPE_NULL, 0);
2903:   #endif
2904: #endif

2906: /*
2907:     List of external packages and queries on it
2908: */
2909: PETSC_EXTERN PetscErrorCode PetscHasExternalPackage(const char[], PetscBool *);

2911: /* this cannot go here because it may be in a different shared library */
2912: PETSC_EXTERN PetscErrorCode PCMPIServerBegin(void);
2913: PETSC_EXTERN PetscErrorCode PCMPIServerEnd(void);
2914: PETSC_EXTERN PetscBool      PCMPIServerActive;
2915: PETSC_EXTERN PetscBool      PCMPIServerInSolve;
2916: PETSC_EXTERN PetscBool      PCMPIServerUseShmget;
2917: PETSC_EXTERN PetscErrorCode PetscShmgetAllocateArray(size_t, size_t, void **);
2918: PETSC_EXTERN PetscErrorCode PetscShmgetDeallocateArray(void **);
2919: PETSC_EXTERN PetscErrorCode PetscShmgetMapAddresses(MPI_Comm, PetscInt, const void **, void **);
2920: PETSC_EXTERN PetscErrorCode PetscShmgetUnmapAddresses(PetscInt, void **);
2921: PETSC_EXTERN PetscErrorCode PetscShmgetAddressesFinalize(void);

2923: typedef struct {
2924:   PetscInt n;
2925:   void    *addr[3];
2926: } PCMPIServerAddresses;
2927: PETSC_EXTERN PetscCtxDestroyFn PCMPIServerAddressesDestroy;

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

2931: PETSC_EXTERN PetscErrorCode PetscBLASSetNumThreads(PetscInt);
2932: PETSC_EXTERN PetscErrorCode PetscBLASGetNumThreads(PetscInt *);

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

2937:    Level: beginner

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

2945: /* this is required to force PetscDevice to be visible at the system level for the Fortran interface */
2946: #include <petscdevicetypes.h>

2948: #if PetscDefined(USE_DEBUG) && !PetscDefined(HAVE_THREADSAFETY)
2949: PETSC_EXTERN PetscErrorCode PetscStackView(FILE *);
2950: #else
2951:   #define PetscStackView(file) PETSC_SUCCESS
2952: #endif