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
8
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
11
12 Level: developer
13
14 Example:
15 .vb
16 PetscErrorCode XXXX(Vec v, PeOp PetscObject obj, PeOp PetscInt *idx, PeOp PetscInt *array[])
17 .ve
18
19 Notes:
20 This is not part of the PETSc public API and should only be used in PETSc source code.
21
22 Put this in the function declaration in front of each variable that is optional
23
24 Developer Note:
25 Shortened form of PETSc optional
26
27 .seealso: `PeNS`, `PeNSS`, `PetscCtxRt`, `PetscInitialize()`
28 M*/
29 #define PeOp
30
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
33
34 Level: developer
35
36 Notes:
37 This is not part of the PETSc public API and should only be used in PETSc source code.
38
39 Put this at the end of the function declaration closing parenthesis
40
41 Developer Note:
42 Shortened form of PETSc non-standard
43
44 .seealso: `PeOp`, `PeNSS`, `PetscCtxRt`, `PetscInitialize()`
45 M*/
46 #define PeNS
47
48 /*MC
49 PeNSS - indicates a function that needs a special treatment in the C-side stub when generating the binding for other languages
50
51 Level: developer
52
53 Notes:
54 This is not part of the PETSc public API and should only be used in PETSc source code.
55
56 Put this at the end of the function declaration closing parenthesis
57
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
59
60 Developer Note:
61 Shortened form of PETSc non-standard stub
62
63 .seealso: `PeOp`, `PeNS`, `PetscCtxRt`, `PetscInitialize()`
64 M*/
65 #define PeNSS
66
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>
80
81 /* SUBMANSEC = Sys */
82
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
101
102 #include <petscsystypes.h>
103
104 /* ========================================================================== */
105
106 /*
107 Defines the interface to MPI allowing the use of all MPI functions.
108
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
126
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 #if !defined(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
175
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>
181
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
186
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", )
189
190 /*MC
191 MPIU_INT - Portable MPI datatype corresponding to `PetscInt` independent of the precision of `PetscInt`
192
193 Level: beginner
194
195 Note:
196 In MPI calls that require an MPI datatype that matches a `PetscInt` or array of `PetscInt` values, pass this value.
197
198 .seealso: `PetscReal`, `PetscScalar`, `PetscComplex`, `PetscInt`, `MPIU_COUNT`, `MPIU_REAL`, `MPIU_SCALAR`, `MPIU_COMPLEX`
199 M*/
200
201 PETSC_EXTERN MPI_Datatype MPIU_FORTRANADDR;
202
203 #if defined(PETSC_USE_64BIT_INDICES)
204 #define MPIU_INT MPIU_INT64
205 #else
206 #define MPIU_INT MPI_INT
207 #endif
208
209 /*MC
210 MPIU_COUNT - Portable MPI datatype corresponding to `PetscCount` independent of the precision of `PetscCount`
211
212 Level: beginner
213
214 Note:
215 In MPI calls that require an MPI datatype that matches a `PetscCount` or array of `PetscCount` values, pass this value.
216
217 Developer Note:
218 It seems `MPI_AINT` is unsigned so this may be the wrong choice here since `PetscCount` is signed
219
220 .seealso: `PetscReal`, `PetscScalar`, `PetscComplex`, `PetscInt`, `MPIU_INT`, `MPIU_REAL`, `MPIU_SCALAR`, `MPIU_COMPLEX`
221 M*/
222 #define MPIU_COUNT MPI_AINT
223
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);
228
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;
234
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;
240
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
248
249 /*
250 Declare extern C stuff after including external header files
251 */
252
253 PETSC_EXTERN PetscBool PETSC_RUNNING_ON_VALGRIND;
254 /*
255 Defines elementary mathematics functions and constants.
256 */
257 #include <petscmath.h>
258
259 /*MC
260 PETSC_IGNORE - same as `NULL`, means PETSc will ignore this argument
261
262 Level: beginner
263
264 Note:
265 Accepted by many PETSc functions to not set a parameter and instead use a default value
266
267 Fortran Note:
268 Use `PETSC_NULL_INTEGER`, `PETSC_NULL_SCALAR` etc
269
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
274
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
277
278 Level: beginner
279
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.
285
286 Fortran Note:
287 Use `PETSC_UNLIMITED_INTEGER` or `PETSC_UNLIMITED_REAL`.
288
289 .seealso: `PETSC_DEFAULT`, `PETSC_IGNORE`, `PETSC_DETERMINE`, `PETSC_DECIDE`
290 M*/
291
292 /*MC
293 PETSC_DECIDE - standard way of passing an integer or floating point parameter to indicate PETSc should determine an appropriate value
294
295 Level: beginner
296
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()`.
303
304 Fortran Note:
305 Use `PETSC_DECIDE_INTEGER` or `PETSC_DECIDE_REAL`.
306
307 .seealso: `PETSC_DEFAULT`, `PETSC_IGNORE`, `PETSC_DETERMINE`, `PETSC_UNLIMITED`
308 M*/
309
310 /*MC
311 PETSC_DETERMINE - standard way of passing an integer or floating point parameter to indicate PETSc should determine an appropriate value
312
313 Level: beginner
314
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.
320
321 Note:
322 Same as `PETSC_DECIDE`
323
324 Fortran Note:
325 Use `PETSC_DETERMINE_INTEGER` or `PETSC_DETERMINE_REAL`.
326
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.
330
331 .seealso: `PETSC_DECIDE`, `PETSC_DEFAULT`, `PETSC_IGNORE`, `VecSetSizes()`, `PETSC_UNLIMITED`
332 M*/
333
334 /*MC
335 PETSC_CURRENT - standard way of indicating to an object not to change the current value of the parameter in the object
336
337 Level: beginner
338
339 Note:
340 Use `PETSC_DECIDE` to use the value that was set by PETSc when the object's type was set
341
342 Fortran Note:
343 Use `PETSC_CURRENT_INTEGER` or `PETSC_CURRENT_REAL`.
344
345 .seealso: `PETSC_DECIDE`, `PETSC_IGNORE`, `PETSC_DETERMINE`, `PETSC_DEFAULT`, `PETSC_UNLIMITED`
346 M*/
347
348 /*MC
349 PETSC_DEFAULT - deprecated, see `PETSC_CURRENT` and `PETSC_DETERMINE`
350
351 Level: beginner
352
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.
355
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()`.
359
360 .seealso: `PETSC_DECIDE`, `PETSC_IGNORE`, `PETSC_DETERMINE`, `PETSC_CURRENT`, `PETSC_UNLIMITED`
361 M*/
362
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
370
371 /*MC
372 PETSC_COMM_WORLD - the equivalent of the `MPI_COMM_WORLD` communicator which represents all the processes that PETSc knows about.
373
374 Level: beginner
375
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.
381
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.
384
385 .seealso: `PETSC_COMM_SELF`
386 M*/
387 PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD;
388
389 /*MC
390 PETSC_COMM_SELF - This is always `MPI_COMM_SELF`
391
392 Level: beginner
393
394 Note:
395 Do not USE/access or set this variable before `PetscInitialize()` has been called.
396
397 .seealso: `PETSC_COMM_WORLD`
398 M*/
399 #define PETSC_COMM_SELF MPI_COMM_SELF
400
401 /*MC
402 PETSC_MPI_THREAD_REQUIRED - the required threading support used if PETSc initializes MPI with `MPI_Init_thread()`.
403
404 No Fortran Support
405
406 Level: beginner
407
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`
410
411 .seealso: `PetscInitialize()`
412 M*/
413 PETSC_EXTERN PetscMPIInt PETSC_MPI_THREAD_REQUIRED;
414
415 /*MC
416 PetscBeganMPI - indicates if PETSc initialized MPI using `MPI_Init()` during `PetscInitialize()` or if MPI was already initialized with `MPI_Init()`
417
418 Synopsis:
419 #include <petscsys.h>
420 PetscBool PetscBeganMPI;
421
422 No Fortran Support
423
424 Level: developer
425
426 Note:
427 `MPI_Init()` can never be called after `PetscInitialize()`
428
429 .seealso: `PetscInitialize()`, `PetscInitializeCalled`
430 M*/
431 PETSC_EXTERN PetscBool PetscBeganMPI;
432
433 PETSC_EXTERN PetscBool PetscErrorHandlingInitialized;
434 PETSC_EXTERN PetscBool PetscInitializeCalled;
435 PETSC_EXTERN PetscBool PetscFinalizeCalled;
436 PETSC_EXTERN PetscBool PetscViennaCLSynchronize;
437
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 *);
443
444 #if defined(PETSC_HAVE_KOKKOS)
445 PETSC_EXTERN PetscErrorCode PetscKokkosInitializeCheck(void); /* Initialize Kokkos if not yet. */
446 #endif
447
448 #if defined(PETSC_HAVE_NVSHMEM)
449 PETSC_EXTERN PetscBool PetscBeganNvshmem;
450 PETSC_EXTERN PetscBool PetscNvshmemInitialized;
451 PETSC_EXTERN PetscErrorCode PetscNvshmemFinalize(void);
452 #endif
453
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
459
460 /*MC
461 PetscMalloc - Allocates memory for use with PETSc. One should use `PetscNew()`, `PetscMalloc1()` or `PetscCalloc1()` usually instead of `PetscMalloc()`
462
463 Synopsis:
464 #include <petscsys.h>
465 PetscErrorCode PetscMalloc(size_t m,void **result)
466
467 Not Collective
468
469 Input Parameter:
470 . m - number of bytes to allocate
471
472 Output Parameter:
473 . result - memory allocated
474
475 Level: beginner
476
477 Notes:
478 Memory is always allocated at least double aligned
479
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.
482
483 Developer Note:
484 All the `PetscMallocN()` routines actually call `PetscMalloc()` behind the scenes.
485
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()`
488
489 .seealso: `PetscFree()`, `PetscNew()`, `PetscCalloc()`
490 M*/
491 #define PetscMalloc(a, b) ((*PetscTrMalloc)((a), PETSC_FALSE, __LINE__, PETSC_FUNCTION_NAME, __FILE__, (void **)(b)))
492
493 /*MC
494 PetscRealloc - Reallocates memory
495
496 Synopsis:
497 #include <petscsys.h>
498 PetscErrorCode PetscRealloc(size_t m,void **result)
499
500 Not Collective
501
502 Input Parameters:
503 + m - number of bytes to allocate
504 - result - previous memory
505
506 Output Parameter:
507 . result - new memory allocated
508
509 Level: developer
510
511 Notes:
512 `results` must have already been obtained with `PetscMalloc()`
513
514 Memory is always allocated at least double aligned
515
516 .seealso: `PetscMalloc()`, `PetscFree()`, `PetscNew()`
517 M*/
518 #define PetscRealloc(a, b) ((*PetscTrRealloc)((a), __LINE__, PETSC_FUNCTION_NAME, __FILE__, (void **)(b)))
519
520 /*MC
521 PetscAddrAlign - Rounds up an address to `PETSC_MEMALIGN` alignment
522
523 Synopsis:
524 #include <petscsys.h>
525 void *PetscAddrAlign(void *addr)
526
527 Not Collective
528
529 Input Parameter:
530 . addr - address to align (any pointer type)
531
532 Level: developer
533
534 .seealso: `PetscMallocAlign()`
535 M*/
536 #define PetscAddrAlign(a) ((void *)((((PETSC_UINTPTR_T)(a)) + (PETSC_MEMALIGN - 1)) & ~(PETSC_MEMALIGN - 1)))
537
538 /*MC
539 PetscCalloc - Allocates a cleared (zeroed) memory region aligned to `PETSC_MEMALIGN`, similar to `PetscMalloc()`
540
541 Synopsis:
542 #include <petscsys.h>
543 PetscErrorCode PetscCalloc(size_t m,void **result)
544
545 Not Collective
546
547 Input Parameter:
548 . m - number of bytes to allocate
549
550 Output Parameter:
551 . result - memory allocated
552
553 Level: beginner
554
555 Notes:
556 Memory is always allocated at least double aligned. This macro is useful in allocating memory pointed by void pointers
557
558 It is safe to allocate with an m of 0 and pass the resulting pointer to `PetscFree()`.
559
560 However, the pointer should never be dereferenced or the program will crash.
561
562 Developer Note:
563 All `PetscCallocN()` routines call `PetscCalloc()` behind the scenes.
564
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))
568
569 /*MC
570 PetscMalloc1 - Allocates an array of memory aligned to `PETSC_MEMALIGN`
571
572 Synopsis:
573 #include <petscsys.h>
574 PetscErrorCode PetscMalloc1(size_t m1,type **r1)
575
576 Not Collective
577
578 Input Parameter:
579 . m1 - number of elements to allocate (may be zero)
580
581 Output Parameter:
582 . r1 - memory allocated
583
584 Level: beginner
585
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
598
599 Does not zero the memory allocated, use `PetscCalloc1()` to obtain memory that has been zeroed.
600
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!
604
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
612
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
619
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))
623
624 /*MC
625 PetscCalloc1 - Allocates a cleared (zeroed) array of memory aligned to `PETSC_MEMALIGN`
626
627 Synopsis:
628 #include <petscsys.h>
629 PetscErrorCode PetscCalloc1(size_t m1,type **r1)
630
631 Not Collective
632
633 Input Parameter:
634 . m1 - number of elements to allocate in 1st chunk (may be zero)
635
636 Output Parameter:
637 . r1 - memory allocated
638
639 Level: beginner
640
641 Note:
642 See `PetscMalloc1()` for more details on usage.
643
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))
647
648 /*MC
649 PetscMalloc2 - Allocates 2 arrays of memory both aligned to `PETSC_MEMALIGN`
650
651 Synopsis:
652 #include <petscsys.h>
653 PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2)
654
655 Not Collective
656
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)
660
661 Output Parameters:
662 + r1 - memory allocated in first chunk
663 - r2 - memory allocated in second chunk
664
665 Level: developer
666
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))
670
671 /*MC
672 PetscCalloc2 - Allocates 2 cleared (zeroed) arrays of memory both aligned to `PETSC_MEMALIGN`
673
674 Synopsis:
675 #include <petscsys.h>
676 PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2)
677
678 Not Collective
679
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)
683
684 Output Parameters:
685 + r1 - memory allocated in first chunk
686 - r2 - memory allocated in second chunk
687
688 Level: developer
689
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))
693
694 /*MC
695 PetscMalloc3 - Allocates 3 arrays of memory, all aligned to `PETSC_MEMALIGN`
696
697 Synopsis:
698 #include <petscsys.h>
699 PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)
700
701 Not Collective
702
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)
707
708 Output Parameters:
709 + r1 - memory allocated in first chunk
710 . r2 - memory allocated in second chunk
711 - r3 - memory allocated in third chunk
712
713 Level: developer
714
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))
719
720 /*MC
721 PetscCalloc3 - Allocates 3 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN`
722
723 Synopsis:
724 #include <petscsys.h>
725 PetscErrorCode PetscCalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)
726
727 Not Collective
728
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)
733
734 Output Parameters:
735 + r1 - memory allocated in first chunk
736 . r2 - memory allocated in second chunk
737 - r3 - memory allocated in third chunk
738
739 Level: developer
740
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))
745
746 /*MC
747 PetscMalloc4 - Allocates 4 arrays of memory, all aligned to `PETSC_MEMALIGN`
748
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)
752
753 Not Collective
754
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)
760
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
766
767 Level: developer
768
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))
773
774 /*MC
775 PetscCalloc4 - Allocates 4 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN`
776
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)
780
781 Not Collective
782
783 Input Parameters:
784 + m1 - number of elements to allocate in 1st chunk (may be zero)
785 . m2 - number of elements to allocate in 2nd chunk (may be zero)
786 . m3 - number of elements to allocate in 3rd chunk (may be zero)
787 - m4 - number of elements to allocate in 4th chunk (may be zero)
788
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
794
795 Level: developer
796
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))
801
802 /*MC
803 PetscMalloc5 - Allocates 5 arrays of memory, all aligned to `PETSC_MEMALIGN`
804
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)
808
809 Not Collective
810
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)
817
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
824
825 Level: developer
826
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))
831
832 /*MC
833 PetscCalloc5 - Allocates 5 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN`
834
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)
838
839 Not Collective
840
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)
847
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
854
855 Level: developer
856
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))
861
862 /*MC
863 PetscMalloc6 - Allocates 6 arrays of memory, all aligned to `PETSC_MEMALIGN`
864
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)
868
869 Not Collective
870
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)
878
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
886
887 Level: developer
888
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))
893
894 /*MC
895 PetscCalloc6 - Allocates 6 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN`
896
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)
900
901 Not Collective
902
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)
910
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
918
919 Level: developer
920
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))
925
926 /*MC
927 PetscMalloc7 - Allocates 7 arrays of memory, all aligned to `PETSC_MEMALIGN`
928
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)
932
933 Not Collective
934
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)
943
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
952
953 Level: developer
954
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))
959
960 /*MC
961 PetscCalloc7 - Allocates 7 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN`
962
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)
966
967 Not Collective
968
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)
977
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
986
987 Level: developer
988
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))
993
994 /*MC
995 PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to `PETSC_MEMALIGN`
996
997 Synopsis:
998 #include <petscsys.h>
999 PetscErrorCode PetscNew(type **result)
1000
1001 Not Collective
1002
1003 Output Parameter:
1004 . result - memory allocated, sized to match pointer `type`
1005
1006 Level: beginner
1007
1008 Developer Note:
1009 Calls `PetscCalloc()` with the appropriate memory size obtained from `type`
1010
1011 .seealso: `PetscFree()`, `PetscMalloc()`, `PetscCall()`, `PetscCalloc1()`, `PetscMalloc1()`
1012 M*/
1013 #define PetscNew(b) PetscCalloc1(1, (b))
1014
1015 #define PetscNewLog(o, b) PETSC_DEPRECATED_MACRO(3, 18, 0, "PetscNew()", ) PetscNew(b)
1016
1017 /*MC
1018 PetscFree - Frees memory
1019
1020 Synopsis:
1021 #include <petscsys.h>
1022 PetscErrorCode PetscFree(void *memory)
1023
1024 Not Collective
1025
1026 Input Parameter:
1027 . memory - memory to free (the pointer is ALWAYS set to `NULL` upon success)
1028
1029 Level: beginner
1030
1031 Notes:
1032 Do not free memory obtained with `PetscMalloc2()`, `PetscCalloc2()` etc, they must be freed with `PetscFree2()` etc.
1033
1034 It is safe to call `PetscFree()` on a `NULL` pointer.
1035
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)))
1039
1040 /*MC
1041 PetscFree2 - Frees 2 chunks of memory obtained with `PetscMalloc2()`
1042
1043 Synopsis:
1044 #include <petscsys.h>
1045 PetscErrorCode PetscFree2(void *memory1,void *memory2)
1046
1047 Not Collective
1048
1049 Input Parameters:
1050 + memory1 - memory to free
1051 - memory2 - 2nd memory to free
1052
1053 Level: developer
1054
1055 Notes:
1056 Memory must have been obtained with `PetscMalloc2()`
1057
1058 The arguments need to be in the same order as they were in the call to `PetscMalloc2()`
1059
1060 .seealso: `PetscNew()`, `PetscMalloc()`, `PetscMalloc2()`, `PetscFree()`
1061 M*/
1062 #define PetscFree2(m1, m2) PetscFreeA(2, __LINE__, PETSC_FUNCTION_NAME, __FILE__, &(m1), &(m2))
1063
1064 /*MC
1065 PetscFree3 - Frees 3 chunks of memory obtained with `PetscMalloc3()`
1066
1067 Synopsis:
1068 #include <petscsys.h>
1069 PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3)
1070
1071 Not Collective
1072
1073 Input Parameters:
1074 + memory1 - memory to free
1075 . memory2 - 2nd memory to free
1076 - memory3 - 3rd memory to free
1077
1078 Level: developer
1079
1080 Notes:
1081 Memory must have been obtained with `PetscMalloc3()`
1082
1083 The arguments need to be in the same order as they were in the call to `PetscMalloc3()`
1084
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))
1088
1089 /*MC
1090 PetscFree4 - Frees 4 chunks of memory obtained with `PetscMalloc4()`
1091
1092 Synopsis:
1093 #include <petscsys.h>
1094 PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4)
1095
1096 Not Collective
1097
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
1103
1104 Level: developer
1105
1106 Notes:
1107 Memory must have been obtained with `PetscMalloc4()`
1108
1109 The arguments need to be in the same order as they were in the call to `PetscMalloc4()`
1110
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))
1114
1115 /*MC
1116 PetscFree5 - Frees 5 chunks of memory obtained with `PetscMalloc5()`
1117
1118 Synopsis:
1119 #include <petscsys.h>
1120 PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5)
1121
1122 Not Collective
1123
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
1130
1131 Level: developer
1132
1133 Notes:
1134 Memory must have been obtained with `PetscMalloc5()`
1135
1136 The arguments need to be in the same order as they were in the call to `PetscMalloc5()`
1137
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))
1141
1142 /*MC
1143 PetscFree6 - Frees 6 chunks of memory obtained with `PetscMalloc6()`
1144
1145 Synopsis:
1146 #include <petscsys.h>
1147 PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6)
1148
1149 Not Collective
1150
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
1158
1159 Level: developer
1160
1161 Notes:
1162 Memory must have been obtained with `PetscMalloc6()`
1163
1164 The arguments need to be in the same order as they were in the call to `PetscMalloc6()`
1165
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))
1169
1170 /*MC
1171 PetscFree7 - Frees 7 chunks of memory obtained with `PetscMalloc7()`
1172
1173 Synopsis:
1174 #include <petscsys.h>
1175 PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7)
1176
1177 Not Collective
1178
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
1187
1188 Level: developer
1189
1190 Notes:
1191 Memory must have been obtained with `PetscMalloc7()`
1192
1193 The arguments need to be in the same order as they were in the call to `PetscMalloc7()`
1194
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))
1199
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);
1208
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
1222
1223 #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE
1224 #define MPIU_2PETSCLOGDOUBLE MPI_2DOUBLE_PRECISION
1225
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 *);
1242
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 *);
1247
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 *);
1263
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`.
1268
1269 Level: advanced
1270
1271 Developer Note:
1272 This should be unified with `MPIU_SUM`
1273
1274 .seealso: `MPIU_REAL`, `MPIU_SCALAR`, `MPIU_COMPLEX`
1275 M*/
1276 PETSC_EXTERN MPI_Op MPIU_SUM___FP16___FLOAT128;
1277 #endif
1278
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 */
1283
1284 /*S
1285 PetscVoidFn - A prototype of a `void fn(void)` function
1286
1287 Level: advanced
1288
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.
1292
1293 `PetscErrorCodeFn` is similar to `PetscVoidFn` but should be used when the function returns a `PetscErrorCode`
1294
1295 The deprecated `PetscVoidFunction` works as a replacement for `PetscVoidFn` *.
1296
1297 The deprecated `PetscVoidStarFunction` works as a replacement for `PetscVoidFn` **.
1298
1299 .seealso: `PetscErrorCodeFn`, `PetscObject`, `PetscObjectDestroy()`
1300 S*/
1301 PETSC_EXTERN_TYPEDEF typedef void PetscVoidFn(void);
1302
1303 PETSC_EXTERN_TYPEDEF typedef PetscVoidFn *PetscVoidFunction;
1304 PETSC_EXTERN_TYPEDEF typedef PetscVoidFn **PetscVoidStarFunction;
1305
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)`.
1309
1310 Level: advanced
1311
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()`.
1316
1317 `PetscVoidFn` is similar to `PetscErrorCodeFn` but should be used when the function does not return a `PetscErrorCode`.
1318
1319 The deprecated `PetscErrorCodeFunction` works as a replacement for `PetscErrorCodeFn` *.
1320
1321 Developer Notes:
1322 This function type is equivalent to `PetscVoidFn`*.
1323
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.
1326
1327 .seealso: `PetscVoidFn`, `PetscObject`, `PetscObjectDestroy()`, `VecSetOperation()`
1328 S*/
1329 PETSC_EXTERN_TYPEDEF typedef void PetscErrorCodeFn(void);
1330
1331 PETSC_EXTERN_TYPEDEF typedef PetscErrorCodeFn *PetscErrorCodeFunction;
1332
1333 /*
1334 Defines PETSc error handling.
1335 */
1336 #include <petscerror.h> // IWYU pragma: export
1337
1338 PETSC_EXTERN PetscBool PetscCIEnabled; /* code is running in the PETSc test harness CI */
1339 PETSC_EXTERN PetscBool PetscCIEnabledPortableErrorOutput; /* error output is stripped to ensure portability of error messages across systems */
1340 PETSC_EXTERN const char *PetscCIFilename(const char *);
1341 PETSC_EXTERN int PetscCILinenumber(int);
1342
1343 #define PETSC_SMALLEST_CLASSID 1211211
1344 PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID;
1345 PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID;
1346 PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[], PetscClassId *);
1347 PETSC_EXTERN PetscErrorCode PetscObjectGetId(PetscObject, PetscObjectId *);
1348 PETSC_EXTERN PetscErrorCode PetscObjectCompareId(PetscObject, PetscObjectId, PetscBool *);
1349
1350 /*
1351 Routines that get memory usage information from the OS
1352 */
1353 PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *);
1354 PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *);
1355 PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void);
1356 PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]);
1357
1358 PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal);
1359
1360 /*
1361 Initialization of PETSc
1362 */
1363 PETSC_EXTERN PetscErrorCode PetscInitialize(int *, char ***, const char[], const char[]);
1364 PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int, char *[], const char[], const char[]);
1365 PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void);
1366 PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *);
1367 PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *);
1368 PETSC_EXTERN PetscErrorCode PetscFinalize(void);
1369 PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void);
1370 PETSC_EXTERN PetscErrorCode PetscGetArgs(int *, char ***);
1371 PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***);
1372 PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **);
1373
1374 PETSC_EXTERN PetscErrorCode PetscEnd(void);
1375 PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void);
1376 PETSC_EXTERN PetscErrorCode PetscSysFinalizePackage(void);
1377
1378 PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[], const char[]);
1379 PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void);
1380 PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void);
1381 PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject, const char[]);
1382
1383 /*
1384 Functions that can act on any PETSc object.
1385 */
1386 PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject *);
1387 PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject, MPI_Comm *);
1388 PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject, PetscClassId *);
1389 PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject, const char *[]);
1390 PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject, const char *[]);
1391 PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject, const char[]);
1392 PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject, const char *[]);
1393 PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject, PetscInt);
1394 PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject, PetscInt *);
1395 PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject, PetscObject, PetscInt);
1396 PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject);
1397 PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject, PetscInt *);
1398 PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject);
1399 PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject, PetscMPIInt *);
1400 PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject, const char[], PetscObject);
1401 PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject, const char[]);
1402 PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject, const char[], PetscObject *);
1403 PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject, const char[], PetscErrorCodeFn *);
1404 #define PetscObjectComposeFunction(a, b, ...) PetscObjectComposeFunction_Private((a), (b), (PetscErrorCodeFn *)(__VA_ARGS__))
1405 PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject);
1406 PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject);
1407 PETSC_EXTERN PetscErrorCode PetscObjectSetPrintedOptions(PetscObject);
1408 PETSC_EXTERN PetscErrorCode PetscObjectInheritPrintedOptions(PetscObject, PetscObject);
1409 PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm, PetscMPIInt *);
1410
1411 /*MC
1412 PetscObjectParameterSetDefault - sets a parameter default value in a `PetscObject` to a new default value.
1413 If the current value matches the old default value, then the current value is also set to the new value.
1414
1415 No Fortran Support
1416
1417 Synopsis:
1418 #include <petscsys.h>
1419 PetscBool PetscObjectParameterSetDefault(PetscObject obj, char* NAME, PetscReal value);
1420
1421 Input Parameters:
1422 + obj - the `PetscObject`
1423 . NAME - the name of the parameter, unquoted
1424 - value - the new value
1425
1426 Level: developer
1427
1428 Notes:
1429 The defaults for an object are the values set when the object's type is set.
1430
1431 This should only be used in object constructors, such as, `SNESCreate_NGS()`.
1432
1433 This only works for parameters that are declared in the struct with `PetscObjectParameterDeclare()`
1434
1435 .seealso: `PetscObjectParameterDeclare()`, `PetscInitialize()`, `PetscFinalize()`, `PetscObject`, `SNESParametersInitialize()`
1436 M*/
1437 #define PetscObjectParameterSetDefault(obj, NAME, value) \
1438 do { \
1439 if (obj->NAME == obj->default_##NAME) obj->NAME = value; \
1440 obj->default_##NAME = value; \
1441 } while (0)
1442
1443 /*MC
1444 PetscObjectParameterDeclare - declares a parameter in a `PetscObject` and a location to store its default
1445
1446 No Fortran Support
1447
1448 Synopsis:
1449 #include <petscsys.h>
1450 PetscBool PetscObjectParameterDeclare(type, char* NAME)
1451
1452 Input Parameters:
1453 + type - the type of the parameter, for example `PetscInt`
1454 - NAME - the name of the parameter, unquoted
1455
1456 Level: developer.
1457
1458 .seealso: `PetscObjectParameterSetDefault()`, `PetscInitialize()`, `PetscFinalize()`, `PetscObject`, `SNESParametersInitialize()`
1459 M*/
1460 #define PetscObjectParameterDeclare(type, NAME) type NAME, default_##NAME
1461 #define PetscObjectParameterDeclarePtr(type, NAME) type *NAME, *default_##NAME
1462
1463 /*MC
1464 PetscCtx - indicates an argument that can be a pointer to any C struct (or Fortran derived type).
1465
1466 Level: developer
1467
1468 Notes:
1469 This should not be used for arrays of unknown type.
1470
1471 Fortran Notes:
1472 A Fortran code that calls a function with a `PetscCtx` argument would declare the variable `ctx` with
1473 .vb
1474 type(AppType) :: ctx
1475 .ve
1476 where `AppType` is a Fortran derived type. Or the argument can be a `PetscObject`.
1477
1478 Developer Note:
1479 `PetscCtx` is used instead of `void *` in PETSc code to enhance the clarity of the PETSc source code since `void *` serves so many different roles.
1480 The getAPI() code processor also uses the variable type to generate correct bindings for other languages.
1481
1482 .seealso: [](sec_fortran_context), `PetscCtxRt`, PetscCtxDestroyFn()`, `PeOp`, `PeNS`, `PetscInitialize()`, `DMGetApplicationContext()`,
1483 `DMSetApplicationContextDestroy()`
1484 M*/
1485 typedef void *PetscCtx;
1486
1487 /*MC
1488 PetscCtxRt - indicates an argument that returns a pointer to a C struct (or Fortran derived type) which is generally an application context
1489
1490 Level: developer
1491
1492 Notes:
1493 A PETSc object (in C or Fortran) can be used as a PETSc context
1494
1495 This should not be used for functions that return pointers to arrays of unknown type. Thus it is used for, for example,
1496 `KSPGetApplicationContext()` but not used for `DMNetworkGetComponent()`
1497
1498 A PETSc object (in C or Fortran) can be used as a PETSc context
1499
1500 It is also used for functions that destroy an application context. For example, the destroy function passed to `DMSetApplicationContextDestroy()`
1501 which has a prototype of `PetscCtxDestroyFn()`
1502
1503 This typedef is not part of the PETSc public API and should only be used in PETSc source code.
1504
1505 For pointers to arrays of unknown type and for functions that return PETSc internal objects that are opaque to users, such
1506 as `KSPMonitorDynamicToleranceCreate()` a `void **` should be used.
1507
1508 Fortran Notes:
1509 A Fortran code that calls a function with a `PetscCtxRt` argument must declare the variable `ctx` with
1510 .vb
1511 type(AppType), pointer :: ctx
1512 .ve
1513 where `AppType` is a Fortran derived type.
1514
1515 If one passes a PETSc function with a `PetscCtxRt` argument as an argument in Fortran one must use the function named suffixed with `Cptr`,
1516 for example `KSPConvergedDefaultDestroyCptr`, see src/ksp/ksp/tutorials/ex1f.F90.
1517
1518 Developer Notes:
1519 C++ compilers generate a warning or error if one passes a pointer to a pointer to a specific type (instead of `void`), for example,
1520 .vb
1521 extern calledfunction(void **);
1522 SomeCtx *ctx;
1523 calledfunction(&ctx); << warning that it is passing a pointer to a pointer to a SomeCtx instead of a void **
1524 .ve
1525 By using the common practice of prototyping the function as
1526 .vb
1527 extern calledfunction(void *);
1528 .ve
1529 the warning message is averted.
1530
1531 `PetscCtxRt` is used instead of `void *` in PETSc code to enhance the clarity of the PETSc source code since `void *` serves so many different roles.
1532 The getAPI() code processor also uses the variable type to generate correct bindings for other languages.
1533
1534 The Fortran C stub and Fortran interface definition generated for functions with a `PetscCtxRt` argument are the C function name suffixed with
1535 `Cptr`, for example `KSPConvergedDefaultDestroyCptr`. The Fortran user API is a macro with the original C funtion name, for example,
1536 `KSPConvergedDefaultDestroy` that calls the `KSPConvergedDefaultDestroyCptr` version and then calls `c_f_pointer()` to handle the equivalent of a `void**` cast
1537 to the users Fortran derived type argument.
1538
1539 .seealso: [](sec_fortran_context), `PetscCtx`, `PetscCtxDestroyFn()`, `PeOp`, `PeNS`, `PetscInitialize()`, `DMGetApplicationContext()`,
1540 `DMSetApplicationContextDestroy()`
1541 M*/
1542 typedef void *PetscCtxRt;
1543
1544 /*S
1545 PetscCtxDestroyFn - A prototype of a `PetscErrorCode (*)(PetscCtxRt)` function that is used to free application contexts
1546
1547 Level: intermediate
1548
1549 Notes:
1550 Used in the prototype of functions such as `DMSetApplicationContextDestroy()`
1551
1552 The function argument is a `PetscCtxRt` which is psychologically equivalent to a `void **` meaning that this function is called with a pointer to
1553 the application context (which is itself a pointer) thus the destroy implementation must first reference the context via, for example,
1554 `*(AppCtx **)arg`. Note that syntactically `PetscCtxRt` is defined as a `void *`, this is because C++ does
1555 not accept passing a pointer to a pointer to a `void**` but it does accept passing a pointer to a pointer to `void *`.
1556
1557 PETSc destroy functions take the address of the context (rather than just the context) so that that the destroy function can "zero the pointer" when
1558 appropriate, preventing accidental later use of a dangling pointer.
1559
1560 .seealso: `PetscObject`, `PetscCtxDestroyDefault()`, `PetscObjectDestroy()`, `DMSetApplicationContextDestroy()`
1561 S*/
1562 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode PetscCtxDestroyFn(PetscCtxRt);
1563
1564 PETSC_EXTERN PetscCtxDestroyFn PetscCtxDestroyDefault;
PetscContainerCtxDestroyDefault(PetscCtxRt a)1565 PETSC_DEPRECATED_FUNCTION(3, 23, 0, "PetscCtxDestroyDefault()", ) static inline PetscErrorCode PetscContainerCtxDestroyDefault(PetscCtxRt a)
1566 {
1567 return PetscCtxDestroyDefault(a);
1568 }
1569
1570 PETSC_EXTERN PetscErrorCode PetscMonitorCompare(PetscErrorCode (*)(void), void *, PetscCtxDestroyFn *, PetscErrorCode (*)(void), void *, PetscCtxDestroyFn *, PetscBool *);
1571
1572 #include <petscviewertypes.h>
1573 #include <petscoptions.h>
1574
1575 PETSC_EXTERN PetscErrorCode PetscMallocTraceSet(PetscViewer, PetscBool, PetscLogDouble);
1576 PETSC_EXTERN PetscErrorCode PetscMallocTraceGet(PetscBool *);
1577
1578 PETSC_EXTERN PetscErrorCode PetscObjectsListGetGlobalNumbering(MPI_Comm, PetscInt, PetscObject[], PetscInt *, PetscInt *);
1579
1580 PETSC_EXTERN PetscErrorCode PetscMemoryView(PetscViewer, const char[]);
1581 PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject, PetscViewer);
1582 PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject, PetscViewer);
1583 #define PetscObjectQueryFunction(obj, name, fptr) PetscObjectQueryFunction_Private((obj), (name), (PetscErrorCodeFn **)(fptr))
1584 PETSC_EXTERN PetscErrorCode PetscObjectHasFunction(PetscObject, const char[], PetscBool *);
1585 PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject, const char[], PetscErrorCodeFn **);
1586 PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject, const char[]);
1587 PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject, const char[]);
1588 PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject, const char[]);
1589 PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject, const char *[]);
1590 PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject, const char[]);
1591 PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject);
1592 PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void);
1593 PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject, PetscObject, const char[]);
1594 PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject);
1595 PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject, const char[], PetscBool *);
1596 PETSC_EXTERN PetscErrorCode PetscObjectObjectTypeCompare(PetscObject, PetscObject, PetscBool *);
1597 PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompare(PetscObject, const char[], PetscBool *);
1598 PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject, PetscBool *, const char[], ...);
1599 PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompareAny(PetscObject, PetscBool *, const char[], ...);
1600 PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void));
1601 PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void);
1602
1603 #if defined(PETSC_HAVE_SAWS)
1604 PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void);
1605 PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject);
1606 PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject, PetscBool);
1607 PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject);
1608 PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject);
1609 PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject);
1610 PETSC_EXTERN void PetscStackSAWsGrantAccess(void);
1611 PETSC_EXTERN void PetscStackSAWsTakeAccess(void);
1612 PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void);
1613 PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void);
1614
1615 #else
1616 #define PetscSAWsBlock() PETSC_SUCCESS
1617 #define PetscObjectSAWsViewOff(obj) PETSC_SUCCESS
1618 #define PetscObjectSAWsSetBlock(obj, flg) PETSC_SUCCESS
1619 #define PetscObjectSAWsBlock(obj) PETSC_SUCCESS
1620 #define PetscObjectSAWsGrantAccess(obj) PETSC_SUCCESS
1621 #define PetscObjectSAWsTakeAccess(obj) PETSC_SUCCESS
1622 #define PetscStackViewSAWs() PETSC_SUCCESS
1623 #define PetscStackSAWsViewOff() PETSC_SUCCESS
1624 #define PetscStackSAWsTakeAccess()
1625 #define PetscStackSAWsGrantAccess()
1626
1627 #endif
1628
1629 PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[], PetscDLMode, PetscDLHandle *);
1630 PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *);
1631 PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle, const char[], void **);
1632 PETSC_EXTERN PetscErrorCode PetscDLAddr(PetscVoidFn *, char *[]);
1633 PETSC_EXTERN PetscErrorCode PetscDemangleSymbol(const char *, char *[]);
1634
1635 PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void *, PetscStack **);
1636
1637 PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE *, PetscBool);
1638 PETSC_EXTERN PetscErrorCode PetscObjectsView(PetscViewer);
1639 PETSC_EXTERN PetscErrorCode PetscObjectsGetObject(const char *, PetscObject *, const char *[]);
1640 PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList *);
1641 PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList, const char[], PetscObject *);
1642 PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList, PetscObject, const char *[], PetscBool *);
1643 PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *, const char[], PetscObject);
1644 PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *, const char[]);
1645 PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList, PetscObjectList *);
1646
1647 /*
1648 Dynamic library lists. Lists of names of routines in objects or in dynamic
1649 link libraries that will be loaded as needed.
1650 */
1651
1652 #define PetscFunctionListAdd(list, name, fptr) PetscFunctionListAdd_Private((list), (name), (PetscErrorCodeFn *)(fptr))
1653 PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList *, const char[], PetscErrorCodeFn *);
1654 PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList *);
1655 PETSC_EXTERN PetscErrorCode PetscFunctionListClear(PetscFunctionList);
1656 #define PetscFunctionListFind(list, name, fptr) PetscFunctionListFind_Private((list), (name), (PetscErrorCodeFn **)(fptr))
1657 PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList, const char[], PetscErrorCodeFn **);
1658 PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm, FILE *, const char[], const char[], const char[], const char[], PetscFunctionList, const char[], const char[]);
1659 PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList, PetscFunctionList *);
1660 PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList, PetscViewer);
1661 PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList, const char ***, int *);
1662 PETSC_EXTERN PetscErrorCode PetscFunctionListPrintNonEmpty(PetscFunctionList);
1663 PETSC_EXTERN PetscErrorCode PetscFunctionListPrintAll(void);
1664
1665 PETSC_EXTERN PetscDLLibrary PetscDLLibrariesLoaded;
1666 PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm, PetscDLLibrary *, const char[]);
1667 PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm, PetscDLLibrary *, const char[]);
1668 PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm, PetscDLLibrary *, const char[], const char[], void **);
1669 PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary);
1670 PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm, const char[], char *, size_t, PetscBool *);
1671 PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm, const char[], PetscDLLibrary *);
1672 PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary);
1673
1674 /*
1675 Useful utility routines
1676 */
1677 PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm, PetscInt *, PetscInt *);
1678 PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm, PetscInt, PetscInt *, PetscInt *);
1679 PETSC_EXTERN PetscErrorCode PetscSplitOwnershipEqual(MPI_Comm, PetscInt *, PetscInt *);
1680 PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm, PetscMPIInt);
1681 PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm, PetscMPIInt);
1682 PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject);
1683 PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE *);
1684 PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxInt(MPI_Comm, const PetscInt[2], PetscInt[2]);
1685 PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxReal(MPI_Comm, const PetscReal[2], PetscReal[2]);
1686
1687 /*MC
1688 PetscNot - negates a logical type value and returns result as a `PetscBool`
1689
1690 Level: beginner
1691
1692 Note:
1693 This is useful in cases like
1694 .vb
1695 int *a;
1696 PetscBool flag = PetscNot(a)
1697 .ve
1698 where !a would not return a `PetscBool` because we cannot provide a cast from int to `PetscBool` in C.
1699
1700 .seealso: `PetscBool`, `PETSC_TRUE`, `PETSC_FALSE`
1701 M*/
1702 #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)
1703
1704 /*MC
1705 PetscHelpPrintf - Prints help messages.
1706
1707 Synopsis:
1708 #include <petscsys.h>
1709 PetscErrorCode (*PetscHelpPrintf)(MPI_Comm comm, const char format[],args);
1710
1711 Not Collective, only applies on MPI rank 0; No Fortran Support
1712
1713 Input Parameters:
1714 + comm - the MPI communicator over which the help message is printed
1715 . format - the usual printf() format string
1716 - args - arguments to be printed
1717
1718 Level: developer
1719
1720 Notes:
1721 You can change how help messages are printed by replacing the function pointer with a function that does not simply write to stdout.
1722
1723 To use, write your own function, for example,
1724 .vb
1725 PetscErrorCode mypetschelpprintf(MPI_Comm comm,const char format[],....)
1726 {
1727 PetscFunctionReturn(PETSC_SUCCESS);
1728 }
1729 .ve
1730 then do the assignment
1731 .vb
1732 PetscHelpPrintf = mypetschelpprintf;
1733 .ve
1734
1735 You can do the assignment before `PetscInitialize()`.
1736
1737 The default routine used is called `PetscHelpPrintfDefault()`.
1738
1739 .seealso: `PetscFPrintf()`, `PetscSynchronizedPrintf()`, `PetscErrorPrintf()`, `PetscHelpPrintfDefault()`
1740 M*/
1741 PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);
1742
1743 /*
1744 Defines PETSc profiling.
1745 */
1746 #include <petsclog.h>
1747
1748 /*
1749 Simple PETSc parallel IO for ASCII printing
1750 */
1751 PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[], char[]);
1752 PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm, const char[], const char[], FILE **);
1753 PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm, FILE *);
1754 PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm, FILE *, const char[], ...) PETSC_ATTRIBUTE_FORMAT(3, 4);
1755 PETSC_EXTERN PetscErrorCode PetscFFlush(FILE *);
1756 PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);
1757 PETSC_EXTERN PetscErrorCode PetscSNPrintf(char *, size_t, const char[], ...) PETSC_ATTRIBUTE_FORMAT(3, 4);
1758 PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char *, size_t, const char[], size_t *, ...) PETSC_ATTRIBUTE_FORMAT(3, 5);
1759 PETSC_EXTERN PetscErrorCode PetscFormatRealArray(char[], size_t, const char *, PetscInt, const PetscReal[]);
1760
1761 PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char[], ...) PETSC_ATTRIBUTE_FORMAT(1, 2);
1762 PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char[], ...) PETSC_ATTRIBUTE_FORMAT(1, 2);
1763 PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);
1764
1765 PETSC_EXTERN PetscErrorCode PetscFormatConvertGetSize(const char *, size_t *);
1766 PETSC_EXTERN PetscErrorCode PetscFormatConvert(const char *, char *);
1767
1768 PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm, const char[], const char[], const char[], FILE **);
1769 PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm, FILE *);
1770 PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]);
1771
1772 PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);
1773 PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm, FILE *, const char[], ...) PETSC_ATTRIBUTE_FORMAT(3, 4);
1774 PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm, FILE *);
1775 PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm, FILE *, size_t, char[]);
1776 PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm, const char[], const char[], FILE **);
1777 PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char *[]);
1778
1779 PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID;
1780 PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer, void *);
1781 PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer, void *);
1782 PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer *);
1783 PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm, PetscContainer *);
1784 PETSC_EXTERN PetscErrorCode PetscContainerSetCtxDestroy(PetscContainer, PetscCtxDestroyFn *);
1785 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 23, 0, "PetscContainerSetCtxDestroy()", ) PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void *));
1786 PETSC_EXTERN PetscErrorCode PetscObjectContainerCompose(PetscObject, const char *name, void *, PetscCtxDestroyFn *);
1787 PETSC_EXTERN PetscErrorCode PetscObjectContainerQuery(PetscObject, const char *, PetscCtxRt);
1788
1789 /*
1790 For use in debuggers
1791 */
1792 PETSC_EXTERN PetscMPIInt PetscGlobalRank;
1793 PETSC_EXTERN PetscMPIInt PetscGlobalSize;
1794 PETSC_EXTERN PetscErrorCode PetscIntViewNumColumns(PetscInt, PetscInt, const PetscInt[], PetscViewer);
1795 PETSC_EXTERN PetscErrorCode PetscRealViewNumColumns(PetscInt, PetscInt, const PetscReal[], PetscViewer);
1796 PETSC_EXTERN PetscErrorCode PetscScalarViewNumColumns(PetscInt, PetscInt, const PetscScalar[], PetscViewer);
1797 PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt, const PetscInt[], PetscViewer);
1798 PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt, const PetscReal[], PetscViewer);
1799 PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt, const PetscScalar[], PetscViewer);
1800
1801 /*
1802 Basic memory and string operations. These are usually simple wrappers
1803 around the basic Unix system calls, but a few of them have additional
1804 functionality and/or error checking.
1805 */
1806 #include <petscstring.h>
1807
1808 #include <stddef.h>
1809 #include <stdlib.h>
1810
1811 #if defined(PETSC_CLANG_STATIC_ANALYZER)
1812 #define PetscPrefetchBlock(a, b, c, d)
1813 #else
1814 /*MC
1815 PetscPrefetchBlock - Prefetches a block of memory
1816
1817 Synopsis:
1818 #include <petscsys.h>
1819 void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t)
1820
1821 Not Collective
1822
1823 Input Parameters:
1824 + a - pointer to first element to fetch (any type but usually `PetscInt` or `PetscScalar`)
1825 . n - number of elements to fetch
1826 . rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors)
1827 - t - temporal locality (PETSC_PREFETCH_HINT_{NTA,T0,T1,T2}), see note
1828
1829 Level: developer
1830
1831 Notes:
1832 The last two arguments (`rw` and `t`) must be compile-time constants.
1833
1834 Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality. Not all architectures offer
1835 equivalent locality hints, but the following macros are always defined to their closest analogue.
1836 + `PETSC_PREFETCH_HINT_NTA` - Non-temporal. Prefetches directly to L1, evicts to memory (skips higher level cache unless it was already there when prefetched).
1837 . `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.
1838 . `PETSC_PREFETCH_HINT_T1` - Fetch to level 2 and higher (not L1).
1839 - `PETSC_PREFETCH_HINT_T2` - Fetch to high-level cache only. (On many systems, T0 and T1 are equivalent.)
1840
1841 This function does nothing on architectures that do not support prefetch and never errors (even if passed an invalid
1842 address).
1843
1844 M*/
1845 #define PetscPrefetchBlock(a, n, rw, t) \
1846 do { \
1847 const char *_p = (const char *)(a), *_end = (const char *)((a) + (n)); \
1848 for (; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p, (rw), (t)); \
1849 } while (0)
1850 #endif
1851 /*
1852 Determine if some of the kernel computation routines use
1853 Fortran (rather than C) for the numerical calculations. On some machines
1854 and compilers (like complex numbers) the Fortran version of the routines
1855 is faster than the C/C++ versions. The flag --with-fortran-kernels
1856 should be used with ./configure to turn these on.
1857 */
1858 #if defined(PETSC_USE_FORTRAN_KERNELS)
1859
1860 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL)
1861 #define PETSC_USE_FORTRAN_KERNEL_MULTCRL
1862 #endif
1863
1864 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
1865 #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
1866 #endif
1867
1868 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
1869 #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
1870 #endif
1871
1872 #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
1873 #define PETSC_USE_FORTRAN_KERNEL_MAXPY
1874 #endif
1875
1876 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
1877 #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
1878 #endif
1879
1880 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
1881 #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
1882 #endif
1883
1884 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
1885 #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
1886 #endif
1887
1888 #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
1889 #define PETSC_USE_FORTRAN_KERNEL_MDOT
1890 #endif
1891
1892 #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
1893 #define PETSC_USE_FORTRAN_KERNEL_XTIMESY
1894 #endif
1895
1896 #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX)
1897 #define PETSC_USE_FORTRAN_KERNEL_AYPX
1898 #endif
1899
1900 #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY)
1901 #define PETSC_USE_FORTRAN_KERNEL_WAXPY
1902 #endif
1903
1904 #endif
1905
1906 /*
1907 Macros for indicating code that should be compiled with a C interface,
1908 rather than a C++ interface. Any routines that are dynamically loaded
1909 (such as the PCCreate_XXX() routines) must be wrapped so that the name
1910 mangler does not change the functions symbol name. This just hides the
1911 ugly extern "C" {} wrappers.
1912 */
1913 #if defined(__cplusplus)
1914 #define EXTERN_C_BEGIN extern "C" {
1915 #define EXTERN_C_END }
1916 #else
1917 #define EXTERN_C_BEGIN
1918 #define EXTERN_C_END
1919 #endif
1920
1921 /*MC
1922 MPI_Comm - the basic object used by MPI to determine which processes are involved in a
1923 communication
1924
1925 Level: beginner
1926
1927 Note:
1928 This manual page is a place-holder because MPICH does not have a manual page for `MPI_Comm`
1929
1930 .seealso: `PETSC_COMM_WORLD`, `PETSC_COMM_SELF`
1931 M*/
1932
1933 #if defined(PETSC_HAVE_MPIIO)
1934 PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File, void *, PetscMPIInt, MPI_Datatype, MPI_Status *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(2, 4);
1935 PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File, void *, PetscMPIInt, MPI_Datatype, MPI_Status *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(2, 4);
1936 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);
1937 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);
1938 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);
1939 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);
1940 #endif
1941
1942 #if defined(PETSC_HAVE_MPI_COUNT)
1943 typedef MPI_Count MPIU_Count;
1944 #else
1945 typedef PetscInt64 MPIU_Count;
1946 #endif
1947
1948 /*@C
1949 PetscIntCast - casts a `MPI_Count`, `PetscInt64`, `PetscCount`, or `size_t` to a `PetscInt` (which may be 32-bits in size), generates an
1950 error if the `PetscInt` is not large enough to hold the number.
1951
1952 Not Collective; No Fortran Support
1953
1954 Input Parameter:
1955 . a - the `PetscInt64` value
1956
1957 Output Parameter:
1958 . b - the resulting `PetscInt` value, or `NULL` if the result is not needed
1959
1960 Level: advanced
1961
1962 Note:
1963 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
1964
1965 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscMPIIntCast()`, `PetscBLASIntCast()`, `PetscCIntCast()`, `PetscIntMultError()`, `PetscIntSumError()`
1966 @*/
PetscIntCast(MPIU_Count a,PetscInt * b)1967 static inline PetscErrorCode PetscIntCast(MPIU_Count a, PetscInt *b)
1968 {
1969 PetscFunctionBegin;
1970 if (b) *b = 0; /* to prevent compilers erroneously suggesting uninitialized variable */
1971 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);
1972 if (b) *b = (PetscInt)a;
1973 PetscFunctionReturn(PETSC_SUCCESS);
1974 }
1975
1976 /*@C
1977 PetscBLASIntCast - casts a `MPI_Count`, `PetscInt`, `PetscCount` or `PetscInt64` to a `PetscBLASInt` (which may be 32-bits in size), generates an
1978 error if the `PetscBLASInt` is not large enough to hold the number.
1979
1980 Not Collective; No Fortran Support
1981
1982 Input Parameter:
1983 . a - the `PetscInt` value
1984
1985 Output Parameter:
1986 . b - the resulting `PetscBLASInt` value, or `NULL` if the result is not needed
1987
1988 Level: advanced
1989
1990 Note:
1991 Errors if the integer is negative since PETSc calls to BLAS/LAPACK never need to cast negative integer inputs
1992
1993 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscMPIIntCast()`, `PetscCIntCast()`, `PetscIntCast()`
1994 @*/
PetscBLASIntCast(MPIU_Count a,PetscBLASInt * b)1995 static inline PetscErrorCode PetscBLASIntCast(MPIU_Count a, PetscBLASInt *b)
1996 {
1997 PetscFunctionBegin;
1998 if (b) *b = 0; /* to prevent compilers erroneously suggesting uninitialized variable */
1999 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);
2000 PetscCheck(a >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Passing negative integer to BLAS/LAPACK routine");
2001 if (b) *b = (PetscBLASInt)a;
2002 PetscFunctionReturn(PETSC_SUCCESS);
2003 }
2004
2005 /*@C
2006 PetscCuBLASIntCast - like `PetscBLASIntCast()`, but for `PetscCuBLASInt`.
2007
2008 Not Collective; No Fortran Support
2009
2010 Input Parameter:
2011 . a - the `PetscInt` value
2012
2013 Output Parameter:
2014 . b - the resulting `PetscCuBLASInt` value, or `NULL` if the result is not needed
2015
2016 Level: advanced
2017
2018 Note:
2019 Errors if the integer is negative since PETSc calls to cuBLAS and friends never need to cast negative integer inputs
2020
2021 .seealso: `PetscCuBLASInt`, `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscMPIIntCast()`, `PetscCIntCast()`, `PetscIntCast()`
2022 @*/
PetscCuBLASIntCast(MPIU_Count a,PetscCuBLASInt * b)2023 static inline PetscErrorCode PetscCuBLASIntCast(MPIU_Count a, PetscCuBLASInt *b)
2024 {
2025 PetscFunctionBegin;
2026 if (b) *b = 0; /* to prevent compilers erroneously suggesting uninitialized variable */
2027 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);
2028 PetscCheck(a >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Passing negative integer %" PetscInt64_FMT "to cuBLAS routine", (PetscInt64)a);
2029 if (b) *b = (PetscCuBLASInt)a;
2030 PetscFunctionReturn(PETSC_SUCCESS);
2031 }
2032
2033 /*@C
2034 PetscHipBLASIntCast - like `PetscBLASIntCast()`, but for `PetscHipBLASInt`.
2035
2036 Not Collective; No Fortran Support
2037
2038 Input Parameter:
2039 . a - the `PetscInt` value
2040
2041 Output Parameter:
2042 . b - the resulting `PetscHipBLASInt` value, or `NULL` if the result is not needed
2043
2044 Level: advanced
2045
2046 Note:
2047 Errors if the integer is negative since PETSc calls to hipBLAS and friends never need to cast negative integer inputs
2048
2049 .seealso: `PetscHipBLASInt`, `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscMPIIntCast()`, `PetscCIntCast()`, `PetscIntCast()`
2050 @*/
PetscHipBLASIntCast(MPIU_Count a,PetscHipBLASInt * b)2051 static inline PetscErrorCode PetscHipBLASIntCast(MPIU_Count a, PetscHipBLASInt *b)
2052 {
2053 PetscFunctionBegin;
2054 if (b) *b = 0; /* to prevent compilers erroneously suggesting uninitialized variable */
2055 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);
2056 PetscCheck(a >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Passing negative integer %" PetscInt64_FMT "to hipBLAS routine", (PetscInt64)a);
2057 if (b) *b = (PetscHipBLASInt)a;
2058 PetscFunctionReturn(PETSC_SUCCESS);
2059 }
2060
2061 /*@C
2062 PetscMPIIntCast - casts a `MPI_Count`, `PetscInt`, `PetscCount`, or `PetscInt64` to a `PetscMPIInt` (which is always 32-bits in size), generates an
2063 error if the `PetscMPIInt` is not large enough to hold the number.
2064
2065 Not Collective; No Fortran Support
2066
2067 Input Parameter:
2068 . a - the `PetscInt` value
2069
2070 Output Parameter:
2071 . b - the resulting `PetscMPIInt` value, or `NULL` if the result is not needed
2072
2073 Level: advanced
2074
2075 .seealso: [](stylePetscCount), `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscIntCast()`
2076 @*/
PetscMPIIntCast(MPIU_Count a,PetscMPIInt * b)2077 static inline PetscErrorCode PetscMPIIntCast(MPIU_Count a, PetscMPIInt *b)
2078 {
2079 PetscFunctionBegin;
2080 if (b) *b = 0; /* to prevent compilers erroneously suggesting uninitialized variable */
2081 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);
2082 if (b) *b = (PetscMPIInt)a;
2083 PetscFunctionReturn(PETSC_SUCCESS);
2084 }
2085
2086 /*@C
2087 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.
2088
2089 Not Collective; No Fortran Support
2090
2091 Input Parameter:
2092 . a - the `PetscInt` value
2093
2094 Output Parameter:
2095 . b - the resulting `int` value, or `NULL` if the result is not needed
2096
2097 Level: advanced
2098
2099 .seealso: [](stylePetscCount), `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscMPIIntCast()`, `PetscBLASIntCast()`, `PetscIntCast()`
2100 @*/
PetscCIntCast(MPIU_Count a,int * b)2101 static inline PetscErrorCode PetscCIntCast(MPIU_Count a, int *b)
2102 {
2103 PetscFunctionBegin;
2104 if (b) *b = 0; /* to prevent compilers erroneously suggesting uninitialized variable */
2105 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);
2106 if (b) *b = (int)a;
2107 PetscFunctionReturn(PETSC_SUCCESS);
2108 }
2109
2110 /*MC
2111 PetscInt64Mult - Computes the product of two variables after casting them to `PetscInt64`.
2112
2113 Not Collective; No Fortran Support
2114
2115 Input Parameters:
2116 + a - the first variable
2117 - b - the second variable
2118
2119 Level: advanced
2120
2121 .seealso: [](stylePetscCount), `PetscIntMultError()`, `PetscIntMultTruncate()`
2122 M*/
2123 #if defined(PETSC_USE_64BIT_INDICES)
2124 #define PetscInt64Mult(a, b) ((a) * (b))
2125 #else
2126 #define PetscInt64Mult(a, b) (((PetscInt64)(a)) * ((PetscInt64)(b)))
2127 #endif
2128
2129 /*@C
2130 PetscRealIntMultTruncate - Computes the product of a positive `PetscReal` and a positive
2131 `PetscInt` and truncates the value to slightly less than the maximal possible value.
2132
2133 Not Collective; No Fortran Support
2134
2135 Input Parameters:
2136 + a - The `PetscReal` value
2137 - b - The `PetscInt` value
2138
2139 Level: advanced
2140
2141 Notes:
2142 Returns the result as a `PetscInt` value.
2143
2144 Use `PetscInt64Mult()` to compute the product of two `PetscInt` as a `PetscInt64`.
2145
2146 Use `PetscIntMultTruncate()` to compute the product of two positive `PetscInt` and truncate
2147 to fit a `PetscInt`.
2148
2149 Use `PetscIntMultError()` to compute the product of two `PetscInt` if you wish to generate an
2150 error if the result will not fit in a `PetscInt`.
2151
2152 Developer Notes:
2153 We currently assume that `PetscInt` addition can never overflow, this is obviously wrong but
2154 requires many more checks.
2155
2156 This is used where we compute approximate sizes for workspace and need to insure the
2157 workspace is index-able.
2158
2159 .seealso: `PetscReal`, `PetscInt`, `PetscInt64Mult()`, `PetscIntMultError()`, `PetscIntSumError()`
2160 @*/
PetscRealIntMultTruncate(PetscReal a,PetscInt b)2161 static inline PetscInt PetscRealIntMultTruncate(PetscReal a, PetscInt b)
2162 {
2163 PetscInt64 r = (PetscInt64)(a * (PetscReal)b);
2164 if (r > PETSC_INT_MAX - 100) r = PETSC_INT_MAX - 100;
2165 #if defined(PETSC_USE_64BIT_INDICES)
2166 return r;
2167 #else
2168 return (PetscInt)r;
2169 #endif
2170 }
2171
2172 /*@C
2173 PetscIntMultTruncate - Computes the product of two positive `PetscInt` and truncates the value to slightly less than the maximal possible value
2174
2175 Not Collective; No Fortran Support
2176
2177 Input Parameters:
2178 + a - the `PetscInt` value
2179 - b - the second value
2180
2181 Returns:
2182 The result as a `PetscInt` value
2183
2184 Level: advanced
2185
2186 Notes:
2187 Use `PetscInt64Mult()` to compute the product of two `PetscInt` as a `PetscInt64`
2188
2189 Use `PetscRealIntMultTruncate()` to compute the product of a `PetscReal` and a `PetscInt` and truncate to fit a `PetscInt`
2190
2191 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`
2192
2193 Developer Notes:
2194 We currently assume that `PetscInt` addition can never overflow, this is obviously wrong but requires many more checks.
2195
2196 This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2197
2198 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscInt64Mult()`, `PetscIntMultError()`, `PetscIntSumError()`,
2199 `PetscIntSumTruncate()`
2200 @*/
PetscIntMultTruncate(PetscInt a,PetscInt b)2201 static inline PetscInt PetscIntMultTruncate(PetscInt a, PetscInt b)
2202 {
2203 PetscInt64 r = PetscInt64Mult(a, b);
2204 if (r > PETSC_INT_MAX - 100) r = PETSC_INT_MAX - 100;
2205 #if defined(PETSC_USE_64BIT_INDICES)
2206 return r;
2207 #else
2208 return (PetscInt)r;
2209 #endif
2210 }
2211
2212 /*@C
2213 PetscIntSumTruncate - Computes the sum of two positive `PetscInt` and truncates the value to slightly less than the maximal possible value
2214
2215 Not Collective; No Fortran Support
2216
2217 Input Parameters:
2218 + a - the `PetscInt` value
2219 - b - the second value
2220
2221 Returns:
2222 The result as a `PetscInt` value
2223
2224 Level: advanced
2225
2226 Notes:
2227 Use `PetscInt64Mult()` to compute the product of two `PetscInt` as a `PetscInt64`
2228
2229 Use `PetscRealIntMultTruncate()` to compute the product of a `PetscReal` and a `PetscInt` and truncate to fit a `PetscInt`
2230
2231 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`
2232
2233 Developer Note:
2234 This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2235
2236 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscInt64Mult()`, `PetscIntMultError()`
2237 @*/
PetscIntSumTruncate(PetscInt a,PetscInt b)2238 static inline PetscInt PetscIntSumTruncate(PetscInt a, PetscInt b)
2239 {
2240 PetscInt64 r = a;
2241
2242 r += b;
2243 if (r > PETSC_INT_MAX - 100) r = PETSC_INT_MAX - 100;
2244 #if defined(PETSC_USE_64BIT_INDICES)
2245 return r;
2246 #else
2247 return (PetscInt)r;
2248 #endif
2249 }
2250
2251 /*@C
2252 PetscIntMultError - Computes the product of two positive `PetscInt` and generates an error with overflow.
2253
2254 Not Collective; No Fortran Support
2255
2256 Input Parameters:
2257 + a - the `PetscInt` value
2258 - b - the second value
2259
2260 Output Parameter:
2261 . result - the result as a `PetscInt` value, or `NULL` if you do not want the result, you just want to check if it overflows
2262
2263 Level: advanced
2264
2265 Notes:
2266 Use `PetscInt64Mult()` to compute the product of two `PetscInt` and store in a `PetscInt64`
2267
2268 Use `PetscIntMultTruncate()` to compute the product of two `PetscInt` and truncate it to fit in a `PetscInt`
2269
2270 Developer Note:
2271 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.
2272 `PetscIntSumError()` can be used to check for this situation.
2273
2274 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscInt64Mult()`, `PetscIntSumError()`
2275 @*/
PetscIntMultError(PetscInt a,PetscInt b,PetscInt * result)2276 static inline PetscErrorCode PetscIntMultError(PetscInt a, PetscInt b, PetscInt *result)
2277 {
2278 PetscInt64 r = PetscInt64Mult(a, b);
2279
2280 PetscFunctionBegin;
2281 #if defined(PETSC_USE_64BIT_INDICES)
2282 if (result) *result = r;
2283 #else
2284 if (result) *result = (PetscInt)r;
2285 #endif
2286 if (!PetscDefined(USE_64BIT_INDICES)) {
2287 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);
2288 }
2289 PetscFunctionReturn(PETSC_SUCCESS);
2290 }
2291
2292 /*@C
2293
2294 PetscIntSumError - Computes the sum of two positive `PetscInt` and generates an error with overflow.
2295
2296 Not Collective; No Fortran Support
2297
2298 Input Parameters:
2299 + a - the `PetscInt` value
2300 - b - the second value
2301
2302 Output Parameter:
2303 . c - the result as a `PetscInt` value, or `NULL` if you do not want the result, you just want to check if it overflows
2304
2305 Level: advanced
2306
2307 Notes:
2308 Use `PetscInt64Mult()` to compute the product of two 32-bit `PetscInt` and store in a `PetscInt64`
2309
2310 Use `PetscIntMultTruncate()` to compute the product of two `PetscInt` and truncate it to fit in a `PetscInt`
2311
2312 .seealso: `PetscBLASInt`, `PetscMPIInt`, `PetscInt`, `PetscBLASIntCast()`, `PetscInt64Mult()`, `PetscIntMultError()`
2313 @*/
PetscIntSumError(PetscInt a,PetscInt b,PetscInt * result)2314 static inline PetscErrorCode PetscIntSumError(PetscInt a, PetscInt b, PetscInt *result)
2315 {
2316 PetscInt64 r = a;
2317
2318 PetscFunctionBegin;
2319 r += b;
2320 #if defined(PETSC_USE_64BIT_INDICES)
2321 if (result) *result = r;
2322 #else
2323 if (result) *result = (PetscInt)r;
2324 #endif
2325 if (!PetscDefined(USE_64BIT_INDICES)) {
2326 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);
2327 }
2328 PetscFunctionReturn(PETSC_SUCCESS);
2329 }
2330
2331 /*
2332 The IBM include files define hz, here we hide it so that it may be used as a regular user variable.
2333 */
2334 #if defined(hz)
2335 #undef hz
2336 #endif
2337
2338 #if defined(PETSC_HAVE_SYS_TYPES_H)
2339 #include <sys/types.h>
2340 #endif
2341
2342 /*MC
2343
2344 PETSC_VERSION - This manual page provides information about how PETSc documents and uses its version information. This information is available to both C/C++
2345 and Fortran compilers when `petscsys.h` is included.
2346
2347 The current PETSc version and the API for accessing it are defined in <A HREF="PETSC_DOC_OUT_ROOT_PLACEHOLDER/include/petscversion.h.html">include/petscversion.html</A>
2348
2349 The complete version number is given as the triple PETSC_VERSION_MAJOR.PETSC_VERSION_MINOR.PETSC_VERSION_SUBMINOR (in short hand x.y.z)
2350
2351 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
2352 where only a change in the major version number (x) indicates a change in the API.
2353
2354 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
2355
2356 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),
2357 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
2358 version number (x.y.z).
2359
2360 `PETSC_RELEASE_DATE` is the date the x.y version was released (i.e. the version before any patch releases)
2361
2362 `PETSC_VERSION_DATE` is the date the x.y.z version was released
2363
2364 `PETSC_VERSION_GIT` is the last git commit to the repository given in the form vx.y.z-wwwww
2365
2366 `PETSC_VERSION_DATE_GIT` is the date of the last git commit to the repository
2367
2368 `PETSC_VERSION_()` is deprecated and will eventually be removed.
2369
2370 Level: intermediate
2371 M*/
2372
2373 PETSC_EXTERN PetscErrorCode PetscGetArchType(char[], size_t);
2374 PETSC_EXTERN PetscErrorCode PetscGetHostName(char[], size_t);
2375 PETSC_EXTERN PetscErrorCode PetscGetUserName(char[], size_t);
2376 PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[], size_t);
2377 PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]);
2378 PETSC_EXTERN PetscErrorCode PetscGetDate(char[], size_t);
2379 PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t);
2380 PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt *, PetscInt *, PetscInt *, PetscInt *);
2381
2382 PETSC_EXTERN PetscErrorCode PetscSortedInt(PetscCount, const PetscInt[], PetscBool *);
2383 PETSC_EXTERN PetscErrorCode PetscSortedInt64(PetscCount, const PetscInt64[], PetscBool *);
2384 PETSC_EXTERN PetscErrorCode PetscSortedMPIInt(PetscCount, const PetscMPIInt[], PetscBool *);
2385 PETSC_EXTERN PetscErrorCode PetscSortedReal(PetscCount, const PetscReal[], PetscBool *);
2386 PETSC_EXTERN PetscErrorCode PetscSortInt(PetscCount, PetscInt[]);
2387 PETSC_EXTERN PetscErrorCode PetscSortInt64(PetscCount, PetscInt64[]);
2388 PETSC_EXTERN PetscErrorCode PetscSortCount(PetscCount, PetscCount[]);
2389 PETSC_EXTERN PetscErrorCode PetscSortReverseInt(PetscCount, PetscInt[]);
2390 PETSC_EXTERN PetscErrorCode PetscSortedRemoveDupsInt(PetscInt *, PetscInt[]);
2391 PETSC_EXTERN PetscErrorCode PetscSortedCheckDupsInt(PetscCount, const PetscInt[], PetscBool *);
2392 PETSC_EXTERN PetscErrorCode PetscSortedCheckDupsCount(PetscCount, const PetscCount[], PetscBool *);
2393 PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt *, PetscInt[]);
2394 PETSC_EXTERN PetscErrorCode PetscCheckDupsInt(PetscInt, const PetscInt[], PetscBool *);
2395 PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscCount, const PetscInt[], PetscInt *);
2396 PETSC_EXTERN PetscErrorCode PetscFindMPIInt(PetscMPIInt, PetscCount, const PetscMPIInt[], PetscInt *);
2397 PETSC_EXTERN PetscErrorCode PetscFindCount(PetscCount, PetscCount, const PetscCount[], PetscCount *);
2398 PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt, const PetscInt[], PetscInt[]);
2399 PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt, const char *[], PetscInt[]);
2400 PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscCount, PetscInt[], PetscInt[]);
2401 PETSC_EXTERN PetscErrorCode PetscSortIntWithCountArray(PetscCount, PetscInt[], PetscCount[]);
2402 PETSC_EXTERN PetscErrorCode PetscSortIntWithMPIIntArray(PetscCount, PetscInt[], PetscMPIInt[]);
2403 PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscCount, PetscInt[], PetscInt[], PetscInt[]);
2404 PETSC_EXTERN PetscErrorCode PetscSortIntWithIntCountArrayPair(PetscCount, PetscInt[], PetscInt[], PetscCount[]);
2405 PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscCount, PetscMPIInt[]);
2406 PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt *, PetscMPIInt[]);
2407 PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscCount, PetscMPIInt[], PetscMPIInt[]);
2408 PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithIntArray(PetscCount, PetscMPIInt[], PetscInt[]);
2409 PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscCount, PetscInt[], PetscScalar[]);
2410 PETSC_EXTERN PetscErrorCode PetscSortIntWithDataArray(PetscCount, PetscInt[], void *, size_t, void *);
2411 PETSC_EXTERN PetscErrorCode PetscSortReal(PetscCount, PetscReal[]);
2412 PETSC_EXTERN PetscErrorCode PetscSortRealWithArrayInt(PetscCount, PetscReal[], PetscInt[]);
2413 PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt, const PetscReal[], PetscInt[]);
2414 PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt *, PetscReal[]);
2415 PETSC_EXTERN PetscErrorCode PetscFindReal(PetscReal, PetscCount, const PetscReal[], PetscReal, PetscInt *);
2416 PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt, PetscInt, PetscScalar[], PetscInt[]);
2417 PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt, PetscInt, PetscReal[], PetscInt[]);
2418 PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt, const PetscBool[], const PetscInt[], PetscInt *, PetscInt *[], PetscInt *[], PetscInt *[], PetscInt *[]);
2419 PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt, const PetscInt[], const PetscInt[], PetscInt, const PetscInt[], const PetscInt[], PetscInt *, PetscInt *[], PetscInt *[]);
2420 PETSC_EXTERN PetscErrorCode PetscMergeIntArray(PetscInt, const PetscInt[], PetscInt, const PetscInt[], PetscInt *, PetscInt *[]);
2421 PETSC_EXTERN PetscErrorCode PetscMergeMPIIntArray(PetscInt, const PetscMPIInt[], PetscInt, const PetscMPIInt[], PetscInt *, PetscMPIInt *[]);
2422 PETSC_EXTERN PetscErrorCode PetscParallelSortedInt(MPI_Comm, PetscInt, const PetscInt[], PetscBool *);
2423
2424 PETSC_EXTERN PetscErrorCode PetscTimSort(PetscInt, void *, size_t, int (*)(const void *, const void *, void *), void *);
2425 PETSC_EXTERN PetscErrorCode PetscIntSortSemiOrdered(PetscInt, PetscInt[]);
2426 PETSC_EXTERN PetscErrorCode PetscMPIIntSortSemiOrdered(PetscInt, PetscMPIInt[]);
2427 PETSC_EXTERN PetscErrorCode PetscRealSortSemiOrdered(PetscInt, PetscReal[]);
2428 PETSC_EXTERN PetscErrorCode PetscTimSortWithArray(PetscInt, void *, size_t, void *, size_t, int (*)(const void *, const void *, void *), void *);
2429 PETSC_EXTERN PetscErrorCode PetscIntSortSemiOrderedWithArray(PetscInt, PetscInt[], PetscInt[]);
2430 PETSC_EXTERN PetscErrorCode PetscMPIIntSortSemiOrderedWithArray(PetscInt, PetscMPIInt[], PetscMPIInt[]);
2431 PETSC_EXTERN PetscErrorCode PetscRealSortSemiOrderedWithArrayInt(PetscInt, PetscReal[], PetscInt[]);
2432
2433 PETSC_EXTERN PetscErrorCode PetscSetDisplay(void);
2434 PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[], size_t);
2435
2436 /*J
2437 PetscRandomType - String with the name of a PETSc randomizer
2438
2439 Level: beginner
2440
2441 Note:
2442 To use `PETSCSPRNG` or `PETSCRANDOM123` you must have ./configure PETSc
2443 with the option `--download-sprng` or `--download-random123`. We recommend the default provided with PETSc.
2444
2445 .seealso: `PetscRandomSetType()`, `PetscRandom`, `PetscRandomCreate()`
2446 J*/
2447 typedef const char *PetscRandomType;
2448 #define PETSCRAND "rand"
2449 #define PETSCRAND48 "rand48"
2450 #define PETSCSPRNG "sprng"
2451 #define PETSCRANDER48 "rander48"
2452 #define PETSCRANDOM123 "random123"
2453 #define PETSCCURAND "curand"
2454
2455 /* Logging support */
2456 PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID;
2457
2458 PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void);
2459 PETSC_EXTERN PetscErrorCode PetscRandomFinalizePackage(void);
2460
2461 /* Dynamic creation and loading functions */
2462 PETSC_EXTERN PetscFunctionList PetscRandomList;
2463
2464 PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[], PetscErrorCode (*)(PetscRandom));
2465 PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType);
2466 PETSC_EXTERN PetscErrorCode PetscRandomSetOptionsPrefix(PetscRandom, const char[]);
2467 PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom);
2468 PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType *);
2469 PETSC_EXTERN PetscErrorCode PetscRandomViewFromOptions(PetscRandom, PetscObject, const char[]);
2470 PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom, PetscViewer);
2471
2472 PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm, PetscRandom *);
2473 PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom, PetscScalar *);
2474 PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom, PetscReal *);
2475 PETSC_EXTERN PetscErrorCode PetscRandomGetValues(PetscRandom, PetscInt, PetscScalar *);
2476 PETSC_EXTERN PetscErrorCode PetscRandomGetValuesReal(PetscRandom, PetscInt, PetscReal *);
2477 PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom, PetscScalar *, PetscScalar *);
2478 PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom, PetscScalar, PetscScalar);
2479 PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom, PetscInt64);
2480 PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom, PetscInt64 *);
2481 PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom);
2482 PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom *);
2483
2484 PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[], char[], size_t);
2485 PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[], char[], size_t);
2486 PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[], size_t);
2487 PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[], char[]);
2488 PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[], size_t);
2489 PETSC_EXTERN PetscErrorCode PetscTestFile(const char[], char, PetscBool *);
2490 PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[], char, PetscBool *);
2491 PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]);
2492 PETSC_EXTERN PetscErrorCode PetscMkdtemp(char[]);
2493 PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]);
2494
2495 /*MC
2496 PetscBinaryBigEndian - indicates if values in memory are stored with big endian format
2497
2498 Synopsis:
2499 #include <petscsys.h>
2500 PetscBool PetscBinaryBigEndian(void);
2501
2502 No Fortran Support
2503
2504 Level: developer
2505
2506 .seealso: `PetscInitialize()`, `PetscFinalize()`, `PetscInitializeCalled`
2507 M*/
PetscBinaryBigEndian(void)2508 static inline PetscBool PetscBinaryBigEndian(void)
2509 {
2510 long _petsc_v = 1;
2511 return ((char *)&_petsc_v)[0] ? PETSC_FALSE : PETSC_TRUE;
2512 }
2513
2514 PETSC_EXTERN PetscErrorCode PetscBinaryRead(int, void *, PetscCount, PetscInt *, PetscDataType);
2515 PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm, int, void *, PetscInt, PetscInt *, PetscDataType);
2516 PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int, const void *, PetscCount, PetscDataType);
2517 PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm, int, const void *, PetscInt, PetscDataType);
2518 PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[], PetscFileMode, int *);
2519 PETSC_EXTERN PetscErrorCode PetscBinaryClose(int);
2520 PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm, PetscBool *);
2521 PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm, PetscBool *);
2522 PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm, char[], size_t);
2523 PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm, const char[], char[], size_t, PetscBool *);
2524 PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm, const char[], char[], size_t, PetscBool *);
2525 #if defined(PETSC_USE_SOCKET_VIEWER)
2526 PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[], int, int *);
2527 #endif
2528
2529 PETSC_EXTERN PetscErrorCode PetscBinarySeek(int, off_t, PetscBinarySeekType, off_t *);
2530 PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm, int, off_t, PetscBinarySeekType, off_t *);
2531 PETSC_EXTERN PetscErrorCode PetscByteSwap(void *, PetscDataType, PetscCount);
2532
2533 PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]);
2534 PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[], PetscBool);
2535 PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void);
2536 PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char *);
2537 PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void);
2538 PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void);
2539 PETSC_EXTERN PetscErrorCode PetscWaitOnError(void);
2540
2541 PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm, const PetscMPIInt[], const PetscMPIInt[], PetscMPIInt *);
2542 PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm, PetscMPIInt, PetscMPIInt, const PetscMPIInt[], PetscMPIInt *[], PetscMPIInt *[]);
2543 PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm, PetscMPIInt, PetscMPIInt, const PetscMPIInt[], const PetscMPIInt[], PetscMPIInt *[], PetscMPIInt *[], PetscMPIInt *[]);
2544 PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm, PetscMPIInt, PetscMPIInt, const PetscMPIInt[], const PetscMPIInt[], PetscInt ***, MPI_Request **);
2545 PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm, PetscMPIInt, PetscMPIInt, const PetscMPIInt[], const PetscMPIInt[], PetscScalar ***, MPI_Request **);
2546 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);
2547 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 *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(6, 3);
2548 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 *), PetscCtx ctx) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(6, 3);
2549
2550 PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm, PetscBuildTwoSidedType);
2551 PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm, PetscBuildTwoSidedType *);
2552
PetscSSEIsEnabled(PETSC_UNUSED MPI_Comm comm,PetscBool * lflag,PetscBool * gflag)2553 PETSC_DEPRECATED_FUNCTION(3, 24, 0, "PetscSSEIsEnabled()", ) static inline PetscErrorCode PetscSSEIsEnabled(PETSC_UNUSED MPI_Comm comm, PetscBool *lflag, PetscBool *gflag)
2554 {
2555 if (lflag) *lflag = PETSC_FALSE;
2556 if (gflag) *gflag = PETSC_FALSE;
2557 return PETSC_SUCCESS;
2558 }
2559
2560 PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject);
2561
2562 struct _n_PetscSubcomm {
2563 MPI_Comm parent; /* parent communicator */
2564 MPI_Comm dupparent; /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */
2565 MPI_Comm child; /* the sub-communicator */
2566 PetscMPIInt n; /* num of subcommunicators under the parent communicator */
2567 PetscMPIInt color; /* color of processors belong to this communicator */
2568 PetscMPIInt *subsize; /* size of subcommunicator[color] */
2569 PetscSubcommType type;
2570 char *subcommprefix;
2571 };
2572
PetscSubcommParent(PetscSubcomm scomm)2573 static inline MPI_Comm PetscSubcommParent(PetscSubcomm scomm)
2574 {
2575 return scomm->parent;
2576 }
PetscSubcommChild(PetscSubcomm scomm)2577 static inline MPI_Comm PetscSubcommChild(PetscSubcomm scomm)
2578 {
2579 return scomm->child;
2580 }
PetscSubcommContiguousParent(PetscSubcomm scomm)2581 static inline MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm)
2582 {
2583 return scomm->dupparent;
2584 }
2585 PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm, PetscSubcomm *);
2586 PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm *);
2587 PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm, PetscInt);
2588 PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm, PetscSubcommType);
2589 PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm, PetscMPIInt, PetscMPIInt);
2590 PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm, PetscViewer);
2591 PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm);
2592 PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm, const char[]);
2593 PETSC_EXTERN PetscErrorCode PetscSubcommGetParent(PetscSubcomm, MPI_Comm *);
2594 PETSC_EXTERN PetscErrorCode PetscSubcommGetContiguousParent(PetscSubcomm, MPI_Comm *);
2595 PETSC_EXTERN PetscErrorCode PetscSubcommGetChild(PetscSubcomm, MPI_Comm *);
2596
2597 PETSC_EXTERN PetscErrorCode PetscHeapCreate(PetscInt, PetscHeap *);
2598 PETSC_EXTERN PetscErrorCode PetscHeapAdd(PetscHeap, PetscInt, PetscInt);
2599 PETSC_EXTERN PetscErrorCode PetscHeapPop(PetscHeap, PetscInt *, PetscInt *);
2600 PETSC_EXTERN PetscErrorCode PetscHeapPeek(PetscHeap, PetscInt *, PetscInt *);
2601 PETSC_EXTERN PetscErrorCode PetscHeapStash(PetscHeap, PetscInt, PetscInt);
2602 PETSC_EXTERN PetscErrorCode PetscHeapUnstash(PetscHeap);
2603 PETSC_EXTERN PetscErrorCode PetscHeapDestroy(PetscHeap *);
2604 PETSC_EXTERN PetscErrorCode PetscHeapView(PetscHeap, PetscViewer);
2605
2606 PETSC_EXTERN PetscErrorCode PetscProcessPlacementView(PetscViewer);
2607 PETSC_EXTERN PetscErrorCode PetscShmCommGet(MPI_Comm, PetscShmComm *);
2608 PETSC_EXTERN PetscErrorCode PetscShmCommGlobalToLocal(PetscShmComm, PetscMPIInt, PetscMPIInt *);
2609 PETSC_EXTERN PetscErrorCode PetscShmCommLocalToGlobal(PetscShmComm, PetscMPIInt, PetscMPIInt *);
2610 PETSC_EXTERN PetscErrorCode PetscShmCommGetMpiShmComm(PetscShmComm, MPI_Comm *);
2611
2612 /* routines to better support OpenMP multithreading needs of some PETSc third party libraries */
2613 PETSC_EXTERN PetscErrorCode PetscOmpCtrlCreate(MPI_Comm, PetscInt, PetscOmpCtrl *);
2614 PETSC_EXTERN PetscErrorCode PetscOmpCtrlGetOmpComms(PetscOmpCtrl, MPI_Comm *, MPI_Comm *, PetscBool *);
2615 PETSC_EXTERN PetscErrorCode PetscOmpCtrlDestroy(PetscOmpCtrl *);
2616 PETSC_EXTERN PetscErrorCode PetscOmpCtrlBarrier(PetscOmpCtrl);
2617 PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterBegin(PetscOmpCtrl);
2618 PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterEnd(PetscOmpCtrl);
2619
2620 PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t, PetscCount, PetscSegBuffer *);
2621 PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer *);
2622 PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer, PetscCount, void *);
2623 PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer, void *);
2624 PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer, void *);
2625 PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer, void *);
2626 PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer, PetscCount *);
2627 PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer, PetscCount);
2628
2629 /*MC
2630 PetscSegBufferGetInts - access an array of `PetscInt` from a `PetscSegBuffer`
2631
2632 Synopsis:
2633 #include <petscsys.h>
2634 PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg, size_t count, PetscInt *PETSC_RESTRICT *slot);
2635
2636 No Fortran Support
2637
2638 Input Parameters:
2639 + seg - `PetscSegBuffer` buffer
2640 - count - number of entries needed
2641
2642 Output Parameter:
2643 . buf - address of new buffer for contiguous data
2644
2645 Level: intermediate
2646
2647 Developer Note:
2648 Type-safe wrapper to encourage use of PETSC_RESTRICT. Does not use PetscFunctionBegin because the error handling
2649 prevents the compiler from completely erasing the stub. This is called in inner loops so it has to be as fast as
2650 possible.
2651
2652 .seealso: `PetscSegBuffer`, `PetscSegBufferGet()`, `PetscInitialize()`, `PetscFinalize()`, `PetscInitializeCalled`
2653 M*/
PetscSegBufferGetInts(PetscSegBuffer seg,PetscCount count,PetscInt * PETSC_RESTRICT * slot)2654 static inline PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg, PetscCount count, PetscInt *PETSC_RESTRICT *slot)
2655 {
2656 return PetscSegBufferGet(seg, count, (void **)slot);
2657 }
2658
2659 extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton;
2660 PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted *);
2661 PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted *);
2662 PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted, const char *, const char *, PetscBool *);
2663
2664 #include <stdarg.h>
2665 PETSC_EXTERN PetscErrorCode PetscVSNPrintf(char *, size_t, const char[], size_t *, va_list);
2666 PETSC_EXTERN PetscErrorCode (*PetscVFPrintf)(FILE *, const char[], va_list);
2667
2668 PETSC_EXTERN PetscSegBuffer PetscCitationsList;
2669
2670 /*@
2671 PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used in the code.
2672
2673 Not Collective; No Fortran Support
2674
2675 Input Parameters:
2676 + cite - the bibtex item, formatted to displayed on multiple lines nicely
2677 - set - a boolean variable initially set to `PETSC_FALSE`; this is used to insure only a single registration of the citation
2678
2679 Options Database Key:
2680 . -citations [filename] - print out the bibtex entries for the given computation
2681
2682 Level: intermediate
2683 @*/
PetscCitationsRegister(const char cit[],PetscBool * set)2684 static inline PetscErrorCode PetscCitationsRegister(const char cit[], PetscBool *set)
2685 {
2686 size_t len;
2687 char *vstring;
2688
2689 PetscFunctionBegin;
2690 if (set && *set) PetscFunctionReturn(PETSC_SUCCESS);
2691 PetscCall(PetscStrlen(cit, &len));
2692 PetscCall(PetscSegBufferGet(PetscCitationsList, (PetscCount)len, &vstring));
2693 PetscCall(PetscArraycpy(vstring, cit, len));
2694 if (set) *set = PETSC_TRUE;
2695 PetscFunctionReturn(PETSC_SUCCESS);
2696 }
2697
2698 PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm, char[], char[], size_t);
2699 PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm, const char[], char[], size_t);
2700 PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm, const char[], const char[]);
2701
2702 PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm, char[], char[], size_t);
2703 PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm, const char[], char[], char[], size_t);
2704 PETSC_EXTERN PetscErrorCode PetscBoxUpload(MPI_Comm, const char[], const char[]);
2705
2706 PETSC_EXTERN PetscErrorCode PetscGlobusGetTransfers(MPI_Comm, const char[], char[], size_t);
2707 PETSC_EXTERN PetscErrorCode PetscGlobusAuthorize(MPI_Comm, char[], size_t);
2708 PETSC_EXTERN PetscErrorCode PetscGlobusUpload(MPI_Comm, const char[], const char[]);
2709
2710 PETSC_EXTERN PetscErrorCode PetscPullJSONValue(const char[], const char[], char[], size_t, PetscBool *);
2711 PETSC_EXTERN PetscErrorCode PetscPushJSONValue(char[], const char[], const char[], size_t);
2712
2713 #if !defined(PETSC_HAVE_MPI_LARGE_COUNT)
2714 /*
2715 Cast PetscCount <a> to PetscMPIInt <b>, where <a> is likely used for the 'count' argument in MPI routines.
2716 It is similar to PetscMPIIntCast() except that here it returns an MPI error code.
2717 */
2718 #define PetscMPIIntCast_Internal(a, b) \
2719 do { \
2720 *b = 0; \
2721 if (PetscUnlikely(a > (MPIU_Count)PETSC_MPI_INT_MAX)) return MPI_ERR_COUNT; \
2722 *b = (PetscMPIInt)a; \
2723 } while (0)
2724
MPIU_Get_count(MPI_Status * status,MPI_Datatype dtype,PetscCount * count)2725 static inline PetscMPIInt MPIU_Get_count(MPI_Status *status, MPI_Datatype dtype, PetscCount *count)
2726 {
2727 PetscMPIInt count2, err;
2728
2729 *count = 0; /* to prevent incorrect warnings of uninitialized variables */
2730 err = MPI_Get_count(status, dtype, &count2);
2731 *count = count2;
2732 return err;
2733 }
2734
MPIU_Send(const void * buf,MPIU_Count count,MPI_Datatype dtype,PetscMPIInt dest,PetscMPIInt tag,MPI_Comm comm)2735 static inline PetscMPIInt MPIU_Send(const void *buf, MPIU_Count count, MPI_Datatype dtype, PetscMPIInt dest, PetscMPIInt tag, MPI_Comm comm)
2736 {
2737 PetscMPIInt count2, err;
2738
2739 PetscMPIIntCast_Internal(count, &count2);
2740 err = MPI_Send((void *)buf, count2, dtype, dest, tag, comm);
2741 return err;
2742 }
2743
MPIU_Send_init(const void * buf,MPIU_Count count,MPI_Datatype dtype,PetscMPIInt dest,PetscMPIInt tag,MPI_Comm comm,MPI_Request * request)2744 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)
2745 {
2746 PetscMPIInt count2, err;
2747
2748 PetscMPIIntCast_Internal(count, &count2);
2749 err = MPI_Send_init((void *)buf, count2, dtype, dest, tag, comm, request);
2750 return err;
2751 }
2752
MPIU_Isend(const void * buf,MPIU_Count count,MPI_Datatype dtype,PetscMPIInt dest,PetscMPIInt tag,MPI_Comm comm,MPI_Request * request)2753 static inline PetscMPIInt MPIU_Isend(const void *buf, MPIU_Count count, MPI_Datatype dtype, PetscMPIInt dest, PetscMPIInt tag, MPI_Comm comm, MPI_Request *request)
2754 {
2755 PetscMPIInt count2, err;
2756
2757 PetscMPIIntCast_Internal(count, &count2);
2758 err = MPI_Isend((void *)buf, count2, dtype, dest, tag, comm, request);
2759 return err;
2760 }
2761
MPIU_Recv(const void * buf,MPIU_Count count,MPI_Datatype dtype,PetscMPIInt source,PetscMPIInt tag,MPI_Comm comm,MPI_Status * status)2762 static inline PetscMPIInt MPIU_Recv(const void *buf, MPIU_Count count, MPI_Datatype dtype, PetscMPIInt source, PetscMPIInt tag, MPI_Comm comm, MPI_Status *status)
2763 {
2764 PetscMPIInt count2, err;
2765
2766 PetscMPIIntCast_Internal(count, &count2);
2767 err = MPI_Recv((void *)buf, count2, dtype, source, tag, comm, status);
2768 return err;
2769 }
2770
MPIU_Recv_init(const void * buf,MPIU_Count count,MPI_Datatype dtype,PetscMPIInt source,PetscMPIInt tag,MPI_Comm comm,MPI_Request * request)2771 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)
2772 {
2773 PetscMPIInt count2, err;
2774
2775 PetscMPIIntCast_Internal(count, &count2);
2776 err = MPI_Recv_init((void *)buf, count2, dtype, source, tag, comm, request);
2777 return err;
2778 }
2779
MPIU_Irecv(const void * buf,MPIU_Count count,MPI_Datatype dtype,PetscMPIInt source,PetscMPIInt tag,MPI_Comm comm,MPI_Request * request)2780 static inline PetscMPIInt MPIU_Irecv(const void *buf, MPIU_Count count, MPI_Datatype dtype, PetscMPIInt source, PetscMPIInt tag, MPI_Comm comm, MPI_Request *request)
2781 {
2782 PetscMPIInt count2, err;
2783
2784 PetscMPIIntCast_Internal(count, &count2);
2785 err = MPI_Irecv((void *)buf, count2, dtype, source, tag, comm, request);
2786 return err;
2787 }
2788
MPIU_Reduce(const void * inbuf,void * outbuf,MPIU_Count count,MPI_Datatype dtype,MPI_Op op,PetscMPIInt root,MPI_Comm comm)2789 static inline PetscMPIInt MPIU_Reduce(const void *inbuf, void *outbuf, MPIU_Count count, MPI_Datatype dtype, MPI_Op op, PetscMPIInt root, MPI_Comm comm)
2790 {
2791 PetscMPIInt count2, err;
2792
2793 PetscMPIIntCast_Internal(count, &count2);
2794 err = MPI_Reduce((void *)inbuf, outbuf, count2, dtype, op, root, comm);
2795 return err;
2796 }
2797
2798 #if defined(PETSC_HAVE_MPI_REDUCE_LOCAL)
MPIU_Reduce_local(const void * inbuf,void * inoutbuf,MPIU_Count count,MPI_Datatype dtype,MPI_Op op)2799 static inline PetscMPIInt MPIU_Reduce_local(const void *inbuf, void *inoutbuf, MPIU_Count count, MPI_Datatype dtype, MPI_Op op)
2800 {
2801 PetscMPIInt count2, err;
2802
2803 PetscMPIIntCast_Internal(count, &count2);
2804 err = MPI_Reduce_local((void *)inbuf, inoutbuf, count2, dtype, op);
2805 return err;
2806 }
2807 #endif
2808
2809 #if !defined(PETSC_USE_64BIT_INDICES)
2810 #define MPIU_Scatterv(sendbuf, sendcounts, displs, sendtype, recvbuf, recvcount, recvtype, root, comm) MPI_Scatterv(sendbuf, sendcounts, displs, sendtype, recvbuf, recvcount, recvtype, root, comm)
2811 #define MPIU_Gatherv(sendbuf, sendcount, sendtype, recvbuf, recvcounts, displs, recvtype, root, comm) MPI_Gatherv(sendbuf, sendcount, sendtype, recvbuf, recvcounts, displs, recvtype, root, comm)
2812 #else
2813 #define MPIU_Scatterv(sendbuf, sendcount, displs, sendtype, recvbuf, recvcount, recvtype, root, comm) \
2814 ((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)
2815 #define MPIU_Gatherv(sendbuf, sendcount, sendtype, recvbuf, recvcounts, displs, recvtype, root, comm) \
2816 ((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)
2817 #endif
2818
2819 #else
2820
2821 /* on 32 bit systems MPI_Count maybe 64-bit while PetscCount is 32-bit */
2822 #define PetscCountCast_Internal(a, b) \
2823 do { \
2824 *b = 0; \
2825 if (PetscUnlikely(a > (MPI_Count)PETSC_COUNT_MAX)) return MPI_ERR_COUNT; \
2826 *b = (PetscMPIInt)a; \
2827 } while (0)
2828
MPIU_Get_count(MPI_Status * status,MPI_Datatype dtype,PetscCount * count)2829 static inline PetscMPIInt MPIU_Get_count(MPI_Status *status, MPI_Datatype dtype, PetscCount *count)
2830 {
2831 MPI_Count count2;
2832 PetscMPIInt err;
2833
2834 *count = 0; /* to prevent incorrect warnings of uninitialized variables */
2835 err = MPI_Get_count_c(status, dtype, &count2);
2836 if (err) return err;
2837 PetscCountCast_Internal(count2, count);
2838 return MPI_SUCCESS;
2839 }
2840
2841 #define MPIU_Reduce(inbuf, outbuf, count, dtype, op, root, comm) MPI_Reduce_c(inbuf, outbuf, (MPI_Count)(count), dtype, op, root, comm)
2842 #define MPIU_Send(buf, count, dtype, dest, tag, comm) MPI_Send_c(buf, (MPI_Count)(count), dtype, dest, tag, comm)
2843 #define MPIU_Send_init(buf, count, dtype, dest, tag, comm, request) MPI_Send_init_c(buf, (MPI_Count)(count), dtype, dest, tag, comm, request)
2844 #define MPIU_Isend(buf, count, dtype, dest, tag, comm, request) MPI_Isend_c(buf, (MPI_Count)(count), dtype, dest, tag, comm, request)
2845 #define MPIU_Recv(buf, count, dtype, source, tag, comm, status) MPI_Recv_c(buf, (MPI_Count)(count), dtype, source, tag, comm, status)
2846 #define MPIU_Recv_init(buf, count, dtype, source, tag, comm, request) MPI_Recv_init_c(buf, (MPI_Count)(count), dtype, source, tag, comm, request)
2847 #define MPIU_Irecv(buf, count, dtype, source, tag, comm, request) MPI_Irecv_c(buf, (MPI_Count)(count), dtype, source, tag, comm, request)
2848 #if defined(PETSC_HAVE_MPI_REDUCE_LOCAL)
2849 #define MPIU_Reduce_local(inbuf, inoutbuf, count, dtype, op) MPI_Reduce_local_c(inbuf, inoutbuf, (MPI_Count)(count), dtype, op)
2850 #endif
2851
2852 /*MC
2853 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.
2854
2855 Synopsis:
2856 #include <petscsys.h>
2857 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)
2858
2859 Collective
2860
2861 Input Parameters:
2862 + sendbuf - address of send buffer
2863 . sendcounts - non-negative `PetscInt` array (of length `comm` group size) specifying the number of elements to send to each MPI process
2864 . 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
2865 . sendtype - data type of `sendbuf` elements
2866 . recvcount - number of elements in `recvbuf` (non-negative integer)
2867 . recvtype - data type of `recvbuf` elements
2868 . root - Rank of the MPI root process, which will dispatch the data to scatter
2869 - comm - `MPI_Comm` communicator
2870
2871 Output Parameter:
2872 . recvbuf - the resulting scattered values on this MPI process
2873
2874 Level: developer
2875
2876 Notes:
2877 Should be wrapped with `PetscCallMPI()` for error checking
2878
2879 This is different than most of the `MPIU_` wrappers in that all the count arguments are in `PetscInt`
2880
2881 .seealso: [](stylePetscCount), `MPI_Allreduce()`, `MPIU_Gatherv()`
2882 M*/
2883
2884 #if !defined(PETSC_USE_64BIT_INDICES)
2885 #define MPIU_Scatterv(sendbuf, sendcounts, displs, sendtype, recvbuf, recvcount, recvtype, root, comm) MPI_Scatterv(sendbuf, sendcounts, displs, sendtype, recvbuf, recvcount, recvtype, root, comm)
2886 #define MPIU_Gatherv(sendbuf, sendcount, sendtype, recvbuf, recvcounts, displs, recvtype, root, comm) MPI_Gatherv(sendbuf, sendcount, sendtype, recvbuf, recvcounts, displs, recvtype, root, comm)
2887 #else
2888 #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)
2889 #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)
2890 #endif
2891
2892 #endif
2893
2894 PETSC_EXTERN PetscMPIInt MPIU_Allreduce_Private(const void *, void *, MPIU_Count, MPI_Datatype, MPI_Op, MPI_Comm);
2895 PETSC_EXTERN PetscErrorCode PetscCheckAllreduceSameLineAndCount_Private(MPI_Comm, const char *, PetscMPIInt, PetscMPIInt);
2896
2897 #if defined(PETSC_USE_DEBUG)
PetscStrHash(const char * str)2898 static inline unsigned int PetscStrHash(const char *str)
2899 {
2900 unsigned int c, hash = 5381;
2901
2902 while ((c = (unsigned int)*str++)) hash = ((hash << 5) + hash) + c; /* hash * 33 + c */
2903 return hash;
2904 }
2905 #endif
2906
2907 /*MC
2908 MPIU_Allreduce - A replacement for `MPI_Allreduce()` that (1) performs single-count `MPIU_INT` operations in `PetscInt64` to detect
2909 integer overflows and (2) tries to determine if the call from all the MPI ranks occur in the
2910 same place in the PETSc code. This helps to detect bugs where different MPI ranks follow different code paths
2911 resulting in inconsistent and incorrect calls to `MPI_Allreduce()`.
2912
2913 Synopsis:
2914 #include <petscsys.h>
2915 PetscMPIInt MPIU_Allreduce(void *indata,void *outdata,PetscCount count,MPI_Datatype dtype, MPI_Op op, MPI_Comm comm);
2916
2917 Collective
2918
2919 Input Parameters:
2920 + a - pointer to the input data to be reduced
2921 . count - the number of MPI data items in `a` and `b`
2922 . dtype - the MPI datatype, for example `MPI_INT`
2923 . op - the MPI operation, for example `MPI_SUM`
2924 - comm - the MPI communicator on which the operation occurs
2925
2926 Output Parameter:
2927 . b - the reduced values
2928
2929 Level: developer
2930
2931 Note:
2932 Should be wrapped with `PetscCallMPI()` for error checking
2933
2934 .seealso: [](stylePetscCount), `MPI_Allreduce()`
2935 M*/
2936 #if defined(PETSC_USE_DEBUG)
2937 #define MPIU_Allreduce(a, b, count, dtype, op, comm) \
2938 PetscMacroReturnStandard( \
2939 PetscCall(PetscCheckAllreduceSameLineAndCount_Private((comm), __FILE__, (PetscMPIInt)__LINE__, (PetscMPIInt)(count))); \
2940 PetscCallMPI(MPIU_Allreduce_Private((a), (b), (count), (dtype), (op), (comm)));)
2941 #else
2942 #define MPIU_Allreduce(a, b, count, dtype, op, comm) MPIU_Allreduce_Private((a), (b), (count), (dtype), (op), (comm))
2943 #endif
2944
2945 /* this is a vile hack */
2946 #if defined(PETSC_HAVE_NECMPI)
2947 #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)
2948 #define MPI_Type_free(a) (*(a) = MPI_DATATYPE_NULL, 0);
2949 #endif
2950 #endif
2951
2952 /*
2953 List of external packages and queries on it
2954 */
2955 PETSC_EXTERN PetscErrorCode PetscHasExternalPackage(const char[], PetscBool *);
2956
2957 /* this cannot go here because it may be in a different shared library */
2958 PETSC_EXTERN PetscErrorCode PCMPIServerBegin(void);
2959 PETSC_EXTERN PetscErrorCode PCMPIServerEnd(void);
2960 PETSC_EXTERN PetscBool PCMPIServerActive;
2961 PETSC_EXTERN PetscBool PCMPIServerInSolve;
2962 PETSC_EXTERN PetscBool PCMPIServerUseShmget;
2963 PETSC_EXTERN PetscErrorCode PetscShmgetAllocateArray(size_t, size_t, void **);
2964 PETSC_EXTERN PetscErrorCode PetscShmgetDeallocateArray(void **);
2965 PETSC_EXTERN PetscErrorCode PetscShmgetMapAddresses(MPI_Comm, PetscInt, const void **, void **);
2966 PETSC_EXTERN PetscErrorCode PetscShmgetUnmapAddresses(PetscInt, void **);
2967 PETSC_EXTERN PetscErrorCode PetscShmgetAddressesFinalize(void);
2968
2969 typedef struct {
2970 PetscInt n;
2971 void *addr[3];
2972 } PCMPIServerAddresses;
2973 PETSC_EXTERN PetscErrorCode PCMPIServerAddressesDestroy(PetscCtxRt);
2974
2975 #define PETSC_HAVE_FORTRAN PETSC_DEPRECATED_MACRO(3, 20, 0, "PETSC_USE_FORTRAN_BINDINGS", ) PETSC_USE_FORTRAN_BINDINGS
2976
2977 PETSC_EXTERN PetscErrorCode PetscBLASSetNumThreads(PetscInt);
2978 PETSC_EXTERN PetscErrorCode PetscBLASGetNumThreads(PetscInt *);
2979
2980 /*MC
2981 PetscSafePointerPlusOffset - Checks that a pointer is not `NULL` before applying an offset
2982
2983 Level: beginner
2984
2985 Note:
2986 This is needed to avoid errors with undefined-behavior sanitizers such as
2987 UBSan, assuming PETSc has been configured with `-fsanitize=undefined` as part of the compiler flags
2988 M*/
2989 #define PetscSafePointerPlusOffset(ptr, offset) ((ptr) ? (ptr) + (offset) : NULL)
2990
2991 /* this is required to force PetscDevice to be visible at the system level for the Fortran interface */
2992 #include <petscdevicetypes.h>
2993
2994 #if PetscDefined(USE_DEBUG) && !PetscDefined(HAVE_THREADSAFETY)
2995 PETSC_EXTERN PetscErrorCode PetscStackView(FILE *);
2996 #else
2997 #define PetscStackView(file) PETSC_SUCCESS
2998 #endif
2999