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