Actual source code: petscmat.h

  1: /*
  2:      Include file for the matrix component of PETSc
  3: */
  4: #pragma once

  6: #include <petscvec.h>

  8: /* SUBMANSEC = Mat */

 10: /*S
 11:    Mat - Abstract PETSc matrix object used to manage all linear operators in PETSc, even those without
 12:          an explicit sparse representation (such as matrix-free operators). Also used to hold representations of graphs
 13:          for graph operations such as coloring, `MatColoringCreate()`

 15:    Level: beginner

 17:    Note:
 18:    See [](doc_matrix), [](ch_matrices) and `MatType` for available matrix types

 20: .seealso: [](doc_matrix), [](ch_matrices), `MatCreate()`, `MatType`, `MatSetType()`, `MatDestroy()`
 21: S*/
 22: typedef struct _p_Mat *Mat;

 24: /*J
 25:    MatType - String with the name of a PETSc matrix type

 27:    Level: beginner

 29:    Note:
 30:    [](doc_matrix) for a table of available matrix types

 32: .seealso: [](doc_matrix), [](ch_matrices), `MatSetType()`, `Mat`, `MatSolverType`, `MatRegister()`
 33: J*/
 34: typedef const char *MatType;
 35: #define MATSAME                      "same"
 36: #define MATMAIJ                      "maij"
 37: #define MATSEQMAIJ                   "seqmaij"
 38: #define MATMPIMAIJ                   "mpimaij"
 39: #define MATKAIJ                      "kaij"
 40: #define MATSEQKAIJ                   "seqkaij"
 41: #define MATMPIKAIJ                   "mpikaij"
 42: #define MATIS                        "is"
 43: #define MATAIJ                       "aij"
 44: #define MATSEQAIJ                    "seqaij"
 45: #define MATMPIAIJ                    "mpiaij"
 46: #define MATAIJCRL                    "aijcrl"
 47: #define MATSEQAIJCRL                 "seqaijcrl"
 48: #define MATMPIAIJCRL                 "mpiaijcrl"
 49: #define MATAIJCUSPARSE               "aijcusparse"
 50: #define MATSEQAIJCUSPARSE            "seqaijcusparse"
 51: #define MATMPIAIJCUSPARSE            "mpiaijcusparse"
 52: #define MATAIJHIPSPARSE              "aijhipsparse"
 53: #define MATSEQAIJHIPSPARSE           "seqaijhipsparse"
 54: #define MATMPIAIJHIPSPARSE           "mpiaijhipsparse"
 55: #define MATAIJKOKKOS                 "aijkokkos"
 56: #define MATSEQAIJKOKKOS              "seqaijkokkos"
 57: #define MATMPIAIJKOKKOS              "mpiaijkokkos"
 58: #define MATAIJVIENNACL               "aijviennacl"
 59: #define MATSEQAIJVIENNACL            "seqaijviennacl"
 60: #define MATMPIAIJVIENNACL            "mpiaijviennacl"
 61: #define MATAIJPERM                   "aijperm"
 62: #define MATSEQAIJPERM                "seqaijperm"
 63: #define MATMPIAIJPERM                "mpiaijperm"
 64: #define MATAIJSELL                   "aijsell"
 65: #define MATSEQAIJSELL                "seqaijsell"
 66: #define MATMPIAIJSELL                "mpiaijsell"
 67: #define MATAIJMKL                    "aijmkl"
 68: #define MATSEQAIJMKL                 "seqaijmkl"
 69: #define MATMPIAIJMKL                 "mpiaijmkl"
 70: #define MATBAIJMKL                   "baijmkl"
 71: #define MATSEQBAIJMKL                "seqbaijmkl"
 72: #define MATMPIBAIJMKL                "mpibaijmkl"
 73: #define MATSHELL                     "shell"
 74: #define MATCENTERING                 "centering"
 75: #define MATDENSE                     "dense"
 76: #define MATDENSECUDA                 "densecuda"
 77: #define MATDENSEHIP                  "densehip"
 78: #define MATSEQDENSE                  "seqdense"
 79: #define MATSEQDENSECUDA              "seqdensecuda"
 80: #define MATSEQDENSEHIP               "seqdensehip"
 81: #define MATMPIDENSE                  "mpidense"
 82: #define MATMPIDENSECUDA              "mpidensecuda"
 83: #define MATMPIDENSEHIP               "mpidensehip"
 84: #define MATELEMENTAL                 "elemental"
 85: #define MATSCALAPACK                 "scalapack"
 86: #define MATBAIJ                      "baij"
 87: #define MATSEQBAIJ                   "seqbaij"
 88: #define MATMPIBAIJ                   "mpibaij"
 89: #define MATMPIADJ                    "mpiadj"
 90: #define MATSBAIJ                     "sbaij"
 91: #define MATSEQSBAIJ                  "seqsbaij"
 92: #define MATMPISBAIJ                  "mpisbaij"
 93: #define MATMFFD                      "mffd"
 94: #define MATNORMAL                    "normal"
 95: #define MATNORMALHERMITIAN           "normalh"
 96: #define MATLRC                       "lrc"
 97: #define MATSCATTER                   "scatter"
 98: #define MATBLOCKMAT                  "blockmat"
 99: #define MATCOMPOSITE                 "composite"
100: #define MATFFT                       "fft"
101: #define MATFFTW                      "fftw"
102: #define MATSEQCUFFT                  "seqcufft"
103: #define MATSEQHIPFFT                 "seqhipfft"
104: #define MATTRANSPOSEMAT              PETSC_DEPRECATED_MACRO(3, 18, 0, "MATTRANSPOSEVIRTUAL", ) "transpose"
105: #define MATTRANSPOSEVIRTUAL          "transpose"
106: #define MATHERMITIANTRANSPOSEVIRTUAL "hermitiantranspose"
107: #define MATSCHURCOMPLEMENT           "schurcomplement"
108: #define MATPYTHON                    "python"
109: #define MATHYPRE                     "hypre"
110: #define MATHYPRESTRUCT               "hyprestruct"
111: #define MATHYPRESSTRUCT              "hypresstruct"
112: #define MATSUBMATRIX                 "submatrix"
113: #define MATLOCALREF                  "localref"
114: #define MATNEST                      "nest"
115: #define MATPREALLOCATOR              "preallocator"
116: #define MATSELL                      "sell"
117: #define MATSEQSELL                   "seqsell"
118: #define MATMPISELL                   "mpisell"
119: #define MATSELLCUDA                  "sellcuda"
120: #define MATSEQSELLCUDA               "seqsellcuda"
121: #define MATMPISELLCUDA               "mpisellcuda"
122: #define MATSELLHIP                   "sellhip"
123: #define MATSEQSELLHIP                "seqsellhip"
124: #define MATMPISELLHIP                "mpisellhip"
125: #define MATDUMMY                     "dummy"
126: #define MATLMVM                      "lmvm"
127: #define MATLMVMDFP                   "lmvmdfp"
128: #define MATLMVMDDFP                  "lmvmddfp"
129: #define MATLMVMBFGS                  "lmvmbfgs"
130: #define MATLMVMDBFGS                 "lmvmdbfgs"
131: #define MATLMVMDQN                   "lmvmdqn"
132: #define MATLMVMSR1                   "lmvmsr1"
133: #define MATLMVMBROYDEN               "lmvmbroyden"
134: #define MATLMVMBADBROYDEN            "lmvmbadbroyden"
135: #define MATLMVMSYMBROYDEN            "lmvmsymbroyden"
136: #define MATLMVMSYMBADBROYDEN         "lmvmsymbadbroyden"
137: #define MATLMVMDIAGBROYDEN           "lmvmdiagbroyden"
138: #define MATCONSTANTDIAGONAL          "constantdiagonal"
139: #define MATDIAGONAL                  "diagonal"
140: #define MATHTOOL                     "htool"
141: #define MATH2OPUS                    "h2opus"

143: /*J
144:    MatSolverType - String with the name of a PETSc factorization-based matrix solver type.

146:    For example: "petsc" indicates what PETSc provides, "superlu_dist" the parallel SuperLU_DIST package etc

148:    Level: beginner

150:    Note:
151:    `MATSOLVERUMFPACK`, `MATSOLVERCHOLMOD`, `MATSOLVERKLU`, `MATSOLVERSPQR` form the SuiteSparse package; you can use `--download-suitesparse` as
152:    a ./configure option to install them

154: .seealso: [](sec_matfactor), [](ch_matrices), `MatGetFactor()`, `PCFactorSetMatSolverType()`, `PCFactorGetMatSolverType()`
155: J*/
156: typedef const char *MatSolverType;
157: #define MATSOLVERSUPERLU      "superlu"
158: #define MATSOLVERSUPERLU_DIST "superlu_dist"
159: #define MATSOLVERSTRUMPACK    "strumpack"
160: #define MATSOLVERUMFPACK      "umfpack"
161: #define MATSOLVERCHOLMOD      "cholmod"
162: #define MATSOLVERKLU          "klu"
163: #define MATSOLVERELEMENTAL    "elemental"
164: #define MATSOLVERSCALAPACK    "scalapack"
165: #define MATSOLVERESSL         "essl"
166: #define MATSOLVERLUSOL        "lusol"
167: #define MATSOLVERMUMPS        "mumps"
168: #define MATSOLVERMKL_PARDISO  "mkl_pardiso"
169: #define MATSOLVERMKL_CPARDISO "mkl_cpardiso"
170: #define MATSOLVERPASTIX       "pastix"
171: #define MATSOLVERMATLAB       "matlab"
172: #define MATSOLVERPETSC        "petsc"
173: #define MATSOLVERBAS          "bas"
174: #define MATSOLVERCUSPARSE     "cusparse"
175: #define MATSOLVERCUDA         "cuda"
176: #define MATSOLVERHIPSPARSE    "hipsparse"
177: #define MATSOLVERHIP          "hip"
178: #define MATSOLVERKOKKOS       "kokkos"
179: #define MATSOLVERSPQR         "spqr"

181: /*E
182:     MatFactorType - indicates what type of factorization is requested

184:     Values:
185: +  `MAT_FACTOR_LU`       - LU factorization
186: .  `MAT_FACTOR_CHOLESKY` - Cholesky factorization
187: .  `MAT_FACTOR_ILU`      - ILU factorization
188: .  `MAT_FACTOR_ICC`      - incomplete Cholesky factorization
189: .  `MAT_FACTOR_ILUDT`    - ILU factorization with drop tolerance
190: -  `MAT_FACTOR_QR`       - QR factorization

192:     Level: beginner

194: .seealso: [](ch_matrices), `MatSolverType`, `MatGetFactor()`, `MatGetFactorAvailable()`, `MatSolverTypeRegister()`
195: E*/
196: typedef enum {
197:   MAT_FACTOR_NONE,
198:   MAT_FACTOR_LU,
199:   MAT_FACTOR_CHOLESKY,
200:   MAT_FACTOR_ILU,
201:   MAT_FACTOR_ICC,
202:   MAT_FACTOR_ILUDT,
203:   MAT_FACTOR_QR,
204:   MAT_FACTOR_NUM_TYPES
205: } MatFactorType;
206: PETSC_EXTERN const char *const MatFactorTypes[];

208: PETSC_EXTERN PetscErrorCode MatGetFactor(Mat, MatSolverType, MatFactorType, Mat *);
209: PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat, MatSolverType, MatFactorType, PetscBool *);
210: PETSC_EXTERN PetscErrorCode MatFactorGetCanUseOrdering(Mat, PetscBool *);
211: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "MatFactorGetCanUseOrdering()", ) static inline PetscErrorCode MatFactorGetUseOrdering(Mat A, PetscBool *b)
212: {
213:   return MatFactorGetCanUseOrdering(A, b);
214: }
215: PETSC_EXTERN PetscErrorCode MatFactorGetSolverType(Mat, MatSolverType *);
216: PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat, MatFactorType *);
217: PETSC_EXTERN PetscErrorCode MatSetFactorType(Mat, MatFactorType);
218: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode(MatSolverFn)(Mat, MatFactorType, Mat *);
219: PETSC_EXTERN_TYPEDEF typedef MatSolverFn *MatSolverFunction;

221: PETSC_EXTERN PetscErrorCode MatSolverTypeRegister(MatSolverType, MatType, MatFactorType, MatSolverFn *);
222: PETSC_EXTERN PetscErrorCode MatSolverTypeGet(MatSolverType, MatType, MatFactorType, PetscBool *, PetscBool *, MatSolverFn **);
223: typedef MatSolverType       MatSolverPackage PETSC_DEPRECATED_TYPEDEF(3, 9, 0, "MatSolverType", );
224: PETSC_DEPRECATED_FUNCTION(3, 9, 0, "MatSolverTypeRegister()", ) static inline PetscErrorCode MatSolverPackageRegister(MatSolverType stype, MatType mtype, MatFactorType ftype, MatSolverFn *f)
225: {
226:   return MatSolverTypeRegister(stype, mtype, ftype, f);
227: }
228: PETSC_DEPRECATED_FUNCTION(3, 9, 0, "MatSolverTypeGet()", ) static inline PetscErrorCode MatSolverPackageGet(MatSolverType stype, MatType mtype, MatFactorType ftype, PetscBool *foundmtype, PetscBool *foundstype, MatSolverFn **f)
229: {
230:   return MatSolverTypeGet(stype, mtype, ftype, foundmtype, foundstype, f);
231: }

233: /*E
234:     MatProductType - indicates what type of matrix product to compute

236:     Values:
237: +  `MATPRODUCT_AB`   - product of two matrices
238: .  `MATPRODUCT_AtB`  - product of the transpose of a given matrix with a matrix
239: .  `MATPRODUCT_ABt`  - product of a matrix with the transpose of another given matrix
240: .  `MATPRODUCT_PtAP` - the triple product of the transpose of a matrix with another matrix and itself
241: .  `MATPRODUCT_RARt` - the triple product of a matrix, another matrix and the transpose of the first matrix
242: -  `MATPRODUCT_ABC`  - the product of three matrices

244:     Level: beginner

246: .seealso: [](sec_matmatproduct), [](ch_matrices), `MatProductSetType()`
247: E*/
248: typedef enum {
249:   MATPRODUCT_UNSPECIFIED = 0,
250:   MATPRODUCT_AB,
251:   MATPRODUCT_AtB,
252:   MATPRODUCT_ABt,
253:   MATPRODUCT_PtAP,
254:   MATPRODUCT_RARt,
255:   MATPRODUCT_ABC
256: } MatProductType;
257: PETSC_EXTERN const char *const MatProductTypes[];

259: /*J
260:     MatProductAlgorithm - String with the name of an algorithm for a PETSc matrix product implementation

262:    Level: beginner

264: .seealso: [](sec_matmatproduct), [](ch_matrices), `MatSetType()`, `Mat`, `MatProductSetAlgorithm()`, `MatProductType`
265: J*/
266: typedef const char *MatProductAlgorithm;
267: #define MATPRODUCTALGORITHMDEFAULT         "default"
268: #define MATPRODUCTALGORITHMSORTED          "sorted"
269: #define MATPRODUCTALGORITHMSCALABLE        "scalable"
270: #define MATPRODUCTALGORITHMSCALABLEFAST    "scalable_fast"
271: #define MATPRODUCTALGORITHMHEAP            "heap"
272: #define MATPRODUCTALGORITHMBHEAP           "btheap"
273: #define MATPRODUCTALGORITHMLLCONDENSED     "llcondensed"
274: #define MATPRODUCTALGORITHMROWMERGE        "rowmerge"
275: #define MATPRODUCTALGORITHMOUTERPRODUCT    "outerproduct"
276: #define MATPRODUCTALGORITHMATB             "at*b"
277: #define MATPRODUCTALGORITHMRAP             "rap"
278: #define MATPRODUCTALGORITHMNONSCALABLE     "nonscalable"
279: #define MATPRODUCTALGORITHMSEQMPI          "seqmpi"
280: #define MATPRODUCTALGORITHMBACKEND         "backend"
281: #define MATPRODUCTALGORITHMOVERLAPPING     "overlapping"
282: #define MATPRODUCTALGORITHMMERGED          "merged"
283: #define MATPRODUCTALGORITHMALLATONCE       "allatonce"
284: #define MATPRODUCTALGORITHMALLATONCEMERGED "allatonce_merged"
285: #define MATPRODUCTALGORITHMALLGATHERV      "allgatherv"
286: #define MATPRODUCTALGORITHMCYCLIC          "cyclic"
287: #if defined(PETSC_HAVE_HYPRE)
288:   #define MATPRODUCTALGORITHMHYPRE "hypre"
289: #endif

291: PETSC_EXTERN PetscErrorCode MatProductCreate(Mat, Mat, Mat, Mat *);
292: PETSC_EXTERN PetscErrorCode MatProductCreateWithMat(Mat, Mat, Mat, Mat);
293: PETSC_EXTERN PetscErrorCode MatProductSetType(Mat, MatProductType);
294: PETSC_EXTERN PetscErrorCode MatProductSetAlgorithm(Mat, MatProductAlgorithm);
295: PETSC_EXTERN PetscErrorCode MatProductGetAlgorithm(Mat, MatProductAlgorithm *);
296: PETSC_EXTERN PetscErrorCode MatProductSetFill(Mat, PetscReal);
297: PETSC_EXTERN PetscErrorCode MatProductSetFromOptions(Mat);
298: PETSC_EXTERN PetscErrorCode MatProductSymbolic(Mat);
299: PETSC_EXTERN PetscErrorCode MatProductNumeric(Mat);
300: PETSC_EXTERN PetscErrorCode MatProductReplaceMats(Mat, Mat, Mat, Mat);
301: PETSC_EXTERN PetscErrorCode MatProductClear(Mat);
302: PETSC_EXTERN PetscErrorCode MatProductView(Mat, PetscViewer);
303: PETSC_EXTERN PetscErrorCode MatProductGetType(Mat, MatProductType *);
304: PETSC_EXTERN PetscErrorCode MatProductGetMats(Mat, Mat *, Mat *, Mat *);

