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