1d382aafbSBarry Smith /* 2d382aafbSBarry Smith This is the main PETSc include file (for C and C++). It is included by all 3d382aafbSBarry Smith other PETSc include files, so it almost never has to be specifically included. 4d382aafbSBarry Smith */ 56c7e564aSBarry Smith #if !defined(__PETSCSYS_H) 66c7e564aSBarry Smith #define __PETSCSYS_H 7d382aafbSBarry Smith /* ========================================================================== */ 8d382aafbSBarry Smith /* 9d382aafbSBarry Smith petscconf.h is contained in ${PETSC_ARCH}/include/petscconf.h it is 101cc8b206SBarry Smith found automatically by the compiler due to the -I${PETSC_DIR}/${PETSC_ARCH}/include. 111cc8b206SBarry Smith For --prefix installs the ${PETSC_ARCH}/ does not exist and petscconf.h is in the same 121cc8b206SBarry Smith directory as the other PETSc include files. 13d382aafbSBarry Smith */ 142c8e378dSBarry Smith #include <petscconf.h> 152c8e378dSBarry Smith #include <petscfix.h> 16d382aafbSBarry Smith 1773fca5a0SBarry Smith #if defined(PETSC_DESIRE_FEATURE_TEST_MACROS) 1873fca5a0SBarry Smith /* 1973fca5a0SBarry Smith Feature test macros must be included before headers defined by IEEE Std 1003.1-2001 2073fca5a0SBarry Smith We only turn these in PETSc source files that require them by setting PETSC_DESIRE_FEATURE_TEST_MACROS 2173fca5a0SBarry Smith */ 22216f1ae6SBarry Smith #if defined(PETSC__POSIX_C_SOURCE_200112L) && !defined(_POSIX_C_SOURCE) 2373fca5a0SBarry Smith #define _POSIX_C_SOURCE 200112L 2473fca5a0SBarry Smith #endif 25216f1ae6SBarry Smith #if defined(PETSC__BSD_SOURCE) && !defined(_BSD_SOURCE) 2673fca5a0SBarry Smith #define _BSD_SOURCE 2773fca5a0SBarry Smith #endif 2807f00807SSatish Balay #if defined(PETSC__DEFAULT_SOURCE) && !defined(_DEFAULT_SOURCE) 2907f00807SSatish Balay #define _DEFAULT_SOURCE 3007f00807SSatish Balay #endif 31ea0fecefSShri Abhyankar #if defined(PETSC__GNU_SOURCE) && !defined(_GNU_SOURCE) 32ea0fecefSShri Abhyankar #define _GNU_SOURCE 33ea0fecefSShri Abhyankar #endif 3473fca5a0SBarry Smith #endif 3573fca5a0SBarry Smith 36d382aafbSBarry Smith /* ========================================================================== */ 37d382aafbSBarry Smith /* 382c280183SJed Brown This facilitates using the C version of PETSc from C++ and the C++ version from C. 39d382aafbSBarry Smith */ 401ec50b02SJed Brown #if defined(__cplusplus) 411ec50b02SJed Brown # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_CXX 421ec50b02SJed Brown #else 431ec50b02SJed Brown # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_C 441ec50b02SJed Brown #endif 45d382aafbSBarry Smith 46c5e4d11fSDmitry Karpeev /* ========================================================================== */ 47c5e4d11fSDmitry Karpeev /* 48c5e4d11fSDmitry Karpeev Since PETSc manages its own extern "C" handling users should never include PETSc include 491cc8b206SBarry Smith files within extern "C". This will generate a compiler error if a user does put the include 501cc8b206SBarry Smith file within an extern "C". 51c5e4d11fSDmitry Karpeev */ 52c5e4d11fSDmitry Karpeev #if defined(__cplusplus) 53c5e4d11fSDmitry Karpeev void assert_never_put_petsc_headers_inside_an_extern_c(int); void assert_never_put_petsc_headers_inside_an_extern_c(double); 54c5e4d11fSDmitry Karpeev #endif 55c5e4d11fSDmitry Karpeev 56ed938b00SJed Brown #if defined(__cplusplus) 57ed938b00SJed Brown # define PETSC_RESTRICT PETSC_CXX_RESTRICT 58ed938b00SJed Brown #else 59ed938b00SJed Brown # define PETSC_RESTRICT PETSC_C_RESTRICT 60ed938b00SJed Brown #endif 61ed938b00SJed Brown 62ed938b00SJed Brown #if defined(__cplusplus) 63ed938b00SJed Brown # define PETSC_STATIC_INLINE PETSC_CXX_STATIC_INLINE 64ed938b00SJed Brown #else 65ed938b00SJed Brown # define PETSC_STATIC_INLINE PETSC_C_STATIC_INLINE 66ed938b00SJed Brown #endif 67ed938b00SJed Brown 68ab699e31SSatish Balay #if defined(_WIN32) && defined(PETSC_USE_SHARED_LIBRARIES) /* For Win32 shared libraries */ 69014dd563SJed Brown # define PETSC_DLLEXPORT __declspec(dllexport) 70014dd563SJed Brown # define PETSC_DLLIMPORT __declspec(dllimport) 7121f66b81SJed Brown # define PETSC_VISIBILITY_INTERNAL 7226703958SBarry Smith #elif defined(PETSC_USE_VISIBILITY_CXX) && defined(__cplusplus) 7326703958SBarry Smith # define PETSC_DLLEXPORT __attribute__((visibility ("default"))) 7426703958SBarry Smith # define PETSC_DLLIMPORT __attribute__((visibility ("default"))) 7526703958SBarry Smith # define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden"))) 7626703958SBarry Smith #elif defined(PETSC_USE_VISIBILITY_C) && !defined(__cplusplus) 77014dd563SJed Brown # define PETSC_DLLEXPORT __attribute__((visibility ("default"))) 78014dd563SJed Brown # define PETSC_DLLIMPORT __attribute__((visibility ("default"))) 7921f66b81SJed Brown # define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden"))) 80d382aafbSBarry Smith #else 81014dd563SJed Brown # define PETSC_DLLEXPORT 82014dd563SJed Brown # define PETSC_DLLIMPORT 8321f66b81SJed Brown # define PETSC_VISIBILITY_INTERNAL 84014dd563SJed Brown #endif 85014dd563SJed Brown 86014dd563SJed Brown #if defined(petsc_EXPORTS) /* CMake defines this when building the shared library */ 87014dd563SJed Brown # define PETSC_VISIBILITY_PUBLIC PETSC_DLLEXPORT 88014dd563SJed Brown #else /* Win32 users need this to import symbols from petsc.dll */ 89014dd563SJed Brown # define PETSC_VISIBILITY_PUBLIC PETSC_DLLIMPORT 90014dd563SJed Brown #endif 91014dd563SJed Brown 921cc8b206SBarry Smith /* 931cc8b206SBarry Smith Functions tagged with PETSC_EXTERN in the header files are 941cc8b206SBarry Smith always defined as extern "C" when compiled with C++ so they may be 951cc8b206SBarry Smith used from C and are always visible in the shared libraries 961cc8b206SBarry Smith */ 972c280183SJed Brown #if defined(__cplusplus) 98014dd563SJed Brown #define PETSC_EXTERN extern "C" PETSC_VISIBILITY_PUBLIC 99638cfed1SJed Brown #define PETSC_EXTERN_TYPEDEF extern "C" 10021f66b81SJed Brown #define PETSC_INTERN extern "C" PETSC_VISIBILITY_INTERNAL 101014dd563SJed Brown #else 102014dd563SJed Brown #define PETSC_EXTERN extern PETSC_VISIBILITY_PUBLIC 103638cfed1SJed Brown #define PETSC_EXTERN_TYPEDEF 1046258c452SJed Brown #define PETSC_INTERN extern PETSC_VISIBILITY_INTERNAL 105d382aafbSBarry Smith #endif 10627710113SBarry Smith 1072c8e378dSBarry Smith #include <petscversion.h> 108301d30feSBarry Smith #define PETSC_AUTHOR_INFO " The PETSc Team\n petsc-maint@mcs.anl.gov\n http://www.mcs.anl.gov/petsc/\n" 109d382aafbSBarry Smith 110d382aafbSBarry Smith /* ========================================================================== */ 111d382aafbSBarry Smith 112d382aafbSBarry Smith /* 113d382aafbSBarry Smith Defines the interface to MPI allowing the use of all MPI functions. 114d382aafbSBarry Smith 115d382aafbSBarry Smith PETSc does not use the C++ binding of MPI at ALL. The following flag 116d382aafbSBarry Smith makes sure the C++ bindings are not included. The C++ bindings REQUIRE 117d382aafbSBarry Smith putting mpi.h before ANY C++ include files, we cannot control this 118d382aafbSBarry Smith with all PETSc users. Users who want to use the MPI C++ bindings can include 119d382aafbSBarry Smith mpicxx.h directly in their code 120d382aafbSBarry Smith */ 121fa9e63e2SJed Brown #if !defined(MPICH_SKIP_MPICXX) 122d382aafbSBarry Smith # define MPICH_SKIP_MPICXX 1 123fa9e63e2SJed Brown #endif 124fa9e63e2SJed Brown #if !defined(OMPI_SKIP_MPICXX) 125d382aafbSBarry Smith # define OMPI_SKIP_MPICXX 1 126fa9e63e2SJed Brown #endif 127076e11b5SSatish Balay #if !defined(OMPI_WANT_MPI_INTERFACE_WARNING) 128076e11b5SSatish Balay # define OMPI_WANT_MPI_INTERFACE_WARNING 0 129076e11b5SSatish Balay #endif 1302c8e378dSBarry Smith #include <mpi.h> 13165013866SBarry Smith 132d382aafbSBarry Smith /* 133a7886beaSBarry Smith Perform various sanity checks that the correct mpi.h is being included at compile time. 134a7886beaSBarry Smith This usually happens because 135a7886beaSBarry Smith * either an unexpected mpi.h is in the default compiler path (i.e. in /usr/include) or 136a7886beaSBarry Smith * an extra include path -I/something (which contains the unexpected mpi.h) is being passed to the compiler 137a7886beaSBarry Smith */ 138a7886beaSBarry Smith #if defined(PETSC_HAVE_MPIUNI) 139a7886beaSBarry Smith # if !defined(__MPIUNI_H) 140a7886beaSBarry Smith # error "PETSc was configured with --with-mpi=0 but now appears to be compiling using a different mpi.h" 141a7886beaSBarry Smith # endif 14241f4af4cSSatish Balay #elif defined(PETSC_HAVE_I_MPI_NUMVERSION) 14341f4af4cSSatish Balay # if !defined(I_MPI_NUMVERSION) 14441f4af4cSSatish Balay # error "PETSc was configured with I_MPI but now appears to be compiling using a non-I_MPI mpi.h" 14541f4af4cSSatish Balay # elif I_MPI_NUMVERSION != PETSC_HAVE_I_MPI_NUMVERSION 14641f4af4cSSatish Balay # error "PETSc was configured with one I_MPI mpi.h version but now appears to be compiling using a different I_MPI mpi.h version" 14741f4af4cSSatish Balay # endif 14841f4af4cSSatish Balay #elif defined(PETSC_HAVE_MVAPICH2_NUMVERSION) 14941f4af4cSSatish Balay # if !defined(MVAPICH2_NUMVERSION) 15041f4af4cSSatish Balay # error "PETSc was configured with MVAPICH2 but now appears to be compiling using a non-MVAPICH2 mpi.h" 15141f4af4cSSatish Balay # elif MVAPICH2_NUMVERSION != PETSC_HAVE_MVAPICH2_NUMVERSION 15241f4af4cSSatish Balay # error "PETSc was configured with one MVAPICH2 mpi.h version but now appears to be compiling using a different MVAPICH2 mpi.h version" 15341f4af4cSSatish Balay # endif 154a7886beaSBarry Smith #elif defined(PETSC_HAVE_MPICH_NUMVERSION) 15541f4af4cSSatish Balay # if !defined(MPICH_NUMVERSION) || defined(MVAPICH2_NUMVERSION) || defined(I_MPI_NUMVERSION) 156a7886beaSBarry Smith # error "PETSc was configured with MPICH but now appears to be compiling using a non-MPICH mpi.h" 157a7886beaSBarry Smith # elif MPICH_NUMVERSION != PETSC_HAVE_MPICH_NUMVERSION 158a7886beaSBarry Smith # error "PETSc was configured with one MPICH mpi.h version but now appears to be compiling using a different MPICH mpi.h version" 159a7886beaSBarry Smith # endif 160a7886beaSBarry Smith #elif defined(PETSC_HAVE_OMPI_MAJOR_VERSION) 161a7886beaSBarry Smith # if !defined(OMPI_MAJOR_VERSION) 162a7886beaSBarry Smith # error "PETSc was configured with OpenMPI but now appears to be compiling using a non-OpenMPI mpi.h" 163c3ac57cfSSatish Balay # elif (OMPI_MAJOR_VERSION != PETSC_HAVE_OMPI_MAJOR_VERSION) || (OMPI_MINOR_VERSION != PETSC_HAVE_OMPI_MINOR_VERSION) || (OMPI_RELEASE_VERSION != PETSC_HAVE_OMPI_RELEASE_VERSION) 164c3ac57cfSSatish Balay # error "PETSc was configured with one OpenMPI mpi.h version but now appears to be compiling using a different OpenMPI mpi.h version" 165a7886beaSBarry Smith # endif 16641f4af4cSSatish Balay #elif defined(OMPI_MAJOR_VERSION) || defined(MPICH_NUMVERSION) 16741f4af4cSSatish Balay # error "PETSc was configured with undetermined MPI - but now appears to be compiling using either of OpenMPI or a MPICH variant" 168a7886beaSBarry Smith #endif 169a7886beaSBarry Smith 170a7886beaSBarry Smith /* 1712981ebdbSBarry Smith Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler 172d382aafbSBarry Smith see the top of mpicxx.h in the MPICH2 distribution. 173d382aafbSBarry Smith */ 174d382aafbSBarry Smith #include <stdio.h> 175d382aafbSBarry Smith 176d382aafbSBarry Smith /* MSMPI on 32bit windows requires this yukky hack - that breaks MPI standard compliance */ 177d382aafbSBarry Smith #if !defined(MPIAPI) 178d382aafbSBarry Smith #define MPIAPI 179d382aafbSBarry Smith #endif 180d382aafbSBarry Smith 1811cc8b206SBarry Smith /* 1821cc8b206SBarry Smith Support for Clang (>=3.2) matching type tag arguments with void* buffer types. 1831cc8b206SBarry Smith This allows the compiler to detect cases where the MPI datatype argument passed to a MPI routine 1841cc8b206SBarry Smith does not match the actual type of the argument being passed in 1851cc8b206SBarry Smith */ 186c5e4d11fSDmitry Karpeev #if defined(__has_attribute) && defined(works_with_const_which_is_not_true) 187894dd566SJed Brown # if __has_attribute(argument_with_type_tag) && __has_attribute(pointer_with_type_tag) && __has_attribute(type_tag_for_datatype) 188894dd566SJed Brown # define PetscAttrMPIPointerWithType(bufno,typeno) __attribute__((pointer_with_type_tag(MPI,bufno,typeno))) 1898ad47952SJed Brown # define PetscAttrMPITypeTag(type) __attribute__((type_tag_for_datatype(MPI,type))) 1908ad47952SJed Brown # define PetscAttrMPITypeTagLayoutCompatible(type) __attribute__((type_tag_for_datatype(MPI,type,layout_compatible))) 191894dd566SJed Brown # endif 192894dd566SJed Brown #endif 193894dd566SJed Brown #if !defined(PetscAttrMPIPointerWithType) 194894dd566SJed Brown # define PetscAttrMPIPointerWithType(bufno,typeno) 1958ad47952SJed Brown # define PetscAttrMPITypeTag(type) 1968ad47952SJed Brown # define PetscAttrMPITypeTagLayoutCompatible(type) 197894dd566SJed Brown #endif 198b3506946SBarry Smith 199d382aafbSBarry Smith /*MC 2001957e957SBarry Smith PetscErrorCode - datatype used for return error code from almost all PETSc functions 201d382aafbSBarry Smith 202d382aafbSBarry Smith Level: beginner 203d382aafbSBarry Smith 204d382aafbSBarry Smith .seealso: CHKERRQ, SETERRQ 205d382aafbSBarry Smith M*/ 206d382aafbSBarry Smith typedef int PetscErrorCode; 207d382aafbSBarry Smith 208d382aafbSBarry Smith /*MC 209d382aafbSBarry Smith 210503cfb0cSBarry Smith PetscClassId - A unique id used to identify each PETSc class. 211d382aafbSBarry Smith 2121957e957SBarry Smith Notes: Use PetscClassIdRegister() to obtain a new value for a new class being created. Usually 2131957e957SBarry Smith XXXInitializePackage() calls it for each class it defines. 2141957e957SBarry Smith 2151957e957SBarry Smith Developer Notes: Internal integer stored in the _p_PetscObject data structure. 2161957e957SBarry Smith These are all computed by an offset from the lowest one, PETSC_SMALLEST_CLASSID. 2171957e957SBarry Smith 2181957e957SBarry Smith Level: developer 219d382aafbSBarry Smith 2200700a824SBarry Smith .seealso: PetscClassIdRegister(), PetscLogEventRegister(), PetscHeaderCreate() 221d382aafbSBarry Smith M*/ 2220700a824SBarry Smith typedef int PetscClassId; 223d382aafbSBarry Smith 224d382aafbSBarry Smith 225d382aafbSBarry Smith /*MC 226d382aafbSBarry Smith PetscMPIInt - datatype used to represent 'int' parameters to MPI functions. 227d382aafbSBarry Smith 228d382aafbSBarry Smith Level: intermediate 229d382aafbSBarry Smith 230d382aafbSBarry Smith Notes: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but 2313b2a8c54SBarry Smith standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt it remains 32 bit 232d382aafbSBarry Smith 2334dc2109aSBarry Smith PetscMPIIntCast(a,&b) checks if the given PetscInt a will fit in a PetscMPIInt, if not it 2342981ebdbSBarry Smith generates a PETSC_ERR_ARG_OUTOFRANGE error. 235d382aafbSBarry Smith 2361cc8b206SBarry Smith .seealso: PetscBLASInt, PetscInt, PetscMPIIntCast() 237d382aafbSBarry Smith 238d382aafbSBarry Smith M*/ 239d382aafbSBarry Smith typedef int PetscMPIInt; 240d382aafbSBarry Smith 241d382aafbSBarry Smith /*MC 242d382aafbSBarry Smith PetscEnum - datatype used to pass enum types within PETSc functions. 243d382aafbSBarry Smith 244d382aafbSBarry Smith Level: intermediate 245d382aafbSBarry Smith 246d382aafbSBarry Smith .seealso: PetscOptionsGetEnum(), PetscOptionsEnum(), PetscBagRegisterEnum() 247d382aafbSBarry Smith M*/ 248d382aafbSBarry Smith typedef enum { ENUM_DUMMY } PetscEnum; 2495a576424SJed Brown PETSC_EXTERN MPI_Datatype MPIU_ENUM PetscAttrMPITypeTag(PetscEnum); 250d382aafbSBarry Smith 251fab38c73SJed Brown #if defined(PETSC_HAVE_STDINT_H) 252fab38c73SJed Brown #include <stdint.h> 253fab38c73SJed Brown #endif 254a05e1a72SSatish Balay #if defined (PETSC_HAVE_INTTYPES_H) 25513e758fdSSatish Balay #define __STDC_FORMAT_MACROS /* required for using PRId64 from c++ */ 256a05e1a72SSatish Balay #include <inttypes.h> 25737354ed4SSatish Balay # if !defined(PRId64) 25837354ed4SSatish Balay # define PRId64 "ld" 25937354ed4SSatish Balay # endif 260a05e1a72SSatish Balay #endif 261fab38c73SJed Brown 26299a4b90dSDave May typedef short PetscShort; 26399a4b90dSDave May typedef char PetscChar; 26499a4b90dSDave May typedef float PetscFloat; 26599a4b90dSDave May 266d382aafbSBarry Smith /*MC 267d382aafbSBarry Smith PetscInt - PETSc type that represents integer - used primarily to 2683b2a8c54SBarry Smith represent size of arrays and indexing into arrays. Its size can be configured with the option 269d382aafbSBarry Smith --with-64-bit-indices - to be either 32bit or 64bit [default 32 bit ints] 270d382aafbSBarry Smith 271390e1bf2SBarry Smith 272390e1bf2SBarry Smith Notes: For MPI calls that require datatypes, use MPIU_INT as the datatype for PetscInt. It will automatically work correctly regardless of 273390e1bf2SBarry Smith the size of PetscInt 274390e1bf2SBarry Smith 275d382aafbSBarry Smith Level: intermediate 276d382aafbSBarry Smith 277d382aafbSBarry Smith .seealso: PetscScalar, PetscBLASInt, PetscMPIInt 278d382aafbSBarry Smith M*/ 27937354ed4SSatish Balay #if defined(PETSC_HAVE_STDINT_H) && defined(PETSC_HAVE_INTTYPES_H) && defined(PETSC_HAVE_MPI_INT64_T) /* MPI_INT64_T is not guaranteed to be a macro */ 280bafee8b4SSatish Balay typedef int64_t PetscInt64; 281bd84f1cfSSatish Balay # define MPIU_INT64 MPI_INT64_T 282a05e1a72SSatish Balay # define PetscInt64_FMT PRId64 283fab38c73SJed Brown #elif (PETSC_SIZEOF_LONG_LONG == 8) 284bafee8b4SSatish Balay typedef long long PetscInt64; 285bd84f1cfSSatish Balay # define MPIU_INT64 MPI_LONG_LONG_INT 286a05e1a72SSatish Balay # define PetscInt64_FMT "lld" 287f505b413SSatish Balay #elif defined(PETSC_HAVE___INT64) 288bafee8b4SSatish Balay typedef __int64 PetscInt64; 289bd84f1cfSSatish Balay # define MPIU_INT64 MPI_INT64_T 290a05e1a72SSatish Balay # define PetscInt64_FMT "ld" 291236ed0a3SSatish Balay #else 292bafee8b4SSatish Balay #error "cannot determine PetscInt64 type" 293236ed0a3SSatish Balay #endif 294d382aafbSBarry Smith #if defined(PETSC_USE_64BIT_INDICES) 295bafee8b4SSatish Balay typedef PetscInt64 PetscInt; 296bd84f1cfSSatish Balay #define MPIU_INT MPIU_INT64 297a05e1a72SSatish Balay #define PetscInt_FMT PetscInt64_FMT 298d382aafbSBarry Smith #else 299d382aafbSBarry Smith typedef int PetscInt; 300d382aafbSBarry Smith #define MPIU_INT MPI_INT 301a05e1a72SSatish Balay #define PetscInt_FMT "d" 302d382aafbSBarry Smith #endif 303d382aafbSBarry Smith 304702bc34aSSatish Balay /*MC 305702bc34aSSatish Balay PetscBLASInt - datatype used to represent 'int' parameters to BLAS/LAPACK functions. 306702bc34aSSatish Balay 307702bc34aSSatish Balay Level: intermediate 308702bc34aSSatish Balay 309702bc34aSSatish Balay Notes: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but 310702bc34aSSatish Balay standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt it remains 32 bit 311702bc34aSSatish Balay (except on very rare BLAS/LAPACK implementations that support 64 bit integers see the note below). 312702bc34aSSatish Balay 313c5df96a5SBarry Smith PetscErrorCode PetscBLASIntCast(a,&b) checks if the given PetscInt a will fit in a PetscBLASInt, if not it 3142981ebdbSBarry Smith generates a PETSC_ERR_ARG_OUTOFRANGE error 315702bc34aSSatish Balay 3162981ebdbSBarry Smith Installation Notes: The 64bit versions of MATLAB ship with BLAS and LAPACK that use 64 bit integers for sizes etc, 317702bc34aSSatish Balay if you run ./configure with the option 318149a18a2SBarry Smith --with-blaslapack-lib=[/Applications/MATLAB_R2010b.app/bin/maci64/libmwblas.dylib,/Applications/MATLAB_R2010b.app/bin/maci64/libmwlapack.dylib] 3192981ebdbSBarry Smith but you need to also use --known-64-bit-blas-indices. 3202981ebdbSBarry Smith 321390e1bf2SBarry Smith MKL also ships with 64 bit integer versions of the BLAS and LAPACK, if you select those you must also ./configure with 322390e1bf2SBarry Smith --known-64-bit-blas-indices 323390e1bf2SBarry Smith 324390e1bf2SBarry Smith OpenBLAS can also be built to use 64 bit integers. The ./configure options --download-openblas -download-openblas-64-bit-blas-indices 325390e1bf2SBarry Smith will build a 64 bit integer version 3262981ebdbSBarry Smith 3272981ebdbSBarry Smith Developer Notes: Eventually ./configure should automatically determine the size of the integers used by BLAS/LAPACK. 328702bc34aSSatish Balay 329702bc34aSSatish Balay External packages such as hypre, ML, SuperLU etc do not provide any support for passing 64 bit integers to BLAS/LAPACK so cannot 330702bc34aSSatish Balay be used with PETSc if you have set PetscBLASInt to long int. 331702bc34aSSatish Balay 3321cc8b206SBarry Smith .seealso: PetscMPIInt, PetscInt, PetscBLASIntCast() 333702bc34aSSatish Balay 334702bc34aSSatish Balay M*/ 335702bc34aSSatish Balay #if defined(PETSC_HAVE_64BIT_BLAS_INDICES) 336bafee8b4SSatish Balay typedef PetscInt64 PetscBLASInt; 337702bc34aSSatish Balay #else 338702bc34aSSatish Balay typedef int PetscBLASInt; 339702bc34aSSatish Balay #endif 340702bc34aSSatish Balay 341503cfb0cSBarry Smith /* 342503cfb0cSBarry Smith For the rare cases when one needs to send a size_t object with MPI 343503cfb0cSBarry Smith */ 344d382aafbSBarry Smith #if (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_INT) 345adcec1e5SJed Brown #define MPIU_SIZE_T MPI_UNSIGNED 346d382aafbSBarry Smith #elif (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG) 347adcec1e5SJed Brown #define MPIU_SIZE_T MPI_UNSIGNED_LONG 348d382aafbSBarry Smith #elif (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG_LONG) 349adcec1e5SJed Brown #define MPIU_SIZE_T MPI_UNSIGNED_LONG_LONG 350d382aafbSBarry Smith #else 351d382aafbSBarry Smith #error "Unknown size for size_t! Send us a bugreport at petsc-maint@mcs.anl.gov" 352d382aafbSBarry Smith #endif 353d382aafbSBarry Smith 354d382aafbSBarry Smith /* 355d382aafbSBarry Smith You can use PETSC_STDOUT as a replacement of stdout. You can also change 356d382aafbSBarry Smith the value of PETSC_STDOUT to redirect all standard output elsewhere 357d382aafbSBarry Smith */ 358014dd563SJed Brown PETSC_EXTERN FILE* PETSC_STDOUT; 359d382aafbSBarry Smith 360d382aafbSBarry Smith /* 361d382aafbSBarry Smith You can use PETSC_STDERR as a replacement of stderr. You can also change 362d382aafbSBarry Smith the value of PETSC_STDERR to redirect all standard error elsewhere 363d382aafbSBarry Smith */ 364014dd563SJed Brown PETSC_EXTERN FILE* PETSC_STDERR; 365d382aafbSBarry Smith 366d382aafbSBarry Smith /*MC 367d382aafbSBarry Smith PetscUnlikely - hints the compiler that the given condition is usually FALSE 368d382aafbSBarry Smith 369d382aafbSBarry Smith Synopsis: 370aaa7dc30SBarry Smith #include <petscsys.h> 371ace3abfcSBarry Smith PetscBool PetscUnlikely(PetscBool cond) 372d382aafbSBarry Smith 373eca87e8dSBarry Smith Not Collective 374eca87e8dSBarry Smith 375d382aafbSBarry Smith Input Parameters: 376d382aafbSBarry Smith . cond - condition or expression 377d382aafbSBarry Smith 378d382aafbSBarry Smith Note: This returns the same truth value, it is only a hint to compilers that the resulting 379d382aafbSBarry Smith branch is unlikely. 380d382aafbSBarry Smith 381d382aafbSBarry Smith Level: advanced 382d382aafbSBarry Smith 383d382aafbSBarry Smith .seealso: PetscLikely(), CHKERRQ 384d382aafbSBarry Smith M*/ 385d382aafbSBarry Smith 386d382aafbSBarry Smith /*MC 387d382aafbSBarry Smith PetscLikely - hints the compiler that the given condition is usually TRUE 388d382aafbSBarry Smith 389d382aafbSBarry Smith Synopsis: 390aaa7dc30SBarry Smith #include <petscsys.h> 39123072422SBarry Smith PetscBool PetscLikely(PetscBool cond) 392d382aafbSBarry Smith 393eca87e8dSBarry Smith Not Collective 394eca87e8dSBarry Smith 395d382aafbSBarry Smith Input Parameters: 396d382aafbSBarry Smith . cond - condition or expression 397d382aafbSBarry Smith 398d382aafbSBarry Smith Note: This returns the same truth value, it is only a hint to compilers that the resulting 399d382aafbSBarry Smith branch is likely. 400d382aafbSBarry Smith 401d382aafbSBarry Smith Level: advanced 402d382aafbSBarry Smith 403d382aafbSBarry Smith .seealso: PetscUnlikely() 404d382aafbSBarry Smith M*/ 405d382aafbSBarry Smith #if defined(PETSC_HAVE_BUILTIN_EXPECT) 406d382aafbSBarry Smith # define PetscUnlikely(cond) __builtin_expect(!!(cond),0) 407d382aafbSBarry Smith # define PetscLikely(cond) __builtin_expect(!!(cond),1) 408d382aafbSBarry Smith #else 409cd3f4ce9SJed Brown # define PetscUnlikely(cond) (cond) 410cd3f4ce9SJed Brown # define PetscLikely(cond) (cond) 411d382aafbSBarry Smith #endif 412d382aafbSBarry Smith 413d382aafbSBarry Smith /* 414d382aafbSBarry Smith Declare extern C stuff after including external header files 415d382aafbSBarry Smith */ 416d382aafbSBarry Smith 417d382aafbSBarry Smith 418d382aafbSBarry Smith /* 419d382aafbSBarry Smith Basic PETSc constants 420d382aafbSBarry Smith */ 421d382aafbSBarry Smith 422d382aafbSBarry Smith /*E 423ace3abfcSBarry Smith PetscBool - Logical variable. Actually an int in C and a logical in Fortran. 424d382aafbSBarry Smith 425d382aafbSBarry Smith Level: beginner 426d382aafbSBarry Smith 427ace3abfcSBarry Smith Developer Note: Why have PetscBool , why not use bool in C? The problem is that K and R C, C99 and C++ all have different mechanisms for 42834e82e7dSBarry Smith boolean values. It is not easy to have a simple macro that that will work properly in all circumstances with all three mechanisms. 42934e82e7dSBarry Smith 4301cc8b206SBarry Smith .seealso: PETSC_TRUE, PETSC_FALSE, PetscNot() 431d382aafbSBarry Smith E*/ 432ace3abfcSBarry Smith typedef enum { PETSC_FALSE,PETSC_TRUE } PetscBool; 4336a6fc655SJed Brown PETSC_EXTERN const char *const PetscBools[]; 4345a576424SJed Brown PETSC_EXTERN MPI_Datatype MPIU_BOOL PetscAttrMPITypeTag(PetscBool); 43570b3c8c7SBarry Smith 4368b49ba18SBarry Smith /* 437390e1bf2SBarry Smith Defines elementary mathematics functions and constants. 4388b49ba18SBarry Smith */ 4398b49ba18SBarry Smith #include <petscmath.h> 4408b49ba18SBarry Smith 44170b3c8c7SBarry Smith /*E 44270b3c8c7SBarry Smith PetscCopyMode - Determines how an array passed to certain functions is copied or retained 44370b3c8c7SBarry Smith 44470b3c8c7SBarry Smith Level: beginner 44570b3c8c7SBarry Smith 44670b3c8c7SBarry Smith $ PETSC_COPY_VALUES - the array values are copied into new space, the user is free to reuse or delete the passed in array 44770b3c8c7SBarry Smith $ PETSC_OWN_POINTER - the array values are NOT copied, the object takes ownership of the array and will free it later, the user cannot change or 44870b3c8c7SBarry Smith $ delete the array. The array MUST have been obtained with PetscMalloc(). Hence this mode cannot be used in Fortran. 44970b3c8c7SBarry Smith $ PETSC_USE_POINTER - the array values are NOT copied, the object uses the array but does NOT take ownership of the array. The user cannot use 45070b3c8c7SBarry Smith the array but the user must delete the array after the object is destroyed. 45170b3c8c7SBarry Smith 45270b3c8c7SBarry Smith E*/ 45370b3c8c7SBarry Smith typedef enum { PETSC_COPY_VALUES, PETSC_OWN_POINTER, PETSC_USE_POINTER} PetscCopyMode; 4546a6fc655SJed Brown PETSC_EXTERN const char *const PetscCopyModes[]; 455d382aafbSBarry Smith 456d382aafbSBarry Smith /*MC 457ace3abfcSBarry Smith PETSC_FALSE - False value of PetscBool 458d382aafbSBarry Smith 459d382aafbSBarry Smith Level: beginner 460d382aafbSBarry Smith 461d382aafbSBarry Smith Note: Zero integer 462d382aafbSBarry Smith 463ace3abfcSBarry Smith .seealso: PetscBool, PETSC_TRUE 464d382aafbSBarry Smith M*/ 465d382aafbSBarry Smith 466d382aafbSBarry Smith /*MC 467ace3abfcSBarry Smith PETSC_TRUE - True value of PetscBool 468d382aafbSBarry Smith 469d382aafbSBarry Smith Level: beginner 470d382aafbSBarry Smith 471d382aafbSBarry Smith Note: Nonzero integer 472d382aafbSBarry Smith 473ace3abfcSBarry Smith .seealso: PetscBool, PETSC_FALSE 474d382aafbSBarry Smith M*/ 475d382aafbSBarry Smith 476d382aafbSBarry Smith /*MC 4770298fd71SBarry Smith PETSC_IGNORE - same as NULL, means PETSc will ignore this argument 478d382aafbSBarry Smith 479d382aafbSBarry Smith Level: beginner 480d382aafbSBarry Smith 481d382aafbSBarry Smith Note: accepted by many PETSc functions to not set a parameter and instead use 482d382aafbSBarry Smith some default 483d382aafbSBarry Smith 484d382aafbSBarry Smith Fortran Notes: This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER, 485d382aafbSBarry Smith PETSC_NULL_DOUBLE_PRECISION etc 486d382aafbSBarry Smith 487d382aafbSBarry Smith .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_NULL, PETSC_DETERMINE 488d382aafbSBarry Smith 489d382aafbSBarry Smith M*/ 4900298fd71SBarry Smith #define PETSC_IGNORE NULL 491d382aafbSBarry Smith 492c528d872SBarry Smith /* This is deprecated */ 493c528d872SBarry Smith #define PETSC_NULL NULL 494c528d872SBarry Smith 495d382aafbSBarry Smith /*MC 496557d4da8SBarry Smith PETSC_DECIDE - standard way of passing in integer or floating point parameter 497557d4da8SBarry Smith where you wish PETSc to use the default. 498557d4da8SBarry Smith 499557d4da8SBarry Smith Level: beginner 500557d4da8SBarry Smith 501557d4da8SBarry Smith .seealso: PETSC_NULL, PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE 502557d4da8SBarry Smith 503557d4da8SBarry Smith M*/ 504557d4da8SBarry Smith #define PETSC_DECIDE -1 505557d4da8SBarry Smith 506557d4da8SBarry Smith /*MC 507d382aafbSBarry Smith PETSC_DETERMINE - standard way of passing in integer or floating point parameter 508d382aafbSBarry Smith where you wish PETSc to compute the required value. 509d382aafbSBarry Smith 510d382aafbSBarry Smith Level: beginner 511d382aafbSBarry Smith 512557d4da8SBarry Smith Developer Note: I would like to use const PetscInt PETSC_DETERMINE = PETSC_DECIDE; but for 513557d4da8SBarry Smith some reason this is not allowed by the standard even though PETSC_DECIDE is a constant value. 514557d4da8SBarry Smith 5150298fd71SBarry Smith .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, VecSetSizes() 516d382aafbSBarry Smith 517d382aafbSBarry Smith M*/ 518d382aafbSBarry Smith #define PETSC_DETERMINE PETSC_DECIDE 519d382aafbSBarry Smith 520d382aafbSBarry Smith /*MC 521557d4da8SBarry Smith PETSC_DEFAULT - standard way of passing in integer or floating point parameter 522557d4da8SBarry Smith where you wish PETSc to use the default. 523557d4da8SBarry Smith 524557d4da8SBarry Smith Level: beginner 525557d4da8SBarry Smith 5262d80014bSBarry Smith Fortran Notes: You need to use PETSC_DEFAULT_INTEGER or PETSC_DEFAULT_REAL. 527557d4da8SBarry Smith 5280298fd71SBarry Smith .seealso: PETSC_DECIDE, PETSC_IGNORE, PETSC_DETERMINE 529557d4da8SBarry Smith 530557d4da8SBarry Smith M*/ 531557d4da8SBarry Smith #define PETSC_DEFAULT -2 532557d4da8SBarry Smith 533557d4da8SBarry Smith /*MC 534d382aafbSBarry Smith PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents 535d382aafbSBarry Smith all the processs that PETSc knows about. 536d382aafbSBarry Smith 537d382aafbSBarry Smith Level: beginner 538d382aafbSBarry Smith 539d382aafbSBarry Smith Notes: By default PETSC_COMM_WORLD and MPI_COMM_WORLD are identical unless you wish to 540d382aafbSBarry Smith run PETSc on ONLY a subset of MPI_COMM_WORLD. In that case create your new (smaller) 541d382aafbSBarry Smith communicator, call it, say comm, and set PETSC_COMM_WORLD = comm BEFORE calling 542a990b902SBarry Smith PetscInitialize(), but after MPI_Init() has been called. 543a990b902SBarry Smith 544a990b902SBarry Smith The value of PETSC_COMM_WORLD should never be USED/accessed before PetscInitialize() 545a990b902SBarry Smith is called because it may not have a valid value yet. 546d382aafbSBarry Smith 547d382aafbSBarry Smith .seealso: PETSC_COMM_SELF 548d382aafbSBarry Smith 549d382aafbSBarry Smith M*/ 550014dd563SJed Brown PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD; 551d382aafbSBarry Smith 552d382aafbSBarry Smith /*MC 553503cfb0cSBarry Smith PETSC_COMM_SELF - This is always MPI_COMM_SELF 554d382aafbSBarry Smith 555d382aafbSBarry Smith Level: beginner 556d382aafbSBarry Smith 557a990b902SBarry Smith Notes: Do not USE/access or set this variable before PetscInitialize() has been called. 558a990b902SBarry Smith 559d382aafbSBarry Smith .seealso: PETSC_COMM_WORLD 560d382aafbSBarry Smith 561d382aafbSBarry Smith M*/ 562d382aafbSBarry Smith #define PETSC_COMM_SELF MPI_COMM_SELF 563d382aafbSBarry Smith 564d6f2c3cbSBarry Smith PETSC_EXTERN PetscBool PetscBeganMPI; 565014dd563SJed Brown PETSC_EXTERN PetscBool PetscInitializeCalled; 566014dd563SJed Brown PETSC_EXTERN PetscBool PetscFinalizeCalled; 567014dd563SJed Brown PETSC_EXTERN PetscBool PetscCUSPSynchronize; 5684cf1874eSKarl Rupp PETSC_EXTERN PetscBool PetscViennaCLSynchronize; 56982f73ecaSAlejandro Lamas Daviña PETSC_EXTERN PetscBool PetscCUDASynchronize; 570d382aafbSBarry Smith 571014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm)); 572014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*); 573014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm*); 574d382aafbSBarry Smith 575d382aafbSBarry Smith /*MC 57695dccacaSBarry Smith PetscMalloc - Allocates memory, One should use PetscNew(), PetscMalloc1() or PetscCalloc1() usually instead of this 577d382aafbSBarry Smith 578eca87e8dSBarry Smith Synopsis: 579aaa7dc30SBarry Smith #include <petscsys.h> 580eca87e8dSBarry Smith PetscErrorCode PetscMalloc(size_t m,void **result) 581eca87e8dSBarry Smith 582eca87e8dSBarry Smith Not Collective 583eca87e8dSBarry Smith 584d382aafbSBarry Smith Input Parameter: 585d382aafbSBarry Smith . m - number of bytes to allocate 586d382aafbSBarry Smith 587d382aafbSBarry Smith Output Parameter: 588d382aafbSBarry Smith . result - memory allocated 589d382aafbSBarry Smith 590d382aafbSBarry Smith Level: beginner 591d382aafbSBarry Smith 59249d7da52SJed Brown Notes: 59349d7da52SJed Brown Memory is always allocated at least double aligned 594d382aafbSBarry Smith 59549d7da52SJed Brown It is safe to allocate size 0 and pass the resulting pointer (which may or may not be NULL) to PetscFree(). 596d382aafbSBarry Smith 597d382aafbSBarry Smith .seealso: PetscFree(), PetscNew() 598d382aafbSBarry Smith 599d382aafbSBarry Smith Concepts: memory allocation 600d382aafbSBarry Smith 601d382aafbSBarry Smith M*/ 60249d7da52SJed Brown #define PetscMalloc(a,b) ((*PetscTrMalloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b))) 603d382aafbSBarry Smith 604d382aafbSBarry Smith /*MC 6053221ece2SMatthew G. Knepley PetscRealloc - Rellocates memory 6063221ece2SMatthew G. Knepley 6073221ece2SMatthew G. Knepley Synopsis: 6083221ece2SMatthew G. Knepley #include <petscsys.h> 6093221ece2SMatthew G. Knepley PetscErrorCode PetscRealloc(size_t m,void **result) 6103221ece2SMatthew G. Knepley 6113221ece2SMatthew G. Knepley Not Collective 6123221ece2SMatthew G. Knepley 6133221ece2SMatthew G. Knepley Input Parameters: 6143221ece2SMatthew G. Knepley + m - number of bytes to allocate 6153221ece2SMatthew G. Knepley - result - initial memory allocated 6163221ece2SMatthew G. Knepley 6173221ece2SMatthew G. Knepley Output Parameter: 6183221ece2SMatthew G. Knepley . result - new memory allocated 6193221ece2SMatthew G. Knepley 6203221ece2SMatthew G. Knepley Level: developer 6213221ece2SMatthew G. Knepley 6223221ece2SMatthew G. Knepley Notes: 6233221ece2SMatthew G. Knepley Memory is always allocated at least double aligned 6243221ece2SMatthew G. Knepley 6253221ece2SMatthew G. Knepley .seealso: PetscMalloc(), PetscFree(), PetscNew() 6263221ece2SMatthew G. Knepley 6273221ece2SMatthew G. Knepley Concepts: memory allocation 6283221ece2SMatthew G. Knepley 6293221ece2SMatthew G. Knepley M*/ 6303221ece2SMatthew G. Knepley #define PetscRealloc(a,b) ((*PetscTrRealloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,(void**)(b))) 6313221ece2SMatthew G. Knepley 6323221ece2SMatthew G. Knepley /*MC 633503cfb0cSBarry Smith PetscAddrAlign - Rounds up an address to PETSC_MEMALIGN alignment 634d382aafbSBarry Smith 635d382aafbSBarry Smith Synopsis: 636aaa7dc30SBarry Smith #include <petscsys.h> 637d382aafbSBarry Smith void *PetscAddrAlign(void *addr) 638d382aafbSBarry Smith 639eca87e8dSBarry Smith Not Collective 640eca87e8dSBarry Smith 641eca87e8dSBarry Smith Input Parameters: 642eca87e8dSBarry Smith . addr - address to align (any pointer type) 643eca87e8dSBarry Smith 644d382aafbSBarry Smith Level: developer 645d382aafbSBarry Smith 646d382aafbSBarry Smith .seealso: PetscMallocAlign() 647d382aafbSBarry Smith 648d382aafbSBarry Smith Concepts: memory allocation 649d382aafbSBarry Smith M*/ 650d382aafbSBarry Smith #define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1)) 651d382aafbSBarry Smith 652d382aafbSBarry Smith /*MC 653785e854fSJed Brown PetscMalloc1 - Allocates an array of memory aligned to PETSC_MEMALIGN 654d382aafbSBarry Smith 655eca87e8dSBarry Smith Synopsis: 656aaa7dc30SBarry Smith #include <petscsys.h> 657785e854fSJed Brown PetscErrorCode PetscMalloc1(size_t m1,type **r1) 658785e854fSJed Brown 659785e854fSJed Brown Not Collective 660785e854fSJed Brown 661785e854fSJed Brown Input Parameter: 662390e1bf2SBarry Smith . m1 - number of elements to allocate (may be zero) 663785e854fSJed Brown 664785e854fSJed Brown Output Parameter: 665785e854fSJed Brown . r1 - memory allocated in first chunk 666785e854fSJed Brown 667390e1bf2SBarry Smith Note: This uses the sizeof() of the memory type requested to determine the total memory to be allocated, therefore you should not 668390e1bf2SBarry Smith multiply the number of elements requested by the sizeof() the type. For example use 669390e1bf2SBarry Smith $ PetscInt *id; 670390e1bf2SBarry Smith $ PetscMalloc1(10,&id); 671390e1bf2SBarry Smith not 672390e1bf2SBarry Smith $ PetscInt *id; 673390e1bf2SBarry Smith $ PetscMalloc1(10*sizeof(PetscInt),&id); 674390e1bf2SBarry Smith 675390e1bf2SBarry Smith Does not zero the memory allocatd, used PetscCalloc1() to obtain memory that has been zeroed. 676390e1bf2SBarry Smith 677390e1bf2SBarry Smith Level: beginner 678785e854fSJed Brown 6791795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2() 680785e854fSJed Brown 681785e854fSJed Brown Concepts: memory allocation 682785e854fSJed Brown 683785e854fSJed Brown M*/ 684f0ba7cfcSLisandro Dalcin #define PetscMalloc1(m1,r1) PetscMalloc((m1)*sizeof(**(r1)),r1) 685785e854fSJed Brown 686785e854fSJed Brown /*MC 6871795a4d1SJed Brown PetscCalloc1 - Allocates a cleared (zeroed) array of memory aligned to PETSC_MEMALIGN 6881795a4d1SJed Brown 6891795a4d1SJed Brown Synopsis: 690aaa7dc30SBarry Smith #include <petscsys.h> 6911795a4d1SJed Brown PetscErrorCode PetscCalloc1(size_t m1,type **r1) 6921795a4d1SJed Brown 6931795a4d1SJed Brown Not Collective 6941795a4d1SJed Brown 6951795a4d1SJed Brown Input Parameter: 6961795a4d1SJed Brown . m1 - number of elements to allocate in 1st chunk (may be zero) 6971795a4d1SJed Brown 6981795a4d1SJed Brown Output Parameter: 6991795a4d1SJed Brown . r1 - memory allocated in first chunk 7001795a4d1SJed Brown 701390e1bf2SBarry Smith Notes: see PetsMalloc1() for more details on usage. 702390e1bf2SBarry Smith 703390e1bf2SBarry Smith Level: beginner 7041795a4d1SJed Brown 7051795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2() 7061795a4d1SJed Brown 7071795a4d1SJed Brown Concepts: memory allocation 7081795a4d1SJed Brown 7091795a4d1SJed Brown M*/ 7101795a4d1SJed Brown #define PetscCalloc1(m1,r1) (PetscMalloc1((m1),r1) || PetscMemzero(*(r1),(m1)*sizeof(**(r1)))) 7111795a4d1SJed Brown 7121795a4d1SJed Brown /*MC 713dcca6d9dSJed Brown PetscMalloc2 - Allocates 2 arrays of memory both aligned to PETSC_MEMALIGN 714d382aafbSBarry Smith 715eca87e8dSBarry Smith Synopsis: 716aaa7dc30SBarry Smith #include <petscsys.h> 717dcca6d9dSJed Brown PetscErrorCode PetscMalloc2(size_t m1,type **r1,size_t m2,type **r2) 718eca87e8dSBarry Smith 719eca87e8dSBarry Smith Not Collective 720eca87e8dSBarry Smith 721d382aafbSBarry Smith Input Parameter: 722d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 723dcca6d9dSJed Brown - m2 - number of elements to allocate in 2nd chunk (may be zero) 724d382aafbSBarry Smith 725d382aafbSBarry Smith Output Parameter: 726d382aafbSBarry Smith + r1 - memory allocated in first chunk 727d382aafbSBarry Smith - r2 - memory allocated in second chunk 728d382aafbSBarry Smith 729d382aafbSBarry Smith Level: developer 730d382aafbSBarry Smith 7311795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc1(), PetscCalloc2() 732d382aafbSBarry Smith 733d382aafbSBarry Smith Concepts: memory allocation 734d382aafbSBarry Smith 735d382aafbSBarry Smith M*/ 73620a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED) 7371d2f33c5SMatthew G. Knepley #define PetscMalloc2(m1,r1,m2,r2) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2))) 738d382aafbSBarry Smith #else 739ceba6b73SMatthew G. Knepley #define PetscMalloc2(m1,r1,m2,r2) ((((m1)+(m2)) ? (*(r2) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(PETSC_MEMALIGN-1),r1)) : 0) \ 740ceba6b73SMatthew G. Knepley || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),0) \ 7413589d31bSMatthew G. Knepley || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0)) 742d382aafbSBarry Smith #endif 743d382aafbSBarry Smith 744d382aafbSBarry Smith /*MC 7451795a4d1SJed Brown PetscCalloc2 - Allocates 2 cleared (zeroed) arrays of memory both aligned to PETSC_MEMALIGN 746d382aafbSBarry Smith 747eca87e8dSBarry Smith Synopsis: 748aaa7dc30SBarry Smith #include <petscsys.h> 7491795a4d1SJed Brown PetscErrorCode PetscCalloc2(size_t m1,type **r1,size_t m2,type **r2) 750eca87e8dSBarry Smith 751eca87e8dSBarry Smith Not Collective 752eca87e8dSBarry Smith 753d382aafbSBarry Smith Input Parameter: 754d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 7551795a4d1SJed Brown - m2 - number of elements to allocate in 2nd chunk (may be zero) 7561795a4d1SJed Brown 7571795a4d1SJed Brown Output Parameter: 7581795a4d1SJed Brown + r1 - memory allocated in first chunk 7591795a4d1SJed Brown - r2 - memory allocated in second chunk 7601795a4d1SJed Brown 7611795a4d1SJed Brown Level: developer 7621795a4d1SJed Brown 7631795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc1(), PetscMalloc2() 7641795a4d1SJed Brown 7651795a4d1SJed Brown Concepts: memory allocation 7661795a4d1SJed Brown M*/ 7671795a4d1SJed Brown #define PetscCalloc2(m1,r1,m2,r2) (PetscMalloc2((m1),(r1),(m2),(r2)) || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2)))) 7681795a4d1SJed Brown 7691795a4d1SJed Brown /*MC 770dcca6d9dSJed Brown PetscMalloc3 - Allocates 3 arrays of memory, all aligned to PETSC_MEMALIGN 771d382aafbSBarry Smith 772d382aafbSBarry Smith Synopsis: 773aaa7dc30SBarry Smith #include <petscsys.h> 774dcca6d9dSJed Brown PetscErrorCode PetscMalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3) 775d382aafbSBarry Smith 776d382aafbSBarry Smith Not Collective 777d382aafbSBarry Smith 778d382aafbSBarry Smith Input Parameter: 779d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 780d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 781dcca6d9dSJed Brown - m3 - number of elements to allocate in 3rd chunk (may be zero) 782d382aafbSBarry Smith 783d382aafbSBarry Smith Output Parameter: 784d382aafbSBarry Smith + r1 - memory allocated in first chunk 785d382aafbSBarry Smith . r2 - memory allocated in second chunk 786d382aafbSBarry Smith - r3 - memory allocated in third chunk 787d382aafbSBarry Smith 788d382aafbSBarry Smith Level: developer 789d382aafbSBarry Smith 7901795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc3(), PetscFree3() 791d382aafbSBarry Smith 792d382aafbSBarry Smith Concepts: memory allocation 793d382aafbSBarry Smith 794d382aafbSBarry Smith M*/ 79520a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED) 7961d2f33c5SMatthew G. Knepley #define PetscMalloc3(m1,r1,m2,r2,m3,r3) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3))) 797d382aafbSBarry Smith #else 798ceba6b73SMatthew G. Knepley #define PetscMalloc3(m1,r1,m2,r2,m3,r3) ((((m1)+(m2)+(m3)) ? (*(r2) = 0,*(r3) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+2*(PETSC_MEMALIGN-1),r1)) : 0) \ 799278791cbSMatthew G. Knepley || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),0) \ 8003589d31bSMatthew G. Knepley || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0) || (!(m3) ? (*(r3) = 0,0) : 0)) 801d382aafbSBarry Smith #endif 802d382aafbSBarry Smith 803d382aafbSBarry Smith /*MC 8041795a4d1SJed Brown PetscCalloc3 - Allocates 3 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 805d382aafbSBarry Smith 806eca87e8dSBarry Smith Synopsis: 807aaa7dc30SBarry Smith #include <petscsys.h> 8081795a4d1SJed Brown PetscErrorCode PetscCalloc3(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3) 809eca87e8dSBarry Smith 810eca87e8dSBarry Smith Not Collective 811eca87e8dSBarry Smith 812d382aafbSBarry Smith Input Parameter: 813d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 814d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 8151795a4d1SJed Brown - m3 - number of elements to allocate in 3rd chunk (may be zero) 8161795a4d1SJed Brown 8171795a4d1SJed Brown Output Parameter: 8181795a4d1SJed Brown + r1 - memory allocated in first chunk 8191795a4d1SJed Brown . r2 - memory allocated in second chunk 8201795a4d1SJed Brown - r3 - memory allocated in third chunk 8211795a4d1SJed Brown 8221795a4d1SJed Brown Level: developer 8231795a4d1SJed Brown 8241795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscCalloc2(), PetscMalloc3(), PetscFree3() 8251795a4d1SJed Brown 8261795a4d1SJed Brown Concepts: memory allocation 8271795a4d1SJed Brown M*/ 8281795a4d1SJed Brown #define PetscCalloc3(m1,r1,m2,r2,m3,r3) \ 8291795a4d1SJed Brown (PetscMalloc3((m1),(r1),(m2),(r2),(m3),(r3)) \ 8301795a4d1SJed Brown || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3)))) 8311795a4d1SJed Brown 8321795a4d1SJed Brown /*MC 833dcca6d9dSJed Brown PetscMalloc4 - Allocates 4 arrays of memory, all aligned to PETSC_MEMALIGN 834d382aafbSBarry Smith 835d382aafbSBarry Smith Synopsis: 836aaa7dc30SBarry Smith #include <petscsys.h> 837dcca6d9dSJed Brown PetscErrorCode PetscMalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4) 838d382aafbSBarry Smith 839d382aafbSBarry Smith Not Collective 840d382aafbSBarry Smith 841d382aafbSBarry Smith Input Parameter: 842d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 843d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 844d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 845dcca6d9dSJed Brown - m4 - number of elements to allocate in 4th chunk (may be zero) 846d382aafbSBarry Smith 847d382aafbSBarry Smith Output Parameter: 848d382aafbSBarry Smith + r1 - memory allocated in first chunk 849d382aafbSBarry Smith . r2 - memory allocated in second chunk 850d382aafbSBarry Smith . r3 - memory allocated in third chunk 851d382aafbSBarry Smith - r4 - memory allocated in fourth chunk 852d382aafbSBarry Smith 853d382aafbSBarry Smith Level: developer 854d382aafbSBarry Smith 8551795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4() 856d382aafbSBarry Smith 857d382aafbSBarry Smith Concepts: memory allocation 858d382aafbSBarry Smith 859d382aafbSBarry Smith M*/ 86020a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED) 8611d2f33c5SMatthew G. Knepley #define PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)) || PetscMalloc1((m4),(r4))) 862d382aafbSBarry Smith #else 863dcca6d9dSJed Brown #define PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4) \ 864ceba6b73SMatthew G. Knepley ((((m1)+(m2)+(m3)+(m4)) ? (*(r2) = 0, *(r3) = 0, *(r4) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+(m4)*sizeof(**(r4))+3*(PETSC_MEMALIGN-1),r1)) : 0) \ 865278791cbSMatthew G. Knepley || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),0) \ 8663589d31bSMatthew G. Knepley || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0) || (!(m3) ? (*(r3) = 0,0) : 0) || (!(m4) ? (*(r4) = 0,0) : 0)) 867d382aafbSBarry Smith #endif 868d382aafbSBarry Smith 869d382aafbSBarry Smith /*MC 8701795a4d1SJed Brown PetscCalloc4 - Allocates 4 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 871d382aafbSBarry Smith 872eca87e8dSBarry Smith Synopsis: 873aaa7dc30SBarry Smith #include <petscsys.h> 8741795a4d1SJed Brown PetscErrorCode PetscCalloc4(size_t m1,type **r1,size_t m2,type **r2,size_t m3,type **r3,size_t m4,type **r4) 875eca87e8dSBarry Smith 876eca87e8dSBarry Smith Not Collective 877eca87e8dSBarry Smith 878d382aafbSBarry Smith Input Parameter: 879d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 880d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 881d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 8821795a4d1SJed Brown - m4 - number of elements to allocate in 4th chunk (may be zero) 8831795a4d1SJed Brown 8841795a4d1SJed Brown Output Parameter: 8851795a4d1SJed Brown + r1 - memory allocated in first chunk 8861795a4d1SJed Brown . r2 - memory allocated in second chunk 8871795a4d1SJed Brown . r3 - memory allocated in third chunk 8881795a4d1SJed Brown - r4 - memory allocated in fourth chunk 8891795a4d1SJed Brown 8901795a4d1SJed Brown Level: developer 8911795a4d1SJed Brown 8921795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc4(), PetscFree4() 8931795a4d1SJed Brown 8941795a4d1SJed Brown Concepts: memory allocation 8951795a4d1SJed Brown 8961795a4d1SJed Brown M*/ 8971795a4d1SJed Brown #define PetscCalloc4(m1,r1,m2,r2,m3,r3,m4,r4) \ 8981795a4d1SJed Brown (PetscMalloc4(m1,r1,m2,r2,m3,r3,m4,r4) \ 8991795a4d1SJed Brown || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \ 9001795a4d1SJed Brown || PetscMemzero(*(r4),(m4)*sizeof(**(r4)))) 9011795a4d1SJed Brown 9021795a4d1SJed Brown /*MC 903dcca6d9dSJed Brown PetscMalloc5 - Allocates 5 arrays of memory, all aligned to PETSC_MEMALIGN 904d382aafbSBarry Smith 905d382aafbSBarry Smith Synopsis: 906aaa7dc30SBarry Smith #include <petscsys.h> 907dcca6d9dSJed 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) 908d382aafbSBarry Smith 909d382aafbSBarry Smith Not Collective 910d382aafbSBarry Smith 911d382aafbSBarry Smith Input Parameter: 912d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 913d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 914d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 915d382aafbSBarry Smith . m4 - number of elements to allocate in 4th chunk (may be zero) 916dcca6d9dSJed Brown - m5 - number of elements to allocate in 5th chunk (may be zero) 917d382aafbSBarry Smith 918d382aafbSBarry Smith Output Parameter: 919d382aafbSBarry Smith + r1 - memory allocated in first chunk 920d382aafbSBarry Smith . r2 - memory allocated in second chunk 921d382aafbSBarry Smith . r3 - memory allocated in third chunk 922d382aafbSBarry Smith . r4 - memory allocated in fourth chunk 923d382aafbSBarry Smith - r5 - memory allocated in fifth chunk 924d382aafbSBarry Smith 925d382aafbSBarry Smith Level: developer 926d382aafbSBarry Smith 9271795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc5(), PetscFree5() 928d382aafbSBarry Smith 929d382aafbSBarry Smith Concepts: memory allocation 930d382aafbSBarry Smith 931d382aafbSBarry Smith M*/ 93220a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED) 9331d2f33c5SMatthew G. Knepley #define PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)) || PetscMalloc1((m4),(r4)) || PetscMalloc1((m5),(r5))) 934d382aafbSBarry Smith #else 935dcca6d9dSJed Brown #define PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) \ 936ceba6b73SMatthew G. Knepley ((((m1)+(m2)+(m3)+(m4)+(m5)) ? (*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+(m4)*sizeof(**(r4))+(m5)*sizeof(**(r5))+4*(PETSC_MEMALIGN-1),r1)) : 0) \ 937278791cbSMatthew G. Knepley || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),*(void**)(r5) = PetscAddrAlign(*(r4)+(m4)),0) \ 9383589d31bSMatthew G. Knepley || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0) || (!(m3) ? (*(r3) = 0,0) : 0) || (!(m4) ? (*(r4) = 0,0) : 0) || (!(m5) ? (*(r5) = 0,0) : 0)) 939d382aafbSBarry Smith #endif 940d382aafbSBarry Smith 941d382aafbSBarry Smith /*MC 9421795a4d1SJed Brown PetscCalloc5 - Allocates 5 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 943d382aafbSBarry Smith 944eca87e8dSBarry Smith Synopsis: 945aaa7dc30SBarry Smith #include <petscsys.h> 9461795a4d1SJed 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) 947eca87e8dSBarry Smith 948eca87e8dSBarry Smith Not Collective 949eca87e8dSBarry Smith 950d382aafbSBarry Smith Input Parameter: 951d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 952d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 953d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 954d382aafbSBarry Smith . m4 - number of elements to allocate in 4th chunk (may be zero) 9551795a4d1SJed Brown - m5 - number of elements to allocate in 5th chunk (may be zero) 9561795a4d1SJed Brown 9571795a4d1SJed Brown Output Parameter: 9581795a4d1SJed Brown + r1 - memory allocated in first chunk 9591795a4d1SJed Brown . r2 - memory allocated in second chunk 9601795a4d1SJed Brown . r3 - memory allocated in third chunk 9611795a4d1SJed Brown . r4 - memory allocated in fourth chunk 9621795a4d1SJed Brown - r5 - memory allocated in fifth chunk 9631795a4d1SJed Brown 9641795a4d1SJed Brown Level: developer 9651795a4d1SJed Brown 9661795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc5(), PetscFree5() 9671795a4d1SJed Brown 9681795a4d1SJed Brown Concepts: memory allocation 9691795a4d1SJed Brown 9701795a4d1SJed Brown M*/ 9711795a4d1SJed Brown #define PetscCalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) \ 9721795a4d1SJed Brown (PetscMalloc5(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5) \ 9731795a4d1SJed Brown || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \ 9741795a4d1SJed Brown || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5)))) 975d382aafbSBarry Smith 976d382aafbSBarry Smith /*MC 977dcca6d9dSJed Brown PetscMalloc6 - Allocates 6 arrays of memory, all aligned to PETSC_MEMALIGN 978d382aafbSBarry Smith 979d382aafbSBarry Smith Synopsis: 980aaa7dc30SBarry Smith #include <petscsys.h> 981dcca6d9dSJed 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) 982d382aafbSBarry Smith 983d382aafbSBarry Smith Not Collective 984d382aafbSBarry Smith 985d382aafbSBarry Smith Input Parameter: 986d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 987d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 988d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 989d382aafbSBarry Smith . m4 - number of elements to allocate in 4th chunk (may be zero) 990d382aafbSBarry Smith . m5 - number of elements to allocate in 5th chunk (may be zero) 991dcca6d9dSJed Brown - m6 - number of elements to allocate in 6th chunk (may be zero) 992d382aafbSBarry Smith 993d382aafbSBarry Smith Output Parameter: 994d382aafbSBarry Smith + r1 - memory allocated in first chunk 995d382aafbSBarry Smith . r2 - memory allocated in second chunk 996d382aafbSBarry Smith . r3 - memory allocated in third chunk 997d382aafbSBarry Smith . r4 - memory allocated in fourth chunk 998d382aafbSBarry Smith . r5 - memory allocated in fifth chunk 999d382aafbSBarry Smith - r6 - memory allocated in sixth chunk 1000d382aafbSBarry Smith 1001d382aafbSBarry Smith Level: developer 1002d382aafbSBarry Smith 10031795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc6(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6() 1004d382aafbSBarry Smith 1005d382aafbSBarry Smith Concepts: memory allocation 1006d382aafbSBarry Smith 1007d382aafbSBarry Smith M*/ 100820a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED) 10091d2f33c5SMatthew G. Knepley #define PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)) || PetscMalloc1((m4),(r4)) || PetscMalloc1((m5),(r5)) || PetscMalloc1((m6),(r6))) 1010d382aafbSBarry Smith #else 1011dcca6d9dSJed Brown #define PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) \ 1012ceba6b73SMatthew G. Knepley ((((m1)+(m2)+(m3)+(m4)+(m5)+(m6)) ? (*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,*(r6) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+(m4)*sizeof(**(r4))+(m5)*sizeof(**(r5))+(m6)*sizeof(**(r6))+5*(PETSC_MEMALIGN-1),r1)) : 0) \ 1013278791cbSMatthew G. Knepley || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),*(void**)(r5) = PetscAddrAlign(*(r4)+(m4)),*(void**)(r6) = PetscAddrAlign(*(r5)+(m5)),0) \ 10143589d31bSMatthew G. Knepley || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0) || (!(m3) ? (*(r3) = 0,0) : 0) || (!(m4) ? (*(r4) = 0,0) : 0) || (!(m5) ? (*(r5) = 0,0) : 0) || (!(m6) ? (*(r6) = 0,0) : 0)) 1015d382aafbSBarry Smith #endif 1016d382aafbSBarry Smith 1017d382aafbSBarry Smith /*MC 10181795a4d1SJed Brown PetscCalloc6 - Allocates 6 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 1019d382aafbSBarry Smith 1020eca87e8dSBarry Smith Synopsis: 1021aaa7dc30SBarry Smith #include <petscsys.h> 10221795a4d1SJed 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) 1023eca87e8dSBarry Smith 1024eca87e8dSBarry Smith Not Collective 1025eca87e8dSBarry Smith 1026d382aafbSBarry Smith Input Parameter: 1027d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 1028d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 1029d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 1030d382aafbSBarry Smith . m4 - number of elements to allocate in 4th chunk (may be zero) 1031d382aafbSBarry Smith . m5 - number of elements to allocate in 5th chunk (may be zero) 10321795a4d1SJed Brown - m6 - number of elements to allocate in 6th chunk (may be zero) 10331795a4d1SJed Brown 10341795a4d1SJed Brown Output Parameter: 10351795a4d1SJed Brown + r1 - memory allocated in first chunk 10361795a4d1SJed Brown . r2 - memory allocated in second chunk 10371795a4d1SJed Brown . r3 - memory allocated in third chunk 10381795a4d1SJed Brown . r4 - memory allocated in fourth chunk 10391795a4d1SJed Brown . r5 - memory allocated in fifth chunk 10401795a4d1SJed Brown - r6 - memory allocated in sixth chunk 10411795a4d1SJed Brown 10421795a4d1SJed Brown Level: developer 10431795a4d1SJed Brown 10441795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc6(), PetscFree6() 10451795a4d1SJed Brown 10461795a4d1SJed Brown Concepts: memory allocation 10471795a4d1SJed Brown M*/ 10481795a4d1SJed Brown #define PetscCalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) \ 10491795a4d1SJed Brown (PetscMalloc6(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6) \ 10501795a4d1SJed Brown || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \ 10511795a4d1SJed Brown || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5))) || PetscMemzero(*(r6),(m6)*sizeof(**(r6)))) 10521795a4d1SJed Brown 10531795a4d1SJed Brown /*MC 1054dcca6d9dSJed Brown PetscMalloc7 - Allocates 7 arrays of memory, all aligned to PETSC_MEMALIGN 1055d382aafbSBarry Smith 1056d382aafbSBarry Smith Synopsis: 1057aaa7dc30SBarry Smith #include <petscsys.h> 1058dcca6d9dSJed 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) 1059d382aafbSBarry Smith 1060d382aafbSBarry Smith Not Collective 1061d382aafbSBarry Smith 1062d382aafbSBarry Smith Input Parameter: 1063d382aafbSBarry Smith + m1 - number of elements to allocate in 1st chunk (may be zero) 1064d382aafbSBarry Smith . m2 - number of elements to allocate in 2nd chunk (may be zero) 1065d382aafbSBarry Smith . m3 - number of elements to allocate in 3rd chunk (may be zero) 1066d382aafbSBarry Smith . m4 - number of elements to allocate in 4th chunk (may be zero) 1067d382aafbSBarry Smith . m5 - number of elements to allocate in 5th chunk (may be zero) 1068d382aafbSBarry Smith . m6 - number of elements to allocate in 6th chunk (may be zero) 1069dcca6d9dSJed Brown - m7 - number of elements to allocate in 7th chunk (may be zero) 1070d382aafbSBarry Smith 1071d382aafbSBarry Smith Output Parameter: 1072d382aafbSBarry Smith + r1 - memory allocated in first chunk 1073d382aafbSBarry Smith . r2 - memory allocated in second chunk 1074d382aafbSBarry Smith . r3 - memory allocated in third chunk 1075d382aafbSBarry Smith . r4 - memory allocated in fourth chunk 1076d382aafbSBarry Smith . r5 - memory allocated in fifth chunk 1077d382aafbSBarry Smith . r6 - memory allocated in sixth chunk 1078eca87e8dSBarry Smith - r7 - memory allocated in seventh chunk 1079d382aafbSBarry Smith 1080d382aafbSBarry Smith Level: developer 1081d382aafbSBarry Smith 10821795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscCalloc7(), PetscFree7() 1083d382aafbSBarry Smith 1084d382aafbSBarry Smith Concepts: memory allocation 1085d382aafbSBarry Smith 1086d382aafbSBarry Smith M*/ 108720a89254SJed Brown #if !defined(PETSC_USE_MALLOC_COALESCED) 10881d2f33c5SMatthew G. Knepley #define PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) (PetscMalloc1((m1),(r1)) || PetscMalloc1((m2),(r2)) || PetscMalloc1((m3),(r3)) || PetscMalloc1((m4),(r4)) || PetscMalloc1((m5),(r5)) || PetscMalloc1((m6),(r6)) || PetscMalloc1((m7),(r7))) 1089d382aafbSBarry Smith #else 1090dcca6d9dSJed Brown #define PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) \ 1091ceba6b73SMatthew G. Knepley ((((m1)+(m2)+(m3)+(m4)+(m5)+(m6)+(m7)) ? (*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,*(r6) = 0,*(r7) = 0,PetscMalloc((m1)*sizeof(**(r1))+(m2)*sizeof(**(r2))+(m3)*sizeof(**(r3))+(m4)*sizeof(**(r4))+(m5)*sizeof(**(r5))+(m6)*sizeof(**(r6))+(m7)*sizeof(**(r7))+6*(PETSC_MEMALIGN-1),r1)) : 0) \ 1092278791cbSMatthew G. Knepley || (*(void**)(r2) = PetscAddrAlign(*(r1)+(m1)),*(void**)(r3) = PetscAddrAlign(*(r2)+(m2)),*(void**)(r4) = PetscAddrAlign(*(r3)+(m3)),*(void**)(r5) = PetscAddrAlign(*(r4)+(m4)),*(void**)(r6) = PetscAddrAlign(*(r5)+(m5)),*(void**)(r7) = PetscAddrAlign(*(r6)+(m6)),0) \ 10933589d31bSMatthew G. Knepley || (!(m1) ? (*(r1) = 0,0) : 0) || (!(m2) ? (*(r2) = 0,0) : 0) || (!(m3) ? (*(r3) = 0,0) : 0) || (!(m4) ? (*(r4) = 0,0) : 0) || (!(m5) ? (*(r5) = 0,0) : 0) || (!(m6) ? (*(r6) = 0,0) : 0) || (!(m7) ? (*(r7) = 0,0) : 0)) 1094d382aafbSBarry Smith #endif 1095d382aafbSBarry Smith 1096d382aafbSBarry Smith /*MC 10971795a4d1SJed Brown PetscCalloc7 - Allocates 7 cleared (zeroed) arrays of memory, all aligned to PETSC_MEMALIGN 10981795a4d1SJed Brown 10991795a4d1SJed Brown Synopsis: 1100aaa7dc30SBarry Smith #include <petscsys.h> 11011795a4d1SJed 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) 11021795a4d1SJed Brown 11031795a4d1SJed Brown Not Collective 11041795a4d1SJed Brown 11051795a4d1SJed Brown Input Parameter: 11061795a4d1SJed Brown + m1 - number of elements to allocate in 1st chunk (may be zero) 11071795a4d1SJed Brown . m2 - number of elements to allocate in 2nd chunk (may be zero) 11081795a4d1SJed Brown . m3 - number of elements to allocate in 3rd chunk (may be zero) 11091795a4d1SJed Brown . m4 - number of elements to allocate in 4th chunk (may be zero) 11101795a4d1SJed Brown . m5 - number of elements to allocate in 5th chunk (may be zero) 11111795a4d1SJed Brown . m6 - number of elements to allocate in 6th chunk (may be zero) 11121795a4d1SJed Brown - m7 - number of elements to allocate in 7th chunk (may be zero) 11131795a4d1SJed Brown 11141795a4d1SJed Brown Output Parameter: 11151795a4d1SJed Brown + r1 - memory allocated in first chunk 11161795a4d1SJed Brown . r2 - memory allocated in second chunk 11171795a4d1SJed Brown . r3 - memory allocated in third chunk 11181795a4d1SJed Brown . r4 - memory allocated in fourth chunk 11191795a4d1SJed Brown . r5 - memory allocated in fifth chunk 11201795a4d1SJed Brown . r6 - memory allocated in sixth chunk 11211795a4d1SJed Brown - r7 - memory allocated in seventh chunk 11221795a4d1SJed Brown 11231795a4d1SJed Brown Level: developer 11241795a4d1SJed Brown 11251795a4d1SJed Brown .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscMalloc7(), PetscFree7() 11261795a4d1SJed Brown 11271795a4d1SJed Brown Concepts: memory allocation 11281795a4d1SJed Brown M*/ 11291795a4d1SJed Brown #define PetscCalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) \ 11307ba0cc92SJed Brown (PetscMalloc7(m1,r1,m2,r2,m3,r3,m4,r4,m5,r5,m6,r6,m7,r7) \ 11311795a4d1SJed Brown || PetscMemzero(*(r1),(m1)*sizeof(**(r1))) || PetscMemzero(*(r2),(m2)*sizeof(**(r2))) || PetscMemzero(*(r3),(m3)*sizeof(**(r3))) \ 11321795a4d1SJed Brown || PetscMemzero(*(r4),(m4)*sizeof(**(r4))) || PetscMemzero(*(r5),(m5)*sizeof(**(r5))) || PetscMemzero(*(r6),(m6)*sizeof(**(r6))) \ 11337ba0cc92SJed Brown || PetscMemzero(*(r7),(m7)*sizeof(**(r7)))) 11341795a4d1SJed Brown 11351795a4d1SJed Brown /*MC 1136503cfb0cSBarry Smith PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to PETSC_MEMALIGN 1137d382aafbSBarry Smith 1138eca87e8dSBarry Smith Synopsis: 1139aaa7dc30SBarry Smith #include <petscsys.h> 1140b00a9115SJed Brown PetscErrorCode PetscNew(type **result) 1141eca87e8dSBarry Smith 1142eca87e8dSBarry Smith Not Collective 1143eca87e8dSBarry Smith 1144d382aafbSBarry Smith Output Parameter: 1145b00a9115SJed Brown . result - memory allocated, sized to match pointer type 1146d382aafbSBarry Smith 1147d382aafbSBarry Smith Level: beginner 1148d382aafbSBarry Smith 1149390e1bf2SBarry Smith .seealso: PetscFree(), PetscMalloc(), PetscNewLog(), PetscCalloc1(), PetscMalloc1() 1150d382aafbSBarry Smith 1151d382aafbSBarry Smith Concepts: memory allocation 1152d382aafbSBarry Smith 1153d382aafbSBarry Smith M*/ 1154b00a9115SJed Brown #define PetscNew(b) PetscCalloc1(1,(b)) 1155ad0619ddSBarry Smith 1156ad0619ddSBarry Smith /*MC 1157b00a9115SJed Brown PetscNewLog - Allocates memory of a type matching pointer, zeros the memory! Aligned to PETSC_MEMALIGN. Associates the memory allocated 1158ad0619ddSBarry Smith with the given object using PetscLogObjectMemory(). 1159ad0619ddSBarry Smith 1160ad0619ddSBarry Smith Synopsis: 1161aaa7dc30SBarry Smith #include <petscsys.h> 1162b00a9115SJed Brown PetscErrorCode PetscNewLog(PetscObject obj,type **result) 1163ad0619ddSBarry Smith 1164ad0619ddSBarry Smith Not Collective 1165ad0619ddSBarry Smith 1166ad0619ddSBarry Smith Input Parameter: 1167b00a9115SJed Brown . obj - object memory is logged to 1168ad0619ddSBarry Smith 1169ad0619ddSBarry Smith Output Parameter: 1170b00a9115SJed Brown . result - memory allocated, sized to match pointer type 1171ad0619ddSBarry Smith 1172ad0619ddSBarry Smith Level: developer 1173ad0619ddSBarry Smith 1174390e1bf2SBarry Smith .seealso: PetscFree(), PetscMalloc(), PetscNew(), PetscLogObjectMemory(), PetscCalloc1(), PetscMalloc1() 1175ad0619ddSBarry Smith 1176ad0619ddSBarry Smith Concepts: memory allocation 1177ad0619ddSBarry Smith 1178ad0619ddSBarry Smith M*/ 1179d12f57a0SLisandro Dalcin #define PetscNewLog(o,b) (PetscNew((b)) || PetscLogObjectMemory((PetscObject)o,sizeof(**(b)))) 1180d382aafbSBarry Smith 1181d382aafbSBarry Smith /*MC 1182d382aafbSBarry Smith PetscFree - Frees memory 1183d382aafbSBarry Smith 1184eca87e8dSBarry Smith Synopsis: 1185aaa7dc30SBarry Smith #include <petscsys.h> 1186eca87e8dSBarry Smith PetscErrorCode PetscFree(void *memory) 1187eca87e8dSBarry Smith 1188eca87e8dSBarry Smith Not Collective 1189eca87e8dSBarry Smith 1190d382aafbSBarry Smith Input Parameter: 1191390e1bf2SBarry Smith . memory - memory to free (the pointer is ALWAYS set to NULL upon sucess) 1192d382aafbSBarry Smith 1193d382aafbSBarry Smith Level: beginner 1194d382aafbSBarry Smith 119549d7da52SJed Brown Notes: 1196390e1bf2SBarry Smith Do not free memory obtained with PetscMalloc2(), PetscCalloc2() etc, they must be freed with PetscFree2() etc. 1197390e1bf2SBarry Smith 119849d7da52SJed Brown It is safe to call PetscFree() on a NULL pointer. 1199d382aafbSBarry Smith 1200390e1bf2SBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscNewLog(), PetscMalloc1(), PetscCalloc1() 1201d382aafbSBarry Smith 1202d382aafbSBarry Smith Concepts: memory allocation 1203d382aafbSBarry Smith 1204d382aafbSBarry Smith M*/ 120549d7da52SJed Brown #define PetscFree(a) ((*PetscTrFree)((void*)(a),__LINE__,PETSC_FUNCTION_NAME,__FILE__) || ((a) = 0,0)) 1206d382aafbSBarry Smith 1207d382aafbSBarry Smith /*MC 1208d382aafbSBarry Smith PetscFree2 - Frees 2 chunks of memory obtained with PetscMalloc2() 1209d382aafbSBarry Smith 1210eca87e8dSBarry Smith Synopsis: 1211aaa7dc30SBarry Smith #include <petscsys.h> 1212eca87e8dSBarry Smith PetscErrorCode PetscFree2(void *memory1,void *memory2) 1213eca87e8dSBarry Smith 1214eca87e8dSBarry Smith Not Collective 1215eca87e8dSBarry Smith 1216d382aafbSBarry Smith Input Parameter: 1217d382aafbSBarry Smith + memory1 - memory to free 1218d382aafbSBarry Smith - memory2 - 2nd memory to free 1219d382aafbSBarry Smith 1220d382aafbSBarry Smith Level: developer 1221d382aafbSBarry Smith 1222d382aafbSBarry Smith Notes: Memory must have been obtained with PetscMalloc2() 1223d382aafbSBarry Smith 1224d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree() 1225d382aafbSBarry Smith 1226d382aafbSBarry Smith Concepts: memory allocation 1227d382aafbSBarry Smith 1228d382aafbSBarry Smith M*/ 1229b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED) 1230d382aafbSBarry Smith #define PetscFree2(m1,m2) (PetscFree(m2) || PetscFree(m1)) 1231d382aafbSBarry Smith #else 1232e38f91f2SMatthew G. Knepley #define PetscFree2(m1,m2) ((m1) ? ((m2)=0,PetscFree(m1)) : ((m1)=0,PetscFree(m2))) 1233d382aafbSBarry Smith #endif 1234d382aafbSBarry Smith 1235d382aafbSBarry Smith /*MC 1236d382aafbSBarry Smith PetscFree3 - Frees 3 chunks of memory obtained with PetscMalloc3() 1237d382aafbSBarry Smith 1238eca87e8dSBarry Smith Synopsis: 1239aaa7dc30SBarry Smith #include <petscsys.h> 1240eca87e8dSBarry Smith PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3) 1241eca87e8dSBarry Smith 1242eca87e8dSBarry Smith Not Collective 1243eca87e8dSBarry Smith 1244d382aafbSBarry Smith Input Parameter: 1245d382aafbSBarry Smith + memory1 - memory to free 1246d382aafbSBarry Smith . memory2 - 2nd memory to free 1247d382aafbSBarry Smith - memory3 - 3rd memory to free 1248d382aafbSBarry Smith 1249d382aafbSBarry Smith Level: developer 1250d382aafbSBarry Smith 1251d382aafbSBarry Smith Notes: Memory must have been obtained with PetscMalloc3() 1252d382aafbSBarry Smith 1253d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3() 1254d382aafbSBarry Smith 1255d382aafbSBarry Smith Concepts: memory allocation 1256d382aafbSBarry Smith 1257d382aafbSBarry Smith M*/ 1258b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED) 1259d382aafbSBarry Smith #define PetscFree3(m1,m2,m3) (PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) 1260d382aafbSBarry Smith #else 1261e38f91f2SMatthew G. Knepley #define PetscFree3(m1,m2,m3) ((m1) ? ((m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m3)=0,(m1)=0,PetscFree(m2)) : ((m2)=0,(m1)=0,PetscFree(m3)))) 1262d382aafbSBarry Smith #endif 1263d382aafbSBarry Smith 1264d382aafbSBarry Smith /*MC 1265d382aafbSBarry Smith PetscFree4 - Frees 4 chunks of memory obtained with PetscMalloc4() 1266d382aafbSBarry Smith 1267eca87e8dSBarry Smith Synopsis: 1268aaa7dc30SBarry Smith #include <petscsys.h> 1269eca87e8dSBarry Smith PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4) 1270eca87e8dSBarry Smith 1271eca87e8dSBarry Smith Not Collective 1272eca87e8dSBarry Smith 1273d382aafbSBarry Smith Input Parameter: 1274d382aafbSBarry Smith + m1 - memory to free 1275d382aafbSBarry Smith . m2 - 2nd memory to free 1276d382aafbSBarry Smith . m3 - 3rd memory to free 1277d382aafbSBarry Smith - m4 - 4th memory to free 1278d382aafbSBarry Smith 1279d382aafbSBarry Smith Level: developer 1280d382aafbSBarry Smith 1281d382aafbSBarry Smith Notes: Memory must have been obtained with PetscMalloc4() 1282d382aafbSBarry Smith 1283d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4() 1284d382aafbSBarry Smith 1285d382aafbSBarry Smith Concepts: memory allocation 1286d382aafbSBarry Smith 1287d382aafbSBarry Smith M*/ 1288b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED) 1289d382aafbSBarry Smith #define PetscFree4(m1,m2,m3,m4) (PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) 1290d382aafbSBarry Smith #else 1291e38f91f2SMatthew G. Knepley #define PetscFree4(m1,m2,m3,m4) ((m1) ? ((m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m4)=0,(m3)=0,(m1)=0,PetscFree(m2)) : ((m3) ? ((m4)=0,(m2)=0,(m1)=0,PetscFree(m3)) : ((m3)=0,(m2)=0,(m1)=0,PetscFree(m4))))) 1292d382aafbSBarry Smith #endif 1293d382aafbSBarry Smith 1294d382aafbSBarry Smith /*MC 1295d382aafbSBarry Smith PetscFree5 - Frees 5 chunks of memory obtained with PetscMalloc5() 1296d382aafbSBarry Smith 1297eca87e8dSBarry Smith Synopsis: 1298aaa7dc30SBarry Smith #include <petscsys.h> 1299eca87e8dSBarry Smith PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5) 1300eca87e8dSBarry Smith 1301eca87e8dSBarry Smith Not Collective 1302eca87e8dSBarry Smith 1303d382aafbSBarry Smith Input Parameter: 1304d382aafbSBarry Smith + m1 - memory to free 1305d382aafbSBarry Smith . m2 - 2nd memory to free 1306d382aafbSBarry Smith . m3 - 3rd memory to free 1307d382aafbSBarry Smith . m4 - 4th memory to free 1308d382aafbSBarry Smith - m5 - 5th memory to free 1309d382aafbSBarry Smith 1310d382aafbSBarry Smith Level: developer 1311d382aafbSBarry Smith 1312d382aafbSBarry Smith Notes: Memory must have been obtained with PetscMalloc5() 1313d382aafbSBarry Smith 1314d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5() 1315d382aafbSBarry Smith 1316d382aafbSBarry Smith Concepts: memory allocation 1317d382aafbSBarry Smith 1318d382aafbSBarry Smith M*/ 1319b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED) 1320d382aafbSBarry Smith #define PetscFree5(m1,m2,m3,m4,m5) (PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) 1321d382aafbSBarry Smith #else 1322e38f91f2SMatthew G. Knepley #define PetscFree5(m1,m2,m3,m4,m5) ((m1) ? ((m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m5)=0,(m4)=0,(m3)=0,(m1)=0,PetscFree(m2)) : ((m3) ? ((m5)=0,(m4)=0,(m2)=0,(m1)=0,PetscFree(m3)) : \ 1323e38f91f2SMatthew G. Knepley ((m4) ? ((m5)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m4)) : ((m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m5)))))) 1324d382aafbSBarry Smith #endif 1325d382aafbSBarry Smith 1326d382aafbSBarry Smith 1327d382aafbSBarry Smith /*MC 1328d382aafbSBarry Smith PetscFree6 - Frees 6 chunks of memory obtained with PetscMalloc6() 1329d382aafbSBarry Smith 1330eca87e8dSBarry Smith Synopsis: 1331aaa7dc30SBarry Smith #include <petscsys.h> 1332eca87e8dSBarry Smith PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6) 1333eca87e8dSBarry Smith 1334eca87e8dSBarry Smith Not Collective 1335eca87e8dSBarry Smith 1336d382aafbSBarry Smith Input Parameter: 1337d382aafbSBarry Smith + m1 - memory to free 1338d382aafbSBarry Smith . m2 - 2nd memory to free 1339d382aafbSBarry Smith . m3 - 3rd memory to free 1340d382aafbSBarry Smith . m4 - 4th memory to free 1341d382aafbSBarry Smith . m5 - 5th memory to free 1342d382aafbSBarry Smith - m6 - 6th memory to free 1343d382aafbSBarry Smith 1344d382aafbSBarry Smith 1345d382aafbSBarry Smith Level: developer 1346d382aafbSBarry Smith 1347d382aafbSBarry Smith Notes: Memory must have been obtained with PetscMalloc6() 1348d382aafbSBarry Smith 1349d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6() 1350d382aafbSBarry Smith 1351d382aafbSBarry Smith Concepts: memory allocation 1352d382aafbSBarry Smith 1353d382aafbSBarry Smith M*/ 1354b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED) 1355d382aafbSBarry Smith #define PetscFree6(m1,m2,m3,m4,m5,m6) (PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) 1356d382aafbSBarry Smith #else 1357e38f91f2SMatthew G. Knepley #define PetscFree6(m1,m2,m3,m4,m5,m6) ((m1) ? ((m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m6)=0,(m5)=0,(m4)=0,(m3)=0,(m1)=0,PetscFree(m2)) : \ 1358e38f91f2SMatthew G. Knepley ((m3) ? ((m6)=0,(m5)=0,(m4)=0,(m2)=0,(m1)=0,PetscFree(m3)) : ((m4) ? ((m6)=0,(m5)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m4)) : \ 1359e38f91f2SMatthew G. Knepley ((m5) ? ((m6)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m5)) : ((m5)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m6))))))) 1360d382aafbSBarry Smith #endif 1361d382aafbSBarry Smith 1362d382aafbSBarry Smith /*MC 1363d382aafbSBarry Smith PetscFree7 - Frees 7 chunks of memory obtained with PetscMalloc7() 1364d382aafbSBarry Smith 1365eca87e8dSBarry Smith Synopsis: 1366aaa7dc30SBarry Smith #include <petscsys.h> 1367eca87e8dSBarry Smith PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7) 1368eca87e8dSBarry Smith 1369eca87e8dSBarry Smith Not Collective 1370eca87e8dSBarry Smith 1371d382aafbSBarry Smith Input Parameter: 1372d382aafbSBarry Smith + m1 - memory to free 1373d382aafbSBarry Smith . m2 - 2nd memory to free 1374d382aafbSBarry Smith . m3 - 3rd memory to free 1375d382aafbSBarry Smith . m4 - 4th memory to free 1376d382aafbSBarry Smith . m5 - 5th memory to free 1377d382aafbSBarry Smith . m6 - 6th memory to free 1378d382aafbSBarry Smith - m7 - 7th memory to free 1379d382aafbSBarry Smith 1380d382aafbSBarry Smith 1381d382aafbSBarry Smith Level: developer 1382d382aafbSBarry Smith 1383d382aafbSBarry Smith Notes: Memory must have been obtained with PetscMalloc7() 1384d382aafbSBarry Smith 1385d382aafbSBarry Smith .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(), 1386d382aafbSBarry Smith PetscMalloc7() 1387d382aafbSBarry Smith 1388d382aafbSBarry Smith Concepts: memory allocation 1389d382aafbSBarry Smith 1390d382aafbSBarry Smith M*/ 1391b4cc1d85SMatthew G. Knepley #if !defined(PETSC_USE_MALLOC_COALESCED) 1392d382aafbSBarry Smith #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) (PetscFree(m7) || PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) 1393d382aafbSBarry Smith #else 1394e38f91f2SMatthew G. Knepley #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) ((m1) ? ((m7)=0,(m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) : ((m2) ? ((m7)=0,(m6)=0,(m5)=0,(m4)=0,(m3)=0,(m1)=0,PetscFree(m2)) : \ 1395e38f91f2SMatthew G. Knepley ((m3) ? ((m7)=0,(m6)=0,(m5)=0,(m4)=0,(m2)=0,(m1)=0,PetscFree(m3)) : ((m4) ? ((m7)=0,(m6)=0,(m5)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m4)) : \ 139606c0a5e5SMatthew G. Knepley ((m5) ? ((m7)=0,(m6)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m5)) : ((m6) ? ((m7)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m6)) : \ 1397e38f91f2SMatthew G. Knepley ((m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,(m1)=0,PetscFree(m7)))))))) 1398d382aafbSBarry Smith #endif 1399d382aafbSBarry Smith 1400efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t,int,const char[],const char[],void**); 1401efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[]); 14023221ece2SMatthew G. Knepley PETSC_EXTERN PetscErrorCode (*PetscTrRealloc)(size_t,int,const char[],const char[],void**); 1403efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t,int,const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[])); 1404014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocClear(void); 1405d382aafbSBarry Smith 1406d382aafbSBarry Smith /* 1407c1706be6SHong 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. 1408c1706be6SHong Zhang */ 1409c1706be6SHong Zhang PETSC_EXTERN PetscErrorCode PetscMallocSetDRAM(void); 1410c1706be6SHong Zhang PETSC_EXTERN PetscErrorCode PetscMallocResetDRAM(void); 1411c1706be6SHong Zhang 1412c1706be6SHong Zhang /* 1413a5057860SBarry Smith PetscLogDouble variables are used to contain double precision numbers 1414a5057860SBarry Smith that are not used in the numerical computations, but rather in logging, 1415a5057860SBarry Smith timing etc. 1416a5057860SBarry Smith */ 1417a5057860SBarry Smith typedef double PetscLogDouble; 1418a5057860SBarry Smith #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE 1419a5057860SBarry Smith 1420a5057860SBarry Smith /* 142166d669d6SBarry Smith Routines for tracing memory corruption/bleeding with default PETSc memory allocation 1422d382aafbSBarry Smith */ 1423014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *); 1424014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocDumpLog(FILE *); 1425014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *); 1426014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *); 1427014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocDebug(PetscBool); 14280acecf5bSBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool*); 1429efca3c55SSatish Balay PETSC_EXTERN PetscErrorCode PetscMallocValidate(int,const char[],const char[]); 1430014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLog(void); 1431574034a9SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLogThreshold(PetscLogDouble); 1432014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMallocGetDumpLog(PetscBool*); 1433d382aafbSBarry Smith 1434d382aafbSBarry Smith /*E 1435d382aafbSBarry Smith PetscDataType - Used for handling different basic data types. 1436d382aafbSBarry Smith 1437d382aafbSBarry Smith Level: beginner 1438d382aafbSBarry Smith 1439d382aafbSBarry Smith Developer comment: It would be nice if we could always just use MPI Datatypes, why can we not? 1440d382aafbSBarry Smith 1441d382aafbSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(), 1442d382aafbSBarry Smith PetscDataTypeGetSize() 1443d382aafbSBarry Smith 1444d382aafbSBarry Smith E*/ 1445d382aafbSBarry Smith typedef enum {PETSC_INT = 0,PETSC_DOUBLE = 1,PETSC_COMPLEX = 2, PETSC_LONG = 3 ,PETSC_SHORT = 4,PETSC_FLOAT = 5, 1446570b7f6dSBarry Smith PETSC_CHAR = 6,PETSC_BIT_LOGICAL = 7,PETSC_ENUM = 8,PETSC_BOOL=9, PETSC___FLOAT128 = 10,PETSC_OBJECT = 11, PETSC_FUNCTION = 12, PETSC_STRING = 13, PETSC___FP16 = 14,PETSC_STRUCT, PETSC_DATATYPE_UNKNOWN} PetscDataType; 14476a6fc655SJed Brown PETSC_EXTERN const char *const PetscDataTypes[]; 1448d382aafbSBarry Smith 1449d382aafbSBarry Smith #if defined(PETSC_USE_COMPLEX) 1450d382aafbSBarry Smith #define PETSC_SCALAR PETSC_COMPLEX 1451d382aafbSBarry Smith #else 1452ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 1453d382aafbSBarry Smith #define PETSC_SCALAR PETSC_FLOAT 145459a34000SBarry Smith #elif defined(PETSC_USE_REAL___FLOAT128) 145559a34000SBarry Smith #define PETSC_SCALAR PETSC___FLOAT128 1456570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16) 1457570b7f6dSBarry Smith #define PETSC_SCALAR PETSC___FP16 1458d382aafbSBarry Smith #else 1459d382aafbSBarry Smith #define PETSC_SCALAR PETSC_DOUBLE 1460d382aafbSBarry Smith #endif 1461d382aafbSBarry Smith #endif 1462ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 1463d382aafbSBarry Smith #define PETSC_REAL PETSC_FLOAT 146459a34000SBarry Smith #elif defined(PETSC_USE_REAL___FLOAT128) 146559a34000SBarry Smith #define PETSC_REAL PETSC___FLOAT128 1466570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16) 1467570b7f6dSBarry Smith #define PETSC_REAL PETSC___FP16 1468d382aafbSBarry Smith #else 1469d382aafbSBarry Smith #define PETSC_REAL PETSC_DOUBLE 1470d382aafbSBarry Smith #endif 1471d382aafbSBarry Smith #define PETSC_FORTRANADDR PETSC_LONG 1472d382aafbSBarry Smith 1473014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*); 1474014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*); 1475014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*); 14768e4b2d1dSBarry Smith PETSC_EXTERN PetscErrorCode PetscDataTypeFromString(const char*,PetscDataType*,PetscBool*); 1477d382aafbSBarry Smith 1478d382aafbSBarry Smith /* 1479d382aafbSBarry Smith Basic memory and string operations. These are usually simple wrappers 1480d382aafbSBarry Smith around the basic Unix system calls, but a few of them have additional 1481d382aafbSBarry Smith functionality and/or error checking. 1482d382aafbSBarry Smith */ 1483014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType); 1484014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemmove(void*,void *,size_t); 1485014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemcmp(const void*,const void*,size_t,PetscBool *); 1486014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrlen(const char[],size_t*); 1487d67fe73bSBarry Smith PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[],char,int*,char ***); 1488014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int,char **); 1489014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[],const char[],PetscBool *); 1490014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[],const char[],PetscBool *); 1491014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[],const char[],PetscBool *); 1492014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[],const char[],size_t,PetscBool *); 1493014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcpy(char[],const char[]); 1494014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrcat(char[],const char[]); 1495014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrncat(char[],const char[],size_t); 1496014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrncpy(char[],const char[],size_t); 1497014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrchr(const char[],char,char *[]); 1498014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]); 14992f234a98SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrtoupper(char[]); 1500014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[],char,char *[]); 1501014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrstr(const char[],const char[],char *[]); 1502014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[],const char[],char *[]); 1503014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[],const char[],PetscBool*); 15042c9581d2SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[],const char[],PetscBool*); 1505014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[],const char *const*,PetscInt*); 1506014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[],char *[]); 150747340559SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const*,char***); 15086fed8037SJed Brown PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char***); 15096991f827SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrNArrayallocpy(PetscInt,const char *const*,char***); 15106991f827SBarry Smith PETSC_EXTERN PetscErrorCode PetscStrNArrayDestroy(PetscInt,char***); 1511014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm,const char[],char[],size_t); 1512d382aafbSBarry Smith 1513573b0fb4SBarry Smith PETSC_EXTERN void PetscStrcmpNoError(const char[],const char[],PetscBool *); 1514573b0fb4SBarry Smith 1515d382aafbSBarry Smith /*S 1516d382aafbSBarry Smith PetscToken - 'Token' used for managing tokenizing strings 1517d382aafbSBarry Smith 1518d382aafbSBarry Smith Level: intermediate 1519d382aafbSBarry Smith 1520d382aafbSBarry Smith .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy() 1521d382aafbSBarry Smith S*/ 1522d382aafbSBarry Smith typedef struct _p_PetscToken* PetscToken; 1523d382aafbSBarry Smith 1524014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*); 1525014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]); 1526014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*); 1527d382aafbSBarry Smith 1528a53986e1SJed Brown PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt,const char *const*,const char*,PetscInt*,PetscBool*); 1529a53986e1SJed Brown PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const*,const char*,PetscEnum*,PetscBool*); 1530a53986e1SJed Brown 1531d382aafbSBarry Smith /* 1532d382aafbSBarry Smith These are MPI operations for MPI_Allreduce() etc 1533d382aafbSBarry Smith */ 1534367daffbSBarry Smith PETSC_EXTERN MPI_Op MPIU_MAXSUM_OP; 1535570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 1536014dd563SJed Brown PETSC_EXTERN MPI_Op MPIU_SUM; 15372414b3c7SJed Brown #else 15382414b3c7SJed Brown #define MPIU_SUM MPI_SUM 15392414b3c7SJed Brown #endif 1540570b7f6dSBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 1541014dd563SJed Brown PETSC_EXTERN MPI_Op MPIU_MAX; 1542014dd563SJed Brown PETSC_EXTERN MPI_Op MPIU_MIN; 1543d9822059SBarry Smith #else 1544d9822059SBarry Smith #define MPIU_MAX MPI_MAX 1545d9822059SBarry Smith #define MPIU_MIN MPI_MIN 1546d9822059SBarry Smith #endif 1547014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*); 1548d382aafbSBarry Smith 1549014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm); 1550014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm); 1551eb3f98d2SBarry Smith 1552d382aafbSBarry Smith /*S 1553d382aafbSBarry Smith PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc 1554d382aafbSBarry Smith 1555d382aafbSBarry Smith Level: beginner 1556d382aafbSBarry Smith 15572981ebdbSBarry Smith Note: This is the base class from which all PETSc objects are derived from. 1558d382aafbSBarry Smith 15592b26979fSBarry Smith .seealso: PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName(), PetscObjectReference(), PetscObjectDereference() 1560d382aafbSBarry Smith S*/ 1561d382aafbSBarry Smith typedef struct _p_PetscObject* PetscObject; 1562d382aafbSBarry Smith 1563270bf2e7SJed Brown /*MC 1564127c8a3bSJed Brown PetscObjectId - unique integer Id for a PetscObject 1565127c8a3bSJed Brown 1566127c8a3bSJed Brown Level: developer 1567127c8a3bSJed Brown 1568127c8a3bSJed Brown Notes: Unlike pointer values, object ids are never reused. 1569127c8a3bSJed Brown 1570127c8a3bSJed Brown .seealso: PetscObjectState, PetscObjectGetId() 1571127c8a3bSJed Brown M*/ 157206e41213SSatish Balay #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */ 157306e41213SSatish Balay typedef int PetscObjectId; 157406e41213SSatish Balay #else 1575bafee8b4SSatish Balay typedef PetscInt64 PetscObjectId; 157606e41213SSatish Balay #endif 1577127c8a3bSJed Brown 1578127c8a3bSJed Brown /*MC 1579270bf2e7SJed Brown PetscObjectState - integer state for a PetscObject 1580270bf2e7SJed Brown 1581270bf2e7SJed Brown Level: developer 1582270bf2e7SJed Brown 1583270bf2e7SJed Brown Notes: 1584270bf2e7SJed Brown Object state is always-increasing and (for objects that track state) can be used to determine if an object has 1585270bf2e7SJed Brown changed since the last time you interacted with it. It is 64-bit so that it will not overflow for a very long time. 1586270bf2e7SJed Brown 15878dcff661SJed Brown .seealso: PetscObjectId, PetscObjectStateGet(), PetscObjectStateIncrease(), PetscObjectStateSet() 1588270bf2e7SJed Brown M*/ 158906e41213SSatish Balay #if defined(PETSC_USING_F90) && !defined(PETSC_USE_FORTRANKIND) /* compaq F90 */ 159006e41213SSatish Balay typedef int PetscObjectState; 159106e41213SSatish Balay #else 1592bafee8b4SSatish Balay typedef PetscInt64 PetscObjectState; 159306e41213SSatish Balay #endif 1594270bf2e7SJed Brown 1595d382aafbSBarry Smith /*S 1596140e18c1SBarry Smith PetscFunctionList - Linked list of functions, possibly stored in dynamic libraries, accessed 1597d382aafbSBarry Smith by string name 1598d382aafbSBarry Smith 1599d382aafbSBarry Smith Level: advanced 1600d382aafbSBarry Smith 1601140e18c1SBarry Smith .seealso: PetscFunctionListAdd(), PetscFunctionListDestroy(), PetscOpFlist 1602d382aafbSBarry Smith S*/ 1603140e18c1SBarry Smith typedef struct _n_PetscFunctionList *PetscFunctionList; 1604d382aafbSBarry Smith 1605d382aafbSBarry Smith /*E 1606d382aafbSBarry Smith PetscFileMode - Access mode for a file. 1607d382aafbSBarry Smith 1608d382aafbSBarry Smith Level: beginner 1609d382aafbSBarry Smith 16101cc8b206SBarry Smith $ FILE_MODE_READ - open a file at its beginning for reading 16111cc8b206SBarry Smith $ FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist) 16121cc8b206SBarry Smith $ FILE_MODE_APPEND - open a file at end for writing 16131cc8b206SBarry Smith $ FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing 16141cc8b206SBarry Smith $ FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end 1615d382aafbSBarry Smith 1616d382aafbSBarry Smith .seealso: PetscViewerFileSetMode() 1617d382aafbSBarry Smith E*/ 1618d382aafbSBarry Smith typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode; 1619d6a4318aSJed Brown extern const char *const PetscFileModes[]; 1620d6a4318aSJed Brown 1621639ff905SBarry Smith /* 1622639ff905SBarry Smith Defines PETSc error handling. 1623639ff905SBarry Smith */ 1624639ff905SBarry Smith #include <petscerror.h> 1625d382aafbSBarry Smith 16260700a824SBarry Smith #define PETSC_SMALLEST_CLASSID 1211211 1627014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID; 1628014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID; 1629014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *); 1630d382aafbSBarry Smith 1631d382aafbSBarry Smith /* 1632d382aafbSBarry Smith Routines that get memory usage information from the OS 1633d382aafbSBarry Smith */ 1634014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *); 1635014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *); 1636014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void); 1637b44d5720SBarry Smith PETSC_EXTERN PetscErrorCode PetscMemoryTrace(const char[]); 1638d382aafbSBarry Smith 1639014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInfoAllow(PetscBool ,const char []); 1640014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal); 1641d382aafbSBarry Smith 1642d382aafbSBarry Smith /* 1643d382aafbSBarry Smith Initialization of PETSc 1644d382aafbSBarry Smith */ 1645014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]); 1646014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]); 1647014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void); 1648014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *); 1649014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *); 1650014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFinalize(void); 1651014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void); 1652014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***); 1653014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***); 1654014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **); 1655d382aafbSBarry Smith 1656014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscEnd(void); 1657607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void); 1658d382aafbSBarry Smith 1659014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]); 1660014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void); 1661014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void); 1662014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]); 1663d382aafbSBarry Smith 1664d382aafbSBarry Smith /* 1665d382aafbSBarry Smith These are so that in extern C code we can caste function pointers to non-extern C 16662981ebdbSBarry Smith function pointers. Since the regular C++ code expects its function pointers to be C++ 1667d382aafbSBarry Smith */ 1668638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void); 1669638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void); 1670638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void); 1671d382aafbSBarry Smith 1672d382aafbSBarry Smith /* 1673d382aafbSBarry Smith Functions that can act on any PETSc object. 1674d382aafbSBarry Smith */ 1675014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject*); 1676014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject,MPI_Comm *); 1677014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject,PetscClassId *); 1678014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject,const char *[]); 1679014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetType(PetscObject,const char []); 1680014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject,const char *[]); 1681014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject,const char[]); 1682014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject,const char*[]); 1683014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject,PetscInt); 1684014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject,PetscInt*); 1685014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt); 1686014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject); 1687014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject,PetscInt*); 1688014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject); 1689014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject,PetscMPIInt *); 1690014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject,const char[],PetscObject); 1691014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject,const char[]); 1692014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject,const char[],PetscObject *); 1693bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject,const char[],void (*)(void)); 1694bdf89e91SBarry Smith #define PetscObjectComposeFunction(a,b,d) PetscObjectComposeFunction_Private(a,b,(PetscVoidFunction)(d)) 1695014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject); 1696014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject); 16970eb63584SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSetPrintedOptions(PetscObject); 16980eb63584SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectInheritPrintedOptions(PetscObject,PetscObject); 1699014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm,PetscMPIInt *); 1700d382aafbSBarry Smith 1701665c2dedSJed Brown #include <petscviewertypes.h> 1702639ff905SBarry Smith #include <petscoptions.h> 1703639ff905SBarry Smith 17040633abcbSJed Brown PETSC_EXTERN PetscErrorCode PetscObjectsListGetGlobalNumbering(MPI_Comm,PetscInt,PetscObject*,PetscInt*,PetscInt*); 17050633abcbSJed Brown 1706639ff905SBarry Smith PETSC_EXTERN PetscErrorCode PetscMemoryShowUsage(PetscViewer,const char[]); 1707c5e4d11fSDmitry Karpeev PETSC_EXTERN PetscErrorCode PetscMemoryView(PetscViewer,const char[]); 1708dae58748SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject,PetscViewer); 1709639ff905SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject,PetscViewer); 17100005d66cSJed Brown #define PetscObjectQueryFunction(obj,name,fptr) PetscObjectQueryFunction_Private((obj),(name),(PetscVoidFunction*)(fptr)) 17110005d66cSJed Brown PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject,const char[],void (**)(void)); 1712014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject,const char[]); 1713014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject,const char[]); 1714014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject,const char[]); 1715014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject,const char*[]); 1716014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject,const char[]); 1717014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject); 1718014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void); 1719685405a1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectViewFromOptions(PetscObject,PetscObject,const char[]); 1720014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject); 1721014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject,const char[],PetscBool *); 1722014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject,PetscBool*,const char[],...); 1723014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void)); 1724014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void); 1725d382aafbSBarry Smith 1726e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 17277aab2a10SBarry Smith PETSC_EXTERN PetscErrorCode PetscSAWsBlock(void); 1728e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsViewOff(PetscObject); 1729e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsSetBlock(PetscObject,PetscBool); 1730e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsBlock(PetscObject); 1731e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsGrantAccess(PetscObject); 1732e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectSAWsTakeAccess(PetscObject); 1733e04113cfSBarry Smith PETSC_EXTERN void PetscStackSAWsGrantAccess(void); 1734e04113cfSBarry Smith PETSC_EXTERN void PetscStackSAWsTakeAccess(void); 1735e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscStackViewSAWs(void); 1736e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscStackSAWsViewOff(void); 173715681b3cSBarry Smith 1738ec7429eaSBarry Smith #else 17397aab2a10SBarry Smith #define PetscSAWsBlock() 0 1740e04113cfSBarry Smith #define PetscObjectSAWsViewOff(obj) 0 1741e04113cfSBarry Smith #define PetscObjectSAWsSetBlock(obj,flg) 0 1742e04113cfSBarry Smith #define PetscObjectSAWsBlock(obj) 0 1743e04113cfSBarry Smith #define PetscObjectSAWsGrantAccess(obj) 0 1744e04113cfSBarry Smith #define PetscObjectSAWsTakeAccess(obj) 0 1745e04113cfSBarry Smith #define PetscStackViewSAWs() 0 1746e04113cfSBarry Smith #define PetscStackSAWsViewOff() 0 1747e04113cfSBarry Smith #define PetscStackSAWsTakeAccess() 1748e04113cfSBarry Smith #define PetscStackSAWsGrantAccess() 174915681b3cSBarry Smith 1750ec7429eaSBarry Smith #endif 1751b90c6cbeSBarry Smith 17527d5d4d99SBarry Smith typedef void* PetscDLHandle; 1753e4d177b5SBarry Smith typedef enum {PETSC_DL_DECIDE=0,PETSC_DL_NOW=1,PETSC_DL_LOCAL=2} PetscDLMode; 175482b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *); 175582b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *); 175682b97d80SJed Brown PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **); 17577d5d4d99SBarry Smith 17585fe58b6fSBarry Smith #if defined(PETSC_USE_DEBUG) 1759a64a8e02SBarry Smith PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**); 17605fe58b6fSBarry Smith #endif 17617eb1d149SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool); 1762a64a8e02SBarry Smith 1763d382aafbSBarry Smith /*S 1764140e18c1SBarry Smith PetscObjectList - Linked list of PETSc objects, each accessable by string name 1765d382aafbSBarry Smith 17661d0fab5eSBarry Smith Level: developer 1767d382aafbSBarry Smith 17681d0fab5eSBarry Smith Notes: Used by PetscObjectCompose() and PetscObjectQuery() 17691d0fab5eSBarry Smith 1770140e18c1SBarry Smith .seealso: PetscObjectListAdd(), PetscObjectListDestroy(), PetscObjectListFind(), PetscObjectCompose(), PetscObjectQuery(), PetscFunctionList 1771d382aafbSBarry Smith S*/ 1772140e18c1SBarry Smith typedef struct _n_PetscObjectList *PetscObjectList; 1773d382aafbSBarry Smith 1774140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList*); 1775140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList,const char[],PetscObject*); 1776140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList,PetscObject,char**,PetscBool*); 1777140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *,const char[],PetscObject); 1778140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *,const char[]); 1779140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList,PetscObjectList *); 1780d382aafbSBarry Smith 1781d382aafbSBarry Smith /* 1782503cfb0cSBarry Smith Dynamic library lists. Lists of names of routines in objects or in dynamic 1783d382aafbSBarry Smith link libraries that will be loaded as needed. 1784d382aafbSBarry Smith */ 1785a240a19fSJed Brown 1786a240a19fSJed Brown #define PetscFunctionListAdd(list,name,fptr) PetscFunctionListAdd_Private((list),(name),(PetscVoidFunction)(fptr)) 1787a240a19fSJed Brown PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList*,const char[],void (*)(void)); 1788140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList*); 17891c9cd337SJed Brown #define PetscFunctionListFind(list,name,fptr) PetscFunctionListFind_Private((list),(name),(PetscVoidFunction*)(fptr)) 17901c9cd337SJed Brown PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList,const char[],void (**)(void)); 1791140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFunctionList,const char[]); 1792140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList,PetscFunctionList *); 1793140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList,PetscViewer); 1794140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList,const char ***,int*); 1795d382aafbSBarry Smith 1796d382aafbSBarry Smith /*S 1797d382aafbSBarry Smith PetscDLLibrary - Linked list of dynamics libraries to search for functions 1798d382aafbSBarry Smith 1799d382aafbSBarry Smith Level: advanced 1800d382aafbSBarry Smith 1801d382aafbSBarry Smith .seealso: PetscDLLibraryOpen() 1802d382aafbSBarry Smith S*/ 1803d382aafbSBarry Smith typedef struct _n_PetscDLLibrary *PetscDLLibrary; 1804014dd563SJed Brown PETSC_EXTERN PetscDLLibrary PetscDLLibrariesLoaded; 1805014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]); 1806014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]); 1807014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **); 1808014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary); 1809014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool *); 1810014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *); 1811014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary); 1812d382aafbSBarry Smith 1813d382aafbSBarry Smith /* 1814d382aafbSBarry Smith Useful utility routines 1815d382aafbSBarry Smith */ 1816014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*); 1817014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*); 1818014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt); 1819014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt); 1820014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject); 1821014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*); 1822d382aafbSBarry Smith 1823503cfb0cSBarry Smith /* 1824ace3abfcSBarry Smith PetscNot - negates a logical type value and returns result as a PetscBool 1825503cfb0cSBarry Smith 1826503cfb0cSBarry Smith Notes: This is useful in cases like 1827503cfb0cSBarry Smith $ int *a; 1828ace3abfcSBarry Smith $ PetscBool flag = PetscNot(a) 18291cc8b206SBarry Smith where !a would not return a PetscBool because we cannot provide a cast from int to PetscBool in C. 1830503cfb0cSBarry Smith */ 1831d382aafbSBarry Smith #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE) 1832503cfb0cSBarry Smith 1833d382aafbSBarry Smith /*MC 1834d382aafbSBarry Smith PetscHelpPrintf - Prints help messages. 1835d382aafbSBarry Smith 1836d382aafbSBarry Smith Synopsis: 1837aaa7dc30SBarry Smith #include <petscsys.h> 1838d382aafbSBarry Smith PetscErrorCode (*PetscHelpPrintf)(const char format[],...); 1839d382aafbSBarry Smith 1840eca87e8dSBarry Smith Not Collective 1841eca87e8dSBarry Smith 1842d382aafbSBarry Smith Input Parameters: 1843d382aafbSBarry Smith . format - the usual printf() format string 1844d382aafbSBarry Smith 1845d382aafbSBarry Smith Level: developer 1846d382aafbSBarry Smith 1847d382aafbSBarry Smith Fortran Note: 1848d382aafbSBarry Smith This routine is not supported in Fortran. 1849d382aafbSBarry Smith 1850d382aafbSBarry Smith Concepts: help messages^printing 1851d382aafbSBarry Smith Concepts: printing^help messages 1852d382aafbSBarry Smith 1853d382aafbSBarry Smith .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf() 1854d382aafbSBarry Smith M*/ 1855014dd563SJed Brown PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...); 1856d382aafbSBarry Smith 1857fcfd50ebSBarry Smith /* 1858fcfd50ebSBarry Smith Defines PETSc profiling. 1859fcfd50ebSBarry Smith */ 18602c8e378dSBarry Smith #include <petsclog.h> 1861fcfd50ebSBarry Smith 1862fcfd50ebSBarry Smith /* 1863fcfd50ebSBarry Smith Simple PETSc parallel IO for ASCII printing 1864fcfd50ebSBarry Smith */ 1865014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]); 1866014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**); 1867014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*); 1868014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...); 1869014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...); 1870014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...); 1871014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...); 1872fcfd50ebSBarry Smith 1873014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...); 1874014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...); 1875014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...); 1876d382aafbSBarry Smith 1877d382aafbSBarry Smith #if defined(PETSC_HAVE_POPEN) 1878014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **); 187996a8e8cbSBarry Smith PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm,FILE*,int*); 188074ba8654SBarry Smith PETSC_EXTERN PetscErrorCode PetscPOpenSetMachine(const char[]); 1881d382aafbSBarry Smith #endif 1882d382aafbSBarry Smith 1883014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm,const char[],...); 1884014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...); 18850ec8b6e3SBarry Smith PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm,FILE*); 1886014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]); 1887014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**); 1888014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm,const char[],const char[],FILE**); 1889014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char*[]); 1890d382aafbSBarry Smith 1891014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPopUpSelect(MPI_Comm,const char*,const char*,int,const char**,int*); 1892d382aafbSBarry Smith 1893d382aafbSBarry Smith /*S 1894d382aafbSBarry Smith PetscContainer - Simple PETSc object that contains a pointer to any required data 1895d382aafbSBarry Smith 1896d382aafbSBarry Smith Level: advanced 1897d382aafbSBarry Smith 1898d382aafbSBarry Smith .seealso: PetscObject, PetscContainerCreate() 1899d382aafbSBarry Smith S*/ 1900014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID; 1901d382aafbSBarry Smith typedef struct _p_PetscContainer* PetscContainer; 1902014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer,void **); 1903014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer,void *); 1904014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer*); 1905014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm,PetscContainer *); 1906014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void*)); 1907d382aafbSBarry Smith 1908d382aafbSBarry Smith /* 1909d382aafbSBarry Smith For use in debuggers 1910d382aafbSBarry Smith */ 1911014dd563SJed Brown PETSC_EXTERN PetscMPIInt PetscGlobalRank; 1912014dd563SJed Brown PETSC_EXTERN PetscMPIInt PetscGlobalSize; 1913014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt,const PetscInt[],PetscViewer); 1914014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt,const PetscReal[],PetscViewer); 1915014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt,const PetscScalar[],PetscViewer); 1916d382aafbSBarry Smith 1917a663daf8SBarry Smith #include <stddef.h> 1918a3aaec0aSJed Brown #include <string.h> /* for memcpy, memset */ 1919d382aafbSBarry Smith #if defined(PETSC_HAVE_STDLIB_H) 1920d382aafbSBarry Smith #include <stdlib.h> 1921d382aafbSBarry Smith #endif 19226c7e564aSBarry Smith 19234a92a979SJed Brown #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__) 1924d382aafbSBarry Smith #include <xmmintrin.h> 1925d382aafbSBarry Smith #endif 1926d382aafbSBarry Smith 1927d382aafbSBarry Smith /*@C 1928d382aafbSBarry Smith PetscMemcpy - Copies n bytes, beginning at location b, to the space 1929d382aafbSBarry Smith beginning at location a. The two memory regions CANNOT overlap, use 1930d382aafbSBarry Smith PetscMemmove() in that case. 1931d382aafbSBarry Smith 1932d382aafbSBarry Smith Not Collective 1933d382aafbSBarry Smith 1934d382aafbSBarry Smith Input Parameters: 1935d382aafbSBarry Smith + b - pointer to initial memory space 1936d382aafbSBarry Smith - n - length (in bytes) of space to copy 1937d382aafbSBarry Smith 1938d382aafbSBarry Smith Output Parameter: 1939d382aafbSBarry Smith . a - pointer to copy space 1940d382aafbSBarry Smith 1941d382aafbSBarry Smith Level: intermediate 1942d382aafbSBarry Smith 1943d382aafbSBarry Smith Compile Option: 1944d382aafbSBarry Smith PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used 1945d382aafbSBarry Smith for memory copies on double precision values. 1946d382aafbSBarry Smith PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used 1947d382aafbSBarry Smith for memory copies on double precision values. 1948d382aafbSBarry Smith PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used 1949d382aafbSBarry Smith for memory copies on double precision values. 1950d382aafbSBarry Smith 1951d382aafbSBarry Smith Note: 1952d382aafbSBarry Smith This routine is analogous to memcpy(). 1953d382aafbSBarry Smith 1954503cfb0cSBarry Smith Developer Note: this is inlined for fastest performance 1955503cfb0cSBarry Smith 1956d382aafbSBarry Smith Concepts: memory^copying 1957d382aafbSBarry Smith Concepts: copying^memory 1958d382aafbSBarry Smith 1959d382aafbSBarry Smith .seealso: PetscMemmove() 1960d382aafbSBarry Smith 1961d382aafbSBarry Smith @*/ 19627087cfbeSBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscMemcpy(void *a,const void *b,size_t n) 1963d382aafbSBarry Smith { 1964d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG) 1965c5e4d11fSDmitry Karpeev size_t al = (size_t) a,bl = (size_t) b; 1966c5e4d11fSDmitry Karpeev size_t nl = (size_t) n; 1967a7e36092SMatthew G Knepley PetscFunctionBegin; 1968e32f2f54SBarry Smith if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer"); 1969e32f2f54SBarry Smith if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer"); 1970a7e36092SMatthew G Knepley #else 1971d382aafbSBarry Smith PetscFunctionBegin; 1972a7e36092SMatthew G Knepley #endif 1973a47a537aSLisandro Dalcin if (a != b && n > 0) { 1974d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG) 1975e47d2de2SBarry 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\ 1976d382aafbSBarry Smith or make sure your copy regions and lengths are correct. \n\ 1977d382aafbSBarry Smith Length (bytes) %ld first address %ld second address %ld",nl,al,bl); 1978d382aafbSBarry Smith #endif 1979d382aafbSBarry Smith #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY)) 1980c5e4d11fSDmitry Karpeev if (!(a % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 1981d382aafbSBarry Smith size_t len = n/sizeof(PetscScalar); 1982d382aafbSBarry Smith #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) 1983c5df96a5SBarry Smith PetscBLASInt one = 1,blen; 1984c5df96a5SBarry Smith PetscErrorCode ierr; 1985c5df96a5SBarry Smith ierr = PetscBLASIntCast(len,&blen);CHKERRQ(ierr); 19868b83055fSJed Brown PetscStackCallBLAS("BLAScopy",BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one)); 1987d382aafbSBarry Smith #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY) 1988d382aafbSBarry Smith fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a); 1989d382aafbSBarry Smith #else 1990d382aafbSBarry Smith size_t i; 1991d382aafbSBarry Smith PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a; 1992d382aafbSBarry Smith for (i=0; i<len; i++) y[i] = x[i]; 1993d382aafbSBarry Smith #endif 1994d382aafbSBarry Smith } else { 1995d382aafbSBarry Smith memcpy((char*)(a),(char*)(b),n); 1996d382aafbSBarry Smith } 1997d382aafbSBarry Smith #else 1998d382aafbSBarry Smith memcpy((char*)(a),(char*)(b),n); 1999d382aafbSBarry Smith #endif 2000d382aafbSBarry Smith } 2001d382aafbSBarry Smith PetscFunctionReturn(0); 2002d382aafbSBarry Smith } 2003d382aafbSBarry Smith 2004d382aafbSBarry Smith /*@C 2005d382aafbSBarry Smith PetscMemzero - Zeros the specified memory. 2006d382aafbSBarry Smith 2007d382aafbSBarry Smith Not Collective 2008d382aafbSBarry Smith 2009d382aafbSBarry Smith Input Parameters: 2010d382aafbSBarry Smith + a - pointer to beginning memory location 2011d382aafbSBarry Smith - n - length (in bytes) of memory to initialize 2012d382aafbSBarry Smith 2013d382aafbSBarry Smith Level: intermediate 2014d382aafbSBarry Smith 2015d382aafbSBarry Smith Compile Option: 2016d382aafbSBarry Smith PETSC_PREFER_BZERO - on certain machines (the IBM RS6000) the bzero() routine happens 2017d382aafbSBarry Smith to be faster than the memset() routine. This flag causes the bzero() routine to be used. 2018d382aafbSBarry Smith 2019503cfb0cSBarry Smith Developer Note: this is inlined for fastest performance 2020503cfb0cSBarry Smith 2021d382aafbSBarry Smith Concepts: memory^zeroing 2022d382aafbSBarry Smith Concepts: zeroing^memory 2023d382aafbSBarry Smith 2024d382aafbSBarry Smith .seealso: PetscMemcpy() 2025d382aafbSBarry Smith @*/ 20267087cfbeSBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscMemzero(void *a,size_t n) 2027d382aafbSBarry Smith { 2028d382aafbSBarry Smith if (n > 0) { 2029d382aafbSBarry Smith #if defined(PETSC_USE_DEBUG) 2030e32f2f54SBarry Smith if (!a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer"); 2031d382aafbSBarry Smith #endif 2032d382aafbSBarry Smith #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) 2033d382aafbSBarry Smith if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 2034d382aafbSBarry Smith size_t i,len = n/sizeof(PetscScalar); 2035d382aafbSBarry Smith PetscScalar *x = (PetscScalar*)a; 2036d382aafbSBarry Smith for (i=0; i<len; i++) x[i] = 0.0; 2037d382aafbSBarry Smith } else { 2038d382aafbSBarry Smith #elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO) 2039d382aafbSBarry Smith if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { 2040d382aafbSBarry Smith PetscInt len = n/sizeof(PetscScalar); 2041d382aafbSBarry Smith fortranzero_(&len,(PetscScalar*)a); 2042d382aafbSBarry Smith } else { 2043d382aafbSBarry Smith #endif 2044d382aafbSBarry Smith #if defined(PETSC_PREFER_BZERO) 2045d382aafbSBarry Smith bzero((char *)a,n); 2046d382aafbSBarry Smith #else 2047d382aafbSBarry Smith memset((char*)a,0,n); 2048d382aafbSBarry Smith #endif 2049d382aafbSBarry Smith #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO) 2050d382aafbSBarry Smith } 2051d382aafbSBarry Smith #endif 2052d382aafbSBarry Smith } 2053d382aafbSBarry Smith return 0; 2054d382aafbSBarry Smith } 2055d382aafbSBarry Smith 2056d382aafbSBarry Smith /*MC 2057d382aafbSBarry Smith PetscPrefetchBlock - Prefetches a block of memory 2058d382aafbSBarry Smith 2059eca87e8dSBarry Smith Synopsis: 2060aaa7dc30SBarry Smith #include <petscsys.h> 2061eca87e8dSBarry Smith void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t) 2062eca87e8dSBarry Smith 2063d382aafbSBarry Smith Not Collective 2064d382aafbSBarry Smith 2065d382aafbSBarry Smith Input Parameters: 2066d382aafbSBarry Smith + a - pointer to first element to fetch (any type but usually PetscInt or PetscScalar) 2067d382aafbSBarry Smith . n - number of elements to fetch 2068d382aafbSBarry Smith . rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors) 206950d8bf02SJed Brown - t - temporal locality (PETSC_PREFETCH_HINT_{NTA,T0,T1,T2}), see note 2070d382aafbSBarry Smith 2071d382aafbSBarry Smith Level: developer 2072d382aafbSBarry Smith 2073d382aafbSBarry Smith Notes: 2074d382aafbSBarry Smith The last two arguments (rw and t) must be compile-time constants. 2075d382aafbSBarry Smith 207650d8bf02SJed Brown Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality. Not all architectures offer 207750d8bf02SJed Brown equivalent locality hints, but the following macros are always defined to their closest analogue. 207850d8bf02SJed 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). 207963cf1ef0SJed 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. 208063cf1ef0SJed Brown . PETSC_PREFETCH_HINT_T1 - Fetch to level 2 and higher (not L1). 208163cf1ef0SJed Brown - PETSC_PREFETCH_HINT_T2 - Fetch to high-level cache only. (On many systems, T0 and T1 are equivalent.) 2082d382aafbSBarry Smith 2083d382aafbSBarry Smith This function does nothing on architectures that do not support prefetch and never errors (even if passed an invalid 2084d382aafbSBarry Smith address). 2085d382aafbSBarry Smith 2086d382aafbSBarry Smith Concepts: memory 2087d382aafbSBarry Smith M*/ 2088d382aafbSBarry Smith #define PetscPrefetchBlock(a,n,rw,t) do { \ 2089d382aafbSBarry Smith const char *_p = (const char*)(a),*_end = (const char*)((a)+(n)); \ 2090d382aafbSBarry Smith for ( ; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p,(rw),(t)); \ 2091d382aafbSBarry Smith } while (0) 2092d382aafbSBarry Smith 2093d382aafbSBarry Smith /* 2094d382aafbSBarry Smith Determine if some of the kernel computation routines use 2095d382aafbSBarry Smith Fortran (rather than C) for the numerical calculations. On some machines 2096d382aafbSBarry Smith and compilers (like complex numbers) the Fortran version of the routines 2097d382aafbSBarry Smith is faster than the C/C++ versions. The flag --with-fortran-kernels 2098e2e64c6bSBarry Smith should be used with ./configure to turn these on. 2099d382aafbSBarry Smith */ 2100d382aafbSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS) 2101d382aafbSBarry Smith 2102d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL) 2103d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTCRL 2104d382aafbSBarry Smith #endif 2105d382aafbSBarry Smith 21065a11e1b2SBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM) 21075a11e1b2SBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTAIJPERM 2108d382aafbSBarry Smith #endif 2109d382aafbSBarry Smith 2110d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ) 2111d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ 2112d382aafbSBarry Smith #endif 2113d382aafbSBarry Smith 2114d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ) 2115d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ 2116d382aafbSBarry Smith #endif 2117d382aafbSBarry Smith 2118d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM) 2119d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_NORM 2120d382aafbSBarry Smith #endif 2121d382aafbSBarry Smith 2122d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY) 2123d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MAXPY 2124d382aafbSBarry Smith #endif 2125d382aafbSBarry Smith 2126d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ) 2127d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ 2128d382aafbSBarry Smith #endif 2129d382aafbSBarry Smith 2130d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ) 2131d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ 2132d382aafbSBarry Smith #endif 2133d382aafbSBarry Smith 2134d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ) 2135d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ 2136d382aafbSBarry Smith #endif 2137d382aafbSBarry Smith 2138d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ) 2139d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ 2140d382aafbSBarry Smith #endif 2141d382aafbSBarry Smith 2142d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT) 2143d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_MDOT 2144d382aafbSBarry Smith #endif 2145d382aafbSBarry Smith 2146d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY) 2147d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_XTIMESY 2148d382aafbSBarry Smith #endif 2149d382aafbSBarry Smith 2150d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX) 2151d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_AYPX 2152d382aafbSBarry Smith #endif 2153d382aafbSBarry Smith 2154d382aafbSBarry Smith #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY) 2155d382aafbSBarry Smith #define PETSC_USE_FORTRAN_KERNEL_WAXPY 2156d382aafbSBarry Smith #endif 2157d382aafbSBarry Smith 2158d382aafbSBarry Smith #endif 2159d382aafbSBarry Smith 2160d382aafbSBarry Smith /* 2161d382aafbSBarry Smith Macros for indicating code that should be compiled with a C interface, 2162d382aafbSBarry Smith rather than a C++ interface. Any routines that are dynamically loaded 2163d382aafbSBarry Smith (such as the PCCreate_XXX() routines) must be wrapped so that the name 2164d382aafbSBarry Smith mangler does not change the functions symbol name. This just hides the 2165d382aafbSBarry Smith ugly extern "C" {} wrappers. 2166d382aafbSBarry Smith */ 2167d382aafbSBarry Smith #if defined(__cplusplus) 2168d382aafbSBarry Smith #define EXTERN_C_BEGIN extern "C" { 2169d382aafbSBarry Smith #define EXTERN_C_END } 2170d382aafbSBarry Smith #else 2171d382aafbSBarry Smith #define EXTERN_C_BEGIN 2172d382aafbSBarry Smith #define EXTERN_C_END 2173d382aafbSBarry Smith #endif 2174d382aafbSBarry Smith 2175d382aafbSBarry Smith /* --------------------------------------------------------------------*/ 2176d382aafbSBarry Smith 2177d382aafbSBarry Smith /*MC 2178d382aafbSBarry Smith MPI_Comm - the basic object used by MPI to determine which processes are involved in a 2179d382aafbSBarry Smith communication 2180d382aafbSBarry Smith 2181d382aafbSBarry Smith Level: beginner 2182d382aafbSBarry Smith 2183d382aafbSBarry Smith Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm 2184d382aafbSBarry Smith 2185d382aafbSBarry Smith .seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF 2186d382aafbSBarry Smith M*/ 2187d382aafbSBarry Smith 2188d382aafbSBarry Smith /*MC 2189d382aafbSBarry Smith PetscScalar - PETSc type that represents either a double precision real number, a double precision 2190390e1bf2SBarry Smith complex number, a single precision real number, a __float128 real or complex or a __fp16 real - if the code is configured 2191390e1bf2SBarry Smith with --with-scalar-type=real,complex --with-precision=single,double,__float128,__fp16 2192390e1bf2SBarry Smith 2193390e1bf2SBarry Smith Notes: For MPI calls that require datatypes, use MPIU_SCALAR as the datatype for PetscScalar and MPIU_SUM, MPIU_MAX etc for operations. 2194390e1bf2SBarry Smith They will automatically work correctly regardless of the size of PetscScalar 2195d382aafbSBarry Smith 2196d382aafbSBarry Smith Level: beginner 2197d382aafbSBarry Smith 2198390e1bf2SBarry Smith .seealso: PetscReal, MPIU_SCALAR, PetscInt, MPIU_REAL, PetscComplex, MPIU_INT 2199d382aafbSBarry Smith M*/ 2200d382aafbSBarry Smith 2201d382aafbSBarry Smith /*MC 22028619c96cSJed Brown PetscComplex - PETSc type that represents a complex number with precision matching that of PetscReal. 22038619c96cSJed Brown 22048619c96cSJed Brown Synopsis: 22058619c96cSJed Brown #include <petscsys.h> 22068619c96cSJed Brown PetscComplex number = 1. + 2.*PETSC_i; 22078619c96cSJed Brown 22088619c96cSJed Brown Level: beginner 22098619c96cSJed Brown 2210390e1bf2SBarry Smith Notes: For MPI calls that require datatypes, use MPIU_COMPLEX as the datatype for PetscComplex and MPIU_SUM etc for operations. 2211390e1bf2SBarry Smith They will automatically work correctly regardless of the size of PetscComplex 2212390e1bf2SBarry Smith 2213390e1bf2SBarry Smith See PetscScalar for details on how to ./configure the size of PetscReal 2214390e1bf2SBarry Smith 22158cd53115SBarry Smith Complex numbers are automatically available if PETSc was able to find a working complex implementation 22168619c96cSJed Brown 22178619c96cSJed Brown .seealso: PetscReal, PetscComplex, MPIU_COMPLEX, PetscInt, PETSC_i 22188619c96cSJed Brown M*/ 22198619c96cSJed Brown 22208619c96cSJed Brown /*MC 2221d382aafbSBarry Smith PetscReal - PETSc type that represents a real number version of PetscScalar 2222d382aafbSBarry Smith 2223d382aafbSBarry Smith Level: beginner 2224d382aafbSBarry Smith 2225390e1bf2SBarry Smith Notes: For MPI calls that require datatypes, use MPIU_REAL as the datatype for PetscScalar and MPIU_SUM, MPIU_MAX etc for operations. 2226390e1bf2SBarry Smith They will automatically work correctly regardless of the size of PetscReal 2227390e1bf2SBarry Smith 2228390e1bf2SBarry Smith See PetscScalar for details on how to ./configure the size of PetscReal 2229390e1bf2SBarry Smith 2230390e1bf2SBarry Smith .seealso: PetscScalar, PetscComplex, MPIU_REAL, MPIU_SCALAR 2231d382aafbSBarry Smith M*/ 2232d382aafbSBarry Smith 2233d382aafbSBarry Smith /*MC 2234d382aafbSBarry Smith MPIU_SCALAR - MPI datatype corresponding to PetscScalar 2235d382aafbSBarry Smith 2236d382aafbSBarry Smith Level: beginner 2237d382aafbSBarry Smith 2238d382aafbSBarry Smith Note: In MPI calls that require an MPI datatype that matches a PetscScalar or array of PetscScalars 2239d382aafbSBarry Smith pass this value 2240d382aafbSBarry Smith 2241390e1bf2SBarry Smith .seealso: PetscReal, PetscScalar, MPIU_INT, MPIU_REAL, MPIU_COMPLEX 2242d382aafbSBarry Smith M*/ 2243d382aafbSBarry Smith 2244d382aafbSBarry Smith #if defined(PETSC_HAVE_MPIIO) 2245d382aafbSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) 2246014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); 2247014dd563SJed Brown PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); 2248d382aafbSBarry Smith #else 2249d382aafbSBarry Smith #define MPIU_File_write_all(a,b,c,d,e) MPI_File_write_all(a,b,c,d,e) 2250d382aafbSBarry Smith #define MPIU_File_read_all(a,b,c,d,e) MPI_File_read_all(a,b,c,d,e) 2251d382aafbSBarry Smith #endif 2252d382aafbSBarry Smith #endif 2253d382aafbSBarry Smith 2254d382aafbSBarry Smith /* the following petsc_static_inline require petscerror.h */ 2255d382aafbSBarry Smith 2256d382aafbSBarry Smith /* Limit MPI to 32-bits */ 2257d382aafbSBarry Smith #define PETSC_MPI_INT_MAX 2147483647 2258d382aafbSBarry Smith #define PETSC_MPI_INT_MIN -2147483647 2259d382aafbSBarry Smith /* Limit BLAS to 32-bits */ 2260d382aafbSBarry Smith #define PETSC_BLAS_INT_MAX 2147483647 2261d382aafbSBarry Smith #define PETSC_BLAS_INT_MIN -2147483647 2262d382aafbSBarry Smith 226361b0d812SBarry Smith /*@C 226461b0d812SBarry Smith PetscBLASIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscBLASInt (which may be 32 bits in size), generates an 226561b0d812SBarry Smith error if the PetscBLASInt is not large enough to hold the number. 226661b0d812SBarry Smith 226761b0d812SBarry Smith Not Collective 226861b0d812SBarry Smith 226961b0d812SBarry Smith Input Parameter: 227061b0d812SBarry Smith . a - the PetscInt value 227161b0d812SBarry Smith 227261b0d812SBarry Smith Output Parameter: 227361b0d812SBarry Smith . b - the resulting PetscBLASInt value 227461b0d812SBarry Smith 227561b0d812SBarry Smith Level: advanced 227661b0d812SBarry Smith 227761b0d812SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscMPIIntCast() 227861b0d812SBarry Smith @*/ 2279c5df96a5SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscBLASIntCast(PetscInt a,PetscBLASInt *b) 2280c5df96a5SBarry Smith { 2281c5df96a5SBarry Smith PetscFunctionBegin; 2282ab7117d1SBarry Smith *b = (PetscBLASInt)(a); 2283c5df96a5SBarry Smith #if defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_HAVE_64BIT_BLAS_INDICES) 2284c5df96a5SBarry Smith if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK"); 2285c5df96a5SBarry Smith #endif 2286c5df96a5SBarry Smith PetscFunctionReturn(0); 2287c5df96a5SBarry Smith } 2288c5df96a5SBarry Smith 228961b0d812SBarry Smith /*@C 229061b0d812SBarry Smith PetscMPIIntCast - casts a PetscInt (which may be 64 bits in size) to a PetscMPIInt (which may be 32 bits in size), generates an 229161b0d812SBarry Smith error if the PetscMPIInt is not large enough to hold the number. 229261b0d812SBarry Smith 229361b0d812SBarry Smith Not Collective 229461b0d812SBarry Smith 229561b0d812SBarry Smith Input Parameter: 229661b0d812SBarry Smith . a - the PetscInt value 229761b0d812SBarry Smith 229861b0d812SBarry Smith Output Parameter: 229961b0d812SBarry Smith . b - the resulting PetscMPIInt value 230061b0d812SBarry Smith 230161b0d812SBarry Smith Level: advanced 230261b0d812SBarry Smith 230361b0d812SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast() 230461b0d812SBarry Smith @*/ 23054dc2109aSBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscMPIIntCast(PetscInt a,PetscMPIInt *b) 23064dc2109aSBarry Smith { 23074dc2109aSBarry Smith PetscFunctionBegin; 2308ab7117d1SBarry Smith *b = (PetscMPIInt)(a); 23094dc2109aSBarry Smith #if defined(PETSC_USE_64BIT_INDICES) 23104dc2109aSBarry Smith if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for MPI"); 23114dc2109aSBarry Smith #endif 23124dc2109aSBarry Smith PetscFunctionReturn(0); 23134dc2109aSBarry Smith } 23144dc2109aSBarry Smith 2315bafee8b4SSatish Balay #define PetscInt64Mult(a,b) ((PetscInt64)(a))*((PetscInt64)(b)) 23162f18eb33SBarry Smith 23172f18eb33SBarry Smith /*@C 23182f18eb33SBarry Smith 23192f18eb33SBarry 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 23202f18eb33SBarry Smith 23212f18eb33SBarry Smith Not Collective 23222f18eb33SBarry Smith 23232f18eb33SBarry Smith Input Parameter: 23242f18eb33SBarry Smith + a - the PetscReal value 23252f18eb33SBarry Smith - b - the second value 23262f18eb33SBarry Smith 2327390e1bf2SBarry Smith Returns: 2328390e1bf2SBarry Smith the result as a PetscInt value 23292f18eb33SBarry Smith 2330bafee8b4SSatish Balay Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64 23312f18eb33SBarry Smith Use PetscIntMultTruncate() to compute the product of two positive PetscInt and truncate to fit a PetscInt 23322f18eb33SBarry 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 23332f18eb33SBarry Smith 23342f18eb33SBarry Smith Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks. 23352f18eb33SBarry Smith 23362f18eb33SBarry Smith This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able. 23372f18eb33SBarry Smith 23382f18eb33SBarry Smith Level: advanced 23392f18eb33SBarry Smith 2340390e1bf2SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult() 23412f18eb33SBarry Smith @*/ 23422f18eb33SBarry Smith PETSC_STATIC_INLINE PetscInt PetscRealIntMultTruncate(PetscReal a,PetscInt b) 23432f18eb33SBarry Smith { 2344bafee8b4SSatish Balay PetscInt64 r; 23452f18eb33SBarry Smith 2346bafee8b4SSatish Balay r = (PetscInt64) (a*(PetscReal)b); 23472f18eb33SBarry Smith if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100; 23482f18eb33SBarry Smith return (PetscInt) r; 23492f18eb33SBarry Smith } 23502f18eb33SBarry Smith 23512f18eb33SBarry Smith /*@C 23522f18eb33SBarry Smith 23532f18eb33SBarry Smith PetscIntMultTruncate - Computes the product of two positive PetscInt and truncates the value to slightly less than the maximal possible value 23542f18eb33SBarry Smith 23552f18eb33SBarry Smith Not Collective 23562f18eb33SBarry Smith 23572f18eb33SBarry Smith Input Parameter: 23582f18eb33SBarry Smith + a - the PetscInt value 23592f18eb33SBarry Smith - b - the second value 23602f18eb33SBarry Smith 2361390e1bf2SBarry Smith Returns: 2362390e1bf2SBarry Smith the result as a PetscInt value 23632f18eb33SBarry Smith 2364bafee8b4SSatish Balay Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64 23652f18eb33SBarry Smith Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt 23662f18eb33SBarry 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 23672f18eb33SBarry Smith 23682f18eb33SBarry Smith Developers Note: We currently assume that PetscInt addition can never overflow, this is obviously wrong but requires many more checks. 23692f18eb33SBarry Smith 23702f18eb33SBarry Smith This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able. 23712f18eb33SBarry Smith 23722f18eb33SBarry Smith Level: advanced 23732f18eb33SBarry Smith 2374390e1bf2SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult() 23752f18eb33SBarry Smith @*/ 23762f18eb33SBarry Smith PETSC_STATIC_INLINE PetscInt PetscIntMultTruncate(PetscInt a,PetscInt b) 23772f18eb33SBarry Smith { 2378bafee8b4SSatish Balay PetscInt64 r; 23792f18eb33SBarry Smith 2380bafee8b4SSatish Balay r = PetscInt64Mult(a,b); 23812f18eb33SBarry Smith if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100; 23822f18eb33SBarry Smith return (PetscInt) r; 23832f18eb33SBarry Smith } 23842f18eb33SBarry Smith 2385f91af8c7SBarry Smith /*@C 2386f91af8c7SBarry Smith 2387f91af8c7SBarry Smith PetscIntSumTruncate - Computes the sum of two positive PetscInt and truncates the value to slightly less than the maximal possible value 2388f91af8c7SBarry Smith 2389f91af8c7SBarry Smith Not Collective 2390f91af8c7SBarry Smith 2391f91af8c7SBarry Smith Input Parameter: 2392f91af8c7SBarry Smith + a - the PetscInt value 2393f91af8c7SBarry Smith - b - the second value 2394f91af8c7SBarry Smith 2395390e1bf2SBarry Smith Returns: 2396390e1bf2SBarry Smith the result as a PetscInt value 2397f91af8c7SBarry Smith 2398bafee8b4SSatish Balay Use PetscInt64Mult() to compute the product of two PetscInt as a PetscInt64 2399f91af8c7SBarry Smith Use PetscRealIntMultTruncate() to compute the product of a PetscReal and a PetscInt and truncate to fit a PetscInt 2400f91af8c7SBarry 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 2401f91af8c7SBarry Smith 2402f91af8c7SBarry Smith This is used where we compute approximate sizes for workspace and need to insure the workspace is index-able. 2403f91af8c7SBarry Smith 2404f91af8c7SBarry Smith Level: advanced 2405f91af8c7SBarry Smith 2406390e1bf2SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult() 2407f91af8c7SBarry Smith @*/ 2408f91af8c7SBarry Smith PETSC_STATIC_INLINE PetscInt PetscIntSumTruncate(PetscInt a,PetscInt b) 2409f91af8c7SBarry Smith { 2410bafee8b4SSatish Balay PetscInt64 r; 2411f91af8c7SBarry Smith 2412bafee8b4SSatish Balay r = ((PetscInt64)a) + ((PetscInt64)b); 2413f91af8c7SBarry Smith if (r > PETSC_MAX_INT - 100) r = PETSC_MAX_INT - 100; 2414f91af8c7SBarry Smith return (PetscInt) r; 2415f91af8c7SBarry Smith } 2416f91af8c7SBarry Smith 24172f18eb33SBarry Smith /*@C 24182f18eb33SBarry Smith 24192f18eb33SBarry Smith PetscIntMultError - Computes the product of two positive PetscInt and generates an error with overflow. 24202f18eb33SBarry Smith 24212f18eb33SBarry Smith Not Collective 24222f18eb33SBarry Smith 24232f18eb33SBarry Smith Input Parameter: 24242f18eb33SBarry Smith + a - the PetscInt value 24252f18eb33SBarry Smith - b - the second value 24262f18eb33SBarry Smith 24272f18eb33SBarry Smith Output Parameter:ma 2428390e1bf2SBarry 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 24292f18eb33SBarry Smith 2430bafee8b4SSatish Balay Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64 24312f18eb33SBarry Smith Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt 24322f18eb33SBarry Smith 2433220afb94SBarry Smith Developers Note: We currently assume that PetscInt addition does not overflow, this is obviously wrong but requires many more checks. 24342f18eb33SBarry Smith 24352f18eb33SBarry Smith Level: advanced 24362f18eb33SBarry Smith 2437220afb94SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscIntMult64(), PetscIntSumError() 24382f18eb33SBarry Smith @*/ 24392f18eb33SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscIntMultError(PetscInt a,PetscInt b,PetscInt *result) 24402f18eb33SBarry Smith { 2441bafee8b4SSatish Balay PetscInt64 r; 24422f18eb33SBarry Smith 24432f18eb33SBarry Smith PetscFunctionBegin; 2444bafee8b4SSatish Balay r = PetscInt64Mult(a,b); 24452f18eb33SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES) 24462f18eb33SBarry 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); 24472f18eb33SBarry Smith #endif 2448f91af8c7SBarry Smith if (result) *result = (PetscInt) r; 2449f91af8c7SBarry Smith PetscFunctionReturn(0); 2450f91af8c7SBarry Smith } 2451f91af8c7SBarry Smith 2452f91af8c7SBarry Smith /*@C 2453f91af8c7SBarry Smith 2454fbfcfee5SBarry Smith PetscIntSumError - Computes the sum of two positive PetscInt and generates an error with overflow. 2455f91af8c7SBarry Smith 2456f91af8c7SBarry Smith Not Collective 2457f91af8c7SBarry Smith 2458f91af8c7SBarry Smith Input Parameter: 2459f91af8c7SBarry Smith + a - the PetscInt value 2460f91af8c7SBarry Smith - b - the second value 2461f91af8c7SBarry Smith 2462f91af8c7SBarry Smith Output Parameter:ma 2463390e1bf2SBarry 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 2464f91af8c7SBarry Smith 2465bafee8b4SSatish Balay Use PetscInt64Mult() to compute the product of two 32 bit PetscInt and store in a PetscInt64 2466f91af8c7SBarry Smith Use PetscIntMultTruncate() to compute the product of two PetscInt and truncate it to fit in a PetscInt 2467f91af8c7SBarry Smith 2468f91af8c7SBarry Smith Level: advanced 2469f91af8c7SBarry Smith 2470390e1bf2SBarry Smith .seealso: PetscBLASInt, PetscMPIInt, PetscInt, PetscBLASIntCast(), PetscInt64Mult() 2471f91af8c7SBarry Smith @*/ 2472f91af8c7SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscIntSumError(PetscInt a,PetscInt b,PetscInt *result) 2473f91af8c7SBarry Smith { 2474bafee8b4SSatish Balay PetscInt64 r; 2475f91af8c7SBarry Smith 2476f91af8c7SBarry Smith PetscFunctionBegin; 2477bafee8b4SSatish Balay r = ((PetscInt64)a) + ((PetscInt64)b); 2478f91af8c7SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES) 2479f91af8c7SBarry Smith if (r > PETSC_MAX_INT) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_SUP,"Sum of two integer %d %d overflow, you must ./configure PETSc with --with-64-bit-indices for the case you are running",a,b); 2480f91af8c7SBarry Smith #endif 2481f91af8c7SBarry Smith if (result) *result = (PetscInt) r; 24822f18eb33SBarry Smith PetscFunctionReturn(0); 24832f18eb33SBarry Smith } 2484c5df96a5SBarry Smith 2485d382aafbSBarry Smith /* 24862981ebdbSBarry Smith The IBM include files define hz, here we hide it so that it may be used as a regular user variable. 2487d382aafbSBarry Smith */ 2488d382aafbSBarry Smith #if defined(hz) 2489d382aafbSBarry Smith #undef hz 2490d382aafbSBarry Smith #endif 2491d382aafbSBarry Smith 2492d382aafbSBarry Smith /* For arrays that contain filenames or paths */ 2493d382aafbSBarry Smith 2494d382aafbSBarry Smith 2495d382aafbSBarry Smith #if defined(PETSC_HAVE_LIMITS_H) 2496d382aafbSBarry Smith #include <limits.h> 2497d382aafbSBarry Smith #endif 2498d382aafbSBarry Smith #if defined(PETSC_HAVE_SYS_PARAM_H) 2499d382aafbSBarry Smith #include <sys/param.h> 2500d382aafbSBarry Smith #endif 2501d382aafbSBarry Smith #if defined(PETSC_HAVE_SYS_TYPES_H) 2502d382aafbSBarry Smith #include <sys/types.h> 2503d382aafbSBarry Smith #endif 2504d382aafbSBarry Smith #if defined(MAXPATHLEN) 2505d382aafbSBarry Smith # define PETSC_MAX_PATH_LEN MAXPATHLEN 2506d382aafbSBarry Smith #elif defined(MAX_PATH) 2507d382aafbSBarry Smith # define PETSC_MAX_PATH_LEN MAX_PATH 2508d382aafbSBarry Smith #elif defined(_MAX_PATH) 2509d382aafbSBarry Smith # define PETSC_MAX_PATH_LEN _MAX_PATH 2510d382aafbSBarry Smith #else 2511d382aafbSBarry Smith # define PETSC_MAX_PATH_LEN 4096 2512d382aafbSBarry Smith #endif 2513d382aafbSBarry Smith 2514d382aafbSBarry Smith /*MC 2515d382aafbSBarry Smith 25161b266c99SBarry Smith UsingFortran - To use PETSc with Fortran you must use both PETSc include files and modules. At the beginning 25171b266c99SBarry Smith of every function and module definition you need something like 2518d382aafbSBarry Smith 2519d382aafbSBarry Smith $ 2520af0996ceSBarry Smith $#include "petsc/finclude/petscXXX.h" 2521d382aafbSBarry Smith $ use petscXXXX 25221b266c99SBarry Smith 2523*692afcd8SPatrick Sanan You can declare PETSc variables using either of the following. 25241b266c99SBarry Smith 2525d382aafbSBarry Smith $ XXX variablename 25261b266c99SBarry Smith $ type(tXXX) variablename 25271b266c99SBarry Smith 2528*692afcd8SPatrick Sanan For example, 25291b266c99SBarry Smith 2530bfc4c25eSBarry Smith $#include "petsc/finclude/petscvec.h" 25311b266c99SBarry Smith $ use petscvec 2532d382aafbSBarry Smith $ 2533*692afcd8SPatrick Sanan $ Vec b 2534*692afcd8SPatrick Sanan $ type(tVec) x 2535d382aafbSBarry Smith 2536d382aafbSBarry Smith Level: beginner 2537d382aafbSBarry Smith 2538d382aafbSBarry Smith M*/ 2539d382aafbSBarry Smith 2540014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t); 2541014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t); 2542014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t); 2543014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t); 2544014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]); 2545014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t); 254627710113SBarry Smith PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t); 25475f309d01SBarry Smith PETSC_EXTERN PetscErrorCode PetscGetVersionNumber(PetscInt*,PetscInt*,PetscInt*,PetscInt*); 2548d382aafbSBarry Smith 2549014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt,PetscInt[]); 2550014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt*,PetscInt[]); 255160e03357SMatthew G Knepley PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt*); 2552014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]); 2553014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]); 2554014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]); 25556c2863d0SBarry Smith PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt,PetscInt[],PetscInt[],PetscInt[]); 255617d7d925SStefano Zampini PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt,PetscMPIInt[]); 255717d7d925SStefano Zampini PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt*,PetscMPIInt[]); 2558014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]); 2559014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]); 256017df18f2SToby Isaac PETSC_EXTERN PetscErrorCode PetscSortIntWithDataArray(PetscInt,PetscInt[],void*,size_t,void*); 2561014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt,PetscReal[]); 2562014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]); 2563745b41b2SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsReal(PetscInt*,PetscReal[]); 2564014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]); 2565014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]); 2566014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt,const PetscBool [],const PetscInt[],PetscInt*,PetscInt**,PetscInt**,PetscInt**,PetscInt**); 25676c2863d0SBarry Smith PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt,const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],PetscInt*,PetscInt**,PetscInt**); 25686c2863d0SBarry Smith PETSC_EXTERN PetscErrorCode PetscMergeIntArray(PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt*,PetscInt**); 2569e498c390SJed Brown PETSC_EXTERN PetscErrorCode PetscMergeMPIIntArray(PetscInt,const PetscMPIInt[],PetscInt,const PetscMPIInt[],PetscInt*,PetscMPIInt**); 2570d382aafbSBarry Smith 2571014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDisplay(void); 2572014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t); 2573d382aafbSBarry Smith 257476bdecfbSBarry Smith /*J 2575d382aafbSBarry Smith PetscRandomType - String with the name of a PETSc randomizer 2576d382aafbSBarry Smith 2577d382aafbSBarry Smith Level: beginner 2578d382aafbSBarry Smith 2579e2e64c6bSBarry Smith Notes: to use the SPRNG you must have ./configure PETSc 2580d382aafbSBarry Smith with the option --download-sprng 2581d382aafbSBarry Smith 25828f6c3df8SBarry Smith .seealso: PetscRandomSetType(), PetscRandom, PetscRandomCreate() 258376bdecfbSBarry Smith J*/ 258419fd82e9SBarry Smith typedef const char* PetscRandomType; 2585d382aafbSBarry Smith #define PETSCRAND "rand" 2586d382aafbSBarry Smith #define PETSCRAND48 "rand48" 2587d382aafbSBarry Smith #define PETSCSPRNG "sprng" 2588c5e4d11fSDmitry Karpeev #define PETSCRANDER48 "rander48" 2589d382aafbSBarry Smith 2590d382aafbSBarry Smith /* Logging support */ 2591014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID; 2592d382aafbSBarry Smith 2593607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void); 2594d382aafbSBarry Smith 2595d382aafbSBarry Smith /*S 2596d382aafbSBarry Smith PetscRandom - Abstract PETSc object that manages generating random numbers 2597d382aafbSBarry Smith 2598d382aafbSBarry Smith Level: intermediate 2599d382aafbSBarry Smith 2600d382aafbSBarry Smith Concepts: random numbers 2601d382aafbSBarry Smith 2602d382aafbSBarry Smith .seealso: PetscRandomCreate(), PetscRandomGetValue(), PetscRandomType 2603d382aafbSBarry Smith S*/ 2604d382aafbSBarry Smith typedef struct _p_PetscRandom* PetscRandom; 2605d382aafbSBarry Smith 2606d382aafbSBarry Smith /* Dynamic creation and loading functions */ 2607140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList PetscRandomList; 2608d382aafbSBarry Smith 2609bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],PetscErrorCode (*)(PetscRandom)); 261019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType); 2611014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom); 261219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType*); 2613685405a1SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscRandomViewFromOptions(PetscRandom A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);} 2614014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer); 2615d382aafbSBarry Smith 2616014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*); 2617014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*); 2618014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*); 2619014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*); 2620014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar); 2621014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long); 2622014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *); 2623014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom); 2624014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*); 2625d382aafbSBarry Smith 2626014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t); 2627014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t); 2628014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t); 2629014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]); 2630014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t); 2631014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *); 2632014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *); 263397540f07SSatish Balay PETSC_EXTERN PetscErrorCode PetscMkdir(const char[]); 263497540f07SSatish Balay PETSC_EXTERN PetscErrorCode PetscRMTree(const char[]); 2635d382aafbSBarry Smith 2636014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscDataType); 2637014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscDataType); 2638014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,void*,PetscInt,PetscDataType,PetscBool ); 2639014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,void*,PetscInt,PetscDataType,PetscBool ); 2640014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *); 2641014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinaryClose(int); 2642014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool *); 2643014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool *); 2644014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t); 2645014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *); 2646014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *); 2647e2fc02c1SBarry Smith PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[],int,int*); 2648d382aafbSBarry Smith 2649d382aafbSBarry Smith /* 2650d382aafbSBarry Smith In binary files variables are stored using the following lengths, 2651d382aafbSBarry Smith regardless of how they are stored in memory on any one particular 2652d382aafbSBarry Smith machine. Use these rather then sizeof() in computing sizes for 2653d382aafbSBarry Smith PetscBinarySeek(). 2654d382aafbSBarry Smith */ 2655d382aafbSBarry Smith #define PETSC_BINARY_INT_SIZE (32/8) 2656d382aafbSBarry Smith #define PETSC_BINARY_FLOAT_SIZE (32/8) 2657d382aafbSBarry Smith #define PETSC_BINARY_CHAR_SIZE (8/8) 2658d382aafbSBarry Smith #define PETSC_BINARY_SHORT_SIZE (16/8) 2659d382aafbSBarry Smith #define PETSC_BINARY_DOUBLE_SIZE (64/8) 2660d382aafbSBarry Smith #define PETSC_BINARY_SCALAR_SIZE sizeof(PetscScalar) 2661d382aafbSBarry Smith 2662d382aafbSBarry Smith /*E 2663d382aafbSBarry Smith PetscBinarySeekType - argument to PetscBinarySeek() 2664d382aafbSBarry Smith 2665d382aafbSBarry Smith Level: advanced 2666d382aafbSBarry Smith 2667d382aafbSBarry Smith .seealso: PetscBinarySeek(), PetscBinarySynchronizedSeek() 2668d382aafbSBarry Smith E*/ 2669d382aafbSBarry Smith typedef enum {PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1,PETSC_BINARY_SEEK_END = 2} PetscBinarySeekType; 2670014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*); 2671014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*); 2672014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt); 2673d382aafbSBarry Smith 2674014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]); 2675014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool ); 2676014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void); 2677014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*); 2678014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void); 2679014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void); 2680d382aafbSBarry Smith 2681014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*); 2682014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**); 2683014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**); 2684014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**); 2685014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**); 2686cf4b5b4fSJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt*,const void*,PetscMPIInt*,PetscMPIInt**,void*) 2687cf4b5b4fSJed Brown PetscAttrMPIPointerWithType(6,3); 2688d815da10SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedF(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt, 2689d815da10SJed Brown PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*), 2690d815da10SJed Brown PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx) 2691d815da10SJed Brown PetscAttrMPIPointerWithType(6,3); 26926afbe7ddSJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedFReq(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt, 26936afbe7ddSJed Brown MPI_Request**,MPI_Request**, 26946afbe7ddSJed Brown PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*), 26956afbe7ddSJed Brown PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx) 26966afbe7ddSJed Brown PetscAttrMPIPointerWithType(6,3); 2697d382aafbSBarry Smith 26986145cd65SJed Brown /*E 26996145cd65SJed Brown PetscBuildTwoSidedType - algorithm for setting up two-sided communication 27006145cd65SJed Brown 27016145cd65SJed Brown $ PETSC_BUILDTWOSIDED_ALLREDUCE - classical algorithm using an MPI_Allreduce with 27026145cd65SJed Brown $ a buffer of length equal to the communicator size. Not memory-scalable due to 27036145cd65SJed Brown $ the large reduction size. Requires only MPI-1. 27046145cd65SJed Brown $ PETSC_BUILDTWOSIDED_IBARRIER - nonblocking algorithm based on MPI_Issend and MPI_Ibarrier. 27056145cd65SJed Brown $ Proved communication-optimal in Hoefler, Siebert, and Lumsdaine (2010). Requires MPI-3. 27061654bf6bSJed Brown $ PETSC_BUILDTWOSIDED_REDSCATTER - similar to above, but use more optimized function 27071654bf6bSJed Brown $ that only communicates the part of the reduction that is necessary. Requires MPI-2. 27086145cd65SJed Brown 27096145cd65SJed Brown Level: developer 27106145cd65SJed Brown 27116145cd65SJed Brown .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedSetType(), PetscCommBuildTwoSidedGetType() 27126145cd65SJed Brown E*/ 27136145cd65SJed Brown typedef enum { 27146145cd65SJed Brown PETSC_BUILDTWOSIDED_NOTSET = -1, 27156145cd65SJed Brown PETSC_BUILDTWOSIDED_ALLREDUCE = 0, 27161654bf6bSJed Brown PETSC_BUILDTWOSIDED_IBARRIER = 1, 271712af867fSJed Brown PETSC_BUILDTWOSIDED_REDSCATTER = 2 27186145cd65SJed Brown /* Updates here must be accompanied by updates in finclude/petscsys.h and the string array in mpits.c */ 27196145cd65SJed Brown } PetscBuildTwoSidedType; 27206145cd65SJed Brown PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[]; 27216145cd65SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm,PetscBuildTwoSidedType); 27226145cd65SJed Brown PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm,PetscBuildTwoSidedType*); 27236145cd65SJed Brown 2724014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSSEIsEnabled(MPI_Comm,PetscBool *,PetscBool *); 2725d382aafbSBarry Smith 2726d382aafbSBarry Smith /*E 2727d382aafbSBarry Smith InsertMode - Whether entries are inserted or added into vectors or matrices 2728d382aafbSBarry Smith 2729d382aafbSBarry Smith Level: beginner 2730d382aafbSBarry Smith 2731d382aafbSBarry Smith .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), 2732d382aafbSBarry Smith VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), 2733d382aafbSBarry Smith MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd() 2734d382aafbSBarry Smith E*/ 27356fbadbe2SMatthew G Knepley typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES, INSERT_ALL_VALUES, ADD_ALL_VALUES, INSERT_BC_VALUES, ADD_BC_VALUES} InsertMode; 2736d382aafbSBarry Smith 2737d382aafbSBarry Smith /*MC 2738d382aafbSBarry Smith INSERT_VALUES - Put a value into a vector or matrix, overwrites any previous value 2739d382aafbSBarry Smith 2740d382aafbSBarry Smith Level: beginner 2741d382aafbSBarry Smith 2742d382aafbSBarry Smith .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), 2743eca87e8dSBarry Smith VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), ADD_VALUES, 2744eca87e8dSBarry Smith MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES 2745d382aafbSBarry Smith 2746d382aafbSBarry Smith M*/ 2747d382aafbSBarry Smith 2748d382aafbSBarry Smith /*MC 2749d382aafbSBarry Smith ADD_VALUES - Adds a value into a vector or matrix, if there previously was no value, just puts the 2750d382aafbSBarry Smith value into that location 2751d382aafbSBarry Smith 2752d382aafbSBarry Smith Level: beginner 2753d382aafbSBarry Smith 2754d382aafbSBarry Smith .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), 2755eca87e8dSBarry Smith VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), INSERT_VALUES, 2756eca87e8dSBarry Smith MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES 2757d382aafbSBarry Smith 2758d382aafbSBarry Smith M*/ 2759d382aafbSBarry Smith 2760d382aafbSBarry Smith /*MC 2761d382aafbSBarry Smith MAX_VALUES - Puts the maximum of the scattered/gathered value and the current value into each location 2762d382aafbSBarry Smith 2763d382aafbSBarry Smith Level: beginner 2764d382aafbSBarry Smith 2765d382aafbSBarry Smith .seealso: InsertMode, VecScatterBegin(), VecScatterEnd(), ADD_VALUES, INSERT_VALUES 2766d382aafbSBarry Smith 2767d382aafbSBarry Smith M*/ 2768d382aafbSBarry Smith 2769ce94432eSBarry Smith PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject); 2770ce94432eSBarry Smith 277145487dadSJed Brown typedef enum {PETSC_SUBCOMM_GENERAL=0,PETSC_SUBCOMM_CONTIGUOUS=1,PETSC_SUBCOMM_INTERLACED=2} PetscSubcommType; 277245487dadSJed Brown PETSC_EXTERN const char *const PetscSubcommTypes[]; 277345487dadSJed Brown 2774d382aafbSBarry Smith /*S 2775306c2d5bSBarry Smith PetscSubcomm - A decomposition of an MPI communicator into subcommunicators 2776306c2d5bSBarry Smith 2777306c2d5bSBarry Smith Notes: After a call to PetscSubcommSetType(), PetscSubcommSetTypeGeneral(), or PetscSubcommSetFromOptions() one may call 2778306c2d5bSBarry Smith $ PetscSubcommChild() returns the associated subcommunicator on this process 27793bf92927SBarry Smith $ PetscSubcommContiguousParent() returns a parent communitor but with all child of the same subcommunicator having contiguous rank 2780306c2d5bSBarry Smith 2781306c2d5bSBarry Smith Sample Usage: 2782306c2d5bSBarry Smith PetscSubcommCreate() 2783306c2d5bSBarry Smith PetscSubcommSetNumber() 2784306c2d5bSBarry Smith PetscSubcommSetType(PETSC_SUBCOMM_INTERLACED); 2785306c2d5bSBarry Smith ccomm = PetscSubcommChild() 2786306c2d5bSBarry Smith PetscSubcommDestroy() 2787d382aafbSBarry Smith 2788d382aafbSBarry Smith Level: advanced 2789d382aafbSBarry Smith 2790d382aafbSBarry Smith Concepts: communicator, create 2791306c2d5bSBarry Smith 2792306c2d5bSBarry Smith Notes: 2793306c2d5bSBarry Smith $ PETSC_SUBCOMM_GENERAL - similar to MPI_Comm_split() each process sets the new communicator (color) they will belong to and the order within that communicator 27943bf92927SBarry Smith $ PETSC_SUBCOMM_CONTIGUOUS - each new communicator contains a set of process with contiguous ranks in the original MPI communicator 2795306c2d5bSBarry Smith $ PETSC_SUBCOMM_INTERLACED - each new communictor contains a set of processes equally far apart in rank from the others in that new communicator 2796306c2d5bSBarry Smith 2797306c2d5bSBarry Smith Examaple: Consider a communicator with six processes split into 3 subcommunicators. 2798306c2d5bSBarry Smith $ PETSC_SUBCOMM_CONTIGUOUS - the first communicator contains rank 0,1 the second rank 2,3 and the third rank 4,5 in the original ordering of the original communicator 2799306c2d5bSBarry Smith $ PETSC_SUBCOMM_INTERLACED - the first communicator contains rank 0,3, the second 1,4 and the third 2,5 2800306c2d5bSBarry Smith 2801306c2d5bSBarry Smith Developer Notes: This is used in objects such as PCREDUNDANT() to manage the subcommunicators on which the redundant computations 2802306c2d5bSBarry Smith are performed. 2803306c2d5bSBarry Smith 2804306c2d5bSBarry Smith 2805306c2d5bSBarry Smith .seealso: PetscSubcommCreate(), PetscSubcommSetNumber(), PetscSubcommSetType(), PetscSubcommView(), PetscSubcommSetFromOptions() 2806306c2d5bSBarry Smith 2807d382aafbSBarry Smith S*/ 2808d382aafbSBarry Smith typedef struct _n_PetscSubcomm* PetscSubcomm; 2809d382aafbSBarry Smith 2810d382aafbSBarry Smith struct _n_PetscSubcomm { 2811d382aafbSBarry Smith MPI_Comm parent; /* parent communicator */ 2812d382aafbSBarry Smith MPI_Comm dupparent; /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */ 2813306c2d5bSBarry Smith MPI_Comm child; /* the sub-communicator */ 281445487dadSJed Brown PetscMPIInt n; /* num of subcommunicators under the parent communicator */ 281545487dadSJed Brown PetscMPIInt color; /* color of processors belong to this communicator */ 2816708d824cSJed Brown PetscMPIInt *subsize; /* size of subcommunicator[color] */ 281745487dadSJed Brown PetscSubcommType type; 2818e5acf8a4SHong Zhang char *subcommprefix; 2819d382aafbSBarry Smith }; 2820d382aafbSBarry Smith 2821c5e4d11fSDmitry Karpeev PETSC_STATIC_INLINE MPI_Comm PetscSubcommParent(PetscSubcomm scomm) {return scomm->parent;} 2822306c2d5bSBarry Smith PETSC_STATIC_INLINE MPI_Comm PetscSubcommChild(PetscSubcomm scomm) {return scomm->child;} 282336be1a5eSBarry Smith PETSC_STATIC_INLINE MPI_Comm PetscSubcommContiguousParent(PetscSubcomm scomm) {return scomm->dupparent;} 2824014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*); 2825014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*); 2826014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt); 2827014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType); 282865d9b8f1SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt); 2829053d1c95SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm,PetscViewer); 2830f68be91cSHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm); 2831e5acf8a4SHong Zhang PETSC_EXTERN PetscErrorCode PetscSubcommSetOptionsPrefix(PetscSubcomm,const char[]); 2832d382aafbSBarry Smith 28330f453b92SJed Brown /*S 28349962606eSBarry Smith PetscHeap - A simple class for managing heaps 28359962606eSBarry Smith 28369962606eSBarry Smith Level: intermediate 28379962606eSBarry Smith 28389962606eSBarry Smith Concepts: random numbers 28399962606eSBarry Smith 28409962606eSBarry Smith .seealso: PetscHeapCreate(), PetscHeapAdd(), PetscHeapPop(), PetscHeapPeek(), PetscHeapStash(), PetscHeapUnstash(), PetscHeapView(), PetscHeapDestroy() 28419962606eSBarry Smith S*/ 28429962606eSBarry Smith typedef struct _PetscHeap *PetscHeap; 28439962606eSBarry Smith 28449962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapCreate(PetscInt,PetscHeap*); 28459962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapAdd(PetscHeap,PetscInt,PetscInt); 28469962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapPop(PetscHeap,PetscInt*,PetscInt*); 28479962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapPeek(PetscHeap,PetscInt*,PetscInt*); 28489962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapStash(PetscHeap,PetscInt,PetscInt); 28499962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapUnstash(PetscHeap); 28509962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapDestroy(PetscHeap*); 28519962606eSBarry Smith PETSC_EXTERN PetscErrorCode PetscHeapView(PetscHeap,PetscViewer); 28529962606eSBarry Smith 28539962606eSBarry Smith /*S 28540f453b92SJed Brown PetscSegBuffer - a segmented extendable buffer 28550f453b92SJed Brown 28560f453b92SJed Brown Level: developer 28570f453b92SJed Brown 28580f453b92SJed Brown .seealso: PetscSegBufferCreate(), PetscSegBufferGet(), PetscSegBufferExtract(), PetscSegBufferDestroy() 28590f453b92SJed Brown S*/ 28600f453b92SJed Brown typedef struct _n_PetscSegBuffer *PetscSegBuffer; 286113e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t,size_t,PetscSegBuffer*); 28620f453b92SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer*); 286313e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer,size_t,void*); 2864137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer,void*); 2865137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer,void*); 2866137cf7b6SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer,void*); 286713e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer,size_t*); 286813e3f751SJed Brown PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer,size_t); 28690f453b92SJed Brown 2870471ecdacSJed Brown /* Type-safe wrapper to encourage use of PETSC_RESTRICT. Does not use PetscFunctionBegin because the error handling 2871471ecdacSJed Brown * prevents the compiler from completely erasing the stub. This is called in inner loops so it has to be as fast as 2872471ecdacSJed Brown * possible. */ 287335005c2bSLisandro Dalcin PETSC_STATIC_INLINE PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg,PetscInt count,PetscInt *PETSC_RESTRICT *slot) {return PetscSegBufferGet(seg,(size_t)count,(void**)slot);} 2874d382aafbSBarry Smith 28759de0f6ecSBarry Smith typedef struct _n_PetscOptionsHelpPrinted *PetscOptionsHelpPrinted; 28769de0f6ecSBarry Smith extern PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton; 28779de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted*); 28789de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted*); 28799de0f6ecSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted,const char*,const char*,PetscBool*); 28809de0f6ecSBarry Smith 2881268b0dfdSSatish Balay PETSC_EXTERN PetscSegBuffer PetscCitationsList; 2882fbfcfee5SBarry Smith 28831f817a21SBarry Smith /*@C 28841f817a21SBarry Smith PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used in the code. 28851f817a21SBarry Smith 28861f817a21SBarry Smith Not Collective - only what is registered on rank 0 of PETSC_COMM_WORLD will be printed 28871f817a21SBarry Smith 28881f817a21SBarry Smith Input Parameters: 28891f817a21SBarry Smith + cite - the bibtex item, formated to displayed on multiple lines nicely 28901f817a21SBarry Smith - set - a boolean variable initially set to PETSC_FALSE; this is used to insure only a single registration of the citation 28911f817a21SBarry Smith 2892850545d0SSatish Balay Level: intermediate 2893850545d0SSatish Balay 28941f817a21SBarry Smith Options Database: 2895063414e0SPatrick Sanan . -citations [filename] - print out the bibtex entries for the given computation 28961f817a21SBarry Smith @*/ 2897dff31646SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscCitationsRegister(const char cit[],PetscBool *set) 2898dff31646SBarry Smith { 2899dff31646SBarry Smith size_t len; 2900dff31646SBarry Smith char *vstring; 2901dff31646SBarry Smith PetscErrorCode ierr; 2902dff31646SBarry Smith 29031f817a21SBarry Smith PetscFunctionBegin; 29048d3683fcSBarry Smith if (set && *set) PetscFunctionReturn(0); 2905dff31646SBarry Smith ierr = PetscStrlen(cit,&len);CHKERRQ(ierr); 290635005c2bSLisandro Dalcin ierr = PetscSegBufferGet(PetscCitationsList,len,&vstring);CHKERRQ(ierr); 2907dff31646SBarry Smith ierr = PetscMemcpy(vstring,cit,len);CHKERRQ(ierr); 2908dff31646SBarry Smith if (set) *set = PETSC_TRUE; 29091f817a21SBarry Smith PetscFunctionReturn(0); 2910dff31646SBarry Smith } 2911dff31646SBarry Smith 2912b967cddfSBarry Smith PETSC_EXTERN PetscErrorCode PetscURLShorten(const char[],char[],size_t); 2913fe278a28SBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm,char[],char[],size_t); 2914fe278a28SBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm,const char[],char[],size_t); 2915f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscGoogleDriveUpload(MPI_Comm,const char[],const char []); 2916fe278a28SBarry Smith 2917f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscBoxAuthorize(MPI_Comm,char[],char[],size_t); 2918f044a08eSBarry Smith PETSC_EXTERN PetscErrorCode PetscBoxRefresh(MPI_Comm,const char[],char[],char[],size_t); 2919b967cddfSBarry Smith 292004102261SBarry Smith PETSC_EXTERN PetscErrorCode PetscTextBelt(MPI_Comm,const char[],const char[],PetscBool*); 2921763ec7b1SBarry Smith PETSC_EXTERN PetscErrorCode PetscTellMyCell(MPI_Comm,const char[],const char[],PetscBool*); 2922dff31646SBarry Smith 292368e69593SBarry Smith PETSC_EXTERN PetscErrorCode PetscPullJSONValue(const char[],const char[],char[],size_t,PetscBool*); 29245dc0f0a4SBarry Smith PETSC_EXTERN PetscErrorCode PetscPushJSONValue(char[],const char[],const char[],size_t); 2925d382aafbSBarry Smith 2926b2566f29SBarry Smith 2927b2566f29SBarry Smith #if defined(PETSC_USE_DEBUG) 2928b2566f29SBarry Smith /* 2929b2566f29SBarry Smith Verify that all processes in the communicator have called this from the same line of code 2930b2566f29SBarry Smith */ 29318f5db7efSBarry Smith PETSC_EXTERN PetscErrorCode PetscAllreduceBarrierCheck(MPI_Comm,PetscMPIInt,int,const char*,const char *); 293277a5e07dSBarry Smith 293377a5e07dSBarry Smith /*MC 293477a5e07dSBarry Smith MPIU_Allreduce - a PETSc replacement for MPI_Allreduce() that tries to determine if the call from all the MPI processes occur from the 293577a5e07dSBarry Smith same place in the PETSc code. This helps to detect bugs where different MPI processes follow different code paths 293677a5e07dSBarry Smith resulting in inconsistent and incorrect calls to MPI_Allreduce(). 293777a5e07dSBarry Smith 293877a5e07dSBarry Smith Collective on MPI_Comm 293977a5e07dSBarry Smith 294077a5e07dSBarry Smith Synopsis: 294177a5e07dSBarry Smith #include <petscsys.h> 294277a5e07dSBarry Smith PetscErrorCode MPIU_Allreduce(void *indata,void *outdata,PetscMPIInt count,MPI_Datatype datatype, MPI_Op op, MPI_Comm comm); 294377a5e07dSBarry Smith 294477a5e07dSBarry Smith Input Parameters: 294577a5e07dSBarry Smith + indata - pointer to the input data to be reduced 294677a5e07dSBarry Smith . count - the number of MPI data items in indata and outdata 294777a5e07dSBarry Smith . datatype - the MPI datatype, for example MPI_INT 294877a5e07dSBarry Smith . op - the MPI operation, for example MPI_SUM 294977a5e07dSBarry Smith - comm - the MPI communicator on which the operation occurs 295077a5e07dSBarry Smith 295177a5e07dSBarry Smith Output Parameter: 295277a5e07dSBarry Smith . outdata - the reduced values 295377a5e07dSBarry Smith 295477a5e07dSBarry Smith Notes: In optimized mode this directly calls MPI_Allreduce() 295577a5e07dSBarry Smith 295677a5e07dSBarry Smith Level: developer 295777a5e07dSBarry Smith 295877a5e07dSBarry Smith .seealso: MPI_Allreduce() 295977a5e07dSBarry Smith M*/ 2960fbfcfee5SBarry 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)) 2961b2566f29SBarry Smith #else 2962b2566f29SBarry Smith #define MPIU_Allreduce(a,b,c,d,e,fcomm) MPI_Allreduce(a,b,c,d,e,fcomm) 2963b2566f29SBarry Smith #endif 2964b2566f29SBarry Smith 2965d382aafbSBarry Smith #endif 2966