Actual source code: petscmat.h
petsc-3.10.5 2019-03-28
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 MATAIJSELL "aijsell"
49: #define MATSEQAIJSELL "seqaijsell"
50: #define MATMPIAIJSELL "mpiaijsell"
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 MATSELL "sell"
91: #define MATSEQSELL "seqsell"
92: #define MATMPISELL "mpisell"
93: #define MATDUMMY "dummy"
94: #define MATLMVM "lmvm"
95: #define MATLMVMDFP "lmvmdfp"
96: #define MATLMVMBFGS "lmvmbfgs"
97: #define MATLMVMSR1 "lmvmsr1"
98: #define MATLMVMBRDN "lmvmbrdn"
99: #define MATLMVMBADBRDN "lmvmbadbrdn"
100: #define MATLMVMSYMBRDN "lmvmsymbrdn"
101: #define MATLMVMSYMBADBRDN "lmvmsymbadbrdn"
102: #define MATLMVMDIAGBRDN "lmvmdiagbrdn"
104: /*J
105: MatSolverType - String with the name of a PETSc matrix solver type.
107: For example: "petsc" indicates what PETSc provides, "superlu_dist" the parallel SuperLU_DIST package etc
109: Level: beginner
111: .seealso: MatGetFactor(), Mat, MatSetType(), MatType
112: J*/
113: typedef const char* MatSolverType;
114: #define MATSOLVERSUPERLU "superlu"
115: #define MATSOLVERSUPERLU_DIST "superlu_dist"
116: #define MATSOLVERSTRUMPACK "strumpack"
117: #define MATSOLVERUMFPACK "umfpack"
118: #define MATSOLVERCHOLMOD "cholmod"
119: #define MATSOLVERKLU "klu"
120: #define MATSOLVERSPARSEELEMENTAL "sparseelemental"
121: #define MATSOLVERELEMENTAL "elemental"
122: #define MATSOLVERESSL "essl"
123: #define MATSOLVERLUSOL "lusol"
124: #define MATSOLVERMUMPS "mumps"
125: #define MATSOLVERMKL_PARDISO "mkl_pardiso"
126: #define MATSOLVERMKL_CPARDISO "mkl_cpardiso"
127: #define MATSOLVERPASTIX "pastix"
128: #define MATSOLVERMATLAB "matlab"
129: #define MATSOLVERPETSC "petsc"
130: #define MATSOLVERBAS "bas"
131: #define MATSOLVERCUSPARSE "cusparse"
133: /*E
134: MatFactorType - indicates what type of factorization is requested
136: Level: beginner
138: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
140: .seealso: MatSolverType, MatGetFactor()
141: E*/
142: typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType;
143: PETSC_EXTERN const char *const MatFactorTypes[];
145: PETSC_EXTERN PetscErrorCode MatGetFactor(Mat,MatSolverType,MatFactorType,Mat*);
146: PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat,MatSolverType,MatFactorType,PetscBool *);
147: PETSC_EXTERN PetscErrorCode MatFactorGetSolverType(Mat,MatSolverType*);
148: PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat,MatFactorType*);
149: PETSC_EXTERN PetscErrorCode MatSolverTypeRegister(MatSolverType,MatType,MatFactorType,PetscErrorCode(*)(Mat,MatFactorType,Mat*));
150: PETSC_EXTERN PetscErrorCode MatSolverTypeGet(MatSolverType,MatType,MatFactorType,PetscBool*,PetscBool*,PetscErrorCode (**)(Mat,MatFactorType,Mat*));
151: typedef MatSolverType MatSolverPackage PETSC_DEPRECATED("Use MatSolverType");
152: PETSC_DEPRECATED("Use MatSolverTypeRegister()") PETSC_STATIC_INLINE PetscErrorCode MatSolverPackageRegister(MatSolverType stype,MatType mtype,MatFactorType ftype,PetscErrorCode(*f)(Mat,MatFactorType,Mat*))
153: { return MatSolverTypeRegister(stype,mtype,ftype,f); }
154: PETSC_DEPRECATED("Use MatSolverTypeGet()") PETSC_STATIC_INLINE PetscErrorCode MatSolverPackageGet(MatSolverType stype,MatType mtype,MatFactorType ftype,PetscBool *foundmtype,PetscBool *foundstype,PetscErrorCode(**f)(Mat,MatFactorType,Mat*))
155: { return MatSolverTypeGet(stype,mtype,ftype,foundmtype,foundstype,f); }
157: /* Logging support */
158: #define MAT_FILE_CLASSID 1211216 /* used to indicate matrices in binary files */
159: PETSC_EXTERN PetscClassId MAT_CLASSID;
160: PETSC_EXTERN PetscClassId MAT_COLORING_CLASSID;
161: PETSC_EXTERN PetscClassId MAT_FDCOLORING_CLASSID;
162: PETSC_EXTERN PetscClassId MAT_TRANSPOSECOLORING_CLASSID;
163: PETSC_EXTERN PetscClassId MAT_PARTITIONING_CLASSID;
164: PETSC_EXTERN PetscClassId MAT_COARSEN_CLASSID;
165: PETSC_EXTERN PetscClassId MAT_NULLSPACE_CLASSID;
166: PETSC_EXTERN PetscClassId MATMFFD_CLASSID;
168: /*E
169: MatReuse - Indicates if matrices obtained from a previous call to MatCreateSubMatrices(), MatCreateSubMatrix(), MatConvert() or several other functions
170: are to be reused to store the new matrix values.
172: $ MAT_INITIAL_MATRIX - create a new matrix
173: $ MAT_REUSE_MATRIX - reuse the matrix created with a previous call that used MAT_INITIAL_MATRIX
174: $ MAT_INPLACE_MATRIX - replace the first input matrix with the new matrix (not applicable to all functions)
175: $ MAT_IGNORE_MATRIX - do not create a new matrix or reuse a give matrix, just ignore that matrix argument (not applicable to all functions)
177: Level: beginner
179: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
181: .seealso: MatCreateSubMatrices(), MatCreateSubMatrix(), MatDestroyMatrices(), MatConvert()
182: E*/
183: typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX,MAT_INPLACE_MATRIX} MatReuse;
185: /*E
186: MatCreateSubMatrixOption - Indicates if matrices obtained from a call to MatCreateSubMatrices()
187: include the matrix values. Currently it is only used by MatGetSeqNonzerostructure().
189: Level: beginner
191: .seealso: MatGetSeqNonzerostructure()
192: E*/
193: typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatCreateSubMatrixOption;
195: PETSC_EXTERN PetscErrorCode MatInitializePackage(void);
197: PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm,Mat*);
198: PETSC_EXTERN PetscErrorCode MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
199: PETSC_EXTERN PetscErrorCode MatSetType(Mat,MatType);
200: PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat);
201: PETSC_STATIC_INLINE PetscErrorCode MatViewFromOptions(Mat A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
202: PETSC_EXTERN PetscErrorCode MatRegister(const char[],PetscErrorCode(*)(Mat));
203: PETSC_EXTERN PetscErrorCode MatRegisterBaseName(const char[],const char[],const char[]);
204: PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat,const char[]);
205: PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat,const char[]);
206: PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat,const char*[]);
207: PETSC_EXTERN PetscErrorCode MatSetErrorIfFailure(Mat,PetscBool);
209: PETSC_EXTERN PetscFunctionList MatList;
210: PETSC_EXTERN PetscFunctionList MatColoringList;
211: PETSC_EXTERN PetscFunctionList MatPartitioningList;
213: /*E
214: MatStructure - Indicates if two matrices have the same nonzero structure
216: Level: beginner
218: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
220: .seealso: MatCopy(), MatAXPY()
221: E*/
222: typedef enum {DIFFERENT_NONZERO_PATTERN,SUBSET_NONZERO_PATTERN,SAME_NONZERO_PATTERN} MatStructure;
224: #if defined PETSC_HAVE_MKL_SPARSE
225: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
226: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
227: PETSC_EXTERN PetscErrorCode MatCreateBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
228: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
229: #endif
231: PETSC_EXTERN PetscErrorCode MatCreateSeqSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
232: PETSC_EXTERN PetscErrorCode MatCreateSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
233: PETSC_EXTERN PetscErrorCode MatSeqSELLSetPreallocation(Mat,PetscInt,const PetscInt[]);
234: PETSC_EXTERN PetscErrorCode MatMPISELLSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
236: PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
237: PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
238: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
239: PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
240: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
241: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
242: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSeqAIJ(MPI_Comm,Mat,Mat,const PetscInt[],Mat*);
244: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
245: PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
246: PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*);
248: PETSC_EXTERN PetscErrorCode MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
249: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
251: PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
252: PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
253: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
254: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
255: PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],const PetscInt[]);
257: PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
258: PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat,Mat*);
259: PETSC_EXTERN PetscErrorCode MatCreateNormalHermitian(Mat,Mat*);
260: PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat,Mat,Vec,Mat,Mat*);
261: PETSC_EXTERN PetscErrorCode MatLRCGetMats(Mat,Mat*,Mat*,Vec*,Mat*);
262: PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,ISLocalToGlobalMapping,Mat*);
263: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
264: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
266: PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*);
267: PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter);
268: PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*);
269: PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
270: PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat,Mat);
271: PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat);
272: PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
273: typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
274: PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat,MatCompositeType);
276: PETSC_EXTERN PetscErrorCode MatCreateFFT(MPI_Comm,PetscInt,const PetscInt[],MatType,Mat*);
277: PETSC_EXTERN PetscErrorCode MatCreateSeqCUFFT(MPI_Comm,PetscInt,const PetscInt[],Mat*);
279: PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*);
280: PETSC_EXTERN PetscErrorCode MatTransposeGetMat(Mat,Mat*);
281: PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat,Mat*);
282: PETSC_EXTERN PetscErrorCode MatCreateSubMatrixVirtual(Mat,IS,IS,Mat*);
283: PETSC_EXTERN PetscErrorCode MatSubMatrixVirtualUpdate(Mat,Mat,IS,IS);
284: PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*);
286: #if defined(PETSC_HAVE_HYPRE)
287: PETSC_EXTERN PetscErrorCode MatHYPRESetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
288: #endif
290: PETSC_EXTERN PetscErrorCode MatPythonSetType(Mat,const char[]);
292: PETSC_EXTERN PetscErrorCode MatResetPreallocation(Mat);
293: PETSC_EXTERN PetscErrorCode MatSetUp(Mat);
294: PETSC_EXTERN PetscErrorCode MatDestroy(Mat*);
295: PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat,PetscObjectState*);
297: PETSC_EXTERN PetscErrorCode MatConjugate(Mat);
298: PETSC_EXTERN PetscErrorCode MatRealPart(Mat);
299: PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat);
300: PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,Mat*);
301: PETSC_EXTERN PetscErrorCode MatGetTrace(Mat,PetscScalar*);
302: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat,const PetscScalar **);
303: PETSC_EXTERN PetscErrorCode MatInvertVariableBlockDiagonal(Mat,PetscInt,const PetscInt*,PetscScalar*);
304: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonalMat(Mat,Mat);
306: /* ------------------------------------------------------------*/
307: PETSC_EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
308: PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
309: PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
310: PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
311: PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat,PetscInt,PetscInt,PetscInt[],const PetscScalar[]);
312: PETSC_EXTERN PetscErrorCode MatSetRandom(Mat,PetscRandom);
314: /*S
315: MatStencil - Data structure (C struct) for storing information about a single row or
316: column of a matrix as indexed on an associated grid. These are arguments to MatSetStencil() and MatSetBlockStencil()
318: 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).
319: 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.
321: For stencil access to vectors see DMDAVecGetArray(), DMDAVecGetArrayF90().
323: Fortran usage is different, see MatSetValuesStencil() for details.
325: Level: beginner
327: Concepts: matrix; linear operator
329: .seealso: MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockedStencil(), DMDAVecGetArray(), DMDAVecGetArrayF90()
330: S*/
331: typedef struct {
332: PetscInt k,j,i,c;
333: } MatStencil;
335: PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
336: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
337: PETSC_EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
339: /*E
340: MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
341: to continue to add or insert values to it
343: Level: beginner
345: .seealso: MatAssemblyBegin(), MatAssemblyEnd()
346: E*/
347: typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
348: PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType);
349: PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType);
350: PETSC_EXTERN PetscErrorCode MatAssembled(Mat,PetscBool *);
354: /*E
355: MatOption - Options that may be set for a matrix and its behavior or storage
357: Level: beginner
359: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
360: Any additions/changes here must also be made in src/mat/interface/dlregismat.c in MatOptions[]
362: Developer Notes:
363: Entries that are negative need not be called collectively by all processes.
365: .seealso: MatSetOption()
366: E*/
367: typedef enum {MAT_OPTION_MIN = -3,
368: MAT_UNUSED_NONZERO_LOCATION_ERR = -2,
369: MAT_ROW_ORIENTED = -1,
370: MAT_SYMMETRIC = 1,
371: MAT_STRUCTURALLY_SYMMETRIC = 2,
372: MAT_NEW_DIAGONALS = 3,
373: MAT_IGNORE_OFF_PROC_ENTRIES = 4,
374: MAT_USE_HASH_TABLE = 5,
375: MAT_KEEP_NONZERO_PATTERN = 6,
376: MAT_IGNORE_ZERO_ENTRIES = 7,
377: MAT_USE_INODES = 8,
378: MAT_HERMITIAN = 9,
379: MAT_SYMMETRY_ETERNAL = 10,
380: MAT_NEW_NONZERO_LOCATION_ERR = 11,
381: MAT_IGNORE_LOWER_TRIANGULAR = 12,
382: MAT_ERROR_LOWER_TRIANGULAR = 13,
383: MAT_GETROW_UPPERTRIANGULAR = 14,
384: MAT_SPD = 15,
385: MAT_NO_OFF_PROC_ZERO_ROWS = 16,
386: MAT_NO_OFF_PROC_ENTRIES = 17,
387: MAT_NEW_NONZERO_LOCATIONS = 18,
388: MAT_NEW_NONZERO_ALLOCATION_ERR = 19,
389: MAT_SUBSET_OFF_PROC_ENTRIES = 20,
390: MAT_SUBMAT_SINGLEIS = 21,
391: MAT_STRUCTURE_ONLY = 22,
392: MAT_OPTION_MAX = 23} MatOption;
394: PETSC_EXTERN const char *const *MatOptions;
395: PETSC_EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscBool);
396: PETSC_EXTERN PetscErrorCode MatGetOption(Mat,MatOption,PetscBool*);
397: PETSC_EXTERN PetscErrorCode MatGetType(Mat,MatType*);
399: PETSC_EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
400: PETSC_EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
401: PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
402: PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat);
403: PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat);
404: PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt);
405: PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat,PetscScalar *[]);
406: PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat,PetscScalar *[]);
407: PETSC_EXTERN PetscErrorCode MatSeqAIJGetMaxRowNonzeros(Mat,PetscInt*);
408: PETSC_EXTERN PetscErrorCode MatSeqAIJSetValuesLocalFast(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
409: PETSC_EXTERN PetscErrorCode MatSeqAIJSetType(Mat,MatType);
410: PETSC_EXTERN PetscErrorCode MatSeqAIJRegister(const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat *));
411: PETSC_EXTERN PetscFunctionList MatSeqAIJList;
412: PETSC_EXTERN PetscErrorCode MatSeqSBAIJGetArray(Mat,PetscScalar *[]);
413: PETSC_EXTERN PetscErrorCode MatSeqSBAIJRestoreArray(Mat,PetscScalar *[]);
414: PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat,PetscScalar *[]);
415: PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat,PetscScalar *[]);
416: PETSC_EXTERN PetscErrorCode MatDensePlaceArray(Mat,const PetscScalar[]);
417: PETSC_EXTERN PetscErrorCode MatDenseResetArray(Mat);
418: PETSC_EXTERN PetscErrorCode MatDenseGetArrayRead(Mat,const PetscScalar *[]);
419: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayRead(Mat,const PetscScalar *[]);
420: PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *);
421: PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt);
422: PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat,PetscInt *,PetscInt *);
423: PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat,PetscInt,PetscInt);
424: PETSC_EXTERN PetscErrorCode MatSetBlockSizesFromMats(Mat,Mat,Mat);
425: PETSC_EXTERN PetscErrorCode MatSetVariableBlockSizes(Mat,PetscInt,PetscInt*);
426: PETSC_EXTERN PetscErrorCode MatGetVariableBlockSizes(Mat,PetscInt*,const PetscInt**);
428: PETSC_EXTERN PetscErrorCode MatDenseGetColumn(Mat,PetscInt,PetscScalar *[]);
429: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumn(Mat,PetscScalar *[]);
431: PETSC_EXTERN PetscErrorCode MatMult(Mat,Vec,Vec);
432: PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec);
433: PETSC_EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec);
434: PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec);
435: PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec);
436: PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *);
437: PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *);
438: PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec);
439: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
440: PETSC_EXTERN PetscErrorCode MatMultConstrained(Mat,Vec,Vec);
441: PETSC_EXTERN PetscErrorCode MatMultTransposeConstrained(Mat,Vec,Vec);
442: PETSC_EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat);
443: PETSC_EXTERN PetscErrorCode MatMatSolveTranspose(Mat,Mat,Mat);
444: PETSC_EXTERN PetscErrorCode MatMatTransposeSolve(Mat,Mat,Mat);
445: PETSC_EXTERN PetscErrorCode MatResidual(Mat,Vec,Vec,Vec);
447: /*E
448: MatDuplicateOption - Indicates if a duplicated sparse matrix should have
449: its numerical values copied over or just its nonzero structure.
451: Level: beginner
453: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
455: $ MAT_DO_NOT_COPY_VALUES - Create a matrix using the same nonzero pattern as the original matrix,
456: $ with zeros for the numerical values.
457: $ MAT_COPY_VALUES - Create a matrix with the same nonzero pattern as the original matrix
458: $ and with the same numerical values.
459: $ MAT_SHARE_NONZERO_PATTERN - Create a matrix that shares the nonzero structure with the previous matrix
460: $ and does not copy it, using zeros for the numerical values. The parent and
461: $ child matrices will share their index (i and j) arrays, and you cannot
462: $ insert new nonzero entries into either matrix.
464: Notes:
465: Many matrix types (including SeqAIJ) do not support the MAT_SHARE_NONZERO_PATTERN optimization; in
466: this case the behavior is as if MAT_DO_NOT_COPY_VALUES has been specified.
468: .seealso: MatDuplicate()
469: E*/
470: typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;
472: PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*);
473: PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*);
476: PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure);
477: PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer);
478: PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *);
479: PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *);
480: PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *);
481: PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *);
482: PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *);
483: PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool *,PetscInt *);
484: PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer);
486: PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *);
487: PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *);
488: PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *);
489: PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *);
491: /*S
492: MatInfo - Context of matrix information, used with MatGetInfo()
494: In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
496: Level: intermediate
498: Concepts: matrix^nonzero information
500: .seealso: MatGetInfo(), MatInfoType
501: S*/
502: typedef struct {
503: PetscLogDouble block_size; /* block size */
504: PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */
505: PetscLogDouble memory; /* memory allocated */
506: PetscLogDouble assemblies; /* number of matrix assemblies called */
507: PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */
508: PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
509: PetscLogDouble factor_mallocs; /* number of mallocs during factorization */
510: } MatInfo;
512: /*E
513: MatInfoType - Indicates if you want information about the local part of the matrix,
514: the entire parallel matrix or the maximum over all the local parts.
516: Level: beginner
518: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
520: .seealso: MatGetInfo(), MatInfo
521: E*/
522: typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
523: PETSC_EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*);
524: PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec);
525: PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]);
526: PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]);
527: PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
528: PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]);
529: PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat,Vec);
530: PETSC_EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*);
531: PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*);
532: PETSC_EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat*);
533: PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec);
534: PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode);
536: PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool*);
537: PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool*);
538: PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool*);
539: PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool*);
540: PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*);
541: PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
542: PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
544: PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal*);
545: PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal*);
546: PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat);
547: PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
548: PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec);
549: PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec);
550: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec);
551: PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
552: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec);
554: PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*);
555: PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*);
556: PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
557: PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**);
558: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
559: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**);
560: PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*);
562: PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
563: 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);}
564: PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
565: 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);}
566: PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]);
567: PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt,Mat *[]);
568: PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,MatReuse,Mat *);
569: 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);}
570: PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*);
571: PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*);
572: PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*);
573: PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*);
575: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
576: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
577: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat);
578: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*);
579: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
580: PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*);
581: PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);
583: PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
584: PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat mat,PetscInt n,IS is[],PetscInt ov);
585: PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat,PetscBool);
587: PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
588: PETSC_EXTERN PetscErrorCode MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
589: PETSC_EXTERN PetscErrorCode MatMatMultNumeric(Mat,Mat,Mat);
591: PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
592: PETSC_EXTERN PetscErrorCode MatGalerkin(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
594: PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
595: PETSC_EXTERN PetscErrorCode MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
596: PETSC_EXTERN PetscErrorCode MatPtAPNumeric(Mat,Mat,Mat);
597: PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*);
598: PETSC_EXTERN PetscErrorCode MatRARtSymbolic(Mat,Mat,PetscReal,Mat*);
599: PETSC_EXTERN PetscErrorCode MatRARtNumeric(Mat,Mat,Mat);
601: PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
602: PETSC_EXTERN PetscErrorCode MatTransposetMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
603: PETSC_EXTERN PetscErrorCode MatTransposetMatMultNumeric(Mat,Mat,Mat);
604: PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*);
605: PETSC_EXTERN PetscErrorCode MatMatTransposeMultSymbolic(Mat,Mat,PetscReal,Mat*);
606: PETSC_EXTERN PetscErrorCode MatMatTransposeMultNumeric(Mat,Mat,Mat);
608: PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure);
609: PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure);
611: PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar);
612: PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar);
614: PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
615: PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*);
616: PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat,PetscLayout*,PetscLayout*);
617: PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
618: PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
619: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
620: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
621: PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
622: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
624: PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt);
625: PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
627: PETSC_EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec);
628: PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec);
629: PETSC_EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec);
630: PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat,Vec*,Vec*);
631: PETSC_DEPRECATED("Use MatCreateVecs()") PETSC_STATIC_INLINE PetscErrorCode MatGetVecs(Mat mat,Vec *x,Vec *y) {return MatCreateVecs(mat,x,y);}
632: PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat,PetscInt,MPI_Comm,MatReuse,Mat*);
633: PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*);
634: PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*);
635: PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat,IS*);
636: PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
638: /*MC
639: MatSetValue - Set a single entry into a matrix.
641: Not collective
643: Synopsis:
644: #include <petscmat.h>
645: PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode)
647: Input Parameters:
648: + m - the matrix
649: . row - the row location of the entry
650: . col - the column location of the entry
651: . value - the value to insert
652: - mode - either INSERT_VALUES or ADD_VALUES
654: Notes:
655: For efficiency one should use MatSetValues() and set several or many
656: values simultaneously if possible.
658: Level: beginner
660: .seealso: MatSetValues(), MatSetValueLocal()
661: M*/
662: PETSC_STATIC_INLINE PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);}
664: PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);}
666: PETSC_STATIC_INLINE PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);}
668: /*MC
669: MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
670: row in a matrix providing the data that one can use to correctly preallocate the matrix.
672: Synopsis:
673: #include <petscmat.h>
674: PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
676: Collective on MPI_Comm
678: Input Parameters:
679: + comm - the communicator that will share the eventually allocated matrix
680: . nrows - the number of LOCAL rows in the matrix
681: - ncols - the number of LOCAL columns in the matrix
683: Output Parameters:
684: + dnz - the array that will be passed to the matrix preallocation routines
685: - onz - the other array passed to the matrix preallocation routines
687: Level: intermediate
689: Notes:
690: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
692: Do not malloc or free dnz and onz, that is handled internally by these routines
694: Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
696: This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
698: Concepts: preallocation^Matrix
700: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
701: MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocalBlock()
702: M*/
703: #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
704: { \
705: PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ncols = (ncols),__rstart,__start,__end; \
706: _4_PetscCalloc2((size_t)__nrows,&dnz,(size_t)__nrows,&onz);CHKERRQ(_4_ierr); \
707: __start = 0; __end = __start; \
708: _4_MPI_Scan(&__ncols,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ncols;\
709: _4_MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
711: /*MC
712: MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
713: inserted using a local number of the rows and columns
715: Synopsis:
716: #include <petscmat.h>
717: PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
719: Not Collective
721: Input Parameters:
722: + map - the row mapping from local numbering to global numbering
723: . nrows - the number of rows indicated
724: . rows - the indices of the rows
725: . cmap - the column mapping from local to global numbering
726: . ncols - the number of columns in the matrix
727: . cols - the columns indicated
728: . dnz - the array that will be passed to the matrix preallocation routines
729: - onz - the other array passed to the matrix preallocation routines
731: Level: intermediate
733: Notes:
734: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
736: Do not malloc or free dnz and onz, that is handled internally by these routines
738: Concepts: preallocation^Matrix
740: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
741: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocalRemoveDups()
742: M*/
743: #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
744: {\
745: PetscInt __l;\
746: _4_ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
747: _4_ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
748: for (__l=0;__l<nrows;__l++) {\
749: _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
750: }\
751: }
753: /*MC
754: MatPreallocateSetLocalRemoveDups - Indicates the locations (rows and columns) in the matrix where nonzeros will be
755: inserted using a local number of the rows and columns. This version removes any duplicate columns in cols
757: Synopsis:
758: #include <petscmat.h>
759: PetscErrorCode MatPreallocateSetLocalRemoveDups(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
761: Not Collective
763: Input Parameters:
764: + map - the row mapping from local numbering to global numbering
765: . nrows - the number of rows indicated
766: . rows - the indices of the rows (these values are mapped to the global values)
767: . cmap - the column mapping from local to global numbering
768: . ncols - the number of columns in the matrix (this value will be changed if duplicate columns are found)
769: . cols - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed)
770: . dnz - the array that will be passed to the matrix preallocation routines
771: - onz - the other array passed to the matrix preallocation routines
773: Level: intermediate
775: Notes:
776: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
778: Do not malloc or free dnz and onz, that is handled internally by these routines
780: Concepts: preallocation^Matrix
782: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
783: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal()
784: M*/
785: #define MatPreallocateSetLocalRemoveDups(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
786: {\
787: PetscInt __l;\
788: _4_ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
789: _4_ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
790: _4_PetscSortRemoveDupsInt(&ncols,cols);CHKERRQ(_4_ierr);\
791: for (__l=0;__l<nrows;__l++) {\
792: _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
793: }\
794: }
796: /*MC
797: MatPreallocateSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
798: inserted using a local number of the rows and columns
800: Synopsis:
801: #include <petscmat.h>
802: PetscErrorCode MatPreallocateSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
804: Not Collective
806: Input Parameters:
807: + map - the row mapping from local numbering to global numbering
808: . nrows - the number of rows indicated
809: . rows - the indices of the rows
810: . cmap - the column mapping from local to global numbering
811: . ncols - the number of columns in the matrix
812: . cols - the columns indicated
813: . dnz - the array that will be passed to the matrix preallocation routines
814: - onz - the other array passed to the matrix preallocation routines
816: Level: intermediate
818: Notes:
819: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
821: Do not malloc or free dnz and onz, that is handled internally by these routines
823: Concepts: preallocation^Matrix
825: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
826: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock()
827: M*/
828: #define MatPreallocateSetLocalBlock(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
829: {\
830: PetscInt __l;\
831: _4_ISLocalToGlobalMappingApplyBlock(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
832: _4_ISLocalToGlobalMappingApplyBlock(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
833: for (__l=0;__l<nrows;__l++) {\
834: _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
835: }\
836: }
838: /*MC
839: MatPreallocateSymmetricSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
840: inserted using a local number of the rows and columns
842: Synopsis:
843: #include <petscmat.h>
844: PetscErrorCode MatPreallocateSymmetricSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
846: Not Collective
848: Input Parameters:
849: + map - the mapping between local numbering and global numbering
850: . nrows - the number of rows indicated
851: . rows - the indices of the rows
852: . ncols - the number of columns in the matrix
853: . cols - the columns indicated
854: . dnz - the array that will be passed to the matrix preallocation routines
855: - onz - the other array passed to the matrix preallocation routines
857: Level: intermediate
859: Notes:
860: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
862: Do not malloc or free dnz and onz that is handled internally by these routines
864: Concepts: preallocation^Matrix
866: .seealso: MatPreallocateFinalize(), MatPreallocateSet()
867: MatPreallocateInitialize(), MatPreallocateSetLocal()
868: M*/
869: #define MatPreallocateSymmetricSetLocalBlock(map,nrows,rows,ncols,cols,dnz,onz) 0;\
870: {\
871: PetscInt __l;\
872: _4_ISLocalToGlobalMappingApplyBlock(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
873: _4_ISLocalToGlobalMappingApplyBlock(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
874: for (__l=0;__l<nrows;__l++) {\
875: _4_MatPreallocateSymmetricSetBlock((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
876: }\
877: }
878: /*MC
879: MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
880: inserted using a local number of the rows and columns
882: Synopsis:
883: #include <petscmat.h>
884: PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
886: Not Collective
888: Input Parameters:
889: + row - the row
890: . ncols - the number of columns in the matrix
891: - cols - the columns indicated
893: Output Parameters:
894: + dnz - the array that will be passed to the matrix preallocation routines
895: - onz - the other array passed to the matrix preallocation routines
897: Level: intermediate
899: Notes:
900: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
902: Do not malloc or free dnz and onz that is handled internally by these routines
904: This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
906: Concepts: preallocation^Matrix
908: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
909: MatPreallocateInitialize(), MatPreallocateSetLocal()
910: M*/
911: #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
912: { PetscInt __i; \
913: 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);\
914: 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);\
915: for (__i=0; __i<nc; __i++) {\
916: if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
917: else if (dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\
918: }\
919: }
921: /*MC
922: MatPreallocateSymmetricSetBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
923: inserted using a local number of the rows and columns
925: Synopsis:
926: #include <petscmat.h>
927: PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
929: Not Collective
931: Input Parameters:
932: + nrows - the number of rows indicated
933: . rows - the indices of the rows
934: . ncols - the number of columns in the matrix
935: . cols - the columns indicated
936: . dnz - the array that will be passed to the matrix preallocation routines
937: - onz - the other array passed to the matrix preallocation routines
939: Level: intermediate
941: Notes:
942: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
944: Do not malloc or free dnz and onz that is handled internally by these routines
946: This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
948: Concepts: preallocation^Matrix
950: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateInitialize(),
951: MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal()
952: M*/
953: #define MatPreallocateSymmetricSetBlock(row,nc,cols,dnz,onz) 0;\
954: { PetscInt __i; \
955: for (__i=0; __i<nc; __i++) {\
956: if (cols[__i] >= __end) onz[row - __rstart]++; \
957: else if (cols[__i] >= row && dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\
958: }\
959: }
961: /*MC
962: MatPreallocateLocation - An alternative to MatPreallocateSet() that puts the nonzero locations into the matrix if it exists
964: Synopsis:
965: #include <petscmat.h>
966: PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)
968: Not Collective
970: Input Parameters:
971: . A - matrix
972: . row - row where values exist (must be local to this process)
973: . ncols - number of columns
974: . cols - columns with nonzeros
975: . dnz - the array that will be passed to the matrix preallocation routines
976: - onz - the other array passed to the matrix preallocation routines
978: Level: intermediate
980: Notes:
981: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
983: Do not malloc or free dnz and onz that is handled internally by these routines
985: This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.
987: Concepts: preallocation^Matrix
989: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
990: MatPreallocateSymmetricSetLocalBlock()
991: M*/
992: #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);}
995: /*MC
996: MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
997: row in a matrix providing the data that one can use to correctly preallocate the matrix.
999: Synopsis:
1000: #include <petscmat.h>
1001: PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
1003: Collective on MPI_Comm
1005: Input Parameters:
1006: + dnz - the array that was be passed to the matrix preallocation routines
1007: - onz - the other array passed to the matrix preallocation routines
1009: Level: intermediate
1011: Notes:
1012: See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.
1014: Do not malloc or free dnz and onz that is handled internally by these routines
1016: This is a MACRO not a function because it closes the { started in MatPreallocateInitialize().
1018: Concepts: preallocation^Matrix
1020: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
1021: MatPreallocateSymmetricSetLocalBlock()
1022: M*/
1023: #define MatPreallocateFinalize(dnz,onz) 0;_4_PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}
1025: /* Routines unique to particular data structures */
1026: PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat,void *);
1028: PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*);
1029: PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
1031: PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
1032: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
1033: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1034: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1035: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1036: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool);
1038: #define MAT_SKIP_ALLOCATION -4
1040: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1041: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1042: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
1044: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1045: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1046: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1047: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
1048: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1049: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
1050: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1051: PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
1052: PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat,Mat*);
1053: PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
1054: PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
1055: PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
1056: PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
1057: PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*);
1059: PETSC_EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt);
1060: PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*);
1062: PETSC_EXTERN PetscErrorCode MatStoreValues(Mat);
1063: PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat);
1065: PETSC_EXTERN PetscErrorCode MatDAADSetCtx(Mat,void*);
1067: PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*);
1068: PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat,IS*);
1069: /*
1070: These routines are not usually accessed directly, rather solving is
1071: done through the KSP and PC interfaces.
1072: */
1074: /*J
1075: MatOrderingType - String with the name of a PETSc matrix ordering
1077: Level: beginner
1079: .seealso: MatGetOrdering()
1080: J*/
1081: typedef const char* MatOrderingType;
1082: #define MATORDERINGNATURAL "natural"
1083: #define MATORDERINGND "nd"
1084: #define MATORDERING1WD "1wd"
1085: #define MATORDERINGRCM "rcm"
1086: #define MATORDERINGQMD "qmd"
1087: #define MATORDERINGROWLENGTH "rowlength"
1088: #define MATORDERINGWBM "wbm"
1089: #define MATORDERINGSPECTRAL "spectral"
1090: #define MATORDERINGAMD "amd" /* only works if UMFPACK is installed with PETSc */
1092: PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*);
1093: PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*);
1094: PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*));
1095: PETSC_EXTERN PetscFunctionList MatOrderingList;
1097: PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1098: PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*);
1100: /*S
1101: MatFactorShiftType - Numeric Shift.
1103: Level: beginner
1105: S*/
1106: typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
1107: PETSC_EXTERN const char *const MatFactorShiftTypes[];
1108: PETSC_EXTERN const char *const MatFactorShiftTypesDetail[];
1110: /*S
1111: MatFactorError - indicates what type of error in matrix factor
1113: Level: beginner
1115: Developer Notes:
1116: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
1118: .seealso: MatGetFactor()
1119: S*/
1120: typedef enum {MAT_FACTOR_NOERROR,MAT_FACTOR_STRUCT_ZEROPIVOT,MAT_FACTOR_NUMERIC_ZEROPIVOT,MAT_FACTOR_OUTMEMORY,MAT_FACTOR_OTHER} MatFactorError;
1122: PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat,MatFactorError*);
1123: PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat);
1124: PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat,PetscReal*,PetscInt*);
1126: /*S
1127: MatFactorInfo - Data passed into the matrix factorization routines, and information about the resulting factorization
1129: In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
1130: $ MatFactorInfo info(MAT_FACTORINFO_SIZE)
1132: Notes:
1133: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
1135: You can use MatFactorInfoInitialize() to set default values.
1137: Level: developer
1139: .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1140: MatFactorInfoInitialize()
1142: S*/
1143: typedef struct {
1144: PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */
1145: PetscReal usedt;
1146: PetscReal dt; /* drop tolerance */
1147: PetscReal dtcol; /* tolerance for pivoting */
1148: PetscReal dtcount; /* maximum nonzeros to be allowed per row */
1149: PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1150: PetscReal levels; /* ICC/ILU(levels) */
1151: PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1152: factorization may be faster if do not pivot */
1153: PetscReal zeropivot; /* pivot is called zero if less than this */
1154: PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */
1155: PetscReal shiftamount; /* how large the shift is */
1156: } MatFactorInfo;
1158: PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*);
1159: PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
1160: PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1161: PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
1162: PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
1163: PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
1164: PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1165: PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1166: PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1167: PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*);
1168: PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1169: PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1170: PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec);
1171: PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec);
1172: PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec);
1173: PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec);
1174: PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec);
1175: PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1176: PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs);
1177: PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat);
1179: typedef enum {MAT_FACTOR_SCHUR_UNFACTORED, MAT_FACTOR_SCHUR_FACTORED, MAT_FACTOR_SCHUR_INVERTED} MatFactorSchurStatus;
1180: PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat,IS);
1181: PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
1182: PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat,Mat*,MatFactorSchurStatus);
1183: PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat);
1184: PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
1185: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat,Vec,Vec);
1186: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat,Vec,Vec);
1187: PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat);
1189: /*E
1190: MatSORType - What type of (S)SOR to perform
1192: Level: beginner
1194: May be bitwise ORd together
1196: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
1198: MatSORType may be bitwise ORd together, so do not change the numbers
1200: .seealso: MatSOR()
1201: E*/
1202: typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1203: SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1204: SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
1205: SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1206: PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1208: /*
1209: These routines are for efficiently computing Jacobians via finite differences.
1210: */
1212: /*S
1213: MatColoring - Object for managing the coloring of matrices.
1215: Level: beginner
1217: Concepts: matrix, coloring
1219: .seealso: MatFDColoringCreate() ISColoring MatFDColoring
1220: S*/
1221: typedef struct _p_MatColoring* MatColoring;
1222: /*J
1223: MatColoringType - String with the name of a PETSc matrix coloring
1225: Level: beginner
1227: .seealso: MatColoringSetType(), MatColoring
1228: J*/
1230: typedef const char* MatColoringType;
1231: #define MATCOLORINGJP "jp"
1232: #define MATCOLORINGPOWER "power"
1233: #define MATCOLORINGNATURAL "natural"
1234: #define MATCOLORINGSL "sl"
1235: #define MATCOLORINGLF "lf"
1236: #define MATCOLORINGID "id"
1237: #define MATCOLORINGGREEDY "greedy"
1239: /*E
1240: MatColoringWeightType - Type of weight scheme
1242: Not Collective
1244: + MAT_COLORING_RANDOM - Random weights
1245: . MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering.
1246: - MAT_COLORING_LF - Last-first weighting.
1248: Level: intermediate
1250: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
1251: E*/
1252: typedef enum {MAT_COLORING_WEIGHT_RANDOM,MAT_COLORING_WEIGHT_LEXICAL,MAT_COLORING_WEIGHT_LF,MAT_COLORING_WEIGHT_SL} MatColoringWeightType;
1254: PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*);
1255: PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*);
1256: PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*);
1257: PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer);
1258: PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType);
1259: PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring);
1260: PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt);
1261: PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*);
1262: PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt);
1263: PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*);
1264: PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*);
1265: PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring));
1266: PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1267: PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType);
1268: PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*);
1269: PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm);
1270: PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring,ISColoring);
1271: PETSC_DEPRECATED("Use MatColoringTest()") PETSC_STATIC_INLINE PetscErrorCode MatColoringTestValid(MatColoring matcoloring,ISColoring iscoloring) {return MatColoringTest(matcoloring,iscoloring);}
1272: PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat,ISColoring);
1274: /*S
1275: MatFDColoring - Object for computing a sparse Jacobian via finite differences
1276: and coloring
1278: Level: beginner
1280: Concepts: coloring, sparse Jacobian, finite differences
1282: .seealso: MatFDColoringCreate()
1283: S*/
1284: typedef struct _p_MatFDColoring* MatFDColoring;
1286: PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1287: PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*);
1288: PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer);
1289: PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1290: PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1291: PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1292: PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
1293: PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *);
1294: PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec);
1295: PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,const PetscInt*[]);
1296: PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring);
1297: PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt);
1300: /*S
1301: MatTransposeColoring - Object for computing a sparse matrix product C=A*B^T via coloring
1303: Level: beginner
1305: Concepts: coloring, sparse matrix product
1307: .seealso: MatTransposeColoringCreate()
1308: S*/
1309: typedef struct _p_MatTransposeColoring* MatTransposeColoring;
1311: PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *);
1312: PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat);
1313: PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat);
1314: PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*);
1316: /*
1317: These routines are for partitioning matrices: currently used only
1318: for adjacency matrix, MatCreateMPIAdj().
1319: */
1321: /*S
1322: MatPartitioning - Object for managing the partitioning of a matrix or graph
1324: Level: beginner
1326: Concepts: partitioning
1328: .seealso: MatPartitioningCreate(), MatPartitioningType
1329: S*/
1330: typedef struct _p_MatPartitioning* MatPartitioning;
1332: /*J
1333: MatPartitioningType - String with the name of a PETSc matrix partitioning
1335: Level: beginner
1336: dm
1337: .seealso: MatPartitioningCreate(), MatPartitioning
1338: J*/
1339: typedef const char* MatPartitioningType;
1340: #define MATPARTITIONINGCURRENT "current"
1341: #define MATPARTITIONINGAVERAGE "average"
1342: #define MATPARTITIONINGSQUARE "square"
1343: #define MATPARTITIONINGPARMETIS "parmetis"
1344: #define MATPARTITIONINGCHACO "chaco"
1345: #define MATPARTITIONINGPARTY "party"
1346: #define MATPARTITIONINGPTSCOTCH "ptscotch"
1347: #define MATPARTITIONINGHIERARCH "hierarch"
1350: PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1351: PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType);
1352: PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt);
1353: PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat);
1354: PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1355: PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1356: PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*);
1357: PETSC_EXTERN PetscErrorCode MatPartitioningApplyND(MatPartitioning,IS*);
1358: PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*);
1360: PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[],PetscErrorCode (*)(MatPartitioning));
1364: PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer);
1365: PETSC_STATIC_INLINE PetscErrorCode MatPartitioningViewFromOptions(MatPartitioning A,PetscObject B,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,B,name);}
1367: PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
1368: PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*);
1370: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part);
1371: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1372: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);
1374: typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType;
1375: PETSC_EXTERN const char *const MPChacoGlobalTypes[];
1376: typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType;
1377: PETSC_EXTERN const char *const MPChacoLocalTypes[];
1378: typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType;
1379: PETSC_EXTERN const char *const MPChacoEigenTypes[];
1381: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType);
1382: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*);
1383: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType);
1384: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*);
1385: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
1386: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1387: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*);
1388: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal);
1389: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*);
1390: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt);
1391: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*);
1393: #define MP_PARTY_OPT "opt"
1394: #define MP_PARTY_LIN "lin"
1395: #define MP_PARTY_SCA "sca"
1396: #define MP_PARTY_RAN "ran"
1397: #define MP_PARTY_GBF "gbf"
1398: #define MP_PARTY_GCF "gcf"
1399: #define MP_PARTY_BUB "bub"
1400: #define MP_PARTY_DEF "def"
1401: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*);
1402: #define MP_PARTY_HELPFUL_SETS "hs"
1403: #define MP_PARTY_KERNIGHAN_LIN "kl"
1404: #define MP_PARTY_NONE "no"
1405: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*);
1406: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1407: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool);
1408: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool);
1410: typedef enum { MP_PTSCOTCH_DEFAULT,MP_PTSCOTCH_QUALITY,MP_PTSCOTCH_SPEED,MP_PTSCOTCH_BALANCE,MP_PTSCOTCH_SAFETY,MP_PTSCOTCH_SCALABILITY } MPPTScotchStrategyType;
1411: PETSC_EXTERN const char *const MPPTScotchStrategyTypes[];
1413: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal);
1414: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*);
1415: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType);
1416: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*);
1418: /*
1419: * hierarchical partitioning
1420: */
1421: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning,IS*);
1422: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning,IS*);
1423: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning,PetscInt);
1424: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt);
1426: PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
1427: PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);
1429: /*
1430: If you add entries here you must also add them to petsc/finclude/petscmat.h
1431: */
1432: typedef enum { MATOP_SET_VALUES=0,
1433: MATOP_GET_ROW=1,
1434: MATOP_RESTORE_ROW=2,
1435: MATOP_MULT=3,
1436: MATOP_MULT_ADD=4,
1437: MATOP_MULT_TRANSPOSE=5,
1438: MATOP_MULT_TRANSPOSE_ADD=6,
1439: MATOP_SOLVE=7,
1440: MATOP_SOLVE_ADD=8,
1441: MATOP_SOLVE_TRANSPOSE=9,
1442: MATOP_SOLVE_TRANSPOSE_ADD=10,
1443: MATOP_LUFACTOR=11,
1444: MATOP_CHOLESKYFACTOR=12,
1445: MATOP_SOR=13,
1446: MATOP_TRANSPOSE=14,
1447: MATOP_GETINFO=15,
1448: MATOP_EQUAL=16,
1449: MATOP_GET_DIAGONAL=17,
1450: MATOP_DIAGONAL_SCALE=18,
1451: MATOP_NORM=19,
1452: MATOP_ASSEMBLY_BEGIN=20,
1453: MATOP_ASSEMBLY_END=21,
1454: MATOP_SET_OPTION=22,
1455: MATOP_ZERO_ENTRIES=23,
1456: MATOP_ZERO_ROWS=24,
1457: MATOP_LUFACTOR_SYMBOLIC=25,
1458: MATOP_LUFACTOR_NUMERIC=26,
1459: MATOP_CHOLESKY_FACTOR_SYMBOLIC=27,
1460: MATOP_CHOLESKY_FACTOR_NUMERIC=28,
1461: MATOP_SETUP_PREALLOCATION=29,
1462: MATOP_ILUFACTOR_SYMBOLIC=30,
1463: MATOP_ICCFACTOR_SYMBOLIC=31,
1464: MATOP_GET_DIAGONAL_BLOCK=32,
1465: /* MATOP_PLACEHOLDER_33=33, */
1466: MATOP_DUPLICATE=34,
1467: MATOP_FORWARD_SOLVE=35,
1468: MATOP_BACKWARD_SOLVE=36,
1469: MATOP_ILUFACTOR=37,
1470: MATOP_ICCFACTOR=38,
1471: MATOP_AXPY=39,
1472: MATOP_CREATE_SUBMATRICES=40,
1473: MATOP_INCREASE_OVERLAP=41,
1474: MATOP_GET_VALUES=42,
1475: MATOP_COPY=43,
1476: MATOP_GET_ROW_MAX=44,
1477: MATOP_SCALE=45,
1478: MATOP_SHIFT=46,
1479: MATOP_DIAGONAL_SET=47,
1480: MATOP_ZERO_ROWS_COLUMNS=48,
1481: MATOP_SET_RANDOM=49,
1482: MATOP_GET_ROW_IJ=50,
1483: MATOP_RESTORE_ROW_IJ=51,
1484: MATOP_GET_COLUMN_IJ=52,
1485: MATOP_RESTORE_COLUMN_IJ=53,
1486: MATOP_FDCOLORING_CREATE=54,
1487: MATOP_COLORING_PATCH=55,
1488: MATOP_SET_UNFACTORED=56,
1489: MATOP_PERMUTE=57,
1490: MATOP_SET_VALUES_BLOCKED=58,
1491: MATOP_CREATE_SUBMATRIX=59,
1492: MATOP_DESTROY=60,
1493: MATOP_VIEW=61,
1494: MATOP_CONVERT_FROM=62,
1495: MATOP_MATMAT_MULT=63,
1496: MATOP_MATMAT_MULT_SYMBOLIC=64,
1497: MATOP_MATMAT_MULT_NUMERIC=65,
1498: MATOP_SET_LOCAL_TO_GLOBAL_MAP=66,
1499: MATOP_SET_VALUES_LOCAL=67,
1500: MATOP_ZERO_ROWS_LOCAL=68,
1501: MATOP_GET_ROW_MAX_ABS=69,
1502: MATOP_GET_ROW_MIN_ABS=70,
1503: MATOP_CONVERT=71,
1504: MATOP_SET_COLORING=72,
1505: /* MATOP_PLACEHOLDER_73=73, */
1506: MATOP_SET_VALUES_ADIFOR=74,
1507: MATOP_FD_COLORING_APPLY=75,
1508: MATOP_SET_FROM_OPTIONS=76,
1509: MATOP_MULT_CONSTRAINED=77,
1510: MATOP_MULT_TRANSPOSE_CONSTRAIN=78,
1511: MATOP_FIND_ZERO_DIAGONALS=79,
1512: MATOP_MULT_MULTIPLE=80,
1513: MATOP_SOLVE_MULTIPLE=81,
1514: MATOP_GET_INERTIA=82,
1515: MATOP_LOAD=83,
1516: MATOP_IS_SYMMETRIC=84,
1517: MATOP_IS_HERMITIAN=85,
1518: MATOP_IS_STRUCTURALLY_SYMMETRIC=86,
1519: MATOP_SET_VALUES_BLOCKEDLOCAL=87,
1520: MATOP_CREATE_VECS=88,
1521: MATOP_MAT_MULT=89,
1522: MATOP_MAT_MULT_SYMBOLIC=90,
1523: MATOP_MAT_MULT_NUMERIC=91,
1524: MATOP_PTAP=92,
1525: MATOP_PTAP_SYMBOLIC=93,
1526: MATOP_PTAP_NUMERIC=94,
1527: MATOP_MAT_TRANSPOSE_MULT=95,
1528: MATOP_MAT_TRANSPOSE_MULT_SYMBO=96,
1529: MATOP_MAT_TRANSPOSE_MULT_NUMER=97,
1530: /* MATOP_PLACEHOLDER_98=98, */
1531: /* MATOP_PLACEHOLDER_99=99, */
1532: /* MATOP_PLACEHOLDER_100=100, */
1533: /* MATOP_PLACEHOLDER_101=101, */
1534: MATOP_CONJUGATE=102,
1535: /* MATOP_PLACEHOLDER_103=103, */
1536: MATOP_SET_VALUES_ROW=104,
1537: MATOP_REAL_PART=105,
1538: MATOP_IMAGINARY_PART=106,
1539: MATOP_GET_ROW_UPPER_TRIANGULAR=107,
1540: MATOP_RESTORE_ROW_UPPER_TRIANG=108,
1541: MATOP_MAT_SOLVE=109,
1542: MATOP_MAT_SOLVE_TRANSPOSE=110,
1543: MATOP_GET_ROW_MIN=111,
1544: MATOP_GET_COLUMN_VECTOR=112,
1545: MATOP_MISSING_DIAGONAL=113,
1546: MATOP_GET_SEQ_NONZERO_STRUCTUR=114,
1547: MATOP_CREATE=115,
1548: MATOP_GET_GHOSTS=116,
1549: MATOP_GET_LOCAL_SUB_MATRIX=117,
1550: MATOP_RESTORE_LOCALSUB_MATRIX=118,
1551: MATOP_MULT_DIAGONAL_BLOCK=119,
1552: MATOP_HERMITIAN_TRANSPOSE=120,
1553: MATOP_MULT_HERMITIAN_TRANSPOSE=121,
1554: MATOP_MULT_HERMITIAN_TRANS_ADD=122,
1555: MATOP_GET_MULTI_PROC_BLOCK=123,
1556: MATOP_FIND_NONZERO_ROWS=124,
1557: MATOP_GET_COLUMN_NORMS=125,
1558: MATOP_INVERT_BLOCK_DIAGONAL=126,
1559: /* MATOP_PLACEHOLDER_127=127, */
1560: MATOP_CREATE_SUB_MATRICES_MPI=128,
1561: MATOP_SET_VALUES_BATCH=129,
1562: MATOP_TRANSPOSE_MAT_MULT=130,
1563: MATOP_TRANSPOSE_MAT_MULT_SYMBO=131,
1564: MATOP_TRANSPOSE_MAT_MULT_NUMER=132,
1565: MATOP_TRANSPOSE_COLORING_CREAT=133,
1566: MATOP_TRANS_COLORING_APPLY_SPT=134,
1567: MATOP_TRANS_COLORING_APPLY_DEN=135,
1568: MATOP_RART=136,
1569: MATOP_RART_SYMBOLIC=137,
1570: MATOP_RART_NUMERIC=138,
1571: MATOP_SET_BLOCK_SIZES=139,
1572: MATOP_AYPX=140,
1573: MATOP_RESIDUAL=141,
1574: MATOP_FDCOLORING_SETUP=142,
1575: MATOP_MPICONCATENATESEQ=144,
1576: MATOP_DESTROYSUBMATRICES=145
1577: } MatOperation;
1578: PETSC_EXTERN PetscErrorCode MatSetOperation(Mat,MatOperation,void(*)(void));
1579: PETSC_EXTERN PetscErrorCode MatGetOperation(Mat,MatOperation,void(**)(void));
1580: PETSC_EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool *);
1581: PETSC_EXTERN PetscErrorCode MatHasCongruentLayouts(Mat,PetscBool *);
1583: PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void));
1584: PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void));
1585: PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*);
1586: PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*);
1587: PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*);
1588: PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat);
1590: /*
1591: Codes for matrices stored on disk. By default they are
1592: stored in a universal format. By changing the format with
1593: PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
1594: be stored in a way natural for the matrix, for example dense matrices
1595: would be stored as dense. Matrices stored this way may only be
1596: read into matrices of the same type.
1597: */
1598: #define MATRIX_BINARY_FORMAT_DENSE -1
1600: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1602: PETSC_EXTERN PetscErrorCode MatISSetLocalMatType(Mat,MatType);
1603: PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1604: PETSC_EXTERN PetscErrorCode MatISSetUpSF(Mat);
1605: PETSC_EXTERN PetscErrorCode MatISStoreL2L(Mat,PetscBool);
1606: PETSC_EXTERN PetscErrorCode MatISFixLocalEmpty(Mat,PetscBool);
1607: PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*);
1608: PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat,Mat*);
1609: PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat);
1610: PETSC_EXTERN PETSC_DEPRECATED("Use the MatConvert() interface") PetscErrorCode MatISGetMPIXAIJ(Mat,MatReuse,Mat*);
1612: /*S
1613: MatNullSpace - Object that removes a null space from a vector, i.e.
1614: orthogonalizes the vector to a subsapce
1616: Level: advanced
1618: Concepts: matrix; linear operator, null space
1620: Users manual sections:
1621: . Section 4.19 Solving Singular Systems
1623: .seealso: MatNullSpaceCreate()
1624: S*/
1625: typedef struct _p_MatNullSpace* MatNullSpace;
1627: PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*);
1628: PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1629: PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*);
1630: PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec);
1631: PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *);
1632: PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *);
1633: PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat,MatNullSpace);
1634: PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace);
1635: PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace);
1636: PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*);
1637: PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool *);
1638: PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer);
1639: PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**);
1640: PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*);
1642: PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS);
1643: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1644: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
1645: PETSC_EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat);
1647: PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*);
1648: PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*);
1649: PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*);
1651: PETSC_EXTERN PetscErrorCode MatComputeExplicitOperator(Mat,Mat*);
1652: PETSC_EXTERN PetscErrorCode MatComputeExplicitOperatorTranspose(Mat,Mat*);
1654: PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec);
1656: PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
1657: PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec);
1658: PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1659: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1660: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1661: PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1662: PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
1663: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal);
1664: PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt);
1665: PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *);
1666: PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]);
1667: PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1668: PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);
1670: /*S
1671: MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free
1672: Jacobian vector products
1674: Notes:
1675: MATMFFD is a specific MatType which uses the MatMFFD data structure
1677: MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure
1679: Level: developer
1681: .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
1682: S*/
1683: typedef struct _p_MatMFFD* MatMFFD;
1685: /*J
1686: MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function
1688: Level: beginner
1690: .seealso: MatMFFDSetType(), MatMFFDRegister()
1691: J*/
1692: typedef const char* MatMFFDType;
1693: #define MATMFFD_DS "ds"
1694: #define MATMFFD_WP "wp"
1696: PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat,MatMFFDType);
1697: PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[],PetscErrorCode (*)(MatMFFD));
1699: PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal);
1700: PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool );
1702: PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring,MatMFFDType);
1704: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1705: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
1707: /*
1708: PETSc interface to MUMPS
1709: */
1710: #ifdef PETSC_HAVE_MUMPS
1711: PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
1712: PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat,PetscInt,PetscInt*);
1713: PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal);
1714: PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat,PetscInt,PetscReal*);
1716: PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat,PetscInt,PetscInt*);
1717: PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat,PetscInt,PetscInt*);
1718: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat,PetscInt,PetscReal*);
1719: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat,PetscInt,PetscReal*);
1720: PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat,Mat);
1721: PETSC_EXTERN PetscErrorCode MatMumpsGetInverseTranspose(Mat,Mat);
1722: #endif
1724: /*
1725: PETSc interface to Mkl_Pardiso
1726: */
1727: #ifdef PETSC_HAVE_MKL_PARDISO
1728: PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt);
1729: #endif
1731: /*
1732: PETSc interface to Mkl_CPardiso
1733: */
1734: #ifdef PETSC_HAVE_MKL_CPARDISO
1735: PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt);
1736: #endif
1738: /*
1739: PETSc interface to SUPERLU
1740: */
1741: #ifdef PETSC_HAVE_SUPERLU
1742: PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal);
1743: #endif
1745: /*
1746: PETSc interface to SUPERLU_DIST
1747: */
1748: #ifdef PETSC_HAVE_SUPERLU_DIST
1749: PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat,PetscScalar*);
1750: #endif
1752: /*
1753: PETSc interface to STRUMPACK
1754: */
1755: #ifdef PETSC_HAVE_STRUMPACK
1756: /*E
1757: MatSTRUMPACKReordering - sparsity reducing ordering to be used in STRUMPACK
1759: Level: intermediate
1760: E*/
1761: typedef enum {MAT_STRUMPACK_NATURAL=0,
1762: MAT_STRUMPACK_METIS=1,
1763: MAT_STRUMPACK_PARMETIS=2,
1764: MAT_STRUMPACK_SCOTCH=3,
1765: MAT_STRUMPACK_PTSCOTCH=4,
1766: MAT_STRUMPACK_RCM=5} MatSTRUMPACKReordering;
1767: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat,MatSTRUMPACKReordering);
1768: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat,PetscBool);
1769: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSRelTol(Mat,PetscReal);
1770: PETSC_DEPRECATED ("Use MatSTRUMPACKSetHSSRelTol()") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSRelCompTol(Mat mat,PetscReal rtol) {return MatSTRUMPACKSetHSSRelTol(mat,rtol);}
1771: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSAbsTol(Mat,PetscReal);
1772: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMinSepSize(Mat,PetscInt);
1773: PETSC_DEPRECATED ("Use MatSTRUMPACKSetHSSMinSepSize()") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSMinSize(Mat mat,PetscInt hssminsize) {return MatSTRUMPACKSetHSSMinSepSize(mat,hssminsize);}
1774: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMaxRank(Mat,PetscInt);
1775: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSLeafSize(Mat,PetscInt);
1776: #endif
1779: #ifdef PETSC_HAVE_CUDA
1780: /*E
1781: MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU)
1782: matrices.
1784: Not Collective
1786: + MAT_CUSPARSE_CSR - Compressed Sparse Row
1787: . MAT_CUSPARSE_ELL - Ellpack (requires CUDA 4.2 or later).
1788: - MAT_CUSPARSE_HYB - Hybrid, a combination of Ellpack and Coordinate format (requires CUDA 4.2 or later).
1790: Level: intermediate
1792: Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
1794: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation
1795: E*/
1797: typedef enum {MAT_CUSPARSE_CSR, MAT_CUSPARSE_ELL, MAT_CUSPARSE_HYB} MatCUSPARSEStorageFormat;
1799: /* these will be strings associated with enumerated type defined above */
1800: PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[];
1802: /*E
1803: MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU)
1804: matrices whose operation should use a particular storage format.
1806: Not Collective
1808: + MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
1809: . MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
1810: . MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
1811: - MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices
1813: Level: intermediate
1815: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat
1816: E*/
1817: typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation;
1819: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1820: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1821: PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat);
1822: #endif
1824: #if defined(PETSC_HAVE_VIENNACL)
1825: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1826: PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1827: #endif
1829: /*
1830: PETSc interface to FFTW
1831: */
1832: #if defined(PETSC_HAVE_FFTW)
1833: PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec);
1834: PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec);
1835: PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*);
1836: #endif
1838: PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*);
1839: PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*);
1840: PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]);
1841: PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]);
1842: PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***);
1843: PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*);
1844: PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType);
1845: PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]);
1846: PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat);
1848: PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal);
1849: PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*);
1851: PETSC_EXTERN PetscErrorCode MatSubdomainsCreateCoalesce(Mat,PetscInt,PetscInt*,IS**);
1853: PETSC_EXTERN PetscErrorCode MatPreallocatorPreallocate(Mat,PetscBool,Mat);
1855: PETSC_INTERN PetscErrorCode MatHeaderMerge(Mat,Mat*);
1856: PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat,Mat*);
1858: #endif