xref: /petsc/include/petscmat.h (revision 45b63f25e2811289c9ab890473ccbdba6d30c71d)
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"
315a11e1b2SBarry Smith #define MATMAIJ            "maij"
32273d9f13SBarry Smith #define MATSEQMAIJ           "seqmaij"
33273d9f13SBarry Smith #define MATMPIMAIJ           "mpimaij"
34273d9f13SBarry Smith #define MATIS              "is"
355a11e1b2SBarry Smith #define MATAIJ             "aij"
36273d9f13SBarry Smith #define MATSEQAIJ            "seqaij"
37273d9f13SBarry Smith #define MATMPIAIJ            "mpiaij"
385a11e1b2SBarry Smith #define MATAIJCRL              "aijcrl"
395a11e1b2SBarry Smith #define MATSEQAIJCRL             "seqaijcrl"
405a11e1b2SBarry Smith #define MATMPIAIJCRL             "mpiaijcrl"
415a11e1b2SBarry Smith #define MATAIJCUDA             "aijcuda"
425a11e1b2SBarry Smith #define MATSEQAIJCUDA            "seqaijcuda"
435a11e1b2SBarry Smith #define MATMPIAIJCUDA            "mpiaijcuda"
445a11e1b2SBarry Smith #define MATAIJPERM             "aijperm"
455a11e1b2SBarry Smith #define MATSEQAIJPERM            "seqaijperm"
465a11e1b2SBarry Smith #define MATMPIAIJPERM            "mpiaijperm"
47273d9f13SBarry Smith #define MATSHELL           "shell"
485a11e1b2SBarry Smith #define MATDENSE           "dense"
49209238afSKris Buschelman #define MATSEQDENSE          "seqdense"
50273d9f13SBarry Smith #define MATMPIDENSE          "mpidense"
515a11e1b2SBarry Smith #define MATBAIJ            "baij"
52273d9f13SBarry Smith #define MATSEQBAIJ           "seqbaij"
53273d9f13SBarry Smith #define MATMPIBAIJ           "mpibaij"
54273d9f13SBarry Smith #define MATMPIADJ          "mpiadj"
555a11e1b2SBarry Smith #define MATSBAIJ           "sbaij"
56273d9f13SBarry Smith #define MATSEQSBAIJ          "seqsbaij"
57273d9f13SBarry Smith #define MATMPISBAIJ          "mpisbaij"
58cebc7f6cSBarry Smith #define MATDAAD            "daad"
59cebc7f6cSBarry Smith #define MATMFFD            "mffd"
60c8a8475eSBarry Smith #define MATNORMAL          "normal"
61ab92ecdeSBarry Smith #define MATLRC             "lrc"
622a6744ebSBarry Smith #define MATSCATTER         "scatter"
63421e10b8SBarry Smith #define MATBLOCKMAT        "blockmat"
64793850ffSBarry Smith #define MATCOMPOSITE       "composite"
655a7f1df3SHong Zhang #define MATSEQFFTW         "seqfftw"
66e133240eSMatthew G Knepley #define MATSEQCUFFT        "seqcufft"
67557cca28SSatish Balay #define MATTRANSPOSEMAT    "transpose"
6872ca8751SBarry Smith #define MATSCHURCOMPLEMENT "schurcomplement"
691d6018f0SLisandro Dalcin #define MATPYTHON          "python"
70f91d8e95SBarry Smith #define MATHYPRESTRUCT     "hyprestruct"
71a9e6138eSGlenn Hammond #define MATHYPRESSTRUCT    "hypresstruct"
72ee1cef2cSJed Brown #define MATSUBMATRIX       "submatrix"
73dbc6227fSDmitry Karpeev #define MATDD              "matdd"
74ba2f8784SDmitry Karpeev #define MATIM              "matim"
75ba2f8784SDmitry Karpeev 
76773941d6SBarry Smith 
779989ab13SBarry Smith /*E
78c7393fdbSBarry Smith     MatSolverPackage - String with the name of a PETSc matrix solver type.
799989ab13SBarry Smith 
809989ab13SBarry Smith     For example: "petsc" indicates what PETSc provides, "superlu" indicates either
819989ab13SBarry Smith        SuperLU or SuperLU_Dist etc.
829989ab13SBarry Smith 
839989ab13SBarry Smith 
849989ab13SBarry Smith    Level: beginner
859989ab13SBarry Smith 
865c9eb25fSBarry Smith .seealso: MatGetFactor(), Mat, MatSetType(), MatType
879989ab13SBarry Smith E*/
88c7393fdbSBarry Smith #define MatSolverPackage char*
892692d6eeSBarry Smith #define MATSOLVERSPOOLES      "spooles"
902692d6eeSBarry Smith #define MATSOLVERSUPERLU      "superlu"
912692d6eeSBarry Smith #define MATSOLVERSUPERLU_DIST "superlu_dist"
922692d6eeSBarry Smith #define MATSOLVERUMFPACK      "umfpack"
9320db9a53SJed Brown #define MATSOLVERCHOLMOD      "cholmod"
942692d6eeSBarry Smith #define MATSOLVERESSL         "essl"
952692d6eeSBarry Smith #define MATSOLVERLUSOL        "lusol"
962692d6eeSBarry Smith #define MATSOLVERMUMPS        "mumps"
972692d6eeSBarry Smith #define MATSOLVERPASTIX       "pastix"
982692d6eeSBarry Smith #define MATSOLVERDSCPACK      "dscpack"
992692d6eeSBarry Smith #define MATSOLVERMATLAB       "matlab"
1002692d6eeSBarry Smith #define MATSOLVERPETSC        "petsc"
1012692d6eeSBarry Smith #define MATSOLVERPLAPACK      "plapack"
1022692d6eeSBarry Smith #define MATSOLVERBAS          "bas"
103773941d6SBarry Smith 
104b24902e0SBarry Smith /*E
105b24902e0SBarry Smith     MatFactorType - indicates what type of factorization is requested
106b24902e0SBarry Smith 
107b24902e0SBarry Smith     Level: beginner
108b24902e0SBarry Smith 
109b24902e0SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
110b24902e0SBarry Smith 
111c7393fdbSBarry Smith .seealso: MatSolverPackage, MatGetFactor()
112b24902e0SBarry Smith E*/
113599ef60dSHong Zhang typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType;
11434918c53SJed Brown extern const char *const MatFactorTypes[];
115e92e720dSBarry Smith 
116c7393fdbSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactor(Mat,const MatSolverPackage,MatFactorType,Mat*);
117ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactorAvailable(Mat,const MatSolverPackage,MatFactorType,PetscBool *);
11835bd34faSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorGetSolverPackage(Mat,const MatSolverPackage*);
1196335c336SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactorType(Mat,MatFactorType*);
1209989ab13SBarry Smith 
121c06d978dSMatthew Knepley /* Logging support */
1220700a824SBarry Smith #define    MAT_FILE_CLASSID 1211216    /* used to indicate matrices in binary files */
1230700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_CLASSID;
1240700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_FDCOLORING_CLASSID;
1250700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_PARTITIONING_CLASSID;
1260700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_NULLSPACE_CLASSID;
1270700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MATMFFD_CLASSID;
128c06d978dSMatthew Knepley 
129ceb03754SKris Buschelman /*E
130ceb03754SKris Buschelman     MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
131ceb03754SKris Buschelman      or MatGetSubMatrix() are to be reused to store the new matrix values.
132ceb03754SKris Buschelman 
133ceb03754SKris Buschelman     Level: beginner
134ceb03754SKris Buschelman 
135ceb03754SKris Buschelman    Any additions/changes here MUST also be made in include/finclude/petscmat.h
136ceb03754SKris Buschelman 
1370c451bc4SBarry Smith .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
138ceb03754SKris Buschelman E*/
139dfe085dbSJed Brown typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX} MatReuse;
140ceb03754SKris Buschelman 
1415494a064SHong Zhang /*E
1425494a064SHong Zhang     MatGetSubMatrixOption - Indicates if matrices obtained from a call to MatGetSubMatrices()
143829201f2SHong Zhang      include the matrix values. Currently it is only used by MatGetSeqNonzerostructure().
1445494a064SHong Zhang 
1455494a064SHong Zhang     Level: beginner
1465494a064SHong Zhang 
147829201f2SHong Zhang .seealso: MatGetSeqNonzerostructure()
1485494a064SHong Zhang E*/
1495494a064SHong Zhang typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatGetSubMatrixOption;
1505494a064SHong Zhang 
151e5bd5246SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(const char[]);
152c06d978dSMatthew Knepley 
153f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreate(MPI_Comm,Mat*);
154a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(MPI_Comm comm),(comm,&A),Mat,A)
155a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(),(PETSC_COMM_WORLD,&A),Mat,A)
156f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
157a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat,const MatType);
158be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetFromOptions(Mat);
159be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUpPreallocation(Mat);
160be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]);
161be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat));
16230de9b25SBarry Smith 
163f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOptionsPrefix(Mat,const char[]);
164f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAppendOptionsPrefix(Mat,const char[]);
165f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOptionsPrefix(Mat,const char*[]);
166f69a0ea3SMatthew Knepley 
16730de9b25SBarry Smith /*MC
16830de9b25SBarry Smith    MatRegisterDynamic - Adds a new matrix type
16930de9b25SBarry Smith 
17030de9b25SBarry Smith    Synopsis:
1711890ba74SBarry Smith    PetscErrorCode MatRegisterDynamic(const char *name,const char *path,const char *name_create,PetscErrorCode (*routine_create)(Mat))
17230de9b25SBarry Smith 
17330de9b25SBarry Smith    Not Collective
17430de9b25SBarry Smith 
17530de9b25SBarry Smith    Input Parameters:
17630de9b25SBarry Smith +  name - name of a new user-defined matrix type
17730de9b25SBarry Smith .  path - path (either absolute or relative) the library containing this solver
17830de9b25SBarry Smith .  name_create - name of routine to create method context
17930de9b25SBarry Smith -  routine_create - routine to create method context
18030de9b25SBarry Smith 
18130de9b25SBarry Smith    Notes:
18230de9b25SBarry Smith    MatRegisterDynamic() may be called multiple times to add several user-defined solvers.
18330de9b25SBarry Smith 
18430de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
18530de9b25SBarry Smith    is ignored.
18630de9b25SBarry Smith 
18730de9b25SBarry Smith    Sample usage:
18830de9b25SBarry Smith .vb
18930de9b25SBarry Smith    MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a,
19030de9b25SBarry Smith                "MyMatCreate",MyMatCreate);
19130de9b25SBarry Smith .ve
19230de9b25SBarry Smith 
19330de9b25SBarry Smith    Then, your solver can be chosen with the procedural interface via
19430de9b25SBarry Smith $     MatSetType(Mat,"my_mat")
19530de9b25SBarry Smith    or at runtime via the option
19630de9b25SBarry Smith $     -mat_type my_mat
19730de9b25SBarry Smith 
19830de9b25SBarry Smith    Level: advanced
19930de9b25SBarry Smith 
200ab901514SBarry Smith    Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
20130de9b25SBarry Smith          If your function is not being put into a shared library then use VecRegister() instead
20230de9b25SBarry Smith 
20330de9b25SBarry Smith .keywords: Mat, register
20430de9b25SBarry Smith 
20530de9b25SBarry Smith .seealso: MatRegisterAll(), MatRegisterDestroy()
20630de9b25SBarry Smith 
20730de9b25SBarry Smith M*/
208273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
209273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0)
210273d9f13SBarry Smith #else
211273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d)
21230de9b25SBarry Smith #endif
21330de9b25SBarry Smith 
214ace3abfcSBarry Smith extern PetscBool  MatRegisterAllCalled;
215b0a32e0cSBarry Smith extern PetscFList MatList;
216b022a5c1SBarry Smith extern PetscFList MatColoringList;
217b022a5c1SBarry Smith extern PetscFList MatPartitioningList;
21828988994SBarry Smith 
2193b224e63SBarry Smith /*E
2203b224e63SBarry Smith     MatStructure - Indicates if the matrix has the same nonzero structure
2213b224e63SBarry Smith 
2223b224e63SBarry Smith     Level: beginner
2233b224e63SBarry Smith 
2243b224e63SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
2253b224e63SBarry Smith 
2263b224e63SBarry Smith .seealso: MatCopy(), KSPSetOperators(), PCSetOperators()
2273b224e63SBarry Smith E*/
2283b224e63SBarry Smith typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure;
2293b224e63SBarry Smith 
230be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
231be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
232be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
233ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A)
234ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A)
235ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A)
236ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A)
237ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A))
238ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A))
239ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A))
240be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
241ba966639SSatish 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)
242ba966639SSatish 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)
243ba966639SSatish 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)
244ba966639SSatish 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)
245ba966639SSatish 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))
246ba966639SSatish 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))
247ba966639SSatish 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))
248ba966639SSatish 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)
249ba966639SSatish 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)
250ba966639SSatish 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)
251ba966639SSatish 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)
252ba966639SSatish 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))
253ba966639SSatish 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))
254ba966639SSatish 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))
25563ab93bfSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
2568d7a6e47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
2578d7a6e47SBarry Smith 
258be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
259ba966639SSatish 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)
260ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
261ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
262ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
263ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
264ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
265ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
266be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
267ba966639SSatish 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)
268ba966639SSatish 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)
269ba966639SSatish 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)
270ba966639SSatish 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)
271ba966639SSatish 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))
272ba966639SSatish 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))
273ba966639SSatish 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))
274ba966639SSatish 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)
275ba966639SSatish 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)
276ba966639SSatish 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)
277ba966639SSatish 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)
278ba966639SSatish 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))
279ba966639SSatish 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))
280ba966639SSatish 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))
281d21a29f3SJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*);
282d21a29f3SJed Brown 
283be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
284be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
285ba966639SSatish 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)
286ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
287ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
288ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
289ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
290ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
291ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
292d21a29f3SJed Brown 
293be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
294ba966639SSatish 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)
295ba966639SSatish 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)
296ba966639SSatish 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)
297ba966639SSatish 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)
298ba966639SSatish 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))
299ba966639SSatish 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))
300ba966639SSatish 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))
301ba966639SSatish 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)
302ba966639SSatish 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)
303ba966639SSatish 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)
304ba966639SSatish 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)
305ba966639SSatish 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))
306ba966639SSatish 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))
307ba966639SSatish 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))
308dfb205c3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
309dfb205c3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
310dfb205c3SBarry Smith 
311be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
312ba966639SSatish 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)
313ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A)
314be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*);
315be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateNormal(Mat,Mat*);
316ba966639SSatish Balay PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A)
317ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateLRC(Mat,Mat,Mat,Mat*);
318284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*);
3195a11e1b2SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
3205a11e1b2SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
3212a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateScatter(MPI_Comm,VecScatter,Mat*);
3222a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterSetVecScatter(Mat,VecScatter);
3232a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterGetVecScatter(Mat,VecScatter*);
3248cdf2d9bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
325793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeAddMat(Mat,Mat);
326b52f573bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeMerge(Mat);
327793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
3286d7c1e57SBarry Smith typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
3296d7c1e57SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeSetType(Mat,MatCompositeType);
3306d7c1e57SBarry Smith 
331*45b63f25SDmitry Karpeev #if defined PETSC_HAVE_MATDD
332dbc6227fSDmitry Karpeev typedef enum {MATDD_BLOCK_COMM_DEFAULT = 0, MATDD_BLOCK_COMM_SELF = -1, MATDD_BLOCK_COMM_DETERMINE = -2} MatDDBlockCommType;
333dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDAIJSetPreallocation(Mat A,PetscInt nz,PetscInt *nnz);
334dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDGetDefaltBlockType(Mat A, const MatType *type);
335dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetDefaltBlockType(Mat A, const MatType type);
336dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetPreallocation_AIJ(Mat A,PetscInt nz,PetscInt *nnz);
337dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDAddBlock(Mat A, PetscInt rowblock, PetscInt colblock, const MatType blockmattype,  MatDDBlockCommType blockcommtype, Mat *block);
338dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetBlock(Mat A, PetscInt rowblock, PetscInt colblock, Mat block);
339dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDGetBlock(Mat A, PetscInt rowblock, PetscInt colblock, Mat *block);
340dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetScatters(Mat A, PetscInt blockcount, Mat scatters[]);
341dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetGathers(Mat A, PetscInt blockcount,  Mat gathers[]);
342*45b63f25SDmitry Karpeev #endif
34362ee7b53SDmitry Karpeev 
344ba2f8784SDmitry Karpeev #if defined PETSC_HAVE_MATIM
345ba2f8784SDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIMSetIS(Mat A, IS in, IS out);
346ba2f8784SDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIMGetIS(Mat A, IS *in, IS *out);
347ba2f8784SDmitry Karpeev #endif
348ba2f8784SDmitry Karpeev 
349ba2f8784SDmitry Karpeev 
350a6a5cd3fSDmitry Karpeev 
3515a7f1df3SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqFFTW(MPI_Comm,PetscInt,const PetscInt[],Mat*);
352e133240eSMatthew G Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqCUFFT(MPI_Comm,PetscInt,const PetscInt[],Mat*);
353f20085c4SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateTranspose(Mat,Mat*);
354ee1cef2cSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSubMatrix(Mat,IS,IS,Mat*);
355ee1cef2cSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSubMatrixUpdate(Mat,Mat,IS,IS);
3561472f72bSBarry Smith 
3571d6018f0SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreatePython(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const char[],Mat*);
3581d6018f0SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPythonSetType(Mat,const char[]);
3591d6018f0SLisandro Dalcin 
3601d6018f0SLisandro Dalcin 
361f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUp(Mat);
362be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat);
36321c89e3eSBarry Smith 
3640c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat);
36599cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRealPart(Mat);
36699cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatImaginaryPart(Mat);
367ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonalBlock(Mat,PetscBool *,MatReuse,Mat*);
368fe97e370SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetTrace(Mat,PetscScalar*);
36999cafbc1SBarry Smith 
3708ed539a5SBarry Smith /* ------------------------------------------------------------*/
371be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
372be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
37387d4246cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
374f259bd47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
37584cb2905SBarry Smith 
3762ef4de8bSBarry Smith /*S
3772ef4de8bSBarry Smith      MatStencil - Data structure (C struct) for storing information about a single row or
3782ef4de8bSBarry Smith         column of a matrix as index on an associated grid.
3792ef4de8bSBarry Smith 
3802ef4de8bSBarry Smith    Level: beginner
3812ef4de8bSBarry Smith 
3822ef4de8bSBarry Smith   Concepts: matrix; linear operator
3832ef4de8bSBarry Smith 
384d7bd93baSBarry Smith .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil()
3852ef4de8bSBarry Smith S*/
386435da068SBarry Smith typedef struct {
387c1ac3661SBarry Smith   PetscInt k,j,i,c;
388435da068SBarry Smith } MatStencil;
3892ef4de8bSBarry Smith 
390be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
391be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
392be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
393435da068SBarry Smith 
394be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat,ISColoring);
395be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat,void*);
396be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat,PetscInt,void*);
3973a7fca6bSBarry Smith 
398d91e6319SBarry Smith /*E
399d91e6319SBarry Smith     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
400d91e6319SBarry Smith      to continue to add values to it
401d91e6319SBarry Smith 
402d91e6319SBarry Smith     Level: beginner
403d91e6319SBarry Smith 
404d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd()
405d91e6319SBarry Smith E*/
4066d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
407be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat,MatAssemblyType);
408be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat,MatAssemblyType);
409ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat,PetscBool *);
4104f9c727eSBarry Smith 
4111d73ed98SBarry Smith 
41230de9b25SBarry Smith 
413d91e6319SBarry Smith /*E
414d91e6319SBarry Smith     MatOption - Options that may be set for a matrix and its behavior or storage
415d91e6319SBarry Smith 
416d91e6319SBarry Smith     Level: beginner
417d91e6319SBarry Smith 
4180a835dfdSSatish Balay    Any additions/changes here MUST also be made in include/finclude/petscmat.h
419d91e6319SBarry Smith 
420d91e6319SBarry Smith .seealso: MatSetOption()
421d91e6319SBarry Smith E*/
422512a5fc5SBarry Smith typedef enum {MAT_ROW_ORIENTED,MAT_NEW_NONZERO_LOCATIONS,
4234e0d8c25SBarry Smith               MAT_SYMMETRIC,
4244e0d8c25SBarry Smith               MAT_STRUCTURALLY_SYMMETRIC,
4258047e77bSBarry Smith               MAT_NEW_DIAGONALS,MAT_IGNORE_OFF_PROC_ENTRIES,
4264e0d8c25SBarry Smith               MAT_NEW_NONZERO_LOCATION_ERR,
4274e0d8c25SBarry Smith               MAT_NEW_NONZERO_ALLOCATION_ERR,MAT_USE_HASH_TABLE,
428a9817697SBarry Smith               MAT_KEEP_NONZERO_PATTERN,MAT_IGNORE_ZERO_ENTRIES,
4294e0d8c25SBarry Smith               MAT_USE_INODES,
4304e0d8c25SBarry Smith               MAT_HERMITIAN,
4314e0d8c25SBarry Smith               MAT_SYMMETRY_ETERNAL,
4324e0d8c25SBarry Smith               MAT_USE_COMPRESSEDROW,
4334e0d8c25SBarry Smith               MAT_IGNORE_LOWER_TRIANGULAR,MAT_ERROR_LOWER_TRIANGULAR,
43428b2fa4aSMatthew Knepley               MAT_GETROW_UPPERTRIANGULAR,MAT_UNUSED_NONZERO_LOCATION_ERR,
4354cb17eb5SBarry Smith               MAT_SPD,MAT_NO_OFF_PROC_ENTRIES,MAT_NO_OFF_PROC_ZERO_ROWS,
43628b2fa4aSMatthew Knepley               NUM_MAT_OPTIONS} MatOption;
437290bbb0aSBarry Smith extern const char *MatOptions[];
438ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption,PetscBool );
439a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,const MatType*);
440a313700dSBarry Smith PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),const MatType,t)
44184cb2905SBarry Smith 
442be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
443be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
444be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
445f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowUpperTriangular(Mat);
446f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowUpperTriangular(Mat);
447be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
448be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
449be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt);
450be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]);
451ba966639SSatish Balay PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a)
452be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]);
453be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *);
454ba966639SSatish Balay PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a)
455be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt);
4567b80b807SBarry Smith 
4571620fd73SBarry Smith 
458be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec);
45989c6957cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultDiagonalBlock(Mat,Vec,Vec);
460be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec);
461ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
462be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec);
463547795f9SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultHermitianTranspose(Mat,Vec,Vec);
464ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscBool *);
465ace3abfcSBarry Smith PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscBool ,t)
466ace3abfcSBarry Smith PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0,&t),PetscBool ,t)
467ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *);
468be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec);
4695cb05578SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
470ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
471be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec);
472be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec);
4732bebee5dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatSolve(Mat,Mat,Mat);
474f5edf698SHong Zhang 
475d91e6319SBarry Smith /*E
476d91e6319SBarry Smith     MatDuplicateOption - Indicates if a duplicated sparse matrix should have
477d91e6319SBarry Smith   its numerical values copied over or just its nonzero structure.
478d91e6319SBarry Smith 
479d91e6319SBarry Smith     Level: beginner
480d91e6319SBarry Smith 
481d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
482d91e6319SBarry Smith 
48370dcbbb9SBarry Smith $   MAT_SHARE_NONZERO_PATTERN - the i and j arrays in the new matrix will be shared with the original matrix
48470dcbbb9SBarry Smith $                               this also triggers the MAT_DO_NOT_COPY_VALUES option. This is used when you
48570dcbbb9SBarry Smith $                               have several matrices with the same nonzero pattern.
48670dcbbb9SBarry Smith 
487d91e6319SBarry Smith .seealso: MatDuplicate()
488d91e6319SBarry Smith E*/
48970dcbbb9SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;
4902e8a6d31SBarry Smith 
491a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat,const MatType,MatReuse,Mat*);
492a313700dSBarry Smith PetscPolymorphicFunction(MatConvert,(Mat A,const MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a)
493be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat,MatDuplicateOption,Mat*);
494ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a)
495ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a)
49694a9d846SBarry Smith 
497cb5b572fSBarry Smith 
498be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat,Mat,MatStructure);
499be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat,PetscViewer);
500ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat,PetscReal,PetscBool *);
501ace3abfcSBarry Smith PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscBool ,t)
502ace3abfcSBarry Smith PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0,&t),PetscBool ,t)
503ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscBool *);
504ace3abfcSBarry Smith PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscBool ,t)
505ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscReal,PetscBool *);
506ace3abfcSBarry Smith PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,0,&t),PetscBool ,t)
507ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *);
508ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat,PetscBool *,PetscBool *);
509ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMissingDiagonal(Mat,PetscBool  *,PetscInt *);
510112444f4SShri Abhyankar EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoad(Mat, PetscViewer);
5117b80b807SBarry Smith 
512ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,PetscInt *[],PetscInt *[],PetscBool  *);
513ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,PetscInt *[],PetscInt *[],PetscBool  *);
514ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,PetscInt *[],PetscInt *[],PetscBool  *);
515ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,PetscInt *[],PetscInt *[],PetscBool  *);
516d4fbbf0eSBarry Smith 
517d91e6319SBarry Smith /*S
518d91e6319SBarry Smith      MatInfo - Context of matrix information, used with MatGetInfo()
519d91e6319SBarry Smith 
520d91e6319SBarry Smith    In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
521d91e6319SBarry Smith 
522d91e6319SBarry Smith    Level: intermediate
523d91e6319SBarry Smith 
524d91e6319SBarry Smith   Concepts: matrix^nonzero information
525d91e6319SBarry Smith 
526d9274352SBarry Smith .seealso:  MatGetInfo(), MatInfoType
527d91e6319SBarry Smith S*/
5284e220ebcSLois Curfman McInnes typedef struct {
529b0a32e0cSBarry Smith   PetscLogDouble block_size;                         /* block size */
530b0a32e0cSBarry Smith   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
531b0a32e0cSBarry Smith   PetscLogDouble memory;                             /* memory allocated */
532b0a32e0cSBarry Smith   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
533b0a32e0cSBarry Smith   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
534b0a32e0cSBarry Smith   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
535b0a32e0cSBarry Smith   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
5364e220ebcSLois Curfman McInnes } MatInfo;
5374e220ebcSLois Curfman McInnes 
538d9274352SBarry Smith /*E
539d9274352SBarry Smith     MatInfoType - Indicates if you want information about the local part of the matrix,
540d9274352SBarry Smith      the entire parallel matrix or the maximum over all the local parts.
541d9274352SBarry Smith 
542d9274352SBarry Smith     Level: beginner
543d9274352SBarry Smith 
544d9274352SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
545d9274352SBarry Smith 
546d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo
547d9274352SBarry Smith E*/
5487b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
549be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat,MatInfoType,MatInfo*);
550be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat,Vec);
551985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec,PetscInt[]);
552985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMin(Mat,Vec,PetscInt[]);
553985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
554c87e5d42SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMinAbs(Mat,Vec,PetscInt[]);
55586697f06SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowSum(Mat,Vec);
556fc4dec0aSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,MatReuse,Mat*);
557fc4dec0aSBarry Smith PetscPolymorphicFunction(MatTranspose,(Mat A),(A,MAT_INITIAL_MATRIX,&t),Mat,t)
558eeffb40dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHermitianTranspose(Mat,MatReuse,Mat*);
559be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *);
560ba966639SSatish Balay PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t)
561be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *);
562be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec);
563be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode);
564ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscBool *);
565ace3abfcSBarry Smith PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscBool ,t)
566ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscBool *);
567ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscBool *);
568ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool *);
569ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool *);
5707b80b807SBarry Smith 
571be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *);
572ba966639SSatish Balay PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n)
573242f1d38SBarry Smith EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal *);
574be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat);
575f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar);
576f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar);
577c504e21bSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar);
578f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*);
579f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumnsIS(Mat,IS,const PetscScalar*);
5807b80b807SBarry Smith 
581ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscBool );
582be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec);
583be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec);
5845ef9f2a5SBarry Smith 
585be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*);
586be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*);
587be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
5888ee2e534SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRanges(Mat,const PetscInt**);
589f4b8409dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
59072ca8751SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangesColumn(Mat,const PetscInt**);
5917b80b807SBarry Smith 
592be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
593be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]);
5944aa3045dSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,MatReuse,Mat *);
595f6d58c54SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSeqNonzeroStructure(Mat,Mat*);
596f6d58c54SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroySeqNonzeroStructure(Mat*);
5975494a064SHong Zhang 
598be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
599be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
600be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
601be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat);
602be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat);
603be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*);
604be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
605be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*);
6061d79065fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscInt**,MatScalar**,Mat*);
60743eb5e2fSMatthew Knepley #if defined (PETSC_USE_CTABLE)
608cd116e26SSatish Balay #include "petscctable.h"
60943eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *);
61043eb5e2fSMatthew Knepley #else
61143eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *);
61243eb5e2fSMatthew Knepley #endif
6138c7482ecSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);
6148efafbd8SBarry Smith 
615be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
6167b80b807SBarry Smith 
617be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
618be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
619be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat);
62022440eb1SKris Buschelman 
621be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
622be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
623be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat);
62422440eb1SKris Buschelman 
625be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*);
626be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*);
627be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat);
628bc011b1eSHong Zhang 
629f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure);
63004aac2b0SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat,MatStructure);
6311c741599SHong Zhang 
632f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar);
633f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar);
6347b80b807SBarry Smith 
635be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping);
636be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping);
637f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar);
638f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar);
639be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
640be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
641052efed2SBarry Smith 
642be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt);
643be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
64490f02eecSBarry Smith 
645be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec);
6460c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec);
647ba966639SSatish Balay PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
648be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec);
649be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*);
65069db28dcSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*);
651d6037b41SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetMultiProcBlock(Mat,MPI_Comm,Mat*);
652bd481603SBarry Smith 
653bd481603SBarry Smith /*MC
6541620fd73SBarry Smith    MatSetValue - Set a single entry into a matrix.
6551620fd73SBarry Smith 
6561620fd73SBarry Smith    Not collective
6571620fd73SBarry Smith 
6581620fd73SBarry Smith    Input Parameters:
6591620fd73SBarry Smith +  m - the matrix
6601620fd73SBarry Smith .  row - the row location of the entry
6611620fd73SBarry Smith .  col - the column location of the entry
6621620fd73SBarry Smith .  value - the value to insert
6631620fd73SBarry Smith -  mode - either INSERT_VALUES or ADD_VALUES
6641620fd73SBarry Smith 
6651620fd73SBarry Smith    Notes:
6661620fd73SBarry Smith    For efficiency one should use MatSetValues() and set several or many
6671620fd73SBarry Smith    values simultaneously if possible.
6681620fd73SBarry Smith 
6691620fd73SBarry Smith    Level: beginner
6701620fd73SBarry Smith 
6711620fd73SBarry Smith .seealso: MatSetValues(), MatSetValueLocal()
6721620fd73SBarry Smith M*/
6731620fd73SBarry 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);}
6741620fd73SBarry Smith 
6751620fd73SBarry Smith PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);}
6761620fd73SBarry Smith 
6771620fd73SBarry 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);}
6781620fd73SBarry Smith 
6791620fd73SBarry Smith /*MC
6800d2a7ff2SSatish Balay    MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
681bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
682bd481603SBarry Smith 
683bd481603SBarry Smith    Synopsis:
684c1ac3661SBarry Smith    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
685bd481603SBarry Smith 
686bd481603SBarry Smith    Collective on MPI_Comm
687bd481603SBarry Smith 
688bd481603SBarry Smith    Input Parameters:
689bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
690859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
691859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
692bd481603SBarry Smith 
693bd481603SBarry Smith    Output Parameters:
694bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
695bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
696bd481603SBarry Smith 
697bd481603SBarry Smith 
698bd481603SBarry Smith    Level: intermediate
699bd481603SBarry Smith 
700bd481603SBarry Smith    Notes:
7010598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
702bd481603SBarry Smith 
7031d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
704bd481603SBarry Smith 
705bd481603SBarry Smith    Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
706bd481603SBarry Smith 
7071620fd73SBarry Smith    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
7081620fd73SBarry Smith 
709bd481603SBarry Smith   Concepts: preallocation^Matrix
710bd481603SBarry Smith 
711bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
712bd481603SBarry Smith           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
713bd481603SBarry Smith M*/
714c4f061fbSSatish Balay #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
7157c922b88SBarry Smith { \
716a89bc211SBarry Smith   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
717a89bc211SBarry Smith   _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
718a89bc211SBarry Smith   _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
719a89bc211SBarry Smith   _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
720c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
721a89bc211SBarry Smith   _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
7227c922b88SBarry Smith 
723bd481603SBarry Smith /*MC
7240d2a7ff2SSatish Balay    MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per
725bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
726bd481603SBarry Smith 
727bd481603SBarry Smith    Synopsis:
728c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
729bd481603SBarry Smith 
730bd481603SBarry Smith    Collective on MPI_Comm
731bd481603SBarry Smith 
732bd481603SBarry Smith    Input Parameters:
733bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
734859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
735859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
736bd481603SBarry Smith 
737bd481603SBarry Smith    Output Parameters:
738bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
739bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
740bd481603SBarry Smith 
741bd481603SBarry Smith 
742bd481603SBarry Smith    Level: intermediate
743bd481603SBarry Smith 
744bd481603SBarry Smith    Notes:
7450598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
746bd481603SBarry Smith 
7471d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
748bd481603SBarry Smith 
7491620fd73SBarry Smith    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
7501620fd73SBarry Smith 
751bd481603SBarry Smith   Concepts: preallocation^Matrix
752bd481603SBarry Smith 
753bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
754bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
755bd481603SBarry Smith M*/
756222b16d4SBarry Smith #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \
757222b16d4SBarry Smith { \
758a89bc211SBarry Smith   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__end; \
759a89bc211SBarry Smith   _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
760a89bc211SBarry Smith   _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
761a89bc211SBarry Smith   _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
762c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\
763a89bc211SBarry Smith   _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
764222b16d4SBarry Smith 
765bd481603SBarry Smith /*MC
766bd481603SBarry Smith    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
767bd481603SBarry Smith        inserted using a local number of the rows and columns
768bd481603SBarry Smith 
769bd481603SBarry Smith    Synopsis:
770c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
771bd481603SBarry Smith 
772bd481603SBarry Smith    Not Collective
773bd481603SBarry Smith 
774bd481603SBarry Smith    Input Parameters:
775bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
776bd481603SBarry Smith .  nrows - the number of rows indicated
7771d73ed98SBarry Smith .  rows - the indices of the rows
778bd481603SBarry Smith .  ncols - the number of columns in the matrix
779bd481603SBarry Smith .  cols - the columns indicated
780bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
781bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
782bd481603SBarry Smith 
783bd481603SBarry Smith 
784bd481603SBarry Smith    Level: intermediate
785bd481603SBarry Smith 
786bd481603SBarry Smith    Notes:
7870598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
788bd481603SBarry Smith 
7891d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
790bd481603SBarry Smith 
791bd481603SBarry Smith   Concepts: preallocation^Matrix
792bd481603SBarry Smith 
793bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
794bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
795bd481603SBarry Smith M*/
796c4f061fbSSatish Balay #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
797c4f061fbSSatish Balay {\
798c1ac3661SBarry Smith   PetscInt __l;\
799ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
800ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
801c4f061fbSSatish Balay   for (__l=0;__l<nrows;__l++) {\
802ef66eb69SBarry Smith     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
803c4f061fbSSatish Balay   }\
804c4f061fbSSatish Balay }
805c4f061fbSSatish Balay 
806bd481603SBarry Smith /*MC
807bd481603SBarry Smith    MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
808bd481603SBarry Smith        inserted using a local number of the rows and columns
809bd481603SBarry Smith 
810bd481603SBarry Smith    Synopsis:
811c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
812bd481603SBarry Smith 
813bd481603SBarry Smith    Not Collective
814bd481603SBarry Smith 
815bd481603SBarry Smith    Input Parameters:
816bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
817bd481603SBarry Smith .  nrows - the number of rows indicated
8181d73ed98SBarry Smith .  rows - the indices of the rows
819bd481603SBarry Smith .  ncols - the number of columns in the matrix
820bd481603SBarry Smith .  cols - the columns indicated
821bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
822bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
823bd481603SBarry Smith 
824bd481603SBarry Smith 
825bd481603SBarry Smith    Level: intermediate
826bd481603SBarry Smith 
827bd481603SBarry Smith    Notes:
8280598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
829bd481603SBarry Smith 
830bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
831bd481603SBarry Smith 
832bd481603SBarry Smith   Concepts: preallocation^Matrix
833bd481603SBarry Smith 
834bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
835bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
836bd481603SBarry Smith M*/
837d3d32019SBarry Smith #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
838d3d32019SBarry Smith {\
839c1ac3661SBarry Smith   PetscInt __l;\
840d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
841d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
842d3d32019SBarry Smith   for (__l=0;__l<nrows;__l++) {\
843d3d32019SBarry Smith     _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
844d3d32019SBarry Smith   }\
845d3d32019SBarry Smith }
846d3d32019SBarry Smith 
847bd481603SBarry Smith /*MC
848bd481603SBarry Smith    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
849bd481603SBarry Smith        inserted using a local number of the rows and columns
850bd481603SBarry Smith 
851bd481603SBarry Smith    Synopsis:
852c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
853bd481603SBarry Smith 
854bd481603SBarry Smith    Not Collective
855bd481603SBarry Smith 
856bd481603SBarry Smith    Input Parameters:
85764075487SBarry Smith +  row - the row
858bd481603SBarry Smith .  ncols - the number of columns in the matrix
859a50f8bf6SHong Zhang -  cols - the columns indicated
860a50f8bf6SHong Zhang 
861a50f8bf6SHong Zhang    Output Parameters:
862a50f8bf6SHong Zhang +  dnz - the array that will be passed to the matrix preallocation routines
863bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
864bd481603SBarry Smith 
865bd481603SBarry Smith 
866bd481603SBarry Smith    Level: intermediate
867bd481603SBarry Smith 
868bd481603SBarry Smith    Notes:
8690598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
870bd481603SBarry Smith 
871bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
872bd481603SBarry Smith 
8731620fd73SBarry Smith    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
8741620fd73SBarry Smith 
875bd481603SBarry Smith   Concepts: preallocation^Matrix
876bd481603SBarry Smith 
877bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
878bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
879bd481603SBarry Smith M*/
880c4f061fbSSatish Balay #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
881c1ac3661SBarry Smith { PetscInt __i; \
882e32f2f54SBarry Smith   if (row < __rstart) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D less than first local row %D",row,__rstart);\
883e32f2f54SBarry Smith   if (row >= __rstart+__nrows) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D greater than last local row %D",row,__rstart+__nrows-1);\
8847c922b88SBarry Smith   for (__i=0; __i<nc; __i++) {\
88564075487SBarry Smith     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
8867cc688d7SBarry Smith     else dnz[row - __rstart]++;\
8877c922b88SBarry Smith   }\
8887c922b88SBarry Smith }
8897c922b88SBarry Smith 
890bd481603SBarry Smith /*MC
891bd481603SBarry Smith    MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
892bd481603SBarry Smith        inserted using a local number of the rows and columns
893bd481603SBarry Smith 
894bd481603SBarry Smith    Synopsis:
895c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
896bd481603SBarry Smith 
897bd481603SBarry Smith    Not Collective
898bd481603SBarry Smith 
899bd481603SBarry Smith    Input Parameters:
900bd481603SBarry Smith +  nrows - the number of rows indicated
9011d73ed98SBarry Smith .  rows - the indices of the rows
902bd481603SBarry Smith .  ncols - the number of columns in the matrix
903bd481603SBarry Smith .  cols - the columns indicated
904bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
905bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
906bd481603SBarry Smith 
907bd481603SBarry Smith 
908bd481603SBarry Smith    Level: intermediate
909bd481603SBarry Smith 
910bd481603SBarry Smith    Notes:
9110598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
912bd481603SBarry Smith 
913bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
914bd481603SBarry Smith 
9151620fd73SBarry Smith    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
9161620fd73SBarry Smith 
917bd481603SBarry Smith   Concepts: preallocation^Matrix
918bd481603SBarry Smith 
919bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
920bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
921bd481603SBarry Smith M*/
922d3d32019SBarry Smith #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
923c1ac3661SBarry Smith { PetscInt __i; \
924d3d32019SBarry Smith   for (__i=0; __i<nc; __i++) {\
925d3d32019SBarry Smith     if (cols[__i] >= __end) onz[row - __rstart]++; \
926d3d32019SBarry Smith     else if (cols[__i] >= row) dnz[row - __rstart]++;\
927d3d32019SBarry Smith   }\
928d3d32019SBarry Smith }
929d3d32019SBarry Smith 
930bd481603SBarry Smith /*MC
93116371a99SBarry Smith    MatPreallocateLocation -  An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists
93216371a99SBarry Smith 
93316371a99SBarry Smith    Synopsis:
93416371a99SBarry Smith    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)
93516371a99SBarry Smith 
93616371a99SBarry Smith    Not Collective
93716371a99SBarry Smith 
93816371a99SBarry Smith    Input Parameters:
93916371a99SBarry Smith .  A - matrix
94016371a99SBarry Smith .  row - row where values exist (must be local to this process)
94116371a99SBarry Smith .  ncols - number of columns
94216371a99SBarry Smith .  cols - columns with nonzeros
94316371a99SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
94416371a99SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
94516371a99SBarry Smith 
94616371a99SBarry Smith 
94716371a99SBarry Smith    Level: intermediate
94816371a99SBarry Smith 
94916371a99SBarry Smith    Notes:
9500598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
95116371a99SBarry Smith 
95216371a99SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
95316371a99SBarry Smith 
95416371a99SBarry Smith    This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.
95516371a99SBarry Smith 
95616371a99SBarry Smith   Concepts: preallocation^Matrix
95716371a99SBarry Smith 
95816371a99SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
95916371a99SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
96016371a99SBarry Smith M*/
96116371a99SBarry 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);}
96216371a99SBarry Smith 
96316371a99SBarry Smith 
96416371a99SBarry Smith /*MC
9650d2a7ff2SSatish Balay    MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
966bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
967bd481603SBarry Smith 
968bd481603SBarry Smith    Synopsis:
969c1ac3661SBarry Smith    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
970bd481603SBarry Smith 
971bd481603SBarry Smith    Collective on MPI_Comm
972bd481603SBarry Smith 
973bd481603SBarry Smith    Input Parameters:
97416371a99SBarry Smith +  dnz - the array that was be passed to the matrix preallocation routines
975bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
976bd481603SBarry Smith 
977bd481603SBarry Smith 
978bd481603SBarry Smith    Level: intermediate
979bd481603SBarry Smith 
980bd481603SBarry Smith    Notes:
9810598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
982bd481603SBarry Smith 
983bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
984bd481603SBarry Smith 
9851620fd73SBarry Smith    This is a MACRO not a function because it closes the { started in MatPreallocateInitialize().
9861620fd73SBarry Smith 
987bd481603SBarry Smith   Concepts: preallocation^Matrix
988bd481603SBarry Smith 
989bd481603SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
990bd481603SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
991bd481603SBarry Smith M*/
992a89bc211SBarry Smith #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}
9937c922b88SBarry Smith 
994bd481603SBarry Smith 
995bd481603SBarry Smith 
9967b80b807SBarry Smith /* Routines unique to particular data structures */
997be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **);
998ba966639SSatish Balay PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t)
999698d4c6aSKris Buschelman 
1000be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*);
1001be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
1002698d4c6aSKris Buschelman 
1003be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
1004be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
1005be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1006c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1007c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
10087b80b807SBarry Smith 
1009a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4
1010a96a251dSBarry Smith 
1011be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1012ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
1013be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1014ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
1015be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
1016ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz))
1017273d9f13SBarry Smith 
1018be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1019ba966639SSatish Balay PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz))
1020be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1021be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
102253803f26SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
1023725b52f3SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1024be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
1025be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1026be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
1027be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
1028284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
1029be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
1030be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
1031be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void));
1032273d9f13SBarry Smith 
1033be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt);
1034ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDenseGetLocalMatrix(Mat,Mat*);
10351b807ce4Svictorle 
1036be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat);
1037be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat);
10382e8a6d31SBarry Smith 
1039be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*);
10403a7fca6bSBarry Smith 
10417b80b807SBarry Smith /*
10427b80b807SBarry Smith   These routines are not usually accessed directly, rather solving is
104394b7f48cSBarry Smith   done through the KSP and PC interfaces.
10447b80b807SBarry Smith */
10457b80b807SBarry Smith 
1046d9274352SBarry Smith /*E
1047d9274352SBarry Smith     MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
1048d9274352SBarry Smith        with an optional dynamic library name, for example
1049d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
1050d9274352SBarry Smith 
1051d9274352SBarry Smith    Level: beginner
1052d9274352SBarry Smith 
1053e5a9bf91SBarry Smith    Cannot use const because the PC objects manipulate the string
1054e5a9bf91SBarry Smith 
1055d9274352SBarry Smith .seealso: MatGetOrdering()
1056d9274352SBarry Smith E*/
10573eaad2caSSatish Balay #define MatOrderingType char*
10582692d6eeSBarry Smith #define MATORDERINGNATURAL     "natural"
10592692d6eeSBarry Smith #define MATORDERINGND          "nd"
10602692d6eeSBarry Smith #define MATORDERING1WD         "1wd"
10612692d6eeSBarry Smith #define MATORDERINGRCM         "rcm"
10622692d6eeSBarry Smith #define MATORDERINGQMD         "qmd"
10632692d6eeSBarry Smith #define MATORDERINGROWLENGTH   "rowlength"
10642692d6eeSBarry Smith #define MATORDERINGDSC_ND      "dsc_nd"         /* these three are only for DSCPACK, see its documentation for details */
10652692d6eeSBarry Smith #define MATORDERINGDSC_MMD     "dsc_mmd"
10662692d6eeSBarry Smith #define MATORDERINGDSC_MDF     "dsc_mdf"
1067312e372aSBarry Smith #define MATORDERINGAMD         "amd"            /* only works if UMFPACK is installed with PETSc */
1068b12f92e5SBarry Smith 
1069f2416520SSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
1070be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list);
1071f2416520SSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));
107230de9b25SBarry Smith 
107330de9b25SBarry Smith /*MC
10741890ba74SBarry Smith    MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the matrix package.
107530de9b25SBarry Smith 
107630de9b25SBarry Smith    Synopsis:
10771890ba74SBarry Smith    PetscErrorCode MatOrderingRegisterDynamic(const char *name_ordering,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
107830de9b25SBarry Smith 
107930de9b25SBarry Smith    Not Collective
108030de9b25SBarry Smith 
108130de9b25SBarry Smith    Input Parameters:
10822692d6eeSBarry Smith +  sname - name of ordering (for example MATORDERINGND)
108330de9b25SBarry Smith .  path - location of library where creation routine is
108430de9b25SBarry Smith .  name - name of function that creates the ordering type,a string
108530de9b25SBarry Smith -  function - function pointer that creates the ordering
108630de9b25SBarry Smith 
108730de9b25SBarry Smith    Level: developer
108830de9b25SBarry Smith 
108930de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
109030de9b25SBarry Smith    is ignored.
109130de9b25SBarry Smith 
109230de9b25SBarry Smith    Sample usage:
109330de9b25SBarry Smith .vb
109430de9b25SBarry Smith    MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
109530de9b25SBarry Smith                "MyOrder",MyOrder);
109630de9b25SBarry Smith .ve
109730de9b25SBarry Smith 
109830de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
109930de9b25SBarry Smith $     MatOrderingSetType(part,"my_order)
110030de9b25SBarry Smith    or at runtime via the option
11012401956bSBarry Smith $     -pc_factor_mat_ordering_type my_order
110230de9b25SBarry Smith 
1103ab901514SBarry Smith    ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
110430de9b25SBarry Smith 
110530de9b25SBarry Smith .keywords: matrix, ordering, register
110630de9b25SBarry Smith 
110730de9b25SBarry Smith .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
110830de9b25SBarry Smith M*/
1109aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1110f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
1111b12f92e5SBarry Smith #else
1112f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
1113b12f92e5SBarry Smith #endif
111430de9b25SBarry Smith 
1115be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void);
1116be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]);
1117ace3abfcSBarry Smith extern PetscBool  MatOrderingRegisterAllCalled;
1118b0a32e0cSBarry Smith extern PetscFList MatOrderingList;
1119d4fbbf0eSBarry Smith 
1120be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1121a2ce50c7SBarry Smith 
1122d91e6319SBarry Smith /*S
1123d90ac83dSHong Zhang     MatFactorShiftType - Numeric Shift.
1124d90ac83dSHong Zhang 
1125d90ac83dSHong Zhang    Level: beginner
1126d90ac83dSHong Zhang 
1127d90ac83dSHong Zhang S*/
1128d90ac83dSHong Zhang typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
1129d90ac83dSHong Zhang extern const char *MatFactorShiftTypes[];
1130d90ac83dSHong Zhang 
1131d90ac83dSHong Zhang /*S
11322401956bSBarry Smith    MatFactorInfo - Data passed into the matrix factorization routines
1133b00f7748SHong Zhang 
113461cad860SBarry Smith    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
113561cad860SBarry Smith $     MatFactorInfo  info(MAT_FACTORINFO_SIZE)
1136b00f7748SHong Zhang 
113715e8a5b3SHong Zhang    Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
1138b00f7748SHong Zhang 
113961cad860SBarry Smith       You can use MatFactorInfoInitialize() to set default values.
114061cad860SBarry Smith 
1141b00f7748SHong Zhang    Level: developer
1142b00f7748SHong Zhang 
1143d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1144d7d82daaSBarry Smith           MatFactorInfoInitialize()
1145b00f7748SHong Zhang 
1146b00f7748SHong Zhang S*/
1147b00f7748SHong Zhang typedef struct {
114815e8a5b3SHong Zhang   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
114985317021SBarry Smith   PetscReal     usedt;
115015e8a5b3SHong Zhang   PetscReal     dt;             /* drop tolerance */
1151b00f7748SHong Zhang   PetscReal     dtcol;          /* tolerance for pivoting */
115215e8a5b3SHong Zhang   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
115367e28bfeSBarry Smith   PetscReal     fill;           /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1154348344bbSBarry Smith   PetscReal     levels;         /* ICC/ILU(levels) */
1155bcd9e38bSBarry Smith   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1156bcd9e38bSBarry Smith                                    factorization may be faster if do not pivot */
115715e8a5b3SHong Zhang   PetscReal     zeropivot;      /* pivot is called zero if less than this */
1158f4db908eSBarry Smith   PetscReal     shifttype;      /* type of shift added to matrix factor to prevent zero pivots */
1159f4db908eSBarry Smith   PetscReal     shiftamount;     /* how large the shift is */
116015e8a5b3SHong Zhang } MatFactorInfo;
1161ffa6d0a5SLois Curfman McInnes 
1162be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*);
11630481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
11640481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
11650481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
11660481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
11670481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
11680481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
11690481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
11700481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
11710481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,const MatFactorInfo*);
11720481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1173be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1174be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec);
1175be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec);
1176be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec);
1177be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec);
1178be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec);
1179be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1180be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs);
11818ed539a5SBarry Smith 
1182be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat);
1183bb5a7306SBarry Smith 
1184d91e6319SBarry Smith /*E
1185d91e6319SBarry Smith     MatSORType - What type of (S)SOR to perform
1186bb1eb677SSatish Balay 
1187d91e6319SBarry Smith     Level: beginner
1188d91e6319SBarry Smith 
1189d9274352SBarry Smith    May be bitwise ORd together
1190d9274352SBarry Smith 
1191d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1192d91e6319SBarry Smith 
11934e7234bfSBarry Smith    MatSORType may be bitwise ORd together, so do not change the numbers
11944e7234bfSBarry Smith 
119541f059aeSBarry Smith .seealso: MatSOR()
1196d91e6319SBarry Smith E*/
1197ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1198ee50ffe9SBarry Smith               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1199ee50ffe9SBarry Smith               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
120084cb2905SBarry Smith               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
120141f059aeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
12028ed539a5SBarry Smith 
1203d4fbbf0eSBarry Smith /*
1204639f9d9dSBarry Smith     These routines are for efficiently computing Jacobians via finite differences.
1205639f9d9dSBarry Smith */
1206b12f92e5SBarry Smith 
1207d9274352SBarry Smith /*E
1208d9274352SBarry Smith     MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1209d9274352SBarry Smith        with an optional dynamic library name, for example
1210d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1211d9274352SBarry Smith 
1212d9274352SBarry Smith    Level: beginner
1213d9274352SBarry Smith 
1214d9274352SBarry Smith .seealso: MatGetColoring()
1215d9274352SBarry Smith E*/
1216a313700dSBarry Smith #define MatColoringType char*
12172692d6eeSBarry Smith #define MATCOLORINGNATURAL "natural"
12182692d6eeSBarry Smith #define MATCOLORINGSL      "sl"
12192692d6eeSBarry Smith #define MATCOLORINGLF      "lf"
12202692d6eeSBarry Smith #define MATCOLORINGID      "id"
1221b12f92e5SBarry Smith 
1222ab970d9bSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,const MatColoringType,ISColoring*);
12232e90c967SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *));
122430de9b25SBarry Smith 
122530de9b25SBarry Smith /*MC
122630de9b25SBarry Smith    MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
122730de9b25SBarry Smith                                matrix package.
122830de9b25SBarry Smith 
122930de9b25SBarry Smith    Synopsis:
12301890ba74SBarry Smith    PetscErrorCode MatColoringRegisterDynamic(const char *name_coloring,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatColoring))
123130de9b25SBarry Smith 
123230de9b25SBarry Smith    Not Collective
123330de9b25SBarry Smith 
123430de9b25SBarry Smith    Input Parameters:
12352692d6eeSBarry Smith +  sname - name of Coloring (for example MATCOLORINGSL)
123630de9b25SBarry Smith .  path - location of library where creation routine is
123730de9b25SBarry Smith .  name - name of function that creates the Coloring type, a string
123830de9b25SBarry Smith -  function - function pointer that creates the coloring
123930de9b25SBarry Smith 
124030de9b25SBarry Smith    Level: developer
124130de9b25SBarry Smith 
124230de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
124330de9b25SBarry Smith    is ignored.
124430de9b25SBarry Smith 
124530de9b25SBarry Smith    Sample usage:
124630de9b25SBarry Smith .vb
124730de9b25SBarry Smith    MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
124830de9b25SBarry Smith                "MyColor",MyColor);
124930de9b25SBarry Smith .ve
125030de9b25SBarry Smith 
125130de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
125230de9b25SBarry Smith $     MatColoringSetType(part,"my_color")
125330de9b25SBarry Smith    or at runtime via the option
125430de9b25SBarry Smith $     -mat_coloring_type my_color
125530de9b25SBarry Smith 
1256ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
125730de9b25SBarry Smith 
125830de9b25SBarry Smith .keywords: matrix, Coloring, register
125930de9b25SBarry Smith 
126030de9b25SBarry Smith .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
126130de9b25SBarry Smith M*/
1262aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1263f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1264b12f92e5SBarry Smith #else
1265f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1266b12f92e5SBarry Smith #endif
126730de9b25SBarry Smith 
1268ace3abfcSBarry Smith extern PetscBool  MatColoringRegisterAllCalled;
1269f1144a30SSatish Balay 
1270be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]);
1271be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void);
1272be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1273639f9d9dSBarry Smith 
1274d9274352SBarry Smith /*S
1275d9274352SBarry Smith      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1276d9274352SBarry Smith         and coloring
1277639f9d9dSBarry Smith 
1278d9274352SBarry Smith    Level: beginner
1279d9274352SBarry Smith 
1280d9274352SBarry Smith   Concepts: coloring, sparse Jacobian, finite differences
1281d9274352SBarry Smith 
1282d9274352SBarry Smith .seealso:  MatFDColoringCreate()
1283d9274352SBarry Smith S*/
1284e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring;
1285639f9d9dSBarry Smith 
1286be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1287be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring);
1288be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer);
1289be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
12904a9d489dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1291be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1292be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring);
1293be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1294be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *);
1295be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec);
1296be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1297639f9d9dSBarry Smith /*
12980752156aSBarry Smith     These routines are for partitioning matrices: currently used only
12993eda8832SBarry Smith   for adjacency matrix, MatCreateMPIAdj().
13000752156aSBarry Smith */
1301ca161407SBarry Smith 
1302d9274352SBarry Smith /*S
1303d9274352SBarry Smith      MatPartitioning - Object for managing the partitioning of a matrix or graph
1304d9274352SBarry Smith 
1305d9274352SBarry Smith    Level: beginner
1306d9274352SBarry Smith 
1307d9274352SBarry Smith   Concepts: partitioning
1308d9274352SBarry Smith 
1309743a1026Svictorle .seealso:  MatPartitioningCreate(), MatPartitioningType
1310d9274352SBarry Smith S*/
131191e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning;
1312d9274352SBarry Smith 
1313d9274352SBarry Smith /*E
13145bc6e7ccSvictorle     MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1315d9274352SBarry Smith        with an optional dynamic library name, for example
1316d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1317d9274352SBarry Smith 
1318d9274352SBarry Smith    Level: beginner
1319d9274352SBarry Smith 
1320b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning
1321d9274352SBarry Smith E*/
1322a313700dSBarry Smith #define MatPartitioningType char*
13232692d6eeSBarry Smith #define MATPARTITIONINGCURRENT  "current"
13242692d6eeSBarry Smith #define MATPARTITIONINGSQUARE   "square"
13252692d6eeSBarry Smith #define MATPARTITIONINGPARMETIS "parmetis"
13262692d6eeSBarry Smith #define MATPARTITIONINGCHACO    "chaco"
13272692d6eeSBarry Smith #define MATPARTITIONINGJOSTLE   "jostle"
13282692d6eeSBarry Smith #define MATPARTITIONINGPARTY    "party"
13292692d6eeSBarry Smith #define MATPARTITIONINGSCOTCH   "scotch"
133071306c60Sjroman 
1331ca161407SBarry Smith 
1332be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1333a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,const MatPartitioningType);
1334be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt);
1335be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat);
1336be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1337be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1338be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*);
1339be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning);
13402aabb6bbSBarry Smith 
1341be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
134230de9b25SBarry Smith 
134330de9b25SBarry Smith /*MC
134430de9b25SBarry Smith    MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
134530de9b25SBarry Smith    matrix package.
134630de9b25SBarry Smith 
134730de9b25SBarry Smith    Synopsis:
13481890ba74SBarry Smith    PetscErrorCode MatPartitioningRegisterDynamic(const char *name_partitioning,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
134930de9b25SBarry Smith 
135030de9b25SBarry Smith    Not Collective
135130de9b25SBarry Smith 
135230de9b25SBarry Smith    Input Parameters:
13532692d6eeSBarry Smith +  sname - name of partitioning (for example MATPARTITIONINGCURRENT) or parmetis
135430de9b25SBarry Smith .  path - location of library where creation routine is
135530de9b25SBarry Smith .  name - name of function that creates the partitioning type, a string
135630de9b25SBarry Smith -  function - function pointer that creates the partitioning type
135730de9b25SBarry Smith 
135830de9b25SBarry Smith    Level: developer
135930de9b25SBarry Smith 
136030de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
136130de9b25SBarry Smith    is ignored.
136230de9b25SBarry Smith 
136330de9b25SBarry Smith    Sample usage:
136430de9b25SBarry Smith .vb
136530de9b25SBarry Smith    MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
136630de9b25SBarry Smith                "MyPartCreate",MyPartCreate);
136730de9b25SBarry Smith .ve
136830de9b25SBarry Smith 
136930de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
137030de9b25SBarry Smith $     MatPartitioningSetType(part,"my_part")
137130de9b25SBarry Smith    or at runtime via the option
137230de9b25SBarry Smith $     -mat_partitioning_type my_part
137330de9b25SBarry Smith 
1374ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
137530de9b25SBarry Smith 
137630de9b25SBarry Smith .keywords: matrix, partitioning, register
137730de9b25SBarry Smith 
137830de9b25SBarry Smith .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
137930de9b25SBarry Smith M*/
1380aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1381f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
13822aabb6bbSBarry Smith #else
1383f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
13842aabb6bbSBarry Smith #endif
13852aabb6bbSBarry Smith 
1386ace3abfcSBarry Smith extern PetscBool  MatPartitioningRegisterAllCalled;
1387f1144a30SSatish Balay 
1388be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]);
1389be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void);
13902bad1931SBarry Smith 
1391be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer);
1392be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning);
1393a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,const MatPartitioningType*);
1394ca161407SBarry Smith 
1395be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
13960e8af3caSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);
13970752156aSBarry Smith 
1398be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal);
1399be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning);
140071306c60Sjroman 
1401954b3ec6SBarry Smith typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType;
1402be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
140371306c60Sjroman typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType;
1404be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1405be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
140671306c60Sjroman typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType;
1407be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1408be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1409be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
141071306c60Sjroman 
141171306c60Sjroman #define MP_PARTY_OPT "opt"
141271306c60Sjroman #define MP_PARTY_LIN "lin"
141371306c60Sjroman #define MP_PARTY_SCA "sca"
141471306c60Sjroman #define MP_PARTY_RAN "ran"
141571306c60Sjroman #define MP_PARTY_GBF "gbf"
141671306c60Sjroman #define MP_PARTY_GCF "gcf"
141771306c60Sjroman #define MP_PARTY_BUB "bub"
141871306c60Sjroman #define MP_PARTY_DEF "def"
1419be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*);
142071306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs"
142171306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl"
142271306c60Sjroman #define MP_PARTY_NONE "no"
1423be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*);
1424be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1425ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscBool );
1426ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool );
142771306c60Sjroman 
142871306c60Sjroman typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType;
1429be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*);
1430be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning);
1431be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType);
1432be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal);
1433be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*);
143471306c60Sjroman typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType;
1435be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType);
1436be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning);
1437be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*);
143871306c60Sjroman 
1439591294e4SBarry Smith EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
144014196391SBarry Smith EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);
1441591294e4SBarry Smith 
14420752156aSBarry Smith /*
14430a835dfdSSatish Balay     If you add entries here you must also add them to finclude/petscmat.h
1444d4fbbf0eSBarry Smith */
14451c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0,
14461c1c02c0SLois Curfman McInnes                MATOP_GET_ROW=1,
14471c1c02c0SLois Curfman McInnes                MATOP_RESTORE_ROW=2,
14481c1c02c0SLois Curfman McInnes                MATOP_MULT=3,
14491c1c02c0SLois Curfman McInnes                MATOP_MULT_ADD=4,
14507c922b88SBarry Smith                MATOP_MULT_TRANSPOSE=5,
14517c922b88SBarry Smith                MATOP_MULT_TRANSPOSE_ADD=6,
14521c1c02c0SLois Curfman McInnes                MATOP_SOLVE=7,
14531c1c02c0SLois Curfman McInnes                MATOP_SOLVE_ADD=8,
14547c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE=9,
14557c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE_ADD=10,
14561c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR=11,
14571c1c02c0SLois Curfman McInnes                MATOP_CHOLESKYFACTOR=12,
1458a714c06dSBarry Smith                MATOP_SOR=13,
14591c1c02c0SLois Curfman McInnes                MATOP_TRANSPOSE=14,
14601c1c02c0SLois Curfman McInnes                MATOP_GETINFO=15,
14611c1c02c0SLois Curfman McInnes                MATOP_EQUAL=16,
14621c1c02c0SLois Curfman McInnes                MATOP_GET_DIAGONAL=17,
14631c1c02c0SLois Curfman McInnes                MATOP_DIAGONAL_SCALE=18,
14641c1c02c0SLois Curfman McInnes                MATOP_NORM=19,
14651c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_BEGIN=20,
14661c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_END=21,
1467d519adbfSMatthew Knepley                MATOP_SET_OPTION=22,
1468d519adbfSMatthew Knepley                MATOP_ZERO_ENTRIES=23,
1469d519adbfSMatthew Knepley                MATOP_ZERO_ROWS=24,
1470d519adbfSMatthew Knepley                MATOP_LUFACTOR_SYMBOLIC=25,
1471d519adbfSMatthew Knepley                MATOP_LUFACTOR_NUMERIC=26,
1472d519adbfSMatthew Knepley                MATOP_CHOLESKY_FACTOR_SYMBOLIC=27,
1473d519adbfSMatthew Knepley                MATOP_CHOLESKY_FACTOR_NUMERIC=28,
1474d519adbfSMatthew Knepley                MATOP_SETUP_PREALLOCATION=29,
1475d519adbfSMatthew Knepley                MATOP_ILUFACTOR_SYMBOLIC=30,
1476d519adbfSMatthew Knepley                MATOP_ICCFACTOR_SYMBOLIC=31,
1477d519adbfSMatthew Knepley                MATOP_GET_ARRAY=32,
1478d519adbfSMatthew Knepley                MATOP_RESTORE_ARRAY=33,
1479d519adbfSMatthew Knepley                MATOP_DUPLICATE=34,
1480d519adbfSMatthew Knepley                MATOP_FORWARD_SOLVE=35,
1481d519adbfSMatthew Knepley                MATOP_BACKWARD_SOLVE=36,
1482d519adbfSMatthew Knepley                MATOP_ILUFACTOR=37,
1483d519adbfSMatthew Knepley                MATOP_ICCFACTOR=38,
1484d519adbfSMatthew Knepley                MATOP_AXPY=39,
1485d519adbfSMatthew Knepley                MATOP_GET_SUBMATRICES=40,
1486d519adbfSMatthew Knepley                MATOP_INCREASE_OVERLAP=41,
1487d519adbfSMatthew Knepley                MATOP_GET_VALUES=42,
1488d519adbfSMatthew Knepley                MATOP_COPY=43,
1489d519adbfSMatthew Knepley                MATOP_GET_ROW_MAX=44,
1490d519adbfSMatthew Knepley                MATOP_SCALE=45,
1491d519adbfSMatthew Knepley                MATOP_SHIFT=46,
149235153367SBarry Smith                MATOP_DIAGONAL_SET=47,
1493d519adbfSMatthew Knepley                MATOP_ILUDT_FACTOR=48,
1494d519adbfSMatthew Knepley                MATOP_SET_BLOCK_SIZE=49,
1495d519adbfSMatthew Knepley                MATOP_GET_ROW_IJ=50,
1496d519adbfSMatthew Knepley                MATOP_RESTORE_ROW_IJ=51,
1497d519adbfSMatthew Knepley                MATOP_GET_COLUMN_IJ=52,
1498d519adbfSMatthew Knepley                MATOP_RESTORE_COLUMN_IJ=53,
1499d519adbfSMatthew Knepley                MATOP_FDCOLORING_CREATE=54,
1500d519adbfSMatthew Knepley                MATOP_COLORING_PATCH=55,
1501d519adbfSMatthew Knepley                MATOP_SET_UNFACTORED=56,
1502d519adbfSMatthew Knepley                MATOP_PERMUTE=57,
1503d519adbfSMatthew Knepley                MATOP_SET_VALUES_BLOCKED=58,
1504d519adbfSMatthew Knepley                MATOP_GET_SUBMATRIX=59,
1505d519adbfSMatthew Knepley                MATOP_DESTROY=60,
1506d519adbfSMatthew Knepley                MATOP_VIEW=61,
1507d519adbfSMatthew Knepley                MATOP_CONVERT_FROM=62,
1508d519adbfSMatthew Knepley                MATOP_USE_SCALED_FORM=63,
1509d519adbfSMatthew Knepley                MATOP_SCALE_SYSTEM=64,
1510d519adbfSMatthew Knepley                MATOP_UNSCALE_SYSTEM=65,
1511d519adbfSMatthew Knepley                MATOP_SET_LOCAL_TO_GLOBAL_MAP=66,
1512d519adbfSMatthew Knepley                MATOP_SET_VALUES_LOCAL=67,
1513d519adbfSMatthew Knepley                MATOP_ZERO_ROWS_LOCAL=68,
1514d519adbfSMatthew Knepley                MATOP_GET_ROW_MAX_ABS=69,
1515d519adbfSMatthew Knepley                MATOP_GET_ROW_MIN_ABS=70,
1516d519adbfSMatthew Knepley                MATOP_CONVERT=71,
1517d519adbfSMatthew Knepley                MATOP_SET_COLORING=72,
1518d519adbfSMatthew Knepley                MATOP_SET_VALUES_ADIC=73,
1519d519adbfSMatthew Knepley                MATOP_SET_VALUES_ADIFOR=74,
1520d519adbfSMatthew Knepley                MATOP_FD_COLORING_APPLY=75,
1521d519adbfSMatthew Knepley                MATOP_SET_FROM_OPTIONS=76,
1522d519adbfSMatthew Knepley                MATOP_MULT_CON=77,
1523d519adbfSMatthew Knepley                MATOP_MULT_TRANSPOSE_CON=78,
1524d519adbfSMatthew Knepley                MATOP_PERMUTE_SPARSIFY=79,
1525d519adbfSMatthew Knepley                MATOP_MULT_MULTIPLE=80,
1526d519adbfSMatthew Knepley                MATOP_SOLVE_MULTIPLE=81,
1527d519adbfSMatthew Knepley                MATOP_GET_INERTIA=82,
1528d519adbfSMatthew Knepley                MATOP_LOAD=83,
1529d519adbfSMatthew Knepley                MATOP_IS_SYMMETRIC=84,
1530d519adbfSMatthew Knepley                MATOP_IS_HERMITIAN=85,
1531d519adbfSMatthew Knepley                MATOP_IS_STRUCTURALLY_SYMMETRIC=86,
153241f059aeSBarry Smith                MATOP_DUMMY=87,
1533d519adbfSMatthew Knepley                MATOP_GET_VECS=88,
1534d519adbfSMatthew Knepley                MATOP_MAT_MULT=89,
1535d519adbfSMatthew Knepley                MATOP_MAT_MULT_SYMBOLIC=90,
1536d519adbfSMatthew Knepley                MATOP_MAT_MULT_NUMERIC=91,
1537d519adbfSMatthew Knepley                MATOP_PTAP=92,
1538d519adbfSMatthew Knepley                MATOP_PTAP_SYMBOLIC=93,
1539d519adbfSMatthew Knepley                MATOP_PTAP_NUMERIC=94,
1540d519adbfSMatthew Knepley                MATOP_MAT_MULTTRANSPOSE=95,
15411763ac4eSSatish Balay                MATOP_MAT_MULTTRANSPOSE_SYM=96,
15421763ac4eSSatish Balay                MATOP_MAT_MULTTRANSPOSE_NUM=97,
1543d519adbfSMatthew Knepley                MATOP_PTAP_SYMBOLIC_SEQAIJ=98,
1544d519adbfSMatthew Knepley                MATOP_PTAP_NUMERIC_SEQAIJ=99,
1545d519adbfSMatthew Knepley                MATOP_PTAP_SYMBOLIC_MPIAIJ=100,
1546d519adbfSMatthew Knepley                MATOP_PTAP_NUMERIC_MPIAIJ=101,
1547d519adbfSMatthew Knepley                MATOP_CONJUGATE=102,
1548d519adbfSMatthew Knepley                MATOP_SET_SIZES=103,
1549d519adbfSMatthew Knepley                MATOP_SET_VALUES_ROW=104,
1550d519adbfSMatthew Knepley                MATOP_REAL_PART=105,
1551d519adbfSMatthew Knepley                MATOP_IMAG_PART=106,
1552d519adbfSMatthew Knepley                MATOP_GET_ROW_UTRIANGULAR=107,
1553d519adbfSMatthew Knepley                MATOP_RESTORE_ROW_UTRIANGULAR=108,
1554d519adbfSMatthew Knepley                MATOP_MATSOLVE=109,
1555d519adbfSMatthew Knepley                MATOP_GET_REDUNDANTMATRIX=110,
1556d519adbfSMatthew Knepley                MATOP_GET_ROW_MIN=111,
1557d519adbfSMatthew Knepley                MATOP_GET_COLUMN_VEC=112,
1558d519adbfSMatthew Knepley                MATOP_MISSING_DIAGONAL=113,
1559d519adbfSMatthew Knepley                MATOP_MATGETSEQNONZEROSTRUCTURE=114,
156089c6957cSBarry Smith                MATOP_CREATE=115,
156189c6957cSBarry Smith                MATOP_GET_GHOSTS=116,
1562eeffb40dSHong Zhang                MATOP_MULT_DIAGONAL_BLOCK=119,
1563547795f9SHong Zhang                MATOP_HERMITIANTRANSPOSE=120,
1564547795f9SHong Zhang                MATOP_MULTHERMITIANTRANSPOSE=121,
1565fbdbba38SShri Abhyankar                MATOP_MULTHERMITIANTRANSPOSEADD=122,
1566d6037b41SHong Zhang 	       MATOP_GETMULTIPROCBLOCK=123,
1567fae171e0SBarry Smith              } MatOperation;
1568ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscBool *);
1569be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void));
1570be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void));
1571be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*);
1572112a2221SBarry Smith 
157390ace30eSBarry Smith /*
157490ace30eSBarry Smith    Codes for matrices stored on disk. By default they are
157590ace30eSBarry Smith    stored in a universal format. By changing the format with
15767973ad04SBarry Smith    PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
157790ace30eSBarry Smith    be stored in a way natural for the matrix, for example dense matrices
157890ace30eSBarry Smith    would be stored as dense. Matrices stored this way may only be
1579f4403165SShri Abhyankar    read into matrices of the same type.
158090ace30eSBarry Smith */
158190ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1
158290ace30eSBarry Smith 
1583be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1584be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*);
15851f4e1ec7SBarry Smith 
1586d9274352SBarry Smith /*S
1587d9274352SBarry Smith      MatNullSpace - Object that removes a null space from a vector, i.e.
1588d9274352SBarry Smith          orthogonalizes the vector to a subsapce
1589d9274352SBarry Smith 
1590f7a9e4ceSBarry Smith    Level: advanced
1591d9274352SBarry Smith 
1592d9274352SBarry Smith   Concepts: matrix; linear operator, null space
1593d9274352SBarry Smith 
15946e1639daSBarry Smith   Users manual sections:
15956e1639daSBarry Smith .   sec_singular
15966e1639daSBarry Smith 
1597d9274352SBarry Smith .seealso:  MatNullSpaceCreate()
1598d9274352SBarry Smith S*/
159974637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace;
1600d9274352SBarry Smith 
1601ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*);
1602b22b330cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1603be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace);
1604be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1605be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace);
1606ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat,PetscBool  *);
160774637425SBarry Smith 
1608be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS);
1609be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1610be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
161146129b97SKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat);
16123f1d51d7SBarry Smith 
1613be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*);
1614be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*);
1615be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*);
1616c4f061fbSSatish Balay 
1617be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*);
1618b0a32e0cSBarry Smith 
1619be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec);
162004f1ad80SBarry Smith 
1621fef1beadSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
16223ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetBase(Mat,Vec,Vec);
16233ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1624e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1625e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1626e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDAddNullSpace(Mat,MatNullSpace);
1627e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1628e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDResetHHistory(Mat);
1629e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctionError(Mat,PetscReal);
1630e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetPeriod(Mat,PetscInt);
1631e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDGetH(Mat,PetscScalar *);
16326aa9148fSLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetOptionsPrefix(Mat,const char[]);
1633e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFromOptions(Mat);
1634e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1635e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);
1636e884886fSBarry Smith 
16376370053bSBarry Smith /*S
16386370053bSBarry Smith     MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free
16396370053bSBarry Smith               Jacobian vector products
1640e884886fSBarry Smith 
16416370053bSBarry Smith     Notes: MATMFFD is a specific MatType which uses the MatMFFD data structure
16426370053bSBarry Smith 
16436370053bSBarry Smith            MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure
16446370053bSBarry Smith 
16456370053bSBarry Smith     Level: developer
16466370053bSBarry Smith 
16476370053bSBarry Smith .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
16486370053bSBarry Smith S*/
1649e884886fSBarry Smith typedef struct _p_MatMFFD* MatMFFD;
1650e884886fSBarry Smith 
1651e884886fSBarry Smith /*E
1652e884886fSBarry Smith     MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function
1653e884886fSBarry Smith 
1654e884886fSBarry Smith    Level: beginner
1655e884886fSBarry Smith 
1656e884886fSBarry Smith .seealso: MatMFFDSetType(), MatMFFDRegister()
1657e884886fSBarry Smith E*/
1658a313700dSBarry Smith #define MatMFFDType char*
1659e884886fSBarry Smith #define MATMFFD_DS  "ds"
1660e884886fSBarry Smith #define MATMFFD_WP  "wp"
1661e884886fSBarry Smith 
1662a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetType(Mat,const MatMFFDType);
1663e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatMFFD));
1664e884886fSBarry Smith 
1665e884886fSBarry Smith /*MC
1666e884886fSBarry Smith    MatMFFDRegisterDynamic - Adds a method to the MatMFFD registry.
1667e884886fSBarry Smith 
1668e884886fSBarry Smith    Synopsis:
16691890ba74SBarry Smith    PetscErrorCode MatMFFDRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatMFFD))
1670e884886fSBarry Smith 
1671e884886fSBarry Smith    Not Collective
1672e884886fSBarry Smith 
1673e884886fSBarry Smith    Input Parameters:
1674e884886fSBarry Smith +  name_solver - name of a new user-defined compute-h module
1675e884886fSBarry Smith .  path - path (either absolute or relative) the library containing this solver
1676e884886fSBarry Smith .  name_create - name of routine to create method context
1677e884886fSBarry Smith -  routine_create - routine to create method context
1678e884886fSBarry Smith 
1679e884886fSBarry Smith    Level: developer
1680e884886fSBarry Smith 
1681e884886fSBarry Smith    Notes:
1682e884886fSBarry Smith    MatMFFDRegisterDynamic() may be called multiple times to add several user-defined solvers.
1683e884886fSBarry Smith 
1684e884886fSBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
1685e884886fSBarry Smith    is ignored.
1686e884886fSBarry Smith 
1687e884886fSBarry Smith    Sample usage:
1688e884886fSBarry Smith .vb
1689e884886fSBarry Smith    MatMFFDRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a,
1690e884886fSBarry Smith                "MyHCreate",MyHCreate);
1691e884886fSBarry Smith .ve
1692e884886fSBarry Smith 
1693e884886fSBarry Smith    Then, your solver can be chosen with the procedural interface via
1694e884886fSBarry Smith $     MatMFFDSetType(mfctx,"my_h")
1695e884886fSBarry Smith    or at runtime via the option
1696e884886fSBarry Smith $     -snes_mf_type my_h
1697e884886fSBarry Smith 
1698e884886fSBarry Smith .keywords: MatMFFD, register
1699e884886fSBarry Smith 
1700e884886fSBarry Smith .seealso: MatMFFDRegisterAll(), MatMFFDRegisterDestroy()
1701e884886fSBarry Smith M*/
1702e884886fSBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1703e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,0)
1704e884886fSBarry Smith #else
1705e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,d)
1706e884886fSBarry Smith #endif
1707e884886fSBarry Smith 
1708e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterAll(const char[]);
1709e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterDestroy(void);
17101d0fab5eSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDDSSetUmin(Mat,PetscReal);
1711ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDWPSetComputeNormU(Mat,PetscBool );
1712e884886fSBarry Smith 
1713e884886fSBarry Smith 
1714be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1715be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
17167dbadf16SMatthew Knepley 
171797969023SHong Zhang /*
171897969023SHong Zhang    PETSc interface to MUMPS
171997969023SHong Zhang */
172097969023SHong Zhang #ifdef PETSC_HAVE_MUMPS
1721a1f19f5aSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetMumpsIcntl(Mat,PetscInt,PetscInt);
172297969023SHong Zhang #endif
172323a5497aSJed Brown 
172423a5497aSJed Brown PETSC_EXTERN_CXX_END
172523a5497aSJed Brown #endif
1726