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