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