306: /* Logging support */
307: #define MAT_FILE_CLASSID 1211216 /* used to indicate matrices in binary files */
308: PETSC_EXTERN PetscClassId MAT_CLASSID;
309: PETSC_EXTERN PetscClassId MAT_COLORING_CLASSID;
310: PETSC_EXTERN PetscClassId MAT_FDCOLORING_CLASSID;
311: PETSC_EXTERN PetscClassId MAT_TRANSPOSECOLORING_CLASSID;
312: PETSC_EXTERN PetscClassId MAT_PARTITIONING_CLASSID;
313: PETSC_EXTERN PetscClassId MAT_COARSEN_CLASSID;
314: PETSC_EXTERN PetscClassId MAT_NULLSPACE_CLASSID;
315: PETSC_EXTERN PetscClassId MATMFFD_CLASSID;

317: /*E
318:    MatReuse - Indicates if matrices obtained from a previous call to `MatCreateSubMatrices()`, `MatCreateSubMatrix()`, `MatConvert()` or several other functions
319:    are to be reused to store the new matrix values.

321:    Values:
322: +  `MAT_INITIAL_MATRIX` - create a new matrix
323: .  `MAT_REUSE_MATRIX`   - reuse the matrix created with a previous call that used `MAT_INITIAL_MATRIX`
324: .  `MAT_INPLACE_MATRIX` - replace the first input matrix with the new matrix (not applicable to all functions)
325: -  `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:     Level: beginner

329: .seealso: [](ch_matrices), `Mat`, `MatCreateSubMatrices()`, `MatCreateSubMatrix()`, `MatDestroyMatrices()`, `MatConvert()`
330: E*/
331: typedef enum {
332:   MAT_INITIAL_MATRIX,
333:   MAT_REUSE_MATRIX,
334:   MAT_IGNORE_MATRIX,
335:   MAT_INPLACE_MATRIX
336: } MatReuse;

338: /*E
339:     MatCreateSubMatrixOption - Indicates if matrices obtained from a call to `MatCreateSubMatrices()`
340:     include the matrix values. Currently it is only used by `MatGetSeqNonzeroStructure()`.

342:     Values:
343: +  `MAT_DO_NOT_GET_VALUES` - do not copy the matrix values
344: -  `MAT_GET_VALUES`        - copy the matrix values

346:     Level: developer

348:     Developer Note:
349:     Why is not just a boolean used for this information?

351: .seealso: [](ch_matrices), `Mat`, `MatDuplicateOption`, `PetscCopyMode`, `MatGetSeqNonzeroStructure()`
352: E*/
353: typedef enum {
354:   MAT_DO_NOT_GET_VALUES,
355:   MAT_GET_VALUES
356: } MatCreateSubMatrixOption;

358: PETSC_EXTERN PetscErrorCode MatInitializePackage(void);
359: PETSC_EXTERN PetscErrorCode MatFinalizePackage(void);

361: PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm, Mat *);
362: PETSC_EXTERN PetscErrorCode MatCreateFromOptions(MPI_Comm, const char *, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, Mat *);
363: PETSC_EXTERN PetscErrorCode MatSetSizes(Mat, PetscInt, PetscInt, PetscInt, PetscInt);
364: PETSC_EXTERN PetscErrorCode MatSetType(Mat, MatType);
365: PETSC_EXTERN PetscErrorCode MatGetVecType(Mat, VecType *);
366: PETSC_EXTERN PetscErrorCode MatSetVecType(Mat, VecType);
367: PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat);
368: PETSC_EXTERN PetscErrorCode MatViewFromOptions(Mat, PetscObject, const char[]);
369: PETSC_EXTERN PetscErrorCode MatRegister(const char[], PetscErrorCode (*)(Mat));
370: PETSC_EXTERN PetscErrorCode MatRegisterRootName(const char[], const char[], const char[]);
371: PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat, const char[]);
372: PETSC_EXTERN PetscErrorCode MatSetOptionsPrefixFactor(Mat, const char[]);
373: PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefixFactor(Mat, const char[]);
374: PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat, const char[]);
375: PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat, const char *[]);
376: PETSC_EXTERN PetscErrorCode MatSetErrorIfFailure(Mat, PetscBool);

378: PETSC_EXTERN PetscFunctionList MatList;
379: PETSC_EXTERN PetscFunctionList MatColoringList;
380: PETSC_EXTERN PetscFunctionList MatPartitioningList;

382: /*E
383:    MatStructure - Indicates if two matrices have the same nonzero structure

385:    Values:
386: +  `SAME_NONZERO_PATTERN`      - the two matrices have identical nonzero patterns
387: .  `DIFFERENT_NONZERO_PATTERN` - the two matrices may have different nonzero patterns
388: .  `SUBSET_NONZERO_PATTERN`    - the nonzero pattern of the second matrix is a subset of the nonzero pattern of the first matrix
389: -  `UNKNOWN_NONZERO_PATTERN`   - there is no known relationship between the nonzero patterns. In this case the implementations
390:                                  may try to detect a relationship to optimize the operation

392:    Level: beginner

394:    Note:
395:    Certain matrix operations (such as `MatAXPY()`) can run much faster if the sparsity pattern of the matrices are the same. But actually determining if
396:    the patterns are the same may be costly. This provides a way for users who know something about the sparsity patterns to provide this information
397:    to certain PETSc routines.

399: .seealso: [](ch_matrices), `Mat`, `MatCopy()`, `MatAXPY()`, `MatAYPX()`
400: E*/
401: typedef enum {
402:   DIFFERENT_NONZERO_PATTERN,
403:   SUBSET_NONZERO_PATTERN,
404:   SAME_NONZERO_PATTERN,
405:   UNKNOWN_NONZERO_PATTERN
406: } MatStructure;
407: PETSC_EXTERN const char *const MatStructures[];

409: #if defined PETSC_HAVE_MKL_SPARSE
410: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJMKL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
411: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJMKL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
412: PETSC_EXTERN PetscErrorCode MatCreateBAIJMKL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
413: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJMKL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
414: #endif

416: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJPERM(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
417: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJPERM(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);

419: PETSC_EXTERN PetscErrorCode MatCreateSeqSELL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
420: PETSC_EXTERN PetscErrorCode MatCreateSELL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
421: PETSC_EXTERN PetscErrorCode MatSeqSELLSetPreallocation(Mat, PetscInt, const PetscInt[]);
422: PETSC_EXTERN PetscErrorCode MatMPISELLSetPreallocation(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
423: PETSC_EXTERN PetscErrorCode MatSeqSELLGetFillRatio(Mat, PetscReal *);
424: PETSC_EXTERN PetscErrorCode MatSeqSELLGetMaxSliceWidth(Mat, PetscInt *);
425: PETSC_EXTERN PetscErrorCode MatSeqSELLGetAvgSliceWidth(Mat, PetscReal *);
426: PETSC_EXTERN PetscErrorCode MatSeqSELLSetSliceHeight(Mat, PetscInt);
427: PETSC_EXTERN PetscErrorCode MatSeqSELLGetVarSliceSize(Mat, PetscReal *);

429: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJSELL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
430: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSELL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
431: PETSC_EXTERN PetscErrorCode MatMPISELLGetLocalMatCondensed(Mat, MatReuse, IS *, IS *, Mat *);
432: PETSC_EXTERN PetscErrorCode MatMPISELLGetSeqSELL(Mat, Mat *, Mat *, const PetscInt *[]);

434: PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm, PetscInt, PetscInt, PetscScalar[], Mat *);
435: PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar[], Mat *);
436: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
437: PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
438: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], Mat *);
439: PETSC_EXTERN PetscErrorCode MatUpdateMPIAIJWithArrays(Mat, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]);
440: PETSC_EXTERN PetscErrorCode MatUpdateMPIAIJWithArray(Mat, const PetscScalar[]);
441: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], PetscInt[], PetscInt[], PetscScalar[], Mat *);
442: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSeqAIJ(MPI_Comm, Mat, Mat, const PetscInt[], Mat *);

444: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
445: PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
446: PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], Mat *);

448: PETSC_EXTERN PetscErrorCode MatSetPreallocationCOO(Mat, PetscCount, PetscInt[], PetscInt[]);
449: PETSC_EXTERN PetscErrorCode MatSetPreallocationCOOLocal(Mat, PetscCount, PetscInt[], PetscInt[]);
450: PETSC_EXTERN PetscErrorCode MatSetValuesCOO(Mat, const PetscScalar[], InsertMode);

452: PETSC_EXTERN PetscErrorCode MatCreateMPIAdj(MPI_Comm, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscInt[], Mat *);
453: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);

455: PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
456: PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], Mat *);
457: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]);
458: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]);
459: PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscInt[], const PetscInt[]);

461: PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, void *, Mat *);
462: PETSC_EXTERN PetscErrorCode MatCreateCentering(MPI_Comm, PetscInt, PetscInt, Mat *);
463: PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat, Mat *);
464: PETSC_EXTERN PetscErrorCode MatCreateNormalHermitian(Mat, Mat *);
465: PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat, Mat, Vec, Mat, Mat *);
466: PETSC_EXTERN PetscErrorCode MatLRCGetMats(Mat, Mat *, Mat *, Vec *, Mat *);
467: PETSC_EXTERN PetscErrorCode MatLRCSetMats(Mat, Mat, Mat, Vec, Mat);
468: PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, ISLocalToGlobalMapping, ISLocalToGlobalMapping, Mat *);
469: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
470: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);

472: PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm, VecScatter, Mat *);
473: PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat, VecScatter);
474: PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat, VecScatter *);
475: PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt *, Mat *);
476: PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat, Mat);
477: PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat);
478: typedef enum {
479:   MAT_COMPOSITE_MERGE_RIGHT,
480:   MAT_COMPOSITE_MERGE_LEFT
481: } MatCompositeMergeType;
482: PETSC_EXTERN PetscErrorCode MatCompositeSetMergeType(Mat, MatCompositeMergeType);
483: PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm, PetscInt, const Mat *, Mat *);
484: /*E
485:     MatCompositeType - indicates what type of `MATCOMPOSITE` is used

487:     Values:
488: +  `MAT_COMPOSITE_ADDITIVE`       - sum of matrices (default)
489: -  `MAT_COMPOSITE_MULTIPLICATIVE` - product of matrices

491:     Level: beginner

493: .seealso: [](ch_matrices), `MATCOMPOSITE`, `MatCompositeSetType()`, `MatCompositeGetType()`
494: E*/
495: typedef enum {
496:   MAT_COMPOSITE_ADDITIVE,
497:   MAT_COMPOSITE_MULTIPLICATIVE
498: } MatCompositeType;
499: PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat, MatCompositeType);
500: PETSC_EXTERN PetscErrorCode MatCompositeGetType(Mat, MatCompositeType *);
501: PETSC_EXTERN PetscErrorCode MatCompositeSetMatStructure(Mat, MatStructure);
502: PETSC_EXTERN PetscErrorCode MatCompositeGetMatStructure(Mat, MatStructure *);
503: PETSC_EXTERN PetscErrorCode MatCompositeGetNumberMat(Mat, PetscInt *);
504: PETSC_EXTERN PetscErrorCode MatCompositeGetMat(Mat, PetscInt, Mat *);
505: PETSC_EXTERN PetscErrorCode MatCompositeSetScalings(Mat, const PetscScalar *);

507: PETSC_EXTERN PetscErrorCode MatCreateFFT(MPI_Comm, PetscInt, const PetscInt[], MatType, Mat *);
508: PETSC_EXTERN PetscErrorCode MatCreateSeqCUFFT(MPI_Comm, PetscInt, const PetscInt[], Mat *);

510: PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat, Mat *);
511: PETSC_EXTERN PetscErrorCode MatTransposeGetMat(Mat, Mat *);
512: PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat, Mat *);
513: PETSC_EXTERN PetscErrorCode MatHermitianTransposeGetMat(Mat, Mat *);
514: PETSC_EXTERN PetscErrorCode MatNormalGetMat(Mat, Mat *);
515: PETSC_EXTERN PetscErrorCode MatNormalHermitianGetMat(Mat, Mat *);
516: PETSC_EXTERN PetscErrorCode MatCreateSubMatrixVirtual(Mat, IS, IS, Mat *);
517: PETSC_EXTERN PetscErrorCode MatSubMatrixVirtualUpdate(Mat, Mat, IS, IS);
518: PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat, IS, IS, Mat *);
519: PETSC_EXTERN PetscErrorCode MatCreateConstantDiagonal(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar, Mat *);
520: PETSC_EXTERN PetscErrorCode MatCreateDiagonal(Vec, Mat *);
521: PETSC_EXTERN PetscErrorCode MatDiagonalGetDiagonal(Mat, Vec *);
522: PETSC_EXTERN PetscErrorCode MatDiagonalRestoreDiagonal(Mat, Vec *);
523: PETSC_EXTERN PetscErrorCode MatDiagonalGetInverseDiagonal(Mat, Vec *);
524: PETSC_EXTERN PetscErrorCode MatDiagonalRestoreInverseDiagonal(Mat, Vec *);

526: #if defined(PETSC_HAVE_HYPRE)
527: PETSC_EXTERN PetscErrorCode MatHYPRESetPreallocation(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
528: #endif

530: PETSC_EXTERN PetscErrorCode MatPythonSetType(Mat, const char[]);
531: PETSC_EXTERN PetscErrorCode MatPythonGetType(Mat, const char *[]);

533: PETSC_EXTERN PetscErrorCode MatResetPreallocation(Mat);
534: PETSC_EXTERN PetscErrorCode MatSetUp(Mat);
535: PETSC_EXTERN PetscErrorCode MatDestroy(Mat *);
536: PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat, PetscObjectState *);

538: PETSC_EXTERN PetscErrorCode MatConjugate(Mat);
539: PETSC_EXTERN PetscErrorCode MatRealPart(Mat);
540: PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat);
541: PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat, Mat *);
542: PETSC_EXTERN PetscErrorCode MatGetTrace(Mat, PetscScalar *);
543: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat, const PetscScalar **);
544: PETSC_EXTERN PetscErrorCode MatInvertVariableBlockDiagonal(Mat, PetscInt, const PetscInt *, PetscScalar *);
545: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonalMat(Mat, Mat);
546: PETSC_EXTERN PetscErrorCode MatInvertVariableBlockEnvelope(Mat, MatReuse, Mat *);
547: PETSC_EXTERN PetscErrorCode MatComputeVariableBlockEnvelope(Mat);

549: PETSC_EXTERN PetscErrorCode MatSetValues(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
550: PETSC_EXTERN PetscErrorCode MatSetValuesIS(Mat, IS, IS, const PetscScalar[], InsertMode);
551: PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
552: PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat, PetscInt, const PetscScalar[]);
553: PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat, PetscInt, const PetscScalar[]);
554: PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat, PetscInt, PetscInt, PetscInt[], const PetscScalar[]);
555: PETSC_EXTERN PetscErrorCode MatSetRandom(Mat, PetscRandom);

557: /*S
558:    MatStencil - Data structure (C struct) for storing information about rows and
559:    columns of a matrix as indexed on an associated grid. These are arguments to `MatSetStencil()` and `MatSetBlockStencil()`

561:    Level: beginner

563:    Notes:
564:    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).
565:    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.

567:    For stencil access to vectors see `DMDAVecGetArray()`, `DMDAVecGetArrayF90()`.

569:    For staggered grids, see `DMStagStencil`

571:    Fortran Note:
572:    See `MatSetValuesStencil()` for details.

574: .seealso: [](ch_matrices), `Mat`, `MatSetValuesStencil()`, `MatSetStencil()`, `MatSetValuesBlockedStencil()`, `DMDAVecGetArray()`, `DMDAVecGetArrayF90()`,
575:           `DMStagStencil`
576: S*/
577: typedef struct {
578:   PetscInt k, j, i, c;
579: } MatStencil;

581: PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat, PetscInt, const MatStencil[], PetscInt, const MatStencil[], const PetscScalar[], InsertMode);
582: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat, PetscInt, const MatStencil[], PetscInt, const MatStencil[], const PetscScalar[], InsertMode);
583: PETSC_EXTERN PetscErrorCode MatSetStencil(Mat, PetscInt, const PetscInt[], const PetscInt[], PetscInt);

585: /*E
586:     MatAssemblyType - Indicates if the process of setting values into the matrix is complete, and the matrix is ready for use

588:     Values:
589: +   `MAT_FLUSH_ASSEMBLY` - you will continue to put values into the matrix
590: -   `MAT_FINAL_ASSEMBLY` - you wish to use the matrix with the values currently inserted

592:     Level: beginner

594: .seealso: [](ch_matrices), `Mat`, `MatSetValues`, `MatAssemblyBegin()`, `MatAssemblyEnd()`
595: E*/
596: typedef enum {
597:   MAT_FLUSH_ASSEMBLY = 1,
598:   MAT_FINAL_ASSEMBLY = 0
599: } MatAssemblyType;

601: PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat, MatAssemblyType);
602: PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat, MatAssemblyType);
603: PETSC_EXTERN PetscErrorCode MatAssembled(Mat, PetscBool *);

