Actual source code: petscmat.h
petsc-master 2020-05-31
1: /*
2: Include file for the matrix component of PETSc
3: */
4: #ifndef PETSCMAT_H
5: #define 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: .seealso: MatCreate(), MatType, MatSetType(), MatDestroy()
15: S*/
16: typedef struct _p_Mat* Mat;
18: /*J
19: MatType - String with the name of a PETSc matrix type
21: Level: beginner
23: .seealso: MatSetType(), Mat, MatSolverType, MatRegister()
24: J*/
25: typedef const char* MatType;
26: #define MATSAME "same"
27: #define MATMAIJ "maij"
28: #define MATSEQMAIJ "seqmaij"
29: #define MATMPIMAIJ "mpimaij"
30: #define MATKAIJ "kaij"
31: #define MATSEQKAIJ "seqkaij"
32: #define MATMPIKAIJ "mpikaij"
33: #define MATIS "is"
34: #define MATAIJ "aij"
35: #define MATSEQAIJ "seqaij"
36: #define MATMPIAIJ "mpiaij"
37: #define MATAIJCRL "aijcrl"
38: #define MATSEQAIJCRL "seqaijcrl"
39: #define MATMPIAIJCRL "mpiaijcrl"
40: #define MATAIJCUSPARSE "aijcusparse"
41: #define MATSEQAIJCUSPARSE "seqaijcusparse"
42: #define MATMPIAIJCUSPARSE "mpiaijcusparse"
43: #define MATAIJVIENNACL "aijviennacl"
44: #define MATSEQAIJVIENNACL "seqaijviennacl"
45: #define MATMPIAIJVIENNACL "mpiaijviennacl"
46: #define MATAIJPERM "aijperm"
47: #define MATSEQAIJPERM "seqaijperm"
48: #define MATMPIAIJPERM "mpiaijperm"
49: #define MATAIJSELL "aijsell"
50: #define MATSEQAIJSELL "seqaijsell"
51: #define MATMPIAIJSELL "mpiaijsell"
52: #define MATAIJMKL "aijmkl"
53: #define MATSEQAIJMKL "seqaijmkl"
54: #define MATMPIAIJMKL "mpiaijmkl"
55: #define MATBAIJMKL "baijmkl"
56: #define MATSEQBAIJMKL "seqbaijmkl"
57: #define MATMPIBAIJMKL "mpibaijmkl"
58: #define MATSHELL "shell"
59: #define MATDENSE "dense"
60: #define MATDENSECUDA "densecuda"
61: #define MATSEQDENSE "seqdense"
62: #define MATSEQDENSECUDA "seqdensecuda"
63: #define MATMPIDENSE "mpidense"
64: #define MATMPIDENSECUDA "mpidensecuda"
65: #define MATELEMENTAL "elemental"
66: #define MATBAIJ "baij"
67: #define MATSEQBAIJ "seqbaij"
68: #define MATMPIBAIJ "mpibaij"
69: #define MATMPIADJ "mpiadj"
70: #define MATSBAIJ "sbaij"
71: #define MATSEQSBAIJ "seqsbaij"
72: #define MATMPISBAIJ "mpisbaij"
73: #define MATDAAD "daad"
74: #define MATMFFD "mffd"
75: #define MATNORMAL "normal"
76: #define MATNORMALHERMITIAN "normalh"
77: #define MATLRC "lrc"
78: #define MATSCATTER "scatter"
79: #define MATBLOCKMAT "blockmat"
80: #define MATCOMPOSITE "composite"
81: #define MATFFT "fft"
82: #define MATFFTW "fftw"
83: #define MATSEQCUFFT "seqcufft"
84: #define MATTRANSPOSEMAT "transpose"
85: #define MATSCHURCOMPLEMENT "schurcomplement"
86: #define MATPYTHON "python"
87: #define MATHYPRE "hypre"
88: #define MATHYPRESTRUCT "hyprestruct"
89: #define MATHYPRESSTRUCT "hypresstruct"
90: #define MATSUBMATRIX "submatrix"
91: #define MATLOCALREF "localref"
92: #define MATNEST "nest"
93: #define MATPREALLOCATOR "preallocator"
94: #define MATSELL "sell"
95: #define MATSEQSELL "seqsell"
96: #define MATMPISELL "mpisell"
97: #define MATDUMMY "dummy"
98: #define MATLMVM "lmvm"
99: #define MATLMVMDFP "lmvmdfp"
100: #define MATLMVMBFGS "lmvmbfgs"
101: #define MATLMVMSR1 "lmvmsr1"
102: #define MATLMVMBROYDEN "lmvmbroyden"
103: #define MATLMVMBADBROYDEN "lmvmbadbroyden"
104: #define MATLMVMSYMBROYDEN "lmvmsymbroyden"
105: #define MATLMVMSYMBADBROYDEN "lmvmsymbadbroyden"
106: #define MATLMVMDIAGBROYDEN "lmvmdiagbroyden"
107: #define MATCONSTANTDIAGONAL "constantdiagonal"
108: #define MATHARA "hara"
110: /*J
111: MatSolverType - String with the name of a PETSc matrix solver type.
113: For example: "petsc" indicates what PETSc provides, "superlu_dist" the parallel SuperLU_DIST package etc
115: Level: beginner
117: Notes: MATSOLVERUMFPACK, MATSOLVERCHOLMOD, MATSOLVERKLU form the SuiteSparse package for which you can use --download-suitesparse
119: .seealso: MatGetFactor(), PCFactorSetMatSolverType(), PCFactorGetMatSolverType()
120: J*/
121: typedef const char* MatSolverType;
122: #define MATSOLVERSUPERLU "superlu"
123: #define MATSOLVERSUPERLU_DIST "superlu_dist"
124: #define MATSOLVERSTRUMPACK "strumpack"
125: #define MATSOLVERUMFPACK "umfpack"
126: #define MATSOLVERCHOLMOD "cholmod"
127: #define MATSOLVERKLU "klu"
128: #define MATSOLVERSPARSEELEMENTAL "sparseelemental"
129: #define MATSOLVERELEMENTAL "elemental"
130: #define MATSOLVERESSL "essl"
131: #define MATSOLVERLUSOL "lusol"
132: #define MATSOLVERMUMPS "mumps"
133: #define MATSOLVERMKL_PARDISO "mkl_pardiso"
134: #define MATSOLVERMKL_CPARDISO "mkl_cpardiso"
135: #define MATSOLVERPASTIX "pastix"
136: #define MATSOLVERMATLAB "matlab"
137: #define MATSOLVERPETSC "petsc"
138: #define MATSOLVERBAS "bas"
139: #define MATSOLVERCUSPARSE "cusparse"
140: #define MATSOLVERCUDA "cuda"
142: /*E
143: MatFactorType - indicates what type of factorization is requested
145: Level: beginner
147: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
149: .seealso: MatSolverType, MatGetFactor()
150: E*/
151: typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType;
152: PETSC_EXTERN const char *const MatFactorTypes[];
154: PETSC_EXTERN PetscErrorCode MatGetFactor(Mat,MatSolverType,MatFactorType,Mat*);
155: PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat,MatSolverType,MatFactorType,PetscBool *);
156: PETSC_EXTERN PetscErrorCode MatFactorGetSolverType(Mat,MatSolverType*);
157: PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat,MatFactorType*);
158: PETSC_EXTERN PetscErrorCode MatSetFactorType(Mat,MatFactorType);
159: PETSC_EXTERN PetscErrorCode MatSolverTypeRegister(MatSolverType,MatType,MatFactorType,PetscErrorCode(*)(Mat,MatFactorType,Mat*));
160: PETSC_EXTERN PetscErrorCode MatSolverTypeGet(MatSolverType,MatType,MatFactorType,PetscBool*,PetscBool*,PetscErrorCode (**)(Mat,MatFactorType,Mat*));
161: typedef MatSolverType MatSolverPackage PETSC_DEPRECATED_TYPEDEF("Use MatSolverType (since version 3.9)");
162: PETSC_DEPRECATED_FUNCTION("Use MatSolverTypeRegister() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSolverPackageRegister(MatSolverType stype,MatType mtype,MatFactorType ftype,PetscErrorCode(*f)(Mat,MatFactorType,Mat*))
163: { return MatSolverTypeRegister(stype,mtype,ftype,f); }
164: PETSC_DEPRECATED_FUNCTION("Use MatSolverTypeGet() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSolverPackageGet(MatSolverType stype,MatType mtype,MatFactorType ftype,PetscBool *foundmtype,PetscBool *foundstype,PetscErrorCode(**f)(Mat,MatFactorType,Mat*))
165: { return MatSolverTypeGet(stype,mtype,ftype,foundmtype,foundstype,f); }
167: /*E
168: MatProductType - indicates what type of matrix product is requested
170: Level: beginner
172: .seealso: MatSolverType, MatProductSetType()
173: E*/
174: typedef enum {MATPRODUCT_UNSPECIFIED=0,MATPRODUCT_AB,MATPRODUCT_AtB,MATPRODUCT_ABt,MATPRODUCT_PtAP,MATPRODUCT_RARt,MATPRODUCT_ABC} MatProductType;
175: PETSC_EXTERN const char *const MatProductTypes[];
177: /*J
178: MatProductAlgorithm - String with the name of an algorithm for a PETSc matrix product implementation
180: Level: beginner
182: .seealso: MatSetType(), Mat, MatSolverType, MatRegister(), MatProductSetAlgorithm(), MatProductType
183: J*/
184: typedef const char* MatProductAlgorithm;
185: #define MATPRODUCTALGORITHM_DEFAULT "default"
187: PETSC_EXTERN PetscErrorCode MatProductCreate(Mat,Mat,Mat,Mat*);
188: PETSC_EXTERN PetscErrorCode MatProductCreateWithMat(Mat,Mat,Mat,Mat);
189: PETSC_EXTERN PetscErrorCode MatProductSetType(Mat,MatProductType);
190: PETSC_EXTERN PetscErrorCode MatProductSetAlgorithm(Mat,MatProductAlgorithm);
191: PETSC_EXTERN PetscErrorCode MatProductSetFill(Mat,PetscReal);
192: PETSC_EXTERN PetscErrorCode MatProductSetFromOptions(Mat);
193: PETSC_EXTERN PetscErrorCode MatProductSymbolic(Mat);
194: PETSC_EXTERN PetscErrorCode MatProductNumeric(Mat);
195: PETSC_EXTERN PetscErrorCode MatProductReplaceMats(Mat,Mat,Mat,Mat);
196: PETSC_EXTERN PetscErrorCode MatProductClear(Mat);
197: PETSC_EXTERN PetscErrorCode MatProductView(Mat,PetscViewer);
199: /* Logging support */
200: #define MAT_FILE_CLASSID 1211216 /* used to indicate matrices in binary files */
201: PETSC_EXTERN PetscClassId MAT_CLASSID;
202: PETSC_EXTERN PetscClassId MAT_COLORING_CLASSID;
203: PETSC_EXTERN PetscClassId MAT_FDCOLORING_CLASSID;
204: PETSC_EXTERN PetscClassId MAT_TRANSPOSECOLORING_CLASSID;
205: PETSC_EXTERN PetscClassId MAT_PARTITIONING_CLASSID;
206: PETSC_EXTERN PetscClassId MAT_COARSEN_CLASSID;
207: PETSC_EXTERN PetscClassId MAT_NULLSPACE_CLASSID;
208: PETSC_EXTERN PetscClassId MATMFFD_CLASSID;
210: /*E
211: MatReuse - Indicates if matrices obtained from a previous call to MatCreateSubMatrices(), MatCreateSubMatrix(), MatConvert() or several other functions
212: are to be reused to store the new matrix values.
214: $ MAT_INITIAL_MATRIX - create a new matrix
215: $ MAT_REUSE_MATRIX - reuse the matrix created with a previous call that used MAT_INITIAL_MATRIX
216: $ MAT_INPLACE_MATRIX - replace the first input matrix with the new matrix (not applicable to all functions)
217: $ MAT_IGNORE_MATRIX - do not create a new matrix or reuse a give matrix, just ignore that matrix argument (not applicable to all functions)
219: Level: beginner
221: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
223: .seealso: MatCreateSubMatrices(), MatCreateSubMatrix(), MatDestroyMatrices(), MatConvert()
224: E*/
225: typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX,MAT_INPLACE_MATRIX} MatReuse;
227: /*E
228: MatCreateSubMatrixOption - Indicates if matrices obtained from a call to MatCreateSubMatrices()
229: include the matrix values. Currently it is only used by MatGetSeqNonzerostructure().
231: Level: beginner
233: .seealso: MatGetSeqNonzerostructure()
234: E*/
235: typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatCreateSubMatrixOption;
237: PETSC_EXTERN PetscErrorCode MatInitializePackage(void);
239: PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm,Mat*);
240: PETSC_EXTERN PetscErrorCode MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
241: PETSC_EXTERN PetscErrorCode MatSetType(Mat,MatType);
242: PETSC_EXTERN PetscErrorCode MatGetVecType(Mat,VecType*);
243: PETSC_EXTERN PetscErrorCode MatSetVecType(Mat,VecType);
244: PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat);
245: PETSC_EXTERN PetscErrorCode MatViewFromOptions(Mat,PetscObject,const char[]);
246: PETSC_EXTERN PetscErrorCode MatRegister(const char[],PetscErrorCode(*)(Mat));
247: PETSC_EXTERN PetscErrorCode MatRegisterRootName(const char[],const char[],const char[]);
248: PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat,const char[]);
249: PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat,const char[]);
250: PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat,const char*[]);
251: PETSC_EXTERN PetscErrorCode MatSetErrorIfFailure(Mat,PetscBool);
253: PETSC_EXTERN PetscFunctionList MatList;
254: PETSC_EXTERN PetscFunctionList MatColoringList;
255: PETSC_EXTERN PetscFunctionList MatPartitioningList;
257: /*E
258: MatStructure - Indicates if two matrices have the same nonzero structure
260: Level: beginner
262: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
264: .seealso: MatCopy(), MatAXPY()
265: E*/
266: typedef enum {DIFFERENT_NONZERO_PATTERN,SUBSET_NONZERO_PATTERN,SAME_NONZERO_PATTERN} MatStructure;
268: #if defined PETSC_HAVE_MKL_SPARSE
269: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
270: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
271: PETSC_EXTERN PetscErrorCode MatCreateBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
272: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
273: #endif
275: PETSC_EXTERN PetscErrorCode MatCreateSeqSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
276: PETSC_EXTERN PetscErrorCode MatCreateSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
277: PETSC_EXTERN PetscErrorCode MatSeqSELLSetPreallocation(Mat,PetscInt,const PetscInt[]);
278: PETSC_EXTERN PetscErrorCode MatMPISELLSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
280: PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
281: PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
282: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
283: PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
284: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
285: PETSC_EXTERN PetscErrorCode MatUpdateMPIAIJWithArrays(Mat,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
286: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
287: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSeqAIJ(MPI_Comm,Mat,Mat,const PetscInt[],Mat*);
289: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
290: PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
291: PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*);
293: PETSC_EXTERN PetscErrorCode MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
294: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
296: PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
297: PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
298: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
299: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
300: PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],const PetscInt[]);
302: PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
303: PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat,Mat*);
304: PETSC_EXTERN PetscErrorCode MatCreateNormalHermitian(Mat,Mat*);
305: PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat,Mat,Vec,Mat,Mat*);
306: PETSC_EXTERN PetscErrorCode MatLRCGetMats(Mat,Mat*,Mat*,Vec*,Mat*);
307: PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,ISLocalToGlobalMapping,Mat*);
308: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
309: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
311: PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*);
312: PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter);
313: PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*);
314: PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
315: PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat,Mat);
316: PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat);
317: typedef enum {MAT_COMPOSITE_MERGE_RIGHT,MAT_COMPOSITE_MERGE_LEFT} MatCompositeMergeType;
318: PETSC_EXTERN PetscErrorCode MatCompositeSetMergeType(Mat,MatCompositeMergeType);
319: PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
320: typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
321: PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat,MatCompositeType);
322: PETSC_EXTERN PetscErrorCode MatCompositeGetType(Mat,MatCompositeType*);
323: PETSC_EXTERN PetscErrorCode MatCompositeSetMatStructure(Mat,MatStructure);
324: PETSC_EXTERN PetscErrorCode MatCompositeGetMatStructure(Mat,MatStructure*);
325: PETSC_EXTERN PetscErrorCode MatCompositeGetNumberMat(Mat,PetscInt*);
326: PETSC_EXTERN PetscErrorCode MatCompositeGetMat(Mat,PetscInt,Mat*);
327: PETSC_EXTERN PetscErrorCode MatCompositeSetScalings(Mat,const PetscScalar*);
329: PETSC_EXTERN PetscErrorCode MatCreateFFT(MPI_Comm,PetscInt,const PetscInt[],MatType,Mat*);
330: PETSC_EXTERN PetscErrorCode MatCreateSeqCUFFT(MPI_Comm,PetscInt,const PetscInt[],Mat*);
332: PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*);
333: PETSC_EXTERN PetscErrorCode MatTransposeGetMat(Mat,Mat*);
334: PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat,Mat*);
335: PETSC_EXTERN PetscErrorCode MatHermitianTransposeGetMat(Mat,Mat*);
336: PETSC_EXTERN PetscErrorCode MatCreateSubMatrixVirtual(Mat,IS,IS,Mat*);
337: PETSC_EXTERN PetscErrorCode MatSubMatrixVirtualUpdate(Mat,Mat,IS,IS);
338: PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*);
339: PETSC_EXTERN PetscErrorCode MatCreateConstantDiagonal(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar,Mat*);
341: #if defined(PETSC_HAVE_HYPRE)
342: PETSC_EXTERN PetscErrorCode MatHYPRESetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
343: #endif
345: PETSC_EXTERN PetscErrorCode MatPythonSetType(Mat,const char[]);
347: PETSC_EXTERN PetscErrorCode MatResetPreallocation(Mat);
348: PETSC_EXTERN PetscErrorCode MatSetUp(Mat);
349: PETSC_EXTERN PetscErrorCode MatDestroy(Mat*);
350: PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat,PetscObjectState*);
352: PETSC_EXTERN PetscErrorCode MatConjugate(Mat);
353: PETSC_EXTERN PetscErrorCode MatRealPart(Mat);
354: PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat);
355: PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,Mat*);
356: PETSC_EXTERN PetscErrorCode MatGetTrace(Mat,PetscScalar*);
357: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat,const PetscScalar **);
358: PETSC_EXTERN PetscErrorCode MatInvertVariableBlockDiagonal(Mat,PetscInt,const PetscInt*,PetscScalar*);
359: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonalMat(Mat,Mat);
361: /* ------------------------------------------------------------*/
362: PETSC_EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
363: PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
364: PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
365: PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
366: PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat,PetscInt,PetscInt,PetscInt[],const PetscScalar[]);
367: PETSC_EXTERN PetscErrorCode MatSetRandom(Mat,PetscRandom);
369: /*S
370: MatStencil - Data structure (C struct) for storing information about a single row or
371: column of a matrix as indexed on an associated grid. These are arguments to MatSetStencil() and MatSetBlockStencil()
373: 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).
374: 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.
376: For stencil access to vectors see DMDAVecGetArray(), DMDAVecGetArrayF90().
378: Fortran usage is different, see MatSetValuesStencil() for details.
380: Level: beginner
382: .seealso: MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockedStencil(), DMDAVecGetArray(), DMDAVecGetArrayF90()
383: S*/
384: typedef struct {
385: PetscInt k,j,i,c;
386: } MatStencil;
388: PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
389: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
390: PETSC_EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
392: /*E
393: MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
394: to continue to add or insert values to it
396: Level: beginner
398: .seealso: MatAssemblyBegin(), MatAssemblyEnd()
399: E*/
400: typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
401: PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType);
402: PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType);
403: PETSC_EXTERN PetscErrorCode MatAssembled(Mat,PetscBool *);
407: /*E
408: MatOption - Options that may be set for a matrix and its behavior or storage
410: Level: beginner
412: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
413: Any additions/changes here must also be made in src/mat/interface/dlregismat.c in MatOptions[]
415: Developer Notes:
416: Entries that are negative need not be called collectively by all processes.
418: .seealso: MatSetOption()
419: E*/
420: typedef enum {MAT_OPTION_MIN = -3,
421: MAT_UNUSED_NONZERO_LOCATION_ERR = -2,
422: MAT_ROW_ORIENTED = -1,
423: MAT_SYMMETRIC = 1,
424: MAT_STRUCTURALLY_SYMMETRIC = 2,
425: MAT_NEW_DIAGONALS = 3,
426: MAT_IGNORE_OFF_PROC_ENTRIES = 4,
427: MAT_USE_HASH_TABLE = 5,
428: MAT_KEEP_NONZERO_PATTERN = 6,
429: MAT_IGNORE_ZERO_ENTRIES = 7,
430: MAT_USE_INODES = 8,
431: MAT_HERMITIAN = 9,
432: MAT_SYMMETRY_ETERNAL = 10,
433: MAT_NEW_NONZERO_LOCATION_ERR = 11,
434: MAT_IGNORE_LOWER_TRIANGULAR = 12,
435: MAT_ERROR_LOWER_TRIANGULAR = 13,
436: MAT_GETROW_UPPERTRIANGULAR = 14,
437: MAT_SPD = 15,
438: MAT_NO_OFF_PROC_ZERO_ROWS = 16,
439: MAT_NO_OFF_PROC_ENTRIES = 17,
440: MAT_NEW_NONZERO_LOCATIONS = 18,
441: MAT_NEW_NONZERO_ALLOCATION_ERR = 19,
442: MAT_SUBSET_OFF_PROC_ENTRIES = 20,
443: MAT_SUBMAT_SINGLEIS = 21,
444: MAT_STRUCTURE_ONLY = 22,
445: MAT_SORTED_FULL = 23,
446: MAT_OPTION_MAX = 24} MatOption;
448: PETSC_EXTERN const char *const *MatOptions;
449: PETSC_EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscBool);
450: PETSC_EXTERN PetscErrorCode MatGetOption(Mat,MatOption,PetscBool*);
451: PETSC_EXTERN PetscErrorCode MatPropagateSymmetryOptions(Mat,Mat);
452: PETSC_EXTERN PetscErrorCode MatGetType(Mat,MatType*);
454: PETSC_EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
455: PETSC_EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
456: PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
457: PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat);
458: PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat);
459: PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt);
460: PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat,PetscScalar *[]);
461: PETSC_EXTERN PetscErrorCode MatSeqAIJGetArrayRead(Mat,const PetscScalar *[]);
462: PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat,PetscScalar *[]);
463: PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArrayRead(Mat,const PetscScalar *[]);
464: PETSC_EXTERN PetscErrorCode MatSeqAIJGetMaxRowNonzeros(Mat,PetscInt*);
465: PETSC_EXTERN PetscErrorCode MatSeqAIJSetValuesLocalFast(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
466: PETSC_EXTERN PetscErrorCode MatSeqAIJSetType(Mat,MatType);
467: PETSC_EXTERN PetscErrorCode MatSeqAIJRegister(const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat *));
468: PETSC_EXTERN PetscFunctionList MatSeqAIJList;
469: PETSC_EXTERN PetscErrorCode MatSeqBAIJGetArray(Mat,PetscScalar *[]);
470: PETSC_EXTERN PetscErrorCode MatSeqBAIJRestoreArray(Mat,PetscScalar *[]);
471: PETSC_EXTERN PetscErrorCode MatSeqSBAIJGetArray(Mat,PetscScalar *[]);
472: PETSC_EXTERN PetscErrorCode MatSeqSBAIJRestoreArray(Mat,PetscScalar *[]);
473: PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat,PetscScalar *[]);
474: PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat,PetscScalar *[]);
475: PETSC_EXTERN PetscErrorCode MatDensePlaceArray(Mat,const PetscScalar[]);
476: PETSC_EXTERN PetscErrorCode MatDenseReplaceArray(Mat,const PetscScalar[]);
477: PETSC_EXTERN PetscErrorCode MatDenseResetArray(Mat);
478: PETSC_EXTERN PetscErrorCode MatDenseGetArrayRead(Mat,const PetscScalar *[]);
479: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayRead(Mat,const PetscScalar *[]);
480: PETSC_EXTERN PetscErrorCode MatDenseGetArrayWrite(Mat,PetscScalar *[]);
481: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayWrite(Mat,PetscScalar *[]);
482: PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *);
483: PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt);
484: PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat,PetscInt *,PetscInt *);
485: PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat,PetscInt,PetscInt);
486: PETSC_EXTERN PetscErrorCode MatSetBlockSizesFromMats(Mat,Mat,Mat);
487: PETSC_EXTERN PetscErrorCode MatSetVariableBlockSizes(Mat,PetscInt,PetscInt*);
488: PETSC_EXTERN PetscErrorCode MatGetVariableBlockSizes(Mat,PetscInt*,const PetscInt**);
490: PETSC_EXTERN PetscErrorCode MatDenseGetColumn(Mat,PetscInt,PetscScalar*[]);
491: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumn(Mat,PetscScalar*[]);
492: PETSC_EXTERN PetscErrorCode MatDenseGetColumnVec(Mat,PetscInt,Vec*);
493: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVec(Mat,PetscInt,Vec*);
494: PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecRead(Mat,PetscInt,Vec*);
495: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecRead(Mat,PetscInt,Vec*);
496: PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecWrite(Mat,PetscInt,Vec*);
497: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecWrite(Mat,PetscInt,Vec*);
499: PETSC_EXTERN PetscErrorCode MatMult(Mat,Vec,Vec);
500: PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec);
501: PETSC_EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec);
502: PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec);
503: PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec);
504: PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *);
505: PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *);
506: PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec);
507: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
508: PETSC_EXTERN PetscErrorCode MatMultConstrained(Mat,Vec,Vec);
509: PETSC_EXTERN PetscErrorCode MatMultTransposeConstrained(Mat,Vec,Vec);
510: PETSC_EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat);
511: PETSC_EXTERN PetscErrorCode MatMatSolveTranspose(Mat,Mat,Mat);
512: PETSC_EXTERN PetscErrorCode MatMatTransposeSolve(Mat,Mat,Mat);
513: PETSC_EXTERN PetscErrorCode MatResidual(Mat,Vec,Vec,Vec);
515: /*E
516: MatDuplicateOption - Indicates if a duplicated sparse matrix should have
517: its numerical values copied over or just its nonzero structure.
519: Level: beginner
521: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
523: $ MAT_DO_NOT_COPY_VALUES - Create a matrix using the same nonzero pattern as the original matrix,
524: $ with zeros for the numerical values.
525: $ MAT_COPY_VALUES - Create a matrix with the same nonzero pattern as the original matrix
526: $ and with the same numerical values.
527: $ MAT_SHARE_NONZERO_PATTERN - Create a matrix that shares the nonzero structure with the previous matrix
528: $ and does not copy it, using zeros for the numerical values. The parent and
529: $ child matrices will share their index (i and j) arrays, and you cannot
530: $ insert new nonzero entries into either matrix.
532: Notes:
533: Many matrix types (including SeqAIJ) do not support the MAT_SHARE_NONZERO_PATTERN optimization; in
534: this case the behavior is as if MAT_DO_NOT_COPY_VALUES has been specified.
536: .seealso: MatDuplicate()
537: E*/
538: typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;
540: PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*);
541: PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*);
544: PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure);
545: PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer);
546: PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *);
547: PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *);
548: PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *);
549: PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *);
550: PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *);
551: PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool *,PetscInt *);
552: PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer);
554: PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *);
555: PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *);
556: PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *);
557: PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *);
559: /*S
560: MatInfo - Context of matrix information, used with MatGetInfo()
562: In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
564: Level: intermediate
566: .seealso: MatGetInfo(), MatInfoType
567: S*/
568: typedef struct {
569: PetscLogDouble block_size; /* block size */
570: PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */
571: PetscLogDouble memory; /* memory allocated */
572: PetscLogDouble assemblies; /* number of matrix assemblies called */
573: PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */
574: PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
575: PetscLogDouble factor_mallocs; /* number of mallocs during factorization */
576: } MatInfo;
578: /*E
579: MatInfoType - Indicates if you want information about the local part of the matrix,
580: the entire parallel matrix or the maximum over all the local parts.
582: Level: beginner
584: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
586: .seealso: MatGetInfo(), MatInfo
587: E*/
588: typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
589: PETSC_EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*);
590: PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec);
591: PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]);
592: PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]);
593: PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
594: PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]);
595: PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat,Vec);
596: PETSC_EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*);
597: PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*);
598: PETSC_EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat*);
599: PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec);
600: PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode);
602: PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool*);
603: PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool*);
604: PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool*);
605: PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool*);
606: PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*);
607: PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
608: PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
609: PETSC_EXTERN PetscErrorCode MatMatTransposeMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
610: PETSC_EXTERN PetscErrorCode MatPtAPMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
611: PETSC_EXTERN PetscErrorCode MatRARtMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
612: PETSC_EXTERN PetscErrorCode MatIsLinear(Mat,PetscInt,PetscBool*);
614: PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal*);
615: PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal*);
616: PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat);
617: PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
618: PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec);
619: PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec);
620: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec);
621: PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
622: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec);
624: PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*);
625: PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*);
626: PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
627: PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**);
628: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
629: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**);
630: PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*);
632: PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
633: PETSC_DEPRECATED_FUNCTION("Use MatCreateSubMatrices() (since version 3.8)") 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);}
634: PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
635: PETSC_DEPRECATED_FUNCTION("Use MatCreateSubMatricesMPI() (since version 3.8)") 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);}
636: PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]);
637: PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt,Mat *[]);
638: PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,MatReuse,Mat *);
639: PETSC_DEPRECATED_FUNCTION("Use MatCreateSubMatrix() (since version 3.8)") PETSC_STATIC_INLINE PetscErrorCode MatGetSubMatrix(Mat mat,IS isrow,IS iscol,MatReuse cll,Mat *newmat) {return MatCreateSubMatrix(mat,isrow,iscol,cll,newmat);}
640: PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*);
641: PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*);
642: PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*);
643: PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*);
645: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
646: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
647: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat);
648: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*);
649: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
650: PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*);
651: PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);
653: PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
654: PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat mat,PetscInt n,IS is[],PetscInt ov);
655: PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat,PetscBool);
657: PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
659: PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
660: PETSC_EXTERN PetscErrorCode MatGalerkin(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
662: PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
663: PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*);
665: PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
666: PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*);
668: PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure);
669: PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure);
671: PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar);
672: PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar);
674: PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
675: PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*);
676: PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat,PetscLayout*,PetscLayout*);
677: PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
678: PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
679: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
680: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
681: PETSC_EXTERN PetscErrorCode MatGetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
682: PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
683: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
685: PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt);
686: PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
688: PETSC_EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec);
689: PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec);
690: PETSC_EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec);
691: PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat,Vec*,Vec*);
692: PETSC_DEPRECATED_FUNCTION("Use MatCreateVecs() (since version 3.6)") PETSC_STATIC_INLINE PetscErrorCode MatGetVecs(Mat mat,Vec *x,Vec *y) {return MatCreateVecs(mat,x,y);}
693: PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat,PetscInt,MPI_Comm,MatReuse,Mat*);
694: PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*);
695: PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*);
696: PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat,IS*);
697: PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
699: /*MC
700: MatSetValue - Set a single entry into a matrix.
702: Not collective
704: Synopsis:
705: #include <petscmat.h>
706: PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode)
708: Input Parameters:
709: + m - the matrix
710: . row - the row location of the entry
711: . col - the column location of the entry
712: . value - the value to insert
713: - mode - either INSERT_VALUES or ADD_VALUES
715: Notes:
716: For efficiency one should use MatSetValues() and set several or many
717: values simultaneously if possible.
719: Level: beginner
721: .seealso: MatSetValues(), MatSetValueLocal()
722: M*/
723: PETSC_STATIC_INLINE PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);}
725: PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);}
727: PETSC_STATIC_INLINE PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);}
729: /*MC
730: MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
731: row in a matrix providing the data that one can use to correctly preallocate the matrix.
733: Synopsis:
734: #include <petscmat.h>
735: PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
737: Collective
739: Input Parameters:
740: + comm - the communicator that will share the eventually allocated matrix
741: . nrows - the number of LOCAL rows in the matrix
742: - ncols - the number of LOCAL columns in the matrix
744: Output Parameters:
745: + dnz - the array that will be passed to the matrix preallocation routines
746: - onz - the other array passed to the matrix preallocation routines
748: Level: intermediate
750: Notes:
751: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
753: Do not malloc or free dnz and onz, that is handled internally by these routines
755: This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
757: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
758: MatPreallocateSymmetricSetLocalBlock()
759: M*/
760: #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
761: do { \
762: PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ncols = (ncols),__rstart,__start,__end; \
763: _4_PetscCalloc2((size_t)__nrows,&dnz,(size_t)__nrows,&onz);CHKERRQ(_4_ierr); \
764: __start = 0; __end = __start; \
765: _4_MPI_Scan(&__ncols,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ncols;\
766: _4_MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows; \
767: do { } while(0)
769: /*MC
770: MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
771: inserted using a local number of the rows and columns
773: Synopsis:
774: #include <petscmat.h>
775: PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
777: Not Collective
779: Input Parameters:
780: + map - the row mapping from local numbering to global numbering
781: . nrows - the number of rows indicated
782: . rows - the indices of the rows
783: . cmap - the column mapping from local to global numbering
784: . ncols - the number of columns in the matrix
785: . cols - the columns indicated
786: . dnz - the array that will be passed to the matrix preallocation routines
787: - onz - the other array passed to the matrix preallocation routines
789: Level: intermediate
791: Notes:
792: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
794: Do not malloc or free dnz and onz, that is handled internally by these routines
796: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
797: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocalRemoveDups()
798: M*/
799: #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
800: do {\
801: PetscInt __l;\
802: _4_ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
803: _4_ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
804: for (__l=0;__l<nrows;__l++) {\
805: _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
806: }\
807: } while (0)
809: /*MC
810: MatPreallocateSetLocalRemoveDups - Indicates the locations (rows and columns) in the matrix where nonzeros will be
811: inserted using a local number of the rows and columns. This version removes any duplicate columns in cols
813: Synopsis:
814: #include <petscmat.h>
815: PetscErrorCode MatPreallocateSetLocalRemoveDups(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
817: Not Collective
819: Input Parameters:
820: + map - the row mapping from local numbering to global numbering
821: . nrows - the number of rows indicated
822: . rows - the indices of the rows (these values are mapped to the global values)
823: . cmap - the column mapping from local to global numbering
824: . ncols - the number of columns in the matrix (this value will be changed if duplicate columns are found)
825: . cols - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed)
826: . dnz - the array that will be passed to the matrix preallocation routines
827: - onz - the other array passed to the matrix preallocation routines
829: Level: intermediate
831: Notes:
832: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
834: Do not malloc or free dnz and onz, that is handled internally by these routines
836: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
837: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal()
838: M*/
839: #define MatPreallocateSetLocalRemoveDups(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
840: do {\
841: PetscInt __l;\
842: _4_ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
843: _4_ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
844: _4_PetscSortRemoveDupsInt(&ncols,cols);CHKERRQ(_4_ierr);\
845: for (__l=0;__l<nrows;__l++) {\
846: _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
847: }\
848: } while (0)
850: /*MC
851: MatPreallocateSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
852: inserted using a local number of the rows and columns
854: Synopsis:
855: #include <petscmat.h>
856: PetscErrorCode MatPreallocateSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
858: Not Collective
860: Input Parameters:
861: + map - the row mapping from local numbering to global numbering
862: . nrows - the number of rows indicated
863: . rows - the indices of the rows
864: . cmap - the column mapping from local to global numbering
865: . ncols - the number of columns in the matrix
866: . cols - the columns indicated
867: . dnz - the array that will be passed to the matrix preallocation routines
868: - onz - the other array passed to the matrix preallocation routines
870: Level: intermediate
872: Notes:
873: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
875: Do not malloc or free dnz and onz, that is handled internally by these routines
877: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
878: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock()
879: M*/
880: #define MatPreallocateSetLocalBlock(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
881: do {\
882: PetscInt __l;\
883: _4_ISLocalToGlobalMappingApplyBlock(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
884: _4_ISLocalToGlobalMappingApplyBlock(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
885: for (__l=0;__l<nrows;__l++) {\
886: _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
887: }\
888: } while (0)
890: /*MC
891: MatPreallocateSymmetricSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
892: inserted using a local number of the rows and columns
894: Synopsis:
895: #include <petscmat.h>
896: PetscErrorCode MatPreallocateSymmetricSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
898: Not Collective
900: Input Parameters:
901: + map - the mapping between local numbering and global numbering
902: . nrows - the number of rows indicated
903: . rows - the indices of the rows
904: . ncols - the number of columns in the matrix
905: . cols - the columns indicated
906: . dnz - the array that will be passed to the matrix preallocation routines
907: - onz - the other array passed to the matrix preallocation routines
909: Level: intermediate
911: Notes:
912: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
914: Do not malloc or free dnz and onz that is handled internally by these routines
916: .seealso: MatPreallocateFinalize(), MatPreallocateSet()
917: MatPreallocateInitialize(), MatPreallocateSetLocal()
918: M*/
919: #define MatPreallocateSymmetricSetLocalBlock(map,nrows,rows,ncols,cols,dnz,onz) 0;\
920: do {\
921: PetscInt __l;\
922: _4_ISLocalToGlobalMappingApplyBlock(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
923: _4_ISLocalToGlobalMappingApplyBlock(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
924: for (__l=0;__l<nrows;__l++) {\
925: _4_MatPreallocateSymmetricSetBlock((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
926: }\
927: } while (0)
929: /*MC
930: MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
931: inserted using a local number of the rows and columns
933: Synopsis:
934: #include <petscmat.h>
935: PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
937: Not Collective
939: Input Parameters:
940: + row - the row
941: . ncols - the number of columns in the matrix
942: - cols - the columns indicated
944: Output Parameters:
945: + dnz - the array that will be passed to the matrix preallocation routines
946: - onz - the other array passed to the matrix preallocation routines
948: Level: intermediate
950: Notes:
951: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
953: Do not malloc or free dnz and onz that is handled internally by these routines
955: This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
957: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
958: MatPreallocateInitialize(), MatPreallocateSetLocal()
959: M*/
960: #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
961: do { PetscInt __i; \
962: 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);\
963: 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);\
964: for (__i=0; __i<nc; __i++) {\
965: if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
966: else if (dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\
967: }\
968: } while (0)
970: /*MC
971: MatPreallocateSymmetricSetBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
972: inserted using a local number of the rows and columns
974: Synopsis:
975: #include <petscmat.h>
976: PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
978: Not Collective
980: Input Parameters:
981: + nrows - the number of rows indicated
982: . rows - the indices of the rows
983: . ncols - the number of columns in the matrix
984: . cols - the columns indicated
985: . dnz - the array that will be passed to the matrix preallocation routines
986: - onz - the other array passed to the matrix preallocation routines
988: Level: intermediate
990: Notes:
991: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
993: Do not malloc or free dnz and onz that is handled internally by these routines
995: This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
997: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateInitialize(),
998: MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal()
999: M*/
1000: #define MatPreallocateSymmetricSetBlock(row,nc,cols,dnz,onz) 0;\
1001: do { PetscInt __i; \
1002: for (__i=0; __i<nc; __i++) {\
1003: if (cols[__i] >= __end) onz[row - __rstart]++; \
1004: else if (cols[__i] >= row && dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\
1005: }\
1006: } while (0)
1008: /*MC
1009: MatPreallocateLocation - An alternative to MatPreallocateSet() that puts the nonzero locations into the matrix if it exists
1011: Synopsis:
1012: #include <petscmat.h>
1013: PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)
1015: Not Collective
1017: Input Parameters:
1018: + A - matrix
1019: . row - row where values exist (must be local to this process)
1020: . ncols - number of columns
1021: . cols - columns with nonzeros
1022: . dnz - the array that will be passed to the matrix preallocation routines
1023: - onz - the other array passed to the matrix preallocation routines
1025: Level: intermediate
1027: Notes:
1028: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
1030: Do not malloc or free dnz and onz that is handled internally by these routines
1032: This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.
1034: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
1035: MatPreallocateSymmetricSetLocalBlock()
1036: M*/
1037: #define MatPreallocateLocation(A,row,ncols,cols,dnz,onz) 0; do {if (A) {MatSetValues(A,1,&row,ncols,cols,NULL,INSERT_VALUES);} else { MatPreallocateSet(row,ncols,cols,dnz,onz);}} while(0)
1040: /*MC
1041: MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
1042: row in a matrix providing the data that one can use to correctly preallocate the matrix.
1044: Synopsis:
1045: #include <petscmat.h>
1046: PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
1048: Collective
1050: Input Parameters:
1051: + dnz - the array that was be passed to the matrix preallocation routines
1052: - onz - the other array passed to the matrix preallocation routines
1054: Level: intermediate
1056: Notes:
1057: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
1059: Do not malloc or free dnz and onz that is handled internally by these routines
1061: This is a MACRO not a function because it closes the { started in MatPreallocateInitialize().
1063: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
1064: MatPreallocateSymmetricSetLocalBlock()
1065: M*/
1066: #define MatPreallocateFinalize(dnz,onz) 0;_4_PetscFree2(dnz,onz);CHKERRQ(_4_ierr);} while(0)
1068: /* Routines unique to particular data structures */
1069: PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat,void *);
1071: PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*);
1072: PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
1074: PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
1075: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
1076: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1077: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1078: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1079: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool);
1081: #define MAT_SKIP_ALLOCATION -4
1083: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1084: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1085: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
1087: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1088: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1089: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1090: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
1091: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1092: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
1093: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1094: PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
1095: PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat,Mat*);
1096: PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
1097: PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
1098: PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
1099: PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
1100: PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*);
1102: PETSC_EXTERN PetscErrorCode MatDenseGetLDA(Mat,PetscInt*);
1103: PETSC_EXTERN PetscErrorCode MatDenseSetLDA(Mat,PetscInt);
1104: PETSC_DEPRECATED_FUNCTION("Use MatDenseSetLDA() (since version 3.14)") PETSC_STATIC_INLINE PetscErrorCode MatSeqDenseSetLDA(Mat A,PetscInt lda) {return MatDenseSetLDA(A,lda);}
1105: PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*);
1107: PETSC_EXTERN PetscErrorCode MatBlockMatSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1109: PETSC_EXTERN PetscErrorCode MatStoreValues(Mat);
1110: PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat);
1112: PETSC_EXTERN PetscErrorCode MatDAADSetCtx(Mat,void*);
1114: PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*);
1115: PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat,IS*);
1116: /*
1117: These routines are not usually accessed directly, rather solving is
1118: done through the KSP and PC interfaces.
1119: */
1121: /*J
1122: MatOrderingType - String with the name of a PETSc matrix ordering
1124: Level: beginner
1126: .seealso: MatGetOrdering()
1127: J*/
1128: typedef const char* MatOrderingType;
1129: #define MATORDERINGNATURAL "natural"
1130: #define MATORDERINGND "nd"
1131: #define MATORDERING1WD "1wd"
1132: #define MATORDERINGRCM "rcm"
1133: #define MATORDERINGQMD "qmd"
1134: #define MATORDERINGROWLENGTH "rowlength"
1135: #define MATORDERINGWBM "wbm"
1136: #define MATORDERINGSPECTRAL "spectral"
1137: #define MATORDERINGAMD "amd" /* only works if UMFPACK is installed with PETSc */
1138: #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 */
1140: PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*);
1141: PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*);
1142: PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*));
1143: PETSC_EXTERN PetscFunctionList MatOrderingList;
1145: PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1146: PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*);
1148: /*S
1149: MatFactorShiftType - Numeric Shift for factorizations
1151: Level: beginner
1153: .seealso: MatGetFactor()
1154: S*/
1155: typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
1156: PETSC_EXTERN const char *const MatFactorShiftTypes[];
1157: PETSC_EXTERN const char *const MatFactorShiftTypesDetail[];
1159: /*S
1160: MatFactorError - indicates what type of error was generated in a matrix factorization
1162: Level: beginner
1164: Developer Notes:
1165: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
1167: .seealso: MatGetFactor()
1168: S*/
1169: typedef enum {MAT_FACTOR_NOERROR,MAT_FACTOR_STRUCT_ZEROPIVOT,MAT_FACTOR_NUMERIC_ZEROPIVOT,MAT_FACTOR_OUTMEMORY,MAT_FACTOR_OTHER} MatFactorError;
1171: PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat,MatFactorError*);
1172: PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat);
1173: PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat,PetscReal*,PetscInt*);
1175: /*S
1176: MatFactorInfo - Data passed into the matrix factorization routines, and information about the resulting factorization
1178: In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
1179: $ MatFactorInfo info(MAT_FACTORINFO_SIZE)
1181: Notes:
1182: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
1184: You can use MatFactorInfoInitialize() to set default values.
1186: Level: developer
1188: .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1189: MatFactorInfoInitialize()
1191: S*/
1192: typedef struct {
1193: PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */
1194: PetscReal usedt;
1195: PetscReal dt; /* drop tolerance */
1196: PetscReal dtcol; /* tolerance for pivoting */
1197: PetscReal dtcount; /* maximum nonzeros to be allowed per row */
1198: PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1199: PetscReal levels; /* ICC/ILU(levels) */
1200: PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1201: factorization may be faster if do not pivot */
1202: PetscReal zeropivot; /* pivot is called zero if less than this */
1203: PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */
1204: PetscReal shiftamount; /* how large the shift is */
1205: } MatFactorInfo;
1207: PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*);
1208: PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
1209: PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1210: PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
1211: PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
1212: PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
1213: PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1214: PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1215: PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1216: PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*);
1217: PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1218: PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1219: PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec);
1220: PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec);
1221: PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec);
1222: PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec);
1223: PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec);
1224: PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1225: PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs);
1226: PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat);
1228: typedef enum {MAT_FACTOR_SCHUR_UNFACTORED, MAT_FACTOR_SCHUR_FACTORED, MAT_FACTOR_SCHUR_INVERTED} MatFactorSchurStatus;
1229: PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat,IS);
1230: PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
1231: PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat,Mat*,MatFactorSchurStatus);
1232: PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat);
1233: PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
1234: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat,Vec,Vec);
1235: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat,Vec,Vec);
1236: PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat);
1238: /*E
1239: MatSORType - What type of (S)SOR to perform
1241: Level: beginner
1243: May be bitwise ORd together
1245: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
1247: MatSORType may be bitwise ORd together, so do not change the numbers
1249: .seealso: MatSOR()
1250: E*/
1251: typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1252: SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1253: SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
1254: SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1255: PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1257: /*
1258: These routines are for efficiently computing Jacobians via finite differences.
1259: */
1261: /*S
1262: MatColoring - Object for managing the coloring of matrices.
1264: Level: beginner
1266: Notes:
1267: Coloring of matrices can be computed directly from the sparse matrix nonzero structure via the MatColoring object or from the mesh from which the
1268: matrix comes from via DMCreateColoring(). In general using the mesh produces a more optimal coloring (fewer colors).
1270: Once a coloring is available MatFDColoringCreate() creates an object that can be used to efficiently compute Jacobians using that coloring. This
1271: same object can also be used to efficiently convert data created by Automatic Differentation tools to PETSc sparse matrices.
1273: .seealso: MatFDColoringCreate(), MatColoringWeightType, ISColoring, MatFDColoring, DMCreateColoring(), MatColoringCreate(), MatOrdering, MatPartitioning
1274: S*/
1275: typedef struct _p_MatColoring* MatColoring;
1277: /*J
1278: MatColoringType - String with the name of a PETSc matrix coloring
1280: Level: beginner
1282: .seealso: MatColoringSetType(), MatColoring
1283: J*/
1284: typedef const char* MatColoringType;
1285: #define MATCOLORINGJP "jp"
1286: #define MATCOLORINGPOWER "power"
1287: #define MATCOLORINGNATURAL "natural"
1288: #define MATCOLORINGSL "sl"
1289: #define MATCOLORINGLF "lf"
1290: #define MATCOLORINGID "id"
1291: #define MATCOLORINGGREEDY "greedy"
1293: /*E
1294: MatColoringWeightType - Type of weight scheme
1296: Not Collective
1298: + MAT_COLORING_RANDOM - Random weights
1299: . MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering.
1300: - MAT_COLORING_LF - Last-first weighting.
1302: Level: intermediate
1304: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
1306: .seealso: MatColoring, MatColoringCreate()
1307: E*/
1308: typedef enum {MAT_COLORING_WEIGHT_RANDOM,MAT_COLORING_WEIGHT_LEXICAL,MAT_COLORING_WEIGHT_LF,MAT_COLORING_WEIGHT_SL} MatColoringWeightType;
1310: PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*);
1311: PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*);
1312: PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*);
1313: PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer);
1314: PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType);
1315: PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring);
1316: PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt);
1317: PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*);
1318: PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt);
1319: PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*);
1320: PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*);
1321: PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring));
1322: PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1323: PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType);
1324: PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*);
1325: PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm);
1326: PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring,ISColoring);
1327: PETSC_DEPRECATED_FUNCTION("Use MatColoringTest() (since version 3.10)") PETSC_STATIC_INLINE PetscErrorCode MatColoringTestValid(MatColoring matcoloring,ISColoring iscoloring) {return MatColoringTest(matcoloring,iscoloring);}
1328: PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat,ISColoring);
1330: /*S
1331: MatFDColoring - Object for computing a sparse Jacobian via finite differences
1332: and coloring
1334: Level: beginner
1336: Notes:
1337: This object is creating utilizing a coloring provided by the MatColoring object or DMCreateColoring()
1339: .seealso: MatFDColoringCreate(), MatColoring, DMCreateColoring()
1340: S*/
1341: typedef struct _p_MatFDColoring* MatFDColoring;
1343: PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1344: PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*);
1345: PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer);
1346: PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1347: PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1348: PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1349: PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
1350: PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *);
1351: PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec);
1352: PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,const PetscInt*[]);
1353: PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring);
1354: PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt);
1355: PETSC_EXTERN PetscErrorCode MatFDColoringSetValues(Mat,MatFDColoring,const PetscScalar*);
1357: /*S
1358: MatTransposeColoring - Object for computing a sparse matrix product C=A*B^T via coloring
1360: Level: beginner
1362: .seealso: MatTransposeColoringCreate()
1363: S*/
1364: typedef struct _p_MatTransposeColoring* MatTransposeColoring;
1366: PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *);
1367: PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat);
1368: PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat);
1369: PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*);
1371: /*
1372: These routines are for partitioning matrices: currently used only
1373: for adjacency matrix, MatCreateMPIAdj().
1374: */
1376: /*S
1377: MatPartitioning - Object for managing the partitioning of a matrix or graph
1379: Level: beginner
1381: Notes:
1382: There is also a PetscPartitioner object that provides the same functionality. It can utilize the MatPartitioning operations
1383: via PetscPartitionerSetType(p,PETSCPARTITIONERMATPARTITIONING)
1385: Developers Note:
1386: It is an extra maintainance and documentation cost to have two objects with the same functionality.
1388: .seealso: MatPartitioningCreate(), MatPartitioningType, MatColoring, MatGetOrdering()
1389: S*/
1390: typedef struct _p_MatPartitioning* MatPartitioning;
1392: /*J
1393: MatPartitioningType - String with the name of a PETSc matrix partitioning
1395: Level: beginner
1396: dm
1397: .seealso: MatPartitioningCreate(), MatPartitioning
1398: J*/
1399: typedef const char* MatPartitioningType;
1400: #define MATPARTITIONINGCURRENT "current"
1401: #define MATPARTITIONINGAVERAGE "average"
1402: #define MATPARTITIONINGSQUARE "square"
1403: #define MATPARTITIONINGPARMETIS "parmetis"
1404: #define MATPARTITIONINGCHACO "chaco"
1405: #define MATPARTITIONINGPARTY "party"
1406: #define MATPARTITIONINGPTSCOTCH "ptscotch"
1407: #define MATPARTITIONINGHIERARCH "hierarch"
1409: PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1410: PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType);
1411: PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt);
1412: PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat);
1413: PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1414: PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1415: PETSC_EXTERN PetscErrorCode MatPartitioningSetUseEdgeWeights(MatPartitioning,PetscBool);
1416: PETSC_EXTERN PetscErrorCode MatPartitioningGetUseEdgeWeights(MatPartitioning,PetscBool*);
1417: PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*);
1418: PETSC_EXTERN PetscErrorCode MatPartitioningImprove(MatPartitioning,IS*);
1419: PETSC_EXTERN PetscErrorCode MatPartitioningViewImbalance(MatPartitioning,IS);
1420: PETSC_EXTERN PetscErrorCode MatPartitioningApplyND(MatPartitioning,IS*);
1421: PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*);
1422: PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[],PetscErrorCode (*)(MatPartitioning));
1423: PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer);
1424: PETSC_EXTERN PetscErrorCode MatPartitioningViewFromOptions(MatPartitioning,PetscObject,const char[]);
1425: PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
1426: PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*);
1428: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part);
1429: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1430: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);
1432: typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType;
1433: PETSC_EXTERN const char *const MPChacoGlobalTypes[];
1434: typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType;
1435: PETSC_EXTERN const char *const MPChacoLocalTypes[];
1436: typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType;
1437: PETSC_EXTERN const char *const MPChacoEigenTypes[];
1439: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType);
1440: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*);
1441: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType);
1442: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*);
1443: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
1444: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1445: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*);
1446: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal);
1447: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*);
1448: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt);
1449: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*);
1451: #define MP_PARTY_OPT "opt"
1452: #define MP_PARTY_LIN "lin"
1453: #define MP_PARTY_SCA "sca"
1454: #define MP_PARTY_RAN "ran"
1455: #define MP_PARTY_GBF "gbf"
1456: #define MP_PARTY_GCF "gcf"
1457: #define MP_PARTY_BUB "bub"
1458: #define MP_PARTY_DEF "def"
1459: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*);
1460: #define MP_PARTY_HELPFUL_SETS "hs"
1461: #define MP_PARTY_KERNIGHAN_LIN "kl"
1462: #define MP_PARTY_NONE "no"
1463: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*);
1464: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1465: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool);
1466: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool);
1468: typedef enum { MP_PTSCOTCH_DEFAULT,MP_PTSCOTCH_QUALITY,MP_PTSCOTCH_SPEED,MP_PTSCOTCH_BALANCE,MP_PTSCOTCH_SAFETY,MP_PTSCOTCH_SCALABILITY } MPPTScotchStrategyType;
1469: PETSC_EXTERN const char *const MPPTScotchStrategyTypes[];
1471: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal);
1472: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*);
1473: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType);
1474: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*);
1476: /*
1477: * hierarchical partitioning
1478: */
1479: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning,IS*);
1480: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning,IS*);
1481: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning,PetscInt);
1482: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt);
1484: PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
1485: PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);
1487: /*
1488: If you add entries here you must also add them to include/petscmat.h
1489: and src/mat/f90-mod/petscmat.h
1490: */
1491: typedef enum { MATOP_SET_VALUES=0,
1492: MATOP_GET_ROW=1,
1493: MATOP_RESTORE_ROW=2,
1494: MATOP_MULT=3,
1495: MATOP_MULT_ADD=4,
1496: MATOP_MULT_TRANSPOSE=5,
1497: MATOP_MULT_TRANSPOSE_ADD=6,
1498: MATOP_SOLVE=7,
1499: MATOP_SOLVE_ADD=8,
1500: MATOP_SOLVE_TRANSPOSE=9,
1501: MATOP_SOLVE_TRANSPOSE_ADD=10,
1502: MATOP_LUFACTOR=11,
1503: MATOP_CHOLESKYFACTOR=12,
1504: MATOP_SOR=13,
1505: MATOP_TRANSPOSE=14,
1506: MATOP_GETINFO=15,
1507: MATOP_EQUAL=16,
1508: MATOP_GET_DIAGONAL=17,
1509: MATOP_DIAGONAL_SCALE=18,
1510: MATOP_NORM=19,
1511: MATOP_ASSEMBLY_BEGIN=20,
1512: MATOP_ASSEMBLY_END=21,
1513: MATOP_SET_OPTION=22,
1514: MATOP_ZERO_ENTRIES=23,
1515: MATOP_ZERO_ROWS=24,
1516: MATOP_LUFACTOR_SYMBOLIC=25,
1517: MATOP_LUFACTOR_NUMERIC=26,
1518: MATOP_CHOLESKY_FACTOR_SYMBOLIC=27,
1519: MATOP_CHOLESKY_FACTOR_NUMERIC=28,
1520: MATOP_SETUP_PREALLOCATION=29,
1521: MATOP_ILUFACTOR_SYMBOLIC=30,
1522: MATOP_ICCFACTOR_SYMBOLIC=31,
1523: MATOP_GET_DIAGONAL_BLOCK=32,
1524: MATOP_FREE_INTER_STRUCT=33,
1525: MATOP_DUPLICATE=34,
1526: MATOP_FORWARD_SOLVE=35,
1527: MATOP_BACKWARD_SOLVE=36,
1528: MATOP_ILUFACTOR=37,
1529: MATOP_ICCFACTOR=38,
1530: MATOP_AXPY=39,
1531: MATOP_CREATE_SUBMATRICES=40,
1532: MATOP_INCREASE_OVERLAP=41,
1533: MATOP_GET_VALUES=42,
1534: MATOP_COPY=43,
1535: MATOP_GET_ROW_MAX=44,
1536: MATOP_SCALE=45,
1537: MATOP_SHIFT=46,
1538: MATOP_DIAGONAL_SET=47,
1539: MATOP_ZERO_ROWS_COLUMNS=48,
1540: MATOP_SET_RANDOM=49,
1541: MATOP_GET_ROW_IJ=50,
1542: MATOP_RESTORE_ROW_IJ=51,
1543: MATOP_GET_COLUMN_IJ=52,
1544: MATOP_RESTORE_COLUMN_IJ=53,
1545: MATOP_FDCOLORING_CREATE=54,
1546: MATOP_COLORING_PATCH=55,
1547: MATOP_SET_UNFACTORED=56,
1548: MATOP_PERMUTE=57,
1549: MATOP_SET_VALUES_BLOCKED=58,
1550: MATOP_CREATE_SUBMATRIX=59,
1551: MATOP_DESTROY=60,
1552: MATOP_VIEW=61,
1553: MATOP_CONVERT_FROM=62,
1554: MATOP_MATMAT_MULT=63,
1555: MATOP_MATMAT_MULT_SYMBOLIC=64,
1556: MATOP_MATMAT_MULT_NUMERIC=65,
1557: MATOP_SET_LOCAL_TO_GLOBAL_MAP=66,
1558: MATOP_SET_VALUES_LOCAL=67,
1559: MATOP_ZERO_ROWS_LOCAL=68,
1560: MATOP_GET_ROW_MAX_ABS=69,
1561: MATOP_GET_ROW_MIN_ABS=70,
1562: MATOP_CONVERT=71,
1563: MATOP_SET_COLORING=72,
1564: /* MATOP_PLACEHOLDER_73=73, */
1565: MATOP_SET_VALUES_ADIFOR=74,
1566: MATOP_FD_COLORING_APPLY=75,
1567: MATOP_SET_FROM_OPTIONS=76,
1568: MATOP_MULT_CONSTRAINED=77,
1569: MATOP_MULT_TRANSPOSE_CONSTRAIN=78,
1570: MATOP_FIND_ZERO_DIAGONALS=79,
1571: MATOP_MULT_MULTIPLE=80,
1572: MATOP_SOLVE_MULTIPLE=81,
1573: MATOP_GET_INERTIA=82,
1574: MATOP_LOAD=83,
1575: MATOP_IS_SYMMETRIC=84,
1576: MATOP_IS_HERMITIAN=85,
1577: MATOP_IS_STRUCTURALLY_SYMMETRIC=86,
1578: MATOP_SET_VALUES_BLOCKEDLOCAL=87,
1579: MATOP_CREATE_VECS=88,
1580: MATOP_MAT_MULT=89,
1581: MATOP_MAT_MULT_SYMBOLIC=90,
1582: MATOP_MAT_MULT_NUMERIC=91,
1583: MATOP_PTAP=92,
1584: MATOP_PTAP_SYMBOLIC=93,
1585: MATOP_PTAP_NUMERIC=94,
1586: MATOP_MAT_TRANSPOSE_MULT=95,
1587: MATOP_MAT_TRANSPOSE_MULT_SYMBO=96,
1588: MATOP_MAT_TRANSPOSE_MULT_NUMER=97,
1589: /* MATOP_PLACEHOLDER_98=98, */
1590: MATOP_PRODUCTSETFROMOPTIONS=99,
1591: MATOP_PRODUCTSYMBOLIC=100,
1592: MATOP_PRODUCTNUMERIC=101,
1593: MATOP_CONJUGATE=102,
1594: /* MATOP_PLACEHOLDER_103=103, */
1595: MATOP_SET_VALUES_ROW=104,
1596: MATOP_REAL_PART=105,
1597: MATOP_IMAGINARY_PART=106,
1598: MATOP_GET_ROW_UPPER_TRIANGULAR=107,
1599: MATOP_RESTORE_ROW_UPPER_TRIANG=108,
1600: MATOP_MAT_SOLVE=109,
1601: MATOP_MAT_SOLVE_TRANSPOSE=110,
1602: MATOP_GET_ROW_MIN=111,
1603: MATOP_GET_COLUMN_VECTOR=112,
1604: MATOP_MISSING_DIAGONAL=113,
1605: MATOP_GET_SEQ_NONZERO_STRUCTUR=114,
1606: MATOP_CREATE=115,
1607: MATOP_GET_GHOSTS=116,
1608: MATOP_GET_LOCAL_SUB_MATRIX=117,
1609: MATOP_RESTORE_LOCALSUB_MATRIX=118,
1610: MATOP_MULT_DIAGONAL_BLOCK=119,
1611: MATOP_HERMITIAN_TRANSPOSE=120,
1612: MATOP_MULT_HERMITIAN_TRANSPOSE=121,
1613: MATOP_MULT_HERMITIAN_TRANS_ADD=122,
1614: MATOP_GET_MULTI_PROC_BLOCK=123,
1615: MATOP_FIND_NONZERO_ROWS=124,
1616: MATOP_GET_COLUMN_NORMS=125,
1617: MATOP_INVERT_BLOCK_DIAGONAL=126,
1618: /* MATOP_PLACEHOLDER_127=127, */
1619: MATOP_CREATE_SUB_MATRICES_MPI=128,
1620: MATOP_SET_VALUES_BATCH=129,
1621: MATOP_TRANSPOSE_MAT_MULT=130,
1622: MATOP_TRANSPOSE_MAT_MULT_SYMBO=131,
1623: MATOP_TRANSPOSE_MAT_MULT_NUMER=132,
1624: MATOP_TRANSPOSE_COLORING_CREAT=133,
1625: MATOP_TRANS_COLORING_APPLY_SPT=134,
1626: MATOP_TRANS_COLORING_APPLY_DEN=135,
1627: MATOP_RART=136,
1628: MATOP_RART_SYMBOLIC=137,
1629: MATOP_RART_NUMERIC=138,
1630: MATOP_SET_BLOCK_SIZES=139,
1631: MATOP_AYPX=140,
1632: MATOP_RESIDUAL=141,
1633: MATOP_FDCOLORING_SETUP=142,
1634: MATOP_MPICONCATENATESEQ=144,
1635: MATOP_DESTROYSUBMATRICES=145,
1636: MATOP_TRANSPOSE_SOLVE=146,
1637: MATOP_GET_VALUES_LOCAL=147
1638: } MatOperation;
1639: PETSC_EXTERN PetscErrorCode MatSetOperation(Mat,MatOperation,void(*)(void));
1640: PETSC_EXTERN PetscErrorCode MatGetOperation(Mat,MatOperation,void(**)(void));
1641: PETSC_EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool*);
1642: PETSC_EXTERN PetscErrorCode MatHasCongruentLayouts(Mat,PetscBool*);
1643: PETSC_DEPRECATED_FUNCTION("Use MatProductClear() (since version 3.14)") PETSC_STATIC_INLINE PetscErrorCode MatFreeIntermediateDataStructures(Mat A) {return MatProductClear(A);}
1644: PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void));
1645: PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void));
1646: PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*);
1647: PETSC_EXTERN PetscErrorCode MatShellSetVecType(Mat,VecType);
1648: PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*);
1649: PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*);
1650: PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat);
1651: PETSC_EXTERN PetscErrorCode MatShellSetMatProductOperation(Mat,MatProductType,PetscErrorCode (*)(Mat,Mat,Mat,void**),PetscErrorCode (*)(Mat,Mat,Mat,void*),PetscErrorCode (*)(void*),MatType,MatType);
1652: PETSC_EXTERN PetscErrorCode MatIsShell(Mat,PetscBool*);
1654: /*
1655: Codes for matrices stored on disk. By default they are
1656: stored in a universal format. By changing the format with
1657: PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
1658: be stored in a way natural for the matrix, for example dense matrices
1659: would be stored as dense. Matrices stored this way may only be
1660: read into matrices of the same type.
1661: */
1662: #define MATRIX_BINARY_FORMAT_DENSE -1
1664: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1666: PETSC_EXTERN PetscErrorCode MatISSetLocalMatType(Mat,MatType);
1667: PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1668: PETSC_EXTERN PetscErrorCode MatISStoreL2L(Mat,PetscBool);
1669: PETSC_EXTERN PetscErrorCode MatISFixLocalEmpty(Mat,PetscBool);
1670: PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*);
1671: PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat,Mat*);
1672: PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat);
1673: PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use the MatConvert() interface (since version 3.10)") PetscErrorCode MatISGetMPIXAIJ(Mat,MatReuse,Mat*);
1675: /*S
1676: MatNullSpace - Object that removes a null space from a vector, i.e.
1677: orthogonalizes the vector to a subsapce
1679: Level: advanced
1681: Users manual sections:
1682: . Section 4.19 Solving Singular Systems
1684: .seealso: MatNullSpaceCreate()
1685: S*/
1686: typedef struct _p_MatNullSpace* MatNullSpace;
1688: PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*);
1689: PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1690: PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*);
1691: PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec);
1692: PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *);
1693: PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *);
1694: PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat,MatNullSpace);
1695: PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace);
1696: PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace);
1697: PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*);
1698: PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool *);
1699: PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer);
1700: PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**);
1701: PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*);
1703: PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS);
1704: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1705: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
1706: PETSC_EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat);
1708: PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*);
1709: PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*);
1710: PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*);
1712: PETSC_EXTERN PetscErrorCode MatComputeOperator(Mat,MatType,Mat*);
1713: PETSC_EXTERN PetscErrorCode MatComputeOperatorTranspose(Mat,MatType,Mat*);
1715: PETSC_DEPRECATED_FUNCTION("Use MatComputeOperator() (since version 3.12)") PETSC_STATIC_INLINE PetscErrorCode MatComputeExplicitOperator(Mat A,Mat* B) { return MatComputeOperator(A,NULL,B); }
1716: PETSC_DEPRECATED_FUNCTION("Use MatComputeOperatorTranspose() (since version 3.12)") PETSC_STATIC_INLINE PetscErrorCode MatComputeExplicitOperatorTranspose(Mat A,Mat* B) { return MatComputeOperatorTranspose(A,NULL,B); }
1718: PETSC_EXTERN PetscErrorCode MatCreateKAIJ(Mat,PetscInt,PetscInt,const PetscScalar[],const PetscScalar[],Mat*);
1719: PETSC_EXTERN PetscErrorCode MatKAIJGetAIJ(Mat,Mat*);
1720: PETSC_EXTERN PetscErrorCode MatKAIJGetS(Mat,PetscInt*,PetscInt*,PetscScalar**);
1721: PETSC_EXTERN PetscErrorCode MatKAIJGetSRead(Mat,PetscInt*,PetscInt*,const PetscScalar**);
1722: PETSC_EXTERN PetscErrorCode MatKAIJRestoreS(Mat,PetscScalar**);
1723: PETSC_EXTERN PetscErrorCode MatKAIJRestoreSRead(Mat,const PetscScalar**);
1724: PETSC_EXTERN PetscErrorCode MatKAIJGetT(Mat,PetscInt*,PetscInt*,PetscScalar**);
1725: PETSC_EXTERN PetscErrorCode MatKAIJGetTRead(Mat,PetscInt*,PetscInt*,const PetscScalar**);
1726: PETSC_EXTERN PetscErrorCode MatKAIJRestoreT(Mat,PetscScalar**);
1727: PETSC_EXTERN PetscErrorCode MatKAIJRestoreTRead(Mat,const PetscScalar**);
1728: PETSC_EXTERN PetscErrorCode MatKAIJSetAIJ(Mat,Mat);
1729: PETSC_EXTERN PetscErrorCode MatKAIJSetS(Mat,PetscInt,PetscInt,const PetscScalar[]);
1730: PETSC_EXTERN PetscErrorCode MatKAIJSetT(Mat,PetscInt,PetscInt,const PetscScalar[]);
1731: PETSC_EXTERN PetscErrorCode MatKAIJGetScaledIdentity(Mat,PetscBool*);
1733: PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec);
1735: PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
1736: PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec);
1737: PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1738: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1739: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1740: PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1741: PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
1742: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal);
1743: PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt);
1744: PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *);
1745: PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]);
1746: PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1747: PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);
1749: /*S
1750: MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free
1751: Jacobian vector products
1753: Notes:
1754: MATMFFD is a specific MatType which uses the MatMFFD data structure
1756: MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure
1758: Level: developer
1760: .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
1761: S*/
1762: typedef struct _p_MatMFFD* MatMFFD;
1764: /*J
1765: MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function
1767: Level: beginner
1769: .seealso: MatMFFDSetType(), MatMFFDRegister()
1770: J*/
1771: typedef const char* MatMFFDType;
1772: #define MATMFFD_DS "ds"
1773: #define MATMFFD_WP "wp"
1775: PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat,MatMFFDType);
1776: PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[],PetscErrorCode (*)(MatMFFD));
1778: PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal);
1779: PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool );
1781: PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring,MatMFFDType);
1783: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1784: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
1786: #ifdef PETSC_HAVE_HARA
1787: PETSC_EXTERN_TYPEDEF typedef PetscScalar (*MatHaraKernel)(PetscInt,PetscReal[],PetscReal[],void*);
1788: PETSC_EXTERN PetscErrorCode MatCreateHaraFromKernel(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscReal[],MatHaraKernel,void*,PetscReal,PetscInt,PetscInt,Mat*);
1789: PETSC_EXTERN PetscErrorCode MatCreateHaraFromMat(Mat,PetscInt,const PetscReal[],PetscReal,PetscInt,PetscInt,PetscInt,PetscReal,Mat*);
1790: PETSC_EXTERN PetscErrorCode MatHaraSetSamplingMat(Mat,Mat,PetscInt,PetscReal);
1791: #endif
1793: /*
1794: PETSc interface to MUMPS
1795: */
1796: #ifdef PETSC_HAVE_MUMPS
1797: PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
1798: PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat,PetscInt,PetscInt*);
1799: PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal);
1800: PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat,PetscInt,PetscReal*);
1802: PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat,PetscInt,PetscInt*);
1803: PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat,PetscInt,PetscInt*);
1804: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat,PetscInt,PetscReal*);
1805: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat,PetscInt,PetscReal*);
1806: PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat,Mat);
1807: PETSC_EXTERN PetscErrorCode MatMumpsGetInverseTranspose(Mat,Mat);
1808: #endif
1810: /*
1811: PETSc interface to Mkl_Pardiso
1812: */
1813: #ifdef PETSC_HAVE_MKL_PARDISO
1814: PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt);
1815: #endif
1817: /*
1818: PETSc interface to Mkl_CPardiso
1819: */
1820: #ifdef PETSC_HAVE_MKL_CPARDISO
1821: PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt);
1822: #endif
1824: /*
1825: PETSc interface to SUPERLU
1826: */
1827: #ifdef PETSC_HAVE_SUPERLU
1828: PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal);
1829: #endif
1831: /*
1832: PETSc interface to SUPERLU_DIST
1833: */
1834: #ifdef PETSC_HAVE_SUPERLU_DIST
1835: PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat,PetscScalar*);
1836: #endif
1838: /*
1839: PETSc interface to STRUMPACK
1840: */
1841: #ifdef PETSC_HAVE_STRUMPACK
1842: /*E
1843: MatSTRUMPACKReordering - sparsity reducing ordering to be used in STRUMPACK
1845: Level: intermediate
1846: E*/
1847: typedef enum {MAT_STRUMPACK_NATURAL=0,
1848: MAT_STRUMPACK_METIS=1,
1849: MAT_STRUMPACK_PARMETIS=2,
1850: MAT_STRUMPACK_SCOTCH=3,
1851: MAT_STRUMPACK_PTSCOTCH=4,
1852: MAT_STRUMPACK_RCM=5} MatSTRUMPACKReordering;
1853: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat,MatSTRUMPACKReordering);
1854: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat,PetscBool);
1855: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSRelTol(Mat,PetscReal);
1856: PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSRelTol() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSRelCompTol(Mat mat,PetscReal rtol) {return MatSTRUMPACKSetHSSRelTol(mat,rtol);}
1857: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSAbsTol(Mat,PetscReal);
1858: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMinSepSize(Mat,PetscInt);
1859: PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSMinSepSize() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSMinSize(Mat mat,PetscInt hssminsize) {return MatSTRUMPACKSetHSSMinSepSize(mat,hssminsize);}
1860: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMaxRank(Mat,PetscInt);
1861: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSLeafSize(Mat,PetscInt);
1862: #endif
1865: PETSC_EXTERN PetscErrorCode MatBindToCPU(Mat,PetscBool);
1866: PETSC_DEPRECATED_FUNCTION("Use MatBindToCPU (since v3.13)") PETSC_STATIC_INLINE PetscErrorCode MatPinToCPU(Mat A,PetscBool flg) {return MatBindToCPU(A,flg);}
1868: #ifdef PETSC_HAVE_CUDA
1869: /*E
1870: MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU)
1871: matrices.
1873: Not Collective
1875: + MAT_CUSPARSE_CSR - Compressed Sparse Row
1876: . MAT_CUSPARSE_ELL - Ellpack (requires CUDA 4.2 or later).
1877: - MAT_CUSPARSE_HYB - Hybrid, a combination of Ellpack and Coordinate format (requires CUDA 4.2 or later).
1879: Level: intermediate
1881: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
1883: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation
1884: E*/
1886: typedef enum {MAT_CUSPARSE_CSR, MAT_CUSPARSE_ELL, MAT_CUSPARSE_HYB} MatCUSPARSEStorageFormat;
1888: /* these will be strings associated with enumerated type defined above */
1889: PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[];
1891: /*E
1892: MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU)
1893: matrices whose operation should use a particular storage format.
1895: Not Collective
1897: + MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
1898: . MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
1899: . MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
1900: - MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices
1902: Level: intermediate
1904: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat
1905: E*/
1906: typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation;
1908: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1909: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1910: PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat);
1912: PETSC_EXTERN PetscErrorCode MatCreateDenseCUDA(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
1913: PETSC_EXTERN PetscErrorCode MatCreateSeqDenseCUDA(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
1914: PETSC_EXTERN PetscErrorCode MatMPIDenseCUDASetPreallocation(Mat,PetscScalar[]);
1915: PETSC_EXTERN PetscErrorCode MatSeqDenseCUDASetPreallocation(Mat,PetscScalar[]);
1916: PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayWrite(Mat,PetscScalar**);
1917: PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayRead(Mat,const PetscScalar**);
1918: PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArray(Mat,PetscScalar**);
1919: PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayWrite(Mat,PetscScalar**);
1920: PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayRead(Mat,const PetscScalar**);
1921: PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArray(Mat,PetscScalar**);
1922: PETSC_EXTERN PetscErrorCode MatDenseCUDAPlaceArray(Mat,const PetscScalar*);
1923: PETSC_EXTERN PetscErrorCode MatDenseCUDAReplaceArray(Mat,const PetscScalar*);
1924: PETSC_EXTERN PetscErrorCode MatDenseCUDAResetArray(Mat);
1925: #endif
1927: #if defined(PETSC_HAVE_VIENNACL)
1928: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1929: PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1930: #endif
1932: /*
1933: PETSc interface to FFTW
1934: */
1935: #if defined(PETSC_HAVE_FFTW)
1936: PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec);
1937: PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec);
1938: PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*);
1939: #endif
1941: PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*);
1942: PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*);
1943: PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]);
1944: PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]);
1945: PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***);
1946: PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*);
1947: PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType);
1948: PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]);
1949: PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat);
1951: PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal);
1952: PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*);
1954: PETSC_EXTERN PetscErrorCode MatSubdomainsCreateCoalesce(Mat,PetscInt,PetscInt*,IS**);
1956: PETSC_EXTERN PetscErrorCode MatPreallocatorPreallocate(Mat,PetscBool,Mat);
1958: PETSC_INTERN PetscErrorCode MatHeaderMerge(Mat,Mat*);
1959: PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat,Mat*);
1961: #endif