xref: /petsc/include/petscsys.h (revision df4397b0113739eddce7836635e612aecb0144dc)
1d382aafbSBarry Smith /*
2d382aafbSBarry Smith    This is the main PETSc include file (for C and C++).  It is included by all
3d382aafbSBarry Smith    other PETSc include files, so it almost never has to be specifically included.
4d382aafbSBarry Smith */
56c7e564aSBarry Smith #if !defined(__PETSCSYS_H)
66c7e564aSBarry Smith #define __PETSCSYS_H
7d382aafbSBarry Smith /* ========================================================================== */
8d382aafbSBarry Smith /*
9d382aafbSBarry Smith    petscconf.h is contained in ${PETSC_ARCH}/include/petscconf.h it is
101cc8b206SBarry Smith    found automatically by the compiler due to the -I${PETSC_DIR}/${PETSC_ARCH}/include.
111cc8b206SBarry Smith    For --prefix installs the ${PETSC_ARCH}/ does not exist and petscconf.h is in the same
121cc8b206SBarry Smith    directory as the other PETSc include files.
13d382aafbSBarry Smith */
142c8e378dSBarry Smith #include <petscconf.h>
152c8e378dSBarry Smith #include <petscfix.h>
16d382aafbSBarry Smith 
1773fca5a0SBarry Smith #if defined(PETSC_DESIRE_FEATURE_TEST_MACROS)
1873fca5a0SBarry Smith /*
1973fca5a0SBarry Smith    Feature test macros must be included before headers defined by IEEE Std 1003.1-2001
2073fca5a0SBarry Smith    We only turn these in PETSc source files that require them by setting PETSC_DESIRE_FEATURE_TEST_MACROS
2173fca5a0SBarry Smith */
22216f1ae6SBarry Smith #  if defined(PETSC__POSIX_C_SOURCE_200112L) && !defined(_POSIX_C_SOURCE)
2373fca5a0SBarry Smith #    define _POSIX_C_SOURCE 200112L
2473fca5a0SBarry Smith #  endif
25216f1ae6SBarry Smith #  if defined(PETSC__BSD_SOURCE) && !defined(_BSD_SOURCE)
2673fca5a0SBarry Smith #    define _BSD_SOURCE
2773fca5a0SBarry Smith #  endif
2807f00807SSatish Balay #  if defined(PETSC__DEFAULT_SOURCE) && !defined(_DEFAULT_SOURCE)
2907f00807SSatish Balay #    define _DEFAULT_SOURCE
3007f00807SSatish Balay #  endif
31ea0fecefSShri Abhyankar #  if defined(PETSC__GNU_SOURCE) && !defined(_GNU_SOURCE)
32ea0fecefSShri Abhyankar #    define _GNU_SOURCE
33ea0fecefSShri Abhyankar #  endif
3473fca5a0SBarry Smith #endif
3573fca5a0SBarry Smith 
36*df4397b0SStefano Zampini #include <petscsystypes.h>
37*df4397b0SStefano Zampini 
38d382aafbSBarry Smith /* ========================================================================== */
39d382aafbSBarry Smith /*
402c280183SJed Brown    This facilitates using the C version of PETSc from C++ and the C++ version from C.
41d382aafbSBarry Smith */
421ec50b02SJed Brown #if defined(__cplusplus)
431ec50b02SJed Brown #  define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_CXX
441ec50b02SJed Brown #else
451ec50b02SJed Brown #  define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_C
461ec50b02SJed Brown #endif
47d382aafbSBarry Smith 
48c5e4d11fSDmitry Karpeev /* ========================================================================== */
49c5e4d11fSDmitry Karpeev /*
50c5e4d11fSDmitry Karpeev    Since PETSc manages its own extern "C" handling users should never include PETSc include
511cc8b206SBarry Smith    files within extern "C". This will generate a compiler error if a user does put the include
521cc8b206SBarry Smith    file within an extern "C".
53c5e4d11fSDmitry Karpeev */
54c5e4d11fSDmitry Karpeev #if defined(__cplusplus)
55c5e4d11fSDmitry Karpeev void assert_never_put_petsc_headers_inside_an_extern_c(int); void assert_never_put_petsc_headers_inside_an_extern_c(double);
56c5e4d11fSDmitry Karpeev #endif
57c5e4d11fSDmitry Karpeev 
58ed938b00SJed Brown #if defined(__cplusplus)
59ed938b00SJed Brown #  define PETSC_RESTRICT PETSC_CXX_RESTRICT
60ed938b00SJed Brown #else
61ed938b00SJed Brown #  define PETSC_RESTRICT PETSC_C_RESTRICT
62ed938b00SJed Brown #endif
63ed938b00SJed Brown 
64ed938b00SJed Brown #if defined(__cplusplus)
6558c433abSLisandro Dalcin #  define PETSC_INLINE PETSC_CXX_INLINE
66ed938b00SJed Brown #else
6758c433abSLisandro Dalcin #  define PETSC_INLINE PETSC_C_INLINE
68ed938b00SJed Brown #endif
69ed938b00SJed Brown 
7058c433abSLisandro Dalcin #define PETSC_STATIC_INLINE static PETSC_INLINE
7158c433abSLisandro Dalcin 
72ab699e31SSatish Balay #if defined(_WIN32) && defined(PETSC_USE_SHARED_LIBRARIES) /* For Win32 shared libraries */
73014dd563SJed Brown #  define PETSC_DLLEXPORT __declspec(dllexport)
74014dd563SJed Brown #  define PETSC_DLLIMPORT __declspec(dllimport)
7521f66b81SJed Brown #  define PETSC_VISIBILITY_INTERNAL
7626703958SBarry Smith #elif defined(PETSC_USE_VISIBILITY_CXX) && defined(__cplusplus)
7726703958SBarry Smith #  define PETSC_DLLEXPORT __attribute__((visibility ("default")))
7826703958SBarry Smith #  define PETSC_DLLIMPORT __attribute__((visibility ("default")))
7926703958SBarry Smith #  define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden")))
8026703958SBarry Smith #elif defined(PETSC_USE_VISIBILITY_C) && !defined(__cplusplus)
81014dd563SJed Brown #  define PETSC_DLLEXPORT __attribute__((visibility ("default")))
82014dd563SJed Brown #  define PETSC_DLLIMPORT __attribute__((visibility ("default")))
8321f66b81SJed Brown #  define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden")))
84d382aafbSBarry Smith #else
85014dd563SJed Brown #  define PETSC_DLLEXPORT
86014dd563SJed Brown #  define PETSC_DLLIMPORT
8721f66b81SJed Brown #  define PETSC_VISIBILITY_INTERNAL
88014dd563SJed Brown #endif
89014dd563SJed Brown 
90014dd563SJed Brown #if defined(petsc_EXPORTS)      /* CMake defines this when building the shared library */
91014dd563SJed Brown #  define PETSC_VISIBILITY_PUBLIC PETSC_DLLEXPORT
92014dd563SJed Brown #else  /* Win32 users need this to import symbols from petsc.dll */
93014dd563SJed Brown #  define PETSC_VISIBILITY_PUBLIC PETSC_DLLIMPORT
94014dd563SJed Brown #endif
95014dd563SJed Brown 
961cc8b206SBarry Smith /*
971cc8b206SBarry Smith     Functions tagged with PETSC_EXTERN in the header files are
981cc8b206SBarry Smith   always defined as extern "C" when compiled with C++ so they may be
991cc8b206SBarry Smith   used from C and are always visible in the shared libraries
1001cc8b206SBarry Smith */
1012c280183SJed Brown #if defined(__cplusplus)
102014dd563SJed Brown #  define PETSC_EXTERN extern "C" PETSC_VISIBILITY_PUBLIC
103638cfed1SJed Brown #  define PETSC_EXTERN_TYPEDEF extern "C"
10421f66b81SJed Brown #  define PETSC_INTERN extern "C" PETSC_VISIBILITY_INTERNAL
105014dd563SJed Brown #else
106014dd563SJed Brown #  define PETSC_EXTERN extern PETSC_VISIBILITY_PUBLIC
107638cfed1SJed Brown #  define PETSC_EXTERN_TYPEDEF
1086258c452SJed Brown #  define PETSC_INTERN extern PETSC_VISIBILITY_INTERNAL
109d382aafbSBarry Smith #endif
11027710113SBarry Smith 
1112c8e378dSBarry Smith #include <petscversion.h>
112301d30feSBarry Smith #define PETSC_AUTHOR_INFO  "       The PETSc Team\n    petsc-maint@mcs.anl.gov\n http://www.mcs.anl.gov/petsc/\n"
113d382aafbSBarry Smith 
114d382aafbSBarry Smith /* ========================================================================== */
115d382aafbSBarry Smith 
116d382aafbSBarry Smith /*
117d382aafbSBarry Smith     Defines the interface to MPI allowing the use of all MPI functions.
118d382aafbSBarry Smith 
119d382aafbSBarry Smith     PETSc does not use the C++ binding of MPI at ALL. The following flag
120d382aafbSBarry Smith     makes sure the C++ bindings are not included. The C++ bindings REQUIRE
121d382aafbSBarry Smith     putting mpi.h before ANY C++ include files, we cannot control this
122d382aafbSBarry Smith     with all PETSc users. Users who want to use the MPI C++ bindings can include
123d382aafbSBarry Smith     mpicxx.h directly in their code
124d382aafbSBarry Smith */
125fa9e63e2SJed Brown #if !defined(MPICH_SKIP_MPICXX)
126d382aafbSBarry Smith #  define MPICH_SKIP_MPICXX 1
127fa9e63e2SJed Brown #endif
128fa9e63e2SJed Brown #if !defined(OMPI_SKIP_MPICXX)
129d382aafbSBarry Smith #  define OMPI_SKIP_MPICXX 1
130fa9e63e2SJed Brown #endif
131e771154cSJed Brown #if defined(PETSC_HAVE_MPIUNI)
132e771154cSJed Brown #  include <petsc/mpiuni/mpi.h>
133e771154cSJed Brown #else
1342c8e378dSBarry Smith #  include <mpi.h>
135e771154cSJed Brown #endif
13665013866SBarry Smith 
137d382aafbSBarry Smith /*
138a7886beaSBarry Smith    Perform various sanity checks that the correct mpi.h is being included at compile time.
139a7886beaSBarry Smith    This usually happens because
140a7886beaSBarry Smith       * either an unexpected mpi.h is in the default compiler path (i.e. in /usr/include) or
141a7886beaSBarry Smith       * an extra include path -I/something (which contains the unexpected mpi.h) is being passed to the compiler
142a7886beaSBarry Smith */
143a7886beaSBarry Smith #if defined(PETSC_HAVE_MPIUNI)
144a7886beaSBarry Smith #  if !defined(__MPIUNI_H)
145a7886beaSBarry Smith #    error "PETSc was configured with --with-mpi=0 but now appears to be compiling using a different mpi.h"
146a7886beaSBarry Smith #  endif
14741f4af4cSSatish Balay #elif defined(PETSC_HAVE_I_MPI_NUMVERSION)
14841f4af4cSSatish Balay #  if !defined(I_MPI_NUMVERSION)
14941f4af4cSSatish Balay #    error "PETSc was configured with I_MPI but now appears to be compiling using a non-I_MPI mpi.h"
15041f4af4cSSatish Balay #  elif I_MPI_NUMVERSION != PETSC_HAVE_I_MPI_NUMVERSION
15141f4af4cSSatish Balay #    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"
15241f4af4cSSatish Balay #  endif
15341f4af4cSSatish Balay #elif defined(PETSC_HAVE_MVAPICH2_NUMVERSION)
15441f4af4cSSatish Balay #  if !defined(MVAPICH2_NUMVERSION)
15541f4af4cSSatish Balay #    error "PETSc was configured with MVAPICH2 but now appears to be compiling using a non-MVAPICH2 mpi.h"
15641f4af4cSSatish Balay #  elif MVAPICH2_NUMVERSION != PETSC_HAVE_MVAPICH2_NUMVERSION
15741f4af4cSSatish Balay #    error "PETSc was configured with one MVAPICH2 mpi.h version but now appears to be compiling using a different MVAPICH2 mpi.h version"
15841f4af4cSSatish Balay #  endif
159a7886beaSBarry Smith #elif defined(PETSC_HAVE_MPICH_NUMVERSION)
16041f4af4cSSatish Balay #  if !defined(MPICH_NUMVERSION) || defined(MVAPICH2_NUMVERSION) || defined(I_MPI_NUMVERSION)
161a7886beaSBarry Smith #    error "PETSc was configured with MPICH but now appears to be compiling using a non-MPICH mpi.h"
162ca70f86eSJed Brown #  elif (MPICH_NUMVERSION/100000 != PETSC_HAVE_MPICH_NUMVERSION/100000) || (MPICH_NUMVERSION%100000/1000 < PETSC_HAVE_MPICH_NUMVERSION%100000/1000)
163a7886beaSBarry Smith #    error "PETSc was configured with one MPICH mpi.h version but now appears to be compiling using a different MPICH mpi.h version"
164a7886beaSBarry Smith #  endif
165a7886beaSBarry Smith #elif defined(PETSC_HAVE_OMPI_MAJOR_VERSION)
166a7886beaSBarry Smith #  if !defined(OMPI_MAJOR_VERSION)
167a7886beaSBarry Smith #    error "PETSc was configured with OpenMPI but now appears to be compiling using a non-OpenMPI mpi.h"
168ca70f86eSJed Brown #  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)
169c3ac57cfSSatish Balay #    error "PETSc was configured with one OpenMPI mpi.h version but now appears to be compiling using a different OpenMPI mpi.h version"
170a7886beaSBarry Smith #  endif
17141f4af4cSSatish Balay #elif defined(OMPI_MAJOR_VERSION) || defined(MPICH_NUMVERSION)
17241f4af4cSSatish Balay #  error "PETSc was configured with undetermined MPI - but now appears to be compiling using either of OpenMPI or a MPICH variant"
173a7886beaSBarry Smith #endif
174a7886beaSBarry Smith 
175a7886beaSBarry Smith /*
1762981ebdbSBarry Smith     Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler
177d382aafbSBarry Smith     see the top of mpicxx.h in the MPICH2 distribution.
178d382aafbSBarry Smith */
179d382aafbSBarry Smith #include <stdio.h>
180d382aafbSBarry Smith 
181d382aafbSBarry Smith /* MSMPI on 32bit windows requires this yukky hack - that breaks MPI standard compliance */
182d382aafbSBarry Smith #if !defined(MPIAPI)
183d382aafbSBarry Smith #define MPIAPI
184d382aafbSBarry Smith #endif
185d382aafbSBarry Smith 
1861cc8b206SBarry Smith /*
1871cc8b206SBarry Smith    Support for Clang (>=3.2) matching type tag arguments with void* buffer types.
1881cc8b206SBarry Smith    This allows the compiler to detect cases where the MPI datatype argument passed to a MPI routine
1891cc8b206SBarry Smith    does not match the actual type of the argument being passed in
1901cc8b206SBarry Smith */
191c5e4d11fSDmitry Karpeev #if defined(__has_attribute) && defined(works_with_const_which_is_not_true)
192894dd566SJed Brown #  if __has_attribute(argument_with_type_tag) && __has_attribute(pointer_with_type_tag) && __has_attribute(type_tag_for_datatype)
193894dd566SJed Brown #    define PetscAttrMPIPointerWithType(bufno,typeno) __attribute__((pointer_with_type_tag(MPI,bufno,typeno)))
1948ad47952SJed Brown #    define PetscAttrMPITypeTag(type)                 __attribute__((type_tag_for_datatype(MPI,type)))
1958ad47952SJed Brown #    define PetscAttrMPITypeTagLayoutCompatible(type) __attribute__((type_tag_for_datatype(MPI,type,layout_compatible)))
196894dd566SJed Brown #  endif
197894dd566SJed Brown #endif
198894dd566SJed Brown #if !defined(PetscAttrMPIPointerWithType)
199894dd566SJed Brown #  define PetscAttrMPIPointerWithType(bufno,typeno)
2008ad47952SJed Brown #  define PetscAttrMPITypeTag(type)
2018ad47952SJed Brown #  define PetscAttrMPITypeTagLayoutCompatible(type)
202894dd566SJed Brown #endif
203b3506946SBarry Smith 
2045a576424SJed Brown PETSC_EXTERN MPI_Datatype MPIU_ENUM PetscAttrMPITypeTag(PetscEnum);
205*df4397b0SStefano Zampini PETSC_EXTERN MPI_Datatype MPIU_BOOL PetscAttrMPITypeTag(PetscBool);
206e28ce29aSPatrick Sanan 
207e28ce29aSPatrick Sanan /*MC
208e28ce29aSPatrick Sanan    MPIU_INT - MPI datatype corresponding to PetscInt
209e28ce29aSPatrick Sanan 
210e28ce29aSPatrick Sanan    Notes:
211e28ce29aSPatrick Sanan    In MPI calls that require an MPI datatype that matches a PetscInt or array of PetscInt values, pass this value.
212e28ce29aSPatrick Sanan 
213e28ce29aSPatrick Sanan    Level: beginner
214e28ce29aSPatrick Sanan 
215e28ce29aSPatrick Sanan .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX
216e28ce29aSPatrick Sanan M*/
217e28ce29aSPatrick Sanan 
21837354ed4SSatish Balay #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 */
219bd84f1cfSSatish Balay #  define MPIU_INT64 MPI_INT64_T
220a05e1a72SSatish Balay #  define PetscInt64_FMT PRId64
221fab38c73SJed Brown #elif (PETSC_SIZEOF_LONG_LONG == 8)
222bd84f1cfSSatish Balay #  define MPIU_INT64 MPI_LONG_LONG_INT
223a05e1a72SSatish Balay #  define PetscInt64_FMT "lld"
224f505b413SSatish Balay #elif defined(PETSC_HAVE___INT64)
225bd84f1cfSSatish Balay #  define MPIU_INT64 MPI_INT64_T
226a05e1a72SSatish Balay #  define PetscInt64_FMT "ld"
227236ed0a3SSatish Balay #else
228bafee8b4SSatish Balay #  error "cannot determine PetscInt64 type"
229236ed0a3SSatish Balay #endif
230b7b8f77aSBarry Smith 
231b7b8f77aSBarry Smith #if PETSC_SIZEOF_VOID_P == 4
232b7b8f77aSBarry Smith #  define MPIU_FORTRANADDR MPI_INT
233b7b8f77aSBarry Smith #else
234b7b8f77aSBarry Smith #  define MPIU_FORTRANADDR MPIU_INT64
235b7b8f77aSBarry Smith #endif
236b7b8f77aSBarry Smith 
237d382aafbSBarry Smith #if defined(PETSC_USE_64BIT_INDICES)
238bd84f1cfSSatish Balay #  define MPIU_INT MPIU_INT64
239a05e1a72SSatish Balay #  define PetscInt_FMT PetscInt64_FMT
240d382aafbSBarry Smith #else
241d382aafbSBarry Smith #  define MPIU_INT MPI_INT
242a05e1a72SSatish Balay #  define PetscInt_FMT "d"
243d382aafbSBarry Smith #endif
244d382aafbSBarry Smith 
245503cfb0cSBarry Smith /*
246503cfb0cSBarry Smith     For the rare cases when one needs to send a size_t object with MPI
247503cfb0cSBarry Smith */
248d382aafbSBarry Smith #if (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_INT)
249adcec1e5SJed Brown #  define MPIU_SIZE_T MPI_UNSIGNED
250d382aafbSBarry Smith #elif  (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG)
251adcec1e5SJed Brown #  define MPIU_SIZE_T MPI_UNSIGNED_LONG
252d382aafbSBarry Smith #elif  (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG_LONG)
253adcec1e5SJed Brown #  define MPIU_SIZE_T MPI_UNSIGNED_LONG_LONG
254d382aafbSBarry Smith #else
255d382aafbSBarry Smith #  error "Unknown size for size_t! Send us a bugreport at petsc-maint@mcs.anl.gov"
256d382aafbSBarry Smith #endif
257d382aafbSBarry Smith 
258d382aafbSBarry Smith /*
259d382aafbSBarry Smith       You can use PETSC_STDOUT as a replacement of stdout. You can also change
260d382aafbSBarry Smith     the value of PETSC_STDOUT to redirect all standard output elsewhere
261d382aafbSBarry Smith */
262014dd563SJed Brown PETSC_EXTERN FILE* PETSC_STDOUT;
263d382aafbSBarry Smith 
264d382aafbSBarry Smith /*
265d382aafbSBarry Smith       You can use PETSC_STDERR as a replacement of stderr. You can also change
266d382aafbSBarry Smith     the value of PETSC_STDERR to redirect all standard error elsewhere
267d382aafbSBarry Smith */
268014dd563SJed Brown PETSC_EXTERN FILE* PETSC_STDERR;
269d382aafbSBarry Smith 
270d382aafbSBarry Smith /*MC
271d382aafbSBarry Smith     PetscUnlikely - hints the compiler that the given condition is usually FALSE
272d382aafbSBarry Smith 
273d382aafbSBarry Smith     Synopsis:
274aaa7dc30SBarry Smith     #include <petscsys.h>
275ace3abfcSBarry Smith     PetscBool  PetscUnlikely(PetscBool  cond)
276d382aafbSBarry Smith 
277eca87e8dSBarry Smith     Not Collective
278eca87e8dSBarry Smith 
279d382aafbSBarry Smith     Input Parameters:
280d382aafbSBarry Smith .   cond - condition or expression
281d382aafbSBarry Smith 
282e28ce29aSPatrick Sanan     Notes:
283e28ce29aSPatrick Sanan     This returns the same truth value, it is only a hint to compilers that the resulting
284d382aafbSBarry Smith     branch is unlikely.
285d382aafbSBarry Smith 
286d382aafbSBarry Smith     Level: advanced
287d382aafbSBarry Smith 
288d382aafbSBarry Smith .seealso: PetscLikely(), CHKERRQ
289d382aafbSBarry Smith M*/
290d382aafbSBarry Smith 
291d382aafbSBarry Smith /*MC
292d382aafbSBarry Smith     PetscLikely - hints the compiler that the given condition is usually TRUE
293d382aafbSBarry Smith 
294d382aafbSBarry Smith     Synopsis:
295aaa7dc30SBarry Smith     #include <petscsys.h>
29623072422SBarry Smith     PetscBool  PetscLikely(PetscBool  cond)
297d382aafbSBarry Smith 
298eca87e8dSBarry Smith     Not Collective
299eca87e8dSBarry Smith 
300d382aafbSBarry Smith     Input Parameters:
301d382aafbSBarry Smith .   cond - condition or expression
302d382aafbSBarry Smith 
303e28ce29aSPatrick Sanan     Notes:
304e28ce29aSPatrick Sanan     This returns the same truth value, it is only a hint to compilers that the resulting
305d382aafbSBarry Smith     branch is likely.
306d382aafbSBarry Smith 
307d382aafbSBarry Smith     Level: advanced
308d382aafbSBarry Smith 
309d382aafbSBarry Smith .seealso: PetscUnlikely()
310d382aafbSBarry Smith M*/
311d382aafbSBarry Smith #if defined(PETSC_HAVE_BUILTIN_EXPECT)
312d382aafbSBarry Smith #  define PetscUnlikely(cond)   __builtin_expect(!!(cond),0)
313d382aafbSBarry Smith #  define PetscLikely(cond)     __builtin_expect(!!(cond),1)
314d382aafbSBarry Smith #else
315cd3f4ce9SJed Brown #  define PetscUnlikely(cond)   (cond)
316cd3f4ce9SJed Brown #  define PetscLikely(cond)     (cond)
317d382aafbSBarry Smith #endif
318d382aafbSBarry Smith 
319d382aafbSBarry Smith /*
320d382aafbSBarry Smith     Declare extern C stuff after including external header files
321d382aafbSBarry Smith */
322d382aafbSBarry Smith 
3236a6fc655SJed Brown PETSC_EXTERN const char *const PetscBools[];
32470b3c8c7SBarry Smith 
3258b49ba18SBarry Smith /*
326390e1bf2SBarry Smith     Defines elementary mathematics functions and constants.
3278b49ba18SBarry Smith */
3288b49ba18SBarry Smith #include <petscmath.h>
3298b49ba18SBarry Smith 
3306a6fc655SJed Brown PETSC_EXTERN const char *const PetscCopyModes[];
331d382aafbSBarry Smith 
332d382aafbSBarry Smith /*MC
3330298fd71SBarry Smith     PETSC_IGNORE - same as NULL, means PETSc will ignore this argument
334d382aafbSBarry Smith 
335d382aafbSBarry Smith    Level: beginner
336d382aafbSBarry Smith 
337e28ce29aSPatrick Sanan    Note:
338e28ce29aSPatrick Sanan    Accepted by many PETSc functions to not set a parameter and instead use
339d382aafbSBarry Smith           some default
340d382aafbSBarry Smith 
341e28ce29aSPatrick Sanan    Fortran Notes:
342e28ce29aSPatrick Sanan    This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER,
343d382aafbSBarry Smith           PETSC_NULL_DOUBLE_PRECISION etc
344d382aafbSBarry Smith 
345e28ce29aSPatrick Sanan .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_DETERMINE
346d382aafbSBarry Smith 
347d382aafbSBarry Smith M*/
3480298fd71SBarry Smith #define PETSC_IGNORE NULL
349d382aafbSBarry Smith 
350c528d872SBarry Smith /* This is deprecated */
351c528d872SBarry Smith #define PETSC_NULL NULL
352c528d872SBarry Smith 
353d382aafbSBarry Smith /*MC
354557d4da8SBarry Smith     PETSC_DECIDE - standard way of passing in integer or floating point parameter
355557d4da8SBarry Smith        where you wish PETSc to use the default.
356557d4da8SBarry Smith 
357557d4da8SBarry Smith    Level: beginner
358557d4da8SBarry Smith 
359e28ce29aSPatrick Sanan .seealso: PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE
360557d4da8SBarry Smith 
361557d4da8SBarry Smith M*/
362557d4da8SBarry Smith #define PETSC_DECIDE -1
363557d4da8SBarry Smith 
364557d4da8SBarry Smith /*MC
365d382aafbSBarry Smith     PETSC_DETERMINE - standard way of passing in integer or floating point parameter
366d382aafbSBarry Smith        where you wish PETSc to compute the required value.
367d382aafbSBarry Smith 
368d382aafbSBarry Smith    Level: beginner
369d382aafbSBarry Smith 
370e28ce29aSPatrick Sanan    Developer Note:
371e28ce29aSPatrick Sanan    I would like to use const PetscInt PETSC_DETERMINE = PETSC_DECIDE; but for
372557d4da8SBarry Smith      some reason this is not allowed by the standard even though PETSC_DECIDE is a constant value.
373557d4da8SBarry Smith 
3740298fd71SBarry Smith .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, VecSetSizes()
375d382aafbSBarry Smith 
376d382aafbSBarry Smith M*/
377d382aafbSBarry Smith #define PETSC_DETERMINE PETSC_DECIDE
378d382aafbSBarry Smith 
379d382aafbSBarry Smith /*MC
380557d4da8SBarry Smith     PETSC_DEFAULT - standard way of passing in integer or floating point parameter
381557d4da8SBarry Smith        where you wish PETSc to use the default.
382557d4da8SBarry Smith 
383557d4da8SBarry Smith    Level: beginner
384557d4da8SBarry Smith 
385e28ce29aSPatrick Sanan    Fortran Notes:
386e28ce29aSPatrick Sanan    You need to use PETSC_DEFAULT_INTEGER or PETSC_DEFAULT_REAL.
387557d4da8SBarry Smith 
3880298fd71SBarry Smith .seealso: PETSC_DECIDE, PETSC_IGNORE, PETSC_DETERMINE
389557d4da8SBarry Smith 
390557d4da8SBarry Smith M*/
391557d4da8SBarry Smith #define PETSC_DEFAULT -2
392557d4da8SBarry Smith 
393557d4da8SBarry Smith /*MC
394d382aafbSBarry Smith     PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents
395d382aafbSBarry Smith            all the processs that PETSc knows about.
396d382aafbSBarry Smith 
397d382aafbSBarry Smith    Level: beginner
398d382aafbSBarry Smith 
399e28ce29aSPatrick Sanan    Notes:
400e28ce29aSPatrick Sanan    By default PETSC_COMM_WORLD and MPI_COMM_WORLD are identical unless you wish to
401d382aafbSBarry Smith           run PETSc on ONLY a subset of MPI_COMM_WORLD. In that case create your new (smaller)
402d382aafbSBarry Smith           communicator, call it, say comm, and set PETSC_COMM_WORLD = comm BEFORE calling
403a990b902SBarry Smith           PetscInitialize(), but after MPI_Init() has been called.
404a990b902SBarry Smith 
405a990b902SBarry Smith           The value of PETSC_COMM_WORLD should never be USED/accessed before PetscInitialize()
406a990b902SBarry Smith           is called because it may not have a valid value yet.
407d382aafbSBarry Smith 
408d382aafbSBarry Smith .seealso: PETSC_COMM_SELF
409d382aafbSBarry Smith 
410d382aafbSBarry Smith M*/
411014dd563SJed Brown PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD;
412d382aafbSBarry Smith 
413d382aafbSBarry Smith /*MC
414503cfb0cSBarry Smith     PETSC_COMM_SELF - This is always MPI_COMM_SELF
415d382aafbSBarry Smith 
416d382aafbSBarry Smith    Level: beginner
417d382aafbSBarry Smith 
418e28ce29aSPatrick Sanan    Notes:
419e28ce29aSPatrick Sanan    Do not USE/access or set this variable before PetscInitialize() has been called.
420a990b902SBarry Smith 
421d382aafbSBarry Smith .seealso: PETSC_COMM_WORLD
422d382aafbSBarry Smith 
423d382aafbSBarry Smith M*/
424d382aafbSBarry Smith #define PETSC_COMM_SELF MPI_COMM_SELF
425d382aafbSBarry Smith 
426d6f2c3cbSBarry Smith PETSC_EXTERN PetscBool PetscBeganMPI;
427014dd563SJed Brown PETSC_EXTERN PetscBool PetscInitializeCalled;
428014dd563SJed Brown PETSC_EXTERN PetscBool PetscFinalizeCalled;
4294cf1874eSKarl Rupp PETSC_EXTERN PetscBool PetscViennaCLSynchronize;
43082f73ecaSAlejandro Lamas Daviña PETSC_EXTERN PetscBool PetscCUDASynchronize;
431d382aafbSBarry Smith 
432014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm));
433014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*);
434014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm*);
435d382aafbSBarry Smith 
436d382aafbSBarry Smith /*MC
43795dccacaSBarry Smith    PetscMalloc - Allocates memory, One should use PetscNew(), PetscMalloc1() or PetscCalloc1() usually instead of this
438d382aafbSBarry Smith 
439eca87e8dSBarry Smith    Synopsis:
440aaa7dc30SBarry Smith     #include <petscsys.h>
441eca87e8dSBarry Smith    PetscErrorCode PetscMalloc(size_t m,void **result)
442eca87e8dSBarry Smith 
443eca87e8dSBarry Smith    Not Collective
444eca87e8dSBarry Smith 
445d382aafbSBarry Smith    Input Parameter:
446d382aafbSBarry Smith .  m - number of bytes to allocate
447d382aafbSBarry Smith 
448d382aafbSBarry Smith    Output Parameter:
449d382aafbSBarry Smith .  result - memory allocated
450d382aafbSBarry Smith 
451d382aafbSBarry Smith    Level: beginner
452d382aafbSBarry Smith 
45349d7da52SJed Brown    Notes:
45449d7da52SJed Brown    Memory is always allocated at least double aligned
455d382aafbSBarry Smith 
45649d7da52SJed Brown    It is safe to allocate size 0 and pass the resulting pointer (which may or may not be NULL) to PetscFree().
457d382aafbSBarry Smith 
458d382aafbSBarry Smith .seealso: PetscFree(), PetscNew()
459d382aafbSBarry Smith 
460d382aafbSBarry Smith   Concepts: memory allocation
461d382aafbSBarry Smith 
462d382aafbSBarry Smith M*/
46349d7da52SJed Brown #define PetscMalloc(a,b)  ((*PetscTrMalloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b)))
464d382aafbSBarry Smith 
465d382aafbSBarry Smith /*MC
4663221ece2SMatthew G. Knepley    PetscRealloc - Rellocates memory
4673221ece2SMatthew G. Knepley 
4683221ece2SMatthew G. Knepley    Synopsis:
4693221ece2SMatthew G. Knepley     #include <petscsys.h>
4703221ece2SMatthew G. Knepley    PetscErrorCode PetscRealloc(size_t m,void **result)
4713221ece2SMatthew G. Knepley 
4723221ece2SMatthew G. Knepley    Not Collective
4733221ece2SMatthew G. Knepley 
4743221ece2SMatthew G. Knepley    Input Parameters:
4753221ece2SMatthew G. Knepley +  m - number of bytes to allocate
4763221ece2SMatthew G. Knepley -  result - initial memory allocated
4773221ece2SMatthew G. Knepley 
4783221ece2SMatthew G. Knepley    Output Parameter:
4793221ece2SMatthew G. Knepley .  result - new memory allocated
4803221ece2SMatthew G. Knepley 
4813221ece2SMatthew G. Knepley    Level: developer
4823221ece2SMatthew G. Knepley 
4833221ece2SMatthew G. Knepley    Notes:
4843221ece2SMatthew G. Knepley    Memory is always allocated at least double aligned
4853221ece2SMatthew G. Knepley 
4863221ece2SMatthew G. Knepley .seealso: PetscMalloc(), PetscFree(), PetscNew()
4873221ece2SMatthew G. Knepley 
4883221ece2SMatthew G. Knepley   Concepts: memory allocation
4893221ece2SMatthew G. Knepley 
4903221ece2SMatthew G. Knepley M*/
4913221ece2SMatthew G. Knepley #define PetscRealloc(a,b)  ((*PetscTrRealloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b)))
4923221ece2SMatthew G. Knepley 
4933221ece2SMatthew G. Knepley /*MC
494503cfb0cSBarry Smith    PetscAddrAlign - Rounds up an address to PETSC_MEMALIGN alignment
495d382aafbSBarry Smith 
496d382aafbSBarry Smith    Synopsis:
497aaa7dc30SBarry Smith     #include <petscsys.h>
498d382aafbSBarry Smith    void *PetscAddrAlign(void *addr)
499d382aafbSBarry Smith 
500eca87e8dSBarry Smith    Not Collective
501eca87e8dSBarry Smith 
502eca87e8dSBarry Smith    Input Parameters:
503eca87e8dSBarry Smith .  addr - address to align (any pointer type)
504eca87e8dSBarry Smith 
505d382aafbSBarry Smith    Level: developer
506d382aafbSBarry Smith 
507d382aafbSBarry Smith .seealso: PetscMallocAlign()
508d382aafbSBarry Smith 
509d382aafbSBarry Smith   Concepts: memory allocation
510d382aafbSBarry Smith M*/
511d382aafbSBarry Smith #define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1))
512d382aafbSBarry Smith 
513d382aafbSBarry Smith /*MC
514785e854fSJed Brown    PetscMalloc1 - Allocates an array of memory aligned to PETSC_MEMALIGN
515d382aafbSBarry Smith 
516eca87e8dSBarry Smith    Synopsis:
517aaa7dc30SBarry Smith     #include <petscsys.h>
518785e854fSJed Brown    PetscErrorCode PetscMalloc1(size_t m1,type **r1)
519785e854fSJed Brown 
520785e854fSJed Brown    Not Collective
521785e854fSJed Brown 
522785e854fSJed Brown    Input Parameter:
523390e1bf2SBarry Smith .  m1 - number of elements to allocate  (may be zero)
524785e854fSJed Brown 
525785e854fSJed Brown    Output Parameter:
526785e854fSJed Brown .  r1 - memory allocated in first chunk
527785e854fSJed Brown 
528e28ce29aSPatrick Sanan    Note:
529e28ce29aSPatrick Sanan    This uses the sizeof() of the memory type requested to determine the total memory to be allocated, therefore you should not
530390e1bf2SBarry Smith          multiply the number of elements requested by the sizeof() the type. For example use
531390e1bf2SBarry Smith $  PetscInt *id;
532390e1bf2SBarry Smith $  PetscMalloc1(10,&id);
533390e1bf2SBarry Smith         not
534390e1bf2SBarry Smith $  PetscInt *id;
535390e1bf2SBarry Smith $  PetscMalloc1(10*sizeof(PetscInt),&id);
536390e1bf2SBarry Smith 
537390e1bf2SBarry Smith         Does not zero the memory allocatd, used PetscCalloc1() to obtain memory that has been zeroed.
538390e1bf2SBarry Smith 
539390e1bf2SBarry Smith    Level: beginner
540785e854fSJed Brown 
5411795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2()
542785e854fSJed Brown 
543785e854fSJed Brown   Concepts: memory allocation
544785e854fSJed Brown 
545785e854fSJed Brown M*/
5462553b7ecSJed Brown #define PetscMalloc1(m1,r1) PetscMallocA(1,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1))
547785e854fSJed Brown 
548785e854fSJed Brown /*MC
5491795a4d1SJed Brown    PetscCalloc1 - Allocates a cleared (zeroed) array of memory aligned to PETSC_MEMALIGN
5501795a4d1SJed Brown 
5511795a4d1SJed Brown    Synopsis:
552aaa7dc30SBarry Smith     #include <petscsys.h>
5531795a4d1SJed Brown    PetscErrorCode PetscCalloc1(size_t m1,type **r1)
5541795a4d1SJed Brown 
5551795a4d1SJed Brown    Not Collective
5561795a4d1SJed Brown 
5571795a4d1SJed Brown    Input Parameter:
5581795a4d1SJed Brown .  m1 - number of elements to allocate in 1st chunk  (may be zero)
5591795a4d1SJed Brown 
5601795a4d1SJed Brown    Output Parameter:
5611795a4d1SJed Brown .  r1 - memory allocated in first chunk
5621795a4d1SJed Brown 
563e28ce29aSPatrick Sanan    Notes:
564e28ce29aSPatrick Sanan    See PetsMalloc1() for more details on usage.
565390e1bf2SBarry Smith 
566390e1bf2SBarry Smith    Level: beginner
5671795a4d1SJed Brown 
5681795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2()
5691795a4d1SJed Brown 
5701795a4d1SJed Brown   Concepts: memory allocation
5711795a4d1SJed Brown 
5721795a4d1SJed Brown M*/
5732553b7ecSJed Brown #define PetscCalloc1(m1,r1) PetscMallocA(1,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1))
5741795a4d1SJed Brown 
5751795a4d1SJed Brown /*MC
576dcca6d9dSJed Brown    PetscMalloc2 - Allocates 2 arrays of memory both aligned to PETSC_MEMALIGN
577d382aafbSBarry Smith 
578eca87e8dSBarry Smith    Synopsis:
579aaa7dc30SBarry Smith     #include <petscsys.h>
580dcca6d9dSJed Brown    PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2)
581eca87e8dSBarry Smith 
582eca87e8dSBarry Smith    Not Collective
583eca87e8dSBarry Smith 
584d382aafbSBarry Smith    Input Parameter:
585d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
586dcca6d9dSJed Brown -  m2 - number of elements to allocate in 2nd chunk  (may be zero)
587d382aafbSBarry Smith 
588d382aafbSBarry Smith    Output Parameter:
589d382aafbSBarry Smith +  r1 - memory allocated in first chunk
590d382aafbSBarry Smith -  r2 - memory allocated in second chunk
591d382aafbSBarry Smith 
592d382aafbSBarry Smith    Level: developer
593d382aafbSBarry Smith 
5941795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2()
595d382aafbSBarry Smith 
596d382aafbSBarry Smith   Concepts: memory allocation
597d382aafbSBarry Smith 
598d382aafbSBarry Smith M*/
5992553b7ecSJed Brown #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))
600d382aafbSBarry Smith 
601d382aafbSBarry Smith /*MC
6021795a4d1SJed Brown    PetscCalloc2 - Allocates 2 cleared (zeroed) arrays of memory both aligned to PETSC_MEMALIGN
603d382aafbSBarry Smith 
604eca87e8dSBarry Smith    Synopsis:
605aaa7dc30SBarry Smith     #include <petscsys.h>
6061795a4d1SJed Brown    PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2)
607eca87e8dSBarry Smith 
608eca87e8dSBarry Smith    Not Collective
609eca87e8dSBarry Smith 
610d382aafbSBarry Smith    Input Parameter:
611d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
6121795a4d1SJed Brown -  m2 - number of elements to allocate in 2nd chunk  (may be zero)
6131795a4d1SJed Brown 
6141795a4d1SJed Brown    Output Parameter:
6151795a4d1SJed Brown +  r1 - memory allocated in first chunk
6161795a4d1SJed Brown -  r2 - memory allocated in second chunk
6171795a4d1SJed Brown 
6181795a4d1SJed Brown    Level: developer
6191795a4d1SJed Brown 
6201795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2()
6211795a4d1SJed Brown 
6221795a4d1SJed Brown   Concepts: memory allocation
6231795a4d1SJed Brown M*/
6242553b7ecSJed Brown #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))
6251795a4d1SJed Brown 
6261795a4d1SJed Brown /*MC
627dcca6d9dSJed Brown    PetscMalloc3 - Allocates 3 arrays of memory, all aligned to PETSC_MEMALIGN
628d382aafbSBarry Smith 
629d382aafbSBarry Smith    Synopsis:
630aaa7dc30SBarry Smith     #include <petscsys.h>
631dcca6d9dSJed Brown    PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)
632d382aafbSBarry Smith 
633d382aafbSBarry Smith    Not Collective
634d382aafbSBarry Smith 
635d382aafbSBarry Smith    Input Parameter:
636d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
637d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
638dcca6d9dSJed Brown -  m3 - number of elements to allocate in 3rd chunk  (may be zero)
639d382aafbSBarry Smith 
640d382aafbSBarry Smith    Output Parameter:
641d382aafbSBarry Smith +  r1 - memory allocated in first chunk
642d382aafbSBarry Smith .  r2 - memory allocated in second chunk
643d382aafbSBarry Smith -  r3 - memory allocated in third chunk
644d382aafbSBarry Smith 
645d382aafbSBarry Smith    Level: developer
646d382aafbSBarry Smith 
6471795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc3(), PetscFree3()
648d382aafbSBarry Smith 
649d382aafbSBarry Smith   Concepts: memory allocation
650d382aafbSBarry Smith 
651d382aafbSBarry Smith M*/
6522553b7ecSJed Brown #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))
653d382aafbSBarry Smith 
654d382aafbSBarry Smith /*MC
6551795a4d1SJed Brown    PetscCalloc3 - Allocates 3 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
656d382aafbSBarry Smith 
657eca87e8dSBarry Smith    Synopsis:
658aaa7dc30SBarry Smith     #include <petscsys.h>
6591795a4d1SJed Brown    PetscErrorCode PetscCalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)
660eca87e8dSBarry Smith 
661eca87e8dSBarry Smith    Not Collective
662eca87e8dSBarry Smith 
663d382aafbSBarry Smith    Input Parameter:
664d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
665d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
6661795a4d1SJed Brown -  m3 - number of elements to allocate in 3rd chunk  (may be zero)
6671795a4d1SJed Brown 
6681795a4d1SJed Brown    Output Parameter:
6691795a4d1SJed Brown +  r1 - memory allocated in first chunk
6701795a4d1SJed Brown .  r2 - memory allocated in second chunk
6711795a4d1SJed Brown -  r3 - memory allocated in third chunk
6721795a4d1SJed Brown 
6731795a4d1SJed Brown    Level: developer
6741795a4d1SJed Brown 
6751795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc2(), PetscMalloc3(), PetscFree3()
6761795a4d1SJed Brown 
6771795a4d1SJed Brown   Concepts: memory allocation
6781795a4d1SJed Brown M*/
6792553b7ecSJed Brown #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))
6801795a4d1SJed Brown 
6811795a4d1SJed Brown /*MC
682dcca6d9dSJed Brown    PetscMalloc4 - Allocates 4 arrays of memory, all aligned to PETSC_MEMALIGN
683d382aafbSBarry Smith 
684d382aafbSBarry Smith    Synopsis:
685aaa7dc30SBarry Smith     #include <petscsys.h>
686dcca6d9dSJed Brown    PetscErrorCode PetscMalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)
687d382aafbSBarry Smith 
688d382aafbSBarry Smith    Not Collective
689d382aafbSBarry Smith 
690d382aafbSBarry Smith    Input Parameter:
691d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
692d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
693d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
694dcca6d9dSJed Brown -  m4 - number of elements to allocate in 4th chunk  (may be zero)
695d382aafbSBarry Smith 
696d382aafbSBarry Smith    Output Parameter:
697d382aafbSBarry Smith +  r1 - memory allocated in first chunk
698d382aafbSBarry Smith .  r2 - memory allocated in second chunk
699d382aafbSBarry Smith .  r3 - memory allocated in third chunk
700d382aafbSBarry Smith -  r4 - memory allocated in fourth chunk
701d382aafbSBarry Smith 
702d382aafbSBarry Smith    Level: developer
703d382aafbSBarry Smith 
7041795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4()
705d382aafbSBarry Smith 
706d382aafbSBarry Smith   Concepts: memory allocation
707d382aafbSBarry Smith 
708d382aafbSBarry Smith M*/
7092553b7ecSJed Brown #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))
710d382aafbSBarry Smith 
711d382aafbSBarry Smith /*MC
7121795a4d1SJed Brown    PetscCalloc4 - Allocates 4 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
713d382aafbSBarry Smith 
714eca87e8dSBarry Smith    Synopsis:
715aaa7dc30SBarry Smith     #include <petscsys.h>
7161795a4d1SJed Brown    PetscErrorCode PetscCalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)
717eca87e8dSBarry Smith 
718eca87e8dSBarry Smith    Not Collective
719eca87e8dSBarry Smith 
720e28ce29aSPatrick Sanan    Input Parameters:
721d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
722d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
723d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
7241795a4d1SJed Brown -  m4 - number of elements to allocate in 4th chunk  (may be zero)
7251795a4d1SJed Brown 
726e28ce29aSPatrick Sanan    Output Parameters:
7271795a4d1SJed Brown +  r1 - memory allocated in first chunk
7281795a4d1SJed Brown .  r2 - memory allocated in second chunk
7291795a4d1SJed Brown .  r3 - memory allocated in third chunk
7301795a4d1SJed Brown -  r4 - memory allocated in fourth chunk
7311795a4d1SJed Brown 
7321795a4d1SJed Brown    Level: developer
7331795a4d1SJed Brown 
7341795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4()
7351795a4d1SJed Brown 
7361795a4d1SJed Brown   Concepts: memory allocation
7371795a4d1SJed Brown 
7381795a4d1SJed Brown M*/
7392553b7ecSJed Brown #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))
7401795a4d1SJed Brown 
7411795a4d1SJed Brown /*MC
742dcca6d9dSJed Brown    PetscMalloc5 - Allocates 5 arrays of memory, all aligned to PETSC_MEMALIGN
743d382aafbSBarry Smith 
744d382aafbSBarry Smith    Synopsis:
745aaa7dc30SBarry Smith     #include <petscsys.h>
746dcca6d9dSJed Brown    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)
747d382aafbSBarry Smith 
748d382aafbSBarry Smith    Not Collective
749d382aafbSBarry Smith 
750e28ce29aSPatrick Sanan    Input Parameters:
751d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
752d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
753d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
754d382aafbSBarry Smith .  m4 - number of elements to allocate in 4th chunk  (may be zero)
755dcca6d9dSJed Brown -  m5 - number of elements to allocate in 5th chunk  (may be zero)
756d382aafbSBarry Smith 
757e28ce29aSPatrick Sanan    Output Parameters:
758d382aafbSBarry Smith +  r1 - memory allocated in first chunk
759d382aafbSBarry Smith .  r2 - memory allocated in second chunk
760d382aafbSBarry Smith .  r3 - memory allocated in third chunk
761d382aafbSBarry Smith .  r4 - memory allocated in fourth chunk
762d382aafbSBarry Smith -  r5 - memory allocated in fifth chunk
763d382aafbSBarry Smith 
764d382aafbSBarry Smith    Level: developer
765d382aafbSBarry Smith 
7661795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc5(), PetscFree5()
767d382aafbSBarry Smith 
768d382aafbSBarry Smith   Concepts: memory allocation
769d382aafbSBarry Smith 
770d382aafbSBarry Smith M*/
7712553b7ecSJed Brown #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))
772d382aafbSBarry Smith 
773d382aafbSBarry Smith /*MC
7741795a4d1SJed Brown    PetscCalloc5 - Allocates 5 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
775d382aafbSBarry Smith 
776eca87e8dSBarry Smith    Synopsis:
777aaa7dc30SBarry Smith     #include <petscsys.h>
7781795a4d1SJed Brown    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)
779eca87e8dSBarry Smith 
780eca87e8dSBarry Smith    Not Collective
781eca87e8dSBarry Smith 
782e28ce29aSPatrick Sanan    Input Parameters:
783d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
784d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
785d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
786d382aafbSBarry Smith .  m4 - number of elements to allocate in 4th chunk  (may be zero)
7871795a4d1SJed Brown -  m5 - number of elements to allocate in 5th chunk  (may be zero)
7881795a4d1SJed Brown 
789e28ce29aSPatrick Sanan    Output Parameters:
7901795a4d1SJed Brown +  r1 - memory allocated in first chunk
7911795a4d1SJed Brown .  r2 - memory allocated in second chunk
7921795a4d1SJed Brown .  r3 - memory allocated in third chunk
7931795a4d1SJed Brown .  r4 - memory allocated in fourth chunk
7941795a4d1SJed Brown -  r5 - memory allocated in fifth chunk
7951795a4d1SJed Brown 
7961795a4d1SJed Brown    Level: developer
7971795a4d1SJed Brown 
7981795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc5(), PetscFree5()
7991795a4d1SJed Brown 
8001795a4d1SJed Brown   Concepts: memory allocation
8011795a4d1SJed Brown 
8021795a4d1SJed Brown M*/
8032553b7ecSJed Brown #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))
804d382aafbSBarry Smith 
805d382aafbSBarry Smith /*MC
806dcca6d9dSJed Brown    PetscMalloc6 - Allocates 6 arrays of memory, all aligned to PETSC_MEMALIGN
807d382aafbSBarry Smith 
808d382aafbSBarry Smith    Synopsis:
809aaa7dc30SBarry Smith     #include <petscsys.h>
810dcca6d9dSJed Brown    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)
811d382aafbSBarry Smith 
812d382aafbSBarry Smith    Not Collective
813d382aafbSBarry Smith 
814e28ce29aSPatrick Sanan    Input Parameters:
815d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
816d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
817d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
818d382aafbSBarry Smith .  m4 - number of elements to allocate in 4th chunk  (may be zero)
819d382aafbSBarry Smith .  m5 - number of elements to allocate in 5th chunk  (may be zero)
820dcca6d9dSJed Brown -  m6 - number of elements to allocate in 6th chunk  (may be zero)
821d382aafbSBarry Smith 
822e28ce29aSPatrick Sanan    Output Parameteasr:
823d382aafbSBarry Smith +  r1 - memory allocated in first chunk
824d382aafbSBarry Smith .  r2 - memory allocated in second chunk
825d382aafbSBarry Smith .  r3 - memory allocated in third chunk
826d382aafbSBarry Smith .  r4 - memory allocated in fourth chunk
827d382aafbSBarry Smith .  r5 - memory allocated in fifth chunk
828d382aafbSBarry Smith -  r6 - memory allocated in sixth chunk
829d382aafbSBarry Smith 
830d382aafbSBarry Smith    Level: developer
831d382aafbSBarry Smith 
8321795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc6(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6()
833d382aafbSBarry Smith 
834d382aafbSBarry Smith   Concepts: memory allocation
835d382aafbSBarry Smith 
836d382aafbSBarry Smith M*/
8372553b7ecSJed Brown #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))
838d382aafbSBarry Smith 
839d382aafbSBarry Smith /*MC
8401795a4d1SJed Brown    PetscCalloc6 - Allocates 6 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
841d382aafbSBarry Smith 
842eca87e8dSBarry Smith    Synopsis:
843aaa7dc30SBarry Smith     #include <petscsys.h>
8441795a4d1SJed Brown    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)
845eca87e8dSBarry Smith 
846eca87e8dSBarry Smith    Not Collective
847eca87e8dSBarry Smith 
848e28ce29aSPatrick Sanan    Input Parameters:
849d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
850d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
851d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
852d382aafbSBarry Smith .  m4 - number of elements to allocate in 4th chunk  (may be zero)
853d382aafbSBarry Smith .  m5 - number of elements to allocate in 5th chunk  (may be zero)
8541795a4d1SJed Brown -  m6 - number of elements to allocate in 6th chunk  (may be zero)
8551795a4d1SJed Brown 
856e28ce29aSPatrick Sanan    Output Parameters:
8571795a4d1SJed Brown +  r1 - memory allocated in first chunk
8581795a4d1SJed Brown .  r2 - memory allocated in second chunk
8591795a4d1SJed Brown .  r3 - memory allocated in third chunk
8601795a4d1SJed Brown .  r4 - memory allocated in fourth chunk
8611795a4d1SJed Brown .  r5 - memory allocated in fifth chunk
8621795a4d1SJed Brown -  r6 - memory allocated in sixth chunk
8631795a4d1SJed Brown 
8641795a4d1SJed Brown    Level: developer
8651795a4d1SJed Brown 
8661795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc6(), PetscFree6()
8671795a4d1SJed Brown 
8681795a4d1SJed Brown   Concepts: memory allocation
8691795a4d1SJed Brown M*/
8702553b7ecSJed Brown #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))
8711795a4d1SJed Brown 
8721795a4d1SJed Brown /*MC
873dcca6d9dSJed Brown    PetscMalloc7 - Allocates 7 arrays of memory, all aligned to PETSC_MEMALIGN
874d382aafbSBarry Smith 
875d382aafbSBarry Smith    Synopsis:
876aaa7dc30SBarry Smith     #include <petscsys.h>
877dcca6d9dSJed Brown    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)
878d382aafbSBarry Smith 
879d382aafbSBarry Smith    Not Collective
880d382aafbSBarry Smith 
881e28ce29aSPatrick Sanan    Input Parameters:
882d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
883d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
884d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
885d382aafbSBarry Smith .  m4 - number of elements to allocate in 4th chunk  (may be zero)
886d382aafbSBarry Smith .  m5 - number of elements to allocate in 5th chunk  (may be zero)
887d382aafbSBarry Smith .  m6 - number of elements to allocate in 6th chunk  (may be zero)
888dcca6d9dSJed Brown -  m7 - number of elements to allocate in 7th chunk  (may be zero)
889d382aafbSBarry Smith 
890e28ce29aSPatrick Sanan    Output Parameters:
891d382aafbSBarry Smith +  r1 - memory allocated in first chunk
892d382aafbSBarry Smith .  r2 - memory allocated in second chunk
893d382aafbSBarry Smith .  r3 - memory allocated in third chunk
894d382aafbSBarry Smith .  r4 - memory allocated in fourth chunk
895d382aafbSBarry Smith .  r5 - memory allocated in fifth chunk
896d382aafbSBarry Smith .  r6 - memory allocated in sixth chunk
897eca87e8dSBarry Smith -  r7 - memory allocated in seventh chunk
898d382aafbSBarry Smith 
899d382aafbSBarry Smith    Level: developer
900d382aafbSBarry Smith 
9011795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc7(), PetscFree7()
902d382aafbSBarry Smith 
903d382aafbSBarry Smith   Concepts: memory allocation
904d382aafbSBarry Smith 
905d382aafbSBarry Smith M*/
9062553b7ecSJed Brown #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))
907d382aafbSBarry Smith 
908d382aafbSBarry Smith /*MC
9091795a4d1SJed Brown    PetscCalloc7 - Allocates 7 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
9101795a4d1SJed Brown 
9111795a4d1SJed Brown    Synopsis:
912aaa7dc30SBarry Smith     #include <petscsys.h>
9131795a4d1SJed Brown    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)
9141795a4d1SJed Brown 
9151795a4d1SJed Brown    Not Collective
9161795a4d1SJed Brown 
917e28ce29aSPatrick Sanan    Input Parameters:
9181795a4d1SJed Brown +  m1 - number of elements to allocate in 1st chunk  (may be zero)
9191795a4d1SJed Brown .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
9201795a4d1SJed Brown .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
9211795a4d1SJed Brown .  m4 - number of elements to allocate in 4th chunk  (may be zero)
9221795a4d1SJed Brown .  m5 - number of elements to allocate in 5th chunk  (may be zero)
9231795a4d1SJed Brown .  m6 - number of elements to allocate in 6th chunk  (may be zero)
9241795a4d1SJed Brown -  m7 - number of elements to allocate in 7th chunk  (may be zero)
9251795a4d1SJed Brown 
926e28ce29aSPatrick Sanan    Output Parameters:
9271795a4d1SJed Brown +  r1 - memory allocated in first chunk
9281795a4d1SJed Brown .  r2 - memory allocated in second chunk
9291795a4d1SJed Brown .  r3 - memory allocated in third chunk
9301795a4d1SJed Brown .  r4 - memory allocated in fourth chunk
9311795a4d1SJed Brown .  r5 - memory allocated in fifth chunk
9321795a4d1SJed Brown .  r6 - memory allocated in sixth chunk
9331795a4d1SJed Brown -  r7 - memory allocated in seventh chunk
9341795a4d1SJed Brown 
9351795a4d1SJed Brown    Level: developer
9361795a4d1SJed Brown 
9371795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc7(), PetscFree7()
9381795a4d1SJed Brown 
9391795a4d1SJed Brown   Concepts: memory allocation
9401795a4d1SJed Brown M*/
9412553b7ecSJed Brown #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))
9421795a4d1SJed Brown 
9431795a4d1SJed Brown /*MC
944503cfb0cSBarry Smith    PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to PETSC_MEMALIGN
945d382aafbSBarry Smith 
946eca87e8dSBarry Smith    Synopsis:
947aaa7dc30SBarry Smith     #include <petscsys.h>
948b00a9115SJed Brown    PetscErrorCode PetscNew(type **result)
949eca87e8dSBarry Smith 
950eca87e8dSBarry Smith    Not Collective
951eca87e8dSBarry Smith 
952d382aafbSBarry Smith    Output Parameter:
953b00a9115SJed Brown .  result - memory allocated, sized to match pointer type
954d382aafbSBarry Smith 
955d382aafbSBarry Smith    Level: beginner
956d382aafbSBarry Smith 
957390e1bf2SBarry Smith .seealso: PetscFree(), PetscMalloc(), PetscNewLog(), PetscCalloc1(), PetscMalloc1()
958d382aafbSBarry Smith 
959d382aafbSBarry Smith   Concepts: memory allocation
960d382aafbSBarry Smith 
961d382aafbSBarry Smith M*/
962b00a9115SJed Brown #define PetscNew(b)      PetscCalloc1(1,(b))
963ad0619ddSBarry Smith 
964ad0619ddSBarry Smith /*MC
965b00a9115SJed Brown    PetscNewLog - Allocates memory of a type matching pointer, zeros the memory! Aligned to PETSC_MEMALIGN. Associates the memory allocated
966ad0619ddSBarry Smith          with the given object using PetscLogObjectMemory().
967ad0619ddSBarry Smith 
968ad0619ddSBarry Smith    Synopsis:
969aaa7dc30SBarry Smith     #include <petscsys.h>
970b00a9115SJed Brown    PetscErrorCode PetscNewLog(PetscObject obj,type **result)
971ad0619ddSBarry Smith 
972ad0619ddSBarry Smith    Not Collective
973ad0619ddSBarry Smith 
974ad0619ddSBarry Smith    Input Parameter:
975b00a9115SJed Brown .  obj - object memory is logged to
976ad0619ddSBarry Smith 
977ad0619ddSBarry Smith    Output Parameter:
978b00a9115SJed Brown .  result - memory allocated, sized to match pointer type
979ad0619ddSBarry Smith 
980ad0619ddSBarry Smith    Level: developer
981ad0619ddSBarry Smith 
982390e1bf2SBarry Smith .seealso: PetscFree(), PetscMalloc(), PetscNew(), PetscLogObjectMemory(), PetscCalloc1(), PetscMalloc1()
983ad0619ddSBarry Smith 
984ad0619ddSBarry Smith   Concepts: memory allocation
985ad0619ddSBarry Smith 
986ad0619ddSBarry Smith M*/
987d12f57a0SLisandro Dalcin #define PetscNewLog(o,b) (PetscNew((b)) || PetscLogObjectMemory((PetscObject)o,sizeof(**(b))))
988d382aafbSBarry Smith 
989d382aafbSBarry Smith /*MC
990d382aafbSBarry Smith    PetscFree - Frees memory
991d382aafbSBarry Smith 
992eca87e8dSBarry Smith    Synopsis:
993aaa7dc30SBarry Smith     #include <petscsys.h>
994eca87e8dSBarry Smith    PetscErrorCode PetscFree(void *memory)
995eca87e8dSBarry Smith 
996eca87e8dSBarry Smith    Not Collective
997eca87e8dSBarry Smith 
998d382aafbSBarry Smith    Input Parameter:
999390e1bf2SBarry Smith .   memory - memory to free (the pointer is ALWAYS set to NULL upon sucess)
1000d382aafbSBarry Smith 
1001d382aafbSBarry Smith    Level: beginner
1002d382aafbSBarry Smith 
100349d7da52SJed Brown    Notes:
1004390e1bf2SBarry Smith    Do not free memory obtained with PetscMalloc2(), PetscCalloc2() etc, they must be freed with PetscFree2() etc.
1005390e1bf2SBarry Smith 
100649d7da52SJed Brown    It is safe to call PetscFree() on a NULL pointer.
1007d382aafbSBarry Smith 
1008390e1bf2SBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscNewLog(), PetscMalloc1(), PetscCalloc1()
1009d382aafbSBarry Smith 
1010d382aafbSBarry Smith   Concepts: memory allocation
1011d382aafbSBarry Smith 
1012d382aafbSBarry Smith M*/
101349d7da52SJed Brown #define PetscFree(a)   ((*PetscTrFree)((void*)(a),__LINE__,PETSC_FUNCTION_NAME,__FILE__) || ((a) = 0,0))
1014d382aafbSBarry Smith 
1015d382aafbSBarry Smith /*MC
1016d382aafbSBarry Smith    PetscFree2 - Frees 2 chunks of memory obtained with PetscMalloc2()
1017d382aafbSBarry Smith 
1018eca87e8dSBarry Smith    Synopsis:
1019aaa7dc30SBarry Smith     #include <petscsys.h>
1020eca87e8dSBarry Smith    PetscErrorCode PetscFree2(void *memory1,void *memory2)
1021eca87e8dSBarry Smith 
1022eca87e8dSBarry Smith    Not Collective
1023eca87e8dSBarry Smith 
1024e28ce29aSPatrick Sanan    Input Parameters:
1025d382aafbSBarry Smith +   memory1 - memory to free
1026d382aafbSBarry Smith -   memory2 - 2nd memory to free
1027d382aafbSBarry Smith 
1028d382aafbSBarry Smith    Level: developer
1029d382aafbSBarry Smith 
103095452b02SPatrick Sanan    Notes:
103195452b02SPatrick Sanan     Memory must have been obtained with PetscMalloc2()
1032d382aafbSBarry Smith 
1033d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree()
1034d382aafbSBarry Smith 
1035d382aafbSBarry Smith   Concepts: memory allocation
1036d382aafbSBarry Smith 
1037d382aafbSBarry Smith M*/
1038ba282f50SJed Brown #define PetscFree2(m1,m2)   PetscFreeA(2,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2))
1039d382aafbSBarry Smith 
1040d382aafbSBarry Smith /*MC
1041d382aafbSBarry Smith    PetscFree3 - Frees 3 chunks of memory obtained with PetscMalloc3()
1042d382aafbSBarry Smith 
1043eca87e8dSBarry Smith    Synopsis:
1044aaa7dc30SBarry Smith     #include <petscsys.h>
1045eca87e8dSBarry Smith    PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3)
1046eca87e8dSBarry Smith 
1047eca87e8dSBarry Smith    Not Collective
1048eca87e8dSBarry Smith 
1049e28ce29aSPatrick Sanan    Input Parameters:
1050d382aafbSBarry Smith +   memory1 - memory to free
1051d382aafbSBarry Smith .   memory2 - 2nd memory to free
1052d382aafbSBarry Smith -   memory3 - 3rd memory to free
1053d382aafbSBarry Smith 
1054d382aafbSBarry Smith    Level: developer
1055d382aafbSBarry Smith 
105695452b02SPatrick Sanan    Notes:
105795452b02SPatrick Sanan     Memory must have been obtained with PetscMalloc3()
1058d382aafbSBarry Smith 
1059d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3()
1060d382aafbSBarry Smith 
1061d382aafbSBarry Smith   Concepts: memory allocation
1062d382aafbSBarry Smith 
1063d382aafbSBarry Smith M*/
1064ba282f50SJed Brown #define PetscFree3(m1,m2,m3)   PetscFreeA(3,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3))
1065d382aafbSBarry Smith 
1066d382aafbSBarry Smith /*MC
1067d382aafbSBarry Smith    PetscFree4 - Frees 4 chunks of memory obtained with PetscMalloc4()
1068d382aafbSBarry Smith 
1069eca87e8dSBarry Smith    Synopsis:
1070aaa7dc30SBarry Smith     #include <petscsys.h>
1071eca87e8dSBarry Smith    PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4)
1072eca87e8dSBarry Smith 
1073eca87e8dSBarry Smith    Not Collective
1074eca87e8dSBarry Smith 
1075e28ce29aSPatrick Sanan    Input Parameters:
1076d382aafbSBarry Smith +   m1 - memory to free
1077d382aafbSBarry Smith .   m2 - 2nd memory to free
1078d382aafbSBarry Smith .   m3 - 3rd memory to free
1079d382aafbSBarry Smith -   m4 - 4th memory to free
1080d382aafbSBarry Smith 
1081d382aafbSBarry Smith    Level: developer
1082d382aafbSBarry Smith 
108395452b02SPatrick Sanan    Notes:
108495452b02SPatrick Sanan     Memory must have been obtained with PetscMalloc4()
1085d382aafbSBarry Smith 
1086d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4()
1087d382aafbSBarry Smith 
1088d382aafbSBarry Smith   Concepts: memory allocation
1089d382aafbSBarry Smith 
1090d382aafbSBarry Smith M*/
1091ba282f50SJed Brown #define PetscFree4(m1,m2,m3,m4)   PetscFreeA(4,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4))
1092d382aafbSBarry Smith 
1093d382aafbSBarry Smith /*MC
1094d382aafbSBarry Smith    PetscFree5 - Frees 5 chunks of memory obtained with PetscMalloc5()
1095d382aafbSBarry Smith 
1096eca87e8dSBarry Smith    Synopsis:
1097aaa7dc30SBarry Smith     #include <petscsys.h>
1098eca87e8dSBarry Smith    PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5)
1099eca87e8dSBarry Smith 
1100eca87e8dSBarry Smith    Not Collective
1101eca87e8dSBarry Smith 
1102e28ce29aSPatrick Sanan    Input Parameters:
1103d382aafbSBarry Smith +   m1 - memory to free
1104d382aafbSBarry Smith .   m2 - 2nd memory to free
1105d382aafbSBarry Smith .   m3 - 3rd memory to free
1106d382aafbSBarry Smith .   m4 - 4th memory to free
1107d382aafbSBarry Smith -   m5 - 5th memory to free
1108d382aafbSBarry Smith 
1109d382aafbSBarry Smith    Level: developer
1110d382aafbSBarry Smith 
111195452b02SPatrick Sanan    Notes:
111295452b02SPatrick Sanan     Memory must have been obtained with PetscMalloc5()
1113d382aafbSBarry Smith 
1114d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5()
1115d382aafbSBarry Smith 
1116d382aafbSBarry Smith   Concepts: memory allocation
1117d382aafbSBarry Smith 
1118d382aafbSBarry Smith M*/
1119ba282f50SJed Brown #define PetscFree5(m1,m2,m3,m4,m5)   PetscFreeA(5,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5))
1120d382aafbSBarry Smith 
1121d382aafbSBarry Smith /*MC
1122d382aafbSBarry Smith    PetscFree6 - Frees 6 chunks of memory obtained with PetscMalloc6()
1123d382aafbSBarry Smith 
1124eca87e8dSBarry Smith    Synopsis:
1125aaa7dc30SBarry Smith     #include <petscsys.h>
1126eca87e8dSBarry Smith    PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6)
1127eca87e8dSBarry Smith 
1128eca87e8dSBarry Smith    Not Collective
1129eca87e8dSBarry Smith 
1130e28ce29aSPatrick Sanan    Input Parameters:
1131d382aafbSBarry Smith +   m1 - memory to free
1132d382aafbSBarry Smith .   m2 - 2nd memory to free
1133d382aafbSBarry Smith .   m3 - 3rd memory to free
1134d382aafbSBarry Smith .   m4 - 4th memory to free
1135d382aafbSBarry Smith .   m5 - 5th memory to free
1136d382aafbSBarry Smith -   m6 - 6th memory to free
1137d382aafbSBarry Smith 
1138d382aafbSBarry Smith 
1139d382aafbSBarry Smith    Level: developer
1140d382aafbSBarry Smith 
114195452b02SPatrick Sanan    Notes:
114295452b02SPatrick Sanan     Memory must have been obtained with PetscMalloc6()
1143d382aafbSBarry Smith 
1144d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6()
1145d382aafbSBarry Smith 
1146d382aafbSBarry Smith   Concepts: memory allocation
1147d382aafbSBarry Smith 
1148d382aafbSBarry Smith M*/
1149ba282f50SJed Brown #define PetscFree6(m1,m2,m3,m4,m5,m6)   PetscFreeA(6,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5),&(m6))
1150d382aafbSBarry Smith 
1151d382aafbSBarry Smith /*MC
1152d382aafbSBarry Smith    PetscFree7 - Frees 7 chunks of memory obtained with PetscMalloc7()
1153d382aafbSBarry Smith 
1154eca87e8dSBarry Smith    Synopsis:
1155aaa7dc30SBarry Smith     #include <petscsys.h>
1156eca87e8dSBarry Smith    PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7)
1157eca87e8dSBarry Smith 
1158eca87e8dSBarry Smith    Not Collective
1159eca87e8dSBarry Smith 
1160e28ce29aSPatrick Sanan    Input Parameters:
1161d382aafbSBarry Smith +   m1 - memory to free
1162d382aafbSBarry Smith .   m2 - 2nd memory to free
1163d382aafbSBarry Smith .   m3 - 3rd memory to free
1164d382aafbSBarry Smith .   m4 - 4th memory to free
1165d382aafbSBarry Smith .   m5 - 5th memory to free
1166d382aafbSBarry Smith .   m6 - 6th memory to free
1167d382aafbSBarry Smith -   m7 - 7th memory to free
1168d382aafbSBarry Smith 
1169d382aafbSBarry Smith 
1170d382aafbSBarry Smith    Level: developer
1171d382aafbSBarry Smith 
117295452b02SPatrick Sanan    Notes:
117395452b02SPatrick Sanan     Memory must have been obtained with PetscMalloc7()
1174d382aafbSBarry Smith 
1175d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(),
1176d382aafbSBarry Smith           PetscMalloc7()
1177d382aafbSBarry Smith 
1178d382aafbSBarry Smith   Concepts: memory allocation
1179d382aafbSBarry Smith 
1180d382aafbSBarry Smith M*/
1181ba282f50SJed Brown #define PetscFree7(m1,m2,m3,m4,m5,m6,m7)   PetscFreeA(7,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5),&(m6),&(m7))
1182d382aafbSBarry Smith 
1183ba282f50SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocA(int,PetscBool,int,const char *,const char *,size_t,void *,...);
1184ba282f50SJed Brown PETSC_EXTERN PetscErrorCode PetscFreeA(int,int,const char *,const char *,void *,...);
1185efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t,int,const char[],const char[],void**);
1186efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[]);
11873221ece2SMatthew G. Knepley PETSC_EXTERN PetscErrorCode (*PetscTrRealloc)(size_t,int,const char[],const char[],void**);
1188ba282f50SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocSetCoalesce(PetscBool);
1189efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t,int,const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[]));
1190014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocClear(void);
1191d382aafbSBarry Smith 
1192d382aafbSBarry Smith /*
1193c1706be6SHong Zhang   Unlike PetscMallocSet and PetscMallocClear which overwrite the existing settings, these two functions save the previous choice of allocator, and should be used in pair.
1194c1706be6SHong Zhang */
1195c1706be6SHong Zhang PETSC_EXTERN PetscErrorCode PetscMallocSetDRAM(void);
1196c1706be6SHong Zhang PETSC_EXTERN PetscErrorCode PetscMallocResetDRAM(void);
1197c1706be6SHong Zhang 
1198a5057860SBarry Smith #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE
1199a5057860SBarry Smith 
1200a5057860SBarry Smith /*
120166d669d6SBarry Smith    Routines for tracing memory corruption/bleeding with default PETSc memory allocation
1202d382aafbSBarry Smith */
1203014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *);
1204014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocDumpLog(FILE *);
1205014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *);
1206014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *);
1207014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocDebug(PetscBool);
12080acecf5bSBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool*);
1209efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode PetscMallocValidate(int,const char[],const char[]);
1210014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLog(void);
1211574034a9SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLogThreshold(PetscLogDouble);
1212014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocGetDumpLog(PetscBool*);
1213d382aafbSBarry Smith 
12146a6fc655SJed Brown PETSC_EXTERN const char *const PetscDataTypes[];
1215014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*);
1216014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*);
1217014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*);
12188e4b2d1dSBarry Smith PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char*,PetscDataType*,PetscBool*);
1219d382aafbSBarry Smith 
1220d382aafbSBarry Smith /*
1221d382aafbSBarry Smith     Basic memory and string operations. These are usually simple wrappers
1222d382aafbSBarry Smith    around the basic Unix system calls, but a few of them have additional
1223d382aafbSBarry Smith    functionality and/or error checking.
1224d382aafbSBarry Smith */
1225014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType);
1226014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemmove(void*,void *,size_t);
1227014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemcmp(const void*,const void*,size_t,PetscBool  *);
1228014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrlen(const char[],size_t*);
1229d67fe73bSBarry Smith PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[],char,int*,char ***);
1230014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int,char **);
1231014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[],const char[],PetscBool  *);
1232014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[],const char[],PetscBool  *);
1233014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[],const char[],PetscBool *);
1234014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[],const char[],size_t,PetscBool *);
1235014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcpy(char[],const char[]);
1236014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcat(char[],const char[]);
1237a126751eSBarry Smith PETSC_EXTERN PetscErrorCode PetscStrlcat(char[],const char[],size_t);
1238014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrncpy(char[],const char[],size_t);
1239014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrchr(const char[],char,char *[]);
1240014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]);
12412f234a98SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrtoupper(char[]);
1242014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[],char,char *[]);
1243014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrstr(const char[],const char[],char *[]);
1244014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[],const char[],char *[]);
1245014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[],const char[],PetscBool*);
12462c9581d2SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[],const char[],PetscBool*);
1247014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[],const char *const*,PetscInt*);
1248014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[],char *[]);
124947340559SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const*,char***);
12506fed8037SJed Brown PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char***);
12516991f827SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrNArrayallocpy(PetscInt,const char *const*,char***);
12526991f827SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrNArrayDestroy(PetscInt,char***);
1253014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm,const char[],char[],size_t);
1254d382aafbSBarry Smith 
1255573b0fb4SBarry Smith PETSC_EXTERN void PetscStrcmpNoError(const char[],const char[],PetscBool  *);
1256573b0fb4SBarry Smith 
1257014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*);
1258014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]);
1259014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*);
12608e81d068SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscStrInList(const char[],const char[],char,PetscBool*);
1261d382aafbSBarry Smith 
1262a53986e1SJed Brown PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt,const char *const*,const char*,PetscInt*,PetscBool*);
1263a53986e1SJed Brown PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const*,const char*,PetscEnum*,PetscBool*);
1264a53986e1SJed Brown 
1265d382aafbSBarry Smith /*
1266d382aafbSBarry Smith    These are MPI operations for MPI_Allreduce() etc
1267d382aafbSBarry Smith */
1268367daffbSBarry Smith PETSC_EXTERN MPI_Op MPIU_MAXSUM_OP;
1269570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1270014dd563SJed Brown PETSC_EXTERN MPI_Op MPIU_SUM;
12712414b3c7SJed Brown #else
12722414b3c7SJed Brown #define MPIU_SUM MPI_SUM
12732414b3c7SJed Brown #endif
1274570b7f6dSBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1275014dd563SJed Brown PETSC_EXTERN MPI_Op MPIU_MAX;
1276014dd563SJed Brown PETSC_EXTERN MPI_Op MPIU_MIN;
1277d9822059SBarry Smith #else
1278d9822059SBarry Smith #define MPIU_MAX MPI_MAX
1279d9822059SBarry Smith #define MPIU_MIN MPI_MIN
1280d9822059SBarry Smith #endif
1281014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*);
1282d382aafbSBarry Smith 
1283014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1284014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1285eb3f98d2SBarry Smith 
128695c0884eSLisandro Dalcin PETSC_EXTERN const char *const PetscFileModes[];
1287d6a4318aSJed Brown 
1288639ff905SBarry Smith /*
1289639ff905SBarry Smith     Defines PETSc error handling.
1290639ff905SBarry Smith */
1291639ff905SBarry Smith #include <petscerror.h>
1292d382aafbSBarry Smith 
12930700a824SBarry Smith #define PETSC_SMALLEST_CLASSID  1211211
1294014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID;
1295014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID;
1296014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *);
1297d382aafbSBarry Smith 
1298d382aafbSBarry Smith /*
1299d382aafbSBarry Smith    Routines that get memory usage information from the OS
1300d382aafbSBarry Smith */
1301014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *);
1302014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *);
1303014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void);
1304b44d5720SBarry Smith PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]);
1305d382aafbSBarry Smith 
1306014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInfoAllow(PetscBool ,const char []);
1307014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal);
1308d382aafbSBarry Smith 
1309d382aafbSBarry Smith /*
1310d382aafbSBarry Smith    Initialization of PETSc
1311d382aafbSBarry Smith */
1312014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]);
1313014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]);
1314014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void);
1315014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *);
1316014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *);
1317014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFinalize(void);
1318014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void);
1319014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***);
1320014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***);
1321014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **);
1322d382aafbSBarry Smith 
1323014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscEnd(void);
1324607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void);
1325d382aafbSBarry Smith 
1326014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]);
1327014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void);
1328014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void);
1329014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]);
1330d382aafbSBarry Smith 
1331d382aafbSBarry Smith /*
1332d382aafbSBarry Smith      These are so that in extern C code we can caste function pointers to non-extern C
13332981ebdbSBarry Smith    function pointers. Since the regular C++ code expects its function pointers to be C++
1334d382aafbSBarry Smith */
1335638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void);
1336638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void);
1337638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void);
1338d382aafbSBarry Smith 
1339d382aafbSBarry Smith /*
1340d382aafbSBarry Smith     Functions that can act on any PETSc object.
1341d382aafbSBarry Smith */
1342014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject*);
1343014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject,MPI_Comm *);
1344014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject,PetscClassId *);
1345014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject,const char *[]);
1346014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetType(PetscObject,const char []);
1347014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject,const char *[]);
1348014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject,const char[]);
1349014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject,const char*[]);
1350014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject,PetscInt);
1351014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject,PetscInt*);
1352014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt);
1353014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject);
1354014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject,PetscInt*);
1355014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject);
1356014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject,PetscMPIInt *);
1357014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject,const char[],PetscObject);
1358014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject,const char[]);
1359014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject,const char[],PetscObject *);
1360bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject,const char[],void (*)(void));
1361bdf89e91SBarry Smith #define PetscObjectComposeFunction(a,b,d) PetscObjectComposeFunction_Private(a,b,(PetscVoidFunction)(d))
1362014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject);
1363014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject);
13640eb63584SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSetPrintedOptions(PetscObject);
13650eb63584SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectInheritPrintedOptions(PetscObject,PetscObject);
1366014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm,PetscMPIInt *);
1367d382aafbSBarry Smith 
1368665c2dedSJed Brown #include <petscviewertypes.h>
1369639ff905SBarry Smith #include <petscoptions.h>
1370639ff905SBarry Smith 
13710633abcbSJed Brown PETSC_EXTERN PetscErrorCode PetscObjectsListGetGlobalNumbering(MPI_Comm,PetscInt,PetscObject*,PetscInt*,PetscInt*);
13720633abcbSJed Brown 
1373639ff905SBarry Smith PETSC_EXTERN PetscErrorCode PetscMemoryShowUsage(PetscViewer,const char[]);
1374c5e4d11fSDmitry Karpeev PETSC_EXTERN PetscErrorCode PetscMemoryView(PetscViewer,const char[]);
1375dae58748SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject,PetscViewer);
1376639ff905SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject,PetscViewer);
13770005d66cSJed Brown #define PetscObjectQueryFunction(obj,name,fptr) PetscObjectQueryFunction_Private((obj),(name),(PetscVoidFunction*)(fptr))
13780005d66cSJed Brown PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject,const char[],void (**)(void));
1379014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject,const char[]);
1380014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject,const char[]);
1381014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject,const char[]);
1382014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject,const char*[]);
1383014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject,const char[]);
1384014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject);
1385014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void);
1386685405a1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject,PetscObject,const char[]);
1387014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject);
1388014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject,const char[],PetscBool *);
13894099cc6bSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompare(PetscObject,const char[],PetscBool *);
1390014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject,PetscBool*,const char[],...);
1391014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void));
1392014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void);
1393d382aafbSBarry Smith 
1394e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
13957aab2a10SBarry Smith PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void);
1396e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject);
1397e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject,PetscBool);
1398e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject);
1399e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject);
1400e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject);
1401e04113cfSBarry Smith PETSC_EXTERN void           PetscStackSAWsGrantAccess(void);
1402e04113cfSBarry Smith PETSC_EXTERN void           PetscStackSAWsTakeAccess(void);
1403e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void);
1404e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void);
140515681b3cSBarry Smith 
1406ec7429eaSBarry Smith #else
14077aab2a10SBarry Smith #define PetscSAWsBlock()                        0
1408e04113cfSBarry Smith #define PetscObjectSAWsViewOff(obj)             0
1409e04113cfSBarry Smith #define PetscObjectSAWsSetBlock(obj,flg)        0
1410e04113cfSBarry Smith #define PetscObjectSAWsBlock(obj)               0
1411e04113cfSBarry Smith #define PetscObjectSAWsGrantAccess(obj)         0
1412e04113cfSBarry Smith #define PetscObjectSAWsTakeAccess(obj)          0
1413e04113cfSBarry Smith #define PetscStackViewSAWs()                    0
1414e04113cfSBarry Smith #define PetscStackSAWsViewOff()                 0
1415e04113cfSBarry Smith #define PetscStackSAWsTakeAccess()
1416e04113cfSBarry Smith #define PetscStackSAWsGrantAccess()
141715681b3cSBarry Smith 
1418ec7429eaSBarry Smith #endif
1419b90c6cbeSBarry Smith 
142082b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *);
142182b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *);
142282b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **);
14237d5d4d99SBarry Smith 
14245fe58b6fSBarry Smith #if defined(PETSC_USE_DEBUG)
1425a64a8e02SBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**);
14265fe58b6fSBarry Smith #endif
14277eb1d149SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool);
1428a64a8e02SBarry Smith 
1429140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList*);
1430140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList,const char[],PetscObject*);
1431140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList,PetscObject,char**,PetscBool*);
1432140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *,const char[],PetscObject);
1433140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *,const char[]);
1434140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList,PetscObjectList *);
1435d382aafbSBarry Smith 
1436d382aafbSBarry Smith /*
1437503cfb0cSBarry Smith     Dynamic library lists. Lists of names of routines in objects or in dynamic
1438d382aafbSBarry Smith   link libraries that will be loaded as needed.
1439d382aafbSBarry Smith */
1440a240a19fSJed Brown 
1441a240a19fSJed Brown #define PetscFunctionListAdd(list,name,fptr) PetscFunctionListAdd_Private((list),(name),(PetscVoidFunction)(fptr))
1442a240a19fSJed Brown PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList*,const char[],void (*)(void));
1443140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList*);
14441c9cd337SJed Brown #define PetscFunctionListFind(list,name,fptr) PetscFunctionListFind_Private((list),(name),(PetscVoidFunction*)(fptr))
14451c9cd337SJed Brown PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList,const char[],void (**)(void));
1446140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFunctionList,const char[]);
1447140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList,PetscFunctionList *);
1448140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList,PetscViewer);
1449140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList,const char ***,int*);
1450d382aafbSBarry Smith 
1451014dd563SJed Brown PETSC_EXTERN PetscDLLibrary  PetscDLLibrariesLoaded;
1452014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]);
1453014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]);
1454014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **);
1455014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary);
1456014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool  *);
1457014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *);
1458014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary);
1459d382aafbSBarry Smith 
1460d382aafbSBarry Smith /*
1461d382aafbSBarry Smith      Useful utility routines
1462d382aafbSBarry Smith */
1463014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*);
1464014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*);
1465014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt);
1466014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt);
1467014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject);
1468014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*);
14696ba4152bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxInt(MPI_Comm,PetscInt[],PetscInt[]);
14706ba4152bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxReal(MPI_Comm,PetscReal[],PetscReal[]);
1471d382aafbSBarry Smith 
147264ac3b0dSPatrick Sanan /*MC
1473ace3abfcSBarry Smith     PetscNot - negates a logical type value and returns result as a PetscBool
1474503cfb0cSBarry Smith 
1475e28ce29aSPatrick Sanan     Notes:
1476e28ce29aSPatrick Sanan     This is useful in cases like
1477503cfb0cSBarry Smith $     int        *a;
1478ace3abfcSBarry Smith $     PetscBool  flag = PetscNot(a)
14791cc8b206SBarry Smith      where !a would not return a PetscBool because we cannot provide a cast from int to PetscBool in C.
148064ac3b0dSPatrick Sanan 
148164ac3b0dSPatrick Sanan     Level: beginner
148264ac3b0dSPatrick Sanan 
148364ac3b0dSPatrick Sanan     .seealso : PetscBool, PETSC_TRUE, PETSC_FALSE
148464ac3b0dSPatrick Sanan M*/
1485d382aafbSBarry Smith #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)
1486503cfb0cSBarry Smith 
1487d382aafbSBarry Smith /*MC
1488d382aafbSBarry Smith     PetscHelpPrintf - Prints help messages.
1489d382aafbSBarry Smith 
1490d382aafbSBarry Smith    Synopsis:
1491aaa7dc30SBarry Smith     #include <petscsys.h>
1492d382aafbSBarry Smith      PetscErrorCode (*PetscHelpPrintf)(const char format[],...);
1493d382aafbSBarry Smith 
1494eca87e8dSBarry Smith     Not Collective
1495eca87e8dSBarry Smith 
1496d382aafbSBarry Smith     Input Parameters:
1497d382aafbSBarry Smith .   format - the usual printf() format string
1498d382aafbSBarry Smith 
1499d382aafbSBarry Smith    Level: developer
1500d382aafbSBarry Smith 
1501d382aafbSBarry Smith     Fortran Note:
1502d382aafbSBarry Smith     This routine is not supported in Fortran.
1503d382aafbSBarry Smith 
1504d382aafbSBarry Smith     Concepts: help messages^printing
1505d382aafbSBarry Smith     Concepts: printing^help messages
1506d382aafbSBarry Smith 
1507d382aafbSBarry Smith .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf()
1508d382aafbSBarry Smith M*/
1509014dd563SJed Brown PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...);
1510d382aafbSBarry Smith 
1511fcfd50ebSBarry Smith /*
1512fcfd50ebSBarry Smith      Defines PETSc profiling.
1513fcfd50ebSBarry Smith */
15142c8e378dSBarry Smith #include <petsclog.h>
1515fcfd50ebSBarry Smith 
1516fcfd50ebSBarry Smith /*
1517fcfd50ebSBarry Smith       Simple PETSc parallel IO for ASCII printing
1518fcfd50ebSBarry Smith */
1519014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]);
1520014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**);
1521014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*);
1522014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...);
1523014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...);
1524014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...);
1525014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...);
15261b5687a1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFormatRealArray(char[],size_t,const char*,PetscInt,const PetscReal[]);
1527fcfd50ebSBarry Smith 
1528014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...);
1529014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...);
1530014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...);
1531d382aafbSBarry Smith 
1532d781fa04SBarry Smith PETSC_EXTERN PetscErrorCode PetscFormatConvertGetSize(const char*,size_t*);
1533d781fa04SBarry Smith PETSC_EXTERN PetscErrorCode PetscFormatConvert(const char*,char *);
1534d781fa04SBarry Smith 
1535d382aafbSBarry Smith #if defined(PETSC_HAVE_POPEN)
1536014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **);
1537016831caSBarry Smith PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm,FILE*);
153874ba8654SBarry Smith PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]);
1539d382aafbSBarry Smith #endif
1540d382aafbSBarry Smith 
1541014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm,const char[],...);
1542014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...);
15430ec8b6e3SBarry Smith PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm,FILE*);
1544014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]);
1545014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**);
1546014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm,const char[],const char[],FILE**);
1547014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char*[]);
1548d382aafbSBarry Smith 
1549014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID;
1550014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer,void **);
1551014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer,void *);
1552014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer*);
1553014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm,PetscContainer *);
1554014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void*));
1555b61ba218SStefano Zampini PETSC_EXTERN PetscErrorCode PetscContainerUserDestroyDefault(void*);
1556d382aafbSBarry Smith 
1557d382aafbSBarry Smith /*
1558d382aafbSBarry Smith    For use in debuggers
1559d382aafbSBarry Smith */
1560014dd563SJed Brown PETSC_EXTERN PetscMPIInt PetscGlobalRank;
1561014dd563SJed Brown PETSC_EXTERN PetscMPIInt PetscGlobalSize;
1562014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt,const PetscInt[],PetscViewer);
1563014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt,const PetscReal[],PetscViewer);
1564014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt,const PetscScalar[],PetscViewer);
1565d382aafbSBarry Smith 
1566a663daf8SBarry Smith #include <stddef.h>
1567a3aaec0aSJed Brown #include <string.h>             /* for memcpy, memset */
1568d382aafbSBarry Smith #if defined(PETSC_HAVE_STDLIB_H)
1569d382aafbSBarry Smith #include <stdlib.h>
1570d382aafbSBarry Smith #endif
15716c7e564aSBarry Smith 
15724a92a979SJed Brown #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__)
1573d382aafbSBarry Smith #include <xmmintrin.h>
1574d382aafbSBarry Smith #endif
1575d382aafbSBarry Smith 
1576d382aafbSBarry Smith /*@C
1577d382aafbSBarry Smith    PetscMemcpy - Copies n bytes, beginning at location b, to the space
1578d382aafbSBarry Smith    beginning at location a. The two memory regions CANNOT overlap, use
1579d382aafbSBarry Smith    PetscMemmove() in that case.
1580d382aafbSBarry Smith 
1581d382aafbSBarry Smith    Not Collective
1582d382aafbSBarry Smith 
1583d382aafbSBarry Smith    Input Parameters:
1584d382aafbSBarry Smith +  b - pointer to initial memory space
1585d382aafbSBarry Smith -  n - length (in bytes) of space to copy
1586d382aafbSBarry Smith 
1587d382aafbSBarry Smith    Output Parameter:
1588d382aafbSBarry Smith .  a - pointer to copy space
1589d382aafbSBarry Smith 
1590d382aafbSBarry Smith    Level: intermediate
1591d382aafbSBarry Smith 
1592d382aafbSBarry Smith    Compile Option:
1593d382aafbSBarry Smith     PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used
1594d382aafbSBarry Smith                                   for memory copies on double precision values.
1595d382aafbSBarry Smith     PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used
1596d382aafbSBarry Smith                                   for memory copies on double precision values.
1597d382aafbSBarry Smith     PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used
1598d382aafbSBarry Smith                                   for memory copies on double precision values.
1599d382aafbSBarry Smith 
1600d382aafbSBarry Smith    Note:
1601d382aafbSBarry Smith    This routine is analogous to memcpy().
1602d382aafbSBarry Smith 
16031fd49c25SBarry Smith    Not available from Fortran
16041fd49c25SBarry Smith 
1605f5f57ec0SBarry Smith    Developer Note: this is inlined for fastest performance
1606f5f57ec0SBarry Smith 
1607d382aafbSBarry Smith   Concepts: memory^copying
1608d382aafbSBarry Smith   Concepts: copying^memory
1609d382aafbSBarry Smith 
16101fd49c25SBarry Smith .seealso: PetscMemmove(), PetscStrallocpy()
1611d382aafbSBarry Smith 
1612d382aafbSBarry Smith @*/
16137087cfbeSBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscMemcpy(void *a,const void *b,size_t n)
1614d382aafbSBarry Smith {
1615d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG)
1616c5e4d11fSDmitry Karpeev   size_t al = (size_t) a,bl = (size_t) b;
1617c5e4d11fSDmitry Karpeev   size_t nl = (size_t) n;
1618a7e36092SMatthew G Knepley   PetscFunctionBegin;
1619e32f2f54SBarry Smith   if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer");
1620e32f2f54SBarry Smith   if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer");
1621a7e36092SMatthew G Knepley #else
1622d382aafbSBarry Smith   PetscFunctionBegin;
1623a7e36092SMatthew G Knepley #endif
1624a47a537aSLisandro Dalcin   if (a != b && n > 0) {
1625d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG)
1626e47d2de2SBarry Smith     if ((al > bl && (al - bl) < nl) || (bl - al) < nl)  SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Memory regions overlap: either use PetscMemmov()\n\
1627d382aafbSBarry Smith               or make sure your copy regions and lengths are correct. \n\
1628d382aafbSBarry Smith               Length (bytes) %ld first address %ld second address %ld",nl,al,bl);
1629d382aafbSBarry Smith #endif
1630d382aafbSBarry Smith #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY))
1631c5e4d11fSDmitry Karpeev    if (!(a % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1632d382aafbSBarry Smith       size_t len = n/sizeof(PetscScalar);
1633d382aafbSBarry Smith #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY)
1634c5df96a5SBarry Smith       PetscBLASInt   one = 1,blen;
1635c5df96a5SBarry Smith       PetscErrorCode ierr;
1636c5df96a5SBarry Smith       ierr = PetscBLASIntCast(len,&blen);CHKERRQ(ierr);
16378b83055fSJed Brown       PetscStackCallBLAS("BLAScopy",BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one));
1638d382aafbSBarry Smith #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY)
1639d382aafbSBarry Smith       fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a);
1640d382aafbSBarry Smith #else
1641d382aafbSBarry Smith       size_t      i;
1642d382aafbSBarry Smith       PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a;
1643d382aafbSBarry Smith       for (i=0; i<len; i++) y[i] = x[i];
1644d382aafbSBarry Smith #endif
1645d382aafbSBarry Smith     } else {
1646d382aafbSBarry Smith       memcpy((char*)(a),(char*)(b),n);
1647d382aafbSBarry Smith     }
1648d382aafbSBarry Smith #else
1649d382aafbSBarry Smith     memcpy((char*)(a),(char*)(b),n);
1650d382aafbSBarry Smith #endif
1651d382aafbSBarry Smith   }
1652d382aafbSBarry Smith   PetscFunctionReturn(0);
1653d382aafbSBarry Smith }
1654d382aafbSBarry Smith 
1655d382aafbSBarry Smith /*@C
1656d382aafbSBarry Smith    PetscMemzero - Zeros the specified memory.
1657d382aafbSBarry Smith 
1658d382aafbSBarry Smith    Not Collective
1659d382aafbSBarry Smith 
1660d382aafbSBarry Smith    Input Parameters:
1661d382aafbSBarry Smith +  a - pointer to beginning memory location
1662d382aafbSBarry Smith -  n - length (in bytes) of memory to initialize
1663d382aafbSBarry Smith 
1664d382aafbSBarry Smith    Level: intermediate
1665d382aafbSBarry Smith 
1666d382aafbSBarry Smith    Compile Option:
1667d382aafbSBarry Smith    PETSC_PREFER_BZERO - on certain machines (the IBM RS6000) the bzero() routine happens
1668d382aafbSBarry Smith   to be faster than the memset() routine. This flag causes the bzero() routine to be used.
1669d382aafbSBarry Smith 
16701fd49c25SBarry Smith    Not available from Fortran
16711fd49c25SBarry Smith 
1672503cfb0cSBarry Smith    Developer Note: this is inlined for fastest performance
1673503cfb0cSBarry Smith 
1674d382aafbSBarry Smith    Concepts: memory^zeroing
1675d382aafbSBarry Smith    Concepts: zeroing^memory
1676d382aafbSBarry Smith 
1677d382aafbSBarry Smith .seealso: PetscMemcpy()
1678d382aafbSBarry Smith @*/
16797087cfbeSBarry Smith PETSC_STATIC_INLINE PetscErrorCode  PetscMemzero(void *a,size_t n)
1680d382aafbSBarry Smith {
1681d382aafbSBarry Smith   if (n > 0) {
1682d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG)
1683e32f2f54SBarry Smith     if (!a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer");
1684d382aafbSBarry Smith #endif
1685d382aafbSBarry Smith #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO)
1686d382aafbSBarry Smith     if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1687d382aafbSBarry Smith       size_t      i,len = n/sizeof(PetscScalar);
1688d382aafbSBarry Smith       PetscScalar *x = (PetscScalar*)a;
1689d382aafbSBarry Smith       for (i=0; i<len; i++) x[i] = 0.0;
1690d382aafbSBarry Smith     } else {
1691d382aafbSBarry Smith #elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
1692d382aafbSBarry Smith     if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1693d382aafbSBarry Smith       PetscInt len = n/sizeof(PetscScalar);
1694d382aafbSBarry Smith       fortranzero_(&len,(PetscScalar*)a);
1695d382aafbSBarry Smith     } else {
1696d382aafbSBarry Smith #endif
1697d382aafbSBarry Smith #if defined(PETSC_PREFER_BZERO)
1698d382aafbSBarry Smith       bzero((char *)a,n);
1699d382aafbSBarry Smith #else
1700d382aafbSBarry Smith       memset((char*)a,0,n);
1701d382aafbSBarry Smith #endif
1702d382aafbSBarry Smith #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
1703d382aafbSBarry Smith     }
1704d382aafbSBarry Smith #endif
1705d382aafbSBarry Smith   }
1706d382aafbSBarry Smith   return 0;
1707d382aafbSBarry Smith }
1708d382aafbSBarry Smith 
1709d382aafbSBarry Smith /*MC
1710d382aafbSBarry Smith    PetscPrefetchBlock - Prefetches a block of memory
1711d382aafbSBarry Smith 
1712eca87e8dSBarry Smith    Synopsis:
1713aaa7dc30SBarry Smith     #include <petscsys.h>
1714eca87e8dSBarry Smith     void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t)
1715eca87e8dSBarry Smith 
1716d382aafbSBarry Smith    Not Collective
1717d382aafbSBarry Smith 
1718d382aafbSBarry Smith    Input Parameters:
1719d382aafbSBarry Smith +  a - pointer to first element to fetch (any type but usually PetscInt or PetscScalar)
1720d382aafbSBarry Smith .  n - number of elements to fetch
1721d382aafbSBarry Smith .  rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors)
172250d8bf02SJed Brown -  t - temporal locality (PETSC_PREFETCH_HINT_{NTA,T0,T1,T2}), see note
1723d382aafbSBarry Smith 
1724d382aafbSBarry Smith    Level: developer
1725d382aafbSBarry Smith 
1726d382aafbSBarry Smith    Notes:
1727d382aafbSBarry Smith    The last two arguments (rw and t) must be compile-time constants.
1728d382aafbSBarry Smith 
172950d8bf02SJed Brown    Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality.  Not all architectures offer
173050d8bf02SJed Brown    equivalent locality hints, but the following macros are always defined to their closest analogue.
173150d8bf02SJed Brown +  PETSC_PREFETCH_HINT_NTA - Non-temporal.  Prefetches directly to L1, evicts to memory (skips higher level cache unless it was already there when prefetched).
173263cf1ef0SJed Brown .  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.
173363cf1ef0SJed Brown .  PETSC_PREFETCH_HINT_T1 - Fetch to level 2 and higher (not L1).
173463cf1ef0SJed Brown -  PETSC_PREFETCH_HINT_T2 - Fetch to high-level cache only.  (On many systems, T0 and T1 are equivalent.)
1735d382aafbSBarry Smith 
1736d382aafbSBarry Smith    This function does nothing on architectures that do not support prefetch and never errors (even if passed an invalid
1737d382aafbSBarry Smith    address).
1738d382aafbSBarry Smith 
1739d382aafbSBarry Smith    Concepts: memory
1740d382aafbSBarry Smith M*/
1741d382aafbSBarry Smith #define PetscPrefetchBlock(a,n,rw,t) do {                               \
1742d382aafbSBarry Smith     const char *_p = (const char*)(a),*_end = (const char*)((a)+(n));   \
1743d382aafbSBarry Smith     for ( ; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p,(rw),(t)); \
1744d382aafbSBarry Smith   } while (0)
1745d382aafbSBarry Smith 
1746d382aafbSBarry Smith /*
1747d382aafbSBarry Smith       Determine if some of the kernel computation routines use
1748d382aafbSBarry Smith    Fortran (rather than C) for the numerical calculations. On some machines
1749d382aafbSBarry Smith    and compilers (like complex numbers) the Fortran version of the routines
1750d382aafbSBarry Smith    is faster than the C/C++ versions. The flag --with-fortran-kernels
1751e2e64c6bSBarry Smith    should be used with ./configure to turn these on.
1752d382aafbSBarry Smith */
1753d382aafbSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS)
1754d382aafbSBarry Smith 
1755d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL)
1756d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTCRL
1757d382aafbSBarry Smith #endif
1758d382aafbSBarry Smith 
17595a11e1b2SBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM)
17605a11e1b2SBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM
1761d382aafbSBarry Smith #endif
1762d382aafbSBarry Smith 
1763d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
1764d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
1765d382aafbSBarry Smith #endif
1766d382aafbSBarry Smith 
1767d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
1768d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
1769d382aafbSBarry Smith #endif
1770d382aafbSBarry Smith 
1771d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM)
1772d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_NORM
1773d382aafbSBarry Smith #endif
1774d382aafbSBarry Smith 
1775d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
1776d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MAXPY
1777d382aafbSBarry Smith #endif
1778d382aafbSBarry Smith 
1779d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
1780d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
1781d382aafbSBarry Smith #endif
1782d382aafbSBarry Smith 
1783d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ)
1784d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ
1785d382aafbSBarry Smith #endif
1786d382aafbSBarry Smith 
1787d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
1788d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
1789d382aafbSBarry Smith #endif
1790d382aafbSBarry Smith 
1791d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
1792d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
1793d382aafbSBarry Smith #endif
1794d382aafbSBarry Smith 
1795d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
1796d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MDOT
1797d382aafbSBarry Smith #endif
1798d382aafbSBarry Smith 
1799d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
1800d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_XTIMESY
1801d382aafbSBarry Smith #endif
1802d382aafbSBarry Smith 
1803d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX)
1804d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_AYPX
1805d382aafbSBarry Smith #endif
1806d382aafbSBarry Smith 
1807d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY)
1808d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_WAXPY
1809d382aafbSBarry Smith #endif
1810d382aafbSBarry Smith 
1811d382aafbSBarry Smith #endif
1812d382aafbSBarry Smith 
1813d382aafbSBarry Smith /*
1814d382aafbSBarry Smith     Macros for indicating code that should be compiled with a C interface,
1815d382aafbSBarry Smith    rather than a C++ interface. Any routines that are dynamically loaded
1816d382aafbSBarry Smith    (such as the PCCreate_XXX() routines) must be wrapped so that the name
1817d382aafbSBarry Smith    mangler does not change the functions symbol name. This just hides the
1818d382aafbSBarry Smith    ugly extern "C" {} wrappers.
1819d382aafbSBarry Smith */
1820d382aafbSBarry Smith #if defined(__cplusplus)
1821d382aafbSBarry Smith #  define EXTERN_C_BEGIN extern "C" {
1822d382aafbSBarry Smith #  define EXTERN_C_END }
1823d382aafbSBarry Smith #else
1824d382aafbSBarry Smith #  define EXTERN_C_BEGIN
1825d382aafbSBarry Smith #  define EXTERN_C_END
1826d382aafbSBarry Smith #endif
1827d382aafbSBarry Smith 
1828d382aafbSBarry Smith /* --------------------------------------------------------------------*/
1829d382aafbSBarry Smith 
1830d382aafbSBarry Smith /*MC
1831d382aafbSBarry Smith     MPI_Comm - the basic object used by MPI to determine which processes are involved in a
1832d382aafbSBarry Smith         communication
1833d382aafbSBarry Smith 
1834d382aafbSBarry Smith    Level: beginner
1835d382aafbSBarry Smith 
1836d382aafbSBarry Smith    Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm
1837d382aafbSBarry Smith 
1838d382aafbSBarry Smith .seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF
1839d382aafbSBarry Smith M*/
1840d382aafbSBarry Smith 
1841d382aafbSBarry Smith #if defined(PETSC_HAVE_MPIIO)
1842d382aafbSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
1843014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
1844014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
1845d382aafbSBarry Smith #else
1846d382aafbSBarry Smith #define MPIU_File_write_all(a,b,c,d,e) MPI_File_write_all(a,b,c,d,e)
1847d382aafbSBarry Smith #define MPIU_File_read_all(a,b,c,d,e) MPI_File_read_all(a,b,c,d,e)
1848d382aafbSBarry Smith #endif
1849d382aafbSBarry Smith #endif
1850d382aafbSBarry Smith 
1851d382aafbSBarry Smith /* the following petsc_static_inline require petscerror.h */
1852d382aafbSBarry Smith 
1853d382aafbSBarry Smith /* Limit MPI to 32-bits */
1854d382aafbSBarry Smith #define PETSC_MPI_INT_MAX  2147483647
1855d382aafbSBarry Smith #define PETSC_MPI_INT_MIN -2147483647
1856d382aafbSBarry Smith /* Limit BLAS to 32-bits */
1857d382aafbSBarry Smith #define PETSC_BLAS_INT_MAX  2147483647
1858d382aafbSBarry Smith #define PETSC_BLAS_INT_MIN -2147483647
1859d382aafbSBarry Smith 
186061b0d812SBarry Smith /*@C
186161b0d812SBarry Smith     PetscBLASIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscBLASInt (which may be 32 bits in size), generates an
186261b0d812SBarry Smith          error if the PetscBLASInt is not large enough to hold the number.
186361b0d812SBarry Smith 
186461b0d812SBarry Smith    Not Collective
186561b0d812SBarry Smith 
186661b0d812SBarry Smith    Input Parameter:
186761b0d812SBarry Smith .     a - the PetscInt value
186861b0d812SBarry Smith 
186961b0d812SBarry Smith    Output Parameter:
187061b0d812SBarry Smith .     b - the resulting PetscBLASInt value
187161b0d812SBarry Smith 
187261b0d812SBarry Smith    Level: advanced
187361b0d812SBarry Smith 
18741fd49c25SBarry Smith    Not available from Fortran
18751fd49c25SBarry Smith 
187661b0d812SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscMPIIntCast()
187761b0d812SBarry Smith @*/
1878c5df96a5SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscBLASIntCast(PetscInt a,PetscBLASInt *b)
1879c5df96a5SBarry Smith {
1880c5df96a5SBarry Smith   PetscFunctionBegin;
1881ab7117d1SBarry Smith   *b =  (PetscBLASInt)(a);
1882c5df96a5SBarry Smith #if defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_HAVE_64BIT_BLAS_INDICES)
1883c5df96a5SBarry Smith   if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK");
1884c5df96a5SBarry Smith #endif
1885c5df96a5SBarry Smith   PetscFunctionReturn(0);
1886c5df96a5SBarry Smith }
1887c5df96a5SBarry Smith 
188861b0d812SBarry Smith /*@C
188961b0d812SBarry Smith     PetscMPIIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscMPIInt (which may be 32 bits in size), generates an
189061b0d812SBarry Smith          error if the PetscMPIInt is not large enough to hold the number.
189161b0d812SBarry Smith 
189261b0d812SBarry Smith    Not Collective
189361b0d812SBarry Smith 
189461b0d812SBarry Smith    Input Parameter:
189561b0d812SBarry Smith .     a - the PetscInt value
189661b0d812SBarry Smith 
189761b0d812SBarry Smith    Output Parameter:
189861b0d812SBarry Smith .     b - the resulting PetscMPIInt value
189961b0d812SBarry Smith 
190061b0d812SBarry Smith    Level: advanced
190161b0d812SBarry Smith 
19021fd49c25SBarry Smith    Not available from Fortran
19031fd49c25SBarry Smith 
190461b0d812SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast()
190561b0d812SBarry Smith @*/
19064dc2109aSBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscMPIIntCast(PetscInt a,PetscMPIInt *b)
19074dc2109aSBarry Smith {
19084dc2109aSBarry Smith   PetscFunctionBegin;
1909ab7117d1SBarry Smith   *b =  (PetscMPIInt)(a);
19104dc2109aSBarry Smith #if defined(PETSC_USE_64BIT_INDICES)
19114dc2109aSBarry Smith   if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for MPI");
19124dc2109aSBarry Smith #endif
19134dc2109aSBarry Smith   PetscFunctionReturn(0);
19144dc2109aSBarry Smith }
19154dc2109aSBarry Smith 
1916bafee8b4SSatish Balay #define PetscInt64Mult(a,b)   ((PetscInt64)(a))*((PetscInt64)(b))
19172f18eb33SBarry Smith 
19182f18eb33SBarry Smith /*@C
19192f18eb33SBarry Smith 
19202f18eb33SBarry Smith    PetscRealIntMultTruncate - Computes the product of a positive PetscReal and a positive PetscInt and truncates the value to slightly less than the maximal possible value
19212f18eb33SBarry Smith 
19222f18eb33SBarry Smith    Not Collective
19232f18eb33SBarry Smith 
19242f18eb33SBarry Smith    Input Parameter:
19252f18eb33SBarry Smith +     a - the PetscReal value
19262f18eb33SBarry Smith -     b - the second value
19272f18eb33SBarry Smith 
1928390e1bf2SBarry Smith    Returns:
1929390e1bf2SBarry Smith       the result as a PetscInt value
19302f18eb33SBarry Smith 
1931bafee8b4SSatish Balay    Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
19322f18eb33SBarry Smith    Use PetscIntMultTruncate() to compute the product of two positive PetscInt and truncate to fit a PetscInt
19332f18eb33SBarry Smith    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
19342f18eb33SBarry Smith 
1935e28ce29aSPatrick Sanan    Developers Note:
1936e28ce29aSPatrick Sanan    We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks.
19372f18eb33SBarry Smith 
19382f18eb33SBarry Smith    This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
19392f18eb33SBarry Smith 
19401fd49c25SBarry Smith    Not available from Fortran
19411fd49c25SBarry Smith 
19422f18eb33SBarry Smith    Level: advanced
19432f18eb33SBarry Smith 
1944390e1bf2SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
19452f18eb33SBarry Smith @*/
19462f18eb33SBarry Smith PETSC_STATIC_INLINE PetscInt PetscRealIntMultTruncate(PetscReal a,PetscInt b)
19472f18eb33SBarry Smith {
1948bafee8b4SSatish Balay   PetscInt64 r;
19492f18eb33SBarry Smith 
1950bafee8b4SSatish Balay   r  =  (PetscInt64) (a*(PetscReal)b);
19512f18eb33SBarry Smith   if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
19522f18eb33SBarry Smith   return (PetscInt) r;
19532f18eb33SBarry Smith }
19542f18eb33SBarry Smith 
19552f18eb33SBarry Smith /*@C
19562f18eb33SBarry Smith 
19572f18eb33SBarry Smith    PetscIntMultTruncate - Computes the product of two positive PetscInt and truncates the value to slightly less than the maximal possible value
19582f18eb33SBarry Smith 
19592f18eb33SBarry Smith    Not Collective
19602f18eb33SBarry Smith 
19612f18eb33SBarry Smith    Input Parameter:
19622f18eb33SBarry Smith +     a - the PetscInt value
19632f18eb33SBarry Smith -     b - the second value
19642f18eb33SBarry Smith 
1965390e1bf2SBarry Smith    Returns:
1966390e1bf2SBarry Smith       the result as a PetscInt value
19672f18eb33SBarry Smith 
1968bafee8b4SSatish Balay    Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
19692f18eb33SBarry Smith    Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
19702f18eb33SBarry Smith    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
19712f18eb33SBarry Smith 
19721fd49c25SBarry Smith    Not available from Fortran
19731fd49c25SBarry Smith 
19742f18eb33SBarry Smith    Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks.
19752f18eb33SBarry Smith 
19762f18eb33SBarry Smith    This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
19772f18eb33SBarry Smith 
19782f18eb33SBarry Smith    Level: advanced
19792f18eb33SBarry Smith 
1980390e1bf2SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
19812f18eb33SBarry Smith @*/
19822f18eb33SBarry Smith PETSC_STATIC_INLINE PetscInt PetscIntMultTruncate(PetscInt a,PetscInt b)
19832f18eb33SBarry Smith {
1984bafee8b4SSatish Balay   PetscInt64 r;
19852f18eb33SBarry Smith 
1986bafee8b4SSatish Balay   r  =  PetscInt64Mult(a,b);
19872f18eb33SBarry Smith   if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
19882f18eb33SBarry Smith   return (PetscInt) r;
19892f18eb33SBarry Smith }
19902f18eb33SBarry Smith 
1991f91af8c7SBarry Smith /*@C
1992f91af8c7SBarry Smith 
1993f91af8c7SBarry Smith    PetscIntSumTruncate - Computes the sum of two positive PetscInt and truncates the value to slightly less than the maximal possible value
1994f91af8c7SBarry Smith 
1995f91af8c7SBarry Smith    Not Collective
1996f91af8c7SBarry Smith 
1997f91af8c7SBarry Smith    Input Parameter:
1998f91af8c7SBarry Smith +     a - the PetscInt value
1999f91af8c7SBarry Smith -     b - the second value
2000f91af8c7SBarry Smith 
2001390e1bf2SBarry Smith    Returns:
2002390e1bf2SBarry Smith      the result as a PetscInt value
2003f91af8c7SBarry Smith 
2004bafee8b4SSatish Balay    Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2005f91af8c7SBarry Smith    Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
2006f91af8c7SBarry Smith    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
2007f91af8c7SBarry Smith 
2008f91af8c7SBarry Smith    This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2009f91af8c7SBarry Smith 
2010f5f57ec0SBarry Smith    Not available from Fortran
2011f5f57ec0SBarry Smith 
2012f91af8c7SBarry Smith    Level: advanced
2013f91af8c7SBarry Smith 
2014390e1bf2SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2015f91af8c7SBarry Smith @*/
2016f91af8c7SBarry Smith PETSC_STATIC_INLINE PetscInt PetscIntSumTruncate(PetscInt a,PetscInt b)
2017f91af8c7SBarry Smith {
2018bafee8b4SSatish Balay   PetscInt64 r;
2019f91af8c7SBarry Smith 
2020bafee8b4SSatish Balay   r  =  ((PetscInt64)a) + ((PetscInt64)b);
2021f91af8c7SBarry Smith   if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2022f91af8c7SBarry Smith   return (PetscInt) r;
2023f91af8c7SBarry Smith }
2024f91af8c7SBarry Smith 
20252f18eb33SBarry Smith /*@C
20262f18eb33SBarry Smith 
20272f18eb33SBarry Smith    PetscIntMultError - Computes the product of two positive PetscInt and generates an error with overflow.
20282f18eb33SBarry Smith 
20292f18eb33SBarry Smith    Not Collective
20302f18eb33SBarry Smith 
20312f18eb33SBarry Smith    Input Parameter:
20322f18eb33SBarry Smith +     a - the PetscInt value
20332f18eb33SBarry Smith -     b - the second value
20342f18eb33SBarry Smith 
20352f18eb33SBarry Smith    Output Parameter:ma
2036390e1bf2SBarry Smith .     result - the result as a PetscInt value, or NULL if you do not want the result, you just want to check if it overflows
20372f18eb33SBarry Smith 
2038bafee8b4SSatish Balay    Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64
20392f18eb33SBarry Smith    Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt
20402f18eb33SBarry Smith 
2041f5f57ec0SBarry Smith    Not available from Fortran
2042f5f57ec0SBarry Smith 
2043220afb94SBarry Smith    Developers Note: We currently assume that PetscInt addition does not overflow, this is obviously wrong but requires many more checks.
20442f18eb33SBarry Smith 
20452f18eb33SBarry Smith    Level: advanced
20462f18eb33SBarry Smith 
2047220afb94SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntMult64(), PetscIntSumError()
20482f18eb33SBarry Smith @*/
20492f18eb33SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscIntMultError(PetscInt a,PetscInt b,PetscInt *result)
20502f18eb33SBarry Smith {
2051bafee8b4SSatish Balay   PetscInt64 r;
20522f18eb33SBarry Smith 
20532f18eb33SBarry Smith   PetscFunctionBegin;
2054bafee8b4SSatish Balay   r  =  PetscInt64Mult(a,b);
20552f18eb33SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES)
20562f18eb33SBarry Smith   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);
20572f18eb33SBarry Smith #endif
2058f91af8c7SBarry Smith   if (result) *result = (PetscInt) r;
2059f91af8c7SBarry Smith   PetscFunctionReturn(0);
2060f91af8c7SBarry Smith }
2061f91af8c7SBarry Smith 
2062f91af8c7SBarry Smith /*@C
2063f91af8c7SBarry Smith 
2064fbfcfee5SBarry Smith    PetscIntSumError - Computes the sum of two positive PetscInt and generates an error with overflow.
2065f91af8c7SBarry Smith 
2066f91af8c7SBarry Smith    Not Collective
2067f91af8c7SBarry Smith 
2068f91af8c7SBarry Smith    Input Parameter:
2069f91af8c7SBarry Smith +     a - the PetscInt value
2070f91af8c7SBarry Smith -     b - the second value
2071f91af8c7SBarry Smith 
2072f91af8c7SBarry Smith    Output Parameter:ma
2073390e1bf2SBarry Smith .     c - the result as a PetscInt value,  or NULL if you do not want the result, you just want to check if it overflows
2074f91af8c7SBarry Smith 
2075bafee8b4SSatish Balay    Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64
2076f91af8c7SBarry Smith    Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt
2077f91af8c7SBarry Smith 
2078f5f57ec0SBarry Smith    Not available from Fortran
2079f5f57ec0SBarry Smith 
2080f91af8c7SBarry Smith    Level: advanced
2081f91af8c7SBarry Smith 
2082390e1bf2SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2083f91af8c7SBarry Smith @*/
2084f91af8c7SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscIntSumError(PetscInt a,PetscInt b,PetscInt *result)
2085f91af8c7SBarry Smith {
2086bafee8b4SSatish Balay   PetscInt64 r;
2087f91af8c7SBarry Smith 
2088f91af8c7SBarry Smith   PetscFunctionBegin;
2089bafee8b4SSatish Balay   r  =  ((PetscInt64)a) + ((PetscInt64)b);
2090f91af8c7SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES)
2091f91af8c7SBarry Smith   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);
2092f91af8c7SBarry Smith #endif
2093f91af8c7SBarry Smith   if (result) *result = (PetscInt) r;
20942f18eb33SBarry Smith   PetscFunctionReturn(0);
20952f18eb33SBarry Smith }
2096c5df96a5SBarry Smith 
2097d382aafbSBarry Smith /*
20982981ebdbSBarry Smith      The IBM include files define hz, here we hide it so that it may be used as a regular user variable.
2099d382aafbSBarry Smith */
2100d382aafbSBarry Smith #if defined(hz)
2101d382aafbSBarry Smith #  undef hz
2102d382aafbSBarry Smith #endif
2103d382aafbSBarry Smith 
2104d382aafbSBarry Smith /*  For arrays that contain filenames or paths */
2105d382aafbSBarry Smith 
2106d382aafbSBarry Smith #if defined(PETSC_HAVE_LIMITS_H)
2107d382aafbSBarry Smith #  include <limits.h>
2108d382aafbSBarry Smith #endif
2109d382aafbSBarry Smith #if defined(PETSC_HAVE_SYS_PARAM_H)
2110d382aafbSBarry Smith #  include <sys/param.h>
2111d382aafbSBarry Smith #endif
2112d382aafbSBarry Smith #if defined(PETSC_HAVE_SYS_TYPES_H)
2113d382aafbSBarry Smith #  include <sys/types.h>
2114d382aafbSBarry Smith #endif
2115d382aafbSBarry Smith #if defined(MAXPATHLEN)
2116d382aafbSBarry Smith #  define PETSC_MAX_PATH_LEN MAXPATHLEN
2117d382aafbSBarry Smith #elif defined(MAX_PATH)
2118d382aafbSBarry Smith #  define PETSC_MAX_PATH_LEN MAX_PATH
2119d382aafbSBarry Smith #elif defined(_MAX_PATH)
2120d382aafbSBarry Smith #  define PETSC_MAX_PATH_LEN _MAX_PATH
2121d382aafbSBarry Smith #else
2122d382aafbSBarry Smith #  define PETSC_MAX_PATH_LEN 4096
2123d382aafbSBarry Smith #endif
2124d382aafbSBarry Smith 
2125d382aafbSBarry Smith /*MC
2126d382aafbSBarry Smith 
212766d79e26SBarry Smith     PETSC_VERSION - This manual page provides information about how PETSc documents and uses its version information. This information is available to both C/C++
212866d79e26SBarry Smith                     and Fortran compilers when petscsys.h is included.
212966d79e26SBarry Smith 
213066d79e26SBarry Smith 
213166d79e26SBarry Smith     The current PETSc version and the API for accessing it are defined in petscversion.h
213266d79e26SBarry Smith 
213366d79e26SBarry Smith     The complete version number is given as the triple  PETSC_VERSION_MAJOR.PETSC_VERSION_MINOR.PETSC_VERSION_SUBMINOR (in short hand x.y.z)
213466d79e26SBarry Smith 
213566d79e26SBarry Smith     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
213666d79e26SBarry Smith     where only a change in the major version number (x) indicates a change in the API.
213766d79e26SBarry Smith 
213866d79e26SBarry Smith     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
213966d79e26SBarry Smith 
214066d79e26SBarry Smith     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),
214166d79e26SBarry Smith     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
214266d79e26SBarry Smith     version number (x.y.z).
214366d79e26SBarry Smith 
214466d79e26SBarry Smith     PETSC_RELEASE_DATE is the date the x.y version was released (i.e. the version before any patch releases)
214566d79e26SBarry Smith 
214666d79e26SBarry Smith     PETSC_VERSION_DATE is the date the x.y.z version was released
214766d79e26SBarry Smith 
214866d79e26SBarry Smith     PETSC_VERSION_GIT is the last git commit to the repository given in the form vx.y.z-wwwww
214966d79e26SBarry Smith 
215066d79e26SBarry Smith     PETSC_VERSION_DATE_GIT is the date of the last git commit to the repository
215166d79e26SBarry Smith 
215266d79e26SBarry Smith     Level: intermediate
215366d79e26SBarry Smith 
215466d79e26SBarry Smith     PETSC_VERSION_() and PETSC_VERSION_PATCH are deprecated and will eventually be removed. For several releases PETSC_VERSION_PATCH is always 0
215566d79e26SBarry Smith 
215666d79e26SBarry Smith M*/
215766d79e26SBarry Smith 
215866d79e26SBarry Smith /*MC
215966d79e26SBarry Smith 
21601b266c99SBarry Smith     UsingFortran - To use PETSc with Fortran you must use both PETSc include files and modules. At the beginning
21611b266c99SBarry Smith       of every function and module definition you need something like
2162d382aafbSBarry Smith 
2163d382aafbSBarry Smith $
2164af0996ceSBarry Smith $#include "petsc/finclude/petscXXX.h"
21650f665fc7SPatrick Sanan $         use petscXXX
21661b266c99SBarry Smith 
2167692afcd8SPatrick Sanan      You can declare PETSc variables using either of the following.
21681b266c99SBarry Smith 
2169d382aafbSBarry Smith $    XXX variablename
21701b266c99SBarry Smith $    type(tXXX) variablename
21711b266c99SBarry Smith 
2172692afcd8SPatrick Sanan     For example,
21731b266c99SBarry Smith 
2174bfc4c25eSBarry Smith $#include "petsc/finclude/petscvec.h"
21751b266c99SBarry Smith $         use petscvec
2176d382aafbSBarry Smith $
2177692afcd8SPatrick Sanan $    Vec b
2178692afcd8SPatrick Sanan $    type(tVec) x
2179d382aafbSBarry Smith 
2180d382aafbSBarry Smith     Level: beginner
2181d382aafbSBarry Smith 
2182d382aafbSBarry Smith M*/
2183d382aafbSBarry Smith 
2184014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t);
2185014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t);
2186014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t);
2187014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t);
2188014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]);
2189014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t);
219027710113SBarry Smith PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t);
21915f309d01SBarry Smith PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt*,PetscInt*,PetscInt*,PetscInt*);
2192d382aafbSBarry Smith 
2193014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt,PetscInt[]);
219422ab5688SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscSortedRemoveDupsInt(PetscInt*,PetscInt[]);
2195014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt*,PetscInt[]);
219660e03357SMatthew G Knepley PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt*);
2197d2aeb606SJed Brown PETSC_EXTERN PetscErrorCode PetscFindMPIInt(PetscMPIInt, PetscInt, const PetscMPIInt[], PetscInt*);
2198014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]);
2199014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]);
2200014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]);
22016c2863d0SBarry Smith PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt,PetscInt[],PetscInt[],PetscInt[]);
220217d7d925SStefano Zampini PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt,PetscMPIInt[]);
220317d7d925SStefano Zampini PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt*,PetscMPIInt[]);
2204014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]);
2205014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]);
220617df18f2SToby Isaac PETSC_EXTERN PetscErrorCode PetscSortIntWithDataArray(PetscInt,PetscInt[],void*,size_t,void*);
2207014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt,PetscReal[]);
220839f41f7fSStefano Zampini PETSC_EXTERN PetscErrorCode PetscSortRealWithArrayInt(PetscInt,PetscReal[],PetscInt[]);
2209014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]);
2210745b41b2SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt*,PetscReal[]);
221139f41f7fSStefano Zampini PETSC_EXTERN PetscErrorCode PetscFindReal(PetscReal,PetscInt,const PetscReal[],PetscReal,PetscInt*);
2212014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]);
2213014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]);
2214014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt,const PetscBool [],const PetscInt[],PetscInt*,PetscInt**,PetscInt**,PetscInt**,PetscInt**);
22156c2863d0SBarry Smith PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt,const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],PetscInt*,PetscInt**,PetscInt**);
22166c2863d0SBarry Smith PETSC_EXTERN PetscErrorCode PetscMergeIntArray(PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt*,PetscInt**);
2217e498c390SJed Brown PETSC_EXTERN PetscErrorCode PetscMergeMPIIntArray(PetscInt,const PetscMPIInt[],PetscInt,const PetscMPIInt[],PetscInt*,PetscMPIInt**);
2218d382aafbSBarry Smith 
2219014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDisplay(void);
2220014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t);
2221d382aafbSBarry Smith 
222276bdecfbSBarry Smith /*J
2223d382aafbSBarry Smith     PetscRandomType - String with the name of a PETSc randomizer
2224d382aafbSBarry Smith 
2225d382aafbSBarry Smith    Level: beginner
2226d382aafbSBarry Smith 
2227e28ce29aSPatrick Sanan    Notes:
2228e28ce29aSPatrick Sanan    To use SPRNG or RANDOM123 you must have ./configure PETSc
222925ccb61fSToby Isaac    with the option --download-sprng or --download-random123
2230d382aafbSBarry Smith 
22318f6c3df8SBarry Smith .seealso: PetscRandomSetType(), PetscRandom, PetscRandomCreate()
223276bdecfbSBarry Smith J*/
223319fd82e9SBarry Smith typedef const char* PetscRandomType;
2234d382aafbSBarry Smith #define PETSCRAND       "rand"
2235d382aafbSBarry Smith #define PETSCRAND48     "rand48"
2236d382aafbSBarry Smith #define PETSCSPRNG      "sprng"
2237c5e4d11fSDmitry Karpeev #define PETSCRANDER48   "rander48"
223825ccb61fSToby Isaac #define PETSCRANDOM123  "random123"
2239d382aafbSBarry Smith 
2240d382aafbSBarry Smith /* Logging support */
2241014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID;
2242d382aafbSBarry Smith 
2243607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void);
2244d382aafbSBarry Smith 
2245d382aafbSBarry Smith /* Dynamic creation and loading functions */
2246140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList PetscRandomList;
2247d382aafbSBarry Smith 
2248bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],PetscErrorCode (*)(PetscRandom));
224919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType);
2250014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom);
225119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType*);
2252685405a1SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscRandomViewFromOptions(PetscRandom A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
2253014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer);
2254d382aafbSBarry Smith 
2255014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*);
2256014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*);
2257014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*);
2258014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*);
2259014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar);
2260014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long);
2261014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *);
2262014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom);
2263014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*);
2264d382aafbSBarry Smith 
2265014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t);
2266014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t);
2267014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t);
2268014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]);
2269014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t);
2270014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *);
2271014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *);
227297540f07SSatish Balay PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]);
227397540f07SSatish Balay PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]);
2274d382aafbSBarry Smith 
2275014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscDataType);
2276014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscDataType);
2277014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,void*,PetscInt,PetscDataType,PetscBool );
2278014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,void*,PetscInt,PetscDataType,PetscBool );
2279014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *);
2280014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryClose(int);
2281014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool  *);
2282014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool  *);
2283014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t);
2284014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *);
2285014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *);
2286c891a504SStefano Zampini #if defined(PETSC_USE_SOCKET_VIEWER)
2287e2fc02c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[],int,int*);
2288c891a504SStefano Zampini #endif
2289d382aafbSBarry Smith 
2290014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*);
2291014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*);
2292014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt);
2293d382aafbSBarry Smith 
2294014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]);
2295014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool );
2296014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void);
2297014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*);
2298014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void);
2299014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void);
2300d382aafbSBarry Smith 
2301014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*);
2302014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**);
2303014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**);
2304014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**);
2305014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**);
2306cf4b5b4fSJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt*,const void*,PetscMPIInt*,PetscMPIInt**,void*)
2307cf4b5b4fSJed Brown   PetscAttrMPIPointerWithType(6,3);
2308d815da10SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedF(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
2309d815da10SJed Brown                                                     PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
2310d815da10SJed Brown                                                     PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
2311d815da10SJed Brown   PetscAttrMPIPointerWithType(6,3);
23126afbe7ddSJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedFReq(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
23136afbe7ddSJed Brown                                                        MPI_Request**,MPI_Request**,
23146afbe7ddSJed Brown                                                        PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
23156afbe7ddSJed Brown                                                        PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
23166afbe7ddSJed Brown   PetscAttrMPIPointerWithType(6,3);
2317d382aafbSBarry Smith 
23186145cd65SJed Brown PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[];
23196145cd65SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm,PetscBuildTwoSidedType);
23206145cd65SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm,PetscBuildTwoSidedType*);
23216145cd65SJed Brown 
2322014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSSEIsEnabled(MPI_Comm,PetscBool*,PetscBool*);
2323d382aafbSBarry Smith 
2324ce94432eSBarry Smith PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject);
2325ce94432eSBarry Smith 
232645487dadSJed Brown PETSC_EXTERN const char *const PetscSubcommTypes[];
232745487dadSJed Brown 
2328d382aafbSBarry Smith struct _n_PetscSubcomm {
2329d382aafbSBarry Smith   MPI_Comm         parent;           /* parent communicator */
2330d382aafbSBarry Smith   MPI_Comm         dupparent;        /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */
2331306c2d5bSBarry Smith   MPI_Comm         child;            /* the sub-communicator */
233245487dadSJed Brown   PetscMPIInt      n;                /* num of subcommunicators under the parent communicator */
233345487dadSJed Brown   PetscMPIInt      color;            /* color of processors belong to this communicator */
2334708d824cSJed Brown   PetscMPIInt      *subsize;         /* size of subcommunicator[color] */
233545487dadSJed Brown   PetscSubcommType type;
2336e5acf8a4SHong Zhang   char             *subcommprefix;
2337d382aafbSBarry Smith };
2338d382aafbSBarry Smith 
2339c5e4d11fSDmitry Karpeev PETSC_STATIC_INLINE MPI_Comm PetscSubcommParent(PetscSubcomm scomm) {return scomm->parent;}
2340306c2d5bSBarry Smith PETSC_STATIC_INLINE MPI_Comm PetscSubcommChild(PetscSubcomm scomm) {return scomm->child;}
234136be1a5eSBarry Smith PETSC_STATIC_INLINE MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm) {return scomm->dupparent;}
2342014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*);
2343014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*);
2344014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt);
2345014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType);
234665d9b8f1SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt);
2347053d1c95SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm,PetscViewer);
2348f68be91cSHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm);
2349e5acf8a4SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm,const char[]);
2350d382aafbSBarry Smith 
23519962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapCreate(PetscInt,PetscHeap*);
23529962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapAdd(PetscHeap,PetscInt,PetscInt);
23539962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapPop(PetscHeap,PetscInt*,PetscInt*);
23549962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapPeek(PetscHeap,PetscInt*,PetscInt*);
23559962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapStash(PetscHeap,PetscInt,PetscInt);
23569962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapUnstash(PetscHeap);
23579962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapDestroy(PetscHeap*);
23589962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapView(PetscHeap,PetscViewer);
23599962606eSBarry Smith 
23605e71baefSBarry Smith PETSC_EXTERN PetscErrorCode PetscProcessPlacementView(PetscViewer);
23615f7487a0SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscShmCommGet(MPI_Comm,PetscShmComm*);
23625f7487a0SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscShmCommGlobalToLocal(PetscShmComm,PetscMPIInt,PetscMPIInt*);
23635f7487a0SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscShmCommLocalToGlobal(PetscShmComm,PetscMPIInt,PetscMPIInt*);
23645f7487a0SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscShmCommGetMpiShmComm(PetscShmComm,MPI_Comm*);
23655e71baefSBarry Smith 
2366a32e93adSJunchao Zhang /* routines to better support OpenMP multithreading needs of some PETSc third party libraries */
2367a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlCreate(MPI_Comm,PetscInt,PetscOmpCtrl*);
2368a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlGetOmpComms(PetscOmpCtrl,MPI_Comm*,MPI_Comm*,PetscBool*);
2369a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlDestroy(PetscOmpCtrl*);
2370a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlBarrier(PetscOmpCtrl);
2371a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterBegin(PetscOmpCtrl);
2372a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterEnd(PetscOmpCtrl);
2373a32e93adSJunchao Zhang 
237413e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t,size_t,PetscSegBuffer*);
23750f453b92SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer*);
237613e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer,size_t,void*);
2377137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer,void*);
2378137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer,void*);
2379137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer,void*);
238013e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer,size_t*);
238113e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer,size_t);
23820f453b92SJed Brown 
23835e71baefSBarry Smith 
2384471ecdacSJed Brown /* Type-safe wrapper to encourage use of PETSC_RESTRICT. Does not use PetscFunctionBegin because the error handling
2385471ecdacSJed Brown  * prevents the compiler from completely erasing the stub. This is called in inner loops so it has to be as fast as
2386471ecdacSJed Brown  * possible. */
238735005c2bSLisandro Dalcin PETSC_STATIC_INLINE PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg,PetscInt count,PetscInt *PETSC_RESTRICT *slot) {return PetscSegBufferGet(seg,(size_t)count,(void**)slot);}
2388d382aafbSBarry Smith 
23899de0f6ecSBarry Smith extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton;
23909de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted*);
23919de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted*);
23929de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted,const char*,const char*,PetscBool*);
23939de0f6ecSBarry Smith 
2394ace2fbaeSBarry Smith #include <stdarg.h>
2395ace2fbaeSBarry Smith PETSC_EXTERN PetscErrorCode PetscVSNPrintf(char*,size_t,const char[],size_t*,va_list);
2396ace2fbaeSBarry Smith PETSC_EXTERN PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list);
2397ace2fbaeSBarry Smith 
2398268b0dfdSSatish Balay PETSC_EXTERN PetscSegBuffer PetscCitationsList;
2399fbfcfee5SBarry Smith 
24001f817a21SBarry Smith /*@C
24011f817a21SBarry Smith       PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used in the code.
24021f817a21SBarry Smith 
24031f817a21SBarry Smith      Not Collective - only what is registered on rank 0 of PETSC_COMM_WORLD will be printed
24041f817a21SBarry Smith 
24051f817a21SBarry Smith      Input Parameters:
24061f817a21SBarry Smith +      cite - the bibtex item, formated to displayed on multiple lines nicely
24071f817a21SBarry Smith -      set - a boolean variable initially set to PETSC_FALSE; this is used to insure only a single registration of the citation
24081f817a21SBarry Smith 
2409850545d0SSatish Balay    Level: intermediate
2410850545d0SSatish Balay 
2411f5f57ec0SBarry Smith    Not available from Fortran
2412f5f57ec0SBarry Smith 
24131f817a21SBarry Smith      Options Database:
2414063414e0SPatrick Sanan .     -citations [filename]   - print out the bibtex entries for the given computation
24151f817a21SBarry Smith @*/
2416dff31646SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscCitationsRegister(const char cit[],PetscBool *set)
2417dff31646SBarry Smith {
2418dff31646SBarry Smith   size_t         len;
2419dff31646SBarry Smith   char           *vstring;
2420dff31646SBarry Smith   PetscErrorCode ierr;
2421dff31646SBarry Smith 
24221f817a21SBarry Smith   PetscFunctionBegin;
24238d3683fcSBarry Smith   if (set && *set) PetscFunctionReturn(0);
2424dff31646SBarry Smith   ierr = PetscStrlen(cit,&len);CHKERRQ(ierr);
242535005c2bSLisandro Dalcin   ierr = PetscSegBufferGet(PetscCitationsList,len,&vstring);CHKERRQ(ierr);
2426dff31646SBarry Smith   ierr = PetscMemcpy(vstring,cit,len);CHKERRQ(ierr);
2427dff31646SBarry Smith   if (set) *set = PETSC_TRUE;
24281f817a21SBarry Smith   PetscFunctionReturn(0);
2429dff31646SBarry Smith }
2430dff31646SBarry Smith 
2431b967cddfSBarry Smith PETSC_EXTERN PetscErrorCode PetscURLShorten(const char[],char[],size_t);
2432fe278a28SBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm,char[],char[],size_t);
2433fe278a28SBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm,const char[],char[],size_t);
2434f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm,const char[],const char []);
2435fe278a28SBarry Smith 
2436f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm,char[],char[],size_t);
2437f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm,const char[],char[],char[],size_t);
2438b967cddfSBarry Smith 
24399f4d3c52SBarry Smith PETSC_EXTERN PetscErrorCode PetscGlobusGetTransfers(MPI_Comm,const char[],char[],size_t);
24409f4d3c52SBarry Smith 
244104102261SBarry Smith PETSC_EXTERN PetscErrorCode PetscTextBelt(MPI_Comm,const char[],const char[],PetscBool*);
2442763ec7b1SBarry Smith PETSC_EXTERN PetscErrorCode PetscTellMyCell(MPI_Comm,const char[],const char[],PetscBool*);
2443dff31646SBarry Smith 
244468e69593SBarry Smith PETSC_EXTERN PetscErrorCode PetscPullJSONValue(const char[],const char[],char[],size_t,PetscBool*);
24455dc0f0a4SBarry Smith PETSC_EXTERN PetscErrorCode PetscPushJSONValue(char[],const char[],const char[],size_t);
2446d382aafbSBarry Smith 
2447b2566f29SBarry Smith 
2448b2566f29SBarry Smith #if defined(PETSC_USE_DEBUG)
2449b2566f29SBarry Smith /*
2450b2566f29SBarry Smith    Verify that all processes in the communicator have called this from the same line of code
2451b2566f29SBarry Smith  */
24528f5db7efSBarry Smith PETSC_EXTERN PetscErrorCode PetscAllreduceBarrierCheck(MPI_Comm,PetscMPIInt,int,const char*,const char *);
245377a5e07dSBarry Smith 
245477a5e07dSBarry Smith /*MC
245577a5e07dSBarry Smith    MPIU_Allreduce - a PETSc replacement for MPI_Allreduce() that tries to determine if the call from all the MPI processes occur from the
245677a5e07dSBarry Smith                     same place in the PETSc code. This helps to detect bugs where different MPI processes follow different code paths
245777a5e07dSBarry Smith                     resulting in inconsistent and incorrect calls to MPI_Allreduce().
245877a5e07dSBarry Smith 
245977a5e07dSBarry Smith    Collective on MPI_Comm
246077a5e07dSBarry Smith 
246177a5e07dSBarry Smith    Synopsis:
246277a5e07dSBarry Smith      #include <petscsys.h>
246377a5e07dSBarry Smith      PetscErrorCode MPIU_Allreduce(void *indata,void *outdata,PetscMPIInt count,MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);
246477a5e07dSBarry Smith 
246577a5e07dSBarry Smith    Input Parameters:
246677a5e07dSBarry Smith +  indata - pointer to the input data to be reduced
246777a5e07dSBarry Smith .  count - the number of MPI data items in indata and outdata
246877a5e07dSBarry Smith .  datatype - the MPI datatype, for example MPI_INT
246977a5e07dSBarry Smith .  op - the MPI operation, for example MPI_SUM
247077a5e07dSBarry Smith -  comm - the MPI communicator on which the operation occurs
247177a5e07dSBarry Smith 
247277a5e07dSBarry Smith    Output Parameter:
247377a5e07dSBarry Smith .  outdata - the reduced values
247477a5e07dSBarry Smith 
2475e28ce29aSPatrick Sanan    Notes:
2476e28ce29aSPatrick Sanan    In optimized mode this directly calls MPI_Allreduce()
247777a5e07dSBarry Smith 
247877a5e07dSBarry Smith    Level: developer
247977a5e07dSBarry Smith 
248077a5e07dSBarry Smith .seealso: MPI_Allreduce()
248177a5e07dSBarry Smith M*/
2482fbfcfee5SBarry Smith #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))
2483b2566f29SBarry Smith #else
2484b2566f29SBarry Smith #define MPIU_Allreduce(a,b,c,d,e,fcomm) MPI_Allreduce(a,b,c,d,e,fcomm)
2485b2566f29SBarry Smith #endif
2486b2566f29SBarry Smith 
24876f7079ddSSatish Balay #if defined(PETSC_HAVE_MPI_WIN_CREATE_FEATURE)
24888198064fSBarry Smith PETSC_EXTERN PetscErrorCode MPIU_Win_allocate_shared(MPI_Aint,PetscMPIInt,MPI_Info,MPI_Comm,void*,MPI_Win*);
24898198064fSBarry Smith PETSC_EXTERN PetscErrorCode MPIU_Win_shared_query(MPI_Win,PetscMPIInt,MPI_Aint*,PetscMPIInt*,void*);
24902f065d89SBarry Smith #endif
24918198064fSBarry Smith 
249212801b39SBarry Smith /*
249312801b39SBarry Smith     Returned from PETSc functions that are called from MPI, such as related to attributes
249412801b39SBarry Smith */
24958ba48ad5SSatish Balay PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CLASS;
24968ba48ad5SSatish Balay PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CODE;
249712801b39SBarry Smith 
2498d382aafbSBarry Smith #endif
2499