Actual source code: petscsys.h
petsc-3.9.4 2018-09-11
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: */
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>
17: #if defined(PETSC_DESIRE_FEATURE_TEST_MACROS)
18: /*
19: Feature test macros must be included before headers defined by IEEE Std 1003.1-2001
20: We only turn these in PETSc source files that require them by setting PETSC_DESIRE_FEATURE_TEST_MACROS
21: */
22: #if defined(PETSC__POSIX_C_SOURCE_200112L) && !defined(_POSIX_C_SOURCE)
23: #define _POSIX_C_SOURCE 200112L
24: #endif
25: #if defined(PETSC__BSD_SOURCE) && !defined(_BSD_SOURCE)
26: #define _BSD_SOURCE
27: #endif
28: #if defined(PETSC__DEFAULT_SOURCE) && !defined(_DEFAULT_SOURCE)
29: #define _DEFAULT_SOURCE
30: #endif
31: #if defined(PETSC__GNU_SOURCE) && !defined(_GNU_SOURCE)
32: #define _GNU_SOURCE
33: #endif
34: #endif
36: /* ========================================================================== */
37: /*
38: This facilitates using the C version of PETSc from C++ and the C++ version from C.
39: */
40: #if defined(__cplusplus)
41: # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_CXX
42: #else
43: # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_C
44: #endif
46: /* ========================================================================== */
47: /*
48: Since PETSc manages its own extern "C" handling users should never include PETSc include
49: files within extern "C". This will generate a compiler error if a user does put the include
50: file within an extern "C".
51: */
52: #if defined(__cplusplus)
53: void assert_never_put_petsc_headers_inside_an_extern_c(int); void assert_never_put_petsc_headers_inside_an_extern_c(double);
54: #endif
56: #if defined(__cplusplus)
57: # define PETSC_RESTRICT PETSC_CXX_RESTRICT
58: #else
59: # define PETSC_RESTRICT PETSC_C_RESTRICT
60: #endif
62: #if defined(__cplusplus)
63: # define PETSC_STATIC_INLINE PETSC_CXX_STATIC_INLINE
64: #else
65: # define PETSC_STATIC_INLINE PETSC_C_STATIC_INLINE
66: #endif
68: #if defined(_WIN32) && defined(PETSC_USE_SHARED_LIBRARIES) /* For Win32 shared libraries */
69: # define __declspec(dllexport)
70: # define PETSC_DLLIMPORT __declspec(dllimport)
71: # define PETSC_VISIBILITY_INTERNAL
72: #elif defined(PETSC_USE_VISIBILITY_CXX) && defined(__cplusplus)
73: # define __attribute__((visibility ("default")))
74: # define PETSC_DLLIMPORT __attribute__((visibility ("default")))
75: # define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden")))
76: #elif defined(PETSC_USE_VISIBILITY_C) && !defined(__cplusplus)
77: # define __attribute__((visibility ("default")))
78: # define PETSC_DLLIMPORT __attribute__((visibility ("default")))
79: # define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden")))
80: #else
81: # define
82: # define PETSC_DLLIMPORT
83: # define PETSC_VISIBILITY_INTERNAL
84: #endif
86: #if defined(petsc_EXPORTS) /* CMake defines this when building the shared library */
87: # define PETSC_VISIBILITY_PUBLIC
88: #else /* Win32 users need this to import symbols from petsc.dll */
89: # define PETSC_VISIBILITY_PUBLIC PETSC_DLLIMPORT
90: #endif
92: /*
93: Functions tagged with PETSC_EXTERN in the header files are
94: always defined as extern "C" when compiled with C++ so they may be
95: used from C and are always visible in the shared libraries
96: */
97: #if defined(__cplusplus)
98: #define PETSC_EXTERN extern "C" PETSC_VISIBILITY_PUBLIC
99: #define PETSC_EXTERN_TYPEDEF extern "C"
100: #define PETSC_INTERN extern "C" PETSC_VISIBILITY_INTERNAL
101: #else
102: #define PETSC_EXTERN extern PETSC_VISIBILITY_PUBLIC
103: #define PETSC_EXTERN_TYPEDEF
104: #define PETSC_INTERN extern PETSC_VISIBILITY_INTERNAL
105: #endif
107: #include <petscversion.h>
108: #define PETSC_AUTHOR_INFO " The PETSc Team\n petsc-maint@mcs.anl.gov\n http://www.mcs.anl.gov/petsc/\n"
110: /* ========================================================================== */
112: /*
113: Defines the interface to MPI allowing the use of all MPI functions.
115: PETSc does not use the C++ binding of MPI at ALL. The following flag
116: makes sure the C++ bindings are not included. The C++ bindings REQUIRE
117: putting mpi.h before ANY C++ include files, we cannot control this
118: with all PETSc users. Users who want to use the MPI C++ bindings can include
119: mpicxx.h directly in their code
120: */
121: #if !defined(MPICH_SKIP_MPICXX)
122: # define MPICH_SKIP_MPICXX 1
123: #endif
124: #if !defined(OMPI_SKIP_MPICXX)
125: # define OMPI_SKIP_MPICXX 1
126: #endif
127: #if defined(PETSC_HAVE_MPIUNI)
128: # include <petsc/mpiuni/mpi.h>
129: #else
130: # include <mpi.h>
131: #endif
133: /*
134: Perform various sanity checks that the correct mpi.h is being included at compile time.
135: This usually happens because
136: * either an unexpected mpi.h is in the default compiler path (i.e. in /usr/include) or
137: * an extra include path -I/something (which contains the unexpected mpi.h) is being passed to the compiler
138: */
139: #if defined(PETSC_HAVE_MPIUNI)
140: # if !defined(__MPIUNI_H)
141: # error "PETSc was configured with --with-mpi=0 but now appears to be compiling using a different mpi.h"
142: # endif
143: #elif defined(PETSC_HAVE_I_MPI_NUMVERSION)
144: # if !defined(I_MPI_NUMVERSION)
145: # error "PETSc was configured with I_MPI but now appears to be compiling using a non-I_MPI mpi.h"
146: # elif I_MPI_NUMVERSION != PETSC_HAVE_I_MPI_NUMVERSION
147: # 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"
148: # endif
149: #elif defined(PETSC_HAVE_MVAPICH2_NUMVERSION)
150: # if !defined(MVAPICH2_NUMVERSION)
151: # error "PETSc was configured with MVAPICH2 but now appears to be compiling using a non-MVAPICH2 mpi.h"
152: # elif MVAPICH2_NUMVERSION != PETSC_HAVE_MVAPICH2_NUMVERSION
153: # error "PETSc was configured with one MVAPICH2 mpi.h version but now appears to be compiling using a different MVAPICH2 mpi.h version"
154: # endif
155: #elif defined(PETSC_HAVE_MPICH_NUMVERSION)
156: # if !defined(MPICH_NUMVERSION) || defined(MVAPICH2_NUMVERSION) || defined(I_MPI_NUMVERSION)
157: # error "PETSc was configured with MPICH but now appears to be compiling using a non-MPICH mpi.h"
158: # elif (MPICH_NUMVERSION/100000 != PETSC_HAVE_MPICH_NUMVERSION/100000) || (MPICH_NUMVERSION%100000/1000 < PETSC_HAVE_MPICH_NUMVERSION%100000/1000)
159: # error "PETSc was configured with one MPICH mpi.h version but now appears to be compiling using a different MPICH mpi.h version"
160: # endif
161: #elif defined(PETSC_HAVE_OMPI_MAJOR_VERSION)
162: # if !defined(OMPI_MAJOR_VERSION)
163: # error "PETSc was configured with OpenMPI but now appears to be compiling using a non-OpenMPI mpi.h"
164: # 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)
165: # error "PETSc was configured with one OpenMPI mpi.h version but now appears to be compiling using a different OpenMPI mpi.h version"
166: # endif
167: #elif defined(OMPI_MAJOR_VERSION) || defined(MPICH_NUMVERSION)
168: # error "PETSc was configured with undetermined MPI - but now appears to be compiling using either of OpenMPI or a MPICH variant"
169: #endif
171: /*
172: Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler
173: see the top of mpicxx.h in the MPICH2 distribution.
174: */
175: #include <stdio.h>
177: /* MSMPI on 32bit windows requires this yukky hack - that breaks MPI standard compliance */
178: #if !defined(MPIAPI)
179: #define MPIAPI
180: #endif
182: /*
183: Support for Clang (>=3.2) matching type tag arguments with void* buffer types.
184: This allows the compiler to detect cases where the MPI datatype argument passed to a MPI routine
185: does not match the actual type of the argument being passed in
186: */
187: #if defined(__has_attribute) && defined(works_with_const_which_is_not_true)
188: # if __has_attribute(argument_with_type_tag) && __has_attribute(pointer_with_type_tag) && __has_attribute(type_tag_for_datatype)
189: # define PetscAttrMPIPointerWithType(bufno,typeno) __attribute__((pointer_with_type_tag(MPI,bufno,typeno)))
190: # define PetscAttrMPITypeTag(type) __attribute__((type_tag_for_datatype(MPI,type)))
191: # define PetscAttrMPITypeTagLayoutCompatible(type) __attribute__((type_tag_for_datatype(MPI,type,layout_compatible)))
192: # endif
193: #endif
194: #if !defined(PetscAttrMPIPointerWithType)
195: # define PetscAttrMPIPointerWithType(bufno,typeno)
196: # define PetscAttrMPITypeTag(type)
197: # define PetscAttrMPITypeTagLayoutCompatible(type)
198: #endif
200: /*MC
201: PetscErrorCode - datatype used for return error code from almost all PETSc functions
203: Level: beginner
205: .seealso: CHKERRQ, SETERRQ
206: M*/
207: typedef int PetscErrorCode;
209: /*MC
211: PetscClassId - A unique id used to identify each PETSc class.
213: Notes:
214: Use PetscClassIdRegister() to obtain a new value for a new class being created. Usually
215: XXXInitializePackage() calls it for each class it defines.
217: Developer Notes:
218: Internal integer stored in the _p_PetscObject data structure.
219: These are all computed by an offset from the lowest one, PETSC_SMALLEST_CLASSID.
221: Level: developer
223: .seealso: PetscClassIdRegister(), PetscLogEventRegister(), PetscHeaderCreate()
224: M*/
225: typedef int PetscClassId;
228: /*MC
229: PetscMPIInt - datatype used to represent 'int' parameters to MPI functions.
231: Level: intermediate
233: Notes:
234: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but
235: standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt; it remains 32 bit.
237: PetscMPIIntCast(a,&b) checks if the given PetscInt a will fit in a PetscMPIInt, if not it
238: generates a PETSC_ERR_ARG_OUTOFRANGE error.
240: .seealso: PetscBLASInt, PetscInt, PetscMPIIntCast()
242: M*/
243: typedef int PetscMPIInt;
245: /*MC
246: PetscEnum - datatype used to pass enum types within PETSc functions.
248: Level: intermediate
250: .seealso: PetscOptionsGetEnum(), PetscOptionsEnum(), PetscBagRegisterEnum()
251: M*/
252: typedef enum { ENUM_DUMMY } PetscEnum;
253: PETSC_EXTERN MPI_Datatype MPIU_ENUM PetscAttrMPITypeTag(PetscEnum);
255: #if defined(PETSC_HAVE_STDINT_H)
256: #include <stdint.h>
257: #endif
258: #if defined (PETSC_HAVE_INTTYPES_H)
261: #endif
262: #include <inttypes.h>
263: # if !defined(PRId64)
264: # define PRId64 "ld"
265: # endif
266: #endif
268: typedef short PetscShort;
269: typedef char PetscChar;
270: typedef float PetscFloat;
272: /*MC
273: PetscInt - PETSc type that represents an integer, used primarily to
274: represent size of arrays and indexing into arrays. Its size can be configured with the option --with-64-bit-indices to be either 32-bit (default) or 64-bit.
276: Notes:
277: For MPI calls that require datatypes, use MPIU_INT as the datatype for PetscInt. It will automatically work correctly regardless of the size of PetscInt.
279: Level: beginner
281: .seealso: PetscBLASInt, PetscMPIInt, PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT
282: M*/
284: /*MC
285: MPIU_INT - MPI datatype corresponding to PetscInt
287: Notes:
288: In MPI calls that require an MPI datatype that matches a PetscInt or array of PetscInt values, pass this value.
290: Level: beginner
292: .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX
293: M*/
295: #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 */
296: typedef int64_t PetscInt64;
297: # define MPIU_INT64 MPI_INT64_T
298: # define PetscInt64_FMT PRId64
299: #elif (PETSC_SIZEOF_LONG_LONG == 8)
300: typedef long long PetscInt64;
301: # define MPIU_INT64 MPI_LONG_LONG_INT
302: # define PetscInt64_FMT "lld"
303: #elif defined(PETSC_HAVE___INT64)
304: typedef __int64 PetscInt64;
305: # define MPIU_INT64 MPI_INT64_T
306: # define PetscInt64_FMT "ld"
307: #else
308: #error "cannot determine PetscInt64 type"
309: #endif
311: #if PETSC_SIZEOF_VOID_P == 4
312: #define MPIU_FORTRANADDR MPI_INT
313: #else
314: #define MPIU_FORTRANADDR MPIU_INT64
315: #endif
317: #if defined(PETSC_USE_64BIT_INDICES)
318: typedef PetscInt64 PetscInt;
319: #define MPIU_INT MPIU_INT64
320: #define PetscInt_FMT PetscInt64_FMT
321: #else
322: typedef int PetscInt;
323: #define MPIU_INT MPI_INT
324: #define PetscInt_FMT "d"
325: #endif
327: /*MC
328: PetscBLASInt - datatype used to represent 'int' parameters to BLAS/LAPACK functions.
330: Notes:
331: Usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but
332: standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt it remains 32 bit
333: (except on very rare BLAS/LAPACK implementations that support 64 bit integers see the note below).
335: PetscErrorCode PetscBLASIntCast(a,&b) checks if the given PetscInt a will fit in a PetscBLASInt, if not it
336: generates a PETSC_ERR_ARG_OUTOFRANGE error
338: Installation Notes:
339: The 64bit versions of MATLAB ship with BLAS and LAPACK that use 64 bit integers for sizes etc,
340: if you run ./configure with the option
341: --with-blaslapack-lib=[/Applications/MATLAB_R2010b.app/bin/maci64/libmwblas.dylib,/Applications/MATLAB_R2010b.app/bin/maci64/libmwlapack.dylib]
342: but you need to also use --known-64-bit-blas-indices.
344: MKL also ships with 64 bit integer versions of the BLAS and LAPACK, if you select those you must also ./configure with
345: --known-64-bit-blas-indices
347: OpenBLAS can also be built to use 64 bit integers. The ./configure options --download-openblas -download-openblas-64-bit-blas-indices
348: will build a 64 bit integer version
350: Developer Notes:
351: Eventually ./configure should automatically determine the size of the integers used by BLAS/LAPACK.
353: External packages such as hypre, ML, SuperLU etc do not provide any support for passing 64 bit integers to BLAS/LAPACK so cannot
354: be used with PETSc if you have set PetscBLASInt to long int.
356: Level: intermediate
358: .seealso: PetscMPIInt, PetscInt, PetscBLASIntCast()
360: M*/
361: #if defined(PETSC_HAVE_64BIT_BLAS_INDICES)
362: typedef PetscInt64 PetscBLASInt;
363: #else
364: typedef int PetscBLASInt;
365: #endif
367: /*
368: For the rare cases when one needs to send a size_t object with MPI
369: */
370: #if (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_INT)
371: #define MPIU_SIZE_T MPI_UNSIGNED
372: #elif (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG)
373: #define MPIU_SIZE_T MPI_UNSIGNED_LONG
374: #elif (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG_LONG)
375: #define MPIU_SIZE_T MPI_UNSIGNED_LONG_LONG
376: #else
377: #error "Unknown size for size_t! Send us a bugreport at petsc-maint@mcs.anl.gov"
378: #endif
380: /*
381: You can use PETSC_STDOUT as a replacement of stdout. You can also change
382: the value of PETSC_STDOUT to redirect all standard output elsewhere
383: */
384: PETSC_EXTERN FILE* PETSC_STDOUT;
386: /*
387: You can use PETSC_STDERR as a replacement of stderr. You can also change
388: the value of PETSC_STDERR to redirect all standard error elsewhere
389: */
390: PETSC_EXTERN FILE* PETSC_STDERR;
392: /*MC
393: PetscUnlikely - hints the compiler that the given condition is usually FALSE
395: Synopsis:
396: #include <petscsys.h>
397: PetscBool PetscUnlikely(PetscBool cond)
399: Not Collective
401: Input Parameters:
402: . cond - condition or expression
404: Notes:
405: This returns the same truth value, it is only a hint to compilers that the resulting
406: branch is unlikely.
408: Level: advanced
410: .seealso: PetscLikely(), CHKERRQ
411: M*/
413: /*MC
414: PetscLikely - hints the compiler that the given condition is usually TRUE
416: Synopsis:
417: #include <petscsys.h>
418: PetscBool PetscLikely(PetscBool cond)
420: Not Collective
422: Input Parameters:
423: . cond - condition or expression
425: Notes:
426: This returns the same truth value, it is only a hint to compilers that the resulting
427: branch is likely.
429: Level: advanced
431: .seealso: PetscUnlikely()
432: M*/
433: #if defined(PETSC_HAVE_BUILTIN_EXPECT)
434: # define PetscUnlikely(cond) __builtin_expect(!!(cond),0)
435: # define PetscLikely(cond) __builtin_expect(!!(cond),1)
436: #else
437: # define PetscUnlikely(cond) (cond)
438: # define PetscLikely(cond) (cond)
439: #endif
441: /*
442: Declare extern C stuff after including external header files
443: */
446: /*
447: Basic PETSc constants
448: */
450: /*E
451: PetscBool - Logical variable. Actually an int in C and a logical in Fortran.
453: Level: beginner
455: Developer Note:
456: Why have PetscBool , why not use bool in C? The problem is that K and R C, C99 and C++ all have different mechanisms for
457: boolean values. It is not easy to have a simple macro that that will work properly in all circumstances with all three mechanisms.
459: .seealso: PETSC_TRUE, PETSC_FALSE, PetscNot()
460: E*/
461: typedef enum { PETSC_FALSE,PETSC_TRUE } PetscBool;
462: PETSC_EXTERN const char *const PetscBools[];
463: PETSC_EXTERN MPI_Datatype MPIU_BOOL PetscAttrMPITypeTag(PetscBool);
465: /*
466: Defines elementary mathematics functions and constants.
467: */
468: #include <petscmath.h>
470: /*E
471: PetscCopyMode - Determines how an array passed to certain functions is copied or retained
473: Level: beginner
475: $ PETSC_COPY_VALUES - the array values are copied into new space, the user is free to reuse or delete the passed in array
476: $ PETSC_OWN_POINTER - the array values are NOT copied, the object takes ownership of the array and will free it later, the user cannot change or
477: $ delete the array. The array MUST have been obtained with PetscMalloc(). Hence this mode cannot be used in Fortran.
478: $ PETSC_USE_POINTER - the array values are NOT copied, the object uses the array but does NOT take ownership of the array. The user cannot use
479: the array but the user must delete the array after the object is destroyed.
481: E*/
482: typedef enum { PETSC_COPY_VALUES, PETSC_OWN_POINTER, PETSC_USE_POINTER} PetscCopyMode;
483: PETSC_EXTERN const char *const PetscCopyModes[];
485: /*MC
486: PETSC_FALSE - False value of PetscBool
488: Level: beginner
490: Note:
491: Zero integer
493: .seealso: PetscBool, PETSC_TRUE
494: M*/
496: /*MC
497: PETSC_TRUE - True value of PetscBool
499: Level: beginner
501: Note:
502: Nonzero integer
504: .seealso: PetscBool, PETSC_FALSE
505: M*/
507: /*MC
508: PETSC_IGNORE - same as NULL, means PETSc will ignore this argument
510: Level: beginner
512: Note:
513: Accepted by many PETSc functions to not set a parameter and instead use
514: some default
516: Fortran Notes:
517: This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER,
518: PETSC_NULL_DOUBLE_PRECISION etc
520: .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_DETERMINE
522: M*/
523: #define PETSC_IGNORE NULL
525: /* This is deprecated */
526: #define PETSC_NULL NULL
528: /*MC
529: PETSC_DECIDE - standard way of passing in integer or floating point parameter
530: where you wish PETSc to use the default.
532: Level: beginner
534: .seealso: PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE
536: M*/
537: #define PETSC_DECIDE -1
539: /*MC
540: PETSC_DETERMINE - standard way of passing in integer or floating point parameter
541: where you wish PETSc to compute the required value.
543: Level: beginner
545: Developer Note:
546: I would like to use const PetscInt PETSC_DETERMINE = PETSC_DECIDE; but for
547: some reason this is not allowed by the standard even though PETSC_DECIDE is a constant value.
549: .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, VecSetSizes()
551: M*/
552: #define PETSC_DETERMINE PETSC_DECIDE
554: /*MC
555: PETSC_DEFAULT - standard way of passing in integer or floating point parameter
556: where you wish PETSc to use the default.
558: Level: beginner
560: Fortran Notes:
561: You need to use PETSC_DEFAULT_INTEGER or PETSC_DEFAULT_REAL.
563: .seealso: PETSC_DECIDE, PETSC_IGNORE, PETSC_DETERMINE
565: M*/
566: #define PETSC_DEFAULT -2
568: /*MC
569: PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents
570: all the processs that PETSc knows about.
572: Level: beginner
574: Notes:
575: By default PETSC_COMM_WORLD and MPI_COMM_WORLD are identical unless you wish to
576: run PETSc on ONLY a subset of MPI_COMM_WORLD. In that case create your new (smaller)
577: communicator, call it, say comm, and set PETSC_COMM_WORLD = comm BEFORE calling
578: PetscInitialize(), but after MPI_Init() has been called.
580: The value of PETSC_COMM_WORLD should never be USED/accessed before PetscInitialize()
581: is called because it may not have a valid value yet.
583: .seealso: PETSC_COMM_SELF
585: M*/
586: PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD;
588: /*MC
589: PETSC_COMM_SELF - This is always MPI_COMM_SELF
591: Level: beginner
593: Notes:
594: Do not USE/access or set this variable before PetscInitialize() has been called.
596: .seealso: PETSC_COMM_WORLD
598: M*/
599: #define PETSC_COMM_SELF MPI_COMM_SELF
601: PETSC_EXTERN PetscBool PetscBeganMPI;
602: PETSC_EXTERN PetscBool PetscInitializeCalled;
603: PETSC_EXTERN PetscBool PetscFinalizeCalled;
604: PETSC_EXTERN PetscBool PetscViennaCLSynchronize;
605: PETSC_EXTERN PetscBool PetscCUDASynchronize;
607: PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm));
608: PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*);
609: PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm*);
611: /*MC
612: PetscMalloc - Allocates memory, One should use PetscNew(), PetscMalloc1() or PetscCalloc1() usually instead of this
614: Synopsis:
615: #include <petscsys.h>
616: PetscErrorCode PetscMalloc(size_t m,void **result)
618: Not Collective
620: Input Parameter:
621: . m - number of bytes to allocate
623: Output Parameter:
624: . result - memory allocated
626: Level: beginner
628: Notes:
629: Memory is always allocated at least double aligned
631: It is safe to allocate size 0 and pass the resulting pointer (which may or may not be NULL) to PetscFree().
633: .seealso: PetscFree(), PetscNew()
635: Concepts: memory allocation
637: M*/
638: #define PetscMalloc(a,b) ((*PetscTrMalloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b)))
640: /*MC
641: PetscRealloc - Rellocates memory
643: Synopsis:
644: #include <petscsys.h>
645: PetscErrorCode PetscRealloc(size_t m,void **result)
647: Not Collective
649: Input Parameters:
650: + m - number of bytes to allocate
651: - result - initial memory allocated
653: Output Parameter:
654: . result - new memory allocated
656: Level: developer
658: Notes:
659: Memory is always allocated at least double aligned
661: .seealso: PetscMalloc(), PetscFree(), PetscNew()
663: Concepts: memory allocation
665: M*/
666: #define PetscRealloc(a,b) ((*PetscTrRealloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b)))
668: /*MC
669: PetscAddrAlign - Rounds up an address to PETSC_MEMALIGN alignment
671: Synopsis:
672: #include <petscsys.h>
673: void *PetscAddrAlign(void *addr)
675: Not Collective
677: Input Parameters:
678: . addr - address to align (any pointer type)
680: Level: developer
682: .seealso: PetscMallocAlign()
684: Concepts: memory allocation
685: M*/
686: #define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1))
688: /*MC
689: PetscMalloc1 - Allocates an array of memory aligned to PETSC_MEMALIGN
691: Synopsis:
692: #include <petscsys.h>
693: PetscErrorCode PetscMalloc1(size_t m1,type **r1)
695: Not Collective
697: Input Parameter:
698: . m1 - number of elements to allocate (may be zero)
700: Output Parameter:
701: . r1 - memory allocated in first chunk
703: Note:
704: This uses the sizeof() of the memory type requested to determine the total memory to be allocated, therefore you should not
705: multiply the number of elements requested by the sizeof() the type. For example use
706: $ PetscInt *id;
707: $ PetscMalloc1(10,&id);
708: not
709: $ PetscInt *id;
710: $ PetscMalloc1(10*sizeof(PetscInt),&id);
712: Does not zero the memory allocatd, used PetscCalloc1() to obtain memory that has been zeroed.
714: Level: beginner
716: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2()
718: Concepts: memory allocation
720: M*/
721: #define PetscMalloc1(m1,r1) PetscMallocA(1,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1))
723: /*MC
724: PetscCalloc1 - Allocates a cleared (zeroed) array of memory aligned to PETSC_MEMALIGN
726: Synopsis:
727: #include <petscsys.h>
728: PetscErrorCode PetscCalloc1(size_t m1,type **r1)
730: Not Collective
732: Input Parameter:
733: . m1 - number of elements to allocate in 1st chunk (may be zero)
735: Output Parameter:
736: . r1 - memory allocated in first chunk
738: Notes:
739: See PetsMalloc1() for more details on usage.
741: Level: beginner
743: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2()
745: Concepts: memory allocation
747: M*/
748: #define PetscCalloc1(m1,r1) PetscMallocA(1,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1))
750: /*MC
751: PetscMalloc2 - Allocates 2 arrays of memory both aligned to PETSC_MEMALIGN
753: Synopsis:
754: #include <petscsys.h>
755: PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2)
757: Not Collective
759: Input Parameter:
760: + m1 - number of elements to allocate in 1st chunk (may be zero)
761: - m2 - number of elements to allocate in 2nd chunk (may be zero)
763: Output Parameter:
764: + r1 - memory allocated in first chunk
765: - r2 - memory allocated in second chunk
767: Level: developer
769: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2()
771: Concepts: memory allocation
773: M*/
774: #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))
776: /*MC
777: PetscCalloc2 - Allocates 2 cleared (zeroed) arrays of memory both aligned to PETSC_MEMALIGN
779: Synopsis:
780: #include <petscsys.h>
781: PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2)
783: Not Collective
785: Input Parameter:
786: + m1 - number of elements to allocate in 1st chunk (may be zero)
787: - m2 - number of elements to allocate in 2nd chunk (may be zero)
789: Output Parameter:
790: + r1 - memory allocated in first chunk
791: - r2 - memory allocated in second chunk
793: Level: developer
795: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2()
797: Concepts: memory allocation
798: M*/
799: #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))
801: /*MC
802: PetscMalloc3 - Allocates 3 arrays of memory, all aligned to PETSC_MEMALIGN
804: Synopsis:
805: #include <petscsys.h>
806: PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)
808: Not Collective
810: Input Parameter:
811: + m1 - number of elements to allocate in 1st chunk (may be zero)
812: . m2 - number of elements to allocate in 2nd chunk (may be zero)
813: - m3 - number of elements to allocate in 3rd chunk (may be zero)
815: Output Parameter:
816: + r1 - memory allocated in first chunk
817: . r2 - memory allocated in second chunk
818: - r3 - memory allocated in third chunk
820: Level: developer
822: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc3(), PetscFree3()
824: Concepts: memory allocation
826: M*/
827: #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))
829: /*MC
830: PetscCalloc3 - Allocates 3 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
832: Synopsis:
833: #include <petscsys.h>
834: PetscErrorCode PetscCalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)
836: Not Collective
838: Input Parameter:
839: + m1 - number of elements to allocate in 1st chunk (may be zero)
840: . m2 - number of elements to allocate in 2nd chunk (may be zero)
841: - m3 - number of elements to allocate in 3rd chunk (may be zero)
843: Output Parameter:
844: + r1 - memory allocated in first chunk
845: . r2 - memory allocated in second chunk
846: - r3 - memory allocated in third chunk
848: Level: developer
850: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc2(), PetscMalloc3(), PetscFree3()
852: Concepts: memory allocation
853: M*/
854: #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))
856: /*MC
857: PetscMalloc4 - Allocates 4 arrays of memory, all aligned to PETSC_MEMALIGN
859: Synopsis:
860: #include <petscsys.h>
861: PetscErrorCode PetscMalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)
863: Not Collective
865: Input Parameter:
866: + m1 - number of elements to allocate in 1st chunk (may be zero)
867: . m2 - number of elements to allocate in 2nd chunk (may be zero)
868: . m3 - number of elements to allocate in 3rd chunk (may be zero)
869: - m4 - number of elements to allocate in 4th chunk (may be zero)
871: Output Parameter:
872: + r1 - memory allocated in first chunk
873: . r2 - memory allocated in second chunk
874: . r3 - memory allocated in third chunk
875: - r4 - memory allocated in fourth chunk
877: Level: developer
879: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4()
881: Concepts: memory allocation
883: M*/
884: #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))
886: /*MC
887: PetscCalloc4 - Allocates 4 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
889: Synopsis:
890: #include <petscsys.h>
891: PetscErrorCode PetscCalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)
893: Not Collective
895: Input Parameters:
896: + m1 - number of elements to allocate in 1st chunk (may be zero)
897: . m2 - number of elements to allocate in 2nd chunk (may be zero)
898: . m3 - number of elements to allocate in 3rd chunk (may be zero)
899: - m4 - number of elements to allocate in 4th chunk (may be zero)
901: Output Parameters:
902: + r1 - memory allocated in first chunk
903: . r2 - memory allocated in second chunk
904: . r3 - memory allocated in third chunk
905: - r4 - memory allocated in fourth chunk
907: Level: developer
909: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4()
911: Concepts: memory allocation
913: M*/
914: #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))
916: /*MC
917: PetscMalloc5 - Allocates 5 arrays of memory, all aligned to PETSC_MEMALIGN
919: Synopsis:
920: #include <petscsys.h>
921: 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)
923: Not Collective
925: Input Parameters:
926: + m1 - number of elements to allocate in 1st chunk (may be zero)
927: . m2 - number of elements to allocate in 2nd chunk (may be zero)
928: . m3 - number of elements to allocate in 3rd chunk (may be zero)
929: . m4 - number of elements to allocate in 4th chunk (may be zero)
930: - m5 - number of elements to allocate in 5th chunk (may be zero)
932: Output Parameters:
933: + r1 - memory allocated in first chunk
934: . r2 - memory allocated in second chunk
935: . r3 - memory allocated in third chunk
936: . r4 - memory allocated in fourth chunk
937: - r5 - memory allocated in fifth chunk
939: Level: developer
941: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc5(), PetscFree5()
943: Concepts: memory allocation
945: M*/
946: #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))
948: /*MC
949: PetscCalloc5 - Allocates 5 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
951: Synopsis:
952: #include <petscsys.h>
953: 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)
955: Not Collective
957: Input Parameters:
958: + m1 - number of elements to allocate in 1st chunk (may be zero)
959: . m2 - number of elements to allocate in 2nd chunk (may be zero)
960: . m3 - number of elements to allocate in 3rd chunk (may be zero)
961: . m4 - number of elements to allocate in 4th chunk (may be zero)
962: - m5 - number of elements to allocate in 5th chunk (may be zero)
964: Output Parameters:
965: + r1 - memory allocated in first chunk
966: . r2 - memory allocated in second chunk
967: . r3 - memory allocated in third chunk
968: . r4 - memory allocated in fourth chunk
969: - r5 - memory allocated in fifth chunk
971: Level: developer
973: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc5(), PetscFree5()
975: Concepts: memory allocation
977: M*/
978: #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))
980: /*MC
981: PetscMalloc6 - Allocates 6 arrays of memory, all aligned to PETSC_MEMALIGN
983: Synopsis:
984: #include <petscsys.h>
985: 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)
987: Not Collective
989: Input Parameters:
990: + m1 - number of elements to allocate in 1st chunk (may be zero)
991: . m2 - number of elements to allocate in 2nd chunk (may be zero)
992: . m3 - number of elements to allocate in 3rd chunk (may be zero)
993: . m4 - number of elements to allocate in 4th chunk (may be zero)
994: . m5 - number of elements to allocate in 5th chunk (may be zero)
995: - m6 - number of elements to allocate in 6th chunk (may be zero)
997: Output Parameteasr:
998: + r1 - memory allocated in first chunk
999: . r2 - memory allocated in second chunk
1000: . r3 - memory allocated in third chunk
1001: . r4 - memory allocated in fourth chunk
1002: . r5 - memory allocated in fifth chunk
1003: - r6 - memory allocated in sixth chunk
1005: Level: developer
1007: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc6(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6()
1009: Concepts: memory allocation
1011: M*/
1012: #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))
1014: /*MC
1015: PetscCalloc6 - Allocates 6 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
1017: Synopsis:
1018: #include <petscsys.h>
1019: 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)
1021: Not Collective
1023: Input Parameters:
1024: + m1 - number of elements to allocate in 1st chunk (may be zero)
1025: . m2 - number of elements to allocate in 2nd chunk (may be zero)
1026: . m3 - number of elements to allocate in 3rd chunk (may be zero)
1027: . m4 - number of elements to allocate in 4th chunk (may be zero)
1028: . m5 - number of elements to allocate in 5th chunk (may be zero)
1029: - m6 - number of elements to allocate in 6th chunk (may be zero)
1031: Output Parameters:
1032: + r1 - memory allocated in first chunk
1033: . r2 - memory allocated in second chunk
1034: . r3 - memory allocated in third chunk
1035: . r4 - memory allocated in fourth chunk
1036: . r5 - memory allocated in fifth chunk
1037: - r6 - memory allocated in sixth chunk
1039: Level: developer
1041: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc6(), PetscFree6()
1043: Concepts: memory allocation
1044: M*/
1045: #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))
1047: /*MC
1048: PetscMalloc7 - Allocates 7 arrays of memory, all aligned to PETSC_MEMALIGN
1050: Synopsis:
1051: #include <petscsys.h>
1052: 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)
1054: Not Collective
1056: Input Parameters:
1057: + m1 - number of elements to allocate in 1st chunk (may be zero)
1058: . m2 - number of elements to allocate in 2nd chunk (may be zero)
1059: . m3 - number of elements to allocate in 3rd chunk (may be zero)
1060: . m4 - number of elements to allocate in 4th chunk (may be zero)
1061: . m5 - number of elements to allocate in 5th chunk (may be zero)
1062: . m6 - number of elements to allocate in 6th chunk (may be zero)
1063: - m7 - number of elements to allocate in 7th chunk (may be zero)
1065: Output Parameters:
1066: + r1 - memory allocated in first chunk
1067: . r2 - memory allocated in second chunk
1068: . r3 - memory allocated in third chunk
1069: . r4 - memory allocated in fourth chunk
1070: . r5 - memory allocated in fifth chunk
1071: . r6 - memory allocated in sixth chunk
1072: - r7 - memory allocated in seventh chunk
1074: Level: developer
1076: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc7(), PetscFree7()
1078: Concepts: memory allocation
1080: M*/
1081: #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))
1083: /*MC
1084: PetscCalloc7 - Allocates 7 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
1086: Synopsis:
1087: #include <petscsys.h>
1088: 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)
1090: Not Collective
1092: Input Parameters:
1093: + m1 - number of elements to allocate in 1st chunk (may be zero)
1094: . m2 - number of elements to allocate in 2nd chunk (may be zero)
1095: . m3 - number of elements to allocate in 3rd chunk (may be zero)
1096: . m4 - number of elements to allocate in 4th chunk (may be zero)
1097: . m5 - number of elements to allocate in 5th chunk (may be zero)
1098: . m6 - number of elements to allocate in 6th chunk (may be zero)
1099: - m7 - number of elements to allocate in 7th chunk (may be zero)
1101: Output Parameters:
1102: + r1 - memory allocated in first chunk
1103: . r2 - memory allocated in second chunk
1104: . r3 - memory allocated in third chunk
1105: . r4 - memory allocated in fourth chunk
1106: . r5 - memory allocated in fifth chunk
1107: . r6 - memory allocated in sixth chunk
1108: - r7 - memory allocated in seventh chunk
1110: Level: developer
1112: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc7(), PetscFree7()
1114: Concepts: memory allocation
1115: M*/
1116: #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))
1118: /*MC
1119: PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to PETSC_MEMALIGN
1121: Synopsis:
1122: #include <petscsys.h>
1123: PetscErrorCode PetscNew(type **result)
1125: Not Collective
1127: Output Parameter:
1128: . result - memory allocated, sized to match pointer type
1130: Level: beginner
1132: .seealso: PetscFree(), PetscMalloc(), PetscNewLog(), PetscCalloc1(), PetscMalloc1()
1134: Concepts: memory allocation
1136: M*/
1137: #define PetscNew(b) PetscCalloc1(1,(b))
1139: /*MC
1140: PetscNewLog - Allocates memory of a type matching pointer, zeros the memory! Aligned to PETSC_MEMALIGN. Associates the memory allocated
1141: with the given object using PetscLogObjectMemory().
1143: Synopsis:
1144: #include <petscsys.h>
1145: PetscErrorCode PetscNewLog(PetscObject obj,type **result)
1147: Not Collective
1149: Input Parameter:
1150: . obj - object memory is logged to
1152: Output Parameter:
1153: . result - memory allocated, sized to match pointer type
1155: Level: developer
1157: .seealso: PetscFree(), PetscMalloc(), PetscNew(), PetscLogObjectMemory(), PetscCalloc1(), PetscMalloc1()
1159: Concepts: memory allocation
1161: M*/
1162: #define PetscNewLog(o,b) (PetscNew((b)) || PetscLogObjectMemory((PetscObject)o,sizeof(**(b))))
1164: /*MC
1165: PetscFree - Frees memory
1167: Synopsis:
1168: #include <petscsys.h>
1169: PetscErrorCode PetscFree(void *memory)
1171: Not Collective
1173: Input Parameter:
1174: . memory - memory to free (the pointer is ALWAYS set to NULL upon sucess)
1176: Level: beginner
1178: Notes:
1179: Do not free memory obtained with PetscMalloc2(), PetscCalloc2() etc, they must be freed with PetscFree2() etc.
1181: It is safe to call PetscFree() on a NULL pointer.
1183: .seealso: PetscNew(), PetscMalloc(), PetscNewLog(), PetscMalloc1(), PetscCalloc1()
1185: Concepts: memory allocation
1187: M*/
1188: #define PetscFree(a) ((*PetscTrFree)((void*)(a),__LINE__,PETSC_FUNCTION_NAME,__FILE__) || ((a) = 0,0))
1190: /*MC
1191: PetscFree2 - Frees 2 chunks of memory obtained with PetscMalloc2()
1193: Synopsis:
1194: #include <petscsys.h>
1195: PetscErrorCode PetscFree2(void *memory1,void *memory2)
1197: Not Collective
1199: Input Parameters:
1200: + memory1 - memory to free
1201: - memory2 - 2nd memory to free
1203: Level: developer
1205: Notes: Memory must have been obtained with PetscMalloc2()
1207: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree()
1209: Concepts: memory allocation
1211: M*/
1212: #define PetscFree2(m1,m2) PetscFreeA(2,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2))
1214: /*MC
1215: PetscFree3 - Frees 3 chunks of memory obtained with PetscMalloc3()
1217: Synopsis:
1218: #include <petscsys.h>
1219: PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3)
1221: Not Collective
1223: Input Parameters:
1224: + memory1 - memory to free
1225: . memory2 - 2nd memory to free
1226: - memory3 - 3rd memory to free
1228: Level: developer
1230: Notes: Memory must have been obtained with PetscMalloc3()
1232: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3()
1234: Concepts: memory allocation
1236: M*/
1237: #define PetscFree3(m1,m2,m3) PetscFreeA(3,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3))
1239: /*MC
1240: PetscFree4 - Frees 4 chunks of memory obtained with PetscMalloc4()
1242: Synopsis:
1243: #include <petscsys.h>
1244: PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4)
1246: Not Collective
1248: Input Parameters:
1249: + m1 - memory to free
1250: . m2 - 2nd memory to free
1251: . m3 - 3rd memory to free
1252: - m4 - 4th memory to free
1254: Level: developer
1256: Notes: Memory must have been obtained with PetscMalloc4()
1258: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4()
1260: Concepts: memory allocation
1262: M*/
1263: #define PetscFree4(m1,m2,m3,m4) PetscFreeA(4,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4))
1265: /*MC
1266: PetscFree5 - Frees 5 chunks of memory obtained with PetscMalloc5()
1268: Synopsis:
1269: #include <petscsys.h>
1270: PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5)
1272: Not Collective
1274: Input Parameters:
1275: + m1 - memory to free
1276: . m2 - 2nd memory to free
1277: . m3 - 3rd memory to free
1278: . m4 - 4th memory to free
1279: - m5 - 5th memory to free
1281: Level: developer
1283: Notes: Memory must have been obtained with PetscMalloc5()
1285: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5()
1287: Concepts: memory allocation
1289: M*/
1290: #define PetscFree5(m1,m2,m3,m4,m5) PetscFreeA(5,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5))
1292: /*MC
1293: PetscFree6 - Frees 6 chunks of memory obtained with PetscMalloc6()
1295: Synopsis:
1296: #include <petscsys.h>
1297: PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6)
1299: Not Collective
1301: Input Parameters:
1302: + m1 - memory to free
1303: . m2 - 2nd memory to free
1304: . m3 - 3rd memory to free
1305: . m4 - 4th memory to free
1306: . m5 - 5th memory to free
1307: - m6 - 6th memory to free
1310: Level: developer
1312: Notes: Memory must have been obtained with PetscMalloc6()
1314: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6()
1316: Concepts: memory allocation
1318: M*/
1319: #define PetscFree6(m1,m2,m3,m4,m5,m6) PetscFreeA(6,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5),&(m6))
1321: /*MC
1322: PetscFree7 - Frees 7 chunks of memory obtained with PetscMalloc7()
1324: Synopsis:
1325: #include <petscsys.h>
1326: PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7)
1328: Not Collective
1330: Input Parameters:
1331: + m1 - memory to free
1332: . m2 - 2nd memory to free
1333: . m3 - 3rd memory to free
1334: . m4 - 4th memory to free
1335: . m5 - 5th memory to free
1336: . m6 - 6th memory to free
1337: - m7 - 7th memory to free
1340: Level: developer
1342: Notes: Memory must have been obtained with PetscMalloc7()
1344: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(),
1345: PetscMalloc7()
1347: Concepts: memory allocation
1349: M*/
1350: #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) PetscFreeA(7,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5),&(m6),&(m7))
1352: PETSC_EXTERN PetscErrorCode PetscMallocA(int,PetscBool,int,const char *,const char *,size_t,void *,...);
1353: PETSC_EXTERN PetscErrorCode PetscFreeA(int,int,const char *,const char *,void *,...);
1354: PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t,int,const char[],const char[],void**);
1355: PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[]);
1356: PETSC_EXTERN PetscErrorCode (*PetscTrRealloc)(size_t,int,const char[],const char[],void**);
1357: PETSC_EXTERN PetscErrorCode PetscMallocSetCoalesce(PetscBool);
1358: PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t,int,const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[]));
1359: PETSC_EXTERN PetscErrorCode PetscMallocClear(void);
1361: /*
1362: Unlike PetscMallocSet and PetscMallocClear which overwrite the existing settings, these two functions save the previous choice of allocator, and should be used in pair.
1363: */
1364: PETSC_EXTERN PetscErrorCode PetscMallocSetDRAM(void);
1365: PETSC_EXTERN PetscErrorCode PetscMallocResetDRAM(void);
1367: /*
1368: PetscLogDouble variables are used to contain double precision numbers
1369: that are not used in the numerical computations, but rather in logging,
1370: timing etc.
1371: */
1372: typedef double PetscLogDouble;
1373: #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE
1375: /*
1376: Routines for tracing memory corruption/bleeding with default PETSc memory allocation
1377: */
1378: PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *);
1379: PETSC_EXTERN PetscErrorCode PetscMallocDumpLog(FILE *);
1380: PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *);
1381: PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *);
1382: PETSC_EXTERN PetscErrorCode PetscMallocDebug(PetscBool);
1383: PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool*);
1384: PETSC_EXTERN PetscErrorCode PetscMallocValidate(int,const char[],const char[]);
1385: PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLog(void);
1386: PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLogThreshold(PetscLogDouble);
1387: PETSC_EXTERN PetscErrorCode PetscMallocGetDumpLog(PetscBool*);
1389: /*E
1390: PetscDataType - Used for handling different basic data types.
1392: Level: beginner
1394: Notes:
1395: Use of this should be avoided if one can directly use MPI_Datatype instead.
1397: Developer comment:
1398: It would be nice if we could always just use MPI Datatypes, why can we not?
1400: .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(),
1401: PetscDataTypeGetSize()
1403: E*/
1404: typedef enum {PETSC_INT = 0,PETSC_DOUBLE = 1,PETSC_COMPLEX = 2, PETSC_LONG = 3 ,PETSC_SHORT = 4,PETSC_FLOAT = 5,
1405: PETSC_CHAR = 6,PETSC_BIT_LOGICAL = 7,PETSC_ENUM = 8,PETSC_BOOL=9, PETSC___FLOAT128 = 10,PETSC_OBJECT = 11, PETSC_FUNCTION = 12, PETSC_STRING = 13, PETSC___FP16 = 14,PETSC_STRUCT, PETSC_DATATYPE_UNKNOWN} PetscDataType;
1406: PETSC_EXTERN const char *const PetscDataTypes[];
1408: #if defined(PETSC_USE_COMPLEX)
1409: #define PETSC_SCALAR PETSC_COMPLEX
1410: #else
1411: #if defined(PETSC_USE_REAL_SINGLE)
1412: #define PETSC_SCALAR PETSC_FLOAT
1413: #elif defined(PETSC_USE_REAL___FLOAT128)
1414: #define PETSC_SCALAR PETSC___FLOAT128
1415: #elif defined(PETSC_USE_REAL___FP16)
1416: #define PETSC_SCALAR PETSC___FP16
1417: #else
1418: #define PETSC_SCALAR PETSC_DOUBLE
1419: #endif
1420: #endif
1421: #if defined(PETSC_USE_REAL_SINGLE)
1422: #define PETSC_REAL PETSC_FLOAT
1423: #elif defined(PETSC_USE_REAL___FLOAT128)
1424: #define PETSC_REAL PETSC___FLOAT128
1425: #elif defined(PETSC_USE_REAL___FP16)
1426: #define PETSC_REAL PETSC___FP16
1427: #else
1428: #define PETSC_REAL PETSC_DOUBLE
1429: #endif
1430: #define PETSC_FORTRANADDR PETSC_LONG
1432: PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*);
1433: PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*);
1434: PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*);
1435: PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char*,PetscDataType*,PetscBool*);
1437: /*
1438: Basic memory and string operations. These are usually simple wrappers
1439: around the basic Unix system calls, but a few of them have additional
1440: functionality and/or error checking.
1441: */
1442: PETSC_EXTERN PetscErrorCode PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType);
1443: PETSC_EXTERN PetscErrorCode PetscMemmove(void*,void *,size_t);
1444: PETSC_EXTERN PetscErrorCode PetscMemcmp(const void*,const void*,size_t,PetscBool *);
1445: PETSC_EXTERN PetscErrorCode PetscStrlen(const char[],size_t*);
1446: PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[],char,int*,char ***);
1447: PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int,char **);
1448: PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[],const char[],PetscBool *);
1449: PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[],const char[],PetscBool *);
1450: PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[],const char[],PetscBool *);
1451: PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[],const char[],size_t,PetscBool *);
1452: PETSC_EXTERN PetscErrorCode PetscStrcpy(char[],const char[]);
1453: PETSC_EXTERN PetscErrorCode PetscStrcat(char[],const char[]);
1454: PETSC_EXTERN PetscErrorCode PetscStrlcat(char[],const char[],size_t);
1455: PETSC_EXTERN PetscErrorCode PetscStrncpy(char[],const char[],size_t);
1456: PETSC_EXTERN PetscErrorCode PetscStrchr(const char[],char,char *[]);
1457: PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]);
1458: PETSC_EXTERN PetscErrorCode PetscStrtoupper(char[]);
1459: PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[],char,char *[]);
1460: PETSC_EXTERN PetscErrorCode PetscStrstr(const char[],const char[],char *[]);
1461: PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[],const char[],char *[]);
1462: PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[],const char[],PetscBool*);
1463: PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[],const char[],PetscBool*);
1464: PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[],const char *const*,PetscInt*);
1465: PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[],char *[]);
1466: PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const*,char***);
1467: PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char***);
1468: PETSC_EXTERN PetscErrorCode PetscStrNArrayallocpy(PetscInt,const char *const*,char***);
1469: PETSC_EXTERN PetscErrorCode PetscStrNArrayDestroy(PetscInt,char***);
1470: PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm,const char[],char[],size_t);
1472: PETSC_EXTERN void PetscStrcmpNoError(const char[],const char[],PetscBool *);
1474: /*S
1475: PetscToken - 'Token' used for managing tokenizing strings
1477: Level: intermediate
1479: .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy()
1480: S*/
1481: typedef struct _p_PetscToken* PetscToken;
1483: PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*);
1484: PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]);
1485: PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*);
1486: PETSC_EXTERN PetscErrorCode PetscStrInList(const char[],const char[],char,PetscBool*);
1488: PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt,const char *const*,const char*,PetscInt*,PetscBool*);
1489: PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const*,const char*,PetscEnum*,PetscBool*);
1491: /*
1492: These are MPI operations for MPI_Allreduce() etc
1493: */
1494: PETSC_EXTERN MPI_Op MPIU_MAXSUM_OP;
1495: #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1496: PETSC_EXTERN MPI_Op MPIU_SUM;
1497: #else
1498: #define MPIU_SUM MPI_SUM
1499: #endif
1500: #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1501: PETSC_EXTERN MPI_Op MPIU_MAX;
1502: PETSC_EXTERN MPI_Op MPIU_MIN;
1503: #else
1504: #define MPIU_MAX MPI_MAX
1505: #define MPIU_MIN MPI_MIN
1506: #endif
1507: PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*);
1509: PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1510: PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1512: /*S
1513: PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc
1515: Level: beginner
1517: Note:
1518: This is the base class from which all PETSc objects are derived from.
1520: .seealso: PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName(), PetscObjectReference(), PetscObjectDereference()
1521: S*/
1522: typedef struct _p_PetscObject* PetscObject;
1524: /*MC
1525: PetscObjectId - unique integer Id for a PetscObject
1527: Level: developer
1529: Notes:
1530: Unlike pointer values, object ids are never reused.
1532: .seealso: PetscObjectState, PetscObjectGetId()
1533: M*/
1534: #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */
1535: typedef int PetscObjectId;
1536: #else
1537: typedef PetscInt64 PetscObjectId;
1538: #endif
1540: /*MC
1541: PetscObjectState - integer state for a PetscObject
1543: Level: developer
1545: Notes:
1546: Object state is always-increasing and (for objects that track state) can be used to determine if an object has
1547: changed since the last time you interacted with it. It is 64-bit so that it will not overflow for a very long time.
1549: .seealso: PetscObjectId, PetscObjectStateGet(), PetscObjectStateIncrease(), PetscObjectStateSet()
1550: M*/
1551: #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */
1552: typedef int PetscObjectState;
1553: #else
1554: typedef PetscInt64 PetscObjectState;
1555: #endif
1557: /*S
1558: PetscFunctionList - Linked list of functions, possibly stored in dynamic libraries, accessed
1559: by string name
1561: Level: advanced
1563: .seealso: PetscFunctionListAdd(), PetscFunctionListDestroy(), PetscOpFlist
1564: S*/
1565: typedef struct _n_PetscFunctionList *PetscFunctionList;
1567: /*E
1568: PetscFileMode - Access mode for a file.
1570: Level: beginner
1572: $ FILE_MODE_READ - open a file at its beginning for reading
1573: $ FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist)
1574: $ FILE_MODE_APPEND - open a file at end for writing
1575: $ FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing
1576: $ FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end
1578: .seealso: PetscViewerFileSetMode()
1579: E*/
1580: typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode;
1581: extern const char *const PetscFileModes[];
1583: /*
1584: Defines PETSc error handling.
1585: */
1586: #include <petscerror.h>
1588: #define PETSC_SMALLEST_CLASSID 1211211
1589: PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID;
1590: PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID;
1591: PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *);
1593: /*
1594: Routines that get memory usage information from the OS
1595: */
1596: PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *);
1597: PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *);
1598: PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void);
1599: PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]);
1601: PETSC_EXTERN PetscErrorCode PetscInfoAllow(PetscBool ,const char []);
1602: PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal);
1604: /*
1605: Initialization of PETSc
1606: */
1607: PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]);
1608: PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]);
1609: PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void);
1610: PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *);
1611: PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *);
1612: PETSC_EXTERN PetscErrorCode PetscFinalize(void);
1613: PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void);
1614: PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***);
1615: PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***);
1616: PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **);
1618: PETSC_EXTERN PetscErrorCode PetscEnd(void);
1619: PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void);
1621: PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]);
1622: PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void);
1623: PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void);
1624: PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]);
1626: /*
1627: These are so that in extern C code we can caste function pointers to non-extern C
1628: function pointers. Since the regular C++ code expects its function pointers to be C++
1629: */
1630: PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void);
1631: PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void);
1632: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void);
1634: /*
1635: Functions that can act on any PETSc object.
1636: */
1637: PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject*);
1638: PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject,MPI_Comm *);
1639: PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject,PetscClassId *);
1640: PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject,const char *[]);
1641: PETSC_EXTERN PetscErrorCode PetscObjectSetType(PetscObject,const char []);
1642: PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject,const char *[]);
1643: PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject,const char[]);
1644: PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject,const char*[]);
1645: PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject,PetscInt);
1646: PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject,PetscInt*);
1647: PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt);
1648: PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject);
1649: PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject,PetscInt*);
1650: PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject);
1651: PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject,PetscMPIInt *);
1652: PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject,const char[],PetscObject);
1653: PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject,const char[]);
1654: PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject,const char[],PetscObject *);
1655: PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject,const char[],void (*)(void));
1656: #define PetscObjectComposeFunction(a,b,d) PetscObjectComposeFunction_Private(a,b,(PetscVoidFunction)(d))
1657: PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject);
1658: PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject);
1659: PETSC_EXTERN PetscErrorCode PetscObjectSetPrintedOptions(PetscObject);
1660: PETSC_EXTERN PetscErrorCode PetscObjectInheritPrintedOptions(PetscObject,PetscObject);
1661: PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm,PetscMPIInt *);
1663: #include <petscviewertypes.h>
1664: #include <petscoptions.h>
1666: PETSC_EXTERN PetscErrorCode PetscObjectsListGetGlobalNumbering(MPI_Comm,PetscInt,PetscObject*,PetscInt*,PetscInt*);
1668: PETSC_EXTERN PetscErrorCode PetscMemoryShowUsage(PetscViewer,const char[]);
1669: PETSC_EXTERN PetscErrorCode PetscMemoryView(PetscViewer,const char[]);
1670: PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject,PetscViewer);
1671: PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject,PetscViewer);
1672: #define PetscObjectQueryFunction(obj,name,fptr) PetscObjectQueryFunction_Private((obj),(name),(PetscVoidFunction*)(fptr))
1673: PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject,const char[],void (**)(void));
1674: PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject,const char[]);
1675: PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject,const char[]);
1676: PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject,const char[]);
1677: PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject,const char*[]);
1678: PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject,const char[]);
1679: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject);
1680: PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void);
1681: PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject,PetscObject,const char[]);
1682: PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject);
1683: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject,const char[],PetscBool *);
1684: PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompare(PetscObject,const char[],PetscBool *);
1685: PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject,PetscBool*,const char[],...);
1686: PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void));
1687: PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void);
1689: #if defined(PETSC_HAVE_SAWS)
1690: PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void);
1691: PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject);
1692: PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject,PetscBool);
1693: PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject);
1694: PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject);
1695: PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject);
1696: PETSC_EXTERN void PetscStackSAWsGrantAccess(void);
1697: PETSC_EXTERN void PetscStackSAWsTakeAccess(void);
1698: PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void);
1699: PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void);
1701: #else
1702: #define PetscSAWsBlock() 0
1703: #define PetscObjectSAWsViewOff(obj) 0
1704: #define PetscObjectSAWsSetBlock(obj,flg) 0
1705: #define PetscObjectSAWsBlock(obj) 0
1706: #define PetscObjectSAWsGrantAccess(obj) 0
1707: #define PetscObjectSAWsTakeAccess(obj) 0
1708: #define PetscStackViewSAWs() 0
1709: #define PetscStackSAWsViewOff() 0
1710: #define PetscStackSAWsTakeAccess()
1711: #define PetscStackSAWsGrantAccess()
1713: #endif
1715: typedef void* PetscDLHandle;
1716: typedef enum {PETSC_DL_DECIDE=0,PETSC_DL_NOW=1,PETSC_DL_LOCAL=2} PetscDLMode;
1717: PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *);
1718: PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *);
1719: PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **);
1721: #if defined(PETSC_USE_DEBUG)
1722: PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**);
1723: #endif
1724: PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool);
1726: /*S
1727: PetscObjectList - Linked list of PETSc objects, each accessable by string name
1729: Level: developer
1731: Notes:
1732: Used by PetscObjectCompose() and PetscObjectQuery()
1734: .seealso: PetscObjectListAdd(), PetscObjectListDestroy(), PetscObjectListFind(), PetscObjectCompose(), PetscObjectQuery(), PetscFunctionList
1735: S*/
1736: typedef struct _n_PetscObjectList *PetscObjectList;
1738: PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList*);
1739: PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList,const char[],PetscObject*);
1740: PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList,PetscObject,char**,PetscBool*);
1741: PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *,const char[],PetscObject);
1742: PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *,const char[]);
1743: PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList,PetscObjectList *);
1745: /*
1746: Dynamic library lists. Lists of names of routines in objects or in dynamic
1747: link libraries that will be loaded as needed.
1748: */
1750: #define PetscFunctionListAdd(list,name,fptr) PetscFunctionListAdd_Private((list),(name),(PetscVoidFunction)(fptr))
1751: PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList*,const char[],void (*)(void));
1752: PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList*);
1753: #define PetscFunctionListFind(list,name,fptr) PetscFunctionListFind_Private((list),(name),(PetscVoidFunction*)(fptr))
1754: PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList,const char[],void (**)(void));
1755: PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFunctionList,const char[]);
1756: PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList,PetscFunctionList *);
1757: PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList,PetscViewer);
1758: PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList,const char ***,int*);
1760: /*S
1761: PetscDLLibrary - Linked list of dynamics libraries to search for functions
1763: Level: advanced
1765: .seealso: PetscDLLibraryOpen()
1766: S*/
1767: typedef struct _n_PetscDLLibrary *PetscDLLibrary;
1768: PETSC_EXTERN PetscDLLibrary PetscDLLibrariesLoaded;
1769: PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]);
1770: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]);
1771: PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **);
1772: PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary);
1773: PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool *);
1774: PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *);
1775: PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary);
1777: /*
1778: Useful utility routines
1779: */
1780: PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*);
1781: PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*);
1782: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt);
1783: PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt);
1784: PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject);
1785: PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*);
1786: PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxInt(MPI_Comm,PetscInt[],PetscInt[]);
1787: PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxReal(MPI_Comm,PetscReal[],PetscReal[]);
1789: /*
1790: PetscNot - negates a logical type value and returns result as a PetscBool
1792: Notes:
1793: This is useful in cases like
1794: $ int *a;
1795: $ PetscBool flag = PetscNot(a)
1796: where !a would not return a PetscBool because we cannot provide a cast from int to PetscBool in C.
1797: */
1798: #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)
1800: /*MC
1801: PetscHelpPrintf - Prints help messages.
1803: Synopsis:
1804: #include <petscsys.h>
1805: PetscErrorCode (*PetscHelpPrintf)(const char format[],...);
1807: Not Collective
1809: Input Parameters:
1810: . format - the usual printf() format string
1812: Level: developer
1814: Fortran Note:
1815: This routine is not supported in Fortran.
1817: Concepts: help messages^printing
1818: Concepts: printing^help messages
1820: .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf()
1821: M*/
1822: PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...);
1824: /*
1825: Defines PETSc profiling.
1826: */
1827: #include <petsclog.h>
1829: /*
1830: Simple PETSc parallel IO for ASCII printing
1831: */
1832: PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]);
1833: PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**);
1834: PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*);
1835: PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...);
1836: PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...);
1837: PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...);
1838: PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...);
1840: PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...);
1841: PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...);
1842: PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...);
1844: #if defined(PETSC_HAVE_POPEN)
1845: PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **);
1846: PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm,FILE*);
1847: PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]);
1848: #endif
1850: PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm,const char[],...);
1851: PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...);
1852: PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm,FILE*);
1853: PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]);
1854: PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**);
1855: PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm,const char[],const char[],FILE**);
1856: PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char*[]);
1858: /*S
1859: PetscContainer - Simple PETSc object that contains a pointer to any required data
1861: Level: advanced
1863: .seealso: PetscObject, PetscContainerCreate()
1864: S*/
1865: PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID;
1866: typedef struct _p_PetscContainer* PetscContainer;
1867: PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer,void **);
1868: PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer,void *);
1869: PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer*);
1870: PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm,PetscContainer *);
1871: PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void*));
1872: PETSC_EXTERN PetscErrorCode PetscContainerUserDestroyDefault(void*);
1874: /*
1875: For use in debuggers
1876: */
1877: PETSC_EXTERN PetscMPIInt PetscGlobalRank;
1878: PETSC_EXTERN PetscMPIInt PetscGlobalSize;
1879: PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt,const PetscInt[],PetscViewer);
1880: PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt,const PetscReal[],PetscViewer);
1881: PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt,const PetscScalar[],PetscViewer);
1883: #include <stddef.h>
1884: #include <string.h> /* for memcpy, memset */
1885: #if defined(PETSC_HAVE_STDLIB_H)
1886: #include <stdlib.h>
1887: #endif
1889: #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__)
1890: #include <xmmintrin.h>
1891: #endif
1893: /*@C
1894: PetscMemcpy - Copies n bytes, beginning at location b, to the space
1895: beginning at location a. The two memory regions CANNOT overlap, use
1896: PetscMemmove() in that case.
1898: Not Collective
1900: Input Parameters:
1901: + b - pointer to initial memory space
1902: - n - length (in bytes) of space to copy
1904: Output Parameter:
1905: . a - pointer to copy space
1907: Level: intermediate
1909: Compile Option:
1910: PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used
1911: for memory copies on double precision values.
1912: PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used
1913: for memory copies on double precision values.
1914: PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used
1915: for memory copies on double precision values.
1917: Note:
1918: This routine is analogous to memcpy().
1920: Not available from Fortran
1922: Developer Note: this is inlined for fastest performance
1924: Concepts: memory^copying
1925: Concepts: copying^memory
1927: .seealso: PetscMemmove(), PetscStrallocpy()
1929: @*/
1930: PETSC_STATIC_INLINE PetscErrorCode PetscMemcpy(void *a,const void *b,size_t n)
1931: {
1932: #if defined(PETSC_USE_DEBUG)
1933: size_t al = (size_t) a,bl = (size_t) b;
1934: size_t nl = (size_t) n;
1936: if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer");
1937: if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer");
1938: #else
1940: #endif
1941: if (a != b && n > 0) {
1942: #if defined(PETSC_USE_DEBUG)
1943: if ((al > bl && (al - bl) < nl) || (bl - al) < nl) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Memory regions overlap: either use PetscMemmov()\n\
1944: or make sure your copy regions and lengths are correct. \n\
1945: Length (bytes) %ld first address %ld second address %ld",nl,al,bl);
1946: #endif
1947: #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY))
1948: if (!(a % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1949: size_t len = n/sizeof(PetscScalar);
1950: #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY)
1951: PetscBLASInt one = 1,blen;
1953: PetscBLASIntCast(len,&blen);
1954: PetscStackCallBLAS("BLAScopy",BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one));
1955: #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY)
1956: fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a);
1957: #else
1958: size_t i;
1959: PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a;
1960: for (i=0; i<len; i++) y[i] = x[i];
1961: #endif
1962: } else {
1963: memcpy((char*)(a),(char*)(b),n);
1964: }
1965: #else
1966: memcpy((char*)(a),(char*)(b),n);
1967: #endif
1968: }
1969: return(0);
1970: }
1972: /*@C
1973: PetscMemzero - Zeros the specified memory.
1975: Not Collective
1977: Input Parameters:
1978: + a - pointer to beginning memory location
1979: - n - length (in bytes) of memory to initialize
1981: Level: intermediate
1983: Compile Option:
1984: PETSC_PREFER_BZERO - on certain machines (the IBM RS6000) the bzero() routine happens
1985: to be faster than the memset() routine. This flag causes the bzero() routine to be used.
1987: Not available from Fortran
1989: Developer Note: this is inlined for fastest performance
1991: Concepts: memory^zeroing
1992: Concepts: zeroing^memory
1994: .seealso: PetscMemcpy()
1995: @*/
1996: PETSC_STATIC_INLINE PetscErrorCode PetscMemzero(void *a,size_t n)
1997: {
1998: if (n > 0) {
1999: #if defined(PETSC_USE_DEBUG)
2000: if (!a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer");
2001: #endif
2002: #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO)
2003: if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
2004: size_t i,len = n/sizeof(PetscScalar);
2005: PetscScalar *x = (PetscScalar*)a;
2006: for (i=0; i<len; i++) x[i] = 0.0;
2007: } else {
2008: #elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
2009: if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
2010: PetscInt len = n/sizeof(PetscScalar);
2011: fortranzero_(&len,(PetscScalar*)a);
2012: } else {
2013: #endif
2014: #if defined(PETSC_PREFER_BZERO)
2015: bzero((char *)a,n);
2016: #else
2017: memset((char*)a,0,n);
2018: #endif
2019: #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
2020: }
2021: #endif
2022: }
2023: return 0;
2024: }
2026: /*MC
2027: PetscPrefetchBlock - Prefetches a block of memory
2029: Synopsis:
2030: #include <petscsys.h>
2031: void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t)
2033: Not Collective
2035: Input Parameters:
2036: + a - pointer to first element to fetch (any type but usually PetscInt or PetscScalar)
2037: . n - number of elements to fetch
2038: . rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors)
2039: - t - temporal locality (PETSC_PREFETCH_HINT_{NTA,T0,T1,T2}), see note
2041: Level: developer
2043: Notes:
2044: The last two arguments (rw and t) must be compile-time constants.
2046: Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality. Not all architectures offer
2047: equivalent locality hints, but the following macros are always defined to their closest analogue.
2048: + PETSC_PREFETCH_HINT_NTA - Non-temporal. Prefetches directly to L1, evicts to memory (skips higher level cache unless it was already there when prefetched).
2049: . 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.
2050: . PETSC_PREFETCH_HINT_T1 - Fetch to level 2 and higher (not L1).
2051: - PETSC_PREFETCH_HINT_T2 - Fetch to high-level cache only. (On many systems, T0 and T1 are equivalent.)
2053: This function does nothing on architectures that do not support prefetch and never errors (even if passed an invalid
2054: address).
2056: Concepts: memory
2057: M*/
2058: #define PetscPrefetchBlock(a,n,rw,t) do { \
2059: const char *_p = (const char*)(a),*_end = (const char*)((a)+(n)); \
2060: for ( ; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p,(rw),(t)); \
2061: } while (0)
2063: /*
2064: Determine if some of the kernel computation routines use
2065: Fortran (rather than C) for the numerical calculations. On some machines
2066: and compilers (like complex numbers) the Fortran version of the routines
2067: is faster than the C/C++ versions. The flag --with-fortran-kernels
2068: should be used with ./configure to turn these on.
2069: */
2070: #if defined(PETSC_USE_FORTRAN_KERNELS)
2072: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL)
2073: #define PETSC_USE_FORTRAN_KERNEL_MULTCRL
2074: #endif
2076: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM)
2077: #define PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM
2078: #endif
2080: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
2081: #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
2082: #endif
2084: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
2085: #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
2086: #endif
2088: #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM)
2089: #define PETSC_USE_FORTRAN_KERNEL_NORM
2090: #endif
2092: #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
2093: #define PETSC_USE_FORTRAN_KERNEL_MAXPY
2094: #endif
2096: #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
2097: #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
2098: #endif
2100: #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ)
2101: #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ
2102: #endif
2104: #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
2105: #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
2106: #endif
2108: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
2109: #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
2110: #endif
2112: #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
2113: #define PETSC_USE_FORTRAN_KERNEL_MDOT
2114: #endif
2116: #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
2117: #define PETSC_USE_FORTRAN_KERNEL_XTIMESY
2118: #endif
2120: #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX)
2121: #define PETSC_USE_FORTRAN_KERNEL_AYPX
2122: #endif
2124: #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY)
2125: #define PETSC_USE_FORTRAN_KERNEL_WAXPY
2126: #endif
2128: #endif
2130: /*
2131: Macros for indicating code that should be compiled with a C interface,
2132: rather than a C++ interface. Any routines that are dynamically loaded
2133: (such as the PCCreate_XXX() routines) must be wrapped so that the name
2134: mangler does not change the functions symbol name. This just hides the
2135: ugly extern "C" {} wrappers.
2136: */
2137: #if defined(__cplusplus)
2138: #define EXTERN_C_BEGIN extern "C" {
2139: #define EXTERN_C_END }
2140: #else
2141: #define EXTERN_C_BEGIN
2142: #define EXTERN_C_END
2143: #endif
2145: /* --------------------------------------------------------------------*/
2147: /*MC
2148: MPI_Comm - the basic object used by MPI to determine which processes are involved in a
2149: communication
2151: Level: beginner
2153: Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm
2155: .seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF
2156: M*/
2158: /*MC
2159: PetscScalar - PETSc type that represents either a double precision real number, a double precision
2160: complex number, a single precision real number, a __float128 real or complex or a __fp16 real - if the code is configured
2161: with --with-scalar-type=real,complex --with-precision=single,double,__float128,__fp16
2163: Notes:
2164: For MPI calls that require datatypes, use MPIU_SCALAR as the datatype for PetscScalar and MPIU_SUM, MPIU_MAX etc for operations. They will automatically work correctly regardless of the size of PetscScalar.
2166: Level: beginner
2168: .seealso: PetscReal, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT, PetscRealPart(), PetscImaginaryPart()
2169: M*/
2171: /*MC
2172: PetscComplex - PETSc type that represents a complex number with precision matching that of PetscReal.
2174: Synopsis:
2175: #include <petscsys.h>
2176: PetscComplex number = 1. + 2.*PETSC_i;
2178: Notes:
2179: For MPI calls that require datatypes, use MPIU_COMPLEX as the datatype for PetscComplex and MPIU_SUM etc for operations.
2180: They will automatically work correctly regardless of the size of PetscComplex.
2182: See PetscScalar for details on how to ./configure the size of PetscReal
2184: Complex numbers are automatically available if PETSc was able to find a working complex implementation
2186: Level: beginner
2188: .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT, PETSC_i
2189: M*/
2191: /*MC
2192: PetscReal - PETSc type that represents a real number version of PetscScalar
2195: Notes:
2196: For MPI calls that require datatypes, use MPIU_REAL as the datatype for PetscScalar and MPIU_SUM, MPIU_MAX, etc. for operations.
2197: They will automatically work correctly regardless of the size of PetscReal.
2199: See PetscScalar for details on how to ./configure the size of PetscReal.
2201: Level: beginner
2203: .seealso: PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT
2204: M*/
2206: /*MC
2207: MPIU_SCALAR - MPI datatype corresponding to PetscScalar
2209: Notes:
2210: In MPI calls that require an MPI datatype that matches a PetscScalar or array of PetscScalar values, pass this value.
2212: Level: beginner
2214: .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_COMPLEX, MPIU_INT
2215: M*/
2217: /*MC
2218: MPIU_COMPLEX - MPI datatype corresponding to PetscComplex
2220: Notes:
2221: In MPI calls that require an MPI datatype that matches a PetscComplex or array of PetscComplex values, pass this value.
2223: Level: beginner
2225: .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT, PETSC_i
2226: M*/
2228: /*MC
2229: MPIU_REAL - MPI datatype corresponding to PetscReal
2231: Notes:
2232: In MPI calls that require an MPI datatype that matches a PetscReal or array of PetscReal values, pass this value.
2234: Level: beginner
2236: .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_SCALAR, MPIU_COMPLEX, MPIU_INT
2237: M*/
2239: #if defined(PETSC_HAVE_MPIIO)
2240: #if !defined(PETSC_WORDS_BIGENDIAN)
2241: PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2242: PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2243: #else
2244: #define MPIU_File_write_all(a,b,c,d,e) MPI_File_write_all(a,b,c,d,e)
2245: #define MPIU_File_read_all(a,b,c,d,e) MPI_File_read_all(a,b,c,d,e)
2246: #endif
2247: #endif
2249: /* the following petsc_static_inline require petscerror.h */
2251: /* Limit MPI to 32-bits */
2252: #define PETSC_MPI_INT_MAX 2147483647
2253: #define PETSC_MPI_INT_MIN -2147483647
2254: /* Limit BLAS to 32-bits */
2255: #define PETSC_BLAS_INT_MAX 2147483647
2256: #define PETSC_BLAS_INT_MIN -2147483647
2258: /*@C
2259: PetscBLASIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscBLASInt (which may be 32 bits in size), generates an
2260: error if the PetscBLASInt is not large enough to hold the number.
2262: Not Collective
2264: Input Parameter:
2265: . a - the PetscInt value
2267: Output Parameter:
2268: . b - the resulting PetscBLASInt value
2270: Level: advanced
2272: Not available from Fortran
2274: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscMPIIntCast()
2275: @*/
2276: PETSC_STATIC_INLINE PetscErrorCode PetscBLASIntCast(PetscInt a,PetscBLASInt *b)
2277: {
2279: *b = (PetscBLASInt)(a);
2280: #if defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_HAVE_64BIT_BLAS_INDICES)
2281: if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK");
2282: #endif
2283: return(0);
2284: }
2286: /*@C
2287: PetscMPIIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscMPIInt (which may be 32 bits in size), generates an
2288: error if the PetscMPIInt is not large enough to hold the number.
2290: Not Collective
2292: Input Parameter:
2293: . a - the PetscInt value
2295: Output Parameter:
2296: . b - the resulting PetscMPIInt value
2298: Level: advanced
2300: Not available from Fortran
2302: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast()
2303: @*/
2304: PETSC_STATIC_INLINE PetscErrorCode PetscMPIIntCast(PetscInt a,PetscMPIInt *b)
2305: {
2307: *b = (PetscMPIInt)(a);
2308: #if defined(PETSC_USE_64BIT_INDICES)
2309: if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for MPI");
2310: #endif
2311: return(0);
2312: }
2314: #define PetscInt64Mult(a,b) ((PetscInt64)(a))*((PetscInt64)(b))
2316: /*@C
2318: PetscRealIntMultTruncate - Computes the product of a positive PetscReal and a positive PetscInt and truncates the value to slightly less than the maximal possible value
2320: Not Collective
2322: Input Parameter:
2323: + a - the PetscReal value
2324: - b - the second value
2326: Returns:
2327: the result as a PetscInt value
2329: Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2330: Use PetscIntMultTruncate() to compute the product of two positive PetscInt and truncate to fit a PetscInt
2331: 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
2333: Developers Note:
2334: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks.
2336: This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2338: Not available from Fortran
2340: Level: advanced
2342: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2343: @*/
2344: PETSC_STATIC_INLINE PetscInt PetscRealIntMultTruncate(PetscReal a,PetscInt b)
2345: {
2346: PetscInt64 r;
2348: r = (PetscInt64) (a*(PetscReal)b);
2349: if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2350: return (PetscInt) r;
2351: }
2353: /*@C
2355: PetscIntMultTruncate - Computes the product of two positive PetscInt and truncates the value to slightly less than the maximal possible value
2357: Not Collective
2359: Input Parameter:
2360: + a - the PetscInt value
2361: - b - the second value
2363: Returns:
2364: the result as a PetscInt value
2366: Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2367: Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
2368: 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
2370: Not available from Fortran
2372: Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks.
2374: This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2376: Level: advanced
2378: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2379: @*/
2380: PETSC_STATIC_INLINE PetscInt PetscIntMultTruncate(PetscInt a,PetscInt b)
2381: {
2382: PetscInt64 r;
2384: r = PetscInt64Mult(a,b);
2385: if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2386: return (PetscInt) r;
2387: }
2389: /*@C
2391: PetscIntSumTruncate - Computes the sum of two positive PetscInt and truncates the value to slightly less than the maximal possible value
2393: Not Collective
2395: Input Parameter:
2396: + a - the PetscInt value
2397: - b - the second value
2399: Returns:
2400: the result as a PetscInt value
2402: Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2403: Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
2404: 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
2406: This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2408: Not available from Fortran
2410: Level: advanced
2412: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2413: @*/
2414: PETSC_STATIC_INLINE PetscInt PetscIntSumTruncate(PetscInt a,PetscInt b)
2415: {
2416: PetscInt64 r;
2418: r = ((PetscInt64)a) + ((PetscInt64)b);
2419: if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2420: return (PetscInt) r;
2421: }
2423: /*@C
2425: PetscIntMultError - Computes the product of two positive PetscInt and generates an error with overflow.
2427: Not Collective
2429: Input Parameter:
2430: + a - the PetscInt value
2431: - b - the second value
2433: Output Parameter:ma
2434: . result - the result as a PetscInt value, or NULL if you do not want the result, you just want to check if it overflows
2436: Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64
2437: Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt
2439: Not available from Fortran
2441: Developers Note: We currently assume that PetscInt addition does not overflow, this is obviously wrong but requires many more checks.
2443: Level: advanced
2445: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntMult64(), PetscIntSumError()
2446: @*/
2447: PETSC_STATIC_INLINE PetscErrorCode PetscIntMultError(PetscInt a,PetscInt b,PetscInt *result)
2448: {
2449: PetscInt64 r;
2452: r = PetscInt64Mult(a,b);
2453: #if !defined(PETSC_USE_64BIT_INDICES)
2454: 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);
2455: #endif
2456: if (result) *result = (PetscInt) r;
2457: return(0);
2458: }
2460: /*@C
2462: PetscIntSumError - Computes the sum of two positive PetscInt and generates an error with overflow.
2464: Not Collective
2466: Input Parameter:
2467: + a - the PetscInt value
2468: - b - the second value
2470: Output Parameter:ma
2471: . c - the result as a PetscInt value, or NULL if you do not want the result, you just want to check if it overflows
2473: Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64
2474: Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt
2476: Not available from Fortran
2478: Level: advanced
2480: .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2481: @*/
2482: PETSC_STATIC_INLINE PetscErrorCode PetscIntSumError(PetscInt a,PetscInt b,PetscInt *result)
2483: {
2484: PetscInt64 r;
2487: r = ((PetscInt64)a) + ((PetscInt64)b);
2488: #if !defined(PETSC_USE_64BIT_INDICES)
2489: 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);
2490: #endif
2491: if (result) *result = (PetscInt) r;
2492: return(0);
2493: }
2495: /*
2496: The IBM include files define hz, here we hide it so that it may be used as a regular user variable.
2497: */
2498: #if defined(hz)
2499: #undef hz
2500: #endif
2502: /* For arrays that contain filenames or paths */
2505: #if defined(PETSC_HAVE_LIMITS_H)
2506: #include <limits.h>
2507: #endif
2508: #if defined(PETSC_HAVE_SYS_PARAM_H)
2509: #include <sys/param.h>
2510: #endif
2511: #if defined(PETSC_HAVE_SYS_TYPES_H)
2512: #include <sys/types.h>
2513: #endif
2514: #if defined(MAXPATHLEN)
2515: # define PETSC_MAX_PATH_LEN MAXPATHLEN
2516: #elif defined(MAX_PATH)
2517: # define PETSC_MAX_PATH_LEN MAX_PATH
2518: #elif defined(_MAX_PATH)
2519: # define PETSC_MAX_PATH_LEN _MAX_PATH
2520: #else
2521: # define PETSC_MAX_PATH_LEN 4096
2522: #endif
2524: /*MC
2526: PETSC_VERSION - This manual page provides information about how PETSc documents and uses its version information. This information is available to both C/C++
2527: and Fortran compilers when petscsys.h is included.
2530: The current PETSc version and the API for accessing it are defined in petscversion.h
2532: The complete version number is given as the triple PETSC_VERSION_MAJOR.PETSC_VERSION_MINOR.PETSC_VERSION_SUBMINOR (in short hand x.y.z)
2534: 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
2535: where only a change in the major version number (x) indicates a change in the API.
2537: 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
2539: 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),
2540: 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
2541: version number (x.y.z).
2543: PETSC_RELEASE_DATE is the date the x.y version was released (i.e. the version before any patch releases)
2545: PETSC_VERSION_DATE is the date the x.y.z version was released
2547: PETSC_VERSION_GIT is the last git commit to the repository given in the form vx.y.z-wwwww
2549: PETSC_VERSION_DATE_GIT is the date of the last git commit to the repository
2551: Level: intermediate
2553: PETSC_VERSION_() and PETSC_VERSION_PATCH are deprecated and will eventually be removed. For several releases PETSC_VERSION_PATCH is always 0
2555: M*/
2557: /*MC
2559: UsingFortran - To use PETSc with Fortran you must use both PETSc include files and modules. At the beginning
2560: of every function and module definition you need something like
2562: $
2563: $#include "petsc/finclude/petscXXX.h"
2564: $ use petscXXX
2566: You can declare PETSc variables using either of the following.
2568: $ XXX variablename
2569: $ type(tXXX) variablename
2571: For example,
2573: $#include "petsc/finclude/petscvec.h"
2574: $ use petscvec
2575: $
2576: $ Vec b
2577: $ type(tVec) x
2579: Level: beginner
2581: M*/
2583: PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t);
2584: PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t);
2585: PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t);
2586: PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t);
2587: PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]);
2588: PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t);
2589: PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t);
2590: PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt*,PetscInt*,PetscInt*,PetscInt*);
2592: PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt,PetscInt[]);
2593: PETSC_EXTERN PetscErrorCode PetscSortedRemoveDupsInt(PetscInt*,PetscInt[]);
2594: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt*,PetscInt[]);
2595: PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt*);
2596: PETSC_EXTERN PetscErrorCode PetscFindMPIInt(PetscMPIInt, PetscInt, const PetscMPIInt[], PetscInt*);
2597: PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]);
2598: PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]);
2599: PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]);
2600: PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt,PetscInt[],PetscInt[],PetscInt[]);
2601: PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt,PetscMPIInt[]);
2602: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt*,PetscMPIInt[]);
2603: PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]);
2604: PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]);
2605: PETSC_EXTERN PetscErrorCode PetscSortIntWithDataArray(PetscInt,PetscInt[],void*,size_t,void*);
2606: PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt,PetscReal[]);
2607: PETSC_EXTERN PetscErrorCode PetscSortRealWithArrayInt(PetscInt,PetscReal[],PetscInt[]);
2608: PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]);
2609: PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt*,PetscReal[]);
2610: PETSC_EXTERN PetscErrorCode PetscFindReal(PetscReal,PetscInt,const PetscReal[],PetscReal,PetscInt*);
2611: PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]);
2612: PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]);
2613: PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt,const PetscBool [],const PetscInt[],PetscInt*,PetscInt**,PetscInt**,PetscInt**,PetscInt**);
2614: PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt,const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],PetscInt*,PetscInt**,PetscInt**);
2615: PETSC_EXTERN PetscErrorCode PetscMergeIntArray(PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt*,PetscInt**);
2616: PETSC_EXTERN PetscErrorCode PetscMergeMPIIntArray(PetscInt,const PetscMPIInt[],PetscInt,const PetscMPIInt[],PetscInt*,PetscMPIInt**);
2618: PETSC_EXTERN PetscErrorCode PetscSetDisplay(void);
2619: PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t);
2621: /*J
2622: PetscRandomType - String with the name of a PETSc randomizer
2624: Level: beginner
2626: Notes:
2627: To use SPRNG or RANDOM123 you must have ./configure PETSc
2628: with the option --download-sprng or --download-random123
2630: .seealso: PetscRandomSetType(), PetscRandom, PetscRandomCreate()
2631: J*/
2632: typedef const char* PetscRandomType;
2633: #define PETSCRAND "rand"
2634: #define PETSCRAND48 "rand48"
2635: #define PETSCSPRNG "sprng"
2636: #define PETSCRANDER48 "rander48"
2637: #define PETSCRANDOM123 "random123"
2639: /* Logging support */
2640: PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID;
2642: PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void);
2644: /*S
2645: PetscRandom - Abstract PETSc object that manages generating random numbers
2647: Level: intermediate
2649: Concepts: random numbers
2651: .seealso: PetscRandomCreate(), PetscRandomGetValue(), PetscRandomType
2652: S*/
2653: typedef struct _p_PetscRandom* PetscRandom;
2655: /* Dynamic creation and loading functions */
2656: PETSC_EXTERN PetscFunctionList PetscRandomList;
2658: PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],PetscErrorCode (*)(PetscRandom));
2659: PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType);
2660: PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom);
2661: PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType*);
2662: PETSC_STATIC_INLINE PetscErrorCode PetscRandomViewFromOptions(PetscRandom A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
2663: PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer);
2665: PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*);
2666: PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*);
2667: PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*);
2668: PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*);
2669: PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar);
2670: PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long);
2671: PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *);
2672: PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom);
2673: PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*);
2675: PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t);
2676: PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t);
2677: PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t);
2678: PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]);
2679: PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t);
2680: PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *);
2681: PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *);
2682: PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]);
2683: PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]);
2685: PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscDataType);
2686: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscDataType);
2687: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,void*,PetscInt,PetscDataType,PetscBool );
2688: PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,void*,PetscInt,PetscDataType,PetscBool );
2689: PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *);
2690: PETSC_EXTERN PetscErrorCode PetscBinaryClose(int);
2691: PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool *);
2692: PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool *);
2693: PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t);
2694: PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *);
2695: PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *);
2696: #if defined(PETSC_USE_SOCKET_VIEWER)
2697: PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[],int,int*);
2698: #endif
2700: /*
2701: In binary files variables are stored using the following lengths,
2702: regardless of how they are stored in memory on any one particular
2703: machine. Use these rather then sizeof() in computing sizes for
2704: PetscBinarySeek().
2705: */
2706: #define PETSC_BINARY_INT_SIZE (32/8)
2707: #define PETSC_BINARY_FLOAT_SIZE (32/8)
2708: #define PETSC_BINARY_CHAR_SIZE (8/8)
2709: #define PETSC_BINARY_SHORT_SIZE (16/8)
2710: #define PETSC_BINARY_DOUBLE_SIZE (64/8)
2711: #define PETSC_BINARY_SCALAR_SIZE sizeof(PetscScalar)
2713: /*E
2714: PetscBinarySeekType - argument to PetscBinarySeek()
2716: Level: advanced
2718: .seealso: PetscBinarySeek(), PetscBinarySynchronizedSeek()
2719: E*/
2720: typedef enum {PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1,PETSC_BINARY_SEEK_END = 2} PetscBinarySeekType;
2721: PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*);
2722: PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*);
2723: PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt);
2725: PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]);
2726: PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool );
2727: PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void);
2728: PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*);
2729: PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void);
2730: PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void);
2732: PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*);
2733: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**);
2734: PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**);
2735: PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**);
2736: PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**);
2737: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt*,const void*,PetscMPIInt*,PetscMPIInt**,void*)
2738: PetscAttrMPIPointerWithType(6,3);
2739: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedF(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
2740: PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
2741: PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
2742: PetscAttrMPIPointerWithType(6,3);
2743: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedFReq(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
2744: MPI_Request**,MPI_Request**,
2745: PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
2746: PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
2747: PetscAttrMPIPointerWithType(6,3);
2749: /*E
2750: PetscBuildTwoSidedType - algorithm for setting up two-sided communication
2752: $ PETSC_BUILDTWOSIDED_ALLREDUCE - classical algorithm using an MPI_Allreduce with
2753: $ a buffer of length equal to the communicator size. Not memory-scalable due to
2754: $ the large reduction size. Requires only MPI-1.
2755: $ PETSC_BUILDTWOSIDED_IBARRIER - nonblocking algorithm based on MPI_Issend and MPI_Ibarrier.
2756: $ Proved communication-optimal in Hoefler, Siebert, and Lumsdaine (2010). Requires MPI-3.
2757: $ PETSC_BUILDTWOSIDED_REDSCATTER - similar to above, but use more optimized function
2758: $ that only communicates the part of the reduction that is necessary. Requires MPI-2.
2760: Level: developer
2762: .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedSetType(), PetscCommBuildTwoSidedGetType()
2763: E*/
2764: typedef enum {
2765: PETSC_BUILDTWOSIDED_NOTSET = -1,
2766: PETSC_BUILDTWOSIDED_ALLREDUCE = 0,
2767: PETSC_BUILDTWOSIDED_IBARRIER = 1,
2768: PETSC_BUILDTWOSIDED_REDSCATTER = 2
2769: /* Updates here must be accompanied by updates in finclude/petscsys.h and the string array in mpits.c */
2770: } PetscBuildTwoSidedType;
2771: PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[];
2772: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm,PetscBuildTwoSidedType);
2773: PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm,PetscBuildTwoSidedType*);
2775: PETSC_EXTERN PetscErrorCode PetscSSEIsEnabled(MPI_Comm,PetscBool *,PetscBool *);
2777: /*E
2778: InsertMode - Whether entries are inserted or added into vectors or matrices
2780: Level: beginner
2782: .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2783: VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(),
2784: MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd()
2785: E*/
2786: typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES, INSERT_ALL_VALUES, ADD_ALL_VALUES, INSERT_BC_VALUES, ADD_BC_VALUES} InsertMode;
2788: /*MC
2789: INSERT_VALUES - Put a value into a vector or matrix, overwrites any previous value
2791: Level: beginner
2793: .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2794: VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), ADD_VALUES,
2795: MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES
2797: M*/
2799: /*MC
2800: ADD_VALUES - Adds a value into a vector or matrix, if there previously was no value, just puts the
2801: value into that location
2803: Level: beginner
2805: .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2806: VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), INSERT_VALUES,
2807: MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES
2809: M*/
2811: /*MC
2812: MAX_VALUES - Puts the maximum of the scattered/gathered value and the current value into each location
2814: Level: beginner
2816: .seealso: InsertMode, VecScatterBegin(), VecScatterEnd(), ADD_VALUES, INSERT_VALUES
2818: M*/
2820: PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject);
2822: typedef enum {PETSC_SUBCOMM_GENERAL=0,PETSC_SUBCOMM_CONTIGUOUS=1,PETSC_SUBCOMM_INTERLACED=2} PetscSubcommType;
2823: PETSC_EXTERN const char *const PetscSubcommTypes[];
2825: /*S
2826: PetscSubcomm - A decomposition of an MPI communicator into subcommunicators
2828: Notes:
2829: After a call to PetscSubcommSetType(), PetscSubcommSetTypeGeneral(), or PetscSubcommSetFromOptions() one may call
2830: $ PetscSubcommChild() returns the associated subcommunicator on this process
2831: $ PetscSubcommContiguousParent() returns a parent communitor but with all child of the same subcommunicator having contiguous rank
2833: Sample Usage:
2834: PetscSubcommCreate()
2835: PetscSubcommSetNumber()
2836: PetscSubcommSetType(PETSC_SUBCOMM_INTERLACED);
2837: ccomm = PetscSubcommChild()
2838: PetscSubcommDestroy()
2840: Level: advanced
2842: Concepts: communicator, create
2844: Notes:
2845: $ PETSC_SUBCOMM_GENERAL - similar to MPI_Comm_split() each process sets the new communicator (color) they will belong to and the order within that communicator
2846: $ PETSC_SUBCOMM_CONTIGUOUS - each new communicator contains a set of process with contiguous ranks in the original MPI communicator
2847: $ PETSC_SUBCOMM_INTERLACED - each new communictor contains a set of processes equally far apart in rank from the others in that new communicator
2849: Example: Consider a communicator with six processes split into 3 subcommunicators.
2850: $ PETSC_SUBCOMM_CONTIGUOUS - the first communicator contains rank 0,1 the second rank 2,3 and the third rank 4,5 in the original ordering of the original communicator
2851: $ PETSC_SUBCOMM_INTERLACED - the first communicator contains rank 0,3, the second 1,4 and the third 2,5
2853: Developer Notes:
2854: This is used in objects such as PCREDUNDANT to manage the subcommunicators on which the redundant computations
2855: are performed.
2858: .seealso: PetscSubcommCreate(), PetscSubcommSetNumber(), PetscSubcommSetType(), PetscSubcommView(), PetscSubcommSetFromOptions()
2860: S*/
2861: typedef struct _n_PetscSubcomm* PetscSubcomm;
2863: struct _n_PetscSubcomm {
2864: MPI_Comm parent; /* parent communicator */
2865: MPI_Comm dupparent; /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */
2866: MPI_Comm child; /* the sub-communicator */
2867: PetscMPIInt n; /* num of subcommunicators under the parent communicator */
2868: PetscMPIInt color; /* color of processors belong to this communicator */
2869: PetscMPIInt *subsize; /* size of subcommunicator[color] */
2870: PetscSubcommType type;
2871: char *subcommprefix;
2872: };
2874: PETSC_STATIC_INLINE MPI_Comm PetscSubcommParent(PetscSubcomm scomm) {return scomm->parent;}
2875: PETSC_STATIC_INLINE MPI_Comm PetscSubcommChild(PetscSubcomm scomm) {return scomm->child;}
2876: PETSC_STATIC_INLINE MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm) {return scomm->dupparent;}
2877: PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*);
2878: PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*);
2879: PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt);
2880: PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType);
2881: PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt);
2882: PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm,PetscViewer);
2883: PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm);
2884: PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm,const char[]);
2886: /*S
2887: PetscHeap - A simple class for managing heaps
2889: Level: intermediate
2891: Concepts: random numbers
2893: .seealso: PetscHeapCreate(), PetscHeapAdd(), PetscHeapPop(), PetscHeapPeek(), PetscHeapStash(), PetscHeapUnstash(), PetscHeapView(), PetscHeapDestroy()
2894: S*/
2895: typedef struct _PetscHeap *PetscHeap;
2897: PETSC_EXTERN PetscErrorCode PetscHeapCreate(PetscInt,PetscHeap*);
2898: PETSC_EXTERN PetscErrorCode PetscHeapAdd(PetscHeap,PetscInt,PetscInt);
2899: PETSC_EXTERN PetscErrorCode PetscHeapPop(PetscHeap,PetscInt*,PetscInt*);
2900: PETSC_EXTERN PetscErrorCode PetscHeapPeek(PetscHeap,PetscInt*,PetscInt*);
2901: PETSC_EXTERN PetscErrorCode PetscHeapStash(PetscHeap,PetscInt,PetscInt);
2902: PETSC_EXTERN PetscErrorCode PetscHeapUnstash(PetscHeap);
2903: PETSC_EXTERN PetscErrorCode PetscHeapDestroy(PetscHeap*);
2904: PETSC_EXTERN PetscErrorCode PetscHeapView(PetscHeap,PetscViewer);
2906: PETSC_EXTERN PetscErrorCode PetscProcessPlacementView(PetscViewer);
2907: typedef struct _n_PetscCommShared* PetscCommShared;
2908: PETSC_EXTERN PetscErrorCode PetscCommSharedGet(MPI_Comm,PetscCommShared*);
2909: PETSC_EXTERN PetscErrorCode PetscCommSharedGlobalToLocal(PetscCommShared,PetscMPIInt,PetscMPIInt*);
2910: PETSC_EXTERN PetscErrorCode PetscCommSharedGetComm(PetscCommShared,MPI_Comm*);
2912: /*S
2913: PetscSegBuffer - a segmented extendable buffer
2915: Level: developer
2917: .seealso: PetscSegBufferCreate(), PetscSegBufferGet(), PetscSegBufferExtract(), PetscSegBufferDestroy()
2918: S*/
2919: typedef struct _n_PetscSegBuffer *PetscSegBuffer;
2920: PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t,size_t,PetscSegBuffer*);
2921: PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer*);
2922: PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer,size_t,void*);
2923: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer,void*);
2924: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer,void*);
2925: PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer,void*);
2926: PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer,size_t*);
2927: PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer,size_t);
2931: * prevents the compiler from completely erasing the stub. This is called in inner loops so it has to be as fast as
2932: * possible. */
2933: PETSC_STATIC_INLINE PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg,PetscInt count,PetscInt *PETSC_RESTRICT *slot) {return PetscSegBufferGet(seg,(size_t)count,(void**)slot);}
2935: typedef struct _n_PetscOptionsHelpPrinted *PetscOptionsHelpPrinted;
2936: extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton;
2937: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted*);
2938: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted*);
2939: PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted,const char*,const char*,PetscBool*);
2941: #include <stdarg.h>
2942: PETSC_EXTERN PetscErrorCode PetscVSNPrintf(char*,size_t,const char[],size_t*,va_list);
2943: PETSC_EXTERN PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list);
2945: PETSC_EXTERN PetscSegBuffer PetscCitationsList;
2947: /*@C
2948: PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used in the code.
2950: Not Collective - only what is registered on rank 0 of PETSC_COMM_WORLD will be printed
2952: Input Parameters:
2953: + cite - the bibtex item, formated to displayed on multiple lines nicely
2954: - set - a boolean variable initially set to PETSC_FALSE; this is used to insure only a single registration of the citation
2956: Level: intermediate
2958: Not available from Fortran
2960: Options Database:
2961: . -citations [filename] - print out the bibtex entries for the given computation
2962: @*/
2963: PETSC_STATIC_INLINE PetscErrorCode PetscCitationsRegister(const char cit[],PetscBool *set)
2964: {
2965: size_t len;
2966: char *vstring;
2970: if (set && *set) return(0);
2971: PetscStrlen(cit,&len);
2972: PetscSegBufferGet(PetscCitationsList,len,&vstring);
2973: PetscMemcpy(vstring,cit,len);
2974: if (set) *set = PETSC_TRUE;
2975: return(0);
2976: }
2978: PETSC_EXTERN PetscErrorCode PetscURLShorten(const char[],char[],size_t);
2979: PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm,char[],char[],size_t);
2980: PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm,const char[],char[],size_t);
2981: PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm,const char[],const char []);
2983: PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm,char[],char[],size_t);
2984: PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm,const char[],char[],char[],size_t);
2986: PETSC_EXTERN PetscErrorCode PetscGlobusGetTransfers(MPI_Comm,const char[],char[],size_t);
2988: PETSC_EXTERN PetscErrorCode PetscTextBelt(MPI_Comm,const char[],const char[],PetscBool*);
2989: PETSC_EXTERN PetscErrorCode PetscTellMyCell(MPI_Comm,const char[],const char[],PetscBool*);
2991: PETSC_EXTERN PetscErrorCode PetscPullJSONValue(const char[],const char[],char[],size_t,PetscBool*);
2992: PETSC_EXTERN PetscErrorCode PetscPushJSONValue(char[],const char[],const char[],size_t);
2995: #if defined(PETSC_USE_DEBUG)
2996: /*
2997: Verify that all processes in the communicator have called this from the same line of code
2998: */
2999: PETSC_EXTERN PetscErrorCode PetscAllreduceBarrierCheck(MPI_Comm,PetscMPIInt,int,const char*,const char *);
3001: /*MC
3002: MPIU_Allreduce - a PETSc replacement for MPI_Allreduce() that tries to determine if the call from all the MPI processes occur from the
3003: same place in the PETSc code. This helps to detect bugs where different MPI processes follow different code paths
3004: resulting in inconsistent and incorrect calls to MPI_Allreduce().
3006: Collective on MPI_Comm
3008: Synopsis:
3009: #include <petscsys.h>
3010: PetscErrorCode MPIU_Allreduce(void *indata,void *outdata,PetscMPIInt count,MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);
3012: Input Parameters:
3013: + indata - pointer to the input data to be reduced
3014: . count - the number of MPI data items in indata and outdata
3015: . datatype - the MPI datatype, for example MPI_INT
3016: . op - the MPI operation, for example MPI_SUM
3017: - comm - the MPI communicator on which the operation occurs
3019: Output Parameter:
3020: . outdata - the reduced values
3022: Notes:
3023: In optimized mode this directly calls MPI_Allreduce()
3025: Level: developer
3027: .seealso: MPI_Allreduce()
3028: M*/
3029: #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))
3030: #else
3031: #define MPIU_Allreduce(a,b,c,d,e,fcomm) MPI_Allreduce(a,b,c,d,e,fcomm)
3032: #endif
3034: #if defined(PETSC_HAVE_MPI_WIN_CREATE_FEATURE)
3035: PETSC_EXTERN PetscErrorCode MPIU_Win_allocate_shared(MPI_Aint,PetscMPIInt,MPI_Info,MPI_Comm,void*,MPI_Win*);
3036: PETSC_EXTERN PetscErrorCode MPIU_Win_shared_query(MPI_Win,PetscMPIInt,MPI_Aint*,PetscMPIInt*,void*);
3037: #endif
3039: /*
3040: Returned from PETSc functions that are called from MPI, such as related to attributes
3041: */
3042: PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CLASS;
3043: PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CODE;
3045: #endif