605: /*E
606:    MatOption - Options that may be set for a matrix that indicate properties of the matrix or affect its behavior or storage

608:    Level: beginner

610:    Note:
611:    See `MatSetOption()` for the use of the options

613:    Developer Note:
614:    Entries that are negative need not be called collectively by all processes.

616: .seealso: [](ch_matrices), `Mat`, `MatSetOption()`
617: E*/
618: typedef enum {
619:   MAT_OPTION_MIN                  = -3,
620:   MAT_UNUSED_NONZERO_LOCATION_ERR = -2,
621:   MAT_ROW_ORIENTED                = -1,
622:   MAT_SYMMETRIC                   = 1,
623:   MAT_STRUCTURALLY_SYMMETRIC      = 2,
624:   MAT_FORCE_DIAGONAL_ENTRIES      = 3,
625:   MAT_IGNORE_OFF_PROC_ENTRIES     = 4,
626:   MAT_USE_HASH_TABLE              = 5,
627:   MAT_KEEP_NONZERO_PATTERN        = 6,
628:   MAT_IGNORE_ZERO_ENTRIES         = 7,
629:   MAT_USE_INODES                  = 8,
630:   MAT_HERMITIAN                   = 9,
631:   MAT_SYMMETRY_ETERNAL            = 10,
632:   MAT_NEW_NONZERO_LOCATION_ERR    = 11,
633:   MAT_IGNORE_LOWER_TRIANGULAR     = 12,
634:   MAT_ERROR_LOWER_TRIANGULAR      = 13,
635:   MAT_GETROW_UPPERTRIANGULAR      = 14,
636:   MAT_SPD                         = 15,
637:   MAT_NO_OFF_PROC_ZERO_ROWS       = 16,
638:   MAT_NO_OFF_PROC_ENTRIES         = 17,
639:   MAT_NEW_NONZERO_LOCATIONS       = 18,
640:   MAT_NEW_NONZERO_ALLOCATION_ERR  = 19,
641:   MAT_SUBSET_OFF_PROC_ENTRIES     = 20,
642:   MAT_SUBMAT_SINGLEIS             = 21,
643:   MAT_STRUCTURE_ONLY              = 22,
644:   MAT_SORTED_FULL                 = 23,
645:   MAT_FORM_EXPLICIT_TRANSPOSE     = 24,
646:   MAT_STRUCTURAL_SYMMETRY_ETERNAL = 25,
647:   MAT_SPD_ETERNAL                 = 26,
648:   MAT_OPTION_MAX                  = 27
649: } MatOption;

651: PETSC_EXTERN const char *const *MatOptions;
652: PETSC_EXTERN PetscErrorCode     MatSetOption(Mat, MatOption, PetscBool);
653: PETSC_EXTERN PetscErrorCode     MatGetOption(Mat, MatOption, PetscBool *);
654: PETSC_EXTERN PetscErrorCode     MatPropagateSymmetryOptions(Mat, Mat);
655: PETSC_EXTERN PetscErrorCode     MatGetType(Mat, MatType *);

657: PETSC_EXTERN PetscErrorCode    MatGetValues(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], PetscScalar[]);
658: PETSC_EXTERN PetscErrorCode    MatGetRow(Mat, PetscInt, PetscInt *, const PetscInt *[], const PetscScalar *[]);
659: PETSC_EXTERN PetscErrorCode    MatRestoreRow(Mat, PetscInt, PetscInt *, const PetscInt *[], const PetscScalar *[]);
660: PETSC_EXTERN PetscErrorCode    MatGetRowUpperTriangular(Mat);
661: PETSC_EXTERN PetscErrorCode    MatRestoreRowUpperTriangular(Mat);
662: PETSC_EXTERN PetscErrorCode    MatGetColumnVector(Mat, Vec, PetscInt);
663: PETSC_EXTERN PetscErrorCode    MatSeqAIJGetArray(Mat, PetscScalar *[]);
664: PETSC_EXTERN PetscErrorCode    MatSeqAIJGetArrayRead(Mat, const PetscScalar *[]);
665: PETSC_EXTERN PetscErrorCode    MatSeqAIJGetArrayWrite(Mat, PetscScalar *[]);
666: PETSC_EXTERN PetscErrorCode    MatSeqAIJRestoreArray(Mat, PetscScalar *[]);
667: PETSC_EXTERN PetscErrorCode    MatSeqAIJRestoreArrayRead(Mat, const PetscScalar *[]);
668: PETSC_EXTERN PetscErrorCode    MatSeqAIJRestoreArrayWrite(Mat, PetscScalar *[]);
669: PETSC_EXTERN PetscErrorCode    MatSeqAIJGetMaxRowNonzeros(Mat, PetscInt *);
670: PETSC_EXTERN PetscErrorCode    MatSeqAIJSetValuesLocalFast(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
671: PETSC_EXTERN PetscErrorCode    MatSeqAIJSetType(Mat, MatType);
672: PETSC_EXTERN PetscErrorCode    MatSeqAIJKron(Mat, Mat, MatReuse, Mat *);
673: PETSC_EXTERN PetscErrorCode    MatSeqAIJRegister(const char[], PetscErrorCode (*)(Mat, MatType, MatReuse, Mat *));
674: PETSC_EXTERN PetscFunctionList MatSeqAIJList;
675: PETSC_EXTERN PetscErrorCode    MatSeqBAIJGetArray(Mat, PetscScalar *[]);
676: PETSC_EXTERN PetscErrorCode    MatSeqBAIJRestoreArray(Mat, PetscScalar *[]);
677: PETSC_EXTERN PetscErrorCode    MatSeqSBAIJGetArray(Mat, PetscScalar *[]);
678: PETSC_EXTERN PetscErrorCode    MatSeqSBAIJRestoreArray(Mat, PetscScalar *[]);
679: PETSC_EXTERN PetscErrorCode    MatDenseGetArray(Mat, PetscScalar *[]);
680: PETSC_EXTERN PetscErrorCode    MatDenseRestoreArray(Mat, PetscScalar *[]);
681: PETSC_EXTERN PetscErrorCode    MatDensePlaceArray(Mat, const PetscScalar[]);
682: PETSC_EXTERN PetscErrorCode    MatDenseReplaceArray(Mat, const PetscScalar[]);
683: PETSC_EXTERN PetscErrorCode    MatDenseResetArray(Mat);
684: PETSC_EXTERN PetscErrorCode    MatDenseGetArrayRead(Mat, const PetscScalar *[]);
685: PETSC_EXTERN PetscErrorCode    MatDenseRestoreArrayRead(Mat, const PetscScalar *[]);
686: PETSC_EXTERN PetscErrorCode    MatDenseGetArrayWrite(Mat, PetscScalar *[]);
687: PETSC_EXTERN PetscErrorCode    MatDenseRestoreArrayWrite(Mat, PetscScalar *[]);
688: PETSC_EXTERN PetscErrorCode    MatDenseGetArrayAndMemType(Mat, PetscScalar *[], PetscMemType *);
689: PETSC_EXTERN PetscErrorCode    MatDenseRestoreArrayAndMemType(Mat, PetscScalar *[]);
690: PETSC_EXTERN PetscErrorCode    MatDenseGetArrayReadAndMemType(Mat, const PetscScalar *[], PetscMemType *);
691: PETSC_EXTERN PetscErrorCode    MatDenseRestoreArrayReadAndMemType(Mat, const PetscScalar *[]);
692: PETSC_EXTERN PetscErrorCode    MatDenseGetArrayWriteAndMemType(Mat, PetscScalar *[], PetscMemType *);
693: PETSC_EXTERN PetscErrorCode    MatDenseRestoreArrayWriteAndMemType(Mat, PetscScalar *[]);
694: PETSC_EXTERN PetscErrorCode    MatGetBlockSize(Mat, PetscInt *);
695: PETSC_EXTERN PetscErrorCode    MatSetBlockSize(Mat, PetscInt);
696: PETSC_EXTERN PetscErrorCode    MatGetBlockSizes(Mat, PetscInt *, PetscInt *);
697: PETSC_EXTERN PetscErrorCode    MatSetBlockSizes(Mat, PetscInt, PetscInt);
698: PETSC_EXTERN PetscErrorCode    MatSetBlockSizesFromMats(Mat, Mat, Mat);
699: PETSC_EXTERN PetscErrorCode    MatSetVariableBlockSizes(Mat, PetscInt, const PetscInt[]);
700: PETSC_EXTERN PetscErrorCode    MatGetVariableBlockSizes(Mat, PetscInt *, const PetscInt *[]);

702: PETSC_EXTERN PetscErrorCode MatDenseGetColumn(Mat, PetscInt, PetscScalar *[]);
703: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumn(Mat, PetscScalar *[]);
704: PETSC_EXTERN PetscErrorCode MatDenseGetColumnVec(Mat, PetscInt, Vec *);
705: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVec(Mat, PetscInt, Vec *);
706: PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecRead(Mat, PetscInt, Vec *);
707: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecRead(Mat, PetscInt, Vec *);
708: PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecWrite(Mat, PetscInt, Vec *);
709: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecWrite(Mat, PetscInt, Vec *);
710: PETSC_EXTERN PetscErrorCode MatDenseGetSubMatrix(Mat, PetscInt, PetscInt, PetscInt, PetscInt, Mat *);
711: PETSC_EXTERN PetscErrorCode MatDenseRestoreSubMatrix(Mat, Mat *);

713: PETSC_EXTERN PetscErrorCode MatMult(Mat, Vec, Vec);
714: PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat, Vec, Vec);
715: PETSC_EXTERN PetscErrorCode MatMultAdd(Mat, Vec, Vec, Vec);
716: PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat, Vec, Vec);
717: PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat, Vec, Vec);
718: PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat, Mat, PetscReal, PetscBool *);
719: PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat, Mat, PetscReal, PetscBool *);
720: PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat, Vec, Vec, Vec);
721: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat, Vec, Vec, Vec);
722: PETSC_EXTERN PetscErrorCode MatMatSolve(Mat, Mat, Mat);
723: PETSC_EXTERN PetscErrorCode MatMatSolveTranspose(Mat, Mat, Mat);
724: PETSC_EXTERN PetscErrorCode MatMatTransposeSolve(Mat, Mat, Mat);
725: PETSC_EXTERN PetscErrorCode MatResidual(Mat, Vec, Vec, Vec);

727: /*E
728:   MatDuplicateOption - Indicates if a duplicated sparse matrix should have
729:   its numerical values copied over or just its nonzero structure.

731:   Values:
732: + `MAT_DO_NOT_COPY_VALUES`    - Create a matrix using the same nonzero pattern as the original matrix,
733:                                 with zeros for the numerical values
734: . `MAT_COPY_VALUES`           - Create a matrix with the same nonzero pattern as the original matrix
735:                                 and with the same numerical values.
736: - `MAT_SHARE_NONZERO_PATTERN` - Create a matrix that shares the nonzero structure with the previous matrix
737:                                 and does not copy it, using zeros for the numerical values. The parent and
738:                                 child matrices will share their index (i and j) arrays, and you cannot
739:                                 insert new nonzero entries into either matrix

741:   Level: beginner

743:   Note:
744:   Many matrix types (including `MATSEQAIJ`) do not support the `MAT_SHARE_NONZERO_PATTERN` optimization; in
745:   this case the behavior is as if `MAT_DO_NOT_COPY_VALUES` has been specified.

747: .seealso: [](ch_matrices), `Mat`, `MatDuplicate()`
748: E*/
749: typedef enum {
750:   MAT_DO_NOT_COPY_VALUES,
751:   MAT_COPY_VALUES,
752:   MAT_SHARE_NONZERO_PATTERN
753: } MatDuplicateOption;

755: PETSC_EXTERN PetscErrorCode MatConvert(Mat, MatType, MatReuse, Mat *);
756: PETSC_EXTERN PetscErrorCode MatDuplicate(Mat, MatDuplicateOption, Mat *);

758: PETSC_EXTERN PetscErrorCode MatCopy(Mat, Mat, MatStructure);
759: PETSC_EXTERN PetscErrorCode MatView(Mat, PetscViewer);
760: PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat, PetscReal, PetscBool *);
761: PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat, PetscBool *);
762: PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat, PetscReal, PetscBool *);
763: PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat, PetscBool *, PetscBool *);
764: PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat, PetscBool *, PetscBool *);
765: PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetricKnown(Mat, PetscBool *, PetscBool *);
766: PETSC_EXTERN PetscErrorCode MatIsSPDKnown(Mat, PetscBool *, PetscBool *);
767: PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat, PetscBool *, PetscInt *);
768: PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer);

770: PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *);
771: PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *);
772: PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *);
773: PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *);

775: /*S
776:    MatInfo - Context of matrix information, used with `MatGetInfo()`

778:    Level: intermediate

780:    Fortran Note:
781:    Information is stored as a double-precision array of dimension `MAT_INFO_SIZE`

783: .seealso: [](ch_matrices), `Mat`, `MatGetInfo()`, `MatInfoType`
784: S*/
785: typedef struct {
786:   PetscLogDouble block_size;                          /* block size */
787:   PetscLogDouble nz_allocated, nz_used, nz_unneeded;  /* number of nonzeros */
788:   PetscLogDouble memory;                              /* memory allocated */
789:   PetscLogDouble assemblies;                          /* number of matrix assemblies called */
790:   PetscLogDouble mallocs;                             /* number of mallocs during MatSetValues() */
791:   PetscLogDouble fill_ratio_given, fill_ratio_needed; /* fill ratio for LU/ILU */
792:   PetscLogDouble factor_mallocs;                      /* number of mallocs during factorization */
793: } MatInfo;

795: /*E
796:     MatInfoType - Indicates if you want information about the local part of the matrix,
797:     the entire parallel matrix or the maximum over all the local parts.

799:     Values:
800: +   `MAT_LOCAL`      - values for each MPI process part of the matrix
801: .   `MAT_GLOBAL_MAX` - maximum of each value over all MPI processes
802: -   `MAT_GLOBAL_SUM` - sum of each value over all MPI processes

804:     Level: beginner

806: .seealso: [](ch_matrices), `MatGetInfo()`, `MatInfo`
807: E*/
808: typedef enum {
809:   MAT_LOCAL      = 1,
810:   MAT_GLOBAL_MAX = 2,
811:   MAT_GLOBAL_SUM = 3
812: } MatInfoType;
813: PETSC_EXTERN PetscErrorCode MatGetInfo(Mat, MatInfoType, MatInfo *);
814: PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat, Vec);
815: PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat, Vec, PetscInt[]);
816: PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat, Vec, PetscInt[]);
817: PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat, Vec, PetscInt[]);
818: PETSC_EXTERN PetscErrorCode MatGetRowSumAbs(Mat, Vec);
819: PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat, Vec, PetscInt[]);
820: PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat, Vec);
821: PETSC_EXTERN PetscErrorCode MatTranspose(Mat, MatReuse, Mat *);
822: PETSC_EXTERN PetscErrorCode MatTransposeSymbolic(Mat, Mat *);
823: PETSC_EXTERN PetscErrorCode MatTransposeSetPrecursor(Mat, Mat);
824: PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat, MatReuse, Mat *);
825: PETSC_EXTERN PetscErrorCode MatPermute(Mat, IS, IS, Mat *);
826: PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat, Vec, Vec);
827: PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat, Vec, InsertMode);

829: PETSC_EXTERN PetscErrorCode MatEqual(Mat, Mat, PetscBool *);
830: PETSC_EXTERN PetscErrorCode MatMultEqual(Mat, Mat, PetscInt, PetscBool *);
831: PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat, Mat, PetscInt, PetscBool *);
832: PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat, Mat, PetscInt, PetscBool *);
833: PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat, Mat, PetscInt, PetscBool *);
834: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeEqual(Mat, Mat, PetscInt, PetscBool *);
835: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAddEqual(Mat, Mat, PetscInt, PetscBool *);
836: PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *);
837: PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *);
838: PETSC_EXTERN PetscErrorCode MatMatTransposeMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *);
839: PETSC_EXTERN PetscErrorCode MatPtAPMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *);
840: PETSC_EXTERN PetscErrorCode MatRARtMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *);
841: PETSC_EXTERN PetscErrorCode MatIsLinear(Mat, PetscInt, PetscBool *);

843: PETSC_EXTERN PetscErrorCode MatNorm(Mat, NormType, PetscReal *);
844: PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat, NormType, PetscReal *);
845: PETSC_EXTERN PetscErrorCode MatGetColumnSums(Mat, PetscScalar *);
846: PETSC_EXTERN PetscErrorCode MatGetColumnSumsRealPart(Mat, PetscReal *);
847: PETSC_EXTERN PetscErrorCode MatGetColumnSumsImaginaryPart(Mat, PetscReal *);
848: PETSC_EXTERN PetscErrorCode MatGetColumnMeans(Mat, PetscScalar *);
849: PETSC_EXTERN PetscErrorCode MatGetColumnMeansRealPart(Mat, PetscReal *);
850: PETSC_EXTERN PetscErrorCode MatGetColumnMeansImaginaryPart(Mat, PetscReal *);
851: PETSC_EXTERN PetscErrorCode MatGetColumnReductions(Mat, PetscInt, PetscReal *);
852: PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat);
853: PETSC_EXTERN PetscErrorCode MatSetInf(Mat);
854: PETSC_EXTERN PetscErrorCode MatZeroRows(Mat, PetscInt, const PetscInt[], PetscScalar, Vec, Vec);
855: PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat, IS, PetscScalar, Vec, Vec);
856: PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat, PetscInt, const MatStencil[], PetscScalar, Vec, Vec);
857: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat, PetscInt, const MatStencil[], PetscScalar, Vec, Vec);
858: PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat, PetscInt, const PetscInt[], PetscScalar, Vec, Vec);
859: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat, IS, PetscScalar, Vec, Vec);

861: PETSC_EXTERN PetscErrorCode MatGetSize(Mat, PetscInt *, PetscInt *);
862: PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat, PetscInt *, PetscInt *);
863: PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat, PetscInt *, PetscInt *);
864: PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat, const PetscInt **);
865: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat, PetscInt *, PetscInt *);
866: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat, const PetscInt **);
867: PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat, IS *, IS *);

869: PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat, PetscInt, const IS[], const IS[], MatReuse, Mat *[]);
870: 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[])
871: {
872:   return MatCreateSubMatrices(mat, n, irow, icol, scall, submat);
873: }
874: PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat, PetscInt, const IS[], const IS[], MatReuse, Mat *[]);
875: 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[])
876: {
877:   return MatCreateSubMatricesMPI(mat, n, irow, icol, scall, submat);
878: }
879: PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt, Mat *[]);
880: PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt, Mat *[]);
881: PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat, IS, IS, MatReuse, Mat *);
882: PETSC_DEPRECATED_FUNCTION(3, 8, 0, "MatCreateSubMatrix()", ) static inline PetscErrorCode MatGetSubMatrix(Mat mat, IS isrow, IS iscol, MatReuse cll, Mat *newmat)
883: {
884:   return MatCreateSubMatrix(mat, isrow, iscol, cll, newmat);
885: }
886: PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat, IS, IS, Mat *);
887: PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat, IS, IS, Mat *);
888: PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat, Mat *);
889: PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat *);

