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