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: /*S
222: MatSolverFn - Function type for the factor-creation callback registered with `MatSolverTypeRegister()`, used by `MatGetFactor()` to allocate a factored matrix of a particular `MatSolverType` and `MatFactorType`
224: Synopsis:
225: #include <petscmat.h>
226: PetscErrorCode MatSolverFn(Mat A, MatFactorType ftype, Mat *F)
228: Calling Sequence:
229: + A - the matrix to be factored
230: . ftype - the kind of factorization requested (e.g. `MAT_FACTOR_LU`, `MAT_FACTOR_CHOLESKY`)
231: - F - on output, the newly created factor `Mat` of the appropriate `MatType` for the solver
233: Level: developer
235: .seealso: `Mat`, `MatGetFactor()`, `MatSolverType`, `MatFactorType`, `MatSolverTypeRegister()`, `MatSolverTypeGet()`
236: S*/
237: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode MatSolverFn(Mat, MatFactorType, Mat *);
238: PETSC_EXTERN_TYPEDEF typedef MatSolverFn *MatSolverFunction;
240: PETSC_EXTERN PetscErrorCode MatSolverTypeRegister(MatSolverType, MatType, MatFactorType, MatSolverFn *);
241: PETSC_EXTERN PetscErrorCode MatSolverTypeGet(MatSolverType, MatType, MatFactorType, PetscBool *, PetscBool *, MatSolverFn **);
242: typedef MatSolverType MatSolverPackage PETSC_DEPRECATED_TYPEDEF(3, 9, 0, "MatSolverType", );
243: PETSC_DEPRECATED_FUNCTION(3, 9, 0, "MatSolverTypeRegister()", ) static inline PetscErrorCode MatSolverPackageRegister(MatSolverType stype, MatType mtype, MatFactorType ftype, MatSolverFn *f)
244: {
245: return MatSolverTypeRegister(stype, mtype, ftype, f);
246: }
247: PETSC_DEPRECATED_FUNCTION(3, 9, 0, "MatSolverTypeGet()", ) static inline PetscErrorCode MatSolverPackageGet(MatSolverType stype, MatType mtype, MatFactorType ftype, PetscBool *foundmtype, PetscBool *foundstype, MatSolverFn **f)
248: {
249: return MatSolverTypeGet(stype, mtype, ftype, foundmtype, foundstype, f);
250: }
252: /*E
253: MatProductType - indicates what type of matrix product to compute
255: Values:
256: + `MATPRODUCT_AB` - product of two matrices
257: . `MATPRODUCT_AtB` - product of the transpose of a given matrix with a matrix
258: . `MATPRODUCT_ABt` - product of a matrix with the transpose of another given matrix
259: . `MATPRODUCT_PtAP` - the triple product of the transpose of a matrix with another matrix and itself
260: . `MATPRODUCT_RARt` - the triple product of a matrix, another matrix and the transpose of the first matrix
261: - `MATPRODUCT_ABC` - the product of three matrices
263: Level: beginner
265: .seealso: [](sec_matmatproduct), [](ch_matrices), `MatProductSetType()`
266: E*/
267: typedef enum {
268: MATPRODUCT_UNSPECIFIED,
269: MATPRODUCT_AB,
270: MATPRODUCT_AtB,
271: MATPRODUCT_ABt,
272: MATPRODUCT_PtAP,
273: MATPRODUCT_RARt,
274: MATPRODUCT_ABC
275: } MatProductType;
276: PETSC_EXTERN const char *const MatProductTypes[];
278: /*J
279: MatProductAlgorithm - String with the name of an algorithm for a PETSc matrix product implementation
281: Level: beginner
283: .seealso: [](sec_matmatproduct), [](ch_matrices), `MatSetType()`, `Mat`, `MatProductSetAlgorithm()`, `MatProductType`
284: J*/
285: typedef const char *MatProductAlgorithm;
286: #define MATPRODUCTALGORITHMDEFAULT "default"
287: #define MATPRODUCTALGORITHMSORTED "sorted"
288: #define MATPRODUCTALGORITHMSCALABLE "scalable"
289: #define MATPRODUCTALGORITHMSCALABLEFAST "scalable_fast"
290: #define MATPRODUCTALGORITHMHEAP "heap"
291: #define MATPRODUCTALGORITHMBHEAP "btheap"
292: #define MATPRODUCTALGORITHMLLCONDENSED "llcondensed"
293: #define MATPRODUCTALGORITHMROWMERGE "rowmerge"
294: #define MATPRODUCTALGORITHMOUTERPRODUCT "outerproduct"
295: #define MATPRODUCTALGORITHMATB "at*b"
296: #define MATPRODUCTALGORITHMRAP "rap"
297: #define MATPRODUCTALGORITHMNONSCALABLE "nonscalable"
298: #define MATPRODUCTALGORITHMSEQMPI "seqmpi"
299: #define MATPRODUCTALGORITHMBACKEND "backend"
300: #define MATPRODUCTALGORITHMOVERLAPPING "overlapping"
301: #define MATPRODUCTALGORITHMMERGED "merged"
302: #define MATPRODUCTALGORITHMALLATONCE "allatonce"
303: #define MATPRODUCTALGORITHMALLATONCEMERGED "allatonce_merged"
304: #define MATPRODUCTALGORITHMALLGATHERV "allgatherv"
305: #define MATPRODUCTALGORITHMCYCLIC "cyclic"
306: #define MATPRODUCTALGORITHMHYPRE "hypre"
308: PETSC_EXTERN PetscErrorCode MatProductCreate(Mat, Mat, Mat, Mat *);
309: PETSC_EXTERN PetscErrorCode MatProductCreateWithMat(Mat, Mat, Mat, Mat);
310: PETSC_EXTERN PetscErrorCode MatProductSetType(Mat, MatProductType);
311: PETSC_EXTERN PetscErrorCode MatProductSetAlgorithm(Mat, MatProductAlgorithm);
312: PETSC_EXTERN PetscErrorCode MatProductGetAlgorithm(Mat, MatProductAlgorithm *);
313: PETSC_EXTERN PetscErrorCode MatProductSetFill(Mat, PetscReal);
314: PETSC_EXTERN PetscErrorCode MatProductSetFromOptions(Mat);
315: PETSC_EXTERN PetscErrorCode MatProductSymbolic(Mat);
316: PETSC_EXTERN PetscErrorCode MatProductNumeric(Mat);
317: PETSC_EXTERN PetscErrorCode MatProductReplaceMats(Mat, Mat, Mat, Mat);
318: PETSC_EXTERN PetscErrorCode MatProductClear(Mat);
319: PETSC_EXTERN PetscErrorCode MatProductView(Mat, PetscViewer);
320: PETSC_EXTERN PetscErrorCode MatProductGetType(Mat, MatProductType *);
321: PETSC_EXTERN PetscErrorCode MatProductGetMats(Mat, Mat *, Mat *, Mat *);
323: /* Logging support */
324: #define MAT_FILE_CLASSID 1211216 /* used to indicate matrices in binary files */
325: PETSC_EXTERN PetscClassId MAT_CLASSID;
326: PETSC_EXTERN PetscClassId MAT_COLORING_CLASSID;
327: PETSC_EXTERN PetscClassId MAT_FDCOLORING_CLASSID;
328: PETSC_EXTERN PetscClassId MAT_TRANSPOSECOLORING_CLASSID;
329: PETSC_EXTERN PetscClassId MAT_PARTITIONING_CLASSID;
330: PETSC_EXTERN PetscClassId MAT_COARSEN_CLASSID;
331: PETSC_EXTERN PetscClassId MAT_NULLSPACE_CLASSID;
332: PETSC_EXTERN PetscClassId MATMFFD_CLASSID;
334: /*E
335: MatReuse - Indicates if matrices obtained from a previous call to `MatCreateSubMatrices()`, `MatCreateSubMatrix()`, `MatConvert()` or several other functions
336: are to be reused to store the new matrix values.
338: Values:
339: + `MAT_INITIAL_MATRIX` - create a new matrix
340: . `MAT_REUSE_MATRIX` - reuse the matrix created with a previous call that used `MAT_INITIAL_MATRIX`
341: . `MAT_INPLACE_MATRIX` - replace the first input matrix with the new matrix (not applicable to all functions)
342: - `MAT_IGNORE_MATRIX` - do not create a new matrix or reuse a given matrix, just ignore that matrix argument (not applicable to all functions)
344: Level: beginner
346: .seealso: [](ch_matrices), `Mat`, `MatCreateSubMatrices()`, `MatCreateSubMatrix()`, `MatDestroyMatrices()`, `MatConvert()`
347: E*/
348: typedef enum {
349: MAT_INITIAL_MATRIX,
350: MAT_REUSE_MATRIX,
351: MAT_IGNORE_MATRIX,
352: MAT_INPLACE_MATRIX
353: } MatReuse;
355: /*E
356: MatCreateSubMatrixOption - Indicates if matrices obtained from a call to `MatCreateSubMatrices()`
357: include the matrix values. Currently it is only used by `MatGetSeqNonzeroStructure()`.
359: Values:
360: + `MAT_DO_NOT_GET_VALUES` - do not copy the matrix values
361: - `MAT_GET_VALUES` - copy the matrix values
363: Level: developer
365: Developer Note:
366: Why is not just a boolean used for this information?
368: .seealso: [](ch_matrices), `Mat`, `MatDuplicateOption`, `PetscCopyMode`, `MatGetSeqNonzeroStructure()`
369: E*/
370: typedef enum {
371: MAT_DO_NOT_GET_VALUES,
372: MAT_GET_VALUES
373: } MatCreateSubMatrixOption;
375: PETSC_EXTERN PetscErrorCode MatInitializePackage(void);
376: PETSC_EXTERN PetscErrorCode MatFinalizePackage(void);
378: PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm, Mat *);
379: PETSC_EXTERN PetscErrorCode MatCreateFromOptions(MPI_Comm, const char *, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, Mat *);
380: PETSC_EXTERN PetscErrorCode MatSetSizes(Mat, PetscInt, PetscInt, PetscInt, PetscInt);
381: PETSC_EXTERN PetscErrorCode MatSetType(Mat, MatType);
382: PETSC_EXTERN PetscErrorCode MatGetVecType(Mat, VecType *);
383: PETSC_EXTERN PetscErrorCode MatSetVecType(Mat, VecType);
384: PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat);
385: PETSC_EXTERN PetscErrorCode MatViewFromOptions(Mat, PetscObject, const char[]);
386: PETSC_EXTERN PetscErrorCode MatRegister(const char[], PetscErrorCode (*)(Mat));
387: PETSC_EXTERN PetscErrorCode MatRegisterRootName(const char[], const char[], const char[]);
388: PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat, const char[]);
389: PETSC_EXTERN PetscErrorCode MatSetOptionsPrefixFactor(Mat, const char[]);
390: PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefixFactor(Mat, const char[]);
391: PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat, const char[]);
392: PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat, const char *[]);
393: PETSC_EXTERN PetscErrorCode MatGetState(Mat, PetscObjectState *);
394: PETSC_EXTERN PetscErrorCode MatSetErrorIfFailure(Mat, PetscBool);
396: PETSC_EXTERN PetscFunctionList MatList;
397: PETSC_EXTERN PetscFunctionList MatColoringList;
398: PETSC_EXTERN PetscFunctionList MatPartitioningList;
400: /*E
401: MatStructure - Indicates if two matrices have the same nonzero structure
403: Values:
404: + `SAME_NONZERO_PATTERN` - the two matrices have identical nonzero patterns
405: . `DIFFERENT_NONZERO_PATTERN` - the two matrices may have different nonzero patterns
406: . `SUBSET_NONZERO_PATTERN` - the nonzero pattern of the second matrix is a subset of the nonzero pattern of the first matrix
407: - `UNKNOWN_NONZERO_PATTERN` - there is no known relationship between the nonzero patterns. In this case the implementations
408: may try to detect a relationship to optimize the operation
410: Level: beginner
412: Note:
413: Certain matrix operations (such as `MatAXPY()`) can run much faster if the sparsity pattern of the matrices are the same. But actually determining if
414: 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
415: to certain PETSc routines.
417: .seealso: [](ch_matrices), `Mat`, `MatCopy()`, `MatAXPY()`, `MatAYPX()`
418: E*/
419: typedef enum {
420: DIFFERENT_NONZERO_PATTERN,
421: SUBSET_NONZERO_PATTERN,
422: SAME_NONZERO_PATTERN,
423: UNKNOWN_NONZERO_PATTERN
424: } MatStructure;
425: PETSC_EXTERN const char *const MatStructures[];
427: #if defined(PETSC_HAVE_MKL_SPARSE)
428: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJMKL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
429: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJMKL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
430: PETSC_EXTERN PetscErrorCode MatCreateBAIJMKL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
431: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJMKL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
432: #endif
434: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJPERM(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
435: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJPERM(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
437: PETSC_EXTERN PetscErrorCode MatCreateSeqSELL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
438: PETSC_EXTERN PetscErrorCode MatCreateSELL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
439: PETSC_EXTERN PetscErrorCode MatSeqSELLSetPreallocation(Mat, PetscInt, const PetscInt[]);
440: PETSC_EXTERN PetscErrorCode MatMPISELLSetPreallocation(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
441: PETSC_EXTERN PetscErrorCode MatSeqSELLGetFillRatio(Mat, PetscReal *);
442: PETSC_EXTERN PetscErrorCode MatSeqSELLGetMaxSliceWidth(Mat, PetscInt *);
443: PETSC_EXTERN PetscErrorCode MatSeqSELLGetAvgSliceWidth(Mat, PetscReal *);
444: PETSC_EXTERN PetscErrorCode MatSeqSELLSetSliceHeight(Mat, PetscInt);
445: PETSC_EXTERN PetscErrorCode MatSeqSELLGetVarSliceSize(Mat, PetscReal *);
447: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJSELL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
448: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSELL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
449: PETSC_EXTERN PetscErrorCode MatMPISELLGetLocalMatCondensed(Mat, MatReuse, IS *, IS *, Mat *);
450: PETSC_EXTERN PetscErrorCode MatMPISELLGetSeqSELL(Mat, Mat *, Mat *, const PetscInt *[]);
452: PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm, PetscInt, PetscInt, PetscScalar[], Mat *);
453: PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar[], Mat *);
454: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
455: PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
456: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], Mat *);
457: PETSC_EXTERN PetscErrorCode MatUpdateMPIAIJWithArrays(Mat, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]);
458: PETSC_EXTERN PetscErrorCode MatUpdateMPIAIJWithArray(Mat, const PetscScalar[]);
459: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], PetscInt[], PetscInt[], PetscScalar[], Mat *);
460: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSeqAIJ(MPI_Comm, PetscInt, PetscInt, Mat, Mat, PetscInt *, Mat *);
462: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
463: PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
464: PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], Mat *);
466: PETSC_EXTERN PetscErrorCode MatSetPreallocationCOO(Mat, PetscCount, PetscInt[], PetscInt[]);
467: PETSC_EXTERN PetscErrorCode MatSetPreallocationCOOLocal(Mat, PetscCount, PetscInt[], PetscInt[]);
468: PETSC_EXTERN PetscErrorCode MatSetValuesCOO(Mat, const PetscScalar[], InsertMode);
470: PETSC_EXTERN PetscErrorCode MatCreateMPIAdj(MPI_Comm, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscInt[], Mat *);
471: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
473: PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
474: PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], Mat *);
475: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]);
476: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]);
477: PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscInt[], const PetscInt[]);
479: PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscCtx, Mat *);
480: PETSC_EXTERN PetscErrorCode MatCreateCentering(MPI_Comm, PetscInt, PetscInt, Mat *);
481: PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat, Mat *);
482: PETSC_EXTERN PetscErrorCode MatCreateNormalHermitian(Mat, Mat *);
483: PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat, Mat, Vec, Mat, Mat *);
484: PETSC_EXTERN PetscErrorCode MatLRCGetMats(Mat, Mat *, Mat *, Vec *, Mat *);
485: PETSC_EXTERN PetscErrorCode MatLRCSetMats(Mat, Mat, Mat, Vec, Mat);
486: PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, ISLocalToGlobalMapping, ISLocalToGlobalMapping, Mat *);
487: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
488: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
490: PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm, VecScatter, Mat *);
491: PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat, VecScatter);
492: PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat, VecScatter *);
493: PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt *, Mat *);
494: PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat, Mat);
495: PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat);
496: typedef enum {
497: MAT_COMPOSITE_MERGE_RIGHT,
498: MAT_COMPOSITE_MERGE_LEFT
499: } MatCompositeMergeType;
500: PETSC_EXTERN PetscErrorCode MatCompositeSetMergeType(Mat, MatCompositeMergeType);
501: PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm, PetscInt, const Mat *, Mat *);
502: /*E
503: MatCompositeType - indicates what type of `MATCOMPOSITE` is used
505: Values:
506: + `MAT_COMPOSITE_ADDITIVE` - sum of matrices (default)
507: - `MAT_COMPOSITE_MULTIPLICATIVE` - product of matrices
509: Level: beginner
511: .seealso: [](ch_matrices), `MATCOMPOSITE`, `MatCompositeSetType()`, `MatCompositeGetType()`
512: E*/
513: typedef enum {
514: MAT_COMPOSITE_ADDITIVE,
515: MAT_COMPOSITE_MULTIPLICATIVE
516: } MatCompositeType;
517: PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat, MatCompositeType);
518: PETSC_EXTERN PetscErrorCode MatCompositeGetType(Mat, MatCompositeType *);
519: PETSC_EXTERN PetscErrorCode MatCompositeSetMatStructure(Mat, MatStructure);
520: PETSC_EXTERN PetscErrorCode MatCompositeGetMatStructure(Mat, MatStructure *);
521: PETSC_EXTERN PetscErrorCode MatCompositeGetNumberMat(Mat, PetscInt *);
522: PETSC_EXTERN PetscErrorCode MatCompositeGetMat(Mat, PetscInt, Mat *);
523: PETSC_EXTERN PetscErrorCode MatCompositeSetScalings(Mat, const PetscScalar *);
525: PETSC_EXTERN PetscErrorCode MatCreateFFT(MPI_Comm, PetscInt, const PetscInt[], MatType, Mat *);
526: PETSC_EXTERN PetscErrorCode MatCreateSeqCUFFT(MPI_Comm, PetscInt, const PetscInt[], Mat *);
528: PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat, Mat *);
529: PETSC_EXTERN PetscErrorCode MatTransposeGetMat(Mat, Mat *);
530: PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat, Mat *);
531: PETSC_EXTERN PetscErrorCode MatHermitianTransposeGetMat(Mat, Mat *);
532: PETSC_EXTERN PetscErrorCode MatNormalGetMat(Mat, Mat *);
533: PETSC_EXTERN PetscErrorCode MatNormalHermitianGetMat(Mat, Mat *);
534: PETSC_EXTERN PetscErrorCode MatCreateSubMatrixVirtual(Mat, IS, IS, Mat *);
535: PETSC_EXTERN PetscErrorCode MatSubMatrixVirtualUpdate(Mat, Mat, IS, IS);
536: PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat, IS, IS, Mat *);
537: PETSC_EXTERN PetscErrorCode MatCreateConstantDiagonal(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar, Mat *);
538: PETSC_EXTERN PetscErrorCode MatCreateDiagonal(Vec, Mat *);
539: PETSC_EXTERN PetscErrorCode MatDiagonalSetDiagonal(Mat, Vec);
540: PETSC_EXTERN PetscErrorCode MatDiagonalGetDiagonal(Mat, Vec *);
541: PETSC_EXTERN PetscErrorCode MatDiagonalRestoreDiagonal(Mat, Vec *);
542: PETSC_EXTERN PetscErrorCode MatDiagonalGetInverseDiagonal(Mat, Vec *);
543: PETSC_EXTERN PetscErrorCode MatDiagonalRestoreInverseDiagonal(Mat, Vec *);
544: PETSC_EXTERN PetscErrorCode MatConstantDiagonalGetConstant(Mat, PetscScalar *);
545: PETSC_EXTERN PetscErrorCode MatGetCurrentMemType(Mat, PetscMemType *);
547: #if defined(PETSC_HAVE_HYPRE)
548: PETSC_EXTERN PetscErrorCode MatHYPRESetPreallocation(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
549: #endif
551: PETSC_EXTERN PetscErrorCode MatPythonSetType(Mat, const char[]);
552: PETSC_EXTERN PetscErrorCode MatPythonGetType(Mat, const char *[]);
553: PETSC_EXTERN PetscErrorCode MatPythonCreate(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const char[], Mat *);
555: PETSC_EXTERN PetscErrorCode MatResetPreallocation(Mat);
556: PETSC_EXTERN PetscErrorCode MatResetHash(Mat);
557: PETSC_EXTERN PetscErrorCode MatSetUp(Mat);
558: PETSC_EXTERN PetscErrorCode MatDestroy(Mat *);
559: PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat, PetscObjectState *);
561: PETSC_EXTERN PetscErrorCode MatConjugate(Mat);
562: PETSC_EXTERN PetscErrorCode MatRealPart(Mat);
563: PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat);
564: PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat, Mat *);
565: PETSC_EXTERN PetscErrorCode MatGetTrace(Mat, PetscScalar *);
566: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat, const PetscScalar **);
567: PETSC_EXTERN PetscErrorCode MatInvertVariableBlockDiagonal(Mat, PetscInt, const PetscInt *, PetscScalar *);
568: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonalMat(Mat, Mat);
569: PETSC_EXTERN PetscErrorCode MatInvertVariableBlockEnvelope(Mat, MatReuse, Mat *);
570: PETSC_EXTERN PetscErrorCode MatComputeVariableBlockEnvelope(Mat);
572: PETSC_EXTERN PetscErrorCode MatSetValues(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
573: PETSC_EXTERN PetscErrorCode MatSetValuesIS(Mat, IS, IS, const PetscScalar[], InsertMode);
574: PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
575: PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat, PetscInt, const PetscScalar[]);
576: PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat, PetscInt, const PetscScalar[]);
577: PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat, PetscInt, PetscInt, PetscInt[], const PetscScalar[]);
578: PETSC_EXTERN PetscErrorCode MatSetRandom(Mat, PetscRandom);
580: /*S
581: MatStencil - Data structure (C struct) for storing information about rows and
582: columns of a matrix as indexed on an associated grid. These are arguments to `MatSetStencil()` and `MatSetBlockStencil()`
584: Level: beginner
586: Notes:
587: 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).
588: 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.
590: For stencil access to vectors see `DMDAVecGetArray()`
592: For staggered grids, see `DMStagStencil`
594: .seealso: [](ch_matrices), `Mat`, `MatSetValuesStencil()`, `MatSetStencil()`, `MatSetValuesBlockedStencil()`, `DMDAVecGetArray()`,
595: `DMStagStencil`
596: S*/
597: typedef struct {
598: PetscInt k, j, i, c;
599: } MatStencil;
601: PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat, PetscInt, const MatStencil[], PetscInt, const MatStencil[], const PetscScalar[], InsertMode);
602: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat, PetscInt, const MatStencil[], PetscInt, const MatStencil[], const PetscScalar[], InsertMode);
603: PETSC_EXTERN PetscErrorCode MatSetStencil(Mat, PetscInt, const PetscInt[], const PetscInt[], PetscInt);
605: /*E
606: MatAssemblyType - Indicates if the process of setting values into the matrix is complete, and the matrix is ready for use
608: Values:
609: + `MAT_FLUSH_ASSEMBLY` - you will continue to put values into the matrix
610: - `MAT_FINAL_ASSEMBLY` - you wish to use the matrix with the values currently inserted
612: Level: beginner
614: .seealso: [](ch_matrices), `Mat`, `MatSetValues`, `MatAssemblyBegin()`, `MatAssemblyEnd()`
615: E*/
616: typedef enum {
617: MAT_FLUSH_ASSEMBLY = 1,
618: MAT_FINAL_ASSEMBLY = 0
619: } MatAssemblyType;
621: PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat, MatAssemblyType);
622: PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat, MatAssemblyType);
623: PETSC_EXTERN PetscErrorCode MatAssembled(Mat, PetscBool *);
625: /*E
626: MatOption - Options that may be set for a matrix that indicate properties of the matrix or affect its behavior or storage
628: Level: beginner
630: Note:
631: See `MatSetOption()` for the use of the options
633: Developer Note:
634: Entries that are negative need not be called collectively by all processes.
636: .seealso: [](ch_matrices), `Mat`, `MatSetOption()`
637: E*/
638: typedef enum {
639: MAT_OPTION_MIN = -3,
640: MAT_UNUSED_NONZERO_LOCATION_ERR = -2,
641: MAT_ROW_ORIENTED = -1,
642: MAT_SYMMETRIC = 1,
643: MAT_STRUCTURALLY_SYMMETRIC = 2,
644: MAT_FORCE_DIAGONAL_ENTRIES = 3,
645: MAT_IGNORE_OFF_PROC_ENTRIES = 4,
646: MAT_USE_HASH_TABLE = 5,
647: MAT_KEEP_NONZERO_PATTERN = 6,
648: MAT_IGNORE_ZERO_ENTRIES = 7,
649: MAT_USE_INODES = 8,
650: MAT_HERMITIAN = 9,
651: MAT_SYMMETRY_ETERNAL = 10,
652: MAT_NEW_NONZERO_LOCATION_ERR = 11,
653: MAT_IGNORE_LOWER_TRIANGULAR = 12,
654: MAT_ERROR_LOWER_TRIANGULAR = 13,
655: MAT_GETROW_UPPERTRIANGULAR = 14,
656: MAT_SPD = 15,
657: MAT_NO_OFF_PROC_ZERO_ROWS = 16,
658: MAT_NO_OFF_PROC_ENTRIES = 17,
659: MAT_NEW_NONZERO_LOCATIONS = 18,
660: MAT_NEW_NONZERO_ALLOCATION_ERR = 19,
661: MAT_SUBSET_OFF_PROC_ENTRIES = 20,
662: MAT_SUBMAT_SINGLEIS = 21,
663: MAT_STRUCTURE_ONLY = 22,
664: MAT_SORTED_FULL = 23,
665: MAT_FORM_EXPLICIT_TRANSPOSE = 24,
666: MAT_STRUCTURAL_SYMMETRY_ETERNAL = 25,
667: MAT_SPD_ETERNAL = 26,
668: MAT_OPTION_MAX = 27
669: } MatOption;
671: PETSC_EXTERN const char *const *MatOptions;
672: PETSC_EXTERN PetscErrorCode MatSetOption(Mat, MatOption, PetscBool);
673: PETSC_EXTERN PetscErrorCode MatGetOption(Mat, MatOption, PetscBool *);
674: PETSC_EXTERN PetscErrorCode MatPropagateSymmetryOptions(Mat, Mat);
675: PETSC_EXTERN PetscErrorCode MatGetType(Mat, MatType *);
677: PETSC_EXTERN PetscErrorCode MatGetValues(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], PetscScalar[]);
678: PETSC_EXTERN PetscErrorCode MatGetRow(Mat, PetscInt, PetscInt *, const PetscInt *[], const PetscScalar *[]);
679: PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat, PetscInt, PetscInt *, const PetscInt *[], const PetscScalar *[]);
680: PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat);
681: PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat);
682: PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat, Vec, PetscInt);
683: PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat, PetscScalar *[]);
684: PETSC_EXTERN PetscErrorCode MatSeqAIJGetArrayRead(Mat, const PetscScalar *[]);
685: PETSC_EXTERN PetscErrorCode MatSeqAIJGetArrayWrite(Mat, PetscScalar *[]);
686: PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat, PetscScalar *[]);
687: PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArrayRead(Mat, const PetscScalar *[]);
688: PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArrayWrite(Mat, PetscScalar *[]);
689: PETSC_EXTERN PetscErrorCode MatSeqAIJGetMaxRowNonzeros(Mat, PetscInt *);
690: PETSC_EXTERN PetscErrorCode MatSeqAIJSetValuesLocalFast(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
691: PETSC_EXTERN PetscErrorCode MatSeqAIJSetType(Mat, MatType);
692: PETSC_EXTERN PetscErrorCode MatSeqAIJKron(Mat, Mat, MatReuse, Mat *);
693: PETSC_EXTERN PetscErrorCode MatSeqAIJRegister(const char[], PetscErrorCode (*)(Mat, MatType, MatReuse, Mat *));
694: PETSC_EXTERN PetscFunctionList MatSeqAIJList;
695: PETSC_EXTERN PetscErrorCode MatSeqBAIJGetArray(Mat, PetscScalar *[]);
696: PETSC_EXTERN PetscErrorCode MatSeqBAIJRestoreArray(Mat, PetscScalar *[]);
697: PETSC_EXTERN PetscErrorCode MatSeqSBAIJGetArray(Mat, PetscScalar *[]);
698: PETSC_EXTERN PetscErrorCode MatSeqSBAIJRestoreArray(Mat, PetscScalar *[]);
699: PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat, PetscScalar *[]);
700: PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat, PetscScalar *[]);
701: PETSC_EXTERN PetscErrorCode MatDensePlaceArray(Mat, const PetscScalar[]);
702: PETSC_EXTERN PetscErrorCode MatDenseReplaceArray(Mat, const PetscScalar[]);
703: PETSC_EXTERN PetscErrorCode MatDenseReplaceArrayWithMemType(Mat, PetscMemType, const PetscScalar[]);
704: PETSC_EXTERN PetscErrorCode MatDenseResetArray(Mat);
705: PETSC_EXTERN PetscErrorCode MatDenseGetArrayRead(Mat, const PetscScalar *[]);
706: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayRead(Mat, const PetscScalar *[]);
707: PETSC_EXTERN PetscErrorCode MatDenseGetArrayWrite(Mat, PetscScalar *[]);
708: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayWrite(Mat, PetscScalar *[]);
709: PETSC_EXTERN PetscErrorCode MatDenseGetArrayAndMemType(Mat, PetscScalar *[], PetscMemType *);
710: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayAndMemType(Mat, PetscScalar *[]);
711: PETSC_EXTERN PetscErrorCode MatDenseGetArrayReadAndMemType(Mat, const PetscScalar *[], PetscMemType *);
712: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayReadAndMemType(Mat, const PetscScalar *[]);
713: PETSC_EXTERN PetscErrorCode MatDenseGetArrayWriteAndMemType(Mat, PetscScalar *[], PetscMemType *);
714: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayWriteAndMemType(Mat, PetscScalar *[]);
715: PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat, PetscInt *);
716: PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat, PetscInt);
717: PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat, PetscInt *, PetscInt *);
718: PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat, PetscInt, PetscInt);
719: PETSC_EXTERN PetscErrorCode MatSetBlockSizesFromMats(Mat, Mat, Mat);
720: PETSC_EXTERN PetscErrorCode MatSetVariableBlockSizes(Mat, PetscInt, const PetscInt[]);
721: PETSC_EXTERN PetscErrorCode MatGetVariableBlockSizes(Mat, PetscInt *, const PetscInt *[]);
722: PETSC_EXTERN PetscErrorCode MatSelectVariableBlockSizes(Mat, Mat, IS);
724: PETSC_EXTERN PetscErrorCode MatDenseGetColumn(Mat, PetscInt, PetscScalar *[]);
725: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumn(Mat, PetscScalar *[]);
726: PETSC_EXTERN PetscErrorCode MatDenseGetColumnVec(Mat, PetscInt, Vec *);
727: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVec(Mat, PetscInt, Vec *);
728: PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecRead(Mat, PetscInt, Vec *);
729: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecRead(Mat, PetscInt, Vec *);
730: PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecWrite(Mat, PetscInt, Vec *);
731: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecWrite(Mat, PetscInt, Vec *);
732: PETSC_EXTERN PetscErrorCode MatDenseGetSubMatrix(Mat, PetscInt, PetscInt, PetscInt, PetscInt, Mat *);
733: PETSC_EXTERN PetscErrorCode MatDenseRestoreSubMatrix(Mat, Mat *);
735: PETSC_EXTERN PetscErrorCode MatMult(Mat, Vec, Vec);
736: PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat, Vec, Vec);
737: PETSC_EXTERN PetscErrorCode MatMultAdd(Mat, Vec, Vec, Vec);
738: PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat, Vec, Vec);
739: PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat, Vec, Vec);
740: PETSC_EXTERN PetscErrorCode MatADot(Mat, Vec, Vec, PetscScalar *);
741: PETSC_EXTERN PetscErrorCode MatANorm(Mat, Vec, PetscReal *);
742: PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat, Mat, PetscReal, PetscBool *);
743: PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat, Mat, PetscReal, PetscBool *);
744: PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat, Vec, Vec, Vec);
745: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat, Vec, Vec, Vec);
746: PETSC_EXTERN PetscErrorCode MatMatSolve(Mat, Mat, Mat);
747: PETSC_EXTERN PetscErrorCode MatMatSolveTranspose(Mat, Mat, Mat);
748: PETSC_EXTERN PetscErrorCode MatMatTransposeSolve(Mat, Mat, Mat);
749: PETSC_EXTERN PetscErrorCode MatResidual(Mat, Vec, Vec, Vec);
751: /*E
752: MatDuplicateOption - Indicates if a duplicated sparse matrix should have
753: its numerical values copied over or just its nonzero structure.
755: Values:
756: + `MAT_DO_NOT_COPY_VALUES` - Create a matrix using the same nonzero pattern as the original matrix,
757: with zeros for the numerical values
758: . `MAT_COPY_VALUES` - Create a matrix with the same nonzero pattern as the original matrix
759: and with the same numerical values.
760: - `MAT_SHARE_NONZERO_PATTERN` - Create a matrix that shares the nonzero structure with the previous matrix
761: and does not copy it, using zeros for the numerical values. The parent and
762: child matrices will share their index (i and j) arrays, and you cannot
763: insert new nonzero entries into either matrix
765: Level: beginner
767: Note:
768: Many matrix types (including `MATSEQAIJ`) do not support the `MAT_SHARE_NONZERO_PATTERN` optimization; in
769: this case the behavior is as if `MAT_DO_NOT_COPY_VALUES` has been specified.
771: .seealso: [](ch_matrices), `Mat`, `MatDuplicate()`
772: E*/
773: typedef enum {
774: MAT_DO_NOT_COPY_VALUES,
775: MAT_COPY_VALUES,
776: MAT_SHARE_NONZERO_PATTERN
777: } MatDuplicateOption;
779: PETSC_EXTERN PetscErrorCode MatConvert(Mat, MatType, MatReuse, Mat *);
780: PETSC_EXTERN PetscErrorCode MatDuplicate(Mat, MatDuplicateOption, Mat *);
782: PETSC_EXTERN PetscErrorCode MatCopy(Mat, Mat, MatStructure);
783: PETSC_EXTERN PetscErrorCode MatView(Mat, PetscViewer);
784: PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat, PetscReal, PetscBool *);
785: PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat, PetscBool *);
786: PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat, PetscReal, PetscBool *);
787: PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat, PetscBool *, PetscBool *);
788: PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat, PetscBool *, PetscBool *);
789: PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetricKnown(Mat, PetscBool *, PetscBool *);
790: PETSC_EXTERN PetscErrorCode MatIsSPDKnown(Mat, PetscBool *, PetscBool *);
791: PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer);
793: PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *);
794: PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *);
795: PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *);
796: PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *);
798: /*S
799: MatInfo - Context of matrix information, used with `MatGetInfo()`
801: Level: intermediate
803: Fortran Note:
804: `MatInfo` is a derived type, use e.g. `matinfo%nz_allocated` to access its components.
806: .seealso: [](ch_matrices), `Mat`, `MatGetInfo()`, `MatInfoType`
807: S*/
808: typedef struct {
809: PetscLogDouble block_size; /* block size */
810: PetscLogDouble nz_allocated, nz_used, nz_unneeded; /* number of nonzeros */
811: PetscLogDouble memory; /* memory allocated */
812: PetscLogDouble assemblies; /* number of matrix assemblies called */
813: PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */
814: PetscLogDouble fill_ratio_given, fill_ratio_needed; /* fill ratio for LU/ILU */
815: PetscLogDouble factor_mallocs; /* number of mallocs during factorization */
816: } MatInfo;
818: /*E
819: MatInfoType - Indicates if you want information about the local part of the matrix,
820: the entire parallel matrix or the maximum over all the local parts.
822: Values:
823: + `MAT_LOCAL` - values for each MPI process part of the matrix
824: . `MAT_GLOBAL_MAX` - maximum of each value over all MPI processes
825: - `MAT_GLOBAL_SUM` - sum of each value over all MPI processes
827: Level: beginner
829: .seealso: [](ch_matrices), `MatGetInfo()`, `MatInfo`
830: E*/
831: typedef enum {
832: MAT_LOCAL = 1,
833: MAT_GLOBAL_MAX = 2,
834: MAT_GLOBAL_SUM = 3
835: } MatInfoType;
836: PETSC_EXTERN PetscErrorCode MatGetInfo(Mat, MatInfoType, MatInfo *);
837: PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat, Vec);
838: PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat, Vec, PetscInt[]);
839: PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat, Vec, PetscInt[]);
840: PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat, Vec, PetscInt[]);
841: PETSC_EXTERN PetscErrorCode MatGetRowSumAbs(Mat, Vec);
842: PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat, Vec, PetscInt[]);
843: PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat, Vec);
844: PETSC_EXTERN PetscErrorCode MatTranspose(Mat, MatReuse, Mat *);
845: PETSC_EXTERN PetscErrorCode MatTransposeSymbolic(Mat, Mat *);
846: PETSC_EXTERN PetscErrorCode MatTransposeSetPrecursor(Mat, Mat);
847: PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat, MatReuse, Mat *);
848: PETSC_EXTERN PetscErrorCode MatPermute(Mat, IS, IS, Mat *);
849: PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat, Vec, Vec);
850: PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat, Vec, InsertMode);
852: PETSC_EXTERN PetscErrorCode MatEqual(Mat, Mat, PetscBool *);
853: PETSC_EXTERN PetscErrorCode MatMultEqual(Mat, Mat, PetscInt, PetscBool *);
854: PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat, Mat, PetscInt, PetscBool *);
855: PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat, Mat, PetscInt, PetscBool *);
856: PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat, Mat, PetscInt, PetscBool *);
857: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeEqual(Mat, Mat, PetscInt, PetscBool *);
858: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAddEqual(Mat, Mat, PetscInt, PetscBool *);
859: PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *);
860: PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *);
861: PETSC_EXTERN PetscErrorCode MatMatTransposeMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *);
862: PETSC_EXTERN PetscErrorCode MatPtAPMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *);
863: PETSC_EXTERN PetscErrorCode MatRARtMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *);
864: PETSC_EXTERN PetscErrorCode MatIsLinear(Mat, PetscInt, PetscBool *);
866: PETSC_EXTERN PetscErrorCode MatNorm(Mat, NormType, PetscReal *);
867: PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat, NormType, PetscReal *);
868: PETSC_EXTERN PetscErrorCode MatGetColumnSums(Mat, PetscScalar *);
869: PETSC_EXTERN PetscErrorCode MatGetColumnSumsRealPart(Mat, PetscReal *);
870: PETSC_EXTERN PetscErrorCode MatGetColumnSumsImaginaryPart(Mat, PetscReal *);
871: PETSC_EXTERN PetscErrorCode MatGetColumnMeans(Mat, PetscScalar *);
872: PETSC_EXTERN PetscErrorCode MatGetColumnMeansRealPart(Mat, PetscReal *);
873: PETSC_EXTERN PetscErrorCode MatGetColumnMeansImaginaryPart(Mat, PetscReal *);
874: PETSC_EXTERN PetscErrorCode MatGetColumnReductions(Mat, PetscInt, PetscReal *);
875: PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat);
876: PETSC_EXTERN PetscErrorCode MatSetInf(Mat);
877: PETSC_EXTERN PetscErrorCode MatZeroRows(Mat, PetscInt, const PetscInt[], PetscScalar, Vec, Vec);
878: PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat, IS, PetscScalar, Vec, Vec);
879: PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat, PetscInt, const MatStencil[], PetscScalar, Vec, Vec);
880: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat, PetscInt, const MatStencil[], PetscScalar, Vec, Vec);
881: PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat, PetscInt, const PetscInt[], PetscScalar, Vec, Vec);
882: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat, IS, PetscScalar, Vec, Vec);
884: PETSC_EXTERN PetscErrorCode MatGetSize(Mat, PetscInt *, PetscInt *);
885: PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat, PetscInt *, PetscInt *);
886: PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat, PetscInt *, PetscInt *);
887: PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat, const PetscInt **);
888: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat, PetscInt *, PetscInt *);
889: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat, const PetscInt **);
890: PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat, IS *, IS *);
892: PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat, PetscInt, const IS[], const IS[], MatReuse, Mat *[]);
893: 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[])
894: {
895: return MatCreateSubMatrices(mat, n, irow, icol, scall, submat);
896: }
897: PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat, PetscInt, const IS[], const IS[], MatReuse, Mat *[]);
898: 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[])
899: {
900: return MatCreateSubMatricesMPI(mat, n, irow, icol, scall, submat);
901: }
902: PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt, Mat *[]);
903: PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt, Mat *[]);
904: PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat, IS, IS, MatReuse, Mat *);
905: PETSC_DEPRECATED_FUNCTION(3, 8, 0, "MatCreateSubMatrix()", ) static inline PetscErrorCode MatGetSubMatrix(Mat mat, IS isrow, IS iscol, MatReuse cll, Mat *newmat)
906: {
907: return MatCreateSubMatrix(mat, isrow, iscol, cll, newmat);
908: }
909: PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat, IS, IS, Mat *);
910: PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat, IS, IS, Mat *);
911: PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat, Mat *);
912: PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat *);
914: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm, Mat, PetscInt, PetscInt, MatReuse, Mat *);
915: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm, Mat, PetscInt, PetscInt, Mat *);
916: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat, Mat);
917: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat, MatReuse, Mat *);
918: PETSC_EXTERN PetscErrorCode MatAIJGetLocalMat(Mat, Mat *);
919: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat, MatReuse, IS *, IS *, Mat *);
920: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatMerge(Mat, MatReuse, IS *, Mat *);
921: PETSC_EXTERN PetscErrorCode MatMPIAIJGetNumberNonzeros(Mat, PetscCount *);
922: PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat, Mat, MatReuse, IS *, IS *, Mat *);
923: PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *, const PetscInt *[]);
925: PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat, PetscInt, IS[], PetscInt);
926: PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat, PetscInt, IS[], PetscInt);
927: PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat, PetscBool);
929: PETSC_EXTERN PetscErrorCode MatMatMult(Mat, Mat, MatReuse, PetscReal, Mat *);
931: PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat, Mat, Mat, MatReuse, PetscReal, Mat *);
932: PETSC_EXTERN PetscErrorCode MatGalerkin(Mat, Mat, Mat, MatReuse, PetscReal, Mat *);
934: PETSC_EXTERN PetscErrorCode MatPtAP(Mat, Mat, MatReuse, PetscReal, Mat *);
935: PETSC_EXTERN PetscErrorCode MatRARt(Mat, Mat, MatReuse, PetscReal, Mat *);
937: PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat, Mat, MatReuse, PetscReal, Mat *);
938: PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat, Mat, MatReuse, PetscReal, Mat *);
940: PETSC_EXTERN PetscErrorCode MatAXPY(Mat, PetscScalar, Mat, MatStructure);
941: PETSC_EXTERN PetscErrorCode MatAYPX(Mat, PetscScalar, Mat, MatStructure);
943: PETSC_EXTERN PetscErrorCode MatScale(Mat, PetscScalar);
944: PETSC_EXTERN PetscErrorCode MatShift(Mat, PetscScalar);
946: PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat, ISLocalToGlobalMapping, ISLocalToGlobalMapping);
947: PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat, ISLocalToGlobalMapping *, ISLocalToGlobalMapping *);
948: PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat, PetscLayout *, PetscLayout *);
949: PETSC_EXTERN PetscErrorCode MatSetLayouts(Mat, PetscLayout, PetscLayout);
950: PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat, PetscInt, const PetscInt[], PetscScalar, Vec, Vec);
951: PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat, IS, PetscScalar, Vec, Vec);
952: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat, PetscInt, const PetscInt[], PetscScalar, Vec, Vec);
953: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat, IS, PetscScalar, Vec, Vec);
954: PETSC_EXTERN PetscErrorCode MatGetValuesLocal(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], PetscScalar[]);
955: PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
956: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
958: PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat, PetscInt, PetscInt);
959: PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat, PetscInt *, PetscInt *, PetscInt *, PetscInt *);
961: PETSC_EXTERN PetscErrorCode MatInterpolate(Mat, Vec, Vec);
962: PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat, Vec, Vec, Vec);
963: PETSC_EXTERN PetscErrorCode MatRestrict(Mat, Vec, Vec);
964: PETSC_EXTERN PetscErrorCode MatMatInterpolate(Mat, Mat, Mat *);
965: PETSC_EXTERN PetscErrorCode MatMatInterpolateAdd(Mat, Mat, Mat, Mat *);
966: PETSC_EXTERN PetscErrorCode MatMatRestrict(Mat, Mat, Mat *);
967: PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat, Vec *, Vec *);
968: PETSC_DEPRECATED_FUNCTION(3, 6, 0, "MatCreateVecs()", ) static inline PetscErrorCode MatGetVecs(Mat mat, Vec *x, Vec *y)
969: {
970: return MatCreateVecs(mat, x, y);
971: }
972: PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat, PetscInt, MPI_Comm, MatReuse, Mat *);
973: PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat, MPI_Comm, MatReuse, Mat *);
974: PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat, IS *);
975: PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat, IS *);
976: PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm, Mat, PetscInt, MatReuse, Mat *);
978: PETSC_EXTERN PetscErrorCode MatCopyHashToXAIJ(Mat A, Mat B);
979: /*@C
980: MatSetValue - Set a single entry into a matrix.
982: Not Collective
984: Input Parameters:
985: + mat - the matrix
986: . i - the row location of the entry
987: . j - the column location of the entry
988: . va - the value to insert
989: - mode - either `INSERT_VALUES` or `ADD_VALUES`
991: Level: beginner
993: Notes:
994: This value may be cached, so `MatAssemblyBegin()` and `MatAssemblyEnd()`
995: MUST be called after all calls to `MatSetValue()` have been completed.
997: For efficiency one should use `MatSetValues()` and set several values simultaneously.
999: .seealso: [](ch_matrices), `Mat`, `MatAssemblyBegin()`, `MatAssemblyEnd()`, `InsertMode`, `MatGetValue()`, `MatSetValues()`,
1000: `MatSetValueLocal()`, `MatSetValuesLocal()`
1001: @*/
1002: static inline PetscErrorCode MatSetValue(Mat mat, PetscInt i, PetscInt j, PetscScalar va, InsertMode mode)
1003: {
1004: return MatSetValues(mat, 1, &i, 1, &j, &va, mode);
1005: }
1007: /*@C
1008: MatGetValue - Gets a single value from a matrix
1010: Not Collective; can only return a value owned by the given process
1012: Input Parameters:
1013: + mat - the matrix
1014: . row - the row location of the entry
1015: - col - the column location of the entry
1017: Output Parameter:
1018: . va - the value
1020: Level: advanced
1022: Notes:
1023: The matrix must have been assembled with `MatAssemblyBegin()` and `MatAssemblyEnd()` before this call
1025: For efficiency one should use `MatGetValues()` and get several values simultaneously.
1027: See notes for `MatGetValues()`.
1029: .seealso: [](ch_matrices), `Mat`, `MatAssemblyBegin()`, `MatAssemblyEnd()`, `MatSetValue()`, `MatGetValuesLocal()`, `MatGetValues()`
1030: @*/
1031: static inline PetscErrorCode MatGetValue(Mat mat, PetscInt row, PetscInt col, PetscScalar *va)
1032: {
1033: return MatGetValues(mat, 1, &row, 1, &col, va);
1034: }
1036: /*@C
1037: MatSetValueLocal - Inserts or adds a single value into a matrix, using a local numbering of the nodes.
1039: Not Collective
1041: Input Parameters:
1042: + mat - the matrix
1043: . i - the row location of the entry
1044: . j - the column location of the entry
1045: . va - the value to insert
1046: - mode - either `INSERT_VALUES` or `ADD_VALUES`
1048: Level: intermediate
1050: Notes:
1051: For efficiency one should use `MatSetValuesLocal()` and set several values simultaneously.
1053: See notes for `MatSetValuesLocal()` for additional information on when and how this function can be used.
1055: .seealso: [](ch_matrices), `MatSetValue()`, `MatSetValuesLocal()`
1056: @*/
1057: static inline PetscErrorCode MatSetValueLocal(Mat mat, PetscInt i, PetscInt j, PetscScalar va, InsertMode mode)
1058: {
1059: return MatSetValuesLocal(mat, 1, &i, 1, &j, &va, mode);
1060: }
1062: /*MC
1063: MatPreallocateBegin - Begins the block of code that will count the number of nonzeros per
1064: row in a matrix providing the data that one can use to correctly preallocate the matrix.
1066: Synopsis:
1067: #include <petscmat.h>
1068: PetscErrorCode MatPreallocateBegin(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
1070: Collective
1072: Input Parameters:
1073: + comm - the communicator that will share the eventually allocated matrix
1074: . nrows - the number of LOCAL rows in the matrix
1075: - ncols - the number of LOCAL columns in the matrix
1077: Output Parameters:
1078: + dnz - the array that will be passed to the matrix preallocation routines
1079: - onz - the other array passed to the matrix preallocation routines
1081: Level: deprecated (since v3.19)
1083: Notes:
1084: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1085: the use of this routine
1087: This is a macro that handles its own error checking, it does not return an error code.
1089: Do not malloc or free `dnz` and `onz`, that is handled internally by these routines
1091: Developer Note:
1092: This is a MACRO, not a function, because it has a leading { that is closed by `PetscPreallocateFinalize()`.
1094: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`,
1095: `MatPreallocateSymmetricSetLocalBlock()`
1096: M*/
1097: #define MatPreallocateBegin(comm, nrows, ncols, dnz, onz) \
1098: do { \
1099: PetscInt __nrows = (nrows), __ncols = (ncols), __rstart, __end = 0; \
1100: PetscInt PETSC_UNUSED __start; \
1101: PetscCall(PetscCalloc2(__nrows, &(dnz), __nrows, &(onz))); \
1102: PetscCallMPI(MPI_Scan(&__ncols, &__end, 1, MPIU_INT, MPI_SUM, comm)); \
1103: __start = __end - __ncols; \
1104: (void)__start; \
1105: PetscCallMPI(MPI_Scan(&__nrows, &__rstart, 1, MPIU_INT, MPI_SUM, comm)); \
1106: __rstart -= __nrows
1108: #define MatPreallocateInitialize(...) PETSC_DEPRECATED_MACRO(3, 18, 0, "MatPreallocateBegin()", ) MatPreallocateBegin(__VA_ARGS__)
1110: /*MC
1111: MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1112: inserted using a local number of the rows and columns
1114: Synopsis:
1115: #include <petscmat.h>
1116: PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
1118: Not Collective
1120: Input Parameters:
1121: + map - the row mapping from local numbering to global numbering
1122: . nrows - the number of rows indicated
1123: . rows - the indices of the rows
1124: . cmap - the column mapping from local to global numbering
1125: . ncols - the number of columns in the matrix
1126: . cols - the columns indicated
1127: . dnz - the array that will be passed to the matrix preallocation routines
1128: - onz - the other array passed to the matrix preallocation routines
1130: Level: deprecated (since v3.19)
1132: Notes:
1133: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1134: the use of this routine
1136: Do not malloc or free `dnz` and `onz`, that is handled internally by these routines
1138: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`,
1139: `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocalRemoveDups()`
1140: M*/
1141: #define MatPreallocateSetLocal(rmap, nrows, rows, cmap, ncols, cols, dnz, onz) \
1142: 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));)
1144: /*MC
1145: MatPreallocateSetLocalRemoveDups - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1146: inserted using a local number of the rows and columns. This version removes any duplicate columns in cols
1148: Synopsis:
1149: #include <petscmat.h>
1150: PetscErrorCode MatPreallocateSetLocalRemoveDups(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
1152: Not Collective
1154: Input Parameters:
1155: + map - the row mapping from local numbering to global numbering
1156: . nrows - the number of rows indicated
1157: . rows - the indices of the rows (these values are mapped to the global values)
1158: . cmap - the column mapping from local to global numbering
1159: . ncols - the number of columns in the matrix (this value will be changed if duplicate columns are found)
1160: . cols - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed)
1161: . dnz - the array that will be passed to the matrix preallocation routines
1162: - onz - the other array passed to the matrix preallocation routines
1164: Level: deprecated (since v3.19)
1166: Notes:
1167: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1168: the use of this routine
1170: Do not malloc or free `dnz` and `onz`, that is handled internally by these routines
1172: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`,
1173: `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocal()`
1174: M*/
1175: #define MatPreallocateSetLocalRemoveDups(rmap, nrows, rows, cmap, ncols, cols, dnz, onz) \
1176: 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));)
1178: /*MC
1179: MatPreallocateSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1180: inserted using a local number of the rows and columns
1182: Synopsis:
1183: #include <petscmat.h>
1184: PetscErrorCode MatPreallocateSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
1186: Not Collective
1188: Input Parameters:
1189: + map - the row mapping from local numbering to global numbering
1190: . nrows - the number of rows indicated
1191: . rows - the indices of the rows
1192: . cmap - the column mapping from local to global numbering
1193: . ncols - the number of columns in the matrix
1194: . cols - the columns indicated
1195: . dnz - the array that will be passed to the matrix preallocation routines
1196: - onz - the other array passed to the matrix preallocation routines
1198: Level: deprecated (since v3.19)
1200: Notes:
1201: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1202: the use of this routine
1204: Do not malloc or free `dnz` and `onz`, that is handled internally by these routines
1206: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`,
1207: `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()`
1208: M*/
1209: #define MatPreallocateSetLocalBlock(rmap, nrows, rows, cmap, ncols, cols, dnz, onz) \
1210: 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));)
1212: /*MC
1213: MatPreallocateSymmetricSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1214: inserted using a local number of the rows and columns
1216: Synopsis:
1217: #include <petscmat.h>
1218: PetscErrorCode MatPreallocateSymmetricSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
1220: Not Collective
1222: Input Parameters:
1223: + map - the mapping between local numbering and global numbering
1224: . nrows - the number of rows indicated
1225: . rows - the indices of the rows
1226: . ncols - the number of columns in the matrix
1227: . cols - the columns indicated
1228: . dnz - the array that will be passed to the matrix preallocation routines
1229: - onz - the other array passed to the matrix preallocation routines
1231: Level: deprecated (since v3.19)
1233: Notes:
1234: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1235: the use of this routine
1237: Do not malloc or free `dnz` and `onz` that is handled internally by these routines
1239: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`,
1240: `MatPreallocateBegin()`, `MatPreallocateSetLocal()`
1241: M*/
1242: #define MatPreallocateSymmetricSetLocalBlock(map, nrows, rows, ncols, cols, dnz, onz) \
1243: 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));)
1245: /*MC
1246: MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1247: inserted using a local number of the rows and columns
1249: Synopsis:
1250: #include <petscmat.h>
1251: PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
1253: Not Collective
1255: Input Parameters:
1256: + row - the row
1257: . ncols - the number of columns in the matrix
1258: - cols - the columns indicated
1260: Output Parameters:
1261: + dnz - the array that will be passed to the matrix preallocation routines
1262: - onz - the other array passed to the matrix preallocation routines
1264: Level: deprecated (since v3.19)
1266: Notes:
1267: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1268: the use of this routine
1270: Do not malloc or free `dnz` and `onz` that is handled internally by these routines
1272: This is a MACRO, not a function, because it uses variables declared in MatPreallocateBegin().
1274: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`,
1275: `MatPreallocateBegin()`, `MatPreallocateSetLocal()`
1276: M*/
1277: #define MatPreallocateSet(row, nc, cols, dnz, onz) \
1278: 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) { \
1279: if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
1280: else if (dnz[row - __rstart] < __ncols) dnz[row - __rstart]++; \
1281: })
1283: /*MC
1284: MatPreallocateSymmetricSetBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1285: inserted using a local number of the rows and columns
1287: Synopsis:
1288: #include <petscmat.h>
1289: PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
1291: Not Collective
1293: Input Parameters:
1294: + nrows - the number of rows indicated
1295: . rows - the indices of the rows
1296: . ncols - the number of columns in the matrix
1297: . cols - the columns indicated
1298: . dnz - the array that will be passed to the matrix preallocation routines
1299: - onz - the other array passed to the matrix preallocation routines
1301: Level: deprecated (since v3.19)
1303: Notes:
1304: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1305: the use of this routine
1307: Do not malloc or free `dnz` and `onz` that is handled internally by these routines
1309: This is a MACRO, not a function, because it uses variables declared in MatPreallocateBegin().
1311: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateBegin()`,
1312: `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocal()`
1313: M*/
1314: #define MatPreallocateSymmetricSetBlock(row, nc, cols, dnz, onz) \
1315: PetscMacroReturnStandard(for (PetscInt __i = 0; __i < nc; __i++) { \
1316: if (cols[__i] >= __end) onz[row - __rstart]++; \
1317: else if (cols[__i] >= row && dnz[row - __rstart] < __ncols) dnz[row - __rstart]++; \
1318: })
1320: /*MC
1321: MatPreallocateLocation - An alternative to MatPreallocateSet() that puts the nonzero locations into the matrix if it exists
1323: Synopsis:
1324: #include <petscmat.h>
1325: PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)
1327: Not Collective
1329: Input Parameters:
1330: + A - matrix
1331: . row - row where values exist (must be local to this process)
1332: . ncols - number of columns
1333: . cols - columns with nonzeros
1334: . dnz - the array that will be passed to the matrix preallocation routines
1335: - onz - the other array passed to the matrix preallocation routines
1337: Level: deprecated (since v3.19)
1339: Notes:
1340: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1341: the use of this routine
1343: Do not malloc or free `dnz` and `onz` that is handled internally by these routines
1345: Developer Note:
1346: This is a MACRO, not a function, because it uses a bunch of variables private to the MatPreallocation.... routines.
1348: .seealso: [](ch_matrices), `MatPreallocateBegin()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`,
1349: `MatPreallocateSymmetricSetLocalBlock()`
1350: M*/
1351: #define MatPreallocateLocation(A, row, ncols, cols, dnz, onz) (A ? MatSetValues(A, 1, &row, ncols, cols, NULL, INSERT_VALUES) : MatPreallocateSet(row, ncols, cols, dnz, onz))
1353: /*MC
1354: MatPreallocateEnd - Ends the block of code that will count the number of nonzeros per
1355: row in a matrix providing the data that one can use to correctly preallocate the matrix.
1357: Synopsis:
1358: #include <petscmat.h>
1359: PetscErrorCode MatPreallocateEnd(PetscInt *dnz, PetscInt *onz)
1361: Collective
1363: Input Parameters:
1364: + dnz - the array that was be passed to the matrix preallocation routines
1365: - onz - the other array passed to the matrix preallocation routines
1367: Level: deprecated (since v3.19)
1369: Notes:
1370: This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1371: the use of this routine
1373: Do not malloc or free `dnz` and `onz`, that is handled internally by these routines
1375: Developer Note:
1376: This is a MACRO, not a function, because it closes the { started in MatPreallocateBegin().
1378: .seealso: [](ch_matrices), `MatPreallocateBegin()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`,
1379: `MatPreallocateSymmetricSetLocalBlock()`
1380: M*/
1381: #define MatPreallocateEnd(dnz, onz) \
1382: PetscCall(PetscFree2(dnz, onz)); \
1383: } \
1384: while (0)
1386: #define MatPreallocateFinalize(...) PETSC_DEPRECATED_MACRO(3, 18, 0, "MatPreallocateEnd()", ) MatPreallocateEnd(__VA_ARGS__)
1388: /* Routines unique to particular data structures */
1389: PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat, PetscCtxRt);
1391: PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat, IS *, IS *);
1392: PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat, PetscInt *, PetscInt *[], PetscInt *);
1394: PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat, PetscInt[]);
1395: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat, PetscInt[]);
1396: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], Mat *);
1397: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], Mat *);
1398: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], Mat *);
1399: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], Mat *, PetscCount, PetscBool);
1401: #define MAT_SKIP_ALLOCATION -4
1403: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[]);
1404: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[]);
1405: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat, PetscInt, const PetscInt[]);
1406: PETSC_EXTERN PetscErrorCode MatSeqAIJSetTotalPreallocation(Mat, PetscInt);
1408: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
1409: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
1410: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
1411: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat, const PetscInt[], const PetscInt[], const PetscScalar[]);
1412: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]);
1413: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat, const PetscInt[], const PetscInt[], const PetscScalar[]);
1414: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]);
1415: PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat, PetscInt[], PetscInt[], PetscInt[]);
1416: PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat, Mat *);
1417: PETSC_EXTERN PetscErrorCode MatMPIAdjToSeqRankZero(Mat, Mat *);
1418: PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat, PetscScalar[]);
1419: PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat, PetscScalar[]);
1420: PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat, Mat *, Mat *, const PetscInt *[]);
1421: PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat, Mat *, Mat *, const PetscInt *[]);
1422: PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat, Mat *);
1424: PETSC_EXTERN PetscErrorCode MatDenseGetLDA(Mat, PetscInt *);
1425: PETSC_EXTERN PetscErrorCode MatDenseSetLDA(Mat, PetscInt);
1426: PETSC_DEPRECATED_FUNCTION(3, 14, 0, "MatDenseSetLDA()", ) static inline PetscErrorCode MatSeqDenseSetLDA(Mat A, PetscInt lda)
1427: {
1428: return MatDenseSetLDA(A, lda);
1429: }
1430: PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat, Mat *);
1432: PETSC_EXTERN PetscErrorCode MatBlockMatSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[]);
1434: PETSC_EXTERN PetscErrorCode MatStoreValues(Mat);
1435: PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat);
1437: PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat, IS *);
1438: PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat, IS *);
1439: /*
1440: These routines are not usually accessed directly, rather solving is
1441: done through the KSP and PC interfaces.
1442: */
1444: /*J
1445: MatOrderingType - String with the name of a PETSc matrix ordering. These orderings are most commonly used
1446: to reduce fill in sparse factorizations.
1448: Level: beginner
1450: Notes:
1451: If `MATORDERINGEXTERNAL` is used then PETSc does not compute an ordering and instead the external factorization solver package called utilizes one
1452: of its own.
1454: There is no `MatOrdering` object, the ordering is obtained directly from the matrix with `MatGetOrdering()`
1456: Developer Note:
1457: This API should be converted to an API similar to those for `MatColoring` and `MatPartitioning`
1459: .seealso: [](ch_matrices), [](sec_graph), `MatGetFactor()`, `MatGetOrdering()`, `MatColoringType`, `MatPartitioningType`, `MatCoarsenType`, `PCFactorSetOrderingType()`
1460: J*/
1461: typedef const char *MatOrderingType;
1462: #define MATORDERINGNATURAL "natural"
1463: #define MATORDERINGND "nd"
1464: #define MATORDERING1WD "1wd"
1465: #define MATORDERINGRCM "rcm"
1466: #define MATORDERINGQMD "qmd"
1467: #define MATORDERINGROWLENGTH "rowlength"
1468: #define MATORDERINGWBM "wbm"
1469: #define MATORDERINGSPECTRAL "spectral"
1470: #define MATORDERINGAMD "amd" /* only works if UMFPACK is installed with PETSc */
1471: #define MATORDERINGMETISND "metisnd" /* only works if METIS is installed with PETSc */
1472: #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 */
1473: #define MATORDERINGEXTERNAL "external" /* uses an ordering type internal to the factorization package */
1475: PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat, MatOrderingType, IS *, IS *);
1476: PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList *);
1477: PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[], PetscErrorCode (*)(Mat, MatOrderingType, IS *, IS *));
1478: PETSC_EXTERN PetscFunctionList MatOrderingList;
1480: #include "petscmatcoarsen.h"
1482: PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat, PetscReal, IS, IS);
1483: PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat, PetscReal, PetscBool, Mat *);
1485: PETSC_EXTERN PetscErrorCode MatFactorGetPreferredOrdering(Mat, MatFactorType, MatOrderingType *);
1487: /*S
1488: MatFactorShiftType - Type of numeric shift used for factorizations
1490: Values:
1491: + `MAT_SHIFT_NONE` - do not shift the matrix diagonal entries
1492: . `MAT_SHIFT_NONZERO` - shift the entries to be non-zero
1493: . `MAT_SHIFT_POSITIVE_DEFINITE` - shift the entries to force the factorization to be positive definite
1494: - `MAT_SHIFT_INBLOCKS` - only shift the factors inside the small dense diagonal blocks of the matrix, for example with `MATBAIJ`
1496: Level: intermediate
1498: .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `PCFactorSetShiftType()`
1499: S*/
1500: typedef enum {
1501: MAT_SHIFT_NONE,
1502: MAT_SHIFT_NONZERO,
1503: MAT_SHIFT_POSITIVE_DEFINITE,
1504: MAT_SHIFT_INBLOCKS
1505: } MatFactorShiftType;
1506: PETSC_EXTERN const char *const MatFactorShiftTypes[];
1507: PETSC_EXTERN const char *const MatFactorShiftTypesDetail[];
1509: /*S
1510: MatFactorError - indicates what type of error was generated in a matrix factorization
1512: Values:
1513: + `MAT_FACTOR_NOERROR` - there was no error during the factorization
1514: . `MAT_FACTOR_STRUCT_ZEROPIVOT` - there was a missing entry in a diagonal location of the matrix
1515: . `MAT_FACTOR_NUMERIC_ZEROPIVOT` - there was a (near) zero pivot during the factorization
1516: . `MAT_FACTOR_OUTMEMORY` - the factorization has run out of memory
1517: - `MAT_FACTOR_OTHER` - some other error has occurred.
1519: Level: intermediate
1521: Note:
1522: When a factorization is done in a preconditioner `PC` the error may be propagated up to a `PCFailedReason` or a `KSPConvergedReason`
1524: .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatFactorGetError()`, `MatFactorGetErrorZeroPivot()`, `MatFactorClearError()`,
1525: `PCFailedReason`, `PCGetFailedReason()`, `KSPConvergedReason`
1526: S*/
1527: typedef enum {
1528: MAT_FACTOR_NOERROR,
1529: MAT_FACTOR_STRUCT_ZEROPIVOT,
1530: MAT_FACTOR_NUMERIC_ZEROPIVOT,
1531: MAT_FACTOR_OUTMEMORY,
1532: MAT_FACTOR_OTHER
1533: } MatFactorError;
1535: PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat, MatFactorError *);
1536: PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat);
1537: PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat, PetscReal *, PetscInt *);
1539: /*S
1540: MatFactorInfo - Data passed into the matrix factorization routines, and information about the resulting factorization
1542: Level: developer
1544: Note:
1545: You can use `MatFactorInfoInitialize()` to set default values.
1547: Fortran Note:
1548: `MatFactorInfo` is a derived type, use e.g. `matfactorinfo%dt` to access its components.
1550: .seealso: [](ch_matrices), `Mat`, `MatInfo`, `MatGetFactor()`, `MatLUFactorSymbolic()`, `MatILUFactorSymbolic()`, `MatCholeskyFactorSymbolic()`,
1551: `MatICCFactorSymbolic()`, `MatICCFactor()`, `MatFactorInfoInitialize()`
1552: S*/
1553: typedef struct {
1554: PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */
1555: PetscReal usedt;
1556: PetscReal dt; /* drop tolerance */
1557: PetscReal dtcol; /* tolerance for pivoting */
1558: PetscReal dtcount; /* maximum nonzeros to be allowed per row */
1559: PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1560: PetscReal levels; /* ICC/ILU(levels) */
1561: PetscReal pivotinblocks; /* BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 factorization may be faster if do not pivot */
1562: PetscReal zeropivot; /* pivot is called zero if less than this */
1563: PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */
1564: PetscReal shiftamount; /* how large the shift is */
1565: PetscBool factoronhost; /* do factorization on host instead of device (for device matrix types) */
1566: PetscBool solveonhost; /* do mat solve on host with the factor (for device matrix types) */
1567: } MatFactorInfo;
1569: PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo *);
1570: PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat, IS, const MatFactorInfo *);
1571: PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat, Mat, IS, const MatFactorInfo *);
1572: PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat, Mat, const MatFactorInfo *);
1573: PETSC_EXTERN PetscErrorCode MatLUFactor(Mat, IS, IS, const MatFactorInfo *);
1574: PETSC_EXTERN PetscErrorCode MatILUFactor(Mat, IS, IS, const MatFactorInfo *);
1575: PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat, Mat, IS, IS, const MatFactorInfo *);
1576: PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat, Mat, IS, IS, const MatFactorInfo *);
1577: PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat, Mat, IS, const MatFactorInfo *);
1578: PETSC_EXTERN PetscErrorCode MatICCFactor(Mat, IS, const MatFactorInfo *);
1579: PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat, Mat, const MatFactorInfo *);
1580: PETSC_EXTERN PetscErrorCode MatQRFactor(Mat, IS, const MatFactorInfo *);
1581: PETSC_EXTERN PetscErrorCode MatQRFactorSymbolic(Mat, Mat, IS, const MatFactorInfo *);
1582: PETSC_EXTERN PetscErrorCode MatQRFactorNumeric(Mat, Mat, const MatFactorInfo *);
1583: PETSC_EXTERN PetscErrorCode MatGetInertia(Mat, PetscInt *, PetscInt *, PetscInt *);
1584: PETSC_EXTERN PetscErrorCode MatSolve(Mat, Vec, Vec);
1585: PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat, Vec, Vec);
1586: PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat, Vec, Vec);
1587: PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat, Vec, Vec, Vec);
1588: PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat, Vec, Vec);
1589: PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat, Vec, Vec, Vec);
1590: PETSC_EXTERN PetscErrorCode MatSolves(Mat, Vecs, Vecs);
1591: PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat);
1593: typedef enum {
1594: MAT_FACTOR_SCHUR_UNFACTORED,
1595: MAT_FACTOR_SCHUR_FACTORED,
1596: MAT_FACTOR_SCHUR_INVERTED
1597: } MatFactorSchurStatus;
1598: PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat, IS);
1599: PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat, Mat *, MatFactorSchurStatus *);
1600: PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat, Mat *, MatFactorSchurStatus);
1601: PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat);
1602: PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat, Mat *, MatFactorSchurStatus *);
1603: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat, Vec, Vec);
1604: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat, Vec, Vec);
1605: PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat);
1607: PETSC_EXTERN PetscErrorCode MatSeqDenseInvert(Mat);
1608: /*E
1609: MatSORType - What type of (S)SOR to perform
1611: Values:
1612: + `SOR_FORWARD_SWEEP` - do a sweep from the first row of the matrix to the last
1613: . `SOR_BACKWARD_SWEEP` - do a sweep from the last row to the first
1614: . `SOR_SYMMETRIC_SWEEP` - do a sweep from the first row to the last and then back to the first
1615: . `SOR_LOCAL_FORWARD_SWEEP` - each MPI process does its own forward sweep with no communication
1616: . `SOR_LOCAL_BACKWARD_SWEEP` - each MPI process does its own backward sweep with no communication
1617: . `SOR_LOCAL_SYMMETRIC_SWEEP` - each MPI process does its own symmetric sweep with no communication
1618: . `SOR_ZERO_INITIAL_GUESS` - indicates the initial solution is zero so the sweep can avoid unneeded computation
1619: . `SOR_EISENSTAT` - apply the Eisentat application of SOR, see `PCEISENSTAT`
1620: . `SOR_APPLY_UPPER` - multiply by the upper triangular portion of the matrix
1621: - `SOR_APPLY_LOWER` - multiply by the lower triangular portion of the matrix
1623: Level: beginner
1625: Note:
1626: These may be bitwise ORd together
1628: Developer Note:
1629: Since `MatSORType` may be bitwise ORd together, so do not change the numerical values below
1631: .seealso: [](ch_matrices), `MatSOR()`
1632: E*/
1633: typedef enum {
1634: SOR_FORWARD_SWEEP = 1,
1635: SOR_BACKWARD_SWEEP = 2,
1636: SOR_SYMMETRIC_SWEEP = 3,
1637: SOR_LOCAL_FORWARD_SWEEP = 4,
1638: SOR_LOCAL_BACKWARD_SWEEP = 8,
1639: SOR_LOCAL_SYMMETRIC_SWEEP = 12,
1640: SOR_ZERO_INITIAL_GUESS = 16,
1641: SOR_EISENSTAT = 32,
1642: SOR_APPLY_UPPER = 64,
1643: SOR_APPLY_LOWER = 128
1644: } MatSORType;
1645: PETSC_EXTERN PetscErrorCode MatSOR(Mat, Vec, PetscReal, MatSORType, PetscReal, PetscInt, PetscInt, Vec);
1647: /*S
1648: MatColoring - Object for managing the coloring of matrices.
1650: Level: beginner
1652: Notes:
1653: Coloring of matrices can be computed directly from the sparse matrix nonzero structure via the `MatColoring` object or from the mesh from which the
1654: matrix comes from via `DMCreateColoring()`. In general using the mesh produces a more optimal coloring (fewer colors).
1656: Once a coloring is available `MatFDColoringCreate()` creates an object that can be used to efficiently compute Jacobians using that coloring. This
1657: same object can also be used to efficiently convert data created by Automatic Differentiation tools to PETSc sparse matrices.
1659: .seealso: [](ch_matrices), [](sec_graph), `MatFDColoringCreate()`, `MatColoringWeightType`, `ISColoring`, `MatFDColoring`, `DMCreateColoring()`, `MatColoringCreate()`,
1660: `MatPartitioning`, `MatColoringType`, `MatPartitioningType`, `MatOrderingType`, `MatColoringSetWeightType()`,
1661: `MatColoringSetWeights()`, `MatCoarsenType`, `MatCoarsen`
1662: S*/
1663: typedef struct _p_MatColoring *MatColoring;
1665: /*J
1666: MatColoringType - String with the name of a PETSc matrix coloring
1668: Level: beginner
1670: .seealso: [](ch_matrices), [](sec_graph), `Mat`, `MatFDColoringCreate()`, `MatColoringSetType()`, `MatColoring`
1671: J*/
1672: typedef const char *MatColoringType;
1673: #define MATCOLORINGJP "jp"
1674: #define MATCOLORINGPOWER "power"
1675: #define MATCOLORINGNATURAL "natural"
1676: #define MATCOLORINGSL "sl"
1677: #define MATCOLORINGLF "lf"
1678: #define MATCOLORINGID "id"
1679: #define MATCOLORINGGREEDY "greedy"
1681: /*E
1682: MatColoringWeightType - Type of weight scheme used for the coloring algorithm
1684: Values:
1685: + `MAT_COLORING_RANDOM` - Random weights
1686: . `MAT_COLORING_LEXICAL` - Lexical weighting based upon global numbering.
1687: - `MAT_COLORING_LF` - Last-first weighting.
1689: Level: intermediate
1691: .seealso: [](ch_matrices), `MatColoring`, `MatColoringCreate()`, `MatColoringSetWeightType()`, `MatColoringSetWeights()`
1692: E*/
1693: typedef enum {
1694: MAT_COLORING_WEIGHT_RANDOM,
1695: MAT_COLORING_WEIGHT_LEXICAL,
1696: MAT_COLORING_WEIGHT_LF,
1697: MAT_COLORING_WEIGHT_SL
1698: } MatColoringWeightType;
1700: PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat, MatColoring *);
1701: PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat, PetscInt, PetscInt *);
1702: PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring *);
1703: PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring, PetscViewer);
1704: PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring, MatColoringType);
1705: PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring);
1706: PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring, PetscInt);
1707: PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring, PetscInt *);
1708: PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring, PetscInt);
1709: PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring, PetscInt *);
1710: PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring, ISColoring *);
1711: PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[], PetscErrorCode (*)(MatColoring));
1712: PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat, PetscInt, PetscInt, ISColoringValue[], ISColoring *);
1713: PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring, MatColoringWeightType);
1714: PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring, PetscReal *, PetscInt *);
1715: PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring, PetscReal **, PetscInt **lperm);
1716: PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring, ISColoring);
1717: PETSC_DEPRECATED_FUNCTION(3, 10, 0, "MatColoringTest()", ) static inline PetscErrorCode MatColoringTestValid(MatColoring matcoloring, ISColoring iscoloring)
1718: {
1719: return MatColoringTest(matcoloring, iscoloring);
1720: }
1721: PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat, ISColoring);
1723: /*S
1724: MatFDColoring - Object for computing a sparse Jacobian via finite differences with coloring
1726: Level: beginner
1728: Options Database Key:
1729: . -snes_fd_coloring - cause the Jacobian needed by `SNES` to be computed via a use of this object
1731: Note:
1732: This object is created utilizing a coloring provided by the `MatColoring` object or `DMCreateColoring()`
1734: .seealso: [](ch_matrices), `Mat`, `MatFDColoringCreate()`, `MatFDColoringSetFunction()`, `MatColoring`, `DMCreateColoring()`
1735: S*/
1736: typedef struct _p_MatFDColoring *MatFDColoring;
1738: /*S
1739: MatFDColoringFn - Function provided to `MatFDColoringSetFunction()` that computes the function being differenced
1741: Level: advanced
1743: Calling Sequence:
1744: + snes - either a `SNES` object if used within `SNES` otherwise an unused parameter
1745: . in - the location where the Jacobian is to be computed
1746: . out - the location to put the computed function value
1747: - fctx - the function context passed into `MatFDColoringSetFunction()`
1749: .seealso: [](ch_matrices), `Mat`, `MatCreateMFFD()`, `MatMFFDSetFunction()`, `MatMFFDiFn`, `MatMFFDiBaseFn`
1750: S*/
1751: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode MatFDColoringFn(void *snes, Vec x, Vec y, void *fctx);
1753: PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat, ISColoring, MatFDColoring *);
1754: PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring *);
1755: PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring, PetscViewer);
1756: PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring, MatFDColoringFn *, void *);
1757: PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring, MatFDColoringFn **, void **);
1758: PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring, PetscReal, PetscReal);
1759: PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
1760: PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat, MatFDColoring, Vec, void *);
1761: PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring, Vec);
1762: PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring, PetscInt *, const PetscInt *[]);
1763: PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat, ISColoring, MatFDColoring);
1764: PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring, PetscInt, PetscInt);
1765: PETSC_EXTERN PetscErrorCode MatFDColoringSetValues(Mat, MatFDColoring, const PetscScalar *);
1767: /*S
1768: MatTransposeColoring - Object for computing a sparse matrix product $C = A*B^T$ via coloring
1770: Level: developer
1772: .seealso: [](ch_matrices), `Mat`, `MatProductType`, `MatTransposeColoringCreate()`
1773: S*/
1774: typedef struct _p_MatTransposeColoring *MatTransposeColoring;
1776: PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat, ISColoring, MatTransposeColoring *);
1777: PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring, Mat, Mat);
1778: PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring, Mat, Mat);
1779: PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring *);
1781: /*S
1782: MatPartitioning - Object for managing the partitioning of a matrix or graph
1784: Level: beginner
1786: Note:
1787: There is also a `PetscPartitioner` object that provides the same functionality. It can utilize the `MatPartitioning` operations
1788: via `PetscPartitionerSetType`(p,`PETSCPARTITIONERMATPARTITIONING`)
1790: Developer Note:
1791: It is an extra maintenance and documentation cost to have two objects with the same functionality. `PetscPartitioner` should be removed
1793: .seealso: [](ch_matrices), [](sec_graph), `Mat`, `MatPartitioningCreate()`, `MatPartitioningType`, `MatColoring`, `MatGetOrdering()`, `MatOrderingType`,
1794: `MatCoarsenType`
1795: S*/
1796: typedef struct _p_MatPartitioning *MatPartitioning;
1798: /*J
1799: MatPartitioningType - String with the name of a PETSc matrix partitioning
1801: Level: beginner
1802: dm
1803: .seealso: [](ch_matrices), [](sec_graph), `Mat`, `MatPartitioningCreate()`, `MatPartitioning`, `MatPartitioningSetType()`, `MatColoringType`, `MatOrderingType`,
1804: `MatCoarsenType`
1805: J*/
1806: typedef const char *MatPartitioningType;
1807: #define MATPARTITIONINGCURRENT "current"
1808: #define MATPARTITIONINGAVERAGE "average"
1809: #define MATPARTITIONINGSQUARE "square"
1810: #define MATPARTITIONINGPARMETIS "parmetis"
1811: #define MATPARTITIONINGCHACO "chaco"
1812: #define MATPARTITIONINGPARTY "party"
1813: #define MATPARTITIONINGPTSCOTCH "ptscotch"
1814: #define MATPARTITIONINGHIERARCH "hierarch"
1816: PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm, MatPartitioning *);
1817: PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning, MatPartitioningType);
1818: PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning, PetscInt);
1819: PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning, Mat);
1820: PETSC_EXTERN PetscErrorCode MatPartitioningSetNumberVertexWeights(MatPartitioning, PetscInt);
1821: PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning, const PetscInt[]);
1822: PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning, const PetscReal[]);
1823: PETSC_EXTERN PetscErrorCode MatPartitioningSetUseEdgeWeights(MatPartitioning, PetscBool);
1824: PETSC_EXTERN PetscErrorCode MatPartitioningGetUseEdgeWeights(MatPartitioning, PetscBool *);
1825: PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning, IS *);
1826: PETSC_EXTERN PetscErrorCode MatPartitioningImprove(MatPartitioning, IS *);
1827: PETSC_EXTERN PetscErrorCode MatPartitioningViewImbalance(MatPartitioning, IS);
1828: PETSC_EXTERN PetscErrorCode MatPartitioningApplyND(MatPartitioning, IS *);
1829: PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning *);
1830: PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[], PetscErrorCode (*)(MatPartitioning));
1831: PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning, PetscViewer);
1832: PETSC_EXTERN PetscErrorCode MatPartitioningViewFromOptions(MatPartitioning, PetscObject, const char[]);
1833: PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
1834: PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning, MatPartitioningType *);
1836: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning);
1837: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1838: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);
1840: typedef enum {
1841: MP_CHACO_MULTILEVEL = 1,
1842: MP_CHACO_SPECTRAL = 2,
1843: MP_CHACO_LINEAR = 4,
1844: MP_CHACO_RANDOM = 5,
1845: MP_CHACO_SCATTERED = 6
1846: } MPChacoGlobalType;
1847: PETSC_EXTERN const char *const MPChacoGlobalTypes[];
1848: typedef enum {
1849: MP_CHACO_KERNIGHAN = 1,
1850: MP_CHACO_NONE = 2
1851: } MPChacoLocalType;
1852: PETSC_EXTERN const char *const MPChacoLocalTypes[];
1853: typedef enum {
1854: MP_CHACO_LANCZOS = 0,
1855: MP_CHACO_RQI = 1
1856: } MPChacoEigenType;
1857: PETSC_EXTERN const char *const MPChacoEigenTypes[];
1859: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
1860: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning, MPChacoGlobalType *);
1861: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1862: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning, MPChacoLocalType *);
1863: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning, PetscReal);
1864: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning, MPChacoEigenType);
1865: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning, MPChacoEigenType *);
1866: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1867: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning, PetscReal *);
1868: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
1869: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning, PetscInt *);
1871: #define MP_PARTY_OPT "opt"
1872: #define MP_PARTY_LIN "lin"
1873: #define MP_PARTY_SCA "sca"
1874: #define MP_PARTY_RAN "ran"
1875: #define MP_PARTY_GBF "gbf"
1876: #define MP_PARTY_GCF "gcf"
1877: #define MP_PARTY_BUB "bub"
1878: #define MP_PARTY_DEF "def"
1879: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning, const char *);
1880: #define MP_PARTY_HELPFUL_SETS "hs"
1881: #define MP_PARTY_KERNIGHAN_LIN "kl"
1882: #define MP_PARTY_NONE "no"
1883: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning, const char *);
1884: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning, PetscReal);
1885: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning, PetscBool);
1886: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning, PetscBool);
1888: typedef enum {
1889: MP_PTSCOTCH_DEFAULT,
1890: MP_PTSCOTCH_QUALITY,
1891: MP_PTSCOTCH_SPEED,
1892: MP_PTSCOTCH_BALANCE,
1893: MP_PTSCOTCH_SAFETY,
1894: MP_PTSCOTCH_SCALABILITY
1895: } MPPTScotchStrategyType;
1896: PETSC_EXTERN const char *const MPPTScotchStrategyTypes[];
1898: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning, PetscReal);
1899: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning, PetscReal *);
1900: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning, MPPTScotchStrategyType);
1901: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning, MPPTScotchStrategyType *);
1903: /*
1904: * hierarchical partitioning
1905: */
1906: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning, IS *);
1907: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning, IS *);
1908: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning, PetscInt);
1909: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt);
1911: PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat, PetscInt, Mat *);
1913: /*
1914: If any of the enum values are changed, also update dMatOps dict at src/binding/petsc4py/src/petsc4py/PETSc/libpetsc4py.pyx
1915: */
1916: typedef enum {
1917: MATOP_SET_VALUES = 0,
1918: MATOP_GET_ROW = 1,
1919: MATOP_RESTORE_ROW = 2,
1920: MATOP_MULT = 3,
1921: MATOP_MULT_ADD = 4,
1922: MATOP_MULT_TRANSPOSE = 5,
1923: MATOP_MULT_TRANSPOSE_ADD = 6,
1924: MATOP_SOLVE = 7,
1925: MATOP_SOLVE_ADD = 8,
1926: MATOP_SOLVE_TRANSPOSE = 9,
1927: MATOP_SOLVE_TRANSPOSE_ADD = 10,
1928: MATOP_LUFACTOR = 11,
1929: MATOP_CHOLESKYFACTOR = 12,
1930: MATOP_SOR = 13,
1931: MATOP_TRANSPOSE = 14,
1932: MATOP_GETINFO = 15,
1933: MATOP_EQUAL = 16,
1934: MATOP_GET_DIAGONAL = 17,
1935: MATOP_DIAGONAL_SCALE = 18,
1936: MATOP_NORM = 19,
1937: MATOP_ASSEMBLY_BEGIN = 20,
1938: MATOP_ASSEMBLY_END = 21,
1939: MATOP_SET_OPTION = 22,
1940: MATOP_ZERO_ENTRIES = 23,
1941: MATOP_ZERO_ROWS = 24,
1942: MATOP_LUFACTOR_SYMBOLIC = 25,
1943: MATOP_LUFACTOR_NUMERIC = 26,
1944: MATOP_CHOLESKY_FACTOR_SYMBOLIC = 27,
1945: MATOP_CHOLESKY_FACTOR_NUMERIC = 28,
1946: MATOP_SETUP = 29,
1947: MATOP_ILUFACTOR_SYMBOLIC = 30,
1948: MATOP_ICCFACTOR_SYMBOLIC = 31,
1949: MATOP_GET_DIAGONAL_BLOCK = 32,
1950: MATOP_SET_INF = 33,
1951: MATOP_DUPLICATE = 34,
1952: MATOP_FORWARD_SOLVE = 35,
1953: MATOP_BACKWARD_SOLVE = 36,
1954: MATOP_ILUFACTOR = 37,
1955: MATOP_ICCFACTOR = 38,
1956: MATOP_AXPY = 39,
1957: MATOP_CREATE_SUBMATRICES = 40,
1958: MATOP_INCREASE_OVERLAP = 41,
1959: MATOP_GET_VALUES = 42,
1960: MATOP_COPY = 43,
1961: MATOP_GET_ROW_MAX = 44,
1962: MATOP_SCALE = 45,
1963: MATOP_SHIFT = 46,
1964: MATOP_DIAGONAL_SET = 47,
1965: MATOP_ZERO_ROWS_COLUMNS = 48,
1966: MATOP_SET_RANDOM = 49,
1967: MATOP_GET_ROW_IJ = 50,
1968: MATOP_RESTORE_ROW_IJ = 51,
1969: MATOP_GET_COLUMN_IJ = 52,
1970: MATOP_RESTORE_COLUMN_IJ = 53,
1971: MATOP_FDCOLORING_CREATE = 54,
1972: MATOP_COLORING_PATCH = 55,
1973: MATOP_SET_UNFACTORED = 56,
1974: MATOP_PERMUTE = 57,
1975: MATOP_SET_VALUES_BLOCKED = 58,
1976: MATOP_CREATE_SUBMATRIX = 59,
1977: MATOP_DESTROY = 60,
1978: MATOP_VIEW = 61,
1979: MATOP_CONVERT_FROM = 62,
1980: MATOP_MATMAT_MULT_SYMBOLIC = 63,
1981: MATOP_MATMAT_MULT_NUMERIC = 64,
1982: MATOP_SET_LOCAL_TO_GLOBAL_MAP = 65,
1983: MATOP_SET_VALUES_LOCAL = 66,
1984: MATOP_ZERO_ROWS_LOCAL = 67,
1985: MATOP_GET_ROW_MAX_ABS = 68,
1986: MATOP_GET_ROW_MIN_ABS = 69,
1987: MATOP_CONVERT = 70,
1988: MATOP_HAS_OPERATION = 71,
1989: MATOP_FD_COLORING_APPLY = 72,
1990: MATOP_SET_FROM_OPTIONS = 73,
1991: MATOP_FIND_ZERO_DIAGONALS = 74,
1992: MATOP_MULT_MULTIPLE = 75,
1993: MATOP_SOLVE_MULTIPLE = 76,
1994: MATOP_GET_INERTIA = 77,
1995: MATOP_LOAD = 78,
1996: MATOP_IS_SYMMETRIC = 79,
1997: MATOP_IS_HERMITIAN = 80,
1998: MATOP_IS_STRUCTURALLY_SYMMETRIC = 81,
1999: MATOP_SET_VALUES_BLOCKEDLOCAL = 82,
2000: MATOP_CREATE_VECS = 83,
2001: MATOP_MAT_MULT_SYMBOLIC = 84,
2002: MATOP_MAT_MULT_NUMERIC = 85,
2003: MATOP_PTAP_NUMERIC = 86,
2004: MATOP_MAT_TRANSPOSE_MULT_SYMBO = 87,
2005: MATOP_MAT_TRANSPOSE_MULT_NUMER = 88,
2006: MATOP_BIND_TO_CPU = 89,
2007: MATOP_PRODUCTSETFROMOPTIONS = 90,
2008: MATOP_PRODUCTSYMBOLIC = 91,
2009: MATOP_PRODUCTNUMERIC = 92,
2010: MATOP_CONJUGATE = 93,
2011: MATOP_VIEW_NATIVE = 94,
2012: MATOP_SET_VALUES_ROW = 95,
2013: MATOP_REAL_PART = 96,
2014: MATOP_IMAGINARY_PART = 97,
2015: MATOP_GET_ROW_UPPER_TRIANGULAR = 98,
2016: MATOP_RESTORE_ROW_UPPER_TRIANG = 99,
2017: MATOP_MAT_SOLVE = 100,
2018: MATOP_MAT_SOLVE_TRANSPOSE = 101,
2019: MATOP_GET_ROW_MIN = 102,
2020: MATOP_GET_COLUMN_VECTOR = 103,
2021: MATOP_GET_SEQ_NONZERO_STRUCTUR = 104,
2022: MATOP_CREATE = 105,
2023: MATOP_GET_GHOSTS = 106,
2024: MATOP_GET_LOCAL_SUB_MATRIX = 107,
2025: MATOP_RESTORE_LOCALSUB_MATRIX = 108,
2026: MATOP_MULT_DIAGONAL_BLOCK = 109,
2027: MATOP_HERMITIAN_TRANSPOSE = 110,
2028: MATOP_MULT_HERMITIAN_TRANSPOSE = 111,
2029: MATOP_MULT_HERMITIAN_TRANS_ADD = 112,
2030: MATOP_GET_MULTI_PROC_BLOCK = 113,
2031: MATOP_FIND_NONZERO_ROWS = 114,
2032: MATOP_GET_COLUMN_NORMS = 115,
2033: MATOP_INVERT_BLOCK_DIAGONAL = 116,
2034: MATOP_INVERT_VBLOCK_DIAGONAL = 117,
2035: MATOP_CREATE_SUB_MATRICES_MPI = 118,
2036: MATOP_SET_VALUES_BATCH = 119,
2037: MATOP_TRANSPOSE_MAT_MULT_SYMBO = 120,
2038: MATOP_TRANSPOSE_MAT_MULT_NUMER = 121,
2039: MATOP_TRANSPOSE_COLORING_CREAT = 122,
2040: MATOP_TRANS_COLORING_APPLY_SPT = 123,
2041: MATOP_TRANS_COLORING_APPLY_DEN = 124,
2042: MATOP_RART_NUMERIC = 125,
2043: MATOP_SET_BLOCK_SIZES = 126,
2044: MATOP_RESIDUAL = 127,
2045: MATOP_FDCOLORING_SETUP = 128,
2046: MATOP_FIND_OFFBLOCK_ENTRIES = 129,
2047: MATOP_MPICONCATENATESEQ = 130,
2048: MATOP_DESTROYSUBMATRICES = 131,
2049: MATOP_MAT_TRANSPOSE_SOLVE = 132,
2050: MATOP_GET_VALUES_LOCAL = 133,
2051: MATOP_CREATE_GRAPH = 134,
2052: MATOP_TRANSPOSE_SYMBOLIC = 135,
2053: MATOP_ELIMINATE_ZEROS = 136,
2054: MATOP_GET_ROW_SUM_ABS = 137,
2055: MATOP_GET_FACTOR = 138,
2056: MATOP_GET_BLOCK_DIAGONAL = 139, /* NOTE: caller of the two op functions owns the returned matrix */
2057: MATOP_GET_VBLOCK_DIAGONAL = 140, /* and need to destroy it after use. */
2058: MATOP_COPY_HASH_TO_XAIJ = 141,
2059: MATOP_GET_CURRENT_MEM_TYPE = 142,
2060: MATOP_ZERO_ROWS_COLUMNS_LOCAL = 143,
2061: MATOP_ADOT = 144,
2062: MATOP_ANORM = 145,
2063: MATOP_ADOT_LOCAL = 146,
2064: MATOP_ANORM_LOCAL = 147
2065: } MatOperation;
2067: PETSC_EXTERN PetscErrorCode MatSetOperation(Mat, MatOperation, PetscErrorCodeFn *);
2068: PETSC_EXTERN PetscErrorCode MatGetOperation(Mat, MatOperation, PetscErrorCodeFn **);
2069: PETSC_EXTERN PetscErrorCode MatHasOperation(Mat, MatOperation, PetscBool *);
2070: PETSC_EXTERN PetscErrorCode MatHasCongruentLayouts(Mat, PetscBool *);
2071: PETSC_DEPRECATED_FUNCTION(3, 14, 0, "MatProductClear()", ) static inline PetscErrorCode MatFreeIntermediateDataStructures(Mat A)
2072: {
2073: return MatProductClear(A);
2074: }
2075: PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat, MatOperation, PetscErrorCodeFn *);
2076: PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat, MatOperation, PetscErrorCodeFn **);
2077: PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat, PetscCtx);
2078: PETSC_EXTERN PetscErrorCode MatShellSetContextDestroy(Mat, PetscCtxDestroyFn *);
2079: PETSC_EXTERN PetscErrorCode MatShellSetVecType(Mat, VecType);
2080: PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat, PetscErrorCode (*)(void *, Vec, Vec), Vec, void *, PetscBool *);
2081: PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat, PetscErrorCode (*)(void *, Vec, Vec), Vec, void *, PetscBool *);
2082: PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat);
2083: PETSC_EXTERN PetscErrorCode MatShellSetMatProductOperation(Mat, MatProductType, PetscErrorCode (*)(Mat, Mat, Mat, void **), PetscErrorCode (*)(Mat, Mat, Mat, void *), PetscCtxDestroyFn *, MatType, MatType);
2084: PETSC_EXTERN PetscErrorCode MatIsShell(Mat, PetscBool *);
2086: /*
2087: Codes for matrices stored on disk. By default they are
2088: stored in a universal format. By changing the format with
2089: PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
2090: be stored in a way natural for the matrix, for example dense matrices
2091: would be stored as dense. Matrices stored this way may only be
2092: read into matrices of the same type.
2093: */
2094: #define MATRIX_BINARY_FORMAT_DENSE -1
2096: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat, PetscReal);
2098: PETSC_EXTERN PetscErrorCode MatISSetLocalMatType(Mat, MatType);
2099: PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
2100: PETSC_EXTERN PetscErrorCode MatISSetAllowRepeated(Mat, PetscBool);
2101: PETSC_EXTERN PetscErrorCode MatISGetAllowRepeated(Mat, PetscBool *);
2102: PETSC_EXTERN PetscErrorCode MatISStoreL2L(Mat, PetscBool);
2103: PETSC_EXTERN PetscErrorCode MatISFixLocalEmpty(Mat, PetscBool);
2104: PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat, Mat *);
2105: PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat, Mat *);
2106: PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat, Mat);
2107: PETSC_EXTERN PetscErrorCode MatISGetLocalToGlobalMapping(Mat, ISLocalToGlobalMapping *, ISLocalToGlobalMapping *);
2109: /*S
2110: MatNullSpace - Object that removes a null space from a vector, i.e.
2111: orthogonalizes the vector to a subspace
2113: Level: advanced
2115: .seealso: [](ch_matrices), `Mat`, `MatNullSpaceCreate()`, `MatNullSpaceSetFunction()`, `MatGetNullSpace()`, `MatSetNullSpace()`
2116: S*/
2117: typedef struct _p_MatNullSpace *MatNullSpace;
2119: /*S
2120: MatNullSpaceRemoveFn - Function provided to `MatNullSpaceSetFunction()` that removes the null space from a vector
2122: Level: advanced
2124: Calling Sequence:
2125: + nsp - the `MatNullSpace` object
2126: . x - the vector from which to remove the null space
2127: - ctx - [optional] user-defined function context provided with `MatNullSpaceSetFunction()`
2129: .seealso: [](ch_matrices), `Mat`, `MatNullSpaceCreate()`, `MatNullSpaceSetFunction()`, `MatGetNullSpace()`, `MatSetNullSpace()`
2130: S*/
2131: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode MatNullSpaceRemoveFn(MatNullSpace nsp, Vec x, PetscCtx ctx);
2133: PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm, PetscBool, PetscInt, const Vec[], MatNullSpace *);
2134: PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace, MatNullSpaceRemoveFn *, void *);
2135: PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace *);
2136: PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace, Vec);
2137: PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *);
2138: PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *);
2139: PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat, MatNullSpace);
2140: PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat, MatNullSpace);
2141: PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat, MatNullSpace);
2142: PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat, MatNullSpace *);
2143: PETSC_EXTERN PetscErrorCode MatGetNullSpaces(PetscInt, Mat[], MatNullSpace *[]);
2144: PETSC_EXTERN PetscErrorCode MatRestoreNullSpaces(PetscInt, Mat[], MatNullSpace *[]);
2145: PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace, Mat, PetscBool *);
2146: PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace, PetscViewer);
2147: PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace, PetscBool *, PetscInt *, const Vec **);
2148: PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec, MatNullSpace *);
2150: PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat, IS);
2151: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat, PetscReal);
2152: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat, PetscInt *);
2154: PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat, PetscInt, Mat *);
2155: PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat, PetscInt, Mat *);
2156: PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat, Mat *);
2158: PETSC_EXTERN PetscErrorCode MatComputeOperator(Mat, MatType, Mat *);
2159: PETSC_EXTERN PetscErrorCode MatComputeOperatorTranspose(Mat, MatType, Mat *);
2161: PETSC_DEPRECATED_FUNCTION(3, 12, 0, "MatComputeOperator()", ) static inline PetscErrorCode MatComputeExplicitOperator(Mat A, Mat *B)
2162: {
2163: return MatComputeOperator(A, PETSC_NULLPTR, B);
2164: }
2165: PETSC_DEPRECATED_FUNCTION(3, 12, 0, "MatComputeOperatorTranspose()", ) static inline PetscErrorCode MatComputeExplicitOperatorTranspose(Mat A, Mat *B)
2166: {
2167: return MatComputeOperatorTranspose(A, PETSC_NULLPTR, B);
2168: }
2170: PETSC_EXTERN PetscErrorCode MatCreateKAIJ(Mat, PetscInt, PetscInt, const PetscScalar[], const PetscScalar[], Mat *);
2171: PETSC_EXTERN PetscErrorCode MatKAIJGetAIJ(Mat, Mat *);
2172: PETSC_EXTERN PetscErrorCode MatKAIJGetS(Mat, PetscInt *, PetscInt *, PetscScalar **);
2173: PETSC_EXTERN PetscErrorCode MatKAIJGetSRead(Mat, PetscInt *, PetscInt *, const PetscScalar **);
2174: PETSC_EXTERN PetscErrorCode MatKAIJRestoreS(Mat, PetscScalar **);
2175: PETSC_EXTERN PetscErrorCode MatKAIJRestoreSRead(Mat, const PetscScalar **);
2176: PETSC_EXTERN PetscErrorCode MatKAIJGetT(Mat, PetscInt *, PetscInt *, PetscScalar **);
2177: PETSC_EXTERN PetscErrorCode MatKAIJGetTRead(Mat, PetscInt *, PetscInt *, const PetscScalar **);
2178: PETSC_EXTERN PetscErrorCode MatKAIJRestoreT(Mat, PetscScalar **);
2179: PETSC_EXTERN PetscErrorCode MatKAIJRestoreTRead(Mat, const PetscScalar **);
2180: PETSC_EXTERN PetscErrorCode MatKAIJSetAIJ(Mat, Mat);
2181: PETSC_EXTERN PetscErrorCode MatKAIJSetS(Mat, PetscInt, PetscInt, const PetscScalar[]);
2182: PETSC_EXTERN PetscErrorCode MatKAIJSetT(Mat, PetscInt, PetscInt, const PetscScalar[]);
2183: PETSC_EXTERN PetscErrorCode MatKAIJGetScaledIdentity(Mat, PetscBool *);
2185: PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat, Vec);
2187: PETSC_EXTERN PetscErrorCode MatMFFDInitializePackage(void);
2188: PETSC_EXTERN PetscErrorCode MatMFFDFinalizePackage(void);
2190: /*S
2191: MatMFFDFn - Function provided to `MatMFFDSetFunction()` that computes the function being differenced
2193: Level: advanced
2195: Calling Sequence:
2196: + ctx - [optional] user-defined function context provided with `MatMFFDSetFunction()`
2197: . x - input vector
2198: - y - output vector
2200: .seealso: [](ch_matrices), `Mat`, `MatCreateMFFD()`, `MatMFFDSetFunction()`, `MatMFFDiFn`, `MatMFFDiBaseFn`
2201: S*/
2202: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode MatMFFDFn(PetscCtx ctx, Vec x, Vec y);
2204: /*S
2205: MatMFFDiFn - Function provided to `MatMFFDSetFunctioni()` that computes the function being differenced at a single point
2207: Level: advanced
2209: Calling Sequence:
2210: + ctx - [optional] user-defined function context provided with `MatMFFDSetFunction()`
2211: . i - the component of the vector to compute
2212: . x - input vector
2213: - result - the value of the function at that component (output)
2215: .seealso: [](ch_matrices), `Mat`, `MatCreateMFFD()`, `MatMFFDSetFunction()`, `MatMFFDFn`, `MatMFFDiBaseFn`
2216: S*/
2217: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode MatMFFDiFn(PetscCtx ctx, PetscInt i, Vec x, PetscScalar *result);
2219: /*S
2220: MatMFFDiBaseFn - Function provided to `MatMFFDSetFunctioniBase()` that computes the base of the function evaluations
2221: that will be used for differencing
2223: Level: advanced
2225: Calling Sequence:
2226: + ctx - [optional] user-defined function context provided with `MatMFFDSetFunction()`
2227: - x - input base vector
2229: .seealso: [](ch_matrices), `Mat`, `MatCreateMFFD()`, `MatMFFDSetFunction()`, `MatMFFDSetFunctioniBase()`, `MatMFFDFn`, `MatMFFDiFn`
2230: S*/
2231: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode MatMFFDiBaseFn(PetscCtx ctx, Vec x);
2233: /*S
2234: MatMFFDCheckhFn - Function provided to `MatMFFDSetCheckh()` that checks and possibly adjusts the value of `h` to ensure some property.
2235: that will be used for differencing
2237: Level: advanced
2239: Calling Sequence:
2240: + ctx - [optional] user-defined function context provided with `MatMFFDSetCheckh()`
2241: . x - input base vector
2242: . y - input step vector that the product is computed with
2243: - h - input tentative step, output possibly adjusted step
2245: Note:
2246: `MatMFFDCheckPositivity()` is one such function
2248: .seealso: [](ch_matrices), `Mat`, `MatCreateMFFD()`, `MatMFFDSetCheckh()`, `MatMFFDCheckPositivity()`
2249: S*/
2250: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode MatMFFDCheckhFn(PetscCtx ctx, Vec x, Vec y, PetscScalar *h);
2252: PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, Mat *);
2253: PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat, Vec, Vec);
2254: PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat, MatMFFDFn *, void *);
2255: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat, MatMFFDiFn *);
2256: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat, MatMFFDiBaseFn *);
2257: PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat, PetscScalar[], PetscInt);
2258: PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
2259: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat, PetscReal);
2260: PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat, PetscInt);
2261: PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat, PetscScalar *);
2262: PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat, const char[]);
2263: PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void *, Vec, Vec, PetscScalar *);
2264: PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat, MatMFFDCheckhFn *, void *);
2266: /*S
2267: MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free
2268: Jacobian vector products
2270: Level: developer
2272: Notes:
2273: `MATMFFD` is a specific `MatType` which uses the `MatMFFD` data structure
2275: MatMFFD*() methods actually take the `Mat` as their first argument. Not a `MatMFFD` data structure
2277: This functionality is often obtained using `MatCreateSNESMF()` or with `SNES` solvers using `-snes_mf` or `-snes_mf_operator`
2279: .seealso: [](ch_matrices), `MatMFFDType`, `MATMFFD`, `MatCreateMFFD()`, `MatMFFDSetFuction()`, `MatMFFDSetType()`, `MatMFFDRegister()`,
2280: `MatCreateSNESMF()`, `SNES`, `-snes_mf`, `-snes_mf_operator`
2281: S*/
2282: typedef struct _p_MatMFFD *MatMFFD;
2284: /*J
2285: MatMFFDType - algorithm used to compute the `h` used in computing matrix-vector products via differencing of a function
2287: Values:
2288: + `MATMFFD_DS` - an algorithm described by Dennis and Schnabel {cite}`dennis:83`
2289: - `MATMFFD_WP` - the Walker-Pernice {cite}`pw98` strategy.
2291: Level: beginner
2293: .seealso: [](ch_matrices), `MatMFFDSetType()`, `MatMFFDRegister()`, `MatMFFDSetFunction()`, `MatCreateMFFD()`
2294: J*/
2295: typedef const char *MatMFFDType;
2296: #define MATMFFD_DS "ds"
2297: #define MATMFFD_WP "wp"
2299: PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat, MatMFFDType);
2300: PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[], PetscErrorCode (*)(MatMFFD));
2302: PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat, PetscReal);
2303: PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat, PetscBool);
2305: PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring, MatMFFDType);
2307: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
2308: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
2310: #ifdef PETSC_HAVE_H2OPUS
2311: PETSC_EXTERN_TYPEDEF typedef PetscScalar(MatH2OpusKernelFn)(PetscInt, PetscReal[], PetscReal[], void *);
2312: PETSC_EXTERN_TYPEDEF typedef MatH2OpusKernelFn *MatH2OpusKernel;
2314: PETSC_EXTERN PetscErrorCode MatCreateH2OpusFromKernel(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscReal[], PetscBool, MatH2OpusKernelFn *, void *, PetscReal, PetscInt, PetscInt, Mat *);
2315: PETSC_EXTERN PetscErrorCode MatCreateH2OpusFromMat(Mat, PetscInt, const PetscReal[], PetscBool, PetscReal, PetscInt, PetscInt, PetscInt, PetscReal, Mat *);
2316: PETSC_EXTERN PetscErrorCode MatH2OpusSetSamplingMat(Mat, Mat, PetscInt, PetscReal);
2317: PETSC_EXTERN PetscErrorCode MatH2OpusOrthogonalize(Mat);
2318: PETSC_EXTERN PetscErrorCode MatH2OpusCompress(Mat, PetscReal);
2319: PETSC_EXTERN PetscErrorCode MatH2OpusSetNativeMult(Mat, PetscBool);
2320: PETSC_EXTERN PetscErrorCode MatH2OpusGetNativeMult(Mat, PetscBool *);
2321: PETSC_EXTERN PetscErrorCode MatH2OpusGetIndexMap(Mat, IS *);
2322: PETSC_EXTERN PetscErrorCode MatH2OpusMapVec(Mat, PetscBool, Vec, Vec *);
2323: PETSC_EXTERN PetscErrorCode MatH2OpusLowRankUpdate(Mat, Mat, Mat, PetscScalar);
2324: #endif
2326: #ifdef PETSC_HAVE_HTOOL
2327: /*S
2328: MatHtoolKernelFn - Function type for the user-supplied kernel callback used by `MATHTOOL` (`MatCreateHtoolFromKernel()`, `MatHtoolSetKernel()`) to evaluate the dense matrix entries on demand
2330: Synopsis:
2331: #include <petscmat.h>
2332: PetscErrorCode MatHtoolKernelFn(PetscInt sdim, PetscInt M, PetscInt N, const PetscInt *J, const PetscInt *K, PetscScalar *ptr, void *ctx)
2334: Calling Sequence:
2335: + sdim - the spatial dimension of the source/target geometries
2336: . M - the number of target points
2337: . N - the number of source points
2338: . J - array of `M` target point indices into the user's target coordinate array
2339: . K - array of `N` source point indices into the user's source coordinate array
2340: . ptr - column-major output buffer of length `M*N` to fill with kernel values
2341: - ctx - the optional user context passed at registration
2343: Level: intermediate
2345: .seealso: `Mat`, `MATHTOOL`, `MatCreateHtoolFromKernel()`, `MatHtoolSetKernel()`
2346: S*/
2347: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode MatHtoolKernelFn(PetscInt, PetscInt, PetscInt, const PetscInt *, const PetscInt *, PetscScalar *, void *);
2348: PETSC_EXTERN_TYPEDEF typedef MatHtoolKernelFn *MatHtoolKernel;
2350: PETSC_EXTERN PetscErrorCode MatCreateHtoolFromKernel(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscReal[], const PetscReal[], MatHtoolKernelFn *, void *, Mat *);
2351: PETSC_EXTERN PetscErrorCode MatHtoolSetKernel(Mat, MatHtoolKernelFn *, void *);
2352: PETSC_EXTERN PetscErrorCode MatHtoolGetPermutationSource(Mat, IS *);
2353: PETSC_EXTERN PetscErrorCode MatHtoolGetPermutationTarget(Mat, IS *);
2354: PETSC_EXTERN PetscErrorCode MatHtoolUsePermutation(Mat, PetscBool);
2355: PETSC_EXTERN PetscErrorCode MatHtoolUseRecompression(Mat, PetscBool);
2357: /*E
2358: MatHtoolCompressorType - Indicates the type of compressor used by a `MATHTOOL`
2360: Values:
2361: + `MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA` (default) - symmetric partial adaptive cross approximation
2362: . `MAT_HTOOL_COMPRESSOR_FULL_ACA` - full adaptive cross approximation
2363: - `MAT_HTOOL_COMPRESSOR_SVD` - singular value decomposition
2365: Level: intermediate
2367: .seealso: [](ch_matrices), `Mat`, `MatCreateHtoolFromKernel()`, `MATHTOOL`, `MatHtoolClusteringType`
2368: E*/
2369: typedef enum {
2370: MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA,
2371: MAT_HTOOL_COMPRESSOR_FULL_ACA,
2372: MAT_HTOOL_COMPRESSOR_SVD
2373: } MatHtoolCompressorType;
2375: /*E
2376: MatHtoolClusteringType - Indicates the type of clustering used by a `MATHTOOL`
2378: Values:
2379: + `MAT_HTOOL_CLUSTERING_PCA_REGULAR` (default) - axis computed via principle component analysis, split uniformly
2380: . `MAT_HTOOL_CLUSTERING_PCA_GEOMETRIC` - axis computed via principle component analysis, split barycentrically
2381: . `MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_REGULAR` - axis along the largest extent of the bounding box, split uniformly
2382: - `MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_GEOMETRIC` - axis along the largest extent of the bounding box, split barycentrically
2384: Level: intermediate
2386: Note:
2387: Higher-dimensional clustering is not yet supported in Htool, but once it is, one should add BOUNDING_BOX_{2,3} types
2389: .seealso: [](ch_matrices), `Mat`, `MatCreateHtoolFromKernel()`, `MATHTOOL`, `MatHtoolCompressorType`
2390: E*/
2391: typedef enum {
2392: MAT_HTOOL_CLUSTERING_PCA_REGULAR,
2393: MAT_HTOOL_CLUSTERING_PCA_GEOMETRIC,
2394: MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_REGULAR,
2395: MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_GEOMETRIC
2396: } MatHtoolClusteringType;
2397: #endif
2399: PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat, PetscInt, PetscInt);
2400: PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat, PetscInt, PetscInt *);
2401: PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat, PetscInt, PetscReal);
2402: PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat, PetscInt, PetscReal *);
2404: PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat, PetscInt, PetscInt *);
2405: PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat, PetscInt, PetscInt *);
2406: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat, PetscInt, PetscReal *);
2407: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat, PetscInt, PetscReal *);
2408: PETSC_EXTERN PetscErrorCode MatMumpsGetNullPivots(Mat, PetscInt *, PetscInt **);
2409: PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat, Mat);
2410: PETSC_EXTERN PetscErrorCode MatMumpsGetInverseTranspose(Mat, Mat);
2411: PETSC_EXTERN PetscErrorCode MatMumpsSetBlk(Mat, PetscInt, const PetscInt[], const PetscInt[]);
2413: PETSC_EXTERN PetscErrorCode MatMumpsSetOocTmpDir(Mat, const char *);
2414: PETSC_EXTERN PetscErrorCode MatMumpsGetOocTmpDir(Mat, const char **);
2416: #ifdef PETSC_HAVE_MKL_PARDISO
2417: PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat, PetscInt, PetscInt);
2418: #endif
2420: #ifdef PETSC_HAVE_MKL_CPARDISO
2421: PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat, PetscInt, PetscInt);
2422: #endif
2424: #ifdef PETSC_HAVE_SUPERLU
2425: PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat, PetscReal);
2426: #endif
2428: #ifdef PETSC_HAVE_SUPERLU_DIST
2429: PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat, PetscScalar *);
2430: #endif
2432: #ifdef PETSC_HAVE_STRUMPACK
2433: /*E
2434: MatSTRUMPACKReordering - sparsity reducing ordering to be used in `MATSOLVERSTRUMPACK`
2436: Values:
2437: + `MAT_STRUMPACK_NATURAL` - use the current ordering
2438: . `MAT_STRUMPACK_METIS` - use MeTis to compute an ordering
2439: . `MAT_STRUMPACK_PARMETIS` - use ParMeTis to compute an ordering
2440: . `MAT_STRUMPACK_SCOTCH` - use Scotch to compute an ordering
2441: . `MAT_STRUMPACK_PTSCOTCH` - use parallel Scotch to compute an ordering
2442: . `MAT_STRUMPACK_RCM` - use an RCM ordering
2443: . `MAT_STRUMPACK_GEOMETRIC` - use a geometric ordering (needs mesh info from user)
2444: . `MAT_STRUMPACK_AMD` - approximate minimum degree
2445: . `MAT_STRUMPACK_MMD` - multiple minimum degree
2446: . `MAT_STRUMPACK_AND` - approximate nested dissection
2447: . `MAT_STRUMPACK_MLF` - minimum local fill
2448: - `MAT_STRUMPACK_SPECTRAL` - spectral nested dissection
2450: Level: intermediate
2452: Developer Note:
2453: Should be called `MatSTRUMPACKReorderingType`
2455: .seealso: `Mat`, `MATSOLVERSTRUMPACK`, `MatGetFactor()`, `MatSTRUMPACKSetReordering()`
2456: E*/
2457: typedef enum {
2458: MAT_STRUMPACK_NATURAL,
2459: MAT_STRUMPACK_METIS,
2460: MAT_STRUMPACK_PARMETIS,
2461: MAT_STRUMPACK_SCOTCH,
2462: MAT_STRUMPACK_PTSCOTCH,
2463: MAT_STRUMPACK_RCM,
2464: MAT_STRUMPACK_GEOMETRIC,
2465: MAT_STRUMPACK_AMD,
2466: MAT_STRUMPACK_MMD,
2467: MAT_STRUMPACK_AND,
2468: MAT_STRUMPACK_MLF,
2469: MAT_STRUMPACK_SPECTRAL
2470: } MatSTRUMPACKReordering;
2472: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat, MatSTRUMPACKReordering);
2473: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetReordering(Mat, MatSTRUMPACKReordering *);
2474: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetGeometricNxyz(Mat, PetscInt, PetscInt, PetscInt);
2475: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetGeometricComponents(Mat, PetscInt);
2476: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetGeometricWidth(Mat, PetscInt);
2477: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat, PetscBool);
2478: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetColPerm(Mat, PetscBool *);
2479: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetGPU(Mat, PetscBool);
2480: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetGPU(Mat, PetscBool *);
2482: /*E
2483: MatSTRUMPACKCompressionType - Compression used in the approximate sparse factorization solver `MATSOLVERSTRUMPACK`
2485: Values:
2486: + `MAT_STRUMPACK_COMPRESSION_TYPE_NONE` - no compression, direct solver
2487: . `MAT_STRUMPACK_COMPRESSION_TYPE_HSS` - hierarchically semi-separable
2488: . `MAT_STRUMPACK_COMPRESSION_TYPE_BLR` - block low rank
2489: . `MAT_STRUMPACK_COMPRESSION_TYPE_HODLR` - hierarchically off-diagonal low rank (requires ButterfyPACK support, configure with --download-butterflypack)
2490: . `MAT_STRUMPACK_COMPRESSION_TYPE_BLR_HODLR` - hybrid of BLR and HODLR (requires ButterfyPACK support, configure with --download-butterflypack)
2491: . `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)
2492: . `MAT_STRUMPACK_COMPRESSION_TYPE_LOSSLESS` - lossless compression (requires ZFP support, configure with --download-zfp)
2493: - `MAT_STRUMPACK_COMPRESSION_TYPE_LOSSY` - lossy compression (requires ZFP support, configure with --download-zfp)
2495: Level: intermediate
2497: .seealso: `Mat`, `MATSOLVERSTRUMPACK`, `MatGetFactor()`, `MatSTRUMPACKSetCompression()`
2498: E*/
2499: typedef enum {
2500: MAT_STRUMPACK_COMPRESSION_TYPE_NONE,
2501: MAT_STRUMPACK_COMPRESSION_TYPE_HSS,
2502: MAT_STRUMPACK_COMPRESSION_TYPE_BLR,
2503: MAT_STRUMPACK_COMPRESSION_TYPE_HODLR,
2504: MAT_STRUMPACK_COMPRESSION_TYPE_BLR_HODLR,
2505: MAT_STRUMPACK_COMPRESSION_TYPE_ZFP_BLR_HODLR,
2506: MAT_STRUMPACK_COMPRESSION_TYPE_LOSSLESS,
2507: MAT_STRUMPACK_COMPRESSION_TYPE_LOSSY
2508: } MatSTRUMPACKCompressionType;
2510: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompression(Mat, MatSTRUMPACKCompressionType);
2511: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompression(Mat, MatSTRUMPACKCompressionType *);
2512: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompRelTol(Mat, PetscReal);
2513: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompRelTol(Mat, PetscReal *);
2514: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompAbsTol(Mat, PetscReal);
2515: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompAbsTol(Mat, PetscReal *);
2516: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompMinSepSize(Mat, PetscInt);
2517: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompMinSepSize(Mat, PetscInt *);
2518: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompLeafSize(Mat, PetscInt);
2519: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompLeafSize(Mat, PetscInt *);
2520: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompLossyPrecision(Mat, PetscInt);
2521: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompLossyPrecision(Mat, PetscInt *);
2522: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompButterflyLevels(Mat, PetscInt);
2523: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompButterflyLevels(Mat, PetscInt *);
2524: #endif
2526: PETSC_EXTERN PetscErrorCode MatBindToCPU(Mat, PetscBool);
2527: PETSC_EXTERN PetscErrorCode MatBoundToCPU(Mat, PetscBool *);
2528: PETSC_DEPRECATED_FUNCTION(3, 13, 0, "MatBindToCPU()", ) static inline PetscErrorCode MatPinToCPU(Mat A, PetscBool flg)
2529: {
2530: return MatBindToCPU(A, flg);
2531: }
2532: PETSC_EXTERN PetscErrorCode MatSetBindingPropagates(Mat, PetscBool);
2533: PETSC_EXTERN PetscErrorCode MatGetBindingPropagates(Mat, PetscBool *);
2535: #ifdef PETSC_HAVE_CUDA
2536: /*E
2537: MatCUSPARSEStorageFormat - indicates the storage format for `MATAIJCUSPARSE` (GPU)
2538: matrices.
2540: Values:
2541: + `MAT_CUSPARSE_CSR` - Compressed Sparse Row
2542: . `MAT_CUSPARSE_ELL` - Ellpack (requires CUDA 4.2 or later).
2543: - `MAT_CUSPARSE_HYB` - Hybrid, a combination of Ellpack and Coordinate format (requires CUDA 4.2 or later).
2545: Level: intermediate
2547: .seealso: [](ch_matrices), `MATAIJCUSPARSE`, `MatCUSPARSESetFormat()`, `MatCUSPARSEFormatOperation`
2548: E*/
2550: typedef enum {
2551: MAT_CUSPARSE_CSR,
2552: MAT_CUSPARSE_ELL,
2553: MAT_CUSPARSE_HYB
2554: } MatCUSPARSEStorageFormat;
2556: /* these will be strings associated with enumerated type defined above */
2557: PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[];
2559: /*E
2560: MatCUSPARSEFormatOperation - indicates the operation of `MATAIJCUSPARSE` (GPU)
2561: matrices whose operation should use a particular storage format.
2563: Values:
2564: + `MAT_CUSPARSE_MULT_DIAG` - sets the storage format for the diagonal matrix in the parallel `MatMult()`
2565: . `MAT_CUSPARSE_MULT_OFFDIAG` - sets the storage format for the off-diagonal matrix in the parallel `MatMult()`
2566: . `MAT_CUSPARSE_MULT` - sets the storage format for the entire matrix in the serial (single GPU) `MatMult()`
2567: - `MAT_CUSPARSE_ALL` - sets the storage format for all `MATAIJCUSPARSE` (GPU) matrices
2569: Level: intermediate
2571: .seealso: [](ch_matrices), `MatCUSPARSESetFormat()`, `MatCUSPARSEStorageFormat`
2572: E*/
2573: typedef enum {
2574: MAT_CUSPARSE_MULT_DIAG,
2575: MAT_CUSPARSE_MULT_OFFDIAG,
2576: MAT_CUSPARSE_MULT,
2577: MAT_CUSPARSE_ALL
2578: } MatCUSPARSEFormatOperation;
2580: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2581: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2582: PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat, MatCUSPARSEFormatOperation, MatCUSPARSEStorageFormat);
2583: PETSC_EXTERN PetscErrorCode MatCUSPARSESetUseCPUSolve(Mat, PetscBool);
2584: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetIJ(Mat, PetscBool, const int **, const int **);
2585: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreIJ(Mat, PetscBool, const int **, const int **);
2586: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArrayRead(Mat, const PetscScalar **);
2587: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArrayRead(Mat, const PetscScalar **);
2588: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArrayWrite(Mat, PetscScalar **);
2589: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArrayWrite(Mat, PetscScalar **);
2590: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArray(Mat, PetscScalar **);
2591: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArray(Mat, PetscScalar **);
2593: PETSC_EXTERN PetscErrorCode MatCreateDenseCUDA(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar[], Mat *);
2594: PETSC_EXTERN PetscErrorCode MatCreateSeqDenseCUDA(MPI_Comm, PetscInt, PetscInt, PetscScalar[], Mat *);
2595: PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayWrite(Mat, PetscScalar **);
2596: PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayRead(Mat, const PetscScalar **);
2597: PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArray(Mat, PetscScalar **);
2598: PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayWrite(Mat, PetscScalar **);
2599: PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayRead(Mat, const PetscScalar **);
2600: PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArray(Mat, PetscScalar **);
2601: PETSC_EXTERN PetscErrorCode MatDenseCUDAPlaceArray(Mat, const PetscScalar *);
2602: PETSC_EXTERN PetscErrorCode MatDenseCUDAReplaceArray(Mat, const PetscScalar *);
2603: PETSC_EXTERN PetscErrorCode MatDenseCUDAResetArray(Mat);
2604: PETSC_EXTERN PetscErrorCode MatDenseCUDASetPreallocation(Mat, PetscScalar *);
2606: PETSC_EXTERN PetscErrorCode MatCreateSeqSELLCUDA(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2607: PETSC_EXTERN PetscErrorCode MatCreateSELLCUDA(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2608: #endif
2610: #ifdef PETSC_HAVE_HIP
2611: /*E
2612: MatHIPSPARSEStorageFormat - indicates the storage format for `MATAIJHIPSPARSE` (GPU)
2613: matrices.
2615: Values:
2616: + `MAT_HIPSPARSE_CSR` - Compressed Sparse Row
2617: . `MAT_HIPSPARSE_ELL` - Ellpack
2618: - `MAT_HIPSPARSE_HYB` - Hybrid, a combination of Ellpack and Coordinate format
2620: Level: intermediate
2622: .seealso: [](ch_matrices), `MatHIPSPARSESetFormat()`, `MatHIPSPARSEFormatOperation`
2623: E*/
2625: typedef enum {
2626: MAT_HIPSPARSE_CSR,
2627: MAT_HIPSPARSE_ELL,
2628: MAT_HIPSPARSE_HYB
2629: } MatHIPSPARSEStorageFormat;
2631: /* these will be strings associated with enumerated type defined above */
2632: PETSC_EXTERN const char *const MatHIPSPARSEStorageFormats[];
2634: /*E
2635: MatHIPSPARSEFormatOperation - indicates the operation of `MATAIJHIPSPARSE` (GPU)
2636: matrices whose operation should use a particular storage format.
2638: Values:
2639: + `MAT_HIPSPARSE_MULT_DIAG` - sets the storage format for the diagonal matrix in the parallel `MatMult()`
2640: . `MAT_HIPSPARSE_MULT_OFFDIAG` - sets the storage format for the off-diagonal matrix in the parallel `MatMult()`
2641: . `MAT_HIPSPARSE_MULT` - sets the storage format for the entire matrix in the serial (single GPU) `MatMult()`
2642: - `MAT_HIPSPARSE_ALL` - sets the storage format for all HIPSPARSE (GPU) matrices
2644: Level: intermediate
2646: .seealso: [](ch_matrices), `MatHIPSPARSESetFormat()`, `MatHIPSPARSEStorageFormat`
2647: E*/
2648: typedef enum {
2649: MAT_HIPSPARSE_MULT_DIAG,
2650: MAT_HIPSPARSE_MULT_OFFDIAG,
2651: MAT_HIPSPARSE_MULT,
2652: MAT_HIPSPARSE_ALL
2653: } MatHIPSPARSEFormatOperation;
2655: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJHIPSPARSE(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2656: PETSC_EXTERN PetscErrorCode MatCreateAIJHIPSPARSE(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2657: PETSC_EXTERN PetscErrorCode MatHIPSPARSESetFormat(Mat, MatHIPSPARSEFormatOperation, MatHIPSPARSEStorageFormat);
2658: PETSC_EXTERN PetscErrorCode MatHIPSPARSESetUseCPUSolve(Mat, PetscBool);
2659: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSEGetIJ(Mat, PetscBool, const int **, const int **);
2660: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSERestoreIJ(Mat, PetscBool, const int **, const int **);
2661: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSEGetArrayRead(Mat, const PetscScalar **);
2662: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSERestoreArrayRead(Mat, const PetscScalar **);
2663: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSEGetArrayWrite(Mat, PetscScalar **);
2664: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSERestoreArrayWrite(Mat, PetscScalar **);
2665: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSEGetArray(Mat, PetscScalar **);
2666: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSERestoreArray(Mat, PetscScalar **);
2668: PETSC_EXTERN PetscErrorCode MatCreateDenseHIP(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar[], Mat *);
2669: PETSC_EXTERN PetscErrorCode MatCreateSeqDenseHIP(MPI_Comm, PetscInt, PetscInt, PetscScalar[], Mat *);
2670: PETSC_EXTERN PetscErrorCode MatDenseHIPGetArrayWrite(Mat, PetscScalar **);
2671: PETSC_EXTERN PetscErrorCode MatDenseHIPGetArrayRead(Mat, const PetscScalar **);
2672: PETSC_EXTERN PetscErrorCode MatDenseHIPGetArray(Mat, PetscScalar **);
2673: PETSC_EXTERN PetscErrorCode MatDenseHIPRestoreArrayWrite(Mat, PetscScalar **);
2674: PETSC_EXTERN PetscErrorCode MatDenseHIPRestoreArrayRead(Mat, const PetscScalar **);
2675: PETSC_EXTERN PetscErrorCode MatDenseHIPRestoreArray(Mat, PetscScalar **);
2676: PETSC_EXTERN PetscErrorCode MatDenseHIPPlaceArray(Mat, const PetscScalar *);
2677: PETSC_EXTERN PetscErrorCode MatDenseHIPReplaceArray(Mat, const PetscScalar *);
2678: PETSC_EXTERN PetscErrorCode MatDenseHIPResetArray(Mat);
2679: PETSC_EXTERN PetscErrorCode MatDenseHIPSetPreallocation(Mat, PetscScalar *);
2680: PETSC_EXTERN PetscErrorCode MatCreateSeqSELLHIP(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2681: PETSC_EXTERN PetscErrorCode MatCreateSELLHIP(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2682: #endif
2684: #if defined(PETSC_HAVE_VIENNACL)
2685: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2686: PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2687: #endif
2689: #if PetscDefined(HAVE_KOKKOS)
2690: PETSC_EXTERN PetscErrorCode MatCreateAIJKokkos(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2691: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJKokkos(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2692: #endif
2694: #if defined(PETSC_HAVE_FFTW)
2695: PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat, Vec, Vec);
2696: PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat, Vec, Vec);
2697: PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat, Vec *, Vec *, Vec *);
2698: #endif
2700: #if defined(PETSC_HAVE_SCALAPACK) && (defined(PETSC_USE_REAL_SINGLE) || defined(PETSC_USE_REAL_DOUBLE))
2701: PETSC_EXTERN PetscErrorCode MatCreateScaLAPACK(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, Mat *);
2702: PETSC_EXTERN PetscErrorCode MatScaLAPACKSetBlockSizes(Mat, PetscInt, PetscInt);
2703: PETSC_EXTERN PetscErrorCode MatScaLAPACKGetBlockSizes(Mat, PetscInt *, PetscInt *);
2704: #endif
2706: PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm, PetscInt, const IS[], PetscInt, const IS[], const Mat[], Mat *);
2707: PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat, PetscInt *, PetscInt *);
2708: PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat, IS[], IS[]);
2709: PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat, IS[], IS[]);
2710: PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat, PetscInt *, PetscInt *, Mat ***);
2711: PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat, PetscInt, PetscInt, Mat *);
2712: PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat, VecType);
2713: PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat, PetscInt, const IS[], PetscInt, const IS[], const Mat[]);
2714: PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat, PetscInt, PetscInt, Mat);
2716: PETSC_EXTERN PetscErrorCode MatFilter(Mat, PetscReal, PetscBool, PetscBool);
2717: PETSC_DEPRECATED_FUNCTION(3, 20, 0, "MatFilter()", ) static inline PetscErrorCode MatChop(Mat A, PetscReal tol)
2718: {
2719: return MatFilter(A, tol, PETSC_FALSE, PETSC_FALSE);
2720: }
2721: PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat, PetscReal, PetscInt *);
2723: PETSC_EXTERN PetscErrorCode MatSubdomainsCreateCoalesce(Mat, PetscInt, PetscInt *, IS **);
2725: PETSC_EXTERN PetscErrorCode MatPreallocatorPreallocate(Mat, PetscBool, Mat);
2727: PETSC_EXTERN PetscErrorCode MatHeaderMerge(Mat, Mat *);
2728: PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat, Mat *);
2730: PETSC_EXTERN PetscErrorCode MatSeqAIJGetCSRAndMemType(Mat, const PetscInt **, const PetscInt **, PetscScalar **, PetscMemType *);
2732: PETSC_EXTERN PetscErrorCode MatCreateGraph(Mat, PetscBool, PetscBool, PetscReal, PetscInt, PetscInt[], Mat *);
2733: PETSC_EXTERN PetscErrorCode MatEliminateZeros(Mat, PetscBool);
2735: PETSC_EXTERN PetscErrorCode MatCreateDenseFromVecType(MPI_Comm, VecType, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar *, Mat *);
2736: PETSC_EXTERN PetscErrorCode MatCreateDenseWithMemType(MPI_Comm, PetscMemType, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar *, Mat *);
2738: PETSC_EXTERN PetscErrorCode MatSetHPL(Mat, int);
2739: #define PETSCBMHPL "hpl"
2741: PETSC_EXTERN PetscErrorCode MatDFischer(Mat, Vec, Vec, Vec, Vec, Vec, Vec, Vec, Vec);