1d382aafbSBarry Smith /* 2d382aafbSBarry Smith This is the main PETSc include file (for C and C++). It is included by all 3d382aafbSBarry Smith other PETSc include files, so it almost never has to be specifically included. 4d382aafbSBarry Smith */ 56c7e564aSBarry Smith #if !defined(__PETSCSYS_H) 66c7e564aSBarry Smith #define __PETSCSYS_H 7d382aafbSBarry Smith /* ========================================================================== */ 8d382aafbSBarry Smith /* 9d382aafbSBarry Smith petscconf.h is contained in ${PETSC_ARCH}/include/petscconf.h it is 101cc8b206SBarry Smith found automatically by the compiler due to the -I${PETSC_DIR}/${PETSC_ARCH}/include. 111cc8b206SBarry Smith For --prefix installs the ${PETSC_ARCH}/ does not exist and petscconf.h is in the same 121cc8b206SBarry Smith directory as the other PETSc include files. 13d382aafbSBarry Smith */ 142c8e378dSBarry Smith #include <petscconf.h> 152c8e378dSBarry Smith #include <petscfix.h> 16d382aafbSBarry Smith 1773fca5a0SBarry Smith #if defined(PETSC_DESIRE_FEATURE_TEST_MACROS) 1873fca5a0SBarry Smith /* 1973fca5a0SBarry Smith Feature test macros must be included before headers defined by IEEE Std 1003.1-2001 2073fca5a0SBarry Smith We only turn these in PETSc source files that require them by setting PETSC_DESIRE_FEATURE_TEST_MACROS 2173fca5a0SBarry Smith */ 22216f1ae6SBarry Smith # if defined(PETSC__POSIX_C_SOURCE_200112L) && !defined(_POSIX_C_SOURCE) 2373fca5a0SBarry Smith # define _POSIX_C_SOURCE 200112L 2473fca5a0SBarry Smith # endif 25216f1ae6SBarry Smith # if defined(PETSC__BSD_SOURCE) && !defined(_BSD_SOURCE) 2673fca5a0SBarry Smith # define _BSD_SOURCE 2773fca5a0SBarry Smith # endif 2807f00807SSatish Balay # if defined(PETSC__DEFAULT_SOURCE) && !defined(_DEFAULT_SOURCE) 2907f00807SSatish Balay # define _DEFAULT_SOURCE 3007f00807SSatish Balay # endif 31ea0fecefSShri Abhyankar # if defined(PETSC__GNU_SOURCE) && !defined(_GNU_SOURCE) 32ea0fecefSShri Abhyankar # define _GNU_SOURCE 33ea0fecefSShri Abhyankar # endif 3473fca5a0SBarry Smith #endif 3573fca5a0SBarry Smith 36df4397b0SStefano Zampini #include <petscsystypes.h> 37df4397b0SStefano Zampini 38d382aafbSBarry Smith /* ========================================================================== */ 39d382aafbSBarry Smith /* 402c280183SJed Brown This facilitates using the C version of PETSc from C++ and the C++ version from C. 41d382aafbSBarry Smith */ 421ec50b02SJed Brown #if defined(__cplusplus) 431ec50b02SJed Brown # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_CXX 441ec50b02SJed Brown #else 451ec50b02SJed Brown # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_C 461ec50b02SJed Brown #endif 47d382aafbSBarry Smith 48c5e4d11fSDmitry Karpeev /* ========================================================================== */ 49c5e4d11fSDmitry Karpeev /* 50c5e4d11fSDmitry Karpeev Since PETSc manages its own extern "C" handling users should never include PETSc include 511cc8b206SBarry Smith files within extern "C". This will generate a compiler error if a user does put the include 521cc8b206SBarry Smith file within an extern "C". 53c5e4d11fSDmitry Karpeev */ 54c5e4d11fSDmitry Karpeev #if defined(__cplusplus) 55c5e4d11fSDmitry Karpeev void assert_never_put_petsc_headers_inside_an_extern_c(int); void assert_never_put_petsc_headers_inside_an_extern_c(double); 56c5e4d11fSDmitry Karpeev #endif 57c5e4d11fSDmitry Karpeev 58ed938b00SJed Brown #if defined(__cplusplus) 59ed938b00SJed Brown # define PETSC_RESTRICT PETSC_CXX_RESTRICT 60ed938b00SJed Brown #else 61ed938b00SJed Brown # define PETSC_RESTRICT PETSC_C_RESTRICT 62ed938b00SJed Brown #endif 63ed938b00SJed Brown 64ed938b00SJed Brown #if defined(__cplusplus) 6558c433abSLisandro Dalcin # define PETSC_INLINE PETSC_CXX_INLINE 66ed938b00SJed Brown #else 6758c433abSLisandro Dalcin # define PETSC_INLINE PETSC_C_INLINE 68ed938b00SJed Brown #endif 69ed938b00SJed Brown 7058c433abSLisandro Dalcin #define PETSC_STATIC_INLINE static PETSC_INLINE 7158c433abSLisandro Dalcin 72ab699e31SSatish Balay #if defined(_WIN32) && defined(PETSC_USE_SHARED_LIBRARIES) /* For Win32 shared libraries */ 73014dd563SJed Brown # define PETSC_DLLEXPORT __declspec(dllexport) 74014dd563SJed Brown # define PETSC_DLLIMPORT __declspec(dllimport) 7521f66b81SJed Brown # define PETSC_VISIBILITY_INTERNAL 7626703958SBarry Smith #elif defined(PETSC_USE_VISIBILITY_CXX) && defined(__cplusplus) 7726703958SBarry Smith # define PETSC_DLLEXPORT __attribute__((visibility ("default"))) 7826703958SBarry Smith # define PETSC_DLLIMPORT __attribute__((visibility ("default"))) 7926703958SBarry Smith # define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden"))) 8026703958SBarry Smith #elif defined(PETSC_USE_VISIBILITY_C) && !defined(__cplusplus) 81014dd563SJed Brown # define PETSC_DLLEXPORT __attribute__((visibility ("default"))) 82014dd563SJed Brown # define PETSC_DLLIMPORT __attribute__((visibility ("default"))) 8321f66b81SJed Brown # define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden"))) 84d382aafbSBarry Smith #else 85014dd563SJed Brown # define PETSC_DLLEXPORT 86014dd563SJed Brown # define PETSC_DLLIMPORT 8721f66b81SJed Brown # define PETSC_VISIBILITY_INTERNAL 88014dd563SJed Brown #endif 89014dd563SJed Brown 90014dd563SJed Brown #if defined(petsc_EXPORTS) /* CMake defines this when building the shared library */ 91014dd563SJed Brown # define PETSC_VISIBILITY_PUBLIC PETSC_DLLEXPORT 92014dd563SJed Brown #else /* Win32 users need this to import symbols from petsc.dll */ 93014dd563SJed Brown # define PETSC_VISIBILITY_PUBLIC PETSC_DLLIMPORT 94014dd563SJed Brown #endif 95014dd563SJed Brown 961cc8b206SBarry Smith /* 971cc8b206SBarry Smith Functions tagged with PETSC_EXTERN in the header files are 981cc8b206SBarry Smith always defined as extern "C" when compiled with C++ so they may be 991cc8b206SBarry Smith used from C and are always visible in the shared libraries 1001cc8b206SBarry Smith */ 1012c280183SJed Brown #if defined(__cplusplus) 102014dd563SJed Brown # define PETSC_EXTERN extern "C" PETSC_VISIBILITY_PUBLIC 103638cfed1SJed Brown # define PETSC_EXTERN_TYPEDEF extern "C" 10421f66b81SJed Brown # define PETSC_INTERN extern "C" PETSC_VISIBILITY_INTERNAL 105014dd563SJed Brown #else 106014dd563SJed Brown # define PETSC_EXTERN extern PETSC_VISIBILITY_PUBLIC 107638cfed1SJed Brown # define PETSC_EXTERN_TYPEDEF 1086258c452SJed Brown # define PETSC_INTERN extern PETSC_VISIBILITY_INTERNAL 109d382aafbSBarry Smith #endif 11027710113SBarry Smith 1112c8e378dSBarry Smith #include <petscversion.h> 112a8d69d7bSBarry Smith #define PETSC_AUTHOR_INFO " The PETSc Team\n petsc-maint@mcs.anl.gov\n https://www.mcs.anl.gov/petsc/\n" 113d382aafbSBarry Smith 114d382aafbSBarry Smith /* ========================================================================== */ 115d382aafbSBarry Smith 116d382aafbSBarry Smith /* 117d382aafbSBarry Smith Defines the interface to MPI allowing the use of all MPI functions. 118d382aafbSBarry Smith 119d382aafbSBarry Smith PETSc does not use the C++ binding of MPI at ALL. The following flag 120d382aafbSBarry Smith makes sure the C++ bindings are not included. The C++ bindings REQUIRE 121d382aafbSBarry Smith putting mpi.h before ANY C++ include files, we cannot control this 122d382aafbSBarry Smith with all PETSc users. Users who want to use the MPI C++ bindings can include 123d382aafbSBarry Smith mpicxx.h directly in their code 124d382aafbSBarry Smith */ 125fa9e63e2SJed Brown #if !defined(MPICH_SKIP_MPICXX) 126d382aafbSBarry Smith # define MPICH_SKIP_MPICXX 1 127fa9e63e2SJed Brown #endif 128fa9e63e2SJed Brown #if !defined(OMPI_SKIP_MPICXX) 129d382aafbSBarry Smith # define OMPI_SKIP_MPICXX 1 130fa9e63e2SJed Brown #endif 131e771154cSJed Brown #if defined(PETSC_HAVE_MPIUNI) 132e771154cSJed Brown # include <petsc/mpiuni/mpi.h> 133e771154cSJed Brown #else 1342c8e378dSBarry Smith # include <mpi.h> 135e771154cSJed Brown #endif 13665013866SBarry Smith 137d382aafbSBarry Smith /* 138a7886beaSBarry Smith Perform various sanity checks that the correct mpi.h is being included at compile time. 139a7886beaSBarry Smith This usually happens because 140a7886beaSBarry Smith * either an unexpected mpi.h is in the default compiler path (i.e. in /usr/include) or 141a7886beaSBarry Smith * an extra include path -I/something (which contains the unexpected mpi.h) is being passed to the compiler 142a7886beaSBarry Smith */ 143a7886beaSBarry Smith #if defined(PETSC_HAVE_MPIUNI) 144a7886beaSBarry Smith # if !defined(__MPIUNI_H) 145a7886beaSBarry Smith # error "PETSc was configured with --with-mpi=0 but now appears to be compiling using a different mpi.h" 146a7886beaSBarry Smith # endif 14741f4af4cSSatish Balay #elif defined(PETSC_HAVE_I_MPI_NUMVERSION) 14841f4af4cSSatish Balay # if !defined(I_MPI_NUMVERSION) 14941f4af4cSSatish Balay # error "PETSc was configured with I_MPI but now appears to be compiling using a non-I_MPI mpi.h" 15041f4af4cSSatish Balay # elif I_MPI_NUMVERSION != PETSC_HAVE_I_MPI_NUMVERSION 15141f4af4cSSatish Balay # error "PETSc was configured with one I_MPI mpi.h version but now appears to be compiling using a different I_MPI mpi.h version" 15241f4af4cSSatish Balay # endif 15341f4af4cSSatish Balay #elif defined(PETSC_HAVE_MVAPICH2_NUMVERSION) 15441f4af4cSSatish Balay # if !defined(MVAPICH2_NUMVERSION) 15541f4af4cSSatish Balay # error "PETSc was configured with MVAPICH2 but now appears to be compiling using a non-MVAPICH2 mpi.h" 15641f4af4cSSatish Balay # elif MVAPICH2_NUMVERSION != PETSC_HAVE_MVAPICH2_NUMVERSION 15741f4af4cSSatish Balay # error "PETSc was configured with one MVAPICH2 mpi.h version but now appears to be compiling using a different MVAPICH2 mpi.h version" 15841f4af4cSSatish Balay # endif 159a7886beaSBarry Smith #elif defined(PETSC_HAVE_MPICH_NUMVERSION) 16041f4af4cSSatish Balay # if !defined(MPICH_NUMVERSION) || defined(MVAPICH2_NUMVERSION) || defined(I_MPI_NUMVERSION) 161a7886beaSBarry Smith # error "PETSc was configured with MPICH but now appears to be compiling using a non-MPICH mpi.h" 162ca70f86eSJed Brown # elif (MPICH_NUMVERSION/100000 != PETSC_HAVE_MPICH_NUMVERSION/100000) || (MPICH_NUMVERSION%100000/1000 < PETSC_HAVE_MPICH_NUMVERSION%100000/1000) 163a7886beaSBarry Smith # error "PETSc was configured with one MPICH mpi.h version but now appears to be compiling using a different MPICH mpi.h version" 164a7886beaSBarry Smith # endif 165a7886beaSBarry Smith #elif defined(PETSC_HAVE_OMPI_MAJOR_VERSION) 166a7886beaSBarry Smith # if !defined(OMPI_MAJOR_VERSION) 167a7886beaSBarry Smith # error "PETSc was configured with OpenMPI but now appears to be compiling using a non-OpenMPI mpi.h" 168ca70f86eSJed Brown # elif (OMPI_MAJOR_VERSION != PETSC_HAVE_OMPI_MAJOR_VERSION) || (OMPI_MINOR_VERSION != PETSC_HAVE_OMPI_MINOR_VERSION) || (OMPI_RELEASE_VERSION < PETSC_HAVE_OMPI_RELEASE_VERSION) 169c3ac57cfSSatish Balay # error "PETSc was configured with one OpenMPI mpi.h version but now appears to be compiling using a different OpenMPI mpi.h version" 170a7886beaSBarry Smith # endif 17141f4af4cSSatish Balay #elif defined(OMPI_MAJOR_VERSION) || defined(MPICH_NUMVERSION) 17241f4af4cSSatish Balay # error "PETSc was configured with undetermined MPI - but now appears to be compiling using either of OpenMPI or a MPICH variant" 173a7886beaSBarry Smith #endif 174a7886beaSBarry Smith 175a7886beaSBarry Smith /* 1762981ebdbSBarry Smith Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler 177d382aafbSBarry Smith see the top of mpicxx.h in the MPICH2 distribution. 178d382aafbSBarry Smith */ 179d382aafbSBarry Smith #include <stdio.h> 180d382aafbSBarry Smith 181d382aafbSBarry Smith /* MSMPI on 32bit windows requires this yukky hack - that breaks MPI standard compliance */ 182d382aafbSBarry Smith #if !defined(MPIAPI) 183d382aafbSBarry Smith #define MPIAPI 184d382aafbSBarry Smith #endif 185d382aafbSBarry Smith 1861cc8b206SBarry Smith /* 1871cc8b206SBarry Smith Support for Clang (>=3.2) matching type tag arguments with void* buffer types. 1881cc8b206SBarry Smith This allows the compiler to detect cases where the MPI datatype argument passed to a MPI routine 1891cc8b206SBarry Smith does not match the actual type of the argument being passed in 1901cc8b206SBarry Smith */ 191c5e4d11fSDmitry Karpeev #if defined(__has_attribute) && defined(works_with_const_which_is_not_true) 192894dd566SJed Brown # if __has_attribute(argument_with_type_tag) && __has_attribute(pointer_with_type_tag) && __has_attribute(type_tag_for_datatype) 193894dd566SJed Brown # define PetscAttrMPIPointerWithType(bufno,typeno) __attribute__((pointer_with_type_tag(MPI,bufno,typeno))) 1948ad47952SJed Brown # define PetscAttrMPITypeTag(type) __attribute__((type_tag_for_datatype(MPI,type))) 1958ad47952SJed Brown # define PetscAttrMPITypeTagLayoutCompatible(type) __attribute__((type_tag_for_datatype(MPI,type,layout_compatible))) 196894dd566SJed Brown # endif 197894dd566SJed Brown #endif 198894dd566SJed Brown #if !defined(PetscAttrMPIPointerWithType) 199894dd566SJed Brown # define PetscAttrMPIPointerWithType(bufno,typeno) 2008ad47952SJed Brown # define PetscAttrMPITypeTag(type) 2018ad47952SJed Brown # define PetscAttrMPITypeTagLayoutCompatible(type) 202894dd566SJed Brown #endif 203b3506946SBarry Smith 2045a576424SJed Brown PETSC_EXTERN MPI_Datatype MPIU_ENUM PetscAttrMPITypeTag(PetscEnum); 205df4397b0SStefano Zampini PETSC_EXTERN MPI_Datatype MPIU_BOOL PetscAttrMPITypeTag(PetscBool); 206e28ce29aSPatrick Sanan 207e28ce29aSPatrick Sanan /*MC 208e28ce29aSPatrick Sanan MPIU_INT - MPI datatype corresponding to PetscInt 209e28ce29aSPatrick Sanan 210e28ce29aSPatrick Sanan Notes: 211e28ce29aSPatrick Sanan In MPI calls that require an MPI datatype that matches a PetscInt or array of PetscInt values, pass this value. 212e28ce29aSPatrick Sanan 213e28ce29aSPatrick Sanan Level: beginner 214e28ce29aSPatrick Sanan 215e28ce29aSPatrick Sanan .seealso: PetscReal, PetscScalar, PetscComplex, PetscInt, MPIU_REAL, MPIU_SCALAR, MPIU_COMPLEX 216e28ce29aSPatrick Sanan M*/ 217e28ce29aSPatrick Sanan 21837354ed4SSatish Balay #if defined(PETSC_HAVE_STDINT_H) && defined(PETSC_HAVE_INTTYPES_H) && defined(PETSC_HAVE_MPI_INT64_T) /* MPI_INT64_T is not guaranteed to be a macro */ 219bd84f1cfSSatish Balay # define MPIU_INT64 MPI_INT64_T 220a05e1a72SSatish Balay # define PetscInt64_FMT PRId64 221fab38c73SJed Brown #elif (PETSC_SIZEOF_LONG_LONG == 8) 222bd84f1cfSSatish Balay # define MPIU_INT64 MPI_LONG_LONG_INT 223a05e1a72SSatish Balay # define PetscInt64_FMT "lld" 224f505b413SSatish Balay #elif defined(PETSC_HAVE___INT64) 225bd84f1cfSSatish Balay # define MPIU_INT64 MPI_INT64_T 226a05e1a72SSatish Balay # define PetscInt64_FMT "ld" 227236ed0a3SSatish Balay #else 228bafee8b4SSatish Balay # error "cannot determine PetscInt64 type" 229236ed0a3SSatish Balay #endif 230b7b8f77aSBarry Smith 2317cdaf61dSJed Brown PETSC_EXTERN MPI_Datatype MPIU_FORTRANADDR; 232b7b8f77aSBarry Smith 233d382aafbSBarry Smith #if defined(PETSC_USE_64BIT_INDICES) 234bd84f1cfSSatish Balay # define MPIU_INT MPIU_INT64 235a05e1a72SSatish Balay # define PetscInt_FMT PetscInt64_FMT 236d382aafbSBarry Smith #else 237d382aafbSBarry Smith # define MPIU_INT MPI_INT 238a05e1a72SSatish Balay # define PetscInt_FMT "d" 239d382aafbSBarry Smith #endif 240d382aafbSBarry Smith 241503cfb0cSBarry Smith /* 242503cfb0cSBarry Smith For the rare cases when one needs to send a size_t object with MPI 243503cfb0cSBarry Smith */ 244e316c87fSJed Brown PETSC_EXTERN MPI_Datatype MPIU_SIZE_T; 245d382aafbSBarry Smith 246d382aafbSBarry Smith /* 247d382aafbSBarry Smith You can use PETSC_STDOUT as a replacement of stdout. You can also change 248d382aafbSBarry Smith the value of PETSC_STDOUT to redirect all standard output elsewhere 249d382aafbSBarry Smith */ 250014dd563SJed Brown PETSC_EXTERN FILE* PETSC_STDOUT; 251d382aafbSBarry Smith 252d382aafbSBarry Smith /* 253d382aafbSBarry Smith You can use PETSC_STDERR as a replacement of stderr. You can also change 254d382aafbSBarry Smith the value of PETSC_STDERR to redirect all standard error elsewhere 255d382aafbSBarry Smith */ 256014dd563SJed Brown PETSC_EXTERN FILE* PETSC_STDERR; 257d382aafbSBarry Smith 258d382aafbSBarry Smith /*MC 259d382aafbSBarry Smith PetscUnlikely - hints the compiler that the given condition is usually FALSE 260d382aafbSBarry Smith 261d382aafbSBarry Smith Synopsis: 262aaa7dc30SBarry Smith #include <petscsys.h> 263ace3abfcSBarry Smith PetscBool PetscUnlikely(PetscBool cond) 264d382aafbSBarry Smith 265eca87e8dSBarry Smith Not Collective 266eca87e8dSBarry Smith 267d382aafbSBarry Smith Input Parameters: 268d382aafbSBarry Smith . cond - condition or expression 269d382aafbSBarry Smith 270e28ce29aSPatrick Sanan Notes: 271e28ce29aSPatrick Sanan This returns the same truth value, it is only a hint to compilers that the resulting 272d382aafbSBarry Smith branch is unlikely. 273d382aafbSBarry Smith 274d382aafbSBarry Smith Level: advanced 275d382aafbSBarry Smith 276d382aafbSBarry Smith .seealso: PetscLikely(), CHKERRQ 277d382aafbSBarry Smith M*/ 278d382aafbSBarry Smith 279d382aafbSBarry Smith /*MC 280d382aafbSBarry Smith PetscLikely - hints the compiler that the given condition is usually TRUE 281d382aafbSBarry Smith 282d382aafbSBarry Smith Synopsis: 283aaa7dc30SBarry Smith #include <petscsys.h> 28423072422SBarry Smith PetscBool PetscLikely(PetscBool cond) 285d382aafbSBarry Smith 286eca87e8dSBarry Smith Not Collective 287eca87e8dSBarry Smith 288d382aafbSBarry Smith Input Parameters: 289d382aafbSBarry Smith . cond - condition or expression 290d382aafbSBarry Smith 291e28ce29aSPatrick Sanan Notes: 292e28ce29aSPatrick Sanan This returns the same truth value, it is only a hint to compilers that the resulting 293d382aafbSBarry Smith branch is likely. 294d382aafbSBarry Smith 295d382aafbSBarry Smith Level: advanced 296d382aafbSBarry Smith 297d382aafbSBarry Smith .seealso: PetscUnlikely() 298d382aafbSBarry Smith M*/ 299d382aafbSBarry Smith #if defined(PETSC_HAVE_BUILTIN_EXPECT) 300d382aafbSBarry Smith # define PetscUnlikely(cond) __builtin_expect(!!(cond),0) 301d382aafbSBarry Smith # define PetscLikely(cond) __builtin_expect(!!(cond),1) 302d382aafbSBarry Smith #else 303cd3f4ce9SJed Brown # define PetscUnlikely(cond) (cond) 304cd3f4ce9SJed Brown # define PetscLikely(cond) (cond) 305d382aafbSBarry Smith #endif 306d382aafbSBarry Smith 307d382aafbSBarry Smith /* 308d382aafbSBarry Smith Declare extern C stuff after including external header files 309d382aafbSBarry Smith */ 310d382aafbSBarry Smith 3116a6fc655SJed Brown PETSC_EXTERN const char *const PetscBools[]; 31270b3c8c7SBarry Smith 3138b49ba18SBarry Smith /* 314390e1bf2SBarry Smith Defines elementary mathematics functions and constants. 3158b49ba18SBarry Smith */ 3168b49ba18SBarry Smith #include <petscmath.h> 3178b49ba18SBarry Smith 3186a6fc655SJed Brown PETSC_EXTERN const char *const PetscCopyModes[]; 319d382aafbSBarry Smith 320d382aafbSBarry Smith /*MC 3210298fd71SBarry Smith PETSC_IGNORE - same as NULL, means PETSc will ignore this argument 322d382aafbSBarry Smith 323d382aafbSBarry Smith Level: beginner 324d382aafbSBarry Smith 325e28ce29aSPatrick Sanan Note: 326e28ce29aSPatrick Sanan Accepted by many PETSc functions to not set a parameter and instead use 327d382aafbSBarry Smith some default 328d382aafbSBarry Smith 329e28ce29aSPatrick Sanan Fortran Notes: 330e28ce29aSPatrick Sanan This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER, 331d382aafbSBarry Smith PETSC_NULL_DOUBLE_PRECISION etc 332d382aafbSBarry Smith 333e28ce29aSPatrick Sanan .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_DETERMINE 334d382aafbSBarry Smith 335d382aafbSBarry Smith M*/ 3360298fd71SBarry Smith #define PETSC_IGNORE NULL 337d382aafbSBarry Smith 338c528d872SBarry Smith /* This is deprecated */ 339c528d872SBarry Smith #define PETSC_NULL NULL 340c528d872SBarry Smith 341d382aafbSBarry Smith /*MC 342557d4da8SBarry Smith PETSC_DECIDE - standard way of passing in integer or floating point parameter 343557d4da8SBarry Smith where you wish PETSc to use the default. 344557d4da8SBarry Smith 345557d4da8SBarry Smith Level: beginner 346557d4da8SBarry Smith 347e28ce29aSPatrick Sanan .seealso: PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE 348557d4da8SBarry Smith 349557d4da8SBarry Smith M*/ 350557d4da8SBarry Smith #define PETSC_DECIDE -1 351557d4da8SBarry Smith 352557d4da8SBarry Smith /*MC 353d382aafbSBarry Smith PETSC_DETERMINE - standard way of passing in integer or floating point parameter 354d382aafbSBarry Smith where you wish PETSc to compute the required value. 355d382aafbSBarry Smith 356d382aafbSBarry Smith Level: beginner 357d382aafbSBarry Smith 358e28ce29aSPatrick Sanan Developer Note: 359e28ce29aSPatrick Sanan I would like to use const PetscInt PETSC_DETERMINE = PETSC_DECIDE; but for 360557d4da8SBarry Smith some reason this is not allowed by the standard even though PETSC_DECIDE is a constant value. 361557d4da8SBarry Smith 3620298fd71SBarry Smith .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, VecSetSizes() 363d382aafbSBarry Smith 364d382aafbSBarry Smith M*/ 365d382aafbSBarry Smith #define PETSC_DETERMINE PETSC_DECIDE 366d382aafbSBarry Smith 367d382aafbSBarry Smith /*MC 368557d4da8SBarry Smith PETSC_DEFAULT - standard way of passing in integer or floating point parameter 369557d4da8SBarry Smith where you wish PETSc to use the default. 370557d4da8SBarry Smith 371557d4da8SBarry Smith Level: beginner 372557d4da8SBarry Smith 373e28ce29aSPatrick Sanan Fortran Notes: 374e28ce29aSPatrick Sanan You need to use PETSC_DEFAULT_INTEGER or PETSC_DEFAULT_REAL. 375557d4da8SBarry Smith 3760298fd71SBarry Smith .seealso: PETSC_DECIDE, PETSC_IGNORE, PETSC_DETERMINE 377557d4da8SBarry Smith 378557d4da8SBarry Smith M*/ 379557d4da8SBarry Smith #define PETSC_DEFAULT -2 380557d4da8SBarry Smith 381557d4da8SBarry Smith /*MC 382d382aafbSBarry Smith PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents 383ea8fe74dSBarry Smith all the processes that PETSc knows about. 384d382aafbSBarry Smith 385d382aafbSBarry Smith Level: beginner 386d382aafbSBarry Smith 387e28ce29aSPatrick Sanan Notes: 388e28ce29aSPatrick Sanan By default PETSC_COMM_WORLD and MPI_COMM_WORLD are identical unless you wish to 389d382aafbSBarry Smith run PETSc on ONLY a subset of MPI_COMM_WORLD. In that case create your new (smaller) 390d382aafbSBarry Smith communicator, call it, say comm, and set PETSC_COMM_WORLD = comm BEFORE calling 391a990b902SBarry Smith PetscInitialize(), but after MPI_Init() has been called. 392a990b902SBarry Smith 393a990b902SBarry Smith The value of PETSC_COMM_WORLD should never be USED/accessed before PetscInitialize() 394a990b902SBarry Smith is called because it may not have a valid value yet. 395d382aafbSBarry Smith 396d382aafbSBarry Smith .seealso: PETSC_COMM_SELF 397d382aafbSBarry Smith 398d382aafbSBarry Smith M*/ 399014dd563SJed Brown PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD; 400d382aafbSBarry Smith 401d382aafbSBarry Smith /*MC 402503cfb0cSBarry Smith PETSC_COMM_SELF - This is always MPI_COMM_SELF 403d382aafbSBarry Smith 404d382aafbSBarry Smith Level: beginner 405d382aafbSBarry Smith 406e28ce29aSPatrick Sanan Notes: 407e28ce29aSPatrick Sanan Do not USE/access or set this variable before PetscInitialize() has been called. 408a990b902SBarry Smith 409d382aafbSBarry Smith .seealso: PETSC_COMM_WORLD 410d382aafbSBarry Smith 411d382aafbSBarry Smith M*/ 412d382aafbSBarry Smith #define PETSC_COMM_SELF MPI_COMM_SELF 413d382aafbSBarry Smith 414d6f2c3cbSBarry Smith PETSC_EXTERN PetscBool PetscBeganMPI; 415014dd563SJed Brown PETSC_EXTERN PetscBool PetscInitializeCalled; 416014dd563SJed Brown PETSC_EXTERN PetscBool PetscFinalizeCalled; 4174cf1874eSKarl Rupp PETSC_EXTERN PetscBool PetscViennaCLSynchronize; 41882f73ecaSAlejandro Lamas Daviña PETSC_EXTERN PetscBool PetscCUDASynchronize; 419d382aafbSBarry Smith 420014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm)); 421014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*); 422014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm*); 423d382aafbSBarry Smith 424*7381773fSBarry Smith #if defined(PETSC_HAVE_CUDA) 425*7381773fSBarry Smith PETSC_EXTERN PetscErrorCode PetscCUDAInitialize(MPI_Comm); 426*7381773fSBarry Smith #endif 427*7381773fSBarry Smith 428d382aafbSBarry Smith /*MC 42995dccacaSBarry Smith PetscMalloc - Allocates memory, One should use PetscNew(), PetscMalloc1() or PetscCalloc1() usually instead of this 430d382aafbSBarry Smith 431eca87e8dSBarry Smith Synopsis: 432aaa7dc30SBarry Smith #include <petscsys.h> 433eca87e8dSBarry Smith PetscErrorCode PetscMalloc(size_t m,void **result) 434eca87e8dSBarry Smith 435eca87e8dSBarry Smith Not Collective 436eca87e8dSBarry Smith 437d382aafbSBarry Smith Input Parameter: 438d382aafbSBarry Smith . m - number of bytes to allocate 439d382aafbSBarry Smith 440d382aafbSBarry Smith Output Parameter: 441d382aafbSBarry Smith . result - memory allocated 442d382aafbSBarry Smith 443d382aafbSBarry Smith Level: beginner 444d382aafbSBarry Smith 44549d7da52SJed Brown Notes: 44649d7da52SJed Brown Memory is always allocated at least double aligned 447d382aafbSBarry Smith 44849d7da52SJed Brown It is safe to allocate size 0 and pass the resulting pointer (which may or may not be NULL) to PetscFree(). 449d382aafbSBarry Smith 450d382aafbSBarry Smith .seealso: PetscFree(), PetscNew() 451d382aafbSBarry Smith 452d382aafbSBarry Smith M*/ 45349d7da52SJed Brown #define PetscMalloc(a,b) ((*PetscTrMalloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b))) 454d382aafbSBarry Smith 455d382aafbSBarry Smith /*MC 4563221ece2SMatthew G. Knepley PetscRealloc - Rellocates memory 4573221ece2SMatthew G. Knepley 4583221ece2SMatthew G. Knepley Synopsis: 4593221ece2SMatthew G. Knepley #include <petscsys.h> 4603221ece2SMatthew G. Knepley PetscErrorCode PetscRealloc(size_t m,void **result) 4613221ece2SMatthew G. Knepley 4623221ece2SMatthew G. Knepley Not Collective 4633221ece2SMatthew G. Knepley 4643221ece2SMatthew G. Knepley Input Parameters: 4653221ece2SMatthew G. Knepley + m - number of bytes to allocate 4663221ece2SMatthew G. Knepley - result - initial memory allocated 4673221ece2SMatthew G. Knepley 4683221ece2SMatthew G. Knepley Output Parameter: 4693221ece2SMatthew G. Knepley . result - new memory allocated 4703221ece2SMatthew G. Knepley 4713221ece2SMatthew G. Knepley Level: developer 4723221ece2SMatthew G. Knepley 4733221ece2SMatthew G. Knepley Notes: 4743221ece2SMatthew G. Knepley Memory is always allocated at least double aligned 4753221ece2SMatthew G. Knepley 4763221ece2SMatthew G. Knepley .seealso: PetscMalloc(), PetscFree(), PetscNew() 4773221ece2SMatthew G. Knepley 4783221ece2SMatthew G. Knepley M*/ 4793221ece2SMatthew G. Knepley #define PetscRealloc(a,b) ((*PetscTrRealloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b))) 4803221ece2SMatthew G. Knepley 4813221ece2SMatthew G. Knepley /*MC 482503cfb0cSBarry Smith PetscAddrAlign - Rounds up an address to PETSC_MEMALIGN alignment 483d382aafbSBarry Smith 484d382aafbSBarry Smith Synopsis: 485aaa7dc30SBarry Smith #include <petscsys.h> 486d382aafbSBarry Smith void *PetscAddrAlign(void *addr) 487d382aafbSBarry Smith 488eca87e8dSBarry Smith Not Collective 489eca87e8dSBarry Smith 490eca87e8dSBarry Smith Input Parameters: 491eca87e8dSBarry Smith . addr - address to align (any pointer type) 492eca87e8dSBarry Smith 493d382aafbSBarry Smith Level: developer 494d382aafbSBarry Smith 495d382aafbSBarry Smith .seealso: PetscMallocAlign() 496d382aafbSBarry Smith 497d382aafbSBarry Smith M*/ 498d382aafbSBarry Smith #define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1)) 499d382aafbSBarry Smith 500d382aafbSBarry Smith /*MC 501785e854fSJed Brown PetscMalloc1 - Allocates an array of memory aligned to PETSC_MEMALIGN 502d382aafbSBarry Smith 503eca87e8dSBarry Smith Synopsis: 504aaa7dc30SBarry Smith #include <petscsys.h> 505785e854fSJed Brown PetscErrorCode PetscMalloc1(size_t m1,type **r1) 506785e854fSJed Brown 507785e854fSJed Brown Not Collective 508785e854fSJed Brown 509785e854fSJed Brown Input Parameter: 510390e1bf2SBarry Smith . m1 - number of elements to allocate (may be zero) 511785e854fSJed Brown 512785e854fSJed Brown Output Parameter: 513785e854fSJed Brown . r1 - memory allocated in first chunk 514785e854fSJed Brown 515e28ce29aSPatrick Sanan Note: 516e28ce29aSPatrick Sanan This uses the sizeof() of the memory type requested to determine the total memory to be allocated, therefore you should not 517390e1bf2SBarry Smith multiply the number of elements requested by the sizeof() the type. For example use 518390e1bf2SBarry Smith $ PetscInt *id; 519390e1bf2SBarry Smith $ PetscMalloc1(10,&id); 520390e1bf2SBarry Smith not 521390e1bf2SBarry Smith $ PetscInt *id; 522390e1bf2SBarry Smith $ PetscMalloc1(10*sizeof(PetscInt),&id); 523390e1bf2SBarry Smith 524390e1bf2SBarry Smith Does not zero the memory allocatd, used PetscCalloc1() to obtain memory that has been zeroed. 525390e1bf2SBarry Smith 526390e1bf2SBarry Smith Level: beginner 527785e854fSJed Brown 5281795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2() 529785e854fSJed Brown 530785e854fSJed Brown M*/ 5312553b7ecSJed Brown #define PetscMalloc1(m1,r1) PetscMallocA(1,PETSC_FALSE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1)) 532785e854fSJed Brown 533785e854fSJed Brown /*MC 5341795a4d1SJed Brown PetscCalloc1 - Allocates a cleared (zeroed) array of memory aligned to PETSC_MEMALIGN 5351795a4d1SJed Brown 5361795a4d1SJed Brown Synopsis: 537aaa7dc30SBarry Smith #include <petscsys.h> 5381795a4d1SJed Brown PetscErrorCode PetscCalloc1(size_t m1,type **r1) 5391795a4d1SJed Brown 5401795a4d1SJed Brown Not Collective 5411795a4d1SJed Brown 5421795a4d1SJed Brown Input Parameter: 5431795a4d1SJed Brown . m1 - number of elements to allocate in 1st chunk (may be zero) 5441795a4d1SJed Brown 5451795a4d1SJed Brown Output Parameter: 5461795a4d1SJed Brown . r1 - memory allocated in first chunk 5471795a4d1SJed Brown 548e28ce29aSPatrick Sanan Notes: 549e28ce29aSPatrick Sanan See PetsMalloc1() for more details on usage. 550390e1bf2SBarry Smith 551390e1bf2SBarry Smith Level: beginner 5521795a4d1SJed Brown 5531795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2() 5541795a4d1SJed Brown 5551795a4d1SJed Brown M*/ 5562553b7ecSJed Brown #define PetscCalloc1(m1,r1) PetscMallocA(1,PETSC_TRUE,__LINE__,PETSC_FUNCTION_NAME,__FILE__,(size_t)(m1)*sizeof(**(r1)),(r1)) 5571795a4d1SJed Brown 5581795a4d1SJed Brown /*MC 559dcca6d9dSJed Brown PetscMalloc2 - Allocates 2 arrays of memory both aligned to PETSC_MEMALIGN 560d382aafbSBarry Smith 561eca87e8dSBarry Smith Synopsis: 562aaa7dc30SBarry Smith #include <petscsys.h> 563dcca6d9dSJed Brown PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2) 564eca87e8dSBarry Smith 565eca87e8dSBarry Smith Not Collective 566eca87e8dSBarry Smith 567d382aafbSBarry Smith Input Parameter: 568d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 569dcca6d9dSJed Brown - m2 - number of elements to allocate in 2nd chunk (may be zero) 570d382aafbSBarry Smith 571d382aafbSBarry Smith Output Parameter: 572d382aafbSBarry Smith + r1 - memory allocated in first chunk 573d382aafbSBarry Smith - r2 - memory allocated in second chunk 574d382aafbSBarry Smith 575d382aafbSBarry Smith Level: developer 576d382aafbSBarry Smith 5771795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2() 578d382aafbSBarry Smith 579d382aafbSBarry Smith M*/ 5802553b7ecSJed 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)) 581d382aafbSBarry Smith 582d382aafbSBarry Smith /*MC 5831795a4d1SJed Brown PetscCalloc2 - Allocates 2 cleared (zeroed) arrays of memory both aligned to PETSC_MEMALIGN 584d382aafbSBarry Smith 585eca87e8dSBarry Smith Synopsis: 586aaa7dc30SBarry Smith #include <petscsys.h> 5871795a4d1SJed Brown PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2) 588eca87e8dSBarry Smith 589eca87e8dSBarry Smith Not Collective 590eca87e8dSBarry Smith 591d382aafbSBarry Smith Input Parameter: 592d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 5931795a4d1SJed Brown - m2 - number of elements to allocate in 2nd chunk (may be zero) 5941795a4d1SJed Brown 5951795a4d1SJed Brown Output Parameter: 5961795a4d1SJed Brown + r1 - memory allocated in first chunk 5971795a4d1SJed Brown - r2 - memory allocated in second chunk 5981795a4d1SJed Brown 5991795a4d1SJed Brown Level: developer 6001795a4d1SJed Brown 6011795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2() 6021795a4d1SJed Brown 6031795a4d1SJed Brown M*/ 6042553b7ecSJed 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)) 6051795a4d1SJed Brown 6061795a4d1SJed Brown /*MC 607dcca6d9dSJed Brown PetscMalloc3 - Allocates 3 arrays of memory, all aligned to PETSC_MEMALIGN 608d382aafbSBarry Smith 609d382aafbSBarry Smith Synopsis: 610aaa7dc30SBarry Smith #include <petscsys.h> 611dcca6d9dSJed Brown PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3) 612d382aafbSBarry Smith 613d382aafbSBarry Smith Not Collective 614d382aafbSBarry Smith 615d382aafbSBarry Smith Input Parameter: 616d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 617d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 618dcca6d9dSJed Brown - m3 - number of elements to allocate in 3rd chunk (may be zero) 619d382aafbSBarry Smith 620d382aafbSBarry Smith Output Parameter: 621d382aafbSBarry Smith + r1 - memory allocated in first chunk 622d382aafbSBarry Smith . r2 - memory allocated in second chunk 623d382aafbSBarry Smith - r3 - memory allocated in third chunk 624d382aafbSBarry Smith 625d382aafbSBarry Smith Level: developer 626d382aafbSBarry Smith 6271795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc3(), PetscFree3() 628d382aafbSBarry Smith 629d382aafbSBarry Smith M*/ 6302553b7ecSJed 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)) 631d382aafbSBarry Smith 632d382aafbSBarry Smith /*MC 6331795a4d1SJed Brown PetscCalloc3 - Allocates 3 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 634d382aafbSBarry Smith 635eca87e8dSBarry Smith Synopsis: 636aaa7dc30SBarry Smith #include <petscsys.h> 6371795a4d1SJed Brown PetscErrorCode PetscCalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3) 638eca87e8dSBarry Smith 639eca87e8dSBarry Smith Not Collective 640eca87e8dSBarry Smith 641d382aafbSBarry Smith Input Parameter: 642d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 643d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 6441795a4d1SJed Brown - m3 - number of elements to allocate in 3rd chunk (may be zero) 6451795a4d1SJed Brown 6461795a4d1SJed Brown Output Parameter: 6471795a4d1SJed Brown + r1 - memory allocated in first chunk 6481795a4d1SJed Brown . r2 - memory allocated in second chunk 6491795a4d1SJed Brown - r3 - memory allocated in third chunk 6501795a4d1SJed Brown 6511795a4d1SJed Brown Level: developer 6521795a4d1SJed Brown 6531795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc2(), PetscMalloc3(), PetscFree3() 6541795a4d1SJed Brown 6551795a4d1SJed Brown M*/ 6562553b7ecSJed 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)) 6571795a4d1SJed Brown 6581795a4d1SJed Brown /*MC 659dcca6d9dSJed Brown PetscMalloc4 - Allocates 4 arrays of memory, all aligned to PETSC_MEMALIGN 660d382aafbSBarry Smith 661d382aafbSBarry Smith Synopsis: 662aaa7dc30SBarry Smith #include <petscsys.h> 663dcca6d9dSJed Brown PetscErrorCode PetscMalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4) 664d382aafbSBarry Smith 665d382aafbSBarry Smith Not Collective 666d382aafbSBarry Smith 667d382aafbSBarry Smith Input Parameter: 668d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 669d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 670d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 671dcca6d9dSJed Brown - m4 - number of elements to allocate in 4th chunk (may be zero) 672d382aafbSBarry Smith 673d382aafbSBarry Smith Output Parameter: 674d382aafbSBarry Smith + r1 - memory allocated in first chunk 675d382aafbSBarry Smith . r2 - memory allocated in second chunk 676d382aafbSBarry Smith . r3 - memory allocated in third chunk 677d382aafbSBarry Smith - r4 - memory allocated in fourth chunk 678d382aafbSBarry Smith 679d382aafbSBarry Smith Level: developer 680d382aafbSBarry Smith 6811795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4() 682d382aafbSBarry Smith 683d382aafbSBarry Smith M*/ 6842553b7ecSJed 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)) 685d382aafbSBarry Smith 686d382aafbSBarry Smith /*MC 6871795a4d1SJed Brown PetscCalloc4 - Allocates 4 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 688d382aafbSBarry Smith 689eca87e8dSBarry Smith Synopsis: 690aaa7dc30SBarry Smith #include <petscsys.h> 6911795a4d1SJed Brown PetscErrorCode PetscCalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4) 692eca87e8dSBarry Smith 693eca87e8dSBarry Smith Not Collective 694eca87e8dSBarry Smith 695e28ce29aSPatrick Sanan Input Parameters: 696d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 697d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 698d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 6991795a4d1SJed Brown - m4 - number of elements to allocate in 4th chunk (may be zero) 7001795a4d1SJed Brown 701e28ce29aSPatrick Sanan Output Parameters: 7021795a4d1SJed Brown + r1 - memory allocated in first chunk 7031795a4d1SJed Brown . r2 - memory allocated in second chunk 7041795a4d1SJed Brown . r3 - memory allocated in third chunk 7051795a4d1SJed Brown - r4 - memory allocated in fourth chunk 7061795a4d1SJed Brown 7071795a4d1SJed Brown Level: developer 7081795a4d1SJed Brown 7091795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4() 7101795a4d1SJed Brown 7111795a4d1SJed Brown M*/ 7122553b7ecSJed 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)) 7131795a4d1SJed Brown 7141795a4d1SJed Brown /*MC 715dcca6d9dSJed Brown PetscMalloc5 - Allocates 5 arrays of memory, all aligned to PETSC_MEMALIGN 716d382aafbSBarry Smith 717d382aafbSBarry Smith Synopsis: 718aaa7dc30SBarry Smith #include <petscsys.h> 719dcca6d9dSJed 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) 720d382aafbSBarry Smith 721d382aafbSBarry Smith Not Collective 722d382aafbSBarry Smith 723e28ce29aSPatrick Sanan Input Parameters: 724d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 725d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 726d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 727d382aafbSBarry Smith . m4 - number of elements to allocate in 4th chunk (may be zero) 728dcca6d9dSJed Brown - m5 - number of elements to allocate in 5th chunk (may be zero) 729d382aafbSBarry Smith 730e28ce29aSPatrick Sanan Output Parameters: 731d382aafbSBarry Smith + r1 - memory allocated in first chunk 732d382aafbSBarry Smith . r2 - memory allocated in second chunk 733d382aafbSBarry Smith . r3 - memory allocated in third chunk 734d382aafbSBarry Smith . r4 - memory allocated in fourth chunk 735d382aafbSBarry Smith - r5 - memory allocated in fifth chunk 736d382aafbSBarry Smith 737d382aafbSBarry Smith Level: developer 738d382aafbSBarry Smith 7391795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc5(), PetscFree5() 740d382aafbSBarry Smith 741d382aafbSBarry Smith M*/ 7422553b7ecSJed 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)) 743d382aafbSBarry Smith 744d382aafbSBarry Smith /*MC 7451795a4d1SJed Brown PetscCalloc5 - Allocates 5 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 746d382aafbSBarry Smith 747eca87e8dSBarry Smith Synopsis: 748aaa7dc30SBarry Smith #include <petscsys.h> 7491795a4d1SJed 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) 750eca87e8dSBarry Smith 751eca87e8dSBarry Smith Not Collective 752eca87e8dSBarry Smith 753e28ce29aSPatrick Sanan Input Parameters: 754d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 755d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 756d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 757d382aafbSBarry Smith . m4 - number of elements to allocate in 4th chunk (may be zero) 7581795a4d1SJed Brown - m5 - number of elements to allocate in 5th chunk (may be zero) 7591795a4d1SJed Brown 760e28ce29aSPatrick Sanan Output Parameters: 7611795a4d1SJed Brown + r1 - memory allocated in first chunk 7621795a4d1SJed Brown . r2 - memory allocated in second chunk 7631795a4d1SJed Brown . r3 - memory allocated in third chunk 7641795a4d1SJed Brown . r4 - memory allocated in fourth chunk 7651795a4d1SJed Brown - r5 - memory allocated in fifth chunk 7661795a4d1SJed Brown 7671795a4d1SJed Brown Level: developer 7681795a4d1SJed Brown 7691795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc5(), PetscFree5() 7701795a4d1SJed Brown 7711795a4d1SJed Brown M*/ 7722553b7ecSJed 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)) 773d382aafbSBarry Smith 774d382aafbSBarry Smith /*MC 775dcca6d9dSJed Brown PetscMalloc6 - Allocates 6 arrays of memory, all aligned to PETSC_MEMALIGN 776d382aafbSBarry Smith 777d382aafbSBarry Smith Synopsis: 778aaa7dc30SBarry Smith #include <petscsys.h> 779dcca6d9dSJed 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) 780d382aafbSBarry Smith 781d382aafbSBarry Smith Not Collective 782d382aafbSBarry Smith 783e28ce29aSPatrick Sanan Input Parameters: 784d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 785d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 786d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 787d382aafbSBarry Smith . m4 - number of elements to allocate in 4th chunk (may be zero) 788d382aafbSBarry Smith . m5 - number of elements to allocate in 5th chunk (may be zero) 789dcca6d9dSJed Brown - m6 - number of elements to allocate in 6th chunk (may be zero) 790d382aafbSBarry Smith 791e28ce29aSPatrick Sanan Output Parameteasr: 792d382aafbSBarry Smith + r1 - memory allocated in first chunk 793d382aafbSBarry Smith . r2 - memory allocated in second chunk 794d382aafbSBarry Smith . r3 - memory allocated in third chunk 795d382aafbSBarry Smith . r4 - memory allocated in fourth chunk 796d382aafbSBarry Smith . r5 - memory allocated in fifth chunk 797d382aafbSBarry Smith - r6 - memory allocated in sixth chunk 798d382aafbSBarry Smith 799d382aafbSBarry Smith Level: developer 800d382aafbSBarry Smith 8011795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc6(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6() 802d382aafbSBarry Smith 803d382aafbSBarry Smith M*/ 8042553b7ecSJed 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)) 805d382aafbSBarry Smith 806d382aafbSBarry Smith /*MC 8071795a4d1SJed Brown PetscCalloc6 - Allocates 6 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 808d382aafbSBarry Smith 809eca87e8dSBarry Smith Synopsis: 810aaa7dc30SBarry Smith #include <petscsys.h> 8111795a4d1SJed 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) 812eca87e8dSBarry Smith 813eca87e8dSBarry Smith Not Collective 814eca87e8dSBarry Smith 815e28ce29aSPatrick Sanan Input Parameters: 816d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 817d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 818d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 819d382aafbSBarry Smith . m4 - number of elements to allocate in 4th chunk (may be zero) 820d382aafbSBarry Smith . m5 - number of elements to allocate in 5th chunk (may be zero) 8211795a4d1SJed Brown - m6 - number of elements to allocate in 6th chunk (may be zero) 8221795a4d1SJed Brown 823e28ce29aSPatrick Sanan Output Parameters: 8241795a4d1SJed Brown + r1 - memory allocated in first chunk 8251795a4d1SJed Brown . r2 - memory allocated in second chunk 8261795a4d1SJed Brown . r3 - memory allocated in third chunk 8271795a4d1SJed Brown . r4 - memory allocated in fourth chunk 8281795a4d1SJed Brown . r5 - memory allocated in fifth chunk 8291795a4d1SJed Brown - r6 - memory allocated in sixth chunk 8301795a4d1SJed Brown 8311795a4d1SJed Brown Level: developer 8321795a4d1SJed Brown 8331795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc6(), PetscFree6() 8341795a4d1SJed Brown 8351795a4d1SJed Brown M*/ 8362553b7ecSJed 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)) 8371795a4d1SJed Brown 8381795a4d1SJed Brown /*MC 839dcca6d9dSJed Brown PetscMalloc7 - Allocates 7 arrays of memory, all aligned to PETSC_MEMALIGN 840d382aafbSBarry Smith 841d382aafbSBarry Smith Synopsis: 842aaa7dc30SBarry Smith #include <petscsys.h> 843dcca6d9dSJed 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) 844d382aafbSBarry Smith 845d382aafbSBarry Smith Not Collective 846d382aafbSBarry Smith 847e28ce29aSPatrick Sanan Input Parameters: 848d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 849d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 850d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 851d382aafbSBarry Smith . m4 - number of elements to allocate in 4th chunk (may be zero) 852d382aafbSBarry Smith . m5 - number of elements to allocate in 5th chunk (may be zero) 853d382aafbSBarry Smith . m6 - number of elements to allocate in 6th chunk (may be zero) 854dcca6d9dSJed Brown - m7 - number of elements to allocate in 7th chunk (may be zero) 855d382aafbSBarry Smith 856e28ce29aSPatrick Sanan Output Parameters: 857d382aafbSBarry Smith + r1 - memory allocated in first chunk 858d382aafbSBarry Smith . r2 - memory allocated in second chunk 859d382aafbSBarry Smith . r3 - memory allocated in third chunk 860d382aafbSBarry Smith . r4 - memory allocated in fourth chunk 861d382aafbSBarry Smith . r5 - memory allocated in fifth chunk 862d382aafbSBarry Smith . r6 - memory allocated in sixth chunk 863eca87e8dSBarry Smith - r7 - memory allocated in seventh chunk 864d382aafbSBarry Smith 865d382aafbSBarry Smith Level: developer 866d382aafbSBarry Smith 8671795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc7(), PetscFree7() 868d382aafbSBarry Smith 869d382aafbSBarry Smith M*/ 8702553b7ecSJed 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)) 871d382aafbSBarry Smith 872d382aafbSBarry Smith /*MC 8731795a4d1SJed Brown PetscCalloc7 - Allocates 7 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 8741795a4d1SJed Brown 8751795a4d1SJed Brown Synopsis: 876aaa7dc30SBarry Smith #include <petscsys.h> 8771795a4d1SJed 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) 8781795a4d1SJed Brown 8791795a4d1SJed Brown Not Collective 8801795a4d1SJed Brown 881e28ce29aSPatrick Sanan Input Parameters: 8821795a4d1SJed Brown + m1 - number of elements to allocate in 1st chunk (may be zero) 8831795a4d1SJed Brown . m2 - number of elements to allocate in 2nd chunk (may be zero) 8841795a4d1SJed Brown . m3 - number of elements to allocate in 3rd chunk (may be zero) 8851795a4d1SJed Brown . m4 - number of elements to allocate in 4th chunk (may be zero) 8861795a4d1SJed Brown . m5 - number of elements to allocate in 5th chunk (may be zero) 8871795a4d1SJed Brown . m6 - number of elements to allocate in 6th chunk (may be zero) 8881795a4d1SJed Brown - m7 - number of elements to allocate in 7th chunk (may be zero) 8891795a4d1SJed Brown 890e28ce29aSPatrick Sanan Output Parameters: 8911795a4d1SJed Brown + r1 - memory allocated in first chunk 8921795a4d1SJed Brown . r2 - memory allocated in second chunk 8931795a4d1SJed Brown . r3 - memory allocated in third chunk 8941795a4d1SJed Brown . r4 - memory allocated in fourth chunk 8951795a4d1SJed Brown . r5 - memory allocated in fifth chunk 8961795a4d1SJed Brown . r6 - memory allocated in sixth chunk 8971795a4d1SJed Brown - r7 - memory allocated in seventh chunk 8981795a4d1SJed Brown 8991795a4d1SJed Brown Level: developer 9001795a4d1SJed Brown 9011795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc7(), PetscFree7() 9021795a4d1SJed Brown 9031795a4d1SJed Brown M*/ 9042553b7ecSJed 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)) 9051795a4d1SJed Brown 9061795a4d1SJed Brown /*MC 907503cfb0cSBarry Smith PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to PETSC_MEMALIGN 908d382aafbSBarry Smith 909eca87e8dSBarry Smith Synopsis: 910aaa7dc30SBarry Smith #include <petscsys.h> 911b00a9115SJed Brown PetscErrorCode PetscNew(type **result) 912eca87e8dSBarry Smith 913eca87e8dSBarry Smith Not Collective 914eca87e8dSBarry Smith 915d382aafbSBarry Smith Output Parameter: 916b00a9115SJed Brown . result - memory allocated, sized to match pointer type 917d382aafbSBarry Smith 918d382aafbSBarry Smith Level: beginner 919d382aafbSBarry Smith 920390e1bf2SBarry Smith .seealso: PetscFree(), PetscMalloc(), PetscNewLog(), PetscCalloc1(), PetscMalloc1() 921d382aafbSBarry Smith 922d382aafbSBarry Smith M*/ 923b00a9115SJed Brown #define PetscNew(b) PetscCalloc1(1,(b)) 924ad0619ddSBarry Smith 925ad0619ddSBarry Smith /*MC 926b00a9115SJed Brown PetscNewLog - Allocates memory of a type matching pointer, zeros the memory! Aligned to PETSC_MEMALIGN. Associates the memory allocated 927ad0619ddSBarry Smith with the given object using PetscLogObjectMemory(). 928ad0619ddSBarry Smith 929ad0619ddSBarry Smith Synopsis: 930aaa7dc30SBarry Smith #include <petscsys.h> 931b00a9115SJed Brown PetscErrorCode PetscNewLog(PetscObject obj,type **result) 932ad0619ddSBarry Smith 933ad0619ddSBarry Smith Not Collective 934ad0619ddSBarry Smith 935ad0619ddSBarry Smith Input Parameter: 936b00a9115SJed Brown . obj - object memory is logged to 937ad0619ddSBarry Smith 938ad0619ddSBarry Smith Output Parameter: 939b00a9115SJed Brown . result - memory allocated, sized to match pointer type 940ad0619ddSBarry Smith 941ad0619ddSBarry Smith Level: developer 942ad0619ddSBarry Smith 943390e1bf2SBarry Smith .seealso: PetscFree(), PetscMalloc(), PetscNew(), PetscLogObjectMemory(), PetscCalloc1(), PetscMalloc1() 944ad0619ddSBarry Smith 945ad0619ddSBarry Smith M*/ 946d12f57a0SLisandro Dalcin #define PetscNewLog(o,b) (PetscNew((b)) || PetscLogObjectMemory((PetscObject)o,sizeof(**(b)))) 947d382aafbSBarry Smith 948d382aafbSBarry Smith /*MC 949d382aafbSBarry Smith PetscFree - Frees memory 950d382aafbSBarry Smith 951eca87e8dSBarry Smith Synopsis: 952aaa7dc30SBarry Smith #include <petscsys.h> 953eca87e8dSBarry Smith PetscErrorCode PetscFree(void *memory) 954eca87e8dSBarry Smith 955eca87e8dSBarry Smith Not Collective 956eca87e8dSBarry Smith 957d382aafbSBarry Smith Input Parameter: 958390e1bf2SBarry Smith . memory - memory to free (the pointer is ALWAYS set to NULL upon sucess) 959d382aafbSBarry Smith 960d382aafbSBarry Smith Level: beginner 961d382aafbSBarry Smith 96249d7da52SJed Brown Notes: 963390e1bf2SBarry Smith Do not free memory obtained with PetscMalloc2(), PetscCalloc2() etc, they must be freed with PetscFree2() etc. 964390e1bf2SBarry Smith 96549d7da52SJed Brown It is safe to call PetscFree() on a NULL pointer. 966d382aafbSBarry Smith 967390e1bf2SBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscNewLog(), PetscMalloc1(), PetscCalloc1() 968d382aafbSBarry Smith 969d382aafbSBarry Smith M*/ 97049d7da52SJed Brown #define PetscFree(a) ((*PetscTrFree)((void*)(a),__LINE__,PETSC_FUNCTION_NAME,__FILE__) || ((a) = 0,0)) 971d382aafbSBarry Smith 972d382aafbSBarry Smith /*MC 973d382aafbSBarry Smith PetscFree2 - Frees 2 chunks of memory obtained with PetscMalloc2() 974d382aafbSBarry Smith 975eca87e8dSBarry Smith Synopsis: 976aaa7dc30SBarry Smith #include <petscsys.h> 977eca87e8dSBarry Smith PetscErrorCode PetscFree2(void *memory1,void *memory2) 978eca87e8dSBarry Smith 979eca87e8dSBarry Smith Not Collective 980eca87e8dSBarry Smith 981e28ce29aSPatrick Sanan Input Parameters: 982d382aafbSBarry Smith + memory1 - memory to free 983d382aafbSBarry Smith - memory2 - 2nd memory to free 984d382aafbSBarry Smith 985d382aafbSBarry Smith Level: developer 986d382aafbSBarry Smith 98795452b02SPatrick Sanan Notes: 98895452b02SPatrick Sanan Memory must have been obtained with PetscMalloc2() 989d382aafbSBarry Smith 990d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree() 991d382aafbSBarry Smith 992d382aafbSBarry Smith M*/ 993ba282f50SJed Brown #define PetscFree2(m1,m2) PetscFreeA(2,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2)) 994d382aafbSBarry Smith 995d382aafbSBarry Smith /*MC 996d382aafbSBarry Smith PetscFree3 - Frees 3 chunks of memory obtained with PetscMalloc3() 997d382aafbSBarry Smith 998eca87e8dSBarry Smith Synopsis: 999aaa7dc30SBarry Smith #include <petscsys.h> 1000eca87e8dSBarry Smith PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3) 1001eca87e8dSBarry Smith 1002eca87e8dSBarry Smith Not Collective 1003eca87e8dSBarry Smith 1004e28ce29aSPatrick Sanan Input Parameters: 1005d382aafbSBarry Smith + memory1 - memory to free 1006d382aafbSBarry Smith . memory2 - 2nd memory to free 1007d382aafbSBarry Smith - memory3 - 3rd memory to free 1008d382aafbSBarry Smith 1009d382aafbSBarry Smith Level: developer 1010d382aafbSBarry Smith 101195452b02SPatrick Sanan Notes: 101295452b02SPatrick Sanan Memory must have been obtained with PetscMalloc3() 1013d382aafbSBarry Smith 1014d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3() 1015d382aafbSBarry Smith 1016d382aafbSBarry Smith M*/ 1017ba282f50SJed Brown #define PetscFree3(m1,m2,m3) PetscFreeA(3,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3)) 1018d382aafbSBarry Smith 1019d382aafbSBarry Smith /*MC 1020d382aafbSBarry Smith PetscFree4 - Frees 4 chunks of memory obtained with PetscMalloc4() 1021d382aafbSBarry Smith 1022eca87e8dSBarry Smith Synopsis: 1023aaa7dc30SBarry Smith #include <petscsys.h> 1024eca87e8dSBarry Smith PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4) 1025eca87e8dSBarry Smith 1026eca87e8dSBarry Smith Not Collective 1027eca87e8dSBarry Smith 1028e28ce29aSPatrick Sanan Input Parameters: 1029d382aafbSBarry Smith + m1 - memory to free 1030d382aafbSBarry Smith . m2 - 2nd memory to free 1031d382aafbSBarry Smith . m3 - 3rd memory to free 1032d382aafbSBarry Smith - m4 - 4th memory to free 1033d382aafbSBarry Smith 1034d382aafbSBarry Smith Level: developer 1035d382aafbSBarry Smith 103695452b02SPatrick Sanan Notes: 103795452b02SPatrick Sanan Memory must have been obtained with PetscMalloc4() 1038d382aafbSBarry Smith 1039d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4() 1040d382aafbSBarry Smith 1041d382aafbSBarry Smith M*/ 1042ba282f50SJed Brown #define PetscFree4(m1,m2,m3,m4) PetscFreeA(4,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4)) 1043d382aafbSBarry Smith 1044d382aafbSBarry Smith /*MC 1045d382aafbSBarry Smith PetscFree5 - Frees 5 chunks of memory obtained with PetscMalloc5() 1046d382aafbSBarry Smith 1047eca87e8dSBarry Smith Synopsis: 1048aaa7dc30SBarry Smith #include <petscsys.h> 1049eca87e8dSBarry Smith PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5) 1050eca87e8dSBarry Smith 1051eca87e8dSBarry Smith Not Collective 1052eca87e8dSBarry Smith 1053e28ce29aSPatrick Sanan Input Parameters: 1054d382aafbSBarry Smith + m1 - memory to free 1055d382aafbSBarry Smith . m2 - 2nd memory to free 1056d382aafbSBarry Smith . m3 - 3rd memory to free 1057d382aafbSBarry Smith . m4 - 4th memory to free 1058d382aafbSBarry Smith - m5 - 5th memory to free 1059d382aafbSBarry Smith 1060d382aafbSBarry Smith Level: developer 1061d382aafbSBarry Smith 106295452b02SPatrick Sanan Notes: 106395452b02SPatrick Sanan Memory must have been obtained with PetscMalloc5() 1064d382aafbSBarry Smith 1065d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5() 1066d382aafbSBarry Smith 1067d382aafbSBarry Smith M*/ 1068ba282f50SJed Brown #define PetscFree5(m1,m2,m3,m4,m5) PetscFreeA(5,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5)) 1069d382aafbSBarry Smith 1070d382aafbSBarry Smith /*MC 1071d382aafbSBarry Smith PetscFree6 - Frees 6 chunks of memory obtained with PetscMalloc6() 1072d382aafbSBarry Smith 1073eca87e8dSBarry Smith Synopsis: 1074aaa7dc30SBarry Smith #include <petscsys.h> 1075eca87e8dSBarry Smith PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6) 1076eca87e8dSBarry Smith 1077eca87e8dSBarry Smith Not Collective 1078eca87e8dSBarry Smith 1079e28ce29aSPatrick Sanan Input Parameters: 1080d382aafbSBarry Smith + m1 - memory to free 1081d382aafbSBarry Smith . m2 - 2nd memory to free 1082d382aafbSBarry Smith . m3 - 3rd memory to free 1083d382aafbSBarry Smith . m4 - 4th memory to free 1084d382aafbSBarry Smith . m5 - 5th memory to free 1085d382aafbSBarry Smith - m6 - 6th memory to free 1086d382aafbSBarry Smith 1087d382aafbSBarry Smith 1088d382aafbSBarry Smith Level: developer 1089d382aafbSBarry Smith 109095452b02SPatrick Sanan Notes: 109195452b02SPatrick Sanan Memory must have been obtained with PetscMalloc6() 1092d382aafbSBarry Smith 1093d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6() 1094d382aafbSBarry Smith 1095d382aafbSBarry Smith M*/ 1096ba282f50SJed Brown #define PetscFree6(m1,m2,m3,m4,m5,m6) PetscFreeA(6,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5),&(m6)) 1097d382aafbSBarry Smith 1098d382aafbSBarry Smith /*MC 1099d382aafbSBarry Smith PetscFree7 - Frees 7 chunks of memory obtained with PetscMalloc7() 1100d382aafbSBarry Smith 1101eca87e8dSBarry Smith Synopsis: 1102aaa7dc30SBarry Smith #include <petscsys.h> 1103eca87e8dSBarry Smith PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7) 1104eca87e8dSBarry Smith 1105eca87e8dSBarry Smith Not Collective 1106eca87e8dSBarry Smith 1107e28ce29aSPatrick Sanan Input Parameters: 1108d382aafbSBarry Smith + m1 - memory to free 1109d382aafbSBarry Smith . m2 - 2nd memory to free 1110d382aafbSBarry Smith . m3 - 3rd memory to free 1111d382aafbSBarry Smith . m4 - 4th memory to free 1112d382aafbSBarry Smith . m5 - 5th memory to free 1113d382aafbSBarry Smith . m6 - 6th memory to free 1114d382aafbSBarry Smith - m7 - 7th memory to free 1115d382aafbSBarry Smith 1116d382aafbSBarry Smith 1117d382aafbSBarry Smith Level: developer 1118d382aafbSBarry Smith 111995452b02SPatrick Sanan Notes: 112095452b02SPatrick Sanan Memory must have been obtained with PetscMalloc7() 1121d382aafbSBarry Smith 1122d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(), 1123d382aafbSBarry Smith PetscMalloc7() 1124d382aafbSBarry Smith 1125d382aafbSBarry Smith M*/ 1126ba282f50SJed Brown #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) PetscFreeA(7,__LINE__,PETSC_FUNCTION_NAME,__FILE__,&(m1),&(m2),&(m3),&(m4),&(m5),&(m6),&(m7)) 1127d382aafbSBarry Smith 1128ba282f50SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocA(int,PetscBool,int,const char *,const char *,size_t,void *,...); 1129ba282f50SJed Brown PETSC_EXTERN PetscErrorCode PetscFreeA(int,int,const char *,const char *,void *,...); 1130efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t,int,const char[],const char[],void**); 1131efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[]); 11323221ece2SMatthew G. Knepley PETSC_EXTERN PetscErrorCode (*PetscTrRealloc)(size_t,int,const char[],const char[],void**); 1133ba282f50SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocSetCoalesce(PetscBool); 1134efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t,int,const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[])); 1135014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocClear(void); 1136d382aafbSBarry Smith 1137d382aafbSBarry Smith /* 1138c1706be6SHong 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. 1139c1706be6SHong Zhang */ 1140c1706be6SHong Zhang PETSC_EXTERN PetscErrorCode PetscMallocSetDRAM(void); 1141c1706be6SHong Zhang PETSC_EXTERN PetscErrorCode PetscMallocResetDRAM(void); 1142c1706be6SHong Zhang 1143a5057860SBarry Smith #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE 114436763ca0SBas van 't Hof #define MPIU_2PETSCLOGDOUBLE MPI_2DOUBLE_PRECISION 1145a5057860SBarry Smith 1146a5057860SBarry Smith /* 114766d669d6SBarry Smith Routines for tracing memory corruption/bleeding with default PETSc memory allocation 1148d382aafbSBarry Smith */ 1149014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *); 1150014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocDumpLog(FILE *); 1151014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *); 1152014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *); 1153e3ed9ee7SBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocPushMaximumUsage(int); 1154e3ed9ee7SBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocPopMaximumUsage(int,PetscLogDouble*); 1155014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocDebug(PetscBool); 11560acecf5bSBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool*); 1157efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode PetscMallocValidate(int,const char[],const char[]); 1158014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLog(void); 1159574034a9SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLogThreshold(PetscLogDouble); 1160014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocGetDumpLog(PetscBool*); 1161d382aafbSBarry Smith 11626a6fc655SJed Brown PETSC_EXTERN const char *const PetscDataTypes[]; 1163014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*); 1164014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*); 1165014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*); 11668e4b2d1dSBarry Smith PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char*,PetscDataType*,PetscBool*); 1167d382aafbSBarry Smith 1168d382aafbSBarry Smith /* 1169d382aafbSBarry Smith Basic memory and string operations. These are usually simple wrappers 1170d382aafbSBarry Smith around the basic Unix system calls, but a few of them have additional 1171d382aafbSBarry Smith functionality and/or error checking. 1172d382aafbSBarry Smith */ 1173014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType); 1174014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemmove(void*,void *,size_t); 1175014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemcmp(const void*,const void*,size_t,PetscBool *); 1176014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrlen(const char[],size_t*); 1177d67fe73bSBarry Smith PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[],char,int*,char ***); 1178014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int,char **); 1179014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[],const char[],PetscBool *); 1180014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[],const char[],PetscBool *); 1181014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[],const char[],PetscBool *); 1182014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[],const char[],size_t,PetscBool *); 1183014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcpy(char[],const char[]); 1184014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcat(char[],const char[]); 1185a126751eSBarry Smith PETSC_EXTERN PetscErrorCode PetscStrlcat(char[],const char[],size_t); 1186014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrncpy(char[],const char[],size_t); 1187014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrchr(const char[],char,char *[]); 1188014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]); 11892f234a98SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrtoupper(char[]); 1190014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[],char,char *[]); 1191014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrstr(const char[],const char[],char *[]); 1192014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[],const char[],char *[]); 1193014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[],const char[],PetscBool*); 11942c9581d2SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[],const char[],PetscBool*); 1195014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[],const char *const*,PetscInt*); 1196014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[],char *[]); 119747340559SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const*,char***); 11986fed8037SJed Brown PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char***); 11996991f827SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrNArrayallocpy(PetscInt,const char *const*,char***); 12006991f827SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrNArrayDestroy(PetscInt,char***); 1201014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm,const char[],char[],size_t); 1202d382aafbSBarry Smith 1203573b0fb4SBarry Smith PETSC_EXTERN void PetscStrcmpNoError(const char[],const char[],PetscBool *); 1204573b0fb4SBarry Smith 1205014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*); 1206014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]); 1207014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*); 12088e81d068SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscStrInList(const char[],const char[],char,PetscBool*); 1209d382aafbSBarry Smith 1210a53986e1SJed Brown PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt,const char *const*,const char*,PetscInt*,PetscBool*); 1211a53986e1SJed Brown PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const*,const char*,PetscEnum*,PetscBool*); 1212a53986e1SJed Brown 1213d382aafbSBarry Smith /* 1214d382aafbSBarry Smith These are MPI operations for MPI_Allreduce() etc 1215d382aafbSBarry Smith */ 1216367daffbSBarry Smith PETSC_EXTERN MPI_Op MPIU_MAXSUM_OP; 1217570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 1218014dd563SJed Brown PETSC_EXTERN MPI_Op MPIU_SUM; 12192414b3c7SJed Brown #else 12202414b3c7SJed Brown #define MPIU_SUM MPI_SUM 12212414b3c7SJed Brown #endif 1222570b7f6dSBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 1223014dd563SJed Brown PETSC_EXTERN MPI_Op MPIU_MAX; 1224014dd563SJed Brown PETSC_EXTERN MPI_Op MPIU_MIN; 1225d9822059SBarry Smith #else 1226d9822059SBarry Smith #define MPIU_MAX MPI_MAX 1227d9822059SBarry Smith #define MPIU_MIN MPI_MIN 1228d9822059SBarry Smith #endif 1229014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*); 1230d382aafbSBarry Smith 1231014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm); 1232014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm); 1233eb3f98d2SBarry Smith 123495c0884eSLisandro Dalcin PETSC_EXTERN const char *const PetscFileModes[]; 1235d6a4318aSJed Brown 1236639ff905SBarry Smith /* 1237639ff905SBarry Smith Defines PETSc error handling. 1238639ff905SBarry Smith */ 1239639ff905SBarry Smith #include <petscerror.h> 1240d382aafbSBarry Smith 12410700a824SBarry Smith #define PETSC_SMALLEST_CLASSID 1211211 1242014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID; 1243014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID; 1244014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *); 1245d382aafbSBarry Smith 1246d382aafbSBarry Smith /* 1247d382aafbSBarry Smith Routines that get memory usage information from the OS 1248d382aafbSBarry Smith */ 1249014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *); 1250014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *); 1251014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void); 1252b44d5720SBarry Smith PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]); 1253d382aafbSBarry Smith 1254014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInfoAllow(PetscBool ,const char []); 1255014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal); 1256d382aafbSBarry Smith 1257d382aafbSBarry Smith /* 1258d382aafbSBarry Smith Initialization of PETSc 1259d382aafbSBarry Smith */ 1260014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]); 1261014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]); 1262014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void); 1263014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *); 1264014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *); 1265014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFinalize(void); 1266014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void); 1267014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***); 1268014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***); 1269014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **); 1270d382aafbSBarry Smith 1271014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscEnd(void); 1272607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void); 1273d382aafbSBarry Smith 1274014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]); 1275014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void); 1276014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void); 1277014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]); 1278d382aafbSBarry Smith 1279d382aafbSBarry Smith /* 1280d382aafbSBarry Smith These are so that in extern C code we can caste function pointers to non-extern C 12812981ebdbSBarry Smith function pointers. Since the regular C++ code expects its function pointers to be C++ 1282d382aafbSBarry Smith */ 1283638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void); 1284638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void); 1285638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void); 1286d382aafbSBarry Smith 1287d382aafbSBarry Smith /* 1288d382aafbSBarry Smith Functions that can act on any PETSc object. 1289d382aafbSBarry Smith */ 1290014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject*); 1291014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject,MPI_Comm *); 1292014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject,PetscClassId *); 1293014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject,const char *[]); 1294014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetType(PetscObject,const char []); 1295014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject,const char *[]); 1296014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject,const char[]); 1297014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject,const char*[]); 1298014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject,PetscInt); 1299014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject,PetscInt*); 1300014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt); 1301014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject); 1302014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject,PetscInt*); 1303014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject); 1304014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject,PetscMPIInt *); 1305014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject,const char[],PetscObject); 1306014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject,const char[]); 1307014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject,const char[],PetscObject *); 1308bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject,const char[],void (*)(void)); 1309bdf89e91SBarry Smith #define PetscObjectComposeFunction(a,b,d) PetscObjectComposeFunction_Private(a,b,(PetscVoidFunction)(d)) 1310014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject); 1311014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject); 13120eb63584SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSetPrintedOptions(PetscObject); 13130eb63584SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectInheritPrintedOptions(PetscObject,PetscObject); 1314014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm,PetscMPIInt *); 1315d382aafbSBarry Smith 1316665c2dedSJed Brown #include <petscviewertypes.h> 1317639ff905SBarry Smith #include <petscoptions.h> 1318639ff905SBarry Smith 13190633abcbSJed Brown PETSC_EXTERN PetscErrorCode PetscObjectsListGetGlobalNumbering(MPI_Comm,PetscInt,PetscObject*,PetscInt*,PetscInt*); 13200633abcbSJed Brown 1321639ff905SBarry Smith PETSC_EXTERN PetscErrorCode PetscMemoryShowUsage(PetscViewer,const char[]); 1322c5e4d11fSDmitry Karpeev PETSC_EXTERN PetscErrorCode PetscMemoryView(PetscViewer,const char[]); 1323dae58748SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject,PetscViewer); 1324639ff905SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject,PetscViewer); 13250005d66cSJed Brown #define PetscObjectQueryFunction(obj,name,fptr) PetscObjectQueryFunction_Private((obj),(name),(PetscVoidFunction*)(fptr)) 13260005d66cSJed Brown PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject,const char[],void (**)(void)); 1327014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject,const char[]); 1328014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject,const char[]); 1329014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject,const char[]); 1330014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject,const char*[]); 1331014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject,const char[]); 1332014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject); 1333014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void); 1334685405a1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject,PetscObject,const char[]); 1335014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject); 1336014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject,const char[],PetscBool *); 13374099cc6bSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectBaseTypeCompare(PetscObject,const char[],PetscBool *); 1338014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject,PetscBool*,const char[],...); 1339014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void)); 1340014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void); 1341d382aafbSBarry Smith 1342e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 13437aab2a10SBarry Smith PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void); 1344e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject); 1345e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject,PetscBool); 1346e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject); 1347e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject); 1348e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject); 1349e04113cfSBarry Smith PETSC_EXTERN void PetscStackSAWsGrantAccess(void); 1350e04113cfSBarry Smith PETSC_EXTERN void PetscStackSAWsTakeAccess(void); 1351e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void); 1352e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void); 135315681b3cSBarry Smith 1354ec7429eaSBarry Smith #else 13557aab2a10SBarry Smith #define PetscSAWsBlock() 0 1356e04113cfSBarry Smith #define PetscObjectSAWsViewOff(obj) 0 1357e04113cfSBarry Smith #define PetscObjectSAWsSetBlock(obj,flg) 0 1358e04113cfSBarry Smith #define PetscObjectSAWsBlock(obj) 0 1359e04113cfSBarry Smith #define PetscObjectSAWsGrantAccess(obj) 0 1360e04113cfSBarry Smith #define PetscObjectSAWsTakeAccess(obj) 0 1361e04113cfSBarry Smith #define PetscStackViewSAWs() 0 1362e04113cfSBarry Smith #define PetscStackSAWsViewOff() 0 1363e04113cfSBarry Smith #define PetscStackSAWsTakeAccess() 1364e04113cfSBarry Smith #define PetscStackSAWsGrantAccess() 136515681b3cSBarry Smith 1366ec7429eaSBarry Smith #endif 1367b90c6cbeSBarry Smith 136882b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *); 136982b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *); 137082b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **); 13717d5d4d99SBarry Smith 13725fe58b6fSBarry Smith #if defined(PETSC_USE_DEBUG) 1373a64a8e02SBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**); 13745fe58b6fSBarry Smith #endif 13757eb1d149SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool); 1376a64a8e02SBarry Smith 1377140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList*); 1378140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList,const char[],PetscObject*); 1379140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList,PetscObject,char**,PetscBool*); 1380140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *,const char[],PetscObject); 1381140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *,const char[]); 1382140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList,PetscObjectList *); 1383d382aafbSBarry Smith 1384d382aafbSBarry Smith /* 1385503cfb0cSBarry Smith Dynamic library lists. Lists of names of routines in objects or in dynamic 1386d382aafbSBarry Smith link libraries that will be loaded as needed. 1387d382aafbSBarry Smith */ 1388a240a19fSJed Brown 1389a240a19fSJed Brown #define PetscFunctionListAdd(list,name,fptr) PetscFunctionListAdd_Private((list),(name),(PetscVoidFunction)(fptr)) 1390a240a19fSJed Brown PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList*,const char[],void (*)(void)); 1391140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList*); 13921c9cd337SJed Brown #define PetscFunctionListFind(list,name,fptr) PetscFunctionListFind_Private((list),(name),(PetscVoidFunction*)(fptr)) 13931c9cd337SJed Brown PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList,const char[],void (**)(void)); 1394140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFunctionList,const char[]); 1395140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList,PetscFunctionList *); 1396140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList,PetscViewer); 1397140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList,const char ***,int*); 1398d382aafbSBarry Smith 1399014dd563SJed Brown PETSC_EXTERN PetscDLLibrary PetscDLLibrariesLoaded; 1400014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]); 1401014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]); 1402014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **); 1403014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary); 1404014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool *); 1405014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *); 1406014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary); 1407d382aafbSBarry Smith 1408d382aafbSBarry Smith /* 1409d382aafbSBarry Smith Useful utility routines 1410d382aafbSBarry Smith */ 1411014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*); 1412014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*); 1413014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt); 1414014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt); 1415014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject); 1416014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*); 14176ba4152bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxInt(MPI_Comm,PetscInt[],PetscInt[]); 14186ba4152bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscGlobalMinMaxReal(MPI_Comm,PetscReal[],PetscReal[]); 1419d382aafbSBarry Smith 142064ac3b0dSPatrick Sanan /*MC 1421ace3abfcSBarry Smith PetscNot - negates a logical type value and returns result as a PetscBool 1422503cfb0cSBarry Smith 1423e28ce29aSPatrick Sanan Notes: 1424e28ce29aSPatrick Sanan This is useful in cases like 1425503cfb0cSBarry Smith $ int *a; 1426ace3abfcSBarry Smith $ PetscBool flag = PetscNot(a) 14271cc8b206SBarry Smith where !a would not return a PetscBool because we cannot provide a cast from int to PetscBool in C. 142864ac3b0dSPatrick Sanan 142964ac3b0dSPatrick Sanan Level: beginner 143064ac3b0dSPatrick Sanan 143164ac3b0dSPatrick Sanan .seealso : PetscBool, PETSC_TRUE, PETSC_FALSE 143264ac3b0dSPatrick Sanan M*/ 1433d382aafbSBarry Smith #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE) 1434503cfb0cSBarry Smith 1435d382aafbSBarry Smith /*MC 1436d382aafbSBarry Smith PetscHelpPrintf - Prints help messages. 1437d382aafbSBarry Smith 1438d382aafbSBarry Smith Synopsis: 1439aaa7dc30SBarry Smith #include <petscsys.h> 1440d382aafbSBarry Smith PetscErrorCode (*PetscHelpPrintf)(const char format[],...); 1441d382aafbSBarry Smith 1442eca87e8dSBarry Smith Not Collective 1443eca87e8dSBarry Smith 1444d382aafbSBarry Smith Input Parameters: 1445d382aafbSBarry Smith . format - the usual printf() format string 1446d382aafbSBarry Smith 1447d382aafbSBarry Smith Level: developer 1448d382aafbSBarry Smith 1449d382aafbSBarry Smith Fortran Note: 1450d382aafbSBarry Smith This routine is not supported in Fortran. 1451d382aafbSBarry Smith 1452d382aafbSBarry Smith 1453d382aafbSBarry Smith .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf() 1454d382aafbSBarry Smith M*/ 1455014dd563SJed Brown PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...); 1456d382aafbSBarry Smith 1457fcfd50ebSBarry Smith /* 1458fcfd50ebSBarry Smith Defines PETSc profiling. 1459fcfd50ebSBarry Smith */ 14602c8e378dSBarry Smith #include <petsclog.h> 1461fcfd50ebSBarry Smith 1462fcfd50ebSBarry Smith /* 1463fcfd50ebSBarry Smith Simple PETSc parallel IO for ASCII printing 1464fcfd50ebSBarry Smith */ 1465014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]); 1466014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**); 1467014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*); 1468014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...); 1469014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...); 1470014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...); 1471014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...); 14721b5687a1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFormatRealArray(char[],size_t,const char*,PetscInt,const PetscReal[]); 1473fcfd50ebSBarry Smith 1474014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...); 1475014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...); 1476014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...); 1477d382aafbSBarry Smith 1478d781fa04SBarry Smith PETSC_EXTERN PetscErrorCode PetscFormatConvertGetSize(const char*,size_t*); 1479d781fa04SBarry Smith PETSC_EXTERN PetscErrorCode PetscFormatConvert(const char*,char *); 1480d781fa04SBarry Smith 1481d382aafbSBarry Smith #if defined(PETSC_HAVE_POPEN) 1482014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **); 1483016831caSBarry Smith PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm,FILE*); 148474ba8654SBarry Smith PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]); 1485d382aafbSBarry Smith #endif 1486d382aafbSBarry Smith 1487014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm,const char[],...); 1488014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...); 14890ec8b6e3SBarry Smith PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm,FILE*); 1490014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]); 1491014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**); 1492014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm,const char[],const char[],FILE**); 1493014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char*[]); 1494d382aafbSBarry Smith 1495014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID; 1496014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer,void **); 1497014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer,void *); 1498014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer*); 1499014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm,PetscContainer *); 1500014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void*)); 1501b61ba218SStefano Zampini PETSC_EXTERN PetscErrorCode PetscContainerUserDestroyDefault(void*); 1502d382aafbSBarry Smith 1503d382aafbSBarry Smith /* 1504d382aafbSBarry Smith For use in debuggers 1505d382aafbSBarry Smith */ 1506014dd563SJed Brown PETSC_EXTERN PetscMPIInt PetscGlobalRank; 1507014dd563SJed Brown PETSC_EXTERN PetscMPIInt PetscGlobalSize; 1508014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt,const PetscInt[],PetscViewer); 1509014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt,const PetscReal[],PetscViewer); 1510014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt,const PetscScalar[],PetscViewer); 1511d382aafbSBarry Smith 1512a663daf8SBarry Smith #include <stddef.h> 1513a3aaec0aSJed Brown #include <string.h> /* for memcpy, memset */ 1514d382aafbSBarry Smith #if defined(PETSC_HAVE_STDLIB_H) 1515d382aafbSBarry Smith #include <stdlib.h> 1516d382aafbSBarry Smith #endif 15176c7e564aSBarry Smith 15184a92a979SJed Brown #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__) 1519d382aafbSBarry Smith #include <xmmintrin.h> 1520d382aafbSBarry Smith #endif 1521d382aafbSBarry Smith 1522d382aafbSBarry Smith /*@C 1523d382aafbSBarry Smith PetscMemcpy - Copies n bytes, beginning at location b, to the space 1524d382aafbSBarry Smith beginning at location a. The two memory regions CANNOT overlap, use 1525d382aafbSBarry Smith PetscMemmove() in that case. 1526d382aafbSBarry Smith 1527d382aafbSBarry Smith Not Collective 1528d382aafbSBarry Smith 1529d382aafbSBarry Smith Input Parameters: 1530d382aafbSBarry Smith + b - pointer to initial memory space 1531d382aafbSBarry Smith - n - length (in bytes) of space to copy 1532d382aafbSBarry Smith 1533d382aafbSBarry Smith Output Parameter: 1534d382aafbSBarry Smith . a - pointer to copy space 1535d382aafbSBarry Smith 1536d382aafbSBarry Smith Level: intermediate 1537d382aafbSBarry Smith 1538d382aafbSBarry Smith Compile Option: 1539d382aafbSBarry Smith PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used 1540d382aafbSBarry Smith for memory copies on double precision values. 1541d382aafbSBarry Smith PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used 1542d382aafbSBarry Smith for memory copies on double precision values. 1543d382aafbSBarry Smith PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used 1544d382aafbSBarry Smith for memory copies on double precision values. 1545d382aafbSBarry Smith 1546d382aafbSBarry Smith Note: 1547d382aafbSBarry Smith This routine is analogous to memcpy(). 1548d382aafbSBarry Smith 15491fd49c25SBarry Smith Not available from Fortran 15501fd49c25SBarry Smith 1551f5f57ec0SBarry Smith Developer Note: this is inlined for fastest performance 1552f5f57ec0SBarry Smith 1553d382aafbSBarry Smith 15541fd49c25SBarry Smith .seealso: PetscMemmove(), PetscStrallocpy() 1555d382aafbSBarry Smith 1556d382aafbSBarry Smith @*/ 15577087cfbeSBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscMemcpy(void *a,const void *b,size_t n) 1558d382aafbSBarry Smith { 1559d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG) 1560c5e4d11fSDmitry Karpeev size_t al = (size_t) a,bl = (size_t) b; 1561c5e4d11fSDmitry Karpeev size_t nl = (size_t) n; 1562a7e36092SMatthew G Knepley PetscFunctionBegin; 1563e32f2f54SBarry Smith if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer"); 1564e32f2f54SBarry Smith if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer"); 1565a7e36092SMatthew G Knepley #else 1566d382aafbSBarry Smith PetscFunctionBegin; 1567a7e36092SMatthew G Knepley #endif 1568a47a537aSLisandro Dalcin if (a != b && n > 0) { 1569d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG) 1570e47d2de2SBarry 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\ 1571d382aafbSBarry Smith or make sure your copy regions and lengths are correct. \n\ 1572d382aafbSBarry Smith Length (bytes) %ld first address %ld second address %ld",nl,al,bl); 1573d382aafbSBarry Smith #endif 1574d382aafbSBarry Smith #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY)) 1575c5e4d11fSDmitry Karpeev if (!(a % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1576d382aafbSBarry Smith size_t len = n/sizeof(PetscScalar); 1577d382aafbSBarry Smith #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) 1578c5df96a5SBarry Smith PetscBLASInt one = 1,blen; 1579c5df96a5SBarry Smith PetscErrorCode ierr; 1580c5df96a5SBarry Smith ierr = PetscBLASIntCast(len,&blen);CHKERRQ(ierr); 15818b83055fSJed Brown PetscStackCallBLAS("BLAScopy",BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one)); 1582d382aafbSBarry Smith #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY) 1583d382aafbSBarry Smith fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a); 1584d382aafbSBarry Smith #else 1585d382aafbSBarry Smith size_t i; 1586d382aafbSBarry Smith PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a; 1587d382aafbSBarry Smith for (i=0; i<len; i++) y[i] = x[i]; 1588d382aafbSBarry Smith #endif 1589d382aafbSBarry Smith } else { 1590d382aafbSBarry Smith memcpy((char*)(a),(char*)(b),n); 1591d382aafbSBarry Smith } 1592d382aafbSBarry Smith #else 1593d382aafbSBarry Smith memcpy((char*)(a),(char*)(b),n); 1594d382aafbSBarry Smith #endif 1595d382aafbSBarry Smith } 1596d382aafbSBarry Smith PetscFunctionReturn(0); 1597d382aafbSBarry Smith } 1598d382aafbSBarry Smith 1599d382aafbSBarry Smith /*@C 1600d382aafbSBarry Smith PetscMemzero - Zeros the specified memory. 1601d382aafbSBarry Smith 1602d382aafbSBarry Smith Not Collective 1603d382aafbSBarry Smith 1604d382aafbSBarry Smith Input Parameters: 1605d382aafbSBarry Smith + a - pointer to beginning memory location 1606d382aafbSBarry Smith - n - length (in bytes) of memory to initialize 1607d382aafbSBarry Smith 1608d382aafbSBarry Smith Level: intermediate 1609d382aafbSBarry Smith 1610d382aafbSBarry Smith Compile Option: 1611d382aafbSBarry Smith PETSC_PREFER_BZERO - on certain machines (the IBM RS6000) the bzero() routine happens 1612d382aafbSBarry Smith to be faster than the memset() routine. This flag causes the bzero() routine to be used. 1613d382aafbSBarry Smith 16141fd49c25SBarry Smith Not available from Fortran 16151fd49c25SBarry Smith 1616503cfb0cSBarry Smith Developer Note: this is inlined for fastest performance 1617503cfb0cSBarry Smith 1618d382aafbSBarry Smith 1619d382aafbSBarry Smith .seealso: PetscMemcpy() 1620d382aafbSBarry Smith @*/ 16217087cfbeSBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscMemzero(void *a,size_t n) 1622d382aafbSBarry Smith { 1623d382aafbSBarry Smith if (n > 0) { 1624d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG) 1625e32f2f54SBarry Smith if (!a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer"); 1626d382aafbSBarry Smith #endif 1627d382aafbSBarry Smith #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) 1628d382aafbSBarry Smith if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1629d382aafbSBarry Smith size_t i,len = n/sizeof(PetscScalar); 1630d382aafbSBarry Smith PetscScalar *x = (PetscScalar*)a; 1631d382aafbSBarry Smith for (i=0; i<len; i++) x[i] = 0.0; 1632d382aafbSBarry Smith } else { 1633d382aafbSBarry Smith #elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO) 1634d382aafbSBarry Smith if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1635d382aafbSBarry Smith PetscInt len = n/sizeof(PetscScalar); 1636d382aafbSBarry Smith fortranzero_(&len,(PetscScalar*)a); 1637d382aafbSBarry Smith } else { 1638d382aafbSBarry Smith #endif 1639d382aafbSBarry Smith #if defined(PETSC_PREFER_BZERO) 1640d382aafbSBarry Smith bzero((char *)a,n); 1641d382aafbSBarry Smith #else 1642d382aafbSBarry Smith memset((char*)a,0,n); 1643d382aafbSBarry Smith #endif 1644d382aafbSBarry Smith #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO) 1645d382aafbSBarry Smith } 1646d382aafbSBarry Smith #endif 1647d382aafbSBarry Smith } 1648d382aafbSBarry Smith return 0; 1649d382aafbSBarry Smith } 1650d382aafbSBarry Smith 1651d382aafbSBarry Smith /*MC 1652d382aafbSBarry Smith PetscPrefetchBlock - Prefetches a block of memory 1653d382aafbSBarry Smith 1654eca87e8dSBarry Smith Synopsis: 1655aaa7dc30SBarry Smith #include <petscsys.h> 1656eca87e8dSBarry Smith void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t) 1657eca87e8dSBarry Smith 1658d382aafbSBarry Smith Not Collective 1659d382aafbSBarry Smith 1660d382aafbSBarry Smith Input Parameters: 1661d382aafbSBarry Smith + a - pointer to first element to fetch (any type but usually PetscInt or PetscScalar) 1662d382aafbSBarry Smith . n - number of elements to fetch 1663d382aafbSBarry Smith . rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors) 166450d8bf02SJed Brown - t - temporal locality (PETSC_PREFETCH_HINT_{NTA,T0,T1,T2}), see note 1665d382aafbSBarry Smith 1666d382aafbSBarry Smith Level: developer 1667d382aafbSBarry Smith 1668d382aafbSBarry Smith Notes: 1669d382aafbSBarry Smith The last two arguments (rw and t) must be compile-time constants. 1670d382aafbSBarry Smith 167150d8bf02SJed Brown Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality. Not all architectures offer 167250d8bf02SJed Brown equivalent locality hints, but the following macros are always defined to their closest analogue. 167350d8bf02SJed 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). 167463cf1ef0SJed 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. 167563cf1ef0SJed Brown . PETSC_PREFETCH_HINT_T1 - Fetch to level 2 and higher (not L1). 167663cf1ef0SJed Brown - PETSC_PREFETCH_HINT_T2 - Fetch to high-level cache only. (On many systems, T0 and T1 are equivalent.) 1677d382aafbSBarry Smith 1678d382aafbSBarry Smith This function does nothing on architectures that do not support prefetch and never errors (even if passed an invalid 1679d382aafbSBarry Smith address). 1680d382aafbSBarry Smith 1681d382aafbSBarry Smith M*/ 1682d382aafbSBarry Smith #define PetscPrefetchBlock(a,n,rw,t) do { \ 1683d382aafbSBarry Smith const char *_p = (const char*)(a),*_end = (const char*)((a)+(n)); \ 1684d382aafbSBarry Smith for ( ; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p,(rw),(t)); \ 1685d382aafbSBarry Smith } while (0) 1686d382aafbSBarry Smith 1687d382aafbSBarry Smith /* 1688d382aafbSBarry Smith Determine if some of the kernel computation routines use 1689d382aafbSBarry Smith Fortran (rather than C) for the numerical calculations. On some machines 1690d382aafbSBarry Smith and compilers (like complex numbers) the Fortran version of the routines 1691d382aafbSBarry Smith is faster than the C/C++ versions. The flag --with-fortran-kernels 1692e2e64c6bSBarry Smith should be used with ./configure to turn these on. 1693d382aafbSBarry Smith */ 1694d382aafbSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS) 1695d382aafbSBarry Smith 1696d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL) 1697d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTCRL 1698d382aafbSBarry Smith #endif 1699d382aafbSBarry Smith 17005a11e1b2SBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM) 17015a11e1b2SBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM 1702d382aafbSBarry Smith #endif 1703d382aafbSBarry Smith 1704d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ) 1705d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ 1706d382aafbSBarry Smith #endif 1707d382aafbSBarry Smith 1708d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ) 1709d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ 1710d382aafbSBarry Smith #endif 1711d382aafbSBarry Smith 1712d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM) 1713d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_NORM 1714d382aafbSBarry Smith #endif 1715d382aafbSBarry Smith 1716d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY) 1717d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MAXPY 1718d382aafbSBarry Smith #endif 1719d382aafbSBarry Smith 1720d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ) 1721d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ 1722d382aafbSBarry Smith #endif 1723d382aafbSBarry Smith 1724d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ) 1725d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ 1726d382aafbSBarry Smith #endif 1727d382aafbSBarry Smith 1728d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ) 1729d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ 1730d382aafbSBarry Smith #endif 1731d382aafbSBarry Smith 1732d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ) 1733d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ 1734d382aafbSBarry Smith #endif 1735d382aafbSBarry Smith 1736d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT) 1737d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MDOT 1738d382aafbSBarry Smith #endif 1739d382aafbSBarry Smith 1740d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY) 1741d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_XTIMESY 1742d382aafbSBarry Smith #endif 1743d382aafbSBarry Smith 1744d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX) 1745d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_AYPX 1746d382aafbSBarry Smith #endif 1747d382aafbSBarry Smith 1748d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY) 1749d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_WAXPY 1750d382aafbSBarry Smith #endif 1751d382aafbSBarry Smith 1752d382aafbSBarry Smith #endif 1753d382aafbSBarry Smith 1754d382aafbSBarry Smith /* 1755d382aafbSBarry Smith Macros for indicating code that should be compiled with a C interface, 1756d382aafbSBarry Smith rather than a C++ interface. Any routines that are dynamically loaded 1757d382aafbSBarry Smith (such as the PCCreate_XXX() routines) must be wrapped so that the name 1758d382aafbSBarry Smith mangler does not change the functions symbol name. This just hides the 1759d382aafbSBarry Smith ugly extern "C" {} wrappers. 1760d382aafbSBarry Smith */ 1761d382aafbSBarry Smith #if defined(__cplusplus) 1762d382aafbSBarry Smith # define EXTERN_C_BEGIN extern "C" { 1763d382aafbSBarry Smith # define EXTERN_C_END } 1764d382aafbSBarry Smith #else 1765d382aafbSBarry Smith # define EXTERN_C_BEGIN 1766d382aafbSBarry Smith # define EXTERN_C_END 1767d382aafbSBarry Smith #endif 1768d382aafbSBarry Smith 1769d382aafbSBarry Smith /* --------------------------------------------------------------------*/ 1770d382aafbSBarry Smith 1771d382aafbSBarry Smith /*MC 1772d382aafbSBarry Smith MPI_Comm - the basic object used by MPI to determine which processes are involved in a 1773d382aafbSBarry Smith communication 1774d382aafbSBarry Smith 1775d382aafbSBarry Smith Level: beginner 1776d382aafbSBarry Smith 1777d382aafbSBarry Smith Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm 1778d382aafbSBarry Smith 1779d382aafbSBarry Smith .seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF 1780d382aafbSBarry Smith M*/ 1781d382aafbSBarry Smith 1782d382aafbSBarry Smith #if defined(PETSC_HAVE_MPIIO) 1783014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); 1784014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); 1785d382aafbSBarry Smith #endif 1786d382aafbSBarry Smith 1787d382aafbSBarry Smith /* the following petsc_static_inline require petscerror.h */ 1788d382aafbSBarry Smith 1789d382aafbSBarry Smith /* Limit MPI to 32-bits */ 1790d382aafbSBarry Smith #define PETSC_MPI_INT_MAX 2147483647 1791d382aafbSBarry Smith #define PETSC_MPI_INT_MIN -2147483647 1792d382aafbSBarry Smith /* Limit BLAS to 32-bits */ 1793d382aafbSBarry Smith #define PETSC_BLAS_INT_MAX 2147483647 1794d382aafbSBarry Smith #define PETSC_BLAS_INT_MIN -2147483647 1795d382aafbSBarry Smith 179661b0d812SBarry Smith /*@C 179761b0d812SBarry Smith PetscBLASIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscBLASInt (which may be 32 bits in size), generates an 179861b0d812SBarry Smith error if the PetscBLASInt is not large enough to hold the number. 179961b0d812SBarry Smith 180061b0d812SBarry Smith Not Collective 180161b0d812SBarry Smith 180261b0d812SBarry Smith Input Parameter: 180361b0d812SBarry Smith . a - the PetscInt value 180461b0d812SBarry Smith 180561b0d812SBarry Smith Output Parameter: 180661b0d812SBarry Smith . b - the resulting PetscBLASInt value 180761b0d812SBarry Smith 180861b0d812SBarry Smith Level: advanced 180961b0d812SBarry Smith 18101fd49c25SBarry Smith Not available from Fortran 18111fd49c25SBarry Smith 181261b0d812SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscMPIIntCast() 181361b0d812SBarry Smith @*/ 1814c5df96a5SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscBLASIntCast(PetscInt a,PetscBLASInt *b) 1815c5df96a5SBarry Smith { 1816c5df96a5SBarry Smith PetscFunctionBegin; 1817ab7117d1SBarry Smith *b = (PetscBLASInt)(a); 1818c5df96a5SBarry Smith #if defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_HAVE_64BIT_BLAS_INDICES) 1819c5df96a5SBarry Smith if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK"); 1820c5df96a5SBarry Smith #endif 1821c5df96a5SBarry Smith PetscFunctionReturn(0); 1822c5df96a5SBarry Smith } 1823c5df96a5SBarry Smith 182461b0d812SBarry Smith /*@C 182561b0d812SBarry Smith PetscMPIIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscMPIInt (which may be 32 bits in size), generates an 182661b0d812SBarry Smith error if the PetscMPIInt is not large enough to hold the number. 182761b0d812SBarry Smith 182861b0d812SBarry Smith Not Collective 182961b0d812SBarry Smith 183061b0d812SBarry Smith Input Parameter: 183161b0d812SBarry Smith . a - the PetscInt value 183261b0d812SBarry Smith 183361b0d812SBarry Smith Output Parameter: 183461b0d812SBarry Smith . b - the resulting PetscMPIInt value 183561b0d812SBarry Smith 183661b0d812SBarry Smith Level: advanced 183761b0d812SBarry Smith 18381fd49c25SBarry Smith Not available from Fortran 18391fd49c25SBarry Smith 184061b0d812SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast() 184161b0d812SBarry Smith @*/ 18424dc2109aSBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscMPIIntCast(PetscInt a,PetscMPIInt *b) 18434dc2109aSBarry Smith { 18444dc2109aSBarry Smith PetscFunctionBegin; 1845ab7117d1SBarry Smith *b = (PetscMPIInt)(a); 18464dc2109aSBarry Smith #if defined(PETSC_USE_64BIT_INDICES) 18474dc2109aSBarry Smith if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for MPI"); 18484dc2109aSBarry Smith #endif 18494dc2109aSBarry Smith PetscFunctionReturn(0); 18504dc2109aSBarry Smith } 18514dc2109aSBarry Smith 1852bafee8b4SSatish Balay #define PetscInt64Mult(a,b) ((PetscInt64)(a))*((PetscInt64)(b)) 18532f18eb33SBarry Smith 18542f18eb33SBarry Smith /*@C 18552f18eb33SBarry Smith 18562f18eb33SBarry 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 18572f18eb33SBarry Smith 18582f18eb33SBarry Smith Not Collective 18592f18eb33SBarry Smith 18602f18eb33SBarry Smith Input Parameter: 18612f18eb33SBarry Smith + a - the PetscReal value 18622f18eb33SBarry Smith - b - the second value 18632f18eb33SBarry Smith 1864390e1bf2SBarry Smith Returns: 1865390e1bf2SBarry Smith the result as a PetscInt value 18662f18eb33SBarry Smith 1867bafee8b4SSatish Balay Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64 18682f18eb33SBarry Smith Use PetscIntMultTruncate() to compute the product of two positive PetscInt and truncate to fit a PetscInt 18692f18eb33SBarry 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 18702f18eb33SBarry Smith 1871e28ce29aSPatrick Sanan Developers Note: 1872e28ce29aSPatrick Sanan We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks. 18732f18eb33SBarry Smith 18742f18eb33SBarry Smith This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able. 18752f18eb33SBarry Smith 18761fd49c25SBarry Smith Not available from Fortran 18771fd49c25SBarry Smith 18782f18eb33SBarry Smith Level: advanced 18792f18eb33SBarry Smith 1880390e1bf2SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult() 18812f18eb33SBarry Smith @*/ 18822f18eb33SBarry Smith PETSC_STATIC_INLINE PetscInt PetscRealIntMultTruncate(PetscReal a,PetscInt b) 18832f18eb33SBarry Smith { 1884bafee8b4SSatish Balay PetscInt64 r; 18852f18eb33SBarry Smith 1886bafee8b4SSatish Balay r = (PetscInt64) (a*(PetscReal)b); 18872f18eb33SBarry Smith if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100; 18882f18eb33SBarry Smith return (PetscInt) r; 18892f18eb33SBarry Smith } 18902f18eb33SBarry Smith 18912f18eb33SBarry Smith /*@C 18922f18eb33SBarry Smith 18932f18eb33SBarry Smith PetscIntMultTruncate - Computes the product of two positive PetscInt and truncates the value to slightly less than the maximal possible value 18942f18eb33SBarry Smith 18952f18eb33SBarry Smith Not Collective 18962f18eb33SBarry Smith 18972f18eb33SBarry Smith Input Parameter: 18982f18eb33SBarry Smith + a - the PetscInt value 18992f18eb33SBarry Smith - b - the second value 19002f18eb33SBarry Smith 1901390e1bf2SBarry Smith Returns: 1902390e1bf2SBarry Smith the result as a PetscInt value 19032f18eb33SBarry Smith 1904bafee8b4SSatish Balay Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64 19052f18eb33SBarry Smith Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt 19062f18eb33SBarry 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 19072f18eb33SBarry Smith 19081fd49c25SBarry Smith Not available from Fortran 19091fd49c25SBarry Smith 19102f18eb33SBarry Smith Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks. 19112f18eb33SBarry Smith 19122f18eb33SBarry Smith This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able. 19132f18eb33SBarry Smith 19142f18eb33SBarry Smith Level: advanced 19152f18eb33SBarry Smith 1916390e1bf2SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult() 19172f18eb33SBarry Smith @*/ 19182f18eb33SBarry Smith PETSC_STATIC_INLINE PetscInt PetscIntMultTruncate(PetscInt a,PetscInt b) 19192f18eb33SBarry Smith { 1920bafee8b4SSatish Balay PetscInt64 r; 19212f18eb33SBarry Smith 1922bafee8b4SSatish Balay r = PetscInt64Mult(a,b); 19232f18eb33SBarry Smith if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100; 19242f18eb33SBarry Smith return (PetscInt) r; 19252f18eb33SBarry Smith } 19262f18eb33SBarry Smith 1927f91af8c7SBarry Smith /*@C 1928f91af8c7SBarry Smith 1929f91af8c7SBarry Smith PetscIntSumTruncate - Computes the sum of two positive PetscInt and truncates the value to slightly less than the maximal possible value 1930f91af8c7SBarry Smith 1931f91af8c7SBarry Smith Not Collective 1932f91af8c7SBarry Smith 1933f91af8c7SBarry Smith Input Parameter: 1934f91af8c7SBarry Smith + a - the PetscInt value 1935f91af8c7SBarry Smith - b - the second value 1936f91af8c7SBarry Smith 1937390e1bf2SBarry Smith Returns: 1938390e1bf2SBarry Smith the result as a PetscInt value 1939f91af8c7SBarry Smith 1940bafee8b4SSatish Balay Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64 1941f91af8c7SBarry Smith Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt 1942f91af8c7SBarry 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 1943f91af8c7SBarry Smith 1944f91af8c7SBarry Smith This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able. 1945f91af8c7SBarry Smith 1946f5f57ec0SBarry Smith Not available from Fortran 1947f5f57ec0SBarry Smith 1948f91af8c7SBarry Smith Level: advanced 1949f91af8c7SBarry Smith 1950390e1bf2SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult() 1951f91af8c7SBarry Smith @*/ 1952f91af8c7SBarry Smith PETSC_STATIC_INLINE PetscInt PetscIntSumTruncate(PetscInt a,PetscInt b) 1953f91af8c7SBarry Smith { 1954bafee8b4SSatish Balay PetscInt64 r; 1955f91af8c7SBarry Smith 1956bafee8b4SSatish Balay r = ((PetscInt64)a) + ((PetscInt64)b); 1957f91af8c7SBarry Smith if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100; 1958f91af8c7SBarry Smith return (PetscInt) r; 1959f91af8c7SBarry Smith } 1960f91af8c7SBarry Smith 19612f18eb33SBarry Smith /*@C 19622f18eb33SBarry Smith 19632f18eb33SBarry Smith PetscIntMultError - Computes the product of two positive PetscInt and generates an error with overflow. 19642f18eb33SBarry Smith 19652f18eb33SBarry Smith Not Collective 19662f18eb33SBarry Smith 19672f18eb33SBarry Smith Input Parameter: 19682f18eb33SBarry Smith + a - the PetscInt value 19692f18eb33SBarry Smith - b - the second value 19702f18eb33SBarry Smith 19712f18eb33SBarry Smith Output Parameter:ma 1972390e1bf2SBarry 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 19732f18eb33SBarry Smith 1974bafee8b4SSatish Balay Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64 19752f18eb33SBarry Smith Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt 19762f18eb33SBarry Smith 1977f5f57ec0SBarry Smith Not available from Fortran 1978f5f57ec0SBarry Smith 1979220afb94SBarry Smith Developers Note: We currently assume that PetscInt addition does not overflow, this is obviously wrong but requires many more checks. 19802f18eb33SBarry Smith 19812f18eb33SBarry Smith Level: advanced 19822f18eb33SBarry Smith 1983220afb94SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntMult64(), PetscIntSumError() 19842f18eb33SBarry Smith @*/ 19852f18eb33SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscIntMultError(PetscInt a,PetscInt b,PetscInt *result) 19862f18eb33SBarry Smith { 1987bafee8b4SSatish Balay PetscInt64 r; 19882f18eb33SBarry Smith 19892f18eb33SBarry Smith PetscFunctionBegin; 1990bafee8b4SSatish Balay r = PetscInt64Mult(a,b); 19912f18eb33SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES) 19922f18eb33SBarry Smith if (r > PETSC_MAX_INT) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_SUP,"Product of two integer %d %d overflow, you must ./configure PETSc with --with-64-bit-indices for the case you are running",a,b); 19932f18eb33SBarry Smith #endif 1994f91af8c7SBarry Smith if (result) *result = (PetscInt) r; 1995f91af8c7SBarry Smith PetscFunctionReturn(0); 1996f91af8c7SBarry Smith } 1997f91af8c7SBarry Smith 1998f91af8c7SBarry Smith /*@C 1999f91af8c7SBarry Smith 2000fbfcfee5SBarry Smith PetscIntSumError - Computes the sum of two positive PetscInt and generates an error with overflow. 2001f91af8c7SBarry Smith 2002f91af8c7SBarry Smith Not Collective 2003f91af8c7SBarry Smith 2004f91af8c7SBarry Smith Input Parameter: 2005f91af8c7SBarry Smith + a - the PetscInt value 2006f91af8c7SBarry Smith - b - the second value 2007f91af8c7SBarry Smith 2008f91af8c7SBarry Smith Output Parameter:ma 2009390e1bf2SBarry 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 2010f91af8c7SBarry Smith 2011bafee8b4SSatish Balay Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64 2012f91af8c7SBarry Smith Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt 2013f91af8c7SBarry Smith 2014f5f57ec0SBarry Smith Not available from Fortran 2015f5f57ec0SBarry Smith 2016f91af8c7SBarry Smith Level: advanced 2017f91af8c7SBarry Smith 2018390e1bf2SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult() 2019f91af8c7SBarry Smith @*/ 2020f91af8c7SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscIntSumError(PetscInt a,PetscInt b,PetscInt *result) 2021f91af8c7SBarry Smith { 2022bafee8b4SSatish Balay PetscInt64 r; 2023f91af8c7SBarry Smith 2024f91af8c7SBarry Smith PetscFunctionBegin; 2025bafee8b4SSatish Balay r = ((PetscInt64)a) + ((PetscInt64)b); 2026f91af8c7SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES) 2027f91af8c7SBarry Smith if (r > PETSC_MAX_INT) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_SUP,"Sum of two integer %d %d overflow, you must ./configure PETSc with --with-64-bit-indices for the case you are running",a,b); 2028f91af8c7SBarry Smith #endif 2029f91af8c7SBarry Smith if (result) *result = (PetscInt) r; 20302f18eb33SBarry Smith PetscFunctionReturn(0); 20312f18eb33SBarry Smith } 2032c5df96a5SBarry Smith 2033d382aafbSBarry Smith /* 20342981ebdbSBarry Smith The IBM include files define hz, here we hide it so that it may be used as a regular user variable. 2035d382aafbSBarry Smith */ 2036d382aafbSBarry Smith #if defined(hz) 2037d382aafbSBarry Smith # undef hz 2038d382aafbSBarry Smith #endif 2039d382aafbSBarry Smith 204015a5570dSLisandro Dalcin #include <limits.h> 204115a5570dSLisandro Dalcin 204215a5570dSLisandro Dalcin /* The number of bits in a byte */ 204315a5570dSLisandro Dalcin 204415a5570dSLisandro Dalcin #define PETSC_BITS_PER_BYTE CHAR_BIT 204515a5570dSLisandro Dalcin 2046d382aafbSBarry Smith /* For arrays that contain filenames or paths */ 2047d382aafbSBarry Smith 2048d382aafbSBarry Smith #if defined(PETSC_HAVE_SYS_PARAM_H) 2049d382aafbSBarry Smith # include <sys/param.h> 2050d382aafbSBarry Smith #endif 2051d382aafbSBarry Smith #if defined(PETSC_HAVE_SYS_TYPES_H) 2052d382aafbSBarry Smith # include <sys/types.h> 2053d382aafbSBarry Smith #endif 2054d382aafbSBarry Smith #if defined(MAXPATHLEN) 2055d382aafbSBarry Smith # define PETSC_MAX_PATH_LEN MAXPATHLEN 2056d382aafbSBarry Smith #elif defined(MAX_PATH) 2057d382aafbSBarry Smith # define PETSC_MAX_PATH_LEN MAX_PATH 2058d382aafbSBarry Smith #elif defined(_MAX_PATH) 2059d382aafbSBarry Smith # define PETSC_MAX_PATH_LEN _MAX_PATH 2060d382aafbSBarry Smith #else 2061d382aafbSBarry Smith # define PETSC_MAX_PATH_LEN 4096 2062d382aafbSBarry Smith #endif 2063d382aafbSBarry Smith 2064d382aafbSBarry Smith /*MC 2065d382aafbSBarry Smith 206666d79e26SBarry 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++ 206766d79e26SBarry Smith and Fortran compilers when petscsys.h is included. 206866d79e26SBarry Smith 206966d79e26SBarry Smith 207066d79e26SBarry Smith The current PETSc version and the API for accessing it are defined in petscversion.h 207166d79e26SBarry Smith 207266d79e26SBarry 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) 207366d79e26SBarry Smith 207466d79e26SBarry 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 207566d79e26SBarry Smith where only a change in the major version number (x) indicates a change in the API. 207666d79e26SBarry Smith 207766d79e26SBarry 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 207866d79e26SBarry Smith 207966d79e26SBarry 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), 208066d79e26SBarry 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 208166d79e26SBarry Smith version number (x.y.z). 208266d79e26SBarry Smith 208366d79e26SBarry Smith PETSC_RELEASE_DATE is the date the x.y version was released (i.e. the version before any patch releases) 208466d79e26SBarry Smith 208566d79e26SBarry Smith PETSC_VERSION_DATE is the date the x.y.z version was released 208666d79e26SBarry Smith 208766d79e26SBarry Smith PETSC_VERSION_GIT is the last git commit to the repository given in the form vx.y.z-wwwww 208866d79e26SBarry Smith 208966d79e26SBarry Smith PETSC_VERSION_DATE_GIT is the date of the last git commit to the repository 209066d79e26SBarry Smith 209166d79e26SBarry Smith Level: intermediate 209266d79e26SBarry Smith 209366d79e26SBarry Smith PETSC_VERSION_() and PETSC_VERSION_PATCH are deprecated and will eventually be removed. For several releases PETSC_VERSION_PATCH is always 0 209466d79e26SBarry Smith 209566d79e26SBarry Smith M*/ 209666d79e26SBarry Smith 209766d79e26SBarry Smith /*MC 209866d79e26SBarry Smith 20991b266c99SBarry Smith UsingFortran - To use PETSc with Fortran you must use both PETSc include files and modules. At the beginning 21001b266c99SBarry Smith of every function and module definition you need something like 2101d382aafbSBarry Smith 2102d382aafbSBarry Smith $ 2103af0996ceSBarry Smith $#include "petsc/finclude/petscXXX.h" 21040f665fc7SPatrick Sanan $ use petscXXX 21051b266c99SBarry Smith 2106692afcd8SPatrick Sanan You can declare PETSc variables using either of the following. 21071b266c99SBarry Smith 2108d382aafbSBarry Smith $ XXX variablename 21091b266c99SBarry Smith $ type(tXXX) variablename 21101b266c99SBarry Smith 2111692afcd8SPatrick Sanan For example, 21121b266c99SBarry Smith 2113bfc4c25eSBarry Smith $#include "petsc/finclude/petscvec.h" 21141b266c99SBarry Smith $ use petscvec 2115d382aafbSBarry Smith $ 2116692afcd8SPatrick Sanan $ Vec b 2117692afcd8SPatrick Sanan $ type(tVec) x 2118d382aafbSBarry Smith 2119d382aafbSBarry Smith Level: beginner 2120d382aafbSBarry Smith 2121d382aafbSBarry Smith M*/ 2122d382aafbSBarry Smith 2123014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t); 2124014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t); 2125014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t); 2126014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t); 2127014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]); 2128014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t); 212927710113SBarry Smith PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t); 21305f309d01SBarry Smith PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt*,PetscInt*,PetscInt*,PetscInt*); 2131d382aafbSBarry Smith 2132014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt,PetscInt[]); 213322ab5688SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscSortedRemoveDupsInt(PetscInt*,PetscInt[]); 2134014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt*,PetscInt[]); 213560e03357SMatthew G Knepley PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt*); 2136d2aeb606SJed Brown PETSC_EXTERN PetscErrorCode PetscFindMPIInt(PetscMPIInt, PetscInt, const PetscMPIInt[], PetscInt*); 2137014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]); 2138014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]); 2139014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]); 21406c2863d0SBarry Smith PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt,PetscInt[],PetscInt[],PetscInt[]); 214117d7d925SStefano Zampini PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt,PetscMPIInt[]); 214217d7d925SStefano Zampini PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt*,PetscMPIInt[]); 2143014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]); 21445569a785SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithIntArray(PetscMPIInt,PetscMPIInt[],PetscInt[]); 2145014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]); 214617df18f2SToby Isaac PETSC_EXTERN PetscErrorCode PetscSortIntWithDataArray(PetscInt,PetscInt[],void*,size_t,void*); 2147014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt,PetscReal[]); 214839f41f7fSStefano Zampini PETSC_EXTERN PetscErrorCode PetscSortRealWithArrayInt(PetscInt,PetscReal[],PetscInt[]); 2149014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]); 2150745b41b2SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt*,PetscReal[]); 215139f41f7fSStefano Zampini PETSC_EXTERN PetscErrorCode PetscFindReal(PetscReal,PetscInt,const PetscReal[],PetscReal,PetscInt*); 2152014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]); 2153014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]); 2154014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt,const PetscBool [],const PetscInt[],PetscInt*,PetscInt**,PetscInt**,PetscInt**,PetscInt**); 21556c2863d0SBarry Smith PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt,const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],PetscInt*,PetscInt**,PetscInt**); 21566c2863d0SBarry Smith PETSC_EXTERN PetscErrorCode PetscMergeIntArray(PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt*,PetscInt**); 2157e498c390SJed Brown PETSC_EXTERN PetscErrorCode PetscMergeMPIIntArray(PetscInt,const PetscMPIInt[],PetscInt,const PetscMPIInt[],PetscInt*,PetscMPIInt**); 2158d382aafbSBarry Smith 2159014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDisplay(void); 2160014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t); 2161d382aafbSBarry Smith 216276bdecfbSBarry Smith /*J 2163d382aafbSBarry Smith PetscRandomType - String with the name of a PETSc randomizer 2164d382aafbSBarry Smith 2165d382aafbSBarry Smith Level: beginner 2166d382aafbSBarry Smith 2167e28ce29aSPatrick Sanan Notes: 2168e28ce29aSPatrick Sanan To use SPRNG or RANDOM123 you must have ./configure PETSc 216925ccb61fSToby Isaac with the option --download-sprng or --download-random123 2170d382aafbSBarry Smith 21718f6c3df8SBarry Smith .seealso: PetscRandomSetType(), PetscRandom, PetscRandomCreate() 217276bdecfbSBarry Smith J*/ 217319fd82e9SBarry Smith typedef const char* PetscRandomType; 2174d382aafbSBarry Smith #define PETSCRAND "rand" 2175d382aafbSBarry Smith #define PETSCRAND48 "rand48" 2176d382aafbSBarry Smith #define PETSCSPRNG "sprng" 2177c5e4d11fSDmitry Karpeev #define PETSCRANDER48 "rander48" 217825ccb61fSToby Isaac #define PETSCRANDOM123 "random123" 2179d382aafbSBarry Smith 2180d382aafbSBarry Smith /* Logging support */ 2181014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID; 2182d382aafbSBarry Smith 2183607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void); 2184d382aafbSBarry Smith 2185d382aafbSBarry Smith /* Dynamic creation and loading functions */ 2186140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList PetscRandomList; 2187d382aafbSBarry Smith 2188bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],PetscErrorCode (*)(PetscRandom)); 218919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType); 2190014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom); 219119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType*); 2192685405a1SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscRandomViewFromOptions(PetscRandom A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);} 2193014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer); 2194d382aafbSBarry Smith 2195014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*); 2196014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*); 2197014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*); 2198014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*); 2199014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar); 2200014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long); 2201014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *); 2202014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom); 2203014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*); 2204d382aafbSBarry Smith 2205014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t); 2206014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t); 2207014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t); 2208014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]); 2209014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t); 2210014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *); 2211014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *); 221297540f07SSatish Balay PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]); 22138a10d460SHong Zhang PETSC_EXTERN PetscErrorCode PetscMkdtemp(char[]); 221497540f07SSatish Balay PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]); 2215d382aafbSBarry Smith 221630815ce0SLisandro Dalcin PETSC_STATIC_INLINE PetscBool PetscBinaryBigEndian(void) {long _petsc_v = 1; return ((char*)&_petsc_v)[0] ? PETSC_FALSE : PETSC_TRUE;} 221730815ce0SLisandro Dalcin 22189860990eSLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscInt*,PetscDataType); 22199860990eSLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscInt*,PetscDataType); 2220014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,void*,PetscInt,PetscDataType,PetscBool); 22219860990eSLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,void*,PetscInt,PetscDataType,PetscBool); 2222014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *); 2223014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryClose(int); 2224014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool *); 2225014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool *); 2226014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t); 2227014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *); 2228014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *); 2229c891a504SStefano Zampini #if defined(PETSC_USE_SOCKET_VIEWER) 2230e2fc02c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[],int,int*); 2231c891a504SStefano Zampini #endif 2232d382aafbSBarry Smith 2233014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*); 2234014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*); 2235014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt); 2236d382aafbSBarry Smith 2237014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]); 2238014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool ); 2239014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void); 2240014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*); 2241014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void); 2242014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void); 2243d382aafbSBarry Smith 2244014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*); 2245014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**); 2246014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**); 2247014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**); 2248014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**); 2249cf4b5b4fSJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt*,const void*,PetscMPIInt*,PetscMPIInt**,void*) 2250cf4b5b4fSJed Brown PetscAttrMPIPointerWithType(6,3); 2251d815da10SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedF(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt, 2252d815da10SJed Brown PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*), 2253d815da10SJed Brown PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx) 2254d815da10SJed Brown PetscAttrMPIPointerWithType(6,3); 22556afbe7ddSJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedFReq(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt, 22566afbe7ddSJed Brown MPI_Request**,MPI_Request**, 22576afbe7ddSJed Brown PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*), 22586afbe7ddSJed Brown PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx) 22596afbe7ddSJed Brown PetscAttrMPIPointerWithType(6,3); 2260d382aafbSBarry Smith 22616145cd65SJed Brown PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[]; 22626145cd65SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm,PetscBuildTwoSidedType); 22636145cd65SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm,PetscBuildTwoSidedType*); 22646145cd65SJed Brown 2265014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSSEIsEnabled(MPI_Comm,PetscBool*,PetscBool*); 2266d382aafbSBarry Smith 2267ce94432eSBarry Smith PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject); 2268ce94432eSBarry Smith 226945487dadSJed Brown PETSC_EXTERN const char *const PetscSubcommTypes[]; 227045487dadSJed Brown 2271d382aafbSBarry Smith struct _n_PetscSubcomm { 2272d382aafbSBarry Smith MPI_Comm parent; /* parent communicator */ 2273d382aafbSBarry Smith MPI_Comm dupparent; /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */ 2274306c2d5bSBarry Smith MPI_Comm child; /* the sub-communicator */ 227545487dadSJed Brown PetscMPIInt n; /* num of subcommunicators under the parent communicator */ 227645487dadSJed Brown PetscMPIInt color; /* color of processors belong to this communicator */ 2277708d824cSJed Brown PetscMPIInt *subsize; /* size of subcommunicator[color] */ 227845487dadSJed Brown PetscSubcommType type; 2279e5acf8a4SHong Zhang char *subcommprefix; 2280d382aafbSBarry Smith }; 2281d382aafbSBarry Smith 2282c5e4d11fSDmitry Karpeev PETSC_STATIC_INLINE MPI_Comm PetscSubcommParent(PetscSubcomm scomm) {return scomm->parent;} 2283306c2d5bSBarry Smith PETSC_STATIC_INLINE MPI_Comm PetscSubcommChild(PetscSubcomm scomm) {return scomm->child;} 228436be1a5eSBarry Smith PETSC_STATIC_INLINE MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm) {return scomm->dupparent;} 2285014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*); 2286014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*); 2287014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt); 2288014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType); 228965d9b8f1SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt); 2290053d1c95SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm,PetscViewer); 2291f68be91cSHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm); 2292e5acf8a4SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm,const char[]); 2293d382aafbSBarry Smith 22949962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapCreate(PetscInt,PetscHeap*); 22959962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapAdd(PetscHeap,PetscInt,PetscInt); 22969962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapPop(PetscHeap,PetscInt*,PetscInt*); 22979962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapPeek(PetscHeap,PetscInt*,PetscInt*); 22989962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapStash(PetscHeap,PetscInt,PetscInt); 22999962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapUnstash(PetscHeap); 23009962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapDestroy(PetscHeap*); 23019962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapView(PetscHeap,PetscViewer); 23029962606eSBarry Smith 23035e71baefSBarry Smith PETSC_EXTERN PetscErrorCode PetscProcessPlacementView(PetscViewer); 23045f7487a0SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscShmCommGet(MPI_Comm,PetscShmComm*); 23055f7487a0SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscShmCommGlobalToLocal(PetscShmComm,PetscMPIInt,PetscMPIInt*); 23065f7487a0SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscShmCommLocalToGlobal(PetscShmComm,PetscMPIInt,PetscMPIInt*); 23075f7487a0SJunchao Zhang PETSC_EXTERN PetscErrorCode PetscShmCommGetMpiShmComm(PetscShmComm,MPI_Comm*); 23085e71baefSBarry Smith 2309a32e93adSJunchao Zhang /* routines to better support OpenMP multithreading needs of some PETSc third party libraries */ 2310a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlCreate(MPI_Comm,PetscInt,PetscOmpCtrl*); 2311a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlGetOmpComms(PetscOmpCtrl,MPI_Comm*,MPI_Comm*,PetscBool*); 2312a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlDestroy(PetscOmpCtrl*); 2313a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlBarrier(PetscOmpCtrl); 2314a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterBegin(PetscOmpCtrl); 2315a32e93adSJunchao Zhang PETSC_EXTERN PetscErrorCode PetscOmpCtrlOmpRegionOnMasterEnd(PetscOmpCtrl); 2316a32e93adSJunchao Zhang 231713e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t,size_t,PetscSegBuffer*); 23180f453b92SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer*); 231913e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer,size_t,void*); 2320137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer,void*); 2321137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer,void*); 2322137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer,void*); 232313e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer,size_t*); 232413e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer,size_t); 23250f453b92SJed Brown 23265e71baefSBarry Smith 2327471ecdacSJed Brown /* Type-safe wrapper to encourage use of PETSC_RESTRICT. Does not use PetscFunctionBegin because the error handling 2328471ecdacSJed Brown * prevents the compiler from completely erasing the stub. This is called in inner loops so it has to be as fast as 2329471ecdacSJed Brown * possible. */ 233035005c2bSLisandro Dalcin PETSC_STATIC_INLINE PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg,PetscInt count,PetscInt *PETSC_RESTRICT *slot) {return PetscSegBufferGet(seg,(size_t)count,(void**)slot);} 2331d382aafbSBarry Smith 23329de0f6ecSBarry Smith extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton; 23339de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted*); 23349de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted*); 23359de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted,const char*,const char*,PetscBool*); 23369de0f6ecSBarry Smith 2337ace2fbaeSBarry Smith #include <stdarg.h> 2338ace2fbaeSBarry Smith PETSC_EXTERN PetscErrorCode PetscVSNPrintf(char*,size_t,const char[],size_t*,va_list); 2339ace2fbaeSBarry Smith PETSC_EXTERN PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list); 2340ace2fbaeSBarry Smith 2341268b0dfdSSatish Balay PETSC_EXTERN PetscSegBuffer PetscCitationsList; 2342fbfcfee5SBarry Smith 23431f817a21SBarry Smith /*@C 23441f817a21SBarry Smith PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used in the code. 23451f817a21SBarry Smith 23461f817a21SBarry Smith Not Collective - only what is registered on rank 0 of PETSC_COMM_WORLD will be printed 23471f817a21SBarry Smith 23481f817a21SBarry Smith Input Parameters: 23491f817a21SBarry Smith + cite - the bibtex item, formated to displayed on multiple lines nicely 23501f817a21SBarry Smith - set - a boolean variable initially set to PETSC_FALSE; this is used to insure only a single registration of the citation 23511f817a21SBarry Smith 2352850545d0SSatish Balay Level: intermediate 2353850545d0SSatish Balay 2354f5f57ec0SBarry Smith Not available from Fortran 2355f5f57ec0SBarry Smith 23561f817a21SBarry Smith Options Database: 2357063414e0SPatrick Sanan . -citations [filename] - print out the bibtex entries for the given computation 23581f817a21SBarry Smith @*/ 2359dff31646SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscCitationsRegister(const char cit[],PetscBool *set) 2360dff31646SBarry Smith { 2361dff31646SBarry Smith size_t len; 2362dff31646SBarry Smith char *vstring; 2363dff31646SBarry Smith PetscErrorCode ierr; 2364dff31646SBarry Smith 23651f817a21SBarry Smith PetscFunctionBegin; 23668d3683fcSBarry Smith if (set && *set) PetscFunctionReturn(0); 2367dff31646SBarry Smith ierr = PetscStrlen(cit,&len);CHKERRQ(ierr); 236835005c2bSLisandro Dalcin ierr = PetscSegBufferGet(PetscCitationsList,len,&vstring);CHKERRQ(ierr); 2369dff31646SBarry Smith ierr = PetscMemcpy(vstring,cit,len);CHKERRQ(ierr); 2370dff31646SBarry Smith if (set) *set = PETSC_TRUE; 23711f817a21SBarry Smith PetscFunctionReturn(0); 2372dff31646SBarry Smith } 2373dff31646SBarry Smith 2374b967cddfSBarry Smith PETSC_EXTERN PetscErrorCode PetscURLShorten(const char[],char[],size_t); 2375fe278a28SBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm,char[],char[],size_t); 2376fe278a28SBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm,const char[],char[],size_t); 2377f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm,const char[],const char []); 2378fe278a28SBarry Smith 2379f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm,char[],char[],size_t); 2380f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm,const char[],char[],char[],size_t); 2381b967cddfSBarry Smith 23829f4d3c52SBarry Smith PETSC_EXTERN PetscErrorCode PetscGlobusGetTransfers(MPI_Comm,const char[],char[],size_t); 23839f4d3c52SBarry Smith 238404102261SBarry Smith PETSC_EXTERN PetscErrorCode PetscTextBelt(MPI_Comm,const char[],const char[],PetscBool*); 2385763ec7b1SBarry Smith PETSC_EXTERN PetscErrorCode PetscTellMyCell(MPI_Comm,const char[],const char[],PetscBool*); 2386dff31646SBarry Smith 238768e69593SBarry Smith PETSC_EXTERN PetscErrorCode PetscPullJSONValue(const char[],const char[],char[],size_t,PetscBool*); 23885dc0f0a4SBarry Smith PETSC_EXTERN PetscErrorCode PetscPushJSONValue(char[],const char[],const char[],size_t); 2389d382aafbSBarry Smith 2390b2566f29SBarry Smith 2391b2566f29SBarry Smith #if defined(PETSC_USE_DEBUG) 2392b2566f29SBarry Smith /* 2393b2566f29SBarry Smith Verify that all processes in the communicator have called this from the same line of code 2394b2566f29SBarry Smith */ 23958f5db7efSBarry Smith PETSC_EXTERN PetscErrorCode PetscAllreduceBarrierCheck(MPI_Comm,PetscMPIInt,int,const char*,const char *); 239677a5e07dSBarry Smith 239777a5e07dSBarry Smith /*MC 239877a5e07dSBarry Smith MPIU_Allreduce - a PETSc replacement for MPI_Allreduce() that tries to determine if the call from all the MPI processes occur from the 239977a5e07dSBarry Smith same place in the PETSc code. This helps to detect bugs where different MPI processes follow different code paths 240077a5e07dSBarry Smith resulting in inconsistent and incorrect calls to MPI_Allreduce(). 240177a5e07dSBarry Smith 2402d083f849SBarry Smith Collective 240377a5e07dSBarry Smith 240477a5e07dSBarry Smith Synopsis: 240577a5e07dSBarry Smith #include <petscsys.h> 240677a5e07dSBarry Smith PetscErrorCode MPIU_Allreduce(void *indata,void *outdata,PetscMPIInt count,MPI_Datatype datatype, MPI_Op op, MPI_Comm comm); 240777a5e07dSBarry Smith 240877a5e07dSBarry Smith Input Parameters: 240977a5e07dSBarry Smith + indata - pointer to the input data to be reduced 241077a5e07dSBarry Smith . count - the number of MPI data items in indata and outdata 241177a5e07dSBarry Smith . datatype - the MPI datatype, for example MPI_INT 241277a5e07dSBarry Smith . op - the MPI operation, for example MPI_SUM 241377a5e07dSBarry Smith - comm - the MPI communicator on which the operation occurs 241477a5e07dSBarry Smith 241577a5e07dSBarry Smith Output Parameter: 241677a5e07dSBarry Smith . outdata - the reduced values 241777a5e07dSBarry Smith 2418e28ce29aSPatrick Sanan Notes: 2419e28ce29aSPatrick Sanan In optimized mode this directly calls MPI_Allreduce() 242077a5e07dSBarry Smith 242177a5e07dSBarry Smith Level: developer 242277a5e07dSBarry Smith 242377a5e07dSBarry Smith .seealso: MPI_Allreduce() 242477a5e07dSBarry Smith M*/ 2425fbfcfee5SBarry Smith #define MPIU_Allreduce(a,b,c,d,e,fcomm) (PetscAllreduceBarrierCheck(fcomm,c,__LINE__,PETSC_FUNCTION_NAME,__FILE__) || MPI_Allreduce(a,b,c,d,e,fcomm)) 2426b2566f29SBarry Smith #else 2427b2566f29SBarry Smith #define MPIU_Allreduce(a,b,c,d,e,fcomm) MPI_Allreduce(a,b,c,d,e,fcomm) 2428b2566f29SBarry Smith #endif 2429b2566f29SBarry Smith 24306f7079ddSSatish Balay #if defined(PETSC_HAVE_MPI_WIN_CREATE_FEATURE) 24318198064fSBarry Smith PETSC_EXTERN PetscErrorCode MPIU_Win_allocate_shared(MPI_Aint,PetscMPIInt,MPI_Info,MPI_Comm,void*,MPI_Win*); 24328198064fSBarry Smith PETSC_EXTERN PetscErrorCode MPIU_Win_shared_query(MPI_Win,PetscMPIInt,MPI_Aint*,PetscMPIInt*,void*); 24332f065d89SBarry Smith #endif 24348198064fSBarry Smith 243512801b39SBarry Smith /* 243612801b39SBarry Smith Returned from PETSc functions that are called from MPI, such as related to attributes 243712801b39SBarry Smith */ 24388ba48ad5SSatish Balay PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CLASS; 24398ba48ad5SSatish Balay PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CODE; 244012801b39SBarry Smith 2441d382aafbSBarry Smith #endif 2442