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