/* This is the main PETSc include file (for C and C++). It is included by all other PETSc include files, so it almost never has to be specifically included. */ #if !defined(__PETSCSYS_H) #define __PETSCSYS_H /* ========================================================================== */ /* petscconf.h is contained in ${PETSC_ARCH}/include/petscconf.h it is found automatically by the compiler due to the -I${PETSC_DIR}/${PETSC_ARCH}/include in the conf/variables definition of PETSC_INCLUDE. For --prefix installs the ${PETSC_ARCH}/ does not exist and petscconf.h is in the same directory as the other PETSc include files. */ #include #include #if defined(PETSC_DESIRE_FEATURE_TEST_MACROS) /* Feature test macros must be included before headers defined by IEEE Std 1003.1-2001 We only turn these in PETSc source files that require them by setting PETSC_DESIRE_FEATURE_TEST_MACROS */ #if defined(PETSC__POSIX_C_SOURCE_200112L) && !defined(_POSIX_C_SOURCE) #define _POSIX_C_SOURCE 200112L #endif #if defined(PETSC__BSD_SOURCE) && !defined(_BSD_SOURCE) #define _BSD_SOURCE #endif #if defined(PETSC__GNU_SOURCE) && !defined(_GNU_SOURCE) #define _GNU_SOURCE #endif #endif /* ========================================================================== */ /* This facilitates using the C version of PETSc from C++ and the C++ version from C. */ #if defined(__cplusplus) # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_CXX #else # define PETSC_FUNCTION_NAME PETSC_FUNCTION_NAME_C #endif #if defined(_WIN32) && defined(PETSC_USE_SHARED_LIBRARIES) /* For Win32 shared libraries */ # define PETSC_DLLEXPORT __declspec(dllexport) # define PETSC_DLLIMPORT __declspec(dllimport) # define PETSC_VISIBILITY_INTERNAL #elif defined(PETSC_USE_VISIBILITY) # define PETSC_DLLEXPORT __attribute__((visibility ("default"))) # define PETSC_DLLIMPORT __attribute__((visibility ("default"))) # define PETSC_VISIBILITY_INTERNAL __attribute__((visibility ("hidden"))) #else # define PETSC_DLLEXPORT # define PETSC_DLLIMPORT # define PETSC_VISIBILITY_INTERNAL #endif #if defined(petsc_EXPORTS) /* CMake defines this when building the shared library */ # define PETSC_VISIBILITY_PUBLIC PETSC_DLLEXPORT #else /* Win32 users need this to import symbols from petsc.dll */ # define PETSC_VISIBILITY_PUBLIC PETSC_DLLIMPORT #endif #if defined(__cplusplus) #define PETSC_EXTERN extern "C" PETSC_VISIBILITY_PUBLIC #define PETSC_EXTERN_TYPEDEF extern "C" #define PETSC_INTERN extern "C" PETSC_VISIBILITY_INTERNAL #else #define PETSC_EXTERN extern PETSC_VISIBILITY_PUBLIC #define PETSC_EXTERN_TYPEDEF #define PETSC_INTERN extern PETSC_VISIBILITY_INTERNAL #endif #include #define PETSC_AUTHOR_INFO " The PETSc Team\n petsc-maint@mcs.anl.gov\n http://www.mcs.anl.gov/petsc/\n" /* ========================================================================== */ /* Defines the interface to MPI allowing the use of all MPI functions. PETSc does not use the C++ binding of MPI at ALL. The following flag makes sure the C++ bindings are not included. The C++ bindings REQUIRE putting mpi.h before ANY C++ include files, we cannot control this with all PETSc users. Users who want to use the MPI C++ bindings can include mpicxx.h directly in their code */ #if !defined(MPICH_SKIP_MPICXX) # define MPICH_SKIP_MPICXX 1 #endif #if !defined(OMPI_SKIP_MPICXX) # define OMPI_SKIP_MPICXX 1 #endif #include /* Need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler see the top of mpicxx.h in the MPICH2 distribution. */ #include /* MSMPI on 32bit windows requires this yukky hack - that breaks MPI standard compliance */ #if !defined(MPIAPI) #define MPIAPI #endif /* Support for Clang (>=3.2) matching type tag arguments with void* buffer types */ #if defined(__has_attribute) # if __has_attribute(argument_with_type_tag) && __has_attribute(pointer_with_type_tag) && __has_attribute(type_tag_for_datatype) # define PetscAttrMPIPointerWithType(bufno,typeno) __attribute__((pointer_with_type_tag(MPI,bufno,typeno))) # define PetscAttrMPITypeTag(type) __attribute__((type_tag_for_datatype(MPI,type))) # define PetscAttrMPITypeTagLayoutCompatible(type) __attribute__((type_tag_for_datatype(MPI,type,layout_compatible))) # endif #endif #if !defined(PetscAttrMPIPointerWithType) # define PetscAttrMPIPointerWithType(bufno,typeno) # define PetscAttrMPITypeTag(type) # define PetscAttrMPITypeTagLayoutCompatible(type) #endif /*MC PetscErrorCode - datatype used for return error code from all PETSc functions Level: beginner .seealso: CHKERRQ, SETERRQ M*/ typedef int PetscErrorCode; /*MC PetscClassId - A unique id used to identify each PETSc class. (internal integer in the data structure used for error checking). These are all computed by an offset from the lowest one, PETSC_SMALLEST_CLASSID. Level: advanced .seealso: PetscClassIdRegister(), PetscLogEventRegister(), PetscHeaderCreate() M*/ typedef int PetscClassId; /*MC PetscMPIInt - datatype used to represent 'int' parameters to MPI functions. Level: intermediate Notes: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt it remains 32 bit PetscMPIIntCast(a,&b) checks if the given PetscInt a will fit in a PetscMPIInt, if not it generates a PETSC_ERR_ARG_OUTOFRANGE error. .seealso: PetscBLASInt, PetscInt M*/ typedef int PetscMPIInt; /*MC PetscEnum - datatype used to pass enum types within PETSc functions. Level: intermediate .seealso: PetscOptionsGetEnum(), PetscOptionsEnum(), PetscBagRegisterEnum() M*/ typedef enum { ENUM_DUMMY } PetscEnum; PETSC_EXTERN MPI_Datatype MPIU_ENUM PetscAttrMPITypeTag(PetscEnum); /*MC PetscInt - PETSc type that represents integer - used primarily to represent size of arrays and indexing into arrays. Its size can be configured with the option --with-64-bit-indices - to be either 32bit or 64bit [default 32 bit ints] Level: intermediate .seealso: PetscScalar, PetscBLASInt, PetscMPIInt M*/ #if (PETSC_SIZEOF_LONG_LONG == 8) typedef long long Petsc64bitInt; #elif defined(PETSC_HAVE___INT64) typedef __int64 Petsc64bitInt; #else typedef unknown64bit Petsc64bitInt #endif #if defined(PETSC_USE_64BIT_INDICES) typedef Petsc64bitInt PetscInt; #define MPIU_INT MPI_LONG_LONG_INT #else typedef int PetscInt; #define MPIU_INT MPI_INT #endif /*MC PetscBLASInt - datatype used to represent 'int' parameters to BLAS/LAPACK functions. Level: intermediate Notes: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt it remains 32 bit (except on very rare BLAS/LAPACK implementations that support 64 bit integers see the note below). PetscErrorCode PetscBLASIntCast(a,&b) checks if the given PetscInt a will fit in a PetscBLASInt, if not it generates a PETSC_ERR_ARG_OUTOFRANGE error Installation Notes: The 64bit versions of MATLAB ship with BLAS and LAPACK that use 64 bit integers for sizes etc, if you run ./configure with the option --with-blas-lapack-lib=[/Applications/MATLAB_R2010b.app/bin/maci64/libmwblas.dylib,/Applications/MATLAB_R2010b.app/bin/maci64/libmwlapack.dylib] but you need to also use --known-64-bit-blas-indices. MKL also ships with 64 bit integer versions of the BLAS and LAPACK, if you select those you must also ./configure with --known-64-bit-blas-indices Developer Notes: Eventually ./configure should automatically determine the size of the integers used by BLAS/LAPACK. External packages such as hypre, ML, SuperLU etc do not provide any support for passing 64 bit integers to BLAS/LAPACK so cannot be used with PETSc if you have set PetscBLASInt to long int. .seealso: PetscMPIInt, PetscInt M*/ #if defined(PETSC_HAVE_64BIT_BLAS_INDICES) typedef Petsc64bitInt PetscBLASInt; #else typedef int PetscBLASInt; #endif /*EC PetscPrecision - indicates what precision the object is using. This is currently not used. Level: advanced .seealso: PetscObjectSetPrecision() E*/ typedef enum { PETSC_PRECISION_SINGLE=4,PETSC_PRECISION_DOUBLE=8 } PetscPrecision; PETSC_EXTERN const char *PetscPrecisions[]; /* For the rare cases when one needs to send a size_t object with MPI */ #if (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_INT) #define MPIU_SIZE_T MPI_UNSIGNED #elif (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG) #define MPIU_SIZE_T MPI_UNSIGNED_LONG #elif (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG_LONG) #define MPIU_SIZE_T MPI_UNSIGNED_LONG_LONG #else #error "Unknown size for size_t! Send us a bugreport at petsc-maint@mcs.anl.gov" #endif /* You can use PETSC_STDOUT as a replacement of stdout. You can also change the value of PETSC_STDOUT to redirect all standard output elsewhere */ PETSC_EXTERN FILE* PETSC_STDOUT; /* You can use PETSC_STDERR as a replacement of stderr. You can also change the value of PETSC_STDERR to redirect all standard error elsewhere */ PETSC_EXTERN FILE* PETSC_STDERR; /*MC PetscUnlikely - hints the compiler that the given condition is usually FALSE Synopsis: #include "petscsys.h" PetscBool PetscUnlikely(PetscBool cond) Not Collective Input Parameters: . cond - condition or expression Note: This returns the same truth value, it is only a hint to compilers that the resulting branch is unlikely. Level: advanced .seealso: PetscLikely(), CHKERRQ M*/ /*MC PetscLikely - hints the compiler that the given condition is usually TRUE Synopsis: #include "petscsys.h" PetscBool PetscUnlikely(PetscBool cond) Not Collective Input Parameters: . cond - condition or expression Note: This returns the same truth value, it is only a hint to compilers that the resulting branch is likely. Level: advanced .seealso: PetscUnlikely() M*/ #if defined(PETSC_HAVE_BUILTIN_EXPECT) # define PetscUnlikely(cond) __builtin_expect(!!(cond),0) # define PetscLikely(cond) __builtin_expect(!!(cond),1) #else # define PetscUnlikely(cond) (cond) # define PetscLikely(cond) (cond) #endif /* Defines some elementary mathematics functions and constants. */ #include /* Declare extern C stuff after including external header files */ /* Basic PETSc constants */ /*E PetscBool - Logical variable. Actually an int in C and a logical in Fortran. Level: beginner 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 boolean values. It is not easy to have a simple macro that that will work properly in all circumstances with all three mechanisms. E*/ typedef enum { PETSC_FALSE,PETSC_TRUE } PetscBool; PETSC_EXTERN const char *const PetscBools[]; PETSC_EXTERN MPI_Datatype MPIU_BOOL PetscAttrMPITypeTag(PetscBool); /*E PetscCopyMode - Determines how an array passed to certain functions is copied or retained Level: beginner $ PETSC_COPY_VALUES - the array values are copied into new space, the user is free to reuse or delete the passed in array $ 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 $ delete the array. The array MUST have been obtained with PetscMalloc(). Hence this mode cannot be used in Fortran. $ 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 the array but the user must delete the array after the object is destroyed. E*/ typedef enum { PETSC_COPY_VALUES, PETSC_OWN_POINTER, PETSC_USE_POINTER} PetscCopyMode; PETSC_EXTERN const char *const PetscCopyModes[]; /*MC PETSC_FALSE - False value of PetscBool Level: beginner Note: Zero integer .seealso: PetscBool , PETSC_TRUE M*/ /*MC PETSC_TRUE - True value of PetscBool Level: beginner Note: Nonzero integer .seealso: PetscBool , PETSC_FALSE M*/ /*MC PETSC_NULL - standard way of passing in a null or array or pointer. This is deprecated in C/C++ simply use NULL Level: beginner Notes: accepted by many PETSc functions to not set a parameter and instead use some default This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER, PETSC_NULL_DOUBLE_PRECISION, PETSC_NULL_FUNCTION, PETSC_NULL_OBJECT etc .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE M*/ #define PETSC_NULL NULL /*MC PETSC_IGNORE - same as NULL, means PETSc will ignore this argument Level: beginner Note: accepted by many PETSc functions to not set a parameter and instead use some default Fortran Notes: This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER, PETSC_NULL_DOUBLE_PRECISION etc .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_NULL, PETSC_DETERMINE M*/ #define PETSC_IGNORE NULL /*MC PETSC_DECIDE - standard way of passing in integer or floating point parameter where you wish PETSc to use the default. Level: beginner .seealso: PETSC_NULL, PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE M*/ #define PETSC_DECIDE -1 /*MC PETSC_DETERMINE - standard way of passing in integer or floating point parameter where you wish PETSc to compute the required value. Level: beginner Developer Note: I would like to use const PetscInt PETSC_DETERMINE = PETSC_DECIDE; but for some reason this is not allowed by the standard even though PETSC_DECIDE is a constant value. .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, VecSetSizes() M*/ #define PETSC_DETERMINE PETSC_DECIDE /*MC PETSC_DEFAULT - standard way of passing in integer or floating point parameter where you wish PETSc to use the default. Level: beginner Fortran Notes: You need to use PETSC_DEFAULT_INTEGER or PETSC_DEFAULT_DOUBLE_PRECISION. .seealso: PETSC_DECIDE, PETSC_IGNORE, PETSC_DETERMINE M*/ #define PETSC_DEFAULT -2 /*MC PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents all the processs that PETSc knows about. Level: beginner Notes: By default PETSC_COMM_WORLD and MPI_COMM_WORLD are identical unless you wish to run PETSc on ONLY a subset of MPI_COMM_WORLD. In that case create your new (smaller) communicator, call it, say comm, and set PETSC_COMM_WORLD = comm BEFORE calling PetscInitialize() .seealso: PETSC_COMM_SELF M*/ PETSC_EXTERN MPI_Comm PETSC_COMM_WORLD; /*MC PETSC_COMM_SELF - This is always MPI_COMM_SELF Level: beginner .seealso: PETSC_COMM_WORLD M*/ #define PETSC_COMM_SELF MPI_COMM_SELF PETSC_EXTERN PetscBool PetscBeganMPI; PETSC_EXTERN PetscBool PetscInitializeCalled; PETSC_EXTERN PetscBool PetscFinalizeCalled; PETSC_EXTERN PetscBool PetscCUSPSynchronize; PETSC_EXTERN PetscBool PetscViennaCLSynchronize; PETSC_EXTERN PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm)); PETSC_EXTERN PetscErrorCode PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*); PETSC_EXTERN PetscErrorCode PetscCommDestroy(MPI_Comm*); /*MC PetscMalloc - Allocates memory Synopsis: #include "petscsys.h" PetscErrorCode PetscMalloc(size_t m,void **result) Not Collective Input Parameter: . m - number of bytes to allocate Output Parameter: . result - memory allocated Level: beginner Notes: Memory is always allocated at least double aligned If you request memory of zero size it will allocate no space and assign the pointer to 0; PetscFree() will properly handle not freeing the null pointer. .seealso: PetscFree(), PetscNew() Concepts: memory allocation M*/ #define PetscMalloc(a,b) ((a != 0) ? (*PetscTrMalloc)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,(void**)(b)) : (*(b) = 0,0) ) /*MC PetscAddrAlign - Rounds up an address to PETSC_MEMALIGN alignment Synopsis: #include "petscsys.h" void *PetscAddrAlign(void *addr) Not Collective Input Parameters: . addr - address to align (any pointer type) Level: developer .seealso: PetscMallocAlign() Concepts: memory allocation M*/ #define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1)) /*MC PetscMalloc2 - Allocates 2 chunks of memory both aligned to PETSC_MEMALIGN Synopsis: #include "petscsys.h" PetscErrorCode PetscMalloc2(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2) Not Collective Input Parameter: + m1 - number of elements to allocate in 1st chunk (may be zero) . t1 - type of first memory elements . m2 - number of elements to allocate in 2nd chunk (may be zero) - t2 - type of second memory elements Output Parameter: + r1 - memory allocated in first chunk - r2 - memory allocated in second chunk Level: developer .seealso: PetscFree(), PetscNew(), PetscMalloc() Concepts: memory allocation M*/ #if defined(PETSC_USE_DEBUG) #define PetscMalloc2(m1,t1,r1,m2,t2,r2) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2)) #else #define PetscMalloc2(m1,t1,r1,m2,t2,r2) ((*(r2) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(PETSC_MEMALIGN-1),r1)) || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),0)) #endif /*MC PetscMalloc3 - Allocates 3 chunks of memory all aligned to PETSC_MEMALIGN Synopsis: #include "petscsys.h" PetscErrorCode PetscMalloc3(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3) Not Collective Input Parameter: + m1 - number of elements to allocate in 1st chunk (may be zero) . t1 - type of first memory elements . m2 - number of elements to allocate in 2nd chunk (may be zero) . t2 - type of second memory elements . m3 - number of elements to allocate in 3rd chunk (may be zero) - t3 - type of third memory elements Output Parameter: + r1 - memory allocated in first chunk . r2 - memory allocated in second chunk - r3 - memory allocated in third chunk Level: developer .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3() Concepts: memory allocation M*/ #if defined(PETSC_USE_DEBUG) #define PetscMalloc3(m1,t1,r1,m2,t2,r2,m3,t3,r3) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3)) #else #define PetscMalloc3(m1,t1,r1,m2,t2,r2,m3,t3,r3) ((*(r2) = 0,*(r3) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+2*(PETSC_MEMALIGN-1),r1)) \ || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),0)) #endif /*MC PetscMalloc4 - Allocates 4 chunks of memory all aligned to PETSC_MEMALIGN Synopsis: #include "petscsys.h" PetscErrorCode PetscMalloc4(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3,size_t m4,type t4,void **r4) Not Collective Input Parameter: + m1 - number of elements to allocate in 1st chunk (may be zero) . t1 - type of first memory elements . m2 - number of elements to allocate in 2nd chunk (may be zero) . t2 - type of second memory elements . m3 - number of elements to allocate in 3rd chunk (may be zero) . t3 - type of third memory elements . m4 - number of elements to allocate in 4th chunk (may be zero) - t4 - type of fourth memory elements Output Parameter: + r1 - memory allocated in first chunk . r2 - memory allocated in second chunk . r3 - memory allocated in third chunk - r4 - memory allocated in fourth chunk Level: developer .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4() Concepts: memory allocation M*/ #if defined(PETSC_USE_DEBUG) #define PetscMalloc4(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3) || PetscMalloc((m4)*sizeof(t4),r4)) #else #define PetscMalloc4(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4) \ ((*(r2) = 0, *(r3) = 0, *(r4) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+3*(PETSC_MEMALIGN-1),r1)) \ || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),*(r4) = (t4*)PetscAddrAlign(*(r3)+m3),0)) #endif /*MC PetscMalloc5 - Allocates 5 chunks of memory all aligned to PETSC_MEMALIGN Synopsis: #include "petscsys.h" PetscErrorCode PetscMalloc5(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3,size_t m4,type t4,void **r4,size_t m5,type t5,void **r5) Not Collective Input Parameter: + m1 - number of elements to allocate in 1st chunk (may be zero) . t1 - type of first memory elements . m2 - number of elements to allocate in 2nd chunk (may be zero) . t2 - type of second memory elements . m3 - number of elements to allocate in 3rd chunk (may be zero) . t3 - type of third memory elements . m4 - number of elements to allocate in 4th chunk (may be zero) . t4 - type of fourth memory elements . m5 - number of elements to allocate in 5th chunk (may be zero) - t5 - type of fifth memory elements Output Parameter: + r1 - memory allocated in first chunk . r2 - memory allocated in second chunk . r3 - memory allocated in third chunk . r4 - memory allocated in fourth chunk - r5 - memory allocated in fifth chunk Level: developer .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5() Concepts: memory allocation M*/ #if defined(PETSC_USE_DEBUG) #define PetscMalloc5(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3) || PetscMalloc((m4)*sizeof(t4),r4) || PetscMalloc((m5)*sizeof(t5),r5)) #else #define PetscMalloc5(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5) \ ((*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5)+4*(PETSC_MEMALIGN-1),r1)) \ || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),*(r4) = (t4*)PetscAddrAlign(*(r3)+m3),*(r5) = (t5*)PetscAddrAlign(*(r4)+m4),0)) #endif /*MC PetscMalloc6 - Allocates 6 chunks of memory all aligned to PETSC_MEMALIGN Synopsis: #include "petscsys.h" PetscErrorCode PetscMalloc6(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3,size_t m4,type t4,void **r4,size_t m5,type t5,void **r5,size_t m6,type t6,void **r6) Not Collective Input Parameter: + m1 - number of elements to allocate in 1st chunk (may be zero) . t1 - type of first memory elements . m2 - number of elements to allocate in 2nd chunk (may be zero) . t2 - type of second memory elements . m3 - number of elements to allocate in 3rd chunk (may be zero) . t3 - type of third memory elements . m4 - number of elements to allocate in 4th chunk (may be zero) . t4 - type of fourth memory elements . m5 - number of elements to allocate in 5th chunk (may be zero) . t5 - type of fifth memory elements . m6 - number of elements to allocate in 6th chunk (may be zero) - t6 - type of sixth memory elements Output Parameter: + r1 - memory allocated in first chunk . r2 - memory allocated in second chunk . r3 - memory allocated in third chunk . r4 - memory allocated in fourth chunk . r5 - memory allocated in fifth chunk - r6 - memory allocated in sixth chunk Level: developer .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6() Concepts: memory allocation M*/ #if defined(PETSC_USE_DEBUG) #define PetscMalloc6(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3) || PetscMalloc((m4)*sizeof(t4),r4) || PetscMalloc((m5)*sizeof(t5),r5) || PetscMalloc((m6)*sizeof(t6),r6)) #else #define PetscMalloc6(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6) \ ((*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,*(r6) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5)+(m6)*sizeof(t6)+5*(PETSC_MEMALIGN-1),r1)) \ || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),*(r4) = (t4*)PetscAddrAlign(*(r3)+m3),*(r5) = (t5*)PetscAddrAlign(*(r4)+m4),*(r6) = (t6*)PetscAddrAlign(*(r5)+m5),0)) #endif /*MC PetscMalloc7 - Allocates 7 chunks of memory all aligned to PETSC_MEMALIGN Synopsis: #include "petscsys.h" PetscErrorCode PetscMalloc7(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3,size_t m4,type t4,void **r4,size_t m5,type t5,void **r5,size_t m6,type t6,void **r6,size_t m7,type t7,void **r7) Not Collective Input Parameter: + m1 - number of elements to allocate in 1st chunk (may be zero) . t1 - type of first memory elements . m2 - number of elements to allocate in 2nd chunk (may be zero) . t2 - type of second memory elements . m3 - number of elements to allocate in 3rd chunk (may be zero) . t3 - type of third memory elements . m4 - number of elements to allocate in 4th chunk (may be zero) . t4 - type of fourth memory elements . m5 - number of elements to allocate in 5th chunk (may be zero) . t5 - type of fifth memory elements . m6 - number of elements to allocate in 6th chunk (may be zero) . t6 - type of sixth memory elements . m7 - number of elements to allocate in 7th chunk (may be zero) - t7 - type of sixth memory elements Output Parameter: + r1 - memory allocated in first chunk . r2 - memory allocated in second chunk . r3 - memory allocated in third chunk . r4 - memory allocated in fourth chunk . r5 - memory allocated in fifth chunk . r6 - memory allocated in sixth chunk - r7 - memory allocated in seventh chunk Level: developer .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6(), PetscFree7() Concepts: memory allocation M*/ #if defined(PETSC_USE_DEBUG) #define PetscMalloc7(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6,m7,t7,r7) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3) || PetscMalloc((m4)*sizeof(t4),r4) || PetscMalloc((m5)*sizeof(t5),r5) || PetscMalloc((m6)*sizeof(t6),r6) || PetscMalloc((m7)*sizeof(t7),r7)) #else #define PetscMalloc7(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6,m7,t7,r7) \ ((*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,*(r6) = 0,*(r7) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5)+(m6)*sizeof(t6)+(m7)*sizeof(t7)+6*(PETSC_MEMALIGN-1),r1)) \ || (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),*(r4) = (t4*)PetscAddrAlign(*(r3)+m3),*(r5) = (t5*)PetscAddrAlign(*(r4)+m4),*(r6) = (t6*)PetscAddrAlign(*(r5)+m5),*(r7) = (t7*)PetscAddrAlign(*(r6)+m6),0)) #endif /*MC PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to PETSC_MEMALIGN Synopsis: #include "petscsys.h" PetscErrorCode PetscNew(struct type,((type *))result) Not Collective Input Parameter: . type - structure name of space to be allocated. Memory of size sizeof(type) is allocated Output Parameter: . result - memory allocated Level: beginner .seealso: PetscFree(), PetscMalloc(), PetscNewLog() Concepts: memory allocation M*/ #define PetscNew(A,b) (PetscMalloc(sizeof(A),(b)) || PetscMemzero(*(b),sizeof(A))) /*MC PetscNewLog - Allocates memory of a particular type, zeros the memory! Aligned to PETSC_MEMALIGN. Associates the memory allocated with the given object using PetscLogObjectMemory(). Synopsis: #include "petscsys.h" PetscErrorCode PetscNewLog(PetscObject obj,struct type,((type *))result) Not Collective Input Parameter: + obj - object memory is logged to - type - structure name of space to be allocated. Memory of size sizeof(type) is allocated Output Parameter: . result - memory allocated Level: developer .seealso: PetscFree(), PetscMalloc(), PetscNew(), PetscLogObjectMemory() Concepts: memory allocation M*/ #define PetscNewLog(o,A,b) (PetscNew(A,b) || ((o) ? PetscLogObjectMemory(o,sizeof(A)) : 0)) /*MC PetscFree - Frees memory Synopsis: #include "petscsys.h" PetscErrorCode PetscFree(void *memory) Not Collective Input Parameter: . memory - memory to free (the pointer is ALWAYS set to 0 upon sucess) Level: beginner Notes: Memory must have been obtained with PetscNew() or PetscMalloc() .seealso: PetscNew(), PetscMalloc(), PetscFreeVoid() Concepts: memory allocation M*/ #define PetscFree(a) ((a) && ((*PetscTrFree)((void*)(a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__) || ((a) = 0,0))) /*MC PetscFreeVoid - Frees memory Synopsis: #include "petscsys.h" void PetscFreeVoid(void *memory) Not Collective Input Parameter: . memory - memory to free Level: beginner Notes: This is different from PetscFree() in that no error code is returned .seealso: PetscFree(), PetscNew(), PetscMalloc() Concepts: memory allocation M*/ #define PetscFreeVoid(a) ((*PetscTrFree)((a),__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__),(a) = 0) /*MC PetscFree2 - Frees 2 chunks of memory obtained with PetscMalloc2() Synopsis: #include "petscsys.h" PetscErrorCode PetscFree2(void *memory1,void *memory2) Not Collective Input Parameter: + memory1 - memory to free - memory2 - 2nd memory to free Level: developer Notes: Memory must have been obtained with PetscMalloc2() .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree() Concepts: memory allocation M*/ #if defined(PETSC_USE_DEBUG) #define PetscFree2(m1,m2) (PetscFree(m2) || PetscFree(m1)) #else #define PetscFree2(m1,m2) ((m2)=0, PetscFree(m1)) #endif /*MC PetscFree3 - Frees 3 chunks of memory obtained with PetscMalloc3() Synopsis: #include "petscsys.h" PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3) Not Collective Input Parameter: + memory1 - memory to free . memory2 - 2nd memory to free - memory3 - 3rd memory to free Level: developer Notes: Memory must have been obtained with PetscMalloc3() .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3() Concepts: memory allocation M*/ #if defined(PETSC_USE_DEBUG) #define PetscFree3(m1,m2,m3) (PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) #else #define PetscFree3(m1,m2,m3) ((m3)=0,(m2)=0,PetscFree(m1)) #endif /*MC PetscFree4 - Frees 4 chunks of memory obtained with PetscMalloc4() Synopsis: #include "petscsys.h" PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4) Not Collective Input Parameter: + m1 - memory to free . m2 - 2nd memory to free . m3 - 3rd memory to free - m4 - 4th memory to free Level: developer Notes: Memory must have been obtained with PetscMalloc4() .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4() Concepts: memory allocation M*/ #if defined(PETSC_USE_DEBUG) #define PetscFree4(m1,m2,m3,m4) (PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) #else #define PetscFree4(m1,m2,m3,m4) ((m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) #endif /*MC PetscFree5 - Frees 5 chunks of memory obtained with PetscMalloc5() Synopsis: #include "petscsys.h" PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5) Not Collective Input Parameter: + m1 - memory to free . m2 - 2nd memory to free . m3 - 3rd memory to free . m4 - 4th memory to free - m5 - 5th memory to free Level: developer Notes: Memory must have been obtained with PetscMalloc5() .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5() Concepts: memory allocation M*/ #if defined(PETSC_USE_DEBUG) #define PetscFree5(m1,m2,m3,m4,m5) (PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) #else #define PetscFree5(m1,m2,m3,m4,m5) ((m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) #endif /*MC PetscFree6 - Frees 6 chunks of memory obtained with PetscMalloc6() Synopsis: #include "petscsys.h" PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6) Not Collective Input Parameter: + m1 - memory to free . m2 - 2nd memory to free . m3 - 3rd memory to free . m4 - 4th memory to free . m5 - 5th memory to free - m6 - 6th memory to free Level: developer Notes: Memory must have been obtained with PetscMalloc6() .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6() Concepts: memory allocation M*/ #if defined(PETSC_USE_DEBUG) #define PetscFree6(m1,m2,m3,m4,m5,m6) (PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) #else #define PetscFree6(m1,m2,m3,m4,m5,m6) ((m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) #endif /*MC PetscFree7 - Frees 7 chunks of memory obtained with PetscMalloc7() Synopsis: #include "petscsys.h" PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7) Not Collective Input Parameter: + m1 - memory to free . m2 - 2nd memory to free . m3 - 3rd memory to free . m4 - 4th memory to free . m5 - 5th memory to free . m6 - 6th memory to free - m7 - 7th memory to free Level: developer Notes: Memory must have been obtained with PetscMalloc7() .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(), PetscMalloc7() Concepts: memory allocation M*/ #if defined(PETSC_USE_DEBUG) #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) (PetscFree(m7) || PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1)) #else #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) ((m7)=0,(m6)=0,(m5)=0,(m4)=0,(m3)=0,(m2)=0,PetscFree(m1)) #endif PETSC_EXTERN PetscErrorCode (*PetscTrMalloc)(size_t,int,const char[],const char[],const char[],void**); PETSC_EXTERN PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[],const char[]); PETSC_EXTERN PetscErrorCode PetscMallocSet(PetscErrorCode (*)(size_t,int,const char[],const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[],const char[])); PETSC_EXTERN PetscErrorCode PetscMallocClear(void); /* PetscLogDouble variables are used to contain double precision numbers that are not used in the numerical computations, but rather in logging, timing etc. */ typedef double PetscLogDouble; #define MPIU_PETSCLOGDOUBLE MPI_DOUBLE /* Routines for tracing memory corruption/bleeding with default PETSc memory allocation */ PETSC_EXTERN PetscErrorCode PetscMallocDump(FILE *); PETSC_EXTERN PetscErrorCode PetscMallocDumpLog(FILE *); PETSC_EXTERN PetscErrorCode PetscMallocGetCurrentUsage(PetscLogDouble *); PETSC_EXTERN PetscErrorCode PetscMallocGetMaximumUsage(PetscLogDouble *); PETSC_EXTERN PetscErrorCode PetscMallocDebug(PetscBool); PETSC_EXTERN PetscErrorCode PetscMallocGetDebug(PetscBool*); PETSC_EXTERN PetscErrorCode PetscMallocValidate(int,const char[],const char[],const char[]); PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLog(void); PETSC_EXTERN PetscErrorCode PetscMallocSetDumpLogThreshold(PetscLogDouble); PETSC_EXTERN PetscErrorCode PetscMallocGetDumpLog(PetscBool*); /*E PetscDataType - Used for handling different basic data types. Level: beginner Developer comment: It would be nice if we could always just use MPI Datatypes, why can we not? .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(), PetscDataTypeGetSize() E*/ typedef enum {PETSC_INT = 0,PETSC_DOUBLE = 1,PETSC_COMPLEX = 2, PETSC_LONG = 3 ,PETSC_SHORT = 4,PETSC_FLOAT = 5, PETSC_CHAR = 6,PETSC_BIT_LOGICAL = 7,PETSC_ENUM = 8,PETSC_BOOL=9, PETSC___FLOAT128 = 10,PETSC_OBJECT = 11, PETSC_FUNCTION = 12} PetscDataType; PETSC_EXTERN const char *const PetscDataTypes[]; #if defined(PETSC_USE_COMPLEX) #define PETSC_SCALAR PETSC_COMPLEX #else #if defined(PETSC_USE_REAL_SINGLE) #define PETSC_SCALAR PETSC_FLOAT #elif defined(PETSC_USE_REAL___FLOAT128) #define PETSC_SCALAR PETSC___FLOAT128 #else #define PETSC_SCALAR PETSC_DOUBLE #endif #endif #if defined(PETSC_USE_REAL_SINGLE) #define PETSC_REAL PETSC_FLOAT #elif defined(PETSC_USE_REAL___FLOAT128) #define PETSC_REAL PETSC___FLOAT128 #else #define PETSC_REAL PETSC_DOUBLE #endif #define PETSC_FORTRANADDR PETSC_LONG PETSC_EXTERN PetscErrorCode PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*); PETSC_EXTERN PetscErrorCode PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*); PETSC_EXTERN PetscErrorCode PetscDataTypeGetSize(PetscDataType,size_t*); /* Basic memory and string operations. These are usually simple wrappers around the basic Unix system calls, but a few of them have additional functionality and/or error checking. */ PETSC_EXTERN PetscErrorCode PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType); PETSC_EXTERN PetscErrorCode PetscMemmove(void*,void *,size_t); PETSC_EXTERN PetscErrorCode PetscMemcmp(const void*,const void*,size_t,PetscBool *); PETSC_EXTERN PetscErrorCode PetscStrlen(const char[],size_t*); PETSC_EXTERN PetscErrorCode PetscStrToArray(const char[],char,int*,char ***); PETSC_EXTERN PetscErrorCode PetscStrToArrayDestroy(int,char **); PETSC_EXTERN PetscErrorCode PetscStrcmp(const char[],const char[],PetscBool *); PETSC_EXTERN PetscErrorCode PetscStrgrt(const char[],const char[],PetscBool *); PETSC_EXTERN PetscErrorCode PetscStrcasecmp(const char[],const char[],PetscBool *); PETSC_EXTERN PetscErrorCode PetscStrncmp(const char[],const char[],size_t,PetscBool *); PETSC_EXTERN PetscErrorCode PetscStrcpy(char[],const char[]); PETSC_EXTERN PetscErrorCode PetscStrcat(char[],const char[]); PETSC_EXTERN PetscErrorCode PetscStrncat(char[],const char[],size_t); PETSC_EXTERN PetscErrorCode PetscStrncpy(char[],const char[],size_t); PETSC_EXTERN PetscErrorCode PetscStrchr(const char[],char,char *[]); PETSC_EXTERN PetscErrorCode PetscStrtolower(char[]); PETSC_EXTERN PetscErrorCode PetscStrtoupper(char[]); PETSC_EXTERN PetscErrorCode PetscStrrchr(const char[],char,char *[]); PETSC_EXTERN PetscErrorCode PetscStrstr(const char[],const char[],char *[]); PETSC_EXTERN PetscErrorCode PetscStrrstr(const char[],const char[],char *[]); PETSC_EXTERN PetscErrorCode PetscStrendswith(const char[],const char[],PetscBool*); PETSC_EXTERN PetscErrorCode PetscStrbeginswith(const char[],const char[],PetscBool*); PETSC_EXTERN PetscErrorCode PetscStrendswithwhich(const char[],const char *const*,PetscInt*); PETSC_EXTERN PetscErrorCode PetscStrallocpy(const char[],char *[]); PETSC_EXTERN PetscErrorCode PetscStrArrayallocpy(const char *const*,char***); PETSC_EXTERN PetscErrorCode PetscStrArrayDestroy(char***); PETSC_EXTERN PetscErrorCode PetscStrreplace(MPI_Comm,const char[],char[],size_t); PETSC_EXTERN void PetscStrcmpNoError(const char[],const char[],PetscBool *); /*S PetscToken - 'Token' used for managing tokenizing strings Level: intermediate .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy() S*/ typedef struct _p_PetscToken* PetscToken; PETSC_EXTERN PetscErrorCode PetscTokenCreate(const char[],const char,PetscToken*); PETSC_EXTERN PetscErrorCode PetscTokenFind(PetscToken,char *[]); PETSC_EXTERN PetscErrorCode PetscTokenDestroy(PetscToken*); PETSC_EXTERN PetscErrorCode PetscEListFind(PetscInt,const char *const*,const char*,PetscInt*,PetscBool*); PETSC_EXTERN PetscErrorCode PetscEnumFind(const char *const*,const char*,PetscEnum*,PetscBool*); /* These are MPI operations for MPI_Allreduce() etc */ PETSC_EXTERN MPI_Op PetscMaxSum_Op; #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) PETSC_EXTERN MPI_Op MPIU_SUM; #else #define MPIU_SUM MPI_SUM #endif #if defined(PETSC_USE_REAL___FLOAT128) PETSC_EXTERN MPI_Op MPIU_MAX; PETSC_EXTERN MPI_Op MPIU_MIN; #else #define MPIU_MAX MPI_MAX #define MPIU_MIN MPI_MIN #endif PETSC_EXTERN PetscErrorCode PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*); PETSC_EXTERN PetscErrorCode MPIULong_Send(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm); PETSC_EXTERN PetscErrorCode MPIULong_Recv(void*,PetscInt,MPI_Datatype,PetscMPIInt,PetscMPIInt,MPI_Comm); /*S PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc Level: beginner Note: This is the base class from which all PETSc objects are derived from. .seealso: PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName(), PetscObjectReference(), PetscObjectDereferenc() S*/ typedef struct _p_PetscObject* PetscObject; /*S PetscFunctionList - Linked list of functions, possibly stored in dynamic libraries, accessed by string name Level: advanced .seealso: PetscFunctionListAdd(), PetscFunctionListDestroy(), PetscOpFlist S*/ typedef struct _n_PetscFunctionList *PetscFunctionList; /*E PetscFileMode - Access mode for a file. Level: beginner FILE_MODE_READ - open a file at its beginning for reading FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist) FILE_MODE_APPEND - open a file at end for writing FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end .seealso: PetscViewerFileSetMode() E*/ typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode; extern const char *const PetscFileModes[]; /* Defines PETSc error handling. */ #include #define PETSC_SMALLEST_CLASSID 1211211 PETSC_EXTERN PetscClassId PETSC_LARGEST_CLASSID; PETSC_EXTERN PetscClassId PETSC_OBJECT_CLASSID; PETSC_EXTERN PetscErrorCode PetscClassIdRegister(const char[],PetscClassId *); /* Routines that get memory usage information from the OS */ PETSC_EXTERN PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *); PETSC_EXTERN PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *); PETSC_EXTERN PetscErrorCode PetscMemorySetGetMaximumUsage(void); PETSC_EXTERN PetscErrorCode PetscInfoAllow(PetscBool ,const char []); PETSC_EXTERN PetscErrorCode PetscSleep(PetscReal); /* Initialization of PETSc */ PETSC_EXTERN PetscErrorCode PetscInitialize(int*,char***,const char[],const char[]); PETSC_EXTERN PetscErrorCode PetscInitializeNoPointers(int,char**,const char[],const char[]); PETSC_EXTERN PetscErrorCode PetscInitializeNoArguments(void); PETSC_EXTERN PetscErrorCode PetscInitialized(PetscBool *); PETSC_EXTERN PetscErrorCode PetscFinalized(PetscBool *); PETSC_EXTERN PetscErrorCode PetscFinalize(void); PETSC_EXTERN PetscErrorCode PetscInitializeFortran(void); PETSC_EXTERN PetscErrorCode PetscGetArgs(int*,char ***); PETSC_EXTERN PetscErrorCode PetscGetArguments(char ***); PETSC_EXTERN PetscErrorCode PetscFreeArguments(char **); PETSC_EXTERN PetscErrorCode PetscEnd(void); PETSC_EXTERN PetscErrorCode PetscSysInitializePackage(void); PETSC_EXTERN MPI_Comm PETSC_COMM_LOCAL_WORLD; PETSC_EXTERN PetscErrorCode PetscHMPIMerge(PetscMPIInt,PetscErrorCode (*)(void*),void*); PETSC_EXTERN PetscErrorCode PetscHMPISpawn(PetscMPIInt); PETSC_EXTERN PetscErrorCode PetscHMPIFinalize(void); PETSC_EXTERN PetscErrorCode PetscHMPIRun(MPI_Comm,PetscErrorCode (*)(MPI_Comm,void *),void*); PETSC_EXTERN PetscErrorCode PetscHMPIRunCtx(MPI_Comm,PetscErrorCode (*)(MPI_Comm,void*,void *),void*); PETSC_EXTERN PetscErrorCode PetscHMPIFree(MPI_Comm,void*); PETSC_EXTERN PetscErrorCode PetscHMPIMalloc(MPI_Comm,size_t,void**); PETSC_EXTERN PetscErrorCode PetscPythonInitialize(const char[],const char[]); PETSC_EXTERN PetscErrorCode PetscPythonFinalize(void); PETSC_EXTERN PetscErrorCode PetscPythonPrintError(void); PETSC_EXTERN PetscErrorCode PetscPythonMonitorSet(PetscObject,const char[]); /* These are so that in extern C code we can caste function pointers to non-extern C function pointers. Since the regular C++ code expects its function pointers to be C++ */ PETSC_EXTERN_TYPEDEF typedef void (**PetscVoidStarFunction)(void); PETSC_EXTERN_TYPEDEF typedef void (*PetscVoidFunction)(void); PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*PetscErrorCodeFunction)(void); /* Functions that can act on any PETSc object. */ PETSC_EXTERN PetscErrorCode PetscObjectDestroy(PetscObject*); PETSC_EXTERN PetscErrorCode PetscObjectGetComm(PetscObject,MPI_Comm *); PETSC_EXTERN PetscErrorCode PetscObjectGetClassId(PetscObject,PetscClassId *); PETSC_EXTERN PetscErrorCode PetscObjectGetClassName(PetscObject,const char *[]); PETSC_EXTERN PetscErrorCode PetscObjectSetType(PetscObject,const char []); PETSC_EXTERN PetscErrorCode PetscObjectSetPrecision(PetscObject,PetscPrecision); PETSC_EXTERN PetscErrorCode PetscObjectGetType(PetscObject,const char *[]); PETSC_EXTERN PetscErrorCode PetscObjectSetName(PetscObject,const char[]); PETSC_EXTERN PetscErrorCode PetscObjectGetName(PetscObject,const char*[]); PETSC_EXTERN PetscErrorCode PetscObjectSetTabLevel(PetscObject,PetscInt); PETSC_EXTERN PetscErrorCode PetscObjectGetTabLevel(PetscObject,PetscInt*); PETSC_EXTERN PetscErrorCode PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt); PETSC_EXTERN PetscErrorCode PetscObjectReference(PetscObject); PETSC_EXTERN PetscErrorCode PetscObjectGetReference(PetscObject,PetscInt*); PETSC_EXTERN PetscErrorCode PetscObjectDereference(PetscObject); PETSC_EXTERN PetscErrorCode PetscObjectGetNewTag(PetscObject,PetscMPIInt *); PETSC_EXTERN PetscErrorCode PetscObjectCompose(PetscObject,const char[],PetscObject); PETSC_EXTERN PetscErrorCode PetscObjectRemoveReference(PetscObject,const char[]); PETSC_EXTERN PetscErrorCode PetscObjectQuery(PetscObject,const char[],PetscObject *); PETSC_EXTERN PetscErrorCode PetscObjectComposeFunction_Private(PetscObject,const char[],void (*)(void)); #define PetscObjectComposeFunction(a,b,d) PetscObjectComposeFunction_Private(a,b,(PetscVoidFunction)(d)) PETSC_EXTERN PetscErrorCode PetscObjectSetFromOptions(PetscObject); PETSC_EXTERN PetscErrorCode PetscObjectSetUp(PetscObject); PETSC_EXTERN PetscErrorCode PetscCommGetNewTag(MPI_Comm,PetscMPIInt *); PETSC_EXTERN PetscErrorCode PetscObjectAddOptionsHandler(PetscObject,PetscErrorCode (*)(PetscObject,void*),PetscErrorCode (*)(PetscObject,void*),void*); PETSC_EXTERN PetscErrorCode PetscObjectProcessOptionsHandlers(PetscObject); PETSC_EXTERN PetscErrorCode PetscObjectDestroyOptionsHandlers(PetscObject); PETSC_EXTERN PetscErrorCode PetscObjectsGetGlobalNumbering(MPI_Comm,PetscInt,PetscObject*,PetscInt*,PetscInt*); #include #include PETSC_EXTERN PetscErrorCode PetscMemoryShowUsage(PetscViewer,const char[]); PETSC_EXTERN PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject,PetscViewer); PETSC_EXTERN PetscErrorCode PetscObjectView(PetscObject,PetscViewer); #define PetscObjectQueryFunction(obj,name,fptr) PetscObjectQueryFunction_Private((obj),(name),(PetscVoidFunction*)(fptr)) PETSC_EXTERN PetscErrorCode PetscObjectQueryFunction_Private(PetscObject,const char[],void (**)(void)); PETSC_EXTERN PetscErrorCode PetscObjectSetOptionsPrefix(PetscObject,const char[]); PETSC_EXTERN PetscErrorCode PetscObjectAppendOptionsPrefix(PetscObject,const char[]); PETSC_EXTERN PetscErrorCode PetscObjectPrependOptionsPrefix(PetscObject,const char[]); PETSC_EXTERN PetscErrorCode PetscObjectGetOptionsPrefix(PetscObject,const char*[]); PETSC_EXTERN PetscErrorCode PetscObjectChangeTypeName(PetscObject,const char[]); PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroy(PetscObject); PETSC_EXTERN PetscErrorCode PetscObjectRegisterDestroyAll(void); PETSC_EXTERN PetscErrorCode PetscObjectName(PetscObject); PETSC_EXTERN PetscErrorCode PetscObjectTypeCompare(PetscObject,const char[],PetscBool *); PETSC_EXTERN PetscErrorCode PetscObjectTypeCompareAny(PetscObject,PetscBool*,const char[],...); PETSC_EXTERN PetscErrorCode PetscRegisterFinalize(PetscErrorCode (*)(void)); PETSC_EXTERN PetscErrorCode PetscRegisterFinalizeAll(void); #if defined(PETSC_HAVE_AMS) PETSC_EXTERN PetscErrorCode PetscObjectAMSViewOff(PetscObject); PETSC_EXTERN PetscErrorCode PetscObjectAMSSetBlock(PetscObject,PetscBool); PETSC_EXTERN PetscErrorCode PetscObjectAMSBlock(PetscObject); PETSC_EXTERN PetscErrorCode PetscObjectAMSGrantAccess(PetscObject); PETSC_EXTERN PetscErrorCode PetscObjectAMSTakeAccess(PetscObject); PETSC_EXTERN void PetscStackAMSGrantAccess(void); PETSC_EXTERN void PetscStackAMSTakeAccess(void); PETSC_EXTERN PetscErrorCode PetscStackViewAMS(void); PETSC_EXTERN PetscErrorCode PetscStackAMSViewOff(void); #else #define PetscObjectAMSViewOff(obj) 0 #define PetscObjectAMSSetBlock(obj,flg) 0 #define PetscObjectAMSBlock(obj) 0 #define PetscObjectAMSGrantAccess(obj) 0 #define PetscObjectAMSTakeAccess(obj) 0 #define PetscStackViewAMS() 0 #define PetscStackAMSViewOff() 0 #define PetscStackAMSTakeAccess() #define PetscStackAMSGrantAccess() #endif typedef void* PetscDLHandle; typedef enum {PETSC_DL_DECIDE=0,PETSC_DL_NOW=1,PETSC_DL_LOCAL=2} PetscDLMode; PETSC_EXTERN PetscErrorCode PetscDLOpen(const char[],PetscDLMode,PetscDLHandle *); PETSC_EXTERN PetscErrorCode PetscDLClose(PetscDLHandle *); PETSC_EXTERN PetscErrorCode PetscDLSym(PetscDLHandle,const char[],void **); #if defined(PETSC_USE_DEBUG) PETSC_EXTERN PetscErrorCode PetscMallocGetStack(void*,PetscStack**); #endif PETSC_EXTERN PetscErrorCode PetscObjectsDump(FILE*,PetscBool); /*S PetscObjectList - Linked list of PETSc objects, each accessable by string name Level: developer Notes: Used by PetscObjectCompose() and PetscObjectQuery() .seealso: PetscObjectListAdd(), PetscObjectListDestroy(), PetscObjectListFind(), PetscObjectCompose(), PetscObjectQuery(), PetscFunctionList S*/ typedef struct _n_PetscObjectList *PetscObjectList; PETSC_EXTERN PetscErrorCode PetscObjectListDestroy(PetscObjectList*); PETSC_EXTERN PetscErrorCode PetscObjectListFind(PetscObjectList,const char[],PetscObject*); PETSC_EXTERN PetscErrorCode PetscObjectListReverseFind(PetscObjectList,PetscObject,char**,PetscBool*); PETSC_EXTERN PetscErrorCode PetscObjectListAdd(PetscObjectList *,const char[],PetscObject); PETSC_EXTERN PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *,const char[]); PETSC_EXTERN PetscErrorCode PetscObjectListDuplicate(PetscObjectList,PetscObjectList *); /* Dynamic library lists. Lists of names of routines in objects or in dynamic link libraries that will be loaded as needed. */ #define PetscFunctionListAdd(list,name,fptr) PetscFunctionListAdd_Private((list),(name),(PetscVoidFunction)(fptr)) PETSC_EXTERN PetscErrorCode PetscFunctionListAdd_Private(PetscFunctionList*,const char[],void (*)(void)); PETSC_EXTERN PetscErrorCode PetscFunctionListDestroy(PetscFunctionList*); #define PetscFunctionListFind(list,name,fptr) PetscFunctionListFind_Private((list),(name),(PetscVoidFunction*)(fptr)) PETSC_EXTERN PetscErrorCode PetscFunctionListFind_Private(PetscFunctionList,const char[],void (**)(void)); PETSC_EXTERN PetscErrorCode PetscFunctionListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFunctionList,const char[]); PETSC_EXTERN PetscErrorCode PetscFunctionListDuplicate(PetscFunctionList,PetscFunctionList *); PETSC_EXTERN PetscErrorCode PetscFunctionListView(PetscFunctionList,PetscViewer); PETSC_EXTERN PetscErrorCode PetscFunctionListGet(PetscFunctionList,const char ***,int*); /*S PetscDLLibrary - Linked list of dynamics libraries to search for functions Level: advanced --with-shared-libraries --with-dynamic-loading must be used with ./configure to use dynamic libraries .seealso: PetscDLLibraryOpen() S*/ typedef struct _n_PetscDLLibrary *PetscDLLibrary; PETSC_EXTERN PetscDLLibrary PetscDLLibrariesLoaded; PETSC_EXTERN PetscErrorCode PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]); PETSC_EXTERN PetscErrorCode PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]); PETSC_EXTERN PetscErrorCode PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **); PETSC_EXTERN PetscErrorCode PetscDLLibraryPrintPath(PetscDLLibrary); PETSC_EXTERN PetscErrorCode PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscBool *); PETSC_EXTERN PetscErrorCode PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *); PETSC_EXTERN PetscErrorCode PetscDLLibraryClose(PetscDLLibrary); /* Useful utility routines */ PETSC_EXTERN PetscErrorCode PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*); PETSC_EXTERN PetscErrorCode PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*); PETSC_EXTERN PetscErrorCode PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt); PETSC_EXTERN PetscErrorCode PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt); PETSC_EXTERN PetscErrorCode PetscBarrier(PetscObject); PETSC_EXTERN PetscErrorCode PetscMPIDump(FILE*); /* PetscNot - negates a logical type value and returns result as a PetscBool Notes: This is useful in cases like $ int *a; $ PetscBool flag = PetscNot(a) where !a does not return a PetscBool because we cannot provide a cast from int to PetscBool in C. */ #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE) #if defined(PETSC_HAVE_VALGRIND) # include # define PETSC_RUNNING_ON_VALGRIND RUNNING_ON_VALGRIND #else # define PETSC_RUNNING_ON_VALGRIND PETSC_FALSE #endif /*MC PetscHelpPrintf - Prints help messages. Synopsis: #include "petscsys.h" PetscErrorCode (*PetscHelpPrintf)(const char format[],...); Not Collective Input Parameters: . format - the usual printf() format string Level: developer Fortran Note: This routine is not supported in Fortran. Concepts: help messages^printing Concepts: printing^help messages .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf() M*/ PETSC_EXTERN PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...); /* Defines PETSc profiling. */ #include /* Simple PETSc parallel IO for ASCII printing */ PETSC_EXTERN PetscErrorCode PetscFixFilename(const char[],char[]); PETSC_EXTERN PetscErrorCode PetscFOpen(MPI_Comm,const char[],const char[],FILE**); PETSC_EXTERN PetscErrorCode PetscFClose(MPI_Comm,FILE*); PETSC_EXTERN PetscErrorCode PetscFPrintf(MPI_Comm,FILE*,const char[],...); PETSC_EXTERN PetscErrorCode PetscPrintf(MPI_Comm,const char[],...); PETSC_EXTERN PetscErrorCode PetscSNPrintf(char*,size_t,const char [],...); PETSC_EXTERN PetscErrorCode PetscSNPrintfCount(char*,size_t,const char [],size_t*,...); /* These are used internally by PETSc ASCII IO routines*/ #include PETSC_EXTERN PetscErrorCode PetscVSNPrintf(char*,size_t,const char[],size_t*,va_list); PETSC_EXTERN PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list); PETSC_EXTERN PetscErrorCode PetscVFPrintfDefault(FILE*,const char[],va_list); #if defined(PETSC_HAVE_MATLAB_ENGINE) PETSC_EXTERN PetscErrorCode PetscVFPrintf_Matlab(FILE*,const char[],va_list); #endif PETSC_EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...); PETSC_EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...); PETSC_EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...); #if defined(PETSC_HAVE_POPEN) PETSC_EXTERN PetscErrorCode PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **); PETSC_EXTERN PetscErrorCode PetscPClose(MPI_Comm,FILE*,int*); #endif PETSC_EXTERN PetscErrorCode PetscSynchronizedPrintf(MPI_Comm,const char[],...); PETSC_EXTERN PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...); PETSC_EXTERN PetscErrorCode PetscSynchronizedFlush(MPI_Comm); PETSC_EXTERN PetscErrorCode PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]); PETSC_EXTERN PetscErrorCode PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**); PETSC_EXTERN PetscErrorCode PetscStartJava(MPI_Comm,const char[],const char[],FILE**); PETSC_EXTERN PetscErrorCode PetscGetPetscDir(const char*[]); PETSC_EXTERN PetscErrorCode PetscPopUpSelect(MPI_Comm,const char*,const char*,int,const char**,int*); /*S PetscContainer - Simple PETSc object that contains a pointer to any required data Level: advanced .seealso: PetscObject, PetscContainerCreate() S*/ PETSC_EXTERN PetscClassId PETSC_CONTAINER_CLASSID; typedef struct _p_PetscContainer* PetscContainer; PETSC_EXTERN PetscErrorCode PetscContainerGetPointer(PetscContainer,void **); PETSC_EXTERN PetscErrorCode PetscContainerSetPointer(PetscContainer,void *); PETSC_EXTERN PetscErrorCode PetscContainerDestroy(PetscContainer*); PETSC_EXTERN PetscErrorCode PetscContainerCreate(MPI_Comm,PetscContainer *); PETSC_EXTERN PetscErrorCode PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void*)); /* For use in debuggers */ PETSC_EXTERN PetscMPIInt PetscGlobalRank; PETSC_EXTERN PetscMPIInt PetscGlobalSize; PETSC_EXTERN PetscErrorCode PetscIntView(PetscInt,const PetscInt[],PetscViewer); PETSC_EXTERN PetscErrorCode PetscRealView(PetscInt,const PetscReal[],PetscViewer); PETSC_EXTERN PetscErrorCode PetscScalarView(PetscInt,const PetscScalar[],PetscViewer); #include #if defined(PETSC_HAVE_MEMORY_H) #include #endif #if defined(PETSC_HAVE_STDLIB_H) #include #endif #if defined(PETSC_HAVE_XMMINTRIN_H) && !defined(__CUDACC__) #include #endif #if defined(PETSC_HAVE_STDINT_H) #include #endif #undef __FUNCT__ #define __FUNCT__ "PetscMemcpy" /*@C PetscMemcpy - Copies n bytes, beginning at location b, to the space beginning at location a. The two memory regions CANNOT overlap, use PetscMemmove() in that case. Not Collective Input Parameters: + b - pointer to initial memory space - n - length (in bytes) of space to copy Output Parameter: . a - pointer to copy space Level: intermediate Compile Option: PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used for memory copies on double precision values. PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used for memory copies on double precision values. PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used for memory copies on double precision values. Note: This routine is analogous to memcpy(). Developer Note: this is inlined for fastest performance Concepts: memory^copying Concepts: copying^memory .seealso: PetscMemmove() @*/ PETSC_STATIC_INLINE PetscErrorCode PetscMemcpy(void *a,const void *b,size_t n) { #if defined(PETSC_USE_DEBUG) unsigned long al = (unsigned long) a,bl = (unsigned long) b; unsigned long nl = (unsigned long) n; PetscFunctionBegin; if (n > 0 && !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer"); if (n > 0 && !a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer"); #else PetscFunctionBegin; #endif if (a != b) { #if defined(PETSC_USE_DEBUG) if ((al > bl && (al - bl) < nl) || (bl - al) < nl) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Memory regions overlap: either use PetscMemmov()\n\ or make sure your copy regions and lengths are correct. \n\ Length (bytes) %ld first address %ld second address %ld",nl,al,bl); #endif #if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY)) if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { size_t len = n/sizeof(PetscScalar); #if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) PetscBLASInt one = 1,blen; PetscErrorCode ierr; ierr = PetscBLASIntCast(len,&blen);CHKERRQ(ierr); PetscStackCallBLAS("BLAScopy",BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one)); #elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY) fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a); #else size_t i; PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a; for (i=0; i 0) { #if defined(PETSC_USE_DEBUG) if (!a) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer"); #endif #if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) { size_t i,len = n/sizeof(PetscScalar); PetscScalar *x = (PetscScalar*)a; for (i=0; i PetscComplex number = 1. + 2.*PETSC_i; Level: beginner Note: Complex numbers are automatically available if PETSc was configured --with-scalar-type=complex (in which case PetscComplex will match PetscScalar), otherwise the macro PETSC_DESIRE_COMPLEX must be defined before including any PETSc headers. If the compiler supports complex numbers, PetscComplex and associated variables and functions will be defined and PETSC_HAVE_COMPLEX will be set. .seealso: PetscReal, PetscComplex, MPIU_COMPLEX, PetscInt, PETSC_i M*/ /*MC PetscReal - PETSc type that represents a real number version of PetscScalar Level: beginner .seealso: PetscScalar, PassiveReal, PassiveScalar M*/ /*MC PassiveScalar - PETSc type that represents a PetscScalar Level: beginner This is the same as a PetscScalar except in code that is automatically differentiated it is treated as a constant (not an indendent or dependent variable) .seealso: PetscReal, PassiveReal, PetscScalar M*/ /*MC PassiveReal - PETSc type that represents a PetscReal Level: beginner This is the same as a PetscReal except in code that is automatically differentiated it is treated as a constant (not an indendent or dependent variable) .seealso: PetscScalar, PetscReal, PassiveScalar M*/ /*MC MPIU_SCALAR - MPI datatype corresponding to PetscScalar Level: beginner Note: In MPI calls that require an MPI datatype that matches a PetscScalar or array of PetscScalars pass this value .seealso: PetscReal, PassiveReal, PassiveScalar, PetscScalar, MPIU_INT M*/ #if defined(PETSC_HAVE_MPIIO) #if !defined(PETSC_WORDS_BIGENDIAN) PETSC_EXTERN PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); PETSC_EXTERN PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*); #else #define MPIU_File_write_all(a,b,c,d,e) MPI_File_write_all(a,b,c,d,e) #define MPIU_File_read_all(a,b,c,d,e) MPI_File_read_all(a,b,c,d,e) #endif #endif /* the following petsc_static_inline require petscerror.h */ /* Limit MPI to 32-bits */ #define PETSC_MPI_INT_MAX 2147483647 #define PETSC_MPI_INT_MIN -2147483647 /* Limit BLAS to 32-bits */ #define PETSC_BLAS_INT_MAX 2147483647 #define PETSC_BLAS_INT_MIN -2147483647 #undef __FUNCT__ #define __FUNCT__ "PetscBLASIntCast" PETSC_STATIC_INLINE PetscErrorCode PetscBLASIntCast(PetscInt a,PetscBLASInt *b) { PetscFunctionBegin; #if defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_HAVE_64BIT_BLAS_INDICES) if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK"); #endif *b = (PetscBLASInt)(a); PetscFunctionReturn(0); } #undef __FUNCT__ #define __FUNCT__ "PetscMPIIntCast" PETSC_STATIC_INLINE PetscErrorCode PetscMPIIntCast(PetscInt a,PetscMPIInt *b) { PetscFunctionBegin; #if defined(PETSC_USE_64BIT_INDICES) if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for MPI"); #endif *b = (PetscMPIInt)(a); PetscFunctionReturn(0); } /* The IBM include files define hz, here we hide it so that it may be used as a regular user variable. */ #if defined(hz) #undef hz #endif /* For arrays that contain filenames or paths */ #if defined(PETSC_HAVE_LIMITS_H) #include #endif #if defined(PETSC_HAVE_SYS_PARAM_H) #include #endif #if defined(PETSC_HAVE_SYS_TYPES_H) #include #endif #if defined(MAXPATHLEN) # define PETSC_MAX_PATH_LEN MAXPATHLEN #elif defined(MAX_PATH) # define PETSC_MAX_PATH_LEN MAX_PATH #elif defined(_MAX_PATH) # define PETSC_MAX_PATH_LEN _MAX_PATH #else # define PETSC_MAX_PATH_LEN 4096 #endif /* Special support for C++ */ #if defined(PETSC_CLANGUAGE_CXX) && defined(__cplusplus) #include #endif /*MC UsingFortran - Fortran can be used with PETSc in four distinct approaches $ 1) classic Fortran 77 style $#include "finclude/petscXXX.h" to work with material from the XXX component of PETSc $ XXX variablename $ You cannot use this approach if you wish to use the Fortran 90 specific PETSc routines $ which end in F90; such as VecGetArrayF90() $ $ 2) classic Fortran 90 style $#include "finclude/petscXXX.h" $#include "finclude/petscXXX.h90" to work with material from the XXX component of PETSc $ XXX variablename $ $ 3) Using Fortran modules $#include "finclude/petscXXXdef.h" $ use petscXXXX $ XXX variablename $ $ 4) Use Fortran modules and Fortran data types for PETSc types $#include "finclude/petscXXXdef.h" $ use petscXXXX $ type(XXX) variablename $ To use this approach you must ./configure PETSc with the additional $ option --with-fortran-datatypes You cannot use the type(XXX) declaration approach without using Fortran modules Finally if you absolutely do not want to use any #include you can use either $ 3a) skip the #include BUT you cannot use any PETSc data type names like Vec, Mat, PetscInt, PetscErrorCode etc $ and you must declare the variables as integer, for example $ integer variablename $ $ 4a) skip the #include, you use the object types like type(Vec) type(Mat) but cannot use the data type $ names like PetscErrorCode, PetscInt etc. again for those you must use integer We recommend either 2 or 3. Approaches 2 and 3 provide type checking for most PETSc function calls; 4 has type checking for only a few PETSc functions. Fortran type checking with interfaces is strick, this means you cannot pass a scalar value when an array value is expected (even though it is legal Fortran). For example when setting a single value in a matrix with MatSetValues() you cannot have something like $ PetscInt row,col $ PetscScalar val $ ... $ call MatSetValues(mat,1,row,1,col,val,INSERT_VALUES,ierr) You must instead have $ PetscInt row(1),col(1) $ PetscScalar val(1) $ ... $ call MatSetValues(mat,1,row,1,col,val,INSERT_VALUES,ierr) See the example src/vec/vec/examples/tutorials/ex20f90.F90 for an example that can use all four approaches Developer Notes: The finclude/petscXXXdef.h contain all the #defines (would be typedefs in C code) these automatically include their predecessors; for example finclude/petscvecdef.h includes finclude/petscisdef.h The finclude/petscXXXX.h contain all the parameter statements for that package. These automatically include their finclude/petscXXXdef.h file but DO NOT automatically include their predecessors; for example finclude/petscvec.h does NOT automatically include finclude/petscis.h The finclude/ftn-custom/petscXXXdef.h90 are not intended to be used directly in code, they define the Fortran data type type(XXX) (for example type(Vec)) when PETSc is ./configure with the --with-fortran-datatypes option. The finclude/ftn-custom/petscXXX.h90 (not included directly by code) contain interface definitions for the PETSc Fortran stubs that have different bindings then their C version (for example VecGetArrayF90). The finclude/ftn-auto/petscXXX.h90 (not included directly by code) contain interface definitions generated automatically by "make allfortranstubs". The finclude/petscXXX.h90 includes the custom finclude/ftn-custom/petscXXX.h90 and if ./configure was run with --with-fortran-interfaces it also includes the finclude/ftn-auto/petscXXX.h90 These DO NOT automatically include their predecessors Level: beginner M*/ PETSC_EXTERN PetscErrorCode PetscGetArchType(char[],size_t); PETSC_EXTERN PetscErrorCode PetscGetHostName(char[],size_t); PETSC_EXTERN PetscErrorCode PetscGetUserName(char[],size_t); PETSC_EXTERN PetscErrorCode PetscGetProgramName(char[],size_t); PETSC_EXTERN PetscErrorCode PetscSetProgramName(const char[]); PETSC_EXTERN PetscErrorCode PetscGetDate(char[],size_t); PETSC_EXTERN PetscErrorCode PetscGetVersion(char[], size_t); PETSC_EXTERN PetscErrorCode PetscSortInt(PetscInt,PetscInt[]); PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsInt(PetscInt*,PetscInt[]); PETSC_EXTERN PetscErrorCode PetscFindInt(PetscInt, PetscInt, const PetscInt[], PetscInt*); PETSC_EXTERN PetscErrorCode PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]); PETSC_EXTERN PetscErrorCode PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]); PETSC_EXTERN PetscErrorCode PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]); PETSC_EXTERN PetscErrorCode PetscSortIntWithArrayPair(PetscInt,PetscInt*,PetscInt*,PetscInt*); PETSC_EXTERN PetscErrorCode PetscSortMPIInt(PetscInt,PetscMPIInt[]); PETSC_EXTERN PetscErrorCode PetscSortRemoveDupsMPIInt(PetscInt*,PetscMPIInt[]); PETSC_EXTERN PetscErrorCode PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]); PETSC_EXTERN PetscErrorCode PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]); PETSC_EXTERN PetscErrorCode PetscSortReal(PetscInt,PetscReal[]); PETSC_EXTERN PetscErrorCode PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]); PETSC_EXTERN PetscErrorCode PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]); PETSC_EXTERN PetscErrorCode PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]); PETSC_EXTERN PetscErrorCode PetscProcessTree(PetscInt,const PetscBool [],const PetscInt[],PetscInt*,PetscInt**,PetscInt**,PetscInt**,PetscInt**); PETSC_EXTERN PetscErrorCode PetscMergeIntArrayPair(PetscInt,const PetscInt*,const PetscInt*,PetscInt,const PetscInt*,const PetscInt*,PetscInt*,PetscInt**,PetscInt**); PETSC_EXTERN PetscErrorCode PetscSetDisplay(void); PETSC_EXTERN PetscErrorCode PetscGetDisplay(char[],size_t); /*J PetscRandomType - String with the name of a PETSc randomizer Level: beginner Notes: to use the SPRNG you must have ./configure PETSc with the option --download-sprng .seealso: PetscRandomSetType(), PetscRandom, PetscRandomCreate() J*/ typedef const char* PetscRandomType; #define PETSCRAND "rand" #define PETSCRAND48 "rand48" #define PETSCSPRNG "sprng" /* Logging support */ PETSC_EXTERN PetscClassId PETSC_RANDOM_CLASSID; PETSC_EXTERN PetscErrorCode PetscRandomInitializePackage(void); /*S PetscRandom - Abstract PETSc object that manages generating random numbers Level: intermediate Concepts: random numbers .seealso: PetscRandomCreate(), PetscRandomGetValue(), PetscRandomType S*/ typedef struct _p_PetscRandom* PetscRandom; /* Dynamic creation and loading functions */ PETSC_EXTERN PetscFunctionList PetscRandomList; PETSC_EXTERN PetscBool PetscRandomRegisterAllCalled; PETSC_EXTERN PetscErrorCode PetscRandomRegisterAll(void); PETSC_EXTERN PetscErrorCode PetscRandomRegister(const char[],PetscErrorCode (*)(PetscRandom)); PETSC_EXTERN PetscErrorCode PetscRandomSetType(PetscRandom, PetscRandomType); PETSC_EXTERN PetscErrorCode PetscRandomSetFromOptions(PetscRandom); PETSC_EXTERN PetscErrorCode PetscRandomGetType(PetscRandom, PetscRandomType*); PETSC_EXTERN PetscErrorCode PetscRandomViewFromOptions(PetscRandom,const char[],const char[]); PETSC_EXTERN PetscErrorCode PetscRandomView(PetscRandom,PetscViewer); PETSC_EXTERN PetscErrorCode PetscRandomCreate(MPI_Comm,PetscRandom*); PETSC_EXTERN PetscErrorCode PetscRandomGetValue(PetscRandom,PetscScalar*); PETSC_EXTERN PetscErrorCode PetscRandomGetValueReal(PetscRandom,PetscReal*); PETSC_EXTERN PetscErrorCode PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*); PETSC_EXTERN PetscErrorCode PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar); PETSC_EXTERN PetscErrorCode PetscRandomSetSeed(PetscRandom,unsigned long); PETSC_EXTERN PetscErrorCode PetscRandomGetSeed(PetscRandom,unsigned long *); PETSC_EXTERN PetscErrorCode PetscRandomSeed(PetscRandom); PETSC_EXTERN PetscErrorCode PetscRandomDestroy(PetscRandom*); PETSC_EXTERN PetscErrorCode PetscGetFullPath(const char[],char[],size_t); PETSC_EXTERN PetscErrorCode PetscGetRelativePath(const char[],char[],size_t); PETSC_EXTERN PetscErrorCode PetscGetWorkingDirectory(char[],size_t); PETSC_EXTERN PetscErrorCode PetscGetRealPath(const char[],char[]); PETSC_EXTERN PetscErrorCode PetscGetHomeDirectory(char[],size_t); PETSC_EXTERN PetscErrorCode PetscTestFile(const char[],char,PetscBool *); PETSC_EXTERN PetscErrorCode PetscTestDirectory(const char[],char,PetscBool *); PETSC_EXTERN PetscErrorCode PetscBinaryRead(int,void*,PetscInt,PetscDataType); PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscDataType); PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm,int,void*,PetscInt,PetscDataType,PetscBool ); PETSC_EXTERN PetscErrorCode PetscBinaryWrite(int,void*,PetscInt,PetscDataType,PetscBool ); PETSC_EXTERN PetscErrorCode PetscBinaryOpen(const char[],PetscFileMode,int *); PETSC_EXTERN PetscErrorCode PetscBinaryClose(int); PETSC_EXTERN PetscErrorCode PetscSharedTmp(MPI_Comm,PetscBool *); PETSC_EXTERN PetscErrorCode PetscSharedWorkingDirectory(MPI_Comm,PetscBool *); PETSC_EXTERN PetscErrorCode PetscGetTmp(MPI_Comm,char[],size_t); PETSC_EXTERN PetscErrorCode PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscBool *); PETSC_EXTERN PetscErrorCode PetscLs(MPI_Comm,const char[],char[],size_t,PetscBool *); PETSC_EXTERN PetscErrorCode PetscOpenSocket(const char[],int,int*); PETSC_EXTERN PetscErrorCode PetscWebServe(MPI_Comm,int); /* In binary files variables are stored using the following lengths, regardless of how they are stored in memory on any one particular machine. Use these rather then sizeof() in computing sizes for PetscBinarySeek(). */ #define PETSC_BINARY_INT_SIZE (32/8) #define PETSC_BINARY_FLOAT_SIZE (32/8) #define PETSC_BINARY_CHAR_SIZE (8/8) #define PETSC_BINARY_SHORT_SIZE (16/8) #define PETSC_BINARY_DOUBLE_SIZE (64/8) #define PETSC_BINARY_SCALAR_SIZE sizeof(PetscScalar) /*E PetscBinarySeekType - argument to PetscBinarySeek() Level: advanced .seealso: PetscBinarySeek(), PetscBinarySynchronizedSeek() E*/ typedef enum {PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1,PETSC_BINARY_SEEK_END = 2} PetscBinarySeekType; PETSC_EXTERN PetscErrorCode PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*); PETSC_EXTERN PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*); PETSC_EXTERN PetscErrorCode PetscByteSwap(void *,PetscDataType,PetscInt); PETSC_EXTERN PetscErrorCode PetscSetDebugTerminal(const char[]); PETSC_EXTERN PetscErrorCode PetscSetDebugger(const char[],PetscBool ); PETSC_EXTERN PetscErrorCode PetscSetDefaultDebugger(void); PETSC_EXTERN PetscErrorCode PetscSetDebuggerFromString(const char*); PETSC_EXTERN PetscErrorCode PetscAttachDebugger(void); PETSC_EXTERN PetscErrorCode PetscStopForDebugger(void); PETSC_EXTERN PetscErrorCode PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*); PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**); PETSC_EXTERN PetscErrorCode PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**); PETSC_EXTERN PetscErrorCode PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**); PETSC_EXTERN PetscErrorCode PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**); PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSided(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscInt,const PetscMPIInt*,const void*,PetscInt*,PetscMPIInt**,void*) PetscAttrMPIPointerWithType(6,3); /*E PetscBuildTwoSidedType - algorithm for setting up two-sided communication $ PETSC_BUILDTWOSIDED_ALLREDUCE - classical algorithm using an MPI_Allreduce with $ a buffer of length equal to the communicator size. Not memory-scalable due to $ the large reduction size. Requires only MPI-1. $ PETSC_BUILDTWOSIDED_IBARRIER - nonblocking algorithm based on MPI_Issend and MPI_Ibarrier. $ Proved communication-optimal in Hoefler, Siebert, and Lumsdaine (2010). Requires MPI-3. Level: developer .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedSetType(), PetscCommBuildTwoSidedGetType() E*/ typedef enum { PETSC_BUILDTWOSIDED_NOTSET = -1, PETSC_BUILDTWOSIDED_ALLREDUCE = 0, PETSC_BUILDTWOSIDED_IBARRIER = 1 /* Updates here must be accompanied by updates in finclude/petscsys.h and the string array in mpits.c */ } PetscBuildTwoSidedType; PETSC_EXTERN const char *const PetscBuildTwoSidedTypes[]; PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm,PetscBuildTwoSidedType); PETSC_EXTERN PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm,PetscBuildTwoSidedType*); PETSC_EXTERN PetscErrorCode PetscSSEIsEnabled(MPI_Comm,PetscBool *,PetscBool *); /*E InsertMode - Whether entries are inserted or added into vectors or matrices Level: beginner .seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd() E*/ typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES, INSERT_ALL_VALUES, ADD_ALL_VALUES, INSERT_BC_VALUES, ADD_BC_VALUES} InsertMode; /*MC INSERT_VALUES - Put a value into a vector or matrix, overwrites any previous value Level: beginner .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), ADD_VALUES, MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES M*/ /*MC ADD_VALUES - Adds a value into a vector or matrix, if there previously was no value, just puts the value into that location Level: beginner .seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(), VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), INSERT_VALUES, MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES M*/ /*MC MAX_VALUES - Puts the maximum of the scattered/gathered value and the current value into each location Level: beginner .seealso: InsertMode, VecScatterBegin(), VecScatterEnd(), ADD_VALUES, INSERT_VALUES M*/ PETSC_EXTERN MPI_Comm PetscObjectComm(PetscObject); /*S PetscSubcomm - Context of MPI subcommunicators, used by PCREDUNDANT Level: advanced Concepts: communicator, create S*/ typedef struct _n_PetscSubcomm* PetscSubcomm; struct _n_PetscSubcomm { MPI_Comm parent; /* parent communicator */ MPI_Comm dupparent; /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */ MPI_Comm comm; /* this communicator */ PetscInt n; /* num of subcommunicators under the parent communicator */ PetscInt color; /* color of processors belong to this communicator */ PetscInt *subsize; /* size of subcommunicator[color] */ PetscInt type; }; typedef enum {PETSC_SUBCOMM_GENERAL=0,PETSC_SUBCOMM_CONTIGUOUS=1,PETSC_SUBCOMM_INTERLACED=2} PetscSubcommType; PETSC_EXTERN const char *const PetscSubcommTypes[]; PETSC_EXTERN PetscErrorCode PetscSubcommCreate(MPI_Comm,PetscSubcomm*); PETSC_EXTERN PetscErrorCode PetscSubcommDestroy(PetscSubcomm*); PETSC_EXTERN PetscErrorCode PetscSubcommSetNumber(PetscSubcomm,PetscInt); PETSC_EXTERN PetscErrorCode PetscSubcommSetType(PetscSubcomm,PetscSubcommType); PETSC_EXTERN PetscErrorCode PetscSubcommSetTypeGeneral(PetscSubcomm,PetscMPIInt,PetscMPIInt); PETSC_EXTERN PetscErrorCode PetscSubcommView(PetscSubcomm,PetscViewer); PETSC_EXTERN PetscErrorCode PetscSubcommSetFromOptions(PetscSubcomm); /*S PetscSegBuffer - a segmented extendable buffer Level: developer .seealso: PetscSegBufferCreate(), PetscSegBufferGet(), PetscSegBufferExtract(), PetscSegBufferDestroy() S*/ typedef struct _n_PetscSegBuffer *PetscSegBuffer; PETSC_EXTERN PetscErrorCode PetscSegBufferCreate(size_t,size_t,PetscSegBuffer*); PETSC_EXTERN PetscErrorCode PetscSegBufferDestroy(PetscSegBuffer*); PETSC_EXTERN PetscErrorCode PetscSegBufferGet(PetscSegBuffer,size_t,void*); PETSC_EXTERN PetscErrorCode PetscSegBufferExtractAlloc(PetscSegBuffer,void*); PETSC_EXTERN PetscErrorCode PetscSegBufferExtractTo(PetscSegBuffer,void*); PETSC_EXTERN PetscErrorCode PetscSegBufferExtractInPlace(PetscSegBuffer,void*); PETSC_EXTERN PetscErrorCode PetscSegBufferGetSize(PetscSegBuffer,size_t*); PETSC_EXTERN PetscErrorCode PetscSegBufferUnuse(PetscSegBuffer,size_t); /* Type-safe wrapper to encourage use of PETSC_RESTRICT. Does not use PetscFunctionBegin because the error handling * prevents the compiler from completely erasing the stub. This is called in inner loops so it has to be as fast as * possible. */ PETSC_STATIC_INLINE PetscErrorCode PetscSegBufferGetInts(PetscSegBuffer seg,PetscInt count,PetscInt *PETSC_RESTRICT *slot) {return PetscSegBufferGet(seg,count,(void**)slot);} extern PetscSegBuffer PetscCitationsList; #undef __FUNCT__ #define __FUNCT__ "PetscCitationsRegister" /*@C PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used in the code. Not Collective - only what is registered on rank 0 of PETSC_COMM_WORLD will be printed Input Parameters: + cite - the bibtex item, formated to displayed on multiple lines nicely - set - a boolean variable initially set to PETSC_FALSE; this is used to insure only a single registration of the citation Options Database: . -citations [filenmae] - print out the bibtex entries for the given computation @*/ PETSC_STATIC_INLINE PetscErrorCode PetscCitationsRegister(const char cit[],PetscBool *set) { size_t len; char *vstring; PetscErrorCode ierr; PetscFunctionBegin; if (set && *set) PetscFunctionReturn(0); ierr = PetscStrlen(cit,&len);CHKERRQ(ierr); ierr = PetscSegBufferGet(PetscCitationsList,(PetscInt)len,&vstring);CHKERRQ(ierr); ierr = PetscMemcpy(vstring,cit,len);CHKERRQ(ierr); if (set) *set = PETSC_TRUE; PetscFunctionReturn(0); } /* Reset __FUNCT__ in case the user does not define it themselves */ #undef __FUNCT__ #define __FUNCT__ "User provided function" #endif