xref: /petsc/include/petscmat.h (revision bce096a405b23f07feb1783633a56a7a90eceb89)
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 /*E
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
28 E*/
29 #define MATSAME            "same"
30 #define MATSEQMAIJ         "seqmaij"
31 #define MATMPIMAIJ         "mpimaij"
32 #define MATMAIJ            "maij"
33 #define MATIS              "is"
34 #define MATMPIROWBS        "mpirowbs"
35 #define MATSEQAIJ          "seqaij"
36 #define MATMPIAIJ          "mpiaij"
37 #define MATAIJ             "aij"
38 #define MATSHELL           "shell"
39 #define MATSEQBDIAG        "seqbdiag"
40 #define MATMPIBDIAG        "mpibdiag"
41 #define MATBDIAG           "bdiag"
42 #define MATSEQDENSE        "seqdense"
43 #define MATMPIDENSE        "mpidense"
44 #define MATDENSE           "dense"
45 #define MATSEQBAIJ         "seqbaij"
46 #define MATMPIBAIJ         "mpibaij"
47 #define MATBAIJ            "baij"
48 #define MATMPIADJ          "mpiadj"
49 #define MATSEQSBAIJ        "seqsbaij"
50 #define MATMPISBAIJ        "mpisbaij"
51 #define MATSBAIJ           "sbaij"
52 #define MATDAAD            "daad"
53 #define MATMFFD            "mffd"
54 #define MATNORMAL          "normal"
55 #define MATLRC             "lrc"
56 #define MATSEQAIJSPOOLES   "seqaijspooles"
57 #define MATMPIAIJSPOOLES   "mpiaijspooles"
58 #define MATSEQSBAIJSPOOLES "seqsbaijspooles"
59 #define MATMPISBAIJSPOOLES "mpisbaijspooles"
60 #define MATAIJSPOOLES      "aijspooles"
61 #define MATSBAIJSPOOLES    "sbaijspooles"
62 #define MATSUPERLU         "superlu"
63 #define MATSUPERLU_DIST    "superlu_dist"
64 #define MATUMFPACK         "umfpack"
65 #define MATESSL            "essl"
66 #define MATLUSOL           "lusol"
67 #define MATAIJMUMPS        "aijmumps"
68 #define MATSBAIJMUMPS      "sbaijmumps"
69 #define MATDSCPACK         "dscpack"
70 #define MATMATLAB          "matlab"
71 #define MATSEQCSRPERM      "seqcsrperm"
72 #define MATMPICSRPERM      "mpicsrperm"
73 #define MATCSRPERM         "csrperm"
74 #define MatType const char*
75 
76 /* Logging support */
77 #define    MAT_FILE_COOKIE 1211216    /* used to indicate matrices in binary files */
78 extern PetscCookie PETSCMAT_DLLEXPORT MAT_COOKIE;
79 extern PetscCookie PETSCMAT_DLLEXPORT MAT_FDCOLORING_COOKIE;
80 extern PetscCookie PETSCMAT_DLLEXPORT MAT_PARTITIONING_COOKIE;
81 extern PetscCookie PETSCMAT_DLLEXPORT MAT_NULLSPACE_COOKIE;
82 extern PetscEvent  MAT_Mult, MAT_MultMatrixFree, MAT_Mults, MAT_MultConstrained, MAT_MultAdd, MAT_MultTranspose;
83 extern PetscEvent  MAT_MultTransposeConstrained, MAT_MultTransposeAdd, MAT_Solve, MAT_Solves, MAT_SolveAdd, MAT_SolveTranspose;
84 extern PetscEvent  MAT_SolveTransposeAdd, MAT_Relax, MAT_ForwardSolve, MAT_BackwardSolve, MAT_LUFactor, MAT_LUFactorSymbolic;
85 extern PetscEvent  MAT_LUFactorNumeric, MAT_CholeskyFactor, MAT_CholeskyFactorSymbolic, MAT_CholeskyFactorNumeric, MAT_ILUFactor;
86 extern PetscEvent  MAT_ILUFactorSymbolic, MAT_ICCFactorSymbolic, MAT_Copy, MAT_Convert, MAT_Scale, MAT_AssemblyBegin;
87 extern PetscEvent  MAT_AssemblyEnd, MAT_SetValues, MAT_GetValues, MAT_GetRow, MAT_GetSubMatrices, MAT_GetColoring, MAT_GetOrdering;
88 extern PetscEvent  MAT_IncreaseOverlap, MAT_Partitioning, MAT_ZeroEntries, MAT_Load, MAT_View, MAT_AXPY, MAT_FDColoringCreate;
89 extern PetscEvent  MAT_FDColoringApply, MAT_Transpose, MAT_FDColoringFunction;
90 extern PetscEvent  MAT_MatMult, MAT_MatMultSymbolic, MAT_MatMultNumeric;
91 extern PetscEvent  MAT_PtAP, MAT_PtAPSymbolic, MAT_PtAPNumeric;
92 extern PetscEvent  MAT_MatMultTranspose, MAT_MatMultTransposeSymbolic, MAT_MatMultTransposeNumeric;
93 
94 /*E
95     MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
96      or MatGetSubMatrix() are to be reused to store the new matrix values.
97 
98     Level: beginner
99 
100    Any additions/changes here MUST also be made in include/finclude/petscmat.h
101 
102 .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
103 E*/
104 typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX} MatReuse;
105 
106 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(char *);
107 
108 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreate(MPI_Comm,Mat*);
109 PetscPolymorphicFunction(MatCreate,(MPI_Comm comm,void *ctx),(comm,&A),Mat,A)
110 PetscPolymorphicFunction(MatCreate,(void *ctx),(PETSC_COMM_WORLD,&A),Mat,A)
111 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
112 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat,MatType);
113 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetFromOptions(Mat);
114 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUpPreallocation(Mat);
115 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]);
116 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat));
117 
118 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOptionsPrefix(Mat,const char[]);
119 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAppendOptionsPrefix(Mat,const char[]);
120 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOptionsPrefix(Mat,const char*[]);
121 
122 /*MC
123    MatRegisterDynamic - Adds a new matrix type
124 
125    Synopsis:
126    PetscErrorCode MatRegisterDynamic(char *name,char *path,char *name_create,PetscErrorCode (*routine_create)(Mat))
127 
128    Not Collective
129 
130    Input Parameters:
131 +  name - name of a new user-defined matrix type
132 .  path - path (either absolute or relative) the library containing this solver
133 .  name_create - name of routine to create method context
134 -  routine_create - routine to create method context
135 
136    Notes:
137    MatRegisterDynamic() may be called multiple times to add several user-defined solvers.
138 
139    If dynamic libraries are used, then the fourth input argument (routine_create)
140    is ignored.
141 
142    Sample usage:
143 .vb
144    MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a,
145                "MyMatCreate",MyMatCreate);
146 .ve
147 
148    Then, your solver can be chosen with the procedural interface via
149 $     MatSetType(Mat,"my_mat")
150    or at runtime via the option
151 $     -mat_type my_mat
152 
153    Level: advanced
154 
155    Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
156          If your function is not being put into a shared library then use VecRegister() instead
157 
158 .keywords: Mat, register
159 
160 .seealso: MatRegisterAll(), MatRegisterDestroy()
161 
162 M*/
163 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
164 #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0)
165 #else
166 #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d)
167 #endif
168 
169 extern PetscTruth MatRegisterAllCalled;
170 extern PetscFList MatList;
171 
172 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
173 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
174 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
175 PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A)
176 PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A)
177 PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A)
178 PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A)
179 PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A))
180 PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A))
181 PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A))
182 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
183 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)
184 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)
185 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)
186 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)
187 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))
188 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))
189 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))
190 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)
191 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)
192 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)
193 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)
194 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))
195 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))
196 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))
197 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIRowbs(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
198 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*);
199 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*);
200 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
201 PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A)
202 PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
203 PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
204 PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
205 PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
206 PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
207 PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
208 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
209 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)
210 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)
211 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)
212 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)
213 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))
214 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))
215 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))
216 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)
217 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)
218 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)
219 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)
220 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))
221 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))
222 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))
223 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
224 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
225 PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A)
226 PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
227 PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
228 PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
229 PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
230 PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
231 PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
232 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
233 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)
234 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)
235 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)
236 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)
237 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))
238 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))
239 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))
240 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)
241 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)
242 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)
243 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)
244 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))
245 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))
246 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))
247 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
248 PetscPolymorphicFunction(MatCreateShell,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(comm,m,n,M,N,ctx,&A),Mat,A)
249 PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A)
250 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*);
251 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateNormal(Mat,Mat*);
252 PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A)
253 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateLRC(Mat,Mat,Mat,Mat*);
254 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUp(Mat);
255 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat);
256 
257 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPrintHelp(Mat);
258 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetPetscMaps(Mat,PetscMap*,PetscMap*);
259 
260 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat);
261 /* ------------------------------------------------------------*/
262 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
263 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
264 
265 /*S
266      MatStencil - Data structure (C struct) for storing information about a single row or
267         column of a matrix as index on an associated grid.
268 
269    Level: beginner
270 
271   Concepts: matrix; linear operator
272 
273 .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil()
274 S*/
275 typedef struct {
276   PetscInt k,j,i,c;
277 } MatStencil;
278 
279 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
280 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
281 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
282 
283 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat,ISColoring);
284 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat,void*);
285 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat,PetscInt,void*);
286 
287 /*E
288     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
289      to continue to add values to it
290 
291     Level: beginner
292 
293 .seealso: MatAssemblyBegin(), MatAssemblyEnd()
294 E*/
295 typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
296 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat,MatAssemblyType);
297 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat,MatAssemblyType);
298 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat,PetscTruth*);
299 
300 extern PETSCMAT_DLLEXPORT PetscInt    MatSetValue_Row;
301 extern PETSCMAT_DLLEXPORT PetscInt    MatSetValue_Column;
302 extern PETSCMAT_DLLEXPORT PetscScalar MatSetValue_Value;
303 
304 /*MC
305    MatSetValue - Set a single entry into a matrix.
306 
307    Synopsis:
308    PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode);
309 
310    Not collective
311 
312    Input Parameters:
313 +  m - the matrix
314 .  row - the row location of the entry
315 .  col - the column location of the entry
316 .  value - the value to insert
317 -  mode - either INSERT_VALUES or ADD_VALUES
318 
319    Notes:
320    For efficiency one should use MatSetValues() and set several or many
321    values simultaneously if possible.
322 
323    Level: beginner
324 
325 .seealso: MatSetValues(), MatSetValueLocal()
326 M*/
327 #define MatSetValue(v,i,j,va,mode) \
328   ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \
329    MatSetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode))
330 
331 #define MatGetValue(v,i,j,va) \
332   ((MatSetValue_Row = i,MatSetValue_Column = j,0) || \
333    MatGetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&va))
334 
335 #define MatSetValueLocal(v,i,j,va,mode) \
336   ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \
337    MatSetValuesLocal(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode))
338 
339 /*E
340     MatOption - Options that may be set for a matrix and its behavior or storage
341 
342     Level: beginner
343 
344    Any additions/changes here MUST also be made in include/finclude/petscmat.h
345 
346 .seealso: MatSetOption()
347 E*/
348 typedef enum {MAT_ROW_ORIENTED=1,MAT_COLUMN_ORIENTED=2,MAT_ROWS_SORTED=4,
349               MAT_COLUMNS_SORTED=8,MAT_NO_NEW_NONZERO_LOCATIONS=16,
350               MAT_YES_NEW_NONZERO_LOCATIONS=32,MAT_SYMMETRIC=64,
351               MAT_STRUCTURALLY_SYMMETRIC=65,MAT_NO_NEW_DIAGONALS=66,
352               MAT_YES_NEW_DIAGONALS=67,MAT_INODE_LIMIT_1=68,MAT_INODE_LIMIT_2=69,
353               MAT_INODE_LIMIT_3=70,MAT_INODE_LIMIT_4=71,MAT_INODE_LIMIT_5=72,
354               MAT_IGNORE_OFF_PROC_ENTRIES=73,MAT_ROWS_UNSORTED=74,
355               MAT_COLUMNS_UNSORTED=75,MAT_NEW_NONZERO_LOCATION_ERR=76,
356               MAT_NEW_NONZERO_ALLOCATION_ERR=77,MAT_USE_HASH_TABLE=78,
357               MAT_KEEP_ZEROED_ROWS=79,MAT_IGNORE_ZERO_ENTRIES=80,MAT_USE_INODES=81,
358               MAT_DO_NOT_USE_INODES=82,MAT_NOT_SYMMETRIC=83,MAT_HERMITIAN=84,
359               MAT_NOT_STRUCTURALLY_SYMMETRIC=85,MAT_NOT_HERMITIAN=86,
360               MAT_SYMMETRY_ETERNAL=87,MAT_NOT_SYMMETRY_ETERNAL=88,
361               MAT_USE_COMPRESSEDROW=89,MAT_DO_NOT_USE_COMPRESSEDROW=90,
362               MAT_IGNORE_LOWER_TRIANGULAR=91,MAT_ERROR_LOWER_TRIANGULAR=92} MatOption;
363 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption);
364 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,MatType*);
365 PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),MatType,t)
366 
367 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
368 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
369 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
370 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
371 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
372 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt);
373 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]);
374 PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a)
375 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]);
376 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *);
377 PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a)
378 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt);
379 
380 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec);
381 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec);
382 PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
383 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec);
384 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*);
385 PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t)
386 PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0.0,&t),PetscTruth,t)
387 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec);
388 PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
389 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec);
390 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec);
391 
392 /*E
393     MatDuplicateOption - Indicates if a duplicated sparse matrix should have
394   its numerical values copied over or just its nonzero structure.
395 
396     Level: beginner
397 
398    Any additions/changes here MUST also be made in include/finclude/petscmat.h
399 
400 .seealso: MatDuplicate()
401 E*/
402 typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES} MatDuplicateOption;
403 
404 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegister(const char[],const char[],const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat*));
405 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
406 #define MatConvertRegisterDynamic(a,b,c,d) MatConvertRegister(a,b,c,0)
407 #else
408 #define MatConvertRegisterDynamic(a,b,c,d) MatConvertRegister(a,b,c,d)
409 #endif
410 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegisterAll(const char[]);
411 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegisterDestroy(void);
412 extern PetscTruth MatConvertRegisterAllCalled;
413 extern PetscFList MatConvertList;
414 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat,MatType,MatReuse,Mat*);
415 PetscPolymorphicFunction(MatConvert,(Mat A,MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a)
416 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat,MatDuplicateOption,Mat*);
417 PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a)
418 PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a)
419 
420 /*E
421     MatStructure - Indicates if the matrix has the same nonzero structure
422 
423     Level: beginner
424 
425    Any additions/changes here MUST also be made in include/finclude/petscmat.h
426 
427 .seealso: MatCopy(), KSPSetOperators(), PCSetOperators()
428 E*/
429 typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure;
430 
431 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat,Mat,MatStructure);
432 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat,PetscViewer);
433 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat,PetscReal,PetscTruth*);
434 PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t)
435 PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0.0,&t),PetscTruth,t)
436 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscTruth*);
437 PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t)
438 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscTruth*);
439 PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,&t),PetscTruth,t)
440 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*);
441 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*);
442 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoad(PetscViewer,MatType,Mat*);
443 PetscPolymorphicFunction(MatLoad,(PetscViewer v,MatType t),(v,t,&a),Mat,a)
444 
445 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
446 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
447 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
448 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
449 
450 /*S
451      MatInfo - Context of matrix information, used with MatGetInfo()
452 
453    In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
454 
455    Level: intermediate
456 
457   Concepts: matrix^nonzero information
458 
459 .seealso:  MatGetInfo(), MatInfoType
460 S*/
461 typedef struct {
462   PetscLogDouble rows_global,columns_global;         /* number of global rows and columns */
463   PetscLogDouble rows_local,columns_local;           /* number of local rows and columns */
464   PetscLogDouble block_size;                         /* block size */
465   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
466   PetscLogDouble memory;                             /* memory allocated */
467   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
468   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
469   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
470   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
471 } MatInfo;
472 
473 /*E
474     MatInfoType - Indicates if you want information about the local part of the matrix,
475      the entire parallel matrix or the maximum over all the local parts.
476 
477     Level: beginner
478 
479    Any additions/changes here MUST also be made in include/finclude/petscmat.h
480 
481 .seealso: MatGetInfo(), MatInfo
482 E*/
483 typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
484 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat,MatInfoType,MatInfo*);
485 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatValid(Mat,PetscTruth*);
486 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat,Vec);
487 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec);
488 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,Mat*);
489 PetscPolymorphicFunction(MatTranspose,(Mat A),(A,&t),Mat,t)
490 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *);
491 PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t)
492 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *);
493 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec);
494 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode);
495 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscTruth*);
496 PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t)
497 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscTruth*);
498 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*);
499 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*);
500 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*);
501 
502 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *);
503 PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n)
504 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat);
505 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar);
506 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar);
507 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*);
508 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumnsIS(Mat,IS,const PetscScalar*);
509 
510 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscTruth);
511 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec);
512 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec);
513 
514 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*);
515 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*);
516 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
517 
518 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
519 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]);
520 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,PetscInt,MatReuse,Mat *);
521 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
522 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
523 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
524 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat);
525 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat);
526 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*);
527 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
528 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*);
529 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscScalar**,Mat*);
530 
531 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
532 
533 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
534 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
535 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat);
536 
537 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
538 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
539 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat);
540 
541 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*);
542 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*);
543 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat);
544 
545 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure);
546 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat);
547 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompress(Mat);
548 
549 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar);
550 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar);
551 
552 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping);
553 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping);
554 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar);
555 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar);
556 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
557 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
558 
559 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt);
560 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
561 
562 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec);
563 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec);
564 PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
565 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec);
566 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*);
567 
568 /*MC
569    MatPreallocInitialize - Begins the block of code that will count the number of nonzeros per
570        row in a matrix providing the data that one can use to correctly preallocate the matrix.
571 
572    Synopsis:
573    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
574 
575    Collective on MPI_Comm
576 
577    Input Parameters:
578 +  comm - the communicator that will share the eventually allocated matrix
579 .  nrows - the number of LOCAL rows in the matrix
580 -  ncols - the number of LOCAL columns in the matrix
581 
582    Output Parameters:
583 +  dnz - the array that will be passed to the matrix preallocation routines
584 -  ozn - the other array passed to the matrix preallocation routines
585 
586 
587    Level: intermediate
588 
589    Notes:
590    See the chapter in the users manual on performance for more details
591 
592    Do not malloc or free dnz and onz, that is handled internally by these routines
593 
594    Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
595 
596   Concepts: preallocation^Matrix
597 
598 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
599           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
600 M*/
601 #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
602 { \
603   PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
604   _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\
605   _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\
606   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
607   _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp;
608 
609 /*MC
610    MatPreallocSymmetricInitialize - Begins the block of code that will count the number of nonzeros per
611        row in a matrix providing the data that one can use to correctly preallocate the matrix.
612 
613    Synopsis:
614    PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
615 
616    Collective on MPI_Comm
617 
618    Input Parameters:
619 +  comm - the communicator that will share the eventually allocated matrix
620 .  nrows - the number of LOCAL rows in the matrix
621 -  ncols - the number of LOCAL columns in the matrix
622 
623    Output Parameters:
624 +  dnz - the array that will be passed to the matrix preallocation routines
625 -  ozn - the other array passed to the matrix preallocation routines
626 
627 
628    Level: intermediate
629 
630    Notes:
631    See the chapter in the users manual on performance for more details
632 
633    Do not malloc or free dnz and onz, that is handled internally by these routines
634 
635   Concepts: preallocation^Matrix
636 
637 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
638           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
639 M*/
640 #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \
641 { \
642   PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__end; \
643   _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\
644   _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\
645   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\
646   _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp;
647 
648 /*MC
649    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
650        inserted using a local number of the rows and columns
651 
652    Synopsis:
653    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
654 
655    Not Collective
656 
657    Input Parameters:
658 +  map - the mapping between local numbering and global numbering
659 .  nrows - the number of rows indicated
660 .  rows - the indices of the rows
661 .  ncols - the number of columns in the matrix
662 .  cols - the columns indicated
663 .  dnz - the array that will be passed to the matrix preallocation routines
664 -  ozn - the other array passed to the matrix preallocation routines
665 
666 
667    Level: intermediate
668 
669    Notes:
670    See the chapter in the users manual on performance for more details
671 
672    Do not malloc or free dnz and onz, that is handled internally by these routines
673 
674   Concepts: preallocation^Matrix
675 
676 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
677           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
678 M*/
679 #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
680 {\
681   PetscInt __l;\
682   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
683   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
684   for (__l=0;__l<nrows;__l++) {\
685     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
686   }\
687 }
688 
689 /*MC
690    MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
691        inserted using a local number of the rows and columns
692 
693    Synopsis:
694    PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
695 
696    Not Collective
697 
698    Input Parameters:
699 +  map - the mapping between local numbering and global numbering
700 .  nrows - the number of rows indicated
701 .  rows - the indices of the rows
702 .  ncols - the number of columns in the matrix
703 .  cols - the columns indicated
704 .  dnz - the array that will be passed to the matrix preallocation routines
705 -  ozn - the other array passed to the matrix preallocation routines
706 
707 
708    Level: intermediate
709 
710    Notes:
711    See the chapter in the users manual on performance for more details
712 
713    Do not malloc or free dnz and onz that is handled internally by these routines
714 
715   Concepts: preallocation^Matrix
716 
717 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
718           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
719 M*/
720 #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
721 {\
722   PetscInt __l;\
723   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
724   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
725   for (__l=0;__l<nrows;__l++) {\
726     _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
727   }\
728 }
729 
730 /*MC
731    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
732        inserted using a local number of the rows and columns
733 
734    Synopsis:
735    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
736 
737    Not Collective
738 
739    Input Parameters:
740 +  nrows - the number of rows indicated
741 .  rows - the indices of the rows
742 .  ncols - the number of columns in the matrix
743 -  cols - the columns indicated
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 chapter in the users manual on performance for more details
754 
755    Do not malloc or free dnz and onz that is handled internally by these routines
756 
757   Concepts: preallocation^Matrix
758 
759 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
760           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
761 M*/
762 #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
763 { PetscInt __i; \
764   for (__i=0; __i<nc; __i++) {\
765     if (cols[__i] < __start || cols[__i] >= __end) onz[row - __rstart]++; \
766   }\
767   dnz[row - __rstart] = nc - onz[row - __rstart];\
768 }
769 
770 /*MC
771    MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
772        inserted using a local number of the rows and columns
773 
774    Synopsis:
775    PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
776 
777    Not Collective
778 
779    Input Parameters:
780 +  nrows - the number of rows indicated
781 .  rows - the indices of the rows
782 .  ncols - the number of columns in the matrix
783 .  cols - the columns indicated
784 .  dnz - the array that will be passed to the matrix preallocation routines
785 -  ozn - the other array passed to the matrix preallocation routines
786 
787 
788    Level: intermediate
789 
790    Notes:
791    See the chapter in the users manual on performance for more details
792 
793    Do not malloc or free dnz and onz that is handled internally by these routines
794 
795   Concepts: preallocation^Matrix
796 
797 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
798           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
799 M*/
800 #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
801 { PetscInt __i; \
802   for (__i=0; __i<nc; __i++) {\
803     if (cols[__i] >= __end) onz[row - __rstart]++; \
804     else if (cols[__i] >= row) dnz[row - __rstart]++;\
805   }\
806 }
807 
808 /*MC
809    MatPreallocFinalize - Ends the block of code that will count the number of nonzeros per
810        row in a matrix providing the data that one can use to correctly preallocate the matrix.
811 
812    Synopsis:
813    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
814 
815    Collective on MPI_Comm
816 
817    Input Parameters:
818 +  dnz - the array that will be passed to the matrix preallocation routines
819 -  ozn - the other array passed to the matrix preallocation routines
820 
821 
822    Level: intermediate
823 
824    Notes:
825    See the chapter in the users manual on performance for more details
826 
827    Do not malloc or free dnz and onz that is handled internally by these routines
828 
829   Concepts: preallocation^Matrix
830 
831 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
832           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
833 M*/
834 #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree(dnz);CHKERRQ(_4_ierr);}
835 
836 
837 
838 /* Routines unique to particular data structures */
839 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **);
840 PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t)
841 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBDiagGetData(Mat,PetscInt*,PetscInt*,PetscInt*[],PetscInt*[],PetscScalar***);
842 
843 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*);
844 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
845 
846 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
847 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
848 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
849 
850 #define MAT_SKIP_ALLOCATION -4
851 
852 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
853 PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
854 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
855 PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
856 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
857 PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz))
858 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDensePreallocation(Mat,PetscScalar[]);
859 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]);
860 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
861 
862 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
863 PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz))
864 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
865 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
866 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
867 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
868 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDensePreallocation(Mat,PetscScalar[]);
869 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]);
870 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
871 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
872 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsSetPreallocation(Mat,PetscInt,const PetscInt[]);
873 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
874 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
875 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void));
876 
877 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt);
878 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDenseGetLocalMatrix(Mat,Mat*);
879 
880 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat);
881 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat);
882 
883 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*);
884 
885 /*
886   These routines are not usually accessed directly, rather solving is
887   done through the KSP and PC interfaces.
888 */
889 
890 /*E
891     MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
892        with an optional dynamic library name, for example
893        http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
894 
895    Level: beginner
896 
897 .seealso: MatGetOrdering()
898 E*/
899 #define MatOrderingType char*
900 #define MATORDERING_NATURAL   "natural"
901 #define MATORDERING_ND        "nd"
902 #define MATORDERING_1WD       "1wd"
903 #define MATORDERING_RCM       "rcm"
904 #define MATORDERING_QMD       "qmd"
905 #define MATORDERING_ROWLENGTH "rowlength"
906 #define MATORDERING_DSC_ND    "dsc_nd"
907 #define MATORDERING_DSC_MMD   "dsc_mmd"
908 #define MATORDERING_DSC_MDF   "dsc_mdf"
909 #define MATORDERING_CONSTRAINED "constrained"
910 #define MATORDERING_IDENTITY  "identity"
911 #define MATORDERING_REVERSE   "reverse"
912 
913 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
914 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list);
915 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));
916 
917 /*MC
918    MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the
919                                matrix package.
920 
921    Synopsis:
922    PetscErrorCode MatOrderingRegisterDynamic(char *name_ordering,char *path,char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
923 
924    Not Collective
925 
926    Input Parameters:
927 +  sname - name of ordering (for example MATORDERING_ND)
928 .  path - location of library where creation routine is
929 .  name - name of function that creates the ordering type,a string
930 -  function - function pointer that creates the ordering
931 
932    Level: developer
933 
934    If dynamic libraries are used, then the fourth input argument (function)
935    is ignored.
936 
937    Sample usage:
938 .vb
939    MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
940                "MyOrder",MyOrder);
941 .ve
942 
943    Then, your partitioner can be chosen with the procedural interface via
944 $     MatOrderingSetType(part,"my_order)
945    or at runtime via the option
946 $     -pc_ilu_mat_ordering_type my_order
947 $     -pc_lu_mat_ordering_type my_order
948 
949    ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
950 
951 .keywords: matrix, ordering, register
952 
953 .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
954 M*/
955 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
956 #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
957 #else
958 #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
959 #endif
960 
961 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void);
962 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]);
963 extern PetscTruth MatOrderingRegisterAllCalled;
964 extern PetscFList MatOrderingList;
965 
966 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
967 
968 /*S
969    MatFactorInfo - Data based into the matrix factorization routines
970 
971    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE
972 
973    Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
974 
975    Level: developer
976 
977 .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
978           MatFactorInfoInitialize()
979 
980 S*/
981 typedef struct {
982   PetscReal     shiftnz;        /* scaling of identity added to matrix to prevent zero pivots */
983   PetscTruth    shiftpd;         /* if true, shift until positive pivots */
984   PetscReal     shift_fraction; /* record shift fraction taken */
985   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
986   PetscReal     dt;             /* drop tolerance */
987   PetscReal     dtcol;          /* tolerance for pivoting */
988   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
989   PetscReal     fill;           /* expected fill; nonzeros in factored matrix/nonzeros in original matrix*/
990   PetscReal     levels;         /* ICC/ILU(levels) */
991   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
992                                    factorization may be faster if do not pivot */
993   PetscReal     zeropivot;      /* pivot is called zero if less than this */
994 } MatFactorInfo;
995 
996 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*);
997 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,MatFactorInfo*);
998 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*);
999 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,MatFactorInfo*,Mat*);
1000 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,MatFactorInfo*);
1001 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,MatFactorInfo*);
1002 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*);
1003 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*);
1004 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*);
1005 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,MatFactorInfo*);
1006 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,MatFactorInfo*,Mat*);
1007 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactor(Mat,IS,IS,MatFactorInfo*,Mat *);
1008 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1009 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec);
1010 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec);
1011 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec);
1012 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec);
1013 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec);
1014 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1015 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs);
1016 
1017 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat);
1018 
1019 /*E
1020     MatSORType - What type of (S)SOR to perform
1021 
1022     Level: beginner
1023 
1024    May be bitwise ORd together
1025 
1026    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1027 
1028    MatSORType may be bitwise ORd together, so do not change the numbers
1029 
1030 .seealso: MatRelax(), MatPBRelax()
1031 E*/
1032 typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1033               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1034               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
1035               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1036 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1037 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPBRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1038 
1039 /*
1040     These routines are for efficiently computing Jacobians via finite differences.
1041 */
1042 
1043 /*E
1044     MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1045        with an optional dynamic library name, for example
1046        http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1047 
1048    Level: beginner
1049 
1050 .seealso: MatGetColoring()
1051 E*/
1052 #define MatColoringType char*
1053 #define MATCOLORING_NATURAL "natural"
1054 #define MATCOLORING_SL      "sl"
1055 #define MATCOLORING_LF      "lf"
1056 #define MATCOLORING_ID      "id"
1057 
1058 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,const MatColoringType,ISColoring*);
1059 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatColoringType,ISColoring *));
1060 
1061 /*MC
1062    MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
1063                                matrix package.
1064 
1065    Synopsis:
1066    PetscErrorCode MatColoringRegisterDynamic(char *name_coloring,char *path,char *name_create,PetscErrorCode (*routine_create)(MatColoring))
1067 
1068    Not Collective
1069 
1070    Input Parameters:
1071 +  sname - name of Coloring (for example MATCOLORING_SL)
1072 .  path - location of library where creation routine is
1073 .  name - name of function that creates the Coloring type, a string
1074 -  function - function pointer that creates the coloring
1075 
1076    Level: developer
1077 
1078    If dynamic libraries are used, then the fourth input argument (function)
1079    is ignored.
1080 
1081    Sample usage:
1082 .vb
1083    MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
1084                "MyColor",MyColor);
1085 .ve
1086 
1087    Then, your partitioner can be chosen with the procedural interface via
1088 $     MatColoringSetType(part,"my_color")
1089    or at runtime via the option
1090 $     -mat_coloring_type my_color
1091 
1092    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
1093 
1094 .keywords: matrix, Coloring, register
1095 
1096 .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
1097 M*/
1098 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1099 #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1100 #else
1101 #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1102 #endif
1103 
1104 extern PetscTruth MatColoringRegisterAllCalled;
1105 
1106 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]);
1107 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void);
1108 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1109 
1110 /*S
1111      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1112         and coloring
1113 
1114    Level: beginner
1115 
1116   Concepts: coloring, sparse Jacobian, finite differences
1117 
1118 .seealso:  MatFDColoringCreate()
1119 S*/
1120 typedef struct _p_MatFDColoring *MatFDColoring;
1121 
1122 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1123 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring);
1124 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer);
1125 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1126 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1127 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFrequency(MatFDColoring,PetscInt);
1128 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFrequency(MatFDColoring,PetscInt*);
1129 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring);
1130 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1131 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *);
1132 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetRecompute(MatFDColoring);
1133 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec);
1134 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1135 /*
1136     These routines are for partitioning matrices: currently used only
1137   for adjacency matrix, MatCreateMPIAdj().
1138 */
1139 
1140 /*S
1141      MatPartitioning - Object for managing the partitioning of a matrix or graph
1142 
1143    Level: beginner
1144 
1145   Concepts: partitioning
1146 
1147 .seealso:  MatPartitioningCreate(), MatPartitioningType
1148 S*/
1149 typedef struct _p_MatPartitioning *MatPartitioning;
1150 
1151 /*E
1152     MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1153        with an optional dynamic library name, for example
1154        http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1155 
1156    Level: beginner
1157 
1158 .seealso: MatPartitioningCreate(), MatPartitioning
1159 E*/
1160 #define MatPartitioningType char*
1161 #define MAT_PARTITIONING_CURRENT  "current"
1162 #define MAT_PARTITIONING_SQUARE   "square"
1163 #define MAT_PARTITIONING_PARMETIS "parmetis"
1164 #define MAT_PARTITIONING_CHACO    "chaco"
1165 #define MAT_PARTITIONING_JOSTLE   "jostle"
1166 #define MAT_PARTITIONING_PARTY    "party"
1167 #define MAT_PARTITIONING_SCOTCH   "scotch"
1168 
1169 
1170 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1171 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,const MatPartitioningType);
1172 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt);
1173 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat);
1174 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1175 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1176 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*);
1177 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning);
1178 
1179 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
1180 
1181 /*MC
1182    MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
1183    matrix package.
1184 
1185    Synopsis:
1186    PetscErrorCode MatPartitioningRegisterDynamic(char *name_partitioning,char *path,char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
1187 
1188    Not Collective
1189 
1190    Input Parameters:
1191 +  sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis
1192 .  path - location of library where creation routine is
1193 .  name - name of function that creates the partitioning type, a string
1194 -  function - function pointer that creates the partitioning type
1195 
1196    Level: developer
1197 
1198    If dynamic libraries are used, then the fourth input argument (function)
1199    is ignored.
1200 
1201    Sample usage:
1202 .vb
1203    MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
1204                "MyPartCreate",MyPartCreate);
1205 .ve
1206 
1207    Then, your partitioner can be chosen with the procedural interface via
1208 $     MatPartitioningSetType(part,"my_part")
1209    or at runtime via the option
1210 $     -mat_partitioning_type my_part
1211 
1212    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
1213 
1214 .keywords: matrix, partitioning, register
1215 
1216 .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
1217 M*/
1218 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1219 #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
1220 #else
1221 #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
1222 #endif
1223 
1224 extern PetscTruth MatPartitioningRegisterAllCalled;
1225 
1226 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]);
1227 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void);
1228 
1229 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer);
1230 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning);
1231 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,MatPartitioningType*);
1232 
1233 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1234 
1235 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal);
1236 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning);
1237 
1238 typedef enum { MP_CHACO_MULTILEVEL_KL, MP_CHACO_SPECTRAL, MP_CHACO_LINEAR,
1239     MP_CHACO_RANDOM, MP_CHACO_SCATTERED } MPChacoGlobalType;
1240 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
1241 typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType;
1242 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1243 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
1244 typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType;
1245 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1246 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1247 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
1248 
1249 #define MP_PARTY_OPT "opt"
1250 #define MP_PARTY_LIN "lin"
1251 #define MP_PARTY_SCA "sca"
1252 #define MP_PARTY_RAN "ran"
1253 #define MP_PARTY_GBF "gbf"
1254 #define MP_PARTY_GCF "gcf"
1255 #define MP_PARTY_BUB "bub"
1256 #define MP_PARTY_DEF "def"
1257 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*);
1258 #define MP_PARTY_HELPFUL_SETS "hs"
1259 #define MP_PARTY_KERNIGHAN_LIN "kl"
1260 #define MP_PARTY_NONE "no"
1261 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*);
1262 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1263 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscTruth);
1264 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth);
1265 
1266 typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType;
1267 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*);
1268 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning);
1269 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType);
1270 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal);
1271 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*);
1272 typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType;
1273 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType);
1274 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning);
1275 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*);
1276 
1277 /*
1278     If you add entries here you must also add them to finclude/petscmat.h
1279 */
1280 typedef enum { MATOP_SET_VALUES=0,
1281                MATOP_GET_ROW=1,
1282                MATOP_RESTORE_ROW=2,
1283                MATOP_MULT=3,
1284                MATOP_MULT_ADD=4,
1285                MATOP_MULT_TRANSPOSE=5,
1286                MATOP_MULT_TRANSPOSE_ADD=6,
1287                MATOP_SOLVE=7,
1288                MATOP_SOLVE_ADD=8,
1289                MATOP_SOLVE_TRANSPOSE=9,
1290                MATOP_SOLVE_TRANSPOSE_ADD=10,
1291                MATOP_LUFACTOR=11,
1292                MATOP_CHOLESKYFACTOR=12,
1293                MATOP_RELAX=13,
1294                MATOP_TRANSPOSE=14,
1295                MATOP_GETINFO=15,
1296                MATOP_EQUAL=16,
1297                MATOP_GET_DIAGONAL=17,
1298                MATOP_DIAGONAL_SCALE=18,
1299                MATOP_NORM=19,
1300                MATOP_ASSEMBLY_BEGIN=20,
1301                MATOP_ASSEMBLY_END=21,
1302                MATOP_COMPRESS=22,
1303                MATOP_SET_OPTION=23,
1304                MATOP_ZERO_ENTRIES=24,
1305                MATOP_ZERO_ROWS=25,
1306                MATOP_LUFACTOR_SYMBOLIC=26,
1307                MATOP_LUFACTOR_NUMERIC=27,
1308                MATOP_CHOLESKY_FACTOR_SYMBOLIC=28,
1309                MATOP_CHOLESKY_FACTOR_NUMERIC=29,
1310                MATOP_SETUP_PREALLOCATION=30,
1311                MATOP_ILUFACTOR_SYMBOLIC=31,
1312                MATOP_ICCFACTOR_SYMBOLIC=32,
1313                MATOP_GET_ARRAY=33,
1314                MATOP_RESTORE_ARRAY=34,
1315                MATOP_DUPLCIATE=35,
1316                MATOP_FORWARD_SOLVE=36,
1317                MATOP_BACKWARD_SOLVE=37,
1318                MATOP_ILUFACTOR=38,
1319                MATOP_ICCFACTOR=39,
1320                MATOP_AXPY=40,
1321                MATOP_GET_SUBMATRICES=41,
1322                MATOP_INCREASE_OVERLAP=42,
1323                MATOP_GET_VALUES=43,
1324                MATOP_COPY=44,
1325                MATOP_PRINT_HELP=45,
1326                MATOP_SCALE=46,
1327                MATOP_SHIFT=47,
1328                MATOP_DIAGONAL_SHIFT=48,
1329                MATOP_ILUDT_FACTOR=49,
1330                MATOP_GET_BLOCK_SIZE=50,
1331                MATOP_GET_ROW_IJ=51,
1332                MATOP_RESTORE_ROW_IJ=52,
1333                MATOP_GET_COLUMN_IJ=53,
1334                MATOP_RESTORE_COLUMN_IJ=54,
1335                MATOP_FDCOLORING_CREATE=55,
1336                MATOP_COLORING_PATCH=56,
1337                MATOP_SET_UNFACTORED=57,
1338                MATOP_PERMUTE=58,
1339                MATOP_SET_VALUES_BLOCKED=59,
1340                MATOP_GET_SUBMATRIX=60,
1341                MATOP_DESTROY=61,
1342                MATOP_VIEW=62,
1343                MATOP_GET_MAPS=63,
1344                MATOP_USE_SCALED_FORM=64,
1345                MATOP_SCALE_SYSTEM=65,
1346                MATOP_UNSCALE_SYSTEM=66,
1347                MATOP_SET_LOCAL_TO_GLOBAL_MAP=67,
1348                MATOP_SET_VALUES_LOCAL=68,
1349                MATOP_ZERO_ROWS_LOCAL=69,
1350                MATOP_GET_ROW_MAX=70,
1351                MATOP_CONVERT=71,
1352                MATOP_SET_COLORING=72,
1353                MATOP_SET_VALUES_ADIC=73,
1354                MATOP_SET_VALUES_ADIFOR=74,
1355                MATOP_FD_COLORING_APPLY=75,
1356                MATOP_SET_FROM_OPTIONS=76,
1357                MATOP_MULT_CON=77,
1358                MATOP_MULT_TRANSPOSE_CON=78,
1359                MATOP_ILU_FACTOR_SYMBOLIC_CON=79,
1360                MATOP_PERMUTE_SPARSIFY=80,
1361                MATOP_MULT_MULTIPLE=81,
1362                MATOP_SOLVE_MULTIPLE=82,
1363                MATOP_GET_INERTIA=83,
1364                MATOP_LOAD=84,
1365                MATOP_IS_SYMMETRIC=85,
1366                MATOP_IS_HERMITIAN=86,
1367                MATOP_IS_STRUCTURALLY_SYMMETRIC=87,
1368                MATOP_PB_RELAX=88,
1369                MATOP_GET_VECS=89,
1370                MATOP_MAT_MULT=90,
1371                MATOP_MAT_MULT_SYMBOLIC=91,
1372                MATOP_MAT_MULT_NUMERIC=92,
1373                MATOP_PTAP=93,
1374                MATOP_PTAP_SYMBOLIC=94,
1375                MATOP_PTAP_NUMERIC=95,
1376                MATOP_MAT_MULTTRANSPOSE=96,
1377                MATOP_MAT_MULTTRANSPOSE_SYMBOLIC=97,
1378                MATOP_MAT_MULTTRANSPOSE_NUMERIC=98,
1379                MATOP_PTAP_SYMBOLIC_SEQAIJ=99,
1380                MATOP_PTAP_NUMERIC_SEQAIJ=100,
1381                MATOP_PTAP_SYMBOLIC_MPIAIJ=101,
1382                MATOP_PTAP_NUMERIC_MPIAIJ=102
1383              } MatOperation;
1384 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscTruth*);
1385 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void));
1386 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void));
1387 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*);
1388 
1389 /*
1390    Codes for matrices stored on disk. By default they are
1391  stored in a universal format. By changing the format with
1392  PetscViewerSetFormat(viewer,PETSC_VIEWER_BINARY_NATIVE); the matrices will
1393  be stored in a way natural for the matrix, for example dense matrices
1394  would be stored as dense. Matrices stored this way may only be
1395  read into matrices of the same time.
1396 */
1397 #define MATRIX_BINARY_FORMAT_DENSE -1
1398 
1399 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1400 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsGetColor(Mat,ISColoring *);
1401 
1402 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*);
1403 
1404 /*S
1405      MatNullSpace - Object that removes a null space from a vector, i.e.
1406          orthogonalizes the vector to a subsapce
1407 
1408    Level: advanced
1409 
1410   Concepts: matrix; linear operator, null space
1411 
1412   Users manual sections:
1413 .   sec_singular
1414 
1415 .seealso:  MatNullSpaceCreate()
1416 S*/
1417 typedef struct _p_MatNullSpace* MatNullSpace;
1418 
1419 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*);
1420 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace);
1421 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1422 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace);
1423 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat);
1424 
1425 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS);
1426 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1427 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
1428 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat);
1429 
1430 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*);
1431 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*);
1432 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*);
1433 
1434 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*);
1435 
1436 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec);
1437 
1438 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1439 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
1440 
1441 PETSC_EXTERN_CXX_END
1442 #endif
1443