xref: /petsc/include/petscsys.h (revision b7b8f77a1c31acd4cca9a56e02609d1dffe2a4b3)
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
14241f4af4cSSatish Balay #elif defined(PETSC_HAVE_I_MPI_NUMVERSION)
14341f4af4cSSatish Balay #  if !defined(I_MPI_NUMVERSION)
14441f4af4cSSatish Balay #    error "PETSc was configured with I_MPI but now appears to be compiling using a non-I_MPI mpi.h"
14541f4af4cSSatish Balay #  elif I_MPI_NUMVERSION != PETSC_HAVE_I_MPI_NUMVERSION
14641f4af4cSSatish Balay #    error "PETSc was configured with one I_MPI mpi.h version but now appears to be compiling using a different I_MPI mpi.h version"
14741f4af4cSSatish Balay #  endif
14841f4af4cSSatish Balay #elif defined(PETSC_HAVE_MVAPICH2_NUMVERSION)
14941f4af4cSSatish Balay #  if !defined(MVAPICH2_NUMVERSION)
15041f4af4cSSatish Balay #    error "PETSc was configured with MVAPICH2 but now appears to be compiling using a non-MVAPICH2 mpi.h"
15141f4af4cSSatish Balay #  elif MVAPICH2_NUMVERSION != PETSC_HAVE_MVAPICH2_NUMVERSION
15241f4af4cSSatish Balay #    error "PETSc was configured with one MVAPICH2 mpi.h version but now appears to be compiling using a different MVAPICH2 mpi.h version"
15341f4af4cSSatish Balay #  endif
154a7886beaSBarry Smith #elif defined(PETSC_HAVE_MPICH_NUMVERSION)
15541f4af4cSSatish Balay #  if !defined(MPICH_NUMVERSION) || defined(MVAPICH2_NUMVERSION) || defined(I_MPI_NUMVERSION)
156a7886beaSBarry Smith #    error "PETSc was configured with MPICH but now appears to be compiling using a non-MPICH mpi.h"
157ca70f86eSJed Brown #  elif (MPICH_NUMVERSION/100000 != PETSC_HAVE_MPICH_NUMVERSION/100000) || (MPICH_NUMVERSION%100000/1000 < PETSC_HAVE_MPICH_NUMVERSION%100000/1000)
158a7886beaSBarry Smith #    error "PETSc was configured with one MPICH mpi.h version but now appears to be compiling using a different MPICH mpi.h version"
159a7886beaSBarry Smith #  endif
160a7886beaSBarry Smith #elif defined(PETSC_HAVE_OMPI_MAJOR_VERSION)
161a7886beaSBarry Smith #  if !defined(OMPI_MAJOR_VERSION)
162a7886beaSBarry Smith #    error "PETSc was configured with OpenMPI but now appears to be compiling using a non-OpenMPI mpi.h"
163ca70f86eSJed Brown #  elif (OMPI_MAJOR_VERSION != PETSC_HAVE_OMPI_MAJOR_VERSION) || (OMPI_MINOR_VERSION != PETSC_HAVE_OMPI_MINOR_VERSION) || (OMPI_RELEASE_VERSION < PETSC_HAVE_OMPI_RELEASE_VERSION)
164c3ac57cfSSatish Balay #    error "PETSc was configured with one OpenMPI mpi.h version but now appears to be compiling using a different OpenMPI mpi.h version"
165a7886beaSBarry Smith #  endif
16641f4af4cSSatish Balay #elif defined(OMPI_MAJOR_VERSION) || defined(MPICH_NUMVERSION)
16741f4af4cSSatish Balay #  error "PETSc was configured with undetermined MPI - but now appears to be compiling using either of OpenMPI or a MPICH variant"
168a7886beaSBarry Smith #endif
169a7886beaSBarry Smith 
170a7886beaSBarry Smith /*
1712981ebdbSBarry Smith     Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler
172d382aafbSBarry Smith     see the top of mpicxx.h in the MPICH2 distribution.
173d382aafbSBarry Smith */
174d382aafbSBarry Smith #include <stdio.h>
175d382aafbSBarry Smith 
176d382aafbSBarry Smith /* MSMPI on 32bit windows requires this yukky hack - that breaks MPI standard compliance */
177d382aafbSBarry Smith #if !defined(MPIAPI)
178d382aafbSBarry Smith #define MPIAPI
179d382aafbSBarry Smith #endif
180d382aafbSBarry Smith 
1811cc8b206SBarry Smith /*
1821cc8b206SBarry Smith    Support for Clang (>=3.2) matching type tag arguments with void* buffer types.
1831cc8b206SBarry Smith    This allows the compiler to detect cases where the MPI datatype argument passed to a MPI routine
1841cc8b206SBarry Smith    does not match the actual type of the argument being passed in
1851cc8b206SBarry Smith */
186c5e4d11fSDmitry Karpeev #if defined(__has_attribute) && defined(works_with_const_which_is_not_true)
187894dd566SJed Brown #  if __has_attribute(argument_with_type_tag) && __has_attribute(pointer_with_type_tag) && __has_attribute(type_tag_for_datatype)
188894dd566SJed Brown #    define PetscAttrMPIPointerWithType(bufno,typeno) __attribute__((pointer_with_type_tag(MPI,bufno,typeno)))
1898ad47952SJed Brown #    define PetscAttrMPITypeTag(type)                 __attribute__((type_tag_for_datatype(MPI,type)))
1908ad47952SJed Brown #    define PetscAttrMPITypeTagLayoutCompatible(type) __attribute__((type_tag_for_datatype(MPI,type,layout_compatible)))
191894dd566SJed Brown #  endif
192894dd566SJed Brown #endif
193894dd566SJed Brown #if !defined(PetscAttrMPIPointerWithType)
194894dd566SJed Brown #  define PetscAttrMPIPointerWithType(bufno,typeno)
1958ad47952SJed Brown #  define PetscAttrMPITypeTag(type)
1968ad47952SJed Brown #  define PetscAttrMPITypeTagLayoutCompatible(type)
197894dd566SJed Brown #endif
198b3506946SBarry Smith 
199d382aafbSBarry Smith /*MC
2001957e957SBarry Smith     PetscErrorCode - datatype used for return error code from almost all PETSc functions
201d382aafbSBarry Smith 
202d382aafbSBarry Smith     Level: beginner
203d382aafbSBarry Smith 
204d382aafbSBarry Smith .seealso: CHKERRQ, SETERRQ
205d382aafbSBarry Smith M*/
206d382aafbSBarry Smith typedef int PetscErrorCode;
207d382aafbSBarry Smith 
208d382aafbSBarry Smith /*MC
209d382aafbSBarry Smith 
210503cfb0cSBarry Smith     PetscClassId - A unique id used to identify each PETSc class.
211d382aafbSBarry Smith 
2121957e957SBarry Smith     Notes: Use PetscClassIdRegister() to obtain a new value for a new class being created. Usually
2131957e957SBarry Smith          XXXInitializePackage() calls it for each class it defines.
2141957e957SBarry Smith 
2151957e957SBarry Smith     Developer Notes: Internal integer stored in the _p_PetscObject data structure.
2161957e957SBarry Smith          These are all computed by an offset from the lowest one, PETSC_SMALLEST_CLASSID.
2171957e957SBarry Smith 
2181957e957SBarry Smith     Level: developer
219d382aafbSBarry Smith 
2200700a824SBarry Smith .seealso: PetscClassIdRegister(), PetscLogEventRegister(), PetscHeaderCreate()
221d382aafbSBarry Smith M*/
2220700a824SBarry Smith typedef int PetscClassId;
223d382aafbSBarry Smith 
224d382aafbSBarry Smith 
225d382aafbSBarry Smith /*MC
226d382aafbSBarry Smith     PetscMPIInt - datatype used to represent 'int' parameters to MPI functions.
227d382aafbSBarry Smith 
228d382aafbSBarry Smith     Level: intermediate
229d382aafbSBarry Smith 
230d382aafbSBarry Smith     Notes: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but
2313b2a8c54SBarry Smith            standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt it remains 32 bit
232d382aafbSBarry Smith 
2334dc2109aSBarry Smith     PetscMPIIntCast(a,&b) checks if the given PetscInt a will fit in a PetscMPIInt, if not it
2342981ebdbSBarry Smith       generates a PETSC_ERR_ARG_OUTOFRANGE error.
235d382aafbSBarry Smith 
2361cc8b206SBarry Smith .seealso: PetscBLASInt, PetscInt, PetscMPIIntCast()
237d382aafbSBarry Smith 
238d382aafbSBarry Smith M*/
239d382aafbSBarry Smith typedef int PetscMPIInt;
240d382aafbSBarry Smith 
241d382aafbSBarry Smith /*MC
242d382aafbSBarry Smith     PetscEnum - datatype used to pass enum types within PETSc functions.
243d382aafbSBarry Smith 
244d382aafbSBarry Smith     Level: intermediate
245d382aafbSBarry Smith 
246d382aafbSBarry Smith .seealso: PetscOptionsGetEnum(), PetscOptionsEnum(), PetscBagRegisterEnum()
247d382aafbSBarry Smith M*/
248d382aafbSBarry Smith typedef enum { ENUM_DUMMY } PetscEnum;
2495a576424SJed Brown PETSC_EXTERN MPI_Datatype MPIU_ENUM PetscAttrMPITypeTag(PetscEnum);
250d382aafbSBarry Smith 
251fab38c73SJed Brown #if defined(PETSC_HAVE_STDINT_H)
252fab38c73SJed Brown #include <stdint.h>
253fab38c73SJed Brown #endif
254a05e1a72SSatish Balay #if defined (PETSC_HAVE_INTTYPES_H)
25513e758fdSSatish Balay #define __STDC_FORMAT_MACROS /* required for using PRId64 from c++ */
256a05e1a72SSatish Balay #include <inttypes.h>
25737354ed4SSatish Balay # if !defined(PRId64)
25837354ed4SSatish Balay # define PRId64 "ld"
25937354ed4SSatish Balay # endif
260a05e1a72SSatish Balay #endif
261fab38c73SJed Brown 
26299a4b90dSDave May typedef short PetscShort;
26399a4b90dSDave May typedef char PetscChar;
26499a4b90dSDave May typedef float PetscFloat;
26599a4b90dSDave May 
266d382aafbSBarry Smith /*MC
267d382aafbSBarry Smith     PetscInt - PETSc type that represents integer - used primarily to
2683b2a8c54SBarry Smith       represent size of arrays and indexing into arrays. Its size can be configured with the option
269d382aafbSBarry Smith       --with-64-bit-indices - to be either 32bit or 64bit [default 32 bit ints]
270d382aafbSBarry Smith 
271390e1bf2SBarry Smith 
272390e1bf2SBarry Smith    Notes: For MPI calls that require datatypes, use MPIU_INT as the datatype for PetscInt. It will automatically work correctly regardless of
273390e1bf2SBarry Smith           the size of PetscInt
274390e1bf2SBarry Smith 
275d382aafbSBarry Smith    Level: intermediate
276d382aafbSBarry Smith 
277d382aafbSBarry Smith .seealso: PetscScalar, PetscBLASInt, PetscMPIInt
278d382aafbSBarry Smith M*/
27937354ed4SSatish 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 */
280bafee8b4SSatish Balay typedef int64_t PetscInt64;
281bd84f1cfSSatish Balay # define MPIU_INT64 MPI_INT64_T
282a05e1a72SSatish Balay # define PetscInt64_FMT PRId64
283fab38c73SJed Brown #elif (PETSC_SIZEOF_LONG_LONG == 8)
284bafee8b4SSatish Balay typedef long long PetscInt64;
285bd84f1cfSSatish Balay # define MPIU_INT64 MPI_LONG_LONG_INT
286a05e1a72SSatish Balay # define PetscInt64_FMT "lld"
287f505b413SSatish Balay #elif defined(PETSC_HAVE___INT64)
288bafee8b4SSatish Balay typedef __int64 PetscInt64;
289bd84f1cfSSatish Balay # define MPIU_INT64 MPI_INT64_T
290a05e1a72SSatish Balay # define PetscInt64_FMT "ld"
291236ed0a3SSatish Balay #else
292bafee8b4SSatish Balay #error "cannot determine PetscInt64 type"
293236ed0a3SSatish Balay #endif
294*b7b8f77aSBarry Smith 
295*b7b8f77aSBarry Smith #if PETSC_SIZEOF_VOID_P == 4
296*b7b8f77aSBarry Smith #define MPIU_FORTRANADDR MPI_INT
297*b7b8f77aSBarry Smith #else
298*b7b8f77aSBarry Smith #define MPIU_FORTRANADDR MPIU_INT64
299*b7b8f77aSBarry Smith #endif
300*b7b8f77aSBarry Smith 
301d382aafbSBarry Smith #if defined(PETSC_USE_64BIT_INDICES)
302bafee8b4SSatish Balay typedef PetscInt64 PetscInt;
303bd84f1cfSSatish Balay #define MPIU_INT MPIU_INT64
304a05e1a72SSatish Balay #define PetscInt_FMT PetscInt64_FMT
305d382aafbSBarry Smith #else
306d382aafbSBarry Smith typedef int PetscInt;
307d382aafbSBarry Smith #define MPIU_INT MPI_INT
308a05e1a72SSatish Balay #define PetscInt_FMT "d"
309d382aafbSBarry Smith #endif
310d382aafbSBarry Smith 
311702bc34aSSatish Balay /*MC
312702bc34aSSatish Balay     PetscBLASInt - datatype used to represent 'int' parameters to BLAS/LAPACK functions.
313702bc34aSSatish Balay 
314702bc34aSSatish Balay     Level: intermediate
315702bc34aSSatish Balay 
316702bc34aSSatish Balay     Notes: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but
317702bc34aSSatish Balay            standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt it remains 32 bit
318702bc34aSSatish Balay            (except on very rare BLAS/LAPACK implementations that support 64 bit integers see the note below).
319702bc34aSSatish Balay 
320c5df96a5SBarry Smith     PetscErrorCode PetscBLASIntCast(a,&b) checks if the given PetscInt a will fit in a PetscBLASInt, if not it
3212981ebdbSBarry Smith       generates a PETSC_ERR_ARG_OUTOFRANGE error
322702bc34aSSatish Balay 
3232981ebdbSBarry Smith     Installation Notes: The 64bit versions of MATLAB ship with BLAS and LAPACK that use 64 bit integers for sizes etc,
324702bc34aSSatish Balay      if you run ./configure with the option
325149a18a2SBarry Smith      --with-blaslapack-lib=[/Applications/MATLAB_R2010b.app/bin/maci64/libmwblas.dylib,/Applications/MATLAB_R2010b.app/bin/maci64/libmwlapack.dylib]
3262981ebdbSBarry Smith      but you need to also use --known-64-bit-blas-indices.
3272981ebdbSBarry Smith 
328390e1bf2SBarry Smith         MKL also ships with 64 bit integer versions of the BLAS and LAPACK, if you select those you must also ./configure with
329390e1bf2SBarry Smith         --known-64-bit-blas-indices
330390e1bf2SBarry Smith 
331390e1bf2SBarry Smith         OpenBLAS can also be built to use 64 bit integers. The ./configure options --download-openblas -download-openblas-64-bit-blas-indices
332390e1bf2SBarry Smith         will build a 64 bit integer version
3332981ebdbSBarry Smith 
3342981ebdbSBarry Smith      Developer Notes: Eventually ./configure should automatically determine the size of the integers used by BLAS/LAPACK.
335702bc34aSSatish Balay 
336702bc34aSSatish Balay      External packages such as hypre, ML, SuperLU etc do not provide any support for passing 64 bit integers to BLAS/LAPACK so cannot
337702bc34aSSatish Balay      be used with PETSc if you have set PetscBLASInt to long int.
338702bc34aSSatish Balay 
3391cc8b206SBarry Smith .seealso: PetscMPIInt, PetscInt, PetscBLASIntCast()
340702bc34aSSatish Balay 
341702bc34aSSatish Balay M*/
342702bc34aSSatish Balay #if defined(PETSC_HAVE_64BIT_BLAS_INDICES)
343bafee8b4SSatish Balay typedef PetscInt64 PetscBLASInt;
344702bc34aSSatish Balay #else
345702bc34aSSatish Balay typedef int PetscBLASInt;
346702bc34aSSatish Balay #endif
347702bc34aSSatish Balay 
348503cfb0cSBarry Smith /*
349503cfb0cSBarry Smith     For the rare cases when one needs to send a size_t object with MPI
350503cfb0cSBarry Smith */
351d382aafbSBarry Smith #if (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_INT)
352adcec1e5SJed Brown #define MPIU_SIZE_T MPI_UNSIGNED
353d382aafbSBarry Smith #elif  (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG)
354adcec1e5SJed Brown #define MPIU_SIZE_T MPI_UNSIGNED_LONG
355d382aafbSBarry Smith #elif  (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG_LONG)
356adcec1e5SJed Brown #define MPIU_SIZE_T MPI_UNSIGNED_LONG_LONG
357d382aafbSBarry Smith #else
358d382aafbSBarry Smith #error "Unknown size for size_t! Send us a bugreport at petsc-maint@mcs.anl.gov"
359d382aafbSBarry Smith #endif
360d382aafbSBarry Smith 
361d382aafbSBarry Smith /*
362d382aafbSBarry Smith       You can use PETSC_STDOUT as a replacement of stdout. You can also change
363d382aafbSBarry Smith     the value of PETSC_STDOUT to redirect all standard output elsewhere
364d382aafbSBarry Smith */
365014dd563SJed Brown PETSC_EXTERN FILE* PETSC_STDOUT;
366d382aafbSBarry Smith 
367d382aafbSBarry Smith /*
368d382aafbSBarry Smith       You can use PETSC_STDERR as a replacement of stderr. You can also change
369d382aafbSBarry Smith     the value of PETSC_STDERR to redirect all standard error elsewhere
370d382aafbSBarry Smith */
371014dd563SJed Brown PETSC_EXTERN FILE* PETSC_STDERR;
372d382aafbSBarry Smith 
373d382aafbSBarry Smith /*MC
374d382aafbSBarry Smith     PetscUnlikely - hints the compiler that the given condition is usually FALSE
375d382aafbSBarry Smith 
376d382aafbSBarry Smith     Synopsis:
377aaa7dc30SBarry Smith     #include <petscsys.h>
378ace3abfcSBarry Smith     PetscBool  PetscUnlikely(PetscBool  cond)
379d382aafbSBarry Smith 
380eca87e8dSBarry Smith     Not Collective
381eca87e8dSBarry Smith 
382d382aafbSBarry Smith     Input Parameters:
383d382aafbSBarry Smith .   cond - condition or expression
384d382aafbSBarry Smith 
385d382aafbSBarry Smith     Note: This returns the same truth value, it is only a hint to compilers that the resulting
386d382aafbSBarry Smith     branch is unlikely.
387d382aafbSBarry Smith 
388d382aafbSBarry Smith     Level: advanced
389d382aafbSBarry Smith 
390d382aafbSBarry Smith .seealso: PetscLikely(), CHKERRQ
391d382aafbSBarry Smith M*/
392d382aafbSBarry Smith 
393d382aafbSBarry Smith /*MC
394d382aafbSBarry Smith     PetscLikely - hints the compiler that the given condition is usually TRUE
395d382aafbSBarry Smith 
396d382aafbSBarry Smith     Synopsis:
397aaa7dc30SBarry Smith     #include <petscsys.h>
39823072422SBarry Smith     PetscBool  PetscLikely(PetscBool  cond)
399d382aafbSBarry Smith 
400eca87e8dSBarry Smith     Not Collective
401eca87e8dSBarry Smith 
402d382aafbSBarry Smith     Input Parameters:
403d382aafbSBarry Smith .   cond - condition or expression
404d382aafbSBarry Smith 
405d382aafbSBarry Smith     Note: This returns the same truth value, it is only a hint to compilers that the resulting
406d382aafbSBarry Smith     branch is likely.
407d382aafbSBarry Smith 
408d382aafbSBarry Smith     Level: advanced
409d382aafbSBarry Smith 
410d382aafbSBarry Smith .seealso: PetscUnlikely()
411d382aafbSBarry Smith M*/
412d382aafbSBarry Smith #if defined(PETSC_HAVE_BUILTIN_EXPECT)
413d382aafbSBarry Smith #  define PetscUnlikely(cond)   __builtin_expect(!!(cond),0)
414d382aafbSBarry Smith #  define PetscLikely(cond)     __builtin_expect(!!(cond),1)
415d382aafbSBarry Smith #else
416cd3f4ce9SJed Brown #  define PetscUnlikely(cond)   (cond)
417cd3f4ce9SJed Brown #  define PetscLikely(cond)     (cond)
418d382aafbSBarry Smith #endif
419d382aafbSBarry Smith 
420d382aafbSBarry Smith /*
421d382aafbSBarry Smith     Declare extern C stuff after including external header files
422d382aafbSBarry Smith */
423d382aafbSBarry Smith 
424d382aafbSBarry Smith 
425d382aafbSBarry Smith /*
426d382aafbSBarry Smith        Basic PETSc constants
427d382aafbSBarry Smith */
428d382aafbSBarry Smith 
429d382aafbSBarry Smith /*E
430ace3abfcSBarry Smith     PetscBool  - Logical variable. Actually an int in C and a logical in Fortran.
431d382aafbSBarry Smith 
432d382aafbSBarry Smith    Level: beginner
433d382aafbSBarry Smith 
434ace3abfcSBarry 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
43534e82e7dSBarry Smith       boolean values. It is not easy to have a simple macro that that will work properly in all circumstances with all three mechanisms.
43634e82e7dSBarry Smith 
4371cc8b206SBarry Smith .seealso: PETSC_TRUE, PETSC_FALSE, PetscNot()
438d382aafbSBarry Smith E*/
439ace3abfcSBarry Smith typedef enum { PETSC_FALSE,PETSC_TRUE } PetscBool;
4406a6fc655SJed Brown PETSC_EXTERN const char *const PetscBools[];
4415a576424SJed Brown PETSC_EXTERN MPI_Datatype MPIU_BOOL PetscAttrMPITypeTag(PetscBool);
44270b3c8c7SBarry Smith 
4438b49ba18SBarry Smith /*
444390e1bf2SBarry Smith     Defines elementary mathematics functions and constants.
4458b49ba18SBarry Smith */
4468b49ba18SBarry Smith #include <petscmath.h>
4478b49ba18SBarry Smith 
44870b3c8c7SBarry Smith /*E
44970b3c8c7SBarry Smith     PetscCopyMode  - Determines how an array passed to certain functions is copied or retained
45070b3c8c7SBarry Smith 
45170b3c8c7SBarry Smith    Level: beginner
45270b3c8c7SBarry Smith 
45370b3c8c7SBarry Smith $   PETSC_COPY_VALUES - the array values are copied into new space, the user is free to reuse or delete the passed in array
45470b3c8c7SBarry 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
45570b3c8c7SBarry Smith $                       delete the array. The array MUST have been obtained with PetscMalloc(). Hence this mode cannot be used in Fortran.
45670b3c8c7SBarry 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
45770b3c8c7SBarry Smith                         the array but the user must delete the array after the object is destroyed.
45870b3c8c7SBarry Smith 
45970b3c8c7SBarry Smith E*/
46070b3c8c7SBarry Smith typedef enum { PETSC_COPY_VALUES, PETSC_OWN_POINTER, PETSC_USE_POINTER} PetscCopyMode;
4616a6fc655SJed Brown PETSC_EXTERN const char *const PetscCopyModes[];
462d382aafbSBarry Smith 
463d382aafbSBarry Smith /*MC
464ace3abfcSBarry Smith     PETSC_FALSE - False value of PetscBool
465d382aafbSBarry Smith 
466d382aafbSBarry Smith     Level: beginner
467d382aafbSBarry Smith 
468d382aafbSBarry Smith     Note: Zero integer
469d382aafbSBarry Smith 
470ace3abfcSBarry Smith .seealso: PetscBool, PETSC_TRUE
471d382aafbSBarry Smith M*/
472d382aafbSBarry Smith 
473d382aafbSBarry Smith /*MC
474ace3abfcSBarry Smith     PETSC_TRUE - True value of PetscBool
475d382aafbSBarry Smith 
476d382aafbSBarry Smith     Level: beginner
477d382aafbSBarry Smith 
478d382aafbSBarry Smith     Note: Nonzero integer
479d382aafbSBarry Smith 
480ace3abfcSBarry Smith .seealso: PetscBool, PETSC_FALSE
481d382aafbSBarry Smith M*/
482d382aafbSBarry Smith 
483d382aafbSBarry Smith /*MC
4840298fd71SBarry Smith     PETSC_IGNORE - same as NULL, means PETSc will ignore this argument
485d382aafbSBarry Smith 
486d382aafbSBarry Smith    Level: beginner
487d382aafbSBarry Smith 
488d382aafbSBarry Smith    Note: accepted by many PETSc functions to not set a parameter and instead use
489d382aafbSBarry Smith           some default
490d382aafbSBarry Smith 
491d382aafbSBarry Smith    Fortran Notes: This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER,
492d382aafbSBarry Smith           PETSC_NULL_DOUBLE_PRECISION etc
493d382aafbSBarry Smith 
494d382aafbSBarry Smith .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_NULL, PETSC_DETERMINE
495d382aafbSBarry Smith 
496d382aafbSBarry Smith M*/
4970298fd71SBarry Smith #define PETSC_IGNORE         NULL
498d382aafbSBarry Smith 
499c528d872SBarry Smith /* This is deprecated */
500c528d872SBarry Smith #define PETSC_NULL NULL
501c528d872SBarry Smith 
502d382aafbSBarry Smith /*MC
503557d4da8SBarry Smith     PETSC_DECIDE - standard way of passing in integer or floating point parameter
504557d4da8SBarry Smith        where you wish PETSc to use the default.
505557d4da8SBarry Smith 
506557d4da8SBarry Smith    Level: beginner
507557d4da8SBarry Smith 
508557d4da8SBarry Smith .seealso: PETSC_NULL, PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE
509557d4da8SBarry Smith 
510557d4da8SBarry Smith M*/
511557d4da8SBarry Smith #define PETSC_DECIDE  -1
512557d4da8SBarry Smith 
513557d4da8SBarry Smith /*MC
514d382aafbSBarry Smith     PETSC_DETERMINE - standard way of passing in integer or floating point parameter
515d382aafbSBarry Smith        where you wish PETSc to compute the required value.
516d382aafbSBarry Smith 
517d382aafbSBarry Smith    Level: beginner
518d382aafbSBarry Smith 
519557d4da8SBarry Smith    Developer Note: I would like to use const PetscInt PETSC_DETERMINE = PETSC_DECIDE; but for
520557d4da8SBarry Smith      some reason this is not allowed by the standard even though PETSC_DECIDE is a constant value.
521557d4da8SBarry Smith 
5220298fd71SBarry Smith .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, VecSetSizes()
523d382aafbSBarry Smith 
524d382aafbSBarry Smith M*/
525d382aafbSBarry Smith #define PETSC_DETERMINE PETSC_DECIDE
526d382aafbSBarry Smith 
527d382aafbSBarry Smith /*MC
528557d4da8SBarry Smith     PETSC_DEFAULT - standard way of passing in integer or floating point parameter
529557d4da8SBarry Smith        where you wish PETSc to use the default.
530557d4da8SBarry Smith 
531557d4da8SBarry Smith    Level: beginner
532557d4da8SBarry Smith 
5332d80014bSBarry Smith    Fortran Notes: You need to use PETSC_DEFAULT_INTEGER or PETSC_DEFAULT_REAL.
534557d4da8SBarry Smith 
5350298fd71SBarry Smith .seealso: PETSC_DECIDE, PETSC_IGNORE, PETSC_DETERMINE
536557d4da8SBarry Smith 
537557d4da8SBarry Smith M*/
538557d4da8SBarry Smith #define PETSC_DEFAULT  -2
539557d4da8SBarry Smith 
540557d4da8SBarry Smith /*MC
541d382aafbSBarry Smith     PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents
542d382aafbSBarry Smith            all the processs that PETSc knows about.
543d382aafbSBarry Smith 
544d382aafbSBarry Smith    Level: beginner
545d382aafbSBarry Smith 
546d382aafbSBarry Smith    Notes: By default PETSC_COMM_WORLD and MPI_COMM_WORLD are identical unless you wish to
547d382aafbSBarry Smith           run PETSc on ONLY a subset of MPI_COMM_WORLD. In that case create your new (smaller)
548d382aafbSBarry Smith           communicator, call it, say comm, and set PETSC_COMM_WORLD = comm BEFORE calling
549a990b902SBarry Smith           PetscInitialize(), but after MPI_Init() has been called.
550a990b902SBarry Smith 
551a990b902SBarry Smith           The value of PETSC_COMM_WORLD should never be USED/accessed before PetscInitialize()
552a990b902SBarry Smith           is called because it may not have a valid value yet.
553d382aafbSBarry Smith 
554d382aafbSBarry Smith .seealso: PETSC_COMM_SELF
555d382aafbSBarry Smith 
556d382aafbSBarry Smith M*/
557014dd563SJed Brown PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD;
558d382aafbSBarry Smith 
559d382aafbSBarry Smith /*MC
560503cfb0cSBarry Smith     PETSC_COMM_SELF - This is always MPI_COMM_SELF
561d382aafbSBarry Smith 
562d382aafbSBarry Smith    Level: beginner
563d382aafbSBarry Smith 
564a990b902SBarry Smith    Notes: Do not USE/access or set this variable before PetscInitialize() has been called.
565a990b902SBarry Smith 
566d382aafbSBarry Smith .seealso: PETSC_COMM_WORLD
567d382aafbSBarry Smith 
568d382aafbSBarry Smith M*/
569d382aafbSBarry Smith #define PETSC_COMM_SELF MPI_COMM_SELF
570d382aafbSBarry Smith 
571d6f2c3cbSBarry Smith PETSC_EXTERN PetscBool PetscBeganMPI;
572014dd563SJed Brown PETSC_EXTERN PetscBool PetscInitializeCalled;
573014dd563SJed Brown PETSC_EXTERN PetscBool PetscFinalizeCalled;
574014dd563SJed Brown PETSC_EXTERN PetscBool PetscCUSPSynchronize;
5754cf1874eSKarl Rupp PETSC_EXTERN PetscBool PetscViennaCLSynchronize;
57682f73ecaSAlejandro Lamas Daviña PETSC_EXTERN PetscBool PetscCUDASynchronize;
577d382aafbSBarry Smith 
578014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm));
579014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*);
580014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm*);
581d382aafbSBarry Smith 
582d382aafbSBarry Smith /*MC
58395dccacaSBarry Smith    PetscMalloc - Allocates memory, One should use PetscNew(), PetscMalloc1() or PetscCalloc1() usually instead of this
584d382aafbSBarry Smith 
585eca87e8dSBarry Smith    Synopsis:
586aaa7dc30SBarry Smith     #include <petscsys.h>
587eca87e8dSBarry Smith    PetscErrorCode PetscMalloc(size_t m,void **result)
588eca87e8dSBarry Smith 
589eca87e8dSBarry Smith    Not Collective
590eca87e8dSBarry Smith 
591d382aafbSBarry Smith    Input Parameter:
592d382aafbSBarry Smith .  m - number of bytes to allocate
593d382aafbSBarry Smith 
594d382aafbSBarry Smith    Output Parameter:
595d382aafbSBarry Smith .  result - memory allocated
596d382aafbSBarry Smith 
597d382aafbSBarry Smith    Level: beginner
598d382aafbSBarry Smith 
59949d7da52SJed Brown    Notes:
60049d7da52SJed Brown    Memory is always allocated at least double aligned
601d382aafbSBarry Smith 
60249d7da52SJed Brown    It is safe to allocate size 0 and pass the resulting pointer (which may or may not be NULL) to PetscFree().
603d382aafbSBarry Smith 
604d382aafbSBarry Smith .seealso: PetscFree(), PetscNew()
605d382aafbSBarry Smith 
606d382aafbSBarry Smith   Concepts: memory allocation
607d382aafbSBarry Smith 
608d382aafbSBarry Smith M*/
60949d7da52SJed Brown #define PetscMalloc(a,b)  ((*PetscTrMalloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b)))
610d382aafbSBarry Smith 
611d382aafbSBarry Smith /*MC
6123221ece2SMatthew G. Knepley    PetscRealloc - Rellocates memory
6133221ece2SMatthew G. Knepley 
6143221ece2SMatthew G. Knepley    Synopsis:
6153221ece2SMatthew G. Knepley     #include <petscsys.h>
6163221ece2SMatthew G. Knepley    PetscErrorCode PetscRealloc(size_t m,void **result)
6173221ece2SMatthew G. Knepley 
6183221ece2SMatthew G. Knepley    Not Collective
6193221ece2SMatthew G. Knepley 
6203221ece2SMatthew G. Knepley    Input Parameters:
6213221ece2SMatthew G. Knepley +  m - number of bytes to allocate
6223221ece2SMatthew G. Knepley -  result - initial memory allocated
6233221ece2SMatthew G. Knepley 
6243221ece2SMatthew G. Knepley    Output Parameter:
6253221ece2SMatthew G. Knepley .  result - new memory allocated
6263221ece2SMatthew G. Knepley 
6273221ece2SMatthew G. Knepley    Level: developer
6283221ece2SMatthew G. Knepley 
6293221ece2SMatthew G. Knepley    Notes:
6303221ece2SMatthew G. Knepley    Memory is always allocated at least double aligned
6313221ece2SMatthew G. Knepley 
6323221ece2SMatthew G. Knepley .seealso: PetscMalloc(), PetscFree(), PetscNew()
6333221ece2SMatthew G. Knepley 
6343221ece2SMatthew G. Knepley   Concepts: memory allocation
6353221ece2SMatthew G. Knepley 
6363221ece2SMatthew G. Knepley M*/
6373221ece2SMatthew G. Knepley #define PetscRealloc(a,b)  ((*PetscTrRealloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b)))
6383221ece2SMatthew G. Knepley 
6393221ece2SMatthew G. Knepley /*MC
640503cfb0cSBarry Smith    PetscAddrAlign - Rounds up an address to PETSC_MEMALIGN alignment
641d382aafbSBarry Smith 
642d382aafbSBarry Smith    Synopsis:
643aaa7dc30SBarry Smith     #include <petscsys.h>
644d382aafbSBarry Smith    void *PetscAddrAlign(void *addr)
645d382aafbSBarry Smith 
646eca87e8dSBarry Smith    Not Collective
647eca87e8dSBarry Smith 
648eca87e8dSBarry Smith    Input Parameters:
649eca87e8dSBarry Smith .  addr - address to align (any pointer type)
650eca87e8dSBarry Smith 
651d382aafbSBarry Smith    Level: developer
652d382aafbSBarry Smith 
653d382aafbSBarry Smith .seealso: PetscMallocAlign()
654d382aafbSBarry Smith 
655d382aafbSBarry Smith   Concepts: memory allocation
656d382aafbSBarry Smith M*/
657d382aafbSBarry Smith #define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1))
658d382aafbSBarry Smith 
659d382aafbSBarry Smith /*MC
660785e854fSJed Brown    PetscMalloc1 - Allocates an array of memory aligned to PETSC_MEMALIGN
661d382aafbSBarry Smith 
662eca87e8dSBarry Smith    Synopsis:
663aaa7dc30SBarry Smith     #include <petscsys.h>
664785e854fSJed Brown    PetscErrorCode PetscMalloc1(size_t m1,type **r1)
665785e854fSJed Brown 
666785e854fSJed Brown    Not Collective
667785e854fSJed Brown 
668785e854fSJed Brown    Input Parameter:
669390e1bf2SBarry Smith .  m1 - number of elements to allocate  (may be zero)
670785e854fSJed Brown 
671785e854fSJed Brown    Output Parameter:
672785e854fSJed Brown .  r1 - memory allocated in first chunk
673785e854fSJed Brown 
674390e1bf2SBarry Smith    Note: This uses the sizeof() of the memory type requested to determine the total memory to be allocated, therefore you should not
675390e1bf2SBarry Smith          multiply the number of elements requested by the sizeof() the type. For example use
676390e1bf2SBarry Smith $  PetscInt *id;
677390e1bf2SBarry Smith $  PetscMalloc1(10,&id);
678390e1bf2SBarry Smith         not
679390e1bf2SBarry Smith $  PetscInt *id;
680390e1bf2SBarry Smith $  PetscMalloc1(10*sizeof(PetscInt),&id);
681390e1bf2SBarry Smith 
682390e1bf2SBarry Smith         Does not zero the memory allocatd, used PetscCalloc1() to obtain memory that has been zeroed.
683390e1bf2SBarry Smith 
684390e1bf2SBarry Smith    Level: beginner
685785e854fSJed Brown 
6861795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2()
687785e854fSJed Brown 
688785e854fSJed Brown   Concepts: memory allocation
689785e854fSJed Brown 
690785e854fSJed Brown M*/
691f0ba7cfcSLisandro Dalcin #define PetscMalloc1(m1,r1) PetscMalloc((m1)*sizeof(**(r1)),r1)
692785e854fSJed Brown 
693785e854fSJed Brown /*MC
6941795a4d1SJed Brown    PetscCalloc1 - Allocates a cleared (zeroed) array of memory aligned to PETSC_MEMALIGN
6951795a4d1SJed Brown 
6961795a4d1SJed Brown    Synopsis:
697aaa7dc30SBarry Smith     #include <petscsys.h>
6981795a4d1SJed Brown    PetscErrorCode PetscCalloc1(size_t m1,type **r1)
6991795a4d1SJed Brown 
7001795a4d1SJed Brown    Not Collective
7011795a4d1SJed Brown 
7021795a4d1SJed Brown    Input Parameter:
7031795a4d1SJed Brown .  m1 - number of elements to allocate in 1st chunk  (may be zero)
7041795a4d1SJed Brown 
7051795a4d1SJed Brown    Output Parameter:
7061795a4d1SJed Brown .  r1 - memory allocated in first chunk
7071795a4d1SJed Brown 
708390e1bf2SBarry Smith    Notes: see PetsMalloc1() for more details on usage.
709390e1bf2SBarry Smith 
710390e1bf2SBarry Smith    Level: beginner
7111795a4d1SJed Brown 
7121795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2()
7131795a4d1SJed Brown 
7141795a4d1SJed Brown   Concepts: memory allocation
7151795a4d1SJed Brown 
7161795a4d1SJed Brown M*/
7171795a4d1SJed Brown #define PetscCalloc1(m1,r1) (PetscMalloc1((m1),r1) || PetscMemzero(*(r1),(m1)*sizeof(**(r1))))
7181795a4d1SJed Brown 
7191795a4d1SJed Brown /*MC
720dcca6d9dSJed Brown    PetscMalloc2 - Allocates 2 arrays of memory both aligned to PETSC_MEMALIGN
721d382aafbSBarry Smith 
722eca87e8dSBarry Smith    Synopsis:
723aaa7dc30SBarry Smith     #include <petscsys.h>
724dcca6d9dSJed Brown    PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2)
725eca87e8dSBarry Smith 
726eca87e8dSBarry Smith    Not Collective
727eca87e8dSBarry Smith 
728d382aafbSBarry Smith    Input Parameter:
729d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
730dcca6d9dSJed Brown -  m2 - number of elements to allocate in 2nd chunk  (may be zero)
731d382aafbSBarry Smith 
732d382aafbSBarry Smith    Output Parameter:
733d382aafbSBarry Smith +  r1 - memory allocated in first chunk
734d382aafbSBarry Smith -  r2 - memory allocated in second chunk
735d382aafbSBarry Smith 
736d382aafbSBarry Smith    Level: developer
737d382aafbSBarry Smith 
7381795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2()
739d382aafbSBarry Smith 
740d382aafbSBarry Smith   Concepts: memory allocation
741d382aafbSBarry Smith 
742d382aafbSBarry Smith M*/
74320a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED)
7441d2f33c5SMatthew G. Knepley #define PetscMalloc2(m1,r1,m2,r2) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)))
745d382aafbSBarry Smith #else
746ceba6b73SMatthew G. Knepley #define PetscMalloc2(m1,r1,m2,r2) ((((m1)+(m2)) ? (*(r2) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(PETSC_MEMALIGN-1),r1)) : 0) \
747ceba6b73SMatthew G. Knepley                                    || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),0) \
74801b1da61SJed Brown                                    || (0==(m1) ? (*(r1) = 0,0) : 0) || (0==(m2) ? (*(r2) = 0,0) : 0))
749d382aafbSBarry Smith #endif
750d382aafbSBarry Smith 
751d382aafbSBarry Smith /*MC
7521795a4d1SJed Brown    PetscCalloc2 - Allocates 2 cleared (zeroed) arrays of memory both aligned to PETSC_MEMALIGN
753d382aafbSBarry Smith 
754eca87e8dSBarry Smith    Synopsis:
755aaa7dc30SBarry Smith     #include <petscsys.h>
7561795a4d1SJed Brown    PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2)
757eca87e8dSBarry Smith 
758eca87e8dSBarry Smith    Not Collective
759eca87e8dSBarry Smith 
760d382aafbSBarry Smith    Input Parameter:
761d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
7621795a4d1SJed Brown -  m2 - number of elements to allocate in 2nd chunk  (may be zero)
7631795a4d1SJed Brown 
7641795a4d1SJed Brown    Output Parameter:
7651795a4d1SJed Brown +  r1 - memory allocated in first chunk
7661795a4d1SJed Brown -  r2 - memory allocated in second chunk
7671795a4d1SJed Brown 
7681795a4d1SJed Brown    Level: developer
7691795a4d1SJed Brown 
7701795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2()
7711795a4d1SJed Brown 
7721795a4d1SJed Brown   Concepts: memory allocation
7731795a4d1SJed Brown M*/
7741795a4d1SJed Brown #define PetscCalloc2(m1,r1,m2,r2) (PetscMalloc2((m1),(r1),(m2),(r2)) || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))))
7751795a4d1SJed Brown 
7761795a4d1SJed Brown /*MC
777dcca6d9dSJed Brown    PetscMalloc3 - Allocates 3 arrays of memory, all aligned to PETSC_MEMALIGN
778d382aafbSBarry Smith 
779d382aafbSBarry Smith    Synopsis:
780aaa7dc30SBarry Smith     #include <petscsys.h>
781dcca6d9dSJed Brown    PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)
782d382aafbSBarry Smith 
783d382aafbSBarry Smith    Not Collective
784d382aafbSBarry Smith 
785d382aafbSBarry Smith    Input Parameter:
786d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
787d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
788dcca6d9dSJed Brown -  m3 - number of elements to allocate in 3rd chunk  (may be zero)
789d382aafbSBarry Smith 
790d382aafbSBarry Smith    Output Parameter:
791d382aafbSBarry Smith +  r1 - memory allocated in first chunk
792d382aafbSBarry Smith .  r2 - memory allocated in second chunk
793d382aafbSBarry Smith -  r3 - memory allocated in third chunk
794d382aafbSBarry Smith 
795d382aafbSBarry Smith    Level: developer
796d382aafbSBarry Smith 
7971795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc3(), PetscFree3()
798d382aafbSBarry Smith 
799d382aafbSBarry Smith   Concepts: memory allocation
800d382aafbSBarry Smith 
801d382aafbSBarry Smith M*/
80220a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED)
8031d2f33c5SMatthew G. Knepley #define PetscMalloc3(m1,r1,m2,r2,m3,r3) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)))
804d382aafbSBarry Smith #else
805ceba6b73SMatthew 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) \
806278791cbSMatthew G. Knepley                                          || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),0) \
80701b1da61SJed Brown                                          || (0==(m1) ? (*(r1) = 0,0) : 0) || (0==(m2) ? (*(r2) = 0,0) : 0) || (0==(m3) ? (*(r3) = 0,0) : 0))
808d382aafbSBarry Smith #endif
809d382aafbSBarry Smith 
810d382aafbSBarry Smith /*MC
8111795a4d1SJed Brown    PetscCalloc3 - Allocates 3 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
812d382aafbSBarry Smith 
813eca87e8dSBarry Smith    Synopsis:
814aaa7dc30SBarry Smith     #include <petscsys.h>
8151795a4d1SJed Brown    PetscErrorCode PetscCalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3)
816eca87e8dSBarry Smith 
817eca87e8dSBarry Smith    Not Collective
818eca87e8dSBarry Smith 
819d382aafbSBarry Smith    Input Parameter:
820d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
821d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
8221795a4d1SJed Brown -  m3 - number of elements to allocate in 3rd chunk  (may be zero)
8231795a4d1SJed Brown 
8241795a4d1SJed Brown    Output Parameter:
8251795a4d1SJed Brown +  r1 - memory allocated in first chunk
8261795a4d1SJed Brown .  r2 - memory allocated in second chunk
8271795a4d1SJed Brown -  r3 - memory allocated in third chunk
8281795a4d1SJed Brown 
8291795a4d1SJed Brown    Level: developer
8301795a4d1SJed Brown 
8311795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc2(), PetscMalloc3(), PetscFree3()
8321795a4d1SJed Brown 
8331795a4d1SJed Brown   Concepts: memory allocation
8341795a4d1SJed Brown M*/
8351795a4d1SJed Brown #define PetscCalloc3(m1,r1,m2,r2,m3,r3)                                 \
8361795a4d1SJed Brown   (PetscMalloc3((m1),(r1),(m2),(r2),(m3),(r3))                          \
8371795a4d1SJed Brown    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))))
8381795a4d1SJed Brown 
8391795a4d1SJed Brown /*MC
840dcca6d9dSJed Brown    PetscMalloc4 - Allocates 4 arrays of memory, all aligned to PETSC_MEMALIGN
841d382aafbSBarry Smith 
842d382aafbSBarry Smith    Synopsis:
843aaa7dc30SBarry Smith     #include <petscsys.h>
844dcca6d9dSJed Brown    PetscErrorCode PetscMalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)
845d382aafbSBarry Smith 
846d382aafbSBarry Smith    Not Collective
847d382aafbSBarry Smith 
848d382aafbSBarry Smith    Input Parameter:
849d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
850d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
851d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
852dcca6d9dSJed Brown -  m4 - number of elements to allocate in 4th chunk  (may be zero)
853d382aafbSBarry Smith 
854d382aafbSBarry Smith    Output Parameter:
855d382aafbSBarry Smith +  r1 - memory allocated in first chunk
856d382aafbSBarry Smith .  r2 - memory allocated in second chunk
857d382aafbSBarry Smith .  r3 - memory allocated in third chunk
858d382aafbSBarry Smith -  r4 - memory allocated in fourth chunk
859d382aafbSBarry Smith 
860d382aafbSBarry Smith    Level: developer
861d382aafbSBarry Smith 
8621795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4()
863d382aafbSBarry Smith 
864d382aafbSBarry Smith   Concepts: memory allocation
865d382aafbSBarry Smith 
866d382aafbSBarry Smith M*/
86720a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED)
8681d2f33c5SMatthew G. Knepley #define PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)) || PetscMalloc1((m4),(r4)))
869d382aafbSBarry Smith #else
870dcca6d9dSJed Brown #define PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4)                           \
871ceba6b73SMatthew 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) \
872278791cbSMatthew G. Knepley    || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),0) \
87301b1da61SJed Brown    || (0==(m1) ? (*(r1) = 0,0) : 0) || (0==(m2) ? (*(r2) = 0,0) : 0) || (0==(m3) ? (*(r3) = 0,0) : 0) || (0==(m4) ? (*(r4) = 0,0) : 0))
874d382aafbSBarry Smith #endif
875d382aafbSBarry Smith 
876d382aafbSBarry Smith /*MC
8771795a4d1SJed Brown    PetscCalloc4 - Allocates 4 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
878d382aafbSBarry Smith 
879eca87e8dSBarry Smith    Synopsis:
880aaa7dc30SBarry Smith     #include <petscsys.h>
8811795a4d1SJed Brown    PetscErrorCode PetscCalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4)
882eca87e8dSBarry Smith 
883eca87e8dSBarry Smith    Not Collective
884eca87e8dSBarry Smith 
885d382aafbSBarry Smith    Input Parameter:
886d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
887d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
888d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
8891795a4d1SJed Brown -  m4 - number of elements to allocate in 4th chunk  (may be zero)
8901795a4d1SJed Brown 
8911795a4d1SJed Brown    Output Parameter:
8921795a4d1SJed Brown +  r1 - memory allocated in first chunk
8931795a4d1SJed Brown .  r2 - memory allocated in second chunk
8941795a4d1SJed Brown .  r3 - memory allocated in third chunk
8951795a4d1SJed Brown -  r4 - memory allocated in fourth chunk
8961795a4d1SJed Brown 
8971795a4d1SJed Brown    Level: developer
8981795a4d1SJed Brown 
8991795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4()
9001795a4d1SJed Brown 
9011795a4d1SJed Brown   Concepts: memory allocation
9021795a4d1SJed Brown 
9031795a4d1SJed Brown M*/
9041795a4d1SJed Brown #define PetscCalloc4(m1,r1,m2,r2,m3,r3,m4,r4)                           \
9051795a4d1SJed Brown   (PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4)                                \
9061795a4d1SJed Brown    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
9071795a4d1SJed Brown    || PetscMemzero(*(r4),(m4)*sizeof(**(r4))))
9081795a4d1SJed Brown 
9091795a4d1SJed Brown /*MC
910dcca6d9dSJed Brown    PetscMalloc5 - Allocates 5 arrays of memory, all aligned to PETSC_MEMALIGN
911d382aafbSBarry Smith 
912d382aafbSBarry Smith    Synopsis:
913aaa7dc30SBarry Smith     #include <petscsys.h>
914dcca6d9dSJed 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)
915d382aafbSBarry Smith 
916d382aafbSBarry Smith    Not Collective
917d382aafbSBarry Smith 
918d382aafbSBarry Smith    Input Parameter:
919d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
920d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
921d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
922d382aafbSBarry Smith .  m4 - number of elements to allocate in 4th chunk  (may be zero)
923dcca6d9dSJed Brown -  m5 - number of elements to allocate in 5th chunk  (may be zero)
924d382aafbSBarry Smith 
925d382aafbSBarry Smith    Output Parameter:
926d382aafbSBarry Smith +  r1 - memory allocated in first chunk
927d382aafbSBarry Smith .  r2 - memory allocated in second chunk
928d382aafbSBarry Smith .  r3 - memory allocated in third chunk
929d382aafbSBarry Smith .  r4 - memory allocated in fourth chunk
930d382aafbSBarry Smith -  r5 - memory allocated in fifth chunk
931d382aafbSBarry Smith 
932d382aafbSBarry Smith    Level: developer
933d382aafbSBarry Smith 
9341795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc5(), PetscFree5()
935d382aafbSBarry Smith 
936d382aafbSBarry Smith   Concepts: memory allocation
937d382aafbSBarry Smith 
938d382aafbSBarry Smith M*/
93920a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED)
9401d2f33c5SMatthew 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)))
941d382aafbSBarry Smith #else
942dcca6d9dSJed Brown #define PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5)      \
943ceba6b73SMatthew 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) \
944278791cbSMatthew G. Knepley    || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),*(void**)(r5) = PetscAddrAlign(*(r4)+(m4)),0) \
94501b1da61SJed Brown    || (0==(m1) ? (*(r1) = 0,0) : 0) || (0==(m2) ? (*(r2) = 0,0) : 0) || (0==(m3) ? (*(r3) = 0,0) : 0) || (0==(m4) ? (*(r4) = 0,0) : 0) || (0==(m5) ? (*(r5) = 0,0) : 0))
946d382aafbSBarry Smith #endif
947d382aafbSBarry Smith 
948d382aafbSBarry Smith /*MC
9491795a4d1SJed Brown    PetscCalloc5 - Allocates 5 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
950d382aafbSBarry Smith 
951eca87e8dSBarry Smith    Synopsis:
952aaa7dc30SBarry Smith     #include <petscsys.h>
9531795a4d1SJed 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)
954eca87e8dSBarry Smith 
955eca87e8dSBarry Smith    Not Collective
956eca87e8dSBarry Smith 
957d382aafbSBarry Smith    Input Parameter:
958d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
959d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
960d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
961d382aafbSBarry Smith .  m4 - number of elements to allocate in 4th chunk  (may be zero)
9621795a4d1SJed Brown -  m5 - number of elements to allocate in 5th chunk  (may be zero)
9631795a4d1SJed Brown 
9641795a4d1SJed Brown    Output Parameter:
9651795a4d1SJed Brown +  r1 - memory allocated in first chunk
9661795a4d1SJed Brown .  r2 - memory allocated in second chunk
9671795a4d1SJed Brown .  r3 - memory allocated in third chunk
9681795a4d1SJed Brown .  r4 - memory allocated in fourth chunk
9691795a4d1SJed Brown -  r5 - memory allocated in fifth chunk
9701795a4d1SJed Brown 
9711795a4d1SJed Brown    Level: developer
9721795a4d1SJed Brown 
9731795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc5(), PetscFree5()
9741795a4d1SJed Brown 
9751795a4d1SJed Brown   Concepts: memory allocation
9761795a4d1SJed Brown 
9771795a4d1SJed Brown M*/
9781795a4d1SJed Brown #define PetscCalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5)                     \
9791795a4d1SJed Brown   (PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5)                          \
9801795a4d1SJed Brown    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
9811795a4d1SJed Brown    || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5))))
982d382aafbSBarry Smith 
983d382aafbSBarry Smith /*MC
984dcca6d9dSJed Brown    PetscMalloc6 - Allocates 6 arrays of memory, all aligned to PETSC_MEMALIGN
985d382aafbSBarry Smith 
986d382aafbSBarry Smith    Synopsis:
987aaa7dc30SBarry Smith     #include <petscsys.h>
988dcca6d9dSJed 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)
989d382aafbSBarry Smith 
990d382aafbSBarry Smith    Not Collective
991d382aafbSBarry Smith 
992d382aafbSBarry Smith    Input Parameter:
993d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
994d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
995d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
996d382aafbSBarry Smith .  m4 - number of elements to allocate in 4th chunk  (may be zero)
997d382aafbSBarry Smith .  m5 - number of elements to allocate in 5th chunk  (may be zero)
998dcca6d9dSJed Brown -  m6 - number of elements to allocate in 6th chunk  (may be zero)
999d382aafbSBarry Smith 
1000d382aafbSBarry Smith    Output Parameter:
1001d382aafbSBarry Smith +  r1 - memory allocated in first chunk
1002d382aafbSBarry Smith .  r2 - memory allocated in second chunk
1003d382aafbSBarry Smith .  r3 - memory allocated in third chunk
1004d382aafbSBarry Smith .  r4 - memory allocated in fourth chunk
1005d382aafbSBarry Smith .  r5 - memory allocated in fifth chunk
1006d382aafbSBarry Smith -  r6 - memory allocated in sixth chunk
1007d382aafbSBarry Smith 
1008d382aafbSBarry Smith    Level: developer
1009d382aafbSBarry Smith 
10101795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc6(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6()
1011d382aafbSBarry Smith 
1012d382aafbSBarry Smith   Concepts: memory allocation
1013d382aafbSBarry Smith 
1014d382aafbSBarry Smith M*/
101520a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED)
10161d2f33c5SMatthew 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)))
1017d382aafbSBarry Smith #else
1018dcca6d9dSJed Brown #define PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) \
1019ceba6b73SMatthew 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) \
1020278791cbSMatthew 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) \
102101b1da61SJed Brown    || (0==(m1) ? (*(r1) = 0,0) : 0) || (0==(m2) ? (*(r2) = 0,0) : 0) || (0==(m3) ? (*(r3) = 0,0) : 0) || (0==(m4) ? (*(r4) = 0,0) : 0) || (0==(m5) ? (*(r5) = 0,0) : 0) || (0==(m6) ? (*(r6) = 0,0) : 0))
1022d382aafbSBarry Smith #endif
1023d382aafbSBarry Smith 
1024d382aafbSBarry Smith /*MC
10251795a4d1SJed Brown    PetscCalloc6 - Allocates 6 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
1026d382aafbSBarry Smith 
1027eca87e8dSBarry Smith    Synopsis:
1028aaa7dc30SBarry Smith     #include <petscsys.h>
10291795a4d1SJed 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)
1030eca87e8dSBarry Smith 
1031eca87e8dSBarry Smith    Not Collective
1032eca87e8dSBarry Smith 
1033d382aafbSBarry Smith    Input Parameter:
1034d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
1035d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
1036d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
1037d382aafbSBarry Smith .  m4 - number of elements to allocate in 4th chunk  (may be zero)
1038d382aafbSBarry Smith .  m5 - number of elements to allocate in 5th chunk  (may be zero)
10391795a4d1SJed Brown -  m6 - number of elements to allocate in 6th chunk  (may be zero)
10401795a4d1SJed Brown 
10411795a4d1SJed Brown    Output Parameter:
10421795a4d1SJed Brown +  r1 - memory allocated in first chunk
10431795a4d1SJed Brown .  r2 - memory allocated in second chunk
10441795a4d1SJed Brown .  r3 - memory allocated in third chunk
10451795a4d1SJed Brown .  r4 - memory allocated in fourth chunk
10461795a4d1SJed Brown .  r5 - memory allocated in fifth chunk
10471795a4d1SJed Brown -  r6 - memory allocated in sixth chunk
10481795a4d1SJed Brown 
10491795a4d1SJed Brown    Level: developer
10501795a4d1SJed Brown 
10511795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc6(), PetscFree6()
10521795a4d1SJed Brown 
10531795a4d1SJed Brown   Concepts: memory allocation
10541795a4d1SJed Brown M*/
10551795a4d1SJed Brown #define PetscCalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6)               \
10561795a4d1SJed Brown   (PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6)                    \
10571795a4d1SJed Brown    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
10581795a4d1SJed Brown    || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5))) || PetscMemzero(*(r6),(m6)*sizeof(**(r6))))
10591795a4d1SJed Brown 
10601795a4d1SJed Brown /*MC
1061dcca6d9dSJed Brown    PetscMalloc7 - Allocates 7 arrays of memory, all aligned to PETSC_MEMALIGN
1062d382aafbSBarry Smith 
1063d382aafbSBarry Smith    Synopsis:
1064aaa7dc30SBarry Smith     #include <petscsys.h>
1065dcca6d9dSJed 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)
1066d382aafbSBarry Smith 
1067d382aafbSBarry Smith    Not Collective
1068d382aafbSBarry Smith 
1069d382aafbSBarry Smith    Input Parameter:
1070d382aafbSBarry Smith +  m1 - number of elements to allocate in 1st chunk  (may be zero)
1071d382aafbSBarry Smith .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
1072d382aafbSBarry Smith .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
1073d382aafbSBarry Smith .  m4 - number of elements to allocate in 4th chunk  (may be zero)
1074d382aafbSBarry Smith .  m5 - number of elements to allocate in 5th chunk  (may be zero)
1075d382aafbSBarry Smith .  m6 - number of elements to allocate in 6th chunk  (may be zero)
1076dcca6d9dSJed Brown -  m7 - number of elements to allocate in 7th chunk  (may be zero)
1077d382aafbSBarry Smith 
1078d382aafbSBarry Smith    Output Parameter:
1079d382aafbSBarry Smith +  r1 - memory allocated in first chunk
1080d382aafbSBarry Smith .  r2 - memory allocated in second chunk
1081d382aafbSBarry Smith .  r3 - memory allocated in third chunk
1082d382aafbSBarry Smith .  r4 - memory allocated in fourth chunk
1083d382aafbSBarry Smith .  r5 - memory allocated in fifth chunk
1084d382aafbSBarry Smith .  r6 - memory allocated in sixth chunk
1085eca87e8dSBarry Smith -  r7 - memory allocated in seventh chunk
1086d382aafbSBarry Smith 
1087d382aafbSBarry Smith    Level: developer
1088d382aafbSBarry Smith 
10891795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc7(), PetscFree7()
1090d382aafbSBarry Smith 
1091d382aafbSBarry Smith   Concepts: memory allocation
1092d382aafbSBarry Smith 
1093d382aafbSBarry Smith M*/
109420a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED)
10951d2f33c5SMatthew 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)))
1096d382aafbSBarry Smith #else
1097dcca6d9dSJed Brown #define PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) \
1098ceba6b73SMatthew 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) \
1099278791cbSMatthew 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) \
110001b1da61SJed Brown    || (0==(m1) ? (*(r1) = 0,0) : 0) || (0==(m2) ? (*(r2) = 0,0) : 0) || (0==(m3) ? (*(r3) = 0,0) : 0) || (0==(m4) ? (*(r4) = 0,0) : 0) || (0==(m5) ? (*(r5) = 0,0) : 0) || (0==(m6) ? (*(r6) = 0,0) : 0) || (0==(m7) ? (*(r7) = 0,0) : 0))
1101d382aafbSBarry Smith #endif
1102d382aafbSBarry Smith 
1103d382aafbSBarry Smith /*MC
11041795a4d1SJed Brown    PetscCalloc7 - Allocates 7 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN
11051795a4d1SJed Brown 
11061795a4d1SJed Brown    Synopsis:
1107aaa7dc30SBarry Smith     #include <petscsys.h>
11081795a4d1SJed 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)
11091795a4d1SJed Brown 
11101795a4d1SJed Brown    Not Collective
11111795a4d1SJed Brown 
11121795a4d1SJed Brown    Input Parameter:
11131795a4d1SJed Brown +  m1 - number of elements to allocate in 1st chunk  (may be zero)
11141795a4d1SJed Brown .  m2 - number of elements to allocate in 2nd chunk  (may be zero)
11151795a4d1SJed Brown .  m3 - number of elements to allocate in 3rd chunk  (may be zero)
11161795a4d1SJed Brown .  m4 - number of elements to allocate in 4th chunk  (may be zero)
11171795a4d1SJed Brown .  m5 - number of elements to allocate in 5th chunk  (may be zero)
11181795a4d1SJed Brown .  m6 - number of elements to allocate in 6th chunk  (may be zero)
11191795a4d1SJed Brown -  m7 - number of elements to allocate in 7th chunk  (may be zero)
11201795a4d1SJed Brown 
11211795a4d1SJed Brown    Output Parameter:
11221795a4d1SJed Brown +  r1 - memory allocated in first chunk
11231795a4d1SJed Brown .  r2 - memory allocated in second chunk
11241795a4d1SJed Brown .  r3 - memory allocated in third chunk
11251795a4d1SJed Brown .  r4 - memory allocated in fourth chunk
11261795a4d1SJed Brown .  r5 - memory allocated in fifth chunk
11271795a4d1SJed Brown .  r6 - memory allocated in sixth chunk
11281795a4d1SJed Brown -  r7 - memory allocated in seventh chunk
11291795a4d1SJed Brown 
11301795a4d1SJed Brown    Level: developer
11311795a4d1SJed Brown 
11321795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc7(), PetscFree7()
11331795a4d1SJed Brown 
11341795a4d1SJed Brown   Concepts: memory allocation
11351795a4d1SJed Brown M*/
11361795a4d1SJed Brown #define PetscCalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7)         \
11377ba0cc92SJed Brown   (PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7)              \
11381795a4d1SJed Brown    || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \
11391795a4d1SJed Brown    || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5))) || PetscMemzero(*(r6),(m6)*sizeof(**(r6))) \
11407ba0cc92SJed Brown    || PetscMemzero(*(r7),(m7)*sizeof(**(r7))))
11411795a4d1SJed Brown 
11421795a4d1SJed Brown /*MC
1143503cfb0cSBarry Smith    PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to PETSC_MEMALIGN
1144d382aafbSBarry Smith 
1145eca87e8dSBarry Smith    Synopsis:
1146aaa7dc30SBarry Smith     #include <petscsys.h>
1147b00a9115SJed Brown    PetscErrorCode PetscNew(type **result)
1148eca87e8dSBarry Smith 
1149eca87e8dSBarry Smith    Not Collective
1150eca87e8dSBarry Smith 
1151d382aafbSBarry Smith    Output Parameter:
1152b00a9115SJed Brown .  result - memory allocated, sized to match pointer type
1153d382aafbSBarry Smith 
1154d382aafbSBarry Smith    Level: beginner
1155d382aafbSBarry Smith 
1156390e1bf2SBarry Smith .seealso: PetscFree(), PetscMalloc(), PetscNewLog(), PetscCalloc1(), PetscMalloc1()
1157d382aafbSBarry Smith 
1158d382aafbSBarry Smith   Concepts: memory allocation
1159d382aafbSBarry Smith 
1160d382aafbSBarry Smith M*/
1161b00a9115SJed Brown #define PetscNew(b)      PetscCalloc1(1,(b))
1162ad0619ddSBarry Smith 
1163ad0619ddSBarry Smith /*MC
1164b00a9115SJed Brown    PetscNewLog - Allocates memory of a type matching pointer, zeros the memory! Aligned to PETSC_MEMALIGN. Associates the memory allocated
1165ad0619ddSBarry Smith          with the given object using PetscLogObjectMemory().
1166ad0619ddSBarry Smith 
1167ad0619ddSBarry Smith    Synopsis:
1168aaa7dc30SBarry Smith     #include <petscsys.h>
1169b00a9115SJed Brown    PetscErrorCode PetscNewLog(PetscObject obj,type **result)
1170ad0619ddSBarry Smith 
1171ad0619ddSBarry Smith    Not Collective
1172ad0619ddSBarry Smith 
1173ad0619ddSBarry Smith    Input Parameter:
1174b00a9115SJed Brown .  obj - object memory is logged to
1175ad0619ddSBarry Smith 
1176ad0619ddSBarry Smith    Output Parameter:
1177b00a9115SJed Brown .  result - memory allocated, sized to match pointer type
1178ad0619ddSBarry Smith 
1179ad0619ddSBarry Smith    Level: developer
1180ad0619ddSBarry Smith 
1181390e1bf2SBarry Smith .seealso: PetscFree(), PetscMalloc(), PetscNew(), PetscLogObjectMemory(), PetscCalloc1(), PetscMalloc1()
1182ad0619ddSBarry Smith 
1183ad0619ddSBarry Smith   Concepts: memory allocation
1184ad0619ddSBarry Smith 
1185ad0619ddSBarry Smith M*/
1186d12f57a0SLisandro Dalcin #define PetscNewLog(o,b) (PetscNew((b)) || PetscLogObjectMemory((PetscObject)o,sizeof(**(b))))
1187d382aafbSBarry Smith 
1188d382aafbSBarry Smith /*MC
1189d382aafbSBarry Smith    PetscFree - Frees memory
1190d382aafbSBarry Smith 
1191eca87e8dSBarry Smith    Synopsis:
1192aaa7dc30SBarry Smith     #include <petscsys.h>
1193eca87e8dSBarry Smith    PetscErrorCode PetscFree(void *memory)
1194eca87e8dSBarry Smith 
1195eca87e8dSBarry Smith    Not Collective
1196eca87e8dSBarry Smith 
1197d382aafbSBarry Smith    Input Parameter:
1198390e1bf2SBarry Smith .   memory - memory to free (the pointer is ALWAYS set to NULL upon sucess)
1199d382aafbSBarry Smith 
1200d382aafbSBarry Smith    Level: beginner
1201d382aafbSBarry Smith 
120249d7da52SJed Brown    Notes:
1203390e1bf2SBarry Smith    Do not free memory obtained with PetscMalloc2(), PetscCalloc2() etc, they must be freed with PetscFree2() etc.
1204390e1bf2SBarry Smith 
120549d7da52SJed Brown    It is safe to call PetscFree() on a NULL pointer.
1206d382aafbSBarry Smith 
1207390e1bf2SBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscNewLog(), PetscMalloc1(), PetscCalloc1()
1208d382aafbSBarry Smith 
1209d382aafbSBarry Smith   Concepts: memory allocation
1210d382aafbSBarry Smith 
1211d382aafbSBarry Smith M*/
121249d7da52SJed Brown #define PetscFree(a)   ((*PetscTrFree)((void*)(a),__LINE__,PETSC_FUNCTION_NAME,__FILE__) || ((a) = 0,0))
1213d382aafbSBarry Smith 
1214d382aafbSBarry Smith /*MC
1215d382aafbSBarry Smith    PetscFree2 - Frees 2 chunks of memory obtained with PetscMalloc2()
1216d382aafbSBarry Smith 
1217eca87e8dSBarry Smith    Synopsis:
1218aaa7dc30SBarry Smith     #include <petscsys.h>
1219eca87e8dSBarry Smith    PetscErrorCode PetscFree2(void *memory1,void *memory2)
1220eca87e8dSBarry Smith 
1221eca87e8dSBarry Smith    Not Collective
1222eca87e8dSBarry Smith 
1223d382aafbSBarry Smith    Input Parameter:
1224d382aafbSBarry Smith +   memory1 - memory to free
1225d382aafbSBarry Smith -   memory2 - 2nd memory to free
1226d382aafbSBarry Smith 
1227d382aafbSBarry Smith    Level: developer
1228d382aafbSBarry Smith 
1229d382aafbSBarry Smith    Notes: Memory must have been obtained with PetscMalloc2()
1230d382aafbSBarry Smith 
1231d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree()
1232d382aafbSBarry Smith 
1233d382aafbSBarry Smith   Concepts: memory allocation
1234d382aafbSBarry Smith 
1235d382aafbSBarry Smith M*/
1236b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED)
1237d382aafbSBarry Smith #define PetscFree2(m1,m2)   (PetscFree(m2) || PetscFree(m1))
1238d382aafbSBarry Smith #else
1239e38f91f2SMatthew G. Knepley #define PetscFree2(m1,m2)   ((m1) ? ((m2)=0,PetscFree(m1)) : ((m1)=0,PetscFree(m2)))
1240d382aafbSBarry Smith #endif
1241d382aafbSBarry Smith 
1242d382aafbSBarry Smith /*MC
1243d382aafbSBarry Smith    PetscFree3 - Frees 3 chunks of memory obtained with PetscMalloc3()
1244d382aafbSBarry Smith 
1245eca87e8dSBarry Smith    Synopsis:
1246aaa7dc30SBarry Smith     #include <petscsys.h>
1247eca87e8dSBarry Smith    PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3)
1248eca87e8dSBarry Smith 
1249eca87e8dSBarry Smith    Not Collective
1250eca87e8dSBarry Smith 
1251d382aafbSBarry Smith    Input Parameter:
1252d382aafbSBarry Smith +   memory1 - memory to free
1253d382aafbSBarry Smith .   memory2 - 2nd memory to free
1254d382aafbSBarry Smith -   memory3 - 3rd memory to free
1255d382aafbSBarry Smith 
1256d382aafbSBarry Smith    Level: developer
1257d382aafbSBarry Smith 
1258d382aafbSBarry Smith    Notes: Memory must have been obtained with PetscMalloc3()
1259d382aafbSBarry Smith 
1260d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3()
1261d382aafbSBarry Smith 
1262d382aafbSBarry Smith   Concepts: memory allocation
1263d382aafbSBarry Smith 
1264d382aafbSBarry Smith M*/
1265b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED)
1266d382aafbSBarry Smith #define PetscFree3(m1,m2,m3)   (PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1267d382aafbSBarry Smith #else
1268e38f91f2SMatthew 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))))
1269d382aafbSBarry Smith #endif
1270d382aafbSBarry Smith 
1271d382aafbSBarry Smith /*MC
1272d382aafbSBarry Smith    PetscFree4 - Frees 4 chunks of memory obtained with PetscMalloc4()
1273d382aafbSBarry Smith 
1274eca87e8dSBarry Smith    Synopsis:
1275aaa7dc30SBarry Smith     #include <petscsys.h>
1276eca87e8dSBarry Smith    PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4)
1277eca87e8dSBarry Smith 
1278eca87e8dSBarry Smith    Not Collective
1279eca87e8dSBarry Smith 
1280d382aafbSBarry Smith    Input Parameter:
1281d382aafbSBarry Smith +   m1 - memory to free
1282d382aafbSBarry Smith .   m2 - 2nd memory to free
1283d382aafbSBarry Smith .   m3 - 3rd memory to free
1284d382aafbSBarry Smith -   m4 - 4th memory to free
1285d382aafbSBarry Smith 
1286d382aafbSBarry Smith    Level: developer
1287d382aafbSBarry Smith 
1288d382aafbSBarry Smith    Notes: Memory must have been obtained with PetscMalloc4()
1289d382aafbSBarry Smith 
1290d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4()
1291d382aafbSBarry Smith 
1292d382aafbSBarry Smith   Concepts: memory allocation
1293d382aafbSBarry Smith 
1294d382aafbSBarry Smith M*/
1295b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED)
1296d382aafbSBarry Smith #define PetscFree4(m1,m2,m3,m4)   (PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1297d382aafbSBarry Smith #else
1298e38f91f2SMatthew 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)))))
1299d382aafbSBarry Smith #endif
1300d382aafbSBarry Smith 
1301d382aafbSBarry Smith /*MC
1302d382aafbSBarry Smith    PetscFree5 - Frees 5 chunks of memory obtained with PetscMalloc5()
1303d382aafbSBarry Smith 
1304eca87e8dSBarry Smith    Synopsis:
1305aaa7dc30SBarry Smith     #include <petscsys.h>
1306eca87e8dSBarry Smith    PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5)
1307eca87e8dSBarry Smith 
1308eca87e8dSBarry Smith    Not Collective
1309eca87e8dSBarry Smith 
1310d382aafbSBarry Smith    Input Parameter:
1311d382aafbSBarry Smith +   m1 - memory to free
1312d382aafbSBarry Smith .   m2 - 2nd memory to free
1313d382aafbSBarry Smith .   m3 - 3rd memory to free
1314d382aafbSBarry Smith .   m4 - 4th memory to free
1315d382aafbSBarry Smith -   m5 - 5th memory to free
1316d382aafbSBarry Smith 
1317d382aafbSBarry Smith    Level: developer
1318d382aafbSBarry Smith 
1319d382aafbSBarry Smith    Notes: Memory must have been obtained with PetscMalloc5()
1320d382aafbSBarry Smith 
1321d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5()
1322d382aafbSBarry Smith 
1323d382aafbSBarry Smith   Concepts: memory allocation
1324d382aafbSBarry Smith 
1325d382aafbSBarry Smith M*/
1326b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED)
1327d382aafbSBarry Smith #define PetscFree5(m1,m2,m3,m4,m5)   (PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1328d382aafbSBarry Smith #else
1329e38f91f2SMatthew 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)) : \
1330e38f91f2SMatthew G. Knepley                                      ((m4) ? ((m5)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m4)) : ((m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m5))))))
1331d382aafbSBarry Smith #endif
1332d382aafbSBarry Smith 
1333d382aafbSBarry Smith 
1334d382aafbSBarry Smith /*MC
1335d382aafbSBarry Smith    PetscFree6 - Frees 6 chunks of memory obtained with PetscMalloc6()
1336d382aafbSBarry Smith 
1337eca87e8dSBarry Smith    Synopsis:
1338aaa7dc30SBarry Smith     #include <petscsys.h>
1339eca87e8dSBarry Smith    PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6)
1340eca87e8dSBarry Smith 
1341eca87e8dSBarry Smith    Not Collective
1342eca87e8dSBarry Smith 
1343d382aafbSBarry Smith    Input Parameter:
1344d382aafbSBarry Smith +   m1 - memory to free
1345d382aafbSBarry Smith .   m2 - 2nd memory to free
1346d382aafbSBarry Smith .   m3 - 3rd memory to free
1347d382aafbSBarry Smith .   m4 - 4th memory to free
1348d382aafbSBarry Smith .   m5 - 5th memory to free
1349d382aafbSBarry Smith -   m6 - 6th memory to free
1350d382aafbSBarry Smith 
1351d382aafbSBarry Smith 
1352d382aafbSBarry Smith    Level: developer
1353d382aafbSBarry Smith 
1354d382aafbSBarry Smith    Notes: Memory must have been obtained with PetscMalloc6()
1355d382aafbSBarry Smith 
1356d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6()
1357d382aafbSBarry Smith 
1358d382aafbSBarry Smith   Concepts: memory allocation
1359d382aafbSBarry Smith 
1360d382aafbSBarry Smith M*/
1361b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED)
1362d382aafbSBarry Smith #define PetscFree6(m1,m2,m3,m4,m5,m6)   (PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1363d382aafbSBarry Smith #else
1364e38f91f2SMatthew 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)) : \
1365e38f91f2SMatthew 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)) : \
1366e38f91f2SMatthew 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)))))))
1367d382aafbSBarry Smith #endif
1368d382aafbSBarry Smith 
1369d382aafbSBarry Smith /*MC
1370d382aafbSBarry Smith    PetscFree7 - Frees 7 chunks of memory obtained with PetscMalloc7()
1371d382aafbSBarry Smith 
1372eca87e8dSBarry Smith    Synopsis:
1373aaa7dc30SBarry Smith     #include <petscsys.h>
1374eca87e8dSBarry Smith    PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7)
1375eca87e8dSBarry Smith 
1376eca87e8dSBarry Smith    Not Collective
1377eca87e8dSBarry Smith 
1378d382aafbSBarry Smith    Input Parameter:
1379d382aafbSBarry Smith +   m1 - memory to free
1380d382aafbSBarry Smith .   m2 - 2nd memory to free
1381d382aafbSBarry Smith .   m3 - 3rd memory to free
1382d382aafbSBarry Smith .   m4 - 4th memory to free
1383d382aafbSBarry Smith .   m5 - 5th memory to free
1384d382aafbSBarry Smith .   m6 - 6th memory to free
1385d382aafbSBarry Smith -   m7 - 7th memory to free
1386d382aafbSBarry Smith 
1387d382aafbSBarry Smith 
1388d382aafbSBarry Smith    Level: developer
1389d382aafbSBarry Smith 
1390d382aafbSBarry Smith    Notes: Memory must have been obtained with PetscMalloc7()
1391d382aafbSBarry Smith 
1392d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(),
1393d382aafbSBarry Smith           PetscMalloc7()
1394d382aafbSBarry Smith 
1395d382aafbSBarry Smith   Concepts: memory allocation
1396d382aafbSBarry Smith 
1397d382aafbSBarry Smith M*/
1398b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED)
1399d382aafbSBarry Smith #define PetscFree7(m1,m2,m3,m4,m5,m6,m7)   (PetscFree(m7) || PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
1400d382aafbSBarry Smith #else
1401e38f91f2SMatthew 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)) : \
1402e38f91f2SMatthew 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)) : \
140306c0a5e5SMatthew 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)) : \
1404e38f91f2SMatthew G. Knepley                                                    ((m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m7))))))))
1405d382aafbSBarry Smith #endif
1406d382aafbSBarry Smith 
1407efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t,int,const char[],const char[],void**);
1408efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[]);
14093221ece2SMatthew G. Knepley PETSC_EXTERN PetscErrorCode (*PetscTrRealloc)(size_t,int,const char[],const char[],void**);
1410efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t,int,const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[]));
1411014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocClear(void);
1412d382aafbSBarry Smith 
1413d382aafbSBarry Smith /*
1414c1706be6SHong Zhang   Unlike PetscMallocSet and PetscMallocClear which overwrite the existing settings, these two functions save the previous choice of allocator, and should be used in pair.
1415c1706be6SHong Zhang */
1416c1706be6SHong Zhang PETSC_EXTERN PetscErrorCode PetscMallocSetDRAM(void);
1417c1706be6SHong Zhang PETSC_EXTERN PetscErrorCode PetscMallocResetDRAM(void);
1418c1706be6SHong Zhang 
1419c1706be6SHong Zhang /*
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,
1453570b7f6dSBarry Smith               PETSC_CHAR = 6,PETSC_BIT_LOGICAL = 7,PETSC_ENUM = 8,PETSC_BOOL=9, PETSC___FLOAT128 = 10,PETSC_OBJECT = 11, PETSC_FUNCTION = 12, PETSC_STRING = 13, PETSC___FP16 = 14,PETSC_STRUCT, PETSC_DATATYPE_UNKNOWN} PetscDataType;
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
1463570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16)
1464570b7f6dSBarry Smith #define  PETSC_SCALAR  PETSC___FP16
1465d382aafbSBarry Smith #else
1466d382aafbSBarry Smith #define  PETSC_SCALAR  PETSC_DOUBLE
1467d382aafbSBarry Smith #endif
1468d382aafbSBarry Smith #endif
1469ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
1470d382aafbSBarry Smith #define  PETSC_REAL  PETSC_FLOAT
147159a34000SBarry Smith #elif defined(PETSC_USE_REAL___FLOAT128)
147259a34000SBarry Smith #define  PETSC_REAL  PETSC___FLOAT128
1473570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16)
1474570b7f6dSBarry Smith #define  PETSC_REAL  PETSC___FP16
1475d382aafbSBarry Smith #else
1476d382aafbSBarry Smith #define  PETSC_REAL  PETSC_DOUBLE
1477d382aafbSBarry Smith #endif
1478d382aafbSBarry Smith #define  PETSC_FORTRANADDR  PETSC_LONG
1479d382aafbSBarry Smith 
1480014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*);
1481014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*);
1482014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*);
14838e4b2d1dSBarry Smith PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char*,PetscDataType*,PetscBool*);
1484d382aafbSBarry Smith 
1485d382aafbSBarry Smith /*
1486d382aafbSBarry Smith     Basic memory and string operations. These are usually simple wrappers
1487d382aafbSBarry Smith    around the basic Unix system calls, but a few of them have additional
1488d382aafbSBarry Smith    functionality and/or error checking.
1489d382aafbSBarry Smith */
1490014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType);
1491014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemmove(void*,void *,size_t);
1492014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemcmp(const void*,const void*,size_t,PetscBool  *);
1493014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrlen(const char[],size_t*);
1494d67fe73bSBarry Smith PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[],char,int*,char ***);
1495014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int,char **);
1496014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[],const char[],PetscBool  *);
1497014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[],const char[],PetscBool  *);
1498014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[],const char[],PetscBool *);
1499014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[],const char[],size_t,PetscBool *);
1500014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcpy(char[],const char[]);
1501014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcat(char[],const char[]);
1502014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrncat(char[],const char[],size_t);
1503014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrncpy(char[],const char[],size_t);
1504014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrchr(const char[],char,char *[]);
1505014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]);
15062f234a98SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrtoupper(char[]);
1507014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[],char,char *[]);
1508014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrstr(const char[],const char[],char *[]);
1509014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[],const char[],char *[]);
1510014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[],const char[],PetscBool*);
15112c9581d2SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[],const char[],PetscBool*);
1512014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[],const char *const*,PetscInt*);
1513014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[],char *[]);
151447340559SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const*,char***);
15156fed8037SJed Brown PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char***);
15166991f827SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrNArrayallocpy(PetscInt,const char *const*,char***);
15176991f827SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrNArrayDestroy(PetscInt,char***);
1518014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm,const char[],char[],size_t);
1519d382aafbSBarry Smith 
1520573b0fb4SBarry Smith PETSC_EXTERN void PetscStrcmpNoError(const char[],const char[],PetscBool  *);
1521573b0fb4SBarry Smith 
1522d382aafbSBarry Smith /*S
1523d382aafbSBarry Smith     PetscToken - 'Token' used for managing tokenizing strings
1524d382aafbSBarry Smith 
1525d382aafbSBarry Smith   Level: intermediate
1526d382aafbSBarry Smith 
1527d382aafbSBarry Smith .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy()
1528d382aafbSBarry Smith S*/
1529d382aafbSBarry Smith typedef struct _p_PetscToken* PetscToken;
1530d382aafbSBarry Smith 
1531014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*);
1532014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]);
1533014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*);
1534d382aafbSBarry Smith 
1535a53986e1SJed Brown PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt,const char *const*,const char*,PetscInt*,PetscBool*);
1536a53986e1SJed Brown PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const*,const char*,PetscEnum*,PetscBool*);
1537a53986e1SJed Brown 
1538d382aafbSBarry Smith /*
1539d382aafbSBarry Smith    These are MPI operations for MPI_Allreduce() etc
1540d382aafbSBarry Smith */
1541367daffbSBarry Smith PETSC_EXTERN MPI_Op MPIU_MAXSUM_OP;
1542570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1543014dd563SJed Brown PETSC_EXTERN MPI_Op MPIU_SUM;
15442414b3c7SJed Brown #else
15452414b3c7SJed Brown #define MPIU_SUM MPI_SUM
15462414b3c7SJed Brown #endif
1547570b7f6dSBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1548014dd563SJed Brown PETSC_EXTERN MPI_Op MPIU_MAX;
1549014dd563SJed Brown PETSC_EXTERN MPI_Op MPIU_MIN;
1550d9822059SBarry Smith #else
1551d9822059SBarry Smith #define MPIU_MAX MPI_MAX
1552d9822059SBarry Smith #define MPIU_MIN MPI_MIN
1553d9822059SBarry Smith #endif
1554014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*);
1555d382aafbSBarry Smith 
1556014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1557014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm);
1558eb3f98d2SBarry Smith 
1559d382aafbSBarry Smith /*S
1560d382aafbSBarry Smith      PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc
1561d382aafbSBarry Smith 
1562d382aafbSBarry Smith    Level: beginner
1563d382aafbSBarry Smith 
15642981ebdbSBarry Smith    Note: This is the base class from which all PETSc objects are derived from.
1565d382aafbSBarry Smith 
15662b26979fSBarry Smith .seealso:  PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName(), PetscObjectReference(), PetscObjectDereference()
1567d382aafbSBarry Smith S*/
1568d382aafbSBarry Smith typedef struct _p_PetscObject* PetscObject;
1569d382aafbSBarry Smith 
1570270bf2e7SJed Brown /*MC
1571127c8a3bSJed Brown     PetscObjectId - unique integer Id for a PetscObject
1572127c8a3bSJed Brown 
1573127c8a3bSJed Brown     Level: developer
1574127c8a3bSJed Brown 
1575127c8a3bSJed Brown     Notes: Unlike pointer values, object ids are never reused.
1576127c8a3bSJed Brown 
1577127c8a3bSJed Brown .seealso: PetscObjectState, PetscObjectGetId()
1578127c8a3bSJed Brown M*/
157906e41213SSatish Balay #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */
158006e41213SSatish Balay typedef int PetscObjectId;
158106e41213SSatish Balay #else
1582bafee8b4SSatish Balay typedef PetscInt64 PetscObjectId;
158306e41213SSatish Balay #endif
1584127c8a3bSJed Brown 
1585127c8a3bSJed Brown /*MC
1586270bf2e7SJed Brown     PetscObjectState - integer state for a PetscObject
1587270bf2e7SJed Brown 
1588270bf2e7SJed Brown     Level: developer
1589270bf2e7SJed Brown 
1590270bf2e7SJed Brown     Notes:
1591270bf2e7SJed Brown     Object state is always-increasing and (for objects that track state) can be used to determine if an object has
1592270bf2e7SJed 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.
1593270bf2e7SJed Brown 
15948dcff661SJed Brown .seealso: PetscObjectId, PetscObjectStateGet(), PetscObjectStateIncrease(), PetscObjectStateSet()
1595270bf2e7SJed Brown M*/
159606e41213SSatish Balay #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */
159706e41213SSatish Balay typedef int PetscObjectState;
159806e41213SSatish Balay #else
1599bafee8b4SSatish Balay typedef PetscInt64 PetscObjectState;
160006e41213SSatish Balay #endif
1601270bf2e7SJed Brown 
1602d382aafbSBarry Smith /*S
1603140e18c1SBarry Smith      PetscFunctionList - Linked list of functions, possibly stored in dynamic libraries, accessed
1604d382aafbSBarry Smith       by string name
1605d382aafbSBarry Smith 
1606d382aafbSBarry Smith    Level: advanced
1607d382aafbSBarry Smith 
1608140e18c1SBarry Smith .seealso:  PetscFunctionListAdd(), PetscFunctionListDestroy(), PetscOpFlist
1609d382aafbSBarry Smith S*/
1610140e18c1SBarry Smith typedef struct _n_PetscFunctionList *PetscFunctionList;
1611d382aafbSBarry Smith 
1612d382aafbSBarry Smith /*E
1613d382aafbSBarry Smith   PetscFileMode - Access mode for a file.
1614d382aafbSBarry Smith 
1615d382aafbSBarry Smith   Level: beginner
1616d382aafbSBarry Smith 
16171cc8b206SBarry Smith $  FILE_MODE_READ - open a file at its beginning for reading
16181cc8b206SBarry Smith $  FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist)
16191cc8b206SBarry Smith $  FILE_MODE_APPEND - open a file at end for writing
16201cc8b206SBarry Smith $  FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing
16211cc8b206SBarry Smith $  FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end
1622d382aafbSBarry Smith 
1623d382aafbSBarry Smith .seealso: PetscViewerFileSetMode()
1624d382aafbSBarry Smith E*/
1625d382aafbSBarry Smith typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode;
1626d6a4318aSJed Brown extern const char *const PetscFileModes[];
1627d6a4318aSJed Brown 
1628639ff905SBarry Smith /*
1629639ff905SBarry Smith     Defines PETSc error handling.
1630639ff905SBarry Smith */
1631639ff905SBarry Smith #include <petscerror.h>
1632d382aafbSBarry Smith 
16330700a824SBarry Smith #define PETSC_SMALLEST_CLASSID  1211211
1634014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID;
1635014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID;
1636014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *);
1637d382aafbSBarry Smith 
1638d382aafbSBarry Smith /*
1639d382aafbSBarry Smith    Routines that get memory usage information from the OS
1640d382aafbSBarry Smith */
1641014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *);
1642014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *);
1643014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void);
1644b44d5720SBarry Smith PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]);
1645d382aafbSBarry Smith 
1646014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInfoAllow(PetscBool ,const char []);
1647014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal);
1648d382aafbSBarry Smith 
1649d382aafbSBarry Smith /*
1650d382aafbSBarry Smith    Initialization of PETSc
1651d382aafbSBarry Smith */
1652014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]);
1653014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]);
1654014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void);
1655014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *);
1656014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *);
1657014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFinalize(void);
1658014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void);
1659014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***);
1660014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***);
1661014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **);
1662d382aafbSBarry Smith 
1663014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscEnd(void);
1664607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void);
1665d382aafbSBarry Smith 
1666014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]);
1667014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void);
1668014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void);
1669014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]);
1670d382aafbSBarry Smith 
1671d382aafbSBarry Smith /*
1672d382aafbSBarry Smith      These are so that in extern C code we can caste function pointers to non-extern C
16732981ebdbSBarry Smith    function pointers. Since the regular C++ code expects its function pointers to be C++
1674d382aafbSBarry Smith */
1675638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void);
1676638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void);
1677638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void);
1678d382aafbSBarry Smith 
1679d382aafbSBarry Smith /*
1680d382aafbSBarry Smith     Functions that can act on any PETSc object.
1681d382aafbSBarry Smith */
1682014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject*);
1683014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject,MPI_Comm *);
1684014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject,PetscClassId *);
1685014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject,const char *[]);
1686014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetType(PetscObject,const char []);
1687014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject,const char *[]);
1688014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject,const char[]);
1689014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject,const char*[]);
1690014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject,PetscInt);
1691014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject,PetscInt*);
1692014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt);
1693014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject);
1694014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject,PetscInt*);
1695014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject);
1696014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject,PetscMPIInt *);
1697014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject,const char[],PetscObject);
1698014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject,const char[]);
1699014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject,const char[],PetscObject *);
1700bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject,const char[],void (*)(void));
1701bdf89e91SBarry Smith #define PetscObjectComposeFunction(a,b,d) PetscObjectComposeFunction_Private(a,b,(PetscVoidFunction)(d))
1702014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject);
1703014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject);
17040eb63584SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSetPrintedOptions(PetscObject);
17050eb63584SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectInheritPrintedOptions(PetscObject,PetscObject);
1706014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm,PetscMPIInt *);
1707d382aafbSBarry Smith 
1708665c2dedSJed Brown #include <petscviewertypes.h>
1709639ff905SBarry Smith #include <petscoptions.h>
1710639ff905SBarry Smith 
17110633abcbSJed Brown PETSC_EXTERN PetscErrorCode PetscObjectsListGetGlobalNumbering(MPI_Comm,PetscInt,PetscObject*,PetscInt*,PetscInt*);
17120633abcbSJed Brown 
1713639ff905SBarry Smith PETSC_EXTERN PetscErrorCode PetscMemoryShowUsage(PetscViewer,const char[]);
1714c5e4d11fSDmitry Karpeev PETSC_EXTERN PetscErrorCode PetscMemoryView(PetscViewer,const char[]);
1715dae58748SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject,PetscViewer);
1716639ff905SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject,PetscViewer);
17170005d66cSJed Brown #define PetscObjectQueryFunction(obj,name,fptr) PetscObjectQueryFunction_Private((obj),(name),(PetscVoidFunction*)(fptr))
17180005d66cSJed Brown PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject,const char[],void (**)(void));
1719014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject,const char[]);
1720014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject,const char[]);
1721014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject,const char[]);
1722014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject,const char*[]);
1723014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject,const char[]);
1724014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject);
1725014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void);
1726685405a1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject,PetscObject,const char[]);
1727014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject);
1728014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject,const char[],PetscBool *);
17294099cc6bSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompare(PetscObject,const char[],PetscBool *);
1730014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject,PetscBool*,const char[],...);
1731014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void));
1732014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void);
1733d382aafbSBarry Smith 
1734e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
17357aab2a10SBarry Smith PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void);
1736e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject);
1737e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject,PetscBool);
1738e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject);
1739e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject);
1740e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject);
1741e04113cfSBarry Smith PETSC_EXTERN void           PetscStackSAWsGrantAccess(void);
1742e04113cfSBarry Smith PETSC_EXTERN void           PetscStackSAWsTakeAccess(void);
1743e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void);
1744e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void);
174515681b3cSBarry Smith 
1746ec7429eaSBarry Smith #else
17477aab2a10SBarry Smith #define PetscSAWsBlock()                        0
1748e04113cfSBarry Smith #define PetscObjectSAWsViewOff(obj)             0
1749e04113cfSBarry Smith #define PetscObjectSAWsSetBlock(obj,flg)        0
1750e04113cfSBarry Smith #define PetscObjectSAWsBlock(obj)               0
1751e04113cfSBarry Smith #define PetscObjectSAWsGrantAccess(obj)         0
1752e04113cfSBarry Smith #define PetscObjectSAWsTakeAccess(obj)          0
1753e04113cfSBarry Smith #define PetscStackViewSAWs()                    0
1754e04113cfSBarry Smith #define PetscStackSAWsViewOff()                 0
1755e04113cfSBarry Smith #define PetscStackSAWsTakeAccess()
1756e04113cfSBarry Smith #define PetscStackSAWsGrantAccess()
175715681b3cSBarry Smith 
1758ec7429eaSBarry Smith #endif
1759b90c6cbeSBarry Smith 
17607d5d4d99SBarry Smith typedef void* PetscDLHandle;
1761e4d177b5SBarry Smith typedef enum {PETSC_DL_DECIDE=0,PETSC_DL_NOW=1,PETSC_DL_LOCAL=2} PetscDLMode;
176282b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *);
176382b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *);
176482b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **);
17657d5d4d99SBarry Smith 
17665fe58b6fSBarry Smith #if defined(PETSC_USE_DEBUG)
1767a64a8e02SBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**);
17685fe58b6fSBarry Smith #endif
17697eb1d149SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool);
1770a64a8e02SBarry Smith 
1771d382aafbSBarry Smith /*S
1772140e18c1SBarry Smith      PetscObjectList - Linked list of PETSc objects, each accessable by string name
1773d382aafbSBarry Smith 
17741d0fab5eSBarry Smith    Level: developer
1775d382aafbSBarry Smith 
17761d0fab5eSBarry Smith    Notes: Used by PetscObjectCompose() and PetscObjectQuery()
17771d0fab5eSBarry Smith 
1778140e18c1SBarry Smith .seealso:  PetscObjectListAdd(), PetscObjectListDestroy(), PetscObjectListFind(), PetscObjectCompose(), PetscObjectQuery(), PetscFunctionList
1779d382aafbSBarry Smith S*/
1780140e18c1SBarry Smith typedef struct _n_PetscObjectList *PetscObjectList;
1781d382aafbSBarry Smith 
1782140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList*);
1783140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList,const char[],PetscObject*);
1784140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList,PetscObject,char**,PetscBool*);
1785140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *,const char[],PetscObject);
1786140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *,const char[]);
1787140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList,PetscObjectList *);
1788d382aafbSBarry Smith 
1789d382aafbSBarry Smith /*
1790503cfb0cSBarry Smith     Dynamic library lists. Lists of names of routines in objects or in dynamic
1791d382aafbSBarry Smith   link libraries that will be loaded as needed.
1792d382aafbSBarry Smith */
1793a240a19fSJed Brown 
1794a240a19fSJed Brown #define PetscFunctionListAdd(list,name,fptr) PetscFunctionListAdd_Private((list),(name),(PetscVoidFunction)(fptr))
1795a240a19fSJed Brown PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList*,const char[],void (*)(void));
1796140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList*);
17971c9cd337SJed Brown #define PetscFunctionListFind(list,name,fptr) PetscFunctionListFind_Private((list),(name),(PetscVoidFunction*)(fptr))
17981c9cd337SJed Brown PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList,const char[],void (**)(void));
1799140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFunctionList,const char[]);
1800140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList,PetscFunctionList *);
1801140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList,PetscViewer);
1802140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList,const char ***,int*);
1803d382aafbSBarry Smith 
1804d382aafbSBarry Smith /*S
1805d382aafbSBarry Smith      PetscDLLibrary - Linked list of dynamics libraries to search for functions
1806d382aafbSBarry Smith 
1807d382aafbSBarry Smith    Level: advanced
1808d382aafbSBarry Smith 
1809d382aafbSBarry Smith .seealso:  PetscDLLibraryOpen()
1810d382aafbSBarry Smith S*/
1811d382aafbSBarry Smith typedef struct _n_PetscDLLibrary *PetscDLLibrary;
1812014dd563SJed Brown PETSC_EXTERN PetscDLLibrary  PetscDLLibrariesLoaded;
1813014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]);
1814014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]);
1815014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **);
1816014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary);
1817014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool  *);
1818014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *);
1819014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary);
1820d382aafbSBarry Smith 
1821d382aafbSBarry Smith /*
1822d382aafbSBarry Smith      Useful utility routines
1823d382aafbSBarry Smith */
1824014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*);
1825014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*);
1826014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt);
1827014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt);
1828014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject);
1829014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*);
1830d382aafbSBarry Smith 
1831503cfb0cSBarry Smith /*
1832ace3abfcSBarry Smith     PetscNot - negates a logical type value and returns result as a PetscBool
1833503cfb0cSBarry Smith 
1834503cfb0cSBarry Smith     Notes: This is useful in cases like
1835503cfb0cSBarry Smith $     int        *a;
1836ace3abfcSBarry Smith $     PetscBool  flag = PetscNot(a)
18371cc8b206SBarry Smith      where !a would not return a PetscBool because we cannot provide a cast from int to PetscBool in C.
1838503cfb0cSBarry Smith */
1839d382aafbSBarry Smith #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)
1840503cfb0cSBarry Smith 
1841d382aafbSBarry Smith /*MC
1842d382aafbSBarry Smith     PetscHelpPrintf - Prints help messages.
1843d382aafbSBarry Smith 
1844d382aafbSBarry Smith    Synopsis:
1845aaa7dc30SBarry Smith     #include <petscsys.h>
1846d382aafbSBarry Smith      PetscErrorCode (*PetscHelpPrintf)(const char format[],...);
1847d382aafbSBarry Smith 
1848eca87e8dSBarry Smith     Not Collective
1849eca87e8dSBarry Smith 
1850d382aafbSBarry Smith     Input Parameters:
1851d382aafbSBarry Smith .   format - the usual printf() format string
1852d382aafbSBarry Smith 
1853d382aafbSBarry Smith    Level: developer
1854d382aafbSBarry Smith 
1855d382aafbSBarry Smith     Fortran Note:
1856d382aafbSBarry Smith     This routine is not supported in Fortran.
1857d382aafbSBarry Smith 
1858d382aafbSBarry Smith     Concepts: help messages^printing
1859d382aafbSBarry Smith     Concepts: printing^help messages
1860d382aafbSBarry Smith 
1861d382aafbSBarry Smith .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf()
1862d382aafbSBarry Smith M*/
1863014dd563SJed Brown PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...);
1864d382aafbSBarry Smith 
1865fcfd50ebSBarry Smith /*
1866fcfd50ebSBarry Smith      Defines PETSc profiling.
1867fcfd50ebSBarry Smith */
18682c8e378dSBarry Smith #include <petsclog.h>
1869fcfd50ebSBarry Smith 
1870fcfd50ebSBarry Smith /*
1871fcfd50ebSBarry Smith       Simple PETSc parallel IO for ASCII printing
1872fcfd50ebSBarry Smith */
1873014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]);
1874014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**);
1875014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*);
1876014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...);
1877014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...);
1878014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...);
1879014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...);
1880fcfd50ebSBarry Smith 
1881014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...);
1882014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...);
1883014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...);
1884d382aafbSBarry Smith 
1885d382aafbSBarry Smith #if defined(PETSC_HAVE_POPEN)
1886014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **);
188796a8e8cbSBarry Smith PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm,FILE*,int*);
188874ba8654SBarry Smith PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]);
1889d382aafbSBarry Smith #endif
1890d382aafbSBarry Smith 
1891014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm,const char[],...);
1892014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...);
18930ec8b6e3SBarry Smith PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm,FILE*);
1894014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]);
1895014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**);
1896014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm,const char[],const char[],FILE**);
1897014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char*[]);
1898d382aafbSBarry Smith 
1899014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPopUpSelect(MPI_Comm,const char*,const char*,int,const char**,int*);
1900d382aafbSBarry Smith 
1901d382aafbSBarry Smith /*S
1902d382aafbSBarry Smith      PetscContainer - Simple PETSc object that contains a pointer to any required data
1903d382aafbSBarry Smith 
1904d382aafbSBarry Smith    Level: advanced
1905d382aafbSBarry Smith 
1906d382aafbSBarry Smith .seealso:  PetscObject, PetscContainerCreate()
1907d382aafbSBarry Smith S*/
1908014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID;
1909d382aafbSBarry Smith typedef struct _p_PetscContainer*  PetscContainer;
1910014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer,void **);
1911014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer,void *);
1912014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer*);
1913014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm,PetscContainer *);
1914014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void*));
1915d382aafbSBarry Smith 
1916d382aafbSBarry Smith /*
1917d382aafbSBarry Smith    For use in debuggers
1918d382aafbSBarry Smith */
1919014dd563SJed Brown PETSC_EXTERN PetscMPIInt PetscGlobalRank;
1920014dd563SJed Brown PETSC_EXTERN PetscMPIInt PetscGlobalSize;
1921014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt,const PetscInt[],PetscViewer);
1922014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt,const PetscReal[],PetscViewer);
1923014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt,const PetscScalar[],PetscViewer);
1924d382aafbSBarry Smith 
1925a663daf8SBarry Smith #include <stddef.h>
1926a3aaec0aSJed Brown #include <string.h>             /* for memcpy, memset */
1927d382aafbSBarry Smith #if defined(PETSC_HAVE_STDLIB_H)
1928d382aafbSBarry Smith #include <stdlib.h>
1929d382aafbSBarry Smith #endif
19306c7e564aSBarry Smith 
19314a92a979SJed Brown #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__)
1932d382aafbSBarry Smith #include <xmmintrin.h>
1933d382aafbSBarry Smith #endif
1934d382aafbSBarry Smith 
1935d382aafbSBarry Smith /*@C
1936d382aafbSBarry Smith    PetscMemcpy - Copies n bytes, beginning at location b, to the space
1937d382aafbSBarry Smith    beginning at location a. The two memory regions CANNOT overlap, use
1938d382aafbSBarry Smith    PetscMemmove() in that case.
1939d382aafbSBarry Smith 
1940d382aafbSBarry Smith    Not Collective
1941d382aafbSBarry Smith 
1942d382aafbSBarry Smith    Input Parameters:
1943d382aafbSBarry Smith +  b - pointer to initial memory space
1944d382aafbSBarry Smith -  n - length (in bytes) of space to copy
1945d382aafbSBarry Smith 
1946d382aafbSBarry Smith    Output Parameter:
1947d382aafbSBarry Smith .  a - pointer to copy space
1948d382aafbSBarry Smith 
1949d382aafbSBarry Smith    Level: intermediate
1950d382aafbSBarry Smith 
1951d382aafbSBarry Smith    Compile Option:
1952d382aafbSBarry Smith     PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used
1953d382aafbSBarry Smith                                   for memory copies on double precision values.
1954d382aafbSBarry Smith     PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used
1955d382aafbSBarry Smith                                   for memory copies on double precision values.
1956d382aafbSBarry Smith     PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used
1957d382aafbSBarry Smith                                   for memory copies on double precision values.
1958d382aafbSBarry Smith 
1959d382aafbSBarry Smith    Note:
1960d382aafbSBarry Smith    This routine is analogous to memcpy().
1961d382aafbSBarry Smith 
1962503cfb0cSBarry Smith    Developer Note: this is inlined for fastest performance
1963503cfb0cSBarry Smith 
1964d382aafbSBarry Smith   Concepts: memory^copying
1965d382aafbSBarry Smith   Concepts: copying^memory
1966d382aafbSBarry Smith 
1967d382aafbSBarry Smith .seealso: PetscMemmove()
1968d382aafbSBarry Smith 
1969d382aafbSBarry Smith @*/
19707087cfbeSBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscMemcpy(void *a,const void *b,size_t n)
1971d382aafbSBarry Smith {
1972d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG)
1973c5e4d11fSDmitry Karpeev   size_t al = (size_t) a,bl = (size_t) b;
1974c5e4d11fSDmitry Karpeev   size_t nl = (size_t) n;
1975a7e36092SMatthew G Knepley   PetscFunctionBegin;
1976e32f2f54SBarry Smith   if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer");
1977e32f2f54SBarry Smith   if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer");
1978a7e36092SMatthew G Knepley #else
1979d382aafbSBarry Smith   PetscFunctionBegin;
1980a7e36092SMatthew G Knepley #endif
1981a47a537aSLisandro Dalcin   if (a != b && n > 0) {
1982d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG)
1983e47d2de2SBarry 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\
1984d382aafbSBarry Smith               or make sure your copy regions and lengths are correct. \n\
1985d382aafbSBarry Smith               Length (bytes) %ld first address %ld second address %ld",nl,al,bl);
1986d382aafbSBarry Smith #endif
1987d382aafbSBarry Smith #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY))
1988c5e4d11fSDmitry Karpeev    if (!(a % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
1989d382aafbSBarry Smith       size_t len = n/sizeof(PetscScalar);
1990d382aafbSBarry Smith #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY)
1991c5df96a5SBarry Smith       PetscBLASInt   one = 1,blen;
1992c5df96a5SBarry Smith       PetscErrorCode ierr;
1993c5df96a5SBarry Smith       ierr = PetscBLASIntCast(len,&blen);CHKERRQ(ierr);
19948b83055fSJed Brown       PetscStackCallBLAS("BLAScopy",BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one));
1995d382aafbSBarry Smith #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY)
1996d382aafbSBarry Smith       fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a);
1997d382aafbSBarry Smith #else
1998d382aafbSBarry Smith       size_t      i;
1999d382aafbSBarry Smith       PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a;
2000d382aafbSBarry Smith       for (i=0; i<len; i++) y[i] = x[i];
2001d382aafbSBarry Smith #endif
2002d382aafbSBarry Smith     } else {
2003d382aafbSBarry Smith       memcpy((char*)(a),(char*)(b),n);
2004d382aafbSBarry Smith     }
2005d382aafbSBarry Smith #else
2006d382aafbSBarry Smith     memcpy((char*)(a),(char*)(b),n);
2007d382aafbSBarry Smith #endif
2008d382aafbSBarry Smith   }
2009d382aafbSBarry Smith   PetscFunctionReturn(0);
2010d382aafbSBarry Smith }
2011d382aafbSBarry Smith 
2012d382aafbSBarry Smith /*@C
2013d382aafbSBarry Smith    PetscMemzero - Zeros the specified memory.
2014d382aafbSBarry Smith 
2015d382aafbSBarry Smith    Not Collective
2016d382aafbSBarry Smith 
2017d382aafbSBarry Smith    Input Parameters:
2018d382aafbSBarry Smith +  a - pointer to beginning memory location
2019d382aafbSBarry Smith -  n - length (in bytes) of memory to initialize
2020d382aafbSBarry Smith 
2021d382aafbSBarry Smith    Level: intermediate
2022d382aafbSBarry Smith 
2023d382aafbSBarry Smith    Compile Option:
2024d382aafbSBarry Smith    PETSC_PREFER_BZERO - on certain machines (the IBM RS6000) the bzero() routine happens
2025d382aafbSBarry Smith   to be faster than the memset() routine. This flag causes the bzero() routine to be used.
2026d382aafbSBarry Smith 
2027503cfb0cSBarry Smith    Developer Note: this is inlined for fastest performance
2028503cfb0cSBarry Smith 
2029d382aafbSBarry Smith    Concepts: memory^zeroing
2030d382aafbSBarry Smith    Concepts: zeroing^memory
2031d382aafbSBarry Smith 
2032d382aafbSBarry Smith .seealso: PetscMemcpy()
2033d382aafbSBarry Smith @*/
20347087cfbeSBarry Smith PETSC_STATIC_INLINE PetscErrorCode  PetscMemzero(void *a,size_t n)
2035d382aafbSBarry Smith {
2036d382aafbSBarry Smith   if (n > 0) {
2037d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG)
2038e32f2f54SBarry Smith     if (!a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer");
2039d382aafbSBarry Smith #endif
2040d382aafbSBarry Smith #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO)
2041d382aafbSBarry Smith     if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
2042d382aafbSBarry Smith       size_t      i,len = n/sizeof(PetscScalar);
2043d382aafbSBarry Smith       PetscScalar *x = (PetscScalar*)a;
2044d382aafbSBarry Smith       for (i=0; i<len; i++) x[i] = 0.0;
2045d382aafbSBarry Smith     } else {
2046d382aafbSBarry Smith #elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
2047d382aafbSBarry Smith     if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
2048d382aafbSBarry Smith       PetscInt len = n/sizeof(PetscScalar);
2049d382aafbSBarry Smith       fortranzero_(&len,(PetscScalar*)a);
2050d382aafbSBarry Smith     } else {
2051d382aafbSBarry Smith #endif
2052d382aafbSBarry Smith #if defined(PETSC_PREFER_BZERO)
2053d382aafbSBarry Smith       bzero((char *)a,n);
2054d382aafbSBarry Smith #else
2055d382aafbSBarry Smith       memset((char*)a,0,n);
2056d382aafbSBarry Smith #endif
2057d382aafbSBarry Smith #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
2058d382aafbSBarry Smith     }
2059d382aafbSBarry Smith #endif
2060d382aafbSBarry Smith   }
2061d382aafbSBarry Smith   return 0;
2062d382aafbSBarry Smith }
2063d382aafbSBarry Smith 
2064d382aafbSBarry Smith /*MC
2065d382aafbSBarry Smith    PetscPrefetchBlock - Prefetches a block of memory
2066d382aafbSBarry Smith 
2067eca87e8dSBarry Smith    Synopsis:
2068aaa7dc30SBarry Smith     #include <petscsys.h>
2069eca87e8dSBarry Smith     void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t)
2070eca87e8dSBarry Smith 
2071d382aafbSBarry Smith    Not Collective
2072d382aafbSBarry Smith 
2073d382aafbSBarry Smith    Input Parameters:
2074d382aafbSBarry Smith +  a - pointer to first element to fetch (any type but usually PetscInt or PetscScalar)
2075d382aafbSBarry Smith .  n - number of elements to fetch
2076d382aafbSBarry Smith .  rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors)
207750d8bf02SJed Brown -  t - temporal locality (PETSC_PREFETCH_HINT_{NTA,T0,T1,T2}), see note
2078d382aafbSBarry Smith 
2079d382aafbSBarry Smith    Level: developer
2080d382aafbSBarry Smith 
2081d382aafbSBarry Smith    Notes:
2082d382aafbSBarry Smith    The last two arguments (rw and t) must be compile-time constants.
2083d382aafbSBarry Smith 
208450d8bf02SJed Brown    Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality.  Not all architectures offer
208550d8bf02SJed Brown    equivalent locality hints, but the following macros are always defined to their closest analogue.
208650d8bf02SJed 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).
208763cf1ef0SJed 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.
208863cf1ef0SJed Brown .  PETSC_PREFETCH_HINT_T1 - Fetch to level 2 and higher (not L1).
208963cf1ef0SJed Brown -  PETSC_PREFETCH_HINT_T2 - Fetch to high-level cache only.  (On many systems, T0 and T1 are equivalent.)
2090d382aafbSBarry Smith 
2091d382aafbSBarry Smith    This function does nothing on architectures that do not support prefetch and never errors (even if passed an invalid
2092d382aafbSBarry Smith    address).
2093d382aafbSBarry Smith 
2094d382aafbSBarry Smith    Concepts: memory
2095d382aafbSBarry Smith M*/
2096d382aafbSBarry Smith #define PetscPrefetchBlock(a,n,rw,t) do {                               \
2097d382aafbSBarry Smith     const char *_p = (const char*)(a),*_end = (const char*)((a)+(n));   \
2098d382aafbSBarry Smith     for ( ; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p,(rw),(t)); \
2099d382aafbSBarry Smith   } while (0)
2100d382aafbSBarry Smith 
2101d382aafbSBarry Smith /*
2102d382aafbSBarry Smith       Determine if some of the kernel computation routines use
2103d382aafbSBarry Smith    Fortran (rather than C) for the numerical calculations. On some machines
2104d382aafbSBarry Smith    and compilers (like complex numbers) the Fortran version of the routines
2105d382aafbSBarry Smith    is faster than the C/C++ versions. The flag --with-fortran-kernels
2106e2e64c6bSBarry Smith    should be used with ./configure to turn these on.
2107d382aafbSBarry Smith */
2108d382aafbSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS)
2109d382aafbSBarry Smith 
2110d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL)
2111d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTCRL
2112d382aafbSBarry Smith #endif
2113d382aafbSBarry Smith 
21145a11e1b2SBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM)
21155a11e1b2SBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM
2116d382aafbSBarry Smith #endif
2117d382aafbSBarry Smith 
2118d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
2119d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
2120d382aafbSBarry Smith #endif
2121d382aafbSBarry Smith 
2122d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
2123d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
2124d382aafbSBarry Smith #endif
2125d382aafbSBarry Smith 
2126d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM)
2127d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_NORM
2128d382aafbSBarry Smith #endif
2129d382aafbSBarry Smith 
2130d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
2131d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MAXPY
2132d382aafbSBarry Smith #endif
2133d382aafbSBarry Smith 
2134d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
2135d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
2136d382aafbSBarry Smith #endif
2137d382aafbSBarry Smith 
2138d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ)
2139d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ
2140d382aafbSBarry Smith #endif
2141d382aafbSBarry Smith 
2142d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
2143d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
2144d382aafbSBarry Smith #endif
2145d382aafbSBarry Smith 
2146d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
2147d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
2148d382aafbSBarry Smith #endif
2149d382aafbSBarry Smith 
2150d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
2151d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MDOT
2152d382aafbSBarry Smith #endif
2153d382aafbSBarry Smith 
2154d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
2155d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_XTIMESY
2156d382aafbSBarry Smith #endif
2157d382aafbSBarry Smith 
2158d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX)
2159d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_AYPX
2160d382aafbSBarry Smith #endif
2161d382aafbSBarry Smith 
2162d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY)
2163d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_WAXPY
2164d382aafbSBarry Smith #endif
2165d382aafbSBarry Smith 
2166d382aafbSBarry Smith #endif
2167d382aafbSBarry Smith 
2168d382aafbSBarry Smith /*
2169d382aafbSBarry Smith     Macros for indicating code that should be compiled with a C interface,
2170d382aafbSBarry Smith    rather than a C++ interface. Any routines that are dynamically loaded
2171d382aafbSBarry Smith    (such as the PCCreate_XXX() routines) must be wrapped so that the name
2172d382aafbSBarry Smith    mangler does not change the functions symbol name. This just hides the
2173d382aafbSBarry Smith    ugly extern "C" {} wrappers.
2174d382aafbSBarry Smith */
2175d382aafbSBarry Smith #if defined(__cplusplus)
2176d382aafbSBarry Smith #define EXTERN_C_BEGIN extern "C" {
2177d382aafbSBarry Smith #define EXTERN_C_END }
2178d382aafbSBarry Smith #else
2179d382aafbSBarry Smith #define EXTERN_C_BEGIN
2180d382aafbSBarry Smith #define EXTERN_C_END
2181d382aafbSBarry Smith #endif
2182d382aafbSBarry Smith 
2183d382aafbSBarry Smith /* --------------------------------------------------------------------*/
2184d382aafbSBarry Smith 
2185d382aafbSBarry Smith /*MC
2186d382aafbSBarry Smith     MPI_Comm - the basic object used by MPI to determine which processes are involved in a
2187d382aafbSBarry Smith         communication
2188d382aafbSBarry Smith 
2189d382aafbSBarry Smith    Level: beginner
2190d382aafbSBarry Smith 
2191d382aafbSBarry Smith    Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm
2192d382aafbSBarry Smith 
2193d382aafbSBarry Smith .seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF
2194d382aafbSBarry Smith M*/
2195d382aafbSBarry Smith 
2196d382aafbSBarry Smith /*MC
2197d382aafbSBarry Smith     PetscScalar - PETSc type that represents either a double precision real number, a double precision
2198390e1bf2SBarry Smith        complex number, a single precision real number, a __float128 real or complex or a __fp16 real - if the code is configured
2199390e1bf2SBarry Smith        with --with-scalar-type=real,complex --with-precision=single,double,__float128,__fp16
2200390e1bf2SBarry Smith 
2201390e1bf2SBarry Smith    Notes: For MPI calls that require datatypes, use MPIU_SCALAR as the datatype for PetscScalar and MPIU_SUM, MPIU_MAX etc for operations.
2202390e1bf2SBarry Smith           They will automatically work correctly regardless of the size of PetscScalar
2203d382aafbSBarry Smith 
2204d382aafbSBarry Smith    Level: beginner
2205d382aafbSBarry Smith 
2206390e1bf2SBarry Smith .seealso: PetscReal, MPIU_SCALAR, PetscInt, MPIU_REAL, PetscComplex, MPIU_INT
2207d382aafbSBarry Smith M*/
2208d382aafbSBarry Smith 
2209d382aafbSBarry Smith /*MC
22108619c96cSJed Brown     PetscComplex - PETSc type that represents a complex number with precision matching that of PetscReal.
22118619c96cSJed Brown 
22128619c96cSJed Brown    Synopsis:
22138619c96cSJed Brown    #include <petscsys.h>
22148619c96cSJed Brown    PetscComplex number = 1. + 2.*PETSC_i;
22158619c96cSJed Brown 
22168619c96cSJed Brown    Level: beginner
22178619c96cSJed Brown 
2218390e1bf2SBarry Smith    Notes: For MPI calls that require datatypes, use MPIU_COMPLEX as the datatype for PetscComplex and MPIU_SUM etc for operations.
2219390e1bf2SBarry Smith           They will automatically work correctly regardless of the size of PetscComplex
2220390e1bf2SBarry Smith 
2221390e1bf2SBarry Smith           See PetscScalar for details on how to ./configure the size of PetscReal
2222390e1bf2SBarry Smith 
22238cd53115SBarry Smith           Complex numbers are automatically available if PETSc was able to find a working complex implementation
22248619c96cSJed Brown 
22258619c96cSJed Brown .seealso: PetscReal, PetscComplex, MPIU_COMPLEX, PetscInt, PETSC_i
22268619c96cSJed Brown M*/
22278619c96cSJed Brown 
22288619c96cSJed Brown /*MC
2229d382aafbSBarry Smith     PetscReal - PETSc type that represents a real number version of PetscScalar
2230d382aafbSBarry Smith 
2231d382aafbSBarry Smith    Level: beginner
2232d382aafbSBarry Smith 
2233390e1bf2SBarry Smith    Notes: For MPI calls that require datatypes, use MPIU_REAL as the datatype for PetscScalar and MPIU_SUM, MPIU_MAX etc for operations.
2234390e1bf2SBarry Smith           They will automatically work correctly regardless of the size of PetscReal
2235390e1bf2SBarry Smith 
2236390e1bf2SBarry Smith           See PetscScalar for details on how to ./configure the size of PetscReal
2237390e1bf2SBarry Smith 
2238390e1bf2SBarry Smith .seealso: PetscScalar, PetscComplex, MPIU_REAL, MPIU_SCALAR
2239d382aafbSBarry Smith M*/
2240d382aafbSBarry Smith 
2241d382aafbSBarry Smith /*MC
2242d382aafbSBarry Smith     MPIU_SCALAR - MPI datatype corresponding to PetscScalar
2243d382aafbSBarry Smith 
2244d382aafbSBarry Smith    Level: beginner
2245d382aafbSBarry Smith 
2246d382aafbSBarry Smith     Note: In MPI calls that require an MPI datatype that matches a PetscScalar or array of PetscScalars
2247d382aafbSBarry Smith           pass this value
2248d382aafbSBarry Smith 
2249390e1bf2SBarry Smith .seealso: PetscReal, PetscScalar, MPIU_INT, MPIU_REAL, MPIU_COMPLEX
2250d382aafbSBarry Smith M*/
2251d382aafbSBarry Smith 
2252d382aafbSBarry Smith #if defined(PETSC_HAVE_MPIIO)
2253d382aafbSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
2254014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2255014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
2256d382aafbSBarry Smith #else
2257d382aafbSBarry Smith #define MPIU_File_write_all(a,b,c,d,e) MPI_File_write_all(a,b,c,d,e)
2258d382aafbSBarry Smith #define MPIU_File_read_all(a,b,c,d,e) MPI_File_read_all(a,b,c,d,e)
2259d382aafbSBarry Smith #endif
2260d382aafbSBarry Smith #endif
2261d382aafbSBarry Smith 
2262d382aafbSBarry Smith /* the following petsc_static_inline require petscerror.h */
2263d382aafbSBarry Smith 
2264d382aafbSBarry Smith /* Limit MPI to 32-bits */
2265d382aafbSBarry Smith #define PETSC_MPI_INT_MAX  2147483647
2266d382aafbSBarry Smith #define PETSC_MPI_INT_MIN -2147483647
2267d382aafbSBarry Smith /* Limit BLAS to 32-bits */
2268d382aafbSBarry Smith #define PETSC_BLAS_INT_MAX  2147483647
2269d382aafbSBarry Smith #define PETSC_BLAS_INT_MIN -2147483647
2270d382aafbSBarry Smith 
227161b0d812SBarry Smith /*@C
227261b0d812SBarry Smith     PetscBLASIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscBLASInt (which may be 32 bits in size), generates an
227361b0d812SBarry Smith          error if the PetscBLASInt is not large enough to hold the number.
227461b0d812SBarry Smith 
227561b0d812SBarry Smith    Not Collective
227661b0d812SBarry Smith 
227761b0d812SBarry Smith    Input Parameter:
227861b0d812SBarry Smith .     a - the PetscInt value
227961b0d812SBarry Smith 
228061b0d812SBarry Smith    Output Parameter:
228161b0d812SBarry Smith .     b - the resulting PetscBLASInt value
228261b0d812SBarry Smith 
228361b0d812SBarry Smith    Level: advanced
228461b0d812SBarry Smith 
228561b0d812SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscMPIIntCast()
228661b0d812SBarry Smith @*/
2287c5df96a5SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscBLASIntCast(PetscInt a,PetscBLASInt *b)
2288c5df96a5SBarry Smith {
2289c5df96a5SBarry Smith   PetscFunctionBegin;
2290ab7117d1SBarry Smith   *b =  (PetscBLASInt)(a);
2291c5df96a5SBarry Smith #if defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_HAVE_64BIT_BLAS_INDICES)
2292c5df96a5SBarry Smith   if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK");
2293c5df96a5SBarry Smith #endif
2294c5df96a5SBarry Smith   PetscFunctionReturn(0);
2295c5df96a5SBarry Smith }
2296c5df96a5SBarry Smith 
229761b0d812SBarry Smith /*@C
229861b0d812SBarry Smith     PetscMPIIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscMPIInt (which may be 32 bits in size), generates an
229961b0d812SBarry Smith          error if the PetscMPIInt is not large enough to hold the number.
230061b0d812SBarry Smith 
230161b0d812SBarry Smith    Not Collective
230261b0d812SBarry Smith 
230361b0d812SBarry Smith    Input Parameter:
230461b0d812SBarry Smith .     a - the PetscInt value
230561b0d812SBarry Smith 
230661b0d812SBarry Smith    Output Parameter:
230761b0d812SBarry Smith .     b - the resulting PetscMPIInt value
230861b0d812SBarry Smith 
230961b0d812SBarry Smith    Level: advanced
231061b0d812SBarry Smith 
231161b0d812SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast()
231261b0d812SBarry Smith @*/
23134dc2109aSBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscMPIIntCast(PetscInt a,PetscMPIInt *b)
23144dc2109aSBarry Smith {
23154dc2109aSBarry Smith   PetscFunctionBegin;
2316ab7117d1SBarry Smith   *b =  (PetscMPIInt)(a);
23174dc2109aSBarry Smith #if defined(PETSC_USE_64BIT_INDICES)
23184dc2109aSBarry Smith   if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for MPI");
23194dc2109aSBarry Smith #endif
23204dc2109aSBarry Smith   PetscFunctionReturn(0);
23214dc2109aSBarry Smith }
23224dc2109aSBarry Smith 
2323bafee8b4SSatish Balay #define PetscInt64Mult(a,b)   ((PetscInt64)(a))*((PetscInt64)(b))
23242f18eb33SBarry Smith 
23252f18eb33SBarry Smith /*@C
23262f18eb33SBarry Smith 
23272f18eb33SBarry 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
23282f18eb33SBarry Smith 
23292f18eb33SBarry Smith    Not Collective
23302f18eb33SBarry Smith 
23312f18eb33SBarry Smith    Input Parameter:
23322f18eb33SBarry Smith +     a - the PetscReal value
23332f18eb33SBarry Smith -     b - the second value
23342f18eb33SBarry Smith 
2335390e1bf2SBarry Smith    Returns:
2336390e1bf2SBarry Smith       the result as a PetscInt value
23372f18eb33SBarry Smith 
2338bafee8b4SSatish Balay    Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
23392f18eb33SBarry Smith    Use PetscIntMultTruncate() to compute the product of two positive PetscInt and truncate to fit a PetscInt
23402f18eb33SBarry 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
23412f18eb33SBarry Smith 
23422f18eb33SBarry Smith    Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks.
23432f18eb33SBarry Smith 
23442f18eb33SBarry Smith    This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
23452f18eb33SBarry Smith 
23462f18eb33SBarry Smith    Level: advanced
23472f18eb33SBarry Smith 
2348390e1bf2SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
23492f18eb33SBarry Smith @*/
23502f18eb33SBarry Smith PETSC_STATIC_INLINE PetscInt PetscRealIntMultTruncate(PetscReal a,PetscInt b)
23512f18eb33SBarry Smith {
2352bafee8b4SSatish Balay   PetscInt64 r;
23532f18eb33SBarry Smith 
2354bafee8b4SSatish Balay   r  =  (PetscInt64) (a*(PetscReal)b);
23552f18eb33SBarry Smith   if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
23562f18eb33SBarry Smith   return (PetscInt) r;
23572f18eb33SBarry Smith }
23582f18eb33SBarry Smith 
23592f18eb33SBarry Smith /*@C
23602f18eb33SBarry Smith 
23612f18eb33SBarry Smith    PetscIntMultTruncate - Computes the product of two positive PetscInt and truncates the value to slightly less than the maximal possible value
23622f18eb33SBarry Smith 
23632f18eb33SBarry Smith    Not Collective
23642f18eb33SBarry Smith 
23652f18eb33SBarry Smith    Input Parameter:
23662f18eb33SBarry Smith +     a - the PetscInt value
23672f18eb33SBarry Smith -     b - the second value
23682f18eb33SBarry Smith 
2369390e1bf2SBarry Smith    Returns:
2370390e1bf2SBarry Smith       the result as a PetscInt value
23712f18eb33SBarry Smith 
2372bafee8b4SSatish Balay    Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
23732f18eb33SBarry Smith    Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
23742f18eb33SBarry 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
23752f18eb33SBarry Smith 
23762f18eb33SBarry Smith    Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks.
23772f18eb33SBarry Smith 
23782f18eb33SBarry Smith    This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
23792f18eb33SBarry Smith 
23802f18eb33SBarry Smith    Level: advanced
23812f18eb33SBarry Smith 
2382390e1bf2SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
23832f18eb33SBarry Smith @*/
23842f18eb33SBarry Smith PETSC_STATIC_INLINE PetscInt PetscIntMultTruncate(PetscInt a,PetscInt b)
23852f18eb33SBarry Smith {
2386bafee8b4SSatish Balay   PetscInt64 r;
23872f18eb33SBarry Smith 
2388bafee8b4SSatish Balay   r  =  PetscInt64Mult(a,b);
23892f18eb33SBarry Smith   if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
23902f18eb33SBarry Smith   return (PetscInt) r;
23912f18eb33SBarry Smith }
23922f18eb33SBarry Smith 
2393f91af8c7SBarry Smith /*@C
2394f91af8c7SBarry Smith 
2395f91af8c7SBarry Smith    PetscIntSumTruncate - Computes the sum of two positive PetscInt and truncates the value to slightly less than the maximal possible value
2396f91af8c7SBarry Smith 
2397f91af8c7SBarry Smith    Not Collective
2398f91af8c7SBarry Smith 
2399f91af8c7SBarry Smith    Input Parameter:
2400f91af8c7SBarry Smith +     a - the PetscInt value
2401f91af8c7SBarry Smith -     b - the second value
2402f91af8c7SBarry Smith 
2403390e1bf2SBarry Smith    Returns:
2404390e1bf2SBarry Smith      the result as a PetscInt value
2405f91af8c7SBarry Smith 
2406bafee8b4SSatish Balay    Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64
2407f91af8c7SBarry Smith    Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt
2408f91af8c7SBarry 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
2409f91af8c7SBarry Smith 
2410f91af8c7SBarry Smith    This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2411f91af8c7SBarry Smith 
2412f91af8c7SBarry Smith    Level: advanced
2413f91af8c7SBarry Smith 
2414390e1bf2SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2415f91af8c7SBarry Smith @*/
2416f91af8c7SBarry Smith PETSC_STATIC_INLINE PetscInt PetscIntSumTruncate(PetscInt a,PetscInt b)
2417f91af8c7SBarry Smith {
2418bafee8b4SSatish Balay   PetscInt64 r;
2419f91af8c7SBarry Smith 
2420bafee8b4SSatish Balay   r  =  ((PetscInt64)a) + ((PetscInt64)b);
2421f91af8c7SBarry Smith   if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100;
2422f91af8c7SBarry Smith   return (PetscInt) r;
2423f91af8c7SBarry Smith }
2424f91af8c7SBarry Smith 
24252f18eb33SBarry Smith /*@C
24262f18eb33SBarry Smith 
24272f18eb33SBarry Smith    PetscIntMultError - Computes the product of two positive PetscInt and generates an error with overflow.
24282f18eb33SBarry Smith 
24292f18eb33SBarry Smith    Not Collective
24302f18eb33SBarry Smith 
24312f18eb33SBarry Smith    Input Parameter:
24322f18eb33SBarry Smith +     a - the PetscInt value
24332f18eb33SBarry Smith -     b - the second value
24342f18eb33SBarry Smith 
24352f18eb33SBarry Smith    Output Parameter:ma
2436390e1bf2SBarry Smith .     result - the result as a PetscInt value, or NULL if you do not want the result, you just want to check if it overflows
24372f18eb33SBarry Smith 
2438bafee8b4SSatish Balay    Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64
24392f18eb33SBarry Smith    Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt
24402f18eb33SBarry Smith 
2441220afb94SBarry Smith    Developers Note: We currently assume that PetscInt addition does not overflow, this is obviously wrong but requires many more checks.
24422f18eb33SBarry Smith 
24432f18eb33SBarry Smith    Level: advanced
24442f18eb33SBarry Smith 
2445220afb94SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntMult64(), PetscIntSumError()
24462f18eb33SBarry Smith @*/
24472f18eb33SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscIntMultError(PetscInt a,PetscInt b,PetscInt *result)
24482f18eb33SBarry Smith {
2449bafee8b4SSatish Balay   PetscInt64 r;
24502f18eb33SBarry Smith 
24512f18eb33SBarry Smith   PetscFunctionBegin;
2452bafee8b4SSatish Balay   r  =  PetscInt64Mult(a,b);
24532f18eb33SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES)
24542f18eb33SBarry 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);
24552f18eb33SBarry Smith #endif
2456f91af8c7SBarry Smith   if (result) *result = (PetscInt) r;
2457f91af8c7SBarry Smith   PetscFunctionReturn(0);
2458f91af8c7SBarry Smith }
2459f91af8c7SBarry Smith 
2460f91af8c7SBarry Smith /*@C
2461f91af8c7SBarry Smith 
2462fbfcfee5SBarry Smith    PetscIntSumError - Computes the sum of two positive PetscInt and generates an error with overflow.
2463f91af8c7SBarry Smith 
2464f91af8c7SBarry Smith    Not Collective
2465f91af8c7SBarry Smith 
2466f91af8c7SBarry Smith    Input Parameter:
2467f91af8c7SBarry Smith +     a - the PetscInt value
2468f91af8c7SBarry Smith -     b - the second value
2469f91af8c7SBarry Smith 
2470f91af8c7SBarry Smith    Output Parameter:ma
2471390e1bf2SBarry Smith .     c - the result as a PetscInt value,  or NULL if you do not want the result, you just want to check if it overflows
2472f91af8c7SBarry Smith 
2473bafee8b4SSatish Balay    Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64
2474f91af8c7SBarry Smith    Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt
2475f91af8c7SBarry Smith 
2476f91af8c7SBarry Smith    Level: advanced
2477f91af8c7SBarry Smith 
2478390e1bf2SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult()
2479f91af8c7SBarry Smith @*/
2480f91af8c7SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscIntSumError(PetscInt a,PetscInt b,PetscInt *result)
2481f91af8c7SBarry Smith {
2482bafee8b4SSatish Balay   PetscInt64 r;
2483f91af8c7SBarry Smith 
2484f91af8c7SBarry Smith   PetscFunctionBegin;
2485bafee8b4SSatish Balay   r  =  ((PetscInt64)a) + ((PetscInt64)b);
2486f91af8c7SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES)
2487f91af8c7SBarry 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);
2488f91af8c7SBarry Smith #endif
2489f91af8c7SBarry Smith   if (result) *result = (PetscInt) r;
24902f18eb33SBarry Smith   PetscFunctionReturn(0);
24912f18eb33SBarry Smith }
2492c5df96a5SBarry Smith 
2493d382aafbSBarry Smith /*
24942981ebdbSBarry Smith      The IBM include files define hz, here we hide it so that it may be used as a regular user variable.
2495d382aafbSBarry Smith */
2496d382aafbSBarry Smith #if defined(hz)
2497d382aafbSBarry Smith #undef hz
2498d382aafbSBarry Smith #endif
2499d382aafbSBarry Smith 
2500d382aafbSBarry Smith /*  For arrays that contain filenames or paths */
2501d382aafbSBarry Smith 
2502d382aafbSBarry Smith 
2503d382aafbSBarry Smith #if defined(PETSC_HAVE_LIMITS_H)
2504d382aafbSBarry Smith #include <limits.h>
2505d382aafbSBarry Smith #endif
2506d382aafbSBarry Smith #if defined(PETSC_HAVE_SYS_PARAM_H)
2507d382aafbSBarry Smith #include <sys/param.h>
2508d382aafbSBarry Smith #endif
2509d382aafbSBarry Smith #if defined(PETSC_HAVE_SYS_TYPES_H)
2510d382aafbSBarry Smith #include <sys/types.h>
2511d382aafbSBarry Smith #endif
2512d382aafbSBarry Smith #if defined(MAXPATHLEN)
2513d382aafbSBarry Smith #  define PETSC_MAX_PATH_LEN     MAXPATHLEN
2514d382aafbSBarry Smith #elif defined(MAX_PATH)
2515d382aafbSBarry Smith #  define PETSC_MAX_PATH_LEN     MAX_PATH
2516d382aafbSBarry Smith #elif defined(_MAX_PATH)
2517d382aafbSBarry Smith #  define PETSC_MAX_PATH_LEN     _MAX_PATH
2518d382aafbSBarry Smith #else
2519d382aafbSBarry Smith #  define PETSC_MAX_PATH_LEN     4096
2520d382aafbSBarry Smith #endif
2521d382aafbSBarry Smith 
2522d382aafbSBarry Smith /*MC
2523d382aafbSBarry Smith 
252466d79e26SBarry Smith     PETSC_VERSION - This manual page provides information about how PETSc documents and uses its version information. This information is available to both C/C++
252566d79e26SBarry Smith                     and Fortran compilers when petscsys.h is included.
252666d79e26SBarry Smith 
252766d79e26SBarry Smith 
252866d79e26SBarry Smith     The current PETSc version and the API for accessing it are defined in petscversion.h
252966d79e26SBarry Smith 
253066d79e26SBarry Smith     The complete version number is given as the triple  PETSC_VERSION_MAJOR.PETSC_VERSION_MINOR.PETSC_VERSION_SUBMINOR (in short hand x.y.z)
253166d79e26SBarry Smith 
253266d79e26SBarry Smith     A change in the minor version number (y) indicates possible/likely changes in the PETSc API. Note this is different than with the semantic versioning convention
253366d79e26SBarry Smith     where only a change in the major version number (x) indicates a change in the API.
253466d79e26SBarry Smith 
253566d79e26SBarry Smith     A subminor greater than zero indicates a patch release. Version x.y.z maintains source and binary compatibility with version x.y.w for all z and w
253666d79e26SBarry Smith 
253766d79e26SBarry Smith     Use the macros PETSC_VERSION_EQ(x,y,z), PETSC_VERSION_LT(x,y,z), PETSC_VERSION_LE(x,y,z), PETSC_VERSION_GT(x,y,z),
253866d79e26SBarry Smith     PETSC_VERSION_GE(x,y,z) to determine if the current version is equal to, less than, less than or equal to, greater than or greater than or equal to a given
253966d79e26SBarry Smith     version number (x.y.z).
254066d79e26SBarry Smith 
254166d79e26SBarry Smith     PETSC_RELEASE_DATE is the date the x.y version was released (i.e. the version before any patch releases)
254266d79e26SBarry Smith 
254366d79e26SBarry Smith     PETSC_VERSION_DATE is the date the x.y.z version was released
254466d79e26SBarry Smith 
254566d79e26SBarry Smith     PETSC_VERSION_GIT is the last git commit to the repository given in the form vx.y.z-wwwww
254666d79e26SBarry Smith 
254766d79e26SBarry Smith     PETSC_VERSION_DATE_GIT is the date of the last git commit to the repository
254866d79e26SBarry Smith 
254966d79e26SBarry Smith     Level: intermediate
255066d79e26SBarry Smith 
255166d79e26SBarry Smith     PETSC_VERSION_() and PETSC_VERSION_PATCH are deprecated and will eventually be removed. For several releases PETSC_VERSION_PATCH is always 0
255266d79e26SBarry Smith 
255366d79e26SBarry Smith M*/
255466d79e26SBarry Smith 
255566d79e26SBarry Smith /*MC
255666d79e26SBarry Smith 
25571b266c99SBarry Smith     UsingFortran - To use PETSc with Fortran you must use both PETSc include files and modules. At the beginning
25581b266c99SBarry Smith       of every function and module definition you need something like
2559d382aafbSBarry Smith 
2560d382aafbSBarry Smith $
2561af0996ceSBarry Smith $#include "petsc/finclude/petscXXX.h"
25620f665fc7SPatrick Sanan $         use petscXXX
25631b266c99SBarry Smith 
2564692afcd8SPatrick Sanan      You can declare PETSc variables using either of the following.
25651b266c99SBarry Smith 
2566d382aafbSBarry Smith $    XXX variablename
25671b266c99SBarry Smith $    type(tXXX) variablename
25681b266c99SBarry Smith 
2569692afcd8SPatrick Sanan     For example,
25701b266c99SBarry Smith 
2571bfc4c25eSBarry Smith $#include "petsc/finclude/petscvec.h"
25721b266c99SBarry Smith $         use petscvec
2573d382aafbSBarry Smith $
2574692afcd8SPatrick Sanan $    Vec b
2575692afcd8SPatrick Sanan $    type(tVec) x
2576d382aafbSBarry Smith 
2577d382aafbSBarry Smith     Level: beginner
2578d382aafbSBarry Smith 
2579d382aafbSBarry Smith M*/
2580d382aafbSBarry Smith 
2581014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t);
2582014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t);
2583014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t);
2584014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t);
2585014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]);
2586014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t);
258727710113SBarry Smith PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t);
25885f309d01SBarry Smith PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt*,PetscInt*,PetscInt*,PetscInt*);
2589d382aafbSBarry Smith 
2590014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt,PetscInt[]);
259122ab5688SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscSortedRemoveDupsInt(PetscInt*,PetscInt[]);
2592014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt*,PetscInt[]);
259360e03357SMatthew G Knepley PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt*);
2594d2aeb606SJed Brown PETSC_EXTERN PetscErrorCode PetscFindMPIInt(PetscMPIInt, PetscInt, const PetscMPIInt[], PetscInt*);
2595014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]);
2596014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]);
2597014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]);
25986c2863d0SBarry Smith PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt,PetscInt[],PetscInt[],PetscInt[]);
259917d7d925SStefano Zampini PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt,PetscMPIInt[]);
260017d7d925SStefano Zampini PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt*,PetscMPIInt[]);
2601014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]);
2602014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]);
260317df18f2SToby Isaac PETSC_EXTERN PetscErrorCode PetscSortIntWithDataArray(PetscInt,PetscInt[],void*,size_t,void*);
2604014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt,PetscReal[]);
2605014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]);
2606745b41b2SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt*,PetscReal[]);
2607014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]);
2608014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]);
2609014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt,const PetscBool [],const PetscInt[],PetscInt*,PetscInt**,PetscInt**,PetscInt**,PetscInt**);
26106c2863d0SBarry Smith PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt,const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],PetscInt*,PetscInt**,PetscInt**);
26116c2863d0SBarry Smith PETSC_EXTERN PetscErrorCode PetscMergeIntArray(PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt*,PetscInt**);
2612e498c390SJed Brown PETSC_EXTERN PetscErrorCode PetscMergeMPIIntArray(PetscInt,const PetscMPIInt[],PetscInt,const PetscMPIInt[],PetscInt*,PetscMPIInt**);
2613d382aafbSBarry Smith 
2614014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDisplay(void);
2615014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t);
2616d382aafbSBarry Smith 
261776bdecfbSBarry Smith /*J
2618d382aafbSBarry Smith     PetscRandomType - String with the name of a PETSc randomizer
2619d382aafbSBarry Smith 
2620d382aafbSBarry Smith    Level: beginner
2621d382aafbSBarry Smith 
262225ccb61fSToby Isaac    Notes: to use SPRNG or RANDOM123 you must have ./configure PETSc
262325ccb61fSToby Isaac    with the option --download-sprng or --download-random123
2624d382aafbSBarry Smith 
26258f6c3df8SBarry Smith .seealso: PetscRandomSetType(), PetscRandom, PetscRandomCreate()
262676bdecfbSBarry Smith J*/
262719fd82e9SBarry Smith typedef const char* PetscRandomType;
2628d382aafbSBarry Smith #define PETSCRAND       "rand"
2629d382aafbSBarry Smith #define PETSCRAND48     "rand48"
2630d382aafbSBarry Smith #define PETSCSPRNG      "sprng"
2631c5e4d11fSDmitry Karpeev #define PETSCRANDER48   "rander48"
263225ccb61fSToby Isaac #define PETSCRANDOM123  "random123"
2633d382aafbSBarry Smith 
2634d382aafbSBarry Smith /* Logging support */
2635014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID;
2636d382aafbSBarry Smith 
2637607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void);
2638d382aafbSBarry Smith 
2639d382aafbSBarry Smith /*S
2640d382aafbSBarry Smith      PetscRandom - Abstract PETSc object that manages generating random numbers
2641d382aafbSBarry Smith 
2642d382aafbSBarry Smith    Level: intermediate
2643d382aafbSBarry Smith 
2644d382aafbSBarry Smith   Concepts: random numbers
2645d382aafbSBarry Smith 
2646d382aafbSBarry Smith .seealso:  PetscRandomCreate(), PetscRandomGetValue(), PetscRandomType
2647d382aafbSBarry Smith S*/
2648d382aafbSBarry Smith typedef struct _p_PetscRandom*   PetscRandom;
2649d382aafbSBarry Smith 
2650d382aafbSBarry Smith /* Dynamic creation and loading functions */
2651140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList PetscRandomList;
2652d382aafbSBarry Smith 
2653bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],PetscErrorCode (*)(PetscRandom));
265419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType);
2655014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom);
265619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType*);
2657685405a1SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscRandomViewFromOptions(PetscRandom A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
2658014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer);
2659d382aafbSBarry Smith 
2660014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*);
2661014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*);
2662014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*);
2663014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*);
2664014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar);
2665014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long);
2666014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *);
2667014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom);
2668014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*);
2669d382aafbSBarry Smith 
2670014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t);
2671014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t);
2672014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t);
2673014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]);
2674014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t);
2675014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *);
2676014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *);
267797540f07SSatish Balay PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]);
267897540f07SSatish Balay PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]);
2679d382aafbSBarry Smith 
2680014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscDataType);
2681014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscDataType);
2682014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,void*,PetscInt,PetscDataType,PetscBool );
2683014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,void*,PetscInt,PetscDataType,PetscBool );
2684014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *);
2685014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryClose(int);
2686014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool  *);
2687014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool  *);
2688014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t);
2689014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *);
2690014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *);
2691c891a504SStefano Zampini #if defined(PETSC_USE_SOCKET_VIEWER)
2692e2fc02c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[],int,int*);
2693c891a504SStefano Zampini #endif
2694d382aafbSBarry Smith 
2695d382aafbSBarry Smith /*
2696d382aafbSBarry Smith    In binary files variables are stored using the following lengths,
2697d382aafbSBarry Smith   regardless of how they are stored in memory on any one particular
2698d382aafbSBarry Smith   machine. Use these rather then sizeof() in computing sizes for
2699d382aafbSBarry Smith   PetscBinarySeek().
2700d382aafbSBarry Smith */
2701d382aafbSBarry Smith #define PETSC_BINARY_INT_SIZE   (32/8)
2702d382aafbSBarry Smith #define PETSC_BINARY_FLOAT_SIZE  (32/8)
2703d382aafbSBarry Smith #define PETSC_BINARY_CHAR_SIZE  (8/8)
2704d382aafbSBarry Smith #define PETSC_BINARY_SHORT_SIZE  (16/8)
2705d382aafbSBarry Smith #define PETSC_BINARY_DOUBLE_SIZE  (64/8)
2706d382aafbSBarry Smith #define PETSC_BINARY_SCALAR_SIZE  sizeof(PetscScalar)
2707d382aafbSBarry Smith 
2708d382aafbSBarry Smith /*E
2709d382aafbSBarry Smith   PetscBinarySeekType - argument to PetscBinarySeek()
2710d382aafbSBarry Smith 
2711d382aafbSBarry Smith   Level: advanced
2712d382aafbSBarry Smith 
2713d382aafbSBarry Smith .seealso: PetscBinarySeek(), PetscBinarySynchronizedSeek()
2714d382aafbSBarry Smith E*/
2715d382aafbSBarry Smith typedef enum {PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1,PETSC_BINARY_SEEK_END = 2} PetscBinarySeekType;
2716014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*);
2717014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*);
2718014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt);
2719d382aafbSBarry Smith 
2720014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]);
2721014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool );
2722014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void);
2723014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*);
2724014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void);
2725014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void);
2726d382aafbSBarry Smith 
2727014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*);
2728014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**);
2729014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**);
2730014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**);
2731014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**);
2732cf4b5b4fSJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt*,const void*,PetscMPIInt*,PetscMPIInt**,void*)
2733cf4b5b4fSJed Brown   PetscAttrMPIPointerWithType(6,3);
2734d815da10SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedF(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
2735d815da10SJed Brown                                                     PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
2736d815da10SJed Brown                                                     PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
2737d815da10SJed Brown   PetscAttrMPIPointerWithType(6,3);
27386afbe7ddSJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedFReq(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,
27396afbe7ddSJed Brown                                                        MPI_Request**,MPI_Request**,
27406afbe7ddSJed Brown                                                        PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
27416afbe7ddSJed Brown                                                        PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
27426afbe7ddSJed Brown   PetscAttrMPIPointerWithType(6,3);
2743d382aafbSBarry Smith 
27446145cd65SJed Brown /*E
27456145cd65SJed Brown     PetscBuildTwoSidedType - algorithm for setting up two-sided communication
27466145cd65SJed Brown 
27476145cd65SJed Brown $  PETSC_BUILDTWOSIDED_ALLREDUCE - classical algorithm using an MPI_Allreduce with
27486145cd65SJed Brown $      a buffer of length equal to the communicator size. Not memory-scalable due to
27496145cd65SJed Brown $      the large reduction size. Requires only MPI-1.
27506145cd65SJed Brown $  PETSC_BUILDTWOSIDED_IBARRIER - nonblocking algorithm based on MPI_Issend and MPI_Ibarrier.
27516145cd65SJed Brown $      Proved communication-optimal in Hoefler, Siebert, and Lumsdaine (2010). Requires MPI-3.
27521654bf6bSJed Brown $  PETSC_BUILDTWOSIDED_REDSCATTER - similar to above, but use more optimized function
27531654bf6bSJed Brown $      that only communicates the part of the reduction that is necessary.  Requires MPI-2.
27546145cd65SJed Brown 
27556145cd65SJed Brown    Level: developer
27566145cd65SJed Brown 
27576145cd65SJed Brown .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedSetType(), PetscCommBuildTwoSidedGetType()
27586145cd65SJed Brown E*/
27596145cd65SJed Brown typedef enum {
27606145cd65SJed Brown   PETSC_BUILDTWOSIDED_NOTSET = -1,
27616145cd65SJed Brown   PETSC_BUILDTWOSIDED_ALLREDUCE = 0,
27621654bf6bSJed Brown   PETSC_BUILDTWOSIDED_IBARRIER = 1,
276312af867fSJed Brown   PETSC_BUILDTWOSIDED_REDSCATTER = 2
27646145cd65SJed Brown   /* Updates here must be accompanied by updates in finclude/petscsys.h and the string array in mpits.c */
27656145cd65SJed Brown } PetscBuildTwoSidedType;
27666145cd65SJed Brown PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[];
27676145cd65SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm,PetscBuildTwoSidedType);
27686145cd65SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm,PetscBuildTwoSidedType*);
27696145cd65SJed Brown 
2770014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSSEIsEnabled(MPI_Comm,PetscBool  *,PetscBool  *);
2771d382aafbSBarry Smith 
2772d382aafbSBarry Smith /*E
2773d382aafbSBarry Smith   InsertMode - Whether entries are inserted or added into vectors or matrices
2774d382aafbSBarry Smith 
2775d382aafbSBarry Smith   Level: beginner
2776d382aafbSBarry Smith 
2777d382aafbSBarry Smith .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2778d382aafbSBarry Smith           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(),
2779d382aafbSBarry Smith           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd()
2780d382aafbSBarry Smith E*/
27816fbadbe2SMatthew 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;
2782d382aafbSBarry Smith 
2783d382aafbSBarry Smith /*MC
2784d382aafbSBarry Smith     INSERT_VALUES - Put a value into a vector or matrix, overwrites any previous value
2785d382aafbSBarry Smith 
2786d382aafbSBarry Smith     Level: beginner
2787d382aafbSBarry Smith 
2788d382aafbSBarry Smith .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2789eca87e8dSBarry Smith           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), ADD_VALUES,
2790eca87e8dSBarry Smith           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES
2791d382aafbSBarry Smith 
2792d382aafbSBarry Smith M*/
2793d382aafbSBarry Smith 
2794d382aafbSBarry Smith /*MC
2795d382aafbSBarry Smith     ADD_VALUES - Adds a value into a vector or matrix, if there previously was no value, just puts the
2796d382aafbSBarry Smith                 value into that location
2797d382aafbSBarry Smith 
2798d382aafbSBarry Smith     Level: beginner
2799d382aafbSBarry Smith 
2800d382aafbSBarry Smith .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
2801eca87e8dSBarry Smith           VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), INSERT_VALUES,
2802eca87e8dSBarry Smith           MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES
2803d382aafbSBarry Smith 
2804d382aafbSBarry Smith M*/
2805d382aafbSBarry Smith 
2806d382aafbSBarry Smith /*MC
2807d382aafbSBarry Smith     MAX_VALUES - Puts the maximum of the scattered/gathered value and the current value into each location
2808d382aafbSBarry Smith 
2809d382aafbSBarry Smith     Level: beginner
2810d382aafbSBarry Smith 
2811d382aafbSBarry Smith .seealso: InsertMode, VecScatterBegin(), VecScatterEnd(), ADD_VALUES, INSERT_VALUES
2812d382aafbSBarry Smith 
2813d382aafbSBarry Smith M*/
2814d382aafbSBarry Smith 
2815ce94432eSBarry Smith PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject);
2816ce94432eSBarry Smith 
281745487dadSJed Brown typedef enum {PETSC_SUBCOMM_GENERAL=0,PETSC_SUBCOMM_CONTIGUOUS=1,PETSC_SUBCOMM_INTERLACED=2} PetscSubcommType;
281845487dadSJed Brown PETSC_EXTERN const char *const PetscSubcommTypes[];
281945487dadSJed Brown 
2820d382aafbSBarry Smith /*S
2821306c2d5bSBarry Smith    PetscSubcomm - A decomposition of an MPI communicator into subcommunicators
2822306c2d5bSBarry Smith 
2823306c2d5bSBarry Smith    Notes: After a call to PetscSubcommSetType(), PetscSubcommSetTypeGeneral(), or PetscSubcommSetFromOptions() one may call
2824306c2d5bSBarry Smith $     PetscSubcommChild() returns the associated subcommunicator on this process
28253bf92927SBarry Smith $     PetscSubcommContiguousParent() returns a parent communitor but with all child of the same subcommunicator having contiguous rank
2826306c2d5bSBarry Smith 
2827306c2d5bSBarry Smith    Sample Usage:
2828306c2d5bSBarry Smith        PetscSubcommCreate()
2829306c2d5bSBarry Smith        PetscSubcommSetNumber()
2830306c2d5bSBarry Smith        PetscSubcommSetType(PETSC_SUBCOMM_INTERLACED);
2831306c2d5bSBarry Smith        ccomm = PetscSubcommChild()
2832306c2d5bSBarry Smith        PetscSubcommDestroy()
2833d382aafbSBarry Smith 
2834d382aafbSBarry Smith    Level: advanced
2835d382aafbSBarry Smith 
2836d382aafbSBarry Smith    Concepts: communicator, create
2837306c2d5bSBarry Smith 
2838306c2d5bSBarry Smith    Notes:
2839306c2d5bSBarry 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
28403bf92927SBarry Smith $   PETSC_SUBCOMM_CONTIGUOUS - each new communicator contains a set of process with contiguous ranks in the original MPI communicator
2841306c2d5bSBarry Smith $   PETSC_SUBCOMM_INTERLACED - each new communictor contains a set of processes equally far apart in rank from the others in that new communicator
2842306c2d5bSBarry Smith 
2843306c2d5bSBarry Smith    Examaple: Consider a communicator with six processes split into 3 subcommunicators.
2844306c2d5bSBarry 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
2845306c2d5bSBarry Smith $     PETSC_SUBCOMM_INTERLACED - the first communicator contains rank 0,3, the second 1,4 and the third 2,5
2846306c2d5bSBarry Smith 
2847306c2d5bSBarry Smith    Developer Notes: This is used in objects such as PCREDUNDANT() to manage the subcommunicators on which the redundant computations
2848306c2d5bSBarry Smith       are performed.
2849306c2d5bSBarry Smith 
2850306c2d5bSBarry Smith 
2851306c2d5bSBarry Smith .seealso: PetscSubcommCreate(), PetscSubcommSetNumber(), PetscSubcommSetType(), PetscSubcommView(), PetscSubcommSetFromOptions()
2852306c2d5bSBarry Smith 
2853d382aafbSBarry Smith S*/
2854d382aafbSBarry Smith typedef struct _n_PetscSubcomm* PetscSubcomm;
2855d382aafbSBarry Smith 
2856d382aafbSBarry Smith struct _n_PetscSubcomm {
2857d382aafbSBarry Smith   MPI_Comm         parent;           /* parent communicator */
2858d382aafbSBarry Smith   MPI_Comm         dupparent;        /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */
2859306c2d5bSBarry Smith   MPI_Comm         child;            /* the sub-communicator */
286045487dadSJed Brown   PetscMPIInt      n;                /* num of subcommunicators under the parent communicator */
286145487dadSJed Brown   PetscMPIInt      color;            /* color of processors belong to this communicator */
2862708d824cSJed Brown   PetscMPIInt      *subsize;         /* size of subcommunicator[color] */
286345487dadSJed Brown   PetscSubcommType type;
2864e5acf8a4SHong Zhang   char             *subcommprefix;
2865d382aafbSBarry Smith };
2866d382aafbSBarry Smith 
2867c5e4d11fSDmitry Karpeev PETSC_STATIC_INLINE MPI_Comm PetscSubcommParent(PetscSubcomm scomm) {return scomm->parent;}
2868306c2d5bSBarry Smith PETSC_STATIC_INLINE MPI_Comm PetscSubcommChild(PetscSubcomm scomm) {return scomm->child;}
286936be1a5eSBarry Smith PETSC_STATIC_INLINE MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm) {return scomm->dupparent;}
2870014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*);
2871014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*);
2872014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt);
2873014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType);
287465d9b8f1SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt);
2875053d1c95SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm,PetscViewer);
2876f68be91cSHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm);
2877e5acf8a4SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm,const char[]);
2878d382aafbSBarry Smith 
28790f453b92SJed Brown /*S
28809962606eSBarry Smith      PetscHeap - A simple class for managing heaps
28819962606eSBarry Smith 
28829962606eSBarry Smith    Level: intermediate
28839962606eSBarry Smith 
28849962606eSBarry Smith   Concepts: random numbers
28859962606eSBarry Smith 
28869962606eSBarry Smith .seealso:  PetscHeapCreate(), PetscHeapAdd(), PetscHeapPop(), PetscHeapPeek(), PetscHeapStash(), PetscHeapUnstash(), PetscHeapView(), PetscHeapDestroy()
28879962606eSBarry Smith S*/
28889962606eSBarry Smith typedef struct _PetscHeap *PetscHeap;
28899962606eSBarry Smith 
28909962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapCreate(PetscInt,PetscHeap*);
28919962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapAdd(PetscHeap,PetscInt,PetscInt);
28929962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapPop(PetscHeap,PetscInt*,PetscInt*);
28939962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapPeek(PetscHeap,PetscInt*,PetscInt*);
28949962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapStash(PetscHeap,PetscInt,PetscInt);
28959962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapUnstash(PetscHeap);
28969962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapDestroy(PetscHeap*);
28979962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapView(PetscHeap,PetscViewer);
28989962606eSBarry Smith 
28999962606eSBarry Smith /*S
29000f453b92SJed Brown    PetscSegBuffer - a segmented extendable buffer
29010f453b92SJed Brown 
29020f453b92SJed Brown    Level: developer
29030f453b92SJed Brown 
29040f453b92SJed Brown .seealso: PetscSegBufferCreate(), PetscSegBufferGet(), PetscSegBufferExtract(), PetscSegBufferDestroy()
29050f453b92SJed Brown S*/
29060f453b92SJed Brown typedef struct _n_PetscSegBuffer *PetscSegBuffer;
290713e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t,size_t,PetscSegBuffer*);
29080f453b92SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer*);
290913e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer,size_t,void*);
2910137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer,void*);
2911137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer,void*);
2912137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer,void*);
291313e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer,size_t*);
291413e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer,size_t);
29150f453b92SJed Brown 
2916471ecdacSJed Brown /* Type-safe wrapper to encourage use of PETSC_RESTRICT. Does not use PetscFunctionBegin because the error handling
2917471ecdacSJed Brown  * prevents the compiler from completely erasing the stub. This is called in inner loops so it has to be as fast as
2918471ecdacSJed Brown  * possible. */
291935005c2bSLisandro Dalcin PETSC_STATIC_INLINE PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg,PetscInt count,PetscInt *PETSC_RESTRICT *slot) {return PetscSegBufferGet(seg,(size_t)count,(void**)slot);}
2920d382aafbSBarry Smith 
29219de0f6ecSBarry Smith typedef struct _n_PetscOptionsHelpPrinted *PetscOptionsHelpPrinted;
29229de0f6ecSBarry Smith extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton;
29239de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted*);
29249de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted*);
29259de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted,const char*,const char*,PetscBool*);
29269de0f6ecSBarry Smith 
2927268b0dfdSSatish Balay PETSC_EXTERN PetscSegBuffer PetscCitationsList;
2928fbfcfee5SBarry Smith 
29291f817a21SBarry Smith /*@C
29301f817a21SBarry Smith       PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used in the code.
29311f817a21SBarry Smith 
29321f817a21SBarry Smith      Not Collective - only what is registered on rank 0 of PETSC_COMM_WORLD will be printed
29331f817a21SBarry Smith 
29341f817a21SBarry Smith      Input Parameters:
29351f817a21SBarry Smith +      cite - the bibtex item, formated to displayed on multiple lines nicely
29361f817a21SBarry Smith -      set - a boolean variable initially set to PETSC_FALSE; this is used to insure only a single registration of the citation
29371f817a21SBarry Smith 
2938850545d0SSatish Balay    Level: intermediate
2939850545d0SSatish Balay 
29401f817a21SBarry Smith      Options Database:
2941063414e0SPatrick Sanan .     -citations [filename]   - print out the bibtex entries for the given computation
29421f817a21SBarry Smith @*/
2943dff31646SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscCitationsRegister(const char cit[],PetscBool *set)
2944dff31646SBarry Smith {
2945dff31646SBarry Smith   size_t         len;
2946dff31646SBarry Smith   char           *vstring;
2947dff31646SBarry Smith   PetscErrorCode ierr;
2948dff31646SBarry Smith 
29491f817a21SBarry Smith   PetscFunctionBegin;
29508d3683fcSBarry Smith   if (set && *set) PetscFunctionReturn(0);
2951dff31646SBarry Smith   ierr = PetscStrlen(cit,&len);CHKERRQ(ierr);
295235005c2bSLisandro Dalcin   ierr = PetscSegBufferGet(PetscCitationsList,len,&vstring);CHKERRQ(ierr);
2953dff31646SBarry Smith   ierr = PetscMemcpy(vstring,cit,len);CHKERRQ(ierr);
2954dff31646SBarry Smith   if (set) *set = PETSC_TRUE;
29551f817a21SBarry Smith   PetscFunctionReturn(0);
2956dff31646SBarry Smith }
2957dff31646SBarry Smith 
2958b967cddfSBarry Smith PETSC_EXTERN PetscErrorCode PetscURLShorten(const char[],char[],size_t);
2959fe278a28SBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm,char[],char[],size_t);
2960fe278a28SBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm,const char[],char[],size_t);
2961f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm,const char[],const char []);
2962fe278a28SBarry Smith 
2963f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm,char[],char[],size_t);
2964f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm,const char[],char[],char[],size_t);
2965b967cddfSBarry Smith 
296604102261SBarry Smith PETSC_EXTERN PetscErrorCode PetscTextBelt(MPI_Comm,const char[],const char[],PetscBool*);
2967763ec7b1SBarry Smith PETSC_EXTERN PetscErrorCode PetscTellMyCell(MPI_Comm,const char[],const char[],PetscBool*);
2968dff31646SBarry Smith 
296968e69593SBarry Smith PETSC_EXTERN PetscErrorCode PetscPullJSONValue(const char[],const char[],char[],size_t,PetscBool*);
29705dc0f0a4SBarry Smith PETSC_EXTERN PetscErrorCode PetscPushJSONValue(char[],const char[],const char[],size_t);
2971d382aafbSBarry Smith 
2972b2566f29SBarry Smith 
2973b2566f29SBarry Smith #if defined(PETSC_USE_DEBUG)
2974b2566f29SBarry Smith /*
2975b2566f29SBarry Smith    Verify that all processes in the communicator have called this from the same line of code
2976b2566f29SBarry Smith  */
29778f5db7efSBarry Smith PETSC_EXTERN PetscErrorCode PetscAllreduceBarrierCheck(MPI_Comm,PetscMPIInt,int,const char*,const char *);
297877a5e07dSBarry Smith 
297977a5e07dSBarry Smith /*MC
298077a5e07dSBarry Smith    MPIU_Allreduce - a PETSc replacement for MPI_Allreduce() that tries to determine if the call from all the MPI processes occur from the
298177a5e07dSBarry Smith                     same place in the PETSc code. This helps to detect bugs where different MPI processes follow different code paths
298277a5e07dSBarry Smith                     resulting in inconsistent and incorrect calls to MPI_Allreduce().
298377a5e07dSBarry Smith 
298477a5e07dSBarry Smith    Collective on MPI_Comm
298577a5e07dSBarry Smith 
298677a5e07dSBarry Smith    Synopsis:
298777a5e07dSBarry Smith      #include <petscsys.h>
298877a5e07dSBarry Smith      PetscErrorCode MPIU_Allreduce(void *indata,void *outdata,PetscMPIInt count,MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);
298977a5e07dSBarry Smith 
299077a5e07dSBarry Smith    Input Parameters:
299177a5e07dSBarry Smith +  indata - pointer to the input data to be reduced
299277a5e07dSBarry Smith .  count - the number of MPI data items in indata and outdata
299377a5e07dSBarry Smith .  datatype - the MPI datatype, for example MPI_INT
299477a5e07dSBarry Smith .  op - the MPI operation, for example MPI_SUM
299577a5e07dSBarry Smith -  comm - the MPI communicator on which the operation occurs
299677a5e07dSBarry Smith 
299777a5e07dSBarry Smith    Output Parameter:
299877a5e07dSBarry Smith .  outdata - the reduced values
299977a5e07dSBarry Smith 
300077a5e07dSBarry Smith    Notes: In optimized mode this directly calls MPI_Allreduce()
300177a5e07dSBarry Smith 
300277a5e07dSBarry Smith    Level: developer
300377a5e07dSBarry Smith 
300477a5e07dSBarry Smith .seealso: MPI_Allreduce()
300577a5e07dSBarry Smith M*/
3006fbfcfee5SBarry Smith #define MPIU_Allreduce(a,b,c,d,e,fcomm) (PetscAllreduceBarrierCheck(fcomm,c,__LINE__,PETSC_FUNCTION_NAME,__FILE__) || MPI_Allreduce(a,b,c,d,e,fcomm))
3007b2566f29SBarry Smith #else
3008b2566f29SBarry Smith #define MPIU_Allreduce(a,b,c,d,e,fcomm) MPI_Allreduce(a,b,c,d,e,fcomm)
3009b2566f29SBarry Smith #endif
3010b2566f29SBarry Smith 
3011d382aafbSBarry Smith #endif
3012