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 */ 526bd1501SBarry Smith #if !defined(PETSCSYS_H) 626bd1501SBarry Smith #define PETSCSYS_H 7d382aafbSBarry Smith /* ========================================================================== */ 8d382aafbSBarry Smith /* 9d382aafbSBarry Smith petscconf.h is contained in ${PETSC_ARCH}/include/petscconf.h it is 101c77a0c5SBarry Smith found automatically by the compiler due to the -I${PETSC_DIR}/${PETSC_ARCH}/include that 111c77a0c5SBarry Smith PETSc's makefiles add to the compiler rules. 121c77a0c5SBarry Smith For --prefix installs the directory ${PETSC_ARCH} does not exist and petscconf.h is in the same 131cc8b206SBarry Smith directory as the other PETSc include files. 14d382aafbSBarry Smith */ 152c8e378dSBarry Smith #include <petscconf.h> 161c77a0c5SBarry Smith #include <petscconf_poison.h> 172c8e378dSBarry Smith #include <petscfix.h> 18d382aafbSBarry Smith 1920c24465SJunchao Zhang #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) || defined(PETSC_HAVE_HIP) || defined(PETSC_HAVE_KOKKOS) 2005035670SJunchao Zhang #define PETSC_HAVE_DEVICE 2105035670SJunchao Zhang #endif 2205035670SJunchao Zhang 2373fca5a0SBarry Smith #if defined(PETSC_DESIRE_FEATURE_TEST_MACROS) 2473fca5a0SBarry Smith /* 2573fca5a0SBarry Smith Feature test macros must be included before headers defined by IEEE Std 1003.1-2001 2673fca5a0SBarry Smith We only turn these in PETSc source files that require them by setting PETSC_DESIRE_FEATURE_TEST_MACROS 2773fca5a0SBarry Smith */ 28216f1ae6SBarry Smith # if defined(PETSC__POSIX_C_SOURCE_200112L) && !defined(_POSIX_C_SOURCE) 2973fca5a0SBarry Smith # define _POSIX_C_SOURCE 200112L 3073fca5a0SBarry Smith # endif 31216f1ae6SBarry Smith # if defined(PETSC__BSD_SOURCE) && !defined(_BSD_SOURCE) 3273fca5a0SBarry Smith # define _BSD_SOURCE 3373fca5a0SBarry Smith # endif 3407f00807SSatish Balay # if defined(PETSC__DEFAULT_SOURCE) && !defined(_DEFAULT_SOURCE) 3507f00807SSatish Balay # define _DEFAULT_SOURCE 3607f00807SSatish Balay # endif 37ea0fecefSShri Abhyankar # if defined(PETSC__GNU_SOURCE) && !defined(_GNU_SOURCE) 38ea0fecefSShri Abhyankar # define _GNU_SOURCE 39ea0fecefSShri Abhyankar # endif 4073fca5a0SBarry Smith #endif 4173fca5a0SBarry Smith 42df4397b0SStefano Zampini #include <petscsystypes.h> 43df4397b0SStefano Zampini 44d382aafbSBarry Smith /* ========================================================================== */ 45d382aafbSBarry Smith /* 462c280183SJed Brown This facilitates using the C version of PETSc from C++ and the C++ version from C. 47d382aafbSBarry Smith */ 481ec50b02SJed Brown #if defined(__cplusplus) 491ec50b02SJed Brown # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_CXX 501ec50b02SJed Brown #else 511ec50b02SJed Brown # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_C 521ec50b02SJed Brown #endif 53d382aafbSBarry Smith 54c5e4d11fSDmitry Karpeev /* ========================================================================== */ 55c5e4d11fSDmitry Karpeev /* 56c5e4d11fSDmitry Karpeev Since PETSc manages its own extern "C" handling users should never include PETSc include 571cc8b206SBarry Smith files within extern "C". This will generate a compiler error if a user does put the include 581cc8b206SBarry Smith file within an extern "C". 59c5e4d11fSDmitry Karpeev */ 60c5e4d11fSDmitry Karpeev #if defined(__cplusplus) 61c5e4d11fSDmitry Karpeev void assert_never_put_petsc_headers_inside_an_extern_c(int); void assert_never_put_petsc_headers_inside_an_extern_c(double); 62c5e4d11fSDmitry Karpeev #endif 63c5e4d11fSDmitry Karpeev 64ed938b00SJed Brown #if defined(__cplusplus) 65ed938b00SJed Brown # define PETSC_RESTRICT PETSC_CXX_RESTRICT 66ed938b00SJed Brown #else 67ed938b00SJed Brown # define PETSC_RESTRICT PETSC_C_RESTRICT 68ed938b00SJed Brown #endif 69ed938b00SJed Brown 70ed938b00SJed Brown #if defined(__cplusplus) 7158c433abSLisandro Dalcin # define PETSC_INLINE PETSC_CXX_INLINE 72ed938b00SJed Brown #else 7358c433abSLisandro Dalcin # define PETSC_INLINE PETSC_C_INLINE 74ed938b00SJed Brown #endif 75ed938b00SJed Brown 7658c433abSLisandro Dalcin #define PETSC_STATIC_INLINE static PETSC_INLINE 7758c433abSLisandro Dalcin 78ab699e31SSatish Balay #if defined(_WIN32) && defined(PETSC_USE_SHARED_LIBRARIES) /* For Win32 shared libraries */ 79014dd563SJed Brown # define PETSC_DLLEXPORT __declspec(dllexport) 80014dd563SJed Brown # define PETSC_DLLIMPORT __declspec(dllimport) 8121f66b81SJed Brown # define PETSC_VISIBILITY_INTERNAL 8226703958SBarry Smith #elif defined(PETSC_USE_VISIBILITY_CXX) && defined(__cplusplus) 8326703958SBarry Smith # define PETSC_DLLEXPORT __attribute__((visibility ("default"))) 8426703958SBarry Smith # define PETSC_DLLIMPORT __attribute__((visibility ("default"))) 8526703958SBarry Smith # define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden"))) 8626703958SBarry Smith #elif defined(PETSC_USE_VISIBILITY_C) && !defined(__cplusplus) 87014dd563SJed Brown # define PETSC_DLLEXPORT __attribute__((visibility ("default"))) 88014dd563SJed Brown # define PETSC_DLLIMPORT __attribute__((visibility ("default"))) 8921f66b81SJed Brown # define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden"))) 90d382aafbSBarry Smith #else 91014dd563SJed Brown # define PETSC_DLLEXPORT 92014dd563SJed Brown # define PETSC_DLLIMPORT 9321f66b81SJed Brown # define PETSC_VISIBILITY_INTERNAL 94014dd563SJed Brown #endif 95014dd563SJed Brown 96014dd563SJed Brown #if defined(petsc_EXPORTS) /* CMake defines this when building the shared library */ 97014dd563SJed Brown # define PETSC_VISIBILITY_PUBLIC PETSC_DLLEXPORT 98014dd563SJed Brown #else /* Win32 users need this to import symbols from petsc.dll */ 99014dd563SJed Brown # define PETSC_VISIBILITY_PUBLIC PETSC_DLLIMPORT 100014dd563SJed Brown #endif 101014dd563SJed Brown 1021cc8b206SBarry Smith /* 1031cc8b206SBarry Smith Functions tagged with PETSC_EXTERN in the header files are 1041cc8b206SBarry Smith always defined as extern "C" when compiled with C++ so they may be 1051cc8b206SBarry Smith used from C and are always visible in the shared libraries 1061cc8b206SBarry Smith */ 1072c280183SJed Brown #if defined(__cplusplus) 108014dd563SJed Brown # define PETSC_EXTERN extern "C" PETSC_VISIBILITY_PUBLIC 109638cfed1SJed Brown # define PETSC_EXTERN_TYPEDEF extern "C" 11021f66b81SJed Brown # define PETSC_INTERN extern "C" PETSC_VISIBILITY_INTERNAL 111014dd563SJed Brown #else 112014dd563SJed Brown # define PETSC_EXTERN extern PETSC_VISIBILITY_PUBLIC 113638cfed1SJed Brown # define PETSC_EXTERN_TYPEDEF 1146258c452SJed Brown # define PETSC_INTERN extern PETSC_VISIBILITY_INTERNAL 115d382aafbSBarry Smith #endif 11627710113SBarry Smith 117*030f984aSJacob Faibussowitsch #if defined(__cplusplus) && defined(PETSC_HAVE_CXX_DIALECT_CXX11) 118*030f984aSJacob Faibussowitsch # define PETSC_NULLPTR nullptr 119*030f984aSJacob Faibussowitsch # define PETSC_CONSTEXPR constexpr 120*030f984aSJacob Faibussowitsch # define PETSC_NOEXCEPT noexcept 121*030f984aSJacob Faibussowitsch # define PETSC_NOEXCEPT_ARG(cond_) noexcept(cond_) 122*030f984aSJacob Faibussowitsch # define PETSC_CXX_DEFAULT(func_) func_ = default 123*030f984aSJacob Faibussowitsch #else 124*030f984aSJacob Faibussowitsch # define PETSC_NULLPTR NULL 125*030f984aSJacob Faibussowitsch # define PETSC_CONSTEXPR 126*030f984aSJacob Faibussowitsch # define PETSC_NOEXCEPT 127*030f984aSJacob Faibussowitsch # define PETSC_NOEXCEPT_ARG(cond_) 128*030f984aSJacob Faibussowitsch # define PETSC_CXX_DEFAULT(func_) 129*030f984aSJacob Faibussowitsch #endif 130*030f984aSJacob Faibussowitsch 131*030f984aSJacob Faibussowitsch #if defined(__cplusplus) && defined(PETSC_HAVE_CXX_DIALECT_CXX17) 132*030f984aSJacob Faibussowitsch # define PETSC_NODISCARD [[nodiscard]] 133*030f984aSJacob Faibussowitsch #else 134*030f984aSJacob Faibussowitsch # define PETSC_NODISCARD 135*030f984aSJacob Faibussowitsch #endif 136*030f984aSJacob Faibussowitsch 1372c8e378dSBarry Smith #include <petscversion.h> 138a17b96a8SKyle Gerard Felker #define PETSC_AUTHOR_INFO " The PETSc Team\n petsc-maint@mcs.anl.gov\n https://petsc.org/\n" 139d382aafbSBarry Smith 140d382aafbSBarry Smith /* ========================================================================== */ 141d382aafbSBarry Smith 142d382aafbSBarry Smith /* 143d382aafbSBarry Smith Defines the interface to MPI allowing the use of all MPI functions. 144d382aafbSBarry Smith 145d382aafbSBarry Smith PETSc does not use the C++ binding of MPI at ALL. The following flag 146d382aafbSBarry Smith makes sure the C++ bindings are not included. The C++ bindings REQUIRE 147d382aafbSBarry Smith putting mpi.h before ANY C++ include files, we cannot control this 148d382aafbSBarry Smith with all PETSc users. Users who want to use the MPI C++ bindings can include 149d382aafbSBarry Smith mpicxx.h directly in their code 150d382aafbSBarry Smith */ 151fa9e63e2SJed Brown #if !defined(MPICH_SKIP_MPICXX) 152d382aafbSBarry Smith # define MPICH_SKIP_MPICXX 1 153fa9e63e2SJed Brown #endif 154fa9e63e2SJed Brown #if !defined(OMPI_SKIP_MPICXX) 155d382aafbSBarry Smith # define OMPI_SKIP_MPICXX 1 156fa9e63e2SJed Brown #endif 157e771154cSJed Brown #if defined(PETSC_HAVE_MPIUNI) 158e771154cSJed Brown # include <petsc/mpiuni/mpi.h> 159e771154cSJed Brown #else 1602c8e378dSBarry Smith # include <mpi.h> 161e771154cSJed Brown #endif 16265013866SBarry Smith 1634e1ad211SJed Brown /*MC 1644e1ad211SJed Brown PetscDefined - determine whether a boolean macro is defined 1654e1ad211SJed Brown 1664e1ad211SJed Brown Notes: 1671393a3abSPatrick Sanan The prefix "PETSC_" is added to the argument. 1681393a3abSPatrick Sanan 1694e1ad211SJed Brown Typical usage is within normal code, 1704e1ad211SJed Brown 1714e1ad211SJed Brown $ if (PetscDefined(USE_DEBUG)) { ... } 1724e1ad211SJed Brown 1734e1ad211SJed Brown but can also be used in the preprocessor, 1744e1ad211SJed Brown 1754e1ad211SJed Brown $ #if PetscDefined(USE_DEBUG) 1764e1ad211SJed Brown $ ... 1774e1ad211SJed Brown $ #else 1784e1ad211SJed Brown 1791393a3abSPatrick Sanan Either way, it evaluates true if PETSC_USE_DEBUG is defined (merely defined or defined to 1), and false if PETSC_USE_DEBUG is undefined. This macro 1804e1ad211SJed Brown should not be used if its argument may be defined to a non-empty value other than 1. 1814e1ad211SJed Brown 1821393a3abSPatrick Sanan To avoid prepending "PETSC_", say to add custom checks in user code, one can use e.g. 1831393a3abSPatrick Sanan 1841393a3abSPatrick Sanan $ #define FooDefined(d) PetscDefined_(FOO_ ## d) 1851393a3abSPatrick Sanan 1864e1ad211SJed Brown Developer Notes: 1874e1ad211SJed Brown Getting something that works in C and CPP for an arg that may or may not be defined is tricky. Here, if we have 1884e1ad211SJed Brown "#define PETSC_HAVE_BOOGER 1" we match on the placeholder define, insert the "0," for arg1 and generate the triplet 1894e1ad211SJed Brown (0, 1, 0). Then the last step cherry picks the 2nd arg (a one). When PETSC_HAVE_BOOGER is not defined, we generate 1904e1ad211SJed Brown a (... 1, 0) pair, and when the last step cherry picks the 2nd arg, we get a zero. 1914e1ad211SJed Brown 1924e1ad211SJed Brown Our extra expansion via PetscDefined__take_second_expand() is needed with MSVC, which has a nonconforming 1934e1ad211SJed Brown implementation of variadic macros. 1944e1ad211SJed Brown 1954e1ad211SJed Brown Level: developer 1964e1ad211SJed Brown M*/ 1974e1ad211SJed Brown #if !defined(PETSC_SKIP_VARIADIC_MACROS) 1984e1ad211SJed Brown # define PetscDefined_arg_1 shift, 1994e1ad211SJed Brown # define PetscDefined_arg_ shift, 2004e1ad211SJed Brown # define PetscDefined__take_second_expanded(ignored, val, ...) val 2014e1ad211SJed Brown # define PetscDefined__take_second_expand(args) PetscDefined__take_second_expanded args 2024e1ad211SJed Brown # define PetscDefined__take_second(...) PetscDefined__take_second_expand((__VA_ARGS__)) 2034e1ad211SJed Brown # define PetscDefined___(arg1_or_junk) PetscDefined__take_second(arg1_or_junk 1, 0, at_) 2044e1ad211SJed Brown # define PetscDefined__(value) PetscDefined___(PetscDefined_arg_ ## value) 2054e1ad211SJed Brown # define PetscDefined_(d) PetscDefined__(d) 2064e1ad211SJed Brown # define PetscDefined(d) PetscDefined_(PETSC_ ## d) 2074e1ad211SJed Brown #endif 2084e1ad211SJed Brown 209d382aafbSBarry Smith /* 210a7886beaSBarry Smith Perform various sanity checks that the correct mpi.h is being included at compile time. 211a7886beaSBarry Smith This usually happens because 212a7886beaSBarry Smith * either an unexpected mpi.h is in the default compiler path (i.e. in /usr/include) or 213a7886beaSBarry Smith * an extra include path -I/something (which contains the unexpected mpi.h) is being passed to the compiler 214a7886beaSBarry Smith */ 215a7886beaSBarry Smith #if defined(PETSC_HAVE_MPIUNI) 216c9b973beSBarry Smith # if !defined(MPIUNI_H) 217a7886beaSBarry Smith # error "PETSc was configured with --with-mpi=0 but now appears to be compiling using a different mpi.h" 218a7886beaSBarry Smith # endif 21941f4af4cSSatish Balay #elif defined(PETSC_HAVE_I_MPI_NUMVERSION) 22041f4af4cSSatish Balay # if !defined(I_MPI_NUMVERSION) 22141f4af4cSSatish Balay # error "PETSc was configured with I_MPI but now appears to be compiling using a non-I_MPI mpi.h" 22241f4af4cSSatish Balay # elif I_MPI_NUMVERSION != PETSC_HAVE_I_MPI_NUMVERSION 22341f4af4cSSatish 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" 22441f4af4cSSatish Balay # endif 22541f4af4cSSatish Balay #elif defined(PETSC_HAVE_MVAPICH2_NUMVERSION) 22641f4af4cSSatish Balay # if !defined(MVAPICH2_NUMVERSION) 22741f4af4cSSatish Balay # error "PETSc was configured with MVAPICH2 but now appears to be compiling using a non-MVAPICH2 mpi.h" 22841f4af4cSSatish Balay # elif MVAPICH2_NUMVERSION != PETSC_HAVE_MVAPICH2_NUMVERSION 22941f4af4cSSatish Balay # error "PETSc was configured with one MVAPICH2 mpi.h version but now appears to be compiling using a different MVAPICH2 mpi.h version" 23041f4af4cSSatish Balay # endif 231a7886beaSBarry Smith #elif defined(PETSC_HAVE_MPICH_NUMVERSION) 23241f4af4cSSatish Balay # if !defined(MPICH_NUMVERSION) || defined(MVAPICH2_NUMVERSION) || defined(I_MPI_NUMVERSION) 233a7886beaSBarry Smith # error "PETSc was configured with MPICH but now appears to be compiling using a non-MPICH mpi.h" 234ca70f86eSJed Brown # elif (MPICH_NUMVERSION/100000 != PETSC_HAVE_MPICH_NUMVERSION/100000) || (MPICH_NUMVERSION%100000/1000 < PETSC_HAVE_MPICH_NUMVERSION%100000/1000) 235a7886beaSBarry Smith # error "PETSc was configured with one MPICH mpi.h version but now appears to be compiling using a different MPICH mpi.h version" 236a7886beaSBarry Smith # endif 237a7886beaSBarry Smith #elif defined(PETSC_HAVE_OMPI_MAJOR_VERSION) 238a7886beaSBarry Smith # if !defined(OMPI_MAJOR_VERSION) 239a7886beaSBarry Smith # error "PETSc was configured with OpenMPI but now appears to be compiling using a non-OpenMPI mpi.h" 240ca70f86eSJed 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) 241c3ac57cfSSatish Balay # error "PETSc was configured with one OpenMPI mpi.h version but now appears to be compiling using a different OpenMPI mpi.h version" 242a7886beaSBarry Smith # endif 243d97fd468SStefano Zampini #elif defined(PETSC_HAVE_MSMPI_VERSION) 244d97fd468SStefano Zampini # if !defined(MSMPI_VER) 245d97fd468SStefano Zampini # error "PETSc was configured with MSMPI but now appears to be compiling using a non-MSMPI mpi.h" 246d97fd468SStefano Zampini # elif (MSMPI_VER != PETSC_HAVE_MSMPI_VERSION) 247d97fd468SStefano Zampini # error "PETSc was configured with one MSMPI mpi.h version but now appears to be compiling using a different MSMPI mpi.h version" 248d97fd468SStefano Zampini # endif 249d97fd468SStefano Zampini #elif defined(OMPI_MAJOR_VERSION) || defined(MPICH_NUMVERSION) || defined(MSMPI_VER) 250d97fd468SStefano Zampini # error "PETSc was configured with undetermined MPI - but now appears to be compiling using any of OpenMPI, MS-MPI or a MPICH variant" 251a7886beaSBarry Smith #endif 252a7886beaSBarry Smith 253a7886beaSBarry Smith /* 2542981ebdbSBarry Smith Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler 255d382aafbSBarry Smith see the top of mpicxx.h in the MPICH2 distribution. 256d382aafbSBarry Smith */ 257d382aafbSBarry Smith #include <stdio.h> 258d382aafbSBarry Smith 259d382aafbSBarry Smith /* MSMPI on 32bit windows requires this yukky hack - that breaks MPI standard compliance */ 260d382aafbSBarry Smith #if !defined(MPIAPI) 261d382aafbSBarry Smith #define MPIAPI 262d382aafbSBarry Smith #endif 263d382aafbSBarry Smith 2641cc8b206SBarry Smith /* 2651cc8b206SBarry Smith Support for Clang (>=3.2) matching type tag arguments with void* buffer types. 2661cc8b206SBarry Smith This allows the compiler to detect cases where the MPI datatype argument passed to a MPI routine 2671cc8b206SBarry Smith does not match the actual type of the argument being passed in 2681cc8b206SBarry Smith */ 269c5e4d11fSDmitry Karpeev #if defined(__has_attribute) && defined(works_with_const_which_is_not_true) 270894dd566SJed Brown # if __has_attribute(argument_with_type_tag) && __has_attribute(pointer_with_type_tag) && __has_attribute(type_tag_for_datatype) 271894dd566SJed Brown # define PetscAttrMPIPointerWithType(bufno,typeno) __attribute__((pointer_with_type_tag(MPI,bufno,typeno))) 2728ad47952SJed Brown # define PetscAttrMPITypeTag(type) __attribute__((type_tag_for_datatype(MPI,type))) 2738ad47952SJed Brown # define PetscAttrMPITypeTagLayoutCompatible(type) __attribute__((type_tag_for_datatype(MPI,type,layout_compatible))) 274894dd566SJed Brown # endif 275894dd566SJed Brown #endif 276894dd566SJed Brown #if !defined(PetscAttrMPIPointerWithType) 277894dd566SJed Brown # define PetscAttrMPIPointerWithType(bufno,typeno) 2788ad47952SJed Brown # define PetscAttrMPITypeTag(type) 2798ad47952SJed Brown # define PetscAttrMPITypeTagLayoutCompatible(type) 280894dd566SJed Brown #endif 281b3506946SBarry Smith 2825a576424SJed Brown PETSC_EXTERN MPI_Datatype MPIU_ENUM PetscAttrMPITypeTag(PetscEnum); 283df4397b0SStefano Zampini PETSC_EXTERN MPI_Datatype MPIU_BOOL PetscAttrMPITypeTag(PetscBool); 284e28ce29aSPatrick Sanan 285e28ce29aSPatrick Sanan /*MC 286e28ce29aSPatrick Sanan MPIU_INT - MPI datatype corresponding to PetscInt 287e28ce29aSPatrick Sanan 288e28ce29aSPatrick Sanan Notes: 289e28ce29aSPatrick Sanan In MPI calls that require an MPI datatype that matches a PetscInt or array of PetscInt values, pass this value. 290e28ce29aSPatrick Sanan 291e28ce29aSPatrick Sanan Level: beginner 292e28ce29aSPatrick Sanan 293e28ce29aSPatrick Sanan .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX 294e28ce29aSPatrick Sanan M*/ 295e28ce29aSPatrick Sanan 29637354ed4SSatish 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 */ 297bd84f1cfSSatish Balay # define MPIU_INT64 MPI_INT64_T 298a05e1a72SSatish Balay # define PetscInt64_FMT PRId64 299fab38c73SJed Brown #elif (PETSC_SIZEOF_LONG_LONG == 8) 300bd84f1cfSSatish Balay # define MPIU_INT64 MPI_LONG_LONG_INT 301a05e1a72SSatish Balay # define PetscInt64_FMT "lld" 302f505b413SSatish Balay #elif defined(PETSC_HAVE___INT64) 303bd84f1cfSSatish Balay # define MPIU_INT64 MPI_INT64_T 304a05e1a72SSatish Balay # define PetscInt64_FMT "ld" 305236ed0a3SSatish Balay #else 306bafee8b4SSatish Balay # error "cannot determine PetscInt64 type" 307236ed0a3SSatish Balay #endif 308b7b8f77aSBarry Smith 3097cdaf61dSJed Brown PETSC_EXTERN MPI_Datatype MPIU_FORTRANADDR; 310b7b8f77aSBarry Smith 311d382aafbSBarry Smith #if defined(PETSC_USE_64BIT_INDICES) 312bd84f1cfSSatish Balay # define MPIU_INT MPIU_INT64 313a05e1a72SSatish Balay # define PetscInt_FMT PetscInt64_FMT 314d382aafbSBarry Smith #else 315d382aafbSBarry Smith # define MPIU_INT MPI_INT 316a05e1a72SSatish Balay # define PetscInt_FMT "d" 317d382aafbSBarry Smith #endif 318d382aafbSBarry Smith 319503cfb0cSBarry Smith /* 320503cfb0cSBarry Smith For the rare cases when one needs to send a size_t object with MPI 321503cfb0cSBarry Smith */ 322e316c87fSJed Brown PETSC_EXTERN MPI_Datatype MPIU_SIZE_T; 323d382aafbSBarry Smith 324d382aafbSBarry Smith /* 325d382aafbSBarry Smith You can use PETSC_STDOUT as a replacement of stdout. You can also change 326d382aafbSBarry Smith the value of PETSC_STDOUT to redirect all standard output elsewhere 327d382aafbSBarry Smith */ 328014dd563SJed Brown PETSC_EXTERN FILE* PETSC_STDOUT; 329d382aafbSBarry Smith 330d382aafbSBarry Smith /* 331d382aafbSBarry Smith You can use PETSC_STDERR as a replacement of stderr. You can also change 332d382aafbSBarry Smith the value of PETSC_STDERR to redirect all standard error elsewhere 333d382aafbSBarry Smith */ 334014dd563SJed Brown PETSC_EXTERN FILE* PETSC_STDERR; 335d382aafbSBarry Smith 336d382aafbSBarry Smith /*MC 337d382aafbSBarry Smith PetscUnlikely - hints the compiler that the given condition is usually FALSE 338d382aafbSBarry Smith 339d382aafbSBarry Smith Synopsis: 340aaa7dc30SBarry Smith #include <petscsys.h> 341ace3abfcSBarry Smith PetscBool PetscUnlikely(PetscBool cond) 342d382aafbSBarry Smith 343eca87e8dSBarry Smith Not Collective 344eca87e8dSBarry Smith 345d382aafbSBarry Smith Input Parameters: 346d382aafbSBarry Smith . cond - condition or expression 347d382aafbSBarry Smith 348e28ce29aSPatrick Sanan Notes: 349e28ce29aSPatrick Sanan This returns the same truth value, it is only a hint to compilers that the resulting 350d382aafbSBarry Smith branch is unlikely. 351d382aafbSBarry Smith 352d382aafbSBarry Smith Level: advanced 353d382aafbSBarry Smith 354cf9c20a2SJed Brown .seealso: PetscUnlikelyDebug(), PetscLikely(), CHKERRQ 355d382aafbSBarry Smith M*/ 356d382aafbSBarry Smith 357d382aafbSBarry Smith /*MC 358d382aafbSBarry Smith PetscLikely - hints the compiler that the given condition is usually TRUE 359d382aafbSBarry Smith 360d382aafbSBarry Smith Synopsis: 361aaa7dc30SBarry Smith #include <petscsys.h> 36223072422SBarry Smith PetscBool PetscLikely(PetscBool cond) 363d382aafbSBarry Smith 364eca87e8dSBarry Smith Not Collective 365eca87e8dSBarry Smith 366d382aafbSBarry Smith Input Parameters: 367d382aafbSBarry Smith . cond - condition or expression 368d382aafbSBarry Smith 369e28ce29aSPatrick Sanan Notes: 370e28ce29aSPatrick Sanan This returns the same truth value, it is only a hint to compilers that the resulting 371d382aafbSBarry Smith branch is likely. 372d382aafbSBarry Smith 373d382aafbSBarry Smith Level: advanced 374d382aafbSBarry Smith 375d382aafbSBarry Smith .seealso: PetscUnlikely() 376d382aafbSBarry Smith M*/ 377d382aafbSBarry Smith #if defined(PETSC_HAVE_BUILTIN_EXPECT) 378d382aafbSBarry Smith # define PetscUnlikely(cond) __builtin_expect(!!(cond),0) 379d382aafbSBarry Smith # define PetscLikely(cond) __builtin_expect(!!(cond),1) 380d382aafbSBarry Smith #else 381cd3f4ce9SJed Brown # define PetscUnlikely(cond) (cond) 382cd3f4ce9SJed Brown # define PetscLikely(cond) (cond) 383d382aafbSBarry Smith #endif 384d382aafbSBarry Smith 385cf9c20a2SJed Brown /*MC 386cf9c20a2SJed Brown PetscUnlikelyDebug - hints the compiler that the given condition is usually FALSE, eliding the check in optimized mode 387cf9c20a2SJed Brown 388cf9c20a2SJed Brown Synopsis: 389cf9c20a2SJed Brown #include <petscsys.h> 390cf9c20a2SJed Brown PetscBool PetscUnlikelyDebug(PetscBool cond) 391cf9c20a2SJed Brown 392cf9c20a2SJed Brown Not Collective 393cf9c20a2SJed Brown 394cf9c20a2SJed Brown Input Parameters: 395cf9c20a2SJed Brown . cond - condition or expression 396cf9c20a2SJed Brown 397cf9c20a2SJed Brown Notes: 398cf9c20a2SJed Brown This returns the same truth value, it is only a hint to compilers that the resulting 399cf9c20a2SJed Brown branch is unlikely. When compiled in optimized mode, it always returns false. 400cf9c20a2SJed Brown 401cf9c20a2SJed Brown Level: advanced 402cf9c20a2SJed Brown 403cf9c20a2SJed Brown .seealso: PetscUnlikely(), CHKERRQ, SETERRQ 404cf9c20a2SJed Brown M*/ 405cf9c20a2SJed Brown #define PetscUnlikelyDebug(cond) (PetscDefined(USE_DEBUG) && PetscUnlikely(cond)) 406cf9c20a2SJed Brown 407c8b9133aSSatish Balay /* PetscPragmaSIMD - from CeedPragmaSIMD */ 408c8b9133aSSatish Balay 409c8b9133aSSatish Balay #if defined(__INTEL_COMPILER) && !defined(_WIN32) 410c8b9133aSSatish Balay # define PetscPragmaSIMD _Pragma("vector") 4111dba8834SJose E. Roman #elif defined(__GNUC__) && __GNUC__ >= 5 && !defined(__PGI) 412c8b9133aSSatish Balay # define PetscPragmaSIMD _Pragma("GCC ivdep") 413160a5775SAli Reza Khaz'ali #elif defined(_OPENMP) && _OPENMP >= 201307 && !defined(_WIN32) 414c8b9133aSSatish Balay # define PetscPragmaSIMD _Pragma("omp simd") 415160a5775SAli Reza Khaz'ali #elif defined(_OPENMP) && _OPENMP >= 201307 && defined(_WIN32) 416160a5775SAli Reza Khaz'ali # define PetscPragmaSIMD __pragma(omp simd) 417c8b9133aSSatish Balay #elif defined(PETSC_HAVE_CRAY_VECTOR) 418c8b9133aSSatish Balay # define PetscPragmaSIMD _Pragma("_CRI ivdep") 419c8b9133aSSatish Balay #else 420c8b9133aSSatish Balay # define PetscPragmaSIMD 421c8b9133aSSatish Balay #endif 422c8b9133aSSatish Balay 423d382aafbSBarry Smith /* 424d382aafbSBarry Smith Declare extern C stuff after including external header files 425d382aafbSBarry Smith */ 426d382aafbSBarry Smith 4276a6fc655SJed Brown PETSC_EXTERN const char *const PetscBools[]; 42870b3c8c7SBarry Smith 4296edef35eSSatish Balay PETSC_EXTERN PetscBool PETSC_RUNNING_ON_VALGRIND; 4308b49ba18SBarry Smith /* 431390e1bf2SBarry Smith Defines elementary mathematics functions and constants. 4328b49ba18SBarry Smith */ 4338b49ba18SBarry Smith #include <petscmath.h> 4348b49ba18SBarry Smith 4356a6fc655SJed Brown PETSC_EXTERN const char *const PetscCopyModes[]; 436d382aafbSBarry Smith 437d382aafbSBarry Smith /*MC 4380298fd71SBarry Smith PETSC_IGNORE - same as NULL, means PETSc will ignore this argument 439d382aafbSBarry Smith 440d382aafbSBarry Smith Level: beginner 441d382aafbSBarry Smith 442e28ce29aSPatrick Sanan Note: 443e28ce29aSPatrick Sanan Accepted by many PETSc functions to not set a parameter and instead use 444d382aafbSBarry Smith some default 445d382aafbSBarry Smith 446e28ce29aSPatrick Sanan Fortran Notes: 447e28ce29aSPatrick Sanan This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER, 448d382aafbSBarry Smith PETSC_NULL_DOUBLE_PRECISION etc 449d382aafbSBarry Smith 450e28ce29aSPatrick Sanan .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_DETERMINE 451d382aafbSBarry Smith 452d382aafbSBarry Smith M*/ 4530298fd71SBarry Smith #define PETSC_IGNORE NULL 454d382aafbSBarry Smith 455c528d872SBarry Smith /* This is deprecated */ 456c528d872SBarry Smith #define PETSC_NULL NULL 457c528d872SBarry Smith 458d382aafbSBarry Smith /*MC 459557d4da8SBarry Smith PETSC_DECIDE - standard way of passing in integer or floating point parameter 460557d4da8SBarry Smith where you wish PETSc to use the default. 461557d4da8SBarry Smith 462557d4da8SBarry Smith Level: beginner 463557d4da8SBarry Smith 464e28ce29aSPatrick Sanan .seealso: PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE 465557d4da8SBarry Smith 466557d4da8SBarry Smith M*/ 467557d4da8SBarry Smith #define PETSC_DECIDE -1 468557d4da8SBarry Smith 469557d4da8SBarry Smith /*MC 470d382aafbSBarry Smith PETSC_DETERMINE - standard way of passing in integer or floating point parameter 471d382aafbSBarry Smith where you wish PETSc to compute the required value. 472d382aafbSBarry Smith 473d382aafbSBarry Smith Level: beginner 474d382aafbSBarry Smith 475e28ce29aSPatrick Sanan Developer Note: 476e28ce29aSPatrick Sanan I would like to use const PetscInt PETSC_DETERMINE = PETSC_DECIDE; but for 477557d4da8SBarry Smith some reason this is not allowed by the standard even though PETSC_DECIDE is a constant value. 478557d4da8SBarry Smith 4790298fd71SBarry Smith .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, VecSetSizes() 480d382aafbSBarry Smith 481d382aafbSBarry Smith M*/ 482d382aafbSBarry Smith #define PETSC_DETERMINE PETSC_DECIDE 483d382aafbSBarry Smith 484d382aafbSBarry Smith /*MC 485557d4da8SBarry Smith PETSC_DEFAULT - standard way of passing in integer or floating point parameter 486557d4da8SBarry Smith where you wish PETSc to use the default. 487557d4da8SBarry Smith 488557d4da8SBarry Smith Level: beginner 489557d4da8SBarry Smith 490e28ce29aSPatrick Sanan Fortran Notes: 491e28ce29aSPatrick Sanan You need to use PETSC_DEFAULT_INTEGER or PETSC_DEFAULT_REAL. 492557d4da8SBarry Smith 4930298fd71SBarry Smith .seealso: PETSC_DECIDE, PETSC_IGNORE, PETSC_DETERMINE 494557d4da8SBarry Smith 495557d4da8SBarry Smith M*/ 496557d4da8SBarry Smith #define PETSC_DEFAULT -2 497557d4da8SBarry Smith 498557d4da8SBarry Smith /*MC 499d382aafbSBarry Smith PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents 500ea8fe74dSBarry Smith all the processes that PETSc knows about. 501d382aafbSBarry Smith 502d382aafbSBarry Smith Level: beginner 503d382aafbSBarry Smith 504e28ce29aSPatrick Sanan Notes: 505e28ce29aSPatrick Sanan By default PETSC_COMM_WORLD and MPI_COMM_WORLD are identical unless you wish to 506d382aafbSBarry Smith run PETSc on ONLY a subset of MPI_COMM_WORLD. In that case create your new (smaller) 507d382aafbSBarry Smith communicator, call it, say comm, and set PETSC_COMM_WORLD = comm BEFORE calling 508a990b902SBarry Smith PetscInitialize(), but after MPI_Init() has been called. 509a990b902SBarry Smith 510a990b902SBarry Smith The value of PETSC_COMM_WORLD should never be USED/accessed before PetscInitialize() 511a990b902SBarry Smith is called because it may not have a valid value yet. 512d382aafbSBarry Smith 513d382aafbSBarry Smith .seealso: PETSC_COMM_SELF 514d382aafbSBarry Smith 515d382aafbSBarry Smith M*/ 516014dd563SJed Brown PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD; 517d382aafbSBarry Smith 518d382aafbSBarry Smith /*MC 519503cfb0cSBarry Smith PETSC_COMM_SELF - This is always MPI_COMM_SELF 520d382aafbSBarry Smith 521d382aafbSBarry Smith Level: beginner 522d382aafbSBarry Smith 523e28ce29aSPatrick Sanan Notes: 524e28ce29aSPatrick Sanan Do not USE/access or set this variable before PetscInitialize() has been called. 525a990b902SBarry Smith 526d382aafbSBarry Smith .seealso: PETSC_COMM_WORLD 527d382aafbSBarry Smith 528d382aafbSBarry Smith M*/ 529d382aafbSBarry Smith #define PETSC_COMM_SELF MPI_COMM_SELF 530d382aafbSBarry Smith 5316de5d289SStefano Zampini /*MC 5326de5d289SStefano Zampini PETSC_MPI_THREAD_REQUIRED - the required threading support used if PETSc initializes 5336de5d289SStefano Zampini MPI with MPI_Init_thread. 5346de5d289SStefano Zampini 5356de5d289SStefano Zampini Level: beginner 5366de5d289SStefano Zampini 5376de5d289SStefano Zampini Notes: 5386de5d289SStefano Zampini By default PETSC_MPI_THREAD_REQUIRED equals MPI_THREAD_FUNNELED. 5396de5d289SStefano Zampini 5406de5d289SStefano Zampini .seealso: PetscInitialize() 5416de5d289SStefano Zampini 5426de5d289SStefano Zampini M*/ 5436de5d289SStefano Zampini PETSC_EXTERN PetscMPIInt PETSC_MPI_THREAD_REQUIRED; 5446de5d289SStefano Zampini 545d6f2c3cbSBarry Smith PETSC_EXTERN PetscBool PetscBeganMPI; 5468ad20175SVaclav Hapla PETSC_EXTERN PetscBool PetscErrorHandlingInitialized; 547014dd563SJed Brown PETSC_EXTERN PetscBool PetscInitializeCalled; 548014dd563SJed Brown PETSC_EXTERN PetscBool PetscFinalizeCalled; 5494cf1874eSKarl Rupp PETSC_EXTERN PetscBool PetscViennaCLSynchronize; 550d382aafbSBarry Smith 551014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm)); 552014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*); 553014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm*); 554d382aafbSBarry Smith 5557381773fSBarry Smith #if defined(PETSC_HAVE_CUDA) 55605035670SJunchao Zhang PETSC_EXTERN PetscBool PetscCUDASynchronize; 557cae85d06SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscCUDAInitialize(MPI_Comm,PetscInt); 5583c7e804fSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscCUDAInitializeCheck(void); 5597381773fSBarry Smith #endif 5607381773fSBarry Smith 56105035670SJunchao Zhang #if defined(PETSC_HAVE_HIP) 56205035670SJunchao Zhang PETSC_EXTERN PetscBool PetscHIPSynchronize; 56305035670SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscHIPInitialize(MPI_Comm,PetscInt); 5643c7e804fSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscHIPInitializeCheck(void); 56505035670SJunchao Zhang #endif 56605035670SJunchao Zhang 56759e55d94SJunchao Zhang #if defined(PETSC_HAVE_KOKKOS) 56859e55d94SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscKokkosInitializeCheck(void); /* Initialize Kokkos if not yet. */ 56959e55d94SJunchao Zhang #endif 57059e55d94SJunchao Zhang 57171438e86SJunchao Zhang #if defined(PETSC_HAVE_NVSHMEM) 57271438e86SJunchao Zhang PETSC_EXTERN PetscBool PetscBeganNvshmem; 57371438e86SJunchao Zhang PETSC_EXTERN PetscBool PetscNvshmemInitialized; 57471438e86SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscNvshmemFinalize(void); 57571438e86SJunchao Zhang #endif 57671438e86SJunchao Zhang 577540e20f2SPierre Jolivet #if defined(PETSC_HAVE_ELEMENTAL) 578540e20f2SPierre Jolivet PETSC_EXTERN PetscErrorCode PetscElementalInitializePackage(void); 579540e20f2SPierre Jolivet PETSC_EXTERN PetscErrorCode PetscElementalInitialized(PetscBool*); 580540e20f2SPierre Jolivet PETSC_EXTERN PetscErrorCode PetscElementalFinalizePackage(void); 581540e20f2SPierre Jolivet #endif 582540e20f2SPierre Jolivet 583d382aafbSBarry Smith /*MC 58495dccacaSBarry Smith PetscMalloc - Allocates memory, One should use PetscNew(), PetscMalloc1() or PetscCalloc1() usually instead of this 585d382aafbSBarry Smith 586eca87e8dSBarry Smith Synopsis: 587aaa7dc30SBarry Smith #include <petscsys.h> 588eca87e8dSBarry Smith PetscErrorCode PetscMalloc(size_t m,void **result) 589eca87e8dSBarry Smith 590eca87e8dSBarry Smith Not Collective 591eca87e8dSBarry Smith 592d382aafbSBarry Smith Input Parameter: 593d382aafbSBarry Smith . m - number of bytes to allocate 594d382aafbSBarry Smith 595d382aafbSBarry Smith Output Parameter: 596d382aafbSBarry Smith . result - memory allocated 597d382aafbSBarry Smith 598d382aafbSBarry Smith Level: beginner 599d382aafbSBarry Smith 60049d7da52SJed Brown Notes: 60149d7da52SJed Brown Memory is always allocated at least double aligned 602d382aafbSBarry Smith 60349d7da52SJed Brown It is safe to allocate size 0 and pass the resulting pointer (which may or may not be NULL) to PetscFree(). 604d382aafbSBarry Smith 605d382aafbSBarry Smith .seealso: PetscFree(), PetscNew() 606d382aafbSBarry Smith 607d382aafbSBarry Smith M*/ 608071fcb05SBarry Smith #define PetscMalloc(a,b) ((*PetscTrMalloc)((a),PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b))) 609d382aafbSBarry Smith 610d382aafbSBarry Smith /*MC 6113221ece2SMatthew G. Knepley PetscRealloc - Rellocates memory 6123221ece2SMatthew G. Knepley 6133221ece2SMatthew G. Knepley Synopsis: 6143221ece2SMatthew G. Knepley #include <petscsys.h> 6153221ece2SMatthew G. Knepley PetscErrorCode PetscRealloc(size_t m,void **result) 6163221ece2SMatthew G. Knepley 6173221ece2SMatthew G. Knepley Not Collective 6183221ece2SMatthew G. Knepley 6193221ece2SMatthew G. Knepley Input Parameters: 6203221ece2SMatthew G. Knepley + m - number of bytes to allocate 62192f119d6SBarry Smith - result - previous memory 6223221ece2SMatthew G. Knepley 6233221ece2SMatthew G. Knepley Output Parameter: 6243221ece2SMatthew G. Knepley . result - new memory allocated 6253221ece2SMatthew G. Knepley 6263221ece2SMatthew G. Knepley Level: developer 6273221ece2SMatthew G. Knepley 6283221ece2SMatthew G. Knepley Notes: 6293221ece2SMatthew G. Knepley Memory is always allocated at least double aligned 6303221ece2SMatthew G. Knepley 6313221ece2SMatthew G. Knepley .seealso: PetscMalloc(), PetscFree(), PetscNew() 6323221ece2SMatthew G. Knepley 6333221ece2SMatthew G. Knepley M*/ 6343221ece2SMatthew G. Knepley #define PetscRealloc(a,b) ((*PetscTrRealloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b))) 6353221ece2SMatthew G. Knepley 6363221ece2SMatthew G. Knepley /*MC 637503cfb0cSBarry Smith PetscAddrAlign - Rounds up an address to PETSC_MEMALIGN alignment 638d382aafbSBarry Smith 639d382aafbSBarry Smith Synopsis: 640aaa7dc30SBarry Smith #include <petscsys.h> 641d382aafbSBarry Smith void *PetscAddrAlign(void *addr) 642d382aafbSBarry Smith 643eca87e8dSBarry Smith Not Collective 644eca87e8dSBarry Smith 645eca87e8dSBarry Smith Input Parameters: 646eca87e8dSBarry Smith . addr - address to align (any pointer type) 647eca87e8dSBarry Smith 648d382aafbSBarry Smith Level: developer 649d382aafbSBarry Smith 650d382aafbSBarry Smith .seealso: PetscMallocAlign() 651d382aafbSBarry Smith 652d382aafbSBarry Smith M*/ 653d382aafbSBarry Smith #define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1)) 654d382aafbSBarry Smith 655d382aafbSBarry Smith /*MC 6568f51dc47SJunchao Zhang PetscCalloc - Allocates a cleared (zeroed) memory region aligned to PETSC_MEMALIGN 6578f51dc47SJunchao Zhang 6588f51dc47SJunchao Zhang Synopsis: 6598f51dc47SJunchao Zhang #include <petscsys.h> 6608f51dc47SJunchao Zhang PetscErrorCode PetscCalloc(size_t m,void **result) 6618f51dc47SJunchao Zhang 6628f51dc47SJunchao Zhang Not Collective 6638f51dc47SJunchao Zhang 6648f51dc47SJunchao Zhang Input Parameter: 6658f51dc47SJunchao Zhang . m - number of bytes to allocate 6668f51dc47SJunchao Zhang 6678f51dc47SJunchao Zhang Output Parameter: 6688f51dc47SJunchao Zhang . result - memory allocated 6698f51dc47SJunchao Zhang 6708f51dc47SJunchao Zhang Level: beginner 6718f51dc47SJunchao Zhang 6728f51dc47SJunchao Zhang Notes: 6738f51dc47SJunchao Zhang Memory is always allocated at least double aligned. This macro is useful in allocating memory pointed by void pointers 6748f51dc47SJunchao Zhang 6758f51dc47SJunchao Zhang It is safe to allocate size 0 and pass the resulting pointer (which may or may not be NULL) to PetscFree(). 6768f51dc47SJunchao Zhang 6778f51dc47SJunchao Zhang .seealso: PetscFree(), PetscNew() 6788f51dc47SJunchao Zhang 6798f51dc47SJunchao Zhang M*/ 6808f51dc47SJunchao Zhang #define PetscCalloc(m,result) PetscMallocA(1,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m),(result)) 6818f51dc47SJunchao Zhang 6828f51dc47SJunchao Zhang /*MC 683785e854fSJed Brown PetscMalloc1 - Allocates an array of memory aligned to PETSC_MEMALIGN 684d382aafbSBarry Smith 685eca87e8dSBarry Smith Synopsis: 686aaa7dc30SBarry Smith #include <petscsys.h> 687785e854fSJed Brown PetscErrorCode PetscMalloc1(size_t m1,type **r1) 688785e854fSJed Brown 689785e854fSJed Brown Not Collective 690785e854fSJed Brown 691785e854fSJed Brown Input Parameter: 692390e1bf2SBarry Smith . m1 - number of elements to allocate (may be zero) 693785e854fSJed Brown 694785e854fSJed Brown Output Parameter: 6951fe1b817SJunchao Zhang . r1 - memory allocated 696785e854fSJed Brown 697e28ce29aSPatrick Sanan Note: 698e28ce29aSPatrick Sanan This uses the sizeof() of the memory type requested to determine the total memory to be allocated, therefore you should not 699390e1bf2SBarry Smith multiply the number of elements requested by the sizeof() the type. For example use 700390e1bf2SBarry Smith $ PetscInt *id; 701390e1bf2SBarry Smith $ PetscMalloc1(10,&id); 702390e1bf2SBarry Smith not 703390e1bf2SBarry Smith $ PetscInt *id; 704390e1bf2SBarry Smith $ PetscMalloc1(10*sizeof(PetscInt),&id); 705390e1bf2SBarry Smith 7061fe1b817SJunchao Zhang Does not zero the memory allocated, use PetscCalloc1() to obtain memory that has been zeroed. 707390e1bf2SBarry Smith 708390e1bf2SBarry Smith Level: beginner 709785e854fSJed Brown 7101795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2() 711785e854fSJed Brown 712785e854fSJed Brown M*/ 7132553b7ecSJed Brown #define PetscMalloc1(m1,r1) PetscMallocA(1,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1)) 714785e854fSJed Brown 715785e854fSJed Brown /*MC 7161795a4d1SJed Brown PetscCalloc1 - Allocates a cleared (zeroed) array of memory aligned to PETSC_MEMALIGN 7171795a4d1SJed Brown 7181795a4d1SJed Brown Synopsis: 719aaa7dc30SBarry Smith #include <petscsys.h> 7201795a4d1SJed Brown PetscErrorCode PetscCalloc1(size_t m1,type **r1) 7211795a4d1SJed Brown 7221795a4d1SJed Brown Not Collective 7231795a4d1SJed Brown 7241795a4d1SJed Brown Input Parameter: 7251795a4d1SJed Brown . m1 - number of elements to allocate in 1st chunk (may be zero) 7261795a4d1SJed Brown 7271795a4d1SJed Brown Output Parameter: 7281fe1b817SJunchao Zhang . r1 - memory allocated 7291795a4d1SJed Brown 730e28ce29aSPatrick Sanan Notes: 731e28ce29aSPatrick Sanan See PetsMalloc1() for more details on usage. 732390e1bf2SBarry Smith 733390e1bf2SBarry Smith Level: beginner 7341795a4d1SJed Brown 7351795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2() 7361795a4d1SJed Brown 7371795a4d1SJed Brown M*/ 7382553b7ecSJed Brown #define PetscCalloc1(m1,r1) PetscMallocA(1,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1)) 7391795a4d1SJed Brown 7401795a4d1SJed Brown /*MC 741dcca6d9dSJed Brown PetscMalloc2 - Allocates 2 arrays of memory both aligned to PETSC_MEMALIGN 742d382aafbSBarry Smith 743eca87e8dSBarry Smith Synopsis: 744aaa7dc30SBarry Smith #include <petscsys.h> 745dcca6d9dSJed Brown PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2) 746eca87e8dSBarry Smith 747eca87e8dSBarry Smith Not Collective 748eca87e8dSBarry Smith 749d382aafbSBarry Smith Input Parameter: 750d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 751dcca6d9dSJed Brown - m2 - number of elements to allocate in 2nd chunk (may be zero) 752d382aafbSBarry Smith 753d382aafbSBarry Smith Output Parameter: 754d382aafbSBarry Smith + r1 - memory allocated in first chunk 755d382aafbSBarry Smith - r2 - memory allocated in second chunk 756d382aafbSBarry Smith 757d382aafbSBarry Smith Level: developer 758d382aafbSBarry Smith 7591795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2() 760d382aafbSBarry Smith 761d382aafbSBarry Smith M*/ 7622553b7ecSJed Brown #define PetscMalloc2(m1,r1,m2,r2) PetscMallocA(2,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2)) 763d382aafbSBarry Smith 764d382aafbSBarry Smith /*MC 7651795a4d1SJed Brown PetscCalloc2 - Allocates 2 cleared (zeroed) arrays of memory both aligned to PETSC_MEMALIGN 766d382aafbSBarry Smith 767eca87e8dSBarry Smith Synopsis: 768aaa7dc30SBarry Smith #include <petscsys.h> 7691795a4d1SJed Brown PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2) 770eca87e8dSBarry Smith 771eca87e8dSBarry Smith Not Collective 772eca87e8dSBarry Smith 773d382aafbSBarry Smith Input Parameter: 774d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 7751795a4d1SJed Brown - m2 - number of elements to allocate in 2nd chunk (may be zero) 7761795a4d1SJed Brown 7771795a4d1SJed Brown Output Parameter: 7781795a4d1SJed Brown + r1 - memory allocated in first chunk 7791795a4d1SJed Brown - r2 - memory allocated in second chunk 7801795a4d1SJed Brown 7811795a4d1SJed Brown Level: developer 7821795a4d1SJed Brown 7831795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2() 7841795a4d1SJed Brown 7851795a4d1SJed Brown M*/ 7862553b7ecSJed Brown #define PetscCalloc2(m1,r1,m2,r2) PetscMallocA(2,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2)) 7871795a4d1SJed Brown 7881795a4d1SJed Brown /*MC 789dcca6d9dSJed Brown PetscMalloc3 - Allocates 3 arrays of memory, all aligned to PETSC_MEMALIGN 790d382aafbSBarry Smith 791d382aafbSBarry Smith Synopsis: 792aaa7dc30SBarry Smith #include <petscsys.h> 793dcca6d9dSJed Brown PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3) 794d382aafbSBarry Smith 795d382aafbSBarry Smith Not Collective 796d382aafbSBarry Smith 797d382aafbSBarry Smith Input Parameter: 798d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 799d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 800dcca6d9dSJed Brown - m3 - number of elements to allocate in 3rd chunk (may be zero) 801d382aafbSBarry Smith 802d382aafbSBarry Smith Output Parameter: 803d382aafbSBarry Smith + r1 - memory allocated in first chunk 804d382aafbSBarry Smith . r2 - memory allocated in second chunk 805d382aafbSBarry Smith - r3 - memory allocated in third chunk 806d382aafbSBarry Smith 807d382aafbSBarry Smith Level: developer 808d382aafbSBarry Smith 8091795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc3(), PetscFree3() 810d382aafbSBarry Smith 811d382aafbSBarry Smith M*/ 8122553b7ecSJed Brown #define PetscMalloc3(m1,r1,m2,r2,m3,r3) PetscMallocA(3,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3)) 813d382aafbSBarry Smith 814d382aafbSBarry Smith /*MC 8151795a4d1SJed Brown PetscCalloc3 - Allocates 3 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 816d382aafbSBarry Smith 817eca87e8dSBarry Smith Synopsis: 818aaa7dc30SBarry Smith #include <petscsys.h> 8191795a4d1SJed Brown PetscErrorCode PetscCalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3) 820eca87e8dSBarry Smith 821eca87e8dSBarry Smith Not Collective 822eca87e8dSBarry Smith 823d382aafbSBarry Smith Input Parameter: 824d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 825d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 8261795a4d1SJed Brown - m3 - number of elements to allocate in 3rd chunk (may be zero) 8271795a4d1SJed Brown 8281795a4d1SJed Brown Output Parameter: 8291795a4d1SJed Brown + r1 - memory allocated in first chunk 8301795a4d1SJed Brown . r2 - memory allocated in second chunk 8311795a4d1SJed Brown - r3 - memory allocated in third chunk 8321795a4d1SJed Brown 8331795a4d1SJed Brown Level: developer 8341795a4d1SJed Brown 8351795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc2(), PetscMalloc3(), PetscFree3() 8361795a4d1SJed Brown 8371795a4d1SJed Brown M*/ 8382553b7ecSJed Brown #define PetscCalloc3(m1,r1,m2,r2,m3,r3) PetscMallocA(3,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3)) 8391795a4d1SJed Brown 8401795a4d1SJed Brown /*MC 841dcca6d9dSJed Brown PetscMalloc4 - Allocates 4 arrays of memory, all aligned to PETSC_MEMALIGN 842d382aafbSBarry Smith 843d382aafbSBarry Smith Synopsis: 844aaa7dc30SBarry Smith #include <petscsys.h> 845dcca6d9dSJed Brown PetscErrorCode PetscMalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4) 846d382aafbSBarry Smith 847d382aafbSBarry Smith Not Collective 848d382aafbSBarry Smith 849d382aafbSBarry Smith Input Parameter: 850d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 851d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 852d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 853dcca6d9dSJed Brown - m4 - number of elements to allocate in 4th chunk (may be zero) 854d382aafbSBarry Smith 855d382aafbSBarry Smith Output Parameter: 856d382aafbSBarry Smith + r1 - memory allocated in first chunk 857d382aafbSBarry Smith . r2 - memory allocated in second chunk 858d382aafbSBarry Smith . r3 - memory allocated in third chunk 859d382aafbSBarry Smith - r4 - memory allocated in fourth chunk 860d382aafbSBarry Smith 861d382aafbSBarry Smith Level: developer 862d382aafbSBarry Smith 8631795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4() 864d382aafbSBarry Smith 865d382aafbSBarry Smith M*/ 8662553b7ecSJed Brown #define PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4) PetscMallocA(4,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4)) 867d382aafbSBarry Smith 868d382aafbSBarry Smith /*MC 8691795a4d1SJed Brown PetscCalloc4 - Allocates 4 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 870d382aafbSBarry Smith 871eca87e8dSBarry Smith Synopsis: 872aaa7dc30SBarry Smith #include <petscsys.h> 8731795a4d1SJed Brown PetscErrorCode PetscCalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4) 874eca87e8dSBarry Smith 875eca87e8dSBarry Smith Not Collective 876eca87e8dSBarry Smith 877e28ce29aSPatrick Sanan Input Parameters: 878d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 879d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 880d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 8811795a4d1SJed Brown - m4 - number of elements to allocate in 4th chunk (may be zero) 8821795a4d1SJed Brown 883e28ce29aSPatrick Sanan Output Parameters: 8841795a4d1SJed Brown + r1 - memory allocated in first chunk 8851795a4d1SJed Brown . r2 - memory allocated in second chunk 8861795a4d1SJed Brown . r3 - memory allocated in third chunk 8871795a4d1SJed Brown - r4 - memory allocated in fourth chunk 8881795a4d1SJed Brown 8891795a4d1SJed Brown Level: developer 8901795a4d1SJed Brown 8911795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4() 8921795a4d1SJed Brown 8931795a4d1SJed Brown M*/ 8942553b7ecSJed Brown #define PetscCalloc4(m1,r1,m2,r2,m3,r3,m4,r4) PetscMallocA(4,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4)) 8951795a4d1SJed Brown 8961795a4d1SJed Brown /*MC 897dcca6d9dSJed Brown PetscMalloc5 - Allocates 5 arrays of memory, all aligned to PETSC_MEMALIGN 898d382aafbSBarry Smith 899d382aafbSBarry Smith Synopsis: 900aaa7dc30SBarry Smith #include <petscsys.h> 901dcca6d9dSJed 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) 902d382aafbSBarry Smith 903d382aafbSBarry Smith Not Collective 904d382aafbSBarry Smith 905e28ce29aSPatrick Sanan Input Parameters: 906d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 907d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 908d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 909d382aafbSBarry Smith . m4 - number of elements to allocate in 4th chunk (may be zero) 910dcca6d9dSJed Brown - m5 - number of elements to allocate in 5th chunk (may be zero) 911d382aafbSBarry Smith 912e28ce29aSPatrick Sanan Output Parameters: 913d382aafbSBarry Smith + r1 - memory allocated in first chunk 914d382aafbSBarry Smith . r2 - memory allocated in second chunk 915d382aafbSBarry Smith . r3 - memory allocated in third chunk 916d382aafbSBarry Smith . r4 - memory allocated in fourth chunk 917d382aafbSBarry Smith - r5 - memory allocated in fifth chunk 918d382aafbSBarry Smith 919d382aafbSBarry Smith Level: developer 920d382aafbSBarry Smith 9211795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc5(), PetscFree5() 922d382aafbSBarry Smith 923d382aafbSBarry Smith M*/ 9242553b7ecSJed Brown #define PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) PetscMallocA(5,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5)) 925d382aafbSBarry Smith 926d382aafbSBarry Smith /*MC 9271795a4d1SJed Brown PetscCalloc5 - Allocates 5 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 928d382aafbSBarry Smith 929eca87e8dSBarry Smith Synopsis: 930aaa7dc30SBarry Smith #include <petscsys.h> 9311795a4d1SJed 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) 932eca87e8dSBarry Smith 933eca87e8dSBarry Smith Not Collective 934eca87e8dSBarry Smith 935e28ce29aSPatrick Sanan Input Parameters: 936d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 937d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 938d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 939d382aafbSBarry Smith . m4 - number of elements to allocate in 4th chunk (may be zero) 9401795a4d1SJed Brown - m5 - number of elements to allocate in 5th chunk (may be zero) 9411795a4d1SJed Brown 942e28ce29aSPatrick Sanan Output Parameters: 9431795a4d1SJed Brown + r1 - memory allocated in first chunk 9441795a4d1SJed Brown . r2 - memory allocated in second chunk 9451795a4d1SJed Brown . r3 - memory allocated in third chunk 9461795a4d1SJed Brown . r4 - memory allocated in fourth chunk 9471795a4d1SJed Brown - r5 - memory allocated in fifth chunk 9481795a4d1SJed Brown 9491795a4d1SJed Brown Level: developer 9501795a4d1SJed Brown 9511795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc5(), PetscFree5() 9521795a4d1SJed Brown 9531795a4d1SJed Brown M*/ 9542553b7ecSJed Brown #define PetscCalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) PetscMallocA(5,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5)) 955d382aafbSBarry Smith 956d382aafbSBarry Smith /*MC 957dcca6d9dSJed Brown PetscMalloc6 - Allocates 6 arrays of memory, all aligned to PETSC_MEMALIGN 958d382aafbSBarry Smith 959d382aafbSBarry Smith Synopsis: 960aaa7dc30SBarry Smith #include <petscsys.h> 961dcca6d9dSJed 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) 962d382aafbSBarry Smith 963d382aafbSBarry Smith Not Collective 964d382aafbSBarry Smith 965e28ce29aSPatrick Sanan Input Parameters: 966d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 967d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 968d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 969d382aafbSBarry Smith . m4 - number of elements to allocate in 4th chunk (may be zero) 970d382aafbSBarry Smith . m5 - number of elements to allocate in 5th chunk (may be zero) 971dcca6d9dSJed Brown - m6 - number of elements to allocate in 6th chunk (may be zero) 972d382aafbSBarry Smith 973e28ce29aSPatrick Sanan Output Parameteasr: 974d382aafbSBarry Smith + r1 - memory allocated in first chunk 975d382aafbSBarry Smith . r2 - memory allocated in second chunk 976d382aafbSBarry Smith . r3 - memory allocated in third chunk 977d382aafbSBarry Smith . r4 - memory allocated in fourth chunk 978d382aafbSBarry Smith . r5 - memory allocated in fifth chunk 979d382aafbSBarry Smith - r6 - memory allocated in sixth chunk 980d382aafbSBarry Smith 981d382aafbSBarry Smith Level: developer 982d382aafbSBarry Smith 9831795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc6(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6() 984d382aafbSBarry Smith 985d382aafbSBarry Smith M*/ 9862553b7ecSJed Brown #define PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) PetscMallocA(6,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5),(size_t)(m6)*sizeof(**(r6)),(r6)) 987d382aafbSBarry Smith 988d382aafbSBarry Smith /*MC 9891795a4d1SJed Brown PetscCalloc6 - Allocates 6 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 990d382aafbSBarry Smith 991eca87e8dSBarry Smith Synopsis: 992aaa7dc30SBarry Smith #include <petscsys.h> 9931795a4d1SJed 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) 994eca87e8dSBarry Smith 995eca87e8dSBarry Smith Not Collective 996eca87e8dSBarry Smith 997e28ce29aSPatrick Sanan Input Parameters: 998d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 999d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 1000d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 1001d382aafbSBarry Smith . m4 - number of elements to allocate in 4th chunk (may be zero) 1002d382aafbSBarry Smith . m5 - number of elements to allocate in 5th chunk (may be zero) 10031795a4d1SJed Brown - m6 - number of elements to allocate in 6th chunk (may be zero) 10041795a4d1SJed Brown 1005e28ce29aSPatrick Sanan Output Parameters: 10061795a4d1SJed Brown + r1 - memory allocated in first chunk 10071795a4d1SJed Brown . r2 - memory allocated in second chunk 10081795a4d1SJed Brown . r3 - memory allocated in third chunk 10091795a4d1SJed Brown . r4 - memory allocated in fourth chunk 10101795a4d1SJed Brown . r5 - memory allocated in fifth chunk 10111795a4d1SJed Brown - r6 - memory allocated in sixth chunk 10121795a4d1SJed Brown 10131795a4d1SJed Brown Level: developer 10141795a4d1SJed Brown 10151795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc6(), PetscFree6() 10161795a4d1SJed Brown 10171795a4d1SJed Brown M*/ 10182553b7ecSJed Brown #define PetscCalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) PetscMallocA(6,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5),(size_t)(m6)*sizeof(**(r6)),(r6)) 10191795a4d1SJed Brown 10201795a4d1SJed Brown /*MC 1021dcca6d9dSJed Brown PetscMalloc7 - Allocates 7 arrays of memory, all aligned to PETSC_MEMALIGN 1022d382aafbSBarry Smith 1023d382aafbSBarry Smith Synopsis: 1024aaa7dc30SBarry Smith #include <petscsys.h> 1025dcca6d9dSJed 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) 1026d382aafbSBarry Smith 1027d382aafbSBarry Smith Not Collective 1028d382aafbSBarry Smith 1029e28ce29aSPatrick Sanan Input Parameters: 1030d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 1031d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 1032d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 1033d382aafbSBarry Smith . m4 - number of elements to allocate in 4th chunk (may be zero) 1034d382aafbSBarry Smith . m5 - number of elements to allocate in 5th chunk (may be zero) 1035d382aafbSBarry Smith . m6 - number of elements to allocate in 6th chunk (may be zero) 1036dcca6d9dSJed Brown - m7 - number of elements to allocate in 7th chunk (may be zero) 1037d382aafbSBarry Smith 1038e28ce29aSPatrick Sanan Output Parameters: 1039d382aafbSBarry Smith + r1 - memory allocated in first chunk 1040d382aafbSBarry Smith . r2 - memory allocated in second chunk 1041d382aafbSBarry Smith . r3 - memory allocated in third chunk 1042d382aafbSBarry Smith . r4 - memory allocated in fourth chunk 1043d382aafbSBarry Smith . r5 - memory allocated in fifth chunk 1044d382aafbSBarry Smith . r6 - memory allocated in sixth chunk 1045eca87e8dSBarry Smith - r7 - memory allocated in seventh chunk 1046d382aafbSBarry Smith 1047d382aafbSBarry Smith Level: developer 1048d382aafbSBarry Smith 10491795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc7(), PetscFree7() 1050d382aafbSBarry Smith 1051d382aafbSBarry Smith M*/ 10522553b7ecSJed Brown #define PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) PetscMallocA(7,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5),(size_t)(m6)*sizeof(**(r6)),(r6),(size_t)(m7)*sizeof(**(r7)),(r7)) 1053d382aafbSBarry Smith 1054d382aafbSBarry Smith /*MC 10551795a4d1SJed Brown PetscCalloc7 - Allocates 7 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 10561795a4d1SJed Brown 10571795a4d1SJed Brown Synopsis: 1058aaa7dc30SBarry Smith #include <petscsys.h> 10591795a4d1SJed 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) 10601795a4d1SJed Brown 10611795a4d1SJed Brown Not Collective 10621795a4d1SJed Brown 1063e28ce29aSPatrick Sanan Input Parameters: 10641795a4d1SJed Brown + m1 - number of elements to allocate in 1st chunk (may be zero) 10651795a4d1SJed Brown . m2 - number of elements to allocate in 2nd chunk (may be zero) 10661795a4d1SJed Brown . m3 - number of elements to allocate in 3rd chunk (may be zero) 10671795a4d1SJed Brown . m4 - number of elements to allocate in 4th chunk (may be zero) 10681795a4d1SJed Brown . m5 - number of elements to allocate in 5th chunk (may be zero) 10691795a4d1SJed Brown . m6 - number of elements to allocate in 6th chunk (may be zero) 10701795a4d1SJed Brown - m7 - number of elements to allocate in 7th chunk (may be zero) 10711795a4d1SJed Brown 1072e28ce29aSPatrick Sanan Output Parameters: 10731795a4d1SJed Brown + r1 - memory allocated in first chunk 10741795a4d1SJed Brown . r2 - memory allocated in second chunk 10751795a4d1SJed Brown . r3 - memory allocated in third chunk 10761795a4d1SJed Brown . r4 - memory allocated in fourth chunk 10771795a4d1SJed Brown . r5 - memory allocated in fifth chunk 10781795a4d1SJed Brown . r6 - memory allocated in sixth chunk 10791795a4d1SJed Brown - r7 - memory allocated in seventh chunk 10801795a4d1SJed Brown 10811795a4d1SJed Brown Level: developer 10821795a4d1SJed Brown 10831795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc7(), PetscFree7() 10841795a4d1SJed Brown 10851795a4d1SJed Brown M*/ 10862553b7ecSJed Brown #define PetscCalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) PetscMallocA(7,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1),(size_t)(m2)*sizeof(**(r2)),(r2),(size_t)(m3)*sizeof(**(r3)),(r3),(size_t)(m4)*sizeof(**(r4)),(r4),(size_t)(m5)*sizeof(**(r5)),(r5),(size_t)(m6)*sizeof(**(r6)),(r6),(size_t)(m7)*sizeof(**(r7)),(r7)) 10871795a4d1SJed Brown 10881795a4d1SJed Brown /*MC 1089503cfb0cSBarry Smith PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to PETSC_MEMALIGN 1090d382aafbSBarry Smith 1091eca87e8dSBarry Smith Synopsis: 1092aaa7dc30SBarry Smith #include <petscsys.h> 1093b00a9115SJed Brown PetscErrorCode PetscNew(type **result) 1094eca87e8dSBarry Smith 1095eca87e8dSBarry Smith Not Collective 1096eca87e8dSBarry Smith 1097d382aafbSBarry Smith Output Parameter: 1098b00a9115SJed Brown . result - memory allocated, sized to match pointer type 1099d382aafbSBarry Smith 1100d382aafbSBarry Smith Level: beginner 1101d382aafbSBarry Smith 1102390e1bf2SBarry Smith .seealso: PetscFree(), PetscMalloc(), PetscNewLog(), PetscCalloc1(), PetscMalloc1() 1103d382aafbSBarry Smith 1104d382aafbSBarry Smith M*/ 1105b00a9115SJed Brown #define PetscNew(b) PetscCalloc1(1,(b)) 1106ad0619ddSBarry Smith 1107ad0619ddSBarry Smith /*MC 1108b00a9115SJed Brown PetscNewLog - Allocates memory of a type matching pointer, zeros the memory! Aligned to PETSC_MEMALIGN. Associates the memory allocated 1109ad0619ddSBarry Smith with the given object using PetscLogObjectMemory(). 1110ad0619ddSBarry Smith 1111ad0619ddSBarry Smith Synopsis: 1112aaa7dc30SBarry Smith #include <petscsys.h> 1113b00a9115SJed Brown PetscErrorCode PetscNewLog(PetscObject obj,type **result) 1114ad0619ddSBarry Smith 1115ad0619ddSBarry Smith Not Collective 1116ad0619ddSBarry Smith 1117ad0619ddSBarry Smith Input Parameter: 1118b00a9115SJed Brown . obj - object memory is logged to 1119ad0619ddSBarry Smith 1120ad0619ddSBarry Smith Output Parameter: 1121b00a9115SJed Brown . result - memory allocated, sized to match pointer type 1122ad0619ddSBarry Smith 1123ad0619ddSBarry Smith Level: developer 1124ad0619ddSBarry Smith 1125390e1bf2SBarry Smith .seealso: PetscFree(), PetscMalloc(), PetscNew(), PetscLogObjectMemory(), PetscCalloc1(), PetscMalloc1() 1126ad0619ddSBarry Smith 1127ad0619ddSBarry Smith M*/ 1128d12f57a0SLisandro Dalcin #define PetscNewLog(o,b) (PetscNew((b)) || PetscLogObjectMemory((PetscObject)o,sizeof(**(b)))) 1129d382aafbSBarry Smith 1130d382aafbSBarry Smith /*MC 1131d382aafbSBarry Smith PetscFree - Frees memory 1132d382aafbSBarry Smith 1133eca87e8dSBarry Smith Synopsis: 1134aaa7dc30SBarry Smith #include <petscsys.h> 1135eca87e8dSBarry Smith PetscErrorCode PetscFree(void *memory) 1136eca87e8dSBarry Smith 1137eca87e8dSBarry Smith Not Collective 1138eca87e8dSBarry Smith 1139d382aafbSBarry Smith Input Parameter: 11407f4976b7SJacob Faibussowitsch . memory - memory to free (the pointer is ALWAYS set to NULL upon success) 1141d382aafbSBarry Smith 1142d382aafbSBarry Smith Level: beginner 1143d382aafbSBarry Smith 114449d7da52SJed Brown Notes: 1145390e1bf2SBarry Smith Do not free memory obtained with PetscMalloc2(), PetscCalloc2() etc, they must be freed with PetscFree2() etc. 1146390e1bf2SBarry Smith 114749d7da52SJed Brown It is safe to call PetscFree() on a NULL pointer. 1148d382aafbSBarry Smith 1149390e1bf2SBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscNewLog(), PetscMalloc1(), PetscCalloc1() 1150d382aafbSBarry Smith 1151d382aafbSBarry Smith M*/ 1152ffc31a0eSLisandro Dalcin #define PetscFree(a) ((*PetscTrFree)((void*)(a),__LINE__,PETSC_FUNCTION_NAME,__FILE__) || ((a) = NULL,0)) 1153d382aafbSBarry Smith 1154d382aafbSBarry Smith /*MC 1155d382aafbSBarry Smith PetscFree2 - Frees 2 chunks of memory obtained with PetscMalloc2() 1156d382aafbSBarry Smith 1157eca87e8dSBarry Smith Synopsis: 1158aaa7dc30SBarry Smith #include <petscsys.h> 1159eca87e8dSBarry Smith PetscErrorCode PetscFree2(void *memory1,void *memory2) 1160eca87e8dSBarry Smith 1161eca87e8dSBarry Smith Not Collective 1162eca87e8dSBarry Smith 1163e28ce29aSPatrick Sanan Input Parameters: 1164d382aafbSBarry Smith + memory1 - memory to free 1165d382aafbSBarry Smith - memory2 - 2nd memory to free 1166d382aafbSBarry Smith 1167d382aafbSBarry Smith Level: developer 1168d382aafbSBarry Smith 116995452b02SPatrick Sanan Notes: 117095452b02SPatrick Sanan Memory must have been obtained with PetscMalloc2() 1171d382aafbSBarry Smith 1172d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree() 1173d382aafbSBarry Smith 1174d382aafbSBarry Smith M*/ 1175ba282f50SJed Brown #define PetscFree2(m1,m2) PetscFreeA(2,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2)) 1176d382aafbSBarry Smith 1177d382aafbSBarry Smith /*MC 1178d382aafbSBarry Smith PetscFree3 - Frees 3 chunks of memory obtained with PetscMalloc3() 1179d382aafbSBarry Smith 1180eca87e8dSBarry Smith Synopsis: 1181aaa7dc30SBarry Smith #include <petscsys.h> 1182eca87e8dSBarry Smith PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3) 1183eca87e8dSBarry Smith 1184eca87e8dSBarry Smith Not Collective 1185eca87e8dSBarry Smith 1186e28ce29aSPatrick Sanan Input Parameters: 1187d382aafbSBarry Smith + memory1 - memory to free 1188d382aafbSBarry Smith . memory2 - 2nd memory to free 1189d382aafbSBarry Smith - memory3 - 3rd memory to free 1190d382aafbSBarry Smith 1191d382aafbSBarry Smith Level: developer 1192d382aafbSBarry Smith 119395452b02SPatrick Sanan Notes: 119495452b02SPatrick Sanan Memory must have been obtained with PetscMalloc3() 1195d382aafbSBarry Smith 1196d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3() 1197d382aafbSBarry Smith 1198d382aafbSBarry Smith M*/ 1199ba282f50SJed Brown #define PetscFree3(m1,m2,m3) PetscFreeA(3,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3)) 1200d382aafbSBarry Smith 1201d382aafbSBarry Smith /*MC 1202d382aafbSBarry Smith PetscFree4 - Frees 4 chunks of memory obtained with PetscMalloc4() 1203d382aafbSBarry Smith 1204eca87e8dSBarry Smith Synopsis: 1205aaa7dc30SBarry Smith #include <petscsys.h> 1206eca87e8dSBarry Smith PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4) 1207eca87e8dSBarry Smith 1208eca87e8dSBarry Smith Not Collective 1209eca87e8dSBarry Smith 1210e28ce29aSPatrick Sanan Input Parameters: 1211d382aafbSBarry Smith + m1 - memory to free 1212d382aafbSBarry Smith . m2 - 2nd memory to free 1213d382aafbSBarry Smith . m3 - 3rd memory to free 1214d382aafbSBarry Smith - m4 - 4th memory to free 1215d382aafbSBarry Smith 1216d382aafbSBarry Smith Level: developer 1217d382aafbSBarry Smith 121895452b02SPatrick Sanan Notes: 121995452b02SPatrick Sanan Memory must have been obtained with PetscMalloc4() 1220d382aafbSBarry Smith 1221d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4() 1222d382aafbSBarry Smith 1223d382aafbSBarry Smith M*/ 1224ba282f50SJed Brown #define PetscFree4(m1,m2,m3,m4) PetscFreeA(4,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4)) 1225d382aafbSBarry Smith 1226d382aafbSBarry Smith /*MC 1227d382aafbSBarry Smith PetscFree5 - Frees 5 chunks of memory obtained with PetscMalloc5() 1228d382aafbSBarry Smith 1229eca87e8dSBarry Smith Synopsis: 1230aaa7dc30SBarry Smith #include <petscsys.h> 1231eca87e8dSBarry Smith PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5) 1232eca87e8dSBarry Smith 1233eca87e8dSBarry Smith Not Collective 1234eca87e8dSBarry Smith 1235e28ce29aSPatrick Sanan Input Parameters: 1236d382aafbSBarry Smith + m1 - memory to free 1237d382aafbSBarry Smith . m2 - 2nd memory to free 1238d382aafbSBarry Smith . m3 - 3rd memory to free 1239d382aafbSBarry Smith . m4 - 4th memory to free 1240d382aafbSBarry Smith - m5 - 5th memory to free 1241d382aafbSBarry Smith 1242d382aafbSBarry Smith Level: developer 1243d382aafbSBarry Smith 124495452b02SPatrick Sanan Notes: 124595452b02SPatrick Sanan Memory must have been obtained with PetscMalloc5() 1246d382aafbSBarry Smith 1247d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5() 1248d382aafbSBarry Smith 1249d382aafbSBarry Smith M*/ 1250ba282f50SJed Brown #define PetscFree5(m1,m2,m3,m4,m5) PetscFreeA(5,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5)) 1251d382aafbSBarry Smith 1252d382aafbSBarry Smith /*MC 1253d382aafbSBarry Smith PetscFree6 - Frees 6 chunks of memory obtained with PetscMalloc6() 1254d382aafbSBarry Smith 1255eca87e8dSBarry Smith Synopsis: 1256aaa7dc30SBarry Smith #include <petscsys.h> 1257eca87e8dSBarry Smith PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6) 1258eca87e8dSBarry Smith 1259eca87e8dSBarry Smith Not Collective 1260eca87e8dSBarry Smith 1261e28ce29aSPatrick Sanan Input Parameters: 1262d382aafbSBarry Smith + m1 - memory to free 1263d382aafbSBarry Smith . m2 - 2nd memory to free 1264d382aafbSBarry Smith . m3 - 3rd memory to free 1265d382aafbSBarry Smith . m4 - 4th memory to free 1266d382aafbSBarry Smith . m5 - 5th memory to free 1267d382aafbSBarry Smith - m6 - 6th memory to free 1268d382aafbSBarry Smith 1269d382aafbSBarry Smith Level: developer 1270d382aafbSBarry Smith 127195452b02SPatrick Sanan Notes: 127295452b02SPatrick Sanan Memory must have been obtained with PetscMalloc6() 1273d382aafbSBarry Smith 1274d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6() 1275d382aafbSBarry Smith 1276d382aafbSBarry Smith M*/ 1277ba282f50SJed Brown #define PetscFree6(m1,m2,m3,m4,m5,m6) PetscFreeA(6,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5),&(m6)) 1278d382aafbSBarry Smith 1279d382aafbSBarry Smith /*MC 1280d382aafbSBarry Smith PetscFree7 - Frees 7 chunks of memory obtained with PetscMalloc7() 1281d382aafbSBarry Smith 1282eca87e8dSBarry Smith Synopsis: 1283aaa7dc30SBarry Smith #include <petscsys.h> 1284eca87e8dSBarry Smith PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7) 1285eca87e8dSBarry Smith 1286eca87e8dSBarry Smith Not Collective 1287eca87e8dSBarry Smith 1288e28ce29aSPatrick Sanan Input Parameters: 1289d382aafbSBarry Smith + m1 - memory to free 1290d382aafbSBarry Smith . m2 - 2nd memory to free 1291d382aafbSBarry Smith . m3 - 3rd memory to free 1292d382aafbSBarry Smith . m4 - 4th memory to free 1293d382aafbSBarry Smith . m5 - 5th memory to free 1294d382aafbSBarry Smith . m6 - 6th memory to free 1295d382aafbSBarry Smith - m7 - 7th memory to free 1296d382aafbSBarry Smith 1297d382aafbSBarry Smith Level: developer 1298d382aafbSBarry Smith 129995452b02SPatrick Sanan Notes: 130095452b02SPatrick Sanan Memory must have been obtained with PetscMalloc7() 1301d382aafbSBarry Smith 1302d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(), 1303d382aafbSBarry Smith PetscMalloc7() 1304d382aafbSBarry Smith 1305d382aafbSBarry Smith M*/ 1306ba282f50SJed Brown #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) PetscFreeA(7,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5),&(m6),&(m7)) 1307d382aafbSBarry Smith 1308ba282f50SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocA(int,PetscBool,int,const char *,const char *,size_t,void *,...); 1309ba282f50SJed Brown PETSC_EXTERN PetscErrorCode PetscFreeA(int,int,const char *,const char *,void *,...); 1310071fcb05SBarry Smith PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t,PetscBool,int,const char[],const char[],void**); 1311efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[]); 13123221ece2SMatthew G. Knepley PETSC_EXTERN PetscErrorCode (*PetscTrRealloc)(size_t,int,const char[],const char[],void**); 1313ba282f50SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocSetCoalesce(PetscBool); 131492f119d6SBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t,PetscBool,int,const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[]),PetscErrorCode (*)(size_t,int,const char[],const char[], void **)); 1315014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocClear(void); 1316d382aafbSBarry Smith 1317d382aafbSBarry Smith /* 1318c1706be6SHong 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. 1319c1706be6SHong Zhang */ 1320c1706be6SHong Zhang PETSC_EXTERN PetscErrorCode PetscMallocSetDRAM(void); 1321c1706be6SHong Zhang PETSC_EXTERN PetscErrorCode PetscMallocResetDRAM(void); 132231f06eaaSHong Zhang #if defined(PETSC_HAVE_CUDA) 132331f06eaaSHong Zhang PETSC_EXTERN PetscErrorCode PetscMallocSetCUDAHost(void); 132431f06eaaSHong Zhang PETSC_EXTERN PetscErrorCode PetscMallocResetCUDAHost(void); 132531f06eaaSHong Zhang #endif 132659af0bd3SScott Kruger #if defined(PETSC_HAVE_HIP) 132759af0bd3SScott Kruger PETSC_EXTERN PetscErrorCode PetscMallocSetHIPHost(void); 132859af0bd3SScott Kruger PETSC_EXTERN PetscErrorCode PetscMallocResetHIPHost(void); 132959af0bd3SScott Kruger #endif 133059af0bd3SScott Kruger 1331a5057860SBarry Smith #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE 133236763ca0SBas van 't Hof #define MPIU_2PETSCLOGDOUBLE MPI_2DOUBLE_PRECISION 1333a5057860SBarry Smith 1334a5057860SBarry Smith /* 133566d669d6SBarry Smith Routines for tracing memory corruption/bleeding with default PETSc memory allocation 1336d382aafbSBarry Smith */ 1337014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *); 133892f119d6SBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocView(FILE *); 1339014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *); 1340014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *); 1341e3ed9ee7SBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocPushMaximumUsage(int); 1342e3ed9ee7SBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocPopMaximumUsage(int,PetscLogDouble*); 134392f119d6SBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocSetDebug(PetscBool,PetscBool); 134492f119d6SBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool*,PetscBool*,PetscBool*); 1345efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode PetscMallocValidate(int,const char[],const char[]); 134692f119d6SBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocViewSet(PetscLogDouble); 134792f119d6SBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocViewGet(PetscBool*); 1348608c71bfSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscMallocLogRequestedSizeSet(PetscBool); 1349608c71bfSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscMallocLogRequestedSizeGet(PetscBool*); 1350d382aafbSBarry Smith 13516a6fc655SJed Brown PETSC_EXTERN const char *const PetscDataTypes[]; 1352014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*); 1353014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*); 1354014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*); 13558e4b2d1dSBarry Smith PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char*,PetscDataType*,PetscBool*); 1356d382aafbSBarry Smith 1357d382aafbSBarry Smith /* 1358d382aafbSBarry Smith Basic memory and string operations. These are usually simple wrappers 1359d382aafbSBarry Smith around the basic Unix system calls, but a few of them have additional 1360d382aafbSBarry Smith functionality and/or error checking. 1361d382aafbSBarry Smith */ 1362014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemcmp(const void*,const void*,size_t,PetscBool *); 1363014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrlen(const char[],size_t*); 1364d67fe73bSBarry Smith PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[],char,int*,char ***); 1365014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int,char **); 1366014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[],const char[],PetscBool *); 1367014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[],const char[],PetscBool *); 1368014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[],const char[],PetscBool *); 1369014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[],const char[],size_t,PetscBool *); 1370014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcpy(char[],const char[]); 1371014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcat(char[],const char[]); 1372a126751eSBarry Smith PETSC_EXTERN PetscErrorCode PetscStrlcat(char[],const char[],size_t); 1373014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrncpy(char[],const char[],size_t); 1374014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrchr(const char[],char,char *[]); 1375014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]); 13762f234a98SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrtoupper(char[]); 1377014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[],char,char *[]); 1378014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrstr(const char[],const char[],char *[]); 1379014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[],const char[],char *[]); 1380014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[],const char[],PetscBool*); 13812c9581d2SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[],const char[],PetscBool*); 1382014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[],const char *const*,PetscInt*); 1383014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[],char *[]); 138447340559SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const*,char***); 13856fed8037SJed Brown PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char***); 13866991f827SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrNArrayallocpy(PetscInt,const char *const*,char***); 13876991f827SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrNArrayDestroy(PetscInt,char***); 1388014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm,const char[],char[],size_t); 1389d382aafbSBarry Smith 1390573b0fb4SBarry Smith PETSC_EXTERN void PetscStrcmpNoError(const char[],const char[],PetscBool *); 1391573b0fb4SBarry Smith 1392014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*); 1393014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]); 1394014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*); 1395d382aafbSBarry Smith 1396e94e781bSJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PetscStrInList(const char[],const char[],char,PetscBool*); 1397a53986e1SJed Brown PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt,const char *const*,const char*,PetscInt*,PetscBool*); 1398a53986e1SJed Brown PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const*,const char*,PetscEnum*,PetscBool*); 1399a53986e1SJed Brown 1400d382aafbSBarry Smith /* 1401d382aafbSBarry Smith These are MPI operations for MPI_Allreduce() etc 1402d382aafbSBarry Smith */ 1403367daffbSBarry Smith PETSC_EXTERN MPI_Op MPIU_MAXSUM_OP; 1404570b7f6dSBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 1405de272c7aSSatish Balay PETSC_EXTERN MPI_Op MPIU_SUM; 1406014dd563SJed Brown PETSC_EXTERN MPI_Op MPIU_MAX; 1407014dd563SJed Brown PETSC_EXTERN MPI_Op MPIU_MIN; 1408d9822059SBarry Smith #else 1409de272c7aSSatish Balay #define MPIU_SUM MPI_SUM 1410d9822059SBarry Smith #define MPIU_MAX MPI_MAX 1411d9822059SBarry Smith #define MPIU_MIN MPI_MIN 1412d9822059SBarry Smith #endif 1413014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*); 1414d382aafbSBarry Smith 1415014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm); 1416014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm); 1417eb3f98d2SBarry Smith 141895c0884eSLisandro Dalcin PETSC_EXTERN const char *const PetscFileModes[]; 1419d6a4318aSJed Brown 1420639ff905SBarry Smith /* 1421639ff905SBarry Smith Defines PETSc error handling. 1422639ff905SBarry Smith */ 1423639ff905SBarry Smith #include <petscerror.h> 1424d382aafbSBarry Smith 14250700a824SBarry Smith #define PETSC_SMALLEST_CLASSID 1211211 1426014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID; 1427014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID; 1428014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *); 142981256985SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscObjectGetId(PetscObject,PetscObjectId*); 143081256985SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscObjectCompareId(PetscObject,PetscObjectId,PetscBool*); 143181256985SMatthew G. Knepley 1432d382aafbSBarry Smith /* 1433d382aafbSBarry Smith Routines that get memory usage information from the OS 1434d382aafbSBarry Smith */ 1435014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *); 1436014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *); 1437014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void); 1438b44d5720SBarry Smith PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]); 1439d382aafbSBarry Smith 1440014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal); 1441d382aafbSBarry Smith 1442d382aafbSBarry Smith /* 1443d382aafbSBarry Smith Initialization of PETSc 1444d382aafbSBarry Smith */ 1445014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]); 1446014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]); 1447014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void); 1448014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *); 1449014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *); 1450014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFinalize(void); 1451014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void); 1452014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***); 1453014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***); 1454014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **); 1455d382aafbSBarry Smith 1456014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscEnd(void); 1457607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void); 1458d382aafbSBarry Smith 1459014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]); 1460014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void); 1461014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void); 1462014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]); 1463d382aafbSBarry Smith 1464a50e088cSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscMonitorCompare(PetscErrorCode (*)(void),void *,PetscErrorCode (*)(void**),PetscErrorCode (*)(void),void *,PetscErrorCode (*)(void**),PetscBool *); 1465a50e088cSMatthew G. Knepley 1466d382aafbSBarry Smith /* 1467d382aafbSBarry Smith These are so that in extern C code we can caste function pointers to non-extern C 14682981ebdbSBarry Smith function pointers. Since the regular C++ code expects its function pointers to be C++ 1469d382aafbSBarry Smith */ 1470638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void); 1471638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void); 1472638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void); 1473d382aafbSBarry Smith 1474d382aafbSBarry Smith /* 1475d382aafbSBarry Smith Functions that can act on any PETSc object. 1476d382aafbSBarry Smith */ 1477014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject*); 1478014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject,MPI_Comm *); 1479014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject,PetscClassId *); 1480014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject,const char *[]); 1481014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetType(PetscObject,const char []); 1482014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject,const char *[]); 1483014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject,const char[]); 1484014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject,const char*[]); 1485014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject,PetscInt); 1486014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject,PetscInt*); 1487014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt); 1488014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject); 1489014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject,PetscInt*); 1490014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject); 1491014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject,PetscMPIInt*); 1492014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject,const char[],PetscObject); 1493014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject,const char[]); 1494014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject,const char[],PetscObject*); 1495bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject,const char[],void (*)(void)); 1496bdf89e91SBarry Smith #define PetscObjectComposeFunction(a,b,d) PetscObjectComposeFunction_Private(a,b,(PetscVoidFunction)(d)) 1497014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject); 1498014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject); 14990eb63584SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSetPrintedOptions(PetscObject); 15000eb63584SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectInheritPrintedOptions(PetscObject,PetscObject); 1501014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm,PetscMPIInt*); 1502d382aafbSBarry Smith 1503665c2dedSJed Brown #include <petscviewertypes.h> 1504639ff905SBarry Smith #include <petscoptions.h> 1505639ff905SBarry Smith 1506608c71bfSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscMallocTraceSet(PetscViewer,PetscBool,PetscLogDouble); 1507608c71bfSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscMallocTraceGet(PetscBool*); 1508608c71bfSMatthew G. Knepley 15090633abcbSJed Brown PETSC_EXTERN PetscErrorCode PetscObjectsListGetGlobalNumbering(MPI_Comm,PetscInt,PetscObject*,PetscInt*,PetscInt*); 15100633abcbSJed Brown 1511c5e4d11fSDmitry Karpeev PETSC_EXTERN PetscErrorCode PetscMemoryView(PetscViewer,const char[]); 1512dae58748SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject,PetscViewer); 1513639ff905SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject,PetscViewer); 15140005d66cSJed Brown #define PetscObjectQueryFunction(obj,name,fptr) PetscObjectQueryFunction_Private((obj),(name),(PetscVoidFunction*)(fptr)) 15150005d66cSJed Brown PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject,const char[],void (**)(void)); 1516014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject,const char[]); 1517014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject,const char[]); 1518014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject,const char[]); 1519014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject,const char*[]); 1520014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject,const char[]); 1521014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject); 1522014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void); 1523685405a1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject,PetscObject,const char[]); 1524014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject); 1525014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject,const char[],PetscBool *); 15264099cc6bSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompare(PetscObject,const char[],PetscBool *); 1527014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject,PetscBool*,const char[],...); 1528b9e7e5c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompareAny(PetscObject,PetscBool*,const char[],...); 1529014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void)); 1530014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void); 1531d382aafbSBarry Smith 1532e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 15337aab2a10SBarry Smith PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void); 1534e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject); 1535e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject,PetscBool); 1536e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject); 1537e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject); 1538e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject); 1539e04113cfSBarry Smith PETSC_EXTERN void PetscStackSAWsGrantAccess(void); 1540e04113cfSBarry Smith PETSC_EXTERN void PetscStackSAWsTakeAccess(void); 1541e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void); 1542e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void); 154315681b3cSBarry Smith 1544ec7429eaSBarry Smith #else 15457aab2a10SBarry Smith #define PetscSAWsBlock() 0 1546e04113cfSBarry Smith #define PetscObjectSAWsViewOff(obj) 0 1547e04113cfSBarry Smith #define PetscObjectSAWsSetBlock(obj,flg) 0 1548e04113cfSBarry Smith #define PetscObjectSAWsBlock(obj) 0 1549e04113cfSBarry Smith #define PetscObjectSAWsGrantAccess(obj) 0 1550e04113cfSBarry Smith #define PetscObjectSAWsTakeAccess(obj) 0 1551e04113cfSBarry Smith #define PetscStackViewSAWs() 0 1552e04113cfSBarry Smith #define PetscStackSAWsViewOff() 0 1553e04113cfSBarry Smith #define PetscStackSAWsTakeAccess() 1554e04113cfSBarry Smith #define PetscStackSAWsGrantAccess() 155515681b3cSBarry Smith 1556ec7429eaSBarry Smith #endif 1557b90c6cbeSBarry Smith 155882b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *); 155982b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *); 156082b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **); 1561258ec3d2SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscDLAddr(void (*)(void), char **); 1562258ec3d2SMatthew G. Knepley #ifdef PETSC_HAVE_CXX 1563258ec3d2SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscDemangleSymbol(const char *, char **); 1564258ec3d2SMatthew G. Knepley #endif 15657d5d4d99SBarry Smith 15665fe58b6fSBarry Smith #if defined(PETSC_USE_DEBUG) 1567a64a8e02SBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**); 15685fe58b6fSBarry Smith #endif 15697eb1d149SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool); 1570a64a8e02SBarry Smith 1571140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList*); 1572140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList,const char[],PetscObject*); 1573140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList,PetscObject,char**,PetscBool*); 1574140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *,const char[],PetscObject); 1575140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *,const char[]); 1576140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList,PetscObjectList *); 1577d382aafbSBarry Smith 1578d382aafbSBarry Smith /* 1579503cfb0cSBarry Smith Dynamic library lists. Lists of names of routines in objects or in dynamic 1580d382aafbSBarry Smith link libraries that will be loaded as needed. 1581d382aafbSBarry Smith */ 1582a240a19fSJed Brown 1583a240a19fSJed Brown #define PetscFunctionListAdd(list,name,fptr) PetscFunctionListAdd_Private((list),(name),(PetscVoidFunction)(fptr)) 1584a240a19fSJed Brown PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList*,const char[],void (*)(void)); 1585140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList*); 15861c9cd337SJed Brown #define PetscFunctionListFind(list,name,fptr) PetscFunctionListFind_Private((list),(name),(PetscVoidFunction*)(fptr)) 15871c9cd337SJed Brown PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList,const char[],void (**)(void)); 158844ef3d73SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFunctionList,const char[],const char[]); 1589140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList,PetscFunctionList *); 1590140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList,PetscViewer); 1591140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList,const char ***,int*); 1592d382aafbSBarry Smith 1593014dd563SJed Brown PETSC_EXTERN PetscDLLibrary PetscDLLibrariesLoaded; 1594014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]); 1595014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]); 1596014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **); 1597014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary); 1598014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool *); 1599014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *); 1600014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary); 1601d382aafbSBarry Smith 1602d382aafbSBarry Smith /* 1603d382aafbSBarry Smith Useful utility routines 1604d382aafbSBarry Smith */ 1605014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*); 1606014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*); 1607d24d4204SJose E. Roman PETSC_EXTERN PetscErrorCode PetscSplitOwnershipEqual(MPI_Comm,PetscInt*,PetscInt*); 1608014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt); 1609014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt); 1610014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject); 1611014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*); 1612dd438433SSatish Balay PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxInt(MPI_Comm,PetscInt[2],PetscInt[2]); 1613dd438433SSatish Balay PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxReal(MPI_Comm,PetscReal[2],PetscReal[2]); 1614d382aafbSBarry Smith 161564ac3b0dSPatrick Sanan /*MC 1616ace3abfcSBarry Smith PetscNot - negates a logical type value and returns result as a PetscBool 1617503cfb0cSBarry Smith 1618e28ce29aSPatrick Sanan Notes: 1619e28ce29aSPatrick Sanan This is useful in cases like 1620503cfb0cSBarry Smith $ int *a; 1621ace3abfcSBarry Smith $ PetscBool flag = PetscNot(a) 16221cc8b206SBarry Smith where !a would not return a PetscBool because we cannot provide a cast from int to PetscBool in C. 162364ac3b0dSPatrick Sanan 162464ac3b0dSPatrick Sanan Level: beginner 162564ac3b0dSPatrick Sanan 162664ac3b0dSPatrick Sanan .seealso : PetscBool, PETSC_TRUE, PETSC_FALSE 162764ac3b0dSPatrick Sanan M*/ 1628d382aafbSBarry Smith #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE) 1629503cfb0cSBarry Smith 1630d382aafbSBarry Smith /*MC 1631d382aafbSBarry Smith PetscHelpPrintf - Prints help messages. 1632d382aafbSBarry Smith 1633d382aafbSBarry Smith Synopsis: 1634aaa7dc30SBarry Smith #include <petscsys.h> 1635659f7ba0SBarry Smith PetscErrorCode (*PetscHelpPrintf)(MPI_Comm comm, const char format[],args); 1636d382aafbSBarry Smith 1637659f7ba0SBarry Smith Collective on comm 1638eca87e8dSBarry Smith 1639d382aafbSBarry Smith Input Parameters: 1640659f7ba0SBarry Smith + comm - the MPI communicator over which the help message is printed 1641d382aafbSBarry Smith . format - the usual printf() format string 1642659f7ba0SBarry Smith - args - arguments to be printed 1643d382aafbSBarry Smith 1644d382aafbSBarry Smith Level: developer 1645d382aafbSBarry Smith 1646d382aafbSBarry Smith Fortran Note: 1647d382aafbSBarry Smith This routine is not supported in Fortran. 1648d382aafbSBarry Smith 1649659f7ba0SBarry Smith Note: 1650659f7ba0SBarry Smith You can change how help messages are printed by replacing the function pointer with a function that does not simply write to stdout. 1651659f7ba0SBarry Smith 1652659f7ba0SBarry Smith To use, write your own function, for example, 1653659f7ba0SBarry Smith $PetscErrorCode mypetschelpprintf(MPI_Comm comm,const char format[],....) 1654659f7ba0SBarry Smith ${ 1655659f7ba0SBarry Smith $ PetscFunctionReturn(0); 1656659f7ba0SBarry Smith $} 1657659f7ba0SBarry Smith then do the assigment 1658659f7ba0SBarry Smith $ PetscHelpPrintf = mypetschelpprintf; 1659659f7ba0SBarry Smith You can do the assignment before PetscInitialize(). 1660659f7ba0SBarry Smith 1661659f7ba0SBarry Smith The default routine used is called PetscHelpPrintfDefault(). 1662d382aafbSBarry Smith 1663d382aafbSBarry Smith .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf() 1664d382aafbSBarry Smith M*/ 1665014dd563SJed Brown PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...); 1666d382aafbSBarry Smith 1667fcfd50ebSBarry Smith /* 1668fcfd50ebSBarry Smith Defines PETSc profiling. 1669fcfd50ebSBarry Smith */ 16702c8e378dSBarry Smith #include <petsclog.h> 1671fcfd50ebSBarry Smith 1672fcfd50ebSBarry Smith /* 1673fcfd50ebSBarry Smith Simple PETSc parallel IO for ASCII printing 1674fcfd50ebSBarry Smith */ 1675014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]); 1676014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**); 1677014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*); 1678014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...); 1679014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...); 1680014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...); 1681014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...); 16821b5687a1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFormatRealArray(char[],size_t,const char*,PetscInt,const PetscReal[]); 1683fcfd50ebSBarry Smith 1684014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...); 1685014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...); 1686014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...); 1687d382aafbSBarry Smith 1688d781fa04SBarry Smith PETSC_EXTERN PetscErrorCode PetscFormatConvertGetSize(const char*,size_t*); 1689d781fa04SBarry Smith PETSC_EXTERN PetscErrorCode PetscFormatConvert(const char*,char *); 1690d781fa04SBarry Smith 1691d382aafbSBarry Smith #if defined(PETSC_HAVE_POPEN) 1692014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **); 1693016831caSBarry Smith PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm,FILE*); 169474ba8654SBarry Smith PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]); 1695d382aafbSBarry Smith #endif 1696d382aafbSBarry Smith 1697014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm,const char[],...); 1698014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...); 16990ec8b6e3SBarry Smith PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm,FILE*); 1700014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]); 1701014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**); 1702014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm,const char[],const char[],FILE**); 1703014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char*[]); 1704d382aafbSBarry Smith 1705014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID; 1706014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer,void**); 1707014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer,void*); 1708014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer*); 1709014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm,PetscContainer*); 1710014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer,PetscErrorCode (*)(void*)); 1711b61ba218SStefano Zampini PETSC_EXTERN PetscErrorCode PetscContainerUserDestroyDefault(void*); 1712d382aafbSBarry Smith 1713d382aafbSBarry Smith /* 1714d382aafbSBarry Smith For use in debuggers 1715d382aafbSBarry Smith */ 1716014dd563SJed Brown PETSC_EXTERN PetscMPIInt PetscGlobalRank; 1717014dd563SJed Brown PETSC_EXTERN PetscMPIInt PetscGlobalSize; 1718014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt,const PetscInt[],PetscViewer); 1719014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt,const PetscReal[],PetscViewer); 1720014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt,const PetscScalar[],PetscViewer); 1721d382aafbSBarry Smith 1722a663daf8SBarry Smith #include <stddef.h> 1723a3aaec0aSJed Brown #include <string.h> /* for memcpy, memset */ 1724d382aafbSBarry Smith #include <stdlib.h> 17256c7e564aSBarry Smith 17264a92a979SJed Brown #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__) 1727d382aafbSBarry Smith #include <xmmintrin.h> 1728d382aafbSBarry Smith #endif 1729d382aafbSBarry Smith 1730d382aafbSBarry Smith /*@C 1731580bdb30SBarry Smith PetscMemmove - Copies n bytes, beginning at location b, to the space 1732580bdb30SBarry Smith beginning at location a. Copying between regions that overlap will 1733580bdb30SBarry Smith take place correctly. Use PetscMemcpy() if the locations do not overlap 1734580bdb30SBarry Smith 1735580bdb30SBarry Smith Not Collective 1736580bdb30SBarry Smith 1737580bdb30SBarry Smith Input Parameters: 1738580bdb30SBarry Smith + b - pointer to initial memory space 1739580bdb30SBarry Smith . a - pointer to copy space 1740580bdb30SBarry Smith - n - length (in bytes) of space to copy 1741580bdb30SBarry Smith 1742580bdb30SBarry Smith Level: intermediate 1743580bdb30SBarry Smith 1744580bdb30SBarry Smith Note: 1745857a15f1SBarry Smith PetscArraymove() is preferred 1746580bdb30SBarry Smith This routine is analogous to memmove(). 1747580bdb30SBarry Smith 1748580bdb30SBarry Smith Developers Note: This is inlined for performance 1749580bdb30SBarry Smith 1750580bdb30SBarry Smith .seealso: PetscMemcpy(), PetscMemcmp(), PetscArrayzero(), PetscMemzero(), PetscArraycmp(), PetscArraycpy(), PetscStrallocpy(), 1751580bdb30SBarry Smith PetscArraymove() 1752580bdb30SBarry Smith @*/ 1753580bdb30SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscMemmove(void *a,const void *b,size_t n) 1754580bdb30SBarry Smith { 1755580bdb30SBarry Smith PetscFunctionBegin; 1756580bdb30SBarry Smith if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to null pointer"); 1757580bdb30SBarry Smith if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer"); 1758580bdb30SBarry Smith #if !defined(PETSC_HAVE_MEMMOVE) 1759580bdb30SBarry Smith if (a < b) { 1760580bdb30SBarry Smith if (a <= b - n) memcpy(a,b,n); 1761580bdb30SBarry Smith else { 1762580bdb30SBarry Smith memcpy(a,b,(int)(b - a)); 1763580bdb30SBarry Smith PetscMemmove(b,b + (int)(b - a),n - (int)(b - a)); 1764580bdb30SBarry Smith } 1765580bdb30SBarry Smith } else { 1766580bdb30SBarry Smith if (b <= a - n) memcpy(a,b,n); 1767580bdb30SBarry Smith else { 1768580bdb30SBarry Smith memcpy(b + n,b + (n - (int)(a - b)),(int)(a - b)); 1769580bdb30SBarry Smith PetscMemmove(a,b,n - (int)(a - b)); 1770580bdb30SBarry Smith } 1771580bdb30SBarry Smith } 1772580bdb30SBarry Smith #else 1773580bdb30SBarry Smith memmove((char*)(a),(char*)(b),n); 1774580bdb30SBarry Smith #endif 1775580bdb30SBarry Smith PetscFunctionReturn(0); 1776580bdb30SBarry Smith } 1777580bdb30SBarry Smith 1778d382aafbSBarry Smith /*@C 1779d382aafbSBarry Smith PetscMemcpy - Copies n bytes, beginning at location b, to the space 1780d382aafbSBarry Smith beginning at location a. The two memory regions CANNOT overlap, use 1781d382aafbSBarry Smith PetscMemmove() in that case. 1782d382aafbSBarry Smith 1783d382aafbSBarry Smith Not Collective 1784d382aafbSBarry Smith 1785d382aafbSBarry Smith Input Parameters: 1786d382aafbSBarry Smith + b - pointer to initial memory space 1787d382aafbSBarry Smith - n - length (in bytes) of space to copy 1788d382aafbSBarry Smith 1789d382aafbSBarry Smith Output Parameter: 1790d382aafbSBarry Smith . a - pointer to copy space 1791d382aafbSBarry Smith 1792d382aafbSBarry Smith Level: intermediate 1793d382aafbSBarry Smith 1794d382aafbSBarry Smith Compile Option: 1795d382aafbSBarry Smith PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used 1796d382aafbSBarry Smith for memory copies on double precision values. 1797d382aafbSBarry Smith PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used 1798d382aafbSBarry Smith for memory copies on double precision values. 1799d382aafbSBarry Smith PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used 1800d382aafbSBarry Smith for memory copies on double precision values. 1801d382aafbSBarry Smith 1802d382aafbSBarry Smith Note: 1803580bdb30SBarry Smith Prefer PetscArraycpy() 1804d382aafbSBarry Smith This routine is analogous to memcpy(). 18051fd49c25SBarry Smith Not available from Fortran 18061fd49c25SBarry Smith 1807f5f57ec0SBarry Smith Developer Note: this is inlined for fastest performance 1808f5f57ec0SBarry Smith 1809580bdb30SBarry Smith .seealso: PetscMemzero(), PetscMemcmp(), PetscArrayzero(), PetscArraycmp(), PetscArraycpy(), PetscMemmove(), PetscStrallocpy() 1810d382aafbSBarry Smith 1811d382aafbSBarry Smith @*/ 18127087cfbeSBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscMemcpy(void *a,const void *b,size_t n) 1813d382aafbSBarry Smith { 1814d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG) 1815c5e4d11fSDmitry Karpeev size_t al = (size_t) a,bl = (size_t) b; 1816c5e4d11fSDmitry Karpeev size_t nl = (size_t) n; 1817a7e36092SMatthew G Knepley PetscFunctionBegin; 1818e32f2f54SBarry Smith if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer"); 1819e32f2f54SBarry Smith if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer"); 1820a7e36092SMatthew G Knepley #else 1821d382aafbSBarry Smith PetscFunctionBegin; 1822a7e36092SMatthew G Knepley #endif 1823a47a537aSLisandro Dalcin if (a != b && n > 0) { 1824d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG) 1825e47d2de2SBarry 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\ 1826d382aafbSBarry Smith or make sure your copy regions and lengths are correct. \n\ 1827d382aafbSBarry Smith Length (bytes) %ld first address %ld second address %ld",nl,al,bl); 1828d382aafbSBarry Smith #endif 1829d382aafbSBarry Smith #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY)) 1830c5e4d11fSDmitry Karpeev if (!(a % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1831d382aafbSBarry Smith size_t len = n/sizeof(PetscScalar); 1832d382aafbSBarry Smith #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) 1833c5df96a5SBarry Smith PetscBLASInt one = 1,blen; 1834c5df96a5SBarry Smith PetscErrorCode ierr; 1835c5df96a5SBarry Smith ierr = PetscBLASIntCast(len,&blen);CHKERRQ(ierr); 18368b83055fSJed Brown PetscStackCallBLAS("BLAScopy",BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one)); 1837d382aafbSBarry Smith #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY) 1838d382aafbSBarry Smith fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a); 1839d382aafbSBarry Smith #else 1840d382aafbSBarry Smith size_t i; 1841d382aafbSBarry Smith PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a; 1842d382aafbSBarry Smith for (i=0; i<len; i++) y[i] = x[i]; 1843d382aafbSBarry Smith #endif 1844d382aafbSBarry Smith } else { 1845d382aafbSBarry Smith memcpy((char*)(a),(char*)(b),n); 1846d382aafbSBarry Smith } 1847d382aafbSBarry Smith #else 1848d382aafbSBarry Smith memcpy((char*)(a),(char*)(b),n); 1849d382aafbSBarry Smith #endif 1850d382aafbSBarry Smith } 1851d382aafbSBarry Smith PetscFunctionReturn(0); 1852d382aafbSBarry Smith } 1853d382aafbSBarry Smith 1854d382aafbSBarry Smith /*@C 1855d382aafbSBarry Smith PetscMemzero - Zeros the specified memory. 1856d382aafbSBarry Smith 1857d382aafbSBarry Smith Not Collective 1858d382aafbSBarry Smith 1859d382aafbSBarry Smith Input Parameters: 1860d382aafbSBarry Smith + a - pointer to beginning memory location 1861d382aafbSBarry Smith - n - length (in bytes) of memory to initialize 1862d382aafbSBarry Smith 1863d382aafbSBarry Smith Level: intermediate 1864d382aafbSBarry Smith 1865d382aafbSBarry Smith Compile Option: 1866d382aafbSBarry Smith PETSC_PREFER_BZERO - on certain machines (the IBM RS6000) the bzero() routine happens 1867d382aafbSBarry Smith to be faster than the memset() routine. This flag causes the bzero() routine to be used. 1868d382aafbSBarry Smith 18691fd49c25SBarry Smith Not available from Fortran 1870857a15f1SBarry Smith Prefer PetscArrayzero() 18711fd49c25SBarry Smith 1872503cfb0cSBarry Smith Developer Note: this is inlined for fastest performance 1873503cfb0cSBarry Smith 1874580bdb30SBarry Smith .seealso: PetscMemcpy(), PetscMemcmp(), PetscArrayzero(), PetscArraycmp(), PetscArraycpy(), PetscMemmove(), PetscStrallocpy() 1875d382aafbSBarry Smith @*/ 18767087cfbeSBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscMemzero(void *a,size_t n) 1877d382aafbSBarry Smith { 1878d382aafbSBarry Smith if (n > 0) { 1879d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG) 188018703db9SJunchao Zhang if (!a) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer with %zu bytes",n); 1881d382aafbSBarry Smith #endif 1882d382aafbSBarry Smith #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) 1883d382aafbSBarry Smith if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1884d382aafbSBarry Smith size_t i,len = n/sizeof(PetscScalar); 1885d382aafbSBarry Smith PetscScalar *x = (PetscScalar*)a; 1886d382aafbSBarry Smith for (i=0; i<len; i++) x[i] = 0.0; 1887d382aafbSBarry Smith } else { 1888d382aafbSBarry Smith #elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO) 1889d382aafbSBarry Smith if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1890d382aafbSBarry Smith PetscInt len = n/sizeof(PetscScalar); 1891d382aafbSBarry Smith fortranzero_(&len,(PetscScalar*)a); 1892d382aafbSBarry Smith } else { 1893d382aafbSBarry Smith #endif 1894d382aafbSBarry Smith #if defined(PETSC_PREFER_BZERO) 1895d382aafbSBarry Smith bzero((char *)a,n); 1896d382aafbSBarry Smith #else 1897d382aafbSBarry Smith memset((char*)a,0,n); 1898d382aafbSBarry Smith #endif 1899d382aafbSBarry Smith #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO) 1900d382aafbSBarry Smith } 1901d382aafbSBarry Smith #endif 1902d382aafbSBarry Smith } 1903d382aafbSBarry Smith return 0; 1904d382aafbSBarry Smith } 1905d382aafbSBarry Smith 1906d382aafbSBarry Smith /*MC 1907580bdb30SBarry Smith PetscArraycmp - Compares two arrays in memory. 1908580bdb30SBarry Smith 1909580bdb30SBarry Smith Synopsis: 1910580bdb30SBarry Smith #include <petscsys.h> 1911580bdb30SBarry Smith PetscErrorCode PetscArraycmp(const anytype *str1,const anytype *str2,size_t cnt,PetscBool *e) 1912580bdb30SBarry Smith 1913580bdb30SBarry Smith Not Collective 1914580bdb30SBarry Smith 1915580bdb30SBarry Smith Input Parameters: 1916580bdb30SBarry Smith + str1 - First array 1917580bdb30SBarry Smith . str2 - Second array 1918580bdb30SBarry Smith - cnt - Count of the array, not in bytes, but number of entries in the arrays 1919580bdb30SBarry Smith 1920580bdb30SBarry Smith Output Parameters: 1921580bdb30SBarry Smith . e - PETSC_TRUE if equal else PETSC_FALSE. 1922580bdb30SBarry Smith 1923580bdb30SBarry Smith Level: intermediate 1924580bdb30SBarry Smith 1925580bdb30SBarry Smith Note: 1926857a15f1SBarry Smith This routine is a preferred replacement to PetscMemcmp() 1927580bdb30SBarry Smith The arrays must be of the same type 1928580bdb30SBarry Smith 1929580bdb30SBarry Smith .seealso: PetscMemcpy(), PetscMemcmp(), PetscArrayzero(), PetscMemzero(), PetscArraycpy(), PetscMemmove(), PetscStrallocpy(), 1930580bdb30SBarry Smith PetscArraymove() 1931580bdb30SBarry Smith M*/ 19329e2232c7SLisandro Dalcin #define PetscArraycmp(str1,str2,cnt,e) ((sizeof(*(str1)) != sizeof(*(str2))) || PetscMemcmp(str1,str2,(size_t)(cnt)*sizeof(*(str1)),e)) 1933580bdb30SBarry Smith 19348f8f2f0dSBarry Smith /*MC 1935580bdb30SBarry Smith PetscArraymove - Copies from one array in memory to another, the arrays may overlap. Use PetscArraycpy() when the arrays 1936580bdb30SBarry Smith do not overlap 1937580bdb30SBarry Smith 1938580bdb30SBarry Smith Synopsis: 1939580bdb30SBarry Smith #include <petscsys.h> 1940580bdb30SBarry Smith PetscErrorCode PetscArraymove(anytype *str1,const anytype *str2,size_t cnt) 1941580bdb30SBarry Smith 1942580bdb30SBarry Smith Not Collective 1943580bdb30SBarry Smith 1944580bdb30SBarry Smith Input Parameters: 1945580bdb30SBarry Smith + str1 - First array 1946580bdb30SBarry Smith . str2 - Second array 1947580bdb30SBarry Smith - cnt - Count of the array, not in bytes, but number of entries in the arrays 1948580bdb30SBarry Smith 1949580bdb30SBarry Smith Level: intermediate 1950580bdb30SBarry Smith 1951580bdb30SBarry Smith Note: 1952857a15f1SBarry Smith This routine is a preferred replacement to PetscMemmove() 1953580bdb30SBarry Smith The arrays must be of the same type 1954580bdb30SBarry Smith 1955580bdb30SBarry Smith .seealso: PetscMemcpy(), PetscMemcmp(), PetscArrayzero(), PetscMemzero(), PetscArraycpy(), PetscMemmove(), PetscArraycmp(), PetscStrallocpy() 1956580bdb30SBarry Smith M*/ 19579e2232c7SLisandro Dalcin #define PetscArraymove(str1,str2,cnt) ((sizeof(*(str1)) != sizeof(*(str2))) || PetscMemmove(str1,str2,(size_t)(cnt)*sizeof(*(str1)))) 1958580bdb30SBarry Smith 19598f8f2f0dSBarry Smith /*MC 1960580bdb30SBarry Smith PetscArraycpy - Copies from one array in memory to another 1961580bdb30SBarry Smith 1962580bdb30SBarry Smith Synopsis: 1963580bdb30SBarry Smith #include <petscsys.h> 1964580bdb30SBarry Smith PetscErrorCode PetscArraycpy(anytype *str1,const anytype *str2,size_t cnt) 1965580bdb30SBarry Smith 1966580bdb30SBarry Smith Not Collective 1967580bdb30SBarry Smith 1968580bdb30SBarry Smith Input Parameters: 1969de25709eSStefano Zampini + str1 - First array (destination) 1970de25709eSStefano Zampini . str2 - Second array (source) 1971580bdb30SBarry Smith - cnt - Count of the array, not in bytes, but number of entries in the arrays 1972580bdb30SBarry Smith 1973580bdb30SBarry Smith Level: intermediate 1974580bdb30SBarry Smith 1975580bdb30SBarry Smith Note: 1976857a15f1SBarry Smith This routine is a preferred replacement to PetscMemcpy() 1977580bdb30SBarry Smith The arrays must be of the same type 1978580bdb30SBarry Smith 1979580bdb30SBarry Smith .seealso: PetscMemcpy(), PetscMemcmp(), PetscArrayzero(), PetscMemzero(), PetscArraymove(), PetscMemmove(), PetscArraycmp(), PetscStrallocpy() 1980580bdb30SBarry Smith M*/ 19819e2232c7SLisandro Dalcin #define PetscArraycpy(str1,str2,cnt) ((sizeof(*(str1)) != sizeof(*(str2))) || PetscMemcpy(str1,str2,(size_t)(cnt)*sizeof(*(str1)))) 1982580bdb30SBarry Smith 19838f8f2f0dSBarry Smith /*MC 1984580bdb30SBarry Smith PetscArrayzero - Zeros an array in memory. 1985580bdb30SBarry Smith 1986580bdb30SBarry Smith Synopsis: 1987580bdb30SBarry Smith #include <petscsys.h> 1988580bdb30SBarry Smith PetscErrorCode PetscArrayzero(anytype *str1,size_t cnt) 1989580bdb30SBarry Smith 1990580bdb30SBarry Smith Not Collective 1991580bdb30SBarry Smith 1992580bdb30SBarry Smith Input Parameters: 1993580bdb30SBarry Smith + str1 - array 1994580bdb30SBarry Smith - cnt - Count of the array, not in bytes, but number of entries in the array 1995580bdb30SBarry Smith 1996580bdb30SBarry Smith Level: intermediate 1997580bdb30SBarry Smith 1998580bdb30SBarry Smith Note: 1999857a15f1SBarry Smith This routine is a preferred replacement to PetscMemzero() 2000580bdb30SBarry Smith 2001580bdb30SBarry Smith .seealso: PetscMemcpy(), PetscMemcmp(), PetscMemzero(), PetscArraycmp(), PetscArraycpy(), PetscMemmove(), PetscStrallocpy(), PetscArraymove() 2002580bdb30SBarry Smith M*/ 20039e2232c7SLisandro Dalcin #define PetscArrayzero(str1,cnt) PetscMemzero(str1,(size_t)(cnt)*sizeof(*(str1))) 2004580bdb30SBarry Smith 2005d382aafbSBarry Smith /*MC 2006d382aafbSBarry Smith PetscPrefetchBlock - Prefetches a block of memory 2007d382aafbSBarry Smith 2008eca87e8dSBarry Smith Synopsis: 2009aaa7dc30SBarry Smith #include <petscsys.h> 2010eca87e8dSBarry Smith void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t) 2011eca87e8dSBarry Smith 2012d382aafbSBarry Smith Not Collective 2013d382aafbSBarry Smith 2014d382aafbSBarry Smith Input Parameters: 2015d382aafbSBarry Smith + a - pointer to first element to fetch (any type but usually PetscInt or PetscScalar) 2016d382aafbSBarry Smith . n - number of elements to fetch 2017d382aafbSBarry Smith . rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors) 201850d8bf02SJed Brown - t - temporal locality (PETSC_PREFETCH_HINT_{NTA,T0,T1,T2}), see note 2019d382aafbSBarry Smith 2020d382aafbSBarry Smith Level: developer 2021d382aafbSBarry Smith 2022d382aafbSBarry Smith Notes: 2023d382aafbSBarry Smith The last two arguments (rw and t) must be compile-time constants. 2024d382aafbSBarry Smith 202550d8bf02SJed Brown Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality. Not all architectures offer 202650d8bf02SJed Brown equivalent locality hints, but the following macros are always defined to their closest analogue. 202750d8bf02SJed 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). 202863cf1ef0SJed 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. 202963cf1ef0SJed Brown . PETSC_PREFETCH_HINT_T1 - Fetch to level 2 and higher (not L1). 203063cf1ef0SJed Brown - PETSC_PREFETCH_HINT_T2 - Fetch to high-level cache only. (On many systems, T0 and T1 are equivalent.) 2031d382aafbSBarry Smith 2032d382aafbSBarry Smith This function does nothing on architectures that do not support prefetch and never errors (even if passed an invalid 2033d382aafbSBarry Smith address). 2034d382aafbSBarry Smith 2035d382aafbSBarry Smith M*/ 2036d382aafbSBarry Smith #define PetscPrefetchBlock(a,n,rw,t) do { \ 2037d382aafbSBarry Smith const char *_p = (const char*)(a),*_end = (const char*)((a)+(n)); \ 2038d382aafbSBarry Smith for (; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p,(rw),(t)); \ 2039d382aafbSBarry Smith } while (0) 2040d382aafbSBarry Smith 2041d382aafbSBarry Smith /* 2042d382aafbSBarry Smith Determine if some of the kernel computation routines use 2043d382aafbSBarry Smith Fortran (rather than C) for the numerical calculations. On some machines 2044d382aafbSBarry Smith and compilers (like complex numbers) the Fortran version of the routines 2045d382aafbSBarry Smith is faster than the C/C++ versions. The flag --with-fortran-kernels 2046e2e64c6bSBarry Smith should be used with ./configure to turn these on. 2047d382aafbSBarry Smith */ 2048d382aafbSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS) 2049d382aafbSBarry Smith 2050d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL) 2051d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTCRL 2052d382aafbSBarry Smith #endif 2053d382aafbSBarry Smith 20545a11e1b2SBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM) 20555a11e1b2SBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM 2056d382aafbSBarry Smith #endif 2057d382aafbSBarry Smith 2058d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ) 2059d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ 2060d382aafbSBarry Smith #endif 2061d382aafbSBarry Smith 2062d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ) 2063d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ 2064d382aafbSBarry Smith #endif 2065d382aafbSBarry Smith 2066d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM) 2067d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_NORM 2068d382aafbSBarry Smith #endif 2069d382aafbSBarry Smith 2070d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY) 2071d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MAXPY 2072d382aafbSBarry Smith #endif 2073d382aafbSBarry Smith 2074d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ) 2075d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ 2076d382aafbSBarry Smith #endif 2077d382aafbSBarry Smith 2078d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ) 2079d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ 2080d382aafbSBarry Smith #endif 2081d382aafbSBarry Smith 2082d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ) 2083d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ 2084d382aafbSBarry Smith #endif 2085d382aafbSBarry Smith 2086d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ) 2087d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ 2088d382aafbSBarry Smith #endif 2089d382aafbSBarry Smith 2090d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT) 2091d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MDOT 2092d382aafbSBarry Smith #endif 2093d382aafbSBarry Smith 2094d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY) 2095d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_XTIMESY 2096d382aafbSBarry Smith #endif 2097d382aafbSBarry Smith 2098d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX) 2099d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_AYPX 2100d382aafbSBarry Smith #endif 2101d382aafbSBarry Smith 2102d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY) 2103d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_WAXPY 2104d382aafbSBarry Smith #endif 2105d382aafbSBarry Smith 2106d382aafbSBarry Smith #endif 2107d382aafbSBarry Smith 2108d382aafbSBarry Smith /* 2109d382aafbSBarry Smith Macros for indicating code that should be compiled with a C interface, 2110d382aafbSBarry Smith rather than a C++ interface. Any routines that are dynamically loaded 2111d382aafbSBarry Smith (such as the PCCreate_XXX() routines) must be wrapped so that the name 2112d382aafbSBarry Smith mangler does not change the functions symbol name. This just hides the 2113d382aafbSBarry Smith ugly extern "C" {} wrappers. 2114d382aafbSBarry Smith */ 2115d382aafbSBarry Smith #if defined(__cplusplus) 2116d382aafbSBarry Smith # define EXTERN_C_BEGIN extern "C" { 2117d382aafbSBarry Smith # define EXTERN_C_END } 2118d382aafbSBarry Smith #else 2119d382aafbSBarry Smith # define EXTERN_C_BEGIN 2120d382aafbSBarry Smith # define EXTERN_C_END 2121d382aafbSBarry Smith #endif 2122d382aafbSBarry Smith 2123d382aafbSBarry Smith /* --------------------------------------------------------------------*/ 2124d382aafbSBarry Smith 2125d382aafbSBarry Smith /*MC 2126d382aafbSBarry Smith MPI_Comm - the basic object used by MPI to determine which processes are involved in a 2127d382aafbSBarry Smith communication 2128d382aafbSBarry Smith 2129d382aafbSBarry Smith Level: beginner 2130d382aafbSBarry Smith 2131d382aafbSBarry Smith Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm 2132d382aafbSBarry Smith 2133d382aafbSBarry Smith .seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF 2134d382aafbSBarry Smith M*/ 2135d382aafbSBarry Smith 2136d382aafbSBarry Smith #if defined(PETSC_HAVE_MPIIO) 2137014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); 2138014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); 2139c4e82887SLisandro Dalcin PETSC_EXTERN PetscErrorCode MPIU_File_write_at(MPI_File,MPI_Offset,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); 2140c4e82887SLisandro Dalcin PETSC_EXTERN PetscErrorCode MPIU_File_read_at(MPI_File,MPI_Offset,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); 2141c4e82887SLisandro Dalcin PETSC_EXTERN PetscErrorCode MPIU_File_write_at_all(MPI_File,MPI_Offset,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); 2142c4e82887SLisandro Dalcin PETSC_EXTERN PetscErrorCode MPIU_File_read_at_all(MPI_File,MPI_Offset,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); 2143d382aafbSBarry Smith #endif 2144d382aafbSBarry Smith 2145d382aafbSBarry Smith /* the following petsc_static_inline require petscerror.h */ 2146d382aafbSBarry Smith 2147d382aafbSBarry Smith /* Limit MPI to 32-bits */ 2148d382aafbSBarry Smith #define PETSC_MPI_INT_MAX 2147483647 2149d382aafbSBarry Smith #define PETSC_MPI_INT_MIN -2147483647 2150d382aafbSBarry Smith /* Limit BLAS to 32-bits */ 2151d382aafbSBarry Smith #define PETSC_BLAS_INT_MAX 2147483647 2152d382aafbSBarry Smith #define PETSC_BLAS_INT_MIN -2147483647 2153eee0c0a6SToby Isaac #define PETSC_CUBLAS_INT_MAX 2147483647 2154d382aafbSBarry Smith 215561b0d812SBarry Smith /*@C 2156c73702f5SBarry Smith PetscIntCast - casts a PetscInt64 (which is 64 bits in size) to a PetscInt (which may be 32 bits in size), generates an 2157c73702f5SBarry Smith error if the PetscInt is not large enough to hold the number. 2158c73702f5SBarry Smith 2159c73702f5SBarry Smith Not Collective 2160c73702f5SBarry Smith 2161c73702f5SBarry Smith Input Parameter: 2162c73702f5SBarry Smith . a - the PetscInt64 value 2163c73702f5SBarry Smith 2164c73702f5SBarry Smith Output Parameter: 2165c73702f5SBarry Smith . b - the resulting PetscInt value 2166c73702f5SBarry Smith 2167c73702f5SBarry Smith Level: advanced 2168c73702f5SBarry Smith 2169c73702f5SBarry Smith Notes: If integers needed for the applications are too large to fit in 32 bit ints you can ./configure using --with-64-bit-indices to make PetscInt use 64 bit ints 2170c73702f5SBarry Smith 2171c73702f5SBarry Smith Not available from Fortran 2172c73702f5SBarry Smith 217361778c46SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscMPIIntCast(), PetscBLASIntCast(), PetscIntMultError(), PetscIntSumError() 2174c73702f5SBarry Smith @*/ 2175c73702f5SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscIntCast(PetscInt64 a,PetscInt *b) 2176c73702f5SBarry Smith { 2177c73702f5SBarry Smith PetscFunctionBegin; 2178c73702f5SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES) 2179c73702f5SBarry Smith if ((a) > PETSC_MAX_INT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Integer too long for PetscInt, you may need to ./configure using --with-64-bit-indices"); 2180c73702f5SBarry Smith #endif 2181c73702f5SBarry Smith *b = (PetscInt)(a); 2182c73702f5SBarry Smith PetscFunctionReturn(0); 2183c73702f5SBarry Smith } 2184c73702f5SBarry Smith 2185c73702f5SBarry Smith /*@C 218661b0d812SBarry Smith PetscBLASIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscBLASInt (which may be 32 bits in size), generates an 218761b0d812SBarry Smith error if the PetscBLASInt is not large enough to hold the number. 218861b0d812SBarry Smith 218961b0d812SBarry Smith Not Collective 219061b0d812SBarry Smith 219161b0d812SBarry Smith Input Parameter: 219261b0d812SBarry Smith . a - the PetscInt value 219361b0d812SBarry Smith 219461b0d812SBarry Smith Output Parameter: 219561b0d812SBarry Smith . b - the resulting PetscBLASInt value 219661b0d812SBarry Smith 219761b0d812SBarry Smith Level: advanced 219861b0d812SBarry Smith 21990bc7d38cSBarry Smith Notes: 22001fd49c25SBarry Smith Not available from Fortran 2201f0b7f91aSBarry Smith Errors if the integer is negative since PETSc calls to BLAS/LAPACK never need to cast negative integer inputs 22021fd49c25SBarry Smith 2203c73702f5SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscMPIIntCast(), PetscIntCast() 220461b0d812SBarry Smith @*/ 2205c5df96a5SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscBLASIntCast(PetscInt a,PetscBLASInt *b) 2206c5df96a5SBarry Smith { 2207c5df96a5SBarry Smith PetscFunctionBegin; 2208c5df96a5SBarry Smith #if defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_HAVE_64BIT_BLAS_INDICES) 220973f49a0bSSatish Balay *b = 0; 221061778c46SBarry Smith if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array is too long for BLAS/LAPACK, which is restricted to 32 bit integers. Either you have an invalidly large integer error in your code or you must ./configure PETSc with -with-64-bit-blas-indices for the case you are running"); 2211c5df96a5SBarry Smith #endif 22120bc7d38cSBarry Smith if (a < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Passing negative integer to BLAS/LAPACK routine"); 2213c73702f5SBarry Smith *b = (PetscBLASInt)(a); 2214c5df96a5SBarry Smith PetscFunctionReturn(0); 2215c5df96a5SBarry Smith } 2216c5df96a5SBarry Smith 221761b0d812SBarry Smith /*@C 2218eee0c0a6SToby Isaac PetscCuBLASIntCast - like PetscBLASIntCast(), but for PetscCuBLASInt. 2219eee0c0a6SToby Isaac 2220eee0c0a6SToby Isaac Not Collective 2221eee0c0a6SToby Isaac 2222eee0c0a6SToby Isaac Input Parameter: 2223eee0c0a6SToby Isaac . a - the PetscInt value 2224eee0c0a6SToby Isaac 2225eee0c0a6SToby Isaac Output Parameter: 2226eee0c0a6SToby Isaac . b - the resulting PetscCuBLASInt value 2227eee0c0a6SToby Isaac 2228eee0c0a6SToby Isaac Level: advanced 2229eee0c0a6SToby Isaac 2230eee0c0a6SToby Isaac Notes: 2231eee0c0a6SToby Isaac Errors if the integer is negative since PETSc calls to cuBLAS and friends never need to cast negative integer inputs 2232eee0c0a6SToby Isaac 2233eee0c0a6SToby Isaac .seealso: PetscCuBLASInt, PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscMPIIntCast(), PetscIntCast() 2234eee0c0a6SToby Isaac @*/ 2235eee0c0a6SToby Isaac PETSC_STATIC_INLINE PetscErrorCode PetscCuBLASIntCast(PetscInt a,PetscBLASInt *b) 2236eee0c0a6SToby Isaac { 2237eee0c0a6SToby Isaac PetscFunctionBegin; 2238eee0c0a6SToby Isaac #if defined(PETSC_USE_64BIT_INDICES) 2239eee0c0a6SToby Isaac *b = 0; 2240eee0c0a6SToby Isaac if ((a) > PETSC_CUBLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array is too long for cuBLAS, which is restricted to 32 bit integers."); 2241eee0c0a6SToby Isaac #endif 2242eee0c0a6SToby Isaac if (a < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Passing negative integer to cuBLAS routine"); 2243eee0c0a6SToby Isaac *b = (PetscCuBLASInt)(a); 2244eee0c0a6SToby Isaac PetscFunctionReturn(0); 2245eee0c0a6SToby Isaac } 2246eee0c0a6SToby Isaac 2247eee0c0a6SToby Isaac /*@C 224861b0d812SBarry Smith PetscMPIIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscMPIInt (which may be 32 bits in size), generates an 224961b0d812SBarry Smith error if the PetscMPIInt is not large enough to hold the number. 225061b0d812SBarry Smith 225161b0d812SBarry Smith Not Collective 225261b0d812SBarry Smith 225361b0d812SBarry Smith Input Parameter: 225461b0d812SBarry Smith . a - the PetscInt value 225561b0d812SBarry Smith 225661b0d812SBarry Smith Output Parameter: 225761b0d812SBarry Smith . b - the resulting PetscMPIInt value 225861b0d812SBarry Smith 225961b0d812SBarry Smith Level: advanced 226061b0d812SBarry Smith 22611fd49c25SBarry Smith Not available from Fortran 22621fd49c25SBarry Smith 2263c73702f5SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntCast() 226461b0d812SBarry Smith @*/ 22654dc2109aSBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscMPIIntCast(PetscInt a,PetscMPIInt *b) 22664dc2109aSBarry Smith { 22674dc2109aSBarry Smith PetscFunctionBegin; 22684dc2109aSBarry Smith #if defined(PETSC_USE_64BIT_INDICES) 226973f49a0bSSatish Balay *b = 0; 227061778c46SBarry Smith if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for MPI, which is restricted to 32 bit integers"); 22714dc2109aSBarry Smith #endif 2272c73702f5SBarry Smith *b = (PetscMPIInt)(a); 22734dc2109aSBarry Smith PetscFunctionReturn(0); 22744dc2109aSBarry Smith } 22754dc2109aSBarry Smith 2276bafee8b4SSatish Balay #define PetscInt64Mult(a,b) ((PetscInt64)(a))*((PetscInt64)(b)) 22772f18eb33SBarry Smith 22782f18eb33SBarry Smith /*@C 22792f18eb33SBarry Smith 22802f18eb33SBarry 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 22812f18eb33SBarry Smith 22822f18eb33SBarry Smith Not Collective 22832f18eb33SBarry Smith 22842f18eb33SBarry Smith Input Parameter: 22852f18eb33SBarry Smith + a - the PetscReal value 22862f18eb33SBarry Smith - b - the second value 22872f18eb33SBarry Smith 2288390e1bf2SBarry Smith Returns: 2289390e1bf2SBarry Smith the result as a PetscInt value 22902f18eb33SBarry Smith 2291bafee8b4SSatish Balay Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64 22922f18eb33SBarry Smith Use PetscIntMultTruncate() to compute the product of two positive PetscInt and truncate to fit a PetscInt 22932f18eb33SBarry 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 22942f18eb33SBarry Smith 2295e28ce29aSPatrick Sanan Developers Note: 2296e28ce29aSPatrick Sanan We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks. 22972f18eb33SBarry Smith 22982f18eb33SBarry Smith This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able. 22992f18eb33SBarry Smith 23001fd49c25SBarry Smith Not available from Fortran 23011fd49c25SBarry Smith 23022f18eb33SBarry Smith Level: advanced 23032f18eb33SBarry Smith 230461778c46SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult(), PetscIntMultError(), PetscIntSumError() 23052f18eb33SBarry Smith @*/ 23062f18eb33SBarry Smith PETSC_STATIC_INLINE PetscInt PetscRealIntMultTruncate(PetscReal a,PetscInt b) 23072f18eb33SBarry Smith { 2308bafee8b4SSatish Balay PetscInt64 r; 23092f18eb33SBarry Smith 2310bafee8b4SSatish Balay r = (PetscInt64) (a*(PetscReal)b); 23112f18eb33SBarry Smith if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100; 23122f18eb33SBarry Smith return (PetscInt) r; 23132f18eb33SBarry Smith } 23142f18eb33SBarry Smith 23152f18eb33SBarry Smith /*@C 23162f18eb33SBarry Smith 23172f18eb33SBarry Smith PetscIntMultTruncate - Computes the product of two positive PetscInt and truncates the value to slightly less than the maximal possible value 23182f18eb33SBarry Smith 23192f18eb33SBarry Smith Not Collective 23202f18eb33SBarry Smith 23212f18eb33SBarry Smith Input Parameter: 23222f18eb33SBarry Smith + a - the PetscInt value 23232f18eb33SBarry Smith - b - the second value 23242f18eb33SBarry Smith 2325390e1bf2SBarry Smith Returns: 2326390e1bf2SBarry Smith the result as a PetscInt value 23272f18eb33SBarry Smith 2328bafee8b4SSatish Balay Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64 23292f18eb33SBarry Smith Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt 23302f18eb33SBarry 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 23312f18eb33SBarry Smith 23321fd49c25SBarry Smith Not available from Fortran 23331fd49c25SBarry Smith 23342f18eb33SBarry Smith Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks. 23352f18eb33SBarry Smith 23362f18eb33SBarry Smith This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able. 23372f18eb33SBarry Smith 23382f18eb33SBarry Smith Level: advanced 23392f18eb33SBarry Smith 234061778c46SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult(), PetscIntMultError(), PetscIntSumError() 23412f18eb33SBarry Smith @*/ 23422f18eb33SBarry Smith PETSC_STATIC_INLINE PetscInt PetscIntMultTruncate(PetscInt a,PetscInt b) 23432f18eb33SBarry Smith { 2344bafee8b4SSatish Balay PetscInt64 r; 23452f18eb33SBarry Smith 2346bafee8b4SSatish Balay r = PetscInt64Mult(a,b); 23472f18eb33SBarry Smith if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100; 23482f18eb33SBarry Smith return (PetscInt) r; 23492f18eb33SBarry Smith } 23502f18eb33SBarry Smith 2351f91af8c7SBarry Smith /*@C 2352f91af8c7SBarry Smith 2353f91af8c7SBarry Smith PetscIntSumTruncate - Computes the sum of two positive PetscInt and truncates the value to slightly less than the maximal possible value 2354f91af8c7SBarry Smith 2355f91af8c7SBarry Smith Not Collective 2356f91af8c7SBarry Smith 2357f91af8c7SBarry Smith Input Parameter: 2358f91af8c7SBarry Smith + a - the PetscInt value 2359f91af8c7SBarry Smith - b - the second value 2360f91af8c7SBarry Smith 2361390e1bf2SBarry Smith Returns: 2362390e1bf2SBarry Smith the result as a PetscInt value 2363f91af8c7SBarry Smith 2364bafee8b4SSatish Balay Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64 2365f91af8c7SBarry Smith Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt 2366f91af8c7SBarry 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 2367f91af8c7SBarry Smith 2368f91af8c7SBarry Smith This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able. 2369f91af8c7SBarry Smith 2370f5f57ec0SBarry Smith Not available from Fortran 2371f5f57ec0SBarry Smith 2372f91af8c7SBarry Smith Level: advanced 2373f91af8c7SBarry Smith 237461778c46SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult(), PetscIntMultError() 2375f91af8c7SBarry Smith @*/ 2376f91af8c7SBarry Smith PETSC_STATIC_INLINE PetscInt PetscIntSumTruncate(PetscInt a,PetscInt b) 2377f91af8c7SBarry Smith { 2378bafee8b4SSatish Balay PetscInt64 r; 2379f91af8c7SBarry Smith 2380bafee8b4SSatish Balay r = ((PetscInt64)a) + ((PetscInt64)b); 2381f91af8c7SBarry Smith if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100; 2382f91af8c7SBarry Smith return (PetscInt) r; 2383f91af8c7SBarry Smith } 2384f91af8c7SBarry Smith 23852f18eb33SBarry Smith /*@C 23862f18eb33SBarry Smith 23872f18eb33SBarry Smith PetscIntMultError - Computes the product of two positive PetscInt and generates an error with overflow. 23882f18eb33SBarry Smith 23892f18eb33SBarry Smith Not Collective 23902f18eb33SBarry Smith 23912f18eb33SBarry Smith Input Parameter: 23922f18eb33SBarry Smith + a - the PetscInt value 23932f18eb33SBarry Smith - b - the second value 23942f18eb33SBarry Smith 23952f18eb33SBarry Smith Output Parameter:ma 2396390e1bf2SBarry 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 23972f18eb33SBarry Smith 2398bafee8b4SSatish Balay Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64 23992f18eb33SBarry Smith Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt 24002f18eb33SBarry Smith 2401f5f57ec0SBarry Smith Not available from Fortran 2402f5f57ec0SBarry Smith 2403220afb94SBarry Smith Developers Note: We currently assume that PetscInt addition does not overflow, this is obviously wrong but requires many more checks. 24042f18eb33SBarry Smith 24052f18eb33SBarry Smith Level: advanced 24062f18eb33SBarry Smith 2407220afb94SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntMult64(), PetscIntSumError() 24082f18eb33SBarry Smith @*/ 24092f18eb33SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscIntMultError(PetscInt a,PetscInt b,PetscInt *result) 24102f18eb33SBarry Smith { 2411bafee8b4SSatish Balay PetscInt64 r; 24122f18eb33SBarry Smith 24132f18eb33SBarry Smith PetscFunctionBegin; 2414bafee8b4SSatish Balay r = PetscInt64Mult(a,b); 24152f18eb33SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES) 241661778c46SBarry Smith if (r > PETSC_MAX_INT) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_SUP,"Product of two integers %d %d overflow, either you have an invalidly large integer error in your code or you must ./configure PETSc with --with-64-bit-indices for the case you are running",a,b); 24172f18eb33SBarry Smith #endif 2418f91af8c7SBarry Smith if (result) *result = (PetscInt) r; 2419f91af8c7SBarry Smith PetscFunctionReturn(0); 2420f91af8c7SBarry Smith } 2421f91af8c7SBarry Smith 2422f91af8c7SBarry Smith /*@C 2423f91af8c7SBarry Smith 2424fbfcfee5SBarry Smith PetscIntSumError - Computes the sum of two positive PetscInt and generates an error with overflow. 2425f91af8c7SBarry Smith 2426f91af8c7SBarry Smith Not Collective 2427f91af8c7SBarry Smith 2428f91af8c7SBarry Smith Input Parameter: 2429f91af8c7SBarry Smith + a - the PetscInt value 2430f91af8c7SBarry Smith - b - the second value 2431f91af8c7SBarry Smith 2432f91af8c7SBarry Smith Output Parameter:ma 2433390e1bf2SBarry 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 2434f91af8c7SBarry Smith 2435bafee8b4SSatish Balay Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64 2436f91af8c7SBarry Smith Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt 2437f91af8c7SBarry Smith 2438f5f57ec0SBarry Smith Not available from Fortran 2439f5f57ec0SBarry Smith 2440f91af8c7SBarry Smith Level: advanced 2441f91af8c7SBarry Smith 244261778c46SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult(), PetscIntMultError() 2443f91af8c7SBarry Smith @*/ 2444f91af8c7SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscIntSumError(PetscInt a,PetscInt b,PetscInt *result) 2445f91af8c7SBarry Smith { 2446bafee8b4SSatish Balay PetscInt64 r; 2447f91af8c7SBarry Smith 2448f91af8c7SBarry Smith PetscFunctionBegin; 2449bafee8b4SSatish Balay r = ((PetscInt64)a) + ((PetscInt64)b); 2450f91af8c7SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES) 245161778c46SBarry Smith if (r > PETSC_MAX_INT) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_SUP,"Sum of two integers %d %d overflow, either you have an invalidly large integer error in your code or you must ./configure PETSc with --with-64-bit-indices for the case you are running",a,b); 2452f91af8c7SBarry Smith #endif 2453f91af8c7SBarry Smith if (result) *result = (PetscInt) r; 24542f18eb33SBarry Smith PetscFunctionReturn(0); 24552f18eb33SBarry Smith } 2456c5df96a5SBarry Smith 2457d382aafbSBarry Smith /* 24582981ebdbSBarry Smith The IBM include files define hz, here we hide it so that it may be used as a regular user variable. 2459d382aafbSBarry Smith */ 2460d382aafbSBarry Smith #if defined(hz) 2461d382aafbSBarry Smith # undef hz 2462d382aafbSBarry Smith #endif 2463d382aafbSBarry Smith 246415a5570dSLisandro Dalcin #include <limits.h> 246515a5570dSLisandro Dalcin 246615a5570dSLisandro Dalcin /* The number of bits in a byte */ 246715a5570dSLisandro Dalcin 246815a5570dSLisandro Dalcin #define PETSC_BITS_PER_BYTE CHAR_BIT 246915a5570dSLisandro Dalcin 2470d382aafbSBarry Smith #if defined(PETSC_HAVE_SYS_TYPES_H) 2471d382aafbSBarry Smith # include <sys/types.h> 2472d382aafbSBarry Smith #endif 2473d382aafbSBarry Smith 2474d382aafbSBarry Smith /*MC 2475d382aafbSBarry Smith 247666d79e26SBarry 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++ 247766d79e26SBarry Smith and Fortran compilers when petscsys.h is included. 247866d79e26SBarry Smith 247966d79e26SBarry Smith The current PETSc version and the API for accessing it are defined in petscversion.h 248066d79e26SBarry Smith 248166d79e26SBarry 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) 248266d79e26SBarry Smith 248366d79e26SBarry 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 248466d79e26SBarry Smith where only a change in the major version number (x) indicates a change in the API. 248566d79e26SBarry Smith 248666d79e26SBarry 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 248766d79e26SBarry Smith 248866d79e26SBarry 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), 248966d79e26SBarry 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 249066d79e26SBarry Smith version number (x.y.z). 249166d79e26SBarry Smith 249266d79e26SBarry Smith PETSC_RELEASE_DATE is the date the x.y version was released (i.e. the version before any patch releases) 249366d79e26SBarry Smith 249466d79e26SBarry Smith PETSC_VERSION_DATE is the date the x.y.z version was released 249566d79e26SBarry Smith 249666d79e26SBarry Smith PETSC_VERSION_GIT is the last git commit to the repository given in the form vx.y.z-wwwww 249766d79e26SBarry Smith 249866d79e26SBarry Smith PETSC_VERSION_DATE_GIT is the date of the last git commit to the repository 249966d79e26SBarry Smith 250066d79e26SBarry Smith Level: intermediate 250166d79e26SBarry Smith 250266d79e26SBarry Smith PETSC_VERSION_() and PETSC_VERSION_PATCH are deprecated and will eventually be removed. For several releases PETSC_VERSION_PATCH is always 0 250366d79e26SBarry Smith 250466d79e26SBarry Smith M*/ 250566d79e26SBarry Smith 2506014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t); 2507014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t); 2508014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t); 2509014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t); 2510014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]); 2511014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t); 251227710113SBarry Smith PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t); 25135f309d01SBarry Smith PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt*,PetscInt*,PetscInt*,PetscInt*); 2514d382aafbSBarry Smith 25156a7c706bSVaclav Hapla PETSC_EXTERN PetscErrorCode PetscSortedInt(PetscInt,const PetscInt[],PetscBool*); 25166a7c706bSVaclav Hapla PETSC_EXTERN PetscErrorCode PetscSortedMPIInt(PetscInt,const PetscMPIInt[],PetscBool*); 25176a7c706bSVaclav Hapla PETSC_EXTERN PetscErrorCode PetscSortedReal(PetscInt,const PetscReal[],PetscBool*); 2518014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt,PetscInt[]); 2519ce605777SToby Isaac PETSC_EXTERN PetscErrorCode PetscSortReverseInt(PetscInt,PetscInt[]); 252022ab5688SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscSortedRemoveDupsInt(PetscInt*,PetscInt[]); 2521014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt*,PetscInt[]); 2522f1cab4e1SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscCheckDupsInt(PetscInt,const PetscInt[],PetscBool*); 252360e03357SMatthew G Knepley PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt*); 2524d2aeb606SJed Brown PETSC_EXTERN PetscErrorCode PetscFindMPIInt(PetscMPIInt, PetscInt, const PetscMPIInt[], PetscInt*); 2525014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]); 2526014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]); 2527014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]); 25286c2863d0SBarry Smith PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt,PetscInt[],PetscInt[],PetscInt[]); 252917d7d925SStefano Zampini PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt,PetscMPIInt[]); 253017d7d925SStefano Zampini PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt*,PetscMPIInt[]); 2531014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]); 25325569a785SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithIntArray(PetscMPIInt,PetscMPIInt[],PetscInt[]); 2533014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]); 253417df18f2SToby Isaac PETSC_EXTERN PetscErrorCode PetscSortIntWithDataArray(PetscInt,PetscInt[],void*,size_t,void*); 2535014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt,PetscReal[]); 253639f41f7fSStefano Zampini PETSC_EXTERN PetscErrorCode PetscSortRealWithArrayInt(PetscInt,PetscReal[],PetscInt[]); 2537014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]); 2538745b41b2SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt*,PetscReal[]); 253939f41f7fSStefano Zampini PETSC_EXTERN PetscErrorCode PetscFindReal(PetscReal,PetscInt,const PetscReal[],PetscReal,PetscInt*); 2540014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]); 2541014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]); 2542014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt,const PetscBool [],const PetscInt[],PetscInt*,PetscInt**,PetscInt**,PetscInt**,PetscInt**); 25436c2863d0SBarry Smith PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt,const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],PetscInt*,PetscInt**,PetscInt**); 25446c2863d0SBarry Smith PETSC_EXTERN PetscErrorCode PetscMergeIntArray(PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt*,PetscInt**); 2545e498c390SJed Brown PETSC_EXTERN PetscErrorCode PetscMergeMPIIntArray(PetscInt,const PetscMPIInt[],PetscInt,const PetscMPIInt[],PetscInt*,PetscMPIInt**); 2546ce605777SToby Isaac PETSC_EXTERN PetscErrorCode PetscParallelSortedInt(MPI_Comm, PetscInt, const PetscInt[], PetscBool *); 2547ce605777SToby Isaac 25484d3610e3SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PetscTimSort(PetscInt,void*,size_t,int(*)(const void*,const void*,void*),void*); 2549676f2a66SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PetscIntSortSemiOrdered(PetscInt,PetscInt[]); 2550676f2a66SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PetscMPIIntSortSemiOrdered(PetscInt,PetscMPIInt[]); 2551676f2a66SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PetscRealSortSemiOrdered(PetscInt,PetscReal[]); 25524d3610e3SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PetscTimSortWithArray(PetscInt,void*,size_t,void*,size_t,int(*)(const void*,const void*,void*),void*); 2553676f2a66SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PetscIntSortSemiOrderedWithArray(PetscInt,PetscInt[],PetscInt[]); 2554676f2a66SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PetscMPIIntSortSemiOrderedWithArray(PetscInt,PetscMPIInt[],PetscMPIInt[]); 2555676f2a66SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PetscRealSortSemiOrderedWithArrayInt(PetscInt,PetscReal[],PetscInt[]); 2556676f2a66SJacob Faibussowitsch 2557014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDisplay(void); 2558014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t); 2559d382aafbSBarry Smith 256076bdecfbSBarry Smith /*J 2561d382aafbSBarry Smith PetscRandomType - String with the name of a PETSc randomizer 2562d382aafbSBarry Smith 2563d382aafbSBarry Smith Level: beginner 2564d382aafbSBarry Smith 2565e28ce29aSPatrick Sanan Notes: 2566e28ce29aSPatrick Sanan To use SPRNG or RANDOM123 you must have ./configure PETSc 256725ccb61fSToby Isaac with the option --download-sprng or --download-random123 2568d382aafbSBarry Smith 25698f6c3df8SBarry Smith .seealso: PetscRandomSetType(), PetscRandom, PetscRandomCreate() 257076bdecfbSBarry Smith J*/ 257119fd82e9SBarry Smith typedef const char* PetscRandomType; 2572d382aafbSBarry Smith #define PETSCRAND "rand" 2573d382aafbSBarry Smith #define PETSCRAND48 "rand48" 2574d382aafbSBarry Smith #define PETSCSPRNG "sprng" 2575c5e4d11fSDmitry Karpeev #define PETSCRANDER48 "rander48" 257625ccb61fSToby Isaac #define PETSCRANDOM123 "random123" 2577808ba619SStefano Zampini #define PETSCCURAND "curand" 2578d382aafbSBarry Smith 2579d382aafbSBarry Smith /* Logging support */ 2580014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID; 2581d382aafbSBarry Smith 2582607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void); 2583d382aafbSBarry Smith 2584d382aafbSBarry Smith /* Dynamic creation and loading functions */ 2585140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList PetscRandomList; 2586d382aafbSBarry Smith 2587bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],PetscErrorCode (*)(PetscRandom)); 258819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom,PetscRandomType); 2589014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom); 259019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom,PetscRandomType*); 2591fe2efc57SMark PETSC_EXTERN PetscErrorCode PetscRandomViewFromOptions(PetscRandom,PetscObject,const char[]); 2592014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer); 2593d382aafbSBarry Smith 2594014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*); 2595014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*); 2596014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*); 2597808ba619SStefano Zampini PETSC_EXTERN PetscErrorCode PetscRandomGetValues(PetscRandom,PetscInt,PetscScalar*); 2598808ba619SStefano Zampini PETSC_EXTERN PetscErrorCode PetscRandomGetValuesReal(PetscRandom,PetscInt,PetscReal*); 2599014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*); 2600014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar); 2601014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long); 2602014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *); 2603014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom); 2604014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*); 2605d382aafbSBarry Smith 2606014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t); 2607014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t); 2608014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t); 2609014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]); 2610014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t); 2611014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *); 2612014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *); 261397540f07SSatish Balay PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]); 26148a10d460SHong Zhang PETSC_EXTERN PetscErrorCode PetscMkdtemp(char[]); 261597540f07SSatish Balay PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]); 2616d382aafbSBarry Smith 261730815ce0SLisandro Dalcin PETSC_STATIC_INLINE PetscBool PetscBinaryBigEndian(void) {long _petsc_v = 1; return ((char*)&_petsc_v)[0] ? PETSC_FALSE : PETSC_TRUE;} 261830815ce0SLisandro Dalcin 26199860990eSLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscInt*,PetscDataType); 26209860990eSLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscInt*,PetscDataType); 2621f253e43cSLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,const void*,PetscInt,PetscDataType); 2622f253e43cSLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,const void*,PetscInt,PetscDataType); 2623014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *); 2624014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryClose(int); 2625014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool *); 2626014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool *); 2627014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t); 2628014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *); 2629014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *); 2630c891a504SStefano Zampini #if defined(PETSC_USE_SOCKET_VIEWER) 2631e2fc02c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[],int,int*); 2632c891a504SStefano Zampini #endif 2633d382aafbSBarry Smith 2634014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*); 2635014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*); 2636014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt); 2637d382aafbSBarry Smith 2638014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]); 2639014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool); 2640014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void); 2641014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*); 2642014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void); 2643014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void); 26442a2a2941SBarry Smith PETSC_EXTERN PetscErrorCode PetscWaitOnError(void); 2645d382aafbSBarry Smith 2646014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*); 2647014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**); 2648014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**); 2649014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**); 2650014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**); 2651cf4b5b4fSJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt*,const void*,PetscMPIInt*,PetscMPIInt**,void*) 2652cf4b5b4fSJed Brown PetscAttrMPIPointerWithType(6,3); 2653d815da10SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedF(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt, 2654d815da10SJed Brown PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*), 2655d815da10SJed Brown PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx) 2656d815da10SJed Brown PetscAttrMPIPointerWithType(6,3); 26576afbe7ddSJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedFReq(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt, 26586afbe7ddSJed Brown MPI_Request**,MPI_Request**, 26596afbe7ddSJed Brown PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*), 26606afbe7ddSJed Brown PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx) 26616afbe7ddSJed Brown PetscAttrMPIPointerWithType(6,3); 2662d382aafbSBarry Smith 26636145cd65SJed Brown PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[]; 26646145cd65SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm,PetscBuildTwoSidedType); 26656145cd65SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm,PetscBuildTwoSidedType*); 26666145cd65SJed Brown 2667014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSSEIsEnabled(MPI_Comm,PetscBool*,PetscBool*); 2668d382aafbSBarry Smith 2669ce94432eSBarry Smith PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject); 2670ce94432eSBarry Smith 267145487dadSJed Brown PETSC_EXTERN const char *const PetscSubcommTypes[]; 267245487dadSJed Brown 2673d382aafbSBarry Smith struct _n_PetscSubcomm { 2674d382aafbSBarry Smith MPI_Comm parent; /* parent communicator */ 2675d382aafbSBarry Smith MPI_Comm dupparent; /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */ 2676306c2d5bSBarry Smith MPI_Comm child; /* the sub-communicator */ 267745487dadSJed Brown PetscMPIInt n; /* num of subcommunicators under the parent communicator */ 267845487dadSJed Brown PetscMPIInt color; /* color of processors belong to this communicator */ 2679708d824cSJed Brown PetscMPIInt *subsize; /* size of subcommunicator[color] */ 268045487dadSJed Brown PetscSubcommType type; 2681e5acf8a4SHong Zhang char *subcommprefix; 2682d382aafbSBarry Smith }; 2683d382aafbSBarry Smith 2684c5e4d11fSDmitry Karpeev PETSC_STATIC_INLINE MPI_Comm PetscSubcommParent(PetscSubcomm scomm) {return scomm->parent;} 2685306c2d5bSBarry Smith PETSC_STATIC_INLINE MPI_Comm PetscSubcommChild(PetscSubcomm scomm) {return scomm->child;} 268636be1a5eSBarry Smith PETSC_STATIC_INLINE MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm) {return scomm->dupparent;} 2687014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*); 2688014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*); 2689014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt); 2690014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType); 269165d9b8f1SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt); 2692053d1c95SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm,PetscViewer); 2693f68be91cSHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm); 2694e5acf8a4SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm,const char[]); 2695a530d236SBarry Smith PETSC_EXTERN PetscErrorCode PetscSubcommGetParent(PetscSubcomm,MPI_Comm*); 2696a530d236SBarry Smith PETSC_EXTERN PetscErrorCode PetscSubcommGetContiguousParent(PetscSubcomm,MPI_Comm*); 2697a530d236SBarry Smith PETSC_EXTERN PetscErrorCode PetscSubcommGetChild(PetscSubcomm,MPI_Comm*); 2698d382aafbSBarry Smith 26999962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapCreate(PetscInt,PetscHeap*); 27009962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapAdd(PetscHeap,PetscInt,PetscInt); 27019962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapPop(PetscHeap,PetscInt*,PetscInt*); 27029962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapPeek(PetscHeap,PetscInt*,PetscInt*); 27039962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapStash(PetscHeap,PetscInt,PetscInt); 27049962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapUnstash(PetscHeap); 27059962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapDestroy(PetscHeap*); 27069962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapView(PetscHeap,PetscViewer); 27079962606eSBarry Smith 27085e71baefSBarry Smith PETSC_EXTERN PetscErrorCode PetscProcessPlacementView(PetscViewer); 27095f7487a0SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscShmCommGet(MPI_Comm,PetscShmComm*); 27105f7487a0SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscShmCommGlobalToLocal(PetscShmComm,PetscMPIInt,PetscMPIInt*); 27115f7487a0SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscShmCommLocalToGlobal(PetscShmComm,PetscMPIInt,PetscMPIInt*); 27125f7487a0SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscShmCommGetMpiShmComm(PetscShmComm,MPI_Comm*); 27135e71baefSBarry Smith 2714a32e93adSJunchao Zhang /* routines to better support OpenMP multithreading needs of some PETSc third party libraries */ 2715a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlCreate(MPI_Comm,PetscInt,PetscOmpCtrl*); 2716a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlGetOmpComms(PetscOmpCtrl,MPI_Comm*,MPI_Comm*,PetscBool*); 2717a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlDestroy(PetscOmpCtrl*); 2718a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlBarrier(PetscOmpCtrl); 2719a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterBegin(PetscOmpCtrl); 2720a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterEnd(PetscOmpCtrl); 2721a32e93adSJunchao Zhang 272213e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t,size_t,PetscSegBuffer*); 27230f453b92SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer*); 272413e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer,size_t,void*); 2725137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer,void*); 2726137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer,void*); 2727137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer,void*); 272813e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer,size_t*); 272913e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer,size_t); 27300f453b92SJed Brown 2731471ecdacSJed Brown /* Type-safe wrapper to encourage use of PETSC_RESTRICT. Does not use PetscFunctionBegin because the error handling 2732471ecdacSJed Brown * prevents the compiler from completely erasing the stub. This is called in inner loops so it has to be as fast as 2733471ecdacSJed Brown * possible. */ 27346a11cab8SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg,size_t count,PetscInt *PETSC_RESTRICT *slot) {return PetscSegBufferGet(seg,count,(void**)slot);} 2735d382aafbSBarry Smith 27369de0f6ecSBarry Smith extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton; 27379de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted*); 27389de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted*); 27399de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted,const char*,const char*,PetscBool*); 27409de0f6ecSBarry Smith 2741ace2fbaeSBarry Smith #include <stdarg.h> 2742ace2fbaeSBarry Smith PETSC_EXTERN PetscErrorCode PetscVSNPrintf(char*,size_t,const char[],size_t*,va_list); 2743ace2fbaeSBarry Smith PETSC_EXTERN PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list); 2744ace2fbaeSBarry Smith 2745268b0dfdSSatish Balay PETSC_EXTERN PetscSegBuffer PetscCitationsList; 2746fbfcfee5SBarry Smith 27471f817a21SBarry Smith /*@C 27481f817a21SBarry Smith PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used in the code. 27491f817a21SBarry Smith 27501f817a21SBarry Smith Not Collective - only what is registered on rank 0 of PETSC_COMM_WORLD will be printed 27511f817a21SBarry Smith 27521f817a21SBarry Smith Input Parameters: 27531f817a21SBarry Smith + cite - the bibtex item, formated to displayed on multiple lines nicely 27541f817a21SBarry Smith - set - a boolean variable initially set to PETSC_FALSE; this is used to insure only a single registration of the citation 27551f817a21SBarry Smith 2756850545d0SSatish Balay Level: intermediate 2757850545d0SSatish Balay 2758f5f57ec0SBarry Smith Not available from Fortran 2759f5f57ec0SBarry Smith 27601f817a21SBarry Smith Options Database: 2761063414e0SPatrick Sanan . -citations [filename] - print out the bibtex entries for the given computation 27621f817a21SBarry Smith @*/ 2763dff31646SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscCitationsRegister(const char cit[],PetscBool *set) 2764dff31646SBarry Smith { 2765dff31646SBarry Smith size_t len; 2766dff31646SBarry Smith char *vstring; 2767dff31646SBarry Smith PetscErrorCode ierr; 2768dff31646SBarry Smith 27691f817a21SBarry Smith PetscFunctionBegin; 27708d3683fcSBarry Smith if (set && *set) PetscFunctionReturn(0); 2771dff31646SBarry Smith ierr = PetscStrlen(cit,&len);CHKERRQ(ierr); 277235005c2bSLisandro Dalcin ierr = PetscSegBufferGet(PetscCitationsList,len,&vstring);CHKERRQ(ierr); 2773580bdb30SBarry Smith ierr = PetscArraycpy(vstring,cit,len);CHKERRQ(ierr); 2774dff31646SBarry Smith if (set) *set = PETSC_TRUE; 27751f817a21SBarry Smith PetscFunctionReturn(0); 2776dff31646SBarry Smith } 2777dff31646SBarry Smith 2778b967cddfSBarry Smith PETSC_EXTERN PetscErrorCode PetscURLShorten(const char[],char[],size_t); 2779fe278a28SBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm,char[],char[],size_t); 2780fe278a28SBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm,const char[],char[],size_t); 2781f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm,const char[],const char []); 2782fe278a28SBarry Smith 2783f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm,char[],char[],size_t); 2784f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm,const char[],char[],char[],size_t); 2785b967cddfSBarry Smith 27869f4d3c52SBarry Smith PETSC_EXTERN PetscErrorCode PetscGlobusGetTransfers(MPI_Comm,const char[],char[],size_t); 27879f4d3c52SBarry Smith 278804102261SBarry Smith PETSC_EXTERN PetscErrorCode PetscTextBelt(MPI_Comm,const char[],const char[],PetscBool*); 2789763ec7b1SBarry Smith PETSC_EXTERN PetscErrorCode PetscTellMyCell(MPI_Comm,const char[],const char[],PetscBool*); 2790dff31646SBarry Smith 279168e69593SBarry Smith PETSC_EXTERN PetscErrorCode PetscPullJSONValue(const char[],const char[],char[],size_t,PetscBool*); 27925dc0f0a4SBarry Smith PETSC_EXTERN PetscErrorCode PetscPushJSONValue(char[],const char[],const char[],size_t); 2793d382aafbSBarry Smith 2794b2566f29SBarry Smith #if defined(PETSC_USE_DEBUG) 2795503e1a2cSLisandro Dalcin PETSC_STATIC_INLINE unsigned int PetscStrHash(const char *str) 2796df05ca09SBarry Smith { 2797df05ca09SBarry Smith unsigned int c,hash = 5381; 2798df05ca09SBarry Smith 2799503e1a2cSLisandro Dalcin while ((c = (unsigned int)*str++)) hash = ((hash << 5) + hash) + c; /* hash * 33 + c */ 2800df05ca09SBarry Smith return hash; 2801df05ca09SBarry Smith } 280277a5e07dSBarry Smith 280377a5e07dSBarry Smith /*MC 280477a5e07dSBarry Smith MPIU_Allreduce - a PETSc replacement for MPI_Allreduce() that tries to determine if the call from all the MPI processes occur from the 280577a5e07dSBarry Smith same place in the PETSc code. This helps to detect bugs where different MPI processes follow different code paths 280677a5e07dSBarry Smith resulting in inconsistent and incorrect calls to MPI_Allreduce(). 280777a5e07dSBarry Smith 2808d083f849SBarry Smith Collective 280977a5e07dSBarry Smith 281077a5e07dSBarry Smith Synopsis: 281177a5e07dSBarry Smith #include <petscsys.h> 281277a5e07dSBarry Smith PetscErrorCode MPIU_Allreduce(void *indata,void *outdata,PetscMPIInt count,MPI_Datatype datatype, MPI_Op op, MPI_Comm comm); 281377a5e07dSBarry Smith 281477a5e07dSBarry Smith Input Parameters: 2815df05ca09SBarry Smith + a - pointer to the input data to be reduced 2816df05ca09SBarry Smith . c - the number of MPI data items in a and b 2817df05ca09SBarry Smith . d - the MPI datatype, for example MPI_INT 2818df05ca09SBarry Smith . e - the MPI operation, for example MPI_SUM 2819df05ca09SBarry Smith - fcomm - the MPI communicator on which the operation occurs 282077a5e07dSBarry Smith 282177a5e07dSBarry Smith Output Parameter: 2822df05ca09SBarry Smith . b - the reduced values 282377a5e07dSBarry Smith 2824e28ce29aSPatrick Sanan Notes: 2825e28ce29aSPatrick Sanan In optimized mode this directly calls MPI_Allreduce() 282677a5e07dSBarry Smith 2827df05ca09SBarry Smith This is defined as a macro that can return error codes internally so it cannot be used in a subroutine that returns void. 2828df05ca09SBarry Smith 2829df05ca09SBarry Smith The error code this returns should be checked with CHKERRMPI() 2830df05ca09SBarry Smith 283177a5e07dSBarry Smith Level: developer 283277a5e07dSBarry Smith 283377a5e07dSBarry Smith .seealso: MPI_Allreduce() 283477a5e07dSBarry Smith M*/ 2835df05ca09SBarry Smith #define MPIU_Allreduce(a,b,c,d,e,fcomm) MPI_SUCCESS; do {\ 2836df05ca09SBarry Smith PetscErrorCode _4_ierr; \ 2837df05ca09SBarry Smith PetscMPIInt a_b1[6],a_b2[6];\ 2838df05ca09SBarry Smith a_b1[0] = -(PetscMPIInt)__LINE__; a_b1[1] = -a_b1[0];\ 2839df05ca09SBarry Smith a_b1[2] = -(PetscMPIInt)PetscStrHash(PETSC_FUNCTION_NAME); a_b1[3] = -a_b1[2];\ 2840df05ca09SBarry Smith a_b1[4] = -(PetscMPIInt)(c); a_b1[5] = -a_b1[4];\ 2841df05ca09SBarry Smith _4_ierr = MPI_Allreduce(a_b1,a_b2,6,MPI_INT,MPI_MAX,fcomm);CHKERRMPI(_4_ierr);\ 2842df05ca09SBarry Smith if (-a_b2[0] != a_b2[1]) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"MPI_Allreduce() called in different locations (code lines) on different processors");\ 2843df05ca09SBarry Smith if (-a_b2[2] != a_b2[3]) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"MPI_Allreduce() called in different locations (functions) on different processors");\ 2844df05ca09SBarry Smith if (-a_b2[4] != a_b2[5]) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"MPI_Allreduce() called with different counts %d on different processors",c);\ 2845df05ca09SBarry Smith _4_ierr = MPI_Allreduce((a),(b),(c),d,e,(fcomm));CHKERRMPI(_4_ierr);\ 2846df05ca09SBarry Smith } while (0) 2847b2566f29SBarry Smith #else 2848df05ca09SBarry Smith #define MPIU_Allreduce(a,b,c,d,e,fcomm) MPI_Allreduce((a),(b),(c),d,e,(fcomm)) 2849b2566f29SBarry Smith #endif 2850b2566f29SBarry Smith 2851b674149eSJunchao Zhang #if defined(PETSC_HAVE_MPI_PROCESS_SHARED_MEMORY) 28528198064fSBarry Smith PETSC_EXTERN PetscErrorCode MPIU_Win_allocate_shared(MPI_Aint,PetscMPIInt,MPI_Info,MPI_Comm,void*,MPI_Win*); 28538198064fSBarry Smith PETSC_EXTERN PetscErrorCode MPIU_Win_shared_query(MPI_Win,PetscMPIInt,MPI_Aint*,PetscMPIInt*,void*); 28542f065d89SBarry Smith #endif 28558198064fSBarry Smith 285612801b39SBarry Smith /* 285760fbe2beSVaclav Hapla List of external packages and queries on it 285860fbe2beSVaclav Hapla */ 285960fbe2beSVaclav Hapla PETSC_EXTERN PetscErrorCode PetscHasExternalPackage(const char[],PetscBool*); 286060fbe2beSVaclav Hapla 2861d382aafbSBarry Smith #endif 2862