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 */
5 #if !defined(PETSCSYS_H)
6 #define PETSCSYS_H
7 /* ========================================================================== */
8 /*
9 petscconf.h is contained in ${PETSC_ARCH}/include/petscconf.h it is
10 found automatically by the compiler due to the -I${PETSC_DIR}/${PETSC_ARCH}/include.
11 For --prefix installs the ${PETSC_ARCH}/ does not exist and petscconf.h is in the same
12 directory as the other PETSc include files.
13 */
14 #include <petscconf.h>
15 #include <petscfix.h>
16
17 #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) || defined(PETSC_HAVE_HIP) || defined(PETSC_HAVE_KOKKOS)
18 #define PETSC_HAVE_DEVICE
19 #endif
20
21 #if defined(PETSC_DESIRE_FEATURE_TEST_MACROS)
22 /*
23 Feature test macros must be included before headers defined by IEEE Std 1003.1-2001
24 We only turn these in PETSc source files that require them by setting PETSC_DESIRE_FEATURE_TEST_MACROS
25 */
26 # if defined(PETSC__POSIX_C_SOURCE_200112L) && !defined(_POSIX_C_SOURCE)
27 # define _POSIX_C_SOURCE 200112L
28 # endif
29 # if defined(PETSC__BSD_SOURCE) && !defined(_BSD_SOURCE)
30 # define _BSD_SOURCE
31 # endif
32 # if defined(PETSC__DEFAULT_SOURCE) && !defined(_DEFAULT_SOURCE)
33 # define _DEFAULT_SOURCE
34 # endif
35 # if defined(PETSC__GNU_SOURCE) && !defined(_GNU_SOURCE)
36 # define _GNU_SOURCE
37 # endif
38 #endif
39
40 #include <petscsystypes.h>
41
42 /* ========================================================================== */
43 /*
44 This facilitates using the C version of PETSc from C++ and the C++ version from C.
45 */
46 #if defined(__cplusplus)
47 # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_CXX
48 #else
49 # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_C
50 #endif
51
52 /* ========================================================================== */
53 /*
54 Since PETSc manages its own extern "C" handling users should never include PETSc include
55 files within extern "C". This will generate a compiler error if a user does put the include
56 file within an extern "C".
57 */
58 #if defined(__cplusplus)
59 void assert_never_put_petsc_headers_inside_an_extern_c(int); void assert_never_put_petsc_headers_inside_an_extern_c(double);
60 #endif
61
62 #if defined(__cplusplus)
63 # define PETSC_RESTRICT PETSC_CXX_RESTRICT
64 #else
65 # define PETSC_RESTRICT PETSC_C_RESTRICT
66 #endif
67
68 #if defined(__cplusplus)
69 # define PETSC_INLINE PETSC_CXX_INLINE
70 #else
71 # define PETSC_INLINE PETSC_C_INLINE
72 #endif
73
74 #define PETSC_STATIC_INLINE static PETSC_INLINE
75
76 #if defined(_WIN32) && defined(PETSC_USE_SHARED_LIBRARIES) /* For Win32 shared libraries */
77 # define PETSC_DLLEXPORT __declspec(dllexport)
78 # define PETSC_DLLIMPORT __declspec(dllimport)
79 # define PETSC_VISIBILITY_INTERNAL
80 #elif defined(PETSC_USE_VISIBILITY_CXX) && defined(__cplusplus)
81 # define PETSC_DLLEXPORT __attribute__((visibility ("default")))
82 # define PETSC_DLLIMPORT __attribute__((visibility ("default")))
83 # define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden")))
84 #elif defined(PETSC_USE_VISIBILITY_C) && !defined(__cplusplus)
85 # define PETSC_DLLEXPORT __attribute__((visibility ("default")))
86 # define PETSC_DLLIMPORT __attribute__((visibility ("default")))
87 # define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden")))
88 #else
89 # define PETSC_DLLEXPORT
90 # define PETSC_DLLIMPORT
91 # define PETSC_VISIBILITY_INTERNAL
92 #endif
93
94 #if defined(petsc_EXPORTS) /* CMake defines this when building the shared library */
95 # define PETSC_VISIBILITY_PUBLIC PETSC_DLLEXPORT
96 #else /* Win32 users need this to import symbols from petsc.dll */
97 # define PETSC_VISIBILITY_PUBLIC PETSC_DLLIMPORT
98 #endif
99
100 /*
101 Functions tagged with PETSC_EXTERN in the header files are
102 always defined as extern "C" when compiled with C++ so they may be
103 used from C and are always visible in the shared libraries
104 */
105 #if defined(__cplusplus)
106 # define PETSC_EXTERN extern "C" PETSC_VISIBILITY_PUBLIC
107 # define PETSC_EXTERN_TYPEDEF extern "C"
108 # define PETSC_INTERN extern "C" PETSC_VISIBILITY_INTERNAL
109 #else
110 # define PETSC_EXTERN extern PETSC_VISIBILITY_PUBLIC
111 # define PETSC_EXTERN_TYPEDEF
112 # define PETSC_INTERN extern PETSC_VISIBILITY_INTERNAL
113 #endif
114
115 #include <petscversion.h>
116 #define PETSC_AUTHOR_INFO " The PETSc Team\n petsc-maint@mcs.anl.gov\n https://www.mcs.anl.gov/petsc/\n"
117
118 /* ========================================================================== */
119
120 /*
121 Defines the interface to MPI allowing the use of all MPI functions.
122
123 PETSc does not use the C++ binding of MPI at ALL. The following flag
124 makes sure the C++ bindings are not included. The C++ bindings REQUIRE
125 putting mpi.h before ANY C++ include files, we cannot control this
126 with all PETSc users. Users who want to use the MPI C++ bindings can include
127 mpicxx.h directly in their code
128 */
129 #if !defined(MPICH_SKIP_MPICXX)
130 # define MPICH_SKIP_MPICXX 1
131 #endif
132 #if !defined(OMPI_SKIP_MPICXX)
133 # define OMPI_SKIP_MPICXX 1
134 #endif
135 #if defined(PETSC_HAVE_MPIUNI)
136 # include <petsc/mpiuni/mpi.h>
137 #else
138 # include <mpi.h>
139 #endif
140
141 /*MC
142 PetscDefined - determine whether a boolean macro is defined
143
144 Notes:
145 The prefix "PETSC_" is added to the argument.
146
147 Typical usage is within normal code,
148
149 $ if (PetscDefined(USE_DEBUG)) { ... }
150
151 but can also be used in the preprocessor,
152
153 $ #if PetscDefined(USE_DEBUG)
154 $ ...
155 $ #else
156
157 Either way, it evaluates true if PETSC_USE_DEBUG is defined (merely defined or defined to 1), and false if PETSC_USE_DEBUG is undefined. This macro
158 should not be used if its argument may be defined to a non-empty value other than 1.
159
160 To avoid prepending "PETSC_", say to add custom checks in user code, one can use e.g.
161
162 $ #define FooDefined(d) PetscDefined_(FOO_ ## d)
163
164 Developer Notes:
165 Getting something that works in C and CPP for an arg that may or may not be defined is tricky. Here, if we have
166 "#define PETSC_HAVE_BOOGER 1" we match on the placeholder define, insert the "0," for arg1 and generate the triplet
167 (0, 1, 0). Then the last step cherry picks the 2nd arg (a one). When PETSC_HAVE_BOOGER is not defined, we generate
168 a (... 1, 0) pair, and when the last step cherry picks the 2nd arg, we get a zero.
169
170 Our extra expansion via PetscDefined__take_second_expand() is needed with MSVC, which has a nonconforming
171 implementation of variadic macros.
172
173 Level: developer
174 M*/
175 #if !defined(PETSC_SKIP_VARIADIC_MACROS)
176 # define PetscDefined_arg_1 shift,
177 # define PetscDefined_arg_ shift,
178 # define PetscDefined__take_second_expanded(ignored, val, ...) val
179 # define PetscDefined__take_second_expand(args) PetscDefined__take_second_expanded args
180 # define PetscDefined__take_second(...) PetscDefined__take_second_expand((__VA_ARGS__))
181 # define PetscDefined___(arg1_or_junk) PetscDefined__take_second(arg1_or_junk 1, 0, at_)
182 # define PetscDefined__(value) PetscDefined___(PetscDefined_arg_ ## value)
183 # define PetscDefined_(d) PetscDefined__(d)
184 # define PetscDefined(d) PetscDefined_(PETSC_ ## d)
185 #endif
186
187 /*
188 Perform various sanity checks that the correct mpi.h is being included at compile time.
189 This usually happens because
190 * either an unexpected mpi.h is in the default compiler path (i.e. in /usr/include) or
191 * an extra include path -I/something (which contains the unexpected mpi.h) is being passed to the compiler
192 */
193 #if defined(PETSC_HAVE_MPIUNI)
194 # if !defined(MPIUNI_H)
195 # error "PETSc was configured with --with-mpi=0 but now appears to be compiling using a different mpi.h"
196 # endif
197 #elif defined(PETSC_HAVE_I_MPI_NUMVERSION)
198 # if !defined(I_MPI_NUMVERSION)
199 # error "PETSc was configured with I_MPI but now appears to be compiling using a non-I_MPI mpi.h"
200 # elif I_MPI_NUMVERSION != PETSC_HAVE_I_MPI_NUMVERSION
201 # 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"
202 # endif
203 #elif defined(PETSC_HAVE_MVAPICH2_NUMVERSION)
204 # if !defined(MVAPICH2_NUMVERSION)
205 # error "PETSc was configured with MVAPICH2 but now appears to be compiling using a non-MVAPICH2 mpi.h"
206 # elif MVAPICH2_NUMVERSION != PETSC_HAVE_MVAPICH2_NUMVERSION
207 # error "PETSc was configured with one MVAPICH2 mpi.h version but now appears to be compiling using a different MVAPICH2 mpi.h version"
208 # endif
209 #elif defined(PETSC_HAVE_MPICH_NUMVERSION)
210 # if !defined(MPICH_NUMVERSION) || defined(MVAPICH2_NUMVERSION) || defined(I_MPI_NUMVERSION)
211 # error "PETSc was configured with MPICH but now appears to be compiling using a non-MPICH mpi.h"
212 # elif (MPICH_NUMVERSION/100000 != PETSC_HAVE_MPICH_NUMVERSION/100000) || (MPICH_NUMVERSION%100000/1000 < PETSC_HAVE_MPICH_NUMVERSION%100000/1000)
213 # error "PETSc was configured with one MPICH mpi.h version but now appears to be compiling using a different MPICH mpi.h version"
214 # endif
215 #elif defined(PETSC_HAVE_OMPI_MAJOR_VERSION)
216 # if !defined(OMPI_MAJOR_VERSION)
217 # error "PETSc was configured with OpenMPI but now appears to be compiling using a non-OpenMPI mpi.h"
218 # elif (OMPI_MAJOR_VERSION != PETSC_HAVE_OMPI_MAJOR_VERSION) || (OMPI_MINOR_VERSION != PETSC_HAVE_OMPI_MINOR_VERSION) || (OMPI_RELEASE_VERSION < PETSC_HAVE_OMPI_RELEASE_VERSION)
219 # error "PETSc was configured with one OpenMPI mpi.h version but now appears to be compiling using a different OpenMPI mpi.h version"
220 # endif
221 #elif defined(PETSC_HAVE_MSMPI_VERSION)
222 # if !defined(MSMPI_VER)
223 # error "PETSc was configured with MSMPI but now appears to be compiling using a non-MSMPI mpi.h"
224 # elif (MSMPI_VER != PETSC_HAVE_MSMPI_VERSION)
225 # error "PETSc was configured with one MSMPI mpi.h version but now appears to be compiling using a different MSMPI mpi.h version"
226 # endif
227 #elif defined(OMPI_MAJOR_VERSION) || defined(MPICH_NUMVERSION) || defined(MSMPI_VER)
228 # error "PETSc was configured with undetermined MPI - but now appears to be compiling using any of OpenMPI, MS-MPI or a MPICH variant"
229 #endif
230
231 /*
232 Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler
233 see the top of mpicxx.h in the MPICH2 distribution.
234 */
235 #include <stdio.h>
236
237 /* MSMPI on 32bit windows requires this yukky hack - that breaks MPI standard compliance */
238 #if !defined(MPIAPI)
239 #define MPIAPI
240 #endif
241
242 /*
243 Support for Clang (>=3.2) matching type tag arguments with void* buffer types.
244 This allows the compiler to detect cases where the MPI datatype argument passed to a MPI routine
245 does not match the actual type of the argument being passed in
246 */
247 #if defined(__has_attribute) && defined(works_with_const_which_is_not_true)
248 # if __has_attribute(argument_with_type_tag) && __has_attribute(pointer_with_type_tag) && __has_attribute(type_tag_for_datatype)
249 # define PetscAttrMPIPointerWithType(bufno,typeno) __attribute__((pointer_with_type_tag(MPI,bufno,typeno)))
250 # define PetscAttrMPITypeTag(type) __attribute__((type_tag_for_datatype(MPI,type)))
251 # define PetscAttrMPITypeTagLayoutCompatible(type) __attribute__((type_tag_for_datatype(MPI,type,layout_compatible)))
252 # endif
253 #endif
254 #if !defined(PetscAttrMPIPointerWithType)
255 # define PetscAttrMPIPointerWithType(bufno,typeno)
256 # define PetscAttrMPITypeTag(type)
257 # define PetscAttrMPITypeTagLayoutCompatible(type)
258 #endif
259
260 PETSC_EXTERN MPI_Datatype MPIU_ENUM PetscAttrMPITypeTag(PetscEnum);
261 PETSC_EXTERN MPI_Datatype MPIU_BOOL PetscAttrMPITypeTag(PetscBool);
262
263 /*MC
264 MPIU_INT - MPI datatype corresponding to PetscInt
265
266 Notes:
267 In MPI calls that require an MPI datatype that matches a PetscInt or array of PetscInt values, pass this value.
268
269 Level: beginner
270
271 .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX
272 M*/
273
274 #if defined(PETSC_HAVE_STDINT_H) && defined(PETSC_HAVE_INTTYPES_H) && defined(PETSC_HAVE_MPI_INT64_T) /* MPI_INT64_T is not guaranteed to be a macro */
275 # define MPIU_INT64 MPI_INT64_T
276 # define PetscInt64_FMT PRId64
277 #elif (PETSC_SIZEOF_LONG_LONG == 8)
278 # define MPIU_INT64 MPI_LONG_LONG_INT
279 # define PetscInt64_FMT "lld"
280 #elif defined(PETSC_HAVE___INT64)
281 # define MPIU_INT64 MPI_INT64_T
282 # define PetscInt64_FMT "ld"
283 #else
284 # error "cannot determine PetscInt64 type"
285 #endif
286
287 PETSC_EXTERN MPI_Datatype MPIU_FORTRANADDR;
288
289 #if defined(PETSC_USE_64BIT_INDICES)
290 # define MPIU_INT MPIU_INT64
291 # define PetscInt_FMT PetscInt64_FMT
292 #else
293 # define MPIU_INT MPI_INT
294 # define PetscInt_FMT "d"
295 #endif
296
297 /*
298 For the rare cases when one needs to send a size_t object with MPI
299 */
300 PETSC_EXTERN MPI_Datatype MPIU_SIZE_T;
301
302 /*
303 You can use PETSC_STDOUT as a replacement of stdout. You can also change
304 the value of PETSC_STDOUT to redirect all standard output elsewhere
305 */
306 PETSC_EXTERN FILE* PETSC_STDOUT;
307
308 /*
309 You can use PETSC_STDERR as a replacement of stderr. You can also change
310 the value of PETSC_STDERR to redirect all standard error elsewhere
311 */
312 PETSC_EXTERN FILE* PETSC_STDERR;
313
314 /*MC
315 PetscUnlikely - hints the compiler that the given condition is usually FALSE
316
317 Synopsis:
318 #include <petscsys.h>
319 PetscBool PetscUnlikely(PetscBool cond)
320
321 Not Collective
322
323 Input Parameters:
324 . cond - condition or expression
325
326 Notes:
327 This returns the same truth value, it is only a hint to compilers that the resulting
328 branch is unlikely.
329
330 Level: advanced
331
332 .seealso: PetscUnlikelyDebug(), PetscLikely(), CHKERRQ
333 M*/
334
335 /*MC
336 PetscLikely - hints the compiler that the given condition is usually TRUE
337
338 Synopsis:
339 #include <petscsys.h>
340 PetscBool PetscLikely(PetscBool cond)
341
342 Not Collective
343
344 Input Parameters:
345 . cond - condition or expression
346
347 Notes:
348 This returns the same truth value, it is only a hint to compilers that the resulting
349 branch is likely.
350
351 Level: advanced
352
353 .seealso: PetscUnlikely()
354 M*/
355 #if defined(PETSC_HAVE_BUILTIN_EXPECT)
356 # define PetscUnlikely(cond) __builtin_expect(!!(cond),0)
357 # define PetscLikely(cond) __builtin_expect(!!(cond),1)
358 #else
359 # define PetscUnlikely(cond) (cond)
360 # define PetscLikely(cond) (cond)
361 #endif
362
363 /*MC
364 PetscUnlikelyDebug - hints the compiler that the given condition is usually FALSE, eliding the check in optimized mode
365
366 Synopsis:
367 #include <petscsys.h>
368 PetscBool PetscUnlikelyDebug(PetscBool cond)
369
370 Not Collective
371
372 Input Parameters:
373 . cond - condition or expression
374
375 Notes:
376 This returns the same truth value, it is only a hint to compilers that the resulting
377 branch is unlikely. When compiled in optimized mode, it always returns false.
378
379 Level: advanced
380
381 .seealso: PetscUnlikely(), CHKERRQ, SETERRQ
382 M*/
383 #define PetscUnlikelyDebug(cond) (PetscDefined(USE_DEBUG) && PetscUnlikely(cond))
384
385 /* PetscPragmaSIMD - from CeedPragmaSIMD */
386
387 #if defined(__INTEL_COMPILER) && !defined(_WIN32)
388 # define PetscPragmaSIMD _Pragma("vector")
389 #elif defined(__GNUC__) && __GNUC__ >= 5
390 # define PetscPragmaSIMD _Pragma("GCC ivdep")
391 #elif defined(_OPENMP) && _OPENMP >= 201307
392 # define PetscPragmaSIMD _Pragma("omp simd")
393 #elif defined(PETSC_HAVE_CRAY_VECTOR)
394 # define PetscPragmaSIMD _Pragma("_CRI ivdep")
395 #else
396 # define PetscPragmaSIMD
397 #endif
398
399 /*
400 Declare extern C stuff after including external header files
401 */
402
403 PETSC_EXTERN const char *const PetscBools[];
404
405 /*
406 Defines elementary mathematics functions and constants.
407 */
408 #include <petscmath.h>
409
410 PETSC_EXTERN const char *const PetscCopyModes[];
411
412 /*MC
413 PETSC_IGNORE - same as NULL, means PETSc will ignore this argument
414
415 Level: beginner
416
417 Note:
418 Accepted by many PETSc functions to not set a parameter and instead use
419 some default
420
421 Fortran Notes:
422 This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER,
423 PETSC_NULL_DOUBLE_PRECISION etc
424
425 .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_DETERMINE
426
427 M*/
428 #define PETSC_IGNORE NULL
429
430 /* This is deprecated */
431 #define PETSC_NULL NULL
432
433 /*MC
434 PETSC_DECIDE - standard way of passing in integer or floating point parameter
435 where you wish PETSc to use the default.
436
437 Level: beginner
438
439 .seealso: PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE
440
441 M*/
442 #define PETSC_DECIDE -1
443
444 /*MC
445 PETSC_DETERMINE - standard way of passing in integer or floating point parameter
446 where you wish PETSc to compute the required value.
447
448 Level: beginner
449
450 Developer Note:
451 I would like to use const PetscInt PETSC_DETERMINE = PETSC_DECIDE; but for
452 some reason this is not allowed by the standard even though PETSC_DECIDE is a constant value.
453
454 .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, VecSetSizes()
455
456 M*/
457 #define PETSC_DETERMINE PETSC_DECIDE
458
459 /*MC
460 PETSC_DEFAULT - standard way of passing in integer or floating point parameter
461 where you wish PETSc to use the default.
462
463 Level: beginner
464
465 Fortran Notes:
466 You need to use PETSC_DEFAULT_INTEGER or PETSC_DEFAULT_REAL.
467
468 .seealso: PETSC_DECIDE, PETSC_IGNORE, PETSC_DETERMINE
469
470 M*/
471 #define PETSC_DEFAULT -2
472
473 /*MC
474 PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents
475 all the processes that PETSc knows about.
476
477 Level: beginner
478
479 Notes:
480 By default PETSC_COMM_WORLD and MPI_COMM_WORLD are identical unless you wish to
481 run PETSc on ONLY a subset of MPI_COMM_WORLD. In that case create your new (smaller)
482 communicator, call it, say comm, and set PETSC_COMM_WORLD = comm BEFORE calling
483 PetscInitialize(), but after MPI_Init() has been called.
484
485 The value of PETSC_COMM_WORLD should never be USED/accessed before PetscInitialize()
486 is called because it may not have a valid value yet.
487
488 .seealso: PETSC_COMM_SELF
489
490 M*/
491 PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD;
492
493 /*MC
494 PETSC_COMM_SELF - This is always MPI_COMM_SELF
495
496 Level: beginner
497
498 Notes:
499 Do not USE/access or set this variable before PetscInitialize() has been called.
500
501 .seealso: PETSC_COMM_WORLD
502
503 M*/
504 #define PETSC_COMM_SELF MPI_COMM_SELF
505
506 /*MC
507 PETSC_MPI_THREAD_REQUIRED - the required threading support used if PETSc initializes
508 MPI with MPI_Init_thread.
509
510 Level: beginner
511
512 Notes:
513 By default PETSC_MPI_THREAD_REQUIRED equals MPI_THREAD_FUNNELED.
514
515 .seealso: PetscInitialize()
516
517 M*/
518 PETSC_EXTERN PetscMPIInt PETSC_MPI_THREAD_REQUIRED;
519
520 PETSC_EXTERN PetscBool PetscBeganMPI;
521 PETSC_EXTERN PetscBool PetscErrorHandlingInitialized;
522 PETSC_EXTERN PetscBool PetscInitializeCalled;
523 PETSC_EXTERN PetscBool PetscFinalizeCalled;
524 PETSC_EXTERN PetscBool PetscViennaCLSynchronize;
525
526 PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm));
527 PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*);
528 PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm*);
529
530 #if defined(PETSC_HAVE_CUDA)
531 PETSC_EXTERN PetscBool PetscCUDASynchronize;
532 PETSC_EXTERN PetscErrorCode PetscCUDAInitialize(MPI_Comm,PetscInt);
533 PETSC_EXTERN PetscErrorCode PetscCUDAInitializeCheck(void);
534 #endif
535
536 #if defined(PETSC_HAVE_HIP)
537 PETSC_EXTERN PetscBool PetscHIPSynchronize;
538 PETSC_EXTERN PetscErrorCode PetscHIPInitialize(MPI_Comm,PetscInt);
539 PETSC_EXTERN PetscErrorCode PetscHIPInitializeCheck(void);
540 #endif
541
542 #if defined(PETSC_HAVE_ELEMENTAL)
543 PETSC_EXTERN PetscErrorCode PetscElementalInitializePackage(void);
544 PETSC_EXTERN PetscErrorCode PetscElementalInitialized(PetscBool*);
545 PETSC_EXTERN PetscErrorCode PetscElementalFinalizePackage(void);
546 #endif
547
548 /*MC
549 PetscMalloc - Allocates memory, One should use PetscNew(), PetscMalloc1() or PetscCalloc1() usually instead of this
550
551 Synopsis:
552 #include <petscsys.h>
553 PetscErrorCode PetscMalloc(size_t m,void **result)
554
555 Not Collective
556
557 Input Parameter:
558 . m - number of bytes to allocate
559
560 Output Parameter:
561 . result - memory allocated
562
563 Level: beginner
564
565 Notes:
566 Memory is always allocated at least double aligned
567
568 It is safe to allocate size 0 and pass the resulting pointer (which may or may not be NULL) to PetscFree().
569
570 .seealso: PetscFree(), PetscNew()
571
572 M*/
573 #define PetscMalloc(a,b) ((*PetscTrMalloc)((a),PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b)))
574
575 /*MC
576 PetscRealloc - Rellocates memory
577
578 Synopsis:
579 #include <petscsys.h>
580 PetscErrorCode PetscRealloc(size_t m,void **result)
581
582 Not Collective
583
584 Input Parameters:
585 + m - number of bytes to allocate
586 - result - previous memory
587
588 Output Parameter:
589 . result - new memory allocated
590
591 Level: developer
592
593 Notes:
594 Memory is always allocated at least double aligned
595
596 .seealso: PetscMalloc(), PetscFree(), PetscNew()
597
598 M*/
599 #define PetscRealloc(a,b) ((*PetscTrRealloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b)))
600
601 /*MC
602 PetscAddrAlign - Rounds up an address to PETSC_MEMALIGN alignment
603
604 Synopsis:
605 #include <petscsys.h>
606 void *PetscAddrAlign(void *addr)
607
608 Not Collective
609
610 Input Parameters:
611 . addr - address to align (any pointer type)
612
613 Level: developer
614
615 .seealso: PetscMallocAlign()
616
617 M*/
618 #define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1))
619
620 /*MC
621 PetscMalloc1 - Allocates an array of memory aligned to PETSC_MEMALIGN
622
623 Synopsis:
624 #include <petscsys.h>
625 PetscErrorCode PetscMalloc1(size_t m1,type **r1)
626
627 Not Collective
628
629 Input Parameter:
630 . m1 - number of elements to allocate (may be zero)
631
632 Output Parameter:
633 . r1 - memory allocated
634
635 Note:
636 This uses the sizeof() of the memory type requested to determine the total memory to be allocated, therefore you should not
637 multiply the number of elements requested by the sizeof() the type. For example use
638 $ PetscInt *id;
639 $ PetscMalloc1(10,&id);
640 not
641 $ PetscInt *id;
642 $ PetscMalloc1(10*sizeof(PetscInt),&id);
643
644 Does not zero the memory allocated, use PetscCalloc1() to obtain memory that has been zeroed.
645
646 Level: beginner
647
648 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2()
649
650 M*/
651 #define PetscMalloc1(m1,r1) PetscMallocA(1,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1))
652
653 /*MC
654 PetscCalloc1 - Allocates a cleared (zeroed) array of memory aligned to PETSC_MEMALIGN
655
656 Synopsis:
657 #include <petscsys.h>
658 PetscErrorCode PetscCalloc1(size_t m1,type **r1)
659
660 Not Collective
661
662 Input Parameter:
663 . m1 - number of elements to allocate in 1st chunk (may be zero)
664
665 Output Parameter:
666 . r1 - memory allocated
667
668 Notes:
669 See PetsMalloc1() for more details on usage.
670
671 Level: beginner
672
673 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2()
674
675 M*/
676 #define PetscCalloc1(m1,r1) PetscMallocA(1,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1))
677
678 /*MC
679 PetscMalloc2 - Allocates 2 arrays of memory both aligned to PETSC_MEMALIGN
680
681 Synopsis:
682 #include <petscsys.h>
683 PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2)
684
685 Not Collective
686
687 Input Parameter:
688 + m1 - number of elements to allocate in 1st chunk (may be zero)
689 - m2 - number of elements to allocate in 2nd chunk (may be zero)
690
691 Output Parameter:
692 + r1 - memory allocated in first chunk
693 - r2 - memory allocated in second chunk
694
695 Level: developer
696
697 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2()
698
699 M*/
700 #define PetscMalloc2(m1,r1,m2,r2) PetscMallocA(2,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2))
701
702 /*MC
703 PetscCalloc2 - Allocates 2 cleared (zeroed) arrays of memory both aligned to PETSC_MEMALIGN
704
705 Synopsis:
706 #include <petscsys.h>
707 PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2)
708
709 Not Collective
710
711 Input Parameter:
712 + m1 - number of elements to allocate in 1st chunk (may be zero)
713 - m2 - number of elements to allocate in 2nd chunk (may be zero)
714
715 Output Parameter:
716 + r1 - memory allocated in first chunk
717 - r2 - memory allocated in second chunk
718
719 Level: developer
720
721 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2()
722
723 M*/
724 #define PetscCalloc2(m1,r1,m2,r2) PetscMallocA(2,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2))
725
726 /*MC
727 PetscMalloc3 - Allocates 3 arrays of memory, all aligned to PETSC_MEMALIGN
728
729 Synopsis:
730 #include <petscsys.h>
731 PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)
732
733 Not Collective
734
735 Input Parameter:
736 + m1 - number of elements to allocate in 1st chunk (may be zero)
737 . m2 - number of elements to allocate in 2nd chunk (may be zero)
738 - m3 - number of elements to allocate in 3rd chunk (may be zero)
739
740 Output Parameter:
741 + r1 - memory allocated in first chunk
742 . r2 - memory allocated in second chunk
743 - r3 - memory allocated in third chunk
744
745 Level: developer
746
747 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc3(), PetscFree3()
748
749 M*/
750 #define PetscMalloc3(m1,r1,m2,r2,m3,r3) PetscMallocA(3,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3))
751
752 /*MC
753 PetscCalloc3 - Allocates 3 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
754
755 Synopsis:
756 #include <petscsys.h>
757 PetscErrorCode PetscCalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)
758
759 Not Collective
760
761 Input Parameter:
762 + m1 - number of elements to allocate in 1st chunk (may be zero)
763 . m2 - number of elements to allocate in 2nd chunk (may be zero)
764 - m3 - number of elements to allocate in 3rd chunk (may be zero)
765
766 Output Parameter:
767 + r1 - memory allocated in first chunk
768 . r2 - memory allocated in second chunk
769 - r3 - memory allocated in third chunk
770
771 Level: developer
772
773 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc2(), PetscMalloc3(), PetscFree3()
774
775 M*/
776 #define PetscCalloc3(m1,r1,m2,r2,m3,r3) PetscMallocA(3,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3))
777
778 /*MC
779 PetscMalloc4 - Allocates 4 arrays of memory, all aligned to PETSC_MEMALIGN
780
781 Synopsis:
782 #include <petscsys.h>
783 PetscErrorCode PetscMalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)
784
785 Not Collective
786
787 Input Parameter:
788 + m1 - number of elements to allocate in 1st chunk (may be zero)
789 . m2 - number of elements to allocate in 2nd chunk (may be zero)
790 . m3 - number of elements to allocate in 3rd chunk (may be zero)
791 - m4 - number of elements to allocate in 4th chunk (may be zero)
792
793 Output Parameter:
794 + r1 - memory allocated in first chunk
795 . r2 - memory allocated in second chunk
796 . r3 - memory allocated in third chunk
797 - r4 - memory allocated in fourth chunk
798
799 Level: developer
800
801 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4()
802
803 M*/
804 #define PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4) PetscMallocA(4,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4))
805
806 /*MC
807 PetscCalloc4 - Allocates 4 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
808
809 Synopsis:
810 #include <petscsys.h>
811 PetscErrorCode PetscCalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)
812
813 Not Collective
814
815 Input Parameters:
816 + m1 - number of elements to allocate in 1st chunk (may be zero)
817 . m2 - number of elements to allocate in 2nd chunk (may be zero)
818 . m3 - number of elements to allocate in 3rd chunk (may be zero)
819 - m4 - number of elements to allocate in 4th chunk (may be zero)
820
821 Output Parameters:
822 + r1 - memory allocated in first chunk
823 . r2 - memory allocated in second chunk
824 . r3 - memory allocated in third chunk
825 - r4 - memory allocated in fourth chunk
826
827 Level: developer
828
829 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4()
830
831 M*/
832 #define PetscCalloc4(m1,r1,m2,r2,m3,r3,m4,r4) PetscMallocA(4,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4))
833
834 /*MC
835 PetscMalloc5 - Allocates 5 arrays of memory, all aligned to PETSC_MEMALIGN
836
837 Synopsis:
838 #include <petscsys.h>
839 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)
840
841 Not Collective
842
843 Input Parameters:
844 + m1 - number of elements to allocate in 1st chunk (may be zero)
845 . m2 - number of elements to allocate in 2nd chunk (may be zero)
846 . m3 - number of elements to allocate in 3rd chunk (may be zero)
847 . m4 - number of elements to allocate in 4th chunk (may be zero)
848 - m5 - number of elements to allocate in 5th chunk (may be zero)
849
850 Output Parameters:
851 + r1 - memory allocated in first chunk
852 . r2 - memory allocated in second chunk
853 . r3 - memory allocated in third chunk
854 . r4 - memory allocated in fourth chunk
855 - r5 - memory allocated in fifth chunk
856
857 Level: developer
858
859 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc5(), PetscFree5()
860
861 M*/
862 #define PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) PetscMallocA(5,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5))
863
864 /*MC
865 PetscCalloc5 - Allocates 5 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
866
867 Synopsis:
868 #include <petscsys.h>
869 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)
870
871 Not Collective
872
873 Input Parameters:
874 + m1 - number of elements to allocate in 1st chunk (may be zero)
875 . m2 - number of elements to allocate in 2nd chunk (may be zero)
876 . m3 - number of elements to allocate in 3rd chunk (may be zero)
877 . m4 - number of elements to allocate in 4th chunk (may be zero)
878 - m5 - number of elements to allocate in 5th chunk (may be zero)
879
880 Output Parameters:
881 + r1 - memory allocated in first chunk
882 . r2 - memory allocated in second chunk
883 . r3 - memory allocated in third chunk
884 . r4 - memory allocated in fourth chunk
885 - r5 - memory allocated in fifth chunk
886
887 Level: developer
888
889 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc5(), PetscFree5()
890
891 M*/
892 #define PetscCalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) PetscMallocA(5,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5))
893
894 /*MC
895 PetscMalloc6 - Allocates 6 arrays of memory, all aligned to PETSC_MEMALIGN
896
897 Synopsis:
898 #include <petscsys.h>
899 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)
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 Parameteasr:
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(), PetscCalloc6(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6()
922
923 M*/
924 #define PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) PetscMallocA(6,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5),(size_t)(m6)*sizeof(**(r6)),(r6))
925
926 /*MC
927 PetscCalloc6 - Allocates 6 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
928
929 Synopsis:
930 #include <petscsys.h>
931 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)
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
943 Output Parameters:
944 + r1 - memory allocated in first chunk
945 . r2 - memory allocated in second chunk
946 . r3 - memory allocated in third chunk
947 . r4 - memory allocated in fourth chunk
948 . r5 - memory allocated in fifth chunk
949 - r6 - memory allocated in sixth chunk
950
951 Level: developer
952
953 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc6(), PetscFree6()
954
955 M*/
956 #define PetscCalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) PetscMallocA(6,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5),(size_t)(m6)*sizeof(**(r6)),(r6))
957
958 /*MC
959 PetscMalloc7 - Allocates 7 arrays of memory, all aligned to PETSC_MEMALIGN
960
961 Synopsis:
962 #include <petscsys.h>
963 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)
964
965 Not Collective
966
967 Input Parameters:
968 + m1 - number of elements to allocate in 1st chunk (may be zero)
969 . m2 - number of elements to allocate in 2nd chunk (may be zero)
970 . m3 - number of elements to allocate in 3rd chunk (may be zero)
971 . m4 - number of elements to allocate in 4th chunk (may be zero)
972 . m5 - number of elements to allocate in 5th chunk (may be zero)
973 . m6 - number of elements to allocate in 6th chunk (may be zero)
974 - m7 - number of elements to allocate in 7th chunk (may be zero)
975
976 Output Parameters:
977 + r1 - memory allocated in first chunk
978 . r2 - memory allocated in second chunk
979 . r3 - memory allocated in third chunk
980 . r4 - memory allocated in fourth chunk
981 . r5 - memory allocated in fifth chunk
982 . r6 - memory allocated in sixth chunk
983 - r7 - memory allocated in seventh chunk
984
985 Level: developer
986
987 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc7(), PetscFree7()
988
989 M*/
990 #define PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) PetscMallocA(7,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5),(size_t)(m6)*sizeof(**(r6)),(r6),(size_t)(m7)*sizeof(**(r7)),(r7))
991
992 /*MC
993 PetscCalloc7 - Allocates 7 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
994
995 Synopsis:
996 #include <petscsys.h>
997 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)
998
999 Not Collective
1000
1001 Input Parameters:
1002 + m1 - number of elements to allocate in 1st chunk (may be zero)
1003 . m2 - number of elements to allocate in 2nd chunk (may be zero)
1004 . m3 - number of elements to allocate in 3rd chunk (may be zero)
1005 . m4 - number of elements to allocate in 4th chunk (may be zero)
1006 . m5 - number of elements to allocate in 5th chunk (may be zero)
1007 . m6 - number of elements to allocate in 6th chunk (may be zero)
1008 - m7 - number of elements to allocate in 7th chunk (may be zero)
1009
1010 Output Parameters:
1011 + r1 - memory allocated in first chunk
1012 . r2 - memory allocated in second chunk
1013 . r3 - memory allocated in third chunk
1014 . r4 - memory allocated in fourth chunk
1015 . r5 - memory allocated in fifth chunk
1016 . r6 - memory allocated in sixth chunk
1017 - r7 - memory allocated in seventh chunk
1018
1019 Level: developer
1020
1021 .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc7(), PetscFree7()
1022
1023 M*/
1024 #define PetscCalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) PetscMallocA(7,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5),(size_t)(m6)*sizeof(**(r6)),(r6),(size_t)(m7)*sizeof(**(r7)),(r7))
1025
1026 /*MC
1027 PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to PETSC_MEMALIGN
1028
1029 Synopsis:
1030 #include <petscsys.h>
1031 PetscErrorCode PetscNew(type **result)
1032
1033 Not Collective
1034
1035 Output Parameter:
1036 . result - memory allocated, sized to match pointer type
1037
1038 Level: beginner
1039
1040 .seealso: PetscFree(), PetscMalloc(), PetscNewLog(), PetscCalloc1(), PetscMalloc1()
1041
1042 M*/
1043 #define PetscNew(b) PetscCalloc1(1,(b))
1044
1045 /*MC
1046 PetscNewLog - Allocates memory of a type matching pointer, zeros the memory! Aligned to PETSC_MEMALIGN. Associates the memory allocated
1047 with the given object using PetscLogObjectMemory().
1048
1049 Synopsis:
1050 #include <petscsys.h>
1051 PetscErrorCode PetscNewLog(PetscObject obj,type **result)
1052
1053 Not Collective
1054
1055 Input Parameter:
1056 . obj - object memory is logged to
1057
1058 Output Parameter:
1059 . result - memory allocated, sized to match pointer type
1060
1061 Level: developer
1062
1063 .seealso: PetscFree(), PetscMalloc(), PetscNew(), PetscLogObjectMemory(), PetscCalloc1(), PetscMalloc1()
1064
1065 M*/
1066 #define PetscNewLog(o,b) (PetscNew((b)) || PetscLogObjectMemory((PetscObject)o,sizeof(**(b))))
1067
1068 /*MC
1069 PetscFree - Frees memory
1070
1071 Synopsis:
1072 #include <petscsys.h>
1073 PetscErrorCode PetscFree(void *memory)
1074
1075 Not Collective
1076
1077 Input Parameter:
1078 . memory - memory to free (the pointer is ALWAYS set to NULL upon success)
1079
1080 Level: beginner
1081
1082 Notes:
1083 Do not free memory obtained with PetscMalloc2(), PetscCalloc2() etc, they must be freed with PetscFree2() etc.
1084
1085 It is safe to call PetscFree() on a NULL pointer.
1086
1087 .seealso: PetscNew(), PetscMalloc(), PetscNewLog(), PetscMalloc1(), PetscCalloc1()
1088
1089 M*/
1090 #define PetscFree(a) ((*PetscTrFree)((void*)(a),__LINE__,PETSC_FUNCTION_NAME,__FILE__) || ((a) = NULL,0))
1091
1092 /*MC
1093 PetscFree2 - Frees 2 chunks of memory obtained with PetscMalloc2()
1094
1095 Synopsis:
1096 #include <petscsys.h>
1097 PetscErrorCode PetscFree2(void *memory1,void *memory2)
1098
1099 Not Collective
1100
1101 Input Parameters:
1102 + memory1 - memory to free
1103 - memory2 - 2nd memory to free
1104
1105 Level: developer
1106
1107 Notes:
1108 Memory must have been obtained with PetscMalloc2()
1109
1110 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree()
1111
1112 M*/
1113 #define PetscFree2(m1,m2) PetscFreeA(2,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2))
1114
1115 /*MC
1116 PetscFree3 - Frees 3 chunks of memory obtained with PetscMalloc3()
1117
1118 Synopsis:
1119 #include <petscsys.h>
1120 PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3)
1121
1122 Not Collective
1123
1124 Input Parameters:
1125 + memory1 - memory to free
1126 . memory2 - 2nd memory to free
1127 - memory3 - 3rd memory to free
1128
1129 Level: developer
1130
1131 Notes:
1132 Memory must have been obtained with PetscMalloc3()
1133
1134 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3()
1135
1136 M*/
1137 #define PetscFree3(m1,m2,m3) PetscFreeA(3,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3))
1138
1139 /*MC
1140 PetscFree4 - Frees 4 chunks of memory obtained with PetscMalloc4()
1141
1142 Synopsis:
1143 #include <petscsys.h>
1144 PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4)
1145
1146 Not Collective
1147
1148 Input Parameters:
1149 + m1 - memory to free
1150 . m2 - 2nd memory to free
1151 . m3 - 3rd memory to free
1152 - m4 - 4th memory to free
1153
1154 Level: developer
1155
1156 Notes:
1157 Memory must have been obtained with PetscMalloc4()
1158
1159 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4()
1160
1161 M*/
1162 #define PetscFree4(m1,m2,m3,m4) PetscFreeA(4,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4))
1163
1164 /*MC
1165 PetscFree5 - Frees 5 chunks of memory obtained with PetscMalloc5()
1166
1167 Synopsis:
1168 #include <petscsys.h>
1169 PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5)
1170
1171 Not Collective
1172
1173 Input Parameters:
1174 + m1 - memory to free
1175 . m2 - 2nd memory to free
1176 . m3 - 3rd memory to free
1177 . m4 - 4th memory to free
1178 - m5 - 5th memory to free
1179
1180 Level: developer
1181
1182 Notes:
1183 Memory must have been obtained with PetscMalloc5()
1184
1185 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5()
1186
1187 M*/
1188 #define PetscFree5(m1,m2,m3,m4,m5) PetscFreeA(5,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5))
1189
1190 /*MC
1191 PetscFree6 - Frees 6 chunks of memory obtained with PetscMalloc6()
1192
1193 Synopsis:
1194 #include <petscsys.h>
1195 PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6)
1196
1197 Not Collective
1198
1199 Input Parameters:
1200 + m1 - memory to free
1201 . m2 - 2nd memory to free
1202 . m3 - 3rd memory to free
1203 . m4 - 4th memory to free
1204 . m5 - 5th memory to free
1205 - m6 - 6th memory to free
1206
1207
1208 Level: developer
1209
1210 Notes:
1211 Memory must have been obtained with PetscMalloc6()
1212
1213 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6()
1214
1215 M*/
1216 #define PetscFree6(m1,m2,m3,m4,m5,m6) PetscFreeA(6,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5),&(m6))
1217
1218 /*MC
1219 PetscFree7 - Frees 7 chunks of memory obtained with PetscMalloc7()
1220
1221 Synopsis:
1222 #include <petscsys.h>
1223 PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7)
1224
1225 Not Collective
1226
1227 Input Parameters:
1228 + m1 - memory to free
1229 . m2 - 2nd memory to free
1230 . m3 - 3rd memory to free
1231 . m4 - 4th memory to free
1232 . m5 - 5th memory to free
1233 . m6 - 6th memory to free
1234 - m7 - 7th memory to free
1235
1236
1237 Level: developer
1238
1239 Notes:
1240 Memory must have been obtained with PetscMalloc7()
1241
1242 .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(),
1243 PetscMalloc7()
1244
1245 M*/
1246 #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) PetscFreeA(7,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5),&(m6),&(m7))
1247
1248 PETSC_EXTERN PetscErrorCode PetscMallocA(int,PetscBool,int,const char *,const char *,size_t,void *,...);
1249 PETSC_EXTERN PetscErrorCode PetscFreeA(int,int,const char *,const char *,void *,...);
1250 PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t,PetscBool,int,const char[],const char[],void**);
1251 PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[]);
1252 PETSC_EXTERN PetscErrorCode (*PetscTrRealloc)(size_t,int,const char[],const char[],void**);
1253 PETSC_EXTERN PetscErrorCode PetscMallocSetCoalesce(PetscBool);
1254 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 **));
1255 PETSC_EXTERN PetscErrorCode PetscMallocClear(void);
1256
1257 /*
1258 Unlike PetscMallocSet and PetscMallocClear which overwrite the existing settings, these two functions save the previous choice of allocator, and should be used in pair.
1259 */
1260 PETSC_EXTERN PetscErrorCode PetscMallocSetDRAM(void);
1261 PETSC_EXTERN PetscErrorCode PetscMallocResetDRAM(void);
1262 #if defined(PETSC_HAVE_CUDA)
1263 PETSC_EXTERN PetscErrorCode PetscMallocSetCUDAHost(void);
1264 PETSC_EXTERN PetscErrorCode PetscMallocResetCUDAHost(void);
1265 #endif
1266
1267 #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE
1268 #define MPIU_2PETSCLOGDOUBLE MPI_2DOUBLE_PRECISION
1269
1270 /*
1271 Routines for tracing memory corruption/bleeding with default PETSc memory allocation
1272 */
1273 PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *);
1274 PETSC_EXTERN PetscErrorCode PetscMallocView(FILE *);
1275 PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *);
1276 PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *);
1277 PETSC_EXTERN PetscErrorCode PetscMallocPushMaximumUsage(int);
1278 PETSC_EXTERN PetscErrorCode PetscMallocPopMaximumUsage(int,PetscLogDouble*);
1279 PETSC_EXTERN PetscErrorCode PetscMallocSetDebug(PetscBool,PetscBool);
1280 PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool*,PetscBool*,PetscBool*);
1281 PETSC_EXTERN PetscErrorCode PetscMallocValidate(int,const char[],const char[]);
1282 PETSC_EXTERN PetscErrorCode PetscMallocViewSet(PetscLogDouble);
1283 PETSC_EXTERN PetscErrorCode PetscMallocViewGet(PetscBool*);
1284 PETSC_EXTERN PetscErrorCode PetscMallocLogRequestedSizeSet(PetscBool);
1285 PETSC_EXTERN PetscErrorCode PetscMallocLogRequestedSizeGet(PetscBool*);
1286
1287 PETSC_EXTERN const char *const PetscDataTypes[];
1288 PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*);
1289 PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*);
1290 PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*);
1291 PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char*,PetscDataType*,PetscBool*);
1292
1293 /*
1294 Basic memory and string operations. These are usually simple wrappers
1295 around the basic Unix system calls, but a few of them have additional
1296 functionality and/or error checking.
1297 */
1298 PETSC_EXTERN PetscErrorCode PetscMemcmp(const void*,const void*,size_t,PetscBool *);
1299 PETSC_EXTERN PetscErrorCode PetscStrlen(const char[],size_t*);
1300 PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[],char,int*,char ***);
1301 PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int,char **);
1302 PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[],const char[],PetscBool *);
1303 PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[],const char[],PetscBool *);
1304 PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[],const char[],PetscBool *);
1305 PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[],const char[],size_t,PetscBool *);
1306 PETSC_EXTERN PetscErrorCode PetscStrcpy(char[],const char[]);
1307 PETSC_EXTERN PetscErrorCode PetscStrcat(char[],const char[]);
1308 PETSC_EXTERN PetscErrorCode PetscStrlcat(char[],const char[],size_t);
1309 PETSC_EXTERN PetscErrorCode PetscStrncpy(char[],const char[],size_t);
1310 PETSC_EXTERN PetscErrorCode PetscStrchr(const char[],char,char *[]);
1311 PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]);
1312 PETSC_EXTERN PetscErrorCode PetscStrtoupper(char[]);
1313 PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[],char,char *[]);
1314 PETSC_EXTERN PetscErrorCode PetscStrstr(const char[],const char[],char *[]);
1315 PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[],const char[],char *[]);
1316 PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[],const char[],PetscBool*);
1317 PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[],const char[],PetscBool*);
1318 PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[],const char *const*,PetscInt*);
1319 PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[],char *[]);
1320 PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const*,char***);
1321 PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char***);
1322 PETSC_EXTERN PetscErrorCode PetscStrNArrayallocpy(PetscInt,const char *const*,char***);
1323 PETSC_EXTERN PetscErrorCode PetscStrNArrayDestroy(PetscInt,char***);
1324 PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm,const char[],char[],size_t);
1325
1326 PETSC_EXTERN void PetscStrcmpNoError(const char[],const char[],PetscBool *);
1327
1328 PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*);
1329 PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]);
1330 PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*);
1331
1332 PETSC_EXTERN PetscErrorCode PetscStrInList(const char[],const char[],char,PetscBool*);
1333 PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt,const char *const*,const char*,PetscInt*,PetscBool*);
1334 PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const*,const char*,PetscEnum*,PetscBool*);
1335
1336 /*
1337 These are MPI operations for MPI_Allreduce() etc
1338 */
1339 PETSC_EXTERN MPI_Op MPIU_MAXSUM_OP;
1340 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1341 PETSC_EXTERN MPI_Op MPIU_SUM;
1342 #else
1343 #define MPIU_SUM MPI_SUM
1344 #endif
1345 #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1346 PETSC_EXTERN MPI_Op MPIU_MAX;
1347 PETSC_EXTERN MPI_Op MPIU_MIN;
1348 #else
1349 #define MPIU_MAX MPI_MAX
1350 #define MPIU_MIN MPI_MIN
1351 #endif
1352 PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*);
1353
1354 PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1355 PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1356
1357 PETSC_EXTERN const char *const PetscFileModes[];
1358
1359 /*
1360 Defines PETSc error handling.
1361 */
1362 #include <petscerror.h>
1363
1364 #define PETSC_SMALLEST_CLASSID 1211211
1365 PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID;
1366 PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID;
1367 PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *);
1368 PETSC_EXTERN PetscErrorCode PetscObjectGetId(PetscObject,PetscObjectId*);
1369 PETSC_EXTERN PetscErrorCode PetscObjectCompareId(PetscObject,PetscObjectId,PetscBool*);
1370
1371
1372 /*
1373 Routines that get memory usage information from the OS
1374 */
1375 PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *);
1376 PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *);
1377 PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void);
1378 PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]);
1379
1380 PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal);
1381
1382 /*
1383 Initialization of PETSc
1384 */
1385 PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]);
1386 PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]);
1387 PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void);
1388 PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *);
1389 PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *);
1390 PETSC_EXTERN PetscErrorCode PetscFinalize(void);
1391 PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void);
1392 PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***);
1393 PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***);
1394 PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **);
1395
1396 PETSC_EXTERN PetscErrorCode PetscEnd(void);
1397 PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void);
1398
1399 PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]);
1400 PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void);
1401 PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void);
1402 PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]);
1403
1404 PETSC_EXTERN PetscErrorCode PetscMonitorCompare(PetscErrorCode (*)(void),void *,PetscErrorCode (*)(void**),PetscErrorCode (*)(void),void *,PetscErrorCode (*)(void**),PetscBool *);
1405
1406
1407 /*
1408 These are so that in extern C code we can caste function pointers to non-extern C
1409 function pointers. Since the regular C++ code expects its function pointers to be C++
1410 */
1411 PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void);
1412 PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void);
1413 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void);
1414
1415 /*
1416 Functions that can act on any PETSc object.
1417 */
1418 PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject*);
1419 PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject,MPI_Comm *);
1420 PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject,PetscClassId *);
1421 PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject,const char *[]);
1422 PETSC_EXTERN PetscErrorCode PetscObjectSetType(PetscObject,const char []);
1423 PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject,const char *[]);
1424 PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject,const char[]);
1425 PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject,const char*[]);
1426 PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject,PetscInt);
1427 PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject,PetscInt*);
1428 PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt);
1429 PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject);
1430 PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject,PetscInt*);
1431 PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject);
1432 PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject,PetscMPIInt*);
1433 PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject,const char[],PetscObject);
1434 PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject,const char[]);
1435 PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject,const char[],PetscObject*);
1436 PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject,const char[],void (*)(void));
1437 #define PetscObjectComposeFunction(a,b,d) PetscObjectComposeFunction_Private(a,b,(PetscVoidFunction)(d))
1438 PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject);
1439 PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject);
1440 PETSC_EXTERN PetscErrorCode PetscObjectSetPrintedOptions(PetscObject);
1441 PETSC_EXTERN PetscErrorCode PetscObjectInheritPrintedOptions(PetscObject,PetscObject);
1442 PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm,PetscMPIInt*);
1443
1444 #include <petscviewertypes.h>
1445 #include <petscoptions.h>
1446
1447 PETSC_EXTERN PetscErrorCode PetscMallocTraceSet(PetscViewer,PetscBool,PetscLogDouble);
1448 PETSC_EXTERN PetscErrorCode PetscMallocTraceGet(PetscBool*);
1449
1450 PETSC_EXTERN PetscErrorCode PetscObjectsListGetGlobalNumbering(MPI_Comm,PetscInt,PetscObject*,PetscInt*,PetscInt*);
1451
1452 PETSC_EXTERN PetscErrorCode PetscMemoryShowUsage(PetscViewer,const char[]);
1453 PETSC_EXTERN PetscErrorCode PetscMemoryView(PetscViewer,const char[]);
1454 PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject,PetscViewer);
1455 PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject,PetscViewer);
1456 #define PetscObjectQueryFunction(obj,name,fptr) PetscObjectQueryFunction_Private((obj),(name),(PetscVoidFunction*)(fptr))
1457 PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject,const char[],void (**)(void));
1458 PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject,const char[]);
1459 PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject,const char[]);
1460 PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject,const char[]);
1461 PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject,const char*[]);
1462 PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject,const char[]);
1463 PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject);
1464 PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void);
1465 PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject,PetscObject,const char[]);
1466 PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject);
1467 PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject,const char[],PetscBool *);
1468 PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompare(PetscObject,const char[],PetscBool *);
1469 PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject,PetscBool*,const char[],...);
1470 PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompareAny(PetscObject,PetscBool*,const char[],...);
1471 PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void));
1472 PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void);
1473
1474 #if defined(PETSC_HAVE_SAWS)
1475 PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void);
1476 PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject);
1477 PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject,PetscBool);
1478 PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject);
1479 PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject);
1480 PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject);
1481 PETSC_EXTERN void PetscStackSAWsGrantAccess(void);
1482 PETSC_EXTERN void PetscStackSAWsTakeAccess(void);
1483 PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void);
1484 PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void);
1485
1486 #else
1487 #define PetscSAWsBlock() 0
1488 #define PetscObjectSAWsViewOff(obj) 0
1489 #define PetscObjectSAWsSetBlock(obj,flg) 0
1490 #define PetscObjectSAWsBlock(obj) 0
1491 #define PetscObjectSAWsGrantAccess(obj) 0
1492 #define PetscObjectSAWsTakeAccess(obj) 0
1493 #define PetscStackViewSAWs() 0
1494 #define PetscStackSAWsViewOff() 0
1495 #define PetscStackSAWsTakeAccess()
1496 #define PetscStackSAWsGrantAccess()
1497
1498 #endif
1499
1500 PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *);
1501 PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *);
1502 PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **);
1503
1504 #if defined(PETSC_USE_DEBUG)
1505 PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**);
1506 #endif
1507 PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool);
1508
1509 PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList*);
1510 PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList,const char[],PetscObject*);
1511 PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList,PetscObject,char**,PetscBool*);
1512 PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *,const char[],PetscObject);
1513 PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *,const char[]);
1514 PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList,PetscObjectList *);
1515
1516 /*
1517 Dynamic library lists. Lists of names of routines in objects or in dynamic
1518 link libraries that will be loaded as needed.
1519 */
1520
1521 #define PetscFunctionListAdd(list,name,fptr) PetscFunctionListAdd_Private((list),(name),(PetscVoidFunction)(fptr))
1522 PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList*,const char[],void (*)(void));
1523 PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList*);
1524 #define PetscFunctionListFind(list,name,fptr) PetscFunctionListFind_Private((list),(name),(PetscVoidFunction*)(fptr))
1525 PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList,const char[],void (**)(void));
1526 PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFunctionList,const char[],const char[]);
1527 PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList,PetscFunctionList *);
1528 PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList,PetscViewer);
1529 PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList,const char ***,int*);
1530
1531 PETSC_EXTERN PetscDLLibrary PetscDLLibrariesLoaded;
1532 PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]);
1533 PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]);
1534 PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **);
1535 PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary);
1536 PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool *);
1537 PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *);
1538 PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary);
1539
1540 /*
1541 Useful utility routines
1542 */
1543 PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*);
1544 PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*);
1545 PETSC_EXTERN PetscErrorCode PetscSplitOwnershipEqual(MPI_Comm,PetscInt*,PetscInt*);
1546 PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt);
1547 PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt);
1548 PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject);
1549 PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*);
1550 PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxInt(MPI_Comm,PetscInt[],PetscInt[]);
1551 PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxReal(MPI_Comm,PetscReal[],PetscReal[]);
1552
1553 /*MC
1554 PetscNot - negates a logical type value and returns result as a PetscBool
1555
1556 Notes:
1557 This is useful in cases like
1558 $ int *a;
1559 $ PetscBool flag = PetscNot(a)
1560 where !a would not return a PetscBool because we cannot provide a cast from int to PetscBool in C.
1561
1562 Level: beginner
1563
1564 .seealso : PetscBool, PETSC_TRUE, PETSC_FALSE
1565 M*/
1566 #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)
1567
1568 /*MC
1569 PetscHelpPrintf - Prints help messages.
1570
1571 Synopsis:
1572 #include <petscsys.h>
1573 PetscErrorCode (*PetscHelpPrintf)(const char format[],...);
1574
1575 Not Collective
1576
1577 Input Parameters:
1578 . format - the usual printf() format string
1579
1580 Level: developer
1581
1582 Fortran Note:
1583 This routine is not supported in Fortran.
1584
1585
1586 .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf()
1587 M*/
1588 PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...);
1589
1590 /*
1591 Defines PETSc profiling.
1592 */
1593 #include <petsclog.h>
1594
1595 /*
1596 Simple PETSc parallel IO for ASCII printing
1597 */
1598 PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]);
1599 PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**);
1600 PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*);
1601 PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...);
1602 PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...);
1603 PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...);
1604 PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...);
1605 PETSC_EXTERN PetscErrorCode PetscFormatRealArray(char[],size_t,const char*,PetscInt,const PetscReal[]);
1606
1607 PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...);
1608 PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...);
1609 PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...);
1610
1611 PETSC_EXTERN PetscErrorCode PetscFormatConvertGetSize(const char*,size_t*);
1612 PETSC_EXTERN PetscErrorCode PetscFormatConvert(const char*,char *);
1613
1614 #if defined(PETSC_HAVE_POPEN)
1615 PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **);
1616 PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm,FILE*);
1617 PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]);
1618 #endif
1619
1620 PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm,const char[],...);
1621 PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...);
1622 PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm,FILE*);
1623 PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]);
1624 PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**);
1625 PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm,const char[],const char[],FILE**);
1626 PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char*[]);
1627
1628 PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID;
1629 PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer,void**);
1630 PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer,void*);
1631 PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer*);
1632 PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm,PetscContainer*);
1633 PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer,PetscErrorCode (*)(void*));
1634 PETSC_EXTERN PetscErrorCode PetscContainerUserDestroyDefault(void*);
1635
1636 /*
1637 For use in debuggers
1638 */
1639 PETSC_EXTERN PetscMPIInt PetscGlobalRank;
1640 PETSC_EXTERN PetscMPIInt PetscGlobalSize;
1641 PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt,const PetscInt[],PetscViewer);
1642 PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt,const PetscReal[],PetscViewer);
1643 PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt,const PetscScalar[],PetscViewer);
1644
1645 #include <stddef.h>
1646 #include <string.h> /* for memcpy, memset */
1647 #include <stdlib.h>
1648
1649 #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__)
1650 #include <xmmintrin.h>
1651 #endif
1652
1653 /*@C
1654 PetscMemmove - Copies n bytes, beginning at location b, to the space
1655 beginning at location a. Copying between regions that overlap will
1656 take place correctly. Use PetscMemcpy() if the locations do not overlap
1657
1658 Not Collective
1659
1660 Input Parameters:
1661 + b - pointer to initial memory space
1662 . a - pointer to copy space
1663 - n - length (in bytes) of space to copy
1664
1665 Level: intermediate
1666
1667 Note:
1668 PetscArraymove() is preferred
1669 This routine is analogous to memmove().
1670
1671 Developers Note: This is inlined for performance
1672
1673 .seealso: PetscMemcpy(), PetscMemcmp(), PetscArrayzero(), PetscMemzero(), PetscArraycmp(), PetscArraycpy(), PetscStrallocpy(),
1674 PetscArraymove()
1675 @*/
PetscMemmove(void * a,const void * b,size_t n)1676 PETSC_STATIC_INLINE PetscErrorCode PetscMemmove(void *a,const void *b,size_t n)
1677 {
1678 PetscFunctionBegin;
1679 if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to null pointer");
1680 if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer");
1681 #if !defined(PETSC_HAVE_MEMMOVE)
1682 if (a < b) {
1683 if (a <= b - n) memcpy(a,b,n);
1684 else {
1685 memcpy(a,b,(int)(b - a));
1686 PetscMemmove(b,b + (int)(b - a),n - (int)(b - a));
1687 }
1688 } else {
1689 if (b <= a - n) memcpy(a,b,n);
1690 else {
1691 memcpy(b + n,b + (n - (int)(a - b)),(int)(a - b));
1692 PetscMemmove(a,b,n - (int)(a - b));
1693 }
1694 }
1695 #else
1696 memmove((char*)(a),(char*)(b),n);
1697 #endif
1698 PetscFunctionReturn(0);
1699 }
1700
1701 /*@C
1702 PetscMemcpy - Copies n bytes, beginning at location b, to the space
1703 beginning at location a. The two memory regions CANNOT overlap, use
1704 PetscMemmove() in that case.
1705
1706 Not Collective
1707
1708 Input Parameters:
1709 + b - pointer to initial memory space
1710 - n - length (in bytes) of space to copy
1711
1712 Output Parameter:
1713 . a - pointer to copy space
1714
1715 Level: intermediate
1716
1717 Compile Option:
1718 PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used
1719 for memory copies on double precision values.
1720 PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used
1721 for memory copies on double precision values.
1722 PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used
1723 for memory copies on double precision values.
1724
1725 Note:
1726 Prefer PetscArraycpy()
1727 This routine is analogous to memcpy().
1728 Not available from Fortran
1729
1730 Developer Note: this is inlined for fastest performance
1731
1732 .seealso: PetscMemzero(), PetscMemcmp(), PetscArrayzero(), PetscArraycmp(), PetscArraycpy(), PetscMemmove(), PetscStrallocpy()
1733
1734 @*/
PetscMemcpy(void * a,const void * b,size_t n)1735 PETSC_STATIC_INLINE PetscErrorCode PetscMemcpy(void *a,const void *b,size_t n)
1736 {
1737 #if defined(PETSC_USE_DEBUG)
1738 size_t al = (size_t) a,bl = (size_t) b;
1739 size_t nl = (size_t) n;
1740 PetscFunctionBegin;
1741 if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer");
1742 if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer");
1743 #else
1744 PetscFunctionBegin;
1745 #endif
1746 if (a != b && n > 0) {
1747 #if defined(PETSC_USE_DEBUG)
1748 if ((al > bl && (al - bl) < nl) || (bl - al) < nl) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Memory regions overlap: either use PetscMemmov()\n\
1749 or make sure your copy regions and lengths are correct. \n\
1750 Length (bytes) %ld first address %ld second address %ld",nl,al,bl);
1751 #endif
1752 #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY))
1753 if (!(a % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1754 size_t len = n/sizeof(PetscScalar);
1755 #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY)
1756 PetscBLASInt one = 1,blen;
1757 PetscErrorCode ierr;
1758 ierr = PetscBLASIntCast(len,&blen);CHKERRQ(ierr);
1759 PetscStackCallBLAS("BLAScopy",BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one));
1760 #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY)
1761 fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a);
1762 #else
1763 size_t i;
1764 PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a;
1765 for (i=0; i<len; i++) y[i] = x[i];
1766 #endif
1767 } else {
1768 memcpy((char*)(a),(char*)(b),n);
1769 }
1770 #else
1771 memcpy((char*)(a),(char*)(b),n);
1772 #endif
1773 }
1774 PetscFunctionReturn(0);
1775 }
1776
1777 /*@C
1778 PetscMemzero - Zeros the specified memory.
1779
1780 Not Collective
1781
1782 Input Parameters:
1783 + a - pointer to beginning memory location
1784 - n - length (in bytes) of memory to initialize
1785
1786 Level: intermediate
1787
1788 Compile Option:
1789 PETSC_PREFER_BZERO - on certain machines (the IBM RS6000) the bzero() routine happens
1790 to be faster than the memset() routine. This flag causes the bzero() routine to be used.
1791
1792 Not available from Fortran
1793 Prefer PetscArrayzero()
1794
1795 Developer Note: this is inlined for fastest performance
1796
1797 .seealso: PetscMemcpy(), PetscMemcmp(), PetscArrayzero(), PetscArraycmp(), PetscArraycpy(), PetscMemmove(), PetscStrallocpy()
1798 @*/
PetscMemzero(void * a,size_t n)1799 PETSC_STATIC_INLINE PetscErrorCode PetscMemzero(void *a,size_t n)
1800 {
1801 if (n > 0) {
1802 #if defined(PETSC_USE_DEBUG)
1803 if (!a) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer with %zu bytes",n);
1804 #endif
1805 #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO)
1806 if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1807 size_t i,len = n/sizeof(PetscScalar);
1808 PetscScalar *x = (PetscScalar*)a;
1809 for (i=0; i<len; i++) x[i] = 0.0;
1810 } else {
1811 #elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
1812 if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1813 PetscInt len = n/sizeof(PetscScalar);
1814 fortranzero_(&len,(PetscScalar*)a);
1815 } else {
1816 #endif
1817 #if defined(PETSC_PREFER_BZERO)
1818 bzero((char *)a,n);
1819 #else
1820 memset((char*)a,0,n);
1821 #endif
1822 #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
1823 }
1824 #endif
1825 }
1826 return 0;
1827 }
1828
1829 /*MC
1830 PetscArraycmp - Compares two arrays in memory.
1831
1832 Synopsis:
1833 #include <petscsys.h>
1834 PetscErrorCode PetscArraycmp(const anytype *str1,const anytype *str2,size_t cnt,PetscBool *e)
1835
1836 Not Collective
1837
1838 Input Parameters:
1839 + str1 - First array
1840 . str2 - Second array
1841 - cnt - Count of the array, not in bytes, but number of entries in the arrays
1842
1843 Output Parameters:
1844 . e - PETSC_TRUE if equal else PETSC_FALSE.
1845
1846 Level: intermediate
1847
1848 Note:
1849 This routine is a preferred replacement to PetscMemcmp()
1850 The arrays must be of the same type
1851
1852 .seealso: PetscMemcpy(), PetscMemcmp(), PetscArrayzero(), PetscMemzero(), PetscArraycpy(), PetscMemmove(), PetscStrallocpy(),
1853 PetscArraymove()
1854 M*/
1855 #define PetscArraycmp(str1,str2,cnt,e) ((sizeof(*(str1)) != sizeof(*(str2))) || PetscMemcmp(str1,str2,(size_t)(cnt)*sizeof(*(str1)),e))
1856
1857 /*MC
1858 PetscArraymove - Copies from one array in memory to another, the arrays may overlap. Use PetscArraycpy() when the arrays
1859 do not overlap
1860
1861 Synopsis:
1862 #include <petscsys.h>
1863 PetscErrorCode PetscArraymove(anytype *str1,const anytype *str2,size_t cnt)
1864
1865 Not Collective
1866
1867 Input Parameters:
1868 + str1 - First array
1869 . str2 - Second array
1870 - cnt - Count of the array, not in bytes, but number of entries in the arrays
1871
1872 Level: intermediate
1873
1874 Note:
1875 This routine is a preferred replacement to PetscMemmove()
1876 The arrays must be of the same type
1877
1878 .seealso: PetscMemcpy(), PetscMemcmp(), PetscArrayzero(), PetscMemzero(), PetscArraycpy(), PetscMemmove(), PetscArraycmp(), PetscStrallocpy()
1879 M*/
1880 #define PetscArraymove(str1,str2,cnt) ((sizeof(*(str1)) != sizeof(*(str2))) || PetscMemmove(str1,str2,(size_t)(cnt)*sizeof(*(str1))))
1881
1882 /*MC
1883 PetscArraycpy - Copies from one array in memory to another
1884
1885 Synopsis:
1886 #include <petscsys.h>
1887 PetscErrorCode PetscArraycpy(anytype *str1,const anytype *str2,size_t cnt)
1888
1889 Not Collective
1890
1891 Input Parameters:
1892 + str1 - First array (destination)
1893 . str2 - Second array (source)
1894 - cnt - Count of the array, not in bytes, but number of entries in the arrays
1895
1896 Level: intermediate
1897
1898 Note:
1899 This routine is a preferred replacement to PetscMemcpy()
1900 The arrays must be of the same type
1901
1902 .seealso: PetscMemcpy(), PetscMemcmp(), PetscArrayzero(), PetscMemzero(), PetscArraymove(), PetscMemmove(), PetscArraycmp(), PetscStrallocpy()
1903 M*/
1904 #define PetscArraycpy(str1,str2,cnt) ((sizeof(*(str1)) != sizeof(*(str2))) || PetscMemcpy(str1,str2,(size_t)(cnt)*sizeof(*(str1))))
1905
1906 /*MC
1907 PetscArrayzero - Zeros an array in memory.
1908
1909 Synopsis:
1910 #include <petscsys.h>
1911 PetscErrorCode PetscArrayzero(anytype *str1,size_t cnt)
1912
1913 Not Collective
1914
1915 Input Parameters:
1916 + str1 - array
1917 - cnt - Count of the array, not in bytes, but number of entries in the array
1918
1919 Level: intermediate
1920
1921 Note:
1922 This routine is a preferred replacement to PetscMemzero()
1923
1924 .seealso: PetscMemcpy(), PetscMemcmp(), PetscMemzero(), PetscArraycmp(), PetscArraycpy(), PetscMemmove(), PetscStrallocpy(), PetscArraymove()
1925 M*/
1926 #define PetscArrayzero(str1,cnt) PetscMemzero(str1,(size_t)(cnt)*sizeof(*(str1)))
1927
1928 /*MC
1929 PetscPrefetchBlock - Prefetches a block of memory
1930
1931 Synopsis:
1932 #include <petscsys.h>
1933 void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t)
1934
1935 Not Collective
1936
1937 Input Parameters:
1938 + a - pointer to first element to fetch (any type but usually PetscInt or PetscScalar)
1939 . n - number of elements to fetch
1940 . rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors)
1941 - t - temporal locality (PETSC_PREFETCH_HINT_{NTA,T0,T1,T2}), see note
1942
1943 Level: developer
1944
1945 Notes:
1946 The last two arguments (rw and t) must be compile-time constants.
1947
1948 Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality. Not all architectures offer
1949 equivalent locality hints, but the following macros are always defined to their closest analogue.
1950 + PETSC_PREFETCH_HINT_NTA - Non-temporal. Prefetches directly to L1, evicts to memory (skips higher level cache unless it was already there when prefetched).
1951 . 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.
1952 . PETSC_PREFETCH_HINT_T1 - Fetch to level 2 and higher (not L1).
1953 - PETSC_PREFETCH_HINT_T2 - Fetch to high-level cache only. (On many systems, T0 and T1 are equivalent.)
1954
1955 This function does nothing on architectures that do not support prefetch and never errors (even if passed an invalid
1956 address).
1957
1958 M*/
1959 #define PetscPrefetchBlock(a,n,rw,t) do { \
1960 const char *_p = (const char*)(a),*_end = (const char*)((a)+(n)); \
1961 for (; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p,(rw),(t)); \
1962 } while (0)
1963
1964 /*
1965 Determine if some of the kernel computation routines use
1966 Fortran (rather than C) for the numerical calculations. On some machines
1967 and compilers (like complex numbers) the Fortran version of the routines
1968 is faster than the C/C++ versions. The flag --with-fortran-kernels
1969 should be used with ./configure to turn these on.
1970 */
1971 #if defined(PETSC_USE_FORTRAN_KERNELS)
1972
1973 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL)
1974 #define PETSC_USE_FORTRAN_KERNEL_MULTCRL
1975 #endif
1976
1977 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM)
1978 #define PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM
1979 #endif
1980
1981 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
1982 #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
1983 #endif
1984
1985 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
1986 #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
1987 #endif
1988
1989 #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM)
1990 #define PETSC_USE_FORTRAN_KERNEL_NORM
1991 #endif
1992
1993 #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
1994 #define PETSC_USE_FORTRAN_KERNEL_MAXPY
1995 #endif
1996
1997 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
1998 #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
1999 #endif
2000
2001 #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ)
2002 #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ
2003 #endif
2004
2005 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
2006 #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
2007 #endif
2008
2009 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
2010 #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
2011 #endif
2012
2013 #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
2014 #define PETSC_USE_FORTRAN_KERNEL_MDOT
2015 #endif
2016
2017 #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
2018 #define PETSC_USE_FORTRAN_KERNEL_XTIMESY
2019 #endif
2020
2021 #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX)
2022 #define PETSC_USE_FORTRAN_KERNEL_AYPX
2023 #endif
2024
2025 #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY)
2026 #define PETSC_USE_FORTRAN_KERNEL_WAXPY
2027 #endif
2028
2029 #endif
2030
2031 /*
2032 Macros for indicating code that should be compiled with a C interface,
2033 rather than a C++ interface. Any routines that are dynamically loaded
2034 (such as the PCCreate_XXX() routines) must be wrapped so that the name
2035 mangler does not change the functions symbol name. This just hides the
2036 ugly extern "C" {} wrappers.
2037 */
2038 #if defined(__cplusplus)
2039 # define EXTERN_C_BEGIN extern "C" {
2040 # define EXTERN_C_END }
2041 #else
2042 # define EXTERN_C_BEGIN
2043 # define EXTERN_C_END
2044 #endif
2045
2046 /* --------------------------------------------------------------------*/
2047
2048 /*MC
2049 MPI_Comm - the basic object used by MPI to determine which processes are involved in a
2050 communication
2051
2052 Level: beginner
2053
2054 Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm
2055
2056 .seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF
2057 M*/
2058
2059 #if defined(PETSC_HAVE_MPIIO)
2060 PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2061 PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2062 PETSC_EXTERN PetscErrorCode MPIU_File_write_at(MPI_File,MPI_Offset,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2063 PETSC_EXTERN PetscErrorCode MPIU_File_read_at(MPI_File,MPI_Offset,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2064 PETSC_EXTERN PetscErrorCode MPIU_File_write_at_all(MPI_File,MPI_Offset,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2065 PETSC_EXTERN PetscErrorCode MPIU_File_read_at_all(MPI_File,MPI_Offset,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2066 #endif
2067
2068 /* the following petsc_static_inline require petscerror.h */
2069
2070 /* Limit MPI to 32-bits */
2071 #define PETSC_MPI_INT_MAX 2147483647
2072 #define PETSC_MPI_INT_MIN -2147483647
2073 /* Limit BLAS to 32-bits */
2074 #define PETSC_BLAS_INT_MAX 2147483647
2075 #define PETSC_BLAS_INT_MIN -2147483647
2076
2077 /*@C
2078 PetscIntCast - casts a PetscInt64 (which is 64 bits in size) to a PetscInt (which may be 32 bits in size), generates an
2079 error if the PetscInt is not large enough to hold the number.
2080
2081 Not Collective
2082
2083 Input Parameter:
2084 . a - the PetscInt64 value
2085
2086 Output Parameter:
2087 . b - the resulting PetscInt value
2088
2089 Level: advanced
2090
2091 Notes: 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 ints
2092
2093 Not available from Fortran
2094
2095 .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscMPIIntCast(), PetscBLASIntCast()
2096 @*/
2097 PETSC_STATIC_INLINE PetscErrorCode PetscIntCast(PetscInt64 a,PetscInt *b)
2098 {
2099 PetscFunctionBegin;
2100 #if !defined(PETSC_USE_64BIT_INDICES)
2101 if ((a) > PETSC_MAX_INT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Integer too long for PetscInt, you may need to ./configure using --with-64-bit-indices");
2102 #endif
2103 *b = (PetscInt)(a);
2104 PetscFunctionReturn(0);
2105 }
2106
2107 /*@C
2108 PetscBLASIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscBLASInt (which may be 32 bits in size), generates an
2109 error if the PetscBLASInt is not large enough to hold the number.
2110
2111 Not Collective
2112
2113 Input Parameter:
2114 . a - the PetscInt value
2115
2116 Output Parameter:
2117 . b - the resulting PetscBLASInt value
2118
2119 Level: advanced
2120
2121 Notes:
2122 Not available from Fortran
2123 Errors if the integer is negative since PETSc calls to BLAS/LAPACK never need to cast negative integer inputs
2124
2125 .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscMPIIntCast(), PetscIntCast()
2126 @*/
2127 PETSC_STATIC_INLINE PetscErrorCode PetscBLASIntCast(PetscInt a,PetscBLASInt *b)
2128 {
2129 PetscFunctionBegin;
2130 #if defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_HAVE_64BIT_BLAS_INDICES)
2131 *b = 0;
2132 if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK");
2133 #endif
2134 if (a < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Passing negative integer to BLAS/LAPACK routine");
2135 *b = (PetscBLASInt)(a);
2136 PetscFunctionReturn(0);
2137 }
2138
2139 /*@C
2140 PetscMPIIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscMPIInt (which may be 32 bits in size), generates an
2141 error if the PetscMPIInt is not large enough to hold the number.
2142
2143 Not Collective
2144
2145 Input Parameter:
2146 . a - the PetscInt value
2147
2148 Output Parameter:
2149 . b - the resulting PetscMPIInt value
2150
2151 Level: advanced
2152
2153 Not available from Fortran
2154
2155 .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntCast()
2156 @*/
2157 PETSC_STATIC_INLINE PetscErrorCode PetscMPIIntCast(PetscInt a,PetscMPIInt *b)
2158 {
2159 PetscFunctionBegin;
2160 #if defined(PETSC_USE_64BIT_INDICES)
2161 *b = 0;
2162 if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for MPI");
2163 #endif
2164 *b = (PetscMPIInt)(a);
2165 PetscFunctionReturn(0);
2166 }
2167
2168 #define PetscInt64Mult(a,b) ((PetscInt64)(a))*((PetscInt64)(b))
2169
2170 /*@C
2171
2172 PetscRealIntMultTruncate - Computes the product of a positive PetscReal and a positive PetscInt and truncates the value to slightly less than the maximal possible value
2173
2174 Not Collective
2175
2176 Input Parameter:
2177 + a - the PetscReal value
2178 - b - the second value
2179
2180 Returns:
2181 the result as a PetscInt value
2182
2183 Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2184 Use PetscIntMultTruncate() to compute the product of two positive PetscInt and truncate to fit a PetscInt
2185 Use PetscIntMultError() to compute the product of two PetscInt if you wish to generate an error if the result will not fit in a PetscInt
2186
2187 Developers Note:
2188 We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks.
2189
2190 This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2191
2192 Not available from Fortran
2193
2194 Level: advanced
2195
2196 .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2197 @*/
2198 PETSC_STATIC_INLINE PetscInt PetscRealIntMultTruncate(PetscReal a,PetscInt b)
2199 {
2200 PetscInt64 r;
2201
2202 r = (PetscInt64) (a*(PetscReal)b);
2203 if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2204 return (PetscInt) r;
2205 }
2206
2207 /*@C
2208
2209 PetscIntMultTruncate - Computes the product of two positive PetscInt and truncates the value to slightly less than the maximal possible value
2210
2211 Not Collective
2212
2213 Input Parameter:
2214 + a - the PetscInt value
2215 - b - the second value
2216
2217 Returns:
2218 the result as a PetscInt value
2219
2220 Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2221 Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
2222 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
2223
2224 Not available from Fortran
2225
2226 Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks.
2227
2228 This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2229
2230 Level: advanced
2231
2232 .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2233 @*/
2234 PETSC_STATIC_INLINE PetscInt PetscIntMultTruncate(PetscInt a,PetscInt b)
2235 {
2236 PetscInt64 r;
2237
2238 r = PetscInt64Mult(a,b);
2239 if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2240 return (PetscInt) r;
2241 }
2242
2243 /*@C
2244
2245 PetscIntSumTruncate - Computes the sum of two positive PetscInt and truncates the value to slightly less than the maximal possible value
2246
2247 Not Collective
2248
2249 Input Parameter:
2250 + a - the PetscInt value
2251 - b - the second value
2252
2253 Returns:
2254 the result as a PetscInt value
2255
2256 Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2257 Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
2258 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
2259
2260 This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2261
2262 Not available from Fortran
2263
2264 Level: advanced
2265
2266 .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2267 @*/
2268 PETSC_STATIC_INLINE PetscInt PetscIntSumTruncate(PetscInt a,PetscInt b)
2269 {
2270 PetscInt64 r;
2271
2272 r = ((PetscInt64)a) + ((PetscInt64)b);
2273 if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2274 return (PetscInt) r;
2275 }
2276
2277 /*@C
2278
2279 PetscIntMultError - Computes the product of two positive PetscInt and generates an error with overflow.
2280
2281 Not Collective
2282
2283 Input Parameter:
2284 + a - the PetscInt value
2285 - b - the second value
2286
2287 Output Parameter:ma
2288 . result - the result as a PetscInt value, or NULL if you do not want the result, you just want to check if it overflows
2289
2290 Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64
2291 Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt
2292
2293 Not available from Fortran
2294
2295 Developers Note: We currently assume that PetscInt addition does not overflow, this is obviously wrong but requires many more checks.
2296
2297 Level: advanced
2298
2299 .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntMult64(), PetscIntSumError()
2300 @*/
2301 PETSC_STATIC_INLINE PetscErrorCode PetscIntMultError(PetscInt a,PetscInt b,PetscInt *result)
2302 {
2303 PetscInt64 r;
2304
2305 PetscFunctionBegin;
2306 r = PetscInt64Mult(a,b);
2307 #if !defined(PETSC_USE_64BIT_INDICES)
2308 if (r > PETSC_MAX_INT) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_SUP,"Product of two integer %d %d overflow, you must ./configure PETSc with --with-64-bit-indices for the case you are running",a,b);
2309 #endif
2310 if (result) *result = (PetscInt) r;
2311 PetscFunctionReturn(0);
2312 }
2313
2314 /*@C
2315
2316 PetscIntSumError - Computes the sum of two positive PetscInt and generates an error with overflow.
2317
2318 Not Collective
2319
2320 Input Parameter:
2321 + a - the PetscInt value
2322 - b - the second value
2323
2324 Output Parameter:ma
2325 . c - the result as a PetscInt value, or NULL if you do not want the result, you just want to check if it overflows
2326
2327 Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64
2328 Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt
2329
2330 Not available from Fortran
2331
2332 Level: advanced
2333
2334 .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2335 @*/
2336 PETSC_STATIC_INLINE PetscErrorCode PetscIntSumError(PetscInt a,PetscInt b,PetscInt *result)
2337 {
2338 PetscInt64 r;
2339
2340 PetscFunctionBegin;
2341 r = ((PetscInt64)a) + ((PetscInt64)b);
2342 #if !defined(PETSC_USE_64BIT_INDICES)
2343 if (r > PETSC_MAX_INT) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_SUP,"Sum of two integer %d %d overflow, you must ./configure PETSc with --with-64-bit-indices for the case you are running",a,b);
2344 #endif
2345 if (result) *result = (PetscInt) r;
2346 PetscFunctionReturn(0);
2347 }
2348
2349 /*
2350 The IBM include files define hz, here we hide it so that it may be used as a regular user variable.
2351 */
2352 #if defined(hz)
2353 # undef hz
2354 #endif
2355
2356 #include <limits.h>
2357
2358 /* The number of bits in a byte */
2359
2360 #define PETSC_BITS_PER_BYTE CHAR_BIT
2361
2362 #if defined(PETSC_HAVE_SYS_TYPES_H)
2363 # include <sys/types.h>
2364 #endif
2365
2366 /*MC
2367
2368 PETSC_VERSION - This manual page provides information about how PETSc documents and uses its version information. This information is available to both C/C++
2369 and Fortran compilers when petscsys.h is included.
2370
2371
2372 The current PETSc version and the API for accessing it are defined in petscversion.h
2373
2374 The complete version number is given as the triple PETSC_VERSION_MAJOR.PETSC_VERSION_MINOR.PETSC_VERSION_SUBMINOR (in short hand x.y.z)
2375
2376 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
2377 where only a change in the major version number (x) indicates a change in the API.
2378
2379 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
2380
2381 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),
2382 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
2383 version number (x.y.z).
2384
2385 PETSC_RELEASE_DATE is the date the x.y version was released (i.e. the version before any patch releases)
2386
2387 PETSC_VERSION_DATE is the date the x.y.z version was released
2388
2389 PETSC_VERSION_GIT is the last git commit to the repository given in the form vx.y.z-wwwww
2390
2391 PETSC_VERSION_DATE_GIT is the date of the last git commit to the repository
2392
2393 Level: intermediate
2394
2395 PETSC_VERSION_() and PETSC_VERSION_PATCH are deprecated and will eventually be removed. For several releases PETSC_VERSION_PATCH is always 0
2396
2397 M*/
2398
2399 /*MC
2400
2401 UsingFortran - To use PETSc with Fortran you must use both PETSc include files and modules. At the beginning
2402 of every function and module definition you need something like
2403
2404 $
2405 $#include "petsc/finclude/petscXXX.h"
2406 $ use petscXXX
2407
2408 You can declare PETSc variables using either of the following.
2409
2410 $ XXX variablename
2411 $ type(tXXX) variablename
2412
2413 For example,
2414
2415 $#include "petsc/finclude/petscvec.h"
2416 $ use petscvec
2417 $
2418 $ Vec b
2419 $ type(tVec) x
2420
2421 Level: beginner
2422
2423 M*/
2424
2425 PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t);
2426 PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t);
2427 PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t);
2428 PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t);
2429 PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]);
2430 PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t);
2431 PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t);
2432 PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt*,PetscInt*,PetscInt*,PetscInt*);
2433
2434 PETSC_EXTERN PetscErrorCode PetscSortedInt(PetscInt,const PetscInt[],PetscBool*);
2435 PETSC_EXTERN PetscErrorCode PetscSortedMPIInt(PetscInt,const PetscMPIInt[],PetscBool*);
2436 PETSC_EXTERN PetscErrorCode PetscSortedReal(PetscInt,const PetscReal[],PetscBool*);
2437 PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt,PetscInt[]);
2438 PETSC_EXTERN PetscErrorCode PetscSortReverseInt(PetscInt,PetscInt[]);
2439 PETSC_EXTERN PetscErrorCode PetscSortedRemoveDupsInt(PetscInt*,PetscInt[]);
2440 PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt*,PetscInt[]);
2441 PETSC_EXTERN PetscErrorCode PetscCheckDupsInt(PetscInt,const PetscInt[],PetscBool*);
2442 PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt*);
2443 PETSC_EXTERN PetscErrorCode PetscFindMPIInt(PetscMPIInt, PetscInt, const PetscMPIInt[], PetscInt*);
2444 PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]);
2445 PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]);
2446 PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]);
2447 PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt,PetscInt[],PetscInt[],PetscInt[]);
2448 PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt,PetscMPIInt[]);
2449 PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt*,PetscMPIInt[]);
2450 PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]);
2451 PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithIntArray(PetscMPIInt,PetscMPIInt[],PetscInt[]);
2452 PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]);
2453 PETSC_EXTERN PetscErrorCode PetscSortIntWithDataArray(PetscInt,PetscInt[],void*,size_t,void*);
2454 PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt,PetscReal[]);
2455 PETSC_EXTERN PetscErrorCode PetscSortRealWithArrayInt(PetscInt,PetscReal[],PetscInt[]);
2456 PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]);
2457 PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt*,PetscReal[]);
2458 PETSC_EXTERN PetscErrorCode PetscFindReal(PetscReal,PetscInt,const PetscReal[],PetscReal,PetscInt*);
2459 PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]);
2460 PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]);
2461 PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt,const PetscBool [],const PetscInt[],PetscInt*,PetscInt**,PetscInt**,PetscInt**,PetscInt**);
2462 PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt,const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],PetscInt*,PetscInt**,PetscInt**);
2463 PETSC_EXTERN PetscErrorCode PetscMergeIntArray(PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt*,PetscInt**);
2464 PETSC_EXTERN PetscErrorCode PetscMergeMPIIntArray(PetscInt,const PetscMPIInt[],PetscInt,const PetscMPIInt[],PetscInt*,PetscMPIInt**);
2465 PETSC_EXTERN PetscErrorCode PetscParallelSortedInt(MPI_Comm, PetscInt, const PetscInt[], PetscBool *);
2466
2467 PETSC_EXTERN PetscErrorCode PetscTimSort(PetscInt,void*,size_t,int(*)(const void*,const void*,void*),void*);
2468 PETSC_EXTERN PetscErrorCode PetscIntSortSemiOrdered(PetscInt,PetscInt[]);
2469 PETSC_EXTERN PetscErrorCode PetscMPIIntSortSemiOrdered(PetscInt,PetscMPIInt[]);
2470 PETSC_EXTERN PetscErrorCode PetscRealSortSemiOrdered(PetscInt,PetscReal[]);
2471 PETSC_EXTERN PetscErrorCode PetscTimSortWithArray(PetscInt,void*,size_t,void*,size_t,int(*)(const void*,const void*,void*),void*);
2472 PETSC_EXTERN PetscErrorCode PetscIntSortSemiOrderedWithArray(PetscInt,PetscInt[],PetscInt[]);
2473 PETSC_EXTERN PetscErrorCode PetscMPIIntSortSemiOrderedWithArray(PetscInt,PetscMPIInt[],PetscMPIInt[]);
2474 PETSC_EXTERN PetscErrorCode PetscRealSortSemiOrderedWithArrayInt(PetscInt,PetscReal[],PetscInt[]);
2475
2476 PETSC_EXTERN PetscErrorCode PetscSetDisplay(void);
2477 PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t);
2478
2479 /*J
2480 PetscRandomType - String with the name of a PETSc randomizer
2481
2482 Level: beginner
2483
2484 Notes:
2485 To use SPRNG or RANDOM123 you must have ./configure PETSc
2486 with the option --download-sprng or --download-random123
2487
2488 .seealso: PetscRandomSetType(), PetscRandom, PetscRandomCreate()
2489 J*/
2490 typedef const char* PetscRandomType;
2491 #define PETSCRAND "rand"
2492 #define PETSCRAND48 "rand48"
2493 #define PETSCSPRNG "sprng"
2494 #define PETSCRANDER48 "rander48"
2495 #define PETSCRANDOM123 "random123"
2496
2497 /* Logging support */
2498 PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID;
2499
2500 PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void);
2501
2502 /* Dynamic creation and loading functions */
2503 PETSC_EXTERN PetscFunctionList PetscRandomList;
2504
2505 PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],PetscErrorCode (*)(PetscRandom));
2506 PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType);
2507 PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom);
2508 PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType*);
2509 PETSC_EXTERN PetscErrorCode PetscRandomViewFromOptions(PetscRandom,PetscObject,const char[]);
2510 PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer);
2511
2512 PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*);
2513 PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*);
2514 PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*);
2515 PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*);
2516 PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar);
2517 PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long);
2518 PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *);
2519 PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom);
2520 PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*);
2521
2522 PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t);
2523 PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t);
2524 PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t);
2525 PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]);
2526 PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t);
2527 PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *);
2528 PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *);
2529 PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]);
2530 PETSC_EXTERN PetscErrorCode PetscMkdtemp(char[]);
2531 PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]);
2532
2533 PETSC_STATIC_INLINE PetscBool PetscBinaryBigEndian(void) {long _petsc_v = 1; return ((char*)&_petsc_v)[0] ? PETSC_FALSE : PETSC_TRUE;}
2534
2535 PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscInt*,PetscDataType);
2536 PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscInt*,PetscDataType);
2537 PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,const void*,PetscInt,PetscDataType);
2538 PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,const void*,PetscInt,PetscDataType);
2539 PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *);
2540 PETSC_EXTERN PetscErrorCode PetscBinaryClose(int);
2541 PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool *);
2542 PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool *);
2543 PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t);
2544 PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *);
2545 PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *);
2546 #if defined(PETSC_USE_SOCKET_VIEWER)
2547 PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[],int,int*);
2548 #endif
2549
2550 PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*);
2551 PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*);
2552 PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt);
2553
2554 PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]);
2555 PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool);
2556 PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void);
2557 PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*);
2558 PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void);
2559 PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void);
2560 PETSC_EXTERN PetscErrorCode PetscWaitOnError(void);
2561
2562 PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*);
2563 PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**);
2564 PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**);
2565 PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**);
2566 PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**);
2567 PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt*,const void*,PetscMPIInt*,PetscMPIInt**,void*)
2568 PetscAttrMPIPointerWithType(6,3);
2569 PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedF(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
2570 PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
2571 PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
2572 PetscAttrMPIPointerWithType(6,3);
2573 PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedFReq(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
2574 MPI_Request**,MPI_Request**,
2575 PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
2576 PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
2577 PetscAttrMPIPointerWithType(6,3);
2578
2579 PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[];
2580 PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm,PetscBuildTwoSidedType);
2581 PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm,PetscBuildTwoSidedType*);
2582
2583 PETSC_EXTERN PetscErrorCode PetscSSEIsEnabled(MPI_Comm,PetscBool*,PetscBool*);
2584
2585 PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject);
2586
2587 PETSC_EXTERN const char *const PetscSubcommTypes[];
2588
2589 struct _n_PetscSubcomm {
2590 MPI_Comm parent; /* parent communicator */
2591 MPI_Comm dupparent; /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */
2592 MPI_Comm child; /* the sub-communicator */
2593 PetscMPIInt n; /* num of subcommunicators under the parent communicator */
2594 PetscMPIInt color; /* color of processors belong to this communicator */
2595 PetscMPIInt *subsize; /* size of subcommunicator[color] */
2596 PetscSubcommType type;
2597 char *subcommprefix;
2598 };
2599
2600 PETSC_STATIC_INLINE MPI_Comm PetscSubcommParent(PetscSubcomm scomm) {return scomm->parent;}
2601 PETSC_STATIC_INLINE MPI_Comm PetscSubcommChild(PetscSubcomm scomm) {return scomm->child;}
2602 PETSC_STATIC_INLINE MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm) {return scomm->dupparent;}
2603 PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*);
2604 PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*);
2605 PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt);
2606 PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType);
2607 PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt);
2608 PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm,PetscViewer);
2609 PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm);
2610 PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm,const char[]);
2611 PETSC_EXTERN PetscErrorCode PetscSubcommGetParent(PetscSubcomm,MPI_Comm*);
2612 PETSC_EXTERN PetscErrorCode PetscSubcommGetContiguousParent(PetscSubcomm,MPI_Comm*);
2613 PETSC_EXTERN PetscErrorCode PetscSubcommGetChild(PetscSubcomm,MPI_Comm*);
2614
2615 PETSC_EXTERN PetscErrorCode PetscHeapCreate(PetscInt,PetscHeap*);
2616 PETSC_EXTERN PetscErrorCode PetscHeapAdd(PetscHeap,PetscInt,PetscInt);
2617 PETSC_EXTERN PetscErrorCode PetscHeapPop(PetscHeap,PetscInt*,PetscInt*);
2618 PETSC_EXTERN PetscErrorCode PetscHeapPeek(PetscHeap,PetscInt*,PetscInt*);
2619 PETSC_EXTERN PetscErrorCode PetscHeapStash(PetscHeap,PetscInt,PetscInt);
2620 PETSC_EXTERN PetscErrorCode PetscHeapUnstash(PetscHeap);
2621 PETSC_EXTERN PetscErrorCode PetscHeapDestroy(PetscHeap*);
2622 PETSC_EXTERN PetscErrorCode PetscHeapView(PetscHeap,PetscViewer);
2623
2624 PETSC_EXTERN PetscErrorCode PetscProcessPlacementView(PetscViewer);
2625 PETSC_EXTERN PetscErrorCode PetscShmCommGet(MPI_Comm,PetscShmComm*);
2626 PETSC_EXTERN PetscErrorCode PetscShmCommGlobalToLocal(PetscShmComm,PetscMPIInt,PetscMPIInt*);
2627 PETSC_EXTERN PetscErrorCode PetscShmCommLocalToGlobal(PetscShmComm,PetscMPIInt,PetscMPIInt*);
2628 PETSC_EXTERN PetscErrorCode PetscShmCommGetMpiShmComm(PetscShmComm,MPI_Comm*);
2629
2630 /* routines to better support OpenMP multithreading needs of some PETSc third party libraries */
2631 PETSC_EXTERN PetscErrorCode PetscOmpCtrlCreate(MPI_Comm,PetscInt,PetscOmpCtrl*);
2632 PETSC_EXTERN PetscErrorCode PetscOmpCtrlGetOmpComms(PetscOmpCtrl,MPI_Comm*,MPI_Comm*,PetscBool*);
2633 PETSC_EXTERN PetscErrorCode PetscOmpCtrlDestroy(PetscOmpCtrl*);
2634 PETSC_EXTERN PetscErrorCode PetscOmpCtrlBarrier(PetscOmpCtrl);
2635 PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterBegin(PetscOmpCtrl);
2636 PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterEnd(PetscOmpCtrl);
2637
2638 PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t,size_t,PetscSegBuffer*);
2639 PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer*);
2640 PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer,size_t,void*);
2641 PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer,void*);
2642 PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer,void*);
2643 PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer,void*);
2644 PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer,size_t*);
2645 PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer,size_t);
2646
2647
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 PETSC_STATIC_INLINE PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg,size_t count,PetscInt *PETSC_RESTRICT *slot) {return PetscSegBufferGet(seg,count,(void**)slot);}
2652
2653 extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton;
2654 PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted*);
2655 PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted*);
2656 PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted,const char*,const char*,PetscBool*);
2657
2658 #include <stdarg.h>
2659 PETSC_EXTERN PetscErrorCode PetscVSNPrintf(char*,size_t,const char[],size_t*,va_list);
2660 PETSC_EXTERN PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list);
2661
2662 PETSC_EXTERN PetscSegBuffer PetscCitationsList;
2663
2664 /*@C
2665 PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used in the code.
2666
2667 Not Collective - only what is registered on rank 0 of PETSC_COMM_WORLD will be printed
2668
2669 Input Parameters:
2670 + cite - the bibtex item, formated to displayed on multiple lines nicely
2671 - set - a boolean variable initially set to PETSC_FALSE; this is used to insure only a single registration of the citation
2672
2673 Level: intermediate
2674
2675 Not available from Fortran
2676
2677 Options Database:
2678 . -citations [filename] - print out the bibtex entries for the given computation
2679 @*/
2680 PETSC_STATIC_INLINE PetscErrorCode PetscCitationsRegister(const char cit[],PetscBool *set)
2681 {
2682 size_t len;
2683 char *vstring;
2684 PetscErrorCode ierr;
2685
2686 PetscFunctionBegin;
2687 if (set && *set) PetscFunctionReturn(0);
2688 ierr = PetscStrlen(cit,&len);CHKERRQ(ierr);
2689 ierr = PetscSegBufferGet(PetscCitationsList,len,&vstring);CHKERRQ(ierr);
2690 ierr = PetscArraycpy(vstring,cit,len);CHKERRQ(ierr);
2691 if (set) *set = PETSC_TRUE;
2692 PetscFunctionReturn(0);
2693 }
2694
2695 PETSC_EXTERN PetscErrorCode PetscURLShorten(const char[],char[],size_t);
2696 PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm,char[],char[],size_t);
2697 PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm,const char[],char[],size_t);
2698 PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm,const char[],const char []);
2699
2700 PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm,char[],char[],size_t);
2701 PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm,const char[],char[],char[],size_t);
2702
2703 PETSC_EXTERN PetscErrorCode PetscGlobusGetTransfers(MPI_Comm,const char[],char[],size_t);
2704
2705 PETSC_EXTERN PetscErrorCode PetscTextBelt(MPI_Comm,const char[],const char[],PetscBool*);
2706 PETSC_EXTERN PetscErrorCode PetscTellMyCell(MPI_Comm,const char[],const char[],PetscBool*);
2707
2708 PETSC_EXTERN PetscErrorCode PetscPullJSONValue(const char[],const char[],char[],size_t,PetscBool*);
2709 PETSC_EXTERN PetscErrorCode PetscPushJSONValue(char[],const char[],const char[],size_t);
2710
2711
2712 #if defined(PETSC_USE_DEBUG)
2713 /*
2714 Verify that all processes in the communicator have called this from the same line of code
2715 */
2716 PETSC_EXTERN PetscErrorCode PetscAllreduceBarrierCheck(MPI_Comm,PetscMPIInt,int,const char*,const char *);
2717
2718 /*MC
2719 MPIU_Allreduce - a PETSc replacement for MPI_Allreduce() that tries to determine if the call from all the MPI processes occur from the
2720 same place in the PETSc code. This helps to detect bugs where different MPI processes follow different code paths
2721 resulting in inconsistent and incorrect calls to MPI_Allreduce().
2722
2723 Collective
2724
2725 Synopsis:
2726 #include <petscsys.h>
2727 PetscErrorCode MPIU_Allreduce(void *indata,void *outdata,PetscMPIInt count,MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);
2728
2729 Input Parameters:
2730 + indata - pointer to the input data to be reduced
2731 . count - the number of MPI data items in indata and outdata
2732 . datatype - the MPI datatype, for example MPI_INT
2733 . op - the MPI operation, for example MPI_SUM
2734 - comm - the MPI communicator on which the operation occurs
2735
2736 Output Parameter:
2737 . outdata - the reduced values
2738
2739 Notes:
2740 In optimized mode this directly calls MPI_Allreduce()
2741
2742 Level: developer
2743
2744 .seealso: MPI_Allreduce()
2745 M*/
2746 #define MPIU_Allreduce(a,b,c,d,e,fcomm) (PetscAllreduceBarrierCheck(fcomm,c,__LINE__,PETSC_FUNCTION_NAME,__FILE__) || MPI_Allreduce(a,b,c,d,e,fcomm))
2747 #else
2748 #define MPIU_Allreduce(a,b,c,d,e,fcomm) MPI_Allreduce(a,b,c,d,e,fcomm)
2749 #endif
2750
2751 #if defined(PETSC_HAVE_MPI_PROCESS_SHARED_MEMORY)
2752 PETSC_EXTERN PetscErrorCode MPIU_Win_allocate_shared(MPI_Aint,PetscMPIInt,MPI_Info,MPI_Comm,void*,MPI_Win*);
2753 PETSC_EXTERN PetscErrorCode MPIU_Win_shared_query(MPI_Win,PetscMPIInt,MPI_Aint*,PetscMPIInt*,void*);
2754 #endif
2755
2756 /*
2757 Returned from PETSc functions that are called from MPI, such as related to attributes
2758 */
2759 PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CLASS;
2760 PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CODE;
2761
2762 #endif
2763