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