xref: /petsc/include/petscmat.h (revision dbc6227fcfdc75eef6854d4b4ef5941770997d53)
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 MATSEQAIJ          "seqaij"
36273d9f13SBarry Smith #define MATMPIAIJ          "mpiaij"
37209238afSKris Buschelman #define MATAIJ             "aij"
38273d9f13SBarry Smith #define MATSHELL           "shell"
39209238afSKris Buschelman #define MATSEQDENSE        "seqdense"
40273d9f13SBarry Smith #define MATMPIDENSE        "mpidense"
41209238afSKris Buschelman #define MATDENSE           "dense"
42273d9f13SBarry Smith #define MATSEQBAIJ         "seqbaij"
43273d9f13SBarry Smith #define MATMPIBAIJ         "mpibaij"
44209238afSKris Buschelman #define MATBAIJ            "baij"
45273d9f13SBarry Smith #define MATMPIADJ          "mpiadj"
46273d9f13SBarry Smith #define MATSEQSBAIJ        "seqsbaij"
47273d9f13SBarry Smith #define MATMPISBAIJ        "mpisbaij"
48209238afSKris Buschelman #define MATSBAIJ           "sbaij"
49cebc7f6cSBarry Smith #define MATDAAD            "daad"
50cebc7f6cSBarry Smith #define MATMFFD            "mffd"
51c8a8475eSBarry Smith #define MATNORMAL          "normal"
52ab92ecdeSBarry Smith #define MATLRC             "lrc"
534b8d99adSRichard Tran Mills #define MATSEQCSRPERM      "seqcsrperm"
5418def556SRichard Tran Mills #define MATMPICSRPERM      "mpicsrperm"
55814655b8SBarry Smith #define MATCSRPERM         "csrperm"
5681824310SBarry Smith #define MATSEQCRL          "seqcrl"
57c02b24c5SBarry Smith #define MATMPICRL          "mpicrl"
58c02b24c5SBarry Smith #define MATCRL             "crl"
592a6744ebSBarry Smith #define MATSCATTER         "scatter"
60421e10b8SBarry Smith #define MATBLOCKMAT        "blockmat"
61793850ffSBarry Smith #define MATCOMPOSITE       "composite"
625a7f1df3SHong Zhang #define MATSEQFFTW         "seqfftw"
63557cca28SSatish Balay #define MATTRANSPOSEMAT    "transpose"
6472ca8751SBarry Smith #define MATSCHURCOMPLEMENT "schurcomplement"
651d6018f0SLisandro Dalcin #define MATPYTHON          "python"
66f91d8e95SBarry Smith #define MATHYPRESTRUCT     "hyprestruct"
67a9e6138eSGlenn Hammond #define MATHYPRESSTRUCT    "hypresstruct"
68ee1cef2cSJed Brown #define MATSUBMATRIX       "submatrix"
69d91e6319SBarry Smith 
70164db6ccSDmitry Karpeev 
71*dbc6227fSDmitry Karpeev #define MATDD              "matdd"
72164db6ccSDmitry Karpeev 
73ba2f8784SDmitry Karpeev #define MATIM              "matim"
74ba2f8784SDmitry Karpeev 
75773941d6SBarry Smith 
769989ab13SBarry Smith /*E
77c7393fdbSBarry Smith     MatSolverPackage - String with the name of a PETSc matrix solver type.
789989ab13SBarry Smith 
799989ab13SBarry Smith     For example: "petsc" indicates what PETSc provides, "superlu" indicates either
809989ab13SBarry Smith        SuperLU or SuperLU_Dist etc.
819989ab13SBarry Smith 
829989ab13SBarry Smith 
839989ab13SBarry Smith    Level: beginner
849989ab13SBarry Smith 
855c9eb25fSBarry Smith .seealso: MatGetFactor(), Mat, MatSetType(), MatType
869989ab13SBarry Smith E*/
87c7393fdbSBarry Smith #define MatSolverPackage char*
88b24902e0SBarry Smith #define MAT_SOLVER_SPOOLES      "spooles"
89b24902e0SBarry Smith #define MAT_SOLVER_SUPERLU      "superlu"
90b24902e0SBarry Smith #define MAT_SOLVER_SUPERLU_DIST "superlu_dist"
91b24902e0SBarry Smith #define MAT_SOLVER_UMFPACK      "umfpack"
92b24902e0SBarry Smith #define MAT_SOLVER_ESSL         "essl"
93b24902e0SBarry Smith #define MAT_SOLVER_LUSOL        "lusol"
94b24902e0SBarry Smith #define MAT_SOLVER_MUMPS        "mumps"
953bf14a46SMatthew Knepley #define MAT_SOLVER_PASTIX       "pastix"
96b24902e0SBarry Smith #define MAT_SOLVER_DSCPACK      "dscpack"
97b24902e0SBarry Smith #define MAT_SOLVER_MATLAB       "matlab"
9843244d56SBarry Smith #define MAT_SOLVER_PETSC        "petsc"
99b6806ab0SHong Zhang #define MAT_SOLVER_PLAPACK      "plapack"
100845006b9SBarry Smith #define MAT_SOLVER_BAS          "bas"
101773941d6SBarry Smith 
102b24902e0SBarry Smith /*E
103b24902e0SBarry Smith     MatFactorType - indicates what type of factorization is requested
104b24902e0SBarry Smith 
105b24902e0SBarry Smith     Level: beginner
106b24902e0SBarry Smith 
107b24902e0SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
108b24902e0SBarry Smith 
109c7393fdbSBarry Smith .seealso: MatSolverPackage, MatGetFactor()
110b24902e0SBarry Smith E*/
111599ef60dSHong Zhang typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType;
112c7393fdbSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactor(Mat,const MatSolverPackage,MatFactorType,Mat*);
113db4efbfdSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactorAvailable(Mat,const MatSolverPackage,MatFactorType,PetscTruth*);
11435bd34faSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorGetSolverPackage(Mat,const MatSolverPackage*);
1156335c336SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactorType(Mat,MatFactorType*);
1169989ab13SBarry Smith 
117c06d978dSMatthew Knepley /* Logging support */
1180700a824SBarry Smith #define    MAT_FILE_CLASSID 1211216    /* used to indicate matrices in binary files */
1190700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_CLASSID;
1200700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_FDCOLORING_CLASSID;
1210700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_PARTITIONING_CLASSID;
1220700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_NULLSPACE_CLASSID;
1230700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MATMFFD_CLASSID;
124c06d978dSMatthew Knepley 
125ceb03754SKris Buschelman /*E
126ceb03754SKris Buschelman     MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
127ceb03754SKris Buschelman      or MatGetSubMatrix() are to be reused to store the new matrix values.
128ceb03754SKris Buschelman 
129ceb03754SKris Buschelman     Level: beginner
130ceb03754SKris Buschelman 
131ceb03754SKris Buschelman    Any additions/changes here MUST also be made in include/finclude/petscmat.h
132ceb03754SKris Buschelman 
1330c451bc4SBarry Smith .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
134ceb03754SKris Buschelman E*/
135dfe085dbSJed Brown typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX} MatReuse;
136ceb03754SKris Buschelman 
1375494a064SHong Zhang /*E
1385494a064SHong Zhang     MatGetSubMatrixOption - Indicates if matrices obtained from a call to MatGetSubMatrices()
139829201f2SHong Zhang      include the matrix values. Currently it is only used by MatGetSeqNonzerostructure().
1405494a064SHong Zhang 
1415494a064SHong Zhang     Level: beginner
1425494a064SHong Zhang 
143829201f2SHong Zhang .seealso: MatGetSeqNonzerostructure()
1445494a064SHong Zhang E*/
1455494a064SHong Zhang typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatGetSubMatrixOption;
1465494a064SHong Zhang 
147e5bd5246SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(const char[]);
148c06d978dSMatthew Knepley 
149f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreate(MPI_Comm,Mat*);
150a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(MPI_Comm comm),(comm,&A),Mat,A)
151a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(),(PETSC_COMM_WORLD,&A),Mat,A)
152f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
153a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat,const MatType);
154be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetFromOptions(Mat);
155be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUpPreallocation(Mat);
156be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]);
157be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat));
15830de9b25SBarry Smith 
159f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOptionsPrefix(Mat,const char[]);
160f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAppendOptionsPrefix(Mat,const char[]);
161f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOptionsPrefix(Mat,const char*[]);
162f69a0ea3SMatthew Knepley 
16330de9b25SBarry Smith /*MC
16430de9b25SBarry Smith    MatRegisterDynamic - Adds a new matrix type
16530de9b25SBarry Smith 
16630de9b25SBarry Smith    Synopsis:
1671890ba74SBarry Smith    PetscErrorCode MatRegisterDynamic(const char *name,const char *path,const char *name_create,PetscErrorCode (*routine_create)(Mat))
16830de9b25SBarry Smith 
16930de9b25SBarry Smith    Not Collective
17030de9b25SBarry Smith 
17130de9b25SBarry Smith    Input Parameters:
17230de9b25SBarry Smith +  name - name of a new user-defined matrix type
17330de9b25SBarry Smith .  path - path (either absolute or relative) the library containing this solver
17430de9b25SBarry Smith .  name_create - name of routine to create method context
17530de9b25SBarry Smith -  routine_create - routine to create method context
17630de9b25SBarry Smith 
17730de9b25SBarry Smith    Notes:
17830de9b25SBarry Smith    MatRegisterDynamic() may be called multiple times to add several user-defined solvers.
17930de9b25SBarry Smith 
18030de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
18130de9b25SBarry Smith    is ignored.
18230de9b25SBarry Smith 
18330de9b25SBarry Smith    Sample usage:
18430de9b25SBarry Smith .vb
18530de9b25SBarry Smith    MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a,
18630de9b25SBarry Smith                "MyMatCreate",MyMatCreate);
18730de9b25SBarry Smith .ve
18830de9b25SBarry Smith 
18930de9b25SBarry Smith    Then, your solver can be chosen with the procedural interface via
19030de9b25SBarry Smith $     MatSetType(Mat,"my_mat")
19130de9b25SBarry Smith    or at runtime via the option
19230de9b25SBarry Smith $     -mat_type my_mat
19330de9b25SBarry Smith 
19430de9b25SBarry Smith    Level: advanced
19530de9b25SBarry Smith 
196ab901514SBarry Smith    Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
19730de9b25SBarry Smith          If your function is not being put into a shared library then use VecRegister() instead
19830de9b25SBarry Smith 
19930de9b25SBarry Smith .keywords: Mat, register
20030de9b25SBarry Smith 
20130de9b25SBarry Smith .seealso: MatRegisterAll(), MatRegisterDestroy()
20230de9b25SBarry Smith 
20330de9b25SBarry Smith M*/
204273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
205273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0)
206273d9f13SBarry Smith #else
207273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d)
20830de9b25SBarry Smith #endif
20930de9b25SBarry Smith 
210273d9f13SBarry Smith extern PetscTruth MatRegisterAllCalled;
211b0a32e0cSBarry Smith extern PetscFList MatList;
212b022a5c1SBarry Smith extern PetscFList MatColoringList;
213b022a5c1SBarry Smith extern PetscFList MatPartitioningList;
21428988994SBarry Smith 
2153b224e63SBarry Smith /*E
2163b224e63SBarry Smith     MatStructure - Indicates if the matrix has the same nonzero structure
2173b224e63SBarry Smith 
2183b224e63SBarry Smith     Level: beginner
2193b224e63SBarry Smith 
2203b224e63SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
2213b224e63SBarry Smith 
2223b224e63SBarry Smith .seealso: MatCopy(), KSPSetOperators(), PCSetOperators()
2233b224e63SBarry Smith E*/
2243b224e63SBarry Smith typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure;
2253b224e63SBarry Smith 
226be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
227be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
228be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
229ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A)
230ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A)
231ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A)
232ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A)
233ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A))
234ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A))
235ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A))
236be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
237ba966639SSatish 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)
238ba966639SSatish 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)
239ba966639SSatish 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)
240ba966639SSatish 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)
241ba966639SSatish 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))
242ba966639SSatish 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))
243ba966639SSatish 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))
244ba966639SSatish 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)
245ba966639SSatish 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)
246ba966639SSatish 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)
247ba966639SSatish 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)
248ba966639SSatish 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))
249ba966639SSatish 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))
250ba966639SSatish 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))
25163ab93bfSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
2528d7a6e47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
2538d7a6e47SBarry Smith 
254be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
255ba966639SSatish 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)
256ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
257ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
258ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
259ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
260ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
261ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
262be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
263ba966639SSatish 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)
264ba966639SSatish 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)
265ba966639SSatish 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)
266ba966639SSatish 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)
267ba966639SSatish 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))
268ba966639SSatish 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))
269ba966639SSatish 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))
270ba966639SSatish 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)
271ba966639SSatish 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)
272ba966639SSatish 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)
273ba966639SSatish 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)
274ba966639SSatish 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))
275ba966639SSatish 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))
276ba966639SSatish 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))
277be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
278be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
279ba966639SSatish 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)
280ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
281ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
282ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
283ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
284ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
285ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
286be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
287ba966639SSatish 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)
288ba966639SSatish 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)
289ba966639SSatish 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)
290ba966639SSatish 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)
291ba966639SSatish 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))
292ba966639SSatish 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))
293ba966639SSatish 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))
294ba966639SSatish 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)
295ba966639SSatish 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)
296ba966639SSatish 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)
297ba966639SSatish 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)
298ba966639SSatish 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))
299ba966639SSatish 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))
300ba966639SSatish 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))
301be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
302ba966639SSatish 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)
303ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A)
304be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*);
305be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateNormal(Mat,Mat*);
306ba966639SSatish Balay PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A)
307ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateLRC(Mat,Mat,Mat,Mat*);
308284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*);
3091472f72bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
3101472f72bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPICRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
3112a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateScatter(MPI_Comm,VecScatter,Mat*);
3122a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterSetVecScatter(Mat,VecScatter);
3132a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterGetVecScatter(Mat,VecScatter*);
3148cdf2d9bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
315793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeAddMat(Mat,Mat);
316b52f573bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeMerge(Mat);
317793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
3186d7c1e57SBarry Smith typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
3196d7c1e57SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeSetType(Mat,MatCompositeType);
3206d7c1e57SBarry Smith 
321*dbc6227fSDmitry Karpeev typedef enum {MATDD_BLOCK_COMM_DEFAULT = 0, MATDD_BLOCK_COMM_SELF = -1, MATDD_BLOCK_COMM_DETERMINE = -2} MatDDBlockCommType;
322*dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDAIJSetPreallocation(Mat A,PetscInt nz,PetscInt *nnz);
323*dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDGetDefaltBlockType(Mat A, const MatType *type);
324*dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetDefaltBlockType(Mat A, const MatType type);
325*dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetPreallocation_AIJ(Mat A,PetscInt nz,PetscInt *nnz);
326*dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDAddBlock(Mat A, PetscInt rowblock, PetscInt colblock, const MatType blockmattype,  MatDDBlockCommType blockcommtype, Mat *block);
327*dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetBlock(Mat A, PetscInt rowblock, PetscInt colblock, Mat block);
328*dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDGetBlock(Mat A, PetscInt rowblock, PetscInt colblock, Mat *block);
329*dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetScatters(Mat A, PetscInt blockcount, Mat scatters[]);
330*dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetGathers(Mat A, PetscInt blockcount,  Mat gathers[]);
33162ee7b53SDmitry Karpeev 
332ba2f8784SDmitry Karpeev #if defined PETSC_HAVE_MATIM
333ba2f8784SDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIMSetIS(Mat A, IS in, IS out);
334ba2f8784SDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIMGetIS(Mat A, IS *in, IS *out);
335ba2f8784SDmitry Karpeev #endif
336ba2f8784SDmitry Karpeev 
337ba2f8784SDmitry Karpeev 
338a6a5cd3fSDmitry Karpeev 
3395a7f1df3SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqFFTW(MPI_Comm,PetscInt,const PetscInt[],Mat*);
340f20085c4SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateTranspose(Mat,Mat*);
341ee1cef2cSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSubMatrix(Mat,IS,IS,Mat*);
342ee1cef2cSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSubMatrixUpdate(Mat,Mat,IS,IS);
3431472f72bSBarry Smith 
3441d6018f0SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreatePython(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const char[],Mat*);
3451d6018f0SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPythonSetType(Mat,const char[]);
3461d6018f0SLisandro Dalcin 
3471d6018f0SLisandro Dalcin 
348f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUp(Mat);
349be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat);
35021c89e3eSBarry Smith 
3510c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat);
35299cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRealPart(Mat);
35399cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatImaginaryPart(Mat);
354bfc7d00aSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonalBlock(Mat,PetscTruth*,MatReuse,Mat*);
355fe97e370SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetTrace(Mat,PetscScalar*);
35699cafbc1SBarry Smith 
3578ed539a5SBarry Smith /* ------------------------------------------------------------*/
358be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
359be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
36087d4246cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
361f259bd47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
36284cb2905SBarry Smith 
3632ef4de8bSBarry Smith /*S
3642ef4de8bSBarry Smith      MatStencil - Data structure (C struct) for storing information about a single row or
3652ef4de8bSBarry Smith         column of a matrix as index on an associated grid.
3662ef4de8bSBarry Smith 
3672ef4de8bSBarry Smith    Level: beginner
3682ef4de8bSBarry Smith 
3692ef4de8bSBarry Smith   Concepts: matrix; linear operator
3702ef4de8bSBarry Smith 
371d7bd93baSBarry Smith .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil()
3722ef4de8bSBarry Smith S*/
373435da068SBarry Smith typedef struct {
374c1ac3661SBarry Smith   PetscInt k,j,i,c;
375435da068SBarry Smith } MatStencil;
3762ef4de8bSBarry Smith 
377be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
378be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
379be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
380435da068SBarry Smith 
381be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat,ISColoring);
382be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat,void*);
383be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat,PetscInt,void*);
3843a7fca6bSBarry Smith 
385d91e6319SBarry Smith /*E
386d91e6319SBarry Smith     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
387d91e6319SBarry Smith      to continue to add values to it
388d91e6319SBarry Smith 
389d91e6319SBarry Smith     Level: beginner
390d91e6319SBarry Smith 
391d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd()
392d91e6319SBarry Smith E*/
3936d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
394be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat,MatAssemblyType);
395be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat,MatAssemblyType);
396be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat,PetscTruth*);
3974f9c727eSBarry Smith 
3981d73ed98SBarry Smith 
39930de9b25SBarry Smith 
400d91e6319SBarry Smith /*E
401d91e6319SBarry Smith     MatOption - Options that may be set for a matrix and its behavior or storage
402d91e6319SBarry Smith 
403d91e6319SBarry Smith     Level: beginner
404d91e6319SBarry Smith 
4050a835dfdSSatish Balay    Any additions/changes here MUST also be made in include/finclude/petscmat.h
406d91e6319SBarry Smith 
407d91e6319SBarry Smith .seealso: MatSetOption()
408d91e6319SBarry Smith E*/
409512a5fc5SBarry Smith typedef enum {MAT_ROW_ORIENTED,MAT_NEW_NONZERO_LOCATIONS,
4104e0d8c25SBarry Smith               MAT_SYMMETRIC,
4114e0d8c25SBarry Smith               MAT_STRUCTURALLY_SYMMETRIC,
4128047e77bSBarry Smith               MAT_NEW_DIAGONALS,MAT_IGNORE_OFF_PROC_ENTRIES,
4134e0d8c25SBarry Smith               MAT_NEW_NONZERO_LOCATION_ERR,
4144e0d8c25SBarry Smith               MAT_NEW_NONZERO_ALLOCATION_ERR,MAT_USE_HASH_TABLE,
415a9817697SBarry Smith               MAT_KEEP_NONZERO_PATTERN,MAT_IGNORE_ZERO_ENTRIES,
4164e0d8c25SBarry Smith               MAT_USE_INODES,
4174e0d8c25SBarry Smith               MAT_HERMITIAN,
4184e0d8c25SBarry Smith               MAT_SYMMETRY_ETERNAL,
4194e0d8c25SBarry Smith               MAT_USE_COMPRESSEDROW,
4204e0d8c25SBarry Smith               MAT_IGNORE_LOWER_TRIANGULAR,MAT_ERROR_LOWER_TRIANGULAR,
42128b2fa4aSMatthew Knepley               MAT_GETROW_UPPERTRIANGULAR,MAT_UNUSED_NONZERO_LOCATION_ERR,
42228b2fa4aSMatthew Knepley               NUM_MAT_OPTIONS} MatOption;
423290bbb0aSBarry Smith extern const char *MatOptions[];
4244e0d8c25SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption,PetscTruth);
425a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,const MatType*);
426a313700dSBarry Smith PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),const MatType,t)
42784cb2905SBarry Smith 
428be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
429be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
430be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
431f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowUpperTriangular(Mat);
432f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowUpperTriangular(Mat);
433be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
434be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
435be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt);
436be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]);
437ba966639SSatish Balay PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a)
438be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]);
439be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *);
440ba966639SSatish Balay PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a)
441be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt);
4427b80b807SBarry Smith 
4431620fd73SBarry Smith 
444be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec);
44589c6957cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultDiagonalBlock(Mat,Vec,Vec);
446be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec);
447ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
448be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec);
449547795f9SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultHermitianTranspose(Mat,Vec,Vec);
450be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*);
451ba966639SSatish Balay PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t)
452e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0,&t),PetscTruth,t)
4531cbb95d3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscTruth*);
454be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec);
4555cb05578SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
456ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
457be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec);
458be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec);
4592bebee5dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatSolve(Mat,Mat,Mat);
460f5edf698SHong Zhang 
461d91e6319SBarry Smith /*E
462d91e6319SBarry Smith     MatDuplicateOption - Indicates if a duplicated sparse matrix should have
463d91e6319SBarry Smith   its numerical values copied over or just its nonzero structure.
464d91e6319SBarry Smith 
465d91e6319SBarry Smith     Level: beginner
466d91e6319SBarry Smith 
467d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
468d91e6319SBarry Smith 
46970dcbbb9SBarry Smith $   MAT_SHARE_NONZERO_PATTERN - the i and j arrays in the new matrix will be shared with the original matrix
47070dcbbb9SBarry Smith $                               this also triggers the MAT_DO_NOT_COPY_VALUES option. This is used when you
47170dcbbb9SBarry Smith $                               have several matrices with the same nonzero pattern.
47270dcbbb9SBarry Smith 
473d91e6319SBarry Smith .seealso: MatDuplicate()
474d91e6319SBarry Smith E*/
47570dcbbb9SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;
4762e8a6d31SBarry Smith 
477a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat,const MatType,MatReuse,Mat*);
478a313700dSBarry Smith PetscPolymorphicFunction(MatConvert,(Mat A,const MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a)
479be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat,MatDuplicateOption,Mat*);
480ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a)
481ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a)
48294a9d846SBarry Smith 
483cb5b572fSBarry Smith 
484be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat,Mat,MatStructure);
485be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat,PetscViewer);
486be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat,PetscReal,PetscTruth*);
487ba966639SSatish Balay PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t)
488e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0,&t),PetscTruth,t)
489be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscTruth*);
490ba966639SSatish Balay PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t)
4911cbb95d3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscReal,PetscTruth*);
4921cbb95d3SBarry Smith PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,0,&t),PetscTruth,t)
493be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*);
494be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*);
49564c62002SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMissingDiagonal(Mat,PetscTruth *,PetscInt *);
496a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoad(PetscViewer,const MatType,Mat*);
497a313700dSBarry Smith PetscPolymorphicFunction(MatLoad,(PetscViewer v,const MatType t),(v,t,&a),Mat,a)
4987b80b807SBarry Smith 
4998f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
5008f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
5018f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
5028f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
503d4fbbf0eSBarry Smith 
504d91e6319SBarry Smith /*S
505d91e6319SBarry Smith      MatInfo - Context of matrix information, used with MatGetInfo()
506d91e6319SBarry Smith 
507d91e6319SBarry Smith    In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
508d91e6319SBarry Smith 
509d91e6319SBarry Smith    Level: intermediate
510d91e6319SBarry Smith 
511d91e6319SBarry Smith   Concepts: matrix^nonzero information
512d91e6319SBarry Smith 
513d9274352SBarry Smith .seealso:  MatGetInfo(), MatInfoType
514d91e6319SBarry Smith S*/
5154e220ebcSLois Curfman McInnes typedef struct {
516b0a32e0cSBarry Smith   PetscLogDouble block_size;                         /* block size */
517b0a32e0cSBarry Smith   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
518b0a32e0cSBarry Smith   PetscLogDouble memory;                             /* memory allocated */
519b0a32e0cSBarry Smith   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
520b0a32e0cSBarry Smith   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
521b0a32e0cSBarry Smith   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
522b0a32e0cSBarry Smith   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
5234e220ebcSLois Curfman McInnes } MatInfo;
5244e220ebcSLois Curfman McInnes 
525d9274352SBarry Smith /*E
526d9274352SBarry Smith     MatInfoType - Indicates if you want information about the local part of the matrix,
527d9274352SBarry Smith      the entire parallel matrix or the maximum over all the local parts.
528d9274352SBarry Smith 
529d9274352SBarry Smith     Level: beginner
530d9274352SBarry Smith 
531d9274352SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
532d9274352SBarry Smith 
533d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo
534d9274352SBarry Smith E*/
5357b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
536be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat,MatInfoType,MatInfo*);
537be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatValid(Mat,PetscTruth*);
538be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat,Vec);
539985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec,PetscInt[]);
540985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMin(Mat,Vec,PetscInt[]);
541985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
542c87e5d42SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMinAbs(Mat,Vec,PetscInt[]);
54386697f06SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowSum(Mat,Vec);
544fc4dec0aSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,MatReuse,Mat*);
545fc4dec0aSBarry Smith PetscPolymorphicFunction(MatTranspose,(Mat A),(A,MAT_INITIAL_MATRIX,&t),Mat,t)
546eeffb40dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHermitianTranspose(Mat,MatReuse,Mat*);
547be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *);
548ba966639SSatish Balay PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t)
549be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *);
550be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec);
551be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode);
552be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscTruth*);
553ba966639SSatish Balay PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t)
554be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscTruth*);
555be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*);
556be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*);
557be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*);
5587b80b807SBarry Smith 
559be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *);
560ba966639SSatish Balay PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n)
561242f1d38SBarry Smith EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal *);
562be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat);
563f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar);
564f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar);
565f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*);
566f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumnsIS(Mat,IS,const PetscScalar*);
5677b80b807SBarry Smith 
568be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscTruth);
569be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec);
570be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec);
5715ef9f2a5SBarry Smith 
572be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*);
573be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*);
574be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
5758ee2e534SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRanges(Mat,const PetscInt**);
576f4b8409dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
57772ca8751SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangesColumn(Mat,const PetscInt**);
5787b80b807SBarry Smith 
579be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
580be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]);
5814aa3045dSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,MatReuse,Mat *);
582f6d58c54SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSeqNonzeroStructure(Mat,Mat*);
583f6d58c54SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroySeqNonzeroStructure(Mat*);
5845494a064SHong Zhang 
585be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
586be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
587be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
588be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat);
589be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat);
590be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*);
591be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
592be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*);
5931d79065fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscInt**,MatScalar**,Mat*);
59443eb5e2fSMatthew Knepley #if defined (PETSC_USE_CTABLE)
595cd116e26SSatish Balay #include "petscctable.h"
59643eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *);
59743eb5e2fSMatthew Knepley #else
59843eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *);
59943eb5e2fSMatthew Knepley #endif
6008c7482ecSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);
6018efafbd8SBarry Smith 
602be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
6037b80b807SBarry Smith 
604be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
605be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
606be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat);
60722440eb1SKris Buschelman 
608be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
609be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
610be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat);
61122440eb1SKris Buschelman 
612be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*);
613be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*);
614be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat);
615bc011b1eSHong Zhang 
616f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure);
61704aac2b0SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat,MatStructure);
6181c741599SHong Zhang 
619f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar);
620f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar);
6217b80b807SBarry Smith 
622be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping);
623be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping);
624f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar);
625f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar);
626be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
627be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
628052efed2SBarry Smith 
629be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt);
630be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
63190f02eecSBarry Smith 
632be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec);
6330c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec);
634ba966639SSatish Balay PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
635be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec);
636be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*);
63769db28dcSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*);
638bd481603SBarry Smith 
639bd481603SBarry Smith /*MC
6401620fd73SBarry Smith    MatSetValue - Set a single entry into a matrix.
6411620fd73SBarry Smith 
6421620fd73SBarry Smith    Not collective
6431620fd73SBarry Smith 
6441620fd73SBarry Smith    Input Parameters:
6451620fd73SBarry Smith +  m - the matrix
6461620fd73SBarry Smith .  row - the row location of the entry
6471620fd73SBarry Smith .  col - the column location of the entry
6481620fd73SBarry Smith .  value - the value to insert
6491620fd73SBarry Smith -  mode - either INSERT_VALUES or ADD_VALUES
6501620fd73SBarry Smith 
6511620fd73SBarry Smith    Notes:
6521620fd73SBarry Smith    For efficiency one should use MatSetValues() and set several or many
6531620fd73SBarry Smith    values simultaneously if possible.
6541620fd73SBarry Smith 
6551620fd73SBarry Smith    Level: beginner
6561620fd73SBarry Smith 
6571620fd73SBarry Smith .seealso: MatSetValues(), MatSetValueLocal()
6581620fd73SBarry Smith M*/
6591620fd73SBarry 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);}
6601620fd73SBarry Smith 
6611620fd73SBarry Smith PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);}
6621620fd73SBarry Smith 
6631620fd73SBarry 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);}
6641620fd73SBarry Smith 
6651620fd73SBarry Smith /*MC
6660d2a7ff2SSatish Balay    MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
667bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
668bd481603SBarry Smith 
669bd481603SBarry Smith    Synopsis:
670c1ac3661SBarry Smith    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
671bd481603SBarry Smith 
672bd481603SBarry Smith    Collective on MPI_Comm
673bd481603SBarry Smith 
674bd481603SBarry Smith    Input Parameters:
675bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
676859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
677859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
678bd481603SBarry Smith 
679bd481603SBarry Smith    Output Parameters:
680bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
681bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
682bd481603SBarry Smith 
683bd481603SBarry Smith 
684bd481603SBarry Smith    Level: intermediate
685bd481603SBarry Smith 
686bd481603SBarry Smith    Notes:
687bd481603SBarry Smith    See the chapter in the users manual on performance for more details
688bd481603SBarry Smith 
6891d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
690bd481603SBarry Smith 
691bd481603SBarry Smith    Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
692bd481603SBarry Smith 
6931620fd73SBarry Smith    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
6941620fd73SBarry Smith 
695bd481603SBarry Smith   Concepts: preallocation^Matrix
696bd481603SBarry Smith 
697bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
698bd481603SBarry Smith           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
699bd481603SBarry Smith M*/
700c4f061fbSSatish Balay #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
7017c922b88SBarry Smith { \
702a89bc211SBarry Smith   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
703a89bc211SBarry Smith   _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
704a89bc211SBarry Smith   _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
705a89bc211SBarry Smith   _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
706c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
707a89bc211SBarry Smith   _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
7087c922b88SBarry Smith 
709bd481603SBarry Smith /*MC
7100d2a7ff2SSatish Balay    MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per
711bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
712bd481603SBarry Smith 
713bd481603SBarry Smith    Synopsis:
714c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
715bd481603SBarry Smith 
716bd481603SBarry Smith    Collective on MPI_Comm
717bd481603SBarry Smith 
718bd481603SBarry Smith    Input Parameters:
719bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
720859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
721859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
722bd481603SBarry Smith 
723bd481603SBarry Smith    Output Parameters:
724bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
725bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
726bd481603SBarry Smith 
727bd481603SBarry Smith 
728bd481603SBarry Smith    Level: intermediate
729bd481603SBarry Smith 
730bd481603SBarry Smith    Notes:
731bd481603SBarry Smith    See the chapter in the users manual on performance for more details
732bd481603SBarry Smith 
7331d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
734bd481603SBarry Smith 
7351620fd73SBarry Smith    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
7361620fd73SBarry Smith 
737bd481603SBarry Smith   Concepts: preallocation^Matrix
738bd481603SBarry Smith 
739bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
740bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
741bd481603SBarry Smith M*/
742222b16d4SBarry Smith #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \
743222b16d4SBarry Smith { \
744a89bc211SBarry Smith   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__end; \
745a89bc211SBarry Smith   _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
746a89bc211SBarry Smith   _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
747a89bc211SBarry Smith   _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
748c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\
749a89bc211SBarry Smith   _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
750222b16d4SBarry Smith 
751bd481603SBarry Smith /*MC
752bd481603SBarry Smith    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
753bd481603SBarry Smith        inserted using a local number of the rows and columns
754bd481603SBarry Smith 
755bd481603SBarry Smith    Synopsis:
756c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
757bd481603SBarry Smith 
758bd481603SBarry Smith    Not Collective
759bd481603SBarry Smith 
760bd481603SBarry Smith    Input Parameters:
761bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
762bd481603SBarry Smith .  nrows - the number of rows indicated
7631d73ed98SBarry Smith .  rows - the indices of the rows
764bd481603SBarry Smith .  ncols - the number of columns in the matrix
765bd481603SBarry Smith .  cols - the columns indicated
766bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
767bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
768bd481603SBarry Smith 
769bd481603SBarry Smith 
770bd481603SBarry Smith    Level: intermediate
771bd481603SBarry Smith 
772bd481603SBarry Smith    Notes:
773bd481603SBarry Smith    See the chapter in the users manual on performance for more details
774bd481603SBarry Smith 
7751d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
776bd481603SBarry Smith 
777bd481603SBarry Smith   Concepts: preallocation^Matrix
778bd481603SBarry Smith 
779bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
780bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
781bd481603SBarry Smith M*/
782c4f061fbSSatish Balay #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
783c4f061fbSSatish Balay {\
784c1ac3661SBarry Smith   PetscInt __l;\
785ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
786ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
787c4f061fbSSatish Balay   for (__l=0;__l<nrows;__l++) {\
788ef66eb69SBarry Smith     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
789c4f061fbSSatish Balay   }\
790c4f061fbSSatish Balay }
791c4f061fbSSatish Balay 
792bd481603SBarry Smith /*MC
793bd481603SBarry Smith    MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
794bd481603SBarry Smith        inserted using a local number of the rows and columns
795bd481603SBarry Smith 
796bd481603SBarry Smith    Synopsis:
797c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
798bd481603SBarry Smith 
799bd481603SBarry Smith    Not Collective
800bd481603SBarry Smith 
801bd481603SBarry Smith    Input Parameters:
802bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
803bd481603SBarry Smith .  nrows - the number of rows indicated
8041d73ed98SBarry Smith .  rows - the indices of the rows
805bd481603SBarry Smith .  ncols - the number of columns in the matrix
806bd481603SBarry Smith .  cols - the columns indicated
807bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
808bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
809bd481603SBarry Smith 
810bd481603SBarry Smith 
811bd481603SBarry Smith    Level: intermediate
812bd481603SBarry Smith 
813bd481603SBarry Smith    Notes:
814bd481603SBarry Smith    See the chapter in the users manual on performance for more details
815bd481603SBarry Smith 
816bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
817bd481603SBarry Smith 
818bd481603SBarry Smith   Concepts: preallocation^Matrix
819bd481603SBarry Smith 
820bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
821bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
822bd481603SBarry Smith M*/
823d3d32019SBarry Smith #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
824d3d32019SBarry Smith {\
825c1ac3661SBarry Smith   PetscInt __l;\
826d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
827d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
828d3d32019SBarry Smith   for (__l=0;__l<nrows;__l++) {\
829d3d32019SBarry Smith     _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
830d3d32019SBarry Smith   }\
831d3d32019SBarry Smith }
832d3d32019SBarry Smith 
833bd481603SBarry Smith /*MC
834bd481603SBarry Smith    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
835bd481603SBarry Smith        inserted using a local number of the rows and columns
836bd481603SBarry Smith 
837bd481603SBarry Smith    Synopsis:
838c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
839bd481603SBarry Smith 
840bd481603SBarry Smith    Not Collective
841bd481603SBarry Smith 
842bd481603SBarry Smith    Input Parameters:
84364075487SBarry Smith +  row - the row
844bd481603SBarry Smith .  ncols - the number of columns in the matrix
845a50f8bf6SHong Zhang -  cols - the columns indicated
846a50f8bf6SHong Zhang 
847a50f8bf6SHong Zhang    Output Parameters:
848a50f8bf6SHong Zhang +  dnz - the array that will be passed to the matrix preallocation routines
849bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
850bd481603SBarry Smith 
851bd481603SBarry Smith 
852bd481603SBarry Smith    Level: intermediate
853bd481603SBarry Smith 
854bd481603SBarry Smith    Notes:
855bd481603SBarry Smith    See the chapter in the users manual on performance for more details
856bd481603SBarry Smith 
857bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
858bd481603SBarry Smith 
8591620fd73SBarry Smith    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
8601620fd73SBarry Smith 
861bd481603SBarry Smith   Concepts: preallocation^Matrix
862bd481603SBarry Smith 
863bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
864bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
865bd481603SBarry Smith M*/
866c4f061fbSSatish Balay #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
867c1ac3661SBarry Smith { PetscInt __i; \
8688ee2e534SBarry Smith   if (row < __rstart) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D less than first local row %D",row,__rstart);\
869a89bc211SBarry 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);\
8707c922b88SBarry Smith   for (__i=0; __i<nc; __i++) {\
87164075487SBarry Smith     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
8727cc688d7SBarry Smith     else dnz[row - __rstart]++;\
8737c922b88SBarry Smith   }\
8747c922b88SBarry Smith }
8757c922b88SBarry Smith 
876bd481603SBarry Smith /*MC
877bd481603SBarry Smith    MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
878bd481603SBarry Smith        inserted using a local number of the rows and columns
879bd481603SBarry Smith 
880bd481603SBarry Smith    Synopsis:
881c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
882bd481603SBarry Smith 
883bd481603SBarry Smith    Not Collective
884bd481603SBarry Smith 
885bd481603SBarry Smith    Input Parameters:
886bd481603SBarry Smith +  nrows - the number of rows indicated
8871d73ed98SBarry Smith .  rows - the indices of the rows
888bd481603SBarry Smith .  ncols - the number of columns in the matrix
889bd481603SBarry Smith .  cols - the columns indicated
890bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
891bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
892bd481603SBarry Smith 
893bd481603SBarry Smith 
894bd481603SBarry Smith    Level: intermediate
895bd481603SBarry Smith 
896bd481603SBarry Smith    Notes:
897bd481603SBarry Smith    See the chapter in the users manual on performance for more details
898bd481603SBarry Smith 
899bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
900bd481603SBarry Smith 
9011620fd73SBarry Smith    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
9021620fd73SBarry Smith 
903bd481603SBarry Smith   Concepts: preallocation^Matrix
904bd481603SBarry Smith 
905bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
906bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
907bd481603SBarry Smith M*/
908d3d32019SBarry Smith #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
909c1ac3661SBarry Smith { PetscInt __i; \
910d3d32019SBarry Smith   for (__i=0; __i<nc; __i++) {\
911d3d32019SBarry Smith     if (cols[__i] >= __end) onz[row - __rstart]++; \
912d3d32019SBarry Smith     else if (cols[__i] >= row) dnz[row - __rstart]++;\
913d3d32019SBarry Smith   }\
914d3d32019SBarry Smith }
915d3d32019SBarry Smith 
916bd481603SBarry Smith /*MC
91716371a99SBarry Smith    MatPreallocateLocation -  An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists
91816371a99SBarry Smith 
91916371a99SBarry Smith    Synopsis:
92016371a99SBarry Smith    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)
92116371a99SBarry Smith 
92216371a99SBarry Smith    Not Collective
92316371a99SBarry Smith 
92416371a99SBarry Smith    Input Parameters:
92516371a99SBarry Smith .  A - matrix
92616371a99SBarry Smith .  row - row where values exist (must be local to this process)
92716371a99SBarry Smith .  ncols - number of columns
92816371a99SBarry Smith .  cols - columns with nonzeros
92916371a99SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
93016371a99SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
93116371a99SBarry Smith 
93216371a99SBarry Smith 
93316371a99SBarry Smith    Level: intermediate
93416371a99SBarry Smith 
93516371a99SBarry Smith    Notes:
93616371a99SBarry Smith    See the chapter in the users manual on performance for more details
93716371a99SBarry Smith 
93816371a99SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
93916371a99SBarry Smith 
94016371a99SBarry Smith    This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.
94116371a99SBarry Smith 
94216371a99SBarry Smith   Concepts: preallocation^Matrix
94316371a99SBarry Smith 
94416371a99SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
94516371a99SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
94616371a99SBarry Smith M*/
94716371a99SBarry 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);}
94816371a99SBarry Smith 
94916371a99SBarry Smith 
95016371a99SBarry Smith /*MC
9510d2a7ff2SSatish Balay    MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
952bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
953bd481603SBarry Smith 
954bd481603SBarry Smith    Synopsis:
955c1ac3661SBarry Smith    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
956bd481603SBarry Smith 
957bd481603SBarry Smith    Collective on MPI_Comm
958bd481603SBarry Smith 
959bd481603SBarry Smith    Input Parameters:
96016371a99SBarry Smith +  dnz - the array that was be passed to the matrix preallocation routines
961bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
962bd481603SBarry Smith 
963bd481603SBarry Smith 
964bd481603SBarry Smith    Level: intermediate
965bd481603SBarry Smith 
966bd481603SBarry Smith    Notes:
967bd481603SBarry Smith    See the chapter in the users manual on performance for more details
968bd481603SBarry Smith 
969bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
970bd481603SBarry Smith 
9711620fd73SBarry Smith    This is a MACRO not a function because it closes the { started in MatPreallocateInitialize().
9721620fd73SBarry Smith 
973bd481603SBarry Smith   Concepts: preallocation^Matrix
974bd481603SBarry Smith 
975bd481603SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
976bd481603SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
977bd481603SBarry Smith M*/
978a89bc211SBarry Smith #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}
9797c922b88SBarry Smith 
980bd481603SBarry Smith 
981bd481603SBarry Smith 
9827b80b807SBarry Smith /* Routines unique to particular data structures */
983be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **);
984ba966639SSatish Balay PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t)
985698d4c6aSKris Buschelman 
986be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*);
987be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
988698d4c6aSKris Buschelman 
989be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
990be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
991be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
992c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
993c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
9947b80b807SBarry Smith 
995a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4
996a96a251dSBarry Smith 
997be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
998ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
999be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1000ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
1001be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
1002ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz))
1003273d9f13SBarry Smith 
1004be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1005ba966639SSatish Balay PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz))
1006be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1007be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
100853803f26SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
1009725b52f3SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1010be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
1011be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1012be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
1013be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
1014284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
1015be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
1016be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
1017be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void));
1018273d9f13SBarry Smith 
1019be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt);
1020ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDenseGetLocalMatrix(Mat,Mat*);
10211b807ce4Svictorle 
1022be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat);
1023be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat);
10242e8a6d31SBarry Smith 
1025be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*);
10263a7fca6bSBarry Smith 
10277b80b807SBarry Smith /*
10287b80b807SBarry Smith   These routines are not usually accessed directly, rather solving is
102994b7f48cSBarry Smith   done through the KSP and PC interfaces.
10307b80b807SBarry Smith */
10317b80b807SBarry Smith 
1032d9274352SBarry Smith /*E
1033d9274352SBarry Smith     MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
1034d9274352SBarry Smith        with an optional dynamic library name, for example
1035d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
1036d9274352SBarry Smith 
1037d9274352SBarry Smith    Level: beginner
1038d9274352SBarry Smith 
1039e5a9bf91SBarry Smith    Cannot use const because the PC objects manipulate the string
1040e5a9bf91SBarry Smith 
1041d9274352SBarry Smith .seealso: MatGetOrdering()
1042d9274352SBarry Smith E*/
10433eaad2caSSatish Balay #define MatOrderingType char*
1044b12f92e5SBarry Smith #define MATORDERING_NATURAL     "natural"
1045b12f92e5SBarry Smith #define MATORDERING_ND          "nd"
1046b12f92e5SBarry Smith #define MATORDERING_1WD         "1wd"
1047b12f92e5SBarry Smith #define MATORDERING_RCM         "rcm"
1048b12f92e5SBarry Smith #define MATORDERING_QMD         "qmd"
1049b12f92e5SBarry Smith #define MATORDERING_ROWLENGTH   "rowlength"
1050e106eecfSBarry Smith #define MATORDERING_DSC_ND      "dsc_nd"         /* these three are only for DSCPACK, see its documentation for details */
105162152c8bSBarry Smith #define MATORDERING_DSC_MMD     "dsc_mmd"
105262152c8bSBarry Smith #define MATORDERING_DSC_MDF     "dsc_mdf"
1053c06d978dSMatthew Knepley #define MATORDERING_CONSTRAINED "constrained"
1054c06d978dSMatthew Knepley #define MATORDERING_IDENTITY    "identity"
1055c06d978dSMatthew Knepley #define MATORDERING_REVERSE     "reverse"
10568fa24674SBarry Smith #define MATORDERING_FLOW        "flow"
105799671722SJed Brown #define MATORDERING_AMD         "amd"
1058b12f92e5SBarry Smith 
1059f2416520SSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
1060be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list);
1061f2416520SSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));
106230de9b25SBarry Smith 
106330de9b25SBarry Smith /*MC
10641890ba74SBarry Smith    MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the matrix package.
106530de9b25SBarry Smith 
106630de9b25SBarry Smith    Synopsis:
10671890ba74SBarry Smith    PetscErrorCode MatOrderingRegisterDynamic(const char *name_ordering,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
106830de9b25SBarry Smith 
106930de9b25SBarry Smith    Not Collective
107030de9b25SBarry Smith 
107130de9b25SBarry Smith    Input Parameters:
107230de9b25SBarry Smith +  sname - name of ordering (for example MATORDERING_ND)
107330de9b25SBarry Smith .  path - location of library where creation routine is
107430de9b25SBarry Smith .  name - name of function that creates the ordering type,a string
107530de9b25SBarry Smith -  function - function pointer that creates the ordering
107630de9b25SBarry Smith 
107730de9b25SBarry Smith    Level: developer
107830de9b25SBarry Smith 
107930de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
108030de9b25SBarry Smith    is ignored.
108130de9b25SBarry Smith 
108230de9b25SBarry Smith    Sample usage:
108330de9b25SBarry Smith .vb
108430de9b25SBarry Smith    MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
108530de9b25SBarry Smith                "MyOrder",MyOrder);
108630de9b25SBarry Smith .ve
108730de9b25SBarry Smith 
108830de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
108930de9b25SBarry Smith $     MatOrderingSetType(part,"my_order)
109030de9b25SBarry Smith    or at runtime via the option
10912401956bSBarry Smith $     -pc_factor_mat_ordering_type my_order
109230de9b25SBarry Smith 
1093ab901514SBarry Smith    ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
109430de9b25SBarry Smith 
109530de9b25SBarry Smith .keywords: matrix, ordering, register
109630de9b25SBarry Smith 
109730de9b25SBarry Smith .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
109830de9b25SBarry Smith M*/
1099aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1100f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
1101b12f92e5SBarry Smith #else
1102f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
1103b12f92e5SBarry Smith #endif
110430de9b25SBarry Smith 
1105be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void);
1106be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]);
11072bad1931SBarry Smith extern PetscTruth MatOrderingRegisterAllCalled;
1108b0a32e0cSBarry Smith extern PetscFList MatOrderingList;
1109d4fbbf0eSBarry Smith 
1110be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1111a2ce50c7SBarry Smith 
1112d91e6319SBarry Smith /*S
1113d90ac83dSHong Zhang     MatFactorShiftType - Numeric Shift.
1114d90ac83dSHong Zhang 
1115d90ac83dSHong Zhang    Level: beginner
1116d90ac83dSHong Zhang 
1117d90ac83dSHong Zhang S*/
1118d90ac83dSHong Zhang typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
1119d90ac83dSHong Zhang extern const char *MatFactorShiftTypes[];
1120d90ac83dSHong Zhang 
1121d90ac83dSHong Zhang /*S
11222401956bSBarry Smith    MatFactorInfo - Data passed into the matrix factorization routines
1123b00f7748SHong Zhang 
112461cad860SBarry Smith    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
112561cad860SBarry Smith $     MatFactorInfo  info(MAT_FACTORINFO_SIZE)
1126b00f7748SHong Zhang 
112715e8a5b3SHong Zhang    Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
1128b00f7748SHong Zhang 
112961cad860SBarry Smith       You can use MatFactorInfoInitialize() to set default values.
113061cad860SBarry Smith 
1131b00f7748SHong Zhang    Level: developer
1132b00f7748SHong Zhang 
1133d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1134d7d82daaSBarry Smith           MatFactorInfoInitialize()
1135b00f7748SHong Zhang 
1136b00f7748SHong Zhang S*/
1137b00f7748SHong Zhang typedef struct {
113815e8a5b3SHong Zhang   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
113985317021SBarry Smith   PetscReal     usedt;
114015e8a5b3SHong Zhang   PetscReal     dt;             /* drop tolerance */
1141b00f7748SHong Zhang   PetscReal     dtcol;          /* tolerance for pivoting */
114215e8a5b3SHong Zhang   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
114367e28bfeSBarry Smith   PetscReal     fill;           /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1144348344bbSBarry Smith   PetscReal     levels;         /* ICC/ILU(levels) */
1145bcd9e38bSBarry Smith   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1146bcd9e38bSBarry Smith                                    factorization may be faster if do not pivot */
114715e8a5b3SHong Zhang   PetscReal     zeropivot;      /* pivot is called zero if less than this */
1148f4db908eSBarry Smith   PetscReal     shifttype;      /* type of shift added to matrix factor to prevent zero pivots */
1149f4db908eSBarry Smith   PetscReal     shiftamount;     /* how large the shift is */
115015e8a5b3SHong Zhang } MatFactorInfo;
1151ffa6d0a5SLois Curfman McInnes 
1152be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*);
11530481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
11540481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
11550481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
11560481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
11570481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
11580481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
11590481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
11600481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
11610481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,const MatFactorInfo*);
11620481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1163be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1164be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec);
1165be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec);
1166be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec);
1167be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec);
1168be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec);
1169be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1170be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs);
11718ed539a5SBarry Smith 
1172be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat);
1173bb5a7306SBarry Smith 
1174d91e6319SBarry Smith /*E
1175d91e6319SBarry Smith     MatSORType - What type of (S)SOR to perform
1176bb1eb677SSatish Balay 
1177d91e6319SBarry Smith     Level: beginner
1178d91e6319SBarry Smith 
1179d9274352SBarry Smith    May be bitwise ORd together
1180d9274352SBarry Smith 
1181d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1182d91e6319SBarry Smith 
11834e7234bfSBarry Smith    MatSORType may be bitwise ORd together, so do not change the numbers
11844e7234bfSBarry Smith 
118541f059aeSBarry Smith .seealso: MatSOR()
1186d91e6319SBarry Smith E*/
1187ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1188ee50ffe9SBarry Smith               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1189ee50ffe9SBarry Smith               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
119084cb2905SBarry Smith               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
119141f059aeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
11928ed539a5SBarry Smith 
1193d4fbbf0eSBarry Smith /*
1194639f9d9dSBarry Smith     These routines are for efficiently computing Jacobians via finite differences.
1195639f9d9dSBarry Smith */
1196b12f92e5SBarry Smith 
1197d9274352SBarry Smith /*E
1198d9274352SBarry Smith     MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1199d9274352SBarry Smith        with an optional dynamic library name, for example
1200d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1201d9274352SBarry Smith 
1202d9274352SBarry Smith    Level: beginner
1203d9274352SBarry Smith 
1204d9274352SBarry Smith .seealso: MatGetColoring()
1205d9274352SBarry Smith E*/
1206a313700dSBarry Smith #define MatColoringType char*
1207b12f92e5SBarry Smith #define MATCOLORING_NATURAL "natural"
1208b12f92e5SBarry Smith #define MATCOLORING_SL      "sl"
1209b12f92e5SBarry Smith #define MATCOLORING_LF      "lf"
1210b12f92e5SBarry Smith #define MATCOLORING_ID      "id"
1211b12f92e5SBarry Smith 
1212ab970d9bSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,const MatColoringType,ISColoring*);
12132e90c967SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *));
121430de9b25SBarry Smith 
121530de9b25SBarry Smith /*MC
121630de9b25SBarry Smith    MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
121730de9b25SBarry Smith                                matrix package.
121830de9b25SBarry Smith 
121930de9b25SBarry Smith    Synopsis:
12201890ba74SBarry Smith    PetscErrorCode MatColoringRegisterDynamic(const char *name_coloring,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatColoring))
122130de9b25SBarry Smith 
122230de9b25SBarry Smith    Not Collective
122330de9b25SBarry Smith 
122430de9b25SBarry Smith    Input Parameters:
122530de9b25SBarry Smith +  sname - name of Coloring (for example MATCOLORING_SL)
122630de9b25SBarry Smith .  path - location of library where creation routine is
122730de9b25SBarry Smith .  name - name of function that creates the Coloring type, a string
122830de9b25SBarry Smith -  function - function pointer that creates the coloring
122930de9b25SBarry Smith 
123030de9b25SBarry Smith    Level: developer
123130de9b25SBarry Smith 
123230de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
123330de9b25SBarry Smith    is ignored.
123430de9b25SBarry Smith 
123530de9b25SBarry Smith    Sample usage:
123630de9b25SBarry Smith .vb
123730de9b25SBarry Smith    MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
123830de9b25SBarry Smith                "MyColor",MyColor);
123930de9b25SBarry Smith .ve
124030de9b25SBarry Smith 
124130de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
124230de9b25SBarry Smith $     MatColoringSetType(part,"my_color")
124330de9b25SBarry Smith    or at runtime via the option
124430de9b25SBarry Smith $     -mat_coloring_type my_color
124530de9b25SBarry Smith 
1246ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
124730de9b25SBarry Smith 
124830de9b25SBarry Smith .keywords: matrix, Coloring, register
124930de9b25SBarry Smith 
125030de9b25SBarry Smith .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
125130de9b25SBarry Smith M*/
1252aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1253f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1254b12f92e5SBarry Smith #else
1255f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1256b12f92e5SBarry Smith #endif
125730de9b25SBarry Smith 
12582bad1931SBarry Smith extern PetscTruth MatColoringRegisterAllCalled;
1259f1144a30SSatish Balay 
1260be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]);
1261be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void);
1262be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1263639f9d9dSBarry Smith 
1264d9274352SBarry Smith /*S
1265d9274352SBarry Smith      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1266d9274352SBarry Smith         and coloring
1267639f9d9dSBarry Smith 
1268d9274352SBarry Smith    Level: beginner
1269d9274352SBarry Smith 
1270d9274352SBarry Smith   Concepts: coloring, sparse Jacobian, finite differences
1271d9274352SBarry Smith 
1272d9274352SBarry Smith .seealso:  MatFDColoringCreate()
1273d9274352SBarry Smith S*/
1274e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring;
1275639f9d9dSBarry Smith 
1276be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1277be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring);
1278be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer);
1279be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
12804a9d489dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1281be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1282be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring);
1283be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1284be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *);
1285be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec);
1286be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1287639f9d9dSBarry Smith /*
12880752156aSBarry Smith     These routines are for partitioning matrices: currently used only
12893eda8832SBarry Smith   for adjacency matrix, MatCreateMPIAdj().
12900752156aSBarry Smith */
1291ca161407SBarry Smith 
1292d9274352SBarry Smith /*S
1293d9274352SBarry Smith      MatPartitioning - Object for managing the partitioning of a matrix or graph
1294d9274352SBarry Smith 
1295d9274352SBarry Smith    Level: beginner
1296d9274352SBarry Smith 
1297d9274352SBarry Smith   Concepts: partitioning
1298d9274352SBarry Smith 
1299743a1026Svictorle .seealso:  MatPartitioningCreate(), MatPartitioningType
1300d9274352SBarry Smith S*/
130191e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning;
1302d9274352SBarry Smith 
1303d9274352SBarry Smith /*E
13045bc6e7ccSvictorle     MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1305d9274352SBarry Smith        with an optional dynamic library name, for example
1306d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1307d9274352SBarry Smith 
1308d9274352SBarry Smith    Level: beginner
1309d9274352SBarry Smith 
1310b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning
1311d9274352SBarry Smith E*/
1312a313700dSBarry Smith #define MatPartitioningType char*
13138ba1e511SMatthew Knepley #define MAT_PARTITIONING_CURRENT  "current"
1314c2ec2a73SHong Zhang #define MAT_PARTITIONING_SQUARE   "square"
13158ba1e511SMatthew Knepley #define MAT_PARTITIONING_PARMETIS "parmetis"
131671306c60Sjroman #define MAT_PARTITIONING_CHACO    "chaco"
131771306c60Sjroman #define MAT_PARTITIONING_JOSTLE   "jostle"
131871306c60Sjroman #define MAT_PARTITIONING_PARTY    "party"
131971306c60Sjroman #define MAT_PARTITIONING_SCOTCH   "scotch"
132071306c60Sjroman 
1321ca161407SBarry Smith 
1322be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1323a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,const MatPartitioningType);
1324be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt);
1325be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat);
1326be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1327be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1328be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*);
1329be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning);
13302aabb6bbSBarry Smith 
1331be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
133230de9b25SBarry Smith 
133330de9b25SBarry Smith /*MC
133430de9b25SBarry Smith    MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
133530de9b25SBarry Smith    matrix package.
133630de9b25SBarry Smith 
133730de9b25SBarry Smith    Synopsis:
13381890ba74SBarry Smith    PetscErrorCode MatPartitioningRegisterDynamic(const char *name_partitioning,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
133930de9b25SBarry Smith 
134030de9b25SBarry Smith    Not Collective
134130de9b25SBarry Smith 
134230de9b25SBarry Smith    Input Parameters:
134330de9b25SBarry Smith +  sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis
134430de9b25SBarry Smith .  path - location of library where creation routine is
134530de9b25SBarry Smith .  name - name of function that creates the partitioning type, a string
134630de9b25SBarry Smith -  function - function pointer that creates the partitioning type
134730de9b25SBarry Smith 
134830de9b25SBarry Smith    Level: developer
134930de9b25SBarry Smith 
135030de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
135130de9b25SBarry Smith    is ignored.
135230de9b25SBarry Smith 
135330de9b25SBarry Smith    Sample usage:
135430de9b25SBarry Smith .vb
135530de9b25SBarry Smith    MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
135630de9b25SBarry Smith                "MyPartCreate",MyPartCreate);
135730de9b25SBarry Smith .ve
135830de9b25SBarry Smith 
135930de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
136030de9b25SBarry Smith $     MatPartitioningSetType(part,"my_part")
136130de9b25SBarry Smith    or at runtime via the option
136230de9b25SBarry Smith $     -mat_partitioning_type my_part
136330de9b25SBarry Smith 
1364ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
136530de9b25SBarry Smith 
136630de9b25SBarry Smith .keywords: matrix, partitioning, register
136730de9b25SBarry Smith 
136830de9b25SBarry Smith .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
136930de9b25SBarry Smith M*/
1370aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1371f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
13722aabb6bbSBarry Smith #else
1373f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
13742aabb6bbSBarry Smith #endif
13752aabb6bbSBarry Smith 
13762bad1931SBarry Smith extern PetscTruth MatPartitioningRegisterAllCalled;
1377f1144a30SSatish Balay 
1378be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]);
1379be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void);
13802bad1931SBarry Smith 
1381be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer);
1382be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning);
1383a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,const MatPartitioningType*);
1384ca161407SBarry Smith 
1385be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
13860e8af3caSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);
13870752156aSBarry Smith 
1388be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal);
1389be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning);
139071306c60Sjroman 
1391954b3ec6SBarry Smith typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType;
1392be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
139371306c60Sjroman typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType;
1394be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1395be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
139671306c60Sjroman typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType;
1397be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1398be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1399be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
140071306c60Sjroman 
140171306c60Sjroman #define MP_PARTY_OPT "opt"
140271306c60Sjroman #define MP_PARTY_LIN "lin"
140371306c60Sjroman #define MP_PARTY_SCA "sca"
140471306c60Sjroman #define MP_PARTY_RAN "ran"
140571306c60Sjroman #define MP_PARTY_GBF "gbf"
140671306c60Sjroman #define MP_PARTY_GCF "gcf"
140771306c60Sjroman #define MP_PARTY_BUB "bub"
140871306c60Sjroman #define MP_PARTY_DEF "def"
1409be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*);
141071306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs"
141171306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl"
141271306c60Sjroman #define MP_PARTY_NONE "no"
1413be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*);
1414be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1415be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscTruth);
1416be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth);
141771306c60Sjroman 
141871306c60Sjroman typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType;
1419be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*);
1420be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning);
1421be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType);
1422be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal);
1423be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*);
142471306c60Sjroman typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType;
1425be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType);
1426be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning);
1427be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*);
142871306c60Sjroman 
1429591294e4SBarry Smith EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
143014196391SBarry Smith EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);
1431591294e4SBarry Smith 
14320752156aSBarry Smith /*
14330a835dfdSSatish Balay     If you add entries here you must also add them to finclude/petscmat.h
1434d4fbbf0eSBarry Smith */
14351c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0,
14361c1c02c0SLois Curfman McInnes                MATOP_GET_ROW=1,
14371c1c02c0SLois Curfman McInnes                MATOP_RESTORE_ROW=2,
14381c1c02c0SLois Curfman McInnes                MATOP_MULT=3,
14391c1c02c0SLois Curfman McInnes                MATOP_MULT_ADD=4,
14407c922b88SBarry Smith                MATOP_MULT_TRANSPOSE=5,
14417c922b88SBarry Smith                MATOP_MULT_TRANSPOSE_ADD=6,
14421c1c02c0SLois Curfman McInnes                MATOP_SOLVE=7,
14431c1c02c0SLois Curfman McInnes                MATOP_SOLVE_ADD=8,
14447c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE=9,
14457c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE_ADD=10,
14461c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR=11,
14471c1c02c0SLois Curfman McInnes                MATOP_CHOLESKYFACTOR=12,
1448a714c06dSBarry Smith                MATOP_SOR=13,
14491c1c02c0SLois Curfman McInnes                MATOP_TRANSPOSE=14,
14501c1c02c0SLois Curfman McInnes                MATOP_GETINFO=15,
14511c1c02c0SLois Curfman McInnes                MATOP_EQUAL=16,
14521c1c02c0SLois Curfman McInnes                MATOP_GET_DIAGONAL=17,
14531c1c02c0SLois Curfman McInnes                MATOP_DIAGONAL_SCALE=18,
14541c1c02c0SLois Curfman McInnes                MATOP_NORM=19,
14551c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_BEGIN=20,
14561c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_END=21,
1457d519adbfSMatthew Knepley                MATOP_SET_OPTION=22,
1458d519adbfSMatthew Knepley                MATOP_ZERO_ENTRIES=23,
1459d519adbfSMatthew Knepley                MATOP_ZERO_ROWS=24,
1460d519adbfSMatthew Knepley                MATOP_LUFACTOR_SYMBOLIC=25,
1461d519adbfSMatthew Knepley                MATOP_LUFACTOR_NUMERIC=26,
1462d519adbfSMatthew Knepley                MATOP_CHOLESKY_FACTOR_SYMBOLIC=27,
1463d519adbfSMatthew Knepley                MATOP_CHOLESKY_FACTOR_NUMERIC=28,
1464d519adbfSMatthew Knepley                MATOP_SETUP_PREALLOCATION=29,
1465d519adbfSMatthew Knepley                MATOP_ILUFACTOR_SYMBOLIC=30,
1466d519adbfSMatthew Knepley                MATOP_ICCFACTOR_SYMBOLIC=31,
1467d519adbfSMatthew Knepley                MATOP_GET_ARRAY=32,
1468d519adbfSMatthew Knepley                MATOP_RESTORE_ARRAY=33,
1469d519adbfSMatthew Knepley                MATOP_DUPLICATE=34,
1470d519adbfSMatthew Knepley                MATOP_FORWARD_SOLVE=35,
1471d519adbfSMatthew Knepley                MATOP_BACKWARD_SOLVE=36,
1472d519adbfSMatthew Knepley                MATOP_ILUFACTOR=37,
1473d519adbfSMatthew Knepley                MATOP_ICCFACTOR=38,
1474d519adbfSMatthew Knepley                MATOP_AXPY=39,
1475d519adbfSMatthew Knepley                MATOP_GET_SUBMATRICES=40,
1476d519adbfSMatthew Knepley                MATOP_INCREASE_OVERLAP=41,
1477d519adbfSMatthew Knepley                MATOP_GET_VALUES=42,
1478d519adbfSMatthew Knepley                MATOP_COPY=43,
1479d519adbfSMatthew Knepley                MATOP_GET_ROW_MAX=44,
1480d519adbfSMatthew Knepley                MATOP_SCALE=45,
1481d519adbfSMatthew Knepley                MATOP_SHIFT=46,
148235153367SBarry Smith                MATOP_DIAGONAL_SET=47,
1483d519adbfSMatthew Knepley                MATOP_ILUDT_FACTOR=48,
1484d519adbfSMatthew Knepley                MATOP_SET_BLOCK_SIZE=49,
1485d519adbfSMatthew Knepley                MATOP_GET_ROW_IJ=50,
1486d519adbfSMatthew Knepley                MATOP_RESTORE_ROW_IJ=51,
1487d519adbfSMatthew Knepley                MATOP_GET_COLUMN_IJ=52,
1488d519adbfSMatthew Knepley                MATOP_RESTORE_COLUMN_IJ=53,
1489d519adbfSMatthew Knepley                MATOP_FDCOLORING_CREATE=54,
1490d519adbfSMatthew Knepley                MATOP_COLORING_PATCH=55,
1491d519adbfSMatthew Knepley                MATOP_SET_UNFACTORED=56,
1492d519adbfSMatthew Knepley                MATOP_PERMUTE=57,
1493d519adbfSMatthew Knepley                MATOP_SET_VALUES_BLOCKED=58,
1494d519adbfSMatthew Knepley                MATOP_GET_SUBMATRIX=59,
1495d519adbfSMatthew Knepley                MATOP_DESTROY=60,
1496d519adbfSMatthew Knepley                MATOP_VIEW=61,
1497d519adbfSMatthew Knepley                MATOP_CONVERT_FROM=62,
1498d519adbfSMatthew Knepley                MATOP_USE_SCALED_FORM=63,
1499d519adbfSMatthew Knepley                MATOP_SCALE_SYSTEM=64,
1500d519adbfSMatthew Knepley                MATOP_UNSCALE_SYSTEM=65,
1501d519adbfSMatthew Knepley                MATOP_SET_LOCAL_TO_GLOBAL_MAP=66,
1502d519adbfSMatthew Knepley                MATOP_SET_VALUES_LOCAL=67,
1503d519adbfSMatthew Knepley                MATOP_ZERO_ROWS_LOCAL=68,
1504d519adbfSMatthew Knepley                MATOP_GET_ROW_MAX_ABS=69,
1505d519adbfSMatthew Knepley                MATOP_GET_ROW_MIN_ABS=70,
1506d519adbfSMatthew Knepley                MATOP_CONVERT=71,
1507d519adbfSMatthew Knepley                MATOP_SET_COLORING=72,
1508d519adbfSMatthew Knepley                MATOP_SET_VALUES_ADIC=73,
1509d519adbfSMatthew Knepley                MATOP_SET_VALUES_ADIFOR=74,
1510d519adbfSMatthew Knepley                MATOP_FD_COLORING_APPLY=75,
1511d519adbfSMatthew Knepley                MATOP_SET_FROM_OPTIONS=76,
1512d519adbfSMatthew Knepley                MATOP_MULT_CON=77,
1513d519adbfSMatthew Knepley                MATOP_MULT_TRANSPOSE_CON=78,
1514d519adbfSMatthew Knepley                MATOP_PERMUTE_SPARSIFY=79,
1515d519adbfSMatthew Knepley                MATOP_MULT_MULTIPLE=80,
1516d519adbfSMatthew Knepley                MATOP_SOLVE_MULTIPLE=81,
1517d519adbfSMatthew Knepley                MATOP_GET_INERTIA=82,
1518d519adbfSMatthew Knepley                MATOP_LOAD=83,
1519d519adbfSMatthew Knepley                MATOP_IS_SYMMETRIC=84,
1520d519adbfSMatthew Knepley                MATOP_IS_HERMITIAN=85,
1521d519adbfSMatthew Knepley                MATOP_IS_STRUCTURALLY_SYMMETRIC=86,
152241f059aeSBarry Smith                MATOP_DUMMY=87,
1523d519adbfSMatthew Knepley                MATOP_GET_VECS=88,
1524d519adbfSMatthew Knepley                MATOP_MAT_MULT=89,
1525d519adbfSMatthew Knepley                MATOP_MAT_MULT_SYMBOLIC=90,
1526d519adbfSMatthew Knepley                MATOP_MAT_MULT_NUMERIC=91,
1527d519adbfSMatthew Knepley                MATOP_PTAP=92,
1528d519adbfSMatthew Knepley                MATOP_PTAP_SYMBOLIC=93,
1529d519adbfSMatthew Knepley                MATOP_PTAP_NUMERIC=94,
1530d519adbfSMatthew Knepley                MATOP_MAT_MULTTRANSPOSE=95,
15311763ac4eSSatish Balay                MATOP_MAT_MULTTRANSPOSE_SYM=96,
15321763ac4eSSatish Balay                MATOP_MAT_MULTTRANSPOSE_NUM=97,
1533d519adbfSMatthew Knepley                MATOP_PTAP_SYMBOLIC_SEQAIJ=98,
1534d519adbfSMatthew Knepley                MATOP_PTAP_NUMERIC_SEQAIJ=99,
1535d519adbfSMatthew Knepley                MATOP_PTAP_SYMBOLIC_MPIAIJ=100,
1536d519adbfSMatthew Knepley                MATOP_PTAP_NUMERIC_MPIAIJ=101,
1537d519adbfSMatthew Knepley                MATOP_CONJUGATE=102,
1538d519adbfSMatthew Knepley                MATOP_SET_SIZES=103,
1539d519adbfSMatthew Knepley                MATOP_SET_VALUES_ROW=104,
1540d519adbfSMatthew Knepley                MATOP_REAL_PART=105,
1541d519adbfSMatthew Knepley                MATOP_IMAG_PART=106,
1542d519adbfSMatthew Knepley                MATOP_GET_ROW_UTRIANGULAR=107,
1543d519adbfSMatthew Knepley                MATOP_RESTORE_ROW_UTRIANGULAR=108,
1544d519adbfSMatthew Knepley                MATOP_MATSOLVE=109,
1545d519adbfSMatthew Knepley                MATOP_GET_REDUNDANTMATRIX=110,
1546d519adbfSMatthew Knepley                MATOP_GET_ROW_MIN=111,
1547d519adbfSMatthew Knepley                MATOP_GET_COLUMN_VEC=112,
1548d519adbfSMatthew Knepley                MATOP_MISSING_DIAGONAL=113,
1549d519adbfSMatthew Knepley                MATOP_MATGETSEQNONZEROSTRUCTURE=114,
155089c6957cSBarry Smith                MATOP_CREATE=115,
155189c6957cSBarry Smith                MATOP_GET_GHOSTS=116,
1552eeffb40dSHong Zhang                MATOP_MULT_DIAGONAL_BLOCK=119,
1553547795f9SHong Zhang                MATOP_HERMITIANTRANSPOSE=120,
1554547795f9SHong Zhang                MATOP_MULTHERMITIANTRANSPOSE=121,
1555547795f9SHong Zhang                MATOP_MULTHERMITIANTRANSPOSEADD=122
1556fae171e0SBarry Smith              } MatOperation;
1557be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscTruth*);
1558be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void));
1559be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void));
1560be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*);
1561112a2221SBarry Smith 
156290ace30eSBarry Smith /*
156390ace30eSBarry Smith    Codes for matrices stored on disk. By default they are
156490ace30eSBarry Smith  stored in a universal format. By changing the format with
15657973ad04SBarry Smith  PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
156690ace30eSBarry Smith  be stored in a way natural for the matrix, for example dense matrices
156790ace30eSBarry Smith  would be stored as dense. Matrices stored this way may only be
156890ace30eSBarry Smith  read into matrices of the same time.
156990ace30eSBarry Smith */
157090ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1
157190ace30eSBarry Smith 
1572be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1573be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*);
15741f4e1ec7SBarry Smith 
1575d9274352SBarry Smith /*S
1576d9274352SBarry Smith      MatNullSpace - Object that removes a null space from a vector, i.e.
1577d9274352SBarry Smith          orthogonalizes the vector to a subsapce
1578d9274352SBarry Smith 
1579f7a9e4ceSBarry Smith    Level: advanced
1580d9274352SBarry Smith 
1581d9274352SBarry Smith   Concepts: matrix; linear operator, null space
1582d9274352SBarry Smith 
15836e1639daSBarry Smith   Users manual sections:
15846e1639daSBarry Smith .   sec_singular
15856e1639daSBarry Smith 
1586d9274352SBarry Smith .seealso:  MatNullSpaceCreate()
1587d9274352SBarry Smith S*/
158874637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace;
1589d9274352SBarry Smith 
1590be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*);
1591b22b330cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1592be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace);
1593be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1594be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace);
159595902228SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat,PetscTruth *);
159674637425SBarry Smith 
1597be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS);
1598be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1599be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
160046129b97SKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat);
16013f1d51d7SBarry Smith 
1602be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*);
1603be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*);
1604be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*);
1605c4f061fbSSatish Balay 
1606be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*);
1607b0a32e0cSBarry Smith 
1608be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec);
160904f1ad80SBarry Smith 
1610fef1beadSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
16113ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetBase(Mat,Vec,Vec);
16123ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1613e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1614e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1615e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDAddNullSpace(Mat,MatNullSpace);
1616e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1617e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDResetHHistory(Mat);
1618e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctionError(Mat,PetscReal);
1619e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetPeriod(Mat,PetscInt);
1620e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDGetH(Mat,PetscScalar *);
16216aa9148fSLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetOptionsPrefix(Mat,const char[]);
1622e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFromOptions(Mat);
1623e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1624e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);
1625e884886fSBarry Smith 
16266370053bSBarry Smith /*S
16276370053bSBarry Smith     MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free
16286370053bSBarry Smith               Jacobian vector products
1629e884886fSBarry Smith 
16306370053bSBarry Smith     Notes: MATMFFD is a specific MatType which uses the MatMFFD data structure
16316370053bSBarry Smith 
16326370053bSBarry Smith            MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure
16336370053bSBarry Smith 
16346370053bSBarry Smith     Level: developer
16356370053bSBarry Smith 
16366370053bSBarry Smith .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
16376370053bSBarry Smith S*/
1638e884886fSBarry Smith typedef struct _p_MatMFFD* MatMFFD;
1639e884886fSBarry Smith 
1640e884886fSBarry Smith /*E
1641e884886fSBarry Smith     MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function
1642e884886fSBarry Smith 
1643e884886fSBarry Smith    Level: beginner
1644e884886fSBarry Smith 
1645e884886fSBarry Smith .seealso: MatMFFDSetType(), MatMFFDRegister()
1646e884886fSBarry Smith E*/
1647a313700dSBarry Smith #define MatMFFDType char*
1648e884886fSBarry Smith #define MATMFFD_DS  "ds"
1649e884886fSBarry Smith #define MATMFFD_WP  "wp"
1650e884886fSBarry Smith 
1651a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetType(Mat,const MatMFFDType);
1652e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatMFFD));
1653e884886fSBarry Smith 
1654e884886fSBarry Smith /*MC
1655e884886fSBarry Smith    MatMFFDRegisterDynamic - Adds a method to the MatMFFD registry.
1656e884886fSBarry Smith 
1657e884886fSBarry Smith    Synopsis:
16581890ba74SBarry Smith    PetscErrorCode MatMFFDRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatMFFD))
1659e884886fSBarry Smith 
1660e884886fSBarry Smith    Not Collective
1661e884886fSBarry Smith 
1662e884886fSBarry Smith    Input Parameters:
1663e884886fSBarry Smith +  name_solver - name of a new user-defined compute-h module
1664e884886fSBarry Smith .  path - path (either absolute or relative) the library containing this solver
1665e884886fSBarry Smith .  name_create - name of routine to create method context
1666e884886fSBarry Smith -  routine_create - routine to create method context
1667e884886fSBarry Smith 
1668e884886fSBarry Smith    Level: developer
1669e884886fSBarry Smith 
1670e884886fSBarry Smith    Notes:
1671e884886fSBarry Smith    MatMFFDRegisterDynamic() may be called multiple times to add several user-defined solvers.
1672e884886fSBarry Smith 
1673e884886fSBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
1674e884886fSBarry Smith    is ignored.
1675e884886fSBarry Smith 
1676e884886fSBarry Smith    Sample usage:
1677e884886fSBarry Smith .vb
1678e884886fSBarry Smith    MatMFFDRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a,
1679e884886fSBarry Smith                "MyHCreate",MyHCreate);
1680e884886fSBarry Smith .ve
1681e884886fSBarry Smith 
1682e884886fSBarry Smith    Then, your solver can be chosen with the procedural interface via
1683e884886fSBarry Smith $     MatMFFDSetType(mfctx,"my_h")
1684e884886fSBarry Smith    or at runtime via the option
1685e884886fSBarry Smith $     -snes_mf_type my_h
1686e884886fSBarry Smith 
1687e884886fSBarry Smith .keywords: MatMFFD, register
1688e884886fSBarry Smith 
1689e884886fSBarry Smith .seealso: MatMFFDRegisterAll(), MatMFFDRegisterDestroy()
1690e884886fSBarry Smith M*/
1691e884886fSBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1692e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,0)
1693e884886fSBarry Smith #else
1694e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,d)
1695e884886fSBarry Smith #endif
1696e884886fSBarry Smith 
1697e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterAll(const char[]);
1698e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterDestroy(void);
16991d0fab5eSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDDSSetUmin(Mat,PetscReal);
1700e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDWPSetComputeNormU(Mat,PetscTruth);
1701e884886fSBarry Smith 
1702e884886fSBarry Smith 
1703be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1704be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
17057dbadf16SMatthew Knepley 
170697969023SHong Zhang /*
170797969023SHong Zhang    PETSc interface to MUMPS
170897969023SHong Zhang */
170997969023SHong Zhang #ifdef PETSC_HAVE_MUMPS
171097969023SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
171197969023SHong Zhang #endif
171223a5497aSJed Brown 
171323a5497aSJed Brown PETSC_EXTERN_CXX_END
171423a5497aSJed Brown #endif
1715