xref: /petsc/include/petscsys.h (revision 5f309d014d30c8e30ef8d484fee079cd79b2cbfc)
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 
36d382aafbSBarry Smith /* ========================================================================== */
37d382aafbSBarry Smith /*
382c280183SJed Brown    This facilitates using the C version of PETSc from C++ and the C++ version from C.
39d382aafbSBarry Smith */
401ec50b02SJed Brown #if defined(__cplusplus)
411ec50b02SJed Brown #  define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_CXX
421ec50b02SJed Brown #else
431ec50b02SJed Brown #  define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_C
441ec50b02SJed Brown #endif
45d382aafbSBarry Smith 
46c5e4d11fSDmitry Karpeev /* ========================================================================== */
47c5e4d11fSDmitry Karpeev /*
48c5e4d11fSDmitry Karpeev    Since PETSc manages its own extern "C" handling users should never include PETSc include
491cc8b206SBarry Smith    files within extern "C". This will generate a compiler error if a user does put the include
501cc8b206SBarry Smith    file within an extern "C".
51c5e4d11fSDmitry Karpeev */
52c5e4d11fSDmitry Karpeev #if defined(__cplusplus)
53c5e4d11fSDmitry Karpeev void assert_never_put_petsc_headers_inside_an_extern_c(int); void assert_never_put_petsc_headers_inside_an_extern_c(double);
54c5e4d11fSDmitry Karpeev #endif
55c5e4d11fSDmitry Karpeev 
56ed938b00SJed Brown #if defined(__cplusplus)
57ed938b00SJed Brown #  define PETSC_RESTRICT PETSC_CXX_RESTRICT
58ed938b00SJed Brown #else
59ed938b00SJed Brown #  define PETSC_RESTRICT PETSC_C_RESTRICT
60ed938b00SJed Brown #endif
61ed938b00SJed Brown 
62ed938b00SJed Brown #if defined(__cplusplus)
63ed938b00SJed Brown #  define PETSC_STATIC_INLINE PETSC_CXX_STATIC_INLINE
64ed938b00SJed Brown #else
65ed938b00SJed Brown #  define PETSC_STATIC_INLINE PETSC_C_STATIC_INLINE
66ed938b00SJed Brown #endif
67ed938b00SJed Brown 
68ab699e31SSatish Balay #if defined(_WIN32) && defined(PETSC_USE_SHARED_LIBRARIES) /* For Win32 shared libraries */
69014dd563SJed Brown #  define PETSC_DLLEXPORT __declspec(dllexport)
70014dd563SJed Brown #  define PETSC_DLLIMPORT __declspec(dllimport)
7121f66b81SJed Brown #  define PETSC_VISIBILITY_INTERNAL
7226703958SBarry Smith #elif defined(PETSC_USE_VISIBILITY_CXX) && defined(__cplusplus)
7326703958SBarry Smith #  define PETSC_DLLEXPORT __attribute__((visibility ("default")))
7426703958SBarry Smith #  define PETSC_DLLIMPORT __attribute__((visibility ("default")))
7526703958SBarry Smith #  define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden")))
7626703958SBarry Smith #elif defined(PETSC_USE_VISIBILITY_C) && !defined(__cplusplus)
77014dd563SJed Brown #  define PETSC_DLLEXPORT __attribute__((visibility ("default")))
78014dd563SJed Brown #  define PETSC_DLLIMPORT __attribute__((visibility ("default")))
7921f66b81SJed Brown #  define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden")))
80d382aafbSBarry Smith #else
81014dd563SJed Brown #  define PETSC_DLLEXPORT
82014dd563SJed Brown #  define PETSC_DLLIMPORT
8321f66b81SJed Brown #  define PETSC_VISIBILITY_INTERNAL
84014dd563SJed Brown #endif
85014dd563SJed Brown 
86014dd563SJed Brown #if defined(petsc_EXPORTS)      /* CMake defines this when building the shared library */
87014dd563SJed Brown #  define PETSC_VISIBILITY_PUBLIC PETSC_DLLEXPORT
88014dd563SJed Brown #else  /* Win32 users need this to import symbols from petsc.dll */
89014dd563SJed Brown #  define PETSC_VISIBILITY_PUBLIC PETSC_DLLIMPORT
90014dd563SJed Brown #endif
91014dd563SJed Brown 
921cc8b206SBarry Smith /*
931cc8b206SBarry Smith     Functions tagged with PETSC_EXTERN in the header files are
941cc8b206SBarry Smith   always defined as extern "C" when compiled with C++ so they may be
951cc8b206SBarry Smith   used from C and are always visible in the shared libraries
961cc8b206SBarry Smith */
972c280183SJed Brown #if defined(__cplusplus)
98014dd563SJed Brown #define PETSC_EXTERN extern "C" PETSC_VISIBILITY_PUBLIC
99638cfed1SJed Brown #define PETSC_EXTERN_TYPEDEF extern "C"
10021f66b81SJed Brown #define PETSC_INTERN extern "C" PETSC_VISIBILITY_INTERNAL
101014dd563SJed Brown #else
102014dd563SJed Brown #define PETSC_EXTERN extern PETSC_VISIBILITY_PUBLIC
103638cfed1SJed Brown #define PETSC_EXTERN_TYPEDEF
1046258c452SJed Brown #define PETSC_INTERN extern PETSC_VISIBILITY_INTERNAL
105d382aafbSBarry Smith #endif
10627710113SBarry Smith 
1072c8e378dSBarry Smith #include <petscversion.h>
108301d30feSBarry Smith #define PETSC_AUTHOR_INFO  "       The PETSc Team\n    petsc-maint@mcs.anl.gov\n http://www.mcs.anl.gov/petsc/\n"
109d382aafbSBarry Smith 
110d382aafbSBarry Smith /* ========================================================================== */
111d382aafbSBarry Smith 
112d382aafbSBarry Smith /*
113d382aafbSBarry Smith     Defines the interface to MPI allowing the use of all MPI functions.
114d382aafbSBarry Smith 
115d382aafbSBarry Smith     PETSc does not use the C++ binding of MPI at ALL. The following flag
116d382aafbSBarry Smith     makes sure the C++ bindings are not included. The C++ bindings REQUIRE
117d382aafbSBarry Smith     putting mpi.h before ANY C++ include files, we cannot control this
118d382aafbSBarry Smith     with all PETSc users. Users who want to use the MPI C++ bindings can include
119d382aafbSBarry Smith     mpicxx.h directly in their code
120d382aafbSBarry Smith */
121fa9e63e2SJed Brown #if !defined(MPICH_SKIP_MPICXX)
122d382aafbSBarry Smith #  define MPICH_SKIP_MPICXX 1
123fa9e63e2SJed Brown #endif
124fa9e63e2SJed Brown #if !defined(OMPI_SKIP_MPICXX)
125d382aafbSBarry Smith #  define OMPI_SKIP_MPICXX 1
126fa9e63e2SJed Brown #endif
127076e11b5SSatish Balay #if !defined(OMPI_WANT_MPI_INTERFACE_WARNING)
128076e11b5SSatish Balay #  define OMPI_WANT_MPI_INTERFACE_WARNING 0
129076e11b5SSatish Balay #endif
1302c8e378dSBarry Smith #include <mpi.h>
13165013866SBarry Smith 
132d382aafbSBarry Smith /*
133a7886beaSBarry Smith    Perform various sanity checks that the correct mpi.h is being included at compile time.
134a7886beaSBarry Smith    This usually happens because
135a7886beaSBarry Smith       * either an unexpected mpi.h is in the default compiler path (i.e. in /usr/include) or
136a7886beaSBarry Smith       * an extra include path -I/something (which contains the unexpected mpi.h) is being passed to the compiler
137a7886beaSBarry Smith */
138a7886beaSBarry Smith #if defined(PETSC_HAVE_MPIUNI)
139a7886beaSBarry Smith #  if !defined(__MPIUNI_H)
140a7886beaSBarry Smith #    error "PETSc was configured with --with-mpi=0 but now appears to be compiling using a different mpi.h"
141a7886beaSBarry Smith #  endif
142a7886beaSBarry Smith #elif defined(PETSC_HAVE_MPICH_NUMVERSION)
143a7886beaSBarry Smith #  if !defined(MPICH_NUMVERSION)
144a7886beaSBarry Smith #    error "PETSc was configured with MPICH but now appears to be compiling using a non-MPICH mpi.h"
145a7886beaSBarry Smith #  elif MPICH_NUMVERSION != PETSC_HAVE_MPICH_NUMVERSION
146a7886beaSBarry Smith #    error "PETSc was configured with one MPICH mpi.h version but now appears to be compiling using a different MPICH mpi.h version"
147a7886beaSBarry Smith #  endif
148a7886beaSBarry Smith #elif defined(PETSC_HAVE_OMPI_MAJOR_VERSION)
149a7886beaSBarry Smith #  if !defined(OMPI_MAJOR_VERSION)
150a7886beaSBarry Smith #    error "PETSc was configured with OpenMPI but now appears to be compiling using a non-OpenMPI mpi.h"
151c3ac57cfSSatish Balay #  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)
152c3ac57cfSSatish Balay #    error "PETSc was configured with one OpenMPI mpi.h version but now appears to be compiling using a different OpenMPI mpi.h version"
153a7886beaSBarry Smith #  endif
154a7886beaSBarry Smith #endif
155a7886beaSBarry Smith 
156a7886beaSBarry Smith /*
1572981ebdbSBarry Smith     Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler
158d382aafbSBarry Smith     see the top of mpicxx.h in the MPICH2 distribution.
159d382aafbSBarry Smith */
160d382aafbSBarry Smith #include <stdio.h>
161d382aafbSBarry Smith 
162d382aafbSBarry Smith /* MSMPI on 32bit windows requires this yukky hack - that breaks MPI standard compliance */
163d382aafbSBarry Smith #if !defined(MPIAPI)
164d382aafbSBarry Smith #define MPIAPI
165d382aafbSBarry Smith #endif
166d382aafbSBarry Smith 
1671cc8b206SBarry Smith /*
1681cc8b206SBarry Smith    Support for Clang (>=3.2) matching type tag arguments with void* buffer types.
1691cc8b206SBarry Smith    This allows the compiler to detect cases where the MPI datatype argument passed to a MPI routine
1701cc8b206SBarry Smith    does not match the actual type of the argument being passed in
1711cc8b206SBarry Smith */
172c5e4d11fSDmitry Karpeev #if defined(__has_attribute) && defined(works_with_const_which_is_not_true)
173894dd566SJed Brown #  if __has_attribute(argument_with_type_tag) && __has_attribute(pointer_with_type_tag) && __has_attribute(type_tag_for_datatype)
174894dd566SJed Brown #    define PetscAttrMPIPointerWithType(bufno,typeno) __attribute__((pointer_with_type_tag(MPI,bufno,typeno)))
1758ad47952SJed Brown #    define PetscAttrMPITypeTag(type)                 __attribute__((type_tag_for_datatype(MPI,type)))
1768ad47952SJed Brown #    define PetscAttrMPITypeTagLayoutCompatible(type) __attribute__((type_tag_for_datatype(MPI,type,layout_compatible)))
177894dd566SJed Brown #  endif
178894dd566SJed Brown #endif
179894dd566SJed Brown #if !defined(PetscAttrMPIPointerWithType)
180894dd566SJed Brown #  define PetscAttrMPIPointerWithType(bufno,typeno)
1818ad47952SJed Brown #  define PetscAttrMPITypeTag(type)
1828ad47952SJed Brown #  define PetscAttrMPITypeTagLayoutCompatible(type)
183894dd566SJed Brown #endif
184b3506946SBarry Smith 
185d382aafbSBarry Smith /*MC
1861957e957SBarry Smith     PetscErrorCode - datatype used for return error code from almost all PETSc functions
187d382aafbSBarry Smith 
188d382aafbSBarry Smith     Level: beginner
189d382aafbSBarry Smith 
190d382aafbSBarry Smith .seealso: CHKERRQ, SETERRQ
191d382aafbSBarry Smith M*/
192d382aafbSBarry Smith typedef int PetscErrorCode;
193d382aafbSBarry Smith 
194d382aafbSBarry Smith /*MC
195d382aafbSBarry Smith 
196503cfb0cSBarry Smith     PetscClassId - A unique id used to identify each PETSc class.
197d382aafbSBarry Smith 
1981957e957SBarry Smith     Notes: Use PetscClassIdRegister() to obtain a new value for a new class being created. Usually
1991957e957SBarry Smith          XXXInitializePackage() calls it for each class it defines.
2001957e957SBarry Smith 
2011957e957SBarry Smith     Developer Notes: Internal integer stored in the _p_PetscObject data structure.
2021957e957SBarry Smith          These are all computed by an offset from the lowest one, PETSC_SMALLEST_CLASSID.
2031957e957SBarry Smith 
2041957e957SBarry Smith     Level: developer
205d382aafbSBarry Smith 
2060700a824SBarry Smith .seealso: PetscClassIdRegister(), PetscLogEventRegister(), PetscHeaderCreate()
207d382aafbSBarry Smith M*/
2080700a824SBarry Smith typedef int PetscClassId;
209d382aafbSBarry Smith 
210d382aafbSBarry Smith 
211d382aafbSBarry Smith /*MC
212d382aafbSBarry Smith     PetscMPIInt - datatype used to represent 'int' parameters to MPI functions.
213d382aafbSBarry Smith 
214d382aafbSBarry Smith     Level: intermediate
215d382aafbSBarry Smith 
216d382aafbSBarry Smith     Notes: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but
2173b2a8c54SBarry Smith            standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt it remains 32 bit
218d382aafbSBarry Smith 
2194dc2109aSBarry Smith     PetscMPIIntCast(a,&b) checks if the given PetscInt a will fit in a PetscMPIInt, if not it
2202981ebdbSBarry Smith       generates a PETSC_ERR_ARG_OUTOFRANGE error.
221d382aafbSBarry Smith 
2221cc8b206SBarry Smith .seealso: PetscBLASInt, PetscInt, PetscMPIIntCast()
223d382aafbSBarry Smith 
224d382aafbSBarry Smith M*/
225d382aafbSBarry Smith typedef int PetscMPIInt;
226d382aafbSBarry Smith 
227d382aafbSBarry Smith /*MC
228d382aafbSBarry Smith     PetscEnum - datatype used to pass enum types within PETSc functions.
229d382aafbSBarry Smith 
230d382aafbSBarry Smith     Level: intermediate
231d382aafbSBarry Smith 
232d382aafbSBarry Smith .seealso: PetscOptionsGetEnum(), PetscOptionsEnum(), PetscBagRegisterEnum()
233d382aafbSBarry Smith M*/
234d382aafbSBarry Smith typedef enum { ENUM_DUMMY } PetscEnum;
2355a576424SJed Brown PETSC_EXTERN MPI_Datatype MPIU_ENUM PetscAttrMPITypeTag(PetscEnum);
236d382aafbSBarry Smith 
237fab38c73SJed Brown #if defined(PETSC_HAVE_STDINT_H)
238fab38c73SJed Brown #include <stdint.h>
239fab38c73SJed Brown #endif
240a05e1a72SSatish Balay #if defined (PETSC_HAVE_INTTYPES_H)
24113e758fdSSatish Balay #define __STDC_FORMAT_MACROS /* required for using PRId64 from c++ */
242a05e1a72SSatish Balay #include <inttypes.h>
24337354ed4SSatish Balay # if !defined(PRId64)
24437354ed4SSatish Balay # define PRId64 "ld"
24537354ed4SSatish Balay # endif
246a05e1a72SSatish Balay #endif
247fab38c73SJed Brown 
24899a4b90dSDave May typedef short PetscShort;
24999a4b90dSDave May typedef char PetscChar;
25099a4b90dSDave May typedef float PetscFloat;
25199a4b90dSDave May 
252d382aafbSBarry Smith /*MC
253d382aafbSBarry Smith     PetscInt - PETSc type that represents integer - used primarily to
2543b2a8c54SBarry Smith       represent size of arrays and indexing into arrays. Its size can be configured with the option
255d382aafbSBarry Smith       --with-64-bit-indices - to be either 32bit or 64bit [default 32 bit ints]
256d382aafbSBarry Smith 
257d382aafbSBarry Smith    Level: intermediate
258d382aafbSBarry Smith 
259d382aafbSBarry Smith .seealso: PetscScalar, PetscBLASInt, PetscMPIInt
260d382aafbSBarry Smith M*/
26137354ed4SSatish 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 */
262bafee8b4SSatish Balay typedef int64_t PetscInt64;
263bd84f1cfSSatish Balay # define MPIU_INT64 MPI_INT64_T
264a05e1a72SSatish Balay # define PetscInt64_FMT PRId64
265fab38c73SJed Brown #elif (PETSC_SIZEOF_LONG_LONG == 8)
266bafee8b4SSatish Balay typedef long long PetscInt64;
267bd84f1cfSSatish Balay # define MPIU_INT64 MPI_LONG_LONG_INT
268a05e1a72SSatish Balay # define PetscInt64_FMT "lld"
269f505b413SSatish Balay #elif defined(PETSC_HAVE___INT64)
270bafee8b4SSatish Balay typedef __int64 PetscInt64;
271bd84f1cfSSatish Balay # define MPIU_INT64 MPI_INT64_T
272a05e1a72SSatish Balay # define PetscInt64_FMT "ld"
273236ed0a3SSatish Balay #else
274bafee8b4SSatish Balay #error "cannot determine PetscInt64 type"
275236ed0a3SSatish Balay #endif
276d382aafbSBarry Smith #if defined(PETSC_USE_64BIT_INDICES)
277bafee8b4SSatish Balay typedef PetscInt64 PetscInt;
278bd84f1cfSSatish Balay #define MPIU_INT MPIU_INT64
279a05e1a72SSatish Balay #define PetscInt_FMT PetscInt64_FMT
280d382aafbSBarry Smith #else
281d382aafbSBarry Smith typedef int PetscInt;
282d382aafbSBarry Smith #define MPIU_INT MPI_INT
283a05e1a72SSatish Balay #define PetscInt_FMT "d"
284d382aafbSBarry Smith #endif
285d382aafbSBarry Smith 
286702bc34aSSatish Balay /*MC
287702bc34aSSatish Balay     PetscBLASInt - datatype used to represent 'int' parameters to BLAS/LAPACK functions.
288702bc34aSSatish Balay 
289702bc34aSSatish Balay     Level: intermediate
290702bc34aSSatish Balay 
291702bc34aSSatish Balay     Notes: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but
292702bc34aSSatish Balay            standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt it remains 32 bit
293702bc34aSSatish Balay            (except on very rare BLAS/LAPACK implementations that support 64 bit integers see the note below).
294702bc34aSSatish Balay 
295c5df96a5SBarry Smith     PetscErrorCode PetscBLASIntCast(a,&b) checks if the given PetscInt a will fit in a PetscBLASInt, if not it
2962981ebdbSBarry Smith       generates a PETSC_ERR_ARG_OUTOFRANGE error
297702bc34aSSatish Balay 
2982981ebdbSBarry Smith     Installation Notes: The 64bit versions of MATLAB ship with BLAS and LAPACK that use 64 bit integers for sizes etc,
299702bc34aSSatish Balay      if you run ./configure with the option
300702bc34aSSatish Balay      --with-blas-lapack-lib=[/Applications/MATLAB_R2010b.app/bin/maci64/libmwblas.dylib,/Applications/MATLAB_R2010b.app/bin/maci64/libmwlapack.dylib]
3012981ebdbSBarry Smith      but you need to also use --known-64-bit-blas-indices.
3022981ebdbSBarry Smith 
3032981ebdbSBarry Smith         MKL also ships with 64 bit integer versions of the BLAS and LAPACK, if you select those you must also ./configure with --known-64-bit-blas-indices
3042981ebdbSBarry Smith 
3052981ebdbSBarry Smith      Developer Notes: Eventually ./configure should automatically determine the size of the integers used by BLAS/LAPACK.
306702bc34aSSatish Balay 
307702bc34aSSatish Balay      External packages such as hypre, ML, SuperLU etc do not provide any support for passing 64 bit integers to BLAS/LAPACK so cannot
308702bc34aSSatish Balay      be used with PETSc if you have set PetscBLASInt to long int.
309702bc34aSSatish Balay 
3101cc8b206SBarry Smith .seealso: PetscMPIInt, PetscInt, PetscBLASIntCast()
311702bc34aSSatish Balay 
312702bc34aSSatish Balay M*/
313702bc34aSSatish Balay #if defined(PETSC_HAVE_64BIT_BLAS_INDICES)
314bafee8b4SSatish Balay typedef PetscInt64 PetscBLASInt;
315702bc34aSSatish Balay #else
316702bc34aSSatish Balay typedef int PetscBLASInt;
317702bc34aSSatish Balay #endif
318702bc34aSSatish Balay 
31958b60935SBarry Smith /*EC
32058b60935SBarry Smith 
3212981ebdbSBarry Smith     PetscPrecision - indicates what precision the object is using. This is currently not used.
32258b60935SBarry Smith 
32358b60935SBarry Smith     Level: advanced
32458b60935SBarry Smith 
32558b60935SBarry Smith .seealso: PetscObjectSetPrecision()
32658b60935SBarry Smith E*/
32758b60935SBarry Smith typedef enum { PETSC_PRECISION_SINGLE=4,PETSC_PRECISION_DOUBLE=8 } PetscPrecision;
328014dd563SJed Brown PETSC_EXTERN const char *PetscPrecisions[];
32958b60935SBarry Smith 
330503cfb0cSBarry Smith /*
331503cfb0cSBarry Smith     For the rare cases when one needs to send a size_t object with MPI
332503cfb0cSBarry Smith */
333d382aafbSBarry Smith #if (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_INT)
334adcec1e5SJed Brown #define MPIU_SIZE_T MPI_UNSIGNED
335d382aafbSBarry Smith #elif  (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG)
336adcec1e5SJed Brown #define MPIU_SIZE_T MPI_UNSIGNED_LONG
337d382aafbSBarry Smith #elif  (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG_LONG)
338adcec1e5SJed Brown #define MPIU_SIZE_T MPI_UNSIGNED_LONG_LONG
339d382aafbSBarry Smith #else
340d382aafbSBarry Smith #error "Unknown size for size_t! Send us a bugreport at petsc-maint@mcs.anl.gov"
341d382aafbSBarry Smith #endif
342d382aafbSBarry Smith 
343d382aafbSBarry Smith /*
344d382aafbSBarry Smith       You can use PETSC_STDOUT as a replacement of stdout. You can also change
345d382aafbSBarry Smith     the value of PETSC_STDOUT to redirect all standard output elsewhere
346d382aafbSBarry Smith */
347014dd563SJed Brown PETSC_EXTERN FILE* PETSC_STDOUT;
348d382aafbSBarry Smith 
349d382aafbSBarry Smith /*
350d382aafbSBarry Smith       You can use PETSC_STDERR as a replacement of stderr. You can also change
351d382aafbSBarry Smith     the value of PETSC_STDERR to redirect all standard error elsewhere
352d382aafbSBarry Smith */
353014dd563SJed Brown PETSC_EXTERN FILE* PETSC_STDERR;
354d382aafbSBarry Smith 
355d382aafbSBarry Smith /*MC
356d382aafbSBarry Smith     PetscUnlikely - hints the compiler that the given condition is usually FALSE
357d382aafbSBarry Smith 
358d382aafbSBarry Smith     Synopsis:
359aaa7dc30SBarry Smith     #include <petscsys.h>
360ace3abfcSBarry Smith     PetscBool  PetscUnlikely(PetscBool  cond)
361d382aafbSBarry Smith 
362eca87e8dSBarry Smith     Not Collective
363eca87e8dSBarry Smith 
364d382aafbSBarry Smith     Input Parameters:
365d382aafbSBarry Smith .   cond - condition or expression
366d382aafbSBarry Smith 
367d382aafbSBarry Smith     Note: This returns the same truth value, it is only a hint to compilers that the resulting
368d382aafbSBarry Smith     branch is unlikely.
369d382aafbSBarry Smith 
370d382aafbSBarry Smith     Level: advanced
371d382aafbSBarry Smith 
372d382aafbSBarry Smith .seealso: PetscLikely(), CHKERRQ
373d382aafbSBarry Smith M*/
374d382aafbSBarry Smith 
375d382aafbSBarry Smith /*MC
376d382aafbSBarry Smith     PetscLikely - hints the compiler that the given condition is usually TRUE
377d382aafbSBarry Smith 
378d382aafbSBarry Smith     Synopsis:
379aaa7dc30SBarry Smith     #include <petscsys.h>
380ace3abfcSBarry Smith     PetscBool  PetscUnlikely(PetscBool  cond)
381d382aafbSBarry Smith 
382eca87e8dSBarry Smith     Not Collective
383eca87e8dSBarry Smith 
384d382aafbSBarry Smith     Input Parameters:
385d382aafbSBarry Smith .   cond - condition or expression
386d382aafbSBarry Smith 
387d382aafbSBarry Smith     Note: This returns the same truth value, it is only a hint to compilers that the resulting
388d382aafbSBarry Smith     branch is likely.
389d382aafbSBarry Smith 
390d382aafbSBarry Smith     Level: advanced
391d382aafbSBarry Smith 
392d382aafbSBarry Smith .seealso: PetscUnlikely()
393d382aafbSBarry Smith M*/
394d382aafbSBarry Smith #if defined(PETSC_HAVE_BUILTIN_EXPECT)
395d382aafbSBarry Smith #  define PetscUnlikely(cond)   __builtin_expect(!!(cond),0)
396d382aafbSBarry Smith #  define PetscLikely(cond)     __builtin_expect(!!(cond),1)
397d382aafbSBarry Smith #else
398cd3f4ce9SJed Brown #  define PetscUnlikely(cond)   (cond)
399cd3f4ce9SJed Brown #  define PetscLikely(cond)     (cond)
400d382aafbSBarry Smith #endif
401d382aafbSBarry Smith 
402d382aafbSBarry Smith /*
403d382aafbSBarry Smith     Declare extern C stuff after including external header files
404d382aafbSBarry Smith */
405d382aafbSBarry Smith 
406d382aafbSBarry Smith 
407d382aafbSBarry Smith /*
408d382aafbSBarry Smith        Basic PETSc constants
409d382aafbSBarry Smith */
410d382aafbSBarry Smith 
411d382aafbSBarry Smith /*E
412ace3abfcSBarry Smith     PetscBool  - Logical variable. Actually an int in C and a logical in Fortran.
413d382aafbSBarry Smith 
414d382aafbSBarry Smith    Level: beginner
415d382aafbSBarry Smith 
416ace3abfcSBarry Smith    Developer Note: Why have PetscBool , why not use bool in C? The problem is that K and R C, C99 and C++ all have different mechanisms for
41734e82e7dSBarry Smith       boolean values. It is not easy to have a simple macro that that will work properly in all circumstances with all three mechanisms.
41834e82e7dSBarry Smith 
4191cc8b206SBarry Smith .seealso: PETSC_TRUE, PETSC_FALSE, PetscNot()
420d382aafbSBarry Smith E*/
421ace3abfcSBarry Smith typedef enum { PETSC_FALSE,PETSC_TRUE } PetscBool;
4226a6fc655SJed Brown PETSC_EXTERN const char *const PetscBools[];
4235a576424SJed Brown PETSC_EXTERN MPI_Datatype MPIU_BOOL PetscAttrMPITypeTag(PetscBool);
42470b3c8c7SBarry Smith 
4258b49ba18SBarry Smith /*
4268b49ba18SBarry Smith     Defines some elementary mathematics functions and constants.
4278b49ba18SBarry Smith */
4288b49ba18SBarry Smith #include <petscmath.h>
4298b49ba18SBarry Smith 
43070b3c8c7SBarry Smith /*E
43170b3c8c7SBarry Smith     PetscCopyMode  - Determines how an array passed to certain functions is copied or retained
43270b3c8c7SBarry Smith 
43370b3c8c7SBarry Smith    Level: beginner
43470b3c8c7SBarry Smith 
43570b3c8c7SBarry Smith $   PETSC_COPY_VALUES - the array values are copied into new space, the user is free to reuse or delete the passed in array
43670b3c8c7SBarry Smith $   PETSC_OWN_POINTER - the array values are NOT copied, the object takes ownership of the array and will free it later, the user cannot change or
43770b3c8c7SBarry Smith $                       delete the array. The array MUST have been obtained with PetscMalloc(). Hence this mode cannot be used in Fortran.
43870b3c8c7SBarry Smith $   PETSC_USE_POINTER - the array values are NOT copied, the object uses the array but does NOT take ownership of the array. The user cannot use
43970b3c8c7SBarry Smith                         the array but the user must delete the array after the object is destroyed.
44070b3c8c7SBarry Smith 
44170b3c8c7SBarry Smith E*/
44270b3c8c7SBarry Smith typedef enum { PETSC_COPY_VALUES, PETSC_OWN_POINTER, PETSC_USE_POINTER} PetscCopyMode;
4436a6fc655SJed Brown PETSC_EXTERN const char *const PetscCopyModes[];
444d382aafbSBarry Smith 
445d382aafbSBarry Smith /*MC
446ace3abfcSBarry Smith     PETSC_FALSE - False value of PetscBool
447d382aafbSBarry Smith 
448d382aafbSBarry Smith     Level: beginner
449d382aafbSBarry Smith 
450d382aafbSBarry Smith     Note: Zero integer
451d382aafbSBarry Smith 
452ace3abfcSBarry Smith .seealso: PetscBool, PETSC_TRUE
453d382aafbSBarry Smith M*/
454d382aafbSBarry Smith 
455d382aafbSBarry Smith /*MC
456ace3abfcSBarry Smith     PETSC_TRUE - True value of PetscBool
457d382aafbSBarry Smith 
458d382aafbSBarry Smith     Level: beginner
459d382aafbSBarry Smith 
460d382aafbSBarry Smith     Note: Nonzero integer
461d382aafbSBarry Smith 
462ace3abfcSBarry Smith .seealso: PetscBool, PETSC_FALSE
463d382aafbSBarry Smith M*/
464d382aafbSBarry Smith 
465d382aafbSBarry Smith /*MC
4660298fd71SBarry Smith     PETSC_NULL - standard way of passing in a null or array or pointer. This is deprecated in C/C++ simply use NULL
467d382aafbSBarry Smith 
468d382aafbSBarry Smith    Level: beginner
469d382aafbSBarry Smith 
470d382aafbSBarry Smith    Notes: accepted by many PETSc functions to not set a parameter and instead use
471d382aafbSBarry Smith           some default
472d382aafbSBarry Smith 
473d382aafbSBarry Smith           This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER,
474503cfb0cSBarry Smith           PETSC_NULL_DOUBLE_PRECISION, PETSC_NULL_FUNCTION, PETSC_NULL_OBJECT etc
475d382aafbSBarry Smith 
476d382aafbSBarry Smith .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE
477d382aafbSBarry Smith 
478d382aafbSBarry Smith M*/
4793bcbec90SJed Brown #define PETSC_NULL           NULL
480d382aafbSBarry Smith 
481d382aafbSBarry Smith /*MC
4820298fd71SBarry Smith     PETSC_IGNORE - same as NULL, means PETSc will ignore this argument
483d382aafbSBarry Smith 
484d382aafbSBarry Smith    Level: beginner
485d382aafbSBarry Smith 
486d382aafbSBarry Smith    Note: accepted by many PETSc functions to not set a parameter and instead use
487d382aafbSBarry Smith           some default
488d382aafbSBarry Smith 
489d382aafbSBarry Smith    Fortran Notes: This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER,
490d382aafbSBarry Smith           PETSC_NULL_DOUBLE_PRECISION etc
491d382aafbSBarry Smith 
492d382aafbSBarry Smith .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_NULL, PETSC_DETERMINE
493d382aafbSBarry Smith 
494d382aafbSBarry Smith M*/
4950298fd71SBarry Smith #define PETSC_IGNORE         NULL
496d382aafbSBarry Smith 
497d382aafbSBarry Smith /*MC
498557d4da8SBarry Smith     PETSC_DECIDE - standard way of passing in integer or floating point parameter
499557d4da8SBarry Smith        where you wish PETSc to use the default.
500557d4da8SBarry Smith 
501557d4da8SBarry Smith    Level: beginner
502557d4da8SBarry Smith 
503557d4da8SBarry Smith .seealso: PETSC_NULL, PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE
504557d4da8SBarry Smith 
505557d4da8SBarry Smith M*/
506557d4da8SBarry Smith #define PETSC_DECIDE  -1
507557d4da8SBarry Smith 
508557d4da8SBarry Smith /*MC
509d382aafbSBarry Smith     PETSC_DETERMINE - standard way of passing in integer or floating point parameter
510d382aafbSBarry Smith        where you wish PETSc to compute the required value.
511d382aafbSBarry Smith 
512d382aafbSBarry Smith    Level: beginner
513d382aafbSBarry Smith 
514557d4da8SBarry Smith    Developer Note: I would like to use const PetscInt PETSC_DETERMINE = PETSC_DECIDE; but for
515557d4da8SBarry Smith      some reason this is not allowed by the standard even though PETSC_DECIDE is a constant value.
516557d4da8SBarry Smith 
5170298fd71SBarry Smith .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, VecSetSizes()
518d382aafbSBarry Smith 
519d382aafbSBarry Smith M*/
520d382aafbSBarry Smith #define PETSC_DETERMINE PETSC_DECIDE
521d382aafbSBarry Smith 
522d382aafbSBarry Smith /*MC
523557d4da8SBarry Smith     PETSC_DEFAULT - standard way of passing in integer or floating point parameter
524557d4da8SBarry Smith        where you wish PETSc to use the default.
525557d4da8SBarry Smith 
526557d4da8SBarry Smith    Level: beginner
527557d4da8SBarry Smith 
5282d80014bSBarry Smith    Fortran Notes: You need to use PETSC_DEFAULT_INTEGER or PETSC_DEFAULT_REAL.
529557d4da8SBarry Smith 
5300298fd71SBarry Smith .seealso: PETSC_DECIDE, PETSC_IGNORE, PETSC_DETERMINE
531557d4da8SBarry Smith 
532557d4da8SBarry Smith M*/
533557d4da8SBarry Smith #define PETSC_DEFAULT  -2
534557d4da8SBarry Smith 
535557d4da8SBarry Smith /*MC
536d382aafbSBarry Smith     PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents
537d382aafbSBarry Smith            all the processs that PETSc knows about.
538d382aafbSBarry Smith 
539d382aafbSBarry Smith    Level: beginner
540d382aafbSBarry Smith 
541d382aafbSBarry Smith    Notes: By default PETSC_COMM_WORLD and MPI_COMM_WORLD are identical unless you wish to
542d382aafbSBarry Smith           run PETSc on ONLY a subset of MPI_COMM_WORLD. In that case create your new (smaller)
543d382aafbSBarry Smith           communicator, call it, say comm, and set PETSC_COMM_WORLD = comm BEFORE calling
544a990b902SBarry Smith           PetscInitialize(), but after MPI_Init() has been called.
545a990b902SBarry Smith 
546a990b902SBarry Smith           The value of PETSC_COMM_WORLD should never be USED/accessed before PetscInitialize()
547a990b902SBarry Smith           is called because it may not have a valid value yet.
548d382aafbSBarry Smith 
549d382aafbSBarry Smith .seealso: PETSC_COMM_SELF
550d382aafbSBarry Smith 
551d382aafbSBarry Smith M*/
552014dd563SJed Brown PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD;
553d382aafbSBarry Smith 
554d382aafbSBarry Smith /*MC
555503cfb0cSBarry Smith     PETSC_COMM_SELF - This is always MPI_COMM_SELF
556d382aafbSBarry Smith 
557d382aafbSBarry Smith    Level: beginner
558d382aafbSBarry Smith 
559a990b902SBarry Smith    Notes: Do not USE/access or set this variable before PetscInitialize() has been called.
560a990b902SBarry Smith 
561d382aafbSBarry Smith .seealso: PETSC_COMM_WORLD
562d382aafbSBarry Smith 
563d382aafbSBarry Smith M*/
564d382aafbSBarry Smith #define PETSC_COMM_SELF MPI_COMM_SELF
565d382aafbSBarry Smith 
566d6f2c3cbSBarry Smith PETSC_EXTERN PetscBool PetscBeganMPI;
567014dd563SJed Brown PETSC_EXTERN PetscBool PetscInitializeCalled;
568014dd563SJed Brown PETSC_EXTERN PetscBool PetscFinalizeCalled;
569014dd563SJed Brown PETSC_EXTERN PetscBool PetscCUSPSynchronize;
5704cf1874eSKarl Rupp PETSC_EXTERN PetscBool PetscViennaCLSynchronize;
57182f73ecaSAlejandro Lamas Daviña PETSC_EXTERN PetscBool PetscCUDASynchronize;
572d382aafbSBarry Smith 
573014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm));
574014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*);
575014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm*);
576d382aafbSBarry Smith 
577d382aafbSBarry Smith /*MC
57895dccacaSBarry Smith    PetscMalloc - Allocates memory, One should use PetscNew(), PetscMalloc1() or PetscCalloc1() usually instead of this
579d382aafbSBarry Smith 
580eca87e8dSBarry Smith    Synopsis:
581aaa7dc30SBarry Smith     #include <petscsys.h>
582eca87e8dSBarry Smith    PetscErrorCode PetscMalloc(size_t m,void **result)
583eca87e8dSBarry Smith 
584eca87e8dSBarry Smith    Not Collective
585eca87e8dSBarry Smith 
586d382aafbSBarry Smith    Input Parameter:
587d382aafbSBarry Smith .  m - number of bytes to allocate
588d382aafbSBarry Smith 
589d382aafbSBarry Smith    Output Parameter:
590d382aafbSBarry Smith .  result - memory allocated
591d382aafbSBarry Smith 
592d382aafbSBarry Smith    Level: beginner
593d382aafbSBarry Smith 
59449d7da52SJed Brown    Notes:
59549d7da52SJed Brown    Memory is always allocated at least double aligned
596d382aafbSBarry Smith 
59749d7da52SJed Brown    It is safe to allocate size 0 and pass the resulting pointer (which may or may not be NULL) to PetscFree().
598d382aafbSBarry Smith 
599d382aafbSBarry Smith .seealso: PetscFree(), PetscNew()
600d382aafbSBarry Smith 
601d382aafbSBarry Smith   Concepts: memory allocation
602d382aafbSBarry Smith 
603d382aafbSBarry Smith M*/
60449d7da52SJed Brown #define PetscMalloc(a,b)  ((*PetscTrMalloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b)))
605d382aafbSBarry Smith 
606d382aafbSBarry Smith /*MC
6073221ece2SMatthew G. Knepley    PetscRealloc - Rellocates memory
6083221ece2SMatthew G. Knepley 
6093221ece2SMatthew G. Knepley    Synopsis:
6103221ece2SMatthew G. Knepley     #include <petscsys.h>
6113221ece2SMatthew G. Knepley    PetscErrorCode PetscRealloc(size_t m,void **result)
6123221ece2SMatthew G. Knepley 
6133221ece2SMatthew G. Knepley    Not Collective
6143221ece2SMatthew G. Knepley 
6153221ece2SMatthew G. Knepley    Input Parameters:
6163221ece2SMatthew G. Knepley +  m - number of bytes to allocate
6173221ece2SMatthew G. Knepley -  result - initial memory allocated
6183221ece2SMatthew G. Knepley 
6193221ece2SMatthew G. Knepley    Output Parameter:
6203221ece2SMatthew G. Knepley .  result - new memory allocated
6213221ece2SMatthew G. Knepley 
6223221ece2SMatthew G. Knepley    Level: developer
6233221ece2SMatthew G. Knepley 
6243221ece2SMatthew G. Knepley    Notes:
6253221ece2SMatthew G. Knepley    Memory is always allocated at least double aligned
6263221ece2SMatthew G. Knepley 
6273221ece2SMatthew G. Knepley .seealso: PetscMalloc(), PetscFree(), PetscNew()
6283221ece2SMatthew G. Knepley 
6293221ece2SMatthew G. Knepley   Concepts: memory allocation
6303221ece2SMatthew G. Knepley 
6313221ece2SMatthew G. Knepley M*/
6323221ece2SMatthew G. Knepley #define PetscRealloc(a,b)  ((*PetscTrRealloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b)))
6333221ece2SMatthew G. Knepley 
6343221ece2SMatthew G. Knepley /*MC
635503cfb0cSBarry Smith    PetscAddrAlign - Rounds up an address to PETSC_MEMALIGN alignment
636d382aafbSBarry Smith 
637d382aafbSBarry Smith    Synopsis:
638aaa7dc30SBarry Smith     #include <petscsys.h>
639d382aafbSBarry Smith    void *PetscAddrAlign(void *addr)
640d382aafbSBarry Smith 
641eca87e8dSBarry Smith    Not Collective
642eca87e8dSBarry Smith 
643eca87e8dSBarry Smith    Input Parameters:
644eca87e8dSBarry Smith .  addr - address to align (any pointer type)
645eca87e8dSBarry Smith 
646d382aafbSBarry Smith    Level: developer
647d382aafbSBarry Smith 
648d382aafbSBarry Smith .seealso: PetscMallocAlign()
649d382aafbSBarry Smith 
650d382aafbSBarry Smith   Concepts: memory allocation
651d382aafbSBarry Smith M*/
652d382aafbSBarry Smith #define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1))
653d382aafbSBarry Smith 
654d382aafbSBarry Smith /*MC
655785e854fSJed Brown    PetscMalloc1 - Allocates an array of memory aligned to PETSC_MEMALIGN
656d382aafbSBarry Smith 
657eca87e8dSBarry Smith    Synopsis:
658aaa7dc30SBarry Smith     #include <petscsys.h>
659785e854fSJed Brown    PetscErrorCode PetscMalloc1(size_t m1,type **r1)
660785e854fSJed Brown 
661785e854fSJed Brown    Not Collective
662785e854fSJed Brown 
663785e854fSJed Brown    Input Parameter:
664785e854fSJed Brown .  m1 - number of elements to allocate in 1st chunk  (may be zero)
665785e854fSJed Brown 
666785e854fSJed Brown    Output Parameter:
667785e854fSJed Brown .  r1 - memory allocated in first chunk
668785e854fSJed Brown 
669785e854fSJed Brown    Level: developer
670785e854fSJed Brown 
6711795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2()
672785e854fSJed Brown 
673785e854fSJed Brown   Concepts: memory allocation
674785e854fSJed Brown 
675785e854fSJed Brown M*/
676f0ba7cfcSLisandro Dalcin #define PetscMalloc1(m1,r1) PetscMalloc((m1)*sizeof(**(r1)),r1)
677785e854fSJed Brown 
678785e854fSJed Brown /*MC
6791795a4d1SJed Brown    PetscCalloc1 - Allocates a cleared (zeroed) array of memory aligned to PETSC_MEMALIGN
6801795a4d1SJed Brown 
6811795a4d1SJed Brown    Synopsis:
682aaa7dc30SBarry Smith     #include <petscsys.h>
6831795a4d1SJed Brown    PetscErrorCode PetscCalloc1(size_t m1,type **r1)
6841795a4d1SJed Brown 
6851795a4d1SJed Brown    Not Collective
6861795a4d1SJed Brown 
6871795a4d1SJed Brown    Input Parameter:
6881795a4d1SJed Brown .  m1 - number of elements to allocate in 1st chunk  (may be zero)
6891795a4d1SJed Brown 
6901795a4d1SJed Brown    Output Parameter:
6911795a4d1SJed Brown .  r1 - memory allocated in first chunk
6921795a4d1SJed Brown 
6931795a4d1SJed Brown    Level: developer
6941795a4d1SJed Brown 
6951795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2()
6961795a4d1SJed Brown 
6971795a4d1SJed Brown   Concepts: memory allocation
6981795a4d1SJed Brown 
6991795a4d1SJed Brown M*/
7001795a4d1SJed Brown #define PetscCalloc1(m1,r1) (PetscMalloc1((m1),r1) || PetscMemzero(*(r1),(m1)*sizeof(**(r1))))
7011795a4d1SJed Brown 
7021795a4d1SJed Brown /*MC
703dcca6d9dSJed Brown    PetscMalloc2 - Allocates 2 arrays of memory both aligned to PETSC_MEMALIGN
704d382aafbSBarry Smith 
705eca87e8dSBarry Smith    Synopsis:
706aaa7dc30SBarry Smith     #include <petscsys.h>
707dcca6d9dSJed Brown    PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2)
708eca87e8dSBarry Smith 
709eca87e8dSBarry Smith    Not Collective
710eca87e8dSBarry Smith 
711d382aafbSBarry Smith    Input Parameter:
712d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
713dcca6d9dSJed Brown -  m2 - number of elements to allocate in 2nd chunk  (may be zero)
714d382aafbSBarry Smith 
715d382aafbSBarry Smith    Output Parameter:
716d382aafbSBarry Smith +  r1 - memory allocated in first chunk
717d382aafbSBarry Smith -  r2 - memory allocated in second chunk
718d382aafbSBarry Smith 
719d382aafbSBarry Smith    Level: developer
720d382aafbSBarry Smith 
7211795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2()
722d382aafbSBarry Smith 
723d382aafbSBarry Smith   Concepts: memory allocation
724d382aafbSBarry Smith 
725d382aafbSBarry Smith M*/
72620a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED)
7271d2f33c5SMatthew G. Knepley #define PetscMalloc2(m1,r1,m2,r2) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)))
728d382aafbSBarry Smith #else
729ceba6b73SMatthew G. Knepley #define PetscMalloc2(m1,r1,m2,r2) ((((m1)+(m2)) ? (*(r2) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(PETSC_MEMALIGN-1),r1)) : 0) \
730ceba6b73SMatthew G. Knepley                                    || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),0) \
7313589d31bSMatthew G. Knepley                                    || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0))
732d382aafbSBarry Smith #endif
733d382aafbSBarry Smith 
734d382aafbSBarry Smith /*MC
7351795a4d1SJed Brown    PetscCalloc2 - Allocates 2 cleared (zeroed) arrays of memory both aligned to PETSC_MEMALIGN
736d382aafbSBarry Smith 
737eca87e8dSBarry Smith    Synopsis:
738aaa7dc30SBarry Smith     #include <petscsys.h>
7391795a4d1SJed Brown    PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2)
740eca87e8dSBarry Smith 
741eca87e8dSBarry Smith    Not Collective
742eca87e8dSBarry Smith 
743d382aafbSBarry Smith    Input Parameter:
744d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
7451795a4d1SJed Brown -  m2 - number of elements to allocate in 2nd chunk  (may be zero)
7461795a4d1SJed Brown 
7471795a4d1SJed Brown    Output Parameter:
7481795a4d1SJed Brown +  r1 - memory allocated in first chunk
7491795a4d1SJed Brown -  r2 - memory allocated in second chunk
7501795a4d1SJed Brown 
7511795a4d1SJed Brown    Level: developer
7521795a4d1SJed Brown 
7531795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2()
7541795a4d1SJed Brown 
7551795a4d1SJed Brown   Concepts: memory allocation
7561795a4d1SJed Brown M*/
7571795a4d1SJed Brown #define PetscCalloc2(m1,r1,m2,r2) (PetscMalloc2((m1),(r1),(m2),(r2)) || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))))
7581795a4d1SJed Brown 
7591795a4d1SJed Brown /*MC
760dcca6d9dSJed Brown    PetscMalloc3 - Allocates 3 arrays of memory, all aligned to PETSC_MEMALIGN
761d382aafbSBarry Smith 
762d382aafbSBarry Smith    Synopsis:
763aaa7dc30SBarry Smith     #include <petscsys.h>
764dcca6d9dSJed Brown    PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)
765d382aafbSBarry Smith 
766d382aafbSBarry Smith    Not Collective
767d382aafbSBarry Smith 
768d382aafbSBarry Smith    Input Parameter:
769d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
770d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
771dcca6d9dSJed Brown -  m3 - number of elements to allocate in 3rd chunk  (may be zero)
772d382aafbSBarry Smith 
773d382aafbSBarry Smith    Output Parameter:
774d382aafbSBarry Smith +  r1 - memory allocated in first chunk
775d382aafbSBarry Smith .  r2 - memory allocated in second chunk
776d382aafbSBarry Smith -  r3 - memory allocated in third chunk
777d382aafbSBarry Smith 
778d382aafbSBarry Smith    Level: developer
779d382aafbSBarry Smith 
7801795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc3(), PetscFree3()
781d382aafbSBarry Smith 
782d382aafbSBarry Smith   Concepts: memory allocation
783d382aafbSBarry Smith 
784d382aafbSBarry Smith M*/
78520a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED)
7861d2f33c5SMatthew G. Knepley #define PetscMalloc3(m1,r1,m2,r2,m3,r3) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)))
787d382aafbSBarry Smith #else
788ceba6b73SMatthew G. Knepley #define PetscMalloc3(m1,r1,m2,r2,m3,r3) ((((m1)+(m2)+(m3)) ? (*(r2) = 0,*(r3) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+2*(PETSC_MEMALIGN-1),r1)) : 0) \
789278791cbSMatthew G. Knepley                                          || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),0) \
7903589d31bSMatthew G. Knepley                                          || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0) || (!(m3) ? (*(r3) = 0,0) : 0))
791d382aafbSBarry Smith #endif
792d382aafbSBarry Smith 
793d382aafbSBarry Smith /*MC
7941795a4d1SJed Brown    PetscCalloc3 - Allocates 3 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
795d382aafbSBarry Smith 
796eca87e8dSBarry Smith    Synopsis:
797aaa7dc30SBarry Smith     #include <petscsys.h>
7981795a4d1SJed Brown    PetscErrorCode PetscCalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)
799eca87e8dSBarry Smith 
800eca87e8dSBarry Smith    Not Collective
801eca87e8dSBarry Smith 
802d382aafbSBarry Smith    Input Parameter:
803d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
804d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
8051795a4d1SJed Brown -  m3 - number of elements to allocate in 3rd chunk  (may be zero)
8061795a4d1SJed Brown 
8071795a4d1SJed Brown    Output Parameter:
8081795a4d1SJed Brown +  r1 - memory allocated in first chunk
8091795a4d1SJed Brown .  r2 - memory allocated in second chunk
8101795a4d1SJed Brown -  r3 - memory allocated in third chunk
8111795a4d1SJed Brown 
8121795a4d1SJed Brown    Level: developer
8131795a4d1SJed Brown 
8141795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc2(), PetscMalloc3(), PetscFree3()
8151795a4d1SJed Brown 
8161795a4d1SJed Brown   Concepts: memory allocation
8171795a4d1SJed Brown M*/
8181795a4d1SJed Brown #define PetscCalloc3(m1,r1,m2,r2,m3,r3)                                 \
8191795a4d1SJed Brown   (PetscMalloc3((m1),(r1),(m2),(r2),(m3),(r3))                          \
8201795a4d1SJed Brown    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))))
8211795a4d1SJed Brown 
8221795a4d1SJed Brown /*MC
823dcca6d9dSJed Brown    PetscMalloc4 - Allocates 4 arrays of memory, all aligned to PETSC_MEMALIGN
824d382aafbSBarry Smith 
825d382aafbSBarry Smith    Synopsis:
826aaa7dc30SBarry Smith     #include <petscsys.h>
827dcca6d9dSJed Brown    PetscErrorCode PetscMalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)
828d382aafbSBarry Smith 
829d382aafbSBarry Smith    Not Collective
830d382aafbSBarry Smith 
831d382aafbSBarry Smith    Input Parameter:
832d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
833d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
834d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
835dcca6d9dSJed Brown -  m4 - number of elements to allocate in 4th chunk  (may be zero)
836d382aafbSBarry Smith 
837d382aafbSBarry Smith    Output Parameter:
838d382aafbSBarry Smith +  r1 - memory allocated in first chunk
839d382aafbSBarry Smith .  r2 - memory allocated in second chunk
840d382aafbSBarry Smith .  r3 - memory allocated in third chunk
841d382aafbSBarry Smith -  r4 - memory allocated in fourth chunk
842d382aafbSBarry Smith 
843d382aafbSBarry Smith    Level: developer
844d382aafbSBarry Smith 
8451795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4()
846d382aafbSBarry Smith 
847d382aafbSBarry Smith   Concepts: memory allocation
848d382aafbSBarry Smith 
849d382aafbSBarry Smith M*/
85020a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED)
8511d2f33c5SMatthew G. Knepley #define PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)) || PetscMalloc1((m4),(r4)))
852d382aafbSBarry Smith #else
853dcca6d9dSJed Brown #define PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4)                           \
854ceba6b73SMatthew G. Knepley   ((((m1)+(m2)+(m3)+(m4)) ? (*(r2) = 0, *(r3) = 0, *(r4) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+(m4)*sizeof(**(r4))+3*(PETSC_MEMALIGN-1),r1)) : 0) \
855278791cbSMatthew G. Knepley    || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),0) \
8563589d31bSMatthew G. Knepley    || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0) || (!(m3) ? (*(r3) = 0,0) : 0) || (!(m4) ? (*(r4) = 0,0) : 0))
857d382aafbSBarry Smith #endif
858d382aafbSBarry Smith 
859d382aafbSBarry Smith /*MC
8601795a4d1SJed Brown    PetscCalloc4 - Allocates 4 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
861d382aafbSBarry Smith 
862eca87e8dSBarry Smith    Synopsis:
863aaa7dc30SBarry Smith     #include <petscsys.h>
8641795a4d1SJed Brown    PetscErrorCode PetscCalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)
865eca87e8dSBarry Smith 
866eca87e8dSBarry Smith    Not Collective
867eca87e8dSBarry Smith 
868d382aafbSBarry Smith    Input Parameter:
869d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
870d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
871d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
8721795a4d1SJed Brown -  m4 - number of elements to allocate in 4th chunk  (may be zero)
8731795a4d1SJed Brown 
8741795a4d1SJed Brown    Output Parameter:
8751795a4d1SJed Brown +  r1 - memory allocated in first chunk
8761795a4d1SJed Brown .  r2 - memory allocated in second chunk
8771795a4d1SJed Brown .  r3 - memory allocated in third chunk
8781795a4d1SJed Brown -  r4 - memory allocated in fourth chunk
8791795a4d1SJed Brown 
8801795a4d1SJed Brown    Level: developer
8811795a4d1SJed Brown 
8821795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4()
8831795a4d1SJed Brown 
8841795a4d1SJed Brown   Concepts: memory allocation
8851795a4d1SJed Brown 
8861795a4d1SJed Brown M*/
8871795a4d1SJed Brown #define PetscCalloc4(m1,r1,m2,r2,m3,r3,m4,r4)                           \
8881795a4d1SJed Brown   (PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4)                                \
8891795a4d1SJed Brown    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
8901795a4d1SJed Brown    || PetscMemzero(*(r4),(m4)*sizeof(**(r4))))
8911795a4d1SJed Brown 
8921795a4d1SJed Brown /*MC
893dcca6d9dSJed Brown    PetscMalloc5 - Allocates 5 arrays of memory, all aligned to PETSC_MEMALIGN
894d382aafbSBarry Smith 
895d382aafbSBarry Smith    Synopsis:
896aaa7dc30SBarry Smith     #include <petscsys.h>
897dcca6d9dSJed 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)
898d382aafbSBarry Smith 
899d382aafbSBarry Smith    Not Collective
900d382aafbSBarry Smith 
901d382aafbSBarry Smith    Input Parameter:
902d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
903d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
904d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
905d382aafbSBarry Smith .  m4 - number of elements to allocate in 4th chunk  (may be zero)
906dcca6d9dSJed Brown -  m5 - number of elements to allocate in 5th chunk  (may be zero)
907d382aafbSBarry Smith 
908d382aafbSBarry Smith    Output Parameter:
909d382aafbSBarry Smith +  r1 - memory allocated in first chunk
910d382aafbSBarry Smith .  r2 - memory allocated in second chunk
911d382aafbSBarry Smith .  r3 - memory allocated in third chunk
912d382aafbSBarry Smith .  r4 - memory allocated in fourth chunk
913d382aafbSBarry Smith -  r5 - memory allocated in fifth chunk
914d382aafbSBarry Smith 
915d382aafbSBarry Smith    Level: developer
916d382aafbSBarry Smith 
9171795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc5(), PetscFree5()
918d382aafbSBarry Smith 
919d382aafbSBarry Smith   Concepts: memory allocation
920d382aafbSBarry Smith 
921d382aafbSBarry Smith M*/
92220a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED)
9231d2f33c5SMatthew G. Knepley #define PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)) || PetscMalloc1((m4),(r4)) || PetscMalloc1((m5),(r5)))
924d382aafbSBarry Smith #else
925dcca6d9dSJed Brown #define PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5)      \
926ceba6b73SMatthew G. Knepley   ((((m1)+(m2)+(m3)+(m4)+(m5)) ? (*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+(m4)*sizeof(**(r4))+(m5)*sizeof(**(r5))+4*(PETSC_MEMALIGN-1),r1)) : 0) \
927278791cbSMatthew G. Knepley    || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),*(void**)(r5) = PetscAddrAlign(*(r4)+(m4)),0) \
9283589d31bSMatthew G. Knepley    || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0) || (!(m3) ? (*(r3) = 0,0) : 0) || (!(m4) ? (*(r4) = 0,0) : 0) || (!(m5) ? (*(r5) = 0,0) : 0))
929d382aafbSBarry Smith #endif
930d382aafbSBarry Smith 
931d382aafbSBarry Smith /*MC
9321795a4d1SJed Brown    PetscCalloc5 - Allocates 5 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
933d382aafbSBarry Smith 
934eca87e8dSBarry Smith    Synopsis:
935aaa7dc30SBarry Smith     #include <petscsys.h>
9361795a4d1SJed 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)
937eca87e8dSBarry Smith 
938eca87e8dSBarry Smith    Not Collective
939eca87e8dSBarry Smith 
940d382aafbSBarry Smith    Input Parameter:
941d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
942d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
943d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
944d382aafbSBarry Smith .  m4 - number of elements to allocate in 4th chunk  (may be zero)
9451795a4d1SJed Brown -  m5 - number of elements to allocate in 5th chunk  (may be zero)
9461795a4d1SJed Brown 
9471795a4d1SJed Brown    Output Parameter:
9481795a4d1SJed Brown +  r1 - memory allocated in first chunk
9491795a4d1SJed Brown .  r2 - memory allocated in second chunk
9501795a4d1SJed Brown .  r3 - memory allocated in third chunk
9511795a4d1SJed Brown .  r4 - memory allocated in fourth chunk
9521795a4d1SJed Brown -  r5 - memory allocated in fifth chunk
9531795a4d1SJed Brown 
9541795a4d1SJed Brown    Level: developer
9551795a4d1SJed Brown 
9561795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc5(), PetscFree5()
9571795a4d1SJed Brown 
9581795a4d1SJed Brown   Concepts: memory allocation
9591795a4d1SJed Brown 
9601795a4d1SJed Brown M*/
9611795a4d1SJed Brown #define PetscCalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5)                     \
9621795a4d1SJed Brown   (PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5)                          \
9631795a4d1SJed Brown    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
9641795a4d1SJed Brown    || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5))))
965d382aafbSBarry Smith 
966d382aafbSBarry Smith /*MC
967dcca6d9dSJed Brown    PetscMalloc6 - Allocates 6 arrays of memory, all aligned to PETSC_MEMALIGN
968d382aafbSBarry Smith 
969d382aafbSBarry Smith    Synopsis:
970aaa7dc30SBarry Smith     #include <petscsys.h>
971dcca6d9dSJed 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)
972d382aafbSBarry Smith 
973d382aafbSBarry Smith    Not Collective
974d382aafbSBarry Smith 
975d382aafbSBarry Smith    Input Parameter:
976d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
977d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
978d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
979d382aafbSBarry Smith .  m4 - number of elements to allocate in 4th chunk  (may be zero)
980d382aafbSBarry Smith .  m5 - number of elements to allocate in 5th chunk  (may be zero)
981dcca6d9dSJed Brown -  m6 - number of elements to allocate in 6th chunk  (may be zero)
982d382aafbSBarry Smith 
983d382aafbSBarry Smith    Output Parameter:
984d382aafbSBarry Smith +  r1 - memory allocated in first chunk
985d382aafbSBarry Smith .  r2 - memory allocated in second chunk
986d382aafbSBarry Smith .  r3 - memory allocated in third chunk
987d382aafbSBarry Smith .  r4 - memory allocated in fourth chunk
988d382aafbSBarry Smith .  r5 - memory allocated in fifth chunk
989d382aafbSBarry Smith -  r6 - memory allocated in sixth chunk
990d382aafbSBarry Smith 
991d382aafbSBarry Smith    Level: developer
992d382aafbSBarry Smith 
9931795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc6(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6()
994d382aafbSBarry Smith 
995d382aafbSBarry Smith   Concepts: memory allocation
996d382aafbSBarry Smith 
997d382aafbSBarry Smith M*/
99820a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED)
9991d2f33c5SMatthew G. Knepley #define PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)) || PetscMalloc1((m4),(r4)) || PetscMalloc1((m5),(r5)) || PetscMalloc1((m6),(r6)))
1000d382aafbSBarry Smith #else
1001dcca6d9dSJed Brown #define PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) \
1002ceba6b73SMatthew G. Knepley   ((((m1)+(m2)+(m3)+(m4)+(m5)+(m6)) ? (*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,*(r6) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+(m4)*sizeof(**(r4))+(m5)*sizeof(**(r5))+(m6)*sizeof(**(r6))+5*(PETSC_MEMALIGN-1),r1)) : 0) \
1003278791cbSMatthew G. Knepley    || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),*(void**)(r5) = PetscAddrAlign(*(r4)+(m4)),*(void**)(r6) = PetscAddrAlign(*(r5)+(m5)),0) \
10043589d31bSMatthew G. Knepley    || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0) || (!(m3) ? (*(r3) = 0,0) : 0) || (!(m4) ? (*(r4) = 0,0) : 0) || (!(m5) ? (*(r5) = 0,0) : 0) || (!(m6) ? (*(r6) = 0,0) : 0))
1005d382aafbSBarry Smith #endif
1006d382aafbSBarry Smith 
1007d382aafbSBarry Smith /*MC
10081795a4d1SJed Brown    PetscCalloc6 - Allocates 6 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
1009d382aafbSBarry Smith 
1010eca87e8dSBarry Smith    Synopsis:
1011aaa7dc30SBarry Smith     #include <petscsys.h>
10121795a4d1SJed 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)
1013eca87e8dSBarry Smith 
1014eca87e8dSBarry Smith    Not Collective
1015eca87e8dSBarry Smith 
1016d382aafbSBarry Smith    Input Parameter:
1017d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
1018d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
1019d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
1020d382aafbSBarry Smith .  m4 - number of elements to allocate in 4th chunk  (may be zero)
1021d382aafbSBarry Smith .  m5 - number of elements to allocate in 5th chunk  (may be zero)
10221795a4d1SJed Brown -  m6 - number of elements to allocate in 6th chunk  (may be zero)
10231795a4d1SJed Brown 
10241795a4d1SJed Brown    Output Parameter:
10251795a4d1SJed Brown +  r1 - memory allocated in first chunk
10261795a4d1SJed Brown .  r2 - memory allocated in second chunk
10271795a4d1SJed Brown .  r3 - memory allocated in third chunk
10281795a4d1SJed Brown .  r4 - memory allocated in fourth chunk
10291795a4d1SJed Brown .  r5 - memory allocated in fifth chunk
10301795a4d1SJed Brown -  r6 - memory allocated in sixth chunk
10311795a4d1SJed Brown 
10321795a4d1SJed Brown    Level: developer
10331795a4d1SJed Brown 
10341795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc6(), PetscFree6()
10351795a4d1SJed Brown 
10361795a4d1SJed Brown   Concepts: memory allocation
10371795a4d1SJed Brown M*/
10381795a4d1SJed Brown #define PetscCalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6)               \
10391795a4d1SJed Brown   (PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6)                    \
10401795a4d1SJed Brown    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
10411795a4d1SJed Brown    || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5))) || PetscMemzero(*(r6),(m6)*sizeof(**(r6))))
10421795a4d1SJed Brown 
10431795a4d1SJed Brown /*MC
1044dcca6d9dSJed Brown    PetscMalloc7 - Allocates 7 arrays of memory, all aligned to PETSC_MEMALIGN
1045d382aafbSBarry Smith 
1046d382aafbSBarry Smith    Synopsis:
1047aaa7dc30SBarry Smith     #include <petscsys.h>
1048dcca6d9dSJed 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)
1049d382aafbSBarry Smith 
1050d382aafbSBarry Smith    Not Collective
1051d382aafbSBarry Smith 
1052d382aafbSBarry Smith    Input Parameter:
1053d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
1054d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
1055d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
1056d382aafbSBarry Smith .  m4 - number of elements to allocate in 4th chunk  (may be zero)
1057d382aafbSBarry Smith .  m5 - number of elements to allocate in 5th chunk  (may be zero)
1058d382aafbSBarry Smith .  m6 - number of elements to allocate in 6th chunk  (may be zero)
1059dcca6d9dSJed Brown -  m7 - number of elements to allocate in 7th chunk  (may be zero)
1060d382aafbSBarry Smith 
1061d382aafbSBarry Smith    Output Parameter:
1062d382aafbSBarry Smith +  r1 - memory allocated in first chunk
1063d382aafbSBarry Smith .  r2 - memory allocated in second chunk
1064d382aafbSBarry Smith .  r3 - memory allocated in third chunk
1065d382aafbSBarry Smith .  r4 - memory allocated in fourth chunk
1066d382aafbSBarry Smith .  r5 - memory allocated in fifth chunk
1067d382aafbSBarry Smith .  r6 - memory allocated in sixth chunk
1068eca87e8dSBarry Smith -  r7 - memory allocated in seventh chunk
1069d382aafbSBarry Smith 
1070d382aafbSBarry Smith    Level: developer
1071d382aafbSBarry Smith 
10721795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc7(), PetscFree7()
1073d382aafbSBarry Smith 
1074d382aafbSBarry Smith   Concepts: memory allocation
1075d382aafbSBarry Smith 
1076d382aafbSBarry Smith M*/
107720a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED)
10781d2f33c5SMatthew G. Knepley #define PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)) || PetscMalloc1((m4),(r4)) || PetscMalloc1((m5),(r5)) || PetscMalloc1((m6),(r6)) || PetscMalloc1((m7),(r7)))
1079d382aafbSBarry Smith #else
1080dcca6d9dSJed Brown #define PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) \
1081ceba6b73SMatthew G. Knepley   ((((m1)+(m2)+(m3)+(m4)+(m5)+(m6)+(m7)) ? (*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,*(r6) = 0,*(r7) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+(m4)*sizeof(**(r4))+(m5)*sizeof(**(r5))+(m6)*sizeof(**(r6))+(m7)*sizeof(**(r7))+6*(PETSC_MEMALIGN-1),r1)) : 0) \
1082278791cbSMatthew G. Knepley    || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),*(void**)(r5) = PetscAddrAlign(*(r4)+(m4)),*(void**)(r6) = PetscAddrAlign(*(r5)+(m5)),*(void**)(r7) = PetscAddrAlign(*(r6)+(m6)),0) \
10833589d31bSMatthew G. Knepley    || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0) || (!(m3) ? (*(r3) = 0,0) : 0) || (!(m4) ? (*(r4) = 0,0) : 0) || (!(m5) ? (*(r5) = 0,0) : 0) || (!(m6) ? (*(r6) = 0,0) : 0) || (!(m7) ? (*(r7) = 0,0) : 0))
1084d382aafbSBarry Smith #endif
1085d382aafbSBarry Smith 
1086d382aafbSBarry Smith /*MC
10871795a4d1SJed Brown    PetscCalloc7 - Allocates 7 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
10881795a4d1SJed Brown 
10891795a4d1SJed Brown    Synopsis:
1090aaa7dc30SBarry Smith     #include <petscsys.h>
10911795a4d1SJed 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)
10921795a4d1SJed Brown 
10931795a4d1SJed Brown    Not Collective
10941795a4d1SJed Brown 
10951795a4d1SJed Brown    Input Parameter:
10961795a4d1SJed Brown +  m1 - number of elements to allocate in 1st chunk  (may be zero)
10971795a4d1SJed Brown .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
10981795a4d1SJed Brown .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
10991795a4d1SJed Brown .  m4 - number of elements to allocate in 4th chunk  (may be zero)
11001795a4d1SJed Brown .  m5 - number of elements to allocate in 5th chunk  (may be zero)
11011795a4d1SJed Brown .  m6 - number of elements to allocate in 6th chunk  (may be zero)
11021795a4d1SJed Brown -  m7 - number of elements to allocate in 7th chunk  (may be zero)
11031795a4d1SJed Brown 
11041795a4d1SJed Brown    Output Parameter:
11051795a4d1SJed Brown +  r1 - memory allocated in first chunk
11061795a4d1SJed Brown .  r2 - memory allocated in second chunk
11071795a4d1SJed Brown .  r3 - memory allocated in third chunk
11081795a4d1SJed Brown .  r4 - memory allocated in fourth chunk
11091795a4d1SJed Brown .  r5 - memory allocated in fifth chunk
11101795a4d1SJed Brown .  r6 - memory allocated in sixth chunk
11111795a4d1SJed Brown -  r7 - memory allocated in seventh chunk
11121795a4d1SJed Brown 
11131795a4d1SJed Brown    Level: developer
11141795a4d1SJed Brown 
11151795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc7(), PetscFree7()
11161795a4d1SJed Brown 
11171795a4d1SJed Brown   Concepts: memory allocation
11181795a4d1SJed Brown M*/
11191795a4d1SJed Brown #define PetscCalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7)         \
11207ba0cc92SJed Brown   (PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7)              \
11211795a4d1SJed Brown    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
11221795a4d1SJed Brown    || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5))) || PetscMemzero(*(r6),(m6)*sizeof(**(r6))) \
11237ba0cc92SJed Brown    || PetscMemzero(*(r7),(m7)*sizeof(**(r7))))
11241795a4d1SJed Brown 
11251795a4d1SJed Brown /*MC
1126503cfb0cSBarry Smith    PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to PETSC_MEMALIGN
1127d382aafbSBarry Smith 
1128eca87e8dSBarry Smith    Synopsis:
1129aaa7dc30SBarry Smith     #include <petscsys.h>
1130b00a9115SJed Brown    PetscErrorCode PetscNew(type **result)
1131eca87e8dSBarry Smith 
1132eca87e8dSBarry Smith    Not Collective
1133eca87e8dSBarry Smith 
1134d382aafbSBarry Smith    Output Parameter:
1135b00a9115SJed Brown .  result - memory allocated, sized to match pointer type
1136d382aafbSBarry Smith 
1137d382aafbSBarry Smith    Level: beginner
1138d382aafbSBarry Smith 
1139ad0619ddSBarry Smith .seealso: PetscFree(), PetscMalloc(), PetscNewLog()
1140d382aafbSBarry Smith 
1141d382aafbSBarry Smith   Concepts: memory allocation
1142d382aafbSBarry Smith 
1143d382aafbSBarry Smith M*/
1144b00a9115SJed Brown #define PetscNew(b)      PetscCalloc1(1,(b))
1145ad0619ddSBarry Smith 
1146ad0619ddSBarry Smith /*MC
1147b00a9115SJed Brown    PetscNewLog - Allocates memory of a type matching pointer, zeros the memory! Aligned to PETSC_MEMALIGN. Associates the memory allocated
1148ad0619ddSBarry Smith          with the given object using PetscLogObjectMemory().
1149ad0619ddSBarry Smith 
1150ad0619ddSBarry Smith    Synopsis:
1151aaa7dc30SBarry Smith     #include <petscsys.h>
1152b00a9115SJed Brown    PetscErrorCode PetscNewLog(PetscObject obj,type **result)
1153ad0619ddSBarry Smith 
1154ad0619ddSBarry Smith    Not Collective
1155ad0619ddSBarry Smith 
1156ad0619ddSBarry Smith    Input Parameter:
1157b00a9115SJed Brown .  obj - object memory is logged to
1158ad0619ddSBarry Smith 
1159ad0619ddSBarry Smith    Output Parameter:
1160b00a9115SJed Brown .  result - memory allocated, sized to match pointer type
1161ad0619ddSBarry Smith 
1162ad0619ddSBarry Smith    Level: developer
1163ad0619ddSBarry Smith 
1164ad0619ddSBarry Smith .seealso: PetscFree(), PetscMalloc(), PetscNew(), PetscLogObjectMemory()
1165ad0619ddSBarry Smith 
1166ad0619ddSBarry Smith   Concepts: memory allocation
1167ad0619ddSBarry Smith 
1168ad0619ddSBarry Smith M*/
1169d12f57a0SLisandro Dalcin #define PetscNewLog(o,b) (PetscNew((b)) || PetscLogObjectMemory((PetscObject)o,sizeof(**(b))))
1170d382aafbSBarry Smith 
1171d382aafbSBarry Smith /*MC
1172d382aafbSBarry Smith    PetscFree - Frees memory
1173d382aafbSBarry Smith 
1174eca87e8dSBarry Smith    Synopsis:
1175aaa7dc30SBarry Smith     #include <petscsys.h>
1176eca87e8dSBarry Smith    PetscErrorCode PetscFree(void *memory)
1177eca87e8dSBarry Smith 
1178eca87e8dSBarry Smith    Not Collective
1179eca87e8dSBarry Smith 
1180d382aafbSBarry Smith    Input Parameter:
1181d382aafbSBarry Smith .   memory - memory to free (the pointer is ALWAYS set to 0 upon sucess)
1182d382aafbSBarry Smith 
1183d382aafbSBarry Smith    Level: beginner
1184d382aafbSBarry Smith 
118549d7da52SJed Brown    Notes:
118649d7da52SJed Brown    Memory must have been obtained with PetscNew() or PetscMalloc().
118749d7da52SJed Brown    It is safe to call PetscFree() on a NULL pointer.
1188d382aafbSBarry Smith 
1189d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscFreeVoid()
1190d382aafbSBarry Smith 
1191d382aafbSBarry Smith   Concepts: memory allocation
1192d382aafbSBarry Smith 
1193d382aafbSBarry Smith M*/
119449d7da52SJed Brown #define PetscFree(a)   ((*PetscTrFree)((void*)(a),__LINE__,PETSC_FUNCTION_NAME,__FILE__) || ((a) = 0,0))
1195d382aafbSBarry Smith 
1196d382aafbSBarry Smith /*MC
1197d382aafbSBarry Smith    PetscFreeVoid - Frees memory
1198d382aafbSBarry Smith 
1199d382aafbSBarry Smith    Synopsis:
1200aaa7dc30SBarry Smith     #include <petscsys.h>
1201d382aafbSBarry Smith    void PetscFreeVoid(void *memory)
1202d382aafbSBarry Smith 
1203eca87e8dSBarry Smith    Not Collective
1204eca87e8dSBarry Smith 
1205eca87e8dSBarry Smith    Input Parameter:
1206eca87e8dSBarry Smith .   memory - memory to free
1207eca87e8dSBarry Smith 
1208d382aafbSBarry Smith    Level: beginner
1209d382aafbSBarry Smith 
1210d382aafbSBarry Smith    Notes: This is different from PetscFree() in that no error code is returned
1211d382aafbSBarry Smith 
1212d382aafbSBarry Smith .seealso: PetscFree(), PetscNew(), PetscMalloc()
1213d382aafbSBarry Smith 
1214d382aafbSBarry Smith   Concepts: memory allocation
1215d382aafbSBarry Smith 
1216d382aafbSBarry Smith M*/
1217efca3c55SSatish Balay #define PetscFreeVoid(a) ((*PetscTrFree)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__),(a) = 0)
1218d382aafbSBarry Smith 
1219d382aafbSBarry Smith 
1220d382aafbSBarry Smith /*MC
1221d382aafbSBarry Smith    PetscFree2 - Frees 2 chunks of memory obtained with PetscMalloc2()
1222d382aafbSBarry Smith 
1223eca87e8dSBarry Smith    Synopsis:
1224aaa7dc30SBarry Smith     #include <petscsys.h>
1225eca87e8dSBarry Smith    PetscErrorCode PetscFree2(void *memory1,void *memory2)
1226eca87e8dSBarry Smith 
1227eca87e8dSBarry Smith    Not Collective
1228eca87e8dSBarry Smith 
1229d382aafbSBarry Smith    Input Parameter:
1230d382aafbSBarry Smith +   memory1 - memory to free
1231d382aafbSBarry Smith -   memory2 - 2nd memory to free
1232d382aafbSBarry Smith 
1233d382aafbSBarry Smith    Level: developer
1234d382aafbSBarry Smith 
1235d382aafbSBarry Smith    Notes: Memory must have been obtained with PetscMalloc2()
1236d382aafbSBarry Smith 
1237d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree()
1238d382aafbSBarry Smith 
1239d382aafbSBarry Smith   Concepts: memory allocation
1240d382aafbSBarry Smith 
1241d382aafbSBarry Smith M*/
1242b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED)
1243d382aafbSBarry Smith #define PetscFree2(m1,m2)   (PetscFree(m2) || PetscFree(m1))
1244d382aafbSBarry Smith #else
1245e38f91f2SMatthew G. Knepley #define PetscFree2(m1,m2)   ((m1) ? ((m2)=0,PetscFree(m1)) : ((m1)=0,PetscFree(m2)))
1246d382aafbSBarry Smith #endif
1247d382aafbSBarry Smith 
1248d382aafbSBarry Smith /*MC
1249d382aafbSBarry Smith    PetscFree3 - Frees 3 chunks of memory obtained with PetscMalloc3()
1250d382aafbSBarry Smith 
1251eca87e8dSBarry Smith    Synopsis:
1252aaa7dc30SBarry Smith     #include <petscsys.h>
1253eca87e8dSBarry Smith    PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3)
1254eca87e8dSBarry Smith 
1255eca87e8dSBarry Smith    Not Collective
1256eca87e8dSBarry Smith 
1257d382aafbSBarry Smith    Input Parameter:
1258d382aafbSBarry Smith +   memory1 - memory to free
1259d382aafbSBarry Smith .   memory2 - 2nd memory to free
1260d382aafbSBarry Smith -   memory3 - 3rd memory to free
1261d382aafbSBarry Smith 
1262d382aafbSBarry Smith    Level: developer
1263d382aafbSBarry Smith 
1264d382aafbSBarry Smith    Notes: Memory must have been obtained with PetscMalloc3()
1265d382aafbSBarry Smith 
1266d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3()
1267d382aafbSBarry Smith 
1268d382aafbSBarry Smith   Concepts: memory allocation
1269d382aafbSBarry Smith 
1270d382aafbSBarry Smith M*/
1271b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED)
1272d382aafbSBarry Smith #define PetscFree3(m1,m2,m3)   (PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1273d382aafbSBarry Smith #else
1274e38f91f2SMatthew G. Knepley #define PetscFree3(m1,m2,m3)   ((m1) ? ((m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m3)=0,(m1)=0,PetscFree(m2)) : ((m2)=0,(m1)=0,PetscFree(m3))))
1275d382aafbSBarry Smith #endif
1276d382aafbSBarry Smith 
1277d382aafbSBarry Smith /*MC
1278d382aafbSBarry Smith    PetscFree4 - Frees 4 chunks of memory obtained with PetscMalloc4()
1279d382aafbSBarry Smith 
1280eca87e8dSBarry Smith    Synopsis:
1281aaa7dc30SBarry Smith     #include <petscsys.h>
1282eca87e8dSBarry Smith    PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4)
1283eca87e8dSBarry Smith 
1284eca87e8dSBarry Smith    Not Collective
1285eca87e8dSBarry Smith 
1286d382aafbSBarry Smith    Input Parameter:
1287d382aafbSBarry Smith +   m1 - memory to free
1288d382aafbSBarry Smith .   m2 - 2nd memory to free
1289d382aafbSBarry Smith .   m3 - 3rd memory to free
1290d382aafbSBarry Smith -   m4 - 4th memory to free
1291d382aafbSBarry Smith 
1292d382aafbSBarry Smith    Level: developer
1293d382aafbSBarry Smith 
1294d382aafbSBarry Smith    Notes: Memory must have been obtained with PetscMalloc4()
1295d382aafbSBarry Smith 
1296d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4()
1297d382aafbSBarry Smith 
1298d382aafbSBarry Smith   Concepts: memory allocation
1299d382aafbSBarry Smith 
1300d382aafbSBarry Smith M*/
1301b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED)
1302d382aafbSBarry Smith #define PetscFree4(m1,m2,m3,m4)   (PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1303d382aafbSBarry Smith #else
1304e38f91f2SMatthew G. Knepley #define PetscFree4(m1,m2,m3,m4)   ((m1) ? ((m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m4)=0,(m3)=0,(m1)=0,PetscFree(m2)) : ((m3) ? ((m4)=0,(m2)=0,(m1)=0,PetscFree(m3)) : ((m3)=0,(m2)=0,(m1)=0,PetscFree(m4)))))
1305d382aafbSBarry Smith #endif
1306d382aafbSBarry Smith 
1307d382aafbSBarry Smith /*MC
1308d382aafbSBarry Smith    PetscFree5 - Frees 5 chunks of memory obtained with PetscMalloc5()
1309d382aafbSBarry Smith 
1310eca87e8dSBarry Smith    Synopsis:
1311aaa7dc30SBarry Smith     #include <petscsys.h>
1312eca87e8dSBarry Smith    PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5)
1313eca87e8dSBarry Smith 
1314eca87e8dSBarry Smith    Not Collective
1315eca87e8dSBarry Smith 
1316d382aafbSBarry Smith    Input Parameter:
1317d382aafbSBarry Smith +   m1 - memory to free
1318d382aafbSBarry Smith .   m2 - 2nd memory to free
1319d382aafbSBarry Smith .   m3 - 3rd memory to free
1320d382aafbSBarry Smith .   m4 - 4th memory to free
1321d382aafbSBarry Smith -   m5 - 5th memory to free
1322d382aafbSBarry Smith 
1323d382aafbSBarry Smith    Level: developer
1324d382aafbSBarry Smith 
1325d382aafbSBarry Smith    Notes: Memory must have been obtained with PetscMalloc5()
1326d382aafbSBarry Smith 
1327d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5()
1328d382aafbSBarry Smith 
1329d382aafbSBarry Smith   Concepts: memory allocation
1330d382aafbSBarry Smith 
1331d382aafbSBarry Smith M*/
1332b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED)
1333d382aafbSBarry Smith #define PetscFree5(m1,m2,m3,m4,m5)   (PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1334d382aafbSBarry Smith #else
1335e38f91f2SMatthew G. Knepley #define PetscFree5(m1,m2,m3,m4,m5)   ((m1) ? ((m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m5)=0,(m4)=0,(m3)=0,(m1)=0,PetscFree(m2)) : ((m3) ? ((m5)=0,(m4)=0,(m2)=0,(m1)=0,PetscFree(m3)) : \
1336e38f91f2SMatthew G. Knepley                                      ((m4) ? ((m5)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m4)) : ((m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m5))))))
1337d382aafbSBarry Smith #endif
1338d382aafbSBarry Smith 
1339d382aafbSBarry Smith 
1340d382aafbSBarry Smith /*MC
1341d382aafbSBarry Smith    PetscFree6 - Frees 6 chunks of memory obtained with PetscMalloc6()
1342d382aafbSBarry Smith 
1343eca87e8dSBarry Smith    Synopsis:
1344aaa7dc30SBarry Smith     #include <petscsys.h>
1345eca87e8dSBarry Smith    PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6)
1346eca87e8dSBarry Smith 
1347eca87e8dSBarry Smith    Not Collective
1348eca87e8dSBarry Smith 
1349d382aafbSBarry Smith    Input Parameter:
1350d382aafbSBarry Smith +   m1 - memory to free
1351d382aafbSBarry Smith .   m2 - 2nd memory to free
1352d382aafbSBarry Smith .   m3 - 3rd memory to free
1353d382aafbSBarry Smith .   m4 - 4th memory to free
1354d382aafbSBarry Smith .   m5 - 5th memory to free
1355d382aafbSBarry Smith -   m6 - 6th memory to free
1356d382aafbSBarry Smith 
1357d382aafbSBarry Smith 
1358d382aafbSBarry Smith    Level: developer
1359d382aafbSBarry Smith 
1360d382aafbSBarry Smith    Notes: Memory must have been obtained with PetscMalloc6()
1361d382aafbSBarry Smith 
1362d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6()
1363d382aafbSBarry Smith 
1364d382aafbSBarry Smith   Concepts: memory allocation
1365d382aafbSBarry Smith 
1366d382aafbSBarry Smith M*/
1367b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED)
1368d382aafbSBarry Smith #define PetscFree6(m1,m2,m3,m4,m5,m6)   (PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1369d382aafbSBarry Smith #else
1370e38f91f2SMatthew G. Knepley #define PetscFree6(m1,m2,m3,m4,m5,m6)   ((m1) ? ((m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m6)=0,(m5)=0,(m4)=0,(m3)=0,(m1)=0,PetscFree(m2)) : \
1371e38f91f2SMatthew G. Knepley                                         ((m3) ? ((m6)=0,(m5)=0,(m4)=0,(m2)=0,(m1)=0,PetscFree(m3)) : ((m4) ? ((m6)=0,(m5)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m4)) : \
1372e38f91f2SMatthew G. Knepley                                         ((m5) ? ((m6)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m5)) : ((m5)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m6)))))))
1373d382aafbSBarry Smith #endif
1374d382aafbSBarry Smith 
1375d382aafbSBarry Smith /*MC
1376d382aafbSBarry Smith    PetscFree7 - Frees 7 chunks of memory obtained with PetscMalloc7()
1377d382aafbSBarry Smith 
1378eca87e8dSBarry Smith    Synopsis:
1379aaa7dc30SBarry Smith     #include <petscsys.h>
1380eca87e8dSBarry Smith    PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7)
1381eca87e8dSBarry Smith 
1382eca87e8dSBarry Smith    Not Collective
1383eca87e8dSBarry Smith 
1384d382aafbSBarry Smith    Input Parameter:
1385d382aafbSBarry Smith +   m1 - memory to free
1386d382aafbSBarry Smith .   m2 - 2nd memory to free
1387d382aafbSBarry Smith .   m3 - 3rd memory to free
1388d382aafbSBarry Smith .   m4 - 4th memory to free
1389d382aafbSBarry Smith .   m5 - 5th memory to free
1390d382aafbSBarry Smith .   m6 - 6th memory to free
1391d382aafbSBarry Smith -   m7 - 7th memory to free
1392d382aafbSBarry Smith 
1393d382aafbSBarry Smith 
1394d382aafbSBarry Smith    Level: developer
1395d382aafbSBarry Smith 
1396d382aafbSBarry Smith    Notes: Memory must have been obtained with PetscMalloc7()
1397d382aafbSBarry Smith 
1398d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(),
1399d382aafbSBarry Smith           PetscMalloc7()
1400d382aafbSBarry Smith 
1401d382aafbSBarry Smith   Concepts: memory allocation
1402d382aafbSBarry Smith 
1403d382aafbSBarry Smith M*/
1404b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED)
1405d382aafbSBarry Smith #define PetscFree7(m1,m2,m3,m4,m5,m6,m7)   (PetscFree(m7) || PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1406d382aafbSBarry Smith #else
1407e38f91f2SMatthew G. Knepley #define PetscFree7(m1,m2,m3,m4,m5,m6,m7)   ((m1) ? ((m7)=0,(m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m7)=0,(m6)=0,(m5)=0,(m4)=0,(m3)=0,(m1)=0,PetscFree(m2)) : \
1408e38f91f2SMatthew G. Knepley                                            ((m3) ? ((m7)=0,(m6)=0,(m5)=0,(m4)=0,(m2)=0,(m1)=0,PetscFree(m3)) : ((m4) ? ((m7)=0,(m6)=0,(m5)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m4)) : \
140906c0a5e5SMatthew G. Knepley                                            ((m5) ? ((m7)=0,(m6)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m5)) : ((m6) ? ((m7)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m6)) : \
1410e38f91f2SMatthew G. Knepley                                                    ((m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m7))))))))
1411d382aafbSBarry Smith #endif
1412d382aafbSBarry Smith 
1413efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t,int,const char[],const char[],void**);
1414efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[]);
14153221ece2SMatthew G. Knepley PETSC_EXTERN PetscErrorCode (*PetscTrRealloc)(size_t,int,const char[],const char[],void**);
1416efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t,int,const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[]));
1417014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocClear(void);
1418d382aafbSBarry Smith 
1419d382aafbSBarry Smith /*
1420a5057860SBarry Smith     PetscLogDouble variables are used to contain double precision numbers
1421a5057860SBarry Smith   that are not used in the numerical computations, but rather in logging,
1422a5057860SBarry Smith   timing etc.
1423a5057860SBarry Smith */
1424a5057860SBarry Smith typedef double PetscLogDouble;
1425a5057860SBarry Smith #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE
1426a5057860SBarry Smith 
1427a5057860SBarry Smith /*
142866d669d6SBarry Smith    Routines for tracing memory corruption/bleeding with default PETSc memory allocation
1429d382aafbSBarry Smith */
1430014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *);
1431014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocDumpLog(FILE *);
1432014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *);
1433014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *);
1434014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocDebug(PetscBool);
14350acecf5bSBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool*);
1436efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode PetscMallocValidate(int,const char[],const char[]);
1437014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLog(void);
1438574034a9SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLogThreshold(PetscLogDouble);
1439014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocGetDumpLog(PetscBool*);
1440d382aafbSBarry Smith 
1441d382aafbSBarry Smith /*E
1442d382aafbSBarry Smith     PetscDataType - Used for handling different basic data types.
1443d382aafbSBarry Smith 
1444d382aafbSBarry Smith    Level: beginner
1445d382aafbSBarry Smith 
1446d382aafbSBarry Smith    Developer comment: It would be nice if we could always just use MPI Datatypes, why can we not?
1447d382aafbSBarry Smith 
1448d382aafbSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(),
1449d382aafbSBarry Smith           PetscDataTypeGetSize()
1450d382aafbSBarry Smith 
1451d382aafbSBarry Smith E*/
1452d382aafbSBarry Smith typedef enum {PETSC_INT = 0,PETSC_DOUBLE = 1,PETSC_COMPLEX = 2, PETSC_LONG = 3 ,PETSC_SHORT = 4,PETSC_FLOAT = 5,
145399a4b90dSDave May               PETSC_CHAR = 6,PETSC_BIT_LOGICAL = 7,PETSC_ENUM = 8,PETSC_BOOL=9, PETSC___FLOAT128 = 10,PETSC_OBJECT = 11, PETSC_FUNCTION = 12, PETSC_STRING = 12, PETSC_STRUCT, PETSC_DATATYPE_UNKNOWN} PetscDataType;
14546a6fc655SJed Brown PETSC_EXTERN const char *const PetscDataTypes[];
1455d382aafbSBarry Smith 
1456d382aafbSBarry Smith #if defined(PETSC_USE_COMPLEX)
1457d382aafbSBarry Smith #define  PETSC_SCALAR  PETSC_COMPLEX
1458d382aafbSBarry Smith #else
1459ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
1460d382aafbSBarry Smith #define  PETSC_SCALAR  PETSC_FLOAT
146159a34000SBarry Smith #elif defined(PETSC_USE_REAL___FLOAT128)
146259a34000SBarry Smith #define  PETSC_SCALAR  PETSC___FLOAT128
1463d382aafbSBarry Smith #else
1464d382aafbSBarry Smith #define  PETSC_SCALAR  PETSC_DOUBLE
1465d382aafbSBarry Smith #endif
1466d382aafbSBarry Smith #endif
1467ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
1468d382aafbSBarry Smith #define  PETSC_REAL  PETSC_FLOAT
146959a34000SBarry Smith #elif defined(PETSC_USE_REAL___FLOAT128)
147059a34000SBarry Smith #define  PETSC_REAL  PETSC___FLOAT128
1471d382aafbSBarry Smith #else
1472d382aafbSBarry Smith #define  PETSC_REAL  PETSC_DOUBLE
1473d382aafbSBarry Smith #endif
1474d382aafbSBarry Smith #define  PETSC_FORTRANADDR  PETSC_LONG
1475d382aafbSBarry Smith 
1476014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*);
1477014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*);
1478014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*);
14798e4b2d1dSBarry Smith PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char*,PetscDataType*,PetscBool*);
1480d382aafbSBarry Smith 
1481d382aafbSBarry Smith /*
1482d382aafbSBarry Smith     Basic memory and string operations. These are usually simple wrappers
1483d382aafbSBarry Smith    around the basic Unix system calls, but a few of them have additional
1484d382aafbSBarry Smith    functionality and/or error checking.
1485d382aafbSBarry Smith */
1486014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType);
1487014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemmove(void*,void *,size_t);
1488014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemcmp(const void*,const void*,size_t,PetscBool  *);
1489014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrlen(const char[],size_t*);
1490d67fe73bSBarry Smith PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[],char,int*,char ***);
1491014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int,char **);
1492014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[],const char[],PetscBool  *);
1493014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[],const char[],PetscBool  *);
1494014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[],const char[],PetscBool *);
1495014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[],const char[],size_t,PetscBool *);
1496014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcpy(char[],const char[]);
1497014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcat(char[],const char[]);
1498014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrncat(char[],const char[],size_t);
1499014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrncpy(char[],const char[],size_t);
1500014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrchr(const char[],char,char *[]);
1501014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]);
15022f234a98SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrtoupper(char[]);
1503014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[],char,char *[]);
1504014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrstr(const char[],const char[],char *[]);
1505014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[],const char[],char *[]);
1506014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[],const char[],PetscBool*);
15072c9581d2SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[],const char[],PetscBool*);
1508014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[],const char *const*,PetscInt*);
1509014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[],char *[]);
151047340559SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const*,char***);
15116fed8037SJed Brown PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char***);
15126991f827SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrNArrayallocpy(PetscInt,const char *const*,char***);
15136991f827SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrNArrayDestroy(PetscInt,char***);
1514014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm,const char[],char[],size_t);
1515d382aafbSBarry Smith 
1516573b0fb4SBarry Smith PETSC_EXTERN void PetscStrcmpNoError(const char[],const char[],PetscBool  *);
1517573b0fb4SBarry Smith 
1518d382aafbSBarry Smith /*S
1519d382aafbSBarry Smith     PetscToken - 'Token' used for managing tokenizing strings
1520d382aafbSBarry Smith 
1521d382aafbSBarry Smith   Level: intermediate
1522d382aafbSBarry Smith 
1523d382aafbSBarry Smith .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy()
1524d382aafbSBarry Smith S*/
1525d382aafbSBarry Smith typedef struct _p_PetscToken* PetscToken;
1526d382aafbSBarry Smith 
1527014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*);
1528014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]);
1529014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*);
1530d382aafbSBarry Smith 
1531a53986e1SJed Brown PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt,const char *const*,const char*,PetscInt*,PetscBool*);
1532a53986e1SJed Brown PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const*,const char*,PetscEnum*,PetscBool*);
1533a53986e1SJed Brown 
1534d382aafbSBarry Smith /*
1535d382aafbSBarry Smith    These are MPI operations for MPI_Allreduce() etc
1536d382aafbSBarry Smith */
1537367daffbSBarry Smith PETSC_EXTERN MPI_Op MPIU_MAXSUM_OP;
15387c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1539014dd563SJed Brown PETSC_EXTERN MPI_Op MPIU_SUM;
15402414b3c7SJed Brown #else
15412414b3c7SJed Brown #define MPIU_SUM MPI_SUM
15422414b3c7SJed Brown #endif
15432414b3c7SJed Brown #if defined(PETSC_USE_REAL___FLOAT128)
1544014dd563SJed Brown PETSC_EXTERN MPI_Op MPIU_MAX;
1545014dd563SJed Brown PETSC_EXTERN MPI_Op MPIU_MIN;
1546d9822059SBarry Smith #else
1547d9822059SBarry Smith #define MPIU_MAX MPI_MAX
1548d9822059SBarry Smith #define MPIU_MIN MPI_MIN
1549d9822059SBarry Smith #endif
1550014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*);
1551d382aafbSBarry Smith 
1552014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1553014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1554eb3f98d2SBarry Smith 
1555d382aafbSBarry Smith /*S
1556d382aafbSBarry Smith      PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc
1557d382aafbSBarry Smith 
1558d382aafbSBarry Smith    Level: beginner
1559d382aafbSBarry Smith 
15602981ebdbSBarry Smith    Note: This is the base class from which all PETSc objects are derived from.
1561d382aafbSBarry Smith 
15622b26979fSBarry Smith .seealso:  PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName(), PetscObjectReference(), PetscObjectDereference()
1563d382aafbSBarry Smith S*/
1564d382aafbSBarry Smith typedef struct _p_PetscObject* PetscObject;
1565d382aafbSBarry Smith 
1566270bf2e7SJed Brown /*MC
1567127c8a3bSJed Brown     PetscObjectId - unique integer Id for a PetscObject
1568127c8a3bSJed Brown 
1569127c8a3bSJed Brown     Level: developer
1570127c8a3bSJed Brown 
1571127c8a3bSJed Brown     Notes: Unlike pointer values, object ids are never reused.
1572127c8a3bSJed Brown 
1573127c8a3bSJed Brown .seealso: PetscObjectState, PetscObjectGetId()
1574127c8a3bSJed Brown M*/
1575bafee8b4SSatish Balay typedef PetscInt64 PetscObjectId;
1576127c8a3bSJed Brown 
1577127c8a3bSJed Brown /*MC
1578270bf2e7SJed Brown     PetscObjectState - integer state for a PetscObject
1579270bf2e7SJed Brown 
1580270bf2e7SJed Brown     Level: developer
1581270bf2e7SJed Brown 
1582270bf2e7SJed Brown     Notes:
1583270bf2e7SJed Brown     Object state is always-increasing and (for objects that track state) can be used to determine if an object has
1584270bf2e7SJed Brown     changed since the last time you interacted with it.  It is 64-bit so that it will not overflow for a very long time.
1585270bf2e7SJed Brown 
15868dcff661SJed Brown .seealso: PetscObjectId, PetscObjectStateGet(), PetscObjectStateIncrease(), PetscObjectStateSet()
1587270bf2e7SJed Brown M*/
1588bafee8b4SSatish Balay typedef PetscInt64 PetscObjectState;
1589270bf2e7SJed Brown 
1590d382aafbSBarry Smith /*S
1591140e18c1SBarry Smith      PetscFunctionList - Linked list of functions, possibly stored in dynamic libraries, accessed
1592d382aafbSBarry Smith       by string name
1593d382aafbSBarry Smith 
1594d382aafbSBarry Smith    Level: advanced
1595d382aafbSBarry Smith 
1596140e18c1SBarry Smith .seealso:  PetscFunctionListAdd(), PetscFunctionListDestroy(), PetscOpFlist
1597d382aafbSBarry Smith S*/
1598140e18c1SBarry Smith typedef struct _n_PetscFunctionList *PetscFunctionList;
1599d382aafbSBarry Smith 
1600d382aafbSBarry Smith /*E
1601d382aafbSBarry Smith   PetscFileMode - Access mode for a file.
1602d382aafbSBarry Smith 
1603d382aafbSBarry Smith   Level: beginner
1604d382aafbSBarry Smith 
16051cc8b206SBarry Smith $  FILE_MODE_READ - open a file at its beginning for reading
16061cc8b206SBarry Smith $  FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist)
16071cc8b206SBarry Smith $  FILE_MODE_APPEND - open a file at end for writing
16081cc8b206SBarry Smith $  FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing
16091cc8b206SBarry Smith $  FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end
1610d382aafbSBarry Smith 
1611d382aafbSBarry Smith .seealso: PetscViewerFileSetMode()
1612d382aafbSBarry Smith E*/
1613d382aafbSBarry Smith typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode;
1614d6a4318aSJed Brown extern const char *const PetscFileModes[];
1615d6a4318aSJed Brown 
1616639ff905SBarry Smith /*
1617639ff905SBarry Smith     Defines PETSc error handling.
1618639ff905SBarry Smith */
1619639ff905SBarry Smith #include <petscerror.h>
1620d382aafbSBarry Smith 
16210700a824SBarry Smith #define PETSC_SMALLEST_CLASSID  1211211
1622014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID;
1623014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID;
1624014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *);
1625d382aafbSBarry Smith 
1626d382aafbSBarry Smith /*
1627d382aafbSBarry Smith    Routines that get memory usage information from the OS
1628d382aafbSBarry Smith */
1629014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *);
1630014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *);
1631014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void);
1632b44d5720SBarry Smith PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]);
1633d382aafbSBarry Smith 
1634014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInfoAllow(PetscBool ,const char []);
1635014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal);
1636d382aafbSBarry Smith 
1637d382aafbSBarry Smith /*
1638d382aafbSBarry Smith    Initialization of PETSc
1639d382aafbSBarry Smith */
1640014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]);
1641014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]);
1642014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void);
1643014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *);
1644014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *);
1645014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFinalize(void);
1646014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void);
1647014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***);
1648014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***);
1649014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **);
1650d382aafbSBarry Smith 
1651014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscEnd(void);
1652607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void);
1653d382aafbSBarry Smith 
1654014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]);
1655014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void);
1656014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void);
1657014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]);
1658d382aafbSBarry Smith 
1659d382aafbSBarry Smith /*
1660d382aafbSBarry Smith      These are so that in extern C code we can caste function pointers to non-extern C
16612981ebdbSBarry Smith    function pointers. Since the regular C++ code expects its function pointers to be C++
1662d382aafbSBarry Smith */
1663638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void);
1664638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void);
1665638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void);
1666d382aafbSBarry Smith 
1667d382aafbSBarry Smith /*
1668d382aafbSBarry Smith     Functions that can act on any PETSc object.
1669d382aafbSBarry Smith */
1670014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject*);
1671014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject,MPI_Comm *);
1672014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject,PetscClassId *);
1673014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject,const char *[]);
1674014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetType(PetscObject,const char []);
1675014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetPrecision(PetscObject,PetscPrecision);
1676014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject,const char *[]);
1677014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject,const char[]);
1678014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject,const char*[]);
1679014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject,PetscInt);
1680014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject,PetscInt*);
1681014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt);
1682014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject);
1683014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject,PetscInt*);
1684014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject);
1685014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject,PetscMPIInt *);
1686014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject,const char[],PetscObject);
1687014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject,const char[]);
1688014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject,const char[],PetscObject *);
1689bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject,const char[],void (*)(void));
1690bdf89e91SBarry Smith #define PetscObjectComposeFunction(a,b,d) PetscObjectComposeFunction_Private(a,b,(PetscVoidFunction)(d))
1691014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject);
1692014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject);
16930eb63584SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSetPrintedOptions(PetscObject);
16940eb63584SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectInheritPrintedOptions(PetscObject,PetscObject);
1695014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm,PetscMPIInt *);
1696d382aafbSBarry Smith 
1697665c2dedSJed Brown #include <petscviewertypes.h>
1698639ff905SBarry Smith #include <petscoptions.h>
1699639ff905SBarry Smith 
17000633abcbSJed Brown PETSC_EXTERN PetscErrorCode PetscObjectsListGetGlobalNumbering(MPI_Comm,PetscInt,PetscObject*,PetscInt*,PetscInt*);
17010633abcbSJed Brown 
1702639ff905SBarry Smith PETSC_EXTERN PetscErrorCode PetscMemoryShowUsage(PetscViewer,const char[]);
1703c5e4d11fSDmitry Karpeev PETSC_EXTERN PetscErrorCode PetscMemoryView(PetscViewer,const char[]);
1704dae58748SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject,PetscViewer);
1705639ff905SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject,PetscViewer);
17060005d66cSJed Brown #define PetscObjectQueryFunction(obj,name,fptr) PetscObjectQueryFunction_Private((obj),(name),(PetscVoidFunction*)(fptr))
17070005d66cSJed Brown PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject,const char[],void (**)(void));
1708014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject,const char[]);
1709014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject,const char[]);
1710014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject,const char[]);
1711014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject,const char*[]);
1712014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject,const char[]);
1713014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject);
1714014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void);
1715685405a1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject,PetscObject,const char[]);
1716014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject);
1717014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject,const char[],PetscBool *);
1718014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject,PetscBool*,const char[],...);
1719014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void));
1720014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void);
1721d382aafbSBarry Smith 
1722e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
17237aab2a10SBarry Smith PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void);
1724e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject);
1725e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject,PetscBool);
1726e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject);
1727e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject);
1728e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject);
1729e04113cfSBarry Smith PETSC_EXTERN void           PetscStackSAWsGrantAccess(void);
1730e04113cfSBarry Smith PETSC_EXTERN void           PetscStackSAWsTakeAccess(void);
1731e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void);
1732e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void);
173315681b3cSBarry Smith 
1734ec7429eaSBarry Smith #else
17357aab2a10SBarry Smith #define PetscSAWsBlock()                        0
1736e04113cfSBarry Smith #define PetscObjectSAWsViewOff(obj)             0
1737e04113cfSBarry Smith #define PetscObjectSAWsSetBlock(obj,flg)        0
1738e04113cfSBarry Smith #define PetscObjectSAWsBlock(obj)               0
1739e04113cfSBarry Smith #define PetscObjectSAWsGrantAccess(obj)         0
1740e04113cfSBarry Smith #define PetscObjectSAWsTakeAccess(obj)          0
1741e04113cfSBarry Smith #define PetscStackViewSAWs()                    0
1742e04113cfSBarry Smith #define PetscStackSAWsViewOff()                 0
1743e04113cfSBarry Smith #define PetscStackSAWsTakeAccess()
1744e04113cfSBarry Smith #define PetscStackSAWsGrantAccess()
174515681b3cSBarry Smith 
1746ec7429eaSBarry Smith #endif
1747b90c6cbeSBarry Smith 
17487d5d4d99SBarry Smith typedef void* PetscDLHandle;
1749e4d177b5SBarry Smith typedef enum {PETSC_DL_DECIDE=0,PETSC_DL_NOW=1,PETSC_DL_LOCAL=2} PetscDLMode;
175082b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *);
175182b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *);
175282b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **);
17537d5d4d99SBarry Smith 
17545fe58b6fSBarry Smith #if defined(PETSC_USE_DEBUG)
1755a64a8e02SBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**);
17565fe58b6fSBarry Smith #endif
17577eb1d149SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool);
1758a64a8e02SBarry Smith 
1759d382aafbSBarry Smith /*S
1760140e18c1SBarry Smith      PetscObjectList - Linked list of PETSc objects, each accessable by string name
1761d382aafbSBarry Smith 
17621d0fab5eSBarry Smith    Level: developer
1763d382aafbSBarry Smith 
17641d0fab5eSBarry Smith    Notes: Used by PetscObjectCompose() and PetscObjectQuery()
17651d0fab5eSBarry Smith 
1766140e18c1SBarry Smith .seealso:  PetscObjectListAdd(), PetscObjectListDestroy(), PetscObjectListFind(), PetscObjectCompose(), PetscObjectQuery(), PetscFunctionList
1767d382aafbSBarry Smith S*/
1768140e18c1SBarry Smith typedef struct _n_PetscObjectList *PetscObjectList;
1769d382aafbSBarry Smith 
1770140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList*);
1771140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList,const char[],PetscObject*);
1772140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList,PetscObject,char**,PetscBool*);
1773140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *,const char[],PetscObject);
1774140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *,const char[]);
1775140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList,PetscObjectList *);
1776d382aafbSBarry Smith 
1777d382aafbSBarry Smith /*
1778503cfb0cSBarry Smith     Dynamic library lists. Lists of names of routines in objects or in dynamic
1779d382aafbSBarry Smith   link libraries that will be loaded as needed.
1780d382aafbSBarry Smith */
1781a240a19fSJed Brown 
1782a240a19fSJed Brown #define PetscFunctionListAdd(list,name,fptr) PetscFunctionListAdd_Private((list),(name),(PetscVoidFunction)(fptr))
1783a240a19fSJed Brown PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList*,const char[],void (*)(void));
1784140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList*);
17851c9cd337SJed Brown #define PetscFunctionListFind(list,name,fptr) PetscFunctionListFind_Private((list),(name),(PetscVoidFunction*)(fptr))
17861c9cd337SJed Brown PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList,const char[],void (**)(void));
1787140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFunctionList,const char[]);
1788140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList,PetscFunctionList *);
1789140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList,PetscViewer);
1790140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList,const char ***,int*);
1791d382aafbSBarry Smith 
1792d382aafbSBarry Smith /*S
1793d382aafbSBarry Smith      PetscDLLibrary - Linked list of dynamics libraries to search for functions
1794d382aafbSBarry Smith 
1795d382aafbSBarry Smith    Level: advanced
1796d382aafbSBarry Smith 
1797d382aafbSBarry Smith .seealso:  PetscDLLibraryOpen()
1798d382aafbSBarry Smith S*/
1799d382aafbSBarry Smith typedef struct _n_PetscDLLibrary *PetscDLLibrary;
1800014dd563SJed Brown PETSC_EXTERN PetscDLLibrary  PetscDLLibrariesLoaded;
1801014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]);
1802014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]);
1803014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **);
1804014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary);
1805014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool  *);
1806014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *);
1807014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary);
1808d382aafbSBarry Smith 
1809d382aafbSBarry Smith /*
1810d382aafbSBarry Smith      Useful utility routines
1811d382aafbSBarry Smith */
1812014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*);
1813014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*);
1814014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt);
1815014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt);
1816014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject);
1817014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*);
1818d382aafbSBarry Smith 
1819503cfb0cSBarry Smith /*
1820ace3abfcSBarry Smith     PetscNot - negates a logical type value and returns result as a PetscBool
1821503cfb0cSBarry Smith 
1822503cfb0cSBarry Smith     Notes: This is useful in cases like
1823503cfb0cSBarry Smith $     int        *a;
1824ace3abfcSBarry Smith $     PetscBool  flag = PetscNot(a)
18251cc8b206SBarry Smith      where !a would not return a PetscBool because we cannot provide a cast from int to PetscBool in C.
1826503cfb0cSBarry Smith */
1827d382aafbSBarry Smith #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)
1828503cfb0cSBarry Smith 
1829d382aafbSBarry Smith /*MC
1830d382aafbSBarry Smith     PetscHelpPrintf - Prints help messages.
1831d382aafbSBarry Smith 
1832d382aafbSBarry Smith    Synopsis:
1833aaa7dc30SBarry Smith     #include <petscsys.h>
1834d382aafbSBarry Smith      PetscErrorCode (*PetscHelpPrintf)(const char format[],...);
1835d382aafbSBarry Smith 
1836eca87e8dSBarry Smith     Not Collective
1837eca87e8dSBarry Smith 
1838d382aafbSBarry Smith     Input Parameters:
1839d382aafbSBarry Smith .   format - the usual printf() format string
1840d382aafbSBarry Smith 
1841d382aafbSBarry Smith    Level: developer
1842d382aafbSBarry Smith 
1843d382aafbSBarry Smith     Fortran Note:
1844d382aafbSBarry Smith     This routine is not supported in Fortran.
1845d382aafbSBarry Smith 
1846d382aafbSBarry Smith     Concepts: help messages^printing
1847d382aafbSBarry Smith     Concepts: printing^help messages
1848d382aafbSBarry Smith 
1849d382aafbSBarry Smith .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf()
1850d382aafbSBarry Smith M*/
1851014dd563SJed Brown PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...);
1852d382aafbSBarry Smith 
1853fcfd50ebSBarry Smith /*
1854fcfd50ebSBarry Smith      Defines PETSc profiling.
1855fcfd50ebSBarry Smith */
18562c8e378dSBarry Smith #include <petsclog.h>
1857fcfd50ebSBarry Smith 
1858fcfd50ebSBarry Smith /*
1859fcfd50ebSBarry Smith       Simple PETSc parallel IO for ASCII printing
1860fcfd50ebSBarry Smith */
1861014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]);
1862014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**);
1863014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*);
1864014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...);
1865014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...);
1866014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...);
1867014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...);
1868fcfd50ebSBarry Smith 
1869014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...);
1870014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...);
1871014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...);
1872d382aafbSBarry Smith 
1873d382aafbSBarry Smith #if defined(PETSC_HAVE_POPEN)
1874014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **);
187596a8e8cbSBarry Smith PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm,FILE*,int*);
187674ba8654SBarry Smith PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]);
1877d382aafbSBarry Smith #endif
1878d382aafbSBarry Smith 
1879014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm,const char[],...);
1880014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...);
18810ec8b6e3SBarry Smith PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm,FILE*);
1882014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]);
1883014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**);
1884014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm,const char[],const char[],FILE**);
1885014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char*[]);
1886d382aafbSBarry Smith 
1887014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPopUpSelect(MPI_Comm,const char*,const char*,int,const char**,int*);
1888d382aafbSBarry Smith 
1889d382aafbSBarry Smith /*S
1890d382aafbSBarry Smith      PetscContainer - Simple PETSc object that contains a pointer to any required data
1891d382aafbSBarry Smith 
1892d382aafbSBarry Smith    Level: advanced
1893d382aafbSBarry Smith 
1894d382aafbSBarry Smith .seealso:  PetscObject, PetscContainerCreate()
1895d382aafbSBarry Smith S*/
1896014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID;
1897d382aafbSBarry Smith typedef struct _p_PetscContainer*  PetscContainer;
1898014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer,void **);
1899014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer,void *);
1900014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer*);
1901014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm,PetscContainer *);
1902014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void*));
1903d382aafbSBarry Smith 
1904d382aafbSBarry Smith /*
1905d382aafbSBarry Smith    For use in debuggers
1906d382aafbSBarry Smith */
1907014dd563SJed Brown PETSC_EXTERN PetscMPIInt PetscGlobalRank;
1908014dd563SJed Brown PETSC_EXTERN PetscMPIInt PetscGlobalSize;
1909014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt,const PetscInt[],PetscViewer);
1910014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt,const PetscReal[],PetscViewer);
1911014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt,const PetscScalar[],PetscViewer);
1912d382aafbSBarry Smith 
1913a663daf8SBarry Smith #include <stddef.h>
1914a3aaec0aSJed Brown #include <string.h>             /* for memcpy, memset */
1915d382aafbSBarry Smith #if defined(PETSC_HAVE_STDLIB_H)
1916d382aafbSBarry Smith #include <stdlib.h>
1917d382aafbSBarry Smith #endif
19186c7e564aSBarry Smith 
19194a92a979SJed Brown #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__)
1920d382aafbSBarry Smith #include <xmmintrin.h>
1921d382aafbSBarry Smith #endif
1922d382aafbSBarry Smith 
1923fcfd50ebSBarry Smith #undef __FUNCT__
1924fcfd50ebSBarry Smith #define __FUNCT__ "PetscMemcpy"
1925d382aafbSBarry Smith /*@C
1926d382aafbSBarry Smith    PetscMemcpy - Copies n bytes, beginning at location b, to the space
1927d382aafbSBarry Smith    beginning at location a. The two memory regions CANNOT overlap, use
1928d382aafbSBarry Smith    PetscMemmove() in that case.
1929d382aafbSBarry Smith 
1930d382aafbSBarry Smith    Not Collective
1931d382aafbSBarry Smith 
1932d382aafbSBarry Smith    Input Parameters:
1933d382aafbSBarry Smith +  b - pointer to initial memory space
1934d382aafbSBarry Smith -  n - length (in bytes) of space to copy
1935d382aafbSBarry Smith 
1936d382aafbSBarry Smith    Output Parameter:
1937d382aafbSBarry Smith .  a - pointer to copy space
1938d382aafbSBarry Smith 
1939d382aafbSBarry Smith    Level: intermediate
1940d382aafbSBarry Smith 
1941d382aafbSBarry Smith    Compile Option:
1942d382aafbSBarry Smith     PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used
1943d382aafbSBarry Smith                                   for memory copies on double precision values.
1944d382aafbSBarry Smith     PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used
1945d382aafbSBarry Smith                                   for memory copies on double precision values.
1946d382aafbSBarry Smith     PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used
1947d382aafbSBarry Smith                                   for memory copies on double precision values.
1948d382aafbSBarry Smith 
1949d382aafbSBarry Smith    Note:
1950d382aafbSBarry Smith    This routine is analogous to memcpy().
1951d382aafbSBarry Smith 
1952503cfb0cSBarry Smith    Developer Note: this is inlined for fastest performance
1953503cfb0cSBarry Smith 
1954d382aafbSBarry Smith   Concepts: memory^copying
1955d382aafbSBarry Smith   Concepts: copying^memory
1956d382aafbSBarry Smith 
1957d382aafbSBarry Smith .seealso: PetscMemmove()
1958d382aafbSBarry Smith 
1959d382aafbSBarry Smith @*/
19607087cfbeSBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscMemcpy(void *a,const void *b,size_t n)
1961d382aafbSBarry Smith {
1962d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG)
1963c5e4d11fSDmitry Karpeev   size_t al = (size_t) a,bl = (size_t) b;
1964c5e4d11fSDmitry Karpeev   size_t nl = (size_t) n;
1965a7e36092SMatthew G Knepley   PetscFunctionBegin;
1966e32f2f54SBarry Smith   if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer");
1967e32f2f54SBarry Smith   if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer");
1968a7e36092SMatthew G Knepley #else
1969d382aafbSBarry Smith   PetscFunctionBegin;
1970a7e36092SMatthew G Knepley #endif
1971a47a537aSLisandro Dalcin   if (a != b && n > 0) {
1972d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG)
1973e47d2de2SBarry 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\
1974d382aafbSBarry Smith               or make sure your copy regions and lengths are correct. \n\
1975d382aafbSBarry Smith               Length (bytes) %ld first address %ld second address %ld",nl,al,bl);
1976d382aafbSBarry Smith #endif
1977d382aafbSBarry Smith #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY))
1978c5e4d11fSDmitry Karpeev    if (!(a % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1979d382aafbSBarry Smith       size_t len = n/sizeof(PetscScalar);
1980d382aafbSBarry Smith #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY)
1981c5df96a5SBarry Smith       PetscBLASInt   one = 1,blen;
1982c5df96a5SBarry Smith       PetscErrorCode ierr;
1983c5df96a5SBarry Smith       ierr = PetscBLASIntCast(len,&blen);CHKERRQ(ierr);
19848b83055fSJed Brown       PetscStackCallBLAS("BLAScopy",BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one));
1985d382aafbSBarry Smith #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY)
1986d382aafbSBarry Smith       fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a);
1987d382aafbSBarry Smith #else
1988d382aafbSBarry Smith       size_t      i;
1989d382aafbSBarry Smith       PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a;
1990d382aafbSBarry Smith       for (i=0; i<len; i++) y[i] = x[i];
1991d382aafbSBarry Smith #endif
1992d382aafbSBarry Smith     } else {
1993d382aafbSBarry Smith       memcpy((char*)(a),(char*)(b),n);
1994d382aafbSBarry Smith     }
1995d382aafbSBarry Smith #else
1996d382aafbSBarry Smith     memcpy((char*)(a),(char*)(b),n);
1997d382aafbSBarry Smith #endif
1998d382aafbSBarry Smith   }
1999d382aafbSBarry Smith   PetscFunctionReturn(0);
2000d382aafbSBarry Smith }
2001d382aafbSBarry Smith 
2002d382aafbSBarry Smith /*@C
2003d382aafbSBarry Smith    PetscMemzero - Zeros the specified memory.
2004d382aafbSBarry Smith 
2005d382aafbSBarry Smith    Not Collective
2006d382aafbSBarry Smith 
2007d382aafbSBarry Smith    Input Parameters:
2008d382aafbSBarry Smith +  a - pointer to beginning memory location
2009d382aafbSBarry Smith -  n - length (in bytes) of memory to initialize
2010d382aafbSBarry Smith 
2011d382aafbSBarry Smith    Level: intermediate
2012d382aafbSBarry Smith 
2013d382aafbSBarry Smith    Compile Option:
2014d382aafbSBarry Smith    PETSC_PREFER_BZERO - on certain machines (the IBM RS6000) the bzero() routine happens
2015d382aafbSBarry Smith   to be faster than the memset() routine. This flag causes the bzero() routine to be used.
2016d382aafbSBarry Smith 
2017503cfb0cSBarry Smith    Developer Note: this is inlined for fastest performance
2018503cfb0cSBarry Smith 
2019d382aafbSBarry Smith    Concepts: memory^zeroing
2020d382aafbSBarry Smith    Concepts: zeroing^memory
2021d382aafbSBarry Smith 
2022d382aafbSBarry Smith .seealso: PetscMemcpy()
2023d382aafbSBarry Smith @*/
20247087cfbeSBarry Smith PETSC_STATIC_INLINE PetscErrorCode  PetscMemzero(void *a,size_t n)
2025d382aafbSBarry Smith {
2026d382aafbSBarry Smith   if (n > 0) {
2027d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG)
2028e32f2f54SBarry Smith     if (!a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer");
2029d382aafbSBarry Smith #endif
2030d382aafbSBarry Smith #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO)
2031d382aafbSBarry Smith     if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
2032d382aafbSBarry Smith       size_t      i,len = n/sizeof(PetscScalar);
2033d382aafbSBarry Smith       PetscScalar *x = (PetscScalar*)a;
2034d382aafbSBarry Smith       for (i=0; i<len; i++) x[i] = 0.0;
2035d382aafbSBarry Smith     } else {
2036d382aafbSBarry Smith #elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
2037d382aafbSBarry Smith     if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
2038d382aafbSBarry Smith       PetscInt len = n/sizeof(PetscScalar);
2039d382aafbSBarry Smith       fortranzero_(&len,(PetscScalar*)a);
2040d382aafbSBarry Smith     } else {
2041d382aafbSBarry Smith #endif
2042d382aafbSBarry Smith #if defined(PETSC_PREFER_BZERO)
2043d382aafbSBarry Smith       bzero((char *)a,n);
2044d382aafbSBarry Smith #else
2045d382aafbSBarry Smith       memset((char*)a,0,n);
2046d382aafbSBarry Smith #endif
2047d382aafbSBarry Smith #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
2048d382aafbSBarry Smith     }
2049d382aafbSBarry Smith #endif
2050d382aafbSBarry Smith   }
2051d382aafbSBarry Smith   return 0;
2052d382aafbSBarry Smith }
2053d382aafbSBarry Smith 
2054d382aafbSBarry Smith /*MC
2055d382aafbSBarry Smith    PetscPrefetchBlock - Prefetches a block of memory
2056d382aafbSBarry Smith 
2057eca87e8dSBarry Smith    Synopsis:
2058aaa7dc30SBarry Smith     #include <petscsys.h>
2059eca87e8dSBarry Smith     void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t)
2060eca87e8dSBarry Smith 
2061d382aafbSBarry Smith    Not Collective
2062d382aafbSBarry Smith 
2063d382aafbSBarry Smith    Input Parameters:
2064d382aafbSBarry Smith +  a - pointer to first element to fetch (any type but usually PetscInt or PetscScalar)
2065d382aafbSBarry Smith .  n - number of elements to fetch
2066d382aafbSBarry Smith .  rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors)
206750d8bf02SJed Brown -  t - temporal locality (PETSC_PREFETCH_HINT_{NTA,T0,T1,T2}), see note
2068d382aafbSBarry Smith 
2069d382aafbSBarry Smith    Level: developer
2070d382aafbSBarry Smith 
2071d382aafbSBarry Smith    Notes:
2072d382aafbSBarry Smith    The last two arguments (rw and t) must be compile-time constants.
2073d382aafbSBarry Smith 
207450d8bf02SJed Brown    Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality.  Not all architectures offer
207550d8bf02SJed Brown    equivalent locality hints, but the following macros are always defined to their closest analogue.
207650d8bf02SJed 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).
207763cf1ef0SJed 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.
207863cf1ef0SJed Brown .  PETSC_PREFETCH_HINT_T1 - Fetch to level 2 and higher (not L1).
207963cf1ef0SJed Brown -  PETSC_PREFETCH_HINT_T2 - Fetch to high-level cache only.  (On many systems, T0 and T1 are equivalent.)
2080d382aafbSBarry Smith 
2081d382aafbSBarry Smith    This function does nothing on architectures that do not support prefetch and never errors (even if passed an invalid
2082d382aafbSBarry Smith    address).
2083d382aafbSBarry Smith 
2084d382aafbSBarry Smith    Concepts: memory
2085d382aafbSBarry Smith M*/
2086d382aafbSBarry Smith #define PetscPrefetchBlock(a,n,rw,t) do {                               \
2087d382aafbSBarry Smith     const char *_p = (const char*)(a),*_end = (const char*)((a)+(n));   \
2088d382aafbSBarry Smith     for ( ; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p,(rw),(t)); \
2089d382aafbSBarry Smith   } while (0)
2090d382aafbSBarry Smith 
2091d382aafbSBarry Smith /*
2092d382aafbSBarry Smith       Determine if some of the kernel computation routines use
2093d382aafbSBarry Smith    Fortran (rather than C) for the numerical calculations. On some machines
2094d382aafbSBarry Smith    and compilers (like complex numbers) the Fortran version of the routines
2095d382aafbSBarry Smith    is faster than the C/C++ versions. The flag --with-fortran-kernels
2096e2e64c6bSBarry Smith    should be used with ./configure to turn these on.
2097d382aafbSBarry Smith */
2098d382aafbSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS)
2099d382aafbSBarry Smith 
2100d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL)
2101d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTCRL
2102d382aafbSBarry Smith #endif
2103d382aafbSBarry Smith 
21045a11e1b2SBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM)
21055a11e1b2SBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM
2106d382aafbSBarry Smith #endif
2107d382aafbSBarry Smith 
2108d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
2109d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
2110d382aafbSBarry Smith #endif
2111d382aafbSBarry Smith 
2112d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
2113d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
2114d382aafbSBarry Smith #endif
2115d382aafbSBarry Smith 
2116d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM)
2117d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_NORM
2118d382aafbSBarry Smith #endif
2119d382aafbSBarry Smith 
2120d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
2121d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MAXPY
2122d382aafbSBarry Smith #endif
2123d382aafbSBarry Smith 
2124d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
2125d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
2126d382aafbSBarry Smith #endif
2127d382aafbSBarry Smith 
2128d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ)
2129d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ
2130d382aafbSBarry Smith #endif
2131d382aafbSBarry Smith 
2132d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
2133d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
2134d382aafbSBarry Smith #endif
2135d382aafbSBarry Smith 
2136d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
2137d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
2138d382aafbSBarry Smith #endif
2139d382aafbSBarry Smith 
2140d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
2141d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MDOT
2142d382aafbSBarry Smith #endif
2143d382aafbSBarry Smith 
2144d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
2145d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_XTIMESY
2146d382aafbSBarry Smith #endif
2147d382aafbSBarry Smith 
2148d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX)
2149d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_AYPX
2150d382aafbSBarry Smith #endif
2151d382aafbSBarry Smith 
2152d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY)
2153d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_WAXPY
2154d382aafbSBarry Smith #endif
2155d382aafbSBarry Smith 
2156d382aafbSBarry Smith #endif
2157d382aafbSBarry Smith 
2158d382aafbSBarry Smith /*
2159d382aafbSBarry Smith     Macros for indicating code that should be compiled with a C interface,
2160d382aafbSBarry Smith    rather than a C++ interface. Any routines that are dynamically loaded
2161d382aafbSBarry Smith    (such as the PCCreate_XXX() routines) must be wrapped so that the name
2162d382aafbSBarry Smith    mangler does not change the functions symbol name. This just hides the
2163d382aafbSBarry Smith    ugly extern "C" {} wrappers.
2164d382aafbSBarry Smith */
2165d382aafbSBarry Smith #if defined(__cplusplus)
2166d382aafbSBarry Smith #define EXTERN_C_BEGIN extern "C" {
2167d382aafbSBarry Smith #define EXTERN_C_END }
2168d382aafbSBarry Smith #else
2169d382aafbSBarry Smith #define EXTERN_C_BEGIN
2170d382aafbSBarry Smith #define EXTERN_C_END
2171d382aafbSBarry Smith #endif
2172d382aafbSBarry Smith 
2173d382aafbSBarry Smith /* --------------------------------------------------------------------*/
2174d382aafbSBarry Smith 
2175d382aafbSBarry Smith /*MC
2176d382aafbSBarry Smith     MPI_Comm - the basic object used by MPI to determine which processes are involved in a
2177d382aafbSBarry Smith         communication
2178d382aafbSBarry Smith 
2179d382aafbSBarry Smith    Level: beginner
2180d382aafbSBarry Smith 
2181d382aafbSBarry Smith    Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm
2182d382aafbSBarry Smith 
2183d382aafbSBarry Smith .seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF
2184d382aafbSBarry Smith M*/
2185d382aafbSBarry Smith 
2186d382aafbSBarry Smith /*MC
2187d382aafbSBarry Smith     PetscScalar - PETSc type that represents either a double precision real number, a double precision
2188d382aafbSBarry Smith        complex number, a single precision real number, a long double or an int - if the code is configured
21891cc8b206SBarry Smith        with --with-scalar-type=real,complex --with-precision=single,double,__float128
2190d382aafbSBarry Smith 
2191d382aafbSBarry Smith    Level: beginner
2192d382aafbSBarry Smith 
21931cc8b206SBarry Smith .seealso: PetscReal, MPIU_SCALAR, PetscInt, MPIU_REAL
2194d382aafbSBarry Smith M*/
2195d382aafbSBarry Smith 
2196d382aafbSBarry Smith /*MC
21978619c96cSJed Brown     PetscComplex - PETSc type that represents a complex number with precision matching that of PetscReal.
21988619c96cSJed Brown 
21998619c96cSJed Brown    Synopsis:
22008619c96cSJed Brown    #include <petscsys.h>
22018619c96cSJed Brown    PetscComplex number = 1. + 2.*PETSC_i;
22028619c96cSJed Brown 
22038619c96cSJed Brown    Level: beginner
22048619c96cSJed Brown 
22058619c96cSJed Brown    Note:
22068cd53115SBarry Smith    Complex numbers are automatically available if PETSc was able to find a working complex implementation
22078619c96cSJed Brown 
22088619c96cSJed Brown .seealso: PetscReal, PetscComplex, MPIU_COMPLEX, PetscInt, PETSC_i
22098619c96cSJed Brown M*/
22108619c96cSJed Brown 
22118619c96cSJed Brown /*MC
2212d382aafbSBarry Smith     PetscReal - PETSc type that represents a real number version of PetscScalar
2213d382aafbSBarry Smith 
2214d382aafbSBarry Smith    Level: beginner
2215d382aafbSBarry Smith 
22161cc8b206SBarry Smith .seealso: PetscScalar
2217d382aafbSBarry Smith M*/
2218d382aafbSBarry Smith 
2219d382aafbSBarry Smith /*MC
2220d382aafbSBarry Smith     MPIU_SCALAR - MPI datatype corresponding to PetscScalar
2221d382aafbSBarry Smith 
2222d382aafbSBarry Smith    Level: beginner
2223d382aafbSBarry Smith 
2224d382aafbSBarry Smith     Note: In MPI calls that require an MPI datatype that matches a PetscScalar or array of PetscScalars
2225d382aafbSBarry Smith           pass this value
2226d382aafbSBarry Smith 
22271cc8b206SBarry Smith .seealso: PetscReal, PetscScalar, MPIU_INT
2228d382aafbSBarry Smith M*/
2229d382aafbSBarry Smith 
2230d382aafbSBarry Smith #if defined(PETSC_HAVE_MPIIO)
2231d382aafbSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
2232014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2233014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2234d382aafbSBarry Smith #else
2235d382aafbSBarry Smith #define MPIU_File_write_all(a,b,c,d,e) MPI_File_write_all(a,b,c,d,e)
2236d382aafbSBarry Smith #define MPIU_File_read_all(a,b,c,d,e) MPI_File_read_all(a,b,c,d,e)
2237d382aafbSBarry Smith #endif
2238d382aafbSBarry Smith #endif
2239d382aafbSBarry Smith 
2240d382aafbSBarry Smith /* the following petsc_static_inline require petscerror.h */
2241d382aafbSBarry Smith 
2242d382aafbSBarry Smith /* Limit MPI to 32-bits */
2243d382aafbSBarry Smith #define PETSC_MPI_INT_MAX  2147483647
2244d382aafbSBarry Smith #define PETSC_MPI_INT_MIN -2147483647
2245d382aafbSBarry Smith /* Limit BLAS to 32-bits */
2246d382aafbSBarry Smith #define PETSC_BLAS_INT_MAX  2147483647
2247d382aafbSBarry Smith #define PETSC_BLAS_INT_MIN -2147483647
2248d382aafbSBarry Smith 
2249c5df96a5SBarry Smith #undef __FUNCT__
2250c5df96a5SBarry Smith #define __FUNCT__ "PetscBLASIntCast"
225161b0d812SBarry Smith /*@C
225261b0d812SBarry Smith     PetscBLASIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscBLASInt (which may be 32 bits in size), generates an
225361b0d812SBarry Smith          error if the PetscBLASInt is not large enough to hold the number.
225461b0d812SBarry Smith 
225561b0d812SBarry Smith    Not Collective
225661b0d812SBarry Smith 
225761b0d812SBarry Smith    Input Parameter:
225861b0d812SBarry Smith .     a - the PetscInt value
225961b0d812SBarry Smith 
226061b0d812SBarry Smith    Output Parameter:
226161b0d812SBarry Smith .     b - the resulting PetscBLASInt value
226261b0d812SBarry Smith 
226361b0d812SBarry Smith    Level: advanced
226461b0d812SBarry Smith 
226561b0d812SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscMPIIntCast()
226661b0d812SBarry Smith @*/
2267c5df96a5SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscBLASIntCast(PetscInt a,PetscBLASInt *b)
2268c5df96a5SBarry Smith {
2269c5df96a5SBarry Smith   PetscFunctionBegin;
2270ab7117d1SBarry Smith   *b =  (PetscBLASInt)(a);
2271c5df96a5SBarry Smith #if defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_HAVE_64BIT_BLAS_INDICES)
2272c5df96a5SBarry Smith   if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK");
2273c5df96a5SBarry Smith #endif
2274c5df96a5SBarry Smith   PetscFunctionReturn(0);
2275c5df96a5SBarry Smith }
2276c5df96a5SBarry Smith 
22774dc2109aSBarry Smith #undef __FUNCT__
22784dc2109aSBarry Smith #define __FUNCT__ "PetscMPIIntCast"
227961b0d812SBarry Smith /*@C
228061b0d812SBarry Smith     PetscMPIIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscMPIInt (which may be 32 bits in size), generates an
228161b0d812SBarry Smith          error if the PetscMPIInt is not large enough to hold the number.
228261b0d812SBarry Smith 
228361b0d812SBarry Smith    Not Collective
228461b0d812SBarry Smith 
228561b0d812SBarry Smith    Input Parameter:
228661b0d812SBarry Smith .     a - the PetscInt value
228761b0d812SBarry Smith 
228861b0d812SBarry Smith    Output Parameter:
228961b0d812SBarry Smith .     b - the resulting PetscMPIInt value
229061b0d812SBarry Smith 
229161b0d812SBarry Smith    Level: advanced
229261b0d812SBarry Smith 
229361b0d812SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast()
229461b0d812SBarry Smith @*/
22954dc2109aSBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscMPIIntCast(PetscInt a,PetscMPIInt *b)
22964dc2109aSBarry Smith {
22974dc2109aSBarry Smith   PetscFunctionBegin;
2298ab7117d1SBarry Smith   *b =  (PetscMPIInt)(a);
22994dc2109aSBarry Smith #if defined(PETSC_USE_64BIT_INDICES)
23004dc2109aSBarry Smith   if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for MPI");
23014dc2109aSBarry Smith #endif
23024dc2109aSBarry Smith   PetscFunctionReturn(0);
23034dc2109aSBarry Smith }
23044dc2109aSBarry Smith 
2305bafee8b4SSatish Balay #define PetscInt64Mult(a,b)   ((PetscInt64)(a))*((PetscInt64)(b))
23062f18eb33SBarry Smith 
23072f18eb33SBarry Smith #undef __FUNCT__
23082f18eb33SBarry Smith #define __FUNCT__ "PetscRealIntMultTruncate"
23092f18eb33SBarry Smith /*@C
23102f18eb33SBarry Smith 
23112f18eb33SBarry 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
23122f18eb33SBarry Smith 
23132f18eb33SBarry Smith    Not Collective
23142f18eb33SBarry Smith 
23152f18eb33SBarry Smith    Input Parameter:
23162f18eb33SBarry Smith +     a - the PetscReal value
23172f18eb33SBarry Smith -     b - the second value
23182f18eb33SBarry Smith 
23192f18eb33SBarry Smith    Output Parameter:
23202f18eb33SBarry Smith .     c - the result as a PetscInt value
23212f18eb33SBarry Smith 
2322bafee8b4SSatish Balay    Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
23232f18eb33SBarry Smith    Use PetscIntMultTruncate() to compute the product of two positive PetscInt and truncate to fit a PetscInt
23242f18eb33SBarry 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
23252f18eb33SBarry Smith 
23262f18eb33SBarry Smith    Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks.
23272f18eb33SBarry Smith 
23282f18eb33SBarry Smith    This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
23292f18eb33SBarry Smith 
23302f18eb33SBarry Smith    Level: advanced
23312f18eb33SBarry Smith 
23322f18eb33SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntMult64()
23332f18eb33SBarry Smith @*/
23342f18eb33SBarry Smith PETSC_STATIC_INLINE PetscInt PetscRealIntMultTruncate(PetscReal a,PetscInt b)
23352f18eb33SBarry Smith {
2336bafee8b4SSatish Balay   PetscInt64 r;
23372f18eb33SBarry Smith 
2338bafee8b4SSatish Balay   r  =  (PetscInt64) (a*(PetscReal)b);
23392f18eb33SBarry Smith   if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
23402f18eb33SBarry Smith   return (PetscInt) r;
23412f18eb33SBarry Smith }
23422f18eb33SBarry Smith 
23432f18eb33SBarry Smith #undef __FUNCT__
23442f18eb33SBarry Smith #define __FUNCT__ "PetscIntMultTruncate"
23452f18eb33SBarry Smith /*@C
23462f18eb33SBarry Smith 
23472f18eb33SBarry Smith    PetscIntMultTruncate - Computes the product of two positive PetscInt and truncates the value to slightly less than the maximal possible value
23482f18eb33SBarry Smith 
23492f18eb33SBarry Smith    Not Collective
23502f18eb33SBarry Smith 
23512f18eb33SBarry Smith    Input Parameter:
23522f18eb33SBarry Smith +     a - the PetscInt value
23532f18eb33SBarry Smith -     b - the second value
23542f18eb33SBarry Smith 
23552f18eb33SBarry Smith    Output Parameter:
23562f18eb33SBarry Smith .     c - the result as a PetscInt value
23572f18eb33SBarry Smith 
2358bafee8b4SSatish Balay    Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
23592f18eb33SBarry Smith    Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
23602f18eb33SBarry 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
23612f18eb33SBarry Smith 
23622f18eb33SBarry Smith    Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks.
23632f18eb33SBarry Smith 
23642f18eb33SBarry Smith    This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
23652f18eb33SBarry Smith 
23662f18eb33SBarry Smith    Level: advanced
23672f18eb33SBarry Smith 
23682f18eb33SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntMult64()
23692f18eb33SBarry Smith @*/
23702f18eb33SBarry Smith PETSC_STATIC_INLINE PetscInt PetscIntMultTruncate(PetscInt a,PetscInt b)
23712f18eb33SBarry Smith {
2372bafee8b4SSatish Balay   PetscInt64 r;
23732f18eb33SBarry Smith 
2374bafee8b4SSatish Balay   r  =  PetscInt64Mult(a,b);
23752f18eb33SBarry Smith   if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
23762f18eb33SBarry Smith   return (PetscInt) r;
23772f18eb33SBarry Smith }
23782f18eb33SBarry Smith 
23792f18eb33SBarry Smith #undef __FUNCT__
2380f91af8c7SBarry Smith #define __FUNCT__ "PetscIntSumTruncate"
2381f91af8c7SBarry Smith /*@C
2382f91af8c7SBarry Smith 
2383f91af8c7SBarry Smith    PetscIntSumTruncate - Computes the sum of two positive PetscInt and truncates the value to slightly less than the maximal possible value
2384f91af8c7SBarry Smith 
2385f91af8c7SBarry Smith    Not Collective
2386f91af8c7SBarry Smith 
2387f91af8c7SBarry Smith    Input Parameter:
2388f91af8c7SBarry Smith +     a - the PetscInt value
2389f91af8c7SBarry Smith -     b - the second value
2390f91af8c7SBarry Smith 
2391f91af8c7SBarry Smith    Output Parameter:
2392f91af8c7SBarry Smith .     c - the result as a PetscInt value
2393f91af8c7SBarry Smith 
2394bafee8b4SSatish Balay    Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2395f91af8c7SBarry Smith    Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
2396f91af8c7SBarry 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
2397f91af8c7SBarry Smith 
2398f91af8c7SBarry Smith    This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2399f91af8c7SBarry Smith 
2400f91af8c7SBarry Smith    Level: advanced
2401f91af8c7SBarry Smith 
2402f91af8c7SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntMult64()
2403f91af8c7SBarry Smith @*/
2404f91af8c7SBarry Smith PETSC_STATIC_INLINE PetscInt PetscIntSumTruncate(PetscInt a,PetscInt b)
2405f91af8c7SBarry Smith {
2406bafee8b4SSatish Balay   PetscInt64 r;
2407f91af8c7SBarry Smith 
2408bafee8b4SSatish Balay   r  =  ((PetscInt64)a) + ((PetscInt64)b);
2409f91af8c7SBarry Smith   if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2410f91af8c7SBarry Smith   return (PetscInt) r;
2411f91af8c7SBarry Smith }
2412f91af8c7SBarry Smith 
2413f91af8c7SBarry Smith #undef __FUNCT__
24142f18eb33SBarry Smith #define __FUNCT__ "PetscIntMultError"
24152f18eb33SBarry Smith /*@C
24162f18eb33SBarry Smith 
24172f18eb33SBarry Smith    PetscIntMultError - Computes the product of two positive PetscInt and generates an error with overflow.
24182f18eb33SBarry Smith 
24192f18eb33SBarry Smith    Not Collective
24202f18eb33SBarry Smith 
24212f18eb33SBarry Smith    Input Parameter:
24222f18eb33SBarry Smith +     a - the PetscInt value
24232f18eb33SBarry Smith -     b - the second value
24242f18eb33SBarry Smith 
24252f18eb33SBarry Smith    Output Parameter:ma
24262f18eb33SBarry Smith .     c - the result as a PetscInt value
24272f18eb33SBarry Smith 
2428bafee8b4SSatish Balay    Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64
24292f18eb33SBarry Smith    Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt
24302f18eb33SBarry Smith 
24312f18eb33SBarry Smith    Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks.
24322f18eb33SBarry Smith 
24332f18eb33SBarry Smith    Level: advanced
24342f18eb33SBarry Smith 
24352f18eb33SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntMult64()
24362f18eb33SBarry Smith @*/
24372f18eb33SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscIntMultError(PetscInt a,PetscInt b,PetscInt *result)
24382f18eb33SBarry Smith {
2439bafee8b4SSatish Balay   PetscInt64 r;
24402f18eb33SBarry Smith 
24412f18eb33SBarry Smith   PetscFunctionBegin;
2442bafee8b4SSatish Balay   r  =  PetscInt64Mult(a,b);
24432f18eb33SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES)
24442f18eb33SBarry 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);
24452f18eb33SBarry Smith #endif
2446f91af8c7SBarry Smith   if (result) *result = (PetscInt) r;
2447f91af8c7SBarry Smith   PetscFunctionReturn(0);
2448f91af8c7SBarry Smith }
2449f91af8c7SBarry Smith 
2450f91af8c7SBarry Smith  #undef __FUNCT__
2451f91af8c7SBarry Smith #define __FUNCT__ "PetscIntSumError"
2452f91af8c7SBarry Smith /*@C
2453f91af8c7SBarry Smith 
2454f91af8c7SBarry Smith    PetscIntSumError - Computes the product of two positive PetscInt and generates an error with overflow.
2455f91af8c7SBarry Smith 
2456f91af8c7SBarry Smith    Not Collective
2457f91af8c7SBarry Smith 
2458f91af8c7SBarry Smith    Input Parameter:
2459f91af8c7SBarry Smith +     a - the PetscInt value
2460f91af8c7SBarry Smith -     b - the second value
2461f91af8c7SBarry Smith 
2462f91af8c7SBarry Smith    Output Parameter:ma
2463f91af8c7SBarry Smith .     c - the result as a PetscInt value
2464f91af8c7SBarry Smith 
2465bafee8b4SSatish Balay    Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64
2466f91af8c7SBarry Smith    Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt
2467f91af8c7SBarry Smith 
2468f91af8c7SBarry Smith    Level: advanced
2469f91af8c7SBarry Smith 
2470f91af8c7SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntMult64()
2471f91af8c7SBarry Smith @*/
2472f91af8c7SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscIntSumError(PetscInt a,PetscInt b,PetscInt *result)
2473f91af8c7SBarry Smith {
2474bafee8b4SSatish Balay   PetscInt64 r;
2475f91af8c7SBarry Smith 
2476f91af8c7SBarry Smith   PetscFunctionBegin;
2477bafee8b4SSatish Balay   r  =  ((PetscInt64)a) + ((PetscInt64)b);
2478f91af8c7SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES)
2479f91af8c7SBarry 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);
2480f91af8c7SBarry Smith #endif
2481f91af8c7SBarry Smith   if (result) *result = (PetscInt) r;
24822f18eb33SBarry Smith   PetscFunctionReturn(0);
24832f18eb33SBarry Smith }
2484c5df96a5SBarry Smith 
2485d382aafbSBarry Smith /*
24862981ebdbSBarry Smith      The IBM include files define hz, here we hide it so that it may be used as a regular user variable.
2487d382aafbSBarry Smith */
2488d382aafbSBarry Smith #if defined(hz)
2489d382aafbSBarry Smith #undef hz
2490d382aafbSBarry Smith #endif
2491d382aafbSBarry Smith 
2492d382aafbSBarry Smith /*  For arrays that contain filenames or paths */
2493d382aafbSBarry Smith 
2494d382aafbSBarry Smith 
2495d382aafbSBarry Smith #if defined(PETSC_HAVE_LIMITS_H)
2496d382aafbSBarry Smith #include <limits.h>
2497d382aafbSBarry Smith #endif
2498d382aafbSBarry Smith #if defined(PETSC_HAVE_SYS_PARAM_H)
2499d382aafbSBarry Smith #include <sys/param.h>
2500d382aafbSBarry Smith #endif
2501d382aafbSBarry Smith #if defined(PETSC_HAVE_SYS_TYPES_H)
2502d382aafbSBarry Smith #include <sys/types.h>
2503d382aafbSBarry Smith #endif
2504d382aafbSBarry Smith #if defined(MAXPATHLEN)
2505d382aafbSBarry Smith #  define PETSC_MAX_PATH_LEN     MAXPATHLEN
2506d382aafbSBarry Smith #elif defined(MAX_PATH)
2507d382aafbSBarry Smith #  define PETSC_MAX_PATH_LEN     MAX_PATH
2508d382aafbSBarry Smith #elif defined(_MAX_PATH)
2509d382aafbSBarry Smith #  define PETSC_MAX_PATH_LEN     _MAX_PATH
2510d382aafbSBarry Smith #else
2511d382aafbSBarry Smith #  define PETSC_MAX_PATH_LEN     4096
2512d382aafbSBarry Smith #endif
2513d382aafbSBarry Smith 
2514d382aafbSBarry Smith /*MC
2515d382aafbSBarry Smith 
2516d382aafbSBarry Smith     UsingFortran - Fortran can be used with PETSc in four distinct approaches
2517d382aafbSBarry Smith 
2518d382aafbSBarry Smith $    1) classic Fortran 77 style
2519af0996ceSBarry Smith $#include "petsc/finclude/petscXXX.h" to work with material from the XXX component of PETSc
2520d382aafbSBarry Smith $       XXX variablename
2521d382aafbSBarry Smith $      You cannot use this approach if you wish to use the Fortran 90 specific PETSc routines
2522d382aafbSBarry Smith $      which end in F90; such as VecGetArrayF90()
2523d382aafbSBarry Smith $
2524d382aafbSBarry Smith $    2) classic Fortran 90 style
2525af0996ceSBarry Smith $#include "petsc/finclude/petscXXX.h"
2526af0996ceSBarry Smith $#include "petsc/finclude/petscXXX.h90" to work with material from the XXX component of PETSc
2527d382aafbSBarry Smith $       XXX variablename
2528d382aafbSBarry Smith $
2529d382aafbSBarry Smith $    3) Using Fortran modules
2530af0996ceSBarry Smith $#include "petsc/finclude/petscXXXdef.h"
2531d382aafbSBarry Smith $         use petscXXXX
2532d382aafbSBarry Smith $       XXX variablename
2533d382aafbSBarry Smith $
2534d382aafbSBarry Smith $    4) Use Fortran modules and Fortran data types for PETSc types
2535af0996ceSBarry Smith $#include "petsc/finclude/petscXXXdef.h"
2536d382aafbSBarry Smith $         use petscXXXX
2537d382aafbSBarry Smith $       type(XXX) variablename
2538e2e64c6bSBarry Smith $      To use this approach you must ./configure PETSc with the additional
2539d382aafbSBarry Smith $      option --with-fortran-datatypes You cannot use the type(XXX) declaration approach without using Fortran modules
2540d382aafbSBarry Smith 
2541d382aafbSBarry Smith     Finally if you absolutely do not want to use any #include you can use either
2542d382aafbSBarry Smith 
2543d382aafbSBarry Smith $    3a) skip the #include BUT you cannot use any PETSc data type names like Vec, Mat, PetscInt, PetscErrorCode etc
2544d382aafbSBarry Smith $        and you must declare the variables as integer, for example
2545d382aafbSBarry Smith $        integer variablename
2546d382aafbSBarry Smith $
2547d382aafbSBarry Smith $    4a) skip the #include, you use the object types like type(Vec) type(Mat) but cannot use the data type
2548d382aafbSBarry Smith $        names like PetscErrorCode, PetscInt etc. again for those you must use integer
2549d382aafbSBarry Smith 
2550d382aafbSBarry Smith    We recommend either 2 or 3. Approaches 2 and 3 provide type checking for most PETSc function calls; 4 has type checking
2551d382aafbSBarry Smith for only a few PETSc functions.
2552d382aafbSBarry Smith 
2553d382aafbSBarry Smith    Fortran type checking with interfaces is strick, this means you cannot pass a scalar value when an array value
2554d382aafbSBarry Smith is expected (even though it is legal Fortran). For example when setting a single value in a matrix with MatSetValues()
2555d382aafbSBarry Smith you cannot have something like
2556d382aafbSBarry Smith $      PetscInt row,col
2557d382aafbSBarry Smith $      PetscScalar val
2558d382aafbSBarry Smith $        ...
2559d382aafbSBarry Smith $      call MatSetValues(mat,1,row,1,col,val,INSERT_VALUES,ierr)
2560d382aafbSBarry Smith You must instead have
2561d382aafbSBarry Smith $      PetscInt row(1),col(1)
2562d382aafbSBarry Smith $      PetscScalar val(1)
2563d382aafbSBarry Smith $        ...
2564d382aafbSBarry Smith $      call MatSetValues(mat,1,row,1,col,val,INSERT_VALUES,ierr)
2565d382aafbSBarry Smith 
2566d382aafbSBarry Smith 
2567d382aafbSBarry Smith     See the example src/vec/vec/examples/tutorials/ex20f90.F90 for an example that can use all four approaches
2568d382aafbSBarry Smith 
2569af0996ceSBarry Smith     Developer Notes: The petsc/finclude/petscXXXdef.h contain all the #defines (would be typedefs in C code) these
2570af0996ceSBarry Smith      automatically include their predecessors; for example petsc/finclude/petscvecdef.h includes petsc/finclude/petscisdef.h
2571d382aafbSBarry Smith 
2572af0996ceSBarry Smith      The petsc/finclude/petscXXXX.h contain all the parameter statements for that package. These automatically include
2573af0996ceSBarry Smith      their petsc/finclude/petscXXXdef.h file but DO NOT automatically include their predecessors;  for example
2574af0996ceSBarry Smith      petsc/finclude/petscvec.h does NOT automatically include petsc/finclude/petscis.h
2575d382aafbSBarry Smith 
2576af0996ceSBarry Smith      The petsc/finclude/ftn-custom/petscXXXdef.h90 are not intended to be used directly in code, they define the
2577e2e64c6bSBarry Smith      Fortran data type type(XXX) (for example type(Vec)) when PETSc is ./configure with the --with-fortran-datatypes option.
2578d382aafbSBarry Smith 
2579af0996ceSBarry Smith      The petsc/finclude/ftn-custom/petscXXX.h90 (not included directly by code) contain interface definitions for
2580d382aafbSBarry Smith      the PETSc Fortran stubs that have different bindings then their C version (for example VecGetArrayF90).
2581d382aafbSBarry Smith 
2582af0996ceSBarry Smith      The petsc/finclude/ftn-auto/petscXXX.h90 (not included directly by code) contain interface definitions generated
2583d382aafbSBarry Smith      automatically by "make allfortranstubs".
2584d382aafbSBarry Smith 
2585af0996ceSBarry Smith      The petsc/finclude/petscXXX.h90 includes the custom petsc/finclude/ftn-custom/petscXXX.h90 and if ./configure
2586af0996ceSBarry Smith      was run with --with-fortran-interfaces it also includes the petsc/finclude/ftn-auto/petscXXX.h90 These DO NOT automatically
2587d382aafbSBarry Smith      include their predecessors
2588d382aafbSBarry Smith 
2589d382aafbSBarry Smith     Level: beginner
2590d382aafbSBarry Smith 
2591d382aafbSBarry Smith M*/
2592d382aafbSBarry Smith 
2593014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t);
2594014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t);
2595014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t);
2596014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t);
2597014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]);
2598014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t);
259927710113SBarry Smith PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t);
2600*5f309d01SBarry Smith PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt*,PetscInt*,PetscInt*,PetscInt*);
2601d382aafbSBarry Smith 
2602014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt,PetscInt[]);
2603014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt*,PetscInt[]);
260460e03357SMatthew G Knepley PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt*);
2605014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]);
2606014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]);
2607014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]);
2608014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt,PetscInt*,PetscInt*,PetscInt*);
260917d7d925SStefano Zampini PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt,PetscMPIInt[]);
261017d7d925SStefano Zampini PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt*,PetscMPIInt[]);
2611014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]);
2612014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]);
261317df18f2SToby Isaac PETSC_EXTERN PetscErrorCode PetscSortIntWithDataArray(PetscInt,PetscInt[],void*,size_t,void*);
2614014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt,PetscReal[]);
2615014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]);
2616745b41b2SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt*,PetscReal[]);
2617014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]);
2618014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]);
2619014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt,const PetscBool [],const PetscInt[],PetscInt*,PetscInt**,PetscInt**,PetscInt**,PetscInt**);
2620014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt,const PetscInt*,const PetscInt*,PetscInt,const PetscInt*,const PetscInt*,PetscInt*,PetscInt**,PetscInt**);
262121e72a00SBarry Smith PETSC_EXTERN PetscErrorCode PetscMergeIntArray(PetscInt,const PetscInt*,PetscInt,const PetscInt*,PetscInt*,PetscInt**);
2622e498c390SJed Brown PETSC_EXTERN PetscErrorCode PetscMergeMPIIntArray(PetscInt,const PetscMPIInt[],PetscInt,const PetscMPIInt[],PetscInt*,PetscMPIInt**);
2623d382aafbSBarry Smith 
2624014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDisplay(void);
2625014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t);
2626d382aafbSBarry Smith 
262776bdecfbSBarry Smith /*J
2628d382aafbSBarry Smith     PetscRandomType - String with the name of a PETSc randomizer
2629d382aafbSBarry Smith 
2630d382aafbSBarry Smith    Level: beginner
2631d382aafbSBarry Smith 
2632e2e64c6bSBarry Smith    Notes: to use the SPRNG you must have ./configure PETSc
2633d382aafbSBarry Smith    with the option --download-sprng
2634d382aafbSBarry Smith 
26358f6c3df8SBarry Smith .seealso: PetscRandomSetType(), PetscRandom, PetscRandomCreate()
263676bdecfbSBarry Smith J*/
263719fd82e9SBarry Smith typedef const char* PetscRandomType;
2638d382aafbSBarry Smith #define PETSCRAND       "rand"
2639d382aafbSBarry Smith #define PETSCRAND48     "rand48"
2640d382aafbSBarry Smith #define PETSCSPRNG      "sprng"
2641c5e4d11fSDmitry Karpeev #define PETSCRANDER48   "rander48"
2642d382aafbSBarry Smith 
2643d382aafbSBarry Smith /* Logging support */
2644014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID;
2645d382aafbSBarry Smith 
2646607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void);
2647d382aafbSBarry Smith 
2648d382aafbSBarry Smith /*S
2649d382aafbSBarry Smith      PetscRandom - Abstract PETSc object that manages generating random numbers
2650d382aafbSBarry Smith 
2651d382aafbSBarry Smith    Level: intermediate
2652d382aafbSBarry Smith 
2653d382aafbSBarry Smith   Concepts: random numbers
2654d382aafbSBarry Smith 
2655d382aafbSBarry Smith .seealso:  PetscRandomCreate(), PetscRandomGetValue(), PetscRandomType
2656d382aafbSBarry Smith S*/
2657d382aafbSBarry Smith typedef struct _p_PetscRandom*   PetscRandom;
2658d382aafbSBarry Smith 
2659d382aafbSBarry Smith /* Dynamic creation and loading functions */
2660140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList PetscRandomList;
2661d382aafbSBarry Smith 
2662bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],PetscErrorCode (*)(PetscRandom));
266319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType);
2664014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom);
266519fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType*);
2666685405a1SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscRandomViewFromOptions(PetscRandom A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
2667014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer);
2668d382aafbSBarry Smith 
2669014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*);
2670014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*);
2671014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*);
2672014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*);
2673014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar);
2674014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long);
2675014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *);
2676014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom);
2677014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*);
2678d382aafbSBarry Smith 
2679014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t);
2680014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t);
2681014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t);
2682014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]);
2683014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t);
2684014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *);
2685014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *);
268697540f07SSatish Balay PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]);
268797540f07SSatish Balay PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]);
2688d382aafbSBarry Smith 
2689014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscDataType);
2690014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscDataType);
2691014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,void*,PetscInt,PetscDataType,PetscBool );
2692014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,void*,PetscInt,PetscDataType,PetscBool );
2693014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *);
2694014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryClose(int);
2695014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool  *);
2696014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool  *);
2697014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t);
2698014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *);
2699014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *);
2700e2fc02c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[],int,int*);
2701d382aafbSBarry Smith 
2702d382aafbSBarry Smith /*
2703d382aafbSBarry Smith    In binary files variables are stored using the following lengths,
2704d382aafbSBarry Smith   regardless of how they are stored in memory on any one particular
2705d382aafbSBarry Smith   machine. Use these rather then sizeof() in computing sizes for
2706d382aafbSBarry Smith   PetscBinarySeek().
2707d382aafbSBarry Smith */
2708d382aafbSBarry Smith #define PETSC_BINARY_INT_SIZE   (32/8)
2709d382aafbSBarry Smith #define PETSC_BINARY_FLOAT_SIZE  (32/8)
2710d382aafbSBarry Smith #define PETSC_BINARY_CHAR_SIZE  (8/8)
2711d382aafbSBarry Smith #define PETSC_BINARY_SHORT_SIZE  (16/8)
2712d382aafbSBarry Smith #define PETSC_BINARY_DOUBLE_SIZE  (64/8)
2713d382aafbSBarry Smith #define PETSC_BINARY_SCALAR_SIZE  sizeof(PetscScalar)
2714d382aafbSBarry Smith 
2715d382aafbSBarry Smith /*E
2716d382aafbSBarry Smith   PetscBinarySeekType - argument to PetscBinarySeek()
2717d382aafbSBarry Smith 
2718d382aafbSBarry Smith   Level: advanced
2719d382aafbSBarry Smith 
2720d382aafbSBarry Smith .seealso: PetscBinarySeek(), PetscBinarySynchronizedSeek()
2721d382aafbSBarry Smith E*/
2722d382aafbSBarry Smith typedef enum {PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1,PETSC_BINARY_SEEK_END = 2} PetscBinarySeekType;
2723014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*);
2724014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*);
2725014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt);
2726d382aafbSBarry Smith 
2727014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]);
2728014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool );
2729014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void);
2730014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*);
2731014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void);
2732014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void);
2733d382aafbSBarry Smith 
2734014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*);
2735014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**);
2736014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**);
2737014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**);
2738014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**);
2739cf4b5b4fSJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt*,const void*,PetscMPIInt*,PetscMPIInt**,void*)
2740cf4b5b4fSJed Brown   PetscAttrMPIPointerWithType(6,3);
2741d815da10SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedF(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
2742d815da10SJed Brown                                                     PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
2743d815da10SJed Brown                                                     PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
2744d815da10SJed Brown   PetscAttrMPIPointerWithType(6,3);
27456afbe7ddSJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedFReq(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
27466afbe7ddSJed Brown                                                        MPI_Request**,MPI_Request**,
27476afbe7ddSJed Brown                                                        PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
27486afbe7ddSJed Brown                                                        PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
27496afbe7ddSJed Brown   PetscAttrMPIPointerWithType(6,3);
2750d382aafbSBarry Smith 
27516145cd65SJed Brown /*E
27526145cd65SJed Brown     PetscBuildTwoSidedType - algorithm for setting up two-sided communication
27536145cd65SJed Brown 
27546145cd65SJed Brown $  PETSC_BUILDTWOSIDED_ALLREDUCE - classical algorithm using an MPI_Allreduce with
27556145cd65SJed Brown $      a buffer of length equal to the communicator size. Not memory-scalable due to
27566145cd65SJed Brown $      the large reduction size. Requires only MPI-1.
27576145cd65SJed Brown $  PETSC_BUILDTWOSIDED_IBARRIER - nonblocking algorithm based on MPI_Issend and MPI_Ibarrier.
27586145cd65SJed Brown $      Proved communication-optimal in Hoefler, Siebert, and Lumsdaine (2010). Requires MPI-3.
27591654bf6bSJed Brown $  PETSC_BUILDTWOSIDED_REDSCATTER - similar to above, but use more optimized function
27601654bf6bSJed Brown $      that only communicates the part of the reduction that is necessary.  Requires MPI-2.
27616145cd65SJed Brown 
27626145cd65SJed Brown    Level: developer
27636145cd65SJed Brown 
27646145cd65SJed Brown .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedSetType(), PetscCommBuildTwoSidedGetType()
27656145cd65SJed Brown E*/
27666145cd65SJed Brown typedef enum {
27676145cd65SJed Brown   PETSC_BUILDTWOSIDED_NOTSET = -1,
27686145cd65SJed Brown   PETSC_BUILDTWOSIDED_ALLREDUCE = 0,
27691654bf6bSJed Brown   PETSC_BUILDTWOSIDED_IBARRIER = 1,
277012af867fSJed Brown   PETSC_BUILDTWOSIDED_REDSCATTER = 2
27716145cd65SJed Brown   /* Updates here must be accompanied by updates in finclude/petscsys.h and the string array in mpits.c */
27726145cd65SJed Brown } PetscBuildTwoSidedType;
27736145cd65SJed Brown PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[];
27746145cd65SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm,PetscBuildTwoSidedType);
27756145cd65SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm,PetscBuildTwoSidedType*);
27766145cd65SJed Brown 
2777014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSSEIsEnabled(MPI_Comm,PetscBool  *,PetscBool  *);
2778d382aafbSBarry Smith 
2779d382aafbSBarry Smith /*E
2780d382aafbSBarry Smith   InsertMode - Whether entries are inserted or added into vectors or matrices
2781d382aafbSBarry Smith 
2782d382aafbSBarry Smith   Level: beginner
2783d382aafbSBarry Smith 
2784d382aafbSBarry Smith .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2785d382aafbSBarry Smith           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(),
2786d382aafbSBarry Smith           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd()
2787d382aafbSBarry Smith E*/
27886fbadbe2SMatthew G Knepley  typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES, INSERT_ALL_VALUES, ADD_ALL_VALUES, INSERT_BC_VALUES, ADD_BC_VALUES} InsertMode;
2789d382aafbSBarry Smith 
2790d382aafbSBarry Smith /*MC
2791d382aafbSBarry Smith     INSERT_VALUES - Put a value into a vector or matrix, overwrites any previous value
2792d382aafbSBarry Smith 
2793d382aafbSBarry Smith     Level: beginner
2794d382aafbSBarry Smith 
2795d382aafbSBarry Smith .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2796eca87e8dSBarry Smith           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), ADD_VALUES,
2797eca87e8dSBarry Smith           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES
2798d382aafbSBarry Smith 
2799d382aafbSBarry Smith M*/
2800d382aafbSBarry Smith 
2801d382aafbSBarry Smith /*MC
2802d382aafbSBarry Smith     ADD_VALUES - Adds a value into a vector or matrix, if there previously was no value, just puts the
2803d382aafbSBarry Smith                 value into that location
2804d382aafbSBarry Smith 
2805d382aafbSBarry Smith     Level: beginner
2806d382aafbSBarry Smith 
2807d382aafbSBarry Smith .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2808eca87e8dSBarry Smith           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), INSERT_VALUES,
2809eca87e8dSBarry Smith           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES
2810d382aafbSBarry Smith 
2811d382aafbSBarry Smith M*/
2812d382aafbSBarry Smith 
2813d382aafbSBarry Smith /*MC
2814d382aafbSBarry Smith     MAX_VALUES - Puts the maximum of the scattered/gathered value and the current value into each location
2815d382aafbSBarry Smith 
2816d382aafbSBarry Smith     Level: beginner
2817d382aafbSBarry Smith 
2818d382aafbSBarry Smith .seealso: InsertMode, VecScatterBegin(), VecScatterEnd(), ADD_VALUES, INSERT_VALUES
2819d382aafbSBarry Smith 
2820d382aafbSBarry Smith M*/
2821d382aafbSBarry Smith 
2822ce94432eSBarry Smith PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject);
2823ce94432eSBarry Smith 
282445487dadSJed Brown typedef enum {PETSC_SUBCOMM_GENERAL=0,PETSC_SUBCOMM_CONTIGUOUS=1,PETSC_SUBCOMM_INTERLACED=2} PetscSubcommType;
282545487dadSJed Brown PETSC_EXTERN const char *const PetscSubcommTypes[];
282645487dadSJed Brown 
2827d382aafbSBarry Smith /*S
2828306c2d5bSBarry Smith    PetscSubcomm - A decomposition of an MPI communicator into subcommunicators
2829306c2d5bSBarry Smith 
2830306c2d5bSBarry Smith    Notes: After a call to PetscSubcommSetType(), PetscSubcommSetTypeGeneral(), or PetscSubcommSetFromOptions() one may call
2831306c2d5bSBarry Smith $     PetscSubcommChild() returns the associated subcommunicator on this process
283236be1a5eSBarry Smith $     PetscSubcommContiguousParent() returns a parent communitor but with all child of the same subcommunicator having contiquous rank
2833306c2d5bSBarry Smith 
2834306c2d5bSBarry Smith    Sample Usage:
2835306c2d5bSBarry Smith        PetscSubcommCreate()
2836306c2d5bSBarry Smith        PetscSubcommSetNumber()
2837306c2d5bSBarry Smith        PetscSubcommSetType(PETSC_SUBCOMM_INTERLACED);
2838306c2d5bSBarry Smith        ccomm = PetscSubcommChild()
2839306c2d5bSBarry Smith        PetscSubcommDestroy()
2840d382aafbSBarry Smith 
2841d382aafbSBarry Smith    Level: advanced
2842d382aafbSBarry Smith 
2843d382aafbSBarry Smith    Concepts: communicator, create
2844306c2d5bSBarry Smith 
2845306c2d5bSBarry Smith    Notes:
2846306c2d5bSBarry Smith $   PETSC_SUBCOMM_GENERAL - similar to MPI_Comm_split() each process sets the new communicator (color) they will belong to and the order within that communicator
2847306c2d5bSBarry Smith $   PETSC_SUBCOMM_CONTIGUOUS - each new communicator contains a set of process with contiquous ranks in the original MPI communicator
2848306c2d5bSBarry Smith $   PETSC_SUBCOMM_INTERLACED - each new communictor contains a set of processes equally far apart in rank from the others in that new communicator
2849306c2d5bSBarry Smith 
2850306c2d5bSBarry Smith    Examaple: Consider a communicator with six processes split into 3 subcommunicators.
2851306c2d5bSBarry Smith $     PETSC_SUBCOMM_CONTIGUOUS - the first communicator contains rank 0,1  the second rank 2,3 and the third rank 4,5 in the original ordering of the original communicator
2852306c2d5bSBarry Smith $     PETSC_SUBCOMM_INTERLACED - the first communicator contains rank 0,3, the second 1,4 and the third 2,5
2853306c2d5bSBarry Smith 
2854306c2d5bSBarry Smith    Developer Notes: This is used in objects such as PCREDUNDANT() to manage the subcommunicators on which the redundant computations
2855306c2d5bSBarry Smith       are performed.
2856306c2d5bSBarry Smith 
2857306c2d5bSBarry Smith 
2858306c2d5bSBarry Smith .seealso: PetscSubcommCreate(), PetscSubcommSetNumber(), PetscSubcommSetType(), PetscSubcommView(), PetscSubcommSetFromOptions()
2859306c2d5bSBarry Smith 
2860d382aafbSBarry Smith S*/
2861d382aafbSBarry Smith typedef struct _n_PetscSubcomm* PetscSubcomm;
2862d382aafbSBarry Smith 
2863d382aafbSBarry Smith struct _n_PetscSubcomm {
2864d382aafbSBarry Smith   MPI_Comm         parent;           /* parent communicator */
2865d382aafbSBarry Smith   MPI_Comm         dupparent;        /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */
2866306c2d5bSBarry Smith   MPI_Comm         child;            /* the sub-communicator */
286745487dadSJed Brown   PetscMPIInt      n;                /* num of subcommunicators under the parent communicator */
286845487dadSJed Brown   PetscMPIInt      color;            /* color of processors belong to this communicator */
2869708d824cSJed Brown   PetscMPIInt      *subsize;         /* size of subcommunicator[color] */
287045487dadSJed Brown   PetscSubcommType type;
2871e5acf8a4SHong Zhang   char             *subcommprefix;
2872d382aafbSBarry Smith };
2873d382aafbSBarry Smith 
2874c5e4d11fSDmitry Karpeev PETSC_STATIC_INLINE MPI_Comm PetscSubcommParent(PetscSubcomm scomm) {return scomm->parent;}
2875306c2d5bSBarry Smith PETSC_STATIC_INLINE MPI_Comm PetscSubcommChild(PetscSubcomm scomm) {return scomm->child;}
287636be1a5eSBarry Smith PETSC_STATIC_INLINE MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm) {return scomm->dupparent;}
2877014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*);
2878014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*);
2879014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt);
2880014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType);
288165d9b8f1SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt);
2882053d1c95SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm,PetscViewer);
2883f68be91cSHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm);
2884e5acf8a4SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm,const char[]);
2885d382aafbSBarry Smith 
28860f453b92SJed Brown /*S
28870f453b92SJed Brown    PetscSegBuffer - a segmented extendable buffer
28880f453b92SJed Brown 
28890f453b92SJed Brown    Level: developer
28900f453b92SJed Brown 
28910f453b92SJed Brown .seealso: PetscSegBufferCreate(), PetscSegBufferGet(), PetscSegBufferExtract(), PetscSegBufferDestroy()
28920f453b92SJed Brown S*/
28930f453b92SJed Brown typedef struct _n_PetscSegBuffer *PetscSegBuffer;
289413e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t,size_t,PetscSegBuffer*);
28950f453b92SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer*);
289613e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer,size_t,void*);
2897137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer,void*);
2898137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer,void*);
2899137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer,void*);
290013e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer,size_t*);
290113e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer,size_t);
29020f453b92SJed Brown 
2903471ecdacSJed Brown /* Type-safe wrapper to encourage use of PETSC_RESTRICT. Does not use PetscFunctionBegin because the error handling
2904471ecdacSJed Brown  * prevents the compiler from completely erasing the stub. This is called in inner loops so it has to be as fast as
2905471ecdacSJed Brown  * possible. */
290635005c2bSLisandro Dalcin PETSC_STATIC_INLINE PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg,PetscInt count,PetscInt *PETSC_RESTRICT *slot) {return PetscSegBufferGet(seg,(size_t)count,(void**)slot);}
2907d382aafbSBarry Smith 
29089de0f6ecSBarry Smith typedef struct _n_PetscOptionsHelpPrinted *PetscOptionsHelpPrinted;
29099de0f6ecSBarry Smith extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton;
29109de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted*);
29119de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted*);
29129de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted,const char*,const char*,PetscBool*);
29139de0f6ecSBarry Smith 
2914268b0dfdSSatish Balay PETSC_EXTERN PetscSegBuffer PetscCitationsList;
29151f817a21SBarry Smith #undef __FUNCT__
29161f817a21SBarry Smith #define __FUNCT__ "PetscCitationsRegister"
29171f817a21SBarry Smith /*@C
29181f817a21SBarry Smith       PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used in the code.
29191f817a21SBarry Smith 
29201f817a21SBarry Smith      Not Collective - only what is registered on rank 0 of PETSC_COMM_WORLD will be printed
29211f817a21SBarry Smith 
29221f817a21SBarry Smith      Input Parameters:
29231f817a21SBarry Smith +      cite - the bibtex item, formated to displayed on multiple lines nicely
29241f817a21SBarry Smith -      set - a boolean variable initially set to PETSC_FALSE; this is used to insure only a single registration of the citation
29251f817a21SBarry Smith 
2926850545d0SSatish Balay    Level: intermediate
2927850545d0SSatish Balay 
29281f817a21SBarry Smith      Options Database:
29291f817a21SBarry Smith .     -citations [filenmae]   - print out the bibtex entries for the given computation
29301f817a21SBarry Smith @*/
2931dff31646SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscCitationsRegister(const char cit[],PetscBool *set)
2932dff31646SBarry Smith {
2933dff31646SBarry Smith   size_t         len;
2934dff31646SBarry Smith   char           *vstring;
2935dff31646SBarry Smith   PetscErrorCode ierr;
2936dff31646SBarry Smith 
29371f817a21SBarry Smith   PetscFunctionBegin;
29388d3683fcSBarry Smith   if (set && *set) PetscFunctionReturn(0);
2939dff31646SBarry Smith   ierr = PetscStrlen(cit,&len);CHKERRQ(ierr);
294035005c2bSLisandro Dalcin   ierr = PetscSegBufferGet(PetscCitationsList,len,&vstring);CHKERRQ(ierr);
2941dff31646SBarry Smith   ierr = PetscMemcpy(vstring,cit,len);CHKERRQ(ierr);
2942dff31646SBarry Smith   if (set) *set = PETSC_TRUE;
29431f817a21SBarry Smith   PetscFunctionReturn(0);
2944dff31646SBarry Smith }
2945dff31646SBarry Smith 
2946b967cddfSBarry Smith PETSC_EXTERN PetscErrorCode PetscURLShorten(const char[],char[],size_t);
2947fe278a28SBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm,char[],char[],size_t);
2948fe278a28SBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm,const char[],char[],size_t);
2949f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm,const char[],const char []);
2950fe278a28SBarry Smith 
2951f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm,char[],char[],size_t);
2952f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm,const char[],char[],char[],size_t);
2953b967cddfSBarry Smith 
295404102261SBarry Smith PETSC_EXTERN PetscErrorCode PetscTextBelt(MPI_Comm,const char[],const char[],PetscBool*);
2955dff31646SBarry Smith 
295668e69593SBarry Smith PETSC_EXTERN PetscErrorCode PetscPullJSONValue(const char[],const char[],char[],size_t,PetscBool*);
29575dc0f0a4SBarry Smith PETSC_EXTERN PetscErrorCode PetscPushJSONValue(char[],const char[],const char[],size_t);
2958d382aafbSBarry Smith 
2959b2566f29SBarry Smith 
2960b2566f29SBarry Smith #if defined(PETSC_USE_DEBUG)
2961b2566f29SBarry Smith /*
2962b2566f29SBarry Smith    Verify that all processes in the communicator have called this from the same line of code
2963b2566f29SBarry Smith  */
29648f5db7efSBarry Smith PETSC_EXTERN PetscErrorCode PetscAllreduceBarrierCheck(MPI_Comm,PetscMPIInt,int,const char*,const char *);
296577a5e07dSBarry Smith 
296677a5e07dSBarry Smith /*MC
296777a5e07dSBarry Smith    MPIU_Allreduce - a PETSc replacement for MPI_Allreduce() that tries to determine if the call from all the MPI processes occur from the
296877a5e07dSBarry Smith                     same place in the PETSc code. This helps to detect bugs where different MPI processes follow different code paths
296977a5e07dSBarry Smith                     resulting in inconsistent and incorrect calls to MPI_Allreduce().
297077a5e07dSBarry Smith 
297177a5e07dSBarry Smith    Collective on MPI_Comm
297277a5e07dSBarry Smith 
297377a5e07dSBarry Smith    Synopsis:
297477a5e07dSBarry Smith      #include <petscsys.h>
297577a5e07dSBarry Smith      PetscErrorCode MPIU_Allreduce(void *indata,void *outdata,PetscMPIInt count,MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);
297677a5e07dSBarry Smith 
297777a5e07dSBarry Smith    Input Parameters:
297877a5e07dSBarry Smith +  indata - pointer to the input data to be reduced
297977a5e07dSBarry Smith .  count - the number of MPI data items in indata and outdata
298077a5e07dSBarry Smith .  datatype - the MPI datatype, for example MPI_INT
298177a5e07dSBarry Smith .  op - the MPI operation, for example MPI_SUM
298277a5e07dSBarry Smith -  comm - the MPI communicator on which the operation occurs
298377a5e07dSBarry Smith 
298477a5e07dSBarry Smith    Output Parameter:
298577a5e07dSBarry Smith .  outdata - the reduced values
298677a5e07dSBarry Smith 
298777a5e07dSBarry Smith    Notes: In optimized mode this directly calls MPI_Allreduce()
298877a5e07dSBarry Smith 
298977a5e07dSBarry Smith    Level: developer
299077a5e07dSBarry Smith 
299177a5e07dSBarry Smith .seealso: MPI_Allreduce()
299277a5e07dSBarry Smith M*/
2993b2566f29SBarry Smith #define MPIU_Allreduce(a,b,c,d,e,fcomm) (PetscAllreduceBarrierCheck(fcomm,c,__LINE__,__FUNCT__,__FILE__) || MPI_Allreduce(a,b,c,d,e,fcomm))
2994b2566f29SBarry Smith #else
2995b2566f29SBarry Smith #define MPIU_Allreduce(a,b,c,d,e,fcomm) MPI_Allreduce(a,b,c,d,e,fcomm)
2996b2566f29SBarry Smith #endif
2997b2566f29SBarry Smith 
2998d382aafbSBarry Smith /* Reset __FUNCT__ in case the user does not define it themselves */
2999d382aafbSBarry Smith #undef __FUNCT__
3000d382aafbSBarry Smith #define __FUNCT__ "User provided function"
3001d382aafbSBarry Smith 
3002d382aafbSBarry Smith #endif
3003