891: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm, Mat, PetscInt, PetscInt, MatReuse, Mat *);
892: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm, Mat, PetscInt, PetscInt, Mat *);
893: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat, Mat);
894: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat, MatReuse, Mat *);
895: PETSC_EXTERN PetscErrorCode MatAIJGetLocalMat(Mat, Mat *);
896: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat, MatReuse, IS *, IS *, Mat *);
897: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatMerge(Mat, MatReuse, IS *, Mat *);
898: PETSC_EXTERN PetscErrorCode MatMPIAIJGetNumberNonzeros(Mat, PetscCount *);
899: PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat, Mat, MatReuse, IS *, IS *, Mat *);
900: PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *, const PetscInt *[]);

902: PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat, PetscInt, IS[], PetscInt);
903: PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat mat, PetscInt n, IS is[], PetscInt ov);
904: PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat, PetscBool);

906: PETSC_EXTERN PetscErrorCode MatMatMult(Mat, Mat, MatReuse, PetscReal, Mat *);

908: PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat, Mat, Mat, MatReuse, PetscReal, Mat *);
909: PETSC_EXTERN PetscErrorCode MatGalerkin(Mat, Mat, Mat, MatReuse, PetscReal, Mat *);

911: PETSC_EXTERN PetscErrorCode MatPtAP(Mat, Mat, MatReuse, PetscReal, Mat *);
912: PETSC_EXTERN PetscErrorCode MatRARt(Mat, Mat, MatReuse, PetscReal, Mat *);

914: PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat, Mat, MatReuse, PetscReal, Mat *);
915: PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat, Mat, MatReuse, PetscReal, Mat *);

917: PETSC_EXTERN PetscErrorCode MatAXPY(Mat, PetscScalar, Mat, MatStructure);
918: PETSC_EXTERN PetscErrorCode MatAYPX(Mat, PetscScalar, Mat, MatStructure);

920: PETSC_EXTERN PetscErrorCode MatScale(Mat, PetscScalar);
921: PETSC_EXTERN PetscErrorCode MatShift(Mat, PetscScalar);

923: PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat, ISLocalToGlobalMapping, ISLocalToGlobalMapping);
924: PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat, ISLocalToGlobalMapping *, ISLocalToGlobalMapping *);
925: PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat, PetscLayout *, PetscLayout *);
926: PETSC_EXTERN PetscErrorCode MatSetLayouts(Mat, PetscLayout, PetscLayout);
927: PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat, PetscInt, const PetscInt[], PetscScalar, Vec, Vec);
928: PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat, IS, PetscScalar, Vec, Vec);
929: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat, PetscInt, const PetscInt[], PetscScalar, Vec, Vec);
930: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat, IS, PetscScalar, Vec, Vec);
931: PETSC_EXTERN PetscErrorCode MatGetValuesLocal(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], PetscScalar[]);
932: PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
933: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode);

935: PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat, PetscInt, PetscInt);
936: PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat, PetscInt *, PetscInt *, PetscInt *, PetscInt *);

938: PETSC_EXTERN PetscErrorCode MatInterpolate(Mat, Vec, Vec);
939: PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat, Vec, Vec, Vec);
940: PETSC_EXTERN PetscErrorCode MatRestrict(Mat, Vec, Vec);
941: PETSC_EXTERN PetscErrorCode MatMatInterpolate(Mat, Mat, Mat *);
942: PETSC_EXTERN PetscErrorCode MatMatInterpolateAdd(Mat, Mat, Mat, Mat *);
943: PETSC_EXTERN PetscErrorCode MatMatRestrict(Mat, Mat, Mat *);
944: PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat, Vec *, Vec *);
945: PETSC_DEPRECATED_FUNCTION(3, 6, 0, "MatCreateVecs()", ) static inline PetscErrorCode MatGetVecs(Mat mat, Vec *x, Vec *y)
946: {
947:   return MatCreateVecs(mat, x, y);
948: }
949: PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat, PetscInt, MPI_Comm, MatReuse, Mat *);
950: PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat, MPI_Comm, MatReuse, Mat *);
951: PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat, IS *);
952: PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat, IS *);
953: PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm, Mat, PetscInt, MatReuse, Mat *);

955: /*@C
956:    MatSetValue - Set a single entry into a matrix.

958:    Not Collective

960:    Input Parameters:
961: +  mat  - the matrix
962: .  i    - the row location of the entry
963: .  j    - the column location of the entry
964: .  va   - the value to insert
965: -  mode - either `INSERT_VALUES` or `ADD_VALUES`

967:    Level: beginner

969:    Notes:
970:    This value may be cached, so `MatAssemblyBegin()` and `MatAssemblyEnd()`
971:    MUST be called after all calls to `MatSetValue()` have been completed.

973:    For efficiency one should use `MatSetValues()` and set several values simultaneously.

975: .seealso: [](ch_matrices), `Mat`, `MatAssemblyBegin()`, `MatAssemblyEnd()`, `InsertMode`, `MatGetValue()`, `MatSetValues()`,
976:           `MatSetValueLocal()`, `MatSetValuesLocal()`
977: @*/
978: static inline PetscErrorCode MatSetValue(Mat mat, PetscInt i, PetscInt j, PetscScalar va, InsertMode mode)
979: {
980:   return MatSetValues(mat, 1, &i, 1, &j, &va, mode);
981: }

983: /*@C
984:    MatGetValue - Gets a single value from a matrix

986:    Not Collective; can only return a value owned by the given process

988:    Input Parameters:
989: +  mat - the matrix
990: .  row - the row location of the entry
991: -  col - the column location of the entry

993:    Output Parameter:
994: .  va - the value

996:    Level: advanced

998:    Notes:
999:    The matrix must have been assembled with `MatAssemblyBegin()` and `MatAssemblyEnd()` before this call

1001:    For efficiency one should use `MatGetValues()` and get several values simultaneously.

1003:    See notes for `MatGetValues()`.

1005: .seealso: [](ch_matrices), `Mat`, `MatAssemblyBegin()`, `MatAssemblyEnd()`, `MatSetValue()`, `MatGetValueLocal()`, `MatGetValues()`
1006: @*/
1007: static inline PetscErrorCode MatGetValue(Mat mat, PetscInt row, PetscInt col, PetscScalar *va)
1008: {
1009:   return MatGetValues(mat, 1, &row, 1, &col, va);
1010: }

1012: /*@C
1013:    MatSetValueLocal - Inserts or adds a single value into a matrix, using a local numbering of the nodes.

1015:    Not Collective

1017:    Input Parameters:
1018: +  mat  - the matrix
1019: .  i    - the row location of the entry
1020: .  j    - the column location of the entry
1021: .  va   - the value to insert
1022: -  mode - either `INSERT_VALUES` or `ADD_VALUES`

1024:    Level: intermediate

1026:    Notes:
1027:    For efficiency one should use `MatSetValuesLocal()` and set several values simultaneously.

1029:    See notes for `MatSetValuesLocal()` for additional information on when and how this function can be used.

1031: .seealso: [](ch_matrices), `MatSetValue()`, `MatSetValuesLocal()`
1032: @*/
1033: static inline PetscErrorCode MatSetValueLocal(Mat mat, PetscInt i, PetscInt j, PetscScalar va, InsertMode mode)
1034: {
1035:   return MatSetValuesLocal(mat, 1, &i, 1, &j, &va, mode);
1036: }

1038: /*MC
1039:    MatPreallocateBegin - Begins the block of code that will count the number of nonzeros per
1040:    row in a matrix providing the data that one can use to correctly preallocate the matrix.

1042:    Synopsis:
1043: #include <petscmat.h>
1044:    PetscErrorCode MatPreallocateBegin(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)

1046:    Collective

1048:    Input Parameters:
1049: +  comm  - the communicator that will share the eventually allocated matrix
1050: .  nrows - the number of LOCAL rows in the matrix
1051: -  ncols - the number of LOCAL columns in the matrix

1053:    Output Parameters:
1054: +  dnz - the array that will be passed to the matrix preallocation routines
1055: -  onz - the other array passed to the matrix preallocation routines

1057:    Level: deprecated (since v3.19)

1059:    Notes:
1060:    This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1061:    the use of this routine

1063:    This is a macro that handles its own error checking, it does not return an error code.

1065:    Do not malloc or free `dnz` and `onz`, that is handled internally by these routines

1067:    Developer Note:
1068:    This is a MACRO, not a function, because it has a leading { that is closed by `PetscPreallocateFinalize()`.

1070: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`,
1071:           `MatPreallocateSymmetricSetLocalBlock()`
1072: M*/
1073: #define MatPreallocateBegin(comm, nrows, ncols, dnz, onz) \
1074:   do { \
1075:     PetscInt              __nrows = (nrows), __ncols = (ncols), __rstart, __end = 0; \
1076:     PetscInt PETSC_UNUSED __start; \
1077:     PetscCall(PetscCalloc2(__nrows, &(dnz), __nrows, &(onz))); \
1078:     PetscCallMPI(MPI_Scan(&__ncols, &__end, 1, MPIU_INT, MPI_SUM, comm)); \
1079:     __start = __end - __ncols; \
1080:     (void)__start; \
1081:     PetscCallMPI(MPI_Scan(&__nrows, &__rstart, 1, MPIU_INT, MPI_SUM, comm)); \
1082:   __rstart -= __nrows

1084: #define MatPreallocateInitialize(...) PETSC_DEPRECATED_MACRO(3, 18, 0, "MatPreallocateBegin()", ) MatPreallocateBegin(__VA_ARGS__)

1086: /*MC
1087:    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1088:    inserted using a local number of the rows and columns

1090:    Synopsis:
1091: #include <petscmat.h>
1092:    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

1094:    Not Collective

1096:    Input Parameters:
1097: +  map   - the row mapping from local numbering to global numbering
1098: .  nrows - the number of rows indicated
1099: .  rows  - the indices of the rows
1100: .  cmap  - the column mapping from local to global numbering
1101: .  ncols - the number of columns in the matrix
1102: .  cols  - the columns indicated
1103: .  dnz   - the array that will be passed to the matrix preallocation routines
1104: -  onz   - the other array passed to the matrix preallocation routines

1106:    Level: deprecated (since v3.19)

1108:    Notes:
1109:    This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1110:    the use of this routine

1112:    Do not malloc or free `dnz` and `onz`, that is handled internally by these routines

1114: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`
1115:           `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocalRemoveDups()`
1116: M*/
1117: #define MatPreallocateSetLocal(rmap, nrows, rows, cmap, ncols, cols, dnz, onz) \
1118:   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));)

1120: /*MC
1121:    MatPreallocateSetLocalRemoveDups - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1122:    inserted using a local number of the rows and columns. This version removes any duplicate columns in cols

1124:    Synopsis:
1125: #include <petscmat.h>
1126:    PetscErrorCode MatPreallocateSetLocalRemoveDups(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

1128:    Not Collective

1130:    Input Parameters:
1131: +  map   - the row mapping from local numbering to global numbering
1132: .  nrows - the number of rows indicated
1133: .  rows  - the indices of the rows (these values are mapped to the global values)
1134: .  cmap  - the column mapping from local to global numbering
1135: .  ncols - the number of columns in the matrix   (this value will be changed if duplicate columns are found)
1136: .  cols  - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed)
1137: .  dnz   - the array that will be passed to the matrix preallocation routines
1138: -  onz   - the other array passed to the matrix preallocation routines

1140:    Level: deprecated (since v3.19)

1142:    Notes:
1143:    This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1144:    the use of this routine

1146:    Do not malloc or free `dnz` and `onz`, that is handled internally by these routines

1148: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`
1149:           `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocal()`
1150: M*/
1151: #define MatPreallocateSetLocalRemoveDups(rmap, nrows, rows, cmap, ncols, cols, dnz, onz) \
1152:   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));)

1154: /*MC
1155:    MatPreallocateSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1156:    inserted using a local number of the rows and columns

1158:    Synopsis:
1159: #include <petscmat.h>
1160:    PetscErrorCode MatPreallocateSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

1162:    Not Collective

1164:    Input Parameters:
1165: +  map   - the row mapping from local numbering to global numbering
1166: .  nrows - the number of rows indicated
1167: .  rows  - the indices of the rows
1168: .  cmap  - the column mapping from local to global numbering
1169: .  ncols - the number of columns in the matrix
1170: .  cols  - the columns indicated
1171: .  dnz   - the array that will be passed to the matrix preallocation routines
1172: -  onz   - the other array passed to the matrix preallocation routines

1174:    Level: deprecated (since v3.19)

1176:    Notes:
1177:    This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1178:    the use of this routine

1180:    Do not malloc or free `dnz` and `onz`, that is handled internally by these routines

1182: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`
1183:           `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()`
1184: M*/
1185: #define MatPreallocateSetLocalBlock(rmap, nrows, rows, cmap, ncols, cols, dnz, onz) \
1186:   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));)

1188: /*MC
1189:    MatPreallocateSymmetricSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1190:    inserted using a local number of the rows and columns

1192:    Synopsis:
1193: #include <petscmat.h>
1194:    PetscErrorCode MatPreallocateSymmetricSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

1196:    Not Collective

1198:    Input Parameters:
1199: +  map   - the mapping between local numbering and global numbering
1200: .  nrows - the number of rows indicated
1201: .  rows  - the indices of the rows
1202: .  ncols - the number of columns in the matrix
1203: .  cols  - the columns indicated
1204: .  dnz   - the array that will be passed to the matrix preallocation routines
1205: -  onz   - the other array passed to the matrix preallocation routines

1207:    Level: deprecated (since v3.19)

1209:    Notes:
1210:    This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1211:    the use of this routine

1213:    Do not malloc or free `dnz` and `onz` that is handled internally by these routines

1215: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`
1216:           `MatPreallocateBegin()`, `MatPreallocateSetLocal()`
1217: M*/
1218: #define MatPreallocateSymmetricSetLocalBlock(map, nrows, rows, ncols, cols, dnz, onz) \
1219:   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));)

1221: /*MC
1222:    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1223:    inserted using a local number of the rows and columns

1225:    Synopsis:
1226: #include <petscmat.h>
1227:    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

1229:    Not Collective

1231:    Input Parameters:
1232: +  row   - the row
1233: .  ncols - the number of columns in the matrix
1234: -  cols  - the columns indicated

1236:    Output Parameters:
1237: +  dnz - the array that will be passed to the matrix preallocation routines
1238: -  onz - the other array passed to the matrix preallocation routines

1240:    Level: deprecated (since v3.19)

1242:    Notes:
1243:    This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1244:    the use of this routine

1246:    Do not malloc or free `dnz` and `onz` that is handled internally by these routines

1248:    This is a MACRO, not a function, because it uses variables declared in MatPreallocateBegin().

1250: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`
1251:           `MatPreallocateBegin()`, `MatPreallocateSetLocal()`
1252: M*/
1253: #define MatPreallocateSet(row, nc, cols, dnz, onz) \
1254:   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) { \
1255:     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
1256:     else if (dnz[row - __rstart] < __ncols) dnz[row - __rstart]++; \
1257:   })

1259: /*MC
1260:    MatPreallocateSymmetricSetBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
1261:    inserted using a local number of the rows and columns

1263:    Synopsis:
1264: #include <petscmat.h>
1265:    PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

1267:    Not Collective

1269:    Input Parameters:
1270: +  nrows - the number of rows indicated
1271: .  rows  - the indices of the rows
1272: .  ncols - the number of columns in the matrix
1273: .  cols  - the columns indicated
1274: .  dnz   - the array that will be passed to the matrix preallocation routines
1275: -  onz   - the other array passed to the matrix preallocation routines

1277:    Level: deprecated (since v3.19)

1279:    Notes:
1280:    This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1281:    the use of this routine

1283:    Do not malloc or free `dnz` and `onz` that is handled internally by these routines

1285:    This is a MACRO, not a function, because it uses variables declared in MatPreallocateBegin().

1287: .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateBegin()`,
1288:           `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocal()`
1289: M*/
1290: #define MatPreallocateSymmetricSetBlock(row, nc, cols, dnz, onz) \
1291:   PetscMacroReturnStandard(for (PetscInt __i = 0; __i < nc; __i++) { \
1292:     if (cols[__i] >= __end) onz[row - __rstart]++; \
1293:     else if (cols[__i] >= row && dnz[row - __rstart] < __ncols) dnz[row - __rstart]++; \
1294:   })

1296: /*MC
1297:    MatPreallocateLocation -  An alternative to MatPreallocateSet() that puts the nonzero locations into the matrix if it exists

1299:    Synopsis:
1300: #include <petscmat.h>
1301:    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)

1303:    Not Collective

1305:    Input Parameters:
1306: +  A     - matrix
1307: .  row   - row where values exist (must be local to this process)
1308: .  ncols - number of columns
1309: .  cols  - columns with nonzeros
1310: .  dnz   - the array that will be passed to the matrix preallocation routines
1311: -  onz   - the other array passed to the matrix preallocation routines

1313:    Level: deprecated (since v3.19)

1315:    Notes:
1316:    This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1317:    the use of this routine

1319:    Do not malloc or free `dnz` and `onz` that is handled internally by these routines

1321:    Developer Note:
1322:    This is a MACRO, not a function, because it uses a bunch of variables private to the MatPreallocation.... routines.

1324: .seealso: [](ch_matrices), `MatPreallocateBegin()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`,
1325:           `MatPreallocateSymmetricSetLocalBlock()`
1326: M*/
1327: #define MatPreallocateLocation(A, row, ncols, cols, dnz, onz) (A ? MatSetValues(A, 1, &row, ncols, cols, NULL, INSERT_VALUES) : MatPreallocateSet(row, ncols, cols, dnz, onz))

