xref: /petsc/include/petscmat.h (revision 6719d8e4221aa2df40223c855908a52ac3a76cfd)
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  MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*);
629 extern PetscErrorCode  MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*);
630 extern PetscErrorCode  MatMatMultTransposeNumeric(Mat,Mat,Mat);
631 
632 extern PetscErrorCode  MatAXPY(Mat,PetscScalar,Mat,MatStructure);
633 extern PetscErrorCode  MatAYPX(Mat,PetscScalar,Mat,MatStructure);
634 
635 extern PetscErrorCode  MatScale(Mat,PetscScalar);
636 extern PetscErrorCode  MatShift(Mat,PetscScalar);
637 
638 extern PetscErrorCode  MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
639 extern PetscErrorCode  MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
640 extern PetscErrorCode  MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*);
641 extern PetscErrorCode  MatGetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*);
642 extern PetscErrorCode  MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
643 extern PetscErrorCode  MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
644 extern PetscErrorCode  MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
645 extern PetscErrorCode  MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
646 extern PetscErrorCode  MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
647 extern PetscErrorCode  MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
648 
649 extern PetscErrorCode  MatStashSetInitialSize(Mat,PetscInt,PetscInt);
650 extern PetscErrorCode  MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
651 
652 extern PetscErrorCode  MatInterpolate(Mat,Vec,Vec);
653 extern PetscErrorCode  MatInterpolateAdd(Mat,Vec,Vec,Vec);
654 PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
655 extern PetscErrorCode  MatRestrict(Mat,Vec,Vec);
656 extern PetscErrorCode  MatGetVecs(Mat,Vec*,Vec*);
657 extern PetscErrorCode  MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*);
658 extern PetscErrorCode  MatGetMultiProcBlock(Mat,MPI_Comm,Mat*);
659 extern PetscErrorCode  MatFindZeroDiagonals(Mat,IS*);
660 
661 /*MC
662    MatSetValue - Set a single entry into a matrix.
663 
664    Not collective
665 
666    Input Parameters:
667 +  m - the matrix
668 .  row - the row location of the entry
669 .  col - the column location of the entry
670 .  value - the value to insert
671 -  mode - either INSERT_VALUES or ADD_VALUES
672 
673    Notes:
674    For efficiency one should use MatSetValues() and set several or many
675    values simultaneously if possible.
676 
677    Level: beginner
678 
679 .seealso: MatSetValues(), MatSetValueLocal()
680 M*/
681 PETSC_STATIC_INLINE PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);}
682 
683 PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);}
684 
685 PETSC_STATIC_INLINE PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);}
686 
687 /*MC
688    MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
689        row in a matrix providing the data that one can use to correctly preallocate the matrix.
690 
691    Synopsis:
692    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
693 
694    Collective on MPI_Comm
695 
696    Input Parameters:
697 +  comm - the communicator that will share the eventually allocated matrix
698 .  nrows - the number of LOCAL rows in the matrix
699 -  ncols - the number of LOCAL columns in the matrix
700 
701    Output Parameters:
702 +  dnz - the array that will be passed to the matrix preallocation routines
703 -  ozn - the other array passed to the matrix preallocation routines
704 
705 
706    Level: intermediate
707 
708    Notes:
709     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
710 
711    Do not malloc or free dnz and onz, that is handled internally by these routines
712 
713    Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
714 
715    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
716 
717   Concepts: preallocation^Matrix
718 
719 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
720           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
721 M*/
722 #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
723 { \
724   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
725   _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
726   _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
727   _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
728   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
729   _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
730 
731 /*MC
732    MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per
733        row in a matrix providing the data that one can use to correctly preallocate the matrix.
734 
735    Synopsis:
736    PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
737 
738    Collective on MPI_Comm
739 
740    Input Parameters:
741 +  comm - the communicator that will share the eventually allocated matrix
742 .  nrows - the number of LOCAL rows in the matrix
743 -  ncols - the number of LOCAL columns in the matrix
744 
745    Output Parameters:
746 +  dnz - the array that will be passed to the matrix preallocation routines
747 -  ozn - the other array passed to the matrix preallocation routines
748 
749 
750    Level: intermediate
751 
752    Notes:
753     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
754 
755    Do not malloc or free dnz and onz, that is handled internally by these routines
756 
757    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
758 
759   Concepts: preallocation^Matrix
760 
761 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
762           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
763 M*/
764 #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \
765 { \
766   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__end; \
767   _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
768   _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
769   _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
770   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\
771   _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
772 
773 /*MC
774    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
775        inserted using a local number of the rows and columns
776 
777    Synopsis:
778    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
779 
780    Not Collective
781 
782    Input Parameters:
783 +  map - the row mapping from local numbering to global numbering
784 .  nrows - the number of rows indicated
785 .  rows - the indices of the rows
786 .  cmap - the column mapping from local to global numbering
787 .  ncols - the number of columns in the matrix
788 .  cols - the columns indicated
789 .  dnz - the array that will be passed to the matrix preallocation routines
790 -  ozn - the other array passed to the matrix preallocation routines
791 
792 
793    Level: intermediate
794 
795    Notes:
796     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
797 
798    Do not malloc or free dnz and onz, that is handled internally by these routines
799 
800   Concepts: preallocation^Matrix
801 
802 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
803           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
804 M*/
805 #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
806 {\
807   PetscInt __l;\
808   _4_ierr = ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
809   _4_ierr = ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
810   for (__l=0;__l<nrows;__l++) {\
811     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
812   }\
813 }
814 
815 /*MC
816    MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
817        inserted using a local number of the rows and columns
818 
819    Synopsis:
820    PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
821 
822    Not Collective
823 
824    Input Parameters:
825 +  map - the mapping between local numbering and global numbering
826 .  nrows - the number of rows indicated
827 .  rows - the indices of the rows
828 .  ncols - the number of columns in the matrix
829 .  cols - the columns indicated
830 .  dnz - the array that will be passed to the matrix preallocation routines
831 -  ozn - the other array passed to the matrix preallocation routines
832 
833 
834    Level: intermediate
835 
836    Notes:
837     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
838 
839    Do not malloc or free dnz and onz that is handled internally by these routines
840 
841   Concepts: preallocation^Matrix
842 
843 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
844           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
845 M*/
846 #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
847 {\
848   PetscInt __l;\
849   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
850   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
851   for (__l=0;__l<nrows;__l++) {\
852     _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
853   }\
854 }
855 
856 /*MC
857    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
858        inserted using a local number of the rows and columns
859 
860    Synopsis:
861    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
862 
863    Not Collective
864 
865    Input Parameters:
866 +  row - the row
867 .  ncols - the number of columns in the matrix
868 -  cols - the columns indicated
869 
870    Output Parameters:
871 +  dnz - the array that will be passed to the matrix preallocation routines
872 -  ozn - the other array passed to the matrix preallocation routines
873 
874 
875    Level: intermediate
876 
877    Notes:
878     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
879 
880    Do not malloc or free dnz and onz that is handled internally by these routines
881 
882    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
883 
884   Concepts: preallocation^Matrix
885 
886 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
887           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
888 M*/
889 #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
890 { PetscInt __i; \
891   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);\
892   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);\
893   for (__i=0; __i<nc; __i++) {\
894     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
895     else dnz[row - __rstart]++;\
896   }\
897 }
898 
899 /*MC
900    MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
901        inserted using a local number of the rows and columns
902 
903    Synopsis:
904    PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
905 
906    Not Collective
907 
908    Input Parameters:
909 +  nrows - the number of rows indicated
910 .  rows - the indices of the rows
911 .  ncols - the number of columns in the matrix
912 .  cols - the columns indicated
913 .  dnz - the array that will be passed to the matrix preallocation routines
914 -  ozn - the other array passed to the matrix preallocation routines
915 
916 
917    Level: intermediate
918 
919    Notes:
920     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
921 
922    Do not malloc or free dnz and onz that is handled internally by these routines
923 
924    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
925 
926   Concepts: preallocation^Matrix
927 
928 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
929           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
930 M*/
931 #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
932 { PetscInt __i; \
933   for (__i=0; __i<nc; __i++) {\
934     if (cols[__i] >= __end) onz[row - __rstart]++; \
935     else if (cols[__i] >= row) dnz[row - __rstart]++;\
936   }\
937 }
938 
939 /*MC
940    MatPreallocateLocation -  An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists
941 
942    Synopsis:
943    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)
944 
945    Not Collective
946 
947    Input Parameters:
948 .  A - matrix
949 .  row - row where values exist (must be local to this process)
950 .  ncols - number of columns
951 .  cols - columns with nonzeros
952 .  dnz - the array that will be passed to the matrix preallocation routines
953 -  ozn - the other array passed to the matrix preallocation routines
954 
955 
956    Level: intermediate
957 
958    Notes:
959     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
960 
961    Do not malloc or free dnz and onz that is handled internally by these routines
962 
963    This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.
964 
965   Concepts: preallocation^Matrix
966 
967 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
968           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
969 M*/
970 #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);}
971 
972 
973 /*MC
974    MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
975        row in a matrix providing the data that one can use to correctly preallocate the matrix.
976 
977    Synopsis:
978    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
979 
980    Collective on MPI_Comm
981 
982    Input Parameters:
983 +  dnz - the array that was be passed to the matrix preallocation routines
984 -  ozn - the other array passed to the matrix preallocation routines
985 
986 
987    Level: intermediate
988 
989    Notes:
990     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
991 
992    Do not malloc or free dnz and onz that is handled internally by these routines
993 
994    This is a MACRO not a function because it closes the { started in MatPreallocateInitialize().
995 
996   Concepts: preallocation^Matrix
997 
998 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
999           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
1000 M*/
1001 #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}
1002 
1003 
1004 
1005 /* Routines unique to particular data structures */
1006 extern PetscErrorCode  MatShellGetContext(Mat,void *);
1007 PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t)
1008 
1009 extern PetscErrorCode  MatInodeAdjustForInodes(Mat,IS*,IS*);
1010 extern PetscErrorCode  MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
1011 
1012 extern PetscErrorCode  MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
1013 extern PetscErrorCode  MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
1014 extern PetscErrorCode  MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1015 extern PetscErrorCode  MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1016 extern PetscErrorCode  MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1017 extern PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool);
1018 
1019 #define MAT_SKIP_ALLOCATION -4
1020 
1021 extern PetscErrorCode  MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1022 PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
1023 extern PetscErrorCode  MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1024 PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
1025 extern PetscErrorCode  MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
1026 PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz))
1027 
1028 extern PetscErrorCode  MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1029 PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz))
1030 extern PetscErrorCode  MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1031 extern PetscErrorCode  MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1032 extern PetscErrorCode  MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
1033 extern PetscErrorCode  MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1034 extern PetscErrorCode  MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
1035 extern PetscErrorCode  MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1036 extern PetscErrorCode  MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
1037 extern PetscErrorCode  MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
1038 extern PetscErrorCode  MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
1039 extern PetscErrorCode  MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
1040 extern PetscErrorCode  MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
1041 extern PetscErrorCode  MatAdicSetLocalFunction(Mat,void (*)(void));
1042 
1043 extern PetscErrorCode  MatSeqDenseSetLDA(Mat,PetscInt);
1044 extern PetscErrorCode  MatDenseGetLocalMatrix(Mat,Mat*);
1045 
1046 extern PetscErrorCode  MatStoreValues(Mat);
1047 extern PetscErrorCode  MatRetrieveValues(Mat);
1048 
1049 extern PetscErrorCode  MatDAADSetCtx(Mat,void*);
1050 
1051 extern PetscErrorCode  MatFindNonzeroRows(Mat,IS*);
1052 /*
1053   These routines are not usually accessed directly, rather solving is
1054   done through the KSP and PC interfaces.
1055 */
1056 
1057 /*J
1058     MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
1059        with an optional dynamic library name, for example
1060        http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
1061 
1062    Level: beginner
1063 
1064    Cannot use const because the PC objects manipulate the string
1065 
1066 .seealso: MatGetOrdering()
1067 J*/
1068 #define MatOrderingType char*
1069 #define MATORDERINGNATURAL     "natural"
1070 #define MATORDERINGND          "nd"
1071 #define MATORDERING1WD         "1wd"
1072 #define MATORDERINGRCM         "rcm"
1073 #define MATORDERINGQMD         "qmd"
1074 #define MATORDERINGROWLENGTH   "rowlength"
1075 #define MATORDERINGAMD         "amd"            /* only works if UMFPACK is installed with PETSc */
1076 
1077 extern PetscErrorCode  MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
1078 extern PetscErrorCode  MatGetOrderingList(PetscFList *list);
1079 extern PetscErrorCode  MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));
1080 
1081 /*MC
1082    MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the matrix package.
1083 
1084    Synopsis:
1085    PetscErrorCode MatOrderingRegisterDynamic(const char *name_ordering,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
1086 
1087    Not Collective
1088 
1089    Input Parameters:
1090 +  sname - name of ordering (for example MATORDERINGND)
1091 .  path - location of library where creation routine is
1092 .  name - name of function that creates the ordering type,a string
1093 -  function - function pointer that creates the ordering
1094 
1095    Level: developer
1096 
1097    If dynamic libraries are used, then the fourth input argument (function)
1098    is ignored.
1099 
1100    Sample usage:
1101 .vb
1102    MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
1103                "MyOrder",MyOrder);
1104 .ve
1105 
1106    Then, your partitioner can be chosen with the procedural interface via
1107 $     MatOrderingSetType(part,"my_order)
1108    or at runtime via the option
1109 $     -pc_factor_mat_ordering_type my_order
1110 
1111    ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
1112 
1113 .keywords: matrix, ordering, register
1114 
1115 .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
1116 M*/
1117 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1118 #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
1119 #else
1120 #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
1121 #endif
1122 
1123 extern PetscErrorCode  MatOrderingRegisterDestroy(void);
1124 extern PetscErrorCode  MatOrderingRegisterAll(const char[]);
1125 extern PetscBool  MatOrderingRegisterAllCalled;
1126 extern PetscFList MatOrderingList;
1127 
1128 extern PetscErrorCode  MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1129 
1130 /*S
1131     MatFactorShiftType - Numeric Shift.
1132 
1133    Level: beginner
1134 
1135 S*/
1136 typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
1137 extern const char *MatFactorShiftTypes[];
1138 
1139 /*S
1140    MatFactorInfo - Data passed into the matrix factorization routines
1141 
1142    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
1143 $     MatFactorInfo  info(MAT_FACTORINFO_SIZE)
1144 
1145    Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
1146 
1147       You can use MatFactorInfoInitialize() to set default values.
1148 
1149    Level: developer
1150 
1151 .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1152           MatFactorInfoInitialize()
1153 
1154 S*/
1155 typedef struct {
1156   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
1157   PetscReal     usedt;
1158   PetscReal     dt;             /* drop tolerance */
1159   PetscReal     dtcol;          /* tolerance for pivoting */
1160   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
1161   PetscReal     fill;           /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1162   PetscReal     levels;         /* ICC/ILU(levels) */
1163   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1164                                    factorization may be faster if do not pivot */
1165   PetscReal     zeropivot;      /* pivot is called zero if less than this */
1166   PetscReal     shifttype;      /* type of shift added to matrix factor to prevent zero pivots */
1167   PetscReal     shiftamount;     /* how large the shift is */
1168 } MatFactorInfo;
1169 
1170 extern PetscErrorCode  MatFactorInfoInitialize(MatFactorInfo*);
1171 extern PetscErrorCode  MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
1172 extern PetscErrorCode  MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1173 extern PetscErrorCode  MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
1174 extern PetscErrorCode  MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
1175 extern PetscErrorCode  MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
1176 extern PetscErrorCode  MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1177 extern PetscErrorCode  MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1178 extern PetscErrorCode  MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1179 extern PetscErrorCode  MatICCFactor(Mat,IS,const MatFactorInfo*);
1180 extern PetscErrorCode  MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1181 extern PetscErrorCode  MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1182 extern PetscErrorCode  MatSolve(Mat,Vec,Vec);
1183 extern PetscErrorCode  MatForwardSolve(Mat,Vec,Vec);
1184 extern PetscErrorCode  MatBackwardSolve(Mat,Vec,Vec);
1185 extern PetscErrorCode  MatSolveAdd(Mat,Vec,Vec,Vec);
1186 extern PetscErrorCode  MatSolveTranspose(Mat,Vec,Vec);
1187 extern PetscErrorCode  MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1188 extern PetscErrorCode  MatSolves(Mat,Vecs,Vecs);
1189 
1190 extern PetscErrorCode  MatSetUnfactored(Mat);
1191 
1192 /*E
1193     MatSORType - What type of (S)SOR to perform
1194 
1195     Level: beginner
1196 
1197    May be bitwise ORd together
1198 
1199    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1200 
1201    MatSORType may be bitwise ORd together, so do not change the numbers
1202 
1203 .seealso: MatSOR()
1204 E*/
1205 typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1206               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1207               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
1208               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1209 extern PetscErrorCode  MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1210 
1211 /*
1212     These routines are for efficiently computing Jacobians via finite differences.
1213 */
1214 
1215 /*J
1216     MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1217        with an optional dynamic library name, for example
1218        http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1219 
1220    Level: beginner
1221 
1222 .seealso: MatGetColoring()
1223 J*/
1224 #define MatColoringType char*
1225 #define MATCOLORINGNATURAL "natural"
1226 #define MATCOLORINGSL      "sl"
1227 #define MATCOLORINGLF      "lf"
1228 #define MATCOLORINGID      "id"
1229 
1230 extern PetscErrorCode  MatGetColoring(Mat,const MatColoringType,ISColoring*);
1231 extern PetscErrorCode  MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *));
1232 
1233 /*MC
1234    MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
1235                                matrix package.
1236 
1237    Synopsis:
1238    PetscErrorCode MatColoringRegisterDynamic(const char *name_coloring,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatColoring))
1239 
1240    Not Collective
1241 
1242    Input Parameters:
1243 +  sname - name of Coloring (for example MATCOLORINGSL)
1244 .  path - location of library where creation routine is
1245 .  name - name of function that creates the Coloring type, a string
1246 -  function - function pointer that creates the coloring
1247 
1248    Level: developer
1249 
1250    If dynamic libraries are used, then the fourth input argument (function)
1251    is ignored.
1252 
1253    Sample usage:
1254 .vb
1255    MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
1256                "MyColor",MyColor);
1257 .ve
1258 
1259    Then, your partitioner can be chosen with the procedural interface via
1260 $     MatColoringSetType(part,"my_color")
1261    or at runtime via the option
1262 $     -mat_coloring_type my_color
1263 
1264    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
1265 
1266 .keywords: matrix, Coloring, register
1267 
1268 .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
1269 M*/
1270 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1271 #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1272 #else
1273 #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1274 #endif
1275 
1276 extern PetscBool  MatColoringRegisterAllCalled;
1277 
1278 extern PetscErrorCode  MatColoringRegisterAll(const char[]);
1279 extern PetscErrorCode  MatColoringRegisterDestroy(void);
1280 extern PetscErrorCode  MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1281 
1282 /*S
1283      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1284         and coloring
1285 
1286    Level: beginner
1287 
1288   Concepts: coloring, sparse Jacobian, finite differences
1289 
1290 .seealso:  MatFDColoringCreate()
1291 S*/
1292 typedef struct _p_MatFDColoring* MatFDColoring;
1293 
1294 extern PetscErrorCode  MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1295 extern PetscErrorCode  MatFDColoringDestroy(MatFDColoring*);
1296 extern PetscErrorCode  MatFDColoringView(MatFDColoring,PetscViewer);
1297 extern PetscErrorCode  MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1298 extern PetscErrorCode  MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1299 extern PetscErrorCode  MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1300 extern PetscErrorCode  MatFDColoringSetFromOptions(MatFDColoring);
1301 extern PetscErrorCode  MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1302 extern PetscErrorCode  MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *);
1303 extern PetscErrorCode  MatFDColoringSetF(MatFDColoring,Vec);
1304 extern PetscErrorCode  MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1305 /*
1306     These routines are for partitioning matrices: currently used only
1307   for adjacency matrix, MatCreateMPIAdj().
1308 */
1309 
1310 /*S
1311      MatPartitioning - Object for managing the partitioning of a matrix or graph
1312 
1313    Level: beginner
1314 
1315   Concepts: partitioning
1316 
1317 .seealso:  MatPartitioningCreate(), MatPartitioningType
1318 S*/
1319 typedef struct _p_MatPartitioning* MatPartitioning;
1320 
1321 /*J
1322     MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1323        with an optional dynamic library name, for example
1324        http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1325 
1326    Level: beginner
1327 
1328 .seealso: MatPartitioningCreate(), MatPartitioning
1329 J*/
1330 #define MatPartitioningType char*
1331 #define MATPARTITIONINGCURRENT  "current"
1332 #define MATPARTITIONINGSQUARE   "square"
1333 #define MATPARTITIONINGPARMETIS "parmetis"
1334 #define MATPARTITIONINGCHACO    "chaco"
1335 #define MATPARTITIONINGPARTY    "party"
1336 #define MATPARTITIONINGPTSCOTCH "ptscotch"
1337 
1338 
1339 extern PetscErrorCode  MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1340 extern PetscErrorCode  MatPartitioningSetType(MatPartitioning,const MatPartitioningType);
1341 extern PetscErrorCode  MatPartitioningSetNParts(MatPartitioning,PetscInt);
1342 extern PetscErrorCode  MatPartitioningSetAdjacency(MatPartitioning,Mat);
1343 extern PetscErrorCode  MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1344 extern PetscErrorCode  MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1345 extern PetscErrorCode  MatPartitioningApply(MatPartitioning,IS*);
1346 extern PetscErrorCode  MatPartitioningDestroy(MatPartitioning*);
1347 
1348 extern PetscErrorCode  MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
1349 
1350 /*MC
1351    MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
1352    matrix package.
1353 
1354    Synopsis:
1355    PetscErrorCode MatPartitioningRegisterDynamic(const char *name_partitioning,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
1356 
1357    Not Collective
1358 
1359    Input Parameters:
1360 +  sname - name of partitioning (for example MATPARTITIONINGCURRENT) or parmetis
1361 .  path - location of library where creation routine is
1362 .  name - name of function that creates the partitioning type, a string
1363 -  function - function pointer that creates the partitioning type
1364 
1365    Level: developer
1366 
1367    If dynamic libraries are used, then the fourth input argument (function)
1368    is ignored.
1369 
1370    Sample usage:
1371 .vb
1372    MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
1373                "MyPartCreate",MyPartCreate);
1374 .ve
1375 
1376    Then, your partitioner can be chosen with the procedural interface via
1377 $     MatPartitioningSetType(part,"my_part")
1378    or at runtime via the option
1379 $     -mat_partitioning_type my_part
1380 
1381    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
1382 
1383 .keywords: matrix, partitioning, register
1384 
1385 .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
1386 M*/
1387 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1388 #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
1389 #else
1390 #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
1391 #endif
1392 
1393 extern PetscBool  MatPartitioningRegisterAllCalled;
1394 
1395 extern PetscErrorCode  MatPartitioningRegisterAll(const char[]);
1396 extern PetscErrorCode  MatPartitioningRegisterDestroy(void);
1397 
1398 extern PetscErrorCode  MatPartitioningView(MatPartitioning,PetscViewer);
1399 extern PetscErrorCode  MatPartitioningSetFromOptions(MatPartitioning);
1400 extern PetscErrorCode  MatPartitioningGetType(MatPartitioning,const MatPartitioningType*);
1401 
1402 extern PetscErrorCode  MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1403 extern PetscErrorCode  MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);
1404 
1405 typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType;
1406 extern const char *MPChacoGlobalTypes[];
1407 typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType;
1408 extern const char *MPChacoLocalTypes[];
1409 typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType;
1410 extern const char *MPChacoEigenTypes[];
1411 
1412 extern PetscErrorCode  MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType);
1413 extern PetscErrorCode  MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*);
1414 extern PetscErrorCode  MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType);
1415 extern PetscErrorCode  MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*);
1416 extern PetscErrorCode  MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
1417 extern PetscErrorCode  MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1418 extern PetscErrorCode  MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*);
1419 extern PetscErrorCode  MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal);
1420 extern PetscErrorCode  MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*);
1421 extern PetscErrorCode  MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt);
1422 extern PetscErrorCode  MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*);
1423 
1424 #define MP_PARTY_OPT "opt"
1425 #define MP_PARTY_LIN "lin"
1426 #define MP_PARTY_SCA "sca"
1427 #define MP_PARTY_RAN "ran"
1428 #define MP_PARTY_GBF "gbf"
1429 #define MP_PARTY_GCF "gcf"
1430 #define MP_PARTY_BUB "bub"
1431 #define MP_PARTY_DEF "def"
1432 extern PetscErrorCode  MatPartitioningPartySetGlobal(MatPartitioning,const char*);
1433 #define MP_PARTY_HELPFUL_SETS "hs"
1434 #define MP_PARTY_KERNIGHAN_LIN "kl"
1435 #define MP_PARTY_NONE "no"
1436 extern PetscErrorCode  MatPartitioningPartySetLocal(MatPartitioning,const char*);
1437 extern PetscErrorCode  MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1438 extern PetscErrorCode  MatPartitioningPartySetBipart(MatPartitioning,PetscBool);
1439 extern PetscErrorCode  MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool);
1440 
1441 typedef enum { MP_PTSCOTCH_QUALITY,MP_PTSCOTCH_SPEED,MP_PTSCOTCH_BALANCE,MP_PTSCOTCH_SAFETY,MP_PTSCOTCH_SCALABILITY } MPPTScotchStrategyType;
1442 extern const char *MPPTScotchStrategyTypes[];
1443 
1444 extern PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal);
1445 extern PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*);
1446 extern PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType);
1447 extern PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*);
1448 
1449 extern PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
1450 extern PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);
1451 
1452 /*
1453     If you add entries here you must also add them to finclude/petscmat.h
1454 */
1455 typedef enum { MATOP_SET_VALUES=0,
1456                MATOP_GET_ROW=1,
1457                MATOP_RESTORE_ROW=2,
1458                MATOP_MULT=3,
1459                MATOP_MULT_ADD=4,
1460                MATOP_MULT_TRANSPOSE=5,
1461                MATOP_MULT_TRANSPOSE_ADD=6,
1462                MATOP_SOLVE=7,
1463                MATOP_SOLVE_ADD=8,
1464                MATOP_SOLVE_TRANSPOSE=9,
1465                MATOP_SOLVE_TRANSPOSE_ADD=10,
1466                MATOP_LUFACTOR=11,
1467                MATOP_CHOLESKYFACTOR=12,
1468                MATOP_SOR=13,
1469                MATOP_TRANSPOSE=14,
1470                MATOP_GETINFO=15,
1471                MATOP_EQUAL=16,
1472                MATOP_GET_DIAGONAL=17,
1473                MATOP_DIAGONAL_SCALE=18,
1474                MATOP_NORM=19,
1475                MATOP_ASSEMBLY_BEGIN=20,
1476                MATOP_ASSEMBLY_END=21,
1477                MATOP_SET_OPTION=22,
1478                MATOP_ZERO_ENTRIES=23,
1479                MATOP_ZERO_ROWS=24,
1480                MATOP_LUFACTOR_SYMBOLIC=25,
1481                MATOP_LUFACTOR_NUMERIC=26,
1482                MATOP_CHOLESKY_FACTOR_SYMBOLIC=27,
1483                MATOP_CHOLESKY_FACTOR_NUMERIC=28,
1484                MATOP_SETUP_PREALLOCATION=29,
1485                MATOP_ILUFACTOR_SYMBOLIC=30,
1486                MATOP_ICCFACTOR_SYMBOLIC=31,
1487                MATOP_GET_ARRAY=32,
1488                MATOP_RESTORE_ARRAY=33,
1489                MATOP_DUPLICATE=34,
1490                MATOP_FORWARD_SOLVE=35,
1491                MATOP_BACKWARD_SOLVE=36,
1492                MATOP_ILUFACTOR=37,
1493                MATOP_ICCFACTOR=38,
1494                MATOP_AXPY=39,
1495                MATOP_GET_SUBMATRICES=40,
1496                MATOP_INCREASE_OVERLAP=41,
1497                MATOP_GET_VALUES=42,
1498                MATOP_COPY=43,
1499                MATOP_GET_ROW_MAX=44,
1500                MATOP_SCALE=45,
1501                MATOP_SHIFT=46,
1502                MATOP_DIAGONAL_SET=47,
1503                MATOP_ILUDT_FACTOR=48,
1504                MATOP_SET_BLOCK_SIZE=49,
1505                MATOP_GET_ROW_IJ=50,
1506                MATOP_RESTORE_ROW_IJ=51,
1507                MATOP_GET_COLUMN_IJ=52,
1508                MATOP_RESTORE_COLUMN_IJ=53,
1509                MATOP_FDCOLORING_CREATE=54,
1510                MATOP_COLORING_PATCH=55,
1511                MATOP_SET_UNFACTORED=56,
1512                MATOP_PERMUTE=57,
1513                MATOP_SET_VALUES_BLOCKED=58,
1514                MATOP_GET_SUBMATRIX=59,
1515                MATOP_DESTROY=60,
1516                MATOP_VIEW=61,
1517                MATOP_CONVERT_FROM=62,
1518                MATOP_USE_SCALED_FORM=63,
1519                MATOP_SCALE_SYSTEM=64,
1520                MATOP_UNSCALE_SYSTEM=65,
1521                MATOP_SET_LOCAL_TO_GLOBAL_MAP=66,
1522                MATOP_SET_VALUES_LOCAL=67,
1523                MATOP_ZERO_ROWS_LOCAL=68,
1524                MATOP_GET_ROW_MAX_ABS=69,
1525                MATOP_GET_ROW_MIN_ABS=70,
1526                MATOP_CONVERT=71,
1527                MATOP_SET_COLORING=72,
1528                MATOP_SET_VALUES_ADIC=73,
1529                MATOP_SET_VALUES_ADIFOR=74,
1530                MATOP_FD_COLORING_APPLY=75,
1531                MATOP_SET_FROM_OPTIONS=76,
1532                MATOP_MULT_CON=77,
1533                MATOP_MULT_TRANSPOSE_CON=78,
1534                MATOP_PERMUTE_SPARSIFY=79,
1535                MATOP_MULT_MULTIPLE=80,
1536                MATOP_SOLVE_MULTIPLE=81,
1537                MATOP_GET_INERTIA=82,
1538                MATOP_LOAD=83,
1539                MATOP_IS_SYMMETRIC=84,
1540                MATOP_IS_HERMITIAN=85,
1541                MATOP_IS_STRUCTURALLY_SYMMETRIC=86,
1542                MATOP_DUMMY=87,
1543                MATOP_GET_VECS=88,
1544                MATOP_MAT_MULT=89,
1545                MATOP_MAT_MULT_SYMBOLIC=90,
1546                MATOP_MAT_MULT_NUMERIC=91,
1547                MATOP_PTAP=92,
1548                MATOP_PTAP_SYMBOLIC=93,
1549                MATOP_PTAP_NUMERIC=94,
1550                MATOP_MAT_MULTTRANSPOSE=95,
1551                MATOP_MAT_MULTTRANSPOSE_SYM=96,
1552                MATOP_MAT_MULTTRANSPOSE_NUM=97,
1553                MATOP_PTAP_SYMBOLIC_SEQAIJ=98,
1554                MATOP_PTAP_NUMERIC_SEQAIJ=99,
1555                MATOP_PTAP_SYMBOLIC_MPIAIJ=100,
1556                MATOP_PTAP_NUMERIC_MPIAIJ=101,
1557                MATOP_CONJUGATE=102,
1558                MATOP_SET_SIZES=103,
1559                MATOP_SET_VALUES_ROW=104,
1560                MATOP_REAL_PART=105,
1561                MATOP_IMAG_PART=106,
1562                MATOP_GET_ROW_UTRIANGULAR=107,
1563                MATOP_RESTORE_ROW_UTRIANGULAR=108,
1564                MATOP_MATSOLVE=109,
1565                MATOP_GET_REDUNDANTMATRIX=110,
1566                MATOP_GET_ROW_MIN=111,
1567                MATOP_GET_COLUMN_VEC=112,
1568                MATOP_MISSING_DIAGONAL=113,
1569                MATOP_MATGETSEQNONZEROSTRUCTURE=114,
1570                MATOP_CREATE=115,
1571                MATOP_GET_GHOSTS=116,
1572                MATOP_GET_LOCALSUBMATRIX=117,
1573                MATOP_RESTORE_LOCALSUBMATRIX=118,
1574                MATOP_MULT_DIAGONAL_BLOCK=119,
1575                MATOP_HERMITIANTRANSPOSE=120,
1576                MATOP_MULTHERMITIANTRANSPOSE=121,
1577                MATOP_MULTHERMITIANTRANSPOSEADD=122,
1578                MATOP_GETMULTIPROCBLOCK=123,
1579                MATOP_GETCOLUMNNORMS=125,
1580 	       MATOP_GET_SUBMATRICES_PARALLEL=128,
1581                MATOP_SET_VALUES_BATCH=129
1582              } MatOperation;
1583 extern PetscErrorCode  MatHasOperation(Mat,MatOperation,PetscBool *);
1584 extern PetscErrorCode  MatShellSetOperation(Mat,MatOperation,void(*)(void));
1585 extern PetscErrorCode  MatShellGetOperation(Mat,MatOperation,void(**)(void));
1586 extern PetscErrorCode  MatShellSetContext(Mat,void*);
1587 
1588 /*
1589    Codes for matrices stored on disk. By default they are
1590    stored in a universal format. By changing the format with
1591    PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
1592    be stored in a way natural for the matrix, for example dense matrices
1593    would be stored as dense. Matrices stored this way may only be
1594    read into matrices of the same type.
1595 */
1596 #define MATRIX_BINARY_FORMAT_DENSE -1
1597 
1598 extern PetscErrorCode  MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1599 extern PetscErrorCode  MatISGetLocalMat(Mat,Mat*);
1600 
1601 /*S
1602      MatNullSpace - Object that removes a null space from a vector, i.e.
1603          orthogonalizes the vector to a subsapce
1604 
1605    Level: advanced
1606 
1607   Concepts: matrix; linear operator, null space
1608 
1609   Users manual sections:
1610 .   sec_singular
1611 
1612 .seealso:  MatNullSpaceCreate()
1613 S*/
1614 typedef struct _p_MatNullSpace* MatNullSpace;
1615 
1616 extern PetscErrorCode  MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*);
1617 extern PetscErrorCode  MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1618 extern PetscErrorCode  MatNullSpaceDestroy(MatNullSpace*);
1619 extern PetscErrorCode  MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1620 extern PetscErrorCode  MatSetNullSpace(Mat,MatNullSpace);
1621 extern PetscErrorCode  MatSetNearNullSpace(Mat,MatNullSpace);
1622 extern PetscErrorCode  MatNullSpaceTest(MatNullSpace,Mat,PetscBool  *);
1623 extern PetscErrorCode  MatNullSpaceView(MatNullSpace,PetscViewer);
1624 
1625 extern PetscErrorCode  MatReorderingSeqSBAIJ(Mat,IS);
1626 extern PetscErrorCode  MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1627 extern PetscErrorCode  MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
1628 extern PetscErrorCode  MatSeqBAIJInvertBlockDiagonal(Mat);
1629 
1630 extern PetscErrorCode  MatCreateMAIJ(Mat,PetscInt,Mat*);
1631 extern PetscErrorCode  MatMAIJRedimension(Mat,PetscInt,Mat*);
1632 extern PetscErrorCode  MatMAIJGetAIJ(Mat,Mat*);
1633 
1634 extern PetscErrorCode  MatComputeExplicitOperator(Mat,Mat*);
1635 
1636 extern PetscErrorCode  MatDiagonalScaleLocal(Mat,Vec);
1637 
1638 extern PetscErrorCode  MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
1639 extern PetscErrorCode  MatMFFDSetBase(Mat,Vec,Vec);
1640 extern PetscErrorCode  MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1641 extern PetscErrorCode  MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1642 extern PetscErrorCode  MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1643 extern PetscErrorCode  MatMFFDAddNullSpace(Mat,MatNullSpace);
1644 extern PetscErrorCode  MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1645 extern PetscErrorCode  MatMFFDResetHHistory(Mat);
1646 extern PetscErrorCode  MatMFFDSetFunctionError(Mat,PetscReal);
1647 extern PetscErrorCode  MatMFFDSetPeriod(Mat,PetscInt);
1648 extern PetscErrorCode  MatMFFDGetH(Mat,PetscScalar *);
1649 extern PetscErrorCode  MatMFFDSetOptionsPrefix(Mat,const char[]);
1650 extern PetscErrorCode  MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1651 extern PetscErrorCode  MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);
1652 
1653 /*S
1654     MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free
1655               Jacobian vector products
1656 
1657     Notes: MATMFFD is a specific MatType which uses the MatMFFD data structure
1658 
1659            MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure
1660 
1661     Level: developer
1662 
1663 .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
1664 S*/
1665 typedef struct _p_MatMFFD* MatMFFD;
1666 
1667 /*J
1668     MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function
1669 
1670    Level: beginner
1671 
1672 .seealso: MatMFFDSetType(), MatMFFDRegister()
1673 J*/
1674 #define MatMFFDType char*
1675 #define MATMFFD_DS  "ds"
1676 #define MATMFFD_WP  "wp"
1677 
1678 extern PetscErrorCode  MatMFFDSetType(Mat,const MatMFFDType);
1679 extern PetscErrorCode  MatMFFDRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatMFFD));
1680 
1681 /*MC
1682    MatMFFDRegisterDynamic - Adds a method to the MatMFFD registry.
1683 
1684    Synopsis:
1685    PetscErrorCode MatMFFDRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatMFFD))
1686 
1687    Not Collective
1688 
1689    Input Parameters:
1690 +  name_solver - name of a new user-defined compute-h module
1691 .  path - path (either absolute or relative) the library containing this solver
1692 .  name_create - name of routine to create method context
1693 -  routine_create - routine to create method context
1694 
1695    Level: developer
1696 
1697    Notes:
1698    MatMFFDRegisterDynamic() may be called multiple times to add several user-defined solvers.
1699 
1700    If dynamic libraries are used, then the fourth input argument (routine_create)
1701    is ignored.
1702 
1703    Sample usage:
1704 .vb
1705    MatMFFDRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a,
1706                "MyHCreate",MyHCreate);
1707 .ve
1708 
1709    Then, your solver can be chosen with the procedural interface via
1710 $     MatMFFDSetType(mfctx,"my_h")
1711    or at runtime via the option
1712 $     -snes_mf_type my_h
1713 
1714 .keywords: MatMFFD, register
1715 
1716 .seealso: MatMFFDRegisterAll(), MatMFFDRegisterDestroy()
1717 M*/
1718 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1719 #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,0)
1720 #else
1721 #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,d)
1722 #endif
1723 
1724 extern PetscErrorCode  MatMFFDRegisterAll(const char[]);
1725 extern PetscErrorCode  MatMFFDRegisterDestroy(void);
1726 extern PetscErrorCode  MatMFFDDSSetUmin(Mat,PetscReal);
1727 extern PetscErrorCode  MatMFFDWPSetComputeNormU(Mat,PetscBool );
1728 
1729 
1730 extern PetscErrorCode  PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1731 extern PetscErrorCode  PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
1732 
1733 /*
1734    PETSc interface to MUMPS
1735 */
1736 #ifdef PETSC_HAVE_MUMPS
1737 extern PetscErrorCode  MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
1738 #endif
1739 
1740 /*
1741    PETSc interface to SUPERLU
1742 */
1743 #ifdef PETSC_HAVE_SUPERLU
1744 extern PetscErrorCode  MatSuperluSetILUDropTol(Mat,PetscReal);
1745 #endif
1746 
1747 #if defined(PETSC_HAVE_CUSP)
1748 extern PetscErrorCode  MatCreateSeqAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1749 extern PetscErrorCode  MatCreateMPIAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1750 #endif
1751 
1752 /*
1753    PETSc interface to FFTW
1754 */
1755 #if defined(PETSC_HAVE_FFTW)
1756 extern PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec);
1757 extern PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec);
1758 extern PetscErrorCode MatGetVecsFFTW(Mat,Vec*,Vec*,Vec*);
1759 #endif
1760 
1761 extern PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*);
1762 extern PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*);
1763 extern PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***);
1764 extern PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*);
1765 extern PetscErrorCode MatNestSetVecType(Mat,const VecType);
1766 extern PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]);
1767 extern PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat);
1768 
1769 /*
1770  MatIJ:
1771  An unweighted directed pseudograph
1772  An interpretation of this matrix as a (pseudo)graph allows us to define additional operations on it:
1773  A MatIJ can act on sparse arrays: arrays of indices, or index arrays of integers, scalars, or integer-scalar pairs
1774  by mapping the indices to the indices connected to them by the (pseudo)graph ed
1775  */
1776 typedef enum {MATIJ_LOCAL, MATIJ_GLOBAL} MatIJIndexType;
1777 extern  PetscErrorCode MatIJSetMultivalued(Mat, PetscBool);
1778 extern  PetscErrorCode MatIJGetMultivalued(Mat, PetscBool*);
1779 extern  PetscErrorCode MatIJSetEdges(Mat, PetscInt, const PetscInt*, const PetscInt*);
1780 extern  PetscErrorCode MatIJGetEdges(Mat, PetscInt *, PetscInt **, PetscInt **);
1781 extern  PetscErrorCode MatIJSetEdgesIS(Mat, IS, IS);
1782 extern  PetscErrorCode MatIJGetEdgesIS(Mat, IS*, IS*);
1783 extern  PetscErrorCode MatIJGetRowSizes(Mat, MatIJIndexType, PetscInt, const PetscInt *, PetscInt **);
1784 extern  PetscErrorCode MatIJGetMinRowSize(Mat, PetscInt *);
1785 extern  PetscErrorCode MatIJGetMaxRowSize(Mat, PetscInt *);
1786 extern  PetscErrorCode MatIJGetSupport(Mat,  PetscInt *, PetscInt **);
1787 extern  PetscErrorCode MatIJGetSupportIS(Mat, IS *);
1788 extern  PetscErrorCode MatIJGetImage(Mat, PetscInt*, PetscInt**);
1789 extern  PetscErrorCode MatIJGetImageIS(Mat, IS *);
1790 extern  PetscErrorCode MatIJGetSupportSize(Mat, PetscInt *);
1791 extern  PetscErrorCode MatIJGetImageSize(Mat, PetscInt *);
1792 
1793 extern  PetscErrorCode MatIJBinRenumber(Mat, Mat*);
1794 
1795 extern  PetscErrorCode MatIJMap(Mat, MatIJIndexType, PetscInt,const PetscInt*,const PetscInt*,const PetscScalar*, MatIJIndexType,PetscInt*,PetscInt**,PetscInt**,PetscScalar**,PetscInt**);
1796 extern  PetscErrorCode MatIJBin(Mat, MatIJIndexType, PetscInt,const PetscInt*,const PetscInt*,const PetscScalar*,PetscInt*,PetscInt**,PetscInt**,PetscScalar**,PetscInt**);
1797 extern  PetscErrorCode MatIJBinMap(Mat,Mat, MatIJIndexType,PetscInt,const PetscInt*,const PetscInt*,const PetscScalar*,MatIJIndexType,PetscInt*,PetscInt**,PetscInt**,PetscScalar**,PetscInt**);
1798 
1799 PETSC_EXTERN_CXX_END
1800 #endif
1801