Actual source code: petscmat.h
petsc-3.9.4 2018-09-11
1: /*
2: Include file for the matrix component of PETSc
3: */
4: #ifndef __PETSCMAT_H
6: #include <petscvec.h>
8: /*S
9: Mat - Abstract PETSc matrix object used to manage all linear operators in PETSc, even those without
10: an explicit sparse representation (such as matrix-free operators)
12: Level: beginner
14: Concepts: matrix; linear operator
16: .seealso: MatCreate(), MatType, MatSetType(), MatDestroy()
17: S*/
18: typedef struct _p_Mat* Mat;
20: /*J
21: MatType - String with the name of a PETSc matrix type
23: Level: beginner
25: .seealso: MatSetType(), Mat, MatSolverType, MatRegister()
26: J*/
27: typedef const char* MatType;
28: #define MATSAME "same"
29: #define MATMAIJ "maij"
30: #define MATSEQMAIJ "seqmaij"
31: #define MATMPIMAIJ "mpimaij"
32: #define MATIS "is"
33: #define MATAIJ "aij"
34: #define MATSEQAIJ "seqaij"
35: #define MATMPIAIJ "mpiaij"
36: #define MATAIJCRL "aijcrl"
37: #define MATSEQAIJCRL "seqaijcrl"
38: #define MATMPIAIJCRL "mpiaijcrl"
39: #define MATAIJCUSPARSE "aijcusparse"
40: #define MATSEQAIJCUSPARSE "seqaijcusparse"
41: #define MATMPIAIJCUSPARSE "mpiaijcusparse"
42: #define MATAIJVIENNACL "aijviennacl"
43: #define MATSEQAIJVIENNACL "seqaijviennacl"
44: #define MATMPIAIJVIENNACL "mpiaijviennacl"
45: #define MATAIJPERM "aijperm"
46: #define MATSEQAIJPERM "seqaijperm"
47: #define MATMPIAIJPERM "mpiaijperm"
48: #define MATAIJMKL "aijmkl"
49: #define MATSEQAIJMKL "seqaijmkl"
50: #define MATMPIAIJMKL "mpiaijmkl"
51: #define MATBAIJMKL "baijmkl"
52: #define MATSEQBAIJMKL "seqbaijmkl"
53: #define MATMPIBAIJMKL "mpibaijmkl"
54: #define MATSHELL "shell"
55: #define MATDENSE "dense"
56: #define MATSEQDENSE "seqdense"
57: #define MATMPIDENSE "mpidense"
58: #define MATELEMENTAL "elemental"
59: #define MATBAIJ "baij"
60: #define MATSEQBAIJ "seqbaij"
61: #define MATMPIBAIJ "mpibaij"
62: #define MATMPIADJ "mpiadj"
63: #define MATSBAIJ "sbaij"
64: #define MATSEQSBAIJ "seqsbaij"
65: #define MATMPISBAIJ "mpisbaij"
66: #define MATDAAD "daad"
67: #define MATMFFD "mffd"
68: #define MATNORMAL "normal"
69: #define MATNORMALHERMITIAN "normalh"
70: #define MATLRC "lrc"
71: #define MATSCATTER "scatter"
72: #define MATBLOCKMAT "blockmat"
73: #define MATCOMPOSITE "composite"
74: #define MATFFT "fft"
75: #define MATFFTW "fftw"
76: #define MATSEQCUFFT "seqcufft"
77: #define MATTRANSPOSEMAT "transpose"
78: #define MATSCHURCOMPLEMENT "schurcomplement"
79: #define MATPYTHON "python"
80: #define MATHYPRE "hypre"
81: #define MATHYPRESTRUCT "hyprestruct"
82: #define MATHYPRESSTRUCT "hypresstruct"
83: #define MATSUBMATRIX "submatrix"
84: #define MATLOCALREF "localref"
85: #define MATNEST "nest"
86: #define MATPREALLOCATOR "preallocator"
87: #define MATSELL "sell"
88: #define MATSEQSELL "seqsell"
89: #define MATMPISELL "mpisell"
90: #define MATDUMMY "dummy"
92: /*J
93: MatSolverType - String with the name of a PETSc matrix solver type.
95: For example: "petsc" indicates what PETSc provides, "superlu_dist" the parallel SuperLU_DIST package etc
97: Level: beginner
99: .seealso: MatGetFactor(), Mat, MatSetType(), MatType
100: J*/
101: typedef const char* MatSolverType;
102: #define MATSOLVERSUPERLU "superlu"
103: #define MATSOLVERSUPERLU_DIST "superlu_dist"
104: #define MATSOLVERSTRUMPACK "strumpack"
105: #define MATSOLVERUMFPACK "umfpack"
106: #define MATSOLVERCHOLMOD "cholmod"
107: #define MATSOLVERKLU "klu"
108: #define MATSOLVERSPARSEELEMENTAL "sparseelemental"
109: #define MATSOLVERELEMENTAL "elemental"
110: #define MATSOLVERESSL "essl"
111: #define MATSOLVERLUSOL "lusol"
112: #define MATSOLVERMUMPS "mumps"
113: #define MATSOLVERMKL_PARDISO "mkl_pardiso"
114: #define MATSOLVERMKL_CPARDISO "mkl_cpardiso"
115: #define MATSOLVERPASTIX "pastix"
116: #define MATSOLVERMATLAB "matlab"
117: #define MATSOLVERPETSC "petsc"
118: #define MATSOLVERBAS "bas"
119: #define MATSOLVERCUSPARSE "cusparse"
121: /*E
122: MatFactorType - indicates what type of factorization is requested
124: Level: beginner
126: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
128: .seealso: MatSolverType, MatGetFactor()
129: E*/
130: typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType;
131: PETSC_EXTERN const char *const MatFactorTypes[];
133: PETSC_EXTERN PetscErrorCode MatGetFactor(Mat,MatSolverType,MatFactorType,Mat*);
134: PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat,MatSolverType,MatFactorType,PetscBool *);
135: PETSC_EXTERN PetscErrorCode MatFactorGetSolverType(Mat,MatSolverType*);
136: PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat,MatFactorType*);
137: PETSC_EXTERN PetscErrorCode MatSolverTypeRegister(MatSolverType,const MatType,MatFactorType,PetscErrorCode(*)(Mat,MatFactorType,Mat*));
138: PETSC_EXTERN PetscErrorCode MatSolverTypeGet(MatSolverType,const MatType,MatFactorType,PetscBool*,PetscBool*,PetscErrorCode (**)(Mat,MatFactorType,Mat*));
139: typedef MatSolverType MatSolverPackage PETSC_DEPRECATED("Use MatSolverType");
140: PETSC_DEPRECATED("Use MatSolverTypeRegister()") PETSC_STATIC_INLINE PetscErrorCode MatSolverPackageRegister(MatSolverType stype,MatType mtype,MatFactorType ftype,PetscErrorCode(*f)(Mat,MatFactorType,Mat*))
141: { return MatSolverTypeRegister(stype,mtype,ftype,f); }
142: PETSC_DEPRECATED("Use MatSolverTypeGet()") PETSC_STATIC_INLINE PetscErrorCode MatSolverPackageGet(MatSolverType stype,MatType mtype,MatFactorType ftype,PetscBool *foundmtype,PetscBool *foundstype,PetscErrorCode(**f)(Mat,MatFactorType,Mat*))
143: { return MatSolverTypeGet(stype,mtype,ftype,foundmtype,foundstype,f); }
145: /* Logging support */
146: #define MAT_FILE_CLASSID 1211216 /* used to indicate matrices in binary files */
147: PETSC_EXTERN PetscClassId MAT_CLASSID;
148: PETSC_EXTERN PetscClassId MAT_COLORING_CLASSID;
149: PETSC_EXTERN PetscClassId MAT_FDCOLORING_CLASSID;
150: PETSC_EXTERN PetscClassId MAT_TRANSPOSECOLORING_CLASSID;
151: PETSC_EXTERN PetscClassId MAT_PARTITIONING_CLASSID;
152: PETSC_EXTERN PetscClassId MAT_COARSEN_CLASSID;
153: PETSC_EXTERN PetscClassId MAT_NULLSPACE_CLASSID;
154: PETSC_EXTERN PetscClassId MATMFFD_CLASSID;
156: /*E
157: MatReuse - Indicates if matrices obtained from a previous call to MatCreateSubMatrices(), MatCreateSubMatrix(), MatConvert() or several other functions
158: are to be reused to store the new matrix values.
160: $ MAT_INITIAL_MATRIX - create a new matrix
161: $ MAT_REUSE_MATRIX - reuse the matrix created with a previous call that used MAT_INITIAL_MATRIX
162: $ MAT_INPLACE_MATRIX - replace the first input matrix with the new matrix (not applicable to all functions)
163: $ MAT_IGNORE_MATRIX - do not create a new matrix or reuse a give matrix, just ignore that matrix argument (not applicable to all functions)
165: Level: beginner
167: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
169: .seealso: MatCreateSubMatrices(), MatCreateSubMatrix(), MatDestroyMatrices(), MatConvert()
170: E*/
171: typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX,MAT_INPLACE_MATRIX} MatReuse;
173: /*E
174: MatCreateSubMatrixOption - Indicates if matrices obtained from a call to MatCreateSubMatrices()
175: include the matrix values. Currently it is only used by MatGetSeqNonzerostructure().
177: Level: beginner
179: .seealso: MatGetSeqNonzerostructure()
180: E*/
181: typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatCreateSubMatrixOption;
183: PETSC_EXTERN PetscErrorCode MatInitializePackage(void);
185: PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm,Mat*);
186: PETSC_EXTERN PetscErrorCode MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
187: PETSC_EXTERN PetscErrorCode MatSetType(Mat,MatType);
188: PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat);
189: PETSC_STATIC_INLINE PetscErrorCode MatViewFromOptions(Mat A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
190: PETSC_EXTERN PetscErrorCode MatRegister(const char[],PetscErrorCode(*)(Mat));
191: PETSC_EXTERN PetscErrorCode MatRegisterBaseName(const char[],const char[],const char[]);
192: PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat,const char[]);
193: PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat,const char[]);
194: PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat,const char*[]);
195: PETSC_EXTERN PetscErrorCode MatSetErrorIfFailure(Mat,PetscBool);
197: PETSC_EXTERN PetscFunctionList MatList;
198: PETSC_EXTERN PetscFunctionList MatColoringList;
199: PETSC_EXTERN PetscFunctionList MatPartitioningList;
201: /*E
202: MatStructure - Indicates if two matrices have the same nonzero structure
204: Level: beginner
206: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
208: .seealso: MatCopy(), MatAXPY()
209: E*/
210: typedef enum {DIFFERENT_NONZERO_PATTERN,SUBSET_NONZERO_PATTERN,SAME_NONZERO_PATTERN} MatStructure;
212: #if defined PETSC_HAVE_MKL_SPARSE
213: PETSC_EXTERN PetscErrorCode MatCreateBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
214: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJMKL(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[],Mat *A);
215: #endif
216: PETSC_EXTERN PetscErrorCode MatCreateSeqSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
217: PETSC_EXTERN PetscErrorCode MatCreateSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
218: PETSC_EXTERN PetscErrorCode MatSeqSELLSetPreallocation(Mat,PetscInt,const PetscInt[]);
219: PETSC_EXTERN PetscErrorCode MatMPISELLSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
221: PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
222: PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
223: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
224: PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
225: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
226: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
227: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSeqAIJ(MPI_Comm,Mat,Mat,const PetscInt[],Mat*);
229: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
230: PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
231: PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*);
233: PETSC_EXTERN PetscErrorCode MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
234: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
236: PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
237: PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
238: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
239: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
240: PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],const PetscInt[]);
242: PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
243: PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat,Mat*);
244: PETSC_EXTERN PetscErrorCode MatCreateNormalHermitian(Mat,Mat*);
245: PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat,Mat,Vec,Mat,Mat*);
246: PETSC_EXTERN PetscErrorCode MatLRCGetMats(Mat,Mat*,Mat*,Vec*,Mat*);
247: PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,ISLocalToGlobalMapping,Mat*);
248: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
249: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
251: PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*);
252: PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter);
253: PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*);
254: PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
255: PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat,Mat);
256: PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat);
257: PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
258: typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
259: PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat,MatCompositeType);
261: PETSC_EXTERN PetscErrorCode MatCreateFFT(MPI_Comm,PetscInt,const PetscInt[],MatType,Mat*);
262: PETSC_EXTERN PetscErrorCode MatCreateSeqCUFFT(MPI_Comm,PetscInt,const PetscInt[],Mat*);
264: PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*);
265: PETSC_EXTERN PetscErrorCode MatTransposeGetMat(Mat,Mat*);
266: PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat,Mat*);
267: PETSC_EXTERN PetscErrorCode MatCreateSubMatrixVirtual(Mat,IS,IS,Mat*);
268: PETSC_EXTERN PetscErrorCode MatSubMatrixVirtualUpdate(Mat,Mat,IS,IS);
269: PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*);
271: #if defined(PETSC_HAVE_HYPRE)
272: PETSC_EXTERN PetscErrorCode MatHYPRESetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
273: #endif
275: PETSC_EXTERN PetscErrorCode MatPythonSetType(Mat,const char[]);
277: PETSC_EXTERN PetscErrorCode MatResetPreallocation(Mat);
278: PETSC_EXTERN PetscErrorCode MatSetUp(Mat);
279: PETSC_EXTERN PetscErrorCode MatDestroy(Mat*);
280: PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat,PetscObjectState*);
282: PETSC_EXTERN PetscErrorCode MatConjugate(Mat);
283: PETSC_EXTERN PetscErrorCode MatRealPart(Mat);
284: PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat);
285: PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,Mat*);
286: PETSC_EXTERN PetscErrorCode MatGetTrace(Mat,PetscScalar*);
287: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat,const PetscScalar **);
288: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonalMat(Mat,Mat);
290: /* ------------------------------------------------------------*/
291: PETSC_EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
292: PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
293: PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
294: PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
295: PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat,PetscInt,PetscInt,PetscInt[],const PetscScalar[]);
296: PETSC_EXTERN PetscErrorCode MatSetRandom(Mat,PetscRandom);
298: /*S
299: MatStencil - Data structure (C struct) for storing information about a single row or
300: column of a matrix as indexed on an associated grid. These are arguments to MatSetStencil() and MatSetBlockStencil()
302: 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).
303: 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.
305: For stencil access to vectors see DMDAVecGetArray(), DMDAVecGetArrayF90().
307: Fortran usage is different, see MatSetValuesStencil() for details.
309: Level: beginner
311: Concepts: matrix; linear operator
313: .seealso: MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockedStencil(), DMDAVecGetArray(), DMDAVecGetArrayF90()
314: S*/
315: typedef struct {
316: PetscInt k,j,i,c;
317: } MatStencil;
319: PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
320: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
321: PETSC_EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
323: /*E
324: MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
325: to continue to add or insert values to it
327: Level: beginner
329: .seealso: MatAssemblyBegin(), MatAssemblyEnd()
330: E*/
331: typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
332: PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType);
333: PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType);
334: PETSC_EXTERN PetscErrorCode MatAssembled(Mat,PetscBool *);
338: /*E
339: MatOption - Options that may be set for a matrix and its behavior or storage
341: Level: beginner
343: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
344: Any additions/changes here must also be made in src/mat/interface/dlregismat.c in MatOptions[]
346: Developer Notes: Entries that are negative need not be called collectively by all processes.
348: .seealso: MatSetOption()
349: E*/
350: typedef enum {MAT_OPTION_MIN = -3,
351: MAT_UNUSED_NONZERO_LOCATION_ERR = -2,
352: MAT_ROW_ORIENTED = -1,
353: MAT_SYMMETRIC = 1,
354: MAT_STRUCTURALLY_SYMMETRIC = 2,
355: MAT_NEW_DIAGONALS = 3,
356: MAT_IGNORE_OFF_PROC_ENTRIES = 4,
357: MAT_USE_HASH_TABLE = 5,
358: MAT_KEEP_NONZERO_PATTERN = 6,
359: MAT_IGNORE_ZERO_ENTRIES = 7,
360: MAT_USE_INODES = 8,
361: MAT_HERMITIAN = 9,
362: MAT_SYMMETRY_ETERNAL = 10,
363: MAT_NEW_NONZERO_LOCATION_ERR = 11,
364: MAT_IGNORE_LOWER_TRIANGULAR = 12,
365: MAT_ERROR_LOWER_TRIANGULAR = 13,
366: MAT_GETROW_UPPERTRIANGULAR = 14,
367: MAT_SPD = 15,
368: MAT_NO_OFF_PROC_ZERO_ROWS = 16,
369: MAT_NO_OFF_PROC_ENTRIES = 17,
370: MAT_NEW_NONZERO_LOCATIONS = 18,
371: MAT_NEW_NONZERO_ALLOCATION_ERR = 19,
372: MAT_SUBSET_OFF_PROC_ENTRIES = 20,
373: MAT_SUBMAT_SINGLEIS = 21,
374: MAT_STRUCTURE_ONLY = 22,
375: MAT_OPTION_MAX = 23} MatOption;
377: PETSC_EXTERN const char *const *MatOptions;
378: PETSC_EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscBool);
379: PETSC_EXTERN PetscErrorCode MatGetOption(Mat,MatOption,PetscBool*);
380: PETSC_EXTERN PetscErrorCode MatGetType(Mat,MatType*);
382: PETSC_EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
383: PETSC_EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
384: PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
385: PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat);
386: PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat);
387: PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt);
388: PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat,PetscScalar *[]);
389: PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat,PetscScalar *[]);
390: PETSC_EXTERN PetscErrorCode MatSeqAIJGetMaxRowNonzeros(Mat,PetscInt*);
391: PETSC_EXTERN PetscErrorCode MatSeqAIJSetValuesLocalFast(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
392: PETSC_EXTERN PetscErrorCode MatSeqAIJSetType(Mat,MatType);
393: PETSC_EXTERN PetscErrorCode MatSeqAIJRegister(const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat *));
394: PETSC_EXTERN PetscFunctionList MatSeqAIJList;
395: PETSC_EXTERN PetscErrorCode MatSeqSBAIJGetArray(Mat,PetscScalar *[]);
396: PETSC_EXTERN PetscErrorCode MatSeqSBAIJRestoreArray(Mat,PetscScalar *[]);
397: PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat,PetscScalar *[]);
398: PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat,PetscScalar *[]);
399: PETSC_EXTERN PetscErrorCode MatDensePlaceArray(Mat,const PetscScalar[]);
400: PETSC_EXTERN PetscErrorCode MatDenseResetArray(Mat);
401: PETSC_EXTERN PetscErrorCode MatDenseGetArrayRead(Mat,const PetscScalar *[]);
402: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayRead(Mat,const PetscScalar *[]);
403: PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *);
404: PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt);
405: PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat,PetscInt *,PetscInt *);
406: PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat,PetscInt,PetscInt);
407: PETSC_EXTERN PetscErrorCode MatSetBlockSizesFromMats(Mat,Mat,Mat);
408: PETSC_EXTERN PetscErrorCode MatDenseGetColumn(Mat,PetscInt,PetscScalar *[]);
409: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumn(Mat,PetscScalar *[]);
411: PETSC_EXTERN PetscErrorCode MatMult(Mat,Vec,Vec);
412: PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec);
413: PETSC_EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec);
414: PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec);
415: PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec);
416: PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *);
417: PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *);
418: PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec);
419: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
420: PETSC_EXTERN PetscErrorCode MatMultConstrained(Mat,Vec,Vec);
421: PETSC_EXTERN PetscErrorCode MatMultTransposeConstrained(Mat,Vec,Vec);
422: PETSC_EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat);
423: PETSC_EXTERN PetscErrorCode MatMatSolveTranspose(Mat,Mat,Mat);
424: PETSC_EXTERN PetscErrorCode MatResidual(Mat,Vec,Vec,Vec);
426: /*E
427: MatDuplicateOption - Indicates if a duplicated sparse matrix should have
428: its numerical values copied over or just its nonzero structure.
430: Level: beginner
432: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
434: $ MAT_DO_NOT_COPY_VALUES - Create a matrix using the same nonzero pattern as the original matrix,
435: $ with zeros for the numerical values.
436: $ MAT_COPY_VALUES - Create a matrix with the same nonzero pattern as the original matrix
437: $ and with the same numerical values.
438: $ MAT_SHARE_NONZERO_PATTERN - Create a matrix that shares the nonzero structure with the previous matrix
439: $ and does not copy it, using zeros for the numerical values. The parent and
440: $ child matrices will share their index (i and j) arrays, and you cannot
441: $ insert new nonzero entries into either matrix.
443: Notes: Many matrix types (including SeqAIJ) do not support the MAT_SHARE_NONZERO_PATTERN optimization; in
444: this case the behavior is as if MAT_DO_NOT_COPY_VALUES has been specified.
446: .seealso: MatDuplicate()
447: E*/
448: typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;
450: PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*);
451: PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*);
454: PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure);
455: PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer);
456: PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *);
457: PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *);
458: PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *);
459: PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *);
460: PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *);
461: PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool *,PetscInt *);
462: PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer);
464: PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *);
465: PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *);
466: PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *);
467: PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *);
469: /*S
470: MatInfo - Context of matrix information, used with MatGetInfo()
472: In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
474: Level: intermediate
476: Concepts: matrix^nonzero information
478: .seealso: MatGetInfo(), MatInfoType
479: S*/
480: typedef struct {
481: PetscLogDouble block_size; /* block size */
482: PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */
483: PetscLogDouble memory; /* memory allocated */
484: PetscLogDouble assemblies; /* number of matrix assemblies called */
485: PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */
486: PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
487: PetscLogDouble factor_mallocs; /* number of mallocs during factorization */
488: } MatInfo;
490: /*E
491: MatInfoType - Indicates if you want information about the local part of the matrix,
492: the entire parallel matrix or the maximum over all the local parts.
494: Level: beginner
496: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
498: .seealso: MatGetInfo(), MatInfo
499: E*/
500: typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
501: PETSC_EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*);
502: PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec);
503: PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]);
504: PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]);
505: PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
506: PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]);
507: PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat,Vec);
508: PETSC_EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*);
509: PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*);
510: PETSC_EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat*);
511: PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec);
512: PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode);
514: PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool*);
515: PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool*);
516: PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool*);
517: PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool*);
518: PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*);
519: PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
520: PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
522: PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal*);
523: PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal*);
524: PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat);
525: PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
526: PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec);
527: PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec);
528: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec);
529: PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
530: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec);
532: PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*);
533: PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*);
534: PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
535: PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**);
536: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
537: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**);
538: PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*);
540: PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
541: PETSC_DEPRECATED("Use MatCreateSubMatrices()") PETSC_STATIC_INLINE PetscErrorCode MatGetSubMatrices(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[]) {return MatCreateSubMatrices(mat,n,irow,icol,scall,submat);}
542: PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
543: PETSC_DEPRECATED("Use MatCreateSubMatricesMPI()") PETSC_STATIC_INLINE PetscErrorCode MatGetSubMatricesMPI(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[]) {return MatCreateSubMatricesMPI(mat,n,irow,icol,scall,submat);}
544: PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]);
545: PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt,Mat *[]);
546: PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,MatReuse,Mat *);
547: PETSC_DEPRECATED("Use MatCreateSubMatrix()") PETSC_STATIC_INLINE PetscErrorCode MatGetSubMatrix(Mat mat,IS isrow,IS iscol,MatReuse cll,Mat *newmat) {return MatCreateSubMatrix(mat,isrow,iscol,cll,newmat);}
548: PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*);
549: PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*);
550: PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*);
551: PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*);
553: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
554: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
555: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat);
556: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*);
557: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
558: PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*);
559: PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);
561: PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
562: PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat mat,PetscInt n,IS is[],PetscInt ov);
563: PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat,PetscBool);
565: PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
566: PETSC_EXTERN PetscErrorCode MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
567: PETSC_EXTERN PetscErrorCode MatMatMultNumeric(Mat,Mat,Mat);
569: PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
570: PETSC_EXTERN PetscErrorCode MatGalerkin(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
572: PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
573: PETSC_EXTERN PetscErrorCode MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
574: PETSC_EXTERN PetscErrorCode MatPtAPNumeric(Mat,Mat,Mat);
575: PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*);
576: PETSC_EXTERN PetscErrorCode MatRARtSymbolic(Mat,Mat,PetscReal,Mat*);
577: PETSC_EXTERN PetscErrorCode MatRARtNumeric(Mat,Mat,Mat);
579: PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
580: PETSC_EXTERN PetscErrorCode MatTransposetMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
581: PETSC_EXTERN PetscErrorCode MatTransposetMatMultNumeric(Mat,Mat,Mat);
582: PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*);
583: PETSC_EXTERN PetscErrorCode MatMatTransposeMultSymbolic(Mat,Mat,PetscReal,Mat*);
584: PETSC_EXTERN PetscErrorCode MatMatTransposeMultNumeric(Mat,Mat,Mat);
586: PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure);
587: PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure);
589: PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar);
590: PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar);
592: PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
593: PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*);
594: PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat,PetscLayout*,PetscLayout*);
595: PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
596: PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
597: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
598: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
599: PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
600: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
602: PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt);
603: PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
605: PETSC_EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec);
606: PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec);
607: PETSC_EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec);
608: PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat,Vec*,Vec*);
609: PETSC_DEPRECATED("Use MatCreateVecs()") PETSC_STATIC_INLINE PetscErrorCode MatGetVecs(Mat mat,Vec *x,Vec *y) {return MatCreateVecs(mat,x,y);}
610: PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat,PetscInt,MPI_Comm,MatReuse,Mat*);
611: PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*);
612: PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*);
613: PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat,IS*);
614: PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
616: /*MC
617: MatSetValue - Set a single entry into a matrix.
619: Not collective
621: Synopsis:
622: #include <petscmat.h>
623: PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode)
625: Input Parameters:
626: + m - the matrix
627: . row - the row location of the entry
628: . col - the column location of the entry
629: . value - the value to insert
630: - mode - either INSERT_VALUES or ADD_VALUES
632: Notes:
633: For efficiency one should use MatSetValues() and set several or many
634: values simultaneously if possible.
636: Level: beginner
638: .seealso: MatSetValues(), MatSetValueLocal()
639: M*/
640: PETSC_STATIC_INLINE PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);}
642: PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);}
644: PETSC_STATIC_INLINE PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);}
646: /*MC
647: MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
648: row in a matrix providing the data that one can use to correctly preallocate the matrix.
650: Synopsis:
651: #include <petscmat.h>
652: PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
654: Collective on MPI_Comm
656: Input Parameters:
657: + comm - the communicator that will share the eventually allocated matrix
658: . nrows - the number of LOCAL rows in the matrix
659: - ncols - the number of LOCAL columns in the matrix
661: Output Parameters:
662: + dnz - the array that will be passed to the matrix preallocation routines
663: - onz - the other array passed to the matrix preallocation routines
665: Level: intermediate
667: Notes:
668: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
670: Do not malloc or free dnz and onz, that is handled internally by these routines
672: Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
674: This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
676: Concepts: preallocation^Matrix
678: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
679: MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocalBlock()
680: M*/
681: #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
682: { \
683: PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ncols = (ncols),__rstart,__start,__end; \
684: _4_PetscCalloc2((size_t)__nrows,&dnz,(size_t)__nrows,&onz);CHKERRQ(_4_ierr); \
685: __start = 0; __end = __start; \
686: _4_MPI_Scan(&__ncols,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ncols;\
687: _4_MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
689: /*MC
690: MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
691: inserted using a local number of the rows and columns
693: Synopsis:
694: #include <petscmat.h>
695: PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
697: Not Collective
699: Input Parameters:
700: + map - the row mapping from local numbering to global numbering
701: . nrows - the number of rows indicated
702: . rows - the indices of the rows
703: . cmap - the column mapping from local to global numbering
704: . ncols - the number of columns in the matrix
705: . cols - the columns indicated
706: . dnz - the array that will be passed to the matrix preallocation routines
707: - onz - the other array passed to the matrix preallocation routines
709: Level: intermediate
711: Notes:
712: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
714: Do not malloc or free dnz and onz, that is handled internally by these routines
716: Concepts: preallocation^Matrix
718: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
719: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocalRemoveDups()
720: M*/
721: #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
722: {\
723: PetscInt __l;\
724: _4_ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
725: _4_ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
726: for (__l=0;__l<nrows;__l++) {\
727: _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
728: }\
729: }
731: /*MC
732: MatPreallocateSetLocalRemoveDups - Indicates the locations (rows and columns) in the matrix where nonzeros will be
733: inserted using a local number of the rows and columns. This version removes any duplicate columns in cols
735: Synopsis:
736: #include <petscmat.h>
737: PetscErrorCode MatPreallocateSetLocalRemoveDups(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
739: Not Collective
741: Input Parameters:
742: + map - the row mapping from local numbering to global numbering
743: . nrows - the number of rows indicated
744: . rows - the indices of the rows (these values are mapped to the global values)
745: . cmap - the column mapping from local to global numbering
746: . ncols - the number of columns in the matrix (this value will be changed if duplicate columns are found)
747: . cols - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed)
748: . dnz - the array that will be passed to the matrix preallocation routines
749: - onz - the other array passed to the matrix preallocation routines
751: Level: intermediate
753: Notes:
754: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
756: Do not malloc or free dnz and onz, that is handled internally by these routines
758: Concepts: preallocation^Matrix
760: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
761: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal()
762: M*/
763: #define MatPreallocateSetLocalRemoveDups(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
764: {\
765: PetscInt __l;\
766: _4_ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
767: _4_ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
768: _4_PetscSortRemoveDupsInt(&ncols,cols);CHKERRQ(_4_ierr);\
769: for (__l=0;__l<nrows;__l++) {\
770: _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
771: }\
772: }
774: /*MC
775: MatPreallocateSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
776: inserted using a local number of the rows and columns
778: Synopsis:
779: #include <petscmat.h>
780: PetscErrorCode MatPreallocateSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
782: Not Collective
784: Input Parameters:
785: + map - the row mapping from local numbering to global numbering
786: . nrows - the number of rows indicated
787: . rows - the indices of the rows
788: . cmap - the column mapping from local to global numbering
789: . ncols - the number of columns in the matrix
790: . cols - the columns indicated
791: . dnz - the array that will be passed to the matrix preallocation routines
792: - onz - the other array passed to the matrix preallocation routines
794: Level: intermediate
796: Notes:
797: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
799: Do not malloc or free dnz and onz, that is handled internally by these routines
801: Concepts: preallocation^Matrix
803: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
804: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock()
805: M*/
806: #define MatPreallocateSetLocalBlock(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
807: {\
808: PetscInt __l;\
809: _4_ISLocalToGlobalMappingApplyBlock(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
810: _4_ISLocalToGlobalMappingApplyBlock(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
811: for (__l=0;__l<nrows;__l++) {\
812: _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
813: }\
814: }
816: /*MC
817: MatPreallocateSymmetricSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
818: inserted using a local number of the rows and columns
820: Synopsis:
821: #include <petscmat.h>
822: PetscErrorCode MatPreallocateSymmetricSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
824: Not Collective
826: Input Parameters:
827: + map - the mapping between local numbering and global numbering
828: . nrows - the number of rows indicated
829: . rows - the indices of the rows
830: . ncols - the number of columns in the matrix
831: . cols - the columns indicated
832: . dnz - the array that will be passed to the matrix preallocation routines
833: - onz - the other array passed to the matrix preallocation routines
835: Level: intermediate
837: Notes:
838: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
840: Do not malloc or free dnz and onz that is handled internally by these routines
842: Concepts: preallocation^Matrix
844: .seealso: MatPreallocateFinalize(), MatPreallocateSet()
845: MatPreallocateInitialize(), MatPreallocateSetLocal()
846: M*/
847: #define MatPreallocateSymmetricSetLocalBlock(map,nrows,rows,ncols,cols,dnz,onz) 0;\
848: {\
849: PetscInt __l;\
850: _4_ISLocalToGlobalMappingApplyBlock(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
851: _4_ISLocalToGlobalMappingApplyBlock(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
852: for (__l=0;__l<nrows;__l++) {\
853: _4_MatPreallocateSymmetricSetBlock((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
854: }\
855: }
856: /*MC
857: MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
858: inserted using a local number of the rows and columns
860: Synopsis:
861: #include <petscmat.h>
862: PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
864: Not Collective
866: Input Parameters:
867: + row - the row
868: . ncols - the number of columns in the matrix
869: - cols - the columns indicated
871: Output Parameters:
872: + dnz - the array that will be passed to the matrix preallocation routines
873: - onz - the other array passed to the matrix preallocation routines
875: Level: intermediate
877: Notes:
878: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
880: Do not malloc or free dnz and onz that is handled internally by these routines
882: This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
884: Concepts: preallocation^Matrix
886: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
887: MatPreallocateInitialize(), MatPreallocateSetLocal()
888: M*/
889: #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
890: { PetscInt __i; \
891: if (row < __rstart) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D less than first local row %D",row,__rstart);\
892: if (row >= __rstart+__nrows) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D greater than last local row %D",row,__rstart+__nrows-1);\
893: for (__i=0; __i<nc; __i++) {\
894: if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
895: else if (dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\
896: }\
897: }
899: /*MC
900: MatPreallocateSymmetricSetBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
901: inserted using a local number of the rows and columns
903: Synopsis:
904: #include <petscmat.h>
905: PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
907: Not Collective
909: Input Parameters:
910: + nrows - the number of rows indicated
911: . rows - the indices of the rows
912: . ncols - the number of columns in the matrix
913: . cols - the columns indicated
914: . dnz - the array that will be passed to the matrix preallocation routines
915: - onz - the other array passed to the matrix preallocation routines
917: Level: intermediate
919: Notes:
920: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
922: Do not malloc or free dnz and onz that is handled internally by these routines
924: This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
926: Concepts: preallocation^Matrix
928: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateInitialize(),
929: MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal()
930: M*/
931: #define MatPreallocateSymmetricSetBlock(row,nc,cols,dnz,onz) 0;\
932: { PetscInt __i; \
933: for (__i=0; __i<nc; __i++) {\
934: if (cols[__i] >= __end) onz[row - __rstart]++; \
935: else if (cols[__i] >= row && dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\
936: }\
937: }
939: /*MC
940: MatPreallocateLocation - An alternative to MatPreallocateSet() that puts the nonzero locations into the matrix if it exists
942: Synopsis:
943: #include <petscmat.h>
944: PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)
946: Not Collective
948: Input Parameters:
949: . A - matrix
950: . row - row where values exist (must be local to this process)
951: . ncols - number of columns
952: . cols - columns with nonzeros
953: . dnz - the array that will be passed to the matrix preallocation routines
954: - onz - the other array passed to the matrix preallocation routines
956: Level: intermediate
958: Notes:
959: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
961: Do not malloc or free dnz and onz that is handled internally by these routines
963: This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.
965: Concepts: preallocation^Matrix
967: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
968: MatPreallocateSymmetricSetLocalBlock()
969: M*/
970: #define MatPreallocateLocation(A,row,ncols,cols,dnz,onz) 0;if (A) {MatSetValues(A,1,&row,ncols,cols,NULL,INSERT_VALUES);} else { MatPreallocateSet(row,ncols,cols,dnz,onz);}
973: /*MC
974: MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
975: row in a matrix providing the data that one can use to correctly preallocate the matrix.
977: Synopsis:
978: #include <petscmat.h>
979: PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
981: Collective on MPI_Comm
983: Input Parameters:
984: + dnz - the array that was be passed to the matrix preallocation routines
985: - onz - the other array passed to the matrix preallocation routines
987: Level: intermediate
989: Notes:
990: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
992: Do not malloc or free dnz and onz that is handled internally by these routines
994: This is a MACRO not a function because it closes the { started in MatPreallocateInitialize().
996: Concepts: preallocation^Matrix
998: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
999: MatPreallocateSymmetricSetLocalBlock()
1000: M*/
1001: #define MatPreallocateFinalize(dnz,onz) 0;_4_PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}
1003: /* Routines unique to particular data structures */
1004: PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat,void *);
1006: PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*);
1007: PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
1009: PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
1010: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
1011: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1012: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1013: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1014: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool);
1016: #define MAT_SKIP_ALLOCATION -4
1018: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1019: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1020: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
1022: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1023: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1024: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1025: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
1026: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1027: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
1028: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1029: PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
1030: PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat,Mat*);
1031: PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
1032: PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
1033: PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
1034: PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
1035: PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*);
1037: PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1038: PETSC_EXTERN PetscErrorCode MatISSetUpSF(Mat);
1039: PETSC_EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt);
1040: PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*);
1042: PETSC_EXTERN PetscErrorCode MatStoreValues(Mat);
1043: PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat);
1045: PETSC_EXTERN PetscErrorCode MatDAADSetCtx(Mat,void*);
1047: PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*);
1048: PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat,IS*);
1049: /*
1050: These routines are not usually accessed directly, rather solving is
1051: done through the KSP and PC interfaces.
1052: */
1054: /*J
1055: MatOrderingType - String with the name of a PETSc matrix ordering
1057: Level: beginner
1059: .seealso: MatGetOrdering()
1060: J*/
1061: typedef const char* MatOrderingType;
1062: #define MATORDERINGNATURAL "natural"
1063: #define MATORDERINGND "nd"
1064: #define MATORDERING1WD "1wd"
1065: #define MATORDERINGRCM "rcm"
1066: #define MATORDERINGQMD "qmd"
1067: #define MATORDERINGROWLENGTH "rowlength"
1068: #define MATORDERINGWBM "wbm"
1069: #define MATORDERINGSPECTRAL "spectral"
1070: #define MATORDERINGAMD "amd" /* only works if UMFPACK is installed with PETSc */
1072: PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*);
1073: PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*);
1074: PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*));
1075: PETSC_EXTERN PetscFunctionList MatOrderingList;
1077: PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1078: PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*);
1080: /*S
1081: MatFactorShiftType - Numeric Shift.
1083: Level: beginner
1085: S*/
1086: typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
1087: PETSC_EXTERN const char *const MatFactorShiftTypes[];
1088: PETSC_EXTERN const char *const MatFactorShiftTypesDetail[];
1090: /*S
1091: MatFactorError - indicates what type of error in matrix factor
1093: Level: beginner
1095: Developer Notes: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
1097: .seealso: MatGetFactor()
1098: S*/
1099: typedef enum {MAT_FACTOR_NOERROR,MAT_FACTOR_STRUCT_ZEROPIVOT,MAT_FACTOR_NUMERIC_ZEROPIVOT,MAT_FACTOR_OUTMEMORY,MAT_FACTOR_OTHER} MatFactorError;
1101: PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat,MatFactorError*);
1102: PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat);
1103: PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat,PetscReal*,PetscInt*);
1105: /*S
1106: MatFactorInfo - Data passed into the matrix factorization routines, and information about the resulting factorization
1108: In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
1109: $ MatFactorInfo info(MAT_FACTORINFO_SIZE)
1111: Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
1113: You can use MatFactorInfoInitialize() to set default values.
1115: Level: developer
1117: .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1118: MatFactorInfoInitialize()
1120: S*/
1121: typedef struct {
1122: PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */
1123: PetscReal usedt;
1124: PetscReal dt; /* drop tolerance */
1125: PetscReal dtcol; /* tolerance for pivoting */
1126: PetscReal dtcount; /* maximum nonzeros to be allowed per row */
1127: PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1128: PetscReal levels; /* ICC/ILU(levels) */
1129: PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1130: factorization may be faster if do not pivot */
1131: PetscReal zeropivot; /* pivot is called zero if less than this */
1132: PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */
1133: PetscReal shiftamount; /* how large the shift is */
1134: } MatFactorInfo;
1136: PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*);
1137: PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
1138: PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1139: PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
1140: PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
1141: PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
1142: PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1143: PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1144: PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1145: PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*);
1146: PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1147: PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1148: PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec);
1149: PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec);
1150: PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec);
1151: PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec);
1152: PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec);
1153: PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1154: PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs);
1155: PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat);
1157: typedef enum {MAT_FACTOR_SCHUR_UNFACTORED, MAT_FACTOR_SCHUR_FACTORED, MAT_FACTOR_SCHUR_INVERTED} MatFactorSchurStatus;
1158: PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat,IS);
1159: PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
1160: PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat,Mat*,MatFactorSchurStatus);
1161: PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat);
1162: PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
1163: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat,Vec,Vec);
1164: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat,Vec,Vec);
1165: PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat);
1167: /*E
1168: MatSORType - What type of (S)SOR to perform
1170: Level: beginner
1172: May be bitwise ORd together
1174: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
1176: MatSORType may be bitwise ORd together, so do not change the numbers
1178: .seealso: MatSOR()
1179: E*/
1180: typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1181: SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1182: SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
1183: SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1184: PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1186: /*
1187: These routines are for efficiently computing Jacobians via finite differences.
1188: */
1190: /*S
1191: MatColoring - Object for managing the coloring of matrices.
1193: Level: beginner
1195: Concepts: matrix, coloring
1197: .seealso: MatFDColoringCreate() ISColoring MatFDColoring
1198: S*/
1199: typedef struct _p_MatColoring* MatColoring;
1200: /*J
1201: MatColoringType - String with the name of a PETSc matrix coloring
1203: Level: beginner
1205: .seealso: MatColoringSetType(), MatColoring
1206: J*/
1208: typedef const char* MatColoringType;
1209: #define MATCOLORINGJP "jp"
1210: #define MATCOLORINGPOWER "power"
1211: #define MATCOLORINGNATURAL "natural"
1212: #define MATCOLORINGSL "sl"
1213: #define MATCOLORINGLF "lf"
1214: #define MATCOLORINGID "id"
1215: #define MATCOLORINGGREEDY "greedy"
1217: /*E
1218: MatColoringWeightType - Type of weight scheme
1220: Not Collective
1222: + MAT_COLORING_RANDOM - Random weights
1223: . MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering.
1224: - MAT_COLORING_LF - Last-first weighting.
1226: Level: intermediate
1228: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
1229: E*/
1230: typedef enum {MAT_COLORING_WEIGHT_RANDOM,MAT_COLORING_WEIGHT_LEXICAL,MAT_COLORING_WEIGHT_LF,MAT_COLORING_WEIGHT_SL} MatColoringWeightType;
1232: PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*);
1233: PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*);
1234: PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*);
1235: PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer);
1236: PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType);
1237: PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring);
1238: PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt);
1239: PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*);
1240: PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt);
1241: PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*);
1242: PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*);
1243: PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring));
1244: PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1245: PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType);
1246: PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*);
1247: PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm);
1248: PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring,ISColoring);
1249: PETSC_DEPRECATED("Use MatColoringTest()") PETSC_STATIC_INLINE PetscErrorCode MatColoringTestValid(MatColoring matcoloring,ISColoring iscoloring) {return MatColoringTest(matcoloring,iscoloring);}
1250: PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat,ISColoring);
1252: /*S
1253: MatFDColoring - Object for computing a sparse Jacobian via finite differences
1254: and coloring
1256: Level: beginner
1258: Concepts: coloring, sparse Jacobian, finite differences
1260: .seealso: MatFDColoringCreate()
1261: S*/
1262: typedef struct _p_MatFDColoring* MatFDColoring;
1264: PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1265: PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*);
1266: PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer);
1267: PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1268: PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1269: PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1270: PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
1271: PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *);
1272: PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec);
1273: PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,const PetscInt*[]);
1274: PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring);
1275: PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt);
1278: /*S
1279: MatTransposeColoring - Object for computing a sparse matrix product C=A*B^T via coloring
1281: Level: beginner
1283: Concepts: coloring, sparse matrix product
1285: .seealso: MatTransposeColoringCreate()
1286: S*/
1287: typedef struct _p_MatTransposeColoring* MatTransposeColoring;
1289: PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *);
1290: PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat);
1291: PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat);
1292: PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*);
1294: /*
1295: These routines are for partitioning matrices: currently used only
1296: for adjacency matrix, MatCreateMPIAdj().
1297: */
1299: /*S
1300: MatPartitioning - Object for managing the partitioning of a matrix or graph
1302: Level: beginner
1304: Concepts: partitioning
1306: .seealso: MatPartitioningCreate(), MatPartitioningType
1307: S*/
1308: typedef struct _p_MatPartitioning* MatPartitioning;
1310: /*J
1311: MatPartitioningType - String with the name of a PETSc matrix partitioning
1313: Level: beginner
1314: dm
1315: .seealso: MatPartitioningCreate(), MatPartitioning
1316: J*/
1317: typedef const char* MatPartitioningType;
1318: #define MATPARTITIONINGCURRENT "current"
1319: #define MATPARTITIONINGAVERAGE "average"
1320: #define MATPARTITIONINGSQUARE "square"
1321: #define MATPARTITIONINGPARMETIS "parmetis"
1322: #define MATPARTITIONINGCHACO "chaco"
1323: #define MATPARTITIONINGPARTY "party"
1324: #define MATPARTITIONINGPTSCOTCH "ptscotch"
1325: #define MATPARTITIONINGHIERARCH "hierarch"
1328: PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1329: PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType);
1330: PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt);
1331: PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat);
1332: PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1333: PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1334: PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*);
1335: PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*);
1337: PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[],PetscErrorCode (*)(MatPartitioning));
1341: PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer);
1342: PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
1343: PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*);
1345: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part);
1346: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1347: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);
1349: typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType;
1350: PETSC_EXTERN const char *const MPChacoGlobalTypes[];
1351: typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType;
1352: PETSC_EXTERN const char *const MPChacoLocalTypes[];
1353: typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType;
1354: PETSC_EXTERN const char *const MPChacoEigenTypes[];
1356: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType);
1357: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*);
1358: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType);
1359: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*);
1360: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
1361: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1362: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*);
1363: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal);
1364: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*);
1365: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt);
1366: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*);
1368: #define MP_PARTY_OPT "opt"
1369: #define MP_PARTY_LIN "lin"
1370: #define MP_PARTY_SCA "sca"
1371: #define MP_PARTY_RAN "ran"
1372: #define MP_PARTY_GBF "gbf"
1373: #define MP_PARTY_GCF "gcf"
1374: #define MP_PARTY_BUB "bub"
1375: #define MP_PARTY_DEF "def"
1376: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*);
1377: #define MP_PARTY_HELPFUL_SETS "hs"
1378: #define MP_PARTY_KERNIGHAN_LIN "kl"
1379: #define MP_PARTY_NONE "no"
1380: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*);
1381: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1382: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool);
1383: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool);
1385: typedef enum { MP_PTSCOTCH_DEFAULT,MP_PTSCOTCH_QUALITY,MP_PTSCOTCH_SPEED,MP_PTSCOTCH_BALANCE,MP_PTSCOTCH_SAFETY,MP_PTSCOTCH_SCALABILITY } MPPTScotchStrategyType;
1386: PETSC_EXTERN const char *const MPPTScotchStrategyTypes[];
1388: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal);
1389: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*);
1390: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType);
1391: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*);
1393: /*
1394: * hierarchical partitioning
1395: */
1396: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning,IS*);
1397: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning,IS*);
1398: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning,PetscInt);
1399: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt);
1401: PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
1402: PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);
1404: /*
1405: If you add entries here you must also add them to petsc/finclude/petscmat.h
1406: */
1407: typedef enum { MATOP_SET_VALUES=0,
1408: MATOP_GET_ROW=1,
1409: MATOP_RESTORE_ROW=2,
1410: MATOP_MULT=3,
1411: MATOP_MULT_ADD=4,
1412: MATOP_MULT_TRANSPOSE=5,
1413: MATOP_MULT_TRANSPOSE_ADD=6,
1414: MATOP_SOLVE=7,
1415: MATOP_SOLVE_ADD=8,
1416: MATOP_SOLVE_TRANSPOSE=9,
1417: MATOP_SOLVE_TRANSPOSE_ADD=10,
1418: MATOP_LUFACTOR=11,
1419: MATOP_CHOLESKYFACTOR=12,
1420: MATOP_SOR=13,
1421: MATOP_TRANSPOSE=14,
1422: MATOP_GETINFO=15,
1423: MATOP_EQUAL=16,
1424: MATOP_GET_DIAGONAL=17,
1425: MATOP_DIAGONAL_SCALE=18,
1426: MATOP_NORM=19,
1427: MATOP_ASSEMBLY_BEGIN=20,
1428: MATOP_ASSEMBLY_END=21,
1429: MATOP_SET_OPTION=22,
1430: MATOP_ZERO_ENTRIES=23,
1431: MATOP_ZERO_ROWS=24,
1432: MATOP_LUFACTOR_SYMBOLIC=25,
1433: MATOP_LUFACTOR_NUMERIC=26,
1434: MATOP_CHOLESKY_FACTOR_SYMBOLIC=27,
1435: MATOP_CHOLESKY_FACTOR_NUMERIC=28,
1436: MATOP_SETUP_PREALLOCATION=29,
1437: MATOP_ILUFACTOR_SYMBOLIC=30,
1438: MATOP_ICCFACTOR_SYMBOLIC=31,
1439: MATOP_GET_DIAGONAL_BLOCK=32,
1440: /* MATOP_PLACEHOLDER_33=33, */
1441: MATOP_DUPLICATE=34,
1442: MATOP_FORWARD_SOLVE=35,
1443: MATOP_BACKWARD_SOLVE=36,
1444: MATOP_ILUFACTOR=37,
1445: MATOP_ICCFACTOR=38,
1446: MATOP_AXPY=39,
1447: MATOP_CREATE_SUBMATRICES=40,
1448: MATOP_INCREASE_OVERLAP=41,
1449: MATOP_GET_VALUES=42,
1450: MATOP_COPY=43,
1451: MATOP_GET_ROW_MAX=44,
1452: MATOP_SCALE=45,
1453: MATOP_SHIFT=46,
1454: MATOP_DIAGONAL_SET=47,
1455: MATOP_ZERO_ROWS_COLUMNS=48,
1456: MATOP_SET_RANDOM=49,
1457: MATOP_GET_ROW_IJ=50,
1458: MATOP_RESTORE_ROW_IJ=51,
1459: MATOP_GET_COLUMN_IJ=52,
1460: MATOP_RESTORE_COLUMN_IJ=53,
1461: MATOP_FDCOLORING_CREATE=54,
1462: MATOP_COLORING_PATCH=55,
1463: MATOP_SET_UNFACTORED=56,
1464: MATOP_PERMUTE=57,
1465: MATOP_SET_VALUES_BLOCKED=58,
1466: MATOP_CREATE_SUBMATRIX=59,
1467: MATOP_DESTROY=60,
1468: MATOP_VIEW=61,
1469: MATOP_CONVERT_FROM=62,
1470: MATOP_MATMAT_MULT=63,
1471: MATOP_MATMAT_MULT_SYMBOLIC=64,
1472: MATOP_MATMAT_MULT_NUMERIC=65,
1473: MATOP_SET_LOCAL_TO_GLOBAL_MAP=66,
1474: MATOP_SET_VALUES_LOCAL=67,
1475: MATOP_ZERO_ROWS_LOCAL=68,
1476: MATOP_GET_ROW_MAX_ABS=69,
1477: MATOP_GET_ROW_MIN_ABS=70,
1478: MATOP_CONVERT=71,
1479: MATOP_SET_COLORING=72,
1480: /* MATOP_PLACEHOLDER_73=73, */
1481: MATOP_SET_VALUES_ADIFOR=74,
1482: MATOP_FD_COLORING_APPLY=75,
1483: MATOP_SET_FROM_OPTIONS=76,
1484: MATOP_MULT_CONSTRAINED=77,
1485: MATOP_MULT_TRANSPOSE_CONSTRAIN=78,
1486: MATOP_FIND_ZERO_DIAGONALS=79,
1487: MATOP_MULT_MULTIPLE=80,
1488: MATOP_SOLVE_MULTIPLE=81,
1489: MATOP_GET_INERTIA=82,
1490: MATOP_LOAD=83,
1491: MATOP_IS_SYMMETRIC=84,
1492: MATOP_IS_HERMITIAN=85,
1493: MATOP_IS_STRUCTURALLY_SYMMETRIC=86,
1494: MATOP_SET_VALUES_BLOCKEDLOCAL=87,
1495: MATOP_CREATE_VECS=88,
1496: MATOP_MAT_MULT=89,
1497: MATOP_MAT_MULT_SYMBOLIC=90,
1498: MATOP_MAT_MULT_NUMERIC=91,
1499: MATOP_PTAP=92,
1500: MATOP_PTAP_SYMBOLIC=93,
1501: MATOP_PTAP_NUMERIC=94,
1502: MATOP_MAT_TRANSPOSE_MULT=95,
1503: MATOP_MAT_TRANSPOSE_MULT_SYMBO=96,
1504: MATOP_MAT_TRANSPOSE_MULT_NUMER=97,
1505: /* MATOP_PLACEHOLDER_98=98, */
1506: /* MATOP_PLACEHOLDER_99=99, */
1507: /* MATOP_PLACEHOLDER_100=100, */
1508: /* MATOP_PLACEHOLDER_101=101, */
1509: MATOP_CONJUGATE=102,
1510: /* MATOP_PLACEHOLDER_103=103, */
1511: MATOP_SET_VALUES_ROW=104,
1512: MATOP_REAL_PART=105,
1513: MATOP_IMAGINARY_PART=106,
1514: MATOP_GET_ROW_UPPER_TRIANGULAR=107,
1515: MATOP_RESTORE_ROW_UPPER_TRIANG=108,
1516: MATOP_MAT_SOLVE=109,
1517: MATOP_MAT_SOLVE_TRANSPOSE=110,
1518: MATOP_GET_ROW_MIN=111,
1519: MATOP_GET_COLUMN_VECTOR=112,
1520: MATOP_MISSING_DIAGONAL=113,
1521: MATOP_GET_SEQ_NONZERO_STRUCTUR=114,
1522: MATOP_CREATE=115,
1523: MATOP_GET_GHOSTS=116,
1524: MATOP_GET_LOCAL_SUB_MATRIX=117,
1525: MATOP_RESTORE_LOCALSUB_MATRIX=118,
1526: MATOP_MULT_DIAGONAL_BLOCK=119,
1527: MATOP_HERMITIAN_TRANSPOSE=120,
1528: MATOP_MULT_HERMITIAN_TRANSPOSE=121,
1529: MATOP_MULT_HERMITIAN_TRANS_ADD=122,
1530: MATOP_GET_MULTI_PROC_BLOCK=123,
1531: MATOP_FIND_NONZERO_ROWS=124,
1532: MATOP_GET_COLUMN_NORMS=125,
1533: MATOP_INVERT_BLOCK_DIAGONAL=126,
1534: /* MATOP_PLACEHOLDER_127=127, */
1535: MATOP_CREATE_SUB_MATRICES_MPI=128,
1536: MATOP_SET_VALUES_BATCH=129,
1537: MATOP_TRANSPOSE_MAT_MULT=130,
1538: MATOP_TRANSPOSE_MAT_MULT_SYMBO=131,
1539: MATOP_TRANSPOSE_MAT_MULT_NUMER=132,
1540: MATOP_TRANSPOSE_COLORING_CREAT=133,
1541: MATOP_TRANS_COLORING_APPLY_SPT=134,
1542: MATOP_TRANS_COLORING_APPLY_DEN=135,
1543: MATOP_RART=136,
1544: MATOP_RART_SYMBOLIC=137,
1545: MATOP_RART_NUMERIC=138,
1546: MATOP_SET_BLOCK_SIZES=139,
1547: MATOP_AYPX=140,
1548: MATOP_RESIDUAL=141,
1549: MATOP_FDCOLORING_SETUP=142,
1550: MATOP_MPICONCATENATESEQ=144,
1551: MATOP_DESTROYSUBMATRICES=145
1552: } MatOperation;
1553: PETSC_EXTERN PetscErrorCode MatSetOperation(Mat,MatOperation,void(*)(void));
1554: PETSC_EXTERN PetscErrorCode MatGetOperation(Mat,MatOperation,void(**)(void));
1555: PETSC_EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool *);
1557: PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void));
1558: PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void));
1559: PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*);
1560: PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*);
1561: PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*);
1562: PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat);
1564: /*
1565: Codes for matrices stored on disk. By default they are
1566: stored in a universal format. By changing the format with
1567: PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
1568: be stored in a way natural for the matrix, for example dense matrices
1569: would be stored as dense. Matrices stored this way may only be
1570: read into matrices of the same type.
1571: */
1572: #define MATRIX_BINARY_FORMAT_DENSE -1
1574: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1575: PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*);
1576: PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat,Mat*);
1577: PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat);
1578: PETSC_EXTERN PetscErrorCode MatISGetMPIXAIJ(Mat,MatReuse,Mat*);
1580: /*S
1581: MatNullSpace - Object that removes a null space from a vector, i.e.
1582: orthogonalizes the vector to a subsapce
1584: Level: advanced
1586: Concepts: matrix; linear operator, null space
1588: Users manual sections:
1589: . Section 4.19 Solving Singular Systems
1591: .seealso: MatNullSpaceCreate()
1592: S*/
1593: typedef struct _p_MatNullSpace* MatNullSpace;
1595: PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*);
1596: PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1597: PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*);
1598: PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec);
1599: PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *);
1600: PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *);
1601: PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat,MatNullSpace);
1602: PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace);
1603: PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace);
1604: PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*);
1605: PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool *);
1606: PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer);
1607: PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**);
1608: PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*);
1610: PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS);
1611: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1612: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
1613: PETSC_EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat);
1615: PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*);
1616: PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*);
1617: PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*);
1619: PETSC_EXTERN PetscErrorCode MatComputeExplicitOperator(Mat,Mat*);
1620: PETSC_EXTERN PetscErrorCode MatComputeExplicitOperatorTranspose(Mat,Mat*);
1622: PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec);
1624: PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
1625: PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec);
1626: PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1627: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1628: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1629: PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1630: PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
1631: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal);
1632: PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt);
1633: PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *);
1634: PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]);
1635: PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1636: PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);
1638: /*S
1639: MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free
1640: Jacobian vector products
1642: Notes: MATMFFD is a specific MatType which uses the MatMFFD data structure
1644: MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure
1646: Level: developer
1648: .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
1649: S*/
1650: typedef struct _p_MatMFFD* MatMFFD;
1652: /*J
1653: MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function
1655: Level: beginner
1657: .seealso: MatMFFDSetType(), MatMFFDRegister()
1658: J*/
1659: typedef const char* MatMFFDType;
1660: #define MATMFFD_DS "ds"
1661: #define MATMFFD_WP "wp"
1663: PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat,MatMFFDType);
1664: PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[],PetscErrorCode (*)(MatMFFD));
1666: PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal);
1667: PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool );
1669: PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring,MatMFFDType);
1671: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1672: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
1674: /*
1675: PETSc interface to MUMPS
1676: */
1677: #ifdef PETSC_HAVE_MUMPS
1678: PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
1679: PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat,PetscInt,PetscInt*);
1680: PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal);
1681: PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat,PetscInt,PetscReal*);
1683: PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat,PetscInt,PetscInt*);
1684: PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat,PetscInt,PetscInt*);
1685: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat,PetscInt,PetscReal*);
1686: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat,PetscInt,PetscReal*);
1687: PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat,Mat);
1688: #endif
1690: /*
1691: PETSc interface to Mkl_Pardiso
1692: */
1693: #ifdef PETSC_HAVE_MKL_PARDISO
1694: PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt);
1695: #endif
1697: /*
1698: PETSc interface to Mkl_CPardiso
1699: */
1700: #ifdef PETSC_HAVE_MKL_CPARDISO
1701: PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt);
1702: #endif
1704: /*
1705: PETSc interface to SUPERLU
1706: */
1707: #ifdef PETSC_HAVE_SUPERLU
1708: PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal);
1709: #endif
1711: /*
1712: PETSc interface to SUPERLU_DIST
1713: */
1714: #ifdef PETSC_HAVE_SUPERLU_DIST
1715: PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat,PetscScalar*);
1716: #endif
1718: /*
1719: PETSc interface to STRUMPACK
1720: */
1721: #ifdef PETSC_HAVE_STRUMPACK
1722: /*E
1723: MatSTRUMPACKReordering - sparsity reducing ordering to be used in STRUMPACK
1725: Level: intermediate
1726: E*/
1727: typedef enum {MAT_STRUMPACK_NATURAL=0,
1728: MAT_STRUMPACK_METIS=1,
1729: MAT_STRUMPACK_PARMETIS=2,
1730: MAT_STRUMPACK_SCOTCH=3,
1731: MAT_STRUMPACK_PTSCOTCH=4,
1732: MAT_STRUMPACK_RCM=5} MatSTRUMPACKReordering;
1733: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat,MatSTRUMPACKReordering);
1734: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat,PetscBool);
1735: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSRelTol(Mat,PetscReal);
1736: PETSC_DEPRECATED ("Use MatSTRUMPACKSetHSSRelTol()") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSRelCompTol(Mat mat,PetscReal rtol) {return MatSTRUMPACKSetHSSRelTol(mat,rtol);}
1737: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSAbsTol(Mat,PetscReal);
1738: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMinSepSize(Mat,PetscInt);
1739: PETSC_DEPRECATED ("Use MatSTRUMPACKSetHSSMinSepSize()") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSMinSize(Mat mat,PetscInt hssminsize) {return MatSTRUMPACKSetHSSMinSepSize(mat,hssminsize);}
1740: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMaxRank(Mat,PetscInt);
1741: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSLeafSize(Mat,PetscInt);
1742: #endif
1745: #ifdef PETSC_HAVE_CUDA
1746: /*E
1747: MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU)
1748: matrices.
1750: Not Collective
1752: + MAT_CUSPARSE_CSR - Compressed Sparse Row
1753: . MAT_CUSPARSE_ELL - Ellpack (requires CUDA 4.2 or later).
1754: - MAT_CUSPARSE_HYB - Hybrid, a combination of Ellpack and Coordinate format (requires CUDA 4.2 or later).
1756: Level: intermediate
1758: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
1760: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation
1761: E*/
1763: typedef enum {MAT_CUSPARSE_CSR, MAT_CUSPARSE_ELL, MAT_CUSPARSE_HYB} MatCUSPARSEStorageFormat;
1765: /* these will be strings associated with enumerated type defined above */
1766: PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[];
1768: /*E
1769: MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU)
1770: matrices whose operation should use a particular storage format.
1772: Not Collective
1774: + MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
1775: . MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
1776: . MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
1777: - MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices
1779: Level: intermediate
1781: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat
1782: E*/
1783: typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation;
1785: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1786: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1787: PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat);
1788: #endif
1790: #if defined(PETSC_HAVE_VIENNACL)
1791: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1792: PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1793: #endif
1795: /*
1796: PETSc interface to FFTW
1797: */
1798: #if defined(PETSC_HAVE_FFTW)
1799: PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec);
1800: PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec);
1801: PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*);
1802: #endif
1804: PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*);
1805: PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*);
1806: PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]);
1807: PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]);
1808: PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***);
1809: PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*);
1810: PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType);
1811: PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]);
1812: PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat);
1814: PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal);
1815: PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*);
1817: PETSC_EXTERN PetscErrorCode MatSubdomainsCreateCoalesce(Mat,PetscInt,PetscInt*,IS**);
1819: PETSC_EXTERN PetscErrorCode MatPreallocatorPreallocate(Mat,PetscBool,Mat);
1821: PETSC_INTERN PetscErrorCode MatHeaderMerge(Mat,Mat*);
1822: PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat,Mat*);
1824: #endif