1329: /*MC
1330:    MatPreallocateEnd - Ends the block of code that will count the number of nonzeros per
1331:    row in a matrix providing the data that one can use to correctly preallocate the matrix.

1333:    Synopsis:
1334: #include <petscmat.h>
1335:    PetscErrorCode MatPreallocateEnd(PetscInt *dnz, PetscInt *onz)

1337:    Collective

1339:    Input Parameters:
1340: +  dnz - the array that was be passed to the matrix preallocation routines
1341: -  onz - the other array passed to the matrix preallocation routines

1343:    Level: deprecated (since v3.19)

1345:    Notes:
1346:    This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than
1347:    the use of this routine

1349:    Do not malloc or free `dnz` and `onz`, that is handled internally by these routines

1351:    Developer Note:
1352:    This is a MACRO, not a function, because it closes the { started in MatPreallocateBegin().

1354: .seealso: [](ch_matrices), `MatPreallocateBegin()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`,
1355:           `MatPreallocateSymmetricSetLocalBlock()`
1356: M*/
1357: #define MatPreallocateEnd(dnz, onz) \
1358:   PetscCall(PetscFree2(dnz, onz)); \
1359:   } \
1360:   while (0)

1362: #define MatPreallocateFinalize(...) PETSC_DEPRECATED_MACRO(3, 18, 0, "MatPreallocateEnd()", ) MatPreallocateEnd(__VA_ARGS__)

1364: /* Routines unique to particular data structures */
1365: PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat, void *);

1367: PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat, IS *, IS *);
1368: PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat, PetscInt *, PetscInt *[], PetscInt *);

1370: PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat, PetscInt[]);
1371: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat, PetscInt[]);
1372: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], Mat *);
1373: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], Mat *);
1374: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], Mat *);
1375: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], Mat *, PetscInt, PetscBool);

1377: #define MAT_SKIP_ALLOCATION -4

1379: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[]);
1380: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[]);
1381: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat, PetscInt, const PetscInt[]);
1382: PETSC_EXTERN PetscErrorCode MatSeqAIJSetTotalPreallocation(Mat, PetscInt);

1384: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
1385: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
1386: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
1387: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat, const PetscInt[], const PetscInt[], const PetscScalar[]);
1388: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]);
1389: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat, const PetscInt[], const PetscInt[], const PetscScalar[]);
1390: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]);
1391: PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat, PetscInt[], PetscInt[], PetscInt[]);
1392: PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat, Mat *);
1393: PETSC_EXTERN PetscErrorCode MatMPIAdjToSeqRankZero(Mat, Mat *);
1394: PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat, PetscScalar[]);
1395: PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat, PetscScalar[]);
1396: PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat, Mat *, Mat *, const PetscInt *[]);
1397: PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat, Mat *, Mat *, const PetscInt *[]);
1398: PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat, Mat *);

1400: PETSC_EXTERN PetscErrorCode MatDenseGetLDA(Mat, PetscInt *);
1401: PETSC_EXTERN PetscErrorCode MatDenseSetLDA(Mat, PetscInt);
1402: PETSC_DEPRECATED_FUNCTION(3, 14, 0, "MatDenseSetLDA()", ) static inline PetscErrorCode MatSeqDenseSetLDA(Mat A, PetscInt lda)
1403: {
1404:   return MatDenseSetLDA(A, lda);
1405: }
1406: PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat, Mat *);

1408: PETSC_EXTERN PetscErrorCode MatBlockMatSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[]);

1410: PETSC_EXTERN PetscErrorCode MatStoreValues(Mat);
1411: PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat);

1413: PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat, IS *);
1414: PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat, IS *);
1415: /*
1416:   These routines are not usually accessed directly, rather solving is
1417:   done through the KSP and PC interfaces.
1418: */

1420: /*J
1421:    MatOrderingType - String with the name of a PETSc matrix ordering. These orderings are most commonly used
1422:    to reduce fill in sparse factorizations.

1424:    Level: beginner

1426:    Notes:
1427:    If `MATORDERINGEXTERNAL` is used then PETSc does not compute an ordering and instead the external factorization solver package called utilizes one
1428:    of its own.

1430:    There is no `MatOrdering` object, the ordering is obtained directly from the matrix with `MatGetOrdering()`

1432:    Developer Note:
1433:    This API should be converted to an API similar to those for `MatColoring` and `MatPartitioning`

1435: .seealso: [](ch_matrices), [](sec_graph), `MatGetFactor()`, `MatGetOrdering()`, `MatColoringType`, `MatPartitioningType`, `MatCoarsenType`, `MatCoarsenType`,
1436:           `PCFactorSetOrderingType()`
1437: J*/
1438: typedef const char *MatOrderingType;
1439: #define MATORDERINGNATURAL       "natural"
1440: #define MATORDERINGND            "nd"
1441: #define MATORDERING1WD           "1wd"
1442: #define MATORDERINGRCM           "rcm"
1443: #define MATORDERINGQMD           "qmd"
1444: #define MATORDERINGROWLENGTH     "rowlength"
1445: #define MATORDERINGWBM           "wbm"
1446: #define MATORDERINGSPECTRAL      "spectral"
1447: #define MATORDERINGAMD           "amd"           /* only works if UMFPACK is installed with PETSc */
1448: #define MATORDERINGMETISND       "metisnd"       /* only works if METIS is installed with PETSc */
1449: #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 */
1450: #define MATORDERINGEXTERNAL      "external"      /* uses an ordering type internal to the factorization package */

1452: PETSC_EXTERN PetscErrorCode    MatGetOrdering(Mat, MatOrderingType, IS *, IS *);
1453: PETSC_EXTERN PetscErrorCode    MatGetOrderingList(PetscFunctionList *);
1454: PETSC_EXTERN PetscErrorCode    MatOrderingRegister(const char[], PetscErrorCode (*)(Mat, MatOrderingType, IS *, IS *));
1455: PETSC_EXTERN PetscFunctionList MatOrderingList;

1457: #include "petscmatcoarsen.h"

1459: PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat, PetscReal, IS, IS);
1460: PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat, PetscReal, PetscBool, Mat *);

1462: PETSC_EXTERN PetscErrorCode MatFactorGetPreferredOrdering(Mat, MatFactorType, MatOrderingType *);

1464: /*S
1465:    MatFactorShiftType - Type of numeric shift used for factorizations

1467:    Values:
1468: +  `MAT_SHIFT_NONE`              - do not shift the matrix diagonal entries
1469: .  `MAT_SHIFT_NONZERO`           - shift the entries to be non-zero
1470: .  `MAT_SHIFT_POSITIVE_DEFINITE` - shift the entries to force the factorization to be positive definite
1471: -  `MAT_SHIFT_INBLOCKS`          - only shift the factors inside the small dense diagonal blocks of the matrix, for example with `MATBAIJ`

1473:    Level: intermediate

1475: .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `PCFactorSetShiftType()`
1476: S*/
1477: typedef enum {
1478:   MAT_SHIFT_NONE,
1479:   MAT_SHIFT_NONZERO,
1480:   MAT_SHIFT_POSITIVE_DEFINITE,
1481:   MAT_SHIFT_INBLOCKS
1482: } MatFactorShiftType;
1483: PETSC_EXTERN const char *const MatFactorShiftTypes[];
1484: PETSC_EXTERN const char *const MatFactorShiftTypesDetail[];

1486: /*S
1487:     MatFactorError - indicates what type of error was generated in a matrix factorization

1489:     Values:
1490: +   `MAT_FACTOR_NOERROR`           - there was no error during the factorization
1491: .   `MAT_FACTOR_STRUCT_ZEROPIVOT`  - there was a missing entry in a diagonal location of the matrix
1492: .   `MAT_FACTOR_NUMERIC_ZEROPIVOT` - there was a (near) zero pivot during the factorization
1493: .   `MAT_FACTOR_OUTMEMORY`         - the factorization has run out of memory
1494: -   `MAT_FACTOR_OTHER`             - some other error has occurred.

1496:     Level: intermediate

1498:     Note:
1499:     When a factorization is done in a preconditioner `PC` the error may be propagated up to a `PCFailedReason` or a `KSPConvergedReason`

1501: .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatFactorGetError()`, `MatFactorGetErrorZeroPivot()`, `MatFactorClearError()`,
1502:           `PCFailedReason`, `PCGetFailedReason()`, `KSPConvergedReason`
1503: S*/
1504: typedef enum {
1505:   MAT_FACTOR_NOERROR,
1506:   MAT_FACTOR_STRUCT_ZEROPIVOT,
1507:   MAT_FACTOR_NUMERIC_ZEROPIVOT,
1508:   MAT_FACTOR_OUTMEMORY,
1509:   MAT_FACTOR_OTHER
1510: } MatFactorError;

1512: PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat, MatFactorError *);
1513: PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat);
1514: PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat, PetscReal *, PetscInt *);

1516: /*S
1517:    MatFactorInfo - Data passed into the matrix factorization routines, and information about the resulting factorization

1519:    Level: developer

1521:    Note:
1522:    You can use `MatFactorInfoInitialize()` to set default values.

1524:    Fortran Note:
1525:    The data is available in a double precision arrays of size `MAT_FACTORINFO_SIZE`

1527: .seealso: [](ch_matrices), `Mat`, `MatInfo`, `MatGetFactor()`, `MatLUFactorSymbolic()`, `MatILUFactorSymbolic()`, `MatCholeskyFactorSymbolic()`,
1528:           `MatICCFactorSymbolic()`, `MatICCFactor()`, `MatFactorInfoInitialize()`
1529: S*/
1530: typedef struct {
1531:   PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */
1532:   PetscReal usedt;
1533:   PetscReal dt;            /* drop tolerance */
1534:   PetscReal dtcol;         /* tolerance for pivoting */
1535:   PetscReal dtcount;       /* maximum nonzeros to be allowed per row */
1536:   PetscReal fill;          /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1537:   PetscReal levels;        /* ICC/ILU(levels) */
1538:   PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1539:                                    factorization may be faster if do not pivot */
1540:   PetscReal zeropivot;     /* pivot is called zero if less than this */
1541:   PetscReal shifttype;     /* type of shift added to matrix factor to prevent zero pivots */
1542:   PetscReal shiftamount;   /* how large the shift is */
1543: } MatFactorInfo;

1545: PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo *);
1546: PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat, IS, const MatFactorInfo *);
1547: PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat, Mat, IS, const MatFactorInfo *);
1548: PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat, Mat, const MatFactorInfo *);
1549: PETSC_EXTERN PetscErrorCode MatLUFactor(Mat, IS, IS, const MatFactorInfo *);
1550: PETSC_EXTERN PetscErrorCode MatILUFactor(Mat, IS, IS, const MatFactorInfo *);
1551: PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat, Mat, IS, IS, const MatFactorInfo *);
1552: PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat, Mat, IS, IS, const MatFactorInfo *);
1553: PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat, Mat, IS, const MatFactorInfo *);
1554: PETSC_EXTERN PetscErrorCode MatICCFactor(Mat, IS, const MatFactorInfo *);
1555: PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat, Mat, const MatFactorInfo *);
1556: PETSC_EXTERN PetscErrorCode MatQRFactor(Mat, IS, const MatFactorInfo *);
1557: PETSC_EXTERN PetscErrorCode MatQRFactorSymbolic(Mat, Mat, IS, const MatFactorInfo *);
1558: PETSC_EXTERN PetscErrorCode MatQRFactorNumeric(Mat, Mat, const MatFactorInfo *);
1559: PETSC_EXTERN PetscErrorCode MatGetInertia(Mat, PetscInt *, PetscInt *, PetscInt *);
1560: PETSC_EXTERN PetscErrorCode MatSolve(Mat, Vec, Vec);
1561: PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat, Vec, Vec);
1562: PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat, Vec, Vec);
1563: PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat, Vec, Vec, Vec);
1564: PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat, Vec, Vec);
1565: PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat, Vec, Vec, Vec);
1566: PETSC_EXTERN PetscErrorCode MatSolves(Mat, Vecs, Vecs);
1567: PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat);

1569: typedef enum {
1570:   MAT_FACTOR_SCHUR_UNFACTORED,
1571:   MAT_FACTOR_SCHUR_FACTORED,
1572:   MAT_FACTOR_SCHUR_INVERTED
1573: } MatFactorSchurStatus;
1574: PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat, IS);
1575: PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat, Mat *, MatFactorSchurStatus *);
1576: PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat, Mat *, MatFactorSchurStatus);
1577: PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat);
1578: PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat, Mat *, MatFactorSchurStatus *);
1579: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat, Vec, Vec);
1580: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat, Vec, Vec);
1581: PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat);

1583: PETSC_EXTERN PetscErrorCode MatSeqDenseInvert(Mat);
1584: /*E
1585:    MatSORType - What type of (S)SOR to perform

1587:    Values:
1588: +  `SOR_FORWARD_SWEEP`         - do a sweep from the first row of the matrix to the last
1589: .  `SOR_BACKWARD_SWEEP`        - do a sweep from the last row to the first
1590: .  `SOR_SYMMETRIC_SWEEP`       - do a sweep from the first row to the last and then back to the first
1591: .  `SOR_LOCAL_FORWARD_SWEEP`   - each MPI process does its own forward sweep with no communication
1592: .  `SOR_LOCAL_BACKWARD_SWEEP`  - each MPI process does its own backward sweep with no communication
1593: .  `SOR_LOCAL_SYMMETRIC_SWEEP` - each MPI process does its own symmetric sweep with no communication
1594: .  `SOR_ZERO_INITIAL_GUESS`    - indicates the initial solution is zero so the sweep can avoid unneeded computation
1595: .  `SOR_EISENSTAT`             - apply the Eisentat application of SOR, see `PCEISENSTAT`
1596: .  `SOR_APPLY_UPPER`           - multiply by the upper triangular portion of the matrix
1597: -  `SOR_APPLY_LOWER`           - multiply by the lower triangular portion of the matrix

1599:    Level: beginner

1601:    Note:
1602:    These may be bitwise ORd together

1604:    Developer Note:
1605:    Since `MatSORType` may be bitwise ORd together, so do not change the numerical values below

1607: .seealso: [](ch_matrices), `MatSOR()`
1608: E*/
1609: typedef enum {
1610:   SOR_FORWARD_SWEEP         = 1,
1611:   SOR_BACKWARD_SWEEP        = 2,
1612:   SOR_SYMMETRIC_SWEEP       = 3,
1613:   SOR_LOCAL_FORWARD_SWEEP   = 4,
1614:   SOR_LOCAL_BACKWARD_SWEEP  = 8,
1615:   SOR_LOCAL_SYMMETRIC_SWEEP = 12,
1616:   SOR_ZERO_INITIAL_GUESS    = 16,
1617:   SOR_EISENSTAT             = 32,
1618:   SOR_APPLY_UPPER           = 64,
1619:   SOR_APPLY_LOWER           = 128
1620: } MatSORType;
1621: PETSC_EXTERN PetscErrorCode MatSOR(Mat, Vec, PetscReal, MatSORType, PetscReal, PetscInt, PetscInt, Vec);

1623: /*S
1624:    MatColoring - Object for managing the coloring of matrices.

1626:    Level: beginner

1628:    Notes:
1629:    Coloring of matrices can be computed directly from the sparse matrix nonzero structure via the `MatColoring` object or from the mesh from which the
1630:    matrix comes from via `DMCreateColoring()`. In general using the mesh produces a more optimal coloring (fewer colors).

1632:    Once a coloring is available `MatFDColoringCreate()` creates an object that can be used to efficiently compute Jacobians using that coloring. This
1633:    same object can also be used to efficiently convert data created by Automatic Differentiation tools to PETSc sparse matrices.

1635: .seealso: [](ch_matrices), [](sec_graph), `MatFDColoringCreate()`, `MatColoringWeightType`, `ISColoring`, `MatFDColoring`, `DMCreateColoring()`, `MatColoringCreate()`,
1636:           `MatPartitioning`, `MatColoringType`, `MatPartitioningType`, `MatOrderingType`, `MatColoringSetWeightType()`,
1637:           `MatColoringSetWeights()`, `MatCoarsenType`, `MatCoarsen`
1638: S*/
1639: typedef struct _p_MatColoring *MatColoring;

1641: /*J
1642:    MatColoringType - String with the name of a PETSc matrix coloring

1644:    Level: beginner

1646: .seealso: [](ch_matrices), [](sec_graph), `Mat`, `MatFDColoringCreate()`, `MatColoringSetType()`, `MatColoring`
1647: J*/
1648: typedef const char *MatColoringType;
1649: #define MATCOLORINGJP      "jp"
1650: #define MATCOLORINGPOWER   "power"
1651: #define MATCOLORINGNATURAL "natural"
1652: #define MATCOLORINGSL      "sl"
1653: #define MATCOLORINGLF      "lf"
1654: #define MATCOLORINGID      "id"
1655: #define MATCOLORINGGREEDY  "greedy"

1657: /*E
1658:    MatColoringWeightType - Type of weight scheme used for the coloring algorithm

1660:    Values:
1661: +  `MAT_COLORING_RANDOM`  - Random weights
1662: .  `MAT_COLORING_LEXICAL` - Lexical weighting based upon global numbering.
1663: -  `MAT_COLORING_LF`      - Last-first weighting.

1665:     Level: intermediate

1667: .seealso: [](ch_matrices), `MatColoring`, `MatColoringCreate()`, `MatColoringSetWeightType()`, `MatColoringSetWeights()`
1668: E*/
1669: typedef enum {
1670:   MAT_COLORING_WEIGHT_RANDOM,
1671:   MAT_COLORING_WEIGHT_LEXICAL,
1672:   MAT_COLORING_WEIGHT_LF,
1673:   MAT_COLORING_WEIGHT_SL
1674: } MatColoringWeightType;

