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