Actual source code: petscmat.h
1: /*
2: Include file for the matrix component of PETSc
3: */
4: #pragma once
6: #include <petscvec.h>
8: /* SUBMANSEC = Mat */
10: /*S
11: Mat - Abstract PETSc matrix object used to manage all linear operators in PETSc, even those without
12: an explicit sparse representation (such as matrix-free operators). Also used to hold representations of graphs
13: for graph operations such as coloring, `MatColoringCreate()`
15: Level: beginner
17: Note:
18: See [](doc_matrix), [](ch_matrices) and `MatType` for available matrix types
20: .seealso: [](doc_matrix), [](ch_matrices), `MatCreate()`, `MatType`, `MatSetType()`, `MatDestroy()`
21: S*/
22: typedef struct _p_Mat *Mat;
24: /*J
25: MatType - String with the name of a PETSc matrix type. These are all the matrix formats that PETSc provides.
27: Level: beginner
29: Notes:
30: [](doc_matrix) for a table of available matrix types
32: Use `MatSetType()` or the options database keys `-mat_type` or `-dm_mat_type` to set the matrix format to use for a given `Mat`
34: .seealso: [](doc_matrix), [](ch_matrices), `MatSetType()`, `Mat`, `MatSolverType`, `MatRegister()`
35: J*/
36: typedef const char *MatType;
37: #define MATSAME "same"
38: #define MATMAIJ "maij"
39: #define MATSEQMAIJ "seqmaij"
40: #define MATMPIMAIJ "mpimaij"
41: #define MATKAIJ "kaij"
42: #define MATSEQKAIJ "seqkaij"
43: #define MATMPIKAIJ "mpikaij"
44: #define MATIS "is"
45: #define MATAIJ "aij"
46: #define MATSEQAIJ "seqaij"
47: #define MATMPIAIJ "mpiaij"
48: #define MATAIJCRL "aijcrl"
49: #define MATSEQAIJCRL "seqaijcrl"
50: #define MATMPIAIJCRL "mpiaijcrl"
51: #define MATAIJCUSPARSE "aijcusparse"
52: #define MATSEQAIJCUSPARSE "seqaijcusparse"
53: #define MATMPIAIJCUSPARSE "mpiaijcusparse"
54: #define MATAIJHIPSPARSE "aijhipsparse"
55: #define MATSEQAIJHIPSPARSE "seqaijhipsparse"
56: #define MATMPIAIJHIPSPARSE "mpiaijhipsparse"
57: #define MATAIJKOKKOS "aijkokkos"
58: #define MATSEQAIJKOKKOS "seqaijkokkos"
59: #define MATMPIAIJKOKKOS "mpiaijkokkos"
60: #define MATAIJVIENNACL "aijviennacl"
61: #define MATSEQAIJVIENNACL "seqaijviennacl"
62: #define MATMPIAIJVIENNACL "mpiaijviennacl"
63: #define MATAIJPERM "aijperm"
64: #define MATSEQAIJPERM "seqaijperm"
65: #define MATMPIAIJPERM "mpiaijperm"
66: #define MATAIJSELL "aijsell"
67: #define MATSEQAIJSELL "seqaijsell"
68: #define MATMPIAIJSELL "mpiaijsell"
69: #define MATAIJMKL "aijmkl"
70: #define MATSEQAIJMKL "seqaijmkl"
71: #define MATMPIAIJMKL "mpiaijmkl"
72: #define MATBAIJMKL "baijmkl"
73: #define MATSEQBAIJMKL "seqbaijmkl"
74: #define MATMPIBAIJMKL "mpibaijmkl"
75: #define MATSHELL "shell"
76: #define MATCENTERING "centering"
77: #define MATDENSE "dense"
78: #define MATDENSECUDA "densecuda"
79: #define MATDENSEHIP "densehip"
80: #define MATSEQDENSE "seqdense"
81: #define MATSEQDENSECUDA "seqdensecuda"
82: #define MATSEQDENSEHIP "seqdensehip"
83: #define MATMPIDENSE "mpidense"
84: #define MATMPIDENSECUDA "mpidensecuda"
85: #define MATMPIDENSEHIP "mpidensehip"
86: #define MATELEMENTAL "elemental"
87: #define MATSCALAPACK "scalapack"
88: #define MATBAIJ "baij"
89: #define MATSEQBAIJ "seqbaij"
90: #define MATMPIBAIJ "mpibaij"
91: #define MATMPIADJ "mpiadj"
92: #define MATSBAIJ "sbaij"
93: #define MATSEQSBAIJ "seqsbaij"
94: #define MATMPISBAIJ "mpisbaij"
95: #define MATMFFD "mffd"
96: #define MATNORMAL "normal"
97: #define MATNORMALHERMITIAN "normalh"
98: #define MATLRC "lrc"
99: #define MATSCATTER "scatter"
100: #define MATBLOCKMAT "blockmat"
101: #define MATCOMPOSITE "composite"
102: #define MATFFT "fft"
103: #define MATFFTW "fftw"
104: #define MATSEQCUFFT "seqcufft"
105: #define MATSEQHIPFFT "seqhipfft"
106: #define MATTRANSPOSEMAT PETSC_DEPRECATED_MACRO(3, 18, 0, "MATTRANSPOSEVIRTUAL", ) "transpose"
107: #define MATTRANSPOSEVIRTUAL "transpose"
108: #define MATHERMITIANTRANSPOSEVIRTUAL "hermitiantranspose"
109: #define MATSCHURCOMPLEMENT "schurcomplement"
110: #define MATPYTHON "python"
111: #define MATHYPRE "hypre"
112: #define MATHYPRESTRUCT "hyprestruct"
113: #define MATHYPRESSTRUCT "hypresstruct"
114: #define MATSUBMATRIX "submatrix"
115: #define MATLOCALREF "localref"
116: #define MATNEST "nest"
117: #define MATPREALLOCATOR "preallocator"
118: #define MATSELL "sell"
119: #define MATSEQSELL "seqsell"
120: #define MATMPISELL "mpisell"
121: #define MATSELLCUDA "sellcuda"
122: #define MATSEQSELLCUDA "seqsellcuda"
123: #define MATMPISELLCUDA "mpisellcuda"
124: #define MATSELLHIP "sellhip"
125: #define MATSEQSELLHIP "seqsellhip"
126: #define MATMPISELLHIP "mpisellhip"
127: #define MATDUMMY "dummy"
128: #define MATLMVM "lmvm"
129: #define MATLMVMDFP "lmvmdfp"
130: #define MATLMVMDDFP "lmvmddfp"
131: #define MATLMVMBFGS "lmvmbfgs"
132: #define MATLMVMDBFGS "lmvmdbfgs"
133: #define MATLMVMDQN "lmvmdqn"
134: #define MATLMVMSR1 "lmvmsr1"
135: #define MATLMVMBROYDEN "lmvmbroyden"
136: #define MATLMVMBADBROYDEN "lmvmbadbroyden"
137: #define MATLMVMSYMBROYDEN "lmvmsymbroyden"
138: #define MATLMVMSYMBADBROYDEN "lmvmsymbadbroyden"
139: #define MATLMVMDIAGBROYDEN "lmvmdiagbroyden"
140: #define MATCONSTANTDIAGONAL "constantdiagonal"
141: #define MATDIAGONAL "diagonal"
142: #define MATHTOOL "htool"
143: #define MATH2OPUS "h2opus"
145: /*J
146: MatSolverType - String with the name of a PETSc factorization-based matrix solver type.
148: For example: "petsc" indicates what PETSc provides, "superlu_dist" the parallel SuperLU_DIST package etc
150: Level: beginner
152: Note:
153: `MATSOLVERUMFPACK`, `MATSOLVERCHOLMOD`, `MATSOLVERKLU`, `MATSOLVERSPQR` form the SuiteSparse package; you can use `--download-suitesparse` as
154: a ./configure option to install them
156: .seealso: [](sec_matfactor), [](ch_matrices), `MatGetFactor()`, `PCFactorSetMatSolverType()`, `PCFactorGetMatSolverType()`
157: J*/
158: typedef const char *MatSolverType;
159: #define MATSOLVERSUPERLU "superlu"
160: #define MATSOLVERSUPERLU_DIST "superlu_dist"
161: #define MATSOLVERSTRUMPACK "strumpack"
162: #define MATSOLVERUMFPACK "umfpack"
163: #define MATSOLVERCHOLMOD "cholmod"
164: #define MATSOLVERKLU "klu"
165: #define MATSOLVERELEMENTAL "elemental"
166: #define MATSOLVERSCALAPACK "scalapack"
167: #define MATSOLVERESSL "essl"
168: #define MATSOLVERLUSOL "lusol"
169: #define MATSOLVERMUMPS "mumps"
170: #define MATSOLVERMKL_PARDISO "mkl_pardiso"
171: #define MATSOLVERMKL_CPARDISO "mkl_cpardiso"
172: #define MATSOLVERPASTIX "pastix"
173: #define MATSOLVERMATLAB "matlab"
174: #define MATSOLVERPETSC "petsc"
175: #define MATSOLVERBAS "bas"
176: #define MATSOLVERCUSPARSE "cusparse"
177: #define MATSOLVERCUDA "cuda"
178: #define MATSOLVERHIPSPARSE "hipsparse"
179: #define MATSOLVERHIP "hip"
180: #define MATSOLVERKOKKOS "kokkos"
181: #define MATSOLVERSPQR "spqr"
182: #define MATSOLVERHTOOL "htool"
184: /*E
185: MatFactorType - indicates what type of factorization is requested
187: Values:
188: + `MAT_FACTOR_LU` - LU factorization
189: . `MAT_FACTOR_CHOLESKY` - Cholesky factorization
190: . `MAT_FACTOR_ILU` - ILU factorization
191: . `MAT_FACTOR_ICC` - incomplete Cholesky factorization
192: . `MAT_FACTOR_ILUDT` - ILU factorization with drop tolerance
193: - `MAT_FACTOR_QR` - QR factorization
195: Level: beginner
197: .seealso: [](ch_matrices), `MatSolverType`, `MatGetFactor()`, `MatGetFactorAvailable()`, `MatSolverTypeRegister()`
198: E*/
199: typedef enum {
200: MAT_FACTOR_NONE,
201: MAT_FACTOR_LU,
202: MAT_FACTOR_CHOLESKY,
203: MAT_FACTOR_ILU,
204: MAT_FACTOR_ICC,
205: MAT_FACTOR_ILUDT,
206: MAT_FACTOR_QR,
207: MAT_FACTOR_NUM_TYPES
208: } MatFactorType;
209: PETSC_EXTERN const char *const MatFactorTypes[];
211: PETSC_EXTERN PetscErrorCode MatGetFactor(Mat, MatSolverType, MatFactorType, Mat *);
212: PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat, MatSolverType, MatFactorType, PetscBool *);
213: PETSC_EXTERN PetscErrorCode MatFactorGetCanUseOrdering(Mat, PetscBool *);
214: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "MatFactorGetCanUseOrdering()", ) static inline PetscErrorCode MatFactorGetUseOrdering(Mat A, PetscBool *b)
215: {
216: return MatFactorGetCanUseOrdering(A, b);
217: }
218: PETSC_EXTERN PetscErrorCode MatFactorGetSolverType(Mat, MatSolverType *);
219: PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat, MatFactorType *);
220: PETSC_EXTERN PetscErrorCode MatSetFactorType(Mat, MatFactorType);
221: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode MatSolverFn(Mat, MatFactorType, Mat *);
222: PETSC_EXTERN_TYPEDEF typedef MatSolverFn *MatSolverFunction;
224: PETSC_EXTERN PetscErrorCode MatSolverTypeRegister(MatSolverType, MatType, MatFactorType, MatSolverFn *);
225: PETSC_EXTERN PetscErrorCode MatSolverTypeGet(MatSolverType, MatType, MatFactorType, PetscBool *, PetscBool *, MatSolverFn **);
226: typedef MatSolverType MatSolverPackage PETSC_DEPRECATED_TYPEDEF(3, 9, 0, "MatSolverType", );
227: PETSC_DEPRECATED_FUNCTION(3, 9, 0, "MatSolverTypeRegister()", ) static inline PetscErrorCode MatSolverPackageRegister(MatSolverType stype, MatType mtype, MatFactorType ftype, MatSolverFn *f)
228: {
229: return MatSolverTypeRegister(stype, mtype, ftype, f);
230: }
231: PETSC_DEPRECATED_FUNCTION(3, 9, 0, "MatSolverTypeGet()", ) static inline PetscErrorCode MatSolverPackageGet(MatSolverType stype, MatType mtype, MatFactorType ftype, PetscBool *foundmtype, PetscBool *foundstype, MatSolverFn **f)
232: {
233: return MatSolverTypeGet(stype, mtype, ftype, foundmtype, foundstype, f);
234: }
236: /*E
237: MatProductType - indicates what type of matrix product to compute
239: Values:
240: + `MATPRODUCT_AB` - product of two matrices
241: . `MATPRODUCT_AtB` - product of the transpose of a given matrix with a matrix
242: . `MATPRODUCT_ABt` - product of a matrix with the transpose of another given matrix
243: . `MATPRODUCT_PtAP` - the triple product of the transpose of a matrix with another matrix and itself
244: . `MATPRODUCT_RARt` - the triple product of a matrix, another matrix and the transpose of the first matrix
245: - `MATPRODUCT_ABC` - the product of three matrices
247: Level: beginner
249: .seealso: [](sec_matmatproduct), [](ch_matrices), `MatProductSetType()`
250: E*/
251: typedef enum {
252: MATPRODUCT_UNSPECIFIED,
253: MATPRODUCT_AB,
254: MATPRODUCT_AtB,
255: MATPRODUCT_ABt,
256: MATPRODUCT_PtAP,
257: MATPRODUCT_RARt,
258: MATPRODUCT_ABC
259: } MatProductType;
260: PETSC_EXTERN const char *const MatProductTypes[];
262: /*J
263: MatProductAlgorithm - String with the name of an algorithm for a PETSc matrix product implementation
265: Level: beginner
267: .seealso: [](sec_matmatproduct), [](ch_matrices), `MatSetType()`, `Mat`, `MatProductSetAlgorithm()`, `MatProductType`
268: J*/
269: typedef const char *MatProductAlgorithm;
270: #define MATPRODUCTALGORITHMDEFAULT "default"
271: #define MATPRODUCTALGORITHMSORTED "sorted"
272: #define MATPRODUCTALGORITHMSCALABLE "scalable"
273: #define MATPRODUCTALGORITHMSCALABLEFAST "scalable_fast"
274: #define MATPRODUCTALGORITHMHEAP "heap"
275: #define MATPRODUCTALGORITHMBHEAP "btheap"
276: #define MATPRODUCTALGORITHMLLCONDENSED "llcondensed"
277: #define MATPRODUCTALGORITHMROWMERGE "rowmerge"
278: #define MATPRODUCTALGORITHMOUTERPRODUCT "outerproduct"
279: #define MATPRODUCTALGORITHMATB "at*b"
280: #define MATPRODUCTALGORITHMRAP "rap"
281: #define MATPRODUCTALGORITHMNONSCALABLE "nonscalable"
282: #define MATPRODUCTALGORITHMSEQMPI "seqmpi"
283: #define MATPRODUCTALGORITHMBACKEND "backend"
284: #define MATPRODUCTALGORITHMOVERLAPPING "overlapping"
285: #define MATPRODUCTALGORITHMMERGED "merged"
286: #define MATPRODUCTALGORITHMALLATONCE "allatonce"
287: #define MATPRODUCTALGORITHMALLATONCEMERGED "allatonce_merged"
288: #define MATPRODUCTALGORITHMALLGATHERV "allgatherv"
289: #define MATPRODUCTALGORITHMCYCLIC "cyclic"
290: #define MATPRODUCTALGORITHMHYPRE "hypre"
292: PETSC_EXTERN PetscErrorCode MatProductCreate(Mat, Mat, Mat, Mat *);
293: PETSC_EXTERN PetscErrorCode MatProductCreateWithMat(Mat, Mat, Mat, Mat);
294: PETSC_EXTERN PetscErrorCode MatProductSetType(Mat, MatProductType);
295: PETSC_EXTERN PetscErrorCode MatProductSetAlgorithm(Mat, MatProductAlgorithm);
296: PETSC_EXTERN PetscErrorCode MatProductGetAlgorithm(Mat, MatProductAlgorithm *);
297: PETSC_EXTERN PetscErrorCode MatProductSetFill(Mat, PetscReal);
298: PETSC_EXTERN PetscErrorCode MatProductSetFromOptions(Mat);
299: PETSC_EXTERN PetscErrorCode MatProductSymbolic(Mat);
300: PETSC_EXTERN PetscErrorCode MatProductNumeric(Mat);
301: PETSC_EXTERN PetscErrorCode MatProductReplaceMats(Mat, Mat, Mat, Mat);
302: PETSC_EXTERN PetscErrorCode MatProductClear(Mat);
303: PETSC_EXTERN PetscErrorCode MatProductView(Mat, PetscViewer);
304: PETSC_EXTERN PetscErrorCode MatProductGetType(Mat, MatProductType *);
305: PETSC_EXTERN PetscErrorCode MatProductGetMats(Mat, Mat *, Mat *, Mat *);
307: /* Logging support */
308: #define MAT_FILE_CLASSID 1211216 /* used to indicate matrices in binary files */
309: PETSC_EXTERN PetscClassId MAT_CLASSID;
310: PETSC_EXTERN PetscClassId MAT_COLORING_CLASSID;
311: PETSC_EXTERN PetscClassId MAT_FDCOLORING_CLASSID;
312: PETSC_EXTERN PetscClassId MAT_TRANSPOSECOLORING_CLASSID;
313: PETSC_EXTERN PetscClassId MAT_PARTITIONING_CLASSID;
314: PETSC_EXTERN PetscClassId MAT_COARSEN_CLASSID;
315: PETSC_EXTERN PetscClassId MAT_NULLSPACE_CLASSID;
316: PETSC_EXTERN PetscClassId MATMFFD_CLASSID;
318: /*E
319: MatReuse - Indicates if matrices obtained from a previous call to `MatCreateSubMatrices()`, `MatCreateSubMatrix()`, `MatConvert()` or several other functions
320: are to be reused to store the new matrix values.
322: Values:
323: + `MAT_INITIAL_MATRIX` - create a new matrix
324: . `MAT_REUSE_MATRIX` - reuse the matrix created with a previous call that used `MAT_INITIAL_MATRIX`
325: . `MAT_INPLACE_MATRIX` - replace the first input matrix with the new matrix (not applicable to all functions)
326: - `MAT_IGNORE_MATRIX` - do not create a new matrix or reuse a give matrix, just ignore that matrix argument (not applicable to all functions)
328: Level: beginner
330: .seealso: [](ch_matrices), `Mat`, `MatCreateSubMatrices()`, `MatCreateSubMatrix()`, `MatDestroyMatrices()`, `MatConvert()`
331: E*/
332: typedef enum {
333: MAT_INITIAL_MATRIX,
334: MAT_REUSE_MATRIX,
335: MAT_IGNORE_MATRIX,
336: MAT_INPLACE_MATRIX
337: } MatReuse;
339: /*E
340: MatCreateSubMatrixOption - Indicates if matrices obtained from a call to `MatCreateSubMatrices()`
341: include the matrix values. Currently it is only used by `MatGetSeqNonzeroStructure()`.
343: Values:
344: + `MAT_DO_NOT_GET_VALUES` - do not copy the matrix values
345: - `MAT_GET_VALUES` - copy the matrix values
347: Level: developer
349: Developer Note:
350: Why is not just a boolean used for this information?
352: .seealso: [](ch_matrices), `Mat`, `MatDuplicateOption`, `PetscCopyMode`, `MatGetSeqNonzeroStructure()`
353: E*/
354: typedef enum {
355: MAT_DO_NOT_GET_VALUES,
356: MAT_GET_VALUES
357: } MatCreateSubMatrixOption;
359: PETSC_EXTERN PetscErrorCode MatInitializePackage(void);
360: PETSC_EXTERN PetscErrorCode MatFinalizePackage(void);
362: PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm, Mat *);
363: PETSC_EXTERN PetscErrorCode MatCreateFromOptions(MPI_Comm, const char *, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, Mat *);
364: PETSC_EXTERN PetscErrorCode MatSetSizes(Mat, PetscInt, PetscInt, PetscInt, PetscInt);
365: PETSC_EXTERN PetscErrorCode MatSetType(Mat, MatType);
366: PETSC_EXTERN PetscErrorCode MatGetVecType(Mat, VecType *);
367: PETSC_EXTERN PetscErrorCode MatSetVecType(Mat, VecType);
368: PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat);
369: PETSC_EXTERN PetscErrorCode MatViewFromOptions(Mat, PetscObject, const char[]);
370: PETSC_EXTERN PetscErrorCode MatRegister(const char[], PetscErrorCode (*)(Mat));
371: PETSC_EXTERN PetscErrorCode MatRegisterRootName(const char[], const char[], const char[]);
372: PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat, const char[]);
373: PETSC_EXTERN PetscErrorCode MatSetOptionsPrefixFactor(Mat, const char[]);
374: PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefixFactor(Mat, const char[]);
375: PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat, const char[]);
376: PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat, const char *[]);
377: PETSC_EXTERN PetscErrorCode MatGetState(Mat, PetscObjectState *);
378: PETSC_EXTERN PetscErrorCode MatSetErrorIfFailure(Mat, PetscBool);
380: PETSC_EXTERN PetscFunctionList MatList;
381: PETSC_EXTERN PetscFunctionList MatColoringList;
382: PETSC_EXTERN PetscFunctionList MatPartitioningList;
384: /*E
385: MatStructure - Indicates if two matrices have the same nonzero structure
387: Values:
388: + `SAME_NONZERO_PATTERN` - the two matrices have identical nonzero patterns
389: . `DIFFERENT_NONZERO_PATTERN` - the two matrices may have different nonzero patterns
390: . `SUBSET_NONZERO_PATTERN` - the nonzero pattern of the second matrix is a subset of the nonzero pattern of the first matrix
391: - `UNKNOWN_NONZERO_PATTERN` - there is no known relationship between the nonzero patterns. In this case the implementations
392: may try to detect a relationship to optimize the operation
394: Level: beginner
396: Note:
397: Certain matrix operations (such as `MatAXPY()`) can run much faster if the sparsity pattern of the matrices are the same. But actually determining if
398: the patterns are the same may be costly. This provides a way for users who know something about the sparsity patterns to provide this information
399: to certain PETSc routines.
401: .seealso: [](ch_matrices), `Mat`, `MatCopy()`, `MatAXPY()`, `MatAYPX()`
402: E*/
403: typedef enum {
404: DIFFERENT_NONZERO_PATTERN,
405: SUBSET_NONZERO_PATTERN,
406: SAME_NONZERO_PATTERN,
407: UNKNOWN_NONZERO_PATTERN
408: } MatStructure;
409: PETSC_EXTERN const char *const MatStructures[];
411: #if defined PETSC_HAVE_MKL_SPARSE
412: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJMKL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
413: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJMKL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
414: PETSC_EXTERN PetscErrorCode MatCreateBAIJMKL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
415: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJMKL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
416: #endif
418: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJPERM(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
419: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJPERM(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
421: PETSC_EXTERN PetscErrorCode MatCreateSeqSELL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
422: PETSC_EXTERN PetscErrorCode MatCreateSELL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
423: PETSC_EXTERN PetscErrorCode MatSeqSELLSetPreallocation(Mat, PetscInt, const PetscInt[]);
424: PETSC_EXTERN PetscErrorCode MatMPISELLSetPreallocation(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
425: PETSC_EXTERN PetscErrorCode MatSeqSELLGetFillRatio(Mat, PetscReal *);
426: PETSC_EXTERN PetscErrorCode MatSeqSELLGetMaxSliceWidth(Mat, PetscInt *);
427: PETSC_EXTERN PetscErrorCode MatSeqSELLGetAvgSliceWidth(Mat, PetscReal *);
428: PETSC_EXTERN PetscErrorCode MatSeqSELLSetSliceHeight(Mat, PetscInt);
429: PETSC_EXTERN PetscErrorCode MatSeqSELLGetVarSliceSize(Mat, PetscReal *);
431: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJSELL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
432: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSELL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
433: PETSC_EXTERN PetscErrorCode MatMPISELLGetLocalMatCondensed(Mat, MatReuse, IS *, IS *, Mat *);
434: PETSC_EXTERN PetscErrorCode MatMPISELLGetSeqSELL(Mat, Mat *, Mat *, const PetscInt *[]);
436: PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm, PetscInt, PetscInt, PetscScalar[], Mat *);
437: PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar[], Mat *);
438: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
439: PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
440: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], Mat *);
441: PETSC_EXTERN PetscErrorCode MatUpdateMPIAIJWithArrays(Mat, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]);
442: PETSC_EXTERN PetscErrorCode MatUpdateMPIAIJWithArray(Mat, const PetscScalar[]);
443: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], PetscInt[], PetscInt[], PetscScalar[], Mat *);
444: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSeqAIJ(MPI_Comm, PetscInt, PetscInt, Mat, Mat, PetscInt *, Mat *);
446: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
447: PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
448: PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], Mat *);
450: PETSC_EXTERN PetscErrorCode MatSetPreallocationCOO(Mat, PetscCount, PetscInt[], PetscInt[]);
451: PETSC_EXTERN PetscErrorCode MatSetPreallocationCOOLocal(Mat, PetscCount, PetscInt[], PetscInt[]);
452: PETSC_EXTERN PetscErrorCode MatSetValuesCOO(Mat, const PetscScalar[], InsertMode);
454: PETSC_EXTERN PetscErrorCode MatCreateMPIAdj(MPI_Comm, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscInt[], Mat *);
455: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
457: PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
458: PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], Mat *);
459: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]);
460: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]);
461: PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscInt[], const PetscInt[]);
463: PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, void *, Mat *);
464: PETSC_EXTERN PetscErrorCode MatCreateCentering(MPI_Comm, PetscInt, PetscInt, Mat *);
465: PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat, Mat *);
466: PETSC_EXTERN PetscErrorCode MatCreateNormalHermitian(Mat, Mat *);
467: PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat, Mat, Vec, Mat, Mat *);
468: PETSC_EXTERN PetscErrorCode MatLRCGetMats(Mat, Mat *, Mat *, Vec *, Mat *);
469: PETSC_EXTERN PetscErrorCode MatLRCSetMats(Mat, Mat, Mat, Vec, Mat);
470: PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, ISLocalToGlobalMapping, ISLocalToGlobalMapping, Mat *);
471: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
472: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
474: PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm, VecScatter, Mat *);
475: PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat, VecScatter);
476: PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat, VecScatter *);
477: PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt *, Mat *);
478: PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat, Mat);
479: PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat);
480: typedef enum {
481: MAT_COMPOSITE_MERGE_RIGHT,
482: MAT_COMPOSITE_MERGE_LEFT
483: } MatCompositeMergeType;
484: PETSC_EXTERN PetscErrorCode MatCompositeSetMergeType(Mat, MatCompositeMergeType);
485: PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm, PetscInt, const Mat *, Mat *);
486: /*E
487: MatCompositeType - indicates what type of `MATCOMPOSITE` is used
489: Values:
490: + `MAT_COMPOSITE_ADDITIVE` - sum of matrices (default)
491: - `MAT_COMPOSITE_MULTIPLICATIVE` - product of matrices
493: Level: beginner
495: .seealso: [](ch_matrices), `MATCOMPOSITE`, `MatCompositeSetType()`, `MatCompositeGetType()`
496: E*/
497: typedef enum {
498: MAT_COMPOSITE_ADDITIVE,
499: MAT_COMPOSITE_MULTIPLICATIVE
500: } MatCompositeType;
501: PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat, MatCompositeType);
502: PETSC_EXTERN PetscErrorCode MatCompositeGetType(Mat, MatCompositeType *);
503: PETSC_EXTERN PetscErrorCode MatCompositeSetMatStructure(Mat, MatStructure);
504: PETSC_EXTERN PetscErrorCode MatCompositeGetMatStructure(Mat, MatStructure *);
505: PETSC_EXTERN PetscErrorCode MatCompositeGetNumberMat(Mat, PetscInt *);
506: PETSC_EXTERN PetscErrorCode MatCompositeGetMat(Mat, PetscInt, Mat *);
507: PETSC_EXTERN PetscErrorCode MatCompositeSetScalings(Mat, const PetscScalar *);
509: PETSC_EXTERN PetscErrorCode MatCreateFFT(MPI_Comm, PetscInt, const PetscInt[], MatType, Mat *);
510: PETSC_EXTERN PetscErrorCode MatCreateSeqCUFFT(MPI_Comm, PetscInt, const PetscInt[], Mat *);
512: PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat, Mat *);
513: PETSC_EXTERN PetscErrorCode MatTransposeGetMat(Mat, Mat *);
514: PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat, Mat *);
515: PETSC_EXTERN PetscErrorCode MatHermitianTransposeGetMat(Mat, Mat *);
516: PETSC_EXTERN PetscErrorCode MatNormalGetMat(Mat, Mat *);
517: PETSC_EXTERN PetscErrorCode MatNormalHermitianGetMat(Mat, Mat *);
518: PETSC_EXTERN PetscErrorCode MatCreateSubMatrixVirtual(Mat, IS, IS, Mat *);
519: PETSC_EXTERN PetscErrorCode MatSubMatrixVirtualUpdate(Mat, Mat, IS, IS);
520: PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat, IS, IS, Mat *);
521: PETSC_EXTERN PetscErrorCode MatCreateConstantDiagonal(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar, Mat *);
522: PETSC_EXTERN PetscErrorCode MatCreateDiagonal(Vec, Mat *);
523: PETSC_EXTERN PetscErrorCode MatDiagonalGetDiagonal(Mat, Vec *);
524: PETSC_EXTERN PetscErrorCode MatDiagonalRestoreDiagonal(Mat, Vec *);
525: PETSC_EXTERN PetscErrorCode MatDiagonalGetInverseDiagonal(Mat, Vec *);
526: PETSC_EXTERN PetscErrorCode MatDiagonalRestoreInverseDiagonal(Mat, Vec *);
527: PETSC_EXTERN PetscErrorCode MatConstantDiagonalGetConstant(Mat, PetscScalar *);
528: PETSC_EXTERN PetscErrorCode MatGetCurrentMemType(Mat, PetscMemType *);
530: #if defined(PETSC_HAVE_HYPRE)
531: PETSC_EXTERN PetscErrorCode MatHYPRESetPreallocation(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
532: #endif
534: PETSC_EXTERN PetscErrorCode MatPythonSetType(Mat, const char[]);
535: PETSC_EXTERN PetscErrorCode MatPythonGetType(Mat, const char *[]);
536: PETSC_EXTERN PetscErrorCode MatPythonCreate(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const char[], Mat *);
538: PETSC_EXTERN PetscErrorCode MatResetPreallocation(Mat);
539: PETSC_EXTERN PetscErrorCode MatResetHash(Mat);
540: PETSC_EXTERN PetscErrorCode MatSetUp(Mat);
541: PETSC_EXTERN PetscErrorCode MatDestroy(Mat *);
542: PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat, PetscObjectState *);
544: PETSC_EXTERN PetscErrorCode MatConjugate(Mat);
545: PETSC_EXTERN PetscErrorCode MatRealPart(Mat);
546: PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat);
547: PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat, Mat *);
548: PETSC_EXTERN PetscErrorCode MatGetTrace(Mat, PetscScalar *);
549: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat, const PetscScalar **);
550: PETSC_EXTERN PetscErrorCode MatInvertVariableBlockDiagonal(Mat, PetscInt, const PetscInt *, PetscScalar *);
551: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonalMat(Mat, Mat);
552: PETSC_EXTERN PetscErrorCode MatInvertVariableBlockEnvelope(Mat, MatReuse, Mat *);
553: PETSC_EXTERN PetscErrorCode MatComputeVariableBlockEnvelope(Mat);
555: PETSC_EXTERN PetscErrorCode MatSetValues(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
556: PETSC_EXTERN PetscErrorCode MatSetValuesIS(Mat, IS, IS, const PetscScalar[], InsertMode);
557: PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
558: PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat, PetscInt, const PetscScalar[]);
559: PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat, PetscInt, const PetscScalar[]);
560: PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat, PetscInt, PetscInt, PetscInt[], const PetscScalar[]);
561: PETSC_EXTERN PetscErrorCode MatSetRandom(Mat, PetscRandom);
563: /*S
564: MatStencil - Data structure (C struct) for storing information about rows and
565: columns of a matrix as indexed on an associated grid. These are arguments to `MatSetStencil()` and `MatSetBlockStencil()`
567: Level: beginner
569: Notes:
570: The i,j, and k represent the logical coordinates over the entire grid (for 2 and 1 dimensional problems the k and j entries are ignored).
571: The c represents the degrees of freedom at each grid point (the dof argument to `DMDASetDOF()`). If dof is 1 then this entry is ignored.
573: For stencil access to vectors see `DMDAVecGetArray()`
575: For staggered grids, see `DMStagStencil`
577: .seealso: [](ch_matrices), `Mat`, `MatSetValuesStencil()`, `MatSetStencil()`, `MatSetValuesBlockedStencil()`, `DMDAVecGetArray()`
578: `DMStagStencil`
579: S*/
580: typedef struct {
581: PetscInt k, j, i, c;
582: } MatStencil;
584: PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat, PetscInt, const MatStencil[], PetscInt, const MatStencil[], const PetscScalar[], InsertMode);
585: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat, PetscInt, const MatStencil[], PetscInt, const MatStencil[], const PetscScalar[], InsertMode);
586: PETSC_EXTERN PetscErrorCode MatSetStencil(Mat, PetscInt, const PetscInt[], const PetscInt[], PetscInt);
588: /*E
589: MatAssemblyType - Indicates if the process of setting values into the matrix is complete, and the matrix is ready for use
591: Values:
592: + `MAT_FLUSH_ASSEMBLY` - you will continue to put values into the matrix
593: - `MAT_FINAL_ASSEMBLY` - you wish to use the matrix with the values currently inserted
595: Level: beginner
597: .seealso: [](ch_matrices), `Mat`, `MatSetValues`, `MatAssemblyBegin()`, `MatAssemblyEnd()`
598: E*/
599: typedef enum {
600: MAT_FLUSH_ASSEMBLY = 1,
601: MAT_FINAL_ASSEMBLY = 0
602: } MatAssemblyType;
604: PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat, MatAssemblyType);
605: PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat, MatAssemblyType);
606: PETSC_EXTERN PetscErrorCode MatAssembled(Mat, PetscBool *);
608: /*E
609: MatOption - Options that may be set for a matrix that indicate properties of the matrix or affect its behavior or storage
611: Level: beginner
613: Note:
614: See `MatSetOption()` for the use of the options
616: Developer Note:
617: Entries that are negative need not be called collectively by all processes.
619: .seealso: [](ch_matrices), `Mat`, `MatSetOption()`
620: E*/
621: typedef enum {
622: MAT_OPTION_MIN = -3,
623: MAT_UNUSED_NONZERO_LOCATION_ERR = -2,
624: MAT_ROW_ORIENTED = -1,
625: MAT_SYMMETRIC = 1,
626: MAT_STRUCTURALLY_SYMMETRIC = 2,
627: MAT_FORCE_DIAGONAL_ENTRIES = 3,
628: MAT_IGNORE_OFF_PROC_ENTRIES = 4,
629: MAT_USE_HASH_TABLE = 5,
630: MAT_KEEP_NONZERO_PATTERN = 6,
631: MAT_IGNORE_ZERO_ENTRIES = 7,
632: MAT_USE_INODES = 8,
633: MAT_HERMITIAN = 9,
634: MAT_SYMMETRY_ETERNAL = 10,
635: MAT_NEW_NONZERO_LOCATION_ERR = 11,
636: MAT_IGNORE_LOWER_TRIANGULAR = 12,
637: MAT_ERROR_LOWER_TRIANGULAR = 13,
638: MAT_GETROW_UPPERTRIANGULAR = 14,
639: MAT_SPD = 15,
640: MAT_NO_OFF_PROC_ZERO_ROWS = 16,
641: MAT_NO_OFF_PROC_ENTRIES = 17,
642: MAT_NEW_NONZERO_LOCATIONS = 18,
643: MAT_NEW_NONZERO_ALLOCATION_ERR = 19,
644: MAT_SUBSET_OFF_PROC_ENTRIES = 20,
645: MAT_SUBMAT_SINGLEIS = 21,
646: MAT_STRUCTURE_ONLY = 22,
647: MAT_SORTED_FULL = 23,
648: MAT_FORM_EXPLICIT_TRANSPOSE = 24,
649: MAT_STRUCTURAL_SYMMETRY_ETERNAL = 25,
650: MAT_SPD_ETERNAL = 26,
651: MAT_OPTION_MAX = 27
652: } MatOption;
654: PETSC_EXTERN const char *const *MatOptions;
655: PETSC_EXTERN PetscErrorCode MatSetOption(Mat, MatOption, PetscBool);
656: PETSC_EXTERN PetscErrorCode MatGetOption(Mat, MatOption, PetscBool *);
657: PETSC_EXTERN PetscErrorCode MatPropagateSymmetryOptions(Mat, Mat);
658: PETSC_EXTERN PetscErrorCode MatGetType(Mat, MatType *);
660: PETSC_EXTERN PetscErrorCode MatGetValues(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], PetscScalar[]);
661: PETSC_EXTERN PetscErrorCode MatGetRow(Mat, PetscInt, PetscInt *, const PetscInt *[], const PetscScalar *[]);
662: PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat, PetscInt, PetscInt *, const PetscInt *[], const PetscScalar *[]);
663: PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat);
664: PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat);
665: PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat, Vec, PetscInt);
666: PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat, PetscScalar *[]);
667: PETSC_EXTERN PetscErrorCode MatSeqAIJGetArrayRead(Mat, const PetscScalar *[]);
668: PETSC_EXTERN PetscErrorCode MatSeqAIJGetArrayWrite(Mat, PetscScalar *[]);
669: PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat, PetscScalar *[]);
670: PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArrayRead(Mat, const PetscScalar *[]);
671: PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArrayWrite(Mat, PetscScalar *[]);
672: PETSC_EXTERN PetscErrorCode MatSeqAIJGetMaxRowNonzeros(Mat, PetscInt *);
673: PETSC_EXTERN PetscErrorCode MatSeqAIJSetValuesLocalFast(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
674: PETSC_EXTERN PetscErrorCode MatSeqAIJSetType(Mat, MatType);
675: PETSC_EXTERN PetscErrorCode MatSeqAIJKron(Mat, Mat, MatReuse, Mat *);
676: PETSC_EXTERN PetscErrorCode MatSeqAIJRegister(const char[], PetscErrorCode (*)(Mat, MatType, MatReuse, Mat *));
677: PETSC_EXTERN PetscFunctionList MatSeqAIJList;
678: PETSC_EXTERN PetscErrorCode MatSeqBAIJGetArray(Mat, PetscScalar *[]);
679: PETSC_EXTERN PetscErrorCode MatSeqBAIJRestoreArray(Mat, PetscScalar *[]);
680: PETSC_EXTERN PetscErrorCode MatSeqSBAIJGetArray(Mat, PetscScalar *[]);
681: PETSC_EXTERN PetscErrorCode MatSeqSBAIJRestoreArray(Mat, PetscScalar *[]);
682: PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat, PetscScalar *[]);
683: PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat, PetscScalar *[]);
684: PETSC_EXTERN PetscErrorCode MatDensePlaceArray(Mat, const PetscScalar[]);
685: PETSC_EXTERN PetscErrorCode MatDenseReplaceArray(Mat, const PetscScalar[]);
686: PETSC_EXTERN PetscErrorCode MatDenseResetArray(Mat);
687: PETSC_EXTERN PetscErrorCode MatDenseGetArrayRead(Mat, const PetscScalar *[]);
688: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayRead(Mat, const PetscScalar *[]);
689: PETSC_EXTERN PetscErrorCode MatDenseGetArrayWrite(Mat, PetscScalar *[]);
690: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayWrite(Mat, PetscScalar *[]);
691: PETSC_EXTERN PetscErrorCode MatDenseGetArrayAndMemType(Mat, PetscScalar *[], PetscMemType *);
692: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayAndMemType(Mat, PetscScalar *[]);
693: PETSC_EXTERN PetscErrorCode MatDenseGetArrayReadAndMemType(Mat, const PetscScalar *[], PetscMemType *);
694: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayReadAndMemType(Mat, const PetscScalar *[]);
695: PETSC_EXTERN PetscErrorCode MatDenseGetArrayWriteAndMemType(Mat, PetscScalar *[], PetscMemType *);
696: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayWriteAndMemType(Mat, PetscScalar *[]);
697: PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat, PetscInt *);
698: PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat, PetscInt);
699: PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat, PetscInt *, PetscInt *);
700: PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat, PetscInt, PetscInt);
701: PETSC_EXTERN PetscErrorCode MatSetBlockSizesFromMats(Mat, Mat, Mat);
702: PETSC_EXTERN PetscErrorCode MatSetVariableBlockSizes(Mat, PetscInt, const PetscInt[]);
703: PETSC_EXTERN PetscErrorCode MatGetVariableBlockSizes(Mat, PetscInt *, const PetscInt *[]);
705: PETSC_EXTERN PetscErrorCode MatDenseGetColumn(Mat, PetscInt, PetscScalar *[]);
706: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumn(Mat, PetscScalar *[]);
707: PETSC_EXTERN PetscErrorCode MatDenseGetColumnVec(Mat, PetscInt, Vec *);
708: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVec(Mat, PetscInt, Vec *);
709: PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecRead(Mat, PetscInt, Vec *);
710: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecRead(Mat, PetscInt, Vec *);
711: PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecWrite(Mat, PetscInt, Vec *);
712: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecWrite(Mat, PetscInt, Vec *);
713: PETSC_EXTERN PetscErrorCode MatDenseGetSubMatrix(Mat, PetscInt, PetscInt, PetscInt, PetscInt, Mat *);
714: PETSC_EXTERN PetscErrorCode MatDenseRestoreSubMatrix(Mat, Mat *);
716: PETSC_EXTERN PetscErrorCode MatMult(Mat, Vec, Vec);
717: PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat, Vec, Vec);
718: PETSC_EXTERN PetscErrorCode MatMultAdd(Mat, Vec, Vec, Vec);
719: PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat, Vec, Vec);
720: PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat, Vec, Vec);
721: PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat, Mat, PetscReal, PetscBool *);
722: PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat, Mat, PetscReal, PetscBool *);
723: PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat, Vec, Vec, Vec);
724: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat, Vec, Vec, Vec);
725: PETSC_EXTERN PetscErrorCode MatMatSolve(Mat, Mat, Mat);
726: PETSC_EXTERN PetscErrorCode MatMatSolveTranspose(Mat, Mat, Mat);
727: PETSC_EXTERN PetscErrorCode MatMatTransposeSolve(Mat, Mat, Mat);
728: PETSC_EXTERN PetscErrorCode MatResidual(Mat, Vec, Vec, Vec);
730: /*E
731: MatDuplicateOption - Indicates if a duplicated sparse matrix should have
732: its numerical values copied over or just its nonzero structure.
734: Values:
735: + `MAT_DO_NOT_COPY_VALUES` - Create a matrix using the same nonzero pattern as the original matrix,
736: with zeros for the numerical values
737: . `MAT_COPY_VALUES` - Create a matrix with the same nonzero pattern as the original matrix
738: and with the same numerical values.
739: - `MAT_SHARE_NONZERO_PATTERN` - Create a matrix that shares the nonzero structure with the previous matrix
740: and does not copy it, using zeros for the numerical values. The parent and
741: child matrices will share their index (i and j) arrays, and you cannot
742: insert new nonzero entries into either matrix
744: Level: beginner
746: Note:
747: Many matrix types (including `MATSEQAIJ`) do not support the `MAT_SHARE_NONZERO_PATTERN` optimization; in
748: this case the behavior is as if `MAT_DO_NOT_COPY_VALUES` has been specified.
750: .seealso: [](ch_matrices), `Mat`, `MatDuplicate()`
751: E*/
752: typedef enum {
753: MAT_DO_NOT_COPY_VALUES,
754: MAT_COPY_VALUES,
755: MAT_SHARE_NONZERO_PATTERN
756: } MatDuplicateOption;
758: PETSC_EXTERN PetscErrorCode MatConvert(Mat, MatType, MatReuse, Mat *);
759: PETSC_EXTERN PetscErrorCode MatDuplicate(Mat, MatDuplicateOption, Mat *);
761: PETSC_EXTERN PetscErrorCode MatCopy(Mat, Mat, MatStructure);
762: PETSC_EXTERN PetscErrorCode MatView(Mat, PetscViewer);
763: PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat, PetscReal, PetscBool *);
764: PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat, PetscBool *);
765: PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat, PetscReal, PetscBool *);
766: PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat, PetscBool *, PetscBool *);
767: PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat, PetscBool *, PetscBool *);
768: PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetricKnown(Mat, PetscBool *, PetscBool *);
769: PETSC_EXTERN PetscErrorCode MatIsSPDKnown(Mat, PetscBool *, PetscBool *);
770: PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat, PetscBool *, PetscInt *);
771: PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer);
773: PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *);
774: PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *);
775: PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *);
776: PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *);
778: /*S
779: MatInfo - Context of matrix information, used with `MatGetInfo()`
781: Level: intermediate
783: Fortran Note:
784: `MatInfo` is a derived type, use e.g. `matinfo%nz_allocated` to access its components.
786: .seealso: [](ch_matrices), `Mat`, `MatGetInfo()`, `MatInfoType`
787: S*/
788: typedef struct {
789: PetscLogDouble block_size; /* block size */
790: PetscLogDouble nz_allocated, nz_used, nz_unneeded; /* number of nonzeros */
791: PetscLogDouble memory; /* memory allocated */
792: PetscLogDouble assemblies; /* number of matrix assemblies called */
793: PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */
794: PetscLogDouble fill_ratio_given, fill_ratio_needed; /* fill ratio for LU/ILU */
795: PetscLogDouble factor_mallocs; /* number of mallocs during factorization */
796: } MatInfo;
798: /*E
799: MatInfoType - Indicates if you want information about the local part of the matrix,
800: the entire parallel matrix or the maximum over all the local parts.
802: Values:
803: + `MAT_LOCAL` - values for each MPI process part of the matrix
804: . `MAT_GLOBAL_MAX` - maximum of each value over all MPI processes
805: - `MAT_GLOBAL_SUM` - sum of each value over all MPI processes
807: Level: beginner
809: .seealso: [](ch_matrices), `MatGetInfo()`, `MatInfo`
810: E*/
811: typedef enum {
812: MAT_LOCAL = 1,
813: MAT_GLOBAL_MAX = 2,
814: MAT_GLOBAL_SUM = 3
815: } MatInfoType;
816: PETSC_EXTERN PetscErrorCode MatGetInfo(Mat, MatInfoType, MatInfo *);
817: PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat, Vec);
818: PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat, Vec, PetscInt[]);
819: PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat, Vec, PetscInt[]);
820: PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat, Vec, PetscInt[]);
821: PETSC_EXTERN PetscErrorCode MatGetRowSumAbs(Mat, Vec);
822: PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat, Vec, PetscInt[]);
823: PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat, Vec);
824: PETSC_EXTERN PetscErrorCode MatTranspose(Mat, MatReuse, Mat *);
825: PETSC_EXTERN PetscErrorCode MatTransposeSymbolic(Mat, Mat *);
826: PETSC_EXTERN PetscErrorCode MatTransposeSetPrecursor(Mat, Mat);
827: PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat, MatReuse, Mat *);
828: PETSC_EXTERN PetscErrorCode MatPermute(Mat, IS, IS, Mat *);
829: PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat, Vec, Vec);
830: PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat, Vec, InsertMode);
832: PETSC_EXTERN PetscErrorCode MatEqual(Mat, Mat, PetscBool *);
833: PETSC_EXTERN PetscErrorCode MatMultEqual(Mat, Mat, PetscInt, PetscBool *);
834: PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat, Mat, PetscInt, PetscBool *);
835: PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat, Mat, PetscInt, PetscBool *);
836: PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat, Mat, PetscInt, PetscBool *);
837: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeEqual(Mat, Mat, PetscInt, PetscBool *);
838: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAddEqual(Mat, Mat, PetscInt, PetscBool *);
839: PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *);
840: PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *);
841: PETSC_EXTERN PetscErrorCode MatMatTransposeMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *);
842: PETSC_EXTERN PetscErrorCode MatPtAPMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *);
843: PETSC_EXTERN PetscErrorCode MatRARtMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *);
844: PETSC_EXTERN PetscErrorCode MatIsLinear(Mat, PetscInt, PetscBool *);
846: PETSC_EXTERN PetscErrorCode MatNorm(Mat, NormType, PetscReal *);
847: PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat, NormType, PetscReal *);
848: PETSC_EXTERN PetscErrorCode MatGetColumnSums(Mat, PetscScalar *);
849: PETSC_EXTERN PetscErrorCode MatGetColumnSumsRealPart(Mat, PetscReal *);
850: PETSC_EXTERN PetscErrorCode MatGetColumnSumsImaginaryPart(Mat, PetscReal *);
851: PETSC_EXTERN PetscErrorCode MatGetColumnMeans(Mat, PetscScalar *);
852: PETSC_EXTERN PetscErrorCode MatGetColumnMeansRealPart(Mat, PetscReal *);
853: PETSC_EXTERN PetscErrorCode MatGetColumnMeansImaginaryPart(Mat, PetscReal *);
854: PETSC_EXTERN PetscErrorCode MatGetColumnReductions(Mat, PetscInt, PetscReal *);
855: PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat);
856: PETSC_EXTERN PetscErrorCode MatSetInf(Mat);
857: PETSC_EXTERN PetscErrorCode MatZeroRows(Mat, PetscInt, const PetscInt[], PetscScalar, Vec, Vec);
858: PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat, IS, PetscScalar, Vec, Vec);
859: PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat, PetscInt, const MatStencil[], PetscScalar, Vec, Vec);
860: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat, PetscInt, const MatStencil[], PetscScalar, Vec, Vec);
861: PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat, PetscInt, const PetscInt[], PetscScalar, Vec, Vec);
862: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat, IS, PetscScalar, Vec, Vec);
864: PETSC_EXTERN PetscErrorCode MatGetSize(Mat, PetscInt *, PetscInt *);
865: PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat, PetscInt *, PetscInt *);
866: PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat, PetscInt *, PetscInt *);
867: PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat, const PetscInt **);
868: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat, PetscInt *, PetscInt *);
869: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat, const PetscInt **);
870: PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat, IS *, IS *);
872: PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat, PetscInt, const IS[], const IS[], MatReuse, Mat *[]);
873: PETSC_DEPRECATED_FUNCTION(3, 8, 0, "MatCreateSubMatrices()", ) static inline PetscErrorCode MatGetSubMatrices(Mat mat, PetscInt n, const IS irow[], const IS icol[], MatReuse scall, Mat *submat[])
874: {
875: return MatCreateSubMatrices(mat, n, irow, icol, scall, submat);
876: }
877: PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat, PetscInt, const IS[], const IS[], MatReuse, Mat *[]);
878: PETSC_DEPRECATED_FUNCTION(3, 8, 0, "MatCreateSubMatricesMPI()", ) static inline PetscErrorCode MatGetSubMatricesMPI(Mat mat, PetscInt n, const IS irow[], const IS icol[], MatReuse scall, Mat *submat[])
879: {
880: return MatCreateSubMatricesMPI(mat, n, irow, icol, scall, submat);
881: }
882: PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt, Mat *[]);
883: PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt, Mat *[]);
884: PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat, IS, IS, MatReuse, Mat *);
885: PETSC_DEPRECATED_FUNCTION(3, 8, 0, "MatCreateSubMatrix()", ) static inline PetscErrorCode MatGetSubMatrix(Mat mat, IS isrow, IS iscol, MatReuse cll, Mat *newmat)
886: {
887: return MatCreateSubMatrix(mat, isrow, iscol, cll, newmat);
888: }
889: PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat, IS, IS, Mat *);
890: PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat, IS, IS, Mat *);
891: PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat, Mat *);
892: PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat *);
894: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm, Mat, PetscInt, PetscInt, MatReuse, Mat *);
895: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm, Mat, PetscInt, PetscInt, Mat *);
896: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat, Mat);
897: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat, MatReuse, Mat *);
898: PETSC_EXTERN PetscErrorCode MatAIJGetLocalMat(Mat, Mat *);
899: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat, MatReuse, IS *, IS *, Mat *);
900: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatMerge(Mat, MatReuse, IS *, Mat *);
901: PETSC_EXTERN PetscErrorCode MatMPIAIJGetNumberNonzeros(Mat, PetscCount *);
902: PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat, Mat, MatReuse, IS *, IS *, Mat *);
903: PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *, const PetscInt *[]);
905: PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat, PetscInt, IS[], PetscInt);
906: PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat, PetscInt, IS[], PetscInt);
907: PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat, PetscBool);
909: PETSC_EXTERN PetscErrorCode MatMatMult(Mat, Mat, MatReuse, PetscReal, Mat *);
911: PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat, Mat, Mat, MatReuse, PetscReal, Mat *);
912: PETSC_EXTERN PetscErrorCode MatGalerkin(Mat, Mat, Mat, MatReuse, PetscReal, Mat *);
914: PETSC_EXTERN PetscErrorCode MatPtAP(Mat, Mat, MatReuse, PetscReal, Mat *);
915: PETSC_EXTERN PetscErrorCode MatRARt(Mat, Mat, MatReuse, PetscReal, Mat *);
917: PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat, Mat, MatReuse, PetscReal, Mat *);
918: PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat, Mat, MatReuse, PetscReal, Mat *);
920: PETSC_EXTERN PetscErrorCode MatAXPY(Mat, PetscScalar, Mat, MatStructure);
921: PETSC_EXTERN PetscErrorCode MatAYPX(Mat, PetscScalar, Mat, MatStructure);
923: PETSC_EXTERN PetscErrorCode MatScale(Mat, PetscScalar);
924: PETSC_EXTERN PetscErrorCode MatShift(Mat, PetscScalar);
926: PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat, ISLocalToGlobalMapping, ISLocalToGlobalMapping);
927: PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat, ISLocalToGlobalMapping *, ISLocalToGlobalMapping *);
928: PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat, PetscLayout *, PetscLayout *);
929: PETSC_EXTERN PetscErrorCode MatSetLayouts(Mat, PetscLayout, PetscLayout);
930: PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat, PetscInt, const PetscInt[], PetscScalar, Vec, Vec);
931: PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat, IS, PetscScalar, Vec, Vec);
932: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat, PetscInt, const PetscInt[], PetscScalar, Vec, Vec);
933: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat, IS, PetscScalar, Vec, Vec);
934: PETSC_EXTERN PetscErrorCode MatGetValuesLocal(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], PetscScalar[]);
935: PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
936: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
938: PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat, PetscInt, PetscInt);
939: PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat, PetscInt *, PetscInt *, PetscInt *, PetscInt *);
941: PETSC_EXTERN PetscErrorCode MatInterpolate(Mat, Vec, Vec);
942: PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat, Vec, Vec, Vec);
943: PETSC_EXTERN PetscErrorCode MatRestrict(Mat, Vec, Vec);
944: PETSC_EXTERN PetscErrorCode MatMatInterpolate(Mat, Mat, Mat *);
945: PETSC_EXTERN PetscErrorCode MatMatInterpolateAdd(Mat, Mat, Mat, Mat *);
946: PETSC_EXTERN PetscErrorCode MatMatRestrict(Mat, Mat, Mat *);
947: PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat, Vec *, Vec *);
948: PETSC_DEPRECATED_FUNCTION(3, 6, 0, "MatCreateVecs()", ) static inline PetscErrorCode MatGetVecs(Mat mat, Vec *x, Vec *y)
949: {
950: return MatCreateVecs(mat, x, y);
951: }
952: PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat, PetscInt, MPI_Comm, MatReuse, Mat *);
953: PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat, MPI_Comm, MatReuse, Mat *);
954: PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat, IS *);
955: PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat, IS *);
956: PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm, Mat, PetscInt, MatReuse, Mat *);
958: PETSC_EXTERN PetscErrorCode MatCopyHashToXAIJ(Mat A, Mat B);
959: /*@C
960: MatSetValue - Set a single entry into a matrix.
962: Not Collective
964: Input Parameters:
965: + mat - the matrix
966: . i - the row location of the entry
967: . j - the column location of the entry
968: . va - the value to insert
969: - mode - either `INSERT_VALUES` or `ADD_VALUES`
971: Level: beginner
973: Notes:
974: This value may be cached, so `MatAssemblyBegin()` and `MatAssemblyEnd()`
975: MUST be called after all calls to `MatSetValue()` have been completed.
977: For efficiency one should use `MatSetValues()` and set several values simultaneously.
979: .seealso: [](ch_matrices), `Mat`, `MatAssemblyBegin()`, `MatAssemblyEnd()`, `InsertMode`, `MatGetValue()`, `MatSetValues()`,
980: `MatSetValueLocal()`, `MatSetValuesLocal()`
981: @*/
982: static inline PetscErrorCode MatSetValue(Mat mat, PetscInt i, PetscInt j, PetscScalar va, InsertMode mode)
983: {
984: return MatSetValues(mat, 1, &i, 1, &j, &va, mode);
985: }
987: /*@C
988: MatGetValue - Gets a single value from a matrix
990: Not Collective; can only return a value owned by the given process
992: Input Parameters:
993: + mat - the matrix
994: . row - the row location of the entry
995: - col - the column location of the entry
997: Output Parameter:
998: . va - the value
1000: Level: advanced
1002: Notes:
1003: The matrix must have been assembled with `MatAssemblyBegin()` and `MatAssemblyEnd()` before this call
1005: For efficiency one should use `MatGetValues()` and get several values simultaneously.
1007: See notes for `MatGetValues()`.
1009: .seealso: [](ch_matrices), `Mat`, `MatAssemblyBegin()`, `MatAssemblyEnd()`, `MatSetValue()`, `MatGetValuesLocal()`, `MatGetValues()`
1010: @*/
1011: static inline PetscErrorCode MatGetValue(Mat mat, PetscInt row, PetscInt col, PetscScalar *va)
1012: {
1013: return MatGetValues(mat, 1, &row, 1, &col, va);
1014: }
1016: /*@C
1017: MatSetValueLocal - Inserts or adds a single value into a matrix, using a local numbering of the nodes.
1019: Not Collective
1021: Input Parameters:
1022: + mat - the matrix
1023: . i - the row location of the entry
1024: . j - the column location of the entry
1025: . va - the value to insert
1026: - mode - either `INSERT_VALUES` or `ADD_VALUES`
1028: Level: intermediate
1030: Notes:
1031: For efficiency one should use `MatSetValuesLocal()` and set several values simultaneously.
1033: See notes for `MatSetValuesLocal()` for additional information on when and how this function can be used.
1035: .seealso: [](ch_matrices), `MatSetValue()`, `MatSetValuesLocal()`
1036: @*/
1037: static inline PetscErrorCode MatSetValueLocal(Mat mat, PetscInt i, PetscInt j, PetscScalar va, InsertMode mode)
1038: {
1039: return MatSetValuesLocal(mat, 1, &i, 1, &j, &va, mode);
1040: }
1042: /*MC
1043: MatPreallocateBegin - Begins the block of code that will count the number of nonzeros per
1044: row in a matrix providing the data that one can use to correctly preallocate the matrix.
1046: Synopsis:
1047: #include <petscmat.h>
1048: PetscErrorCode MatPreallocateBegin(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
1050: Collective
1052: Input Parameters:
1053: + comm - the communicator that will share the eventually allocated matrix
1054: . nrows - the number of LOCAL rows in the matrix
1055: - ncols - the number of LOCAL columns in the matrix
1057: Output Parameters:
1058: + dnz - the array that will be passed to the matrix preallocation routines
1059: - onz - the other array passed to the matrix preallocation routines
1061: Level: deprecated (since v3.19)
1063: Notes:
1064: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1065: the use of this routine
1067: This is a macro that handles its own error checking, it does not return an error code.
1069: Do not malloc or free `dnz` and `onz`, that is handled internally by these routines
1071: Developer Note:
1072: This is a MACRO, not a function, because it has a leading { that is closed by `PetscPreallocateFinalize()`.
1074: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`,
1075: `MatPreallocateSymmetricSetLocalBlock()`
1076: M*/
1077: #define MatPreallocateBegin(comm, nrows, ncols, dnz, onz) \
1078: do { \
1079: PetscInt __nrows = (nrows), __ncols = (ncols), __rstart, __end = 0; \
1080: PetscInt PETSC_UNUSED __start; \
1081: PetscCall(PetscCalloc2(__nrows, &(dnz), __nrows, &(onz))); \
1082: PetscCallMPI(MPI_Scan(&__ncols, &__end, 1, MPIU_INT, MPI_SUM, comm)); \
1083: __start = __end - __ncols; \
1084: (void)__start; \
1085: PetscCallMPI(MPI_Scan(&__nrows, &__rstart, 1, MPIU_INT, MPI_SUM, comm)); \
1086: __rstart -= __nrows
1088: #define MatPreallocateInitialize(...) PETSC_DEPRECATED_MACRO(3, 18, 0, "MatPreallocateBegin()", ) MatPreallocateBegin(__VA_ARGS__)
1090: /*MC
1091: MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1092: inserted using a local number of the rows and columns
1094: Synopsis:
1095: #include <petscmat.h>
1096: PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
1098: Not Collective
1100: Input Parameters:
1101: + map - the row mapping from local numbering to global numbering
1102: . nrows - the number of rows indicated
1103: . rows - the indices of the rows
1104: . cmap - the column mapping from local to global numbering
1105: . ncols - the number of columns in the matrix
1106: . cols - the columns indicated
1107: . dnz - the array that will be passed to the matrix preallocation routines
1108: - onz - the other array passed to the matrix preallocation routines
1110: Level: deprecated (since v3.19)
1112: Notes:
1113: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1114: the use of this routine
1116: Do not malloc or free `dnz` and `onz`, that is handled internally by these routines
1118: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`
1119: `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocalRemoveDups()`
1120: M*/
1121: #define MatPreallocateSetLocal(rmap, nrows, rows, cmap, ncols, cols, dnz, onz) \
1122: PetscMacroReturnStandard(PetscCall(ISLocalToGlobalMappingApply(rmap, nrows, rows, rows)); PetscCall(ISLocalToGlobalMappingApply(cmap, ncols, cols, cols)); for (PetscInt __l = 0; __l < nrows; __l++) PetscCall(MatPreallocateSet((rows)[__l], ncols, cols, dnz, onz));)
1124: /*MC
1125: MatPreallocateSetLocalRemoveDups - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1126: inserted using a local number of the rows and columns. This version removes any duplicate columns in cols
1128: Synopsis:
1129: #include <petscmat.h>
1130: PetscErrorCode MatPreallocateSetLocalRemoveDups(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
1132: Not Collective
1134: Input Parameters:
1135: + map - the row mapping from local numbering to global numbering
1136: . nrows - the number of rows indicated
1137: . rows - the indices of the rows (these values are mapped to the global values)
1138: . cmap - the column mapping from local to global numbering
1139: . ncols - the number of columns in the matrix (this value will be changed if duplicate columns are found)
1140: . cols - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed)
1141: . dnz - the array that will be passed to the matrix preallocation routines
1142: - onz - the other array passed to the matrix preallocation routines
1144: Level: deprecated (since v3.19)
1146: Notes:
1147: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1148: the use of this routine
1150: Do not malloc or free `dnz` and `onz`, that is handled internally by these routines
1152: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`
1153: `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocal()`
1154: M*/
1155: #define MatPreallocateSetLocalRemoveDups(rmap, nrows, rows, cmap, ncols, cols, dnz, onz) \
1156: PetscMacroReturnStandard(PetscCall(ISLocalToGlobalMappingApply(rmap, nrows, rows, rows)); PetscCall(ISLocalToGlobalMappingApply(cmap, ncols, cols, cols)); PetscCall(PetscSortRemoveDupsInt(&ncols, cols)); for (PetscInt __l = 0; __l < nrows; __l++) PetscCall(MatPreallocateSet((rows)[__l], ncols, cols, dnz, onz));)
1158: /*MC
1159: MatPreallocateSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1160: inserted using a local number of the rows and columns
1162: Synopsis:
1163: #include <petscmat.h>
1164: PetscErrorCode MatPreallocateSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
1166: Not Collective
1168: Input Parameters:
1169: + map - the row mapping from local numbering to global numbering
1170: . nrows - the number of rows indicated
1171: . rows - the indices of the rows
1172: . cmap - the column mapping from local to global numbering
1173: . ncols - the number of columns in the matrix
1174: . cols - the columns indicated
1175: . dnz - the array that will be passed to the matrix preallocation routines
1176: - onz - the other array passed to the matrix preallocation routines
1178: Level: deprecated (since v3.19)
1180: Notes:
1181: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1182: the use of this routine
1184: Do not malloc or free `dnz` and `onz`, that is handled internally by these routines
1186: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`
1187: `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()`
1188: M*/
1189: #define MatPreallocateSetLocalBlock(rmap, nrows, rows, cmap, ncols, cols, dnz, onz) \
1190: PetscMacroReturnStandard(PetscCall(ISLocalToGlobalMappingApplyBlock(rmap, nrows, rows, rows)); PetscCall(ISLocalToGlobalMappingApplyBlock(cmap, ncols, cols, cols)); for (PetscInt __l = 0; __l < nrows; __l++) PetscCall(MatPreallocateSet((rows)[__l], ncols, cols, dnz, onz));)
1192: /*MC
1193: MatPreallocateSymmetricSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1194: inserted using a local number of the rows and columns
1196: Synopsis:
1197: #include <petscmat.h>
1198: PetscErrorCode MatPreallocateSymmetricSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
1200: Not Collective
1202: Input Parameters:
1203: + map - the mapping between local numbering and global numbering
1204: . nrows - the number of rows indicated
1205: . rows - the indices of the rows
1206: . ncols - the number of columns in the matrix
1207: . cols - the columns indicated
1208: . dnz - the array that will be passed to the matrix preallocation routines
1209: - onz - the other array passed to the matrix preallocation routines
1211: Level: deprecated (since v3.19)
1213: Notes:
1214: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1215: the use of this routine
1217: Do not malloc or free `dnz` and `onz` that is handled internally by these routines
1219: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`
1220: `MatPreallocateBegin()`, `MatPreallocateSetLocal()`
1221: M*/
1222: #define MatPreallocateSymmetricSetLocalBlock(map, nrows, rows, ncols, cols, dnz, onz) \
1223: PetscMacroReturnStandard(PetscCall(ISLocalToGlobalMappingApplyBlock(map, nrows, rows, rows)); PetscCall(ISLocalToGlobalMappingApplyBlock(map, ncols, cols, cols)); for (PetscInt __l = 0; __l < nrows; __l++) PetscCall(MatPreallocateSymmetricSetBlock((rows)[__l], ncols, cols, dnz, onz));)
1225: /*MC
1226: MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1227: inserted using a local number of the rows and columns
1229: Synopsis:
1230: #include <petscmat.h>
1231: PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
1233: Not Collective
1235: Input Parameters:
1236: + row - the row
1237: . ncols - the number of columns in the matrix
1238: - cols - the columns indicated
1240: Output Parameters:
1241: + dnz - the array that will be passed to the matrix preallocation routines
1242: - onz - the other array passed to the matrix preallocation routines
1244: Level: deprecated (since v3.19)
1246: Notes:
1247: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1248: the use of this routine
1250: Do not malloc or free `dnz` and `onz` that is handled internally by these routines
1252: This is a MACRO, not a function, because it uses variables declared in MatPreallocateBegin().
1254: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`
1255: `MatPreallocateBegin()`, `MatPreallocateSetLocal()`
1256: M*/
1257: #define MatPreallocateSet(row, nc, cols, dnz, onz) \
1258: PetscMacroReturnStandard(PetscCheck(row >= __rstart, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Trying to set preallocation for row %" PetscInt_FMT " less than first local row %" PetscInt_FMT, row, __rstart); PetscCheck(row < __rstart + __nrows, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Trying to set preallocation for row %" PetscInt_FMT " greater than last local row %" PetscInt_FMT, row, __rstart + __nrows - 1); for (PetscInt __i = 0; __i < nc; ++__i) { \
1259: if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
1260: else if (dnz[row - __rstart] < __ncols) dnz[row - __rstart]++; \
1261: })
1263: /*MC
1264: MatPreallocateSymmetricSetBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1265: inserted using a local number of the rows and columns
1267: Synopsis:
1268: #include <petscmat.h>
1269: PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
1271: Not Collective
1273: Input Parameters:
1274: + nrows - the number of rows indicated
1275: . rows - the indices of the rows
1276: . ncols - the number of columns in the matrix
1277: . cols - the columns indicated
1278: . dnz - the array that will be passed to the matrix preallocation routines
1279: - onz - the other array passed to the matrix preallocation routines
1281: Level: deprecated (since v3.19)
1283: Notes:
1284: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1285: the use of this routine
1287: Do not malloc or free `dnz` and `onz` that is handled internally by these routines
1289: This is a MACRO, not a function, because it uses variables declared in MatPreallocateBegin().
1291: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateBegin()`,
1292: `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocal()`
1293: M*/
1294: #define MatPreallocateSymmetricSetBlock(row, nc, cols, dnz, onz) \
1295: PetscMacroReturnStandard(for (PetscInt __i = 0; __i < nc; __i++) { \
1296: if (cols[__i] >= __end) onz[row - __rstart]++; \
1297: else if (cols[__i] >= row && dnz[row - __rstart] < __ncols) dnz[row - __rstart]++; \
1298: })
1300: /*MC
1301: MatPreallocateLocation - An alternative to MatPreallocateSet() that puts the nonzero locations into the matrix if it exists
1303: Synopsis:
1304: #include <petscmat.h>
1305: PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)
1307: Not Collective
1309: Input Parameters:
1310: + A - matrix
1311: . row - row where values exist (must be local to this process)
1312: . ncols - number of columns
1313: . cols - columns with nonzeros
1314: . dnz - the array that will be passed to the matrix preallocation routines
1315: - onz - the other array passed to the matrix preallocation routines
1317: Level: deprecated (since v3.19)
1319: Notes:
1320: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1321: the use of this routine
1323: Do not malloc or free `dnz` and `onz` that is handled internally by these routines
1325: Developer Note:
1326: This is a MACRO, not a function, because it uses a bunch of variables private to the MatPreallocation.... routines.
1328: .seealso: [](ch_matrices), `MatPreallocateBegin()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`,
1329: `MatPreallocateSymmetricSetLocalBlock()`
1330: M*/
1331: #define MatPreallocateLocation(A, row, ncols, cols, dnz, onz) (A ? MatSetValues(A, 1, &row, ncols, cols, NULL, INSERT_VALUES) : MatPreallocateSet(row, ncols, cols, dnz, onz))
1333: /*MC
1334: MatPreallocateEnd - Ends the block of code that will count the number of nonzeros per
1335: row in a matrix providing the data that one can use to correctly preallocate the matrix.
1337: Synopsis:
1338: #include <petscmat.h>
1339: PetscErrorCode MatPreallocateEnd(PetscInt *dnz, PetscInt *onz)
1341: Collective
1343: Input Parameters:
1344: + dnz - the array that was be passed to the matrix preallocation routines
1345: - onz - the other array passed to the matrix preallocation routines
1347: Level: deprecated (since v3.19)
1349: Notes:
1350: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1351: the use of this routine
1353: Do not malloc or free `dnz` and `onz`, that is handled internally by these routines
1355: Developer Note:
1356: This is a MACRO, not a function, because it closes the { started in MatPreallocateBegin().
1358: .seealso: [](ch_matrices), `MatPreallocateBegin()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`,
1359: `MatPreallocateSymmetricSetLocalBlock()`
1360: M*/
1361: #define MatPreallocateEnd(dnz, onz) \
1362: PetscCall(PetscFree2(dnz, onz)); \
1363: } \
1364: while (0)
1366: #define MatPreallocateFinalize(...) PETSC_DEPRECATED_MACRO(3, 18, 0, "MatPreallocateEnd()", ) MatPreallocateEnd(__VA_ARGS__)
1368: /* Routines unique to particular data structures */
1369: PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat, void *);
1371: PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat, IS *, IS *);
1372: PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat, PetscInt *, PetscInt *[], PetscInt *);
1374: PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat, PetscInt[]);
1375: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat, PetscInt[]);
1376: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], Mat *);
1377: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], Mat *);
1378: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], Mat *);
1379: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], Mat *, PetscCount, PetscBool);
1381: #define MAT_SKIP_ALLOCATION -4
1383: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[]);
1384: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[]);
1385: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat, PetscInt, const PetscInt[]);
1386: PETSC_EXTERN PetscErrorCode MatSeqAIJSetTotalPreallocation(Mat, PetscInt);
1388: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
1389: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
1390: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
1391: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat, const PetscInt[], const PetscInt[], const PetscScalar[]);
1392: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]);
1393: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat, const PetscInt[], const PetscInt[], const PetscScalar[]);
1394: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]);
1395: PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat, PetscInt[], PetscInt[], PetscInt[]);
1396: PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat, Mat *);
1397: PETSC_EXTERN PetscErrorCode MatMPIAdjToSeqRankZero(Mat, Mat *);
1398: PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat, PetscScalar[]);
1399: PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat, PetscScalar[]);
1400: PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat, Mat *, Mat *, const PetscInt *[]);
1401: PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat, Mat *, Mat *, const PetscInt *[]);
1402: PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat, Mat *);
1404: PETSC_EXTERN PetscErrorCode MatDenseGetLDA(Mat, PetscInt *);
1405: PETSC_EXTERN PetscErrorCode MatDenseSetLDA(Mat, PetscInt);
1406: PETSC_DEPRECATED_FUNCTION(3, 14, 0, "MatDenseSetLDA()", ) static inline PetscErrorCode MatSeqDenseSetLDA(Mat A, PetscInt lda)
1407: {
1408: return MatDenseSetLDA(A, lda);
1409: }
1410: PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat, Mat *);
1412: PETSC_EXTERN PetscErrorCode MatBlockMatSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[]);
1414: PETSC_EXTERN PetscErrorCode MatStoreValues(Mat);
1415: PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat);
1417: PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat, IS *);
1418: PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat, IS *);
1419: /*
1420: These routines are not usually accessed directly, rather solving is
1421: done through the KSP and PC interfaces.
1422: */
1424: /*J
1425: MatOrderingType - String with the name of a PETSc matrix ordering. These orderings are most commonly used
1426: to reduce fill in sparse factorizations.
1428: Level: beginner
1430: Notes:
1431: If `MATORDERINGEXTERNAL` is used then PETSc does not compute an ordering and instead the external factorization solver package called utilizes one
1432: of its own.
1434: There is no `MatOrdering` object, the ordering is obtained directly from the matrix with `MatGetOrdering()`
1436: Developer Note:
1437: This API should be converted to an API similar to those for `MatColoring` and `MatPartitioning`
1439: .seealso: [](ch_matrices), [](sec_graph), `MatGetFactor()`, `MatGetOrdering()`, `MatColoringType`, `MatPartitioningType`, `MatCoarsenType`, `MatCoarsenType`,
1440: `PCFactorSetOrderingType()`
1441: J*/
1442: typedef const char *MatOrderingType;
1443: #define MATORDERINGNATURAL "natural"
1444: #define MATORDERINGND "nd"
1445: #define MATORDERING1WD "1wd"
1446: #define MATORDERINGRCM "rcm"
1447: #define MATORDERINGQMD "qmd"
1448: #define MATORDERINGROWLENGTH "rowlength"
1449: #define MATORDERINGWBM "wbm"
1450: #define MATORDERINGSPECTRAL "spectral"
1451: #define MATORDERINGAMD "amd" /* only works if UMFPACK is installed with PETSc */
1452: #define MATORDERINGMETISND "metisnd" /* only works if METIS is installed with PETSc */
1453: #define MATORDERINGNATURAL_OR_ND "natural_or_nd" /* special coase used for Cholesky and ICC, allows ND when AIJ matrix is used but Natural when SBAIJ is used */
1454: #define MATORDERINGEXTERNAL "external" /* uses an ordering type internal to the factorization package */
1456: PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat, MatOrderingType, IS *, IS *);
1457: PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList *);
1458: PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[], PetscErrorCode (*)(Mat, MatOrderingType, IS *, IS *));
1459: PETSC_EXTERN PetscFunctionList MatOrderingList;
1461: #include "petscmatcoarsen.h"
1463: PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat, PetscReal, IS, IS);
1464: PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat, PetscReal, PetscBool, Mat *);
1466: PETSC_EXTERN PetscErrorCode MatFactorGetPreferredOrdering(Mat, MatFactorType, MatOrderingType *);
1468: /*S
1469: MatFactorShiftType - Type of numeric shift used for factorizations
1471: Values:
1472: + `MAT_SHIFT_NONE` - do not shift the matrix diagonal entries
1473: . `MAT_SHIFT_NONZERO` - shift the entries to be non-zero
1474: . `MAT_SHIFT_POSITIVE_DEFINITE` - shift the entries to force the factorization to be positive definite
1475: - `MAT_SHIFT_INBLOCKS` - only shift the factors inside the small dense diagonal blocks of the matrix, for example with `MATBAIJ`
1477: Level: intermediate
1479: .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `PCFactorSetShiftType()`
1480: S*/
1481: typedef enum {
1482: MAT_SHIFT_NONE,
1483: MAT_SHIFT_NONZERO,
1484: MAT_SHIFT_POSITIVE_DEFINITE,
1485: MAT_SHIFT_INBLOCKS
1486: } MatFactorShiftType;
1487: PETSC_EXTERN const char *const MatFactorShiftTypes[];
1488: PETSC_EXTERN const char *const MatFactorShiftTypesDetail[];
1490: /*S
1491: MatFactorError - indicates what type of error was generated in a matrix factorization
1493: Values:
1494: + `MAT_FACTOR_NOERROR` - there was no error during the factorization
1495: . `MAT_FACTOR_STRUCT_ZEROPIVOT` - there was a missing entry in a diagonal location of the matrix
1496: . `MAT_FACTOR_NUMERIC_ZEROPIVOT` - there was a (near) zero pivot during the factorization
1497: . `MAT_FACTOR_OUTMEMORY` - the factorization has run out of memory
1498: - `MAT_FACTOR_OTHER` - some other error has occurred.
1500: Level: intermediate
1502: Note:
1503: When a factorization is done in a preconditioner `PC` the error may be propagated up to a `PCFailedReason` or a `KSPConvergedReason`
1505: .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatFactorGetError()`, `MatFactorGetErrorZeroPivot()`, `MatFactorClearError()`,
1506: `PCFailedReason`, `PCGetFailedReason()`, `KSPConvergedReason`
1507: S*/
1508: typedef enum {
1509: MAT_FACTOR_NOERROR,
1510: MAT_FACTOR_STRUCT_ZEROPIVOT,
1511: MAT_FACTOR_NUMERIC_ZEROPIVOT,
1512: MAT_FACTOR_OUTMEMORY,
1513: MAT_FACTOR_OTHER
1514: } MatFactorError;
1516: PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat, MatFactorError *);
1517: PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat);
1518: PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat, PetscReal *, PetscInt *);
1520: /*S
1521: MatFactorInfo - Data passed into the matrix factorization routines, and information about the resulting factorization
1523: Level: developer
1525: Note:
1526: You can use `MatFactorInfoInitialize()` to set default values.
1528: Fortran Note:
1529: `MatFactorInfo` is a derived type, use e.g. `matfactorinfo%dt` to access its components.
1531: .seealso: [](ch_matrices), `Mat`, `MatInfo`, `MatGetFactor()`, `MatLUFactorSymbolic()`, `MatILUFactorSymbolic()`, `MatCholeskyFactorSymbolic()`,
1532: `MatICCFactorSymbolic()`, `MatICCFactor()`, `MatFactorInfoInitialize()`
1533: S*/
1534: typedef struct {
1535: PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */
1536: PetscReal usedt;
1537: PetscReal dt; /* drop tolerance */
1538: PetscReal dtcol; /* tolerance for pivoting */
1539: PetscReal dtcount; /* maximum nonzeros to be allowed per row */
1540: PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1541: PetscReal levels; /* ICC/ILU(levels) */
1542: PetscReal pivotinblocks; /* BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 factorization may be faster if do not pivot */
1543: PetscReal zeropivot; /* pivot is called zero if less than this */
1544: PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */
1545: PetscReal shiftamount; /* how large the shift is */
1546: PetscBool factoronhost; /* do factorization on host instead of device (for device matrix types) */
1547: PetscBool solveonhost; /* do mat solve on host with the factor (for device matrix types) */
1548: } MatFactorInfo;
1550: PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo *);
1551: PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat, IS, const MatFactorInfo *);
1552: PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat, Mat, IS, const MatFactorInfo *);
1553: PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat, Mat, const MatFactorInfo *);
1554: PETSC_EXTERN PetscErrorCode MatLUFactor(Mat, IS, IS, const MatFactorInfo *);
1555: PETSC_EXTERN PetscErrorCode MatILUFactor(Mat, IS, IS, const MatFactorInfo *);
1556: PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat, Mat, IS, IS, const MatFactorInfo *);
1557: PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat, Mat, IS, IS, const MatFactorInfo *);
1558: PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat, Mat, IS, const MatFactorInfo *);
1559: PETSC_EXTERN PetscErrorCode MatICCFactor(Mat, IS, const MatFactorInfo *);
1560: PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat, Mat, const MatFactorInfo *);
1561: PETSC_EXTERN PetscErrorCode MatQRFactor(Mat, IS, const MatFactorInfo *);
1562: PETSC_EXTERN PetscErrorCode MatQRFactorSymbolic(Mat, Mat, IS, const MatFactorInfo *);
1563: PETSC_EXTERN PetscErrorCode MatQRFactorNumeric(Mat, Mat, const MatFactorInfo *);
1564: PETSC_EXTERN PetscErrorCode MatGetInertia(Mat, PetscInt *, PetscInt *, PetscInt *);
1565: PETSC_EXTERN PetscErrorCode MatSolve(Mat, Vec, Vec);
1566: PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat, Vec, Vec);
1567: PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat, Vec, Vec);
1568: PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat, Vec, Vec, Vec);
1569: PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat, Vec, Vec);
1570: PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat, Vec, Vec, Vec);
1571: PETSC_EXTERN PetscErrorCode MatSolves(Mat, Vecs, Vecs);
1572: PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat);
1574: typedef enum {
1575: MAT_FACTOR_SCHUR_UNFACTORED,
1576: MAT_FACTOR_SCHUR_FACTORED,
1577: MAT_FACTOR_SCHUR_INVERTED
1578: } MatFactorSchurStatus;
1579: PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat, IS);
1580: PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat, Mat *, MatFactorSchurStatus *);
1581: PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat, Mat *, MatFactorSchurStatus);
1582: PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat);
1583: PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat, Mat *, MatFactorSchurStatus *);
1584: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat, Vec, Vec);
1585: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat, Vec, Vec);
1586: PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat);
1588: PETSC_EXTERN PetscErrorCode MatSeqDenseInvert(Mat);
1589: /*E
1590: MatSORType - What type of (S)SOR to perform
1592: Values:
1593: + `SOR_FORWARD_SWEEP` - do a sweep from the first row of the matrix to the last
1594: . `SOR_BACKWARD_SWEEP` - do a sweep from the last row to the first
1595: . `SOR_SYMMETRIC_SWEEP` - do a sweep from the first row to the last and then back to the first
1596: . `SOR_LOCAL_FORWARD_SWEEP` - each MPI process does its own forward sweep with no communication
1597: . `SOR_LOCAL_BACKWARD_SWEEP` - each MPI process does its own backward sweep with no communication
1598: . `SOR_LOCAL_SYMMETRIC_SWEEP` - each MPI process does its own symmetric sweep with no communication
1599: . `SOR_ZERO_INITIAL_GUESS` - indicates the initial solution is zero so the sweep can avoid unneeded computation
1600: . `SOR_EISENSTAT` - apply the Eisentat application of SOR, see `PCEISENSTAT`
1601: . `SOR_APPLY_UPPER` - multiply by the upper triangular portion of the matrix
1602: - `SOR_APPLY_LOWER` - multiply by the lower triangular portion of the matrix
1604: Level: beginner
1606: Note:
1607: These may be bitwise ORd together
1609: Developer Note:
1610: Since `MatSORType` may be bitwise ORd together, so do not change the numerical values below
1612: .seealso: [](ch_matrices), `MatSOR()`
1613: E*/
1614: typedef enum {
1615: SOR_FORWARD_SWEEP = 1,
1616: SOR_BACKWARD_SWEEP = 2,
1617: SOR_SYMMETRIC_SWEEP = 3,
1618: SOR_LOCAL_FORWARD_SWEEP = 4,
1619: SOR_LOCAL_BACKWARD_SWEEP = 8,
1620: SOR_LOCAL_SYMMETRIC_SWEEP = 12,
1621: SOR_ZERO_INITIAL_GUESS = 16,
1622: SOR_EISENSTAT = 32,
1623: SOR_APPLY_UPPER = 64,
1624: SOR_APPLY_LOWER = 128
1625: } MatSORType;
1626: PETSC_EXTERN PetscErrorCode MatSOR(Mat, Vec, PetscReal, MatSORType, PetscReal, PetscInt, PetscInt, Vec);
1628: /*S
1629: MatColoring - Object for managing the coloring of matrices.
1631: Level: beginner
1633: Notes:
1634: Coloring of matrices can be computed directly from the sparse matrix nonzero structure via the `MatColoring` object or from the mesh from which the
1635: matrix comes from via `DMCreateColoring()`. In general using the mesh produces a more optimal coloring (fewer colors).
1637: Once a coloring is available `MatFDColoringCreate()` creates an object that can be used to efficiently compute Jacobians using that coloring. This
1638: same object can also be used to efficiently convert data created by Automatic Differentiation tools to PETSc sparse matrices.
1640: .seealso: [](ch_matrices), [](sec_graph), `MatFDColoringCreate()`, `MatColoringWeightType`, `ISColoring`, `MatFDColoring`, `DMCreateColoring()`, `MatColoringCreate()`,
1641: `MatPartitioning`, `MatColoringType`, `MatPartitioningType`, `MatOrderingType`, `MatColoringSetWeightType()`,
1642: `MatColoringSetWeights()`, `MatCoarsenType`, `MatCoarsen`
1643: S*/
1644: typedef struct _p_MatColoring *MatColoring;
1646: /*J
1647: MatColoringType - String with the name of a PETSc matrix coloring
1649: Level: beginner
1651: .seealso: [](ch_matrices), [](sec_graph), `Mat`, `MatFDColoringCreate()`, `MatColoringSetType()`, `MatColoring`
1652: J*/
1653: typedef const char *MatColoringType;
1654: #define MATCOLORINGJP "jp"
1655: #define MATCOLORINGPOWER "power"
1656: #define MATCOLORINGNATURAL "natural"
1657: #define MATCOLORINGSL "sl"
1658: #define MATCOLORINGLF "lf"
1659: #define MATCOLORINGID "id"
1660: #define MATCOLORINGGREEDY "greedy"
1662: /*E
1663: MatColoringWeightType - Type of weight scheme used for the coloring algorithm
1665: Values:
1666: + `MAT_COLORING_RANDOM` - Random weights
1667: . `MAT_COLORING_LEXICAL` - Lexical weighting based upon global numbering.
1668: - `MAT_COLORING_LF` - Last-first weighting.
1670: Level: intermediate
1672: .seealso: [](ch_matrices), `MatColoring`, `MatColoringCreate()`, `MatColoringSetWeightType()`, `MatColoringSetWeights()`
1673: E*/
1674: typedef enum {
1675: MAT_COLORING_WEIGHT_RANDOM,
1676: MAT_COLORING_WEIGHT_LEXICAL,
1677: MAT_COLORING_WEIGHT_LF,
1678: MAT_COLORING_WEIGHT_SL
1679: } MatColoringWeightType;
1681: PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat, MatColoring *);
1682: PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat, PetscInt, PetscInt *);
1683: PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring *);
1684: PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring, PetscViewer);
1685: PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring, MatColoringType);
1686: PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring);
1687: PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring, PetscInt);
1688: PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring, PetscInt *);
1689: PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring, PetscInt);
1690: PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring, PetscInt *);
1691: PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring, ISColoring *);
1692: PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[], PetscErrorCode (*)(MatColoring));
1693: PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat, PetscInt, PetscInt, ISColoringValue[], ISColoring *);
1694: PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring, MatColoringWeightType);
1695: PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring, PetscReal *, PetscInt *);
1696: PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring, PetscReal **, PetscInt **lperm);
1697: PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring, ISColoring);
1698: PETSC_DEPRECATED_FUNCTION(3, 10, 0, "MatColoringTest()", ) static inline PetscErrorCode MatColoringTestValid(MatColoring matcoloring, ISColoring iscoloring)
1699: {
1700: return MatColoringTest(matcoloring, iscoloring);
1701: }
1702: PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat, ISColoring);
1704: /*S
1705: MatFDColoring - Object for computing a sparse Jacobian via finite differences with coloring
1707: Level: beginner
1709: Options Database Key:
1710: . -snes_fd_coloring - cause the Jacobian needed by `SNES` to be computed via a use of this object
1712: Note:
1713: This object is created utilizing a coloring provided by the `MatColoring` object or `DMCreateColoring()`
1715: .seealso: [](ch_matrices), `Mat`, `MatFDColoringCreate()`, `MatFDColoringSetFunction()`, `MatColoring`, `DMCreateColoring()`
1716: S*/
1717: typedef struct _p_MatFDColoring *MatFDColoring;
1719: /*S
1720: MatFDColoringFn - Function provided to `MatFDColoringSetFunction()` that computes the function being differenced
1722: Level: advanced
1724: Calling Sequence:
1725: + snes - either a `SNES` object if used within `SNES` otherwise an unused parameter
1726: . in - the location where the Jacobian is to be computed
1727: . out - the location to put the computed function value
1728: - fctx - the function context passed into `MatFDColoringSetFunction()`
1730: .seealso: [](ch_matrices), `Mat`, `MatCreateMFFD()`, `MatMFFDSetFunction()`, `MatMFFDiFn`, `MatMFFDiBaseFn`
1731: S*/
1732: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode MatFDColoringFn(void *snes, Vec x, Vec y, void *fctx);
1734: PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat, ISColoring, MatFDColoring *);
1735: PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring *);
1736: PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring, PetscViewer);
1737: PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring, MatFDColoringFn *, void *);
1738: PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring, MatFDColoringFn **, void **);
1739: PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring, PetscReal, PetscReal);
1740: PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
1741: PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat, MatFDColoring, Vec, void *);
1742: PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring, Vec);
1743: PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring, PetscInt *, const PetscInt *[]);
1744: PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat, ISColoring, MatFDColoring);
1745: PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring, PetscInt, PetscInt);
1746: PETSC_EXTERN PetscErrorCode MatFDColoringSetValues(Mat, MatFDColoring, const PetscScalar *);
1748: /*S
1749: MatTransposeColoring - Object for computing a sparse matrix product $C = A*B^T$ via coloring
1751: Level: developer
1753: .seealso: [](ch_matrices), `Mat`, `MatProductType`, `MatTransposeColoringCreate()`
1754: S*/
1755: typedef struct _p_MatTransposeColoring *MatTransposeColoring;
1757: PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat, ISColoring, MatTransposeColoring *);
1758: PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring, Mat, Mat);
1759: PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring, Mat, Mat);
1760: PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring *);
1762: /*S
1763: MatPartitioning - Object for managing the partitioning of a matrix or graph
1765: Level: beginner
1767: Note:
1768: There is also a `PetscPartitioner` object that provides the same functionality. It can utilize the `MatPartitioning` operations
1769: via `PetscPartitionerSetType`(p,`PETSCPARTITIONERMATPARTITIONING`)
1771: Developer Note:
1772: It is an extra maintenance and documentation cost to have two objects with the same functionality. `PetscPartitioner` should be removed
1774: .seealso: [](ch_matrices), [](sec_graph), `Mat`, `MatPartitioningCreate()`, `MatPartitioningType`, `MatColoring`, `MatGetOrdering()`, `MatOrderingType`,
1775: `MatCoarsenType`, `MatCoarsenType`
1776: S*/
1777: typedef struct _p_MatPartitioning *MatPartitioning;
1779: /*J
1780: MatPartitioningType - String with the name of a PETSc matrix partitioning
1782: Level: beginner
1783: dm
1784: .seealso: [](ch_matrices), [](sec_graph), `Mat`, `MatPartitioningCreate()`, `MatPartitioning`, `MatPartitioningSetType()`, `MatColoringType`, `MatOrderingType`,
1785: `MatCoarsenType`, `MatCoarsenType`
1786: J*/
1787: typedef const char *MatPartitioningType;
1788: #define MATPARTITIONINGCURRENT "current"
1789: #define MATPARTITIONINGAVERAGE "average"
1790: #define MATPARTITIONINGSQUARE "square"
1791: #define MATPARTITIONINGPARMETIS "parmetis"
1792: #define MATPARTITIONINGCHACO "chaco"
1793: #define MATPARTITIONINGPARTY "party"
1794: #define MATPARTITIONINGPTSCOTCH "ptscotch"
1795: #define MATPARTITIONINGHIERARCH "hierarch"
1797: PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm, MatPartitioning *);
1798: PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning, MatPartitioningType);
1799: PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning, PetscInt);
1800: PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning, Mat);
1801: PETSC_EXTERN PetscErrorCode MatPartitioningSetNumberVertexWeights(MatPartitioning, PetscInt);
1802: PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning, const PetscInt[]);
1803: PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning, const PetscReal[]);
1804: PETSC_EXTERN PetscErrorCode MatPartitioningSetUseEdgeWeights(MatPartitioning, PetscBool);
1805: PETSC_EXTERN PetscErrorCode MatPartitioningGetUseEdgeWeights(MatPartitioning, PetscBool *);
1806: PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning, IS *);
1807: PETSC_EXTERN PetscErrorCode MatPartitioningImprove(MatPartitioning, IS *);
1808: PETSC_EXTERN PetscErrorCode MatPartitioningViewImbalance(MatPartitioning, IS);
1809: PETSC_EXTERN PetscErrorCode MatPartitioningApplyND(MatPartitioning, IS *);
1810: PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning *);
1811: PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[], PetscErrorCode (*)(MatPartitioning));
1812: PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning, PetscViewer);
1813: PETSC_EXTERN PetscErrorCode MatPartitioningViewFromOptions(MatPartitioning, PetscObject, const char[]);
1814: PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
1815: PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning, MatPartitioningType *);
1817: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning);
1818: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1819: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);
1821: typedef enum {
1822: MP_CHACO_MULTILEVEL = 1,
1823: MP_CHACO_SPECTRAL = 2,
1824: MP_CHACO_LINEAR = 4,
1825: MP_CHACO_RANDOM = 5,
1826: MP_CHACO_SCATTERED = 6
1827: } MPChacoGlobalType;
1828: PETSC_EXTERN const char *const MPChacoGlobalTypes[];
1829: typedef enum {
1830: MP_CHACO_KERNIGHAN = 1,
1831: MP_CHACO_NONE = 2
1832: } MPChacoLocalType;
1833: PETSC_EXTERN const char *const MPChacoLocalTypes[];
1834: typedef enum {
1835: MP_CHACO_LANCZOS = 0,
1836: MP_CHACO_RQI = 1
1837: } MPChacoEigenType;
1838: PETSC_EXTERN const char *const MPChacoEigenTypes[];
1840: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
1841: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning, MPChacoGlobalType *);
1842: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1843: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning, MPChacoLocalType *);
1844: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning, PetscReal);
1845: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning, MPChacoEigenType);
1846: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning, MPChacoEigenType *);
1847: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1848: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning, PetscReal *);
1849: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
1850: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning, PetscInt *);
1852: #define MP_PARTY_OPT "opt"
1853: #define MP_PARTY_LIN "lin"
1854: #define MP_PARTY_SCA "sca"
1855: #define MP_PARTY_RAN "ran"
1856: #define MP_PARTY_GBF "gbf"
1857: #define MP_PARTY_GCF "gcf"
1858: #define MP_PARTY_BUB "bub"
1859: #define MP_PARTY_DEF "def"
1860: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning, const char *);
1861: #define MP_PARTY_HELPFUL_SETS "hs"
1862: #define MP_PARTY_KERNIGHAN_LIN "kl"
1863: #define MP_PARTY_NONE "no"
1864: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning, const char *);
1865: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning, PetscReal);
1866: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning, PetscBool);
1867: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning, PetscBool);
1869: typedef enum {
1870: MP_PTSCOTCH_DEFAULT,
1871: MP_PTSCOTCH_QUALITY,
1872: MP_PTSCOTCH_SPEED,
1873: MP_PTSCOTCH_BALANCE,
1874: MP_PTSCOTCH_SAFETY,
1875: MP_PTSCOTCH_SCALABILITY
1876: } MPPTScotchStrategyType;
1877: PETSC_EXTERN const char *const MPPTScotchStrategyTypes[];
1879: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning, PetscReal);
1880: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning, PetscReal *);
1881: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning, MPPTScotchStrategyType);
1882: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning, MPPTScotchStrategyType *);
1884: /*
1885: * hierarchical partitioning
1886: */
1887: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning, IS *);
1888: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning, IS *);
1889: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning, PetscInt);
1890: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt);
1892: PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat, PetscInt, Mat *);
1894: /*
1895: If any of the enum values are changed, also update dMatOps dict at src/binding/petsc4py/src/petsc4py/PETSc/libpetsc4py.pyx
1896: */
1897: typedef enum {
1898: MATOP_SET_VALUES = 0,
1899: MATOP_GET_ROW = 1,
1900: MATOP_RESTORE_ROW = 2,
1901: MATOP_MULT = 3,
1902: MATOP_MULT_ADD = 4,
1903: MATOP_MULT_TRANSPOSE = 5,
1904: MATOP_MULT_TRANSPOSE_ADD = 6,
1905: MATOP_SOLVE = 7,
1906: MATOP_SOLVE_ADD = 8,
1907: MATOP_SOLVE_TRANSPOSE = 9,
1908: MATOP_SOLVE_TRANSPOSE_ADD = 10,
1909: MATOP_LUFACTOR = 11,
1910: MATOP_CHOLESKYFACTOR = 12,
1911: MATOP_SOR = 13,
1912: MATOP_TRANSPOSE = 14,
1913: MATOP_GETINFO = 15,
1914: MATOP_EQUAL = 16,
1915: MATOP_GET_DIAGONAL = 17,
1916: MATOP_DIAGONAL_SCALE = 18,
1917: MATOP_NORM = 19,
1918: MATOP_ASSEMBLY_BEGIN = 20,
1919: MATOP_ASSEMBLY_END = 21,
1920: MATOP_SET_OPTION = 22,
1921: MATOP_ZERO_ENTRIES = 23,
1922: MATOP_ZERO_ROWS = 24,
1923: MATOP_LUFACTOR_SYMBOLIC = 25,
1924: MATOP_LUFACTOR_NUMERIC = 26,
1925: MATOP_CHOLESKY_FACTOR_SYMBOLIC = 27,
1926: MATOP_CHOLESKY_FACTOR_NUMERIC = 28,
1927: MATOP_SETUP = 29,
1928: MATOP_ILUFACTOR_SYMBOLIC = 30,
1929: MATOP_ICCFACTOR_SYMBOLIC = 31,
1930: MATOP_GET_DIAGONAL_BLOCK = 32,
1931: MATOP_SET_INF = 33,
1932: MATOP_DUPLICATE = 34,
1933: MATOP_FORWARD_SOLVE = 35,
1934: MATOP_BACKWARD_SOLVE = 36,
1935: MATOP_ILUFACTOR = 37,
1936: MATOP_ICCFACTOR = 38,
1937: MATOP_AXPY = 39,
1938: MATOP_CREATE_SUBMATRICES = 40,
1939: MATOP_INCREASE_OVERLAP = 41,
1940: MATOP_GET_VALUES = 42,
1941: MATOP_COPY = 43,
1942: MATOP_GET_ROW_MAX = 44,
1943: MATOP_SCALE = 45,
1944: MATOP_SHIFT = 46,
1945: MATOP_DIAGONAL_SET = 47,
1946: MATOP_ZERO_ROWS_COLUMNS = 48,
1947: MATOP_SET_RANDOM = 49,
1948: MATOP_GET_ROW_IJ = 50,
1949: MATOP_RESTORE_ROW_IJ = 51,
1950: MATOP_GET_COLUMN_IJ = 52,
1951: MATOP_RESTORE_COLUMN_IJ = 53,
1952: MATOP_FDCOLORING_CREATE = 54,
1953: MATOP_COLORING_PATCH = 55,
1954: MATOP_SET_UNFACTORED = 56,
1955: MATOP_PERMUTE = 57,
1956: MATOP_SET_VALUES_BLOCKED = 58,
1957: MATOP_CREATE_SUBMATRIX = 59,
1958: MATOP_DESTROY = 60,
1959: MATOP_VIEW = 61,
1960: MATOP_CONVERT_FROM = 62,
1961: MATOP_MATMAT_MULT_SYMBOLIC = 63,
1962: MATOP_MATMAT_MULT_NUMERIC = 64,
1963: MATOP_SET_LOCAL_TO_GLOBAL_MAP = 65,
1964: MATOP_SET_VALUES_LOCAL = 66,
1965: MATOP_ZERO_ROWS_LOCAL = 67,
1966: MATOP_GET_ROW_MAX_ABS = 68,
1967: MATOP_GET_ROW_MIN_ABS = 69,
1968: MATOP_CONVERT = 70,
1969: MATOP_HAS_OPERATION = 71,
1970: MATOP_FD_COLORING_APPLY = 72,
1971: MATOP_SET_FROM_OPTIONS = 73,
1972: MATOP_FIND_ZERO_DIAGONALS = 74,
1973: MATOP_MULT_MULTIPLE = 75,
1974: MATOP_SOLVE_MULTIPLE = 76,
1975: MATOP_GET_INERTIA = 77,
1976: MATOP_LOAD = 78,
1977: MATOP_IS_SYMMETRIC = 79,
1978: MATOP_IS_HERMITIAN = 80,
1979: MATOP_IS_STRUCTURALLY_SYMMETRIC = 81,
1980: MATOP_SET_VALUES_BLOCKEDLOCAL = 82,
1981: MATOP_CREATE_VECS = 83,
1982: MATOP_MAT_MULT_SYMBOLIC = 84,
1983: MATOP_MAT_MULT_NUMERIC = 85,
1984: MATOP_PTAP_NUMERIC = 86,
1985: MATOP_MAT_TRANSPOSE_MULT_SYMBO = 87,
1986: MATOP_MAT_TRANSPOSE_MULT_NUMER = 88,
1987: MATOP_BIND_TO_CPU = 89,
1988: MATOP_PRODUCTSETFROMOPTIONS = 90,
1989: MATOP_PRODUCTSYMBOLIC = 91,
1990: MATOP_PRODUCTNUMERIC = 92,
1991: MATOP_CONJUGATE = 93,
1992: MATOP_VIEW_NATIVE = 94,
1993: MATOP_SET_VALUES_ROW = 95,
1994: MATOP_REAL_PART = 96,
1995: MATOP_IMAGINARY_PART = 97,
1996: MATOP_GET_ROW_UPPER_TRIANGULAR = 98,
1997: MATOP_RESTORE_ROW_UPPER_TRIANG = 99,
1998: MATOP_MAT_SOLVE = 100,
1999: MATOP_MAT_SOLVE_TRANSPOSE = 101,
2000: MATOP_GET_ROW_MIN = 102,
2001: MATOP_GET_COLUMN_VECTOR = 103,
2002: MATOP_MISSING_DIAGONAL = 104,
2003: MATOP_GET_SEQ_NONZERO_STRUCTUR = 105,
2004: MATOP_CREATE = 106,
2005: MATOP_GET_GHOSTS = 107,
2006: MATOP_GET_LOCAL_SUB_MATRIX = 108,
2007: MATOP_RESTORE_LOCALSUB_MATRIX = 109,
2008: MATOP_MULT_DIAGONAL_BLOCK = 110,
2009: MATOP_HERMITIAN_TRANSPOSE = 111,
2010: MATOP_MULT_HERMITIAN_TRANSPOSE = 112,
2011: MATOP_MULT_HERMITIAN_TRANS_ADD = 113,
2012: MATOP_GET_MULTI_PROC_BLOCK = 114,
2013: MATOP_FIND_NONZERO_ROWS = 115,
2014: MATOP_GET_COLUMN_NORMS = 116,
2015: MATOP_INVERT_BLOCK_DIAGONAL = 117,
2016: MATOP_INVERT_VBLOCK_DIAGONAL = 118,
2017: MATOP_CREATE_SUB_MATRICES_MPI = 119,
2018: MATOP_SET_VALUES_BATCH = 120,
2019: MATOP_TRANSPOSE_MAT_MULT_SYMBO = 121,
2020: MATOP_TRANSPOSE_MAT_MULT_NUMER = 122,
2021: MATOP_TRANSPOSE_COLORING_CREAT = 123,
2022: MATOP_TRANS_COLORING_APPLY_SPT = 124,
2023: MATOP_TRANS_COLORING_APPLY_DEN = 125,
2024: MATOP_RART_NUMERIC = 126,
2025: MATOP_SET_BLOCK_SIZES = 127,
2026: MATOP_RESIDUAL = 128,
2027: MATOP_FDCOLORING_SETUP = 129,
2028: MATOP_FIND_OFFBLOCK_ENTRIES = 130,
2029: MATOP_MPICONCATENATESEQ = 131,
2030: MATOP_DESTROYSUBMATRICES = 132,
2031: MATOP_MAT_TRANSPOSE_SOLVE = 133,
2032: MATOP_GET_VALUES_LOCAL = 134,
2033: MATOP_CREATE_GRAPH = 135,
2034: MATOP_TRANSPOSE_SYMBOLIC = 136,
2035: MATOP_ELIMINATE_ZEROS = 137,
2036: MATOP_GET_ROW_SUM_ABS = 138,
2037: MATOP_GET_FACTOR = 139,
2038: MATOP_GET_BLOCK_DIAGONAL = 140, /* NOTE: caller of the two op functions owns the returned matrix */
2039: MATOP_GET_VBLOCK_DIAGONAL = 141, /* and need to destroy it after use. */
2040: MATOP_COPY_HASH_TO_XAIJ = 142,
2041: MATOP_GET_CURRENT_MEM_TYPE = 143
2042: } MatOperation;
2043: PETSC_EXTERN PetscErrorCode MatSetOperation(Mat, MatOperation, void (*)(void));
2044: PETSC_EXTERN PetscErrorCode MatGetOperation(Mat, MatOperation, void (**)(void));
2045: PETSC_EXTERN PetscErrorCode MatHasOperation(Mat, MatOperation, PetscBool *);
2046: PETSC_EXTERN PetscErrorCode MatHasCongruentLayouts(Mat, PetscBool *);
2047: PETSC_DEPRECATED_FUNCTION(3, 14, 0, "MatProductClear()", ) static inline PetscErrorCode MatFreeIntermediateDataStructures(Mat A)
2048: {
2049: return MatProductClear(A);
2050: }
2051: PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat, MatOperation, void (*)(void));
2052: PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat, MatOperation, void (**)(void));
2053: PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat, void *);
2054: PETSC_EXTERN PetscErrorCode MatShellSetContextDestroy(Mat, PetscCtxDestroyFn *);
2055: PETSC_EXTERN PetscErrorCode MatShellSetVecType(Mat, VecType);
2056: PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat, PetscErrorCode (*)(void *, Vec, Vec), Vec, void *, PetscBool *);
2057: PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat, PetscErrorCode (*)(void *, Vec, Vec), Vec, void *, PetscBool *);
2058: PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat);
2059: PETSC_EXTERN PetscErrorCode MatShellSetMatProductOperation(Mat, MatProductType, PetscErrorCode (*)(Mat, Mat, Mat, void **), PetscErrorCode (*)(Mat, Mat, Mat, void *), PetscErrorCode (*)(void *), MatType, MatType);
2060: PETSC_EXTERN PetscErrorCode MatIsShell(Mat, PetscBool *);
2062: /*
2063: Codes for matrices stored on disk. By default they are
2064: stored in a universal format. By changing the format with
2065: PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
2066: be stored in a way natural for the matrix, for example dense matrices
2067: would be stored as dense. Matrices stored this way may only be
2068: read into matrices of the same type.
2069: */
2070: #define MATRIX_BINARY_FORMAT_DENSE -1
2072: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat, PetscReal);
2074: PETSC_EXTERN PetscErrorCode MatISSetLocalMatType(Mat, MatType);
2075: PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
2076: PETSC_EXTERN PetscErrorCode MatISSetAllowRepeated(Mat, PetscBool);
2077: PETSC_EXTERN PetscErrorCode MatISGetAllowRepeated(Mat, PetscBool *);
2078: PETSC_EXTERN PetscErrorCode MatISStoreL2L(Mat, PetscBool);
2079: PETSC_EXTERN PetscErrorCode MatISFixLocalEmpty(Mat, PetscBool);
2080: PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat, Mat *);
2081: PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat, Mat *);
2082: PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat, Mat);
2083: PETSC_EXTERN PetscErrorCode MatISGetLocalToGlobalMapping(Mat, ISLocalToGlobalMapping *, ISLocalToGlobalMapping *);
2085: /*S
2086: MatNullSpace - Object that removes a null space from a vector, i.e.
2087: orthogonalizes the vector to a subspace
2089: Level: advanced
2091: .seealso: [](ch_matrices), `Mat`, `MatNullSpaceCreate()`, `MatNullSpaceSetFunction()`, `MatGetNullSpace()`, `MatSetNullSpace()`
2092: S*/
2093: typedef struct _p_MatNullSpace *MatNullSpace;
2095: /*S
2096: MatNullSpaceRemoveFn - Function provided to `MatNullSpaceSetFunction()` that removes the null space from a vector
2098: Level: advanced
2100: Calling Sequence:
2101: + nsp - the `MatNullSpace` object
2102: . x - the vector from which to remove the null space
2103: - ctx - [optional] user-defined function context provided with `MatNullSpaceSetFunction()`
2105: .seealso: [](ch_matrices), `Mat`, `MatNullSpaceCreate()`, `MatNullSpaceSetFunction()`, `MatGetNullSpace()`, `MatSetNullSpace()`
2106: S*/
2107: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode MatNullSpaceRemoveFn(MatNullSpace nsp, Vec x, void *ctx);
2109: PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm, PetscBool, PetscInt, const Vec[], MatNullSpace *);
2110: PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace, MatNullSpaceRemoveFn *, void *);
2111: PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace *);
2112: PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace, Vec);
2113: PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *);
2114: PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *);
2115: PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat, MatNullSpace);
2116: PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat, MatNullSpace);
2117: PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat, MatNullSpace);
2118: PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat, MatNullSpace *);
2119: PETSC_EXTERN PetscErrorCode MatGetNullSpaces(PetscInt, Mat[], MatNullSpace *[]);
2120: PETSC_EXTERN PetscErrorCode MatRestoreNullSpaces(PetscInt, Mat[], MatNullSpace *[]);
2121: PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace, Mat, PetscBool *);
2122: PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace, PetscViewer);
2123: PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace, PetscBool *, PetscInt *, const Vec **);
2124: PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec, MatNullSpace *);
2126: PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat, IS);
2127: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat, PetscReal);
2128: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat, PetscInt *);
2130: PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat, PetscInt, Mat *);
2131: PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat, PetscInt, Mat *);
2132: PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat, Mat *);
2134: PETSC_EXTERN PetscErrorCode MatComputeOperator(Mat, MatType, Mat *);
2135: PETSC_EXTERN PetscErrorCode MatComputeOperatorTranspose(Mat, MatType, Mat *);
2137: PETSC_DEPRECATED_FUNCTION(3, 12, 0, "MatComputeOperator()", ) static inline PetscErrorCode MatComputeExplicitOperator(Mat A, Mat *B)
2138: {
2139: return MatComputeOperator(A, PETSC_NULLPTR, B);
2140: }
2141: PETSC_DEPRECATED_FUNCTION(3, 12, 0, "MatComputeOperatorTranspose()", ) static inline PetscErrorCode MatComputeExplicitOperatorTranspose(Mat A, Mat *B)
2142: {
2143: return MatComputeOperatorTranspose(A, PETSC_NULLPTR, B);
2144: }
2146: PETSC_EXTERN PetscErrorCode MatCreateKAIJ(Mat, PetscInt, PetscInt, const PetscScalar[], const PetscScalar[], Mat *);
2147: PETSC_EXTERN PetscErrorCode MatKAIJGetAIJ(Mat, Mat *);
2148: PETSC_EXTERN PetscErrorCode MatKAIJGetS(Mat, PetscInt *, PetscInt *, PetscScalar **);
2149: PETSC_EXTERN PetscErrorCode MatKAIJGetSRead(Mat, PetscInt *, PetscInt *, const PetscScalar **);
2150: PETSC_EXTERN PetscErrorCode MatKAIJRestoreS(Mat, PetscScalar **);
2151: PETSC_EXTERN PetscErrorCode MatKAIJRestoreSRead(Mat, const PetscScalar **);
2152: PETSC_EXTERN PetscErrorCode MatKAIJGetT(Mat, PetscInt *, PetscInt *, PetscScalar **);
2153: PETSC_EXTERN PetscErrorCode MatKAIJGetTRead(Mat, PetscInt *, PetscInt *, const PetscScalar **);
2154: PETSC_EXTERN PetscErrorCode MatKAIJRestoreT(Mat, PetscScalar **);
2155: PETSC_EXTERN PetscErrorCode MatKAIJRestoreTRead(Mat, const PetscScalar **);
2156: PETSC_EXTERN PetscErrorCode MatKAIJSetAIJ(Mat, Mat);
2157: PETSC_EXTERN PetscErrorCode MatKAIJSetS(Mat, PetscInt, PetscInt, const PetscScalar[]);
2158: PETSC_EXTERN PetscErrorCode MatKAIJSetT(Mat, PetscInt, PetscInt, const PetscScalar[]);
2159: PETSC_EXTERN PetscErrorCode MatKAIJGetScaledIdentity(Mat, PetscBool *);
2161: PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat, Vec);
2163: PETSC_EXTERN PetscErrorCode MatMFFDInitializePackage(void);
2164: PETSC_EXTERN PetscErrorCode MatMFFDFinalizePackage(void);
2166: /*S
2167: MatMFFDFn - Function provided to `MatMFFDSetFunction()` that computes the function being differenced
2169: Level: advanced
2171: Calling Sequence:
2172: + ctx - [optional] user-defined function context provided with `MatMFFDSetFunction()`
2173: . x - input vector
2174: - y - output vector
2176: .seealso: [](ch_matrices), `Mat`, `MatCreateMFFD()`, `MatMFFDSetFunction()`, `MatMFFDiFn`, `MatMFFDiBaseFn`
2177: S*/
2178: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode MatMFFDFn(void *ctx, Vec x, Vec y);
2180: /*S
2181: MatMFFDiFn - Function provided to `MatMFFDSetFunctioni()` that computes the function being differenced at a single point
2183: Level: advanced
2185: Calling Sequence:
2186: + ctx - [optional] user-defined function context provided with `MatMFFDSetFunction()`
2187: . i - the component of the vector to compute
2188: . x - input vector
2189: - result - the value of the function at that component (output)
2191: .seealso: [](ch_matrices), `Mat`, `MatCreateMFFD()`, `MatMFFDSetFunction()`, `MatMFFDFn`, `MatMFFDiBaseFn`
2192: S*/
2193: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode MatMFFDiFn(void *ctx, PetscInt i, Vec x, PetscScalar *result);
2195: /*S
2196: MatMFFDiBaseFn - Function provided to `MatMFFDSetFunctioniBase()` that computes the base of the function evaluations
2197: that will be used for differencing
2199: Level: advanced
2201: Calling Sequence:
2202: + ctx - [optional] user-defined function context provided with `MatMFFDSetFunction()`
2203: - x - input base vector
2205: .seealso: [](ch_matrices), `Mat`, `MatCreateMFFD()`, `MatMFFDSetFunction()`, `MatMFFDSetFunctioniBase()`, `MatMFFDFn`, `MatMFFDiFn`
2206: S*/
2207: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode MatMFFDiBaseFn(void *ctx, Vec x);
2209: /*S
2210: MatMFFDCheckhFn - Function provided to `MatMFFDSetCheckh()` that checks and possibly adjusts the value of `h` to ensure some property.
2211: that will be used for differencing
2213: Level: advanced
2215: Calling Sequence:
2216: + ctx - [optional] user-defined function context provided with `MatMFFDSetCheckh()`
2217: . x - input base vector
2218: . y - input step vector that the product is computed with
2219: - h - input tentative step, output possibly adjusted step
2221: Note:
2222: `MatMFFDCheckPositivity()` is one such function
2224: .seealso: [](ch_matrices), `Mat`, `MatCreateMFFD()`, `MatMFFDSetCheckh()`, `MatMFFDCheckPositivity()`
2225: S*/
2226: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode MatMFFDCheckhFn(void *ctx, Vec x, Vec y, PetscScalar *h);
2228: PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, Mat *);
2229: PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat, Vec, Vec);
2230: PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat, MatMFFDFn *, void *);
2231: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat, MatMFFDiFn *);
2232: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat, MatMFFDiBaseFn *);
2233: PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat, PetscScalar[], PetscInt);
2234: PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
2235: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat, PetscReal);
2236: PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat, PetscInt);
2237: PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat, PetscScalar *);
2238: PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat, const char[]);
2239: PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void *, Vec, Vec, PetscScalar *);
2240: PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat, MatMFFDCheckhFn *, void *);
2242: /*S
2243: MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free
2244: Jacobian vector products
2246: Level: developer
2248: Notes:
2249: `MATMFFD` is a specific `MatType` which uses the `MatMFFD` data structure
2251: MatMFFD*() methods actually take the `Mat` as their first argument. Not a `MatMFFD` data structure
2253: This functionality is often obtained using `MatCreateSNESMF()` or with `SNES` solvers using `-snes_mf` or `-snes_mf_operator`
2255: .seealso: [](ch_matrices), `MatMFFDType`, `MATMFFD`, `MatCreateMFFD()`, `MatMFFDSetFuction()`, `MatMFFDSetType()`, `MatMFFDRegister()`,
2256: `MatCreateSNESMF()`, `SNES`, `-snes_mf`, `-snes_mf_operator`
2257: S*/
2258: typedef struct _p_MatMFFD *MatMFFD;
2260: /*J
2261: MatMFFDType - algorithm used to compute the `h` used in computing matrix-vector products via differencing of a function
2263: Values:
2264: + `MATMFFD_DS` - an algorithm described by Dennis and Schnabel {cite}`dennis:83`
2265: - `MATMFFD_WP` - the Walker-Pernice {cite}`pw98` strategy.
2267: Level: beginner
2269: .seealso: [](ch_matrices), `MatMFFDSetType()`, `MatMFFDRegister()`, `MatMFFDSetFunction()`, `MatCreateMFFD()`
2270: J*/
2271: typedef const char *MatMFFDType;
2272: #define MATMFFD_DS "ds"
2273: #define MATMFFD_WP "wp"
2275: PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat, MatMFFDType);
2276: PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[], PetscErrorCode (*)(MatMFFD));
2278: PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat, PetscReal);
2279: PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat, PetscBool);
2281: PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring, MatMFFDType);
2283: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
2284: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
2286: #ifdef PETSC_HAVE_H2OPUS
2287: PETSC_EXTERN_TYPEDEF typedef PetscScalar(MatH2OpusKernelFn)(PetscInt, PetscReal[], PetscReal[], void *);
2288: PETSC_EXTERN_TYPEDEF typedef MatH2OpusKernelFn *MatH2OpusKernel;
2290: PETSC_EXTERN PetscErrorCode MatCreateH2OpusFromKernel(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscReal[], PetscBool, MatH2OpusKernelFn *, void *, PetscReal, PetscInt, PetscInt, Mat *);
2291: PETSC_EXTERN PetscErrorCode MatCreateH2OpusFromMat(Mat, PetscInt, const PetscReal[], PetscBool, PetscReal, PetscInt, PetscInt, PetscInt, PetscReal, Mat *);
2292: PETSC_EXTERN PetscErrorCode MatH2OpusSetSamplingMat(Mat, Mat, PetscInt, PetscReal);
2293: PETSC_EXTERN PetscErrorCode MatH2OpusOrthogonalize(Mat);
2294: PETSC_EXTERN PetscErrorCode MatH2OpusCompress(Mat, PetscReal);
2295: PETSC_EXTERN PetscErrorCode MatH2OpusSetNativeMult(Mat, PetscBool);
2296: PETSC_EXTERN PetscErrorCode MatH2OpusGetNativeMult(Mat, PetscBool *);
2297: PETSC_EXTERN PetscErrorCode MatH2OpusGetIndexMap(Mat, IS *);
2298: PETSC_EXTERN PetscErrorCode MatH2OpusMapVec(Mat, PetscBool, Vec, Vec *);
2299: PETSC_EXTERN PetscErrorCode MatH2OpusLowRankUpdate(Mat, Mat, Mat, PetscScalar);
2300: #endif
2302: #ifdef PETSC_HAVE_HTOOL
2303: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode MatHtoolKernelFn(PetscInt, PetscInt, PetscInt, const PetscInt *, const PetscInt *, PetscScalar *, void *);
2304: PETSC_EXTERN_TYPEDEF typedef MatHtoolKernelFn *MatHtoolKernel;
2306: PETSC_EXTERN PetscErrorCode MatCreateHtoolFromKernel(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscReal[], const PetscReal[], MatHtoolKernelFn *, void *, Mat *);
2307: PETSC_EXTERN PetscErrorCode MatHtoolSetKernel(Mat, MatHtoolKernelFn *, void *);
2308: PETSC_EXTERN PetscErrorCode MatHtoolGetPermutationSource(Mat, IS *);
2309: PETSC_EXTERN PetscErrorCode MatHtoolGetPermutationTarget(Mat, IS *);
2310: PETSC_EXTERN PetscErrorCode MatHtoolUsePermutation(Mat, PetscBool);
2312: /*E
2313: MatHtoolCompressorType - Indicates the type of compressor used by a `MATHTOOL`
2315: Values:
2316: + `MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA` (default) - symmetric partial adaptive cross approximation
2317: . `MAT_HTOOL_COMPRESSOR_FULL_ACA` - full adaptive cross approximation
2318: - `MAT_HTOOL_COMPRESSOR_SVD` - singular value decomposition
2320: Level: intermediate
2322: .seealso: [](ch_matrices), `Mat`, `MatCreateHtoolFromKernel()`, `MATHTOOL`, `MatHtoolClusteringType`
2323: E*/
2324: typedef enum {
2325: MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA,
2326: MAT_HTOOL_COMPRESSOR_FULL_ACA,
2327: MAT_HTOOL_COMPRESSOR_SVD
2328: } MatHtoolCompressorType;
2330: /*E
2331: MatHtoolClusteringType - Indicates the type of clustering used by a `MATHTOOL`
2333: Values:
2334: + `MAT_HTOOL_CLUSTERING_PCA_REGULAR` (default) - axis computed via principle component analysis, split uniformly
2335: . `MAT_HTOOL_CLUSTERING_PCA_GEOMETRIC` - axis computed via principle component analysis, split barycentrically
2336: . `MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_REGULAR` - axis along the largest extent of the bounding box, split uniformly
2337: - `MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_GEOMETRIC` - axis along the largest extent of the bounding box, split barycentrically
2339: Level: intermediate
2341: Note:
2342: Higher-dimensional clustering is not yet supported in Htool, but once it is, one should add BOUNDING_BOX_{2,3} types
2344: .seealso: [](ch_matrices), `Mat`, `MatCreateHtoolFromKernel()`, `MATHTOOL`, `MatHtoolCompressorType`
2345: E*/
2346: typedef enum {
2347: MAT_HTOOL_CLUSTERING_PCA_REGULAR,
2348: MAT_HTOOL_CLUSTERING_PCA_GEOMETRIC,
2349: MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_REGULAR,
2350: MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_GEOMETRIC
2351: } MatHtoolClusteringType;
2352: #endif
2354: #ifdef PETSC_HAVE_MUMPS
2355: PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat, PetscInt, PetscInt);
2356: PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat, PetscInt, PetscInt *);
2357: PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat, PetscInt, PetscReal);
2358: PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat, PetscInt, PetscReal *);
2360: PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat, PetscInt, PetscInt *);
2361: PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat, PetscInt, PetscInt *);
2362: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat, PetscInt, PetscReal *);
2363: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat, PetscInt, PetscReal *);
2364: PETSC_EXTERN PetscErrorCode MatMumpsGetNullPivots(Mat, PetscInt *, PetscInt **);
2365: PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat, Mat);
2366: PETSC_EXTERN PetscErrorCode MatMumpsGetInverseTranspose(Mat, Mat);
2367: PETSC_EXTERN PetscErrorCode MatMumpsSetBlk(Mat, PetscInt, const PetscInt[], const PetscInt[]);
2368: #else
2369: static inline PetscErrorCode MatMumpsSetIcntl(PETSC_UNUSED Mat F, PETSC_UNUSED PetscInt icntl, PETSC_UNUSED PetscInt ival)
2370: {
2371: return PETSC_SUCCESS;
2372: }
2373: static inline PetscErrorCode MatMumpsSetCntl(PETSC_UNUSED Mat F, PETSC_UNUSED PetscInt icntl, PETSC_UNUSED PetscReal val)
2374: {
2375: return PETSC_SUCCESS;
2376: }
2377: #endif
2379: #ifdef PETSC_HAVE_MKL_PARDISO
2380: PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat, PetscInt, PetscInt);
2381: #endif
2383: #ifdef PETSC_HAVE_MKL_CPARDISO
2384: PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat, PetscInt, PetscInt);
2385: #endif
2387: #ifdef PETSC_HAVE_SUPERLU
2388: PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat, PetscReal);
2389: #endif
2391: #ifdef PETSC_HAVE_SUPERLU_DIST
2392: PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat, PetscScalar *);
2393: #endif
2395: #ifdef PETSC_HAVE_STRUMPACK
2396: /*E
2397: MatSTRUMPACKReordering - sparsity reducing ordering to be used in `MATSOLVERSTRUMPACK`
2399: Values:
2400: + `MAT_STRUMPACK_NATURAL` - use the current ordering
2401: . `MAT_STRUMPACK_METIS` - use MeTis to compute an ordering
2402: . `MAT_STRUMPACK_PARMETIS` - use ParMeTis to compute an ordering
2403: . `MAT_STRUMPACK_SCOTCH` - use Scotch to compute an ordering
2404: . `MAT_STRUMPACK_PTSCOTCH` - use parallel Scotch to compute an ordering
2405: . `MAT_STRUMPACK_RCM` - use an RCM ordering
2406: . `MAT_STRUMPACK_GEOMETRIC` - use a geometric ordering (needs mesh info from user)
2407: . `MAT_STRUMPACK_AMD` - approximate minimum degree
2408: . `MAT_STRUMPACK_MMD` - multiple minimum degree
2409: . `MAT_STRUMPACK_AND` - approximate nested dissection
2410: . `MAT_STRUMPACK_MLF` - minimum local fill
2411: - `MAT_STRUMPACK_SPECTRAL` - spectral nested dissection
2413: Level: intermediate
2415: Developer Note:
2416: Should be called `MatSTRUMPACKReorderingType`
2418: .seealso: `Mat`, `MATSOLVERSTRUMPACK`, `MatGetFactor()`, `MatSTRUMPACKSetReordering()`
2419: E*/
2420: typedef enum {
2421: MAT_STRUMPACK_NATURAL,
2422: MAT_STRUMPACK_METIS,
2423: MAT_STRUMPACK_PARMETIS,
2424: MAT_STRUMPACK_SCOTCH,
2425: MAT_STRUMPACK_PTSCOTCH,
2426: MAT_STRUMPACK_RCM,
2427: MAT_STRUMPACK_GEOMETRIC,
2428: MAT_STRUMPACK_AMD,
2429: MAT_STRUMPACK_MMD,
2430: MAT_STRUMPACK_AND,
2431: MAT_STRUMPACK_MLF,
2432: MAT_STRUMPACK_SPECTRAL
2433: } MatSTRUMPACKReordering;
2435: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat, MatSTRUMPACKReordering);
2436: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetReordering(Mat, MatSTRUMPACKReordering *);
2437: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetGeometricNxyz(Mat, PetscInt, PetscInt, PetscInt);
2438: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetGeometricComponents(Mat, PetscInt);
2439: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetGeometricWidth(Mat, PetscInt);
2440: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat, PetscBool);
2441: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetColPerm(Mat, PetscBool *);
2442: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetGPU(Mat, PetscBool);
2443: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetGPU(Mat, PetscBool *);
2445: /*E
2446: MatSTRUMPACKCompressionType - Compression used in the approximate sparse factorization solver `MATSOLVERSTRUMPACK`
2448: Values:
2449: + `MAT_STRUMPACK_COMPRESSION_TYPE_NONE` - no compression, direct solver
2450: . `MAT_STRUMPACK_COMPRESSION_TYPE_HSS` - hierarchically semi-separable
2451: . `MAT_STRUMPACK_COMPRESSION_TYPE_BLR` - block low rank
2452: . `MAT_STRUMPACK_COMPRESSION_TYPE_HODLR` - hierarchically off-diagonal low rank (requires ButterfyPACK support, configure with --download-butterflypack)
2453: . `MAT_STRUMPACK_COMPRESSION_TYPE_BLR_HODLR` - hybrid of BLR and HODLR (requires ButterfyPACK support, configure with --download-butterflypack)
2454: . `MAT_STRUMPACK_COMPRESSION_TYPE_ZFP_BLR_HODLR` - hybrid of lossy (ZFP), BLR and HODLR (requires ButterfyPACK and ZFP support, configure with --download-butterflypack --download-zfp)
2455: . `MAT_STRUMPACK_COMPRESSION_TYPE_LOSSLESS` - lossless compression (requires ZFP support, configure with --download-zfp)
2456: - `MAT_STRUMPACK_COMPRESSION_TYPE_LOSSY` - lossy compression (requires ZFP support, configure with --download-zfp)
2458: Level: intermediate
2460: .seealso: `Mat`, `MATSOLVERSTRUMPACK`, `MatGetFactor()`, `MatSTRUMPACKSetCompression()`
2461: E*/
2462: typedef enum {
2463: MAT_STRUMPACK_COMPRESSION_TYPE_NONE,
2464: MAT_STRUMPACK_COMPRESSION_TYPE_HSS,
2465: MAT_STRUMPACK_COMPRESSION_TYPE_BLR,
2466: MAT_STRUMPACK_COMPRESSION_TYPE_HODLR,
2467: MAT_STRUMPACK_COMPRESSION_TYPE_BLR_HODLR,
2468: MAT_STRUMPACK_COMPRESSION_TYPE_ZFP_BLR_HODLR,
2469: MAT_STRUMPACK_COMPRESSION_TYPE_LOSSLESS,
2470: MAT_STRUMPACK_COMPRESSION_TYPE_LOSSY
2471: } MatSTRUMPACKCompressionType;
2473: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompression(Mat, MatSTRUMPACKCompressionType);
2474: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompression(Mat, MatSTRUMPACKCompressionType *);
2475: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompRelTol(Mat, PetscReal);
2476: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompRelTol(Mat, PetscReal *);
2477: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompAbsTol(Mat, PetscReal);
2478: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompAbsTol(Mat, PetscReal *);
2479: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompMinSepSize(Mat, PetscInt);
2480: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompMinSepSize(Mat, PetscInt *);
2481: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompLeafSize(Mat, PetscInt);
2482: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompLeafSize(Mat, PetscInt *);
2483: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompLossyPrecision(Mat, PetscInt);
2484: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompLossyPrecision(Mat, PetscInt *);
2485: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompButterflyLevels(Mat, PetscInt);
2486: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompButterflyLevels(Mat, PetscInt *);
2487: #endif
2489: PETSC_EXTERN PetscErrorCode MatBindToCPU(Mat, PetscBool);
2490: PETSC_EXTERN PetscErrorCode MatBoundToCPU(Mat, PetscBool *);
2491: PETSC_DEPRECATED_FUNCTION(3, 13, 0, "MatBindToCPU()", ) static inline PetscErrorCode MatPinToCPU(Mat A, PetscBool flg)
2492: {
2493: return MatBindToCPU(A, flg);
2494: }
2495: PETSC_EXTERN PetscErrorCode MatSetBindingPropagates(Mat, PetscBool);
2496: PETSC_EXTERN PetscErrorCode MatGetBindingPropagates(Mat, PetscBool *);
2498: #ifdef PETSC_HAVE_CUDA
2499: /*E
2500: MatCUSPARSEStorageFormat - indicates the storage format for `MATAIJCUSPARSE` (GPU)
2501: matrices.
2503: Values:
2504: + `MAT_CUSPARSE_CSR` - Compressed Sparse Row
2505: . `MAT_CUSPARSE_ELL` - Ellpack (requires CUDA 4.2 or later).
2506: - `MAT_CUSPARSE_HYB` - Hybrid, a combination of Ellpack and Coordinate format (requires CUDA 4.2 or later).
2508: Level: intermediate
2510: .seealso: [](ch_matrices), `MATAIJCUSPARSE`, `MatCUSPARSESetFormat()`, `MatCUSPARSEFormatOperation`
2511: E*/
2513: typedef enum {
2514: MAT_CUSPARSE_CSR,
2515: MAT_CUSPARSE_ELL,
2516: MAT_CUSPARSE_HYB
2517: } MatCUSPARSEStorageFormat;
2519: /* these will be strings associated with enumerated type defined above */
2520: PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[];
2522: /*E
2523: MatCUSPARSEFormatOperation - indicates the operation of `MATAIJCUSPARSE` (GPU)
2524: matrices whose operation should use a particular storage format.
2526: Values:
2527: + `MAT_CUSPARSE_MULT_DIAG` - sets the storage format for the diagonal matrix in the parallel `MatMult()`
2528: . `MAT_CUSPARSE_MULT_OFFDIAG` - sets the storage format for the off-diagonal matrix in the parallel `MatMult()`
2529: . `MAT_CUSPARSE_MULT` - sets the storage format for the entire matrix in the serial (single GPU) `MatMult()`
2530: - `MAT_CUSPARSE_ALL` - sets the storage format for all `MATAIJCUSPARSE` (GPU) matrices
2532: Level: intermediate
2534: .seealso: [](ch_matrices), `MatCUSPARSESetFormat()`, `MatCUSPARSEStorageFormat`
2535: E*/
2536: typedef enum {
2537: MAT_CUSPARSE_MULT_DIAG,
2538: MAT_CUSPARSE_MULT_OFFDIAG,
2539: MAT_CUSPARSE_MULT,
2540: MAT_CUSPARSE_ALL
2541: } MatCUSPARSEFormatOperation;
2543: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2544: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2545: PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat, MatCUSPARSEFormatOperation, MatCUSPARSEStorageFormat);
2546: PETSC_EXTERN PetscErrorCode MatCUSPARSESetUseCPUSolve(Mat, PetscBool);
2547: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetIJ(Mat, PetscBool, const int **, const int **);
2548: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreIJ(Mat, PetscBool, const int **, const int **);
2549: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArrayRead(Mat, const PetscScalar **);
2550: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArrayRead(Mat, const PetscScalar **);
2551: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArrayWrite(Mat, PetscScalar **);
2552: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArrayWrite(Mat, PetscScalar **);
2553: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArray(Mat, PetscScalar **);
2554: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArray(Mat, PetscScalar **);
2556: PETSC_EXTERN PetscErrorCode MatCreateDenseCUDA(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar[], Mat *);
2557: PETSC_EXTERN PetscErrorCode MatCreateSeqDenseCUDA(MPI_Comm, PetscInt, PetscInt, PetscScalar[], Mat *);
2558: PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayWrite(Mat, PetscScalar **);
2559: PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayRead(Mat, const PetscScalar **);
2560: PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArray(Mat, PetscScalar **);
2561: PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayWrite(Mat, PetscScalar **);
2562: PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayRead(Mat, const PetscScalar **);
2563: PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArray(Mat, PetscScalar **);
2564: PETSC_EXTERN PetscErrorCode MatDenseCUDAPlaceArray(Mat, const PetscScalar *);
2565: PETSC_EXTERN PetscErrorCode MatDenseCUDAReplaceArray(Mat, const PetscScalar *);
2566: PETSC_EXTERN PetscErrorCode MatDenseCUDAResetArray(Mat);
2567: PETSC_EXTERN PetscErrorCode MatDenseCUDASetPreallocation(Mat, PetscScalar *);
2569: PETSC_EXTERN PetscErrorCode MatCreateSeqSELLCUDA(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2570: PETSC_EXTERN PetscErrorCode MatCreateSELLCUDA(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2571: #endif
2573: #ifdef PETSC_HAVE_HIP
2574: /*E
2575: MatHIPSPARSEStorageFormat - indicates the storage format for `MATAIJHIPSPARSE` (GPU)
2576: matrices.
2578: Values:
2579: + `MAT_HIPSPARSE_CSR` - Compressed Sparse Row
2580: . `MAT_HIPSPARSE_ELL` - Ellpack
2581: - `MAT_HIPSPARSE_HYB` - Hybrid, a combination of Ellpack and Coordinate format
2583: Level: intermediate
2585: .seealso: [](ch_matrices), `MatHIPSPARSESetFormat()`, `MatHIPSPARSEFormatOperation`
2586: E*/
2588: typedef enum {
2589: MAT_HIPSPARSE_CSR,
2590: MAT_HIPSPARSE_ELL,
2591: MAT_HIPSPARSE_HYB
2592: } MatHIPSPARSEStorageFormat;
2594: /* these will be strings associated with enumerated type defined above */
2595: PETSC_EXTERN const char *const MatHIPSPARSEStorageFormats[];
2597: /*E
2598: MatHIPSPARSEFormatOperation - indicates the operation of `MATAIJHIPSPARSE` (GPU)
2599: matrices whose operation should use a particular storage format.
2601: Values:
2602: + `MAT_HIPSPARSE_MULT_DIAG` - sets the storage format for the diagonal matrix in the parallel `MatMult()`
2603: . `MAT_HIPSPARSE_MULT_OFFDIAG` - sets the storage format for the off-diagonal matrix in the parallel `MatMult()`
2604: . `MAT_HIPSPARSE_MULT` - sets the storage format for the entire matrix in the serial (single GPU) `MatMult()`
2605: - `MAT_HIPSPARSE_ALL` - sets the storage format for all HIPSPARSE (GPU) matrices
2607: Level: intermediate
2609: .seealso: [](ch_matrices), `MatHIPSPARSESetFormat()`, `MatHIPSPARSEStorageFormat`
2610: E*/
2611: typedef enum {
2612: MAT_HIPSPARSE_MULT_DIAG,
2613: MAT_HIPSPARSE_MULT_OFFDIAG,
2614: MAT_HIPSPARSE_MULT,
2615: MAT_HIPSPARSE_ALL
2616: } MatHIPSPARSEFormatOperation;
2618: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJHIPSPARSE(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2619: PETSC_EXTERN PetscErrorCode MatCreateAIJHIPSPARSE(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2620: PETSC_EXTERN PetscErrorCode MatHIPSPARSESetFormat(Mat, MatHIPSPARSEFormatOperation, MatHIPSPARSEStorageFormat);
2621: PETSC_EXTERN PetscErrorCode MatHIPSPARSESetUseCPUSolve(Mat, PetscBool);
2622: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSEGetIJ(Mat, PetscBool, const int **, const int **);
2623: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSERestoreIJ(Mat, PetscBool, const int **, const int **);
2624: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSEGetArrayRead(Mat, const PetscScalar **);
2625: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSERestoreArrayRead(Mat, const PetscScalar **);
2626: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSEGetArrayWrite(Mat, PetscScalar **);
2627: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSERestoreArrayWrite(Mat, PetscScalar **);
2628: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSEGetArray(Mat, PetscScalar **);
2629: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSERestoreArray(Mat, PetscScalar **);
2631: PETSC_EXTERN PetscErrorCode MatCreateDenseHIP(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar[], Mat *);
2632: PETSC_EXTERN PetscErrorCode MatCreateSeqDenseHIP(MPI_Comm, PetscInt, PetscInt, PetscScalar[], Mat *);
2633: PETSC_EXTERN PetscErrorCode MatDenseHIPGetArrayWrite(Mat, PetscScalar **);
2634: PETSC_EXTERN PetscErrorCode MatDenseHIPGetArrayRead(Mat, const PetscScalar **);
2635: PETSC_EXTERN PetscErrorCode MatDenseHIPGetArray(Mat, PetscScalar **);
2636: PETSC_EXTERN PetscErrorCode MatDenseHIPRestoreArrayWrite(Mat, PetscScalar **);
2637: PETSC_EXTERN PetscErrorCode MatDenseHIPRestoreArrayRead(Mat, const PetscScalar **);
2638: PETSC_EXTERN PetscErrorCode MatDenseHIPRestoreArray(Mat, PetscScalar **);
2639: PETSC_EXTERN PetscErrorCode MatDenseHIPPlaceArray(Mat, const PetscScalar *);
2640: PETSC_EXTERN PetscErrorCode MatDenseHIPReplaceArray(Mat, const PetscScalar *);
2641: PETSC_EXTERN PetscErrorCode MatDenseHIPResetArray(Mat);
2642: PETSC_EXTERN PetscErrorCode MatDenseHIPSetPreallocation(Mat, PetscScalar *);
2643: PETSC_EXTERN PetscErrorCode MatCreateSeqSELLHIP(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2644: PETSC_EXTERN PetscErrorCode MatCreateSELLHIP(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2645: #endif
2647: #if defined(PETSC_HAVE_VIENNACL)
2648: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2649: PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2650: #endif
2652: #if PetscDefined(HAVE_KOKKOS)
2653: PETSC_EXTERN PetscErrorCode MatCreateAIJKokkos(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2654: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJKokkos(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2655: #endif
2657: #if defined(PETSC_HAVE_FFTW)
2658: PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat, Vec, Vec);
2659: PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat, Vec, Vec);
2660: PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat, Vec *, Vec *, Vec *);
2661: #endif
2663: #if defined(PETSC_HAVE_SCALAPACK)
2664: PETSC_EXTERN PetscErrorCode MatCreateScaLAPACK(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, Mat *);
2665: PETSC_EXTERN PetscErrorCode MatScaLAPACKSetBlockSizes(Mat, PetscInt, PetscInt);
2666: PETSC_EXTERN PetscErrorCode MatScaLAPACKGetBlockSizes(Mat, PetscInt *, PetscInt *);
2667: #endif
2669: PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm, PetscInt, const IS[], PetscInt, const IS[], const Mat[], Mat *);
2670: PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat, PetscInt *, PetscInt *);
2671: PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat, IS[], IS[]);
2672: PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat, IS[], IS[]);
2673: PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat, PetscInt *, PetscInt *, Mat ***);
2674: PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat, PetscInt, PetscInt, Mat *);
2675: PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat, VecType);
2676: PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat, PetscInt, const IS[], PetscInt, const IS[], const Mat[]);
2677: PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat, PetscInt, PetscInt, Mat);
2679: PETSC_EXTERN PetscErrorCode MatFilter(Mat, PetscReal, PetscBool, PetscBool);
2680: PETSC_DEPRECATED_FUNCTION(3, 20, 0, "MatFilter()", ) static inline PetscErrorCode MatChop(Mat A, PetscReal tol)
2681: {
2682: return MatFilter(A, tol, PETSC_FALSE, PETSC_FALSE);
2683: }
2684: PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat, PetscReal, PetscInt *);
2686: PETSC_EXTERN PetscErrorCode MatSubdomainsCreateCoalesce(Mat, PetscInt, PetscInt *, IS **);
2688: PETSC_EXTERN PetscErrorCode MatPreallocatorPreallocate(Mat, PetscBool, Mat);
2690: PETSC_EXTERN PetscErrorCode MatHeaderMerge(Mat, Mat *);
2691: PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat, Mat *);
2693: PETSC_EXTERN PetscErrorCode MatSeqAIJGetCSRAndMemType(Mat, const PetscInt **, const PetscInt **, PetscScalar **, PetscMemType *);
2695: PETSC_EXTERN PetscErrorCode MatCreateGraph(Mat, PetscBool, PetscBool, PetscReal, PetscInt, PetscInt[], Mat *);
2696: PETSC_EXTERN PetscErrorCode MatEliminateZeros(Mat, PetscBool);
2698: PETSC_EXTERN PetscErrorCode MatCreateDenseFromVecType(MPI_Comm, VecType, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar *, Mat *);
2700: PETSC_EXTERN PetscErrorCode MatSetHPL(Mat, int);
2701: #define PETSCBMHPL "hpl"
2703: PETSC_EXTERN PetscErrorCode MatDFischer(Mat, Vec, Vec, Vec, Vec, Vec, Vec, Vec, Vec);