Lines Matching +full:check +full:- +full:each +full:- +full:commit
10 …PeOP - indicates an argument to a PETSc function is optional and one can pass `NULL` instead. This…
22 Put this in the function declaration in front of each variable that is optional
32 …PeNS - indicates a function that does not use the PETSc standard arguments which make it easy to g…
42 Shortened form of PETSc non-standard
49 …PeNSS - indicates a function that needs a special treatment in the C-side stub when generating the…
58 …lly but not the C stub, which should be added manually under the appropriate `ftn-custom` directory
61 Shortened form of PETSc non-standard stub
70 found automatically by the compiler due to the -I${PETSC_DIR}/${PETSC_ARCH}/include that
72 For --prefix installs the directory ${PETSC_ARCH} does not exist and petscconf.h is in the same
85 Feature test macros must be included before headers defined by IEEE Std 1003.1-2001
131 …* an extra include path -I/something (which contains the unexpected mpi.h) is being passed to the …
136 …#error "PETSc was configured with --with-mpi=0 but now appears to be compiling using a different m…
140 #error "PETSc was configured with I_MPI but now appears to be compiling using a non-I_MPI mpi.h"
146 …#error "PETSc was configured with MVAPICH2 but now appears to be compiling using a non-MVAPICH2 mp…
152 #error "PETSc was configured with MPICH but now appears to be compiling using a non-MPICH mpi.h"
160 …#error "PETSc was configured with Open MPI but now appears to be compiling using a non-Open MPI mp…
168 #error "PETSc was configured with MSMPI but now appears to be compiling using a non-MSMPI mpi.h"
173 …r "PETSc was configured with undetermined MPI - but now appears to be compiling using any of Open …
182 /* MSMPI on 32-bit Microsoft Windows requires this yukky hack - that breaks MPI standard compliance…
191 …MPIU_INT - Portable MPI datatype corresponding to `PetscInt` independent of the precision of `Pets…
210 …MPIU_COUNT - Portable MPI datatype corresponding to `PetscCount` independent of the precision of `…
260 PETSC_IGNORE - same as `NULL`, means PETSc will ignore this argument
276 …PETSC_UNLIMITED - standard way of passing an integer or floating point parameter to indicate PETSc…
293 …PETSC_DECIDE - standard way of passing an integer or floating point parameter to indicate PETSc sh…
311 …PETSC_DETERMINE - standard way of passing an integer or floating point parameter to indicate PETSc…
335 …PETSC_CURRENT - standard way of indicating to an object not to change the current value of the par…
349 PETSC_DEFAULT - deprecated, see `PETSC_CURRENT` and `PETSC_DETERMINE`
363 /* These MUST be preprocessor defines! see https://gitlab.com/petsc/petsc/-/issues/1370 */
364 #define PETSC_DECIDE (-1)
366 #define PETSC_CURRENT (-2)
367 #define PETSC_UNLIMITED (-3)
372 …PETSC_COMM_WORLD - the equivalent of the `MPI_COMM_WORLD` communicator which represents all the pr…
390 PETSC_COMM_SELF - This is always `MPI_COMM_SELF`
402 …PETSC_MPI_THREAD_REQUIRED - the required threading support used if PETSc initializes MPI with `MPI…
416 …PetscBeganMPI - indicates if PETSc initialized MPI using `MPI_Init()` during `PetscInitialize()` o…
461 …PetscMalloc - Allocates memory for use with PETSc. One should use `PetscNew()`, `PetscMalloc1()` o…
470 . m - number of bytes to allocate
473 . result - memory allocated
494 PetscRealloc - Reallocates memory
503 + m - number of bytes to allocate
504 - result - previous memory
507 . result - new memory allocated
521 PetscAddrAlign - Rounds up an address to `PETSC_MEMALIGN` alignment
530 . addr - address to align (any pointer type)
536 …tscAddrAlign(a) ((void *)((((PETSC_UINTPTR_T)(a)) + (PETSC_MEMALIGN - 1)) & ~(PETSC_MEMALIGN - 1)))
539 …PetscCalloc - Allocates a cleared (zeroed) memory region aligned to `PETSC_MEMALIGN`, similar to `…
548 . m - number of bytes to allocate
551 . result - memory allocated
570 PetscMalloc1 - Allocates an array of memory aligned to `PETSC_MEMALIGN`
579 . m1 - number of elements to allocate (may be zero)
582 . r1 - memory allocated
602 32bit `int` computation - while computation in 64bit `size_t` would not overflow!
603 …It's best if any arithmetic that is done for size computations is done with `size_t` type - avoidi…
605 …`PetscMalloc[N]()` and `PetscCalloc[N]()` attempt to work-around this by casting the first variabl…
610 … a is cast to size_t, but b * b is performed at PetscInt precision first due to order-of-operations
617 …PetscMalloc1(b * b + a, &id); // b is automatically cast to size_t and order-of-operations ensures…
625 PetscCalloc1 - Allocates a cleared (zeroed) array of memory aligned to `PETSC_MEMALIGN`
634 . m1 - number of elements to allocate in 1st chunk (may be zero)
637 . r1 - memory allocated
649 PetscMalloc2 - Allocates 2 arrays of memory both aligned to `PETSC_MEMALIGN`
658 + m1 - number of elements to allocate in 1st chunk (may be zero)
659 - m2 - number of elements to allocate in 2nd chunk (may be zero)
662 + r1 - memory allocated in first chunk
663 - r2 - memory allocated in second chunk
672 PetscCalloc2 - Allocates 2 cleared (zeroed) arrays of memory both aligned to `PETSC_MEMALIGN`
681 + m1 - number of elements to allocate in 1st chunk (may be zero)
682 - m2 - number of elements to allocate in 2nd chunk (may be zero)
685 + r1 - memory allocated in first chunk
686 - r2 - memory allocated in second chunk
695 PetscMalloc3 - Allocates 3 arrays of memory, all aligned to `PETSC_MEMALIGN`
704 + m1 - number of elements to allocate in 1st chunk (may be zero)
705 . m2 - number of elements to allocate in 2nd chunk (may be zero)
706 - m3 - number of elements to allocate in 3rd chunk (may be zero)
709 + r1 - memory allocated in first chunk
710 . r2 - memory allocated in second chunk
711 - r3 - memory allocated in third chunk
721 PetscCalloc3 - Allocates 3 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN`
730 + m1 - number of elements to allocate in 1st chunk (may be zero)
731 . m2 - number of elements to allocate in 2nd chunk (may be zero)
732 - m3 - number of elements to allocate in 3rd chunk (may be zero)
735 + r1 - memory allocated in first chunk
736 . r2 - memory allocated in second chunk
737 - r3 - memory allocated in third chunk
747 PetscMalloc4 - Allocates 4 arrays of memory, all aligned to `PETSC_MEMALIGN`
756 + m1 - number of elements to allocate in 1st chunk (may be zero)
757 . m2 - number of elements to allocate in 2nd chunk (may be zero)
758 . m3 - number of elements to allocate in 3rd chunk (may be zero)
759 - m4 - number of elements to allocate in 4th chunk (may be zero)
762 + r1 - memory allocated in first chunk
763 . r2 - memory allocated in second chunk
764 . r3 - memory allocated in third chunk
765 - r4 - memory allocated in fourth chunk
775 PetscCalloc4 - Allocates 4 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN`
784 + m1 - number of elements to allocate in 1st chunk (may be zero)
785 . m2 - number of elements to allocate in 2nd chunk (may be zero)
786 . m3 - number of elements to allocate in 3rd chunk (may be zero)
787 - m4 - number of elements to allocate in 4th chunk (may be zero)
790 + r1 - memory allocated in first chunk
791 . r2 - memory allocated in second chunk
792 . r3 - memory allocated in third chunk
793 - r4 - memory allocated in fourth chunk
803 PetscMalloc5 - Allocates 5 arrays of memory, all aligned to `PETSC_MEMALIGN`
812 + m1 - number of elements to allocate in 1st chunk (may be zero)
813 . m2 - number of elements to allocate in 2nd chunk (may be zero)
814 . m3 - number of elements to allocate in 3rd chunk (may be zero)
815 . m4 - number of elements to allocate in 4th chunk (may be zero)
816 - m5 - number of elements to allocate in 5th chunk (may be zero)
819 + r1 - memory allocated in first chunk
820 . r2 - memory allocated in second chunk
821 . r3 - memory allocated in third chunk
822 . r4 - memory allocated in fourth chunk
823 - r5 - memory allocated in fifth chunk
833 PetscCalloc5 - Allocates 5 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN`
842 + m1 - number of elements to allocate in 1st chunk (may be zero)
843 . m2 - number of elements to allocate in 2nd chunk (may be zero)
844 . m3 - number of elements to allocate in 3rd chunk (may be zero)
845 . m4 - number of elements to allocate in 4th chunk (may be zero)
846 - m5 - number of elements to allocate in 5th chunk (may be zero)
849 + r1 - memory allocated in first chunk
850 . r2 - memory allocated in second chunk
851 . r3 - memory allocated in third chunk
852 . r4 - memory allocated in fourth chunk
853 - r5 - memory allocated in fifth chunk
863 PetscMalloc6 - Allocates 6 arrays of memory, all aligned to `PETSC_MEMALIGN`
872 + m1 - number of elements to allocate in 1st chunk (may be zero)
873 . m2 - number of elements to allocate in 2nd chunk (may be zero)
874 . m3 - number of elements to allocate in 3rd chunk (may be zero)
875 . m4 - number of elements to allocate in 4th chunk (may be zero)
876 . m5 - number of elements to allocate in 5th chunk (may be zero)
877 - m6 - number of elements to allocate in 6th chunk (may be zero)
880 + r1 - memory allocated in first chunk
881 . r2 - memory allocated in second chunk
882 . r3 - memory allocated in third chunk
883 . r4 - memory allocated in fourth chunk
884 . r5 - memory allocated in fifth chunk
885 - r6 - memory allocated in sixth chunk
895 PetscCalloc6 - Allocates 6 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN`
904 + m1 - number of elements to allocate in 1st chunk (may be zero)
905 . m2 - number of elements to allocate in 2nd chunk (may be zero)
906 . m3 - number of elements to allocate in 3rd chunk (may be zero)
907 . m4 - number of elements to allocate in 4th chunk (may be zero)
908 . m5 - number of elements to allocate in 5th chunk (may be zero)
909 - m6 - number of elements to allocate in 6th chunk (may be zero)
912 + r1 - memory allocated in first chunk
913 . r2 - memory allocated in second chunk
914 . r3 - memory allocated in third chunk
915 . r4 - memory allocated in fourth chunk
916 . r5 - memory allocated in fifth chunk
917 - r6 - memory allocated in sixth chunk
927 PetscMalloc7 - Allocates 7 arrays of memory, all aligned to `PETSC_MEMALIGN`
936 + m1 - number of elements to allocate in 1st chunk (may be zero)
937 . m2 - number of elements to allocate in 2nd chunk (may be zero)
938 . m3 - number of elements to allocate in 3rd chunk (may be zero)
939 . m4 - number of elements to allocate in 4th chunk (may be zero)
940 . m5 - number of elements to allocate in 5th chunk (may be zero)
941 . m6 - number of elements to allocate in 6th chunk (may be zero)
942 - m7 - number of elements to allocate in 7th chunk (may be zero)
945 + r1 - memory allocated in first chunk
946 . r2 - memory allocated in second chunk
947 . r3 - memory allocated in third chunk
948 . r4 - memory allocated in fourth chunk
949 . r5 - memory allocated in fifth chunk
950 . r6 - memory allocated in sixth chunk
951 - r7 - memory allocated in seventh chunk
961 PetscCalloc7 - Allocates 7 cleared (zeroed) arrays of memory, all aligned to `PETSC_MEMALIGN`
970 + m1 - number of elements to allocate in 1st chunk (may be zero)
971 . m2 - number of elements to allocate in 2nd chunk (may be zero)
972 . m3 - number of elements to allocate in 3rd chunk (may be zero)
973 . m4 - number of elements to allocate in 4th chunk (may be zero)
974 . m5 - number of elements to allocate in 5th chunk (may be zero)
975 . m6 - number of elements to allocate in 6th chunk (may be zero)
976 - m7 - number of elements to allocate in 7th chunk (may be zero)
979 + r1 - memory allocated in first chunk
980 . r2 - memory allocated in second chunk
981 . r3 - memory allocated in third chunk
982 . r4 - memory allocated in fourth chunk
983 . r5 - memory allocated in fifth chunk
984 . r6 - memory allocated in sixth chunk
985 - r7 - memory allocated in seventh chunk
995 PetscNew - Allocates memory of a particular type, zeros the memory! Aligned to `PETSC_MEMALIGN`
1004 . result - memory allocated, sized to match pointer `type`
1018 PetscFree - Frees memory
1027 . memory - memory to free (the pointer is ALWAYS set to `NULL` upon success)
1041 PetscFree2 - Frees 2 chunks of memory obtained with `PetscMalloc2()`
1050 + memory1 - memory to free
1051 - memory2 - 2nd memory to free
1065 PetscFree3 - Frees 3 chunks of memory obtained with `PetscMalloc3()`
1074 + memory1 - memory to free
1075 . memory2 - 2nd memory to free
1076 - memory3 - 3rd memory to free
1090 PetscFree4 - Frees 4 chunks of memory obtained with `PetscMalloc4()`
1099 + m1 - memory to free
1100 . m2 - 2nd memory to free
1101 . m3 - 3rd memory to free
1102 - m4 - 4th memory to free
1116 PetscFree5 - Frees 5 chunks of memory obtained with `PetscMalloc5()`
1125 + m1 - memory to free
1126 . m2 - 2nd memory to free
1127 . m3 - 3rd memory to free
1128 . m4 - 4th memory to free
1129 - m5 - 5th memory to free
1143 PetscFree6 - Frees 6 chunks of memory obtained with `PetscMalloc6()`
1152 + m1 - memory to free
1153 . m2 - 2nd memory to free
1154 . m3 - 3rd memory to free
1155 . m4 - 4th memory to free
1156 . m5 - 5th memory to free
1157 - m6 - 6th memory to free
1171 PetscFree7 - Frees 7 chunks of memory obtained with `PetscMalloc7()`
1180 + m1 - memory to free
1181 . m2 - 2nd memory to free
1182 . m3 - 3rd memory to free
1183 . m4 - 4th memory to free
1184 . m5 - 5th memory to free
1185 . m6 - 6th memory to free
1186 - m7 - 7th memory to free
1266 MPIU_SUM___FP16___FLOAT128 - MPI_Op that acts as a replacement for `MPI_SUM` with
1280 These are so that in extern C code we can cast function pointers to non-extern C
1285 PetscVoidFn - A prototype of a `void fn(void)` function
1307 …PetscErrorCodeFn - a function typedef that represents abstractly a function that returns a PETSc e…
1412 …PetscObjectParameterSetDefault - sets a parameter default value in a `PetscObject` to a new defaul…
1422 + obj - the `PetscObject`
1423 . NAME - the name of the parameter, unquoted
1424 - value - the new value
1439 if (obj->NAME == obj->default_##NAME) obj->NAME = value; \
1440 obj->default_##NAME = value; \
1444 …PetscObjectParameterDeclare - declares a parameter in a `PetscObject` and a location to store its …
1453 + type - the type of the parameter, for example `PetscInt`
1454 - NAME - the name of the parameter, unquoted
1464 PetscCtx - indicates an argument that can be a pointer to any C struct (or Fortran derived type).
1488 …PetscCtxRt - indicates an argument that returns a pointer to a C struct (or Fortran derived type) …
1545 …PetscCtxDestroyFn - A prototype of a `PetscErrorCode (*)(PetscCtxRt)` function that is used to fre…
1688 PetscNot - negates a logical type value and returns result as a `PetscBool`
1705 PetscHelpPrintf - Prints help messages.
1714 + comm - the MPI communicator over which the help message is printed
1715 . format - the usual printf() format string
1716 - args - arguments to be printed
1815 PetscPrefetchBlock - Prefetches a block of memory
1824 + a - pointer to first element to fetch (any type but usually `PetscInt` or `PetscScalar`)
1825 . n - number of elements to fetch
1826 . rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors)
1827 - t - temporal locality (PETSC_PREFETCH_HINT_{NTA,T0,T1,T2}), see note
1832 The last two arguments (`rw` and `t`) must be compile-time constants.
1834 …Adopting Intel's x86/x86-64 conventions, there are four levels of temporal locality. Not all arch…
1836 + `PETSC_PREFETCH_HINT_NTA` - Non-temporal. Prefetches directly to L1, evicts to memory (skips hi…
1837 . `PETSC_PREFETCH_HINT_T0` - Fetch to all levels of cache and evict to the closest level. Use th…
1838 . `PETSC_PREFETCH_HINT_T1` - Fetch to level 2 and higher (not L1).
1839 - `PETSC_PREFETCH_HINT_T2` - Fetch to high-level cache only. (On many systems, T0 and T1 are equ…
1855 is faster than the C/C++ versions. The flag --with-fortran-kernels
1922 MPI_Comm - the basic object used by MPI to determine which processes are involved in a
1928 This manual page is a place-holder because MPICH does not have a manual page for `MPI_Comm`
1949 …PetscIntCast - casts a `MPI_Count`, `PetscInt64`, `PetscCount`, or `size_t` to a `PetscInt` (which…
1955 . a - the `PetscInt64` value
1958 . b - the resulting `PetscInt` value, or `NULL` if the result is not needed
1963 …ations are too large to fit in 32-bit ints you can ./configure using `--with-64-bit-indices` to ma…
1971 …t64_FMT " is too big for PetscInt, you may need to ./configure using --with-64-bit-indices", (Pets… in PetscIntCast()
1977 …PetscBLASIntCast - casts a `MPI_Count`, `PetscInt`, `PetscCount` or `PetscInt64` to a `PetscBLASIn…
1983 . a - the `PetscInt` value
1986 . b - the resulting `PetscBLASInt` value, or `NULL` if the result is not needed
1999 …icted to 32-bit integers. Either you have an invalidly large integer error in your code or you mus… in PetscBLASIntCast()
2006 PetscCuBLASIntCast - like `PetscBLASIntCast()`, but for `PetscCuBLASInt`.
2011 . a - the `PetscInt` value
2014 . b - the resulting `PetscCuBLASInt` value, or `NULL` if the result is not needed
2027 …RANGE, "%" PetscInt64_FMT " is too big for cuBLAS, which is restricted to 32-bit integers.", (Pets… in PetscCuBLASIntCast()
2034 PetscHipBLASIntCast - like `PetscBLASIntCast()`, but for `PetscHipBLASInt`.
2039 . a - the `PetscInt` value
2042 . b - the resulting `PetscHipBLASInt` value, or `NULL` if the result is not needed
2055 …ANGE, "%" PetscInt64_FMT " is too big for hipBLAS, which is restricted to 32-bit integers.", (Pets… in PetscHipBLASIntCast()
2062 …PetscMPIIntCast - casts a `MPI_Count`, `PetscInt`, `PetscCount`, or `PetscInt64` to a `PetscMPIInt…
2068 . a - the `PetscInt` value
2071 . b - the resulting `PetscMPIInt` value, or `NULL` if the result is not needed
2087 …PetscCIntCast - casts a `MPI_Count`, `PetscInt`, `PetscCount`, or `PetscInt64` to a `int`, generat…
2092 . a - the `PetscInt` value
2095 . b - the resulting `int` value, or `NULL` if the result is not needed
2111 PetscInt64Mult - Computes the product of two variables after casting them to `PetscInt64`.
2116 + a - the first variable
2117 - b - the second variable
2130 PetscRealIntMultTruncate - Computes the product of a positive `PetscReal` and a positive
2136 + a - The `PetscReal` value
2137 - b - The `PetscInt` value
2157 workspace is index-able.
2164 if (r > PETSC_INT_MAX - 100) r = PETSC_INT_MAX - 100; in PetscRealIntMultTruncate()
2173 …PetscIntMultTruncate - Computes the product of two positive `PetscInt` and truncates the value to …
2178 + a - the `PetscInt` value
2179 - b - the second value
2196 …ed where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2204 if (r > PETSC_INT_MAX - 100) r = PETSC_INT_MAX - 100; in PetscIntMultTruncate()
2213 …PetscIntSumTruncate - Computes the sum of two positive `PetscInt` and truncates the value to sligh…
2218 + a - the `PetscInt` value
2219 - b - the second value
2234 …ed where we compute approximate sizes for workspace and need to insure the workspace is index-able.
2243 if (r > PETSC_INT_MAX - 100) r = PETSC_INT_MAX - 100; in PetscIntSumTruncate()
2252 …PetscIntMultError - Computes the product of two positive `PetscInt` and generates an error with ov…
2257 + a - the `PetscInt` value
2258 - b - the second value
2261 . result - the result as a `PetscInt` value, or `NULL` if you do not want the result, you just wan…
2272 `PetscIntSumError()` can be used to check for this situation.
2287 … large integer error in your code or you must ./configure PETSc with --with-64-bit-indices for the… in PetscIntMultError()
2294 …PetscIntSumError - Computes the sum of two positive `PetscInt` and generates an error with overflo…
2299 + a - the `PetscInt` value
2300 - b - the second value
2303 . c - the result as a `PetscInt` value, or `NULL` if you do not want the result, you just want to…
2308 … Use `PetscInt64Mult()` to compute the product of two 32-bit `PetscInt` and store in a `PetscInt64`
2326 … large integer error in your code or you must ./configure PETSc with --with-64-bit-indices for the… in PetscIntSumError()
2344 …PETSC_VERSION - This manual page provides information about how PETSc documents and uses its versi…
2364 `PETSC_VERSION_GIT` is the last git commit to the repository given in the form vx.y.z-wwwww
2366 `PETSC_VERSION_DATE_GIT` is the date of the last git commit to the repository
2437 PetscRandomType - String with the name of a PETSc randomizer
2443 …with the option `--download-sprng` or `--download-random123`. We recommend the default provided wi…
2496 PetscBinaryBigEndian - indicates if values in memory are stored with big endian format
2565 MPI_Comm child; /* the sub-communicator */
2575 return scomm->parent; in PetscSubcommParent()
2579 return scomm->child; in PetscSubcommChild()
2583 return scomm->dupparent; in PetscSubcommContiguousParent()
2630 PetscSegBufferGetInts - access an array of `PetscInt` from a `PetscSegBuffer`
2639 + seg - `PetscSegBuffer` buffer
2640 - count - number of entries needed
2643 . buf - address of new buffer for contiguous data
2648 …Type-safe wrapper to encourage use of PETSC_RESTRICT. Does not use PetscFunctionBegin because the …
2671 …PetscCitationsRegister - Register a bibtex item to obtain credit for an implemented algorithm used…
2676 + cite - the bibtex item, formatted to displayed on multiple lines nicely
2677 - set - a boolean variable initially set to `PETSC_FALSE`; this is used to insure only a single …
2680 . -citations [filename] - print out the bibtex entries for the given computation
2821 /* on 32 bit systems MPI_Count maybe 64-bit while PetscCount is 32-bit */
2853 …U_Scatterv - A replacement for `MPI_Scatterv()` that can be called with `PetscInt` types when PETS…
2862 + sendbuf - address of send buffer
2863 . sendcounts - non-negative `PetscInt` array (of length `comm` group size) specifying the number of…
2864 . displs - `PetscInt` array (of length `comm` group size). Entry i specifies the displacement (…
2865 . sendtype - data type of `sendbuf` elements
2866 . recvcount - number of elements in `recvbuf` (non-negative integer)
2867 . recvtype - data type of `recvbuf` elements
2868 . root - Rank of the MPI root process, which will dispatch the data to scatter
2869 - comm - `MPI_Comm` communicator
2872 . recvbuf - the resulting scattered values on this MPI process
2908 …MPIU_Allreduce - A replacement for `MPI_Allreduce()` that (1) performs single-count `MPIU_INT` ope…
2920 + a - pointer to the input data to be reduced
2921 . count - the number of MPI data items in `a` and `b`
2922 . dtype - the MPI datatype, for example `MPI_INT`
2923 . op - the MPI operation, for example `MPI_SUM`
2924 - comm - the MPI communicator on which the operation occurs
2927 . b - the reduced values
2981 PetscSafePointerPlusOffset - Checks that a pointer is not `NULL` before applying an offset
2986 This is needed to avoid errors with undefined-behavior sanitizers such as
2987 …UBSan, assuming PETSc has been configured with `-fsanitize=undefined` as part of the compiler flags