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