1676: PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat, MatColoring *);
1677: PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat, PetscInt, PetscInt *);
1678: PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring *);
1679: PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring, PetscViewer);
1680: PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring, MatColoringType);
1681: PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring);
1682: PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring, PetscInt);
1683: PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring, PetscInt *);
1684: PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring, PetscInt);
1685: PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring, PetscInt *);
1686: PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring, ISColoring *);
1687: PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[], PetscErrorCode (*)(MatColoring));
1688: PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat, PetscInt, PetscInt, ISColoringValue[], ISColoring *);
1689: PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring, MatColoringWeightType);
1690: PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring, PetscReal *, PetscInt *);
1691: PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring, PetscReal **, PetscInt **lperm);
1692: PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring, ISColoring);
1693: PETSC_DEPRECATED_FUNCTION(3, 10, 0, "MatColoringTest()", ) static inline PetscErrorCode MatColoringTestValid(MatColoring matcoloring, ISColoring iscoloring)
1694: {
1695:   return MatColoringTest(matcoloring, iscoloring);
1696: }
1697: PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat, ISColoring);

1699: /*S
1700:    MatFDColoring - Object for computing a sparse Jacobian via finite differences with coloring

1702:    Level: beginner

1704:    Notes:
1705:    This object is creating utilizing a coloring provided by the `MatColoring` object or `DMCreateColoring()`

1707:    The `SNES` option `-snes_fd_coloring` will cause the Jacobian needed by `SNES` to be computed via a use of this object

1709: .seealso: [](ch_matrices), `Mat`, `MatFDColoringCreate()`, `MatFDColoringSetFunction()`, `MatColoring`, `DMCreateColoring()`
1710: S*/
1711: typedef struct _p_MatFDColoring *MatFDColoring;

1713: PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat, ISColoring, MatFDColoring *);
1714: PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring *);
1715: PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring, PetscViewer);
1716: PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring, PetscErrorCode (*)(void), void *);
1717: PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring, PetscErrorCode (**)(void), void **);
1718: PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring, PetscReal, PetscReal);
1719: PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
1720: PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat, MatFDColoring, Vec, void *);
1721: PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring, Vec);
1722: PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring, PetscInt *, const PetscInt *[]);
1723: PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat, ISColoring, MatFDColoring);
1724: PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring, PetscInt, PetscInt);
1725: PETSC_EXTERN PetscErrorCode MatFDColoringSetValues(Mat, MatFDColoring, const PetscScalar *);

1727: /*S
1728:    MatTransposeColoring - Object for computing a sparse matrix product $C = A*B^T$ via coloring

1730:    Level: developer

1732: .seealso: [](ch_matrices), `Mat`, `MatProductType`, `MatTransposeColoringCreate()`
1733: S*/
1734: typedef struct _p_MatTransposeColoring *MatTransposeColoring;

1736: PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat, ISColoring, MatTransposeColoring *);
1737: PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring, Mat, Mat);
1738: PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring, Mat, Mat);
1739: PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring *);

1741: /*S
1742:    MatPartitioning - Object for managing the partitioning of a matrix or graph

1744:    Level: beginner

1746:    Note:
1747:    There is also a `PetscPartitioner` object that provides the same functionality. It can utilize the `MatPartitioning` operations
1748:    via `PetscPartitionerSetType`(p,`PETSCPARTITIONERMATPARTITIONING`)

1750:    Developer Note:
1751:    It is an extra maintenance and documentation cost to have two objects with the same functionality. `PetscPartitioner` should be removed

1753: .seealso: [](ch_matrices), [](sec_graph), `Mat`, `MatPartitioningCreate()`, `MatPartitioningType`, `MatColoring`, `MatGetOrdering()`, `MatOrderingType`,
1754:           `MatCoarsenType`, `MatCoarsenType`
1755: S*/
1756: typedef struct _p_MatPartitioning *MatPartitioning;

1758: /*J
1759:     MatPartitioningType - String with the name of a PETSc matrix partitioning

1761:    Level: beginner
1762: dm
1763: .seealso: [](ch_matrices), [](sec_graph), `Mat`, `MatPartitioningCreate()`, `MatPartitioning`, `MatPartitioningSetType()`, `MatColoringType`, `MatOrderingType`,
1764:           `MatCoarsenType`, `MatCoarsenType`
1765: J*/
1766: typedef const char *MatPartitioningType;
1767: #define MATPARTITIONINGCURRENT  "current"
1768: #define MATPARTITIONINGAVERAGE  "average"
1769: #define MATPARTITIONINGSQUARE   "square"
1770: #define MATPARTITIONINGPARMETIS "parmetis"
1771: #define MATPARTITIONINGCHACO    "chaco"
1772: #define MATPARTITIONINGPARTY    "party"
1773: #define MATPARTITIONINGPTSCOTCH "ptscotch"
1774: #define MATPARTITIONINGHIERARCH "hierarch"

1776: PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm, MatPartitioning *);
1777: PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning, MatPartitioningType);
1778: PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning, PetscInt);
1779: PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning, Mat);
1780: PETSC_EXTERN PetscErrorCode MatPartitioningSetNumberVertexWeights(MatPartitioning, PetscInt);
1781: PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning, const PetscInt[]);
1782: PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning, const PetscReal[]);
1783: PETSC_EXTERN PetscErrorCode MatPartitioningSetUseEdgeWeights(MatPartitioning, PetscBool);
1784: PETSC_EXTERN PetscErrorCode MatPartitioningGetUseEdgeWeights(MatPartitioning, PetscBool *);
1785: PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning, IS *);
1786: PETSC_EXTERN PetscErrorCode MatPartitioningImprove(MatPartitioning, IS *);
1787: PETSC_EXTERN PetscErrorCode MatPartitioningViewImbalance(MatPartitioning, IS);
1788: PETSC_EXTERN PetscErrorCode MatPartitioningApplyND(MatPartitioning, IS *);
1789: PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning *);
1790: PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[], PetscErrorCode (*)(MatPartitioning));
1791: PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning, PetscViewer);
1792: PETSC_EXTERN PetscErrorCode MatPartitioningViewFromOptions(MatPartitioning, PetscObject, const char[]);
1793: PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
1794: PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning, MatPartitioningType *);

1796: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part);
1797: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1798: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);

1800: typedef enum {
1801:   MP_CHACO_MULTILEVEL = 1,
1802:   MP_CHACO_SPECTRAL   = 2,
1803:   MP_CHACO_LINEAR     = 4,
1804:   MP_CHACO_RANDOM     = 5,
1805:   MP_CHACO_SCATTERED  = 6
1806: } MPChacoGlobalType;
1807: PETSC_EXTERN const char *const MPChacoGlobalTypes[];
1808: typedef enum {
1809:   MP_CHACO_KERNIGHAN = 1,
1810:   MP_CHACO_NONE      = 2
1811: } MPChacoLocalType;
1812: PETSC_EXTERN const char *const MPChacoLocalTypes[];
1813: typedef enum {
1814:   MP_CHACO_LANCZOS = 0,
1815:   MP_CHACO_RQI     = 1
1816: } MPChacoEigenType;
1817: PETSC_EXTERN const char *const MPChacoEigenTypes[];

1819: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
1820: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning, MPChacoGlobalType *);
1821: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1822: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning, MPChacoLocalType *);
1823: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning, PetscReal);
1824: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning, MPChacoEigenType);
1825: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning, MPChacoEigenType *);
1826: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1827: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning, PetscReal *);
1828: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
1829: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning, PetscInt *);

1831: #define MP_PARTY_OPT "opt"
1832: #define MP_PARTY_LIN "lin"
1833: #define MP_PARTY_SCA "sca"
1834: #define MP_PARTY_RAN "ran"
1835: #define MP_PARTY_GBF "gbf"
1836: #define MP_PARTY_GCF "gcf"
1837: #define MP_PARTY_BUB "bub"
1838: #define MP_PARTY_DEF "def"
1839: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning, const char *);
1840: #define MP_PARTY_HELPFUL_SETS  "hs"
1841: #define MP_PARTY_KERNIGHAN_LIN "kl"
1842: #define MP_PARTY_NONE          "no"
1843: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning, const char *);
1844: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning, PetscReal);
1845: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning, PetscBool);
1846: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning, PetscBool);

1848: typedef enum {
1849:   MP_PTSCOTCH_DEFAULT,
1850:   MP_PTSCOTCH_QUALITY,
1851:   MP_PTSCOTCH_SPEED,
1852:   MP_PTSCOTCH_BALANCE,
1853:   MP_PTSCOTCH_SAFETY,
1854:   MP_PTSCOTCH_SCALABILITY
1855: } MPPTScotchStrategyType;
1856: PETSC_EXTERN const char *const MPPTScotchStrategyTypes[];

1858: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning, PetscReal);
1859: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning, PetscReal *);
1860: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning, MPPTScotchStrategyType);
1861: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning, MPPTScotchStrategyType *);

1863: /*
1864:  * hierarchical partitioning
1865:  */
1866: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning, IS *);
1867: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning, IS *);
1868: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning, PetscInt);
1869: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt);

1871: PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat, PetscInt, Mat *);

1873: /*
1874:     If you add entries here you must also add them to src/mat/f90-mod/petscmat.h
1875:     If any of the enum values are changed, also update dMatOps dict at src/binding/petsc4py/src/libpetsc4py/libpetsc4py.pyx
1876: */
1877: typedef enum {
1878:   MATOP_SET_VALUES               = 0,
1879:   MATOP_GET_ROW                  = 1,
1880:   MATOP_RESTORE_ROW              = 2,
1881:   MATOP_MULT                     = 3,
1882:   MATOP_MULT_ADD                 = 4,
1883:   MATOP_MULT_TRANSPOSE           = 5,
1884:   MATOP_MULT_TRANSPOSE_ADD       = 6,
1885:   MATOP_SOLVE                    = 7,
1886:   MATOP_SOLVE_ADD                = 8,
1887:   MATOP_SOLVE_TRANSPOSE          = 9,
1888:   MATOP_SOLVE_TRANSPOSE_ADD      = 10,
1889:   MATOP_LUFACTOR                 = 11,
1890:   MATOP_CHOLESKYFACTOR           = 12,
1891:   MATOP_SOR                      = 13,
1892:   MATOP_TRANSPOSE                = 14,
1893:   MATOP_GETINFO                  = 15,
1894:   MATOP_EQUAL                    = 16,
1895:   MATOP_GET_DIAGONAL             = 17,
1896:   MATOP_DIAGONAL_SCALE           = 18,
1897:   MATOP_NORM                     = 19,
1898:   MATOP_ASSEMBLY_BEGIN           = 20,
1899:   MATOP_ASSEMBLY_END             = 21,
1900:   MATOP_SET_OPTION               = 22,
1901:   MATOP_ZERO_ENTRIES             = 23,
1902:   MATOP_ZERO_ROWS                = 24,
1903:   MATOP_LUFACTOR_SYMBOLIC        = 25,
1904:   MATOP_LUFACTOR_NUMERIC         = 26,
1905:   MATOP_CHOLESKY_FACTOR_SYMBOLIC = 27,
1906:   MATOP_CHOLESKY_FACTOR_NUMERIC  = 28,
1907:   MATOP_SETUP                    = 29,
1908:   MATOP_ILUFACTOR_SYMBOLIC       = 30,
1909:   MATOP_ICCFACTOR_SYMBOLIC       = 31,
1910:   MATOP_GET_DIAGONAL_BLOCK       = 32,
1911:   MATOP_SET_INF                  = 33,
1912:   MATOP_DUPLICATE                = 34,
1913:   MATOP_FORWARD_SOLVE            = 35,
1914:   MATOP_BACKWARD_SOLVE           = 36,
1915:   MATOP_ILUFACTOR                = 37,
1916:   MATOP_ICCFACTOR                = 38,
1917:   MATOP_AXPY                     = 39,
1918:   MATOP_CREATE_SUBMATRICES       = 40,
1919:   MATOP_INCREASE_OVERLAP         = 41,
1920:   MATOP_GET_VALUES               = 42,
1921:   MATOP_COPY                     = 43,
1922:   MATOP_GET_ROW_MAX              = 44,
1923:   MATOP_SCALE                    = 45,
1924:   MATOP_SHIFT                    = 46,
1925:   MATOP_DIAGONAL_SET             = 47,
1926:   MATOP_ZERO_ROWS_COLUMNS        = 48,
1927:   MATOP_SET_RANDOM               = 49,
1928:   MATOP_GET_ROW_IJ               = 50,
1929:   MATOP_RESTORE_ROW_IJ           = 51,
1930:   MATOP_GET_COLUMN_IJ            = 52,
1931:   MATOP_RESTORE_COLUMN_IJ        = 53,
1932:   MATOP_FDCOLORING_CREATE        = 54,
1933:   MATOP_COLORING_PATCH           = 55,
1934:   MATOP_SET_UNFACTORED           = 56,
1935:   MATOP_PERMUTE                  = 57,
1936:   MATOP_SET_VALUES_BLOCKED       = 58,
1937:   MATOP_CREATE_SUBMATRIX         = 59,
1938:   MATOP_DESTROY                  = 60,
1939:   MATOP_VIEW                     = 61,
1940:   MATOP_CONVERT_FROM             = 62,
1941:   /* MATOP_PLACEHOLDER_63=63 */
1942:   MATOP_MATMAT_MULT_SYMBOLIC    = 64,
1943:   MATOP_MATMAT_MULT_NUMERIC     = 65,
1944:   MATOP_SET_LOCAL_TO_GLOBAL_MAP = 66,
1945:   MATOP_SET_VALUES_LOCAL        = 67,
1946:   MATOP_ZERO_ROWS_LOCAL         = 68,
1947:   MATOP_GET_ROW_MAX_ABS         = 69,
1948:   MATOP_GET_ROW_MIN_ABS         = 70,
1949:   MATOP_CONVERT                 = 71,
1950:   MATOP_HAS_OPERATION           = 72,
1951:   /* MATOP_PLACEHOLDER_73=73, */
1952:   MATOP_SET_VALUES_ADIFOR = 74,
1953:   MATOP_FD_COLORING_APPLY = 75,
1954:   MATOP_SET_FROM_OPTIONS  = 76,
1955:   /* MATOP_PLACEHOLDER_77=77, */
1956:   /* MATOP_PLACEHOLDER_78=78, */
1957:   MATOP_FIND_ZERO_DIAGONALS       = 79,
1958:   MATOP_MULT_MULTIPLE             = 80,
1959:   MATOP_SOLVE_MULTIPLE            = 81,
1960:   MATOP_GET_INERTIA               = 82,
1961:   MATOP_LOAD                      = 83,
1962:   MATOP_IS_SYMMETRIC              = 84,
1963:   MATOP_IS_HERMITIAN              = 85,
1964:   MATOP_IS_STRUCTURALLY_SYMMETRIC = 86,
1965:   MATOP_SET_VALUES_BLOCKEDLOCAL   = 87,
1966:   MATOP_CREATE_VECS               = 88,
1967:   /* MATOP_PLACEHOLDER_89=89, */
1968:   MATOP_MAT_MULT_SYMBOLIC = 90,
1969:   MATOP_MAT_MULT_NUMERIC  = 91,
1970:   /* MATOP_PLACEHOLDER_92=92, */
1971:   MATOP_PTAP_SYMBOLIC = 93,
1972:   MATOP_PTAP_NUMERIC  = 94,
1973:   /* MATOP_PLACEHOLDER_95=95, */
1974:   MATOP_MAT_TRANSPOSE_MULT_SYMBO = 96,
1975:   MATOP_MAT_TRANSPOSE_MULT_NUMER = 97,
1976:   MATOP_BIND_TO_CPU              = 98,
1977:   MATOP_PRODUCTSETFROMOPTIONS    = 99,
1978:   MATOP_PRODUCTSYMBOLIC          = 100,
1979:   MATOP_PRODUCTNUMERIC           = 101,
1980:   MATOP_CONJUGATE                = 102,
1981:   MATOP_VIEW_NATIVE              = 103,
1982:   MATOP_SET_VALUES_ROW           = 104,
1983:   MATOP_REAL_PART                = 105,
1984:   MATOP_IMAGINARY_PART           = 106,
1985:   MATOP_GET_ROW_UPPER_TRIANGULAR = 107,
1986:   MATOP_RESTORE_ROW_UPPER_TRIANG = 108,
1987:   MATOP_MAT_SOLVE                = 109,
1988:   MATOP_MAT_SOLVE_TRANSPOSE      = 110,
1989:   MATOP_GET_ROW_MIN              = 111,
1990:   MATOP_GET_COLUMN_VECTOR        = 112,
1991:   MATOP_MISSING_DIAGONAL         = 113,
1992:   MATOP_GET_SEQ_NONZERO_STRUCTUR = 114,
1993:   MATOP_CREATE                   = 115,
1994:   MATOP_GET_GHOSTS               = 116,
1995:   MATOP_GET_LOCAL_SUB_MATRIX     = 117,
1996:   MATOP_RESTORE_LOCALSUB_MATRIX  = 118,
1997:   MATOP_MULT_DIAGONAL_BLOCK      = 119,
1998:   MATOP_HERMITIAN_TRANSPOSE      = 120,
1999:   MATOP_MULT_HERMITIAN_TRANSPOSE = 121,
2000:   MATOP_MULT_HERMITIAN_TRANS_ADD = 122,
2001:   MATOP_GET_MULTI_PROC_BLOCK     = 123,
2002:   MATOP_FIND_NONZERO_ROWS        = 124,
2003:   MATOP_GET_COLUMN_NORMS         = 125,
2004:   MATOP_INVERT_BLOCK_DIAGONAL    = 126,
2005:   MATOP_INVERT_VBLOCK_DIAGONAL   = 127,
2006:   MATOP_CREATE_SUB_MATRICES_MPI  = 128,
2007:   MATOP_SET_VALUES_BATCH         = 129,
2008:   /* MATOP_PLACEHOLDER_130=130, */
2009:   MATOP_TRANSPOSE_MAT_MULT_SYMBO = 131,
2010:   MATOP_TRANSPOSE_MAT_MULT_NUMER = 132,
2011:   MATOP_TRANSPOSE_COLORING_CREAT = 133,
2012:   MATOP_TRANS_COLORING_APPLY_SPT = 134,
2013:   MATOP_TRANS_COLORING_APPLY_DEN = 135,
2014:   /* MATOP_PLACEHOLDER_136=136, */
2015:   MATOP_RART_SYMBOLIC         = 137,
2016:   MATOP_RART_NUMERIC          = 138,
2017:   MATOP_SET_BLOCK_SIZES       = 139,
2018:   MATOP_AYPX                  = 140,
2019:   MATOP_RESIDUAL              = 141,
2020:   MATOP_FDCOLORING_SETUP      = 142,
2021:   MATOP_FIND_OFFBLOCK_ENTRIES = 143,
2022:   MATOP_MPICONCATENATESEQ     = 144,
2023:   MATOP_DESTROYSUBMATRICES    = 145,
2024:   MATOP_TRANSPOSE_SOLVE       = 146,
2025:   MATOP_GET_VALUES_LOCAL      = 147
2026: } MatOperation;
2027: PETSC_EXTERN PetscErrorCode MatSetOperation(Mat, MatOperation, void (*)(void));
2028: PETSC_EXTERN PetscErrorCode MatGetOperation(Mat, MatOperation, void (**)(void));
2029: PETSC_EXTERN PetscErrorCode MatHasOperation(Mat, MatOperation, PetscBool *);
2030: PETSC_EXTERN PetscErrorCode MatHasCongruentLayouts(Mat, PetscBool *);
2031: PETSC_DEPRECATED_FUNCTION(3, 14, 0, "MatProductClear()", ) static inline PetscErrorCode MatFreeIntermediateDataStructures(Mat A)
2032: {
2033:   return MatProductClear(A);
2034: }
2035: PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat, MatOperation, void (*)(void));
2036: PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat, MatOperation, void (**)(void));
2037: PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat, void *);
2038: PETSC_EXTERN PetscErrorCode MatShellSetContextDestroy(Mat, PetscErrorCode (*)(void *));
2039: PETSC_EXTERN PetscErrorCode MatShellSetVecType(Mat, VecType);
2040: PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat, PetscErrorCode (*)(void *, Vec, Vec), Vec, void *, PetscBool *);
2041: PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat, PetscErrorCode (*)(void *, Vec, Vec), Vec, void *, PetscBool *);
2042: PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat);
2043: PETSC_EXTERN PetscErrorCode MatShellSetMatProductOperation(Mat, MatProductType, PetscErrorCode (*)(Mat, Mat, Mat, void **), PetscErrorCode (*)(Mat, Mat, Mat, void *), PetscErrorCode (*)(void *), MatType, MatType);
2044: PETSC_EXTERN PetscErrorCode MatIsShell(Mat, PetscBool *);

