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