xref: /petsc/include/petscmat.h (revision f3f0eb19a322e1923f66aeb6cc7ffacd1eb54b2a)
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
10 
11    Level: beginner
12 
13   Concepts: matrix; linear operator
14 
15 .seealso:  MatCreate(), MatType, MatSetType()
16 S*/
17 typedef struct _p_Mat*           Mat;
18 
19 /*J
20     MatType - String with the name of a PETSc matrix or the creation function
21        with an optional dynamic library name, for example
22        http://www.mcs.anl.gov/petsc/lib.a:mymatcreate()
23 
24    Level: beginner
25 
26 .seealso: MatSetType(), Mat, MatSolverPackage
27 J*/
28 typedef const char* MatType;
29 #define MATSAME            "same"
30 #define MATMAIJ            "maij"
31 #define MATSEQMAIJ         "seqmaij"
32 #define MATMPIMAIJ         "mpimaij"
33 #define MATIS              "is"
34 #define MATAIJ             "aij"
35 #define MATSEQAIJ          "seqaij"
36 #define MATSEQAIJPTHREAD   "seqaijpthread"
37 #define MATAIJPTHREAD      "aijpthread"
38 #define MATMPIAIJ          "mpiaij"
39 #define MATAIJCRL          "aijcrl"
40 #define MATSEQAIJCRL       "seqaijcrl"
41 #define MATMPIAIJCRL       "mpiaijcrl"
42 #define MATAIJCUSP         "aijcusp"
43 #define MATSEQAIJCUSP      "seqaijcusp"
44 #define MATMPIAIJCUSP      "mpiaijcusp"
45 #define MATAIJCUSPARSE     "aijcusparse"
46 #define MATSEQAIJCUSPARSE  "seqaijcusparse"
47 #define MATMPIAIJCUSPARSE  "mpiaijcusparse"
48 #define MATAIJPERM         "aijperm"
49 #define MATSEQAIJPERM      "seqaijperm"
50 #define MATMPIAIJPERM      "mpiaijperm"
51 #define MATSHELL           "shell"
52 #define MATDENSE           "dense"
53 #define MATSEQDENSE        "seqdense"
54 #define MATMPIDENSE        "mpidense"
55 #define MATELEMENTAL       "elemental"
56 #define MATBAIJ            "baij"
57 #define MATSEQBAIJ         "seqbaij"
58 #define MATMPIBAIJ         "mpibaij"
59 #define MATMPIADJ          "mpiadj"
60 #define MATSBAIJ           "sbaij"
61 #define MATSEQSBAIJ        "seqsbaij"
62 #define MATMPISBAIJ        "mpisbaij"
63 #define MATSEQBSTRM        "seqbstrm"
64 #define MATMPIBSTRM        "mpibstrm"
65 #define MATBSTRM           "bstrm"
66 #define MATSEQSBSTRM       "seqsbstrm"
67 #define MATMPISBSTRM       "mpisbstrm"
68 #define MATSBSTRM          "sbstrm"
69 #define MATDAAD            "daad"
70 #define MATMFFD            "mffd"
71 #define MATNORMAL          "normal"
72 #define MATLRC             "lrc"
73 #define MATSCATTER         "scatter"
74 #define MATBLOCKMAT        "blockmat"
75 #define MATCOMPOSITE       "composite"
76 #define MATFFT             "fft"
77 #define MATFFTW            "fftw"
78 #define MATSEQCUFFT        "seqcufft"
79 #define MATTRANSPOSEMAT    "transpose"
80 #define MATSCHURCOMPLEMENT "schurcomplement"
81 #define MATPYTHON          "python"
82 #define MATHYPRESTRUCT     "hyprestruct"
83 #define MATHYPRESSTRUCT    "hypresstruct"
84 #define MATSUBMATRIX       "submatrix"
85 #define MATLOCALREF        "localref"
86 #define MATNEST            "nest"
87 #define MATIJ              "ij"
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" indicates either
93        SuperLU or SuperLU_Dist etc.
94 
95 
96    Level: beginner
97 
98 .seealso: MatGetFactor(), Mat, MatSetType(), MatType
99 J*/
100 #define MatSolverPackage char*
101 #define MATSOLVERSUPERLU      "superlu"
102 #define MATSOLVERSUPERLU_DIST "superlu_dist"
103 #define MATSOLVERUMFPACK      "umfpack"
104 #define MATSOLVERCHOLMOD      "cholmod"
105 #define MATSOLVERESSL         "essl"
106 #define MATSOLVERLUSOL        "lusol"
107 #define MATSOLVERMUMPS        "mumps"
108 #define MATSOLVERPASTIX       "pastix"
109 #define MATSOLVERMATLAB       "matlab"
110 #define MATSOLVERPETSC        "petsc"
111 #define MATSOLVERBAS          "bas"
112 #define MATSOLVERCUSPARSE     "cusparse"
113 #define MATSOLVERBSTRM        "bstrm"
114 #define MATSOLVERSBSTRM       "sbstrm"
115 #define MATSOLVERELEMENTAL    "elemental"
116 #define MATSOLVERCLIQUE       "clique"
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/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 
135 /* Logging support */
136 #define    MAT_FILE_CLASSID 1211216    /* used to indicate matrices in binary files */
137 PETSC_EXTERN PetscClassId MAT_CLASSID;
138 PETSC_EXTERN PetscClassId MAT_FDCOLORING_CLASSID;
139 PETSC_EXTERN PetscClassId MAT_TRANSPOSECOLORING_CLASSID;
140 PETSC_EXTERN PetscClassId MAT_PARTITIONING_CLASSID;
141 PETSC_EXTERN PetscClassId MAT_COARSEN_CLASSID;
142 PETSC_EXTERN PetscClassId MAT_NULLSPACE_CLASSID;
143 PETSC_EXTERN PetscClassId MATMFFD_CLASSID;
144 
145 /*E
146     MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
147      or MatGetSubMatrix() are to be reused to store the new matrix values. For MatConvert() is used to indicate
148      that the input matrix is to be replaced with the converted matrix.
149 
150     Level: beginner
151 
152    Any additions/changes here MUST also be made in include/finclude/petscmat.h
153 
154 .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
155 E*/
156 typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX} MatReuse;
157 
158 /*E
159     MatGetSubMatrixOption - Indicates if matrices obtained from a call to MatGetSubMatrices()
160      include the matrix values. Currently it is only used by MatGetSeqNonzerostructure().
161 
162     Level: beginner
163 
164 .seealso: MatGetSeqNonzerostructure()
165 E*/
166 typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatGetSubMatrixOption;
167 
168 PETSC_EXTERN PetscErrorCode MatInitializePackage(const char[]);
169 
170 PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm,Mat*);
171 PETSC_EXTERN PetscErrorCode MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
172 PETSC_EXTERN PetscErrorCode MatSetType(Mat,MatType);
173 PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat);
174 PETSC_EXTERN PetscErrorCode MatViewFromOptions(Mat,const char[]);
175 PETSC_EXTERN PetscErrorCode MatRegisterAll(const char[]);
176 PETSC_EXTERN PetscErrorCode MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat));
177 PETSC_EXTERN PetscErrorCode MatRegisterBaseName(const char[],const char[],const char[]);
178 PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat,const char[]);
179 PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat,const char[]);
180 PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat,const char*[]);
181 
182 /*MC
183    MatRegisterDynamic - Adds a new matrix type
184 
185    Synopsis:
186    PetscErrorCode MatRegisterDynamic(const char *name,const char *path,const char *name_create,PetscErrorCode (*routine_create)(Mat))
187 
188    Not Collective
189 
190    Input Parameters:
191 +  name - name of a new user-defined matrix type
192 .  path - path (either absolute or relative) the library containing this solver
193 .  name_create - name of routine to create method context
194 -  routine_create - routine to create method context
195 
196    Notes:
197    MatRegisterDynamic() may be called multiple times to add several user-defined solvers.
198 
199    If dynamic libraries are used, then the fourth input argument (routine_create)
200    is ignored.
201 
202    Sample usage:
203 .vb
204    MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a,
205                "MyMatCreate",MyMatCreate);
206 .ve
207 
208    Then, your solver can be chosen with the procedural interface via
209 $     MatSetType(Mat,"my_mat")
210    or at runtime via the option
211 $     -mat_type my_mat
212 
213    Level: advanced
214 
215    Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
216          If your function is not being put into a shared library then use VecRegister() instead
217 
218 .keywords: Mat, register
219 
220 .seealso: MatRegisterAll(), MatRegisterDestroy()
221 
222 M*/
223 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
224 #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0)
225 #else
226 #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d)
227 #endif
228 
229 PETSC_EXTERN PetscBool MatRegisterAllCalled;
230 PETSC_EXTERN PetscFList MatList;
231 PETSC_EXTERN PetscFList MatColoringList;
232 PETSC_EXTERN PetscFList MatPartitioningList;
233 PETSC_EXTERN PetscFList MatCoarsenList;
234 
235 /*E
236     MatStructure - Indicates if the matrix has the same nonzero structure
237 
238     Level: beginner
239 
240    Any additions/changes here MUST also be made in include/finclude/petscmat.h
241 
242 .seealso: MatCopy(), KSPSetOperators(), PCSetOperators()
243 E*/
244 typedef enum {DIFFERENT_NONZERO_PATTERN,SUBSET_NONZERO_PATTERN,SAME_NONZERO_PATTERN,SAME_PRECONDITIONER} MatStructure;
245 
246 PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
247 PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
248 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
249 PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
250 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
251 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
252 
253 PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
254 PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
255 PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*);
256 
257 PETSC_EXTERN PetscErrorCode MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
258 PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
259 
260 PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
261 PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
262 PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
263 PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat,PetscInt,const PetscInt*,const PetscInt*,const PetscInt*,const PetscInt*);
264 
265 PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
266 PETSC_EXTERN PetscErrorCode MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*);
267 PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat,Mat*);
268 PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat,Mat,Mat,Mat*);
269 PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*);
270 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
271 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
272 
273 PETSC_EXTERN PetscErrorCode MatCreateSeqBSTRM(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
274 PETSC_EXTERN PetscErrorCode MatCreateMPIBSTRM(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
275 PETSC_EXTERN PetscErrorCode MatCreateSeqSBSTRM(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
276 PETSC_EXTERN PetscErrorCode MatCreateMPISBSTRM(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
277 
278 PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*);
279 PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter);
280 PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*);
281 PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
282 PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat,Mat);
283 PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat);
284 PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
285 typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
286 PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat,MatCompositeType);
287 
288 PETSC_EXTERN PetscErrorCode MatCreateFFT(MPI_Comm,PetscInt,const PetscInt[],MatType,Mat*);
289 PETSC_EXTERN PetscErrorCode MatCreateSeqCUFFT(MPI_Comm,PetscInt,const PetscInt[],Mat*);
290 
291 PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*);
292 PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,Mat*);
293 PETSC_EXTERN PetscErrorCode MatSubMatrixUpdate(Mat,Mat,IS,IS);
294 PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*);
295 
296 PETSC_EXTERN PetscErrorCode MatPythonSetType(Mat,const char[]);
297 
298 PETSC_EXTERN PetscErrorCode MatSetUp(Mat);
299 PETSC_EXTERN PetscErrorCode MatDestroy(Mat*);
300 
301 PETSC_EXTERN PetscErrorCode MatConjugate(Mat);
302 PETSC_EXTERN PetscErrorCode MatRealPart(Mat);
303 PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat);
304 PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,Mat*);
305 PETSC_EXTERN PetscErrorCode MatGetTrace(Mat,PetscScalar*);
306 PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat,const PetscScalar **);
307 
308 /* ------------------------------------------------------------*/
309 PETSC_EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
310 PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
311 PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
312 PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
313 PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat,PetscInt,PetscInt,PetscInt[],const PetscScalar[]);
314 PETSC_EXTERN PetscErrorCode MatSetRandom(Mat,PetscRandom);
315 
316 /*S
317      MatStencil - Data structure (C struct) for storing information about a single row or
318         column of a matrix as indexed on an associated grid.
319 
320    Fortran usage is different, see MatSetValuesStencil() for details.
321 
322    Level: beginner
323 
324   Concepts: matrix; linear operator
325 
326 .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockedStencil()
327 S*/
328 typedef struct {
329   PetscInt k,j,i,c;
330 } MatStencil;
331 
332 PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
333 PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
334 PETSC_EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
335 
336 PETSC_EXTERN PetscErrorCode MatSetColoring(Mat,ISColoring);
337 PETSC_EXTERN PetscErrorCode MatSetValuesAdic(Mat,void*);
338 PETSC_EXTERN PetscErrorCode MatSetValuesAdifor(Mat,PetscInt,void*);
339 
340 /*E
341     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
342      to continue to add values to it
343 
344     Level: beginner
345 
346 .seealso: MatAssemblyBegin(), MatAssemblyEnd()
347 E*/
348 typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
349 PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType);
350 PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType);
351 PETSC_EXTERN PetscErrorCode MatAssembled(Mat,PetscBool *);
352 
353 
354 
355 /*E
356     MatOption - Options that may be set for a matrix and its behavior or storage
357 
358     Level: beginner
359 
360    Any additions/changes here MUST also be made in include/finclude/petscmat.h
361 
362    Developer Notes: Entries that are negative need not be called collectively by all processes.
363 
364 .seealso: MatSetOption()
365 E*/
366 typedef enum {MAT_OPTION_MIN = -8,
367               MAT_NEW_NONZERO_LOCATION_ERR = -7,
368               MAT_NO_OFF_PROC_ZERO_ROWS = -6,
369               MAT_NO_OFF_PROC_ENTRIES = -5,
370               MAT_UNUSED_NONZERO_LOCATION_ERR = -4,
371               MAT_NEW_NONZERO_ALLOCATION_ERR = -3,
372               MAT_ROW_ORIENTED = -2,
373               MAT_NEW_NONZERO_LOCATIONS = -1,
374               MAT_SYMMETRIC = 1,
375               MAT_STRUCTURALLY_SYMMETRIC = 2,
376               MAT_NEW_DIAGONALS = 3,
377               MAT_IGNORE_OFF_PROC_ENTRIES = 4,
378               MAT_USE_HASH_TABLE = 5,
379               MAT_KEEP_NONZERO_PATTERN = 6,
380               MAT_IGNORE_ZERO_ENTRIES = 7,
381               MAT_USE_INODES = 8,
382               MAT_HERMITIAN = 9,
383               MAT_SYMMETRY_ETERNAL = 10,
384               MAT_CHECK_COMPRESSED_ROW = 11,
385               MAT_IGNORE_LOWER_TRIANGULAR = 12,
386               MAT_ERROR_LOWER_TRIANGULAR = 13,
387               MAT_GETROW_UPPERTRIANGULAR = 14,
388               MAT_SPD = 15,
389               MAT_OPTION_MAX = 16} MatOption;
390 
391 PETSC_EXTERN const char *MatOptions[];
392 PETSC_EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscBool );
393 PETSC_EXTERN PetscErrorCode MatGetType(Mat,MatType*);
394 
395 PETSC_EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
396 PETSC_EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
397 PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
398 PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat);
399 PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat);
400 PETSC_EXTERN PetscErrorCode MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
401 PETSC_EXTERN PetscErrorCode MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
402 PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt);
403 PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat,PetscScalar *[]);
404 PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat,PetscScalar *[]);
405 PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat,PetscScalar *[]);
406 PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat,PetscScalar *[]);
407 PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *);
408 PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt);
409 PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat,PetscInt *,PetscInt *);
410 PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat,PetscInt,PetscInt);
411 PETSC_EXTERN PetscErrorCode MatSetNThreads(Mat,PetscInt);
412 PETSC_EXTERN PetscErrorCode MatGetNThreads(Mat,PetscInt*);
413 
414 PETSC_EXTERN PetscErrorCode MatMult(Mat,Vec,Vec);
415 PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec);
416 PETSC_EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec);
417 PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec);
418 PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec);
419 PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *);
420 PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *);
421 PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec);
422 PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
423 PETSC_EXTERN PetscErrorCode MatMultConstrained(Mat,Vec,Vec);
424 PETSC_EXTERN PetscErrorCode MatMultTransposeConstrained(Mat,Vec,Vec);
425 PETSC_EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat);
426 
427 /*E
428     MatDuplicateOption - Indicates if a duplicated sparse matrix should have
429   its numerical values copied over or just its nonzero structure.
430 
431     Level: beginner
432 
433    Any additions/changes here MUST also be made in include/finclude/petscmat.h
434 
435 $   MAT_SHARE_NONZERO_PATTERN - the i and j arrays in the new matrix will be shared with the original matrix
436 $                               this also triggers the MAT_DO_NOT_COPY_VALUES option. This is used when you
437 $                               have several matrices with the same nonzero pattern.
438 
439 .seealso: MatDuplicate()
440 E*/
441 typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;
442 
443 PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*);
444 PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*);
445 
446 
447 PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure);
448 PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer);
449 PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *);
450 PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *);
451 PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *);
452 PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *);
453 PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *);
454 PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool  *,PetscInt *);
455 PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer);
456 
457 PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
458 PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);
459 PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
460 PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);
461 
462 /*S
463      MatInfo - Context of matrix information, used with MatGetInfo()
464 
465    In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
466 
467    Level: intermediate
468 
469   Concepts: matrix^nonzero information
470 
471 .seealso:  MatGetInfo(), MatInfoType
472 S*/
473 typedef struct {
474   PetscLogDouble block_size;                         /* block size */
475   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
476   PetscLogDouble memory;                             /* memory allocated */
477   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
478   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
479   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
480   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
481 } MatInfo;
482 
483 /*E
484     MatInfoType - Indicates if you want information about the local part of the matrix,
485      the entire parallel matrix or the maximum over all the local parts.
486 
487     Level: beginner
488 
489    Any additions/changes here MUST also be made in include/finclude/petscmat.h
490 
491 .seealso: MatGetInfo(), MatInfo
492 E*/
493 typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
494 PETSC_EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*);
495 PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec);
496 PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]);
497 PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]);
498 PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
499 PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]);
500 PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat,Vec);
501 PETSC_EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*);
502 PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*);
503 PETSC_EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat *);
504 PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec);
505 PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode);
506 PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool *);
507 PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool *);
508 PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool *);
509 PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool *);
510 PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool *);
511 
512 PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal *);
513 PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal *);
514 PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat);
515 PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
516 PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec);
517 PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec);
518 PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec);
519 PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
520 PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec);
521 
522 PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*);
523 PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*);
524 PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
525 PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**);
526 PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
527 PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**);
528 PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*);
529 
530 PETSC_EXTERN PetscErrorCode MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
531 PETSC_EXTERN PetscErrorCode MatGetSubMatricesParallel(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
532 PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]);
533 PETSC_EXTERN PetscErrorCode MatGetSubMatrix(Mat,IS,IS,MatReuse,Mat *);
534 PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*);
535 PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*);
536 PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*);
537 PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*);
538 
539 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJConcatenateSeqAIJ(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
540 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJConcatenateSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,Mat*);
541 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJConcatenateSeqAIJNumeric(MPI_Comm,Mat,PetscInt,Mat);
542 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
543 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
544 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat);
545 PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*);
546 PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
547 PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*);
548 #if defined (PETSC_USE_CTABLE)
549 PETSC_EXTERN PetscErrorCode MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *);
550 #else
551 PETSC_EXTERN PetscErrorCode MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *);
552 #endif
553 PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);
554 
555 PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
556 
557 PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
558 PETSC_EXTERN PetscErrorCode MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
559 PETSC_EXTERN PetscErrorCode MatMatMultNumeric(Mat,Mat,Mat);
560 
561 PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
562 PETSC_EXTERN PetscErrorCode MatMatMatMultSymbolic(Mat,Mat,Mat,PetscReal,Mat*);
563 PETSC_EXTERN PetscErrorCode MatMatMatMultNumeric(Mat,Mat,Mat,Mat);
564 
565 PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
566 PETSC_EXTERN PetscErrorCode MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
567 PETSC_EXTERN PetscErrorCode MatPtAPNumeric(Mat,Mat,Mat);
568 PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*);
569 PETSC_EXTERN PetscErrorCode MatRARtSymbolic(Mat,Mat,PetscReal,Mat*);
570 PETSC_EXTERN PetscErrorCode MatRARtNumeric(Mat,Mat,Mat);
571 
572 PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
573 PETSC_EXTERN PetscErrorCode MatTransposetMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
574 PETSC_EXTERN PetscErrorCode MatTransposetMatMultNumeric(Mat,Mat,Mat);
575 PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*);
576 PETSC_EXTERN PetscErrorCode MatMatTransposeMultSymbolic(Mat,Mat,PetscReal,Mat*);
577 PETSC_EXTERN PetscErrorCode MatMatTransposeMultNumeric(Mat,Mat,Mat);
578 
579 PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure);
580 PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure);
581 
582 PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar);
583 PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar);
584 
585 PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
586 PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
587 PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*);
588 PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*);
589 PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
590 PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
591 PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
592 PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
593 PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
594 PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
595 
596 PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt);
597 PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
598 
599 PETSC_EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec);
600 PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec);
601 PETSC_EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec);
602 PETSC_EXTERN PetscErrorCode MatGetVecs(Mat,Vec*,Vec*);
603 PETSC_EXTERN PetscErrorCode MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*);
604 PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*);
605 PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*);
606 
607 /*MC
608    MatSetValue - Set a single entry into a matrix.
609 
610    Not collective
611 
612    Input Parameters:
613 +  m - the matrix
614 .  row - the row location of the entry
615 .  col - the column location of the entry
616 .  value - the value to insert
617 -  mode - either INSERT_VALUES or ADD_VALUES
618 
619    Notes:
620    For efficiency one should use MatSetValues() and set several or many
621    values simultaneously if possible.
622 
623    Level: beginner
624 
625 .seealso: MatSetValues(), MatSetValueLocal()
626 M*/
627 PETSC_STATIC_INLINE PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);}
628 
629 PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);}
630 
631 PETSC_STATIC_INLINE PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);}
632 
633 /*MC
634    MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
635        row in a matrix providing the data that one can use to correctly preallocate the matrix.
636 
637    Synopsis:
638    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
639 
640    Collective on MPI_Comm
641 
642    Input Parameters:
643 +  comm - the communicator that will share the eventually allocated matrix
644 .  nrows - the number of LOCAL rows in the matrix
645 -  ncols - the number of LOCAL columns in the matrix
646 
647    Output Parameters:
648 +  dnz - the array that will be passed to the matrix preallocation routines
649 -  ozn - the other array passed to the matrix preallocation routines
650 
651 
652    Level: intermediate
653 
654    Notes:
655     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
656 
657    Do not malloc or free dnz and onz, that is handled internally by these routines
658 
659    Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
660 
661    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
662 
663   Concepts: preallocation^Matrix
664 
665 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
666           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
667 M*/
668 #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
669 { \
670   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
671   _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
672   _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
673   _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr); __start = 0; __end = __start; \
674   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
675   _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
676 
677 /*MC
678    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
679        inserted using a local number of the rows and columns
680 
681    Synopsis:
682    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
683 
684    Not Collective
685 
686    Input Parameters:
687 +  map - the row mapping from local numbering to global numbering
688 .  nrows - the number of rows indicated
689 .  rows - the indices of the rows
690 .  cmap - the column mapping from local to global numbering
691 .  ncols - the number of columns in the matrix
692 .  cols - the columns indicated
693 .  dnz - the array that will be passed to the matrix preallocation routines
694 -  ozn - the other array passed to the matrix preallocation routines
695 
696 
697    Level: intermediate
698 
699    Notes:
700     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
701 
702    Do not malloc or free dnz and onz, that is handled internally by these routines
703 
704   Concepts: preallocation^Matrix
705 
706 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
707           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
708 M*/
709 #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
710 {\
711   PetscInt __l;\
712   _4_ierr = ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
713   _4_ierr = ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
714   for (__l=0;__l<nrows;__l++) {\
715     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
716   }\
717 }
718 
719 /*MC
720    MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
721        inserted using a local number of the rows and columns
722 
723    Synopsis:
724    PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
725 
726    Not Collective
727 
728    Input Parameters:
729 +  map - the mapping between local numbering and global numbering
730 .  nrows - the number of rows indicated
731 .  rows - the indices of the rows
732 .  ncols - the number of columns in the matrix
733 .  cols - the columns indicated
734 .  dnz - the array that will be passed to the matrix preallocation routines
735 -  ozn - the other array passed to the matrix preallocation routines
736 
737 
738    Level: intermediate
739 
740    Notes:
741     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
742 
743    Do not malloc or free dnz and onz that is handled internally by these routines
744 
745   Concepts: preallocation^Matrix
746 
747 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
748           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
749 M*/
750 #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
751 {\
752   PetscInt __l;\
753   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
754   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
755   for (__l=0;__l<nrows;__l++) {\
756     _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
757   }\
758 }
759 
760 /*MC
761    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
762        inserted using a local number of the rows and columns
763 
764    Synopsis:
765    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
766 
767    Not Collective
768 
769    Input Parameters:
770 +  row - the row
771 .  ncols - the number of columns in the matrix
772 -  cols - the columns indicated
773 
774    Output Parameters:
775 +  dnz - the array that will be passed to the matrix preallocation routines
776 -  ozn - the other array passed to the matrix preallocation routines
777 
778 
779    Level: intermediate
780 
781    Notes:
782     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
783 
784    Do not malloc or free dnz and onz that is handled internally by these routines
785 
786    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
787 
788   Concepts: preallocation^Matrix
789 
790 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
791           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
792 M*/
793 #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
794 { PetscInt __i; \
795   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);\
796   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);\
797   for (__i=0; __i<nc; __i++) {\
798     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
799     else dnz[row - __rstart]++;\
800   }\
801 }
802 
803 /*MC
804    MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
805        inserted using a local number of the rows and columns
806 
807    Synopsis:
808    PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
809 
810    Not Collective
811 
812    Input Parameters:
813 +  nrows - the number of rows indicated
814 .  rows - the indices of the rows
815 .  ncols - the number of columns in the matrix
816 .  cols - the columns indicated
817 .  dnz - the array that will be passed to the matrix preallocation routines
818 -  ozn - the other array passed to the matrix preallocation routines
819 
820 
821    Level: intermediate
822 
823    Notes:
824     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
825 
826    Do not malloc or free dnz and onz that is handled internally by these routines
827 
828    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
829 
830   Concepts: preallocation^Matrix
831 
832 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
833           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
834 M*/
835 #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
836 { PetscInt __i; \
837   for (__i=0; __i<nc; __i++) {\
838     if (cols[__i] >= __end) onz[row - __rstart]++; \
839     else if (cols[__i] >= row) dnz[row - __rstart]++;\
840   }\
841 }
842 
843 /*MC
844    MatPreallocateLocation -  An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists
845 
846    Synopsis:
847    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)
848 
849    Not Collective
850 
851    Input Parameters:
852 .  A - matrix
853 .  row - row where values exist (must be local to this process)
854 .  ncols - number of columns
855 .  cols - columns with nonzeros
856 .  dnz - the array that will be passed to the matrix preallocation routines
857 -  ozn - the other array passed to the matrix preallocation routines
858 
859 
860    Level: intermediate
861 
862    Notes:
863     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
864 
865    Do not malloc or free dnz and onz that is handled internally by these routines
866 
867    This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.
868 
869   Concepts: preallocation^Matrix
870 
871 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
872           MatPreallocateSymmetricSetLocal()
873 M*/
874 #define MatPreallocateLocation(A,row,ncols,cols,dnz,onz) 0;if (A) {ierr = MatSetValues(A,1,&row,ncols,cols,PETSC_NULL,INSERT_VALUES);CHKERRQ(ierr);} else {ierr =  MatPreallocateSet(row,ncols,cols,dnz,onz);CHKERRQ(ierr);}
875 
876 
877 /*MC
878    MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
879        row in a matrix providing the data that one can use to correctly preallocate the matrix.
880 
881    Synopsis:
882    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
883 
884    Collective on MPI_Comm
885 
886    Input Parameters:
887 +  dnz - the array that was be passed to the matrix preallocation routines
888 -  ozn - the other array passed to the matrix preallocation routines
889 
890 
891    Level: intermediate
892 
893    Notes:
894     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
895 
896    Do not malloc or free dnz and onz that is handled internally by these routines
897 
898    This is a MACRO not a function because it closes the { started in MatPreallocateInitialize().
899 
900   Concepts: preallocation^Matrix
901 
902 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
903           MatPreallocateSymmetricSetLocal()
904 M*/
905 #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}
906 
907 
908 
909 /* Routines unique to particular data structures */
910 PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat,void *);
911 
912 PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*);
913 PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
914 
915 PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
916 PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
917 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
918 PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
919 PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
920 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool);
921 
922 #define MAT_SKIP_ALLOCATION -4
923 
924 PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
925 PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
926 PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
927 
928 PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
929 PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
930 PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
931 PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
932 PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
933 PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
934 PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
935 PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
936 PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
937 PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
938 PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
939 PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
940 PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*);
941 
942 PETSC_EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt);
943 PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*);
944 
945 PETSC_EXTERN PetscErrorCode MatStoreValues(Mat);
946 PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat);
947 
948 PETSC_EXTERN PetscErrorCode MatDAADSetCtx(Mat,void*);
949 
950 PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*);
951 /*
952   These routines are not usually accessed directly, rather solving is
953   done through the KSP and PC interfaces.
954 */
955 
956 /*J
957     MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
958        with an optional dynamic library name, for example
959        http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
960 
961    Level: beginner
962 
963    Cannot use const because the PC objects manipulate the string
964 
965 .seealso: MatGetOrdering()
966 J*/
967 typedef const char* MatOrderingType;
968 #define MATORDERINGNATURAL     "natural"
969 #define MATORDERINGND          "nd"
970 #define MATORDERING1WD         "1wd"
971 #define MATORDERINGRCM         "rcm"
972 #define MATORDERINGQMD         "qmd"
973 #define MATORDERINGROWLENGTH   "rowlength"
974 #define MATORDERINGAMD         "amd"            /* only works if UMFPACK is installed with PETSc */
975 
976 PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*);
977 PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFList *list);
978 PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*));
979 
980 /*MC
981    MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the matrix package.
982 
983    Synopsis:
984    PetscErrorCode MatOrderingRegisterDynamic(const char *name_ordering,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
985 
986    Not Collective
987 
988    Input Parameters:
989 +  sname - name of ordering (for example MATORDERINGND)
990 .  path - location of library where creation routine is
991 .  name - name of function that creates the ordering type,a string
992 -  function - function pointer that creates the ordering
993 
994    Level: developer
995 
996    If dynamic libraries are used, then the fourth input argument (function)
997    is ignored.
998 
999    Sample usage:
1000 .vb
1001    MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
1002                "MyOrder",MyOrder);
1003 .ve
1004 
1005    Then, your partitioner can be chosen with the procedural interface via
1006 $     MatOrderingSetType(part,"my_order)
1007    or at runtime via the option
1008 $     -pc_factor_mat_ordering_type my_order
1009 
1010    ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
1011 
1012 .keywords: matrix, ordering, register
1013 
1014 .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
1015 M*/
1016 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1017 #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
1018 #else
1019 #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
1020 #endif
1021 
1022 PETSC_EXTERN PetscErrorCode MatOrderingRegisterDestroy(void);
1023 PETSC_EXTERN PetscErrorCode MatOrderingRegisterAll(const char[]);
1024 PETSC_EXTERN PetscBool MatOrderingRegisterAllCalled;
1025 PETSC_EXTERN PetscFList MatOrderingList;
1026 
1027 PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1028 
1029 /*S
1030     MatFactorShiftType - Numeric Shift.
1031 
1032    Level: beginner
1033 
1034 S*/
1035 typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
1036 PETSC_EXTERN const char *const MatFactorShiftTypes[];
1037 
1038 /*S
1039    MatFactorInfo - Data passed into the matrix factorization routines
1040 
1041    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
1042 $     MatFactorInfo  info(MAT_FACTORINFO_SIZE)
1043 
1044    Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
1045 
1046       You can use MatFactorInfoInitialize() to set default values.
1047 
1048    Level: developer
1049 
1050 .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1051           MatFactorInfoInitialize()
1052 
1053 S*/
1054 typedef struct {
1055   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
1056   PetscReal     usedt;
1057   PetscReal     dt;             /* drop tolerance */
1058   PetscReal     dtcol;          /* tolerance for pivoting */
1059   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
1060   PetscReal     fill;           /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1061   PetscReal     levels;         /* ICC/ILU(levels) */
1062   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1063                                    factorization may be faster if do not pivot */
1064   PetscReal     zeropivot;      /* pivot is called zero if less than this */
1065   PetscReal     shifttype;      /* type of shift added to matrix factor to prevent zero pivots */
1066   PetscReal     shiftamount;     /* how large the shift is */
1067 } MatFactorInfo;
1068 
1069 PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*);
1070 PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
1071 PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1072 PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
1073 PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
1074 PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
1075 PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1076 PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1077 PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1078 PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*);
1079 PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1080 PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1081 PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec);
1082 PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec);
1083 PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec);
1084 PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec);
1085 PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec);
1086 PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1087 PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs);
1088 
1089 PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat);
1090 
1091 /*E
1092     MatSORType - What type of (S)SOR to perform
1093 
1094     Level: beginner
1095 
1096    May be bitwise ORd together
1097 
1098    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1099 
1100    MatSORType may be bitwise ORd together, so do not change the numbers
1101 
1102 .seealso: MatSOR()
1103 E*/
1104 typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1105               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1106               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
1107               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1108 PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1109 
1110 /*
1111     These routines are for efficiently computing Jacobians via finite differences.
1112 */
1113 
1114 /*J
1115     MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1116        with an optional dynamic library name, for example
1117        http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1118 
1119    Level: beginner
1120 
1121 .seealso: MatGetColoring()
1122 J*/
1123 typedef const char* MatColoringType;
1124 #define MATCOLORINGNATURAL "natural"
1125 #define MATCOLORINGSL      "sl"
1126 #define MATCOLORINGLF      "lf"
1127 #define MATCOLORINGID      "id"
1128 
1129 PETSC_EXTERN PetscErrorCode MatGetColoring(Mat,MatColoringType,ISColoring*);
1130 PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *));
1131 
1132 /*MC
1133    MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
1134                                matrix package.
1135 
1136    Synopsis:
1137    PetscErrorCode MatColoringRegisterDynamic(const char *name_coloring,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatColoring))
1138 
1139    Not Collective
1140 
1141    Input Parameters:
1142 +  sname - name of Coloring (for example MATCOLORINGSL)
1143 .  path - location of library where creation routine is
1144 .  name - name of function that creates the Coloring type, a string
1145 -  function - function pointer that creates the coloring
1146 
1147    Level: developer
1148 
1149    If dynamic libraries are used, then the fourth input argument (function)
1150    is ignored.
1151 
1152    Sample usage:
1153 .vb
1154    MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
1155                "MyColor",MyColor);
1156 .ve
1157 
1158    Then, your partitioner can be chosen with the procedural interface via
1159 $     MatColoringSetType(part,"my_color")
1160    or at runtime via the option
1161 $     -mat_coloring_type my_color
1162 
1163    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
1164 
1165 .keywords: matrix, Coloring, register
1166 
1167 .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
1168 M*/
1169 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1170 #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1171 #else
1172 #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1173 #endif
1174 
1175 PETSC_EXTERN PetscBool MatColoringRegisterAllCalled;
1176 
1177 PETSC_EXTERN PetscErrorCode MatColoringRegisterAll(const char[]);
1178 PETSC_EXTERN PetscErrorCode MatColoringRegisterDestroy(void);
1179 PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1180 
1181 /*S
1182      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1183         and coloring
1184 
1185    Level: beginner
1186 
1187   Concepts: coloring, sparse Jacobian, finite differences
1188 
1189 .seealso:  MatFDColoringCreate()
1190 S*/
1191 typedef struct _p_MatFDColoring* MatFDColoring;
1192 
1193 PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1194 PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*);
1195 PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer);
1196 PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1197 PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1198 PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1199 PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
1200 PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1201 PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec);
1202 PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1203 
1204 /*S
1205      MatTransposeColoring - Object for computing a sparse matrix product C=A*B^T via coloring
1206 
1207    Level: beginner
1208 
1209   Concepts: coloring, sparse matrix product
1210 
1211 .seealso:  MatTransposeColoringCreate()
1212 S*/
1213 typedef struct _p_MatTransposeColoring* MatTransposeColoring;
1214 
1215 PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *);
1216 PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat);
1217 PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat);
1218 PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*);
1219 
1220 /*
1221     These routines are for partitioning matrices: currently used only
1222   for adjacency matrix, MatCreateMPIAdj().
1223 */
1224 
1225 /*S
1226      MatPartitioning - Object for managing the partitioning of a matrix or graph
1227 
1228    Level: beginner
1229 
1230   Concepts: partitioning
1231 
1232 .seealso:  MatPartitioningCreate(), MatPartitioningType
1233 S*/
1234 typedef struct _p_MatPartitioning* MatPartitioning;
1235 
1236 /*J
1237     MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1238        with an optional dynamic library name, for example
1239        http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1240 
1241    Level: beginner
1242 dm
1243 .seealso: MatPartitioningCreate(), MatPartitioning
1244 J*/
1245 typedef const char* MatPartitioningType;
1246 #define MATPARTITIONINGCURRENT  "current"
1247 #define MATPARTITIONINGSQUARE   "square"
1248 #define MATPARTITIONINGPARMETIS "parmetis"
1249 #define MATPARTITIONINGCHACO    "chaco"
1250 #define MATPARTITIONINGPARTY    "party"
1251 #define MATPARTITIONINGPTSCOTCH "ptscotch"
1252 
1253 
1254 PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1255 PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType);
1256 PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt);
1257 PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat);
1258 PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1259 PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1260 PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*);
1261 PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*);
1262 
1263 PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
1264 
1265 /*MC
1266    MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
1267    matrix package.
1268 
1269    Synopsis:
1270    PetscErrorCode MatPartitioningRegisterDynamic(const char *name_partitioning,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
1271 
1272    Not Collective
1273 
1274    Input Parameters:
1275 +  sname - name of partitioning (for example MATPARTITIONINGCURRENT) or parmetis
1276 .  path - location of library where creation routine is
1277 .  name - name of function that creates the partitioning type, a string
1278 -  function - function pointer that creates the partitioning type
1279 
1280    Level: developer
1281 
1282    If dynamic libraries are used, then the fourth input argument (function)
1283    is ignored.
1284 
1285    Sample usage:
1286 .vb
1287    MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
1288                "MyPartCreate",MyPartCreate);
1289 .ve
1290 
1291    Then, your partitioner can be chosen with the procedural interface via
1292 $     MatPartitioningSetType(part,"my_part")
1293    or at runtime via the option
1294 $     -mat_partitioning_type my_part
1295 
1296    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
1297 
1298 .keywords: matrix, partitioning, register
1299 
1300 .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
1301 M*/
1302 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1303 #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
1304 #else
1305 #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
1306 #endif
1307 
1308 PETSC_EXTERN PetscBool MatPartitioningRegisterAllCalled;
1309 
1310 PETSC_EXTERN PetscErrorCode MatPartitioningRegisterAll(const char[]);
1311 PETSC_EXTERN PetscErrorCode MatPartitioningRegisterDestroy(void);
1312 
1313 PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer);
1314 PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
1315 PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*);
1316 
1317 PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1318 PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);
1319 
1320 typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType;
1321 PETSC_EXTERN const char *const MPChacoGlobalTypes[];
1322 typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType;
1323 PETSC_EXTERN const char *const MPChacoLocalTypes[];
1324 typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType;
1325 PETSC_EXTERN const char *const MPChacoEigenTypes[];
1326 
1327 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType);
1328 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*);
1329 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType);
1330 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*);
1331 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
1332 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1333 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*);
1334 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal);
1335 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*);
1336 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt);
1337 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*);
1338 
1339 #define MP_PARTY_OPT "opt"
1340 #define MP_PARTY_LIN "lin"
1341 #define MP_PARTY_SCA "sca"
1342 #define MP_PARTY_RAN "ran"
1343 #define MP_PARTY_GBF "gbf"
1344 #define MP_PARTY_GCF "gcf"
1345 #define MP_PARTY_BUB "bub"
1346 #define MP_PARTY_DEF "def"
1347 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*);
1348 #define MP_PARTY_HELPFUL_SETS "hs"
1349 #define MP_PARTY_KERNIGHAN_LIN "kl"
1350 #define MP_PARTY_NONE "no"
1351 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*);
1352 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1353 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool);
1354 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool);
1355 
1356 typedef enum { MP_PTSCOTCH_QUALITY,MP_PTSCOTCH_SPEED,MP_PTSCOTCH_BALANCE,MP_PTSCOTCH_SAFETY,MP_PTSCOTCH_SCALABILITY } MPPTScotchStrategyType;
1357 PETSC_EXTERN const char *const MPPTScotchStrategyTypes[];
1358 
1359 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal);
1360 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*);
1361 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType);
1362 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*);
1363 
1364 /*
1365     These routines are for coarsening matrices:
1366 */
1367 
1368 /*S
1369      MatCoarsen - Object for managing the coarsening of a graph (symmetric matrix)
1370 
1371    Level: beginner
1372 
1373   Concepts: coarsen
1374 
1375 .seealso:  MatCoarsenCreate), MatCoarsenType
1376 S*/
1377 typedef struct _p_MatCoarsen* MatCoarsen;
1378 
1379 /*J
1380     MatCoarsenType - String with the name of a PETSc matrix coarsen or the creation function
1381        with an optional dynamic library name, for example
1382        http://www.mcs.anl.gov/petsc/lib.a:coarsencreate()
1383 
1384    Level: beginner
1385 dm
1386 .seealso: MatCoarsenCreate(), MatCoarsen
1387 J*/
1388 typedef const char* MatCoarsenType;
1389 #define MATCOARSENMIS  "mis"
1390 #define MATCOARSENHEM  "hem"
1391 
1392 /* linked list for aggregates */
1393 typedef struct _PetscCDIntNd{
1394   struct _PetscCDIntNd *next;
1395   PetscInt   gid;
1396 }PetscCDIntNd;
1397 
1398 /* only used by node pool */
1399 typedef struct _PetscCDArrNd{
1400   struct _PetscCDArrNd *next;
1401   struct _PetscCDIntNd *array;
1402 }PetscCDArrNd;
1403 
1404 typedef struct _PetscCoarsenData{
1405   /* node pool */
1406   PetscCDArrNd  pool_list;
1407   PetscCDIntNd *new_node;
1408   PetscInt   new_left;
1409   PetscInt   chk_sz;
1410   PetscCDIntNd *extra_nodes;
1411   /* Array of lists */
1412   PetscCDIntNd **array;
1413   PetscInt size;
1414   /* cache a Mat for communication data */
1415   Mat mat;
1416   /* cache IS of removed equations */
1417   /* IS removedIS; */
1418 }PetscCoarsenData;
1419 
1420 PETSC_EXTERN PetscErrorCode MatCoarsenCreate(MPI_Comm,MatCoarsen*);
1421 PETSC_EXTERN PetscErrorCode MatCoarsenSetType(MatCoarsen,MatCoarsenType);
1422 PETSC_EXTERN PetscErrorCode MatCoarsenSetAdjacency(MatCoarsen,Mat);
1423 PETSC_EXTERN PetscErrorCode MatCoarsenSetGreedyOrdering(MatCoarsen,const IS);
1424 PETSC_EXTERN PetscErrorCode MatCoarsenSetStrictAggs(MatCoarsen,PetscBool);
1425 PETSC_EXTERN PetscErrorCode MatCoarsenSetVerbose(MatCoarsen,PetscInt);
1426 PETSC_EXTERN PetscErrorCode MatCoarsenGetData( MatCoarsen, PetscCoarsenData ** );
1427 PETSC_EXTERN PetscErrorCode MatCoarsenApply(MatCoarsen);
1428 PETSC_EXTERN PetscErrorCode MatCoarsenDestroy(MatCoarsen*);
1429 
1430 PETSC_EXTERN PetscErrorCode MatCoarsenRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatCoarsen));
1431 
1432 /*MC
1433    MatCoarsenRegisterDynamic - Adds a new sparse matrix coarsen to the
1434    matrix package.
1435 
1436    Synopsis:
1437    PetscErrorCode MatCoarsenRegisterDynamic(const char *name_coarsen,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatCoarsen))
1438 
1439    Not Collective
1440 
1441    Input Parameters:
1442 +  sname - name of coarsen (for example MATCOARSENMIS)
1443 .  path - location of library where creation routine is
1444 .  name - name of function that creates the coarsen type, a string
1445 -  function - function pointer that creates the coarsen type
1446 
1447    Level: developer
1448 
1449    If dynamic libraries are used, then the fourth input argument (function)
1450    is ignored.
1451 
1452    Sample usage:
1453 .vb
1454    MatCoarsenRegisterDynamic("my_agg",/home/username/my_lib/lib/libO/solaris/mylib.a,
1455                "MyAggCreate",MyAggCreate);
1456 .ve
1457 
1458    Then, your aggregator can be chosen with the procedural interface via
1459 $     MatCoarsenSetType(agg,"my_agg")
1460    or at runtime via the option
1461 $     -mat_coarsen_type my_agg
1462 
1463    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
1464 
1465 .keywords: matrix, coarsen, register
1466 
1467 .seealso: MatCoarsenRegisterDestroy(), MatCoarsenRegisterAll()
1468 M*/
1469 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1470 #define MatCoarsenRegisterDynamic(a,b,c,d) MatCoarsenRegister(a,b,c,0)
1471 #else
1472 #define MatCoarsenRegisterDynamic(a,b,c,d) MatCoarsenRegister(a,b,c,d)
1473 #endif
1474 
1475 PETSC_EXTERN PetscBool MatCoarsenRegisterAllCalled;
1476 
1477 PETSC_EXTERN PetscErrorCode MatCoarsenRegisterAll(const char[]);
1478 PETSC_EXTERN PetscErrorCode MatCoarsenRegisterDestroy(void);
1479 
1480 PETSC_EXTERN PetscErrorCode MatCoarsenView(MatCoarsen,PetscViewer);
1481 PETSC_EXTERN PetscErrorCode MatCoarsenSetFromOptions(MatCoarsen);
1482 PETSC_EXTERN PetscErrorCode MatCoarsenGetType(MatCoarsen,MatCoarsenType*);
1483 
1484 
1485 PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
1486 PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);
1487 
1488 /*
1489     If you add entries here you must also add them to finclude/petscmat.h
1490 */
1491 typedef enum { MATOP_SET_VALUES=0,
1492                MATOP_GET_ROW=1,
1493                MATOP_RESTORE_ROW=2,
1494                MATOP_MULT=3,
1495                MATOP_MULT_ADD=4,
1496                MATOP_MULT_TRANSPOSE=5,
1497                MATOP_MULT_TRANSPOSE_ADD=6,
1498                MATOP_SOLVE=7,
1499                MATOP_SOLVE_ADD=8,
1500                MATOP_SOLVE_TRANSPOSE=9,
1501                MATOP_SOLVE_TRANSPOSE_ADD=10,
1502                MATOP_LUFACTOR=11,
1503                MATOP_CHOLESKYFACTOR=12,
1504                MATOP_SOR=13,
1505                MATOP_TRANSPOSE=14,
1506                MATOP_GETINFO=15,
1507                MATOP_EQUAL=16,
1508                MATOP_GET_DIAGONAL=17,
1509                MATOP_DIAGONAL_SCALE=18,
1510                MATOP_NORM=19,
1511                MATOP_ASSEMBLY_BEGIN=20,
1512                MATOP_ASSEMBLY_END=21,
1513                MATOP_SET_OPTION=22,
1514                MATOP_ZERO_ENTRIES=23,
1515                MATOP_ZERO_ROWS=24,
1516                MATOP_LUFACTOR_SYMBOLIC=25,
1517                MATOP_LUFACTOR_NUMERIC=26,
1518                MATOP_CHOLESKY_FACTOR_SYMBOLIC=27,
1519                MATOP_CHOLESKY_FACTOR_NUMERIC=28,
1520                MATOP_SETUP_PREALLOCATION=29,
1521                MATOP_ILUFACTOR_SYMBOLIC=30,
1522                MATOP_ICCFACTOR_SYMBOLIC=31,
1523                MATOP_GET_ARRAY=32,
1524                MATOP_RESTORE_ARRAY=33,
1525                MATOP_DUPLICATE=34,
1526                MATOP_FORWARD_SOLVE=35,
1527                MATOP_BACKWARD_SOLVE=36,
1528                MATOP_ILUFACTOR=37,
1529                MATOP_ICCFACTOR=38,
1530                MATOP_AXPY=39,
1531                MATOP_GET_SUBMATRICES=40,
1532                MATOP_INCREASE_OVERLAP=41,
1533                MATOP_GET_VALUES=42,
1534                MATOP_COPY=43,
1535                MATOP_GET_ROW_MAX=44,
1536                MATOP_SCALE=45,
1537                MATOP_SHIFT=46,
1538                MATOP_DIAGONAL_SET=47,
1539                MATOP_ILUDT_FACTOR=48,
1540                MATOP_SET_BLOCK_SIZE=49,
1541                MATOP_GET_ROW_IJ=50,
1542                MATOP_RESTORE_ROW_IJ=51,
1543                MATOP_GET_COLUMN_IJ=52,
1544                MATOP_RESTORE_COLUMN_IJ=53,
1545                MATOP_FDCOLORING_CREATE=54,
1546                MATOP_COLORING_PATCH=55,
1547                MATOP_SET_UNFACTORED=56,
1548                MATOP_PERMUTE=57,
1549                MATOP_SET_VALUES_BLOCKED=58,
1550                MATOP_GET_SUBMATRIX=59,
1551                MATOP_DESTROY=60,
1552                MATOP_VIEW=61,
1553                MATOP_CONVERT_FROM=62,
1554                MATOP_MATMAT_MULT=63,
1555                MATOP_MATMAT_MULT_SYMBOLIC=64,
1556                MATOP_MATMAT_MULT_NUMERIC=65,
1557                MATOP_SET_LOCAL_TO_GLOBAL_MAP=66,
1558                MATOP_SET_VALUES_LOCAL=67,
1559                MATOP_ZERO_ROWS_LOCAL=68,
1560                MATOP_GET_ROW_MAX_ABS=69,
1561                MATOP_GET_ROW_MIN_ABS=70,
1562                MATOP_CONVERT=71,
1563                MATOP_SET_COLORING=72,
1564                MATOP_SET_VALUES_ADIC=73,
1565                MATOP_SET_VALUES_ADIFOR=74,
1566                MATOP_FD_COLORING_APPLY=75,
1567                MATOP_SET_FROM_OPTIONS=76,
1568                MATOP_MULT_CONSTRAINED=77,
1569                MATOP_MULT_TRANSPOSE_CONSTRAIN=78,
1570                MATOP_PERMUTE_SPARSIFY=79,
1571                MATOP_MULT_MULTIPLE=80,
1572                MATOP_SOLVE_MULTIPLE=81,
1573                MATOP_GET_INERTIA=82,
1574                MATOP_LOAD=83,
1575                MATOP_IS_SYMMETRIC=84,
1576                MATOP_IS_HERMITIAN=85,
1577                MATOP_IS_STRUCTURALLY_SYMMETRIC=86,
1578                MATOP_SET_VALUES_BLOCKEDLOCAL=87,
1579                MATOP_GET_VECS=88,
1580                MATOP_MAT_MULT=89,
1581                MATOP_MAT_MULT_SYMBOLIC=90,
1582                MATOP_MAT_MULT_NUMERIC=91,
1583                MATOP_PTAP=92,
1584                MATOP_PTAP_SYMBOLIC=93,
1585                MATOP_PTAP_NUMERIC=94,
1586                MATOP_MAT_TRANSPOSE_MULT=95,
1587                MATOP_MAT_TRANSPOSE_MULT_SYMBO=96,
1588                MATOP_MAT_TRANSPOSE_MULT_NUMER=97,
1589                MATOP_DUMMY98=98,
1590                MATOP_DUMMY99=99,
1591                MATOP_DUMMY100=100,
1592                MATOP_DUMMY101=101,
1593                MATOP_CONJUGATE=102,
1594                MATOP_SET_SIZES=103,
1595                MATOP_SET_VALUES_ROW=104,
1596                MATOP_REAL_PART=105,
1597                MATOP_IMAGINARY_PART=106,
1598                MATOP_GET_ROW_UPPER_TRIANGULAR=107,
1599                MATOP_RESTORE_ROW_UPPER_TRIANG=108,
1600                MATOP_MAT_SOLVE=109,
1601                MATOP_GET_REDUNDANT_MATRIX=110,
1602                MATOP_GET_ROW_MIN=111,
1603                MATOP_GET_COLUMN_VECTOR=112,
1604                MATOP_MISSING_DIAGONAL=113,
1605                MATOP_GET_SEQ_NONZERO_STRUCTUR=114,
1606                MATOP_CREATE=115,
1607                MATOP_GET_GHOSTS=116,
1608                MATOP_GET_LOCAL_SUB_MATRIX=117,
1609                MATOP_RESTORE_LOCALSUB_MATRIX=118,
1610                MATOP_MULT_DIAGONAL_BLOCK=119,
1611                MATOP_HERMITIAN_TRANSPOSE=120,
1612                MATOP_MULT_HERMITIAN_TRANSPOSE=121,
1613                MATOP_MULT_HERMITIAN_TRANS_ADD=122,
1614                MATOP_GET_MULTI_PROC_BLOCK=123,
1615                MATOP_GET_COLUMN_NORMS=125,
1616 	       MATOP_GET_SUB_MATRICES_PARALLE=128,
1617                MATOP_SET_VALUES_BATCH=129,
1618                MATOP_TRANSPOSE_MAT_MULT=130,
1619                MATOP_TRANSPOSE_MAT_MULT_SYMBO=131,
1620                MATOP_TRANSPOSE_MAT_MULT_NUMER=132,
1621                MATOP_TRANSPOSE_COLORING_CREAT=133,
1622                MATOP_TRANS_COLORING_APPLY_SPT=134,
1623                MATOP_TRANS_COLORING_APPLY_DEN=135,
1624                MATOP_RART=136,
1625                MATOP_RART_SYMBOLIC=137,
1626                MATOP_RART_NUMERIC=138,
1627                MATOP_SET_BLOCK_SIZES=139,
1628                MATOP_AYPX=140
1629              } MatOperation;
1630 PETSC_EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool *);
1631 PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void));
1632 PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void));
1633 PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*);
1634 
1635 /*
1636    Codes for matrices stored on disk. By default they are
1637    stored in a universal format. By changing the format with
1638    PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
1639    be stored in a way natural for the matrix, for example dense matrices
1640    would be stored as dense. Matrices stored this way may only be
1641    read into matrices of the same type.
1642 */
1643 #define MATRIX_BINARY_FORMAT_DENSE -1
1644 
1645 PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1646 PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*);
1647 PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat);
1648 
1649 /*S
1650      MatNullSpace - Object that removes a null space from a vector, i.e.
1651          orthogonalizes the vector to a subsapce
1652 
1653    Level: advanced
1654 
1655   Concepts: matrix; linear operator, null space
1656 
1657   Users manual sections:
1658 .   sec_singular
1659 
1660 .seealso:  MatNullSpaceCreate()
1661 S*/
1662 typedef struct _p_MatNullSpace* MatNullSpace;
1663 
1664 PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*);
1665 PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1666 PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*);
1667 PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1668 PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *);
1669 PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace);
1670 PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace);
1671 PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*);
1672 PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool  *);
1673 PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer);
1674 PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**);
1675 PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*);
1676 
1677 PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS);
1678 PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1679 PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
1680 PETSC_EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat);
1681 
1682 PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*);
1683 PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*);
1684 PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*);
1685 
1686 PETSC_EXTERN PetscErrorCode MatComputeExplicitOperator(Mat,Mat*);
1687 
1688 PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec);
1689 
1690 PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
1691 PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec);
1692 PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1693 PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1694 PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1695 PETSC_EXTERN PetscErrorCode MatMFFDAddNullSpace(Mat,MatNullSpace);
1696 PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1697 PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
1698 PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal);
1699 PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt);
1700 PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *);
1701 PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]);
1702 PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1703 PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);
1704 
1705 /*S
1706     MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free
1707               Jacobian vector products
1708 
1709     Notes: MATMFFD is a specific MatType which uses the MatMFFD data structure
1710 
1711            MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure
1712 
1713     Level: developer
1714 
1715 .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
1716 S*/
1717 typedef struct _p_MatMFFD* MatMFFD;
1718 
1719 /*J
1720     MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function
1721 
1722    Level: beginner
1723 
1724 .seealso: MatMFFDSetType(), MatMFFDRegister()
1725 J*/
1726 typedef const char* MatMFFDType;
1727 #define MATMFFD_DS  "ds"
1728 #define MATMFFD_WP  "wp"
1729 
1730 PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat,MatMFFDType);
1731 PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatMFFD));
1732 
1733 /*MC
1734    MatMFFDRegisterDynamic - Adds a method to the MatMFFD registry.
1735 
1736    Synopsis:
1737    PetscErrorCode MatMFFDRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatMFFD))
1738 
1739    Not Collective
1740 
1741    Input Parameters:
1742 +  name_solver - name of a new user-defined compute-h module
1743 .  path - path (either absolute or relative) the library containing this solver
1744 .  name_create - name of routine to create method context
1745 -  routine_create - routine to create method context
1746 
1747    Level: developer
1748 
1749    Notes:
1750    MatMFFDRegisterDynamic() may be called multiple times to add several user-defined solvers.
1751 
1752    If dynamic libraries are used, then the fourth input argument (routine_create)
1753    is ignored.
1754 
1755    Sample usage:
1756 .vb
1757    MatMFFDRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a,
1758                "MyHCreate",MyHCreate);
1759 .ve
1760 
1761    Then, your solver can be chosen with the procedural interface via
1762 $     MatMFFDSetType(mfctx,"my_h")
1763    or at runtime via the option
1764 $     -snes_mf_type my_h
1765 
1766 .keywords: MatMFFD, register
1767 
1768 .seealso: MatMFFDRegisterAll(), MatMFFDRegisterDestroy()
1769 M*/
1770 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1771 #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,0)
1772 #else
1773 #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,d)
1774 #endif
1775 
1776 PETSC_EXTERN PetscErrorCode MatMFFDRegisterAll(const char[]);
1777 PETSC_EXTERN PetscErrorCode MatMFFDRegisterDestroy(void);
1778 PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal);
1779 PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool );
1780 
1781 
1782 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1783 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
1784 
1785 /*
1786    PETSc interface to MUMPS
1787 */
1788 #ifdef PETSC_HAVE_MUMPS
1789 PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
1790 #endif
1791 
1792 /*
1793    PETSc interface to SUPERLU
1794 */
1795 #ifdef PETSC_HAVE_SUPERLU
1796 PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal);
1797 #endif
1798 
1799 #if defined PETSC_HAVE_TXPETSCGPU
1800 
1801 /*E
1802     MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU)
1803     matrices.
1804 
1805     Not Collective
1806 
1807 +   MAT_CUSPARSE_CSR : Compressed Sparse Row
1808 .   MAT_CUSPARSE_ELL : Ellpack
1809 -   MAT_CUSPARSE_HYB : Hybrid, a combination of Ellpack and Coordinate format.
1810 
1811     Level: intermediate
1812 
1813    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1814 
1815 .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation
1816 E*/
1817 
1818 typedef enum {MAT_CUSPARSE_CSR, MAT_CUSPARSE_ELL, MAT_CUSPARSE_HYB} MatCUSPARSEStorageFormat;
1819 
1820 /* these will be strings associated with enumerated type defined above */
1821 PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[];
1822 
1823 /*E
1824     MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU)
1825     matrices whose operation should use a particular storage format.
1826 
1827     Not Collective
1828 
1829 +   MAT_CUSPARSE_MULT_DIAG : sets the storage format for the diagonal matrix in the parallel MatMult
1830 .   MAT_CUSPARSE_MULT_OFFDIAG : sets the storage format for the offdiagonal matrix in the parallel MatMult
1831 .   MAT_CUSPARSE_MULT : sets the storage format for the entire matrix in the serial (single GPU) MatMult
1832 .   MAT_CUSPARSE_SOLVE : sets the storage format for the triangular factors in the serial (single GPU) MatSolve
1833 -   MAT_CUSPARSE_ALL : sets the storage format for all CUSPARSE (GPU) matrices
1834 
1835     Level: intermediate
1836 
1837 .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat
1838 E*/
1839 typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_SOLVE, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation;
1840 
1841 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1842 PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1843 PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat);
1844 
1845 #endif
1846 
1847 #if defined(PETSC_HAVE_CUSP)
1848 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1849 PETSC_EXTERN PetscErrorCode MatCreateAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1850 
1851 /*E
1852     MatCUSPStorageFormat - indicates the storage format for CUSP (GPU)
1853     matrices.
1854 
1855     Not Collective
1856 
1857 +   MAT_CUSP_CSR : Compressed Sparse Row
1858 .   MAT_CUSP_DIA : Diagonal
1859 -   MAT_CUSP_ELL : Ellpack
1860 
1861     Level: intermediate
1862 
1863    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1864 
1865 .seealso: MatCUSPSetFormat(), MatCUSPFormatOperation
1866 E*/
1867 typedef enum {MAT_CUSP_CSR, MAT_CUSP_DIA, MAT_CUSP_ELL} MatCUSPStorageFormat;
1868 
1869 /* these will be strings associated with enumerated type defined above */
1870 PETSC_EXTERN const char *const MatCUSPStorageFormats[];
1871 
1872 /*E
1873     MatCUSPFormatOperation - indicates the operation of CUSP (GPU)
1874     matrices whose operation should use a particular storage format.
1875 
1876     Not Collective
1877 
1878 +   MAT_CUSP_MULT_DIAG : sets the storage format for the diagonal matrix in the parallel MatMult
1879 .   MAT_CUSP_MULT_OFFDIAG : sets the storage format for the offdiagonal matrix in the parallel MatMult
1880 .   MAT_CUSP_MULT : sets the storage format for the entire matrix in the serial (single GPU) MatMult
1881 .   MAT_CUSP_SOLVE : sets the storage format for the triangular factors in the serial (single GPU) MatSolve
1882 -   MAT_CUSP_ALL : sets the storage format for all CUSP (GPU) matrices
1883 
1884     Level: intermediate
1885 
1886    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1887 
1888 .seealso: MatCUSPSetFormat(), MatCUSPStorageFormat
1889 E*/
1890 typedef enum {MAT_CUSP_MULT_DIAG, MAT_CUSP_MULT_OFFDIAG, MAT_CUSP_MULT, MAT_CUSP_SOLVE, MAT_CUSP_ALL} MatCUSPFormatOperation;
1891 
1892 PETSC_EXTERN PetscErrorCode MatCUSPSetFormat(Mat,MatCUSPFormatOperation,MatCUSPStorageFormat);
1893 #endif
1894 
1895 /*
1896    PETSc interface to FFTW
1897 */
1898 #if defined(PETSC_HAVE_FFTW)
1899 PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec);
1900 PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec);
1901 PETSC_EXTERN PetscErrorCode MatGetVecsFFTW(Mat,Vec*,Vec*,Vec*);
1902 #endif
1903 
1904 #if defined(PETSC_HAVE_ELEMENTAL)
1905 PETSC_EXTERN PetscErrorCode PetscElementalInitializePackage(const char*);
1906 PETSC_EXTERN PetscErrorCode PetscElementalFinalizePackage(void);
1907 #endif
1908 
1909 PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*);
1910 PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*);
1911 PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]);
1912 PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]);
1913 PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***);
1914 PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*);
1915 PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType);
1916 PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]);
1917 PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat);
1918 
1919 /*
1920  MatIJ:
1921  An unweighted directed pseudograph
1922  An interpretation of this matrix as a (pseudo)graph allows us to define additional operations on it:
1923  A MatIJ can act on sparse arrays: arrays of indices, or index arrays of integers, scalars, or integer-scalar pairs
1924  by mapping the indices to the indices connected to them by the (pseudo)graph ed
1925  */
1926 typedef enum {MATIJ_LOCAL, MATIJ_GLOBAL} MatIJIndexType;
1927 PETSC_EXTERN PetscErrorCode MatIJSetMultivalued(Mat, PetscBool);
1928 PETSC_EXTERN PetscErrorCode MatIJGetMultivalued(Mat, PetscBool*);
1929 PETSC_EXTERN PetscErrorCode MatIJSetEdges(Mat, PetscInt, const PetscInt*, const PetscInt*);
1930 PETSC_EXTERN PetscErrorCode MatIJGetEdges(Mat, PetscInt *, PetscInt **, PetscInt **);
1931 PETSC_EXTERN PetscErrorCode MatIJSetEdgesIS(Mat, IS, IS);
1932 PETSC_EXTERN PetscErrorCode MatIJGetEdgesIS(Mat, IS*, IS*);
1933 PETSC_EXTERN PetscErrorCode MatIJGetRowSizes(Mat, MatIJIndexType, PetscInt, const PetscInt *, PetscInt **);
1934 PETSC_EXTERN PetscErrorCode MatIJGetMinRowSize(Mat, PetscInt *);
1935 PETSC_EXTERN PetscErrorCode MatIJGetMaxRowSize(Mat, PetscInt *);
1936 PETSC_EXTERN PetscErrorCode MatIJGetSupport(Mat,  PetscInt *, PetscInt **);
1937 PETSC_EXTERN PetscErrorCode MatIJGetSupportIS(Mat, IS *);
1938 PETSC_EXTERN PetscErrorCode MatIJGetImage(Mat, PetscInt*, PetscInt**);
1939 PETSC_EXTERN PetscErrorCode MatIJGetImageIS(Mat, IS *);
1940 PETSC_EXTERN PetscErrorCode MatIJGetSupportSize(Mat, PetscInt *);
1941 PETSC_EXTERN PetscErrorCode MatIJGetImageSize(Mat, PetscInt *);
1942 
1943 PETSC_EXTERN PetscErrorCode MatIJBinRenumber(Mat, Mat*);
1944 
1945 PETSC_EXTERN PetscErrorCode MatIJMap(Mat, MatIJIndexType, PetscInt,const PetscInt*,const PetscInt*,const PetscScalar*, MatIJIndexType,PetscInt*,PetscInt**,PetscInt**,PetscScalar**,PetscInt**);
1946 PETSC_EXTERN PetscErrorCode MatIJBin(Mat, MatIJIndexType, PetscInt,const PetscInt*,const PetscInt*,const PetscScalar*,PetscInt*,PetscInt**,PetscInt**,PetscScalar**,PetscInt**);
1947 PETSC_EXTERN PetscErrorCode MatIJBinMap(Mat,Mat, MatIJIndexType,PetscInt,const PetscInt*,const PetscInt*,const PetscScalar*,MatIJIndexType,PetscInt*,PetscInt**,PetscInt**,PetscScalar**,PetscInt**);
1948 
1949 PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal);
1950 
1951 #endif
1952