2046: /*
2047:    Codes for matrices stored on disk. By default they are
2048:    stored in a universal format. By changing the format with
2049:    PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
2050:    be stored in a way natural for the matrix, for example dense matrices
2051:    would be stored as dense. Matrices stored this way may only be
2052:    read into matrices of the same type.
2053: */
2054: #define MATRIX_BINARY_FORMAT_DENSE -1

2056: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat, PetscReal);

2058: PETSC_EXTERN PetscErrorCode MatISSetLocalMatType(Mat, MatType);
2059: PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[]);
2060: PETSC_EXTERN PetscErrorCode MatISSetAllowRepeated(Mat, PetscBool);
2061: PETSC_EXTERN PetscErrorCode MatISGetAllowRepeated(Mat, PetscBool *);
2062: PETSC_EXTERN PetscErrorCode MatISStoreL2L(Mat, PetscBool);
2063: PETSC_EXTERN PetscErrorCode MatISFixLocalEmpty(Mat, PetscBool);
2064: PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat, Mat *);
2065: PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat, Mat *);
2066: PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat, Mat);
2067: PETSC_EXTERN PetscErrorCode MatISGetLocalToGlobalMapping(Mat, ISLocalToGlobalMapping *, ISLocalToGlobalMapping *);

2069: /*S
2070:    MatNullSpace - Object that removes a null space from a vector, i.e.
2071:                   orthogonalizes the vector to a subspace

2073:    Level: advanced

2075: .seealso: [](ch_matrices), `Mat`, `MatNullSpaceCreate()`, `MatNullSpaceSetFunction()`, `MatGetNullSpace()`, `MatSetNullSpace()`
2076: S*/
2077: typedef struct _p_MatNullSpace *MatNullSpace;

2079: PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm, PetscBool, PetscInt, const Vec[], MatNullSpace *);
2080: PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace, PetscErrorCode (*)(MatNullSpace, Vec, void *), void *);
2081: PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace *);
2082: PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace, Vec);
2083: PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *);
2084: PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *);
2085: PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat, MatNullSpace);
2086: PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat, MatNullSpace);
2087: PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat, MatNullSpace);
2088: PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat, MatNullSpace *);
2089: PETSC_EXTERN PetscErrorCode MatGetNullSpaces(PetscInt, Mat[], MatNullSpace *[]);
2090: PETSC_EXTERN PetscErrorCode MatRestoreNullSpaces(PetscInt, Mat[], MatNullSpace *[]);
2091: PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace, Mat, PetscBool *);
2092: PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace, PetscViewer);
2093: PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace, PetscBool *, PetscInt *, const Vec **);
2094: PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec, MatNullSpace *);

2096: PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat, IS);
2097: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat, PetscReal);
2098: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat, PetscInt *);

2100: PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat, PetscInt, Mat *);
2101: PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat, PetscInt, Mat *);
2102: PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat, Mat *);

2104: PETSC_EXTERN PetscErrorCode MatComputeOperator(Mat, MatType, Mat *);
2105: PETSC_EXTERN PetscErrorCode MatComputeOperatorTranspose(Mat, MatType, Mat *);

2107: PETSC_DEPRECATED_FUNCTION(3, 12, 0, "MatComputeOperator()", ) static inline PetscErrorCode MatComputeExplicitOperator(Mat A, Mat *B)
2108: {
2109:   return MatComputeOperator(A, PETSC_NULLPTR, B);
2110: }
2111: PETSC_DEPRECATED_FUNCTION(3, 12, 0, "MatComputeOperatorTranspose()", ) static inline PetscErrorCode MatComputeExplicitOperatorTranspose(Mat A, Mat *B)
2112: {
2113:   return MatComputeOperatorTranspose(A, PETSC_NULLPTR, B);
2114: }

2116: PETSC_EXTERN PetscErrorCode MatCreateKAIJ(Mat, PetscInt, PetscInt, const PetscScalar[], const PetscScalar[], Mat *);
2117: PETSC_EXTERN PetscErrorCode MatKAIJGetAIJ(Mat, Mat *);
2118: PETSC_EXTERN PetscErrorCode MatKAIJGetS(Mat, PetscInt *, PetscInt *, PetscScalar **);
2119: PETSC_EXTERN PetscErrorCode MatKAIJGetSRead(Mat, PetscInt *, PetscInt *, const PetscScalar **);
2120: PETSC_EXTERN PetscErrorCode MatKAIJRestoreS(Mat, PetscScalar **);
2121: PETSC_EXTERN PetscErrorCode MatKAIJRestoreSRead(Mat, const PetscScalar **);
2122: PETSC_EXTERN PetscErrorCode MatKAIJGetT(Mat, PetscInt *, PetscInt *, PetscScalar **);
2123: PETSC_EXTERN PetscErrorCode MatKAIJGetTRead(Mat, PetscInt *, PetscInt *, const PetscScalar **);
2124: PETSC_EXTERN PetscErrorCode MatKAIJRestoreT(Mat, PetscScalar **);
2125: PETSC_EXTERN PetscErrorCode MatKAIJRestoreTRead(Mat, const PetscScalar **);
2126: PETSC_EXTERN PetscErrorCode MatKAIJSetAIJ(Mat, Mat);
2127: PETSC_EXTERN PetscErrorCode MatKAIJSetS(Mat, PetscInt, PetscInt, const PetscScalar[]);
2128: PETSC_EXTERN PetscErrorCode MatKAIJSetT(Mat, PetscInt, PetscInt, const PetscScalar[]);
2129: PETSC_EXTERN PetscErrorCode MatKAIJGetScaledIdentity(Mat, PetscBool *);

2131: PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat, Vec);

2133: PETSC_EXTERN PetscErrorCode MatMFFDInitializePackage(void);
2134: PETSC_EXTERN PetscErrorCode MatMFFDFinalizePackage(void);

2136: PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, Mat *);
2137: PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat, Vec, Vec);
2138: PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat, PetscErrorCode (*)(void *, Vec, Vec), void *);
2139: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat, PetscErrorCode (*)(void *, PetscInt, Vec, PetscScalar *));
2140: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat, PetscErrorCode (*)(void *, Vec));
2141: PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat, PetscScalar[], PetscInt);
2142: PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
2143: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat, PetscReal);
2144: PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat, PetscInt);
2145: PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat, PetscScalar *);
2146: PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat, const char[]);
2147: PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void *, Vec, Vec, PetscScalar *);
2148: PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat, PetscErrorCode (*)(void *, Vec, Vec, PetscScalar *), void *);

2150: /*S
2151:     MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free
2152:               Jacobian vector products

2154:     Level: developer

2156:     Notes:
2157:     `MATMFFD` is a specific `MatType` which uses the `MatMFFD` data structure

2159:      MatMFFD*() methods actually take the `Mat` as their first argument. Not a `MatMFFD` data structure

2161:     This functionality is often obtained using `MatCreateSNESMF()` or with `SNES` solvers using `-snes_mf` or `-snes_mf_operator`

2163: .seealso: [](ch_matrices), `MatMFFDType`, `MATMFFD`, `MatCreateMFFD()`, `MatMFFDSetFuction()`, `MatMFFDSetType()`, `MatMFFDRegister()`,
2164:           `MatCreateSNESMF()`, `SNES`, `-snes_mf`, `-snes_mf_operator`
2165: S*/
2166: typedef struct _p_MatMFFD *MatMFFD;

2168: /*J
2169:    MatMFFDType - algorithm used to compute the `h` used in computing matrix-vector products via differencing of a function

2171:    Values:
2172: +   `MATMFFD_DS` - an algorithm described by Dennis and Schnabel {cite}`dennis:83`
2173: -   `MATMFFD_WP` - the Walker-Pernice {cite}`pw98` strategy.

2175:    Level: beginner

2177: .seealso: [](ch_matrices), `MatMFFDSetType()`, `MatMFFDRegister()`, `MatMFFDSetFunction()`, `MatCreateMFFD()`
2178: J*/
2179: typedef const char *MatMFFDType;
2180: #define MATMFFD_DS "ds"
2181: #define MATMFFD_WP "wp"

2183: PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat, MatMFFDType);
2184: PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[], PetscErrorCode (*)(MatMFFD));

2186: PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat, PetscReal);
2187: PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat, PetscBool);

2189: PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring, MatMFFDType);

2191: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
2192: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);

2194: #ifdef PETSC_HAVE_H2OPUS
2195: PETSC_EXTERN_TYPEDEF typedef PetscScalar(MatH2OpusKernelFn)(PetscInt, PetscReal[], PetscReal[], void *);
2196: PETSC_EXTERN_TYPEDEF typedef MatH2OpusKernelFn *MatH2OpusKernel;
2197: PETSC_EXTERN PetscErrorCode                     MatCreateH2OpusFromKernel(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscReal[], PetscBool, MatH2OpusKernelFn *, void *, PetscReal, PetscInt, PetscInt, Mat *);
2198: PETSC_EXTERN PetscErrorCode                     MatCreateH2OpusFromMat(Mat, PetscInt, const PetscReal[], PetscBool, PetscReal, PetscInt, PetscInt, PetscInt, PetscReal, Mat *);
2199: PETSC_EXTERN PetscErrorCode                     MatH2OpusSetSamplingMat(Mat, Mat, PetscInt, PetscReal);
2200: PETSC_EXTERN PetscErrorCode                     MatH2OpusOrthogonalize(Mat);
2201: PETSC_EXTERN PetscErrorCode                     MatH2OpusCompress(Mat, PetscReal);
2202: PETSC_EXTERN PetscErrorCode                     MatH2OpusSetNativeMult(Mat, PetscBool);
2203: PETSC_EXTERN PetscErrorCode                     MatH2OpusGetNativeMult(Mat, PetscBool *);
2204: PETSC_EXTERN PetscErrorCode                     MatH2OpusGetIndexMap(Mat, IS *);
2205: PETSC_EXTERN PetscErrorCode                     MatH2OpusMapVec(Mat, PetscBool, Vec, Vec *);
2206: PETSC_EXTERN PetscErrorCode                     MatH2OpusLowRankUpdate(Mat, Mat, Mat, PetscScalar);
2207: #endif

2209: #ifdef PETSC_HAVE_HTOOL
2210: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode(MatHtoolKernelFn)(PetscInt, PetscInt, PetscInt, const PetscInt *, const PetscInt *, PetscScalar *, void *);
2211: PETSC_EXTERN_TYPEDEF typedef MatHtoolKernelFn *MatHtoolKernel;
2212: PETSC_EXTERN PetscErrorCode                    MatCreateHtoolFromKernel(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscReal[], const PetscReal[], MatHtoolKernelFn *, void *, Mat *);
2213: PETSC_EXTERN PetscErrorCode                    MatHtoolSetKernel(Mat, MatHtoolKernelFn *, void *);
2214: PETSC_EXTERN PetscErrorCode                    MatHtoolGetPermutationSource(Mat, IS *);
2215: PETSC_EXTERN PetscErrorCode                    MatHtoolGetPermutationTarget(Mat, IS *);
2216: PETSC_EXTERN PetscErrorCode                    MatHtoolUsePermutation(Mat, PetscBool);

2218: /*E
2219:    MatHtoolCompressorType - Indicates the type of compressor used by a `MATHTOOL`

2221:    Values:
2222: +  `MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA` (default) - symmetric partial adaptive cross approximation
2223: .  `MAT_HTOOL_COMPRESSOR_FULL_ACA`                 - full adaptive cross approximation
2224: -  `MAT_HTOOL_COMPRESSOR_SVD`                      - singular value decomposition

2226:    Level: intermediate

2228: .seealso: [](ch_matrices), `Mat`, `MatCreateHtoolFromKernel()`, `MATHTOOL`, `MatHtoolClusteringType`
2229: E*/
2230: typedef enum {
2231:   MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA,
2232:   MAT_HTOOL_COMPRESSOR_FULL_ACA,
2233:   MAT_HTOOL_COMPRESSOR_SVD
2234: } MatHtoolCompressorType;

2236: /*E
2237:    MatHtoolClusteringType - Indicates the type of clustering used by a `MATHTOOL`

2239:    Values:
2240: +  `MAT_HTOOL_CLUSTERING_PCA_REGULAR` (default)    - axis computed via principle component analysis, split uniformly
2241: .  `MAT_HTOOL_CLUSTERING_PCA_GEOMETRIC`            - axis computed via principle component analysis, split barycentrically
2242: .  `MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_REGULAR`   - axis along the largest extent of the bounding box, split uniformly
2243: -  `MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_GEOMETRIC` - axis along the largest extent of the bounding box, split barycentrically

2245:    Level: intermediate

2247:    Note:
2248:    Higher-dimensional clustering is not yet supported in Htool, but once it is, one should add BOUNDING_BOX_{2,3} types

2250: .seealso: [](ch_matrices), `Mat`, `MatCreateHtoolFromKernel()`, `MATHTOOL`, `MatHtoolCompressorType`
2251: E*/
2252: typedef enum {
2253:   MAT_HTOOL_CLUSTERING_PCA_REGULAR,
2254:   MAT_HTOOL_CLUSTERING_PCA_GEOMETRIC,
2255:   MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_REGULAR,
2256:   MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_GEOMETRIC
2257: } MatHtoolClusteringType;
2258: #endif

2260: #ifdef PETSC_HAVE_MUMPS
2261: PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat, PetscInt, PetscInt);
2262: PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat, PetscInt, PetscInt *);
2263: PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat, PetscInt, PetscReal);
2264: PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat, PetscInt, PetscReal *);

2266: PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat, PetscInt, PetscInt *);
2267: PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat, PetscInt, PetscInt *);
2268: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat, PetscInt, PetscReal *);
2269: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat, PetscInt, PetscReal *);
2270: PETSC_EXTERN PetscErrorCode MatMumpsGetNullPivots(Mat, PetscInt *, PetscInt **);
2271: PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat, Mat);
2272: PETSC_EXTERN PetscErrorCode MatMumpsGetInverseTranspose(Mat, Mat);
2273: #endif

2275: #ifdef PETSC_HAVE_MKL_PARDISO
2276: PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat, PetscInt, PetscInt);
2277: #endif

2279: #ifdef PETSC_HAVE_MKL_CPARDISO
2280: PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat, PetscInt, PetscInt);
2281: #endif

2283: #ifdef PETSC_HAVE_SUPERLU
2284: PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat, PetscReal);
2285: #endif

2287: #ifdef PETSC_HAVE_SUPERLU_DIST
2288: PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat, PetscScalar *);
2289: #endif

