xref: /petsc/include/petscmat.h (revision 3b224e63a12ff3b822ab8c4a4b7be13110279612)
12eac72dbSBarry Smith /*
22eac72dbSBarry Smith      Include file for the matrix component of PETSc
32eac72dbSBarry Smith */
40a835dfdSSatish Balay #ifndef __PETSCMAT_H
50a835dfdSSatish Balay #define __PETSCMAT_H
60a835dfdSSatish Balay #include "petscvec.h"
7e9fa29b7SSatish Balay PETSC_EXTERN_CXX_BEGIN
82eac72dbSBarry Smith 
9d9274352SBarry Smith /*S
10d9274352SBarry Smith      Mat - Abstract PETSc matrix object
112eac72dbSBarry Smith 
12d91e6319SBarry Smith    Level: beginner
13d91e6319SBarry Smith 
14d9274352SBarry Smith   Concepts: matrix; linear operator
15d9274352SBarry Smith 
16d9274352SBarry Smith .seealso:  MatCreate(), MatType, MatSetType()
17d9274352SBarry Smith S*/
18d9274352SBarry Smith typedef struct _p_Mat*           Mat;
19d9274352SBarry Smith 
20d9274352SBarry Smith /*E
21d9274352SBarry Smith     MatType - String with the name of a PETSc matrix or the creation function
22d9274352SBarry Smith        with an optional dynamic library name, for example
23d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:mymatcreate()
24d9274352SBarry Smith 
25d9274352SBarry Smith    Level: beginner
26d9274352SBarry Smith 
27c7393fdbSBarry Smith .seealso: MatSetType(), Mat, MatSolverPackage
28d91e6319SBarry Smith E*/
29a313700dSBarry Smith #define MatType char*
30273d9f13SBarry Smith #define MATSAME            "same"
31273d9f13SBarry Smith #define MATSEQMAIJ         "seqmaij"
32273d9f13SBarry Smith #define MATMPIMAIJ         "mpimaij"
33209238afSKris Buschelman #define MATMAIJ            "maij"
34273d9f13SBarry Smith #define MATIS              "is"
35273d9f13SBarry Smith #define MATMPIROWBS        "mpirowbs"
36273d9f13SBarry Smith #define MATSEQAIJ          "seqaij"
37273d9f13SBarry Smith #define MATMPIAIJ          "mpiaij"
38209238afSKris Buschelman #define MATAIJ             "aij"
39273d9f13SBarry Smith #define MATSHELL           "shell"
40209238afSKris Buschelman #define MATSEQDENSE        "seqdense"
41273d9f13SBarry Smith #define MATMPIDENSE        "mpidense"
42209238afSKris Buschelman #define MATDENSE           "dense"
43273d9f13SBarry Smith #define MATSEQBAIJ         "seqbaij"
44273d9f13SBarry Smith #define MATMPIBAIJ         "mpibaij"
45209238afSKris Buschelman #define MATBAIJ            "baij"
46273d9f13SBarry Smith #define MATMPIADJ          "mpiadj"
47273d9f13SBarry Smith #define MATSEQSBAIJ        "seqsbaij"
48273d9f13SBarry Smith #define MATMPISBAIJ        "mpisbaij"
49209238afSKris Buschelman #define MATSBAIJ           "sbaij"
50cebc7f6cSBarry Smith #define MATDAAD            "daad"
51cebc7f6cSBarry Smith #define MATMFFD            "mffd"
52c8a8475eSBarry Smith #define MATNORMAL          "normal"
53ab92ecdeSBarry Smith #define MATLRC             "lrc"
544b8d99adSRichard Tran Mills #define MATSEQCSRPERM      "seqcsrperm"
5518def556SRichard Tran Mills #define MATMPICSRPERM      "mpicsrperm"
56814655b8SBarry Smith #define MATCSRPERM         "csrperm"
5781824310SBarry Smith #define MATSEQCRL          "seqcrl"
58c02b24c5SBarry Smith #define MATMPICRL          "mpicrl"
59c02b24c5SBarry Smith #define MATCRL             "crl"
602a6744ebSBarry Smith #define MATSCATTER         "scatter"
61421e10b8SBarry Smith #define MATBLOCKMAT        "blockmat"
62793850ffSBarry Smith #define MATCOMPOSITE       "composite"
635a7f1df3SHong Zhang #define MATSEQFFTW         "seqfftw"
6485e3dda7SBarry Smith #define MATTRANSPOSE       "transpose"
6572ca8751SBarry Smith #define MATSCHURCOMPLEMENT "schurcomplement"
66d91e6319SBarry Smith 
679989ab13SBarry Smith /*E
68c7393fdbSBarry Smith     MatSolverPackage - String with the name of a PETSc matrix solver type.
699989ab13SBarry Smith 
709989ab13SBarry Smith     For example: "petsc" indicates what PETSc provides, "superlu" indicates either
719989ab13SBarry Smith        SuperLU or SuperLU_Dist etc.
729989ab13SBarry Smith 
739989ab13SBarry Smith 
749989ab13SBarry Smith    Level: beginner
759989ab13SBarry Smith 
765c9eb25fSBarry Smith .seealso: MatGetFactor(), Mat, MatSetType(), MatType
779989ab13SBarry Smith E*/
78c7393fdbSBarry Smith #define MatSolverPackage char*
79b24902e0SBarry Smith #define MAT_SOLVER_SPOOLES      "spooles"
80b24902e0SBarry Smith #define MAT_SOLVER_SUPERLU      "superlu"
81b24902e0SBarry Smith #define MAT_SOLVER_SUPERLU_DIST "superlu_dist"
82b24902e0SBarry Smith #define MAT_SOLVER_UMFPACK      "umfpack"
83b24902e0SBarry Smith #define MAT_SOLVER_ESSL         "essl"
84b24902e0SBarry Smith #define MAT_SOLVER_LUSOL        "lusol"
85b24902e0SBarry Smith #define MAT_SOLVER_MUMPS        "mumps"
86b24902e0SBarry Smith #define MAT_SOLVER_DSCPACK      "dscpack"
87b24902e0SBarry Smith #define MAT_SOLVER_MATLAB       "matlab"
8843244d56SBarry Smith #define MAT_SOLVER_PETSC        "petsc"
89b24902e0SBarry Smith 
90b24902e0SBarry Smith /*E
91b24902e0SBarry Smith     MatFactorType - indicates what type of factorization is requested
92b24902e0SBarry Smith 
93b24902e0SBarry Smith     Level: beginner
94b24902e0SBarry Smith 
95b24902e0SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
96b24902e0SBarry Smith 
97c7393fdbSBarry Smith .seealso: MatSolverPackage, MatGetFactor()
98b24902e0SBarry Smith E*/
995c9eb25fSBarry Smith typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC} MatFactorType;
100c7393fdbSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactor(Mat,const MatSolverPackage,MatFactorType,Mat*);
101b24902e0SBarry Smith 
1029989ab13SBarry Smith 
103c06d978dSMatthew Knepley /* Logging support */
104552e946dSBarry Smith #define    MAT_FILE_COOKIE 1211216    /* used to indicate matrices in binary files */
105be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_COOKIE;
106be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_FDCOLORING_COOKIE;
107be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_PARTITIONING_COOKIE;
108be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_NULLSPACE_COOKIE;
109e884886fSBarry Smith extern PetscCookie PETSCMAT_DLLEXPORT MATMFFD_COOKIE;
110c06d978dSMatthew Knepley 
111ceb03754SKris Buschelman /*E
112ceb03754SKris Buschelman     MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
113ceb03754SKris Buschelman      or MatGetSubMatrix() are to be reused to store the new matrix values.
114ceb03754SKris Buschelman 
115ceb03754SKris Buschelman     Level: beginner
116ceb03754SKris Buschelman 
117ceb03754SKris Buschelman    Any additions/changes here MUST also be made in include/finclude/petscmat.h
118ceb03754SKris Buschelman 
1190c451bc4SBarry Smith .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
120ceb03754SKris Buschelman E*/
121ceb03754SKris Buschelman typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX} MatReuse;
122ceb03754SKris Buschelman 
1235494a064SHong Zhang /*E
1245494a064SHong Zhang     MatGetSubMatrixOption - Indicates if matrices obtained from a call to MatGetSubMatrices()
125829201f2SHong Zhang      include the matrix values. Currently it is only used by MatGetSeqNonzerostructure().
1265494a064SHong Zhang 
1275494a064SHong Zhang     Level: beginner
1285494a064SHong Zhang 
129829201f2SHong Zhang .seealso: MatGetSeqNonzerostructure()
1305494a064SHong Zhang E*/
1315494a064SHong Zhang typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatGetSubMatrixOption;
1325494a064SHong Zhang 
133e5bd5246SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(const char[]);
134c06d978dSMatthew Knepley 
135f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreate(MPI_Comm,Mat*);
136a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(MPI_Comm comm),(comm,&A),Mat,A)
137a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(),(PETSC_COMM_WORLD,&A),Mat,A)
138f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
139a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat,const MatType);
140be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetFromOptions(Mat);
141be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUpPreallocation(Mat);
142be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]);
143be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat));
14430de9b25SBarry Smith 
145f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOptionsPrefix(Mat,const char[]);
146f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAppendOptionsPrefix(Mat,const char[]);
147f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOptionsPrefix(Mat,const char*[]);
148f69a0ea3SMatthew Knepley 
14930de9b25SBarry Smith /*MC
15030de9b25SBarry Smith    MatRegisterDynamic - Adds a new matrix type
15130de9b25SBarry Smith 
15230de9b25SBarry Smith    Synopsis:
153c1ac3661SBarry Smith    PetscErrorCode MatRegisterDynamic(char *name,char *path,char *name_create,PetscErrorCode (*routine_create)(Mat))
15430de9b25SBarry Smith 
15530de9b25SBarry Smith    Not Collective
15630de9b25SBarry Smith 
15730de9b25SBarry Smith    Input Parameters:
15830de9b25SBarry Smith +  name - name of a new user-defined matrix type
15930de9b25SBarry Smith .  path - path (either absolute or relative) the library containing this solver
16030de9b25SBarry Smith .  name_create - name of routine to create method context
16130de9b25SBarry Smith -  routine_create - routine to create method context
16230de9b25SBarry Smith 
16330de9b25SBarry Smith    Notes:
16430de9b25SBarry Smith    MatRegisterDynamic() may be called multiple times to add several user-defined solvers.
16530de9b25SBarry Smith 
16630de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
16730de9b25SBarry Smith    is ignored.
16830de9b25SBarry Smith 
16930de9b25SBarry Smith    Sample usage:
17030de9b25SBarry Smith .vb
17130de9b25SBarry Smith    MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a,
17230de9b25SBarry Smith                "MyMatCreate",MyMatCreate);
17330de9b25SBarry Smith .ve
17430de9b25SBarry Smith 
17530de9b25SBarry Smith    Then, your solver can be chosen with the procedural interface via
17630de9b25SBarry Smith $     MatSetType(Mat,"my_mat")
17730de9b25SBarry Smith    or at runtime via the option
17830de9b25SBarry Smith $     -mat_type my_mat
17930de9b25SBarry Smith 
18030de9b25SBarry Smith    Level: advanced
18130de9b25SBarry Smith 
182ab901514SBarry Smith    Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
18330de9b25SBarry Smith          If your function is not being put into a shared library then use VecRegister() instead
18430de9b25SBarry Smith 
18530de9b25SBarry Smith .keywords: Mat, register
18630de9b25SBarry Smith 
18730de9b25SBarry Smith .seealso: MatRegisterAll(), MatRegisterDestroy()
18830de9b25SBarry Smith 
18930de9b25SBarry Smith M*/
190273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
191273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0)
192273d9f13SBarry Smith #else
193273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d)
19430de9b25SBarry Smith #endif
19530de9b25SBarry Smith 
1969c666560SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]);
197273d9f13SBarry Smith extern PetscTruth MatRegisterAllCalled;
198b0a32e0cSBarry Smith extern PetscFList MatList;
19928988994SBarry Smith 
200*3b224e63SBarry Smith /*E
201*3b224e63SBarry Smith     MatStructure - Indicates if the matrix has the same nonzero structure
202*3b224e63SBarry Smith 
203*3b224e63SBarry Smith     Level: beginner
204*3b224e63SBarry Smith 
205*3b224e63SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
206*3b224e63SBarry Smith 
207*3b224e63SBarry Smith .seealso: MatCopy(), KSPSetOperators(), PCSetOperators()
208*3b224e63SBarry Smith E*/
209*3b224e63SBarry Smith typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure;
210*3b224e63SBarry Smith 
211be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
212be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
213be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
214ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A)
215ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A)
216ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A)
217ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A)
218ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A))
219ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A))
220ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A))
221be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
222ba966639SSatish Balay 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)
223ba966639SSatish Balay 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)
224ba966639SSatish Balay 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)
225ba966639SSatish Balay 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)
226ba966639SSatish Balay 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))
227ba966639SSatish Balay 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))
228ba966639SSatish Balay 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))
229ba966639SSatish Balay 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)
230ba966639SSatish Balay 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)
231ba966639SSatish Balay 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)
232ba966639SSatish Balay 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)
233ba966639SSatish Balay 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))
234ba966639SSatish Balay 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))
235ba966639SSatish Balay 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))
23663ab93bfSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
2378d7a6e47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
2388d7a6e47SBarry Smith 
239be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIRowbs(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
240be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
241ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A)
242ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
243ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
244ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
245ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
246ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
247ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
248be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
249ba966639SSatish Balay 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)
250ba966639SSatish Balay 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)
251ba966639SSatish Balay 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)
252ba966639SSatish Balay 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)
253ba966639SSatish Balay 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))
254ba966639SSatish Balay 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))
255ba966639SSatish Balay 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))
256ba966639SSatish Balay 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)
257ba966639SSatish Balay 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)
258ba966639SSatish Balay 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)
259ba966639SSatish Balay 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)
260ba966639SSatish Balay 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))
261ba966639SSatish Balay 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))
262ba966639SSatish Balay 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))
263be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
264be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
265ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A)
266ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
267ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
268ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
269ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
270ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
271ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
272be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
273ba966639SSatish Balay 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)
274ba966639SSatish Balay 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)
275ba966639SSatish Balay 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)
276ba966639SSatish Balay 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)
277ba966639SSatish Balay 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))
278ba966639SSatish Balay 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))
279ba966639SSatish Balay 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))
280ba966639SSatish Balay 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)
281ba966639SSatish Balay 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)
282ba966639SSatish Balay 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)
283ba966639SSatish Balay 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)
284ba966639SSatish Balay 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))
285ba966639SSatish Balay 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))
286ba966639SSatish Balay 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))
287be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
288ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(comm,m,n,M,N,ctx,&A),Mat,A)
289ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A)
290be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*);
291be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateNormal(Mat,Mat*);
292ba966639SSatish Balay PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A)
293ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateLRC(Mat,Mat,Mat,Mat*);
294284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*);
2951472f72bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
2961472f72bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPICRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
2972a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateScatter(MPI_Comm,VecScatter,Mat*);
2982a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterSetVecScatter(Mat,VecScatter);
2992a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterGetVecScatter(Mat,VecScatter*);
3008cdf2d9bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
301793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeAddMat(Mat,Mat);
302b52f573bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeMerge(Mat);
303793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
3045a7f1df3SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqFFTW(MPI_Comm,PetscInt,const PetscInt[],Mat*);
305f20085c4SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateTranspose(Mat,Mat*);
306f20085c4SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSchurComplement(Mat,Mat,Mat,Mat,Mat*);
307*3b224e63SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSchurComplementUpdate(Mat,Mat,Mat,Mat,Mat,MatStructure);
3081472f72bSBarry Smith 
309f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUp(Mat);
310be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat);
31121c89e3eSBarry Smith 
3120c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat);
31399cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRealPart(Mat);
31499cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatImaginaryPart(Mat);
31599cafbc1SBarry Smith 
3168ed539a5SBarry Smith /* ------------------------------------------------------------*/
317be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
318be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
31987d4246cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
320f259bd47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
32184cb2905SBarry Smith 
3222ef4de8bSBarry Smith /*S
3232ef4de8bSBarry Smith      MatStencil - Data structure (C struct) for storing information about a single row or
3242ef4de8bSBarry Smith         column of a matrix as index on an associated grid.
3252ef4de8bSBarry Smith 
3262ef4de8bSBarry Smith    Level: beginner
3272ef4de8bSBarry Smith 
3282ef4de8bSBarry Smith   Concepts: matrix; linear operator
3292ef4de8bSBarry Smith 
330d7bd93baSBarry Smith .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil()
3312ef4de8bSBarry Smith S*/
332435da068SBarry Smith typedef struct {
333c1ac3661SBarry Smith   PetscInt k,j,i,c;
334435da068SBarry Smith } MatStencil;
3352ef4de8bSBarry Smith 
336be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
337be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
338be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
339435da068SBarry Smith 
340be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat,ISColoring);
341be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat,void*);
342be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat,PetscInt,void*);
3433a7fca6bSBarry Smith 
344d91e6319SBarry Smith /*E
345d91e6319SBarry Smith     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
346d91e6319SBarry Smith      to continue to add values to it
347d91e6319SBarry Smith 
348d91e6319SBarry Smith     Level: beginner
349d91e6319SBarry Smith 
350d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd()
351d91e6319SBarry Smith E*/
3526d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
353be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat,MatAssemblyType);
354be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat,MatAssemblyType);
355be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat,PetscTruth*);
3564f9c727eSBarry Smith 
3571d73ed98SBarry Smith 
35830de9b25SBarry Smith 
359d91e6319SBarry Smith /*E
360d91e6319SBarry Smith     MatOption - Options that may be set for a matrix and its behavior or storage
361d91e6319SBarry Smith 
362d91e6319SBarry Smith     Level: beginner
363d91e6319SBarry Smith 
3640a835dfdSSatish Balay    Any additions/changes here MUST also be made in include/finclude/petscmat.h
365d91e6319SBarry Smith 
366d91e6319SBarry Smith .seealso: MatSetOption()
367d91e6319SBarry Smith E*/
368512a5fc5SBarry Smith typedef enum {MAT_ROW_ORIENTED,MAT_NEW_NONZERO_LOCATIONS,
3694e0d8c25SBarry Smith               MAT_SYMMETRIC,
3704e0d8c25SBarry Smith               MAT_STRUCTURALLY_SYMMETRIC,
3718047e77bSBarry Smith               MAT_NEW_DIAGONALS,MAT_IGNORE_OFF_PROC_ENTRIES,
3724e0d8c25SBarry Smith               MAT_NEW_NONZERO_LOCATION_ERR,
3734e0d8c25SBarry Smith               MAT_NEW_NONZERO_ALLOCATION_ERR,MAT_USE_HASH_TABLE,
3744e0d8c25SBarry Smith               MAT_KEEP_ZEROED_ROWS,MAT_IGNORE_ZERO_ENTRIES,
3754e0d8c25SBarry Smith               MAT_USE_INODES,
3764e0d8c25SBarry Smith               MAT_HERMITIAN,
3774e0d8c25SBarry Smith               MAT_SYMMETRY_ETERNAL,
3784e0d8c25SBarry Smith               MAT_USE_COMPRESSEDROW,
3794e0d8c25SBarry Smith               MAT_IGNORE_LOWER_TRIANGULAR,MAT_ERROR_LOWER_TRIANGULAR,
3804e0d8c25SBarry Smith               MAT_GETROW_UPPERTRIANGULAR} MatOption;
381290bbb0aSBarry Smith extern const char *MatOptions[];
3824e0d8c25SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption,PetscTruth);
383a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,const MatType*);
384a313700dSBarry Smith PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),const MatType,t)
38584cb2905SBarry Smith 
386be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
387be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
388be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
389f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowUpperTriangular(Mat);
390f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowUpperTriangular(Mat);
391be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
392be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
393be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt);
394be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]);
395ba966639SSatish Balay PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a)
396be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]);
397be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *);
398ba966639SSatish Balay PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a)
399be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt);
4007b80b807SBarry Smith 
4011620fd73SBarry Smith 
402be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec);
403be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec);
404ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
405be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec);
406be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*);
407ba966639SSatish Balay PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t)
408e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0,&t),PetscTruth,t)
4091cbb95d3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscTruth*);
410be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec);
411ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
412be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec);
413be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec);
4142bebee5dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatSolve(Mat,Mat,Mat);
415f5edf698SHong Zhang 
416d91e6319SBarry Smith /*E
417d91e6319SBarry Smith     MatDuplicateOption - Indicates if a duplicated sparse matrix should have
418d91e6319SBarry Smith   its numerical values copied over or just its nonzero structure.
419d91e6319SBarry Smith 
420d91e6319SBarry Smith     Level: beginner
421d91e6319SBarry Smith 
422d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
423d91e6319SBarry Smith 
424d91e6319SBarry Smith .seealso: MatDuplicate()
425d91e6319SBarry Smith E*/
4262e8a6d31SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES} MatDuplicateOption;
4272e8a6d31SBarry Smith 
428a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat,const MatType,MatReuse,Mat*);
429a313700dSBarry Smith PetscPolymorphicFunction(MatConvert,(Mat A,const MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a)
430be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat,MatDuplicateOption,Mat*);
431ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a)
432ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a)
43394a9d846SBarry Smith 
434cb5b572fSBarry Smith 
435be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat,Mat,MatStructure);
436be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat,PetscViewer);
437be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat,PetscReal,PetscTruth*);
438ba966639SSatish Balay PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t)
439e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0,&t),PetscTruth,t)
440be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscTruth*);
441ba966639SSatish Balay PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t)
4421cbb95d3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscReal,PetscTruth*);
4431cbb95d3SBarry Smith PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,0,&t),PetscTruth,t)
444be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*);
445be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*);
44664c62002SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMissingDiagonal(Mat,PetscTruth *,PetscInt *);
447a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoad(PetscViewer,const MatType,Mat*);
448a313700dSBarry Smith PetscPolymorphicFunction(MatLoad,(PetscViewer v,const MatType t),(v,t,&a),Mat,a)
4497b80b807SBarry Smith 
4508f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
4518f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
4528f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
4538f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
454d4fbbf0eSBarry Smith 
455d91e6319SBarry Smith /*S
456d91e6319SBarry Smith      MatInfo - Context of matrix information, used with MatGetInfo()
457d91e6319SBarry Smith 
458d91e6319SBarry Smith    In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
459d91e6319SBarry Smith 
460d91e6319SBarry Smith    Level: intermediate
461d91e6319SBarry Smith 
462d91e6319SBarry Smith   Concepts: matrix^nonzero information
463d91e6319SBarry Smith 
464d9274352SBarry Smith .seealso:  MatGetInfo(), MatInfoType
465d91e6319SBarry Smith S*/
4664e220ebcSLois Curfman McInnes typedef struct {
467b0a32e0cSBarry Smith   PetscLogDouble rows_global,columns_global;         /* number of global rows and columns */
468b0a32e0cSBarry Smith   PetscLogDouble rows_local,columns_local;           /* number of local rows and columns */
469b0a32e0cSBarry Smith   PetscLogDouble block_size;                         /* block size */
470b0a32e0cSBarry Smith   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
471b0a32e0cSBarry Smith   PetscLogDouble memory;                             /* memory allocated */
472b0a32e0cSBarry Smith   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
473b0a32e0cSBarry Smith   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
474b0a32e0cSBarry Smith   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
475b0a32e0cSBarry Smith   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
4764e220ebcSLois Curfman McInnes } MatInfo;
4774e220ebcSLois Curfman McInnes 
478d9274352SBarry Smith /*E
479d9274352SBarry Smith     MatInfoType - Indicates if you want information about the local part of the matrix,
480d9274352SBarry Smith      the entire parallel matrix or the maximum over all the local parts.
481d9274352SBarry Smith 
482d9274352SBarry Smith     Level: beginner
483d9274352SBarry Smith 
484d9274352SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
485d9274352SBarry Smith 
486d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo
487d9274352SBarry Smith E*/
4887b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
489be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat,MatInfoType,MatInfo*);
490be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatValid(Mat,PetscTruth*);
491be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat,Vec);
492985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec,PetscInt[]);
493985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMin(Mat,Vec,PetscInt[]);
494985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
49586697f06SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowSum(Mat,Vec);
496fc4dec0aSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,MatReuse,Mat*);
497fc4dec0aSBarry Smith PetscPolymorphicFunction(MatTranspose,(Mat A),(A,MAT_INITIAL_MATRIX,&t),Mat,t)
498be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *);
499ba966639SSatish Balay PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t)
500be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *);
501be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec);
502be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode);
503be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscTruth*);
504ba966639SSatish Balay PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t)
505be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscTruth*);
506be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*);
507be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*);
508be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*);
5097b80b807SBarry Smith 
510be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *);
511ba966639SSatish Balay PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n)
512be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat);
513f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar);
514f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar);
515f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*);
516f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumnsIS(Mat,IS,const PetscScalar*);
5177b80b807SBarry Smith 
518be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscTruth);
519be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec);
520be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec);
5215ef9f2a5SBarry Smith 
522be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*);
523be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*);
524be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
5258ee2e534SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRanges(Mat,const PetscInt**);
526f4b8409dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
52772ca8751SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangesColumn(Mat,const PetscInt**);
5287b80b807SBarry Smith 
529be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
530be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]);
531be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,PetscInt,MatReuse,Mat *);
532abf0e977SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrixRaw(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt,MatReuse,Mat *);
533829201f2SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSeqNonzeroStructure(Mat,Mat *[]);
534829201f2SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroySeqNonzeroStructure(Mat *[]);
5355494a064SHong Zhang 
536be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
537be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
538be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
539be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat);
540be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat);
541be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*);
542be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
543be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*);
544dd6ea824SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,MatScalar**,Mat*);
54543eb5e2fSMatthew Knepley #if defined (PETSC_USE_CTABLE)
546cd116e26SSatish Balay #include "petscctable.h"
54743eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *);
54843eb5e2fSMatthew Knepley #else
54943eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *);
55043eb5e2fSMatthew Knepley #endif
5518efafbd8SBarry Smith 
552be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
5537b80b807SBarry Smith 
554be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
555be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
556be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat);
55722440eb1SKris Buschelman 
558be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
559be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
560be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat);
56122440eb1SKris Buschelman 
562be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*);
563be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*);
564be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat);
565bc011b1eSHong Zhang 
566f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure);
56704aac2b0SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat,MatStructure);
568be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompress(Mat);
5691c741599SHong Zhang 
570f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar);
571f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar);
5727b80b807SBarry Smith 
573be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping);
574be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping);
575f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar);
576f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar);
577be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
578be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
579052efed2SBarry Smith 
580be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt);
581be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
58290f02eecSBarry Smith 
583be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec);
5840c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec);
585ba966639SSatish Balay PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
586be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec);
587be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*);
58869db28dcSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*);
589bd481603SBarry Smith 
590bd481603SBarry Smith /*MC
5911620fd73SBarry Smith    MatSetValue - Set a single entry into a matrix.
5921620fd73SBarry Smith 
5931620fd73SBarry Smith    Not collective
5941620fd73SBarry Smith 
5951620fd73SBarry Smith    Input Parameters:
5961620fd73SBarry Smith +  m - the matrix
5971620fd73SBarry Smith .  row - the row location of the entry
5981620fd73SBarry Smith .  col - the column location of the entry
5991620fd73SBarry Smith .  value - the value to insert
6001620fd73SBarry Smith -  mode - either INSERT_VALUES or ADD_VALUES
6011620fd73SBarry Smith 
6021620fd73SBarry Smith    Notes:
6031620fd73SBarry Smith    For efficiency one should use MatSetValues() and set several or many
6041620fd73SBarry Smith    values simultaneously if possible.
6051620fd73SBarry Smith 
6061620fd73SBarry Smith    Level: beginner
6071620fd73SBarry Smith 
6081620fd73SBarry Smith .seealso: MatSetValues(), MatSetValueLocal()
6091620fd73SBarry Smith M*/
6101620fd73SBarry Smith PETSC_STATIC_INLINE PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);}
6111620fd73SBarry Smith 
6121620fd73SBarry Smith PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);}
6131620fd73SBarry Smith 
6141620fd73SBarry Smith PETSC_STATIC_INLINE PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);}
6151620fd73SBarry Smith 
6161620fd73SBarry Smith /*MC
6170d2a7ff2SSatish Balay    MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
618bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
619bd481603SBarry Smith 
620bd481603SBarry Smith    Synopsis:
621c1ac3661SBarry Smith    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
622bd481603SBarry Smith 
623bd481603SBarry Smith    Collective on MPI_Comm
624bd481603SBarry Smith 
625bd481603SBarry Smith    Input Parameters:
626bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
627859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
628859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
629bd481603SBarry Smith 
630bd481603SBarry Smith    Output Parameters:
631bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
632bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
633bd481603SBarry Smith 
634bd481603SBarry Smith 
635bd481603SBarry Smith    Level: intermediate
636bd481603SBarry Smith 
637bd481603SBarry Smith    Notes:
638bd481603SBarry Smith    See the chapter in the users manual on performance for more details
639bd481603SBarry Smith 
6401d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
641bd481603SBarry Smith 
642bd481603SBarry Smith    Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
643bd481603SBarry Smith 
6441620fd73SBarry Smith    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
6451620fd73SBarry Smith 
646bd481603SBarry Smith   Concepts: preallocation^Matrix
647bd481603SBarry Smith 
648bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
649bd481603SBarry Smith           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
650bd481603SBarry Smith M*/
651c4f061fbSSatish Balay #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
6527c922b88SBarry Smith { \
653a89bc211SBarry Smith   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
654a89bc211SBarry Smith   _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
655a89bc211SBarry Smith   _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
656a89bc211SBarry Smith   _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
657c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
658a89bc211SBarry Smith   _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
6597c922b88SBarry Smith 
660bd481603SBarry Smith /*MC
6610d2a7ff2SSatish Balay    MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per
662bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
663bd481603SBarry Smith 
664bd481603SBarry Smith    Synopsis:
665c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
666bd481603SBarry Smith 
667bd481603SBarry Smith    Collective on MPI_Comm
668bd481603SBarry Smith 
669bd481603SBarry Smith    Input Parameters:
670bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
671859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
672859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
673bd481603SBarry Smith 
674bd481603SBarry Smith    Output Parameters:
675bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
676bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
677bd481603SBarry Smith 
678bd481603SBarry Smith 
679bd481603SBarry Smith    Level: intermediate
680bd481603SBarry Smith 
681bd481603SBarry Smith    Notes:
682bd481603SBarry Smith    See the chapter in the users manual on performance for more details
683bd481603SBarry Smith 
6841d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
685bd481603SBarry Smith 
6861620fd73SBarry Smith    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
6871620fd73SBarry Smith 
688bd481603SBarry Smith   Concepts: preallocation^Matrix
689bd481603SBarry Smith 
690bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
691bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
692bd481603SBarry Smith M*/
693222b16d4SBarry Smith #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \
694222b16d4SBarry Smith { \
695a89bc211SBarry Smith   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__end; \
696a89bc211SBarry Smith   _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
697a89bc211SBarry Smith   _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
698a89bc211SBarry Smith   _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
699c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\
700a89bc211SBarry Smith   _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
701222b16d4SBarry Smith 
702bd481603SBarry Smith /*MC
703bd481603SBarry Smith    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
704bd481603SBarry Smith        inserted using a local number of the rows and columns
705bd481603SBarry Smith 
706bd481603SBarry Smith    Synopsis:
707c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
708bd481603SBarry Smith 
709bd481603SBarry Smith    Not Collective
710bd481603SBarry Smith 
711bd481603SBarry Smith    Input Parameters:
712bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
713bd481603SBarry Smith .  nrows - the number of rows indicated
7141d73ed98SBarry Smith .  rows - the indices of the rows
715bd481603SBarry Smith .  ncols - the number of columns in the matrix
716bd481603SBarry Smith .  cols - the columns indicated
717bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
718bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
719bd481603SBarry Smith 
720bd481603SBarry Smith 
721bd481603SBarry Smith    Level: intermediate
722bd481603SBarry Smith 
723bd481603SBarry Smith    Notes:
724bd481603SBarry Smith    See the chapter in the users manual on performance for more details
725bd481603SBarry Smith 
7261d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
727bd481603SBarry Smith 
728bd481603SBarry Smith   Concepts: preallocation^Matrix
729bd481603SBarry Smith 
730bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
731bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
732bd481603SBarry Smith M*/
733c4f061fbSSatish Balay #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
734c4f061fbSSatish Balay {\
735c1ac3661SBarry Smith   PetscInt __l;\
736ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
737ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
738c4f061fbSSatish Balay   for (__l=0;__l<nrows;__l++) {\
739ef66eb69SBarry Smith     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
740c4f061fbSSatish Balay   }\
741c4f061fbSSatish Balay }
742c4f061fbSSatish Balay 
743bd481603SBarry Smith /*MC
744bd481603SBarry Smith    MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
745bd481603SBarry Smith        inserted using a local number of the rows and columns
746bd481603SBarry Smith 
747bd481603SBarry Smith    Synopsis:
748c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
749bd481603SBarry Smith 
750bd481603SBarry Smith    Not Collective
751bd481603SBarry Smith 
752bd481603SBarry Smith    Input Parameters:
753bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
754bd481603SBarry Smith .  nrows - the number of rows indicated
7551d73ed98SBarry Smith .  rows - the indices of the rows
756bd481603SBarry Smith .  ncols - the number of columns in the matrix
757bd481603SBarry Smith .  cols - the columns indicated
758bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
759bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
760bd481603SBarry Smith 
761bd481603SBarry Smith 
762bd481603SBarry Smith    Level: intermediate
763bd481603SBarry Smith 
764bd481603SBarry Smith    Notes:
765bd481603SBarry Smith    See the chapter in the users manual on performance for more details
766bd481603SBarry Smith 
767bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
768bd481603SBarry Smith 
769bd481603SBarry Smith   Concepts: preallocation^Matrix
770bd481603SBarry Smith 
771bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
772bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
773bd481603SBarry Smith M*/
774d3d32019SBarry Smith #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
775d3d32019SBarry Smith {\
776c1ac3661SBarry Smith   PetscInt __l;\
777d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
778d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
779d3d32019SBarry Smith   for (__l=0;__l<nrows;__l++) {\
780d3d32019SBarry Smith     _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
781d3d32019SBarry Smith   }\
782d3d32019SBarry Smith }
783d3d32019SBarry Smith 
784bd481603SBarry Smith /*MC
785bd481603SBarry Smith    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
786bd481603SBarry Smith        inserted using a local number of the rows and columns
787bd481603SBarry Smith 
788bd481603SBarry Smith    Synopsis:
789c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
790bd481603SBarry Smith 
791bd481603SBarry Smith    Not Collective
792bd481603SBarry Smith 
793bd481603SBarry Smith    Input Parameters:
79464075487SBarry Smith +  row - the row
795bd481603SBarry Smith .  ncols - the number of columns in the matrix
796a50f8bf6SHong Zhang -  cols - the columns indicated
797a50f8bf6SHong Zhang 
798a50f8bf6SHong Zhang    Output Parameters:
799a50f8bf6SHong Zhang +  dnz - the array that will be passed to the matrix preallocation routines
800bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
801bd481603SBarry Smith 
802bd481603SBarry Smith 
803bd481603SBarry Smith    Level: intermediate
804bd481603SBarry Smith 
805bd481603SBarry Smith    Notes:
806bd481603SBarry Smith    See the chapter in the users manual on performance for more details
807bd481603SBarry Smith 
808bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
809bd481603SBarry Smith 
8101620fd73SBarry Smith    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
8111620fd73SBarry Smith 
812bd481603SBarry Smith   Concepts: preallocation^Matrix
813bd481603SBarry Smith 
814bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
815bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
816bd481603SBarry Smith M*/
817c4f061fbSSatish Balay #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
818c1ac3661SBarry Smith { PetscInt __i; \
8198ee2e534SBarry Smith   if (row < __rstart) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D less than first local row %D",row,__rstart);\
820a89bc211SBarry Smith   if (row >= __rstart+__nrows) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D greater than last local row %D",row,__rstart+__nrows-1);\
8217c922b88SBarry Smith   for (__i=0; __i<nc; __i++) {\
82264075487SBarry Smith     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
8237cc688d7SBarry Smith     else dnz[row - __rstart]++;\
8247c922b88SBarry Smith   }\
8257c922b88SBarry Smith }
8267c922b88SBarry Smith 
827bd481603SBarry Smith /*MC
828bd481603SBarry Smith    MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
829bd481603SBarry Smith        inserted using a local number of the rows and columns
830bd481603SBarry Smith 
831bd481603SBarry Smith    Synopsis:
832c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
833bd481603SBarry Smith 
834bd481603SBarry Smith    Not Collective
835bd481603SBarry Smith 
836bd481603SBarry Smith    Input Parameters:
837bd481603SBarry Smith +  nrows - the number of rows indicated
8381d73ed98SBarry Smith .  rows - the indices of the rows
839bd481603SBarry Smith .  ncols - the number of columns in the matrix
840bd481603SBarry Smith .  cols - the columns indicated
841bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
842bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
843bd481603SBarry Smith 
844bd481603SBarry Smith 
845bd481603SBarry Smith    Level: intermediate
846bd481603SBarry Smith 
847bd481603SBarry Smith    Notes:
848bd481603SBarry Smith    See the chapter in the users manual on performance for more details
849bd481603SBarry Smith 
850bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
851bd481603SBarry Smith 
8521620fd73SBarry Smith    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
8531620fd73SBarry Smith 
854bd481603SBarry Smith   Concepts: preallocation^Matrix
855bd481603SBarry Smith 
856bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
857bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
858bd481603SBarry Smith M*/
859d3d32019SBarry Smith #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
860c1ac3661SBarry Smith { PetscInt __i; \
861d3d32019SBarry Smith   for (__i=0; __i<nc; __i++) {\
862d3d32019SBarry Smith     if (cols[__i] >= __end) onz[row - __rstart]++; \
863d3d32019SBarry Smith     else if (cols[__i] >= row) dnz[row - __rstart]++;\
864d3d32019SBarry Smith   }\
865d3d32019SBarry Smith }
866d3d32019SBarry Smith 
867bd481603SBarry Smith /*MC
86816371a99SBarry Smith    MatPreallocateLocation -  An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists
86916371a99SBarry Smith 
87016371a99SBarry Smith    Synopsis:
87116371a99SBarry Smith    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)
87216371a99SBarry Smith 
87316371a99SBarry Smith    Not Collective
87416371a99SBarry Smith 
87516371a99SBarry Smith    Input Parameters:
87616371a99SBarry Smith .  A - matrix
87716371a99SBarry Smith .  row - row where values exist (must be local to this process)
87816371a99SBarry Smith .  ncols - number of columns
87916371a99SBarry Smith .  cols - columns with nonzeros
88016371a99SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
88116371a99SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
88216371a99SBarry Smith 
88316371a99SBarry Smith 
88416371a99SBarry Smith    Level: intermediate
88516371a99SBarry Smith 
88616371a99SBarry Smith    Notes:
88716371a99SBarry Smith    See the chapter in the users manual on performance for more details
88816371a99SBarry Smith 
88916371a99SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
89016371a99SBarry Smith 
89116371a99SBarry Smith    This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.
89216371a99SBarry Smith 
89316371a99SBarry Smith   Concepts: preallocation^Matrix
89416371a99SBarry Smith 
89516371a99SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
89616371a99SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
89716371a99SBarry Smith M*/
89816371a99SBarry Smith #define MatPreallocateLocation(A,row,ncols,cols,dnz,onz) 0;if (A) {ierr = MatSetValues(A,1,&row,ncols,cols,PETSC_NULL,INSERT_VALUES); CHKERRQ(ierr);} else {ierr =  MatPreallocateSet(row,ncols,cols,dnz,onz);CHKERRQ(ierr);}
89916371a99SBarry Smith 
90016371a99SBarry Smith 
90116371a99SBarry Smith /*MC
9020d2a7ff2SSatish Balay    MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
903bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
904bd481603SBarry Smith 
905bd481603SBarry Smith    Synopsis:
906c1ac3661SBarry Smith    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
907bd481603SBarry Smith 
908bd481603SBarry Smith    Collective on MPI_Comm
909bd481603SBarry Smith 
910bd481603SBarry Smith    Input Parameters:
91116371a99SBarry Smith +  dnz - the array that was be passed to the matrix preallocation routines
912bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
913bd481603SBarry Smith 
914bd481603SBarry Smith 
915bd481603SBarry Smith    Level: intermediate
916bd481603SBarry Smith 
917bd481603SBarry Smith    Notes:
918bd481603SBarry Smith    See the chapter in the users manual on performance for more details
919bd481603SBarry Smith 
920bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
921bd481603SBarry Smith 
9221620fd73SBarry Smith    This is a MACRO not a function because it closes the { started in MatPreallocateInitialize().
9231620fd73SBarry Smith 
924bd481603SBarry Smith   Concepts: preallocation^Matrix
925bd481603SBarry Smith 
926bd481603SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
927bd481603SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
928bd481603SBarry Smith M*/
929a89bc211SBarry Smith #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}
9307c922b88SBarry Smith 
931bd481603SBarry Smith 
932bd481603SBarry Smith 
9337b80b807SBarry Smith /* Routines unique to particular data structures */
934be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **);
935ba966639SSatish Balay PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t)
936698d4c6aSKris Buschelman 
937be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*);
938be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
939698d4c6aSKris Buschelman 
940be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
941be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
942be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
943c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
944c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
9457b80b807SBarry Smith 
946a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4
947a96a251dSBarry Smith 
948be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
949ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
950be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
951ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
952be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
953ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz))
954be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDensePreallocation(Mat,PetscScalar[]);
955273d9f13SBarry Smith 
956be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
957ba966639SSatish Balay PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz))
958be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
959be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
96053803f26SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
961725b52f3SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
962be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
963be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
964be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
965be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
966284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
967be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsSetPreallocation(Mat,PetscInt,const PetscInt[]);
968be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
969be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
970be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void));
971273d9f13SBarry Smith 
972be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt);
973ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDenseGetLocalMatrix(Mat,Mat*);
9741b807ce4Svictorle 
975be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat);
976be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat);
9772e8a6d31SBarry Smith 
978be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*);
9793a7fca6bSBarry Smith 
9807b80b807SBarry Smith /*
9817b80b807SBarry Smith   These routines are not usually accessed directly, rather solving is
98294b7f48cSBarry Smith   done through the KSP and PC interfaces.
9837b80b807SBarry Smith */
9847b80b807SBarry Smith 
985d9274352SBarry Smith /*E
986d9274352SBarry Smith     MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
987d9274352SBarry Smith        with an optional dynamic library name, for example
988d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
989d9274352SBarry Smith 
990d9274352SBarry Smith    Level: beginner
991d9274352SBarry Smith 
992e5a9bf91SBarry Smith    Cannot use const because the PC objects manipulate the string
993e5a9bf91SBarry Smith 
994d9274352SBarry Smith .seealso: MatGetOrdering()
995d9274352SBarry Smith E*/
9963eaad2caSSatish Balay #define MatOrderingType char*
997b12f92e5SBarry Smith #define MATORDERING_NATURAL   "natural"
998b12f92e5SBarry Smith #define MATORDERING_ND        "nd"
999b12f92e5SBarry Smith #define MATORDERING_1WD       "1wd"
1000b12f92e5SBarry Smith #define MATORDERING_RCM       "rcm"
1001b12f92e5SBarry Smith #define MATORDERING_QMD       "qmd"
1002b12f92e5SBarry Smith #define MATORDERING_ROWLENGTH "rowlength"
100362152c8bSBarry Smith #define MATORDERING_DSC_ND    "dsc_nd"
100462152c8bSBarry Smith #define MATORDERING_DSC_MMD   "dsc_mmd"
100562152c8bSBarry Smith #define MATORDERING_DSC_MDF   "dsc_mdf"
1006c06d978dSMatthew Knepley #define MATORDERING_CONSTRAINED "constrained"
1007c06d978dSMatthew Knepley #define MATORDERING_IDENTITY  "identity"
1008c06d978dSMatthew Knepley #define MATORDERING_REVERSE   "reverse"
1009b12f92e5SBarry Smith 
1010f2416520SSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
1011be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list);
1012f2416520SSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));
101330de9b25SBarry Smith 
101430de9b25SBarry Smith /*MC
101530de9b25SBarry Smith    MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the
101630de9b25SBarry Smith                                matrix package.
101730de9b25SBarry Smith 
101830de9b25SBarry Smith    Synopsis:
1019c1ac3661SBarry Smith    PetscErrorCode MatOrderingRegisterDynamic(char *name_ordering,char *path,char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
102030de9b25SBarry Smith 
102130de9b25SBarry Smith    Not Collective
102230de9b25SBarry Smith 
102330de9b25SBarry Smith    Input Parameters:
102430de9b25SBarry Smith +  sname - name of ordering (for example MATORDERING_ND)
102530de9b25SBarry Smith .  path - location of library where creation routine is
102630de9b25SBarry Smith .  name - name of function that creates the ordering type,a string
102730de9b25SBarry Smith -  function - function pointer that creates the ordering
102830de9b25SBarry Smith 
102930de9b25SBarry Smith    Level: developer
103030de9b25SBarry Smith 
103130de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
103230de9b25SBarry Smith    is ignored.
103330de9b25SBarry Smith 
103430de9b25SBarry Smith    Sample usage:
103530de9b25SBarry Smith .vb
103630de9b25SBarry Smith    MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
103730de9b25SBarry Smith                "MyOrder",MyOrder);
103830de9b25SBarry Smith .ve
103930de9b25SBarry Smith 
104030de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
104130de9b25SBarry Smith $     MatOrderingSetType(part,"my_order)
104230de9b25SBarry Smith    or at runtime via the option
10432401956bSBarry Smith $     -pc_factor_mat_ordering_type my_order
104430de9b25SBarry Smith 
1045ab901514SBarry Smith    ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
104630de9b25SBarry Smith 
104730de9b25SBarry Smith .keywords: matrix, ordering, register
104830de9b25SBarry Smith 
104930de9b25SBarry Smith .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
105030de9b25SBarry Smith M*/
1051aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1052f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
1053b12f92e5SBarry Smith #else
1054f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
1055b12f92e5SBarry Smith #endif
105630de9b25SBarry Smith 
1057be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void);
1058be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]);
10592bad1931SBarry Smith extern PetscTruth MatOrderingRegisterAllCalled;
1060b0a32e0cSBarry Smith extern PetscFList MatOrderingList;
1061d4fbbf0eSBarry Smith 
1062be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1063a2ce50c7SBarry Smith 
1064d91e6319SBarry Smith /*S
10652401956bSBarry Smith    MatFactorInfo - Data passed into the matrix factorization routines
1066b00f7748SHong Zhang 
106761cad860SBarry Smith    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
106861cad860SBarry Smith $     MatFactorInfo  info(MAT_FACTORINFO_SIZE)
1069b00f7748SHong Zhang 
107015e8a5b3SHong Zhang    Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
1071b00f7748SHong Zhang 
107261cad860SBarry Smith       You can use MatFactorInfoInitialize() to set default values.
107361cad860SBarry Smith 
1074b00f7748SHong Zhang    Level: developer
1075b00f7748SHong Zhang 
1076d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1077d7d82daaSBarry Smith           MatFactorInfoInitialize()
1078b00f7748SHong Zhang 
1079b00f7748SHong Zhang S*/
1080b00f7748SHong Zhang typedef struct {
10810a29876aSHong Zhang   PetscReal     shiftnz;        /* scaling of identity added to matrix to prevent zero pivots */
1082fbf22428SSatish Balay   PetscReal     shiftpd;        /* if true, shift until positive pivots */
10832cea7109SBarry Smith   PetscReal     shift_fraction; /* record shift fraction taken */
108415e8a5b3SHong Zhang   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
108515e8a5b3SHong Zhang   PetscReal     dt;             /* drop tolerance */
1086b00f7748SHong Zhang   PetscReal     dtcol;          /* tolerance for pivoting */
108715e8a5b3SHong Zhang   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
108867e28bfeSBarry Smith   PetscReal     fill;           /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1089348344bbSBarry Smith   PetscReal     levels;         /* ICC/ILU(levels) */
1090bcd9e38bSBarry Smith   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1091bcd9e38bSBarry Smith                                    factorization may be faster if do not pivot */
109262bba022SBarry Smith   PetscReal     shiftinblocks;  /* if block in block factorization has zero pivot then shift diagonal until non-singular */
109315e8a5b3SHong Zhang   PetscReal     zeropivot;      /* pivot is called zero if less than this */
109415e8a5b3SHong Zhang } MatFactorInfo;
1095ffa6d0a5SLois Curfman McInnes 
1096be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*);
1097be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,MatFactorInfo*);
1098be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*);
1099be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,MatFactorInfo*,Mat*);
1100be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,MatFactorInfo*);
1101be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,MatFactorInfo*);
1102be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*);
1103be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*);
1104be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*);
1105be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,MatFactorInfo*);
1106be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,MatFactorInfo*,Mat*);
1107be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactor(Mat,IS,IS,MatFactorInfo*,Mat *);
1108be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1109be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec);
1110be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec);
1111be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec);
1112be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec);
1113be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec);
1114be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1115be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs);
11168ed539a5SBarry Smith 
1117be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat);
1118bb5a7306SBarry Smith 
1119d91e6319SBarry Smith /*E
1120d91e6319SBarry Smith     MatSORType - What type of (S)SOR to perform
1121bb1eb677SSatish Balay 
1122d91e6319SBarry Smith     Level: beginner
1123d91e6319SBarry Smith 
1124d9274352SBarry Smith    May be bitwise ORd together
1125d9274352SBarry Smith 
1126d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1127d91e6319SBarry Smith 
11284e7234bfSBarry Smith    MatSORType may be bitwise ORd together, so do not change the numbers
11294e7234bfSBarry Smith 
1130a1d92eedSBarry Smith .seealso: MatRelax(), MatPBRelax()
1131d91e6319SBarry Smith E*/
1132ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1133ee50ffe9SBarry Smith               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1134ee50ffe9SBarry Smith               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
113584cb2905SBarry Smith               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1136be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1137be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPBRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
11388ed539a5SBarry Smith 
1139d4fbbf0eSBarry Smith /*
1140639f9d9dSBarry Smith     These routines are for efficiently computing Jacobians via finite differences.
1141639f9d9dSBarry Smith */
1142b12f92e5SBarry Smith 
1143d9274352SBarry Smith /*E
1144d9274352SBarry Smith     MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1145d9274352SBarry Smith        with an optional dynamic library name, for example
1146d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1147d9274352SBarry Smith 
1148d9274352SBarry Smith    Level: beginner
1149d9274352SBarry Smith 
1150d9274352SBarry Smith .seealso: MatGetColoring()
1151d9274352SBarry Smith E*/
1152a313700dSBarry Smith #define MatColoringType char*
1153b12f92e5SBarry Smith #define MATCOLORING_NATURAL "natural"
1154b12f92e5SBarry Smith #define MATCOLORING_SL      "sl"
1155b12f92e5SBarry Smith #define MATCOLORING_LF      "lf"
1156b12f92e5SBarry Smith #define MATCOLORING_ID      "id"
1157b12f92e5SBarry Smith 
1158ab970d9bSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,const MatColoringType,ISColoring*);
11592e90c967SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *));
116030de9b25SBarry Smith 
116130de9b25SBarry Smith /*MC
116230de9b25SBarry Smith    MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
116330de9b25SBarry Smith                                matrix package.
116430de9b25SBarry Smith 
116530de9b25SBarry Smith    Synopsis:
1166c1ac3661SBarry Smith    PetscErrorCode MatColoringRegisterDynamic(char *name_coloring,char *path,char *name_create,PetscErrorCode (*routine_create)(MatColoring))
116730de9b25SBarry Smith 
116830de9b25SBarry Smith    Not Collective
116930de9b25SBarry Smith 
117030de9b25SBarry Smith    Input Parameters:
117130de9b25SBarry Smith +  sname - name of Coloring (for example MATCOLORING_SL)
117230de9b25SBarry Smith .  path - location of library where creation routine is
117330de9b25SBarry Smith .  name - name of function that creates the Coloring type, a string
117430de9b25SBarry Smith -  function - function pointer that creates the coloring
117530de9b25SBarry Smith 
117630de9b25SBarry Smith    Level: developer
117730de9b25SBarry Smith 
117830de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
117930de9b25SBarry Smith    is ignored.
118030de9b25SBarry Smith 
118130de9b25SBarry Smith    Sample usage:
118230de9b25SBarry Smith .vb
118330de9b25SBarry Smith    MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
118430de9b25SBarry Smith                "MyColor",MyColor);
118530de9b25SBarry Smith .ve
118630de9b25SBarry Smith 
118730de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
118830de9b25SBarry Smith $     MatColoringSetType(part,"my_color")
118930de9b25SBarry Smith    or at runtime via the option
119030de9b25SBarry Smith $     -mat_coloring_type my_color
119130de9b25SBarry Smith 
1192ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
119330de9b25SBarry Smith 
119430de9b25SBarry Smith .keywords: matrix, Coloring, register
119530de9b25SBarry Smith 
119630de9b25SBarry Smith .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
119730de9b25SBarry Smith M*/
1198aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1199f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1200b12f92e5SBarry Smith #else
1201f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1202b12f92e5SBarry Smith #endif
120330de9b25SBarry Smith 
12042bad1931SBarry Smith extern PetscTruth MatColoringRegisterAllCalled;
1205f1144a30SSatish Balay 
1206be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]);
1207be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void);
1208be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1209639f9d9dSBarry Smith 
1210d9274352SBarry Smith /*S
1211d9274352SBarry Smith      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1212d9274352SBarry Smith         and coloring
1213639f9d9dSBarry Smith 
1214d9274352SBarry Smith    Level: beginner
1215d9274352SBarry Smith 
1216d9274352SBarry Smith   Concepts: coloring, sparse Jacobian, finite differences
1217d9274352SBarry Smith 
1218d9274352SBarry Smith .seealso:  MatFDColoringCreate()
1219d9274352SBarry Smith S*/
1220e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring;
1221639f9d9dSBarry Smith 
1222be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1223be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring);
1224be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer);
1225be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
12264a9d489dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1227be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1228be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFrequency(MatFDColoring,PetscInt);
1229be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFrequency(MatFDColoring,PetscInt*);
1230be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring);
1231be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1232be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *);
1233be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetRecompute(MatFDColoring);
1234be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec);
1235be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1236639f9d9dSBarry Smith /*
12370752156aSBarry Smith     These routines are for partitioning matrices: currently used only
12383eda8832SBarry Smith   for adjacency matrix, MatCreateMPIAdj().
12390752156aSBarry Smith */
1240ca161407SBarry Smith 
1241d9274352SBarry Smith /*S
1242d9274352SBarry Smith      MatPartitioning - Object for managing the partitioning of a matrix or graph
1243d9274352SBarry Smith 
1244d9274352SBarry Smith    Level: beginner
1245d9274352SBarry Smith 
1246d9274352SBarry Smith   Concepts: partitioning
1247d9274352SBarry Smith 
1248743a1026Svictorle .seealso:  MatPartitioningCreate(), MatPartitioningType
1249d9274352SBarry Smith S*/
125091e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning;
1251d9274352SBarry Smith 
1252d9274352SBarry Smith /*E
12535bc6e7ccSvictorle     MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1254d9274352SBarry Smith        with an optional dynamic library name, for example
1255d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1256d9274352SBarry Smith 
1257d9274352SBarry Smith    Level: beginner
1258d9274352SBarry Smith 
1259b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning
1260d9274352SBarry Smith E*/
1261a313700dSBarry Smith #define MatPartitioningType char*
12628ba1e511SMatthew Knepley #define MAT_PARTITIONING_CURRENT  "current"
1263c2ec2a73SHong Zhang #define MAT_PARTITIONING_SQUARE   "square"
12648ba1e511SMatthew Knepley #define MAT_PARTITIONING_PARMETIS "parmetis"
126571306c60Sjroman #define MAT_PARTITIONING_CHACO    "chaco"
126671306c60Sjroman #define MAT_PARTITIONING_JOSTLE   "jostle"
126771306c60Sjroman #define MAT_PARTITIONING_PARTY    "party"
126871306c60Sjroman #define MAT_PARTITIONING_SCOTCH   "scotch"
126971306c60Sjroman 
1270ca161407SBarry Smith 
1271be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1272a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,const MatPartitioningType);
1273be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt);
1274be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat);
1275be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1276be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1277be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*);
1278be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning);
12792aabb6bbSBarry Smith 
1280be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
128130de9b25SBarry Smith 
128230de9b25SBarry Smith /*MC
128330de9b25SBarry Smith    MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
128430de9b25SBarry Smith    matrix package.
128530de9b25SBarry Smith 
128630de9b25SBarry Smith    Synopsis:
1287c1ac3661SBarry Smith    PetscErrorCode MatPartitioningRegisterDynamic(char *name_partitioning,char *path,char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
128830de9b25SBarry Smith 
128930de9b25SBarry Smith    Not Collective
129030de9b25SBarry Smith 
129130de9b25SBarry Smith    Input Parameters:
129230de9b25SBarry Smith +  sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis
129330de9b25SBarry Smith .  path - location of library where creation routine is
129430de9b25SBarry Smith .  name - name of function that creates the partitioning type, a string
129530de9b25SBarry Smith -  function - function pointer that creates the partitioning type
129630de9b25SBarry Smith 
129730de9b25SBarry Smith    Level: developer
129830de9b25SBarry Smith 
129930de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
130030de9b25SBarry Smith    is ignored.
130130de9b25SBarry Smith 
130230de9b25SBarry Smith    Sample usage:
130330de9b25SBarry Smith .vb
130430de9b25SBarry Smith    MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
130530de9b25SBarry Smith                "MyPartCreate",MyPartCreate);
130630de9b25SBarry Smith .ve
130730de9b25SBarry Smith 
130830de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
130930de9b25SBarry Smith $     MatPartitioningSetType(part,"my_part")
131030de9b25SBarry Smith    or at runtime via the option
131130de9b25SBarry Smith $     -mat_partitioning_type my_part
131230de9b25SBarry Smith 
1313ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
131430de9b25SBarry Smith 
131530de9b25SBarry Smith .keywords: matrix, partitioning, register
131630de9b25SBarry Smith 
131730de9b25SBarry Smith .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
131830de9b25SBarry Smith M*/
1319aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1320f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
13212aabb6bbSBarry Smith #else
1322f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
13232aabb6bbSBarry Smith #endif
13242aabb6bbSBarry Smith 
13252bad1931SBarry Smith extern PetscTruth MatPartitioningRegisterAllCalled;
1326f1144a30SSatish Balay 
1327be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]);
1328be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void);
13292bad1931SBarry Smith 
1330be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer);
1331be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning);
1332a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,const MatPartitioningType*);
1333ca161407SBarry Smith 
1334be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
13350752156aSBarry Smith 
1336be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal);
1337be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning);
133871306c60Sjroman 
1339954b3ec6SBarry Smith typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType;
1340be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
134171306c60Sjroman typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType;
1342be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1343be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
134471306c60Sjroman typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType;
1345be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1346be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1347be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
134871306c60Sjroman 
134971306c60Sjroman #define MP_PARTY_OPT "opt"
135071306c60Sjroman #define MP_PARTY_LIN "lin"
135171306c60Sjroman #define MP_PARTY_SCA "sca"
135271306c60Sjroman #define MP_PARTY_RAN "ran"
135371306c60Sjroman #define MP_PARTY_GBF "gbf"
135471306c60Sjroman #define MP_PARTY_GCF "gcf"
135571306c60Sjroman #define MP_PARTY_BUB "bub"
135671306c60Sjroman #define MP_PARTY_DEF "def"
1357be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*);
135871306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs"
135971306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl"
136071306c60Sjroman #define MP_PARTY_NONE "no"
1361be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*);
1362be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1363be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscTruth);
1364be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth);
136571306c60Sjroman 
136671306c60Sjroman typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType;
1367be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*);
1368be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning);
1369be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType);
1370be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal);
1371be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*);
137271306c60Sjroman typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType;
1373be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType);
1374be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning);
1375be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*);
137671306c60Sjroman 
13770752156aSBarry Smith /*
13780a835dfdSSatish Balay     If you add entries here you must also add them to finclude/petscmat.h
1379d4fbbf0eSBarry Smith */
13801c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0,
13811c1c02c0SLois Curfman McInnes                MATOP_GET_ROW=1,
13821c1c02c0SLois Curfman McInnes                MATOP_RESTORE_ROW=2,
13831c1c02c0SLois Curfman McInnes                MATOP_MULT=3,
13841c1c02c0SLois Curfman McInnes                MATOP_MULT_ADD=4,
13857c922b88SBarry Smith                MATOP_MULT_TRANSPOSE=5,
13867c922b88SBarry Smith                MATOP_MULT_TRANSPOSE_ADD=6,
13871c1c02c0SLois Curfman McInnes                MATOP_SOLVE=7,
13881c1c02c0SLois Curfman McInnes                MATOP_SOLVE_ADD=8,
13897c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE=9,
13907c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE_ADD=10,
13911c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR=11,
13921c1c02c0SLois Curfman McInnes                MATOP_CHOLESKYFACTOR=12,
13931c1c02c0SLois Curfman McInnes                MATOP_RELAX=13,
13941c1c02c0SLois Curfman McInnes                MATOP_TRANSPOSE=14,
13951c1c02c0SLois Curfman McInnes                MATOP_GETINFO=15,
13961c1c02c0SLois Curfman McInnes                MATOP_EQUAL=16,
13971c1c02c0SLois Curfman McInnes                MATOP_GET_DIAGONAL=17,
13981c1c02c0SLois Curfman McInnes                MATOP_DIAGONAL_SCALE=18,
13991c1c02c0SLois Curfman McInnes                MATOP_NORM=19,
14001c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_BEGIN=20,
14011c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_END=21,
14021c1c02c0SLois Curfman McInnes                MATOP_COMPRESS=22,
14031c1c02c0SLois Curfman McInnes                MATOP_SET_OPTION=23,
14041c1c02c0SLois Curfman McInnes                MATOP_ZERO_ENTRIES=24,
14051c1c02c0SLois Curfman McInnes                MATOP_ZERO_ROWS=25,
14061c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR_SYMBOLIC=26,
14071c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR_NUMERIC=27,
14081c1c02c0SLois Curfman McInnes                MATOP_CHOLESKY_FACTOR_SYMBOLIC=28,
14091c1c02c0SLois Curfman McInnes                MATOP_CHOLESKY_FACTOR_NUMERIC=29,
1410d643ce63SMatthew Knepley                MATOP_SETUP_PREALLOCATION=30,
1411d643ce63SMatthew Knepley                MATOP_ILUFACTOR_SYMBOLIC=31,
1412d643ce63SMatthew Knepley                MATOP_ICCFACTOR_SYMBOLIC=32,
1413d643ce63SMatthew Knepley                MATOP_GET_ARRAY=33,
1414d643ce63SMatthew Knepley                MATOP_RESTORE_ARRAY=34,
1415e26f1c3cSBarry Smith                MATOP_DUPLICATE=35,
1416d643ce63SMatthew Knepley                MATOP_FORWARD_SOLVE=36,
1417d643ce63SMatthew Knepley                MATOP_BACKWARD_SOLVE=37,
1418d643ce63SMatthew Knepley                MATOP_ILUFACTOR=38,
1419d643ce63SMatthew Knepley                MATOP_ICCFACTOR=39,
1420d643ce63SMatthew Knepley                MATOP_AXPY=40,
1421d643ce63SMatthew Knepley                MATOP_GET_SUBMATRICES=41,
1422d643ce63SMatthew Knepley                MATOP_INCREASE_OVERLAP=42,
1423d643ce63SMatthew Knepley                MATOP_GET_VALUES=43,
1424d643ce63SMatthew Knepley                MATOP_COPY=44,
1425ff1cced0SMatthew Knepley                MATOP_GET_ROW_MAX=45,
1426d643ce63SMatthew Knepley                MATOP_SCALE=46,
1427d643ce63SMatthew Knepley                MATOP_SHIFT=47,
1428d643ce63SMatthew Knepley                MATOP_DIAGONAL_SHIFT=48,
1429d643ce63SMatthew Knepley                MATOP_ILUDT_FACTOR=49,
1430ff1cced0SMatthew Knepley                MATOP_SET_BLOCK_SIZE=50,
1431d643ce63SMatthew Knepley                MATOP_GET_ROW_IJ=51,
1432d643ce63SMatthew Knepley                MATOP_RESTORE_ROW_IJ=52,
1433d643ce63SMatthew Knepley                MATOP_GET_COLUMN_IJ=53,
1434d643ce63SMatthew Knepley                MATOP_RESTORE_COLUMN_IJ=54,
1435d643ce63SMatthew Knepley                MATOP_FDCOLORING_CREATE=55,
1436d643ce63SMatthew Knepley                MATOP_COLORING_PATCH=56,
1437d643ce63SMatthew Knepley                MATOP_SET_UNFACTORED=57,
1438d643ce63SMatthew Knepley                MATOP_PERMUTE=58,
1439d643ce63SMatthew Knepley                MATOP_SET_VALUES_BLOCKED=59,
1440d643ce63SMatthew Knepley                MATOP_GET_SUBMATRIX=60,
1441d643ce63SMatthew Knepley                MATOP_DESTROY=61,
1442d643ce63SMatthew Knepley                MATOP_VIEW=62,
1443ff1cced0SMatthew Knepley                MATOP_CONVERT_FROM=63,
1444d643ce63SMatthew Knepley                MATOP_USE_SCALED_FORM=64,
1445d643ce63SMatthew Knepley                MATOP_SCALE_SYSTEM=65,
1446d643ce63SMatthew Knepley                MATOP_UNSCALE_SYSTEM=66,
1447ba16a8cbSKris Buschelman                MATOP_SET_LOCAL_TO_GLOBAL_MAP=67,
1448d643ce63SMatthew Knepley                MATOP_SET_VALUES_LOCAL=68,
1449d643ce63SMatthew Knepley                MATOP_ZERO_ROWS_LOCAL=69,
1450ff1cced0SMatthew Knepley                MATOP_GET_ROW_MAX_ABS=70,
1451d643ce63SMatthew Knepley                MATOP_CONVERT=71,
1452d643ce63SMatthew Knepley                MATOP_SET_COLORING=72,
1453d643ce63SMatthew Knepley                MATOP_SET_VALUES_ADIC=73,
1454d643ce63SMatthew Knepley                MATOP_SET_VALUES_ADIFOR=74,
1455d643ce63SMatthew Knepley                MATOP_FD_COLORING_APPLY=75,
1456d643ce63SMatthew Knepley                MATOP_SET_FROM_OPTIONS=76,
1457ba16a8cbSKris Buschelman                MATOP_MULT_CON=77,
1458ba16a8cbSKris Buschelman                MATOP_MULT_TRANSPOSE_CON=78,
1459ba16a8cbSKris Buschelman                MATOP_ILU_FACTOR_SYMBOLIC_CON=79,
1460d643ce63SMatthew Knepley                MATOP_PERMUTE_SPARSIFY=80,
1461d643ce63SMatthew Knepley                MATOP_MULT_MULTIPLE=81,
146241acf15aSKris Buschelman                MATOP_SOLVE_MULTIPLE=82,
146341acf15aSKris Buschelman                MATOP_GET_INERTIA=83,
146441acf15aSKris Buschelman                MATOP_LOAD=84,
146541acf15aSKris Buschelman                MATOP_IS_SYMMETRIC=85,
146641acf15aSKris Buschelman                MATOP_IS_HERMITIAN=86,
146741acf15aSKris Buschelman                MATOP_IS_STRUCTURALLY_SYMMETRIC=87,
146841acf15aSKris Buschelman                MATOP_PB_RELAX=88,
146941acf15aSKris Buschelman                MATOP_GET_VECS=89,
147041acf15aSKris Buschelman                MATOP_MAT_MULT=90,
147141acf15aSKris Buschelman                MATOP_MAT_MULT_SYMBOLIC=91,
147241acf15aSKris Buschelman                MATOP_MAT_MULT_NUMERIC=92,
147341acf15aSKris Buschelman                MATOP_PTAP=93,
147441acf15aSKris Buschelman                MATOP_PTAP_SYMBOLIC=94,
1475bc011b1eSHong Zhang                MATOP_PTAP_NUMERIC=95,
1476bc011b1eSHong Zhang                MATOP_MAT_MULTTRANSPOSE=96,
1477bc011b1eSHong Zhang                MATOP_MAT_MULTTRANSPOSE_SYMBOLIC=97,
14787ba1a0bfSKris Buschelman                MATOP_MAT_MULTTRANSPOSE_NUMERIC=98,
14797ba1a0bfSKris Buschelman                MATOP_PTAP_SYMBOLIC_SEQAIJ=99,
14807ba1a0bfSKris Buschelman                MATOP_PTAP_NUMERIC_SEQAIJ=100,
14817ba1a0bfSKris Buschelman                MATOP_PTAP_SYMBOLIC_MPIAIJ=101,
148287d4246cSBarry Smith                MATOP_PTAP_NUMERIC_MPIAIJ=102,
1483ff1cced0SMatthew Knepley                MATOP_CONJUGATE=103,
1484ff1cced0SMatthew Knepley                MATOP_SET_SIZES=104,
1485f5edf698SHong Zhang                MATOP_SET_VALUES_ROW = 105,
1486ff1cced0SMatthew Knepley                MATOP_REAL_PART=106,
1487ff1cced0SMatthew Knepley                MATOP_IMAG_PART=107,
1488d5c63f83SSatish Balay                MATOP_GET_ROW_UTRIANGULAR=108,
14892bebee5dSHong Zhang                MATOP_RESTORE_ROW_UTRIANGULAR=109,
149069db28dcSHong Zhang                MATOP_MATSOLVE=110,
1491829201f2SHong Zhang                MATOP_GET_REDUNDANTMATRIX=111,
1492ff1cced0SMatthew Knepley                MATOP_GET_ROW_MIN=112,
1493ff1cced0SMatthew Knepley                MATOP_GET_COLUMN_VEC=113,
1494ff1cced0SMatthew Knepley                MATOP_MISSING_DIAGONAL=114,
1495ff1cced0SMatthew Knepley                MATOP_MATGETSEQNONZEROSTRUCTURE=115,
1496ff1cced0SMatthew Knepley                MATOP_DESTROY_SOLVER=116
1497fae171e0SBarry Smith              } MatOperation;
1498be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscTruth*);
1499be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void));
1500be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void));
1501be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*);
1502112a2221SBarry Smith 
150390ace30eSBarry Smith /*
150490ace30eSBarry Smith    Codes for matrices stored on disk. By default they are
150590ace30eSBarry Smith  stored in a universal format. By changing the format with
1506fb9695e5SSatish Balay  PetscViewerSetFormat(viewer,PETSC_VIEWER_BINARY_NATIVE); the matrices will
150790ace30eSBarry Smith  be stored in a way natural for the matrix, for example dense matrices
150890ace30eSBarry Smith  would be stored as dense. Matrices stored this way may only be
150990ace30eSBarry Smith  read into matrices of the same time.
151090ace30eSBarry Smith */
151190ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1
151290ace30eSBarry Smith 
1513be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1514be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*);
15151f4e1ec7SBarry Smith 
1516d9274352SBarry Smith /*S
1517d9274352SBarry Smith      MatNullSpace - Object that removes a null space from a vector, i.e.
1518d9274352SBarry Smith          orthogonalizes the vector to a subsapce
1519d9274352SBarry Smith 
1520f7a9e4ceSBarry Smith    Level: advanced
1521d9274352SBarry Smith 
1522d9274352SBarry Smith   Concepts: matrix; linear operator, null space
1523d9274352SBarry Smith 
15246e1639daSBarry Smith   Users manual sections:
15256e1639daSBarry Smith .   sec_singular
15266e1639daSBarry Smith 
1527d9274352SBarry Smith .seealso:  MatNullSpaceCreate()
1528d9274352SBarry Smith S*/
152974637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace;
1530d9274352SBarry Smith 
1531be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*);
1532281d1b2eSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(Vec,void*),void*);
1533be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace);
1534be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1535be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace);
1536be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat);
153774637425SBarry Smith 
1538be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS);
1539be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1540be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
154146129b97SKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat);
15423f1d51d7SBarry Smith 
1543be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*);
1544be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*);
1545be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*);
1546c4f061fbSSatish Balay 
1547be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*);
1548b0a32e0cSBarry Smith 
1549be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec);
155004f1ad80SBarry Smith 
1551fef1beadSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
15523ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetBase(Mat,Vec,Vec);
15533ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1554e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1555e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1556e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDAddNullSpace(Mat,MatNullSpace);
1557e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1558e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDResetHHistory(Mat);
1559e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctionError(Mat,PetscReal);
1560e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetPeriod(Mat,PetscInt);
1561e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDGetH(Mat,PetscScalar *);
1562e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFromOptions(Mat);
1563e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1564e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);
1565e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDDSSetUmin(Mat,PetscReal);
1566e884886fSBarry Smith 
1567e884886fSBarry Smith 
1568e884886fSBarry Smith typedef struct _p_MatMFFD* MatMFFD;
1569e884886fSBarry Smith 
1570e884886fSBarry Smith /*E
1571e884886fSBarry Smith     MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function
1572e884886fSBarry Smith 
1573e884886fSBarry Smith    Level: beginner
1574e884886fSBarry Smith 
1575e884886fSBarry Smith .seealso: MatMFFDSetType(), MatMFFDRegister()
1576e884886fSBarry Smith E*/
1577a313700dSBarry Smith #define MatMFFDType char*
1578e884886fSBarry Smith #define MATMFFD_DS  "ds"
1579e884886fSBarry Smith #define MATMFFD_WP  "wp"
1580e884886fSBarry Smith 
1581a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetType(Mat,const MatMFFDType);
1582e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatMFFD));
1583e884886fSBarry Smith 
1584e884886fSBarry Smith /*MC
1585e884886fSBarry Smith    MatMFFDRegisterDynamic - Adds a method to the MatMFFD registry.
1586e884886fSBarry Smith 
1587e884886fSBarry Smith    Synopsis:
1588e884886fSBarry Smith    PetscErrorCode MatMFFDRegisterDynamic(char *name_solver,char *path,char *name_create,PetscErrorCode (*routine_create)(MatMFFD))
1589e884886fSBarry Smith 
1590e884886fSBarry Smith    Not Collective
1591e884886fSBarry Smith 
1592e884886fSBarry Smith    Input Parameters:
1593e884886fSBarry Smith +  name_solver - name of a new user-defined compute-h module
1594e884886fSBarry Smith .  path - path (either absolute or relative) the library containing this solver
1595e884886fSBarry Smith .  name_create - name of routine to create method context
1596e884886fSBarry Smith -  routine_create - routine to create method context
1597e884886fSBarry Smith 
1598e884886fSBarry Smith    Level: developer
1599e884886fSBarry Smith 
1600e884886fSBarry Smith    Notes:
1601e884886fSBarry Smith    MatMFFDRegisterDynamic() may be called multiple times to add several user-defined solvers.
1602e884886fSBarry Smith 
1603e884886fSBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
1604e884886fSBarry Smith    is ignored.
1605e884886fSBarry Smith 
1606e884886fSBarry Smith    Sample usage:
1607e884886fSBarry Smith .vb
1608e884886fSBarry Smith    MatMFFDRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a,
1609e884886fSBarry Smith                "MyHCreate",MyHCreate);
1610e884886fSBarry Smith .ve
1611e884886fSBarry Smith 
1612e884886fSBarry Smith    Then, your solver can be chosen with the procedural interface via
1613e884886fSBarry Smith $     MatMFFDSetType(mfctx,"my_h")
1614e884886fSBarry Smith    or at runtime via the option
1615e884886fSBarry Smith $     -snes_mf_type my_h
1616e884886fSBarry Smith 
1617e884886fSBarry Smith .keywords: MatMFFD, register
1618e884886fSBarry Smith 
1619e884886fSBarry Smith .seealso: MatMFFDRegisterAll(), MatMFFDRegisterDestroy()
1620e884886fSBarry Smith M*/
1621e884886fSBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1622e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,0)
1623e884886fSBarry Smith #else
1624e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,d)
1625e884886fSBarry Smith #endif
1626e884886fSBarry Smith 
1627e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterAll(const char[]);
1628e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterDestroy(void);
1629e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDDefaultSetUmin(Mat,PetscReal);
1630e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDWPSetComputeNormU(Mat,PetscTruth);
1631e884886fSBarry Smith 
1632e884886fSBarry Smith 
1633be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1634be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
16357dbadf16SMatthew Knepley 
1636e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END
16372eac72dbSBarry Smith #endif
1638