xref: /petsc/include/petscmat.h (revision 9796902319348931aaafebaa8ebb7e3850b24197)
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"
64557cca28SSatish Balay #define MATTRANSPOSEMAT    "transpose"
6572ca8751SBarry Smith #define MATSCHURCOMPLEMENT "schurcomplement"
661d6018f0SLisandro Dalcin #define MATPYTHON          "python"
67f91d8e95SBarry Smith #define MATHYPRESTRUCT     "hyprestruct"
68ee1cef2cSJed Brown #define MATSUBMATRIX       "submatrix"
69d91e6319SBarry Smith 
70a6a5cd3fSDmitry Karpeev #ifdef PETSC_USE_MATFRAMEWORK
71a6a5cd3fSDmitry Karpeev #define MATFRAMEWORK           "framework"
72a6a5cd3fSDmitry Karpeev #endif
73773941d6SBarry Smith 
749989ab13SBarry Smith /*E
75c7393fdbSBarry Smith     MatSolverPackage - String with the name of a PETSc matrix solver type.
769989ab13SBarry Smith 
779989ab13SBarry Smith     For example: "petsc" indicates what PETSc provides, "superlu" indicates either
789989ab13SBarry Smith        SuperLU or SuperLU_Dist etc.
799989ab13SBarry Smith 
809989ab13SBarry Smith 
819989ab13SBarry Smith    Level: beginner
829989ab13SBarry Smith 
835c9eb25fSBarry Smith .seealso: MatGetFactor(), Mat, MatSetType(), MatType
849989ab13SBarry Smith E*/
85c7393fdbSBarry Smith #define MatSolverPackage char*
86b24902e0SBarry Smith #define MAT_SOLVER_SPOOLES      "spooles"
87b24902e0SBarry Smith #define MAT_SOLVER_SUPERLU      "superlu"
88b24902e0SBarry Smith #define MAT_SOLVER_SUPERLU_DIST "superlu_dist"
89b24902e0SBarry Smith #define MAT_SOLVER_UMFPACK      "umfpack"
90b24902e0SBarry Smith #define MAT_SOLVER_ESSL         "essl"
91b24902e0SBarry Smith #define MAT_SOLVER_LUSOL        "lusol"
92b24902e0SBarry Smith #define MAT_SOLVER_MUMPS        "mumps"
933bf14a46SMatthew Knepley #define MAT_SOLVER_PASTIX       "pastix"
94b24902e0SBarry Smith #define MAT_SOLVER_DSCPACK      "dscpack"
95b24902e0SBarry Smith #define MAT_SOLVER_MATLAB       "matlab"
9643244d56SBarry Smith #define MAT_SOLVER_PETSC        "petsc"
97b6806ab0SHong Zhang #define MAT_SOLVER_PLAPACK      "plapack"
98b24902e0SBarry Smith 
99773941d6SBarry Smith 
100b24902e0SBarry Smith /*E
101b24902e0SBarry Smith     MatFactorType - indicates what type of factorization is requested
102b24902e0SBarry Smith 
103b24902e0SBarry Smith     Level: beginner
104b24902e0SBarry Smith 
105b24902e0SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
106b24902e0SBarry Smith 
107c7393fdbSBarry Smith .seealso: MatSolverPackage, MatGetFactor()
108b24902e0SBarry Smith E*/
109599ef60dSHong Zhang typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType;
110c7393fdbSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactor(Mat,const MatSolverPackage,MatFactorType,Mat*);
111db4efbfdSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactorAvailable(Mat,const MatSolverPackage,MatFactorType,PetscTruth*);
11235bd34faSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorGetSolverPackage(Mat,const MatSolverPackage*);
113b24902e0SBarry Smith 
1149989ab13SBarry Smith 
115c06d978dSMatthew Knepley /* Logging support */
116552e946dSBarry Smith #define    MAT_FILE_COOKIE 1211216    /* used to indicate matrices in binary files */
117be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_COOKIE;
118be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_FDCOLORING_COOKIE;
119be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_PARTITIONING_COOKIE;
120be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_NULLSPACE_COOKIE;
121e884886fSBarry Smith extern PetscCookie PETSCMAT_DLLEXPORT MATMFFD_COOKIE;
122c06d978dSMatthew Knepley 
123ceb03754SKris Buschelman /*E
124ceb03754SKris Buschelman     MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
125ceb03754SKris Buschelman      or MatGetSubMatrix() are to be reused to store the new matrix values.
126ceb03754SKris Buschelman 
127ceb03754SKris Buschelman     Level: beginner
128ceb03754SKris Buschelman 
129ceb03754SKris Buschelman    Any additions/changes here MUST also be made in include/finclude/petscmat.h
130ceb03754SKris Buschelman 
1310c451bc4SBarry Smith .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
132ceb03754SKris Buschelman E*/
133dfe085dbSJed Brown typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX} MatReuse;
134ceb03754SKris Buschelman 
1355494a064SHong Zhang /*E
1365494a064SHong Zhang     MatGetSubMatrixOption - Indicates if matrices obtained from a call to MatGetSubMatrices()
137829201f2SHong Zhang      include the matrix values. Currently it is only used by MatGetSeqNonzerostructure().
1385494a064SHong Zhang 
1395494a064SHong Zhang     Level: beginner
1405494a064SHong Zhang 
141829201f2SHong Zhang .seealso: MatGetSeqNonzerostructure()
1425494a064SHong Zhang E*/
1435494a064SHong Zhang typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatGetSubMatrixOption;
1445494a064SHong Zhang 
145e5bd5246SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(const char[]);
146c06d978dSMatthew Knepley 
147f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreate(MPI_Comm,Mat*);
148a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(MPI_Comm comm),(comm,&A),Mat,A)
149a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(),(PETSC_COMM_WORLD,&A),Mat,A)
150f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
151a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat,const MatType);
152be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetFromOptions(Mat);
153be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUpPreallocation(Mat);
154be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]);
155be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat));
15630de9b25SBarry Smith 
157f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOptionsPrefix(Mat,const char[]);
158f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAppendOptionsPrefix(Mat,const char[]);
159f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOptionsPrefix(Mat,const char*[]);
160f69a0ea3SMatthew Knepley 
16130de9b25SBarry Smith /*MC
16230de9b25SBarry Smith    MatRegisterDynamic - Adds a new matrix type
16330de9b25SBarry Smith 
16430de9b25SBarry Smith    Synopsis:
165c1ac3661SBarry Smith    PetscErrorCode MatRegisterDynamic(char *name,char *path,char *name_create,PetscErrorCode (*routine_create)(Mat))
16630de9b25SBarry Smith 
16730de9b25SBarry Smith    Not Collective
16830de9b25SBarry Smith 
16930de9b25SBarry Smith    Input Parameters:
17030de9b25SBarry Smith +  name - name of a new user-defined matrix type
17130de9b25SBarry Smith .  path - path (either absolute or relative) the library containing this solver
17230de9b25SBarry Smith .  name_create - name of routine to create method context
17330de9b25SBarry Smith -  routine_create - routine to create method context
17430de9b25SBarry Smith 
17530de9b25SBarry Smith    Notes:
17630de9b25SBarry Smith    MatRegisterDynamic() may be called multiple times to add several user-defined solvers.
17730de9b25SBarry Smith 
17830de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
17930de9b25SBarry Smith    is ignored.
18030de9b25SBarry Smith 
18130de9b25SBarry Smith    Sample usage:
18230de9b25SBarry Smith .vb
18330de9b25SBarry Smith    MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a,
18430de9b25SBarry Smith                "MyMatCreate",MyMatCreate);
18530de9b25SBarry Smith .ve
18630de9b25SBarry Smith 
18730de9b25SBarry Smith    Then, your solver can be chosen with the procedural interface via
18830de9b25SBarry Smith $     MatSetType(Mat,"my_mat")
18930de9b25SBarry Smith    or at runtime via the option
19030de9b25SBarry Smith $     -mat_type my_mat
19130de9b25SBarry Smith 
19230de9b25SBarry Smith    Level: advanced
19330de9b25SBarry Smith 
194ab901514SBarry Smith    Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
19530de9b25SBarry Smith          If your function is not being put into a shared library then use VecRegister() instead
19630de9b25SBarry Smith 
19730de9b25SBarry Smith .keywords: Mat, register
19830de9b25SBarry Smith 
19930de9b25SBarry Smith .seealso: MatRegisterAll(), MatRegisterDestroy()
20030de9b25SBarry Smith 
20130de9b25SBarry Smith M*/
202273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
203273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0)
204273d9f13SBarry Smith #else
205273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d)
20630de9b25SBarry Smith #endif
20730de9b25SBarry Smith 
208273d9f13SBarry Smith extern PetscTruth MatRegisterAllCalled;
209b0a32e0cSBarry Smith extern PetscFList MatList;
210b022a5c1SBarry Smith extern PetscFList MatColoringList;
211b022a5c1SBarry Smith extern PetscFList MatPartitioningList;
21228988994SBarry Smith 
2133b224e63SBarry Smith /*E
2143b224e63SBarry Smith     MatStructure - Indicates if the matrix has the same nonzero structure
2153b224e63SBarry Smith 
2163b224e63SBarry Smith     Level: beginner
2173b224e63SBarry Smith 
2183b224e63SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
2193b224e63SBarry Smith 
2203b224e63SBarry Smith .seealso: MatCopy(), KSPSetOperators(), PCSetOperators()
2213b224e63SBarry Smith E*/
2223b224e63SBarry Smith typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure;
2233b224e63SBarry Smith 
224be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
225be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
226be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
227ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A)
228ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A)
229ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A)
230ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A)
231ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A))
232ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A))
233ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A))
234be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
235ba966639SSatish 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)
236ba966639SSatish 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)
237ba966639SSatish 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)
238ba966639SSatish 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)
239ba966639SSatish 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))
240ba966639SSatish 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))
241ba966639SSatish 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))
242ba966639SSatish 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)
243ba966639SSatish 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)
244ba966639SSatish 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)
245ba966639SSatish 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)
246ba966639SSatish 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))
247ba966639SSatish 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))
248ba966639SSatish 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))
24963ab93bfSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
2508d7a6e47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
2518d7a6e47SBarry Smith 
252be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIRowbs(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
253be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
254ba966639SSatish 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)
255ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
256ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
257ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
258ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
259ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
260ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
261be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
262ba966639SSatish 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)
263ba966639SSatish 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)
264ba966639SSatish 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)
265ba966639SSatish 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)
266ba966639SSatish 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))
267ba966639SSatish 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))
268ba966639SSatish 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))
269ba966639SSatish 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)
270ba966639SSatish 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)
271ba966639SSatish 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)
272ba966639SSatish 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)
273ba966639SSatish 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))
274ba966639SSatish 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))
275ba966639SSatish 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))
276be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
277be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
278ba966639SSatish 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)
279ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
280ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
281ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
282ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
283ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
284ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
285be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
286ba966639SSatish 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)
287ba966639SSatish 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)
288ba966639SSatish 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)
289ba966639SSatish 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)
290ba966639SSatish 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))
291ba966639SSatish 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))
292ba966639SSatish 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))
293ba966639SSatish 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)
294ba966639SSatish 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)
295ba966639SSatish 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)
296ba966639SSatish 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)
297ba966639SSatish 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))
298ba966639SSatish 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))
299ba966639SSatish 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))
300be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
301ba966639SSatish 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)
302ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A)
303be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*);
304be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateNormal(Mat,Mat*);
305ba966639SSatish Balay PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A)
306ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateLRC(Mat,Mat,Mat,Mat*);
307284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*);
3081472f72bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
3091472f72bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPICRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
3102a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateScatter(MPI_Comm,VecScatter,Mat*);
3112a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterSetVecScatter(Mat,VecScatter);
3122a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterGetVecScatter(Mat,VecScatter*);
3138cdf2d9bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
314793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeAddMat(Mat,Mat);
315b52f573bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeMerge(Mat);
316793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
3176d7c1e57SBarry Smith typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
3186d7c1e57SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeSetType(Mat,MatCompositeType);
3196d7c1e57SBarry Smith 
320a6a5cd3fSDmitry Karpeev #ifdef PETSC_USE_MATFRAMEWORK
321a6a5cd3fSDmitry Karpeev typedef enum {MAT_FRAMEWORK_ADDITIVE, MAT_FRAMEWORK_MULTIPLICATIVE} MatFrameworkType;
322a6a5cd3fSDmitry Karpeev typedef enum {MAT_FRAMEWORK_ASSEMBLED, MAT_FRAMEWORK_DISASSEMBLED} MatFrameworkMode;
323a6a5cd3fSDmitry Karpeev 
324a6a5cd3fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateFramework(MPI_Comm,Mat *);
325a6a5cd3fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFrameworkSetType(Mat,MatFrameworkType);
326a6a5cd3fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFrameworkGetType(Mat,MatFrameworkType*);
327a6a5cd3fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFrameworkSetMode(Mat,MatFrameworkMode);
328a6a5cd3fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFrameworkGetMode(Mat,MatFrameworkMode*);
329a6a5cd3fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFrameworkGetBlockCount(Mat, PetscInt*);
330a6a5cd3fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFrameworkAddBlock(Mat, PetscInt*);
331a6a5cd3fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFrameworkSetBlockEmbedding(Mat, PetscInt, IS,IS);
332a6a5cd3fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFrameworkGetBlockEmbedding(Mat, PetscInt, IS, IS);
333a6a5cd3fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFrameworkSetBlock(Mat, PetscInt, Mat);
334a6a5cd3fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFrameworkGetBlock(Mat, PetscInt, Mat*);
335a6a5cd3fSDmitry Karpeev #endif
336a6a5cd3fSDmitry Karpeev 
3375a7f1df3SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqFFTW(MPI_Comm,PetscInt,const PetscInt[],Mat*);
338f20085c4SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateTranspose(Mat,Mat*);
339ee1cef2cSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSubMatrix(Mat,IS,IS,Mat*);
340ee1cef2cSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSubMatrixUpdate(Mat,Mat,IS,IS);
3411472f72bSBarry Smith 
3421d6018f0SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreatePython(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const char[],Mat*);
3431d6018f0SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPythonSetType(Mat,const char[]);
3441d6018f0SLisandro Dalcin 
3451d6018f0SLisandro Dalcin 
346f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUp(Mat);
347be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat);
34821c89e3eSBarry Smith 
3490c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat);
35099cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRealPart(Mat);
35199cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatImaginaryPart(Mat);
352bfc7d00aSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonalBlock(Mat,PetscTruth*,MatReuse,Mat*);
35399cafbc1SBarry Smith 
3548ed539a5SBarry Smith /* ------------------------------------------------------------*/
355be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
356be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
35787d4246cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
358f259bd47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
35984cb2905SBarry Smith 
3602ef4de8bSBarry Smith /*S
3612ef4de8bSBarry Smith      MatStencil - Data structure (C struct) for storing information about a single row or
3622ef4de8bSBarry Smith         column of a matrix as index on an associated grid.
3632ef4de8bSBarry Smith 
3642ef4de8bSBarry Smith    Level: beginner
3652ef4de8bSBarry Smith 
3662ef4de8bSBarry Smith   Concepts: matrix; linear operator
3672ef4de8bSBarry Smith 
368d7bd93baSBarry Smith .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil()
3692ef4de8bSBarry Smith S*/
370435da068SBarry Smith typedef struct {
371c1ac3661SBarry Smith   PetscInt k,j,i,c;
372435da068SBarry Smith } MatStencil;
3732ef4de8bSBarry Smith 
374be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
375be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
376be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
377435da068SBarry Smith 
378be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat,ISColoring);
379be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat,void*);
380be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat,PetscInt,void*);
3813a7fca6bSBarry Smith 
382d91e6319SBarry Smith /*E
383d91e6319SBarry Smith     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
384d91e6319SBarry Smith      to continue to add values to it
385d91e6319SBarry Smith 
386d91e6319SBarry Smith     Level: beginner
387d91e6319SBarry Smith 
388d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd()
389d91e6319SBarry Smith E*/
3906d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
391be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat,MatAssemblyType);
392be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat,MatAssemblyType);
393be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat,PetscTruth*);
3944f9c727eSBarry Smith 
3951d73ed98SBarry Smith 
39630de9b25SBarry Smith 
397d91e6319SBarry Smith /*E
398d91e6319SBarry Smith     MatOption - Options that may be set for a matrix and its behavior or storage
399d91e6319SBarry Smith 
400d91e6319SBarry Smith     Level: beginner
401d91e6319SBarry Smith 
4020a835dfdSSatish Balay    Any additions/changes here MUST also be made in include/finclude/petscmat.h
403d91e6319SBarry Smith 
404d91e6319SBarry Smith .seealso: MatSetOption()
405d91e6319SBarry Smith E*/
406512a5fc5SBarry Smith typedef enum {MAT_ROW_ORIENTED,MAT_NEW_NONZERO_LOCATIONS,
4074e0d8c25SBarry Smith               MAT_SYMMETRIC,
4084e0d8c25SBarry Smith               MAT_STRUCTURALLY_SYMMETRIC,
4098047e77bSBarry Smith               MAT_NEW_DIAGONALS,MAT_IGNORE_OFF_PROC_ENTRIES,
4104e0d8c25SBarry Smith               MAT_NEW_NONZERO_LOCATION_ERR,
4114e0d8c25SBarry Smith               MAT_NEW_NONZERO_ALLOCATION_ERR,MAT_USE_HASH_TABLE,
412a9817697SBarry Smith               MAT_KEEP_NONZERO_PATTERN,MAT_IGNORE_ZERO_ENTRIES,
4134e0d8c25SBarry Smith               MAT_USE_INODES,
4144e0d8c25SBarry Smith               MAT_HERMITIAN,
4154e0d8c25SBarry Smith               MAT_SYMMETRY_ETERNAL,
4164e0d8c25SBarry Smith               MAT_USE_COMPRESSEDROW,
4174e0d8c25SBarry Smith               MAT_IGNORE_LOWER_TRIANGULAR,MAT_ERROR_LOWER_TRIANGULAR,
41828b2fa4aSMatthew Knepley               MAT_GETROW_UPPERTRIANGULAR,MAT_UNUSED_NONZERO_LOCATION_ERR,
41928b2fa4aSMatthew Knepley               NUM_MAT_OPTIONS} MatOption;
420290bbb0aSBarry Smith extern const char *MatOptions[];
4214e0d8c25SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption,PetscTruth);
422a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,const MatType*);
423a313700dSBarry Smith PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),const MatType,t)
42484cb2905SBarry Smith 
425be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
426be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
427be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
428f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowUpperTriangular(Mat);
429f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowUpperTriangular(Mat);
430be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
431be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
432be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt);
433be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]);
434ba966639SSatish Balay PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a)
435be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]);
436be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *);
437ba966639SSatish Balay PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a)
438be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt);
4397b80b807SBarry Smith 
4401620fd73SBarry Smith 
441be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec);
44289c6957cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultDiagonalBlock(Mat,Vec,Vec);
443be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec);
444ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
445be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec);
446547795f9SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultHermitianTranspose(Mat,Vec,Vec);
447be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*);
448ba966639SSatish Balay PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t)
449e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0,&t),PetscTruth,t)
4501cbb95d3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscTruth*);
451be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec);
4525cb05578SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
453ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
454be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec);
455be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec);
4562bebee5dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatSolve(Mat,Mat,Mat);
457f5edf698SHong Zhang 
458d91e6319SBarry Smith /*E
459d91e6319SBarry Smith     MatDuplicateOption - Indicates if a duplicated sparse matrix should have
460d91e6319SBarry Smith   its numerical values copied over or just its nonzero structure.
461d91e6319SBarry Smith 
462d91e6319SBarry Smith     Level: beginner
463d91e6319SBarry Smith 
464d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
465d91e6319SBarry Smith 
46670dcbbb9SBarry Smith $   MAT_SHARE_NONZERO_PATTERN - the i and j arrays in the new matrix will be shared with the original matrix
46770dcbbb9SBarry Smith $                               this also triggers the MAT_DO_NOT_COPY_VALUES option. This is used when you
46870dcbbb9SBarry Smith $                               have several matrices with the same nonzero pattern.
46970dcbbb9SBarry Smith 
470d91e6319SBarry Smith .seealso: MatDuplicate()
471d91e6319SBarry Smith E*/
47270dcbbb9SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;
4732e8a6d31SBarry Smith 
474a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat,const MatType,MatReuse,Mat*);
475a313700dSBarry Smith PetscPolymorphicFunction(MatConvert,(Mat A,const MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a)
476be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat,MatDuplicateOption,Mat*);
477ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a)
478ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a)
47994a9d846SBarry Smith 
480cb5b572fSBarry Smith 
481be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat,Mat,MatStructure);
482be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat,PetscViewer);
483be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat,PetscReal,PetscTruth*);
484ba966639SSatish Balay PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t)
485e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0,&t),PetscTruth,t)
486be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscTruth*);
487ba966639SSatish Balay PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t)
4881cbb95d3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscReal,PetscTruth*);
4891cbb95d3SBarry Smith PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,0,&t),PetscTruth,t)
490be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*);
491be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*);
49264c62002SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMissingDiagonal(Mat,PetscTruth *,PetscInt *);
493a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoad(PetscViewer,const MatType,Mat*);
494a313700dSBarry Smith PetscPolymorphicFunction(MatLoad,(PetscViewer v,const MatType t),(v,t,&a),Mat,a)
4957b80b807SBarry Smith 
4968f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
4978f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
4988f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
4998f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
500d4fbbf0eSBarry Smith 
501d91e6319SBarry Smith /*S
502d91e6319SBarry Smith      MatInfo - Context of matrix information, used with MatGetInfo()
503d91e6319SBarry Smith 
504d91e6319SBarry Smith    In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
505d91e6319SBarry Smith 
506d91e6319SBarry Smith    Level: intermediate
507d91e6319SBarry Smith 
508d91e6319SBarry Smith   Concepts: matrix^nonzero information
509d91e6319SBarry Smith 
510d9274352SBarry Smith .seealso:  MatGetInfo(), MatInfoType
511d91e6319SBarry Smith S*/
5124e220ebcSLois Curfman McInnes typedef struct {
513b0a32e0cSBarry Smith   PetscLogDouble block_size;                         /* block size */
514b0a32e0cSBarry Smith   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
515b0a32e0cSBarry Smith   PetscLogDouble memory;                             /* memory allocated */
516b0a32e0cSBarry Smith   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
517b0a32e0cSBarry Smith   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
518b0a32e0cSBarry Smith   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
519b0a32e0cSBarry Smith   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
5204e220ebcSLois Curfman McInnes } MatInfo;
5214e220ebcSLois Curfman McInnes 
522d9274352SBarry Smith /*E
523d9274352SBarry Smith     MatInfoType - Indicates if you want information about the local part of the matrix,
524d9274352SBarry Smith      the entire parallel matrix or the maximum over all the local parts.
525d9274352SBarry Smith 
526d9274352SBarry Smith     Level: beginner
527d9274352SBarry Smith 
528d9274352SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
529d9274352SBarry Smith 
530d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo
531d9274352SBarry Smith E*/
5327b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
533be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat,MatInfoType,MatInfo*);
534be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatValid(Mat,PetscTruth*);
535be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat,Vec);
536985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec,PetscInt[]);
537985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMin(Mat,Vec,PetscInt[]);
538985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
539c87e5d42SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMinAbs(Mat,Vec,PetscInt[]);
54086697f06SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowSum(Mat,Vec);
541fc4dec0aSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,MatReuse,Mat*);
542fc4dec0aSBarry Smith PetscPolymorphicFunction(MatTranspose,(Mat A),(A,MAT_INITIAL_MATRIX,&t),Mat,t)
543eeffb40dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHermitianTranspose(Mat,MatReuse,Mat*);
544be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *);
545ba966639SSatish Balay PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t)
546be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *);
547be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec);
548be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode);
549be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscTruth*);
550ba966639SSatish Balay PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t)
551be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscTruth*);
552be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*);
553be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*);
554be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*);
5557b80b807SBarry Smith 
556be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *);
557ba966639SSatish Balay PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n)
558242f1d38SBarry Smith EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal *);
559be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat);
560f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar);
561f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar);
562f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*);
563f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumnsIS(Mat,IS,const PetscScalar*);
5647b80b807SBarry Smith 
565be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscTruth);
566be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec);
567be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec);
5685ef9f2a5SBarry Smith 
569be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*);
570be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*);
571be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
5728ee2e534SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRanges(Mat,const PetscInt**);
573f4b8409dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
57472ca8751SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangesColumn(Mat,const PetscInt**);
5757b80b807SBarry Smith 
576be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
577be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]);
5784aa3045dSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,MatReuse,Mat *);
579f6d58c54SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSeqNonzeroStructure(Mat,Mat*);
580f6d58c54SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroySeqNonzeroStructure(Mat*);
5815494a064SHong Zhang 
582be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
583be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
584be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
585be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat);
586be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat);
587be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*);
588be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
589be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*);
5901d79065fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscInt**,MatScalar**,Mat*);
59143eb5e2fSMatthew Knepley #if defined (PETSC_USE_CTABLE)
592cd116e26SSatish Balay #include "petscctable.h"
59343eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *);
59443eb5e2fSMatthew Knepley #else
59543eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *);
59643eb5e2fSMatthew Knepley #endif
5978c7482ecSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);
5988efafbd8SBarry Smith 
599be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
6007b80b807SBarry Smith 
601be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
602be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
603be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat);
60422440eb1SKris Buschelman 
605be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
606be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
607be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat);
60822440eb1SKris Buschelman 
609be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*);
610be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*);
611be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat);
612bc011b1eSHong Zhang 
613f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure);
61404aac2b0SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat,MatStructure);
6151c741599SHong Zhang 
616f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar);
617f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar);
6187b80b807SBarry Smith 
619be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping);
620be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping);
621f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar);
622f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar);
623be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
624be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
625052efed2SBarry Smith 
626be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt);
627be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
62890f02eecSBarry Smith 
629be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec);
6300c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec);
631ba966639SSatish Balay PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
632be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec);
633be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*);
63469db28dcSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*);
635bd481603SBarry Smith 
636bd481603SBarry Smith /*MC
6371620fd73SBarry Smith    MatSetValue - Set a single entry into a matrix.
6381620fd73SBarry Smith 
6391620fd73SBarry Smith    Not collective
6401620fd73SBarry Smith 
6411620fd73SBarry Smith    Input Parameters:
6421620fd73SBarry Smith +  m - the matrix
6431620fd73SBarry Smith .  row - the row location of the entry
6441620fd73SBarry Smith .  col - the column location of the entry
6451620fd73SBarry Smith .  value - the value to insert
6461620fd73SBarry Smith -  mode - either INSERT_VALUES or ADD_VALUES
6471620fd73SBarry Smith 
6481620fd73SBarry Smith    Notes:
6491620fd73SBarry Smith    For efficiency one should use MatSetValues() and set several or many
6501620fd73SBarry Smith    values simultaneously if possible.
6511620fd73SBarry Smith 
6521620fd73SBarry Smith    Level: beginner
6531620fd73SBarry Smith 
6541620fd73SBarry Smith .seealso: MatSetValues(), MatSetValueLocal()
6551620fd73SBarry Smith M*/
6561620fd73SBarry 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);}
6571620fd73SBarry Smith 
6581620fd73SBarry Smith PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);}
6591620fd73SBarry Smith 
6601620fd73SBarry 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);}
6611620fd73SBarry Smith 
6621620fd73SBarry Smith /*MC
6630d2a7ff2SSatish Balay    MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
664bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
665bd481603SBarry Smith 
666bd481603SBarry Smith    Synopsis:
667c1ac3661SBarry Smith    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
668bd481603SBarry Smith 
669bd481603SBarry Smith    Collective on MPI_Comm
670bd481603SBarry Smith 
671bd481603SBarry Smith    Input Parameters:
672bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
673859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
674859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
675bd481603SBarry Smith 
676bd481603SBarry Smith    Output Parameters:
677bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
678bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
679bd481603SBarry Smith 
680bd481603SBarry Smith 
681bd481603SBarry Smith    Level: intermediate
682bd481603SBarry Smith 
683bd481603SBarry Smith    Notes:
684bd481603SBarry Smith    See the chapter in the users manual on performance for more details
685bd481603SBarry Smith 
6861d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
687bd481603SBarry Smith 
688bd481603SBarry Smith    Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
689bd481603SBarry Smith 
6901620fd73SBarry Smith    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
6911620fd73SBarry Smith 
692bd481603SBarry Smith   Concepts: preallocation^Matrix
693bd481603SBarry Smith 
694bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
695bd481603SBarry Smith           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
696bd481603SBarry Smith M*/
697c4f061fbSSatish Balay #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
6987c922b88SBarry Smith { \
699a89bc211SBarry Smith   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
700a89bc211SBarry Smith   _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
701a89bc211SBarry Smith   _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
702a89bc211SBarry Smith   _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
703c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
704a89bc211SBarry Smith   _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
7057c922b88SBarry Smith 
706bd481603SBarry Smith /*MC
7070d2a7ff2SSatish Balay    MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per
708bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
709bd481603SBarry Smith 
710bd481603SBarry Smith    Synopsis:
711c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
712bd481603SBarry Smith 
713bd481603SBarry Smith    Collective on MPI_Comm
714bd481603SBarry Smith 
715bd481603SBarry Smith    Input Parameters:
716bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
717859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
718859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
719bd481603SBarry Smith 
720bd481603SBarry Smith    Output Parameters:
721bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
722bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
723bd481603SBarry Smith 
724bd481603SBarry Smith 
725bd481603SBarry Smith    Level: intermediate
726bd481603SBarry Smith 
727bd481603SBarry Smith    Notes:
728bd481603SBarry Smith    See the chapter in the users manual on performance for more details
729bd481603SBarry Smith 
7301d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
731bd481603SBarry Smith 
7321620fd73SBarry Smith    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
7331620fd73SBarry Smith 
734bd481603SBarry Smith   Concepts: preallocation^Matrix
735bd481603SBarry Smith 
736bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
737bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
738bd481603SBarry Smith M*/
739222b16d4SBarry Smith #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \
740222b16d4SBarry Smith { \
741a89bc211SBarry Smith   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__end; \
742a89bc211SBarry Smith   _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
743a89bc211SBarry Smith   _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
744a89bc211SBarry Smith   _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
745c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\
746a89bc211SBarry Smith   _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
747222b16d4SBarry Smith 
748bd481603SBarry Smith /*MC
749bd481603SBarry Smith    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
750bd481603SBarry Smith        inserted using a local number of the rows and columns
751bd481603SBarry Smith 
752bd481603SBarry Smith    Synopsis:
753c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
754bd481603SBarry Smith 
755bd481603SBarry Smith    Not Collective
756bd481603SBarry Smith 
757bd481603SBarry Smith    Input Parameters:
758bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
759bd481603SBarry Smith .  nrows - the number of rows indicated
7601d73ed98SBarry Smith .  rows - the indices of the rows
761bd481603SBarry Smith .  ncols - the number of columns in the matrix
762bd481603SBarry Smith .  cols - the columns indicated
763bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
764bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
765bd481603SBarry Smith 
766bd481603SBarry Smith 
767bd481603SBarry Smith    Level: intermediate
768bd481603SBarry Smith 
769bd481603SBarry Smith    Notes:
770bd481603SBarry Smith    See the chapter in the users manual on performance for more details
771bd481603SBarry Smith 
7721d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
773bd481603SBarry Smith 
774bd481603SBarry Smith   Concepts: preallocation^Matrix
775bd481603SBarry Smith 
776bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
777bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
778bd481603SBarry Smith M*/
779c4f061fbSSatish Balay #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
780c4f061fbSSatish Balay {\
781c1ac3661SBarry Smith   PetscInt __l;\
782ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
783ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
784c4f061fbSSatish Balay   for (__l=0;__l<nrows;__l++) {\
785ef66eb69SBarry Smith     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
786c4f061fbSSatish Balay   }\
787c4f061fbSSatish Balay }
788c4f061fbSSatish Balay 
789bd481603SBarry Smith /*MC
790bd481603SBarry Smith    MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
791bd481603SBarry Smith        inserted using a local number of the rows and columns
792bd481603SBarry Smith 
793bd481603SBarry Smith    Synopsis:
794c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
795bd481603SBarry Smith 
796bd481603SBarry Smith    Not Collective
797bd481603SBarry Smith 
798bd481603SBarry Smith    Input Parameters:
799bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
800bd481603SBarry Smith .  nrows - the number of rows indicated
8011d73ed98SBarry Smith .  rows - the indices of the rows
802bd481603SBarry Smith .  ncols - the number of columns in the matrix
803bd481603SBarry Smith .  cols - the columns indicated
804bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
805bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
806bd481603SBarry Smith 
807bd481603SBarry Smith 
808bd481603SBarry Smith    Level: intermediate
809bd481603SBarry Smith 
810bd481603SBarry Smith    Notes:
811bd481603SBarry Smith    See the chapter in the users manual on performance for more details
812bd481603SBarry Smith 
813bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
814bd481603SBarry Smith 
815bd481603SBarry Smith   Concepts: preallocation^Matrix
816bd481603SBarry Smith 
817bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
818bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
819bd481603SBarry Smith M*/
820d3d32019SBarry Smith #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
821d3d32019SBarry Smith {\
822c1ac3661SBarry Smith   PetscInt __l;\
823d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
824d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
825d3d32019SBarry Smith   for (__l=0;__l<nrows;__l++) {\
826d3d32019SBarry Smith     _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
827d3d32019SBarry Smith   }\
828d3d32019SBarry Smith }
829d3d32019SBarry Smith 
830bd481603SBarry Smith /*MC
831bd481603SBarry Smith    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
832bd481603SBarry Smith        inserted using a local number of the rows and columns
833bd481603SBarry Smith 
834bd481603SBarry Smith    Synopsis:
835c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
836bd481603SBarry Smith 
837bd481603SBarry Smith    Not Collective
838bd481603SBarry Smith 
839bd481603SBarry Smith    Input Parameters:
84064075487SBarry Smith +  row - the row
841bd481603SBarry Smith .  ncols - the number of columns in the matrix
842a50f8bf6SHong Zhang -  cols - the columns indicated
843a50f8bf6SHong Zhang 
844a50f8bf6SHong Zhang    Output Parameters:
845a50f8bf6SHong Zhang +  dnz - the array that will be passed to the matrix preallocation routines
846bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
847bd481603SBarry Smith 
848bd481603SBarry Smith 
849bd481603SBarry Smith    Level: intermediate
850bd481603SBarry Smith 
851bd481603SBarry Smith    Notes:
852bd481603SBarry Smith    See the chapter in the users manual on performance for more details
853bd481603SBarry Smith 
854bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
855bd481603SBarry Smith 
8561620fd73SBarry Smith    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
8571620fd73SBarry Smith 
858bd481603SBarry Smith   Concepts: preallocation^Matrix
859bd481603SBarry Smith 
860bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
861bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
862bd481603SBarry Smith M*/
863c4f061fbSSatish Balay #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
864c1ac3661SBarry Smith { PetscInt __i; \
8658ee2e534SBarry Smith   if (row < __rstart) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D less than first local row %D",row,__rstart);\
866a89bc211SBarry 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);\
8677c922b88SBarry Smith   for (__i=0; __i<nc; __i++) {\
86864075487SBarry Smith     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
8697cc688d7SBarry Smith     else dnz[row - __rstart]++;\
8707c922b88SBarry Smith   }\
8717c922b88SBarry Smith }
8727c922b88SBarry Smith 
873bd481603SBarry Smith /*MC
874bd481603SBarry Smith    MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
875bd481603SBarry Smith        inserted using a local number of the rows and columns
876bd481603SBarry Smith 
877bd481603SBarry Smith    Synopsis:
878c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
879bd481603SBarry Smith 
880bd481603SBarry Smith    Not Collective
881bd481603SBarry Smith 
882bd481603SBarry Smith    Input Parameters:
883bd481603SBarry Smith +  nrows - the number of rows indicated
8841d73ed98SBarry Smith .  rows - the indices of the rows
885bd481603SBarry Smith .  ncols - the number of columns in the matrix
886bd481603SBarry Smith .  cols - the columns indicated
887bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
888bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
889bd481603SBarry Smith 
890bd481603SBarry Smith 
891bd481603SBarry Smith    Level: intermediate
892bd481603SBarry Smith 
893bd481603SBarry Smith    Notes:
894bd481603SBarry Smith    See the chapter in the users manual on performance for more details
895bd481603SBarry Smith 
896bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
897bd481603SBarry Smith 
8981620fd73SBarry Smith    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
8991620fd73SBarry Smith 
900bd481603SBarry Smith   Concepts: preallocation^Matrix
901bd481603SBarry Smith 
902bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
903bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
904bd481603SBarry Smith M*/
905d3d32019SBarry Smith #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
906c1ac3661SBarry Smith { PetscInt __i; \
907d3d32019SBarry Smith   for (__i=0; __i<nc; __i++) {\
908d3d32019SBarry Smith     if (cols[__i] >= __end) onz[row - __rstart]++; \
909d3d32019SBarry Smith     else if (cols[__i] >= row) dnz[row - __rstart]++;\
910d3d32019SBarry Smith   }\
911d3d32019SBarry Smith }
912d3d32019SBarry Smith 
913bd481603SBarry Smith /*MC
91416371a99SBarry Smith    MatPreallocateLocation -  An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists
91516371a99SBarry Smith 
91616371a99SBarry Smith    Synopsis:
91716371a99SBarry Smith    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)
91816371a99SBarry Smith 
91916371a99SBarry Smith    Not Collective
92016371a99SBarry Smith 
92116371a99SBarry Smith    Input Parameters:
92216371a99SBarry Smith .  A - matrix
92316371a99SBarry Smith .  row - row where values exist (must be local to this process)
92416371a99SBarry Smith .  ncols - number of columns
92516371a99SBarry Smith .  cols - columns with nonzeros
92616371a99SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
92716371a99SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
92816371a99SBarry Smith 
92916371a99SBarry Smith 
93016371a99SBarry Smith    Level: intermediate
93116371a99SBarry Smith 
93216371a99SBarry Smith    Notes:
93316371a99SBarry Smith    See the chapter in the users manual on performance for more details
93416371a99SBarry Smith 
93516371a99SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
93616371a99SBarry Smith 
93716371a99SBarry Smith    This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.
93816371a99SBarry Smith 
93916371a99SBarry Smith   Concepts: preallocation^Matrix
94016371a99SBarry Smith 
94116371a99SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
94216371a99SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
94316371a99SBarry Smith M*/
94416371a99SBarry 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);}
94516371a99SBarry Smith 
94616371a99SBarry Smith 
94716371a99SBarry Smith /*MC
9480d2a7ff2SSatish Balay    MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
949bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
950bd481603SBarry Smith 
951bd481603SBarry Smith    Synopsis:
952c1ac3661SBarry Smith    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
953bd481603SBarry Smith 
954bd481603SBarry Smith    Collective on MPI_Comm
955bd481603SBarry Smith 
956bd481603SBarry Smith    Input Parameters:
95716371a99SBarry Smith +  dnz - the array that was be passed to the matrix preallocation routines
958bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
959bd481603SBarry Smith 
960bd481603SBarry Smith 
961bd481603SBarry Smith    Level: intermediate
962bd481603SBarry Smith 
963bd481603SBarry Smith    Notes:
964bd481603SBarry Smith    See the chapter in the users manual on performance for more details
965bd481603SBarry Smith 
966bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
967bd481603SBarry Smith 
9681620fd73SBarry Smith    This is a MACRO not a function because it closes the { started in MatPreallocateInitialize().
9691620fd73SBarry Smith 
970bd481603SBarry Smith   Concepts: preallocation^Matrix
971bd481603SBarry Smith 
972bd481603SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
973bd481603SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
974bd481603SBarry Smith M*/
975a89bc211SBarry Smith #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}
9767c922b88SBarry Smith 
977bd481603SBarry Smith 
978bd481603SBarry Smith 
9797b80b807SBarry Smith /* Routines unique to particular data structures */
980be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **);
981ba966639SSatish Balay PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t)
982698d4c6aSKris Buschelman 
983be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*);
984be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
985698d4c6aSKris Buschelman 
986be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
987be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
988be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
989c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
990c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
9917b80b807SBarry Smith 
992a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4
993a96a251dSBarry Smith 
994be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
995ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
996be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
997ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
998be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
999ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz))
1000273d9f13SBarry Smith 
1001be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1002ba966639SSatish Balay PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz))
1003be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1004be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
100553803f26SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
1006725b52f3SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1007be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
1008be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1009be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
1010be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
1011284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
1012be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsSetPreallocation(Mat,PetscInt,const PetscInt[]);
1013be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
1014be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
1015be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void));
1016273d9f13SBarry Smith 
1017be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt);
1018ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDenseGetLocalMatrix(Mat,Mat*);
10191b807ce4Svictorle 
1020be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat);
1021be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat);
10222e8a6d31SBarry Smith 
1023be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*);
10243a7fca6bSBarry Smith 
10257b80b807SBarry Smith /*
10267b80b807SBarry Smith   These routines are not usually accessed directly, rather solving is
102794b7f48cSBarry Smith   done through the KSP and PC interfaces.
10287b80b807SBarry Smith */
10297b80b807SBarry Smith 
1030d9274352SBarry Smith /*E
1031d9274352SBarry Smith     MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
1032d9274352SBarry Smith        with an optional dynamic library name, for example
1033d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
1034d9274352SBarry Smith 
1035d9274352SBarry Smith    Level: beginner
1036d9274352SBarry Smith 
1037e5a9bf91SBarry Smith    Cannot use const because the PC objects manipulate the string
1038e5a9bf91SBarry Smith 
1039d9274352SBarry Smith .seealso: MatGetOrdering()
1040d9274352SBarry Smith E*/
10413eaad2caSSatish Balay #define MatOrderingType char*
1042b12f92e5SBarry Smith #define MATORDERING_NATURAL     "natural"
1043b12f92e5SBarry Smith #define MATORDERING_ND          "nd"
1044b12f92e5SBarry Smith #define MATORDERING_1WD         "1wd"
1045b12f92e5SBarry Smith #define MATORDERING_RCM         "rcm"
1046b12f92e5SBarry Smith #define MATORDERING_QMD         "qmd"
1047b12f92e5SBarry Smith #define MATORDERING_ROWLENGTH   "rowlength"
1048e106eecfSBarry Smith #define MATORDERING_DSC_ND      "dsc_nd"         /* these three are only for DSCPACK, see its documentation for details */
104962152c8bSBarry Smith #define MATORDERING_DSC_MMD     "dsc_mmd"
105062152c8bSBarry Smith #define MATORDERING_DSC_MDF     "dsc_mdf"
1051c06d978dSMatthew Knepley #define MATORDERING_CONSTRAINED "constrained"
1052c06d978dSMatthew Knepley #define MATORDERING_IDENTITY    "identity"
1053c06d978dSMatthew Knepley #define MATORDERING_REVERSE     "reverse"
10548fa24674SBarry Smith #define MATORDERING_FLOW        "flow"
1055b12f92e5SBarry Smith 
1056f2416520SSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
1057be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list);
1058f2416520SSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));
105930de9b25SBarry Smith 
106030de9b25SBarry Smith /*MC
106130de9b25SBarry Smith    MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the
106230de9b25SBarry Smith                                matrix package.
106330de9b25SBarry Smith 
106430de9b25SBarry Smith    Synopsis:
1065c1ac3661SBarry Smith    PetscErrorCode MatOrderingRegisterDynamic(char *name_ordering,char *path,char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
106630de9b25SBarry Smith 
106730de9b25SBarry Smith    Not Collective
106830de9b25SBarry Smith 
106930de9b25SBarry Smith    Input Parameters:
107030de9b25SBarry Smith +  sname - name of ordering (for example MATORDERING_ND)
107130de9b25SBarry Smith .  path - location of library where creation routine is
107230de9b25SBarry Smith .  name - name of function that creates the ordering type,a string
107330de9b25SBarry Smith -  function - function pointer that creates the ordering
107430de9b25SBarry Smith 
107530de9b25SBarry Smith    Level: developer
107630de9b25SBarry Smith 
107730de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
107830de9b25SBarry Smith    is ignored.
107930de9b25SBarry Smith 
108030de9b25SBarry Smith    Sample usage:
108130de9b25SBarry Smith .vb
108230de9b25SBarry Smith    MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
108330de9b25SBarry Smith                "MyOrder",MyOrder);
108430de9b25SBarry Smith .ve
108530de9b25SBarry Smith 
108630de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
108730de9b25SBarry Smith $     MatOrderingSetType(part,"my_order)
108830de9b25SBarry Smith    or at runtime via the option
10892401956bSBarry Smith $     -pc_factor_mat_ordering_type my_order
109030de9b25SBarry Smith 
1091ab901514SBarry Smith    ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
109230de9b25SBarry Smith 
109330de9b25SBarry Smith .keywords: matrix, ordering, register
109430de9b25SBarry Smith 
109530de9b25SBarry Smith .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
109630de9b25SBarry Smith M*/
1097aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1098f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
1099b12f92e5SBarry Smith #else
1100f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
1101b12f92e5SBarry Smith #endif
110230de9b25SBarry Smith 
1103be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void);
1104be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]);
11052bad1931SBarry Smith extern PetscTruth MatOrderingRegisterAllCalled;
1106b0a32e0cSBarry Smith extern PetscFList MatOrderingList;
1107d4fbbf0eSBarry Smith 
1108be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1109a2ce50c7SBarry Smith 
1110d91e6319SBarry Smith /*S
11112401956bSBarry Smith    MatFactorInfo - Data passed into the matrix factorization routines
1112b00f7748SHong Zhang 
111361cad860SBarry Smith    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
111461cad860SBarry Smith $     MatFactorInfo  info(MAT_FACTORINFO_SIZE)
1115b00f7748SHong Zhang 
111615e8a5b3SHong Zhang    Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
1117b00f7748SHong Zhang 
111861cad860SBarry Smith       You can use MatFactorInfoInitialize() to set default values.
111961cad860SBarry Smith 
1120b00f7748SHong Zhang    Level: developer
1121b00f7748SHong Zhang 
1122d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1123d7d82daaSBarry Smith           MatFactorInfoInitialize()
1124b00f7748SHong Zhang 
1125b00f7748SHong Zhang S*/
1126b00f7748SHong Zhang typedef struct {
11270a29876aSHong Zhang   PetscReal     shiftnz;        /* scaling of identity added to matrix to prevent zero pivots */
1128fbf22428SSatish Balay   PetscReal     shiftpd;        /* if true, shift until positive pivots */
112915e8a5b3SHong Zhang   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
113085317021SBarry Smith   PetscReal     usedt;
113115e8a5b3SHong Zhang   PetscReal     dt;             /* drop tolerance */
1132b00f7748SHong Zhang   PetscReal     dtcol;          /* tolerance for pivoting */
113315e8a5b3SHong Zhang   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
113467e28bfeSBarry Smith   PetscReal     fill;           /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1135348344bbSBarry Smith   PetscReal     levels;         /* ICC/ILU(levels) */
1136bcd9e38bSBarry Smith   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1137bcd9e38bSBarry Smith                                    factorization may be faster if do not pivot */
113862bba022SBarry Smith   PetscReal     shiftinblocks;  /* if block in block factorization has zero pivot then shift diagonal until non-singular */
113915e8a5b3SHong Zhang   PetscReal     zeropivot;      /* pivot is called zero if less than this */
114015e8a5b3SHong Zhang } MatFactorInfo;
1141ffa6d0a5SLois Curfman McInnes 
1142be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*);
11430481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
11440481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
11450481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
11460481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
11470481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
11480481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
11490481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
11500481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
11510481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,const MatFactorInfo*);
11520481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
11530481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactor(Mat,IS,IS,const MatFactorInfo*,Mat *);
11543c2a7987SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
11553c2a7987SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactorNumeric(Mat,Mat,const MatFactorInfo*);
1156be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1157be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec);
1158be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec);
1159be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec);
1160be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec);
1161be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec);
1162be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1163be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs);
11648ed539a5SBarry Smith 
1165be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat);
1166bb5a7306SBarry Smith 
1167d91e6319SBarry Smith /*E
1168d91e6319SBarry Smith     MatSORType - What type of (S)SOR to perform
1169bb1eb677SSatish Balay 
1170d91e6319SBarry Smith     Level: beginner
1171d91e6319SBarry Smith 
1172d9274352SBarry Smith    May be bitwise ORd together
1173d9274352SBarry Smith 
1174d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1175d91e6319SBarry Smith 
11764e7234bfSBarry Smith    MatSORType may be bitwise ORd together, so do not change the numbers
11774e7234bfSBarry Smith 
117841f059aeSBarry Smith .seealso: MatSOR()
1179d91e6319SBarry Smith E*/
1180ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1181ee50ffe9SBarry Smith               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1182ee50ffe9SBarry Smith               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
118384cb2905SBarry Smith               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
118441f059aeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
11858ed539a5SBarry Smith 
1186d4fbbf0eSBarry Smith /*
1187639f9d9dSBarry Smith     These routines are for efficiently computing Jacobians via finite differences.
1188639f9d9dSBarry Smith */
1189b12f92e5SBarry Smith 
1190d9274352SBarry Smith /*E
1191d9274352SBarry Smith     MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1192d9274352SBarry Smith        with an optional dynamic library name, for example
1193d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1194d9274352SBarry Smith 
1195d9274352SBarry Smith    Level: beginner
1196d9274352SBarry Smith 
1197d9274352SBarry Smith .seealso: MatGetColoring()
1198d9274352SBarry Smith E*/
1199a313700dSBarry Smith #define MatColoringType char*
1200b12f92e5SBarry Smith #define MATCOLORING_NATURAL "natural"
1201b12f92e5SBarry Smith #define MATCOLORING_SL      "sl"
1202b12f92e5SBarry Smith #define MATCOLORING_LF      "lf"
1203b12f92e5SBarry Smith #define MATCOLORING_ID      "id"
1204b12f92e5SBarry Smith 
1205ab970d9bSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,const MatColoringType,ISColoring*);
12062e90c967SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *));
120730de9b25SBarry Smith 
120830de9b25SBarry Smith /*MC
120930de9b25SBarry Smith    MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
121030de9b25SBarry Smith                                matrix package.
121130de9b25SBarry Smith 
121230de9b25SBarry Smith    Synopsis:
1213c1ac3661SBarry Smith    PetscErrorCode MatColoringRegisterDynamic(char *name_coloring,char *path,char *name_create,PetscErrorCode (*routine_create)(MatColoring))
121430de9b25SBarry Smith 
121530de9b25SBarry Smith    Not Collective
121630de9b25SBarry Smith 
121730de9b25SBarry Smith    Input Parameters:
121830de9b25SBarry Smith +  sname - name of Coloring (for example MATCOLORING_SL)
121930de9b25SBarry Smith .  path - location of library where creation routine is
122030de9b25SBarry Smith .  name - name of function that creates the Coloring type, a string
122130de9b25SBarry Smith -  function - function pointer that creates the coloring
122230de9b25SBarry Smith 
122330de9b25SBarry Smith    Level: developer
122430de9b25SBarry Smith 
122530de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
122630de9b25SBarry Smith    is ignored.
122730de9b25SBarry Smith 
122830de9b25SBarry Smith    Sample usage:
122930de9b25SBarry Smith .vb
123030de9b25SBarry Smith    MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
123130de9b25SBarry Smith                "MyColor",MyColor);
123230de9b25SBarry Smith .ve
123330de9b25SBarry Smith 
123430de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
123530de9b25SBarry Smith $     MatColoringSetType(part,"my_color")
123630de9b25SBarry Smith    or at runtime via the option
123730de9b25SBarry Smith $     -mat_coloring_type my_color
123830de9b25SBarry Smith 
1239ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
124030de9b25SBarry Smith 
124130de9b25SBarry Smith .keywords: matrix, Coloring, register
124230de9b25SBarry Smith 
124330de9b25SBarry Smith .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
124430de9b25SBarry Smith M*/
1245aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1246f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1247b12f92e5SBarry Smith #else
1248f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1249b12f92e5SBarry Smith #endif
125030de9b25SBarry Smith 
12512bad1931SBarry Smith extern PetscTruth MatColoringRegisterAllCalled;
1252f1144a30SSatish Balay 
1253be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]);
1254be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void);
1255be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1256639f9d9dSBarry Smith 
1257d9274352SBarry Smith /*S
1258d9274352SBarry Smith      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1259d9274352SBarry Smith         and coloring
1260639f9d9dSBarry Smith 
1261d9274352SBarry Smith    Level: beginner
1262d9274352SBarry Smith 
1263d9274352SBarry Smith   Concepts: coloring, sparse Jacobian, finite differences
1264d9274352SBarry Smith 
1265d9274352SBarry Smith .seealso:  MatFDColoringCreate()
1266d9274352SBarry Smith S*/
1267e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring;
1268639f9d9dSBarry Smith 
1269be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1270be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring);
1271be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer);
1272be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
12734a9d489dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1274be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1275be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring);
1276be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1277be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *);
1278be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec);
1279be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1280639f9d9dSBarry Smith /*
12810752156aSBarry Smith     These routines are for partitioning matrices: currently used only
12823eda8832SBarry Smith   for adjacency matrix, MatCreateMPIAdj().
12830752156aSBarry Smith */
1284ca161407SBarry Smith 
1285d9274352SBarry Smith /*S
1286d9274352SBarry Smith      MatPartitioning - Object for managing the partitioning of a matrix or graph
1287d9274352SBarry Smith 
1288d9274352SBarry Smith    Level: beginner
1289d9274352SBarry Smith 
1290d9274352SBarry Smith   Concepts: partitioning
1291d9274352SBarry Smith 
1292743a1026Svictorle .seealso:  MatPartitioningCreate(), MatPartitioningType
1293d9274352SBarry Smith S*/
129491e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning;
1295d9274352SBarry Smith 
1296d9274352SBarry Smith /*E
12975bc6e7ccSvictorle     MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1298d9274352SBarry Smith        with an optional dynamic library name, for example
1299d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1300d9274352SBarry Smith 
1301d9274352SBarry Smith    Level: beginner
1302d9274352SBarry Smith 
1303b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning
1304d9274352SBarry Smith E*/
1305a313700dSBarry Smith #define MatPartitioningType char*
13068ba1e511SMatthew Knepley #define MAT_PARTITIONING_CURRENT  "current"
1307c2ec2a73SHong Zhang #define MAT_PARTITIONING_SQUARE   "square"
13088ba1e511SMatthew Knepley #define MAT_PARTITIONING_PARMETIS "parmetis"
130971306c60Sjroman #define MAT_PARTITIONING_CHACO    "chaco"
131071306c60Sjroman #define MAT_PARTITIONING_JOSTLE   "jostle"
131171306c60Sjroman #define MAT_PARTITIONING_PARTY    "party"
131271306c60Sjroman #define MAT_PARTITIONING_SCOTCH   "scotch"
131371306c60Sjroman 
1314ca161407SBarry Smith 
1315be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1316a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,const MatPartitioningType);
1317be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt);
1318be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat);
1319be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1320be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1321be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*);
1322be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning);
13232aabb6bbSBarry Smith 
1324be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
132530de9b25SBarry Smith 
132630de9b25SBarry Smith /*MC
132730de9b25SBarry Smith    MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
132830de9b25SBarry Smith    matrix package.
132930de9b25SBarry Smith 
133030de9b25SBarry Smith    Synopsis:
1331c1ac3661SBarry Smith    PetscErrorCode MatPartitioningRegisterDynamic(char *name_partitioning,char *path,char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
133230de9b25SBarry Smith 
133330de9b25SBarry Smith    Not Collective
133430de9b25SBarry Smith 
133530de9b25SBarry Smith    Input Parameters:
133630de9b25SBarry Smith +  sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis
133730de9b25SBarry Smith .  path - location of library where creation routine is
133830de9b25SBarry Smith .  name - name of function that creates the partitioning type, a string
133930de9b25SBarry Smith -  function - function pointer that creates the partitioning type
134030de9b25SBarry Smith 
134130de9b25SBarry Smith    Level: developer
134230de9b25SBarry Smith 
134330de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
134430de9b25SBarry Smith    is ignored.
134530de9b25SBarry Smith 
134630de9b25SBarry Smith    Sample usage:
134730de9b25SBarry Smith .vb
134830de9b25SBarry Smith    MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
134930de9b25SBarry Smith                "MyPartCreate",MyPartCreate);
135030de9b25SBarry Smith .ve
135130de9b25SBarry Smith 
135230de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
135330de9b25SBarry Smith $     MatPartitioningSetType(part,"my_part")
135430de9b25SBarry Smith    or at runtime via the option
135530de9b25SBarry Smith $     -mat_partitioning_type my_part
135630de9b25SBarry Smith 
1357ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
135830de9b25SBarry Smith 
135930de9b25SBarry Smith .keywords: matrix, partitioning, register
136030de9b25SBarry Smith 
136130de9b25SBarry Smith .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
136230de9b25SBarry Smith M*/
1363aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1364f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
13652aabb6bbSBarry Smith #else
1366f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
13672aabb6bbSBarry Smith #endif
13682aabb6bbSBarry Smith 
13692bad1931SBarry Smith extern PetscTruth MatPartitioningRegisterAllCalled;
1370f1144a30SSatish Balay 
1371be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]);
1372be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void);
13732bad1931SBarry Smith 
1374be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer);
1375be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning);
1376a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,const MatPartitioningType*);
1377ca161407SBarry Smith 
1378be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
13790e8af3caSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);
13800752156aSBarry Smith 
1381be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal);
1382be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning);
138371306c60Sjroman 
1384954b3ec6SBarry Smith typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType;
1385be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
138671306c60Sjroman typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType;
1387be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1388be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
138971306c60Sjroman typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType;
1390be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1391be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1392be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
139371306c60Sjroman 
139471306c60Sjroman #define MP_PARTY_OPT "opt"
139571306c60Sjroman #define MP_PARTY_LIN "lin"
139671306c60Sjroman #define MP_PARTY_SCA "sca"
139771306c60Sjroman #define MP_PARTY_RAN "ran"
139871306c60Sjroman #define MP_PARTY_GBF "gbf"
139971306c60Sjroman #define MP_PARTY_GCF "gcf"
140071306c60Sjroman #define MP_PARTY_BUB "bub"
140171306c60Sjroman #define MP_PARTY_DEF "def"
1402be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*);
140371306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs"
140471306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl"
140571306c60Sjroman #define MP_PARTY_NONE "no"
1406be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*);
1407be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1408be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscTruth);
1409be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth);
141071306c60Sjroman 
141171306c60Sjroman typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType;
1412be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*);
1413be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning);
1414be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType);
1415be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal);
1416be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*);
141771306c60Sjroman typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType;
1418be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType);
1419be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning);
1420be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*);
142171306c60Sjroman 
1422591294e4SBarry Smith EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
142314196391SBarry Smith EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);
1424591294e4SBarry Smith 
14250752156aSBarry Smith /*
14260a835dfdSSatish Balay     If you add entries here you must also add them to finclude/petscmat.h
1427d4fbbf0eSBarry Smith */
14281c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0,
14291c1c02c0SLois Curfman McInnes                MATOP_GET_ROW=1,
14301c1c02c0SLois Curfman McInnes                MATOP_RESTORE_ROW=2,
14311c1c02c0SLois Curfman McInnes                MATOP_MULT=3,
14321c1c02c0SLois Curfman McInnes                MATOP_MULT_ADD=4,
14337c922b88SBarry Smith                MATOP_MULT_TRANSPOSE=5,
14347c922b88SBarry Smith                MATOP_MULT_TRANSPOSE_ADD=6,
14351c1c02c0SLois Curfman McInnes                MATOP_SOLVE=7,
14361c1c02c0SLois Curfman McInnes                MATOP_SOLVE_ADD=8,
14377c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE=9,
14387c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE_ADD=10,
14391c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR=11,
14401c1c02c0SLois Curfman McInnes                MATOP_CHOLESKYFACTOR=12,
14411c1c02c0SLois Curfman McInnes                MATOP_RELAX=13,
14421c1c02c0SLois Curfman McInnes                MATOP_TRANSPOSE=14,
14431c1c02c0SLois Curfman McInnes                MATOP_GETINFO=15,
14441c1c02c0SLois Curfman McInnes                MATOP_EQUAL=16,
14451c1c02c0SLois Curfman McInnes                MATOP_GET_DIAGONAL=17,
14461c1c02c0SLois Curfman McInnes                MATOP_DIAGONAL_SCALE=18,
14471c1c02c0SLois Curfman McInnes                MATOP_NORM=19,
14481c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_BEGIN=20,
14491c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_END=21,
1450d519adbfSMatthew Knepley                MATOP_SET_OPTION=22,
1451d519adbfSMatthew Knepley                MATOP_ZERO_ENTRIES=23,
1452d519adbfSMatthew Knepley                MATOP_ZERO_ROWS=24,
1453d519adbfSMatthew Knepley                MATOP_LUFACTOR_SYMBOLIC=25,
1454d519adbfSMatthew Knepley                MATOP_LUFACTOR_NUMERIC=26,
1455d519adbfSMatthew Knepley                MATOP_CHOLESKY_FACTOR_SYMBOLIC=27,
1456d519adbfSMatthew Knepley                MATOP_CHOLESKY_FACTOR_NUMERIC=28,
1457d519adbfSMatthew Knepley                MATOP_SETUP_PREALLOCATION=29,
1458d519adbfSMatthew Knepley                MATOP_ILUFACTOR_SYMBOLIC=30,
1459d519adbfSMatthew Knepley                MATOP_ICCFACTOR_SYMBOLIC=31,
1460d519adbfSMatthew Knepley                MATOP_GET_ARRAY=32,
1461d519adbfSMatthew Knepley                MATOP_RESTORE_ARRAY=33,
1462d519adbfSMatthew Knepley                MATOP_DUPLICATE=34,
1463d519adbfSMatthew Knepley                MATOP_FORWARD_SOLVE=35,
1464d519adbfSMatthew Knepley                MATOP_BACKWARD_SOLVE=36,
1465d519adbfSMatthew Knepley                MATOP_ILUFACTOR=37,
1466d519adbfSMatthew Knepley                MATOP_ICCFACTOR=38,
1467d519adbfSMatthew Knepley                MATOP_AXPY=39,
1468d519adbfSMatthew Knepley                MATOP_GET_SUBMATRICES=40,
1469d519adbfSMatthew Knepley                MATOP_INCREASE_OVERLAP=41,
1470d519adbfSMatthew Knepley                MATOP_GET_VALUES=42,
1471d519adbfSMatthew Knepley                MATOP_COPY=43,
1472d519adbfSMatthew Knepley                MATOP_GET_ROW_MAX=44,
1473d519adbfSMatthew Knepley                MATOP_SCALE=45,
1474d519adbfSMatthew Knepley                MATOP_SHIFT=46,
147535153367SBarry Smith                MATOP_DIAGONAL_SET=47,
1476d519adbfSMatthew Knepley                MATOP_ILUDT_FACTOR=48,
1477d519adbfSMatthew Knepley                MATOP_SET_BLOCK_SIZE=49,
1478d519adbfSMatthew Knepley                MATOP_GET_ROW_IJ=50,
1479d519adbfSMatthew Knepley                MATOP_RESTORE_ROW_IJ=51,
1480d519adbfSMatthew Knepley                MATOP_GET_COLUMN_IJ=52,
1481d519adbfSMatthew Knepley                MATOP_RESTORE_COLUMN_IJ=53,
1482d519adbfSMatthew Knepley                MATOP_FDCOLORING_CREATE=54,
1483d519adbfSMatthew Knepley                MATOP_COLORING_PATCH=55,
1484d519adbfSMatthew Knepley                MATOP_SET_UNFACTORED=56,
1485d519adbfSMatthew Knepley                MATOP_PERMUTE=57,
1486d519adbfSMatthew Knepley                MATOP_SET_VALUES_BLOCKED=58,
1487d519adbfSMatthew Knepley                MATOP_GET_SUBMATRIX=59,
1488d519adbfSMatthew Knepley                MATOP_DESTROY=60,
1489d519adbfSMatthew Knepley                MATOP_VIEW=61,
1490d519adbfSMatthew Knepley                MATOP_CONVERT_FROM=62,
1491d519adbfSMatthew Knepley                MATOP_USE_SCALED_FORM=63,
1492d519adbfSMatthew Knepley                MATOP_SCALE_SYSTEM=64,
1493d519adbfSMatthew Knepley                MATOP_UNSCALE_SYSTEM=65,
1494d519adbfSMatthew Knepley                MATOP_SET_LOCAL_TO_GLOBAL_MAP=66,
1495d519adbfSMatthew Knepley                MATOP_SET_VALUES_LOCAL=67,
1496d519adbfSMatthew Knepley                MATOP_ZERO_ROWS_LOCAL=68,
1497d519adbfSMatthew Knepley                MATOP_GET_ROW_MAX_ABS=69,
1498d519adbfSMatthew Knepley                MATOP_GET_ROW_MIN_ABS=70,
1499d519adbfSMatthew Knepley                MATOP_CONVERT=71,
1500d519adbfSMatthew Knepley                MATOP_SET_COLORING=72,
1501d519adbfSMatthew Knepley                MATOP_SET_VALUES_ADIC=73,
1502d519adbfSMatthew Knepley                MATOP_SET_VALUES_ADIFOR=74,
1503d519adbfSMatthew Knepley                MATOP_FD_COLORING_APPLY=75,
1504d519adbfSMatthew Knepley                MATOP_SET_FROM_OPTIONS=76,
1505d519adbfSMatthew Knepley                MATOP_MULT_CON=77,
1506d519adbfSMatthew Knepley                MATOP_MULT_TRANSPOSE_CON=78,
1507d519adbfSMatthew Knepley                MATOP_PERMUTE_SPARSIFY=79,
1508d519adbfSMatthew Knepley                MATOP_MULT_MULTIPLE=80,
1509d519adbfSMatthew Knepley                MATOP_SOLVE_MULTIPLE=81,
1510d519adbfSMatthew Knepley                MATOP_GET_INERTIA=82,
1511d519adbfSMatthew Knepley                MATOP_LOAD=83,
1512d519adbfSMatthew Knepley                MATOP_IS_SYMMETRIC=84,
1513d519adbfSMatthew Knepley                MATOP_IS_HERMITIAN=85,
1514d519adbfSMatthew Knepley                MATOP_IS_STRUCTURALLY_SYMMETRIC=86,
151541f059aeSBarry Smith                MATOP_DUMMY=87,
1516d519adbfSMatthew Knepley                MATOP_GET_VECS=88,
1517d519adbfSMatthew Knepley                MATOP_MAT_MULT=89,
1518d519adbfSMatthew Knepley                MATOP_MAT_MULT_SYMBOLIC=90,
1519d519adbfSMatthew Knepley                MATOP_MAT_MULT_NUMERIC=91,
1520d519adbfSMatthew Knepley                MATOP_PTAP=92,
1521d519adbfSMatthew Knepley                MATOP_PTAP_SYMBOLIC=93,
1522d519adbfSMatthew Knepley                MATOP_PTAP_NUMERIC=94,
1523d519adbfSMatthew Knepley                MATOP_MAT_MULTTRANSPOSE=95,
15241763ac4eSSatish Balay                MATOP_MAT_MULTTRANSPOSE_SYM=96,
15251763ac4eSSatish Balay                MATOP_MAT_MULTTRANSPOSE_NUM=97,
1526d519adbfSMatthew Knepley                MATOP_PTAP_SYMBOLIC_SEQAIJ=98,
1527d519adbfSMatthew Knepley                MATOP_PTAP_NUMERIC_SEQAIJ=99,
1528d519adbfSMatthew Knepley                MATOP_PTAP_SYMBOLIC_MPIAIJ=100,
1529d519adbfSMatthew Knepley                MATOP_PTAP_NUMERIC_MPIAIJ=101,
1530d519adbfSMatthew Knepley                MATOP_CONJUGATE=102,
1531d519adbfSMatthew Knepley                MATOP_SET_SIZES=103,
1532d519adbfSMatthew Knepley                MATOP_SET_VALUES_ROW=104,
1533d519adbfSMatthew Knepley                MATOP_REAL_PART=105,
1534d519adbfSMatthew Knepley                MATOP_IMAG_PART=106,
1535d519adbfSMatthew Knepley                MATOP_GET_ROW_UTRIANGULAR=107,
1536d519adbfSMatthew Knepley                MATOP_RESTORE_ROW_UTRIANGULAR=108,
1537d519adbfSMatthew Knepley                MATOP_MATSOLVE=109,
1538d519adbfSMatthew Knepley                MATOP_GET_REDUNDANTMATRIX=110,
1539d519adbfSMatthew Knepley                MATOP_GET_ROW_MIN=111,
1540d519adbfSMatthew Knepley                MATOP_GET_COLUMN_VEC=112,
1541d519adbfSMatthew Knepley                MATOP_MISSING_DIAGONAL=113,
1542d519adbfSMatthew Knepley                MATOP_MATGETSEQNONZEROSTRUCTURE=114,
154389c6957cSBarry Smith                MATOP_CREATE=115,
154489c6957cSBarry Smith                MATOP_GET_GHOSTS=116,
154589c6957cSBarry Smith                MATOP_ILUDTFACTORSYMBOLIC=117,
154689c6957cSBarry Smith                MATOP_ILUDTFACTORNUMERIC=118,
1547eeffb40dSHong Zhang                MATOP_MULT_DIAGONAL_BLOCK=119,
1548547795f9SHong Zhang                MATOP_HERMITIANTRANSPOSE=120,
1549547795f9SHong Zhang                MATOP_MULTHERMITIANTRANSPOSE=121,
1550547795f9SHong Zhang                MATOP_MULTHERMITIANTRANSPOSEADD=122
1551fae171e0SBarry Smith              } MatOperation;
1552be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscTruth*);
1553be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void));
1554be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void));
1555be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*);
1556112a2221SBarry Smith 
155790ace30eSBarry Smith /*
155890ace30eSBarry Smith    Codes for matrices stored on disk. By default they are
155990ace30eSBarry Smith  stored in a universal format. By changing the format with
15607973ad04SBarry Smith  PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
156190ace30eSBarry Smith  be stored in a way natural for the matrix, for example dense matrices
156290ace30eSBarry Smith  would be stored as dense. Matrices stored this way may only be
156390ace30eSBarry Smith  read into matrices of the same time.
156490ace30eSBarry Smith */
156590ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1
156690ace30eSBarry Smith 
1567be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1568be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*);
15691f4e1ec7SBarry Smith 
1570d9274352SBarry Smith /*S
1571d9274352SBarry Smith      MatNullSpace - Object that removes a null space from a vector, i.e.
1572d9274352SBarry Smith          orthogonalizes the vector to a subsapce
1573d9274352SBarry Smith 
1574f7a9e4ceSBarry Smith    Level: advanced
1575d9274352SBarry Smith 
1576d9274352SBarry Smith   Concepts: matrix; linear operator, null space
1577d9274352SBarry Smith 
15786e1639daSBarry Smith   Users manual sections:
15796e1639daSBarry Smith .   sec_singular
15806e1639daSBarry Smith 
1581d9274352SBarry Smith .seealso:  MatNullSpaceCreate()
1582d9274352SBarry Smith S*/
158374637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace;
1584d9274352SBarry Smith 
1585be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*);
1586b22b330cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1587be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace);
1588be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1589be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace);
159095902228SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat,PetscTruth *);
159174637425SBarry Smith 
1592be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS);
1593be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1594be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
159546129b97SKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat);
15963f1d51d7SBarry Smith 
1597be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*);
1598be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*);
1599be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*);
1600c4f061fbSSatish Balay 
1601be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*);
1602b0a32e0cSBarry Smith 
1603be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec);
160404f1ad80SBarry Smith 
1605fef1beadSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
16063ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetBase(Mat,Vec,Vec);
16073ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1608e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1609e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1610e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDAddNullSpace(Mat,MatNullSpace);
1611e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1612e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDResetHHistory(Mat);
1613e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctionError(Mat,PetscReal);
1614e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetPeriod(Mat,PetscInt);
1615e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDGetH(Mat,PetscScalar *);
16166aa9148fSLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetOptionsPrefix(Mat,const char[]);
1617e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFromOptions(Mat);
1618e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1619e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);
1620e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDDSSetUmin(Mat,PetscReal);
1621e884886fSBarry Smith 
1622e884886fSBarry Smith 
1623e884886fSBarry Smith typedef struct _p_MatMFFD* MatMFFD;
1624e884886fSBarry Smith 
1625e884886fSBarry Smith /*E
1626e884886fSBarry Smith     MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function
1627e884886fSBarry Smith 
1628e884886fSBarry Smith    Level: beginner
1629e884886fSBarry Smith 
1630e884886fSBarry Smith .seealso: MatMFFDSetType(), MatMFFDRegister()
1631e884886fSBarry Smith E*/
1632a313700dSBarry Smith #define MatMFFDType char*
1633e884886fSBarry Smith #define MATMFFD_DS  "ds"
1634e884886fSBarry Smith #define MATMFFD_WP  "wp"
1635e884886fSBarry Smith 
1636a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetType(Mat,const MatMFFDType);
1637e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatMFFD));
1638e884886fSBarry Smith 
1639e884886fSBarry Smith /*MC
1640e884886fSBarry Smith    MatMFFDRegisterDynamic - Adds a method to the MatMFFD registry.
1641e884886fSBarry Smith 
1642e884886fSBarry Smith    Synopsis:
1643e884886fSBarry Smith    PetscErrorCode MatMFFDRegisterDynamic(char *name_solver,char *path,char *name_create,PetscErrorCode (*routine_create)(MatMFFD))
1644e884886fSBarry Smith 
1645e884886fSBarry Smith    Not Collective
1646e884886fSBarry Smith 
1647e884886fSBarry Smith    Input Parameters:
1648e884886fSBarry Smith +  name_solver - name of a new user-defined compute-h module
1649e884886fSBarry Smith .  path - path (either absolute or relative) the library containing this solver
1650e884886fSBarry Smith .  name_create - name of routine to create method context
1651e884886fSBarry Smith -  routine_create - routine to create method context
1652e884886fSBarry Smith 
1653e884886fSBarry Smith    Level: developer
1654e884886fSBarry Smith 
1655e884886fSBarry Smith    Notes:
1656e884886fSBarry Smith    MatMFFDRegisterDynamic() may be called multiple times to add several user-defined solvers.
1657e884886fSBarry Smith 
1658e884886fSBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
1659e884886fSBarry Smith    is ignored.
1660e884886fSBarry Smith 
1661e884886fSBarry Smith    Sample usage:
1662e884886fSBarry Smith .vb
1663e884886fSBarry Smith    MatMFFDRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a,
1664e884886fSBarry Smith                "MyHCreate",MyHCreate);
1665e884886fSBarry Smith .ve
1666e884886fSBarry Smith 
1667e884886fSBarry Smith    Then, your solver can be chosen with the procedural interface via
1668e884886fSBarry Smith $     MatMFFDSetType(mfctx,"my_h")
1669e884886fSBarry Smith    or at runtime via the option
1670e884886fSBarry Smith $     -snes_mf_type my_h
1671e884886fSBarry Smith 
1672e884886fSBarry Smith .keywords: MatMFFD, register
1673e884886fSBarry Smith 
1674e884886fSBarry Smith .seealso: MatMFFDRegisterAll(), MatMFFDRegisterDestroy()
1675e884886fSBarry Smith M*/
1676e884886fSBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1677e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,0)
1678e884886fSBarry Smith #else
1679e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,d)
1680e884886fSBarry Smith #endif
1681e884886fSBarry Smith 
1682e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterAll(const char[]);
1683e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterDestroy(void);
1684e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDDefaultSetUmin(Mat,PetscReal);
1685e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDWPSetComputeNormU(Mat,PetscTruth);
1686e884886fSBarry Smith 
1687e884886fSBarry Smith 
1688be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1689be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
16907dbadf16SMatthew Knepley 
1691e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END
16922eac72dbSBarry Smith #endif
1693*97969023SHong Zhang 
1694*97969023SHong Zhang /*
1695*97969023SHong Zhang    PETSc interface to MUMPS
1696*97969023SHong Zhang */
1697*97969023SHong Zhang #ifdef PETSC_HAVE_MUMPS
1698*97969023SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
1699*97969023SHong Zhang #endif
1700