2291: #ifdef PETSC_HAVE_STRUMPACK
2292: /*E
2293:     MatSTRUMPACKReordering - sparsity reducing ordering to be used in `MATSOLVERSTRUMPACK`

2295:     Values:
2296: +  `MAT_STRUMPACK_NATURAL`   - use the current ordering
2297: .  `MAT_STRUMPACK_METIS`     - use MeTis to compute an ordering
2298: .  `MAT_STRUMPACK_PARMETIS`  - use ParMeTis to compute an ordering
2299: .  `MAT_STRUMPACK_SCOTCH`    - use Scotch to compute an ordering
2300: .  `MAT_STRUMPACK_PTSCOTCH`  - use parallel Scotch to compute an ordering
2301: .  `MAT_STRUMPACK_RCM`       - use an RCM ordering
2302: .  `MAT_STRUMPACK_GEOMETRIC` - use a geometric ordering (needs mesh info from user)
2303: .  `MAT_STRUMPACK_AMD`       - approximate minimum degree
2304: .  `MAT_STRUMPACK_MMD`       - multiple minimum degree
2305: .  `MAT_STRUMPACK_AND`       - approximate nested dissection
2306: .  `MAT_STRUMPACK_MLF`       - minimum local fill
2307: -  `MAT_STRUMPACK_SPECTRAL`  - spectral nested dissection

2309:     Level: intermediate

2311:     Developer Note:
2312:     Should be called `MatSTRUMPACKReorderingType`

2314: .seealso: `Mat`, `MATSOLVERSTRUMPACK`, `MatGetFactor()`, `MatSTRUMPACKSetReordering()`
2315: E*/
2316: typedef enum {
2317:   MAT_STRUMPACK_NATURAL,
2318:   MAT_STRUMPACK_METIS,
2319:   MAT_STRUMPACK_PARMETIS,
2320:   MAT_STRUMPACK_SCOTCH,
2321:   MAT_STRUMPACK_PTSCOTCH,
2322:   MAT_STRUMPACK_RCM,
2323:   MAT_STRUMPACK_GEOMETRIC,
2324:   MAT_STRUMPACK_AMD,
2325:   MAT_STRUMPACK_MMD,
2326:   MAT_STRUMPACK_AND,
2327:   MAT_STRUMPACK_MLF,
2328:   MAT_STRUMPACK_SPECTRAL
2329: } MatSTRUMPACKReordering;

2331: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat, MatSTRUMPACKReordering);
2332: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetReordering(Mat, MatSTRUMPACKReordering *);
2333: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetGeometricNxyz(Mat, PetscInt, PetscInt, PetscInt);
2334: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetGeometricComponents(Mat, PetscInt);
2335: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetGeometricWidth(Mat, PetscInt);
2336: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat, PetscBool);
2337: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetColPerm(Mat, PetscBool *);
2338: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetGPU(Mat, PetscBool);
2339: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetGPU(Mat, PetscBool *);

2341: /*E
2342:     MatSTRUMPACKCompressionType - Compression used in the approximate sparse factorization solver `MATSOLVERSTRUMPACK`

2344:     Values:
2345: +  `MAT_STRUMPACK_COMPRESSION_TYPE_NONE`          - no compression, direct solver
2346: .  `MAT_STRUMPACK_COMPRESSION_TYPE_HSS`           - hierarchically semi-separable
2347: .  `MAT_STRUMPACK_COMPRESSION_TYPE_BLR`           - block low rank
2348: .  `MAT_STRUMPACK_COMPRESSION_TYPE_HODLR`         - hierarchically off-diagonal low rank (requires ButterfyPACK support, configure with --download-butterflypack)
2349: .  `MAT_STRUMPACK_COMPRESSION_TYPE_BLR_HODLR`     - hybrid of BLR and HODLR (requires ButterfyPACK support, configure with --download-butterflypack)
2350: .  `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)
2351: .  `MAT_STRUMPACK_COMPRESSION_TYPE_LOSSLESS`      - lossless compression (requires ZFP support, configure with --download-zfp)
2352: -  `MAT_STRUMPACK_COMPRESSION_TYPE_LOSSY`         - lossy compression (requires ZFP support, configure with --download-zfp)

2354:     Level: intermediate

2356: .seealso: `Mat`, `MATSOLVERSTRUMPACK`, `MatGetFactor()`, `MatSTRUMPACKSetCompression()`
2357: E*/
2358: typedef enum {
2359:   MAT_STRUMPACK_COMPRESSION_TYPE_NONE,
2360:   MAT_STRUMPACK_COMPRESSION_TYPE_HSS,
2361:   MAT_STRUMPACK_COMPRESSION_TYPE_BLR,
2362:   MAT_STRUMPACK_COMPRESSION_TYPE_HODLR,
2363:   MAT_STRUMPACK_COMPRESSION_TYPE_BLR_HODLR,
2364:   MAT_STRUMPACK_COMPRESSION_TYPE_ZFP_BLR_HODLR,
2365:   MAT_STRUMPACK_COMPRESSION_TYPE_LOSSLESS,
2366:   MAT_STRUMPACK_COMPRESSION_TYPE_LOSSY
2367: } MatSTRUMPACKCompressionType;

2369: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompression(Mat, MatSTRUMPACKCompressionType);
2370: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompression(Mat, MatSTRUMPACKCompressionType *);
2371: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompRelTol(Mat, PetscReal);
2372: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompRelTol(Mat, PetscReal *);
2373: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompAbsTol(Mat, PetscReal);
2374: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompAbsTol(Mat, PetscReal *);
2375: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompMinSepSize(Mat, PetscInt);
2376: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompMinSepSize(Mat, PetscInt *);
2377: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompLeafSize(Mat, PetscInt);
2378: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompLeafSize(Mat, PetscInt *);
2379: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompLossyPrecision(Mat, PetscInt);
2380: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompLossyPrecision(Mat, PetscInt *);
2381: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompButterflyLevels(Mat, PetscInt);
2382: PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompButterflyLevels(Mat, PetscInt *);
2383: #endif

2385: PETSC_EXTERN PetscErrorCode MatBindToCPU(Mat, PetscBool);
2386: PETSC_EXTERN PetscErrorCode MatBoundToCPU(Mat, PetscBool *);
2387: PETSC_DEPRECATED_FUNCTION(3, 13, 0, "MatBindToCPU()", ) static inline PetscErrorCode MatPinToCPU(Mat A, PetscBool flg)
2388: {
2389:   return MatBindToCPU(A, flg);
2390: }
2391: PETSC_EXTERN PetscErrorCode MatSetBindingPropagates(Mat, PetscBool);
2392: PETSC_EXTERN PetscErrorCode MatGetBindingPropagates(Mat, PetscBool *);

2394: #ifdef PETSC_HAVE_CUDA
2395: /*E
2396:     MatCUSPARSEStorageFormat - indicates the storage format for `MATAIJCUSPARSE` (GPU)
2397:     matrices.

2399:     Values:
2400: +   `MAT_CUSPARSE_CSR` - Compressed Sparse Row
2401: .   `MAT_CUSPARSE_ELL` - Ellpack (requires CUDA 4.2 or later).
2402: -   `MAT_CUSPARSE_HYB` - Hybrid, a combination of Ellpack and Coordinate format (requires CUDA 4.2 or later).

2404:     Level: intermediate

2406: .seealso: [](ch_matrices), `MATAIJCUSPARSE`, `MatCUSPARSESetFormat()`, `MatCUSPARSEFormatOperation`
2407: E*/

2409: typedef enum {
2410:   MAT_CUSPARSE_CSR,
2411:   MAT_CUSPARSE_ELL,
2412:   MAT_CUSPARSE_HYB
2413: } MatCUSPARSEStorageFormat;

2415: /* these will be strings associated with enumerated type defined above */
2416: PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[];

2418: /*E
2419:     MatCUSPARSEFormatOperation - indicates the operation of `MATAIJCUSPARSE` (GPU)
2420:     matrices whose operation should use a particular storage format.

2422:     Values:
2423: +   `MAT_CUSPARSE_MULT_DIAG`    - sets the storage format for the diagonal matrix in the parallel `MatMult()`
2424: .   `MAT_CUSPARSE_MULT_OFFDIAG` - sets the storage format for the off-diagonal matrix in the parallel `MatMult()`
2425: .   `MAT_CUSPARSE_MULT`         - sets the storage format for the entire matrix in the serial (single GPU) `MatMult()`
2426: -   `MAT_CUSPARSE_ALL`          - sets the storage format for all `MATAIJCUSPARSE` (GPU) matrices

2428:     Level: intermediate

2430: .seealso: [](ch_matrices), `MatCUSPARSESetFormat()`, `MatCUSPARSEStorageFormat`
2431: E*/
2432: typedef enum {
2433:   MAT_CUSPARSE_MULT_DIAG,
2434:   MAT_CUSPARSE_MULT_OFFDIAG,
2435:   MAT_CUSPARSE_MULT,
2436:   MAT_CUSPARSE_ALL
2437: } MatCUSPARSEFormatOperation;

2439: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2440: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2441: PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat, MatCUSPARSEFormatOperation, MatCUSPARSEStorageFormat);
2442: PETSC_EXTERN PetscErrorCode MatCUSPARSESetUseCPUSolve(Mat, PetscBool);
2443: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetIJ(Mat, PetscBool, const int **, const int **);
2444: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreIJ(Mat, PetscBool, const int **, const int **);
2445: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArrayRead(Mat, const PetscScalar **);
2446: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArrayRead(Mat, const PetscScalar **);
2447: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArrayWrite(Mat, PetscScalar **);
2448: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArrayWrite(Mat, PetscScalar **);
2449: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArray(Mat, PetscScalar **);
2450: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArray(Mat, PetscScalar **);

2452: PETSC_EXTERN PetscErrorCode MatCreateDenseCUDA(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar[], Mat *);
2453: PETSC_EXTERN PetscErrorCode MatCreateSeqDenseCUDA(MPI_Comm, PetscInt, PetscInt, PetscScalar[], Mat *);
2454: PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayWrite(Mat, PetscScalar **);
2455: PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayRead(Mat, const PetscScalar **);
2456: PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArray(Mat, PetscScalar **);
2457: PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayWrite(Mat, PetscScalar **);
2458: PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayRead(Mat, const PetscScalar **);
2459: PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArray(Mat, PetscScalar **);
2460: PETSC_EXTERN PetscErrorCode MatDenseCUDAPlaceArray(Mat, const PetscScalar *);
2461: PETSC_EXTERN PetscErrorCode MatDenseCUDAReplaceArray(Mat, const PetscScalar *);
2462: PETSC_EXTERN PetscErrorCode MatDenseCUDAResetArray(Mat);
2463: PETSC_EXTERN PetscErrorCode MatDenseCUDASetPreallocation(Mat, PetscScalar *);

2465: PETSC_EXTERN PetscErrorCode MatCreateSeqSELLCUDA(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2466: PETSC_EXTERN PetscErrorCode MatCreateSELLCUDA(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2467: #endif

2469: #ifdef PETSC_HAVE_HIP
2470: /*E
2471:     MatHIPSPARSEStorageFormat - indicates the storage format for `MATAIJHIPSPARSE` (GPU)
2472:     matrices.

2474:     Values:
2475: +   `MAT_HIPSPARSE_CSR` - Compressed Sparse Row
2476: .   `MAT_HIPSPARSE_ELL` - Ellpack
2477: -   `MAT_HIPSPARSE_HYB` - Hybrid, a combination of Ellpack and Coordinate format

2479:     Level: intermediate

2481: .seealso: [](ch_matrices), `MatHIPSPARSESetFormat()`, `MatHIPSPARSEFormatOperation`
2482: E*/

2484: typedef enum {
2485:   MAT_HIPSPARSE_CSR,
2486:   MAT_HIPSPARSE_ELL,
2487:   MAT_HIPSPARSE_HYB
2488: } MatHIPSPARSEStorageFormat;

2490: /* these will be strings associated with enumerated type defined above */
2491: PETSC_EXTERN const char *const MatHIPSPARSEStorageFormats[];

2493: /*E
2494:     MatHIPSPARSEFormatOperation - indicates the operation of `MATAIJHIPSPARSE` (GPU)
2495:     matrices whose operation should use a particular storage format.

2497:     Values:
2498: +   `MAT_HIPSPARSE_MULT_DIAG`    - sets the storage format for the diagonal matrix in the parallel `MatMult()`
2499: .   `MAT_HIPSPARSE_MULT_OFFDIAG` - sets the storage format for the off-diagonal matrix in the parallel `MatMult()`
2500: .   `MAT_HIPSPARSE_MULT`         - sets the storage format for the entire matrix in the serial (single GPU) `MatMult()`
2501: -   `MAT_HIPSPARSE_ALL`          - sets the storage format for all HIPSPARSE (GPU) matrices

2503:     Level: intermediate

2505: .seealso: [](ch_matrices), `MatHIPSPARSESetFormat()`, `MatHIPSPARSEStorageFormat`
2506: E*/
2507: typedef enum {
2508:   MAT_HIPSPARSE_MULT_DIAG,
2509:   MAT_HIPSPARSE_MULT_OFFDIAG,
2510:   MAT_HIPSPARSE_MULT,
2511:   MAT_HIPSPARSE_ALL
2512: } MatHIPSPARSEFormatOperation;

2514: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJHIPSPARSE(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2515: PETSC_EXTERN PetscErrorCode MatCreateAIJHIPSPARSE(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2516: PETSC_EXTERN PetscErrorCode MatHIPSPARSESetFormat(Mat, MatHIPSPARSEFormatOperation, MatHIPSPARSEStorageFormat);
2517: PETSC_EXTERN PetscErrorCode MatHIPSPARSESetUseCPUSolve(Mat, PetscBool);
2518: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSEGetIJ(Mat, PetscBool, const int **, const int **);
2519: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSERestoreIJ(Mat, PetscBool, const int **, const int **);
2520: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSEGetArrayRead(Mat, const PetscScalar **);
2521: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSERestoreArrayRead(Mat, const PetscScalar **);
2522: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSEGetArrayWrite(Mat, PetscScalar **);
2523: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSERestoreArrayWrite(Mat, PetscScalar **);
2524: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSEGetArray(Mat, PetscScalar **);
2525: PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSERestoreArray(Mat, PetscScalar **);

2527: PETSC_EXTERN PetscErrorCode MatCreateDenseHIP(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar[], Mat *);
2528: PETSC_EXTERN PetscErrorCode MatCreateSeqDenseHIP(MPI_Comm, PetscInt, PetscInt, PetscScalar[], Mat *);
2529: PETSC_EXTERN PetscErrorCode MatDenseHIPGetArrayWrite(Mat, PetscScalar **);
2530: PETSC_EXTERN PetscErrorCode MatDenseHIPGetArrayRead(Mat, const PetscScalar **);
2531: PETSC_EXTERN PetscErrorCode MatDenseHIPGetArray(Mat, PetscScalar **);
2532: PETSC_EXTERN PetscErrorCode MatDenseHIPRestoreArrayWrite(Mat, PetscScalar **);
2533: PETSC_EXTERN PetscErrorCode MatDenseHIPRestoreArrayRead(Mat, const PetscScalar **);
2534: PETSC_EXTERN PetscErrorCode MatDenseHIPRestoreArray(Mat, PetscScalar **);
2535: PETSC_EXTERN PetscErrorCode MatDenseHIPPlaceArray(Mat, const PetscScalar *);
2536: PETSC_EXTERN PetscErrorCode MatDenseHIPReplaceArray(Mat, const PetscScalar *);
2537: PETSC_EXTERN PetscErrorCode MatDenseHIPResetArray(Mat);
2538: PETSC_EXTERN PetscErrorCode MatDenseHIPSetPreallocation(Mat, PetscScalar *);
2539: PETSC_EXTERN PetscErrorCode MatCreateSeqSELLHIP(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2540: PETSC_EXTERN PetscErrorCode MatCreateSELLHIP(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2541: #endif

2543: #if defined(PETSC_HAVE_VIENNACL)
2544: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2545: PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2546: #endif

2548: #if PetscDefined(HAVE_KOKKOS)
2549: PETSC_EXTERN PetscErrorCode MatCreateAIJKokkos(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *);
2550: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJKokkos(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *);
2551: #endif

2553: #if defined(PETSC_HAVE_FFTW)
2554: PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat, Vec, Vec);
2555: PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat, Vec, Vec);
2556: PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat, Vec *, Vec *, Vec *);
2557: #endif

2559: #if defined(PETSC_HAVE_SCALAPACK)
2560: PETSC_EXTERN PetscErrorCode MatCreateScaLAPACK(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, Mat *);
2561: PETSC_EXTERN PetscErrorCode MatScaLAPACKSetBlockSizes(Mat, PetscInt, PetscInt);
2562: PETSC_EXTERN PetscErrorCode MatScaLAPACKGetBlockSizes(Mat, PetscInt *, PetscInt *);
2563: #endif

2565: PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm, PetscInt, const IS[], PetscInt, const IS[], const Mat[], Mat *);
2566: PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat, PetscInt *, PetscInt *);
2567: PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat, IS[], IS[]);
2568: PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat, IS[], IS[]);
2569: PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat, PetscInt *, PetscInt *, Mat ***);
2570: PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat, PetscInt, PetscInt, Mat *);
2571: PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat, VecType);
2572: PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat, PetscInt, const IS[], PetscInt, const IS[], const Mat[]);
2573: PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat, PetscInt, PetscInt, Mat);

2575: PETSC_EXTERN PetscErrorCode MatFilter(Mat, PetscReal, PetscBool, PetscBool);
2576: PETSC_DEPRECATED_FUNCTION(3, 20, 0, "MatFilter()", ) static inline PetscErrorCode MatChop(Mat A, PetscReal tol)
2577: {
2578:   return MatFilter(A, tol, PETSC_FALSE, PETSC_FALSE);
2579: }
2580: PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat, PetscReal, PetscInt *);

2582: PETSC_EXTERN PetscErrorCode MatSubdomainsCreateCoalesce(Mat, PetscInt, PetscInt *, IS **);

2584: PETSC_EXTERN PetscErrorCode MatPreallocatorPreallocate(Mat, PetscBool, Mat);

2586: PETSC_EXTERN PetscErrorCode MatHeaderMerge(Mat, Mat *);
2587: PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat, Mat *);

2589: PETSC_EXTERN PetscErrorCode MatSeqAIJGetCSRAndMemType(Mat, const PetscInt **, const PetscInt **, PetscScalar **, PetscMemType *);

2591: PETSC_EXTERN PetscErrorCode MatCreateGraph(Mat, PetscBool, PetscBool, PetscReal, PetscInt, PetscInt[], Mat *);
2592: PETSC_EXTERN PetscErrorCode MatEliminateZeros(Mat, PetscBool);

2594: PETSC_EXTERN PetscErrorCode MatCreateDenseFromVecType(MPI_Comm, VecType, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar *, Mat *);

2596: PETSC_EXTERN PetscErrorCode MatSetHPL(Mat, int);
2597: #define PETSCBMHPL "hpl"