xref: /petsc/include/petscmat.h (revision dfb205c343fb801ef223ce0215bc23136b0dce1d)
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"
66557cca28SSatish Balay #define MATTRANSPOSEMAT    "transpose"
6772ca8751SBarry Smith #define MATSCHURCOMPLEMENT "schurcomplement"
681d6018f0SLisandro Dalcin #define MATPYTHON          "python"
69f91d8e95SBarry Smith #define MATHYPRESTRUCT     "hyprestruct"
70a9e6138eSGlenn Hammond #define MATHYPRESSTRUCT    "hypresstruct"
71ee1cef2cSJed Brown #define MATSUBMATRIX       "submatrix"
72dbc6227fSDmitry Karpeev #define MATDD              "matdd"
73ba2f8784SDmitry Karpeev #define MATIM              "matim"
74ba2f8784SDmitry Karpeev 
75773941d6SBarry Smith 
769989ab13SBarry Smith /*E
77c7393fdbSBarry Smith     MatSolverPackage - String with the name of a PETSc matrix solver type.
789989ab13SBarry Smith 
799989ab13SBarry Smith     For example: "petsc" indicates what PETSc provides, "superlu" indicates either
809989ab13SBarry Smith        SuperLU or SuperLU_Dist etc.
819989ab13SBarry Smith 
829989ab13SBarry Smith 
839989ab13SBarry Smith    Level: beginner
849989ab13SBarry Smith 
855c9eb25fSBarry Smith .seealso: MatGetFactor(), Mat, MatSetType(), MatType
869989ab13SBarry Smith E*/
87c7393fdbSBarry Smith #define MatSolverPackage char*
882692d6eeSBarry Smith #define MATSOLVERSPOOLES      "spooles"
892692d6eeSBarry Smith #define MATSOLVERSUPERLU      "superlu"
902692d6eeSBarry Smith #define MATSOLVERSUPERLU_DIST "superlu_dist"
912692d6eeSBarry Smith #define MATSOLVERUMFPACK      "umfpack"
9220db9a53SJed Brown #define MATSOLVERCHOLMOD      "cholmod"
932692d6eeSBarry Smith #define MATSOLVERESSL         "essl"
942692d6eeSBarry Smith #define MATSOLVERLUSOL        "lusol"
952692d6eeSBarry Smith #define MATSOLVERMUMPS        "mumps"
962692d6eeSBarry Smith #define MATSOLVERPASTIX       "pastix"
972692d6eeSBarry Smith #define MATSOLVERDSCPACK      "dscpack"
982692d6eeSBarry Smith #define MATSOLVERMATLAB       "matlab"
992692d6eeSBarry Smith #define MATSOLVERPETSC        "petsc"
1002692d6eeSBarry Smith #define MATSOLVERPLAPACK      "plapack"
1012692d6eeSBarry Smith #define MATSOLVERBAS          "bas"
102773941d6SBarry Smith 
103b24902e0SBarry Smith /*E
104b24902e0SBarry Smith     MatFactorType - indicates what type of factorization is requested
105b24902e0SBarry Smith 
106b24902e0SBarry Smith     Level: beginner
107b24902e0SBarry Smith 
108b24902e0SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
109b24902e0SBarry Smith 
110c7393fdbSBarry Smith .seealso: MatSolverPackage, MatGetFactor()
111b24902e0SBarry Smith E*/
112599ef60dSHong Zhang typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType;
11334918c53SJed Brown extern const char *const MatFactorTypes[];
114e92e720dSBarry Smith 
115c7393fdbSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactor(Mat,const MatSolverPackage,MatFactorType,Mat*);
116db4efbfdSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactorAvailable(Mat,const MatSolverPackage,MatFactorType,PetscTruth*);
11735bd34faSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorGetSolverPackage(Mat,const MatSolverPackage*);
1186335c336SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactorType(Mat,MatFactorType*);
1199989ab13SBarry Smith 
120c06d978dSMatthew Knepley /* Logging support */
1210700a824SBarry Smith #define    MAT_FILE_CLASSID 1211216    /* used to indicate matrices in binary files */
1220700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_CLASSID;
1230700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_FDCOLORING_CLASSID;
1240700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_PARTITIONING_CLASSID;
1250700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_NULLSPACE_CLASSID;
1260700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MATMFFD_CLASSID;
127c06d978dSMatthew Knepley 
128ceb03754SKris Buschelman /*E
129ceb03754SKris Buschelman     MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
130ceb03754SKris Buschelman      or MatGetSubMatrix() are to be reused to store the new matrix values.
131ceb03754SKris Buschelman 
132ceb03754SKris Buschelman     Level: beginner
133ceb03754SKris Buschelman 
134ceb03754SKris Buschelman    Any additions/changes here MUST also be made in include/finclude/petscmat.h
135ceb03754SKris Buschelman 
1360c451bc4SBarry Smith .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
137ceb03754SKris Buschelman E*/
138dfe085dbSJed Brown typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX} MatReuse;
139ceb03754SKris Buschelman 
1405494a064SHong Zhang /*E
1415494a064SHong Zhang     MatGetSubMatrixOption - Indicates if matrices obtained from a call to MatGetSubMatrices()
142829201f2SHong Zhang      include the matrix values. Currently it is only used by MatGetSeqNonzerostructure().
1435494a064SHong Zhang 
1445494a064SHong Zhang     Level: beginner
1455494a064SHong Zhang 
146829201f2SHong Zhang .seealso: MatGetSeqNonzerostructure()
1475494a064SHong Zhang E*/
1485494a064SHong Zhang typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatGetSubMatrixOption;
1495494a064SHong Zhang 
150e5bd5246SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(const char[]);
151c06d978dSMatthew Knepley 
152f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreate(MPI_Comm,Mat*);
153a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(MPI_Comm comm),(comm,&A),Mat,A)
154a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(),(PETSC_COMM_WORLD,&A),Mat,A)
155f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
156a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat,const MatType);
157be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetFromOptions(Mat);
158be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUpPreallocation(Mat);
159be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]);
160be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat));
16130de9b25SBarry Smith 
162f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOptionsPrefix(Mat,const char[]);
163f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAppendOptionsPrefix(Mat,const char[]);
164f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOptionsPrefix(Mat,const char*[]);
165f69a0ea3SMatthew Knepley 
16630de9b25SBarry Smith /*MC
16730de9b25SBarry Smith    MatRegisterDynamic - Adds a new matrix type
16830de9b25SBarry Smith 
16930de9b25SBarry Smith    Synopsis:
1701890ba74SBarry Smith    PetscErrorCode MatRegisterDynamic(const char *name,const char *path,const char *name_create,PetscErrorCode (*routine_create)(Mat))
17130de9b25SBarry Smith 
17230de9b25SBarry Smith    Not Collective
17330de9b25SBarry Smith 
17430de9b25SBarry Smith    Input Parameters:
17530de9b25SBarry Smith +  name - name of a new user-defined matrix type
17630de9b25SBarry Smith .  path - path (either absolute or relative) the library containing this solver
17730de9b25SBarry Smith .  name_create - name of routine to create method context
17830de9b25SBarry Smith -  routine_create - routine to create method context
17930de9b25SBarry Smith 
18030de9b25SBarry Smith    Notes:
18130de9b25SBarry Smith    MatRegisterDynamic() may be called multiple times to add several user-defined solvers.
18230de9b25SBarry Smith 
18330de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
18430de9b25SBarry Smith    is ignored.
18530de9b25SBarry Smith 
18630de9b25SBarry Smith    Sample usage:
18730de9b25SBarry Smith .vb
18830de9b25SBarry Smith    MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a,
18930de9b25SBarry Smith                "MyMatCreate",MyMatCreate);
19030de9b25SBarry Smith .ve
19130de9b25SBarry Smith 
19230de9b25SBarry Smith    Then, your solver can be chosen with the procedural interface via
19330de9b25SBarry Smith $     MatSetType(Mat,"my_mat")
19430de9b25SBarry Smith    or at runtime via the option
19530de9b25SBarry Smith $     -mat_type my_mat
19630de9b25SBarry Smith 
19730de9b25SBarry Smith    Level: advanced
19830de9b25SBarry Smith 
199ab901514SBarry Smith    Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
20030de9b25SBarry Smith          If your function is not being put into a shared library then use VecRegister() instead
20130de9b25SBarry Smith 
20230de9b25SBarry Smith .keywords: Mat, register
20330de9b25SBarry Smith 
20430de9b25SBarry Smith .seealso: MatRegisterAll(), MatRegisterDestroy()
20530de9b25SBarry Smith 
20630de9b25SBarry Smith M*/
207273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
208273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0)
209273d9f13SBarry Smith #else
210273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d)
21130de9b25SBarry Smith #endif
21230de9b25SBarry Smith 
213273d9f13SBarry Smith extern PetscTruth MatRegisterAllCalled;
214b0a32e0cSBarry Smith extern PetscFList MatList;
215b022a5c1SBarry Smith extern PetscFList MatColoringList;
216b022a5c1SBarry Smith extern PetscFList MatPartitioningList;
21728988994SBarry Smith 
2183b224e63SBarry Smith /*E
2193b224e63SBarry Smith     MatStructure - Indicates if the matrix has the same nonzero structure
2203b224e63SBarry Smith 
2213b224e63SBarry Smith     Level: beginner
2223b224e63SBarry Smith 
2233b224e63SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
2243b224e63SBarry Smith 
2253b224e63SBarry Smith .seealso: MatCopy(), KSPSetOperators(), PCSetOperators()
2263b224e63SBarry Smith E*/
2273b224e63SBarry Smith typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure;
2283b224e63SBarry Smith 
229be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
230be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
231be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
232ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A)
233ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A)
234ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A)
235ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A)
236ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A))
237ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A))
238ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A))
239be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
240ba966639SSatish 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)
241ba966639SSatish 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)
242ba966639SSatish 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)
243ba966639SSatish 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)
244ba966639SSatish 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))
245ba966639SSatish 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))
246ba966639SSatish 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))
247ba966639SSatish 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)
248ba966639SSatish 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)
249ba966639SSatish 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)
250ba966639SSatish 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)
251ba966639SSatish 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))
252ba966639SSatish 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))
253ba966639SSatish 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))
25463ab93bfSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
2558d7a6e47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
2568d7a6e47SBarry Smith 
257be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
258ba966639SSatish 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)
259ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
260ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
261ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
262ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
263ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
264ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
265be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
266ba966639SSatish 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)
267ba966639SSatish 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)
268ba966639SSatish 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)
269ba966639SSatish 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)
270ba966639SSatish 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))
271ba966639SSatish 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))
272ba966639SSatish 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))
273ba966639SSatish 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)
274ba966639SSatish 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)
275ba966639SSatish 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)
276ba966639SSatish 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)
277ba966639SSatish 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))
278ba966639SSatish 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))
279ba966639SSatish 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))
280be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
281be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
282ba966639SSatish 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)
283ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
284ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
285ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
286ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
287ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
288ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
289be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
290ba966639SSatish 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)
291ba966639SSatish 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)
292ba966639SSatish 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)
293ba966639SSatish 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)
294ba966639SSatish 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))
295ba966639SSatish 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))
296ba966639SSatish 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))
297ba966639SSatish 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)
298ba966639SSatish 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)
299ba966639SSatish 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)
300ba966639SSatish 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)
301ba966639SSatish 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))
302ba966639SSatish 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))
303ba966639SSatish 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))
304*dfb205c3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
305*dfb205c3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
306*dfb205c3SBarry Smith 
307be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
308ba966639SSatish 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)
309ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A)
310be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*);
311be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateNormal(Mat,Mat*);
312ba966639SSatish Balay PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A)
313ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateLRC(Mat,Mat,Mat,Mat*);
314284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*);
3155a11e1b2SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
3165a11e1b2SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
3172a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateScatter(MPI_Comm,VecScatter,Mat*);
3182a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterSetVecScatter(Mat,VecScatter);
3192a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterGetVecScatter(Mat,VecScatter*);
3208cdf2d9bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
321793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeAddMat(Mat,Mat);
322b52f573bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeMerge(Mat);
323793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
3246d7c1e57SBarry Smith typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
3256d7c1e57SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeSetType(Mat,MatCompositeType);
3266d7c1e57SBarry Smith 
327dbc6227fSDmitry Karpeev typedef enum {MATDD_BLOCK_COMM_DEFAULT = 0, MATDD_BLOCK_COMM_SELF = -1, MATDD_BLOCK_COMM_DETERMINE = -2} MatDDBlockCommType;
328dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDAIJSetPreallocation(Mat A,PetscInt nz,PetscInt *nnz);
329dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDGetDefaltBlockType(Mat A, const MatType *type);
330dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetDefaltBlockType(Mat A, const MatType type);
331dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetPreallocation_AIJ(Mat A,PetscInt nz,PetscInt *nnz);
332dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDAddBlock(Mat A, PetscInt rowblock, PetscInt colblock, const MatType blockmattype,  MatDDBlockCommType blockcommtype, Mat *block);
333dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetBlock(Mat A, PetscInt rowblock, PetscInt colblock, Mat block);
334dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDGetBlock(Mat A, PetscInt rowblock, PetscInt colblock, Mat *block);
335dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetScatters(Mat A, PetscInt blockcount, Mat scatters[]);
336dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetGathers(Mat A, PetscInt blockcount,  Mat gathers[]);
33762ee7b53SDmitry Karpeev 
338ba2f8784SDmitry Karpeev #if defined PETSC_HAVE_MATIM
339ba2f8784SDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIMSetIS(Mat A, IS in, IS out);
340ba2f8784SDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIMGetIS(Mat A, IS *in, IS *out);
341ba2f8784SDmitry Karpeev #endif
342ba2f8784SDmitry Karpeev 
343ba2f8784SDmitry Karpeev 
344a6a5cd3fSDmitry Karpeev 
3455a7f1df3SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqFFTW(MPI_Comm,PetscInt,const PetscInt[],Mat*);
346f20085c4SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateTranspose(Mat,Mat*);
347ee1cef2cSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSubMatrix(Mat,IS,IS,Mat*);
348ee1cef2cSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSubMatrixUpdate(Mat,Mat,IS,IS);
3491472f72bSBarry Smith 
3501d6018f0SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreatePython(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const char[],Mat*);
3511d6018f0SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPythonSetType(Mat,const char[]);
3521d6018f0SLisandro Dalcin 
3531d6018f0SLisandro Dalcin 
354f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUp(Mat);
355be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat);
35621c89e3eSBarry Smith 
3570c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat);
35899cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRealPart(Mat);
35999cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatImaginaryPart(Mat);
360bfc7d00aSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonalBlock(Mat,PetscTruth*,MatReuse,Mat*);
361fe97e370SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetTrace(Mat,PetscScalar*);
36299cafbc1SBarry Smith 
3638ed539a5SBarry Smith /* ------------------------------------------------------------*/
364be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
365be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
36687d4246cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
367f259bd47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
36884cb2905SBarry Smith 
3692ef4de8bSBarry Smith /*S
3702ef4de8bSBarry Smith      MatStencil - Data structure (C struct) for storing information about a single row or
3712ef4de8bSBarry Smith         column of a matrix as index on an associated grid.
3722ef4de8bSBarry Smith 
3732ef4de8bSBarry Smith    Level: beginner
3742ef4de8bSBarry Smith 
3752ef4de8bSBarry Smith   Concepts: matrix; linear operator
3762ef4de8bSBarry Smith 
377d7bd93baSBarry Smith .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil()
3782ef4de8bSBarry Smith S*/
379435da068SBarry Smith typedef struct {
380c1ac3661SBarry Smith   PetscInt k,j,i,c;
381435da068SBarry Smith } MatStencil;
3822ef4de8bSBarry Smith 
383be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
384be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
385be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
386435da068SBarry Smith 
387be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat,ISColoring);
388be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat,void*);
389be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat,PetscInt,void*);
3903a7fca6bSBarry Smith 
391d91e6319SBarry Smith /*E
392d91e6319SBarry Smith     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
393d91e6319SBarry Smith      to continue to add values to it
394d91e6319SBarry Smith 
395d91e6319SBarry Smith     Level: beginner
396d91e6319SBarry Smith 
397d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd()
398d91e6319SBarry Smith E*/
3996d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
400be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat,MatAssemblyType);
401be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat,MatAssemblyType);
402be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat,PetscTruth*);
4034f9c727eSBarry Smith 
4041d73ed98SBarry Smith 
40530de9b25SBarry Smith 
406d91e6319SBarry Smith /*E
407d91e6319SBarry Smith     MatOption - Options that may be set for a matrix and its behavior or storage
408d91e6319SBarry Smith 
409d91e6319SBarry Smith     Level: beginner
410d91e6319SBarry Smith 
4110a835dfdSSatish Balay    Any additions/changes here MUST also be made in include/finclude/petscmat.h
412d91e6319SBarry Smith 
413d91e6319SBarry Smith .seealso: MatSetOption()
414d91e6319SBarry Smith E*/
415512a5fc5SBarry Smith typedef enum {MAT_ROW_ORIENTED,MAT_NEW_NONZERO_LOCATIONS,
4164e0d8c25SBarry Smith               MAT_SYMMETRIC,
4174e0d8c25SBarry Smith               MAT_STRUCTURALLY_SYMMETRIC,
4188047e77bSBarry Smith               MAT_NEW_DIAGONALS,MAT_IGNORE_OFF_PROC_ENTRIES,
4194e0d8c25SBarry Smith               MAT_NEW_NONZERO_LOCATION_ERR,
4204e0d8c25SBarry Smith               MAT_NEW_NONZERO_ALLOCATION_ERR,MAT_USE_HASH_TABLE,
421a9817697SBarry Smith               MAT_KEEP_NONZERO_PATTERN,MAT_IGNORE_ZERO_ENTRIES,
4224e0d8c25SBarry Smith               MAT_USE_INODES,
4234e0d8c25SBarry Smith               MAT_HERMITIAN,
4244e0d8c25SBarry Smith               MAT_SYMMETRY_ETERNAL,
4254e0d8c25SBarry Smith               MAT_USE_COMPRESSEDROW,
4264e0d8c25SBarry Smith               MAT_IGNORE_LOWER_TRIANGULAR,MAT_ERROR_LOWER_TRIANGULAR,
42728b2fa4aSMatthew Knepley               MAT_GETROW_UPPERTRIANGULAR,MAT_UNUSED_NONZERO_LOCATION_ERR,
4284cb17eb5SBarry Smith               MAT_SPD,MAT_NO_OFF_PROC_ENTRIES,MAT_NO_OFF_PROC_ZERO_ROWS,
42928b2fa4aSMatthew Knepley               NUM_MAT_OPTIONS} MatOption;
430290bbb0aSBarry Smith extern const char *MatOptions[];
4314e0d8c25SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption,PetscTruth);
432a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,const MatType*);
433a313700dSBarry Smith PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),const MatType,t)
43484cb2905SBarry Smith 
435be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
436be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
437be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
438f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowUpperTriangular(Mat);
439f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowUpperTriangular(Mat);
440be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
441be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
442be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt);
443be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]);
444ba966639SSatish Balay PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a)
445be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]);
446be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *);
447ba966639SSatish Balay PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a)
448be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt);
4497b80b807SBarry Smith 
4501620fd73SBarry Smith 
451be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec);
45289c6957cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultDiagonalBlock(Mat,Vec,Vec);
453be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec);
454ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
455be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec);
456547795f9SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultHermitianTranspose(Mat,Vec,Vec);
457be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*);
458ba966639SSatish Balay PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t)
459e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0,&t),PetscTruth,t)
4601cbb95d3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscTruth*);
461be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec);
4625cb05578SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
463ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
464be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec);
465be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec);
4662bebee5dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatSolve(Mat,Mat,Mat);
467f5edf698SHong Zhang 
468d91e6319SBarry Smith /*E
469d91e6319SBarry Smith     MatDuplicateOption - Indicates if a duplicated sparse matrix should have
470d91e6319SBarry Smith   its numerical values copied over or just its nonzero structure.
471d91e6319SBarry Smith 
472d91e6319SBarry Smith     Level: beginner
473d91e6319SBarry Smith 
474d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
475d91e6319SBarry Smith 
47670dcbbb9SBarry Smith $   MAT_SHARE_NONZERO_PATTERN - the i and j arrays in the new matrix will be shared with the original matrix
47770dcbbb9SBarry Smith $                               this also triggers the MAT_DO_NOT_COPY_VALUES option. This is used when you
47870dcbbb9SBarry Smith $                               have several matrices with the same nonzero pattern.
47970dcbbb9SBarry Smith 
480d91e6319SBarry Smith .seealso: MatDuplicate()
481d91e6319SBarry Smith E*/
48270dcbbb9SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;
4832e8a6d31SBarry Smith 
484a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat,const MatType,MatReuse,Mat*);
485a313700dSBarry Smith PetscPolymorphicFunction(MatConvert,(Mat A,const MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a)
486be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat,MatDuplicateOption,Mat*);
487ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a)
488ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a)
48994a9d846SBarry Smith 
490cb5b572fSBarry Smith 
491be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat,Mat,MatStructure);
492be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat,PetscViewer);
493be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat,PetscReal,PetscTruth*);
494ba966639SSatish Balay PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t)
495e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0,&t),PetscTruth,t)
496be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscTruth*);
497ba966639SSatish Balay PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t)
4981cbb95d3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscReal,PetscTruth*);
4991cbb95d3SBarry Smith PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,0,&t),PetscTruth,t)
500be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*);
501be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*);
50264c62002SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMissingDiagonal(Mat,PetscTruth *,PetscInt *);
503112444f4SShri Abhyankar EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoad(Mat, PetscViewer);
5047b80b807SBarry Smith 
5058f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
5068f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
5078f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
5088f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
509d4fbbf0eSBarry Smith 
510d91e6319SBarry Smith /*S
511d91e6319SBarry Smith      MatInfo - Context of matrix information, used with MatGetInfo()
512d91e6319SBarry Smith 
513d91e6319SBarry Smith    In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
514d91e6319SBarry Smith 
515d91e6319SBarry Smith    Level: intermediate
516d91e6319SBarry Smith 
517d91e6319SBarry Smith   Concepts: matrix^nonzero information
518d91e6319SBarry Smith 
519d9274352SBarry Smith .seealso:  MatGetInfo(), MatInfoType
520d91e6319SBarry Smith S*/
5214e220ebcSLois Curfman McInnes typedef struct {
522b0a32e0cSBarry Smith   PetscLogDouble block_size;                         /* block size */
523b0a32e0cSBarry Smith   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
524b0a32e0cSBarry Smith   PetscLogDouble memory;                             /* memory allocated */
525b0a32e0cSBarry Smith   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
526b0a32e0cSBarry Smith   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
527b0a32e0cSBarry Smith   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
528b0a32e0cSBarry Smith   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
5294e220ebcSLois Curfman McInnes } MatInfo;
5304e220ebcSLois Curfman McInnes 
531d9274352SBarry Smith /*E
532d9274352SBarry Smith     MatInfoType - Indicates if you want information about the local part of the matrix,
533d9274352SBarry Smith      the entire parallel matrix or the maximum over all the local parts.
534d9274352SBarry Smith 
535d9274352SBarry Smith     Level: beginner
536d9274352SBarry Smith 
537d9274352SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
538d9274352SBarry Smith 
539d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo
540d9274352SBarry Smith E*/
5417b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
542be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat,MatInfoType,MatInfo*);
543be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat,Vec);
544985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec,PetscInt[]);
545985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMin(Mat,Vec,PetscInt[]);
546985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
547c87e5d42SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMinAbs(Mat,Vec,PetscInt[]);
54886697f06SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowSum(Mat,Vec);
549fc4dec0aSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,MatReuse,Mat*);
550fc4dec0aSBarry Smith PetscPolymorphicFunction(MatTranspose,(Mat A),(A,MAT_INITIAL_MATRIX,&t),Mat,t)
551eeffb40dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHermitianTranspose(Mat,MatReuse,Mat*);
552be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *);
553ba966639SSatish Balay PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t)
554be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *);
555be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec);
556be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode);
557be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscTruth*);
558ba966639SSatish Balay PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t)
559be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscTruth*);
560be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*);
561be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*);
562be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*);
5637b80b807SBarry Smith 
564be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *);
565ba966639SSatish Balay PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n)
566242f1d38SBarry Smith EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal *);
567be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat);
568f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar);
569f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar);
570c504e21bSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar);
571f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*);
572f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumnsIS(Mat,IS,const PetscScalar*);
5737b80b807SBarry Smith 
574be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscTruth);
575be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec);
576be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec);
5775ef9f2a5SBarry Smith 
578be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*);
579be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*);
580be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
5818ee2e534SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRanges(Mat,const PetscInt**);
582f4b8409dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
58372ca8751SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangesColumn(Mat,const PetscInt**);
5847b80b807SBarry Smith 
585be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
586be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]);
5874aa3045dSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,MatReuse,Mat *);
588f6d58c54SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSeqNonzeroStructure(Mat,Mat*);
589f6d58c54SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroySeqNonzeroStructure(Mat*);
5905494a064SHong Zhang 
591be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
592be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
593be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
594be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat);
595be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat);
596be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*);
597be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
598be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*);
5991d79065fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscInt**,MatScalar**,Mat*);
60043eb5e2fSMatthew Knepley #if defined (PETSC_USE_CTABLE)
601cd116e26SSatish Balay #include "petscctable.h"
60243eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *);
60343eb5e2fSMatthew Knepley #else
60443eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *);
60543eb5e2fSMatthew Knepley #endif
6068c7482ecSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);
6078efafbd8SBarry Smith 
608be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
6097b80b807SBarry Smith 
610be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
611be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
612be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat);
61322440eb1SKris Buschelman 
614be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
615be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
616be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat);
61722440eb1SKris Buschelman 
618be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*);
619be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*);
620be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat);
621bc011b1eSHong Zhang 
622f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure);
62304aac2b0SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat,MatStructure);
6241c741599SHong Zhang 
625f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar);
626f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar);
6277b80b807SBarry Smith 
628be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping);
629be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping);
630f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar);
631f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar);
632be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
633be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
634052efed2SBarry Smith 
635be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt);
636be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
63790f02eecSBarry Smith 
638be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec);
6390c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec);
640ba966639SSatish Balay PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
641be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec);
642be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*);
64369db28dcSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*);
644d6037b41SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetMultiProcBlock(Mat,MPI_Comm,Mat*);
645bd481603SBarry Smith 
646bd481603SBarry Smith /*MC
6471620fd73SBarry Smith    MatSetValue - Set a single entry into a matrix.
6481620fd73SBarry Smith 
6491620fd73SBarry Smith    Not collective
6501620fd73SBarry Smith 
6511620fd73SBarry Smith    Input Parameters:
6521620fd73SBarry Smith +  m - the matrix
6531620fd73SBarry Smith .  row - the row location of the entry
6541620fd73SBarry Smith .  col - the column location of the entry
6551620fd73SBarry Smith .  value - the value to insert
6561620fd73SBarry Smith -  mode - either INSERT_VALUES or ADD_VALUES
6571620fd73SBarry Smith 
6581620fd73SBarry Smith    Notes:
6591620fd73SBarry Smith    For efficiency one should use MatSetValues() and set several or many
6601620fd73SBarry Smith    values simultaneously if possible.
6611620fd73SBarry Smith 
6621620fd73SBarry Smith    Level: beginner
6631620fd73SBarry Smith 
6641620fd73SBarry Smith .seealso: MatSetValues(), MatSetValueLocal()
6651620fd73SBarry Smith M*/
6661620fd73SBarry 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);}
6671620fd73SBarry Smith 
6681620fd73SBarry Smith PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);}
6691620fd73SBarry Smith 
6701620fd73SBarry 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);}
6711620fd73SBarry Smith 
6721620fd73SBarry Smith /*MC
6730d2a7ff2SSatish Balay    MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
674bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
675bd481603SBarry Smith 
676bd481603SBarry Smith    Synopsis:
677c1ac3661SBarry Smith    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
678bd481603SBarry Smith 
679bd481603SBarry Smith    Collective on MPI_Comm
680bd481603SBarry Smith 
681bd481603SBarry Smith    Input Parameters:
682bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
683859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
684859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
685bd481603SBarry Smith 
686bd481603SBarry Smith    Output Parameters:
687bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
688bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
689bd481603SBarry Smith 
690bd481603SBarry Smith 
691bd481603SBarry Smith    Level: intermediate
692bd481603SBarry Smith 
693bd481603SBarry Smith    Notes:
6940598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
695bd481603SBarry Smith 
6961d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
697bd481603SBarry Smith 
698bd481603SBarry Smith    Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
699bd481603SBarry Smith 
7001620fd73SBarry Smith    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
7011620fd73SBarry Smith 
702bd481603SBarry Smith   Concepts: preallocation^Matrix
703bd481603SBarry Smith 
704bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
705bd481603SBarry Smith           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
706bd481603SBarry Smith M*/
707c4f061fbSSatish Balay #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
7087c922b88SBarry Smith { \
709a89bc211SBarry Smith   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
710a89bc211SBarry Smith   _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
711a89bc211SBarry Smith   _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
712a89bc211SBarry Smith   _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
713c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
714a89bc211SBarry Smith   _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
7157c922b88SBarry Smith 
716bd481603SBarry Smith /*MC
7170d2a7ff2SSatish Balay    MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per
718bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
719bd481603SBarry Smith 
720bd481603SBarry Smith    Synopsis:
721c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
722bd481603SBarry Smith 
723bd481603SBarry Smith    Collective on MPI_Comm
724bd481603SBarry Smith 
725bd481603SBarry Smith    Input Parameters:
726bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
727859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
728859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
729bd481603SBarry Smith 
730bd481603SBarry Smith    Output Parameters:
731bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
732bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
733bd481603SBarry Smith 
734bd481603SBarry Smith 
735bd481603SBarry Smith    Level: intermediate
736bd481603SBarry Smith 
737bd481603SBarry Smith    Notes:
7380598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
739bd481603SBarry Smith 
7401d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
741bd481603SBarry Smith 
7421620fd73SBarry Smith    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
7431620fd73SBarry Smith 
744bd481603SBarry Smith   Concepts: preallocation^Matrix
745bd481603SBarry Smith 
746bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
747bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
748bd481603SBarry Smith M*/
749222b16d4SBarry Smith #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \
750222b16d4SBarry Smith { \
751a89bc211SBarry Smith   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__end; \
752a89bc211SBarry Smith   _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
753a89bc211SBarry Smith   _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
754a89bc211SBarry Smith   _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
755c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\
756a89bc211SBarry Smith   _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
757222b16d4SBarry Smith 
758bd481603SBarry Smith /*MC
759bd481603SBarry Smith    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
760bd481603SBarry Smith        inserted using a local number of the rows and columns
761bd481603SBarry Smith 
762bd481603SBarry Smith    Synopsis:
763c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
764bd481603SBarry Smith 
765bd481603SBarry Smith    Not Collective
766bd481603SBarry Smith 
767bd481603SBarry Smith    Input Parameters:
768bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
769bd481603SBarry Smith .  nrows - the number of rows indicated
7701d73ed98SBarry Smith .  rows - the indices of the rows
771bd481603SBarry Smith .  ncols - the number of columns in the matrix
772bd481603SBarry Smith .  cols - the columns indicated
773bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
774bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
775bd481603SBarry Smith 
776bd481603SBarry Smith 
777bd481603SBarry Smith    Level: intermediate
778bd481603SBarry Smith 
779bd481603SBarry Smith    Notes:
7800598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
781bd481603SBarry Smith 
7821d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
783bd481603SBarry Smith 
784bd481603SBarry Smith   Concepts: preallocation^Matrix
785bd481603SBarry Smith 
786bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
787bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
788bd481603SBarry Smith M*/
789c4f061fbSSatish Balay #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
790c4f061fbSSatish Balay {\
791c1ac3661SBarry Smith   PetscInt __l;\
792ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
793ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
794c4f061fbSSatish Balay   for (__l=0;__l<nrows;__l++) {\
795ef66eb69SBarry Smith     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
796c4f061fbSSatish Balay   }\
797c4f061fbSSatish Balay }
798c4f061fbSSatish Balay 
799bd481603SBarry Smith /*MC
800bd481603SBarry Smith    MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
801bd481603SBarry Smith        inserted using a local number of the rows and columns
802bd481603SBarry Smith 
803bd481603SBarry Smith    Synopsis:
804c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
805bd481603SBarry Smith 
806bd481603SBarry Smith    Not Collective
807bd481603SBarry Smith 
808bd481603SBarry Smith    Input Parameters:
809bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
810bd481603SBarry Smith .  nrows - the number of rows indicated
8111d73ed98SBarry Smith .  rows - the indices of the rows
812bd481603SBarry Smith .  ncols - the number of columns in the matrix
813bd481603SBarry Smith .  cols - the columns indicated
814bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
815bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
816bd481603SBarry Smith 
817bd481603SBarry Smith 
818bd481603SBarry Smith    Level: intermediate
819bd481603SBarry Smith 
820bd481603SBarry Smith    Notes:
8210598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
822bd481603SBarry Smith 
823bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
824bd481603SBarry Smith 
825bd481603SBarry Smith   Concepts: preallocation^Matrix
826bd481603SBarry Smith 
827bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
828bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
829bd481603SBarry Smith M*/
830d3d32019SBarry Smith #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
831d3d32019SBarry Smith {\
832c1ac3661SBarry Smith   PetscInt __l;\
833d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
834d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
835d3d32019SBarry Smith   for (__l=0;__l<nrows;__l++) {\
836d3d32019SBarry Smith     _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
837d3d32019SBarry Smith   }\
838d3d32019SBarry Smith }
839d3d32019SBarry Smith 
840bd481603SBarry Smith /*MC
841bd481603SBarry Smith    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
842bd481603SBarry Smith        inserted using a local number of the rows and columns
843bd481603SBarry Smith 
844bd481603SBarry Smith    Synopsis:
845c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
846bd481603SBarry Smith 
847bd481603SBarry Smith    Not Collective
848bd481603SBarry Smith 
849bd481603SBarry Smith    Input Parameters:
85064075487SBarry Smith +  row - the row
851bd481603SBarry Smith .  ncols - the number of columns in the matrix
852a50f8bf6SHong Zhang -  cols - the columns indicated
853a50f8bf6SHong Zhang 
854a50f8bf6SHong Zhang    Output Parameters:
855a50f8bf6SHong Zhang +  dnz - the array that will be passed to the matrix preallocation routines
856bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
857bd481603SBarry Smith 
858bd481603SBarry Smith 
859bd481603SBarry Smith    Level: intermediate
860bd481603SBarry Smith 
861bd481603SBarry Smith    Notes:
8620598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
863bd481603SBarry Smith 
864bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
865bd481603SBarry Smith 
8661620fd73SBarry Smith    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
8671620fd73SBarry Smith 
868bd481603SBarry Smith   Concepts: preallocation^Matrix
869bd481603SBarry Smith 
870bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
871bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
872bd481603SBarry Smith M*/
873c4f061fbSSatish Balay #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
874c1ac3661SBarry Smith { PetscInt __i; \
875e32f2f54SBarry 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);\
876e32f2f54SBarry 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);\
8777c922b88SBarry Smith   for (__i=0; __i<nc; __i++) {\
87864075487SBarry Smith     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
8797cc688d7SBarry Smith     else dnz[row - __rstart]++;\
8807c922b88SBarry Smith   }\
8817c922b88SBarry Smith }
8827c922b88SBarry Smith 
883bd481603SBarry Smith /*MC
884bd481603SBarry Smith    MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
885bd481603SBarry Smith        inserted using a local number of the rows and columns
886bd481603SBarry Smith 
887bd481603SBarry Smith    Synopsis:
888c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
889bd481603SBarry Smith 
890bd481603SBarry Smith    Not Collective
891bd481603SBarry Smith 
892bd481603SBarry Smith    Input Parameters:
893bd481603SBarry Smith +  nrows - the number of rows indicated
8941d73ed98SBarry Smith .  rows - the indices of the rows
895bd481603SBarry Smith .  ncols - the number of columns in the matrix
896bd481603SBarry Smith .  cols - the columns indicated
897bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
898bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
899bd481603SBarry Smith 
900bd481603SBarry Smith 
901bd481603SBarry Smith    Level: intermediate
902bd481603SBarry Smith 
903bd481603SBarry Smith    Notes:
9040598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
905bd481603SBarry Smith 
906bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
907bd481603SBarry Smith 
9081620fd73SBarry Smith    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
9091620fd73SBarry Smith 
910bd481603SBarry Smith   Concepts: preallocation^Matrix
911bd481603SBarry Smith 
912bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
913bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
914bd481603SBarry Smith M*/
915d3d32019SBarry Smith #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
916c1ac3661SBarry Smith { PetscInt __i; \
917d3d32019SBarry Smith   for (__i=0; __i<nc; __i++) {\
918d3d32019SBarry Smith     if (cols[__i] >= __end) onz[row - __rstart]++; \
919d3d32019SBarry Smith     else if (cols[__i] >= row) dnz[row - __rstart]++;\
920d3d32019SBarry Smith   }\
921d3d32019SBarry Smith }
922d3d32019SBarry Smith 
923bd481603SBarry Smith /*MC
92416371a99SBarry Smith    MatPreallocateLocation -  An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists
92516371a99SBarry Smith 
92616371a99SBarry Smith    Synopsis:
92716371a99SBarry Smith    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)
92816371a99SBarry Smith 
92916371a99SBarry Smith    Not Collective
93016371a99SBarry Smith 
93116371a99SBarry Smith    Input Parameters:
93216371a99SBarry Smith .  A - matrix
93316371a99SBarry Smith .  row - row where values exist (must be local to this process)
93416371a99SBarry Smith .  ncols - number of columns
93516371a99SBarry Smith .  cols - columns with nonzeros
93616371a99SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
93716371a99SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
93816371a99SBarry Smith 
93916371a99SBarry Smith 
94016371a99SBarry Smith    Level: intermediate
94116371a99SBarry Smith 
94216371a99SBarry Smith    Notes:
9430598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
94416371a99SBarry Smith 
94516371a99SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
94616371a99SBarry Smith 
94716371a99SBarry Smith    This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.
94816371a99SBarry Smith 
94916371a99SBarry Smith   Concepts: preallocation^Matrix
95016371a99SBarry Smith 
95116371a99SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
95216371a99SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
95316371a99SBarry Smith M*/
95416371a99SBarry 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);}
95516371a99SBarry Smith 
95616371a99SBarry Smith 
95716371a99SBarry Smith /*MC
9580d2a7ff2SSatish Balay    MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
959bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
960bd481603SBarry Smith 
961bd481603SBarry Smith    Synopsis:
962c1ac3661SBarry Smith    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
963bd481603SBarry Smith 
964bd481603SBarry Smith    Collective on MPI_Comm
965bd481603SBarry Smith 
966bd481603SBarry Smith    Input Parameters:
96716371a99SBarry Smith +  dnz - the array that was be passed to the matrix preallocation routines
968bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
969bd481603SBarry Smith 
970bd481603SBarry Smith 
971bd481603SBarry Smith    Level: intermediate
972bd481603SBarry Smith 
973bd481603SBarry Smith    Notes:
9740598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
975bd481603SBarry Smith 
976bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
977bd481603SBarry Smith 
9781620fd73SBarry Smith    This is a MACRO not a function because it closes the { started in MatPreallocateInitialize().
9791620fd73SBarry Smith 
980bd481603SBarry Smith   Concepts: preallocation^Matrix
981bd481603SBarry Smith 
982bd481603SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
983bd481603SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
984bd481603SBarry Smith M*/
985a89bc211SBarry Smith #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}
9867c922b88SBarry Smith 
987bd481603SBarry Smith 
988bd481603SBarry Smith 
9897b80b807SBarry Smith /* Routines unique to particular data structures */
990be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **);
991ba966639SSatish Balay PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t)
992698d4c6aSKris Buschelman 
993be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*);
994be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
995698d4c6aSKris Buschelman 
996be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
997be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
998be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
999c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1000c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
10017b80b807SBarry Smith 
1002a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4
1003a96a251dSBarry Smith 
1004be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1005ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
1006be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1007ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
1008be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
1009ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz))
1010273d9f13SBarry Smith 
1011be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1012ba966639SSatish Balay PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz))
1013be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1014be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
101553803f26SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
1016725b52f3SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1017be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
1018be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1019be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
1020be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
1021284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
1022be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
1023be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
1024be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void));
1025273d9f13SBarry Smith 
1026be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt);
1027ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDenseGetLocalMatrix(Mat,Mat*);
10281b807ce4Svictorle 
1029be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat);
1030be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat);
10312e8a6d31SBarry Smith 
1032be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*);
10333a7fca6bSBarry Smith 
10347b80b807SBarry Smith /*
10357b80b807SBarry Smith   These routines are not usually accessed directly, rather solving is
103694b7f48cSBarry Smith   done through the KSP and PC interfaces.
10377b80b807SBarry Smith */
10387b80b807SBarry Smith 
1039d9274352SBarry Smith /*E
1040d9274352SBarry Smith     MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
1041d9274352SBarry Smith        with an optional dynamic library name, for example
1042d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
1043d9274352SBarry Smith 
1044d9274352SBarry Smith    Level: beginner
1045d9274352SBarry Smith 
1046e5a9bf91SBarry Smith    Cannot use const because the PC objects manipulate the string
1047e5a9bf91SBarry Smith 
1048d9274352SBarry Smith .seealso: MatGetOrdering()
1049d9274352SBarry Smith E*/
10503eaad2caSSatish Balay #define MatOrderingType char*
10512692d6eeSBarry Smith #define MATORDERINGNATURAL     "natural"
10522692d6eeSBarry Smith #define MATORDERINGND          "nd"
10532692d6eeSBarry Smith #define MATORDERING1WD         "1wd"
10542692d6eeSBarry Smith #define MATORDERINGRCM         "rcm"
10552692d6eeSBarry Smith #define MATORDERINGQMD         "qmd"
10562692d6eeSBarry Smith #define MATORDERINGROWLENGTH   "rowlength"
10572692d6eeSBarry Smith #define MATORDERINGDSC_ND      "dsc_nd"         /* these three are only for DSCPACK, see its documentation for details */
10582692d6eeSBarry Smith #define MATORDERINGDSC_MMD     "dsc_mmd"
10592692d6eeSBarry Smith #define MATORDERINGDSC_MDF     "dsc_mdf"
1060312e372aSBarry Smith #define MATORDERINGAMD         "amd"            /* only works if UMFPACK is installed with PETSc */
1061b12f92e5SBarry Smith 
1062f2416520SSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
1063be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list);
1064f2416520SSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));
106530de9b25SBarry Smith 
106630de9b25SBarry Smith /*MC
10671890ba74SBarry Smith    MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the matrix package.
106830de9b25SBarry Smith 
106930de9b25SBarry Smith    Synopsis:
10701890ba74SBarry Smith    PetscErrorCode MatOrderingRegisterDynamic(const char *name_ordering,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
107130de9b25SBarry Smith 
107230de9b25SBarry Smith    Not Collective
107330de9b25SBarry Smith 
107430de9b25SBarry Smith    Input Parameters:
10752692d6eeSBarry Smith +  sname - name of ordering (for example MATORDERINGND)
107630de9b25SBarry Smith .  path - location of library where creation routine is
107730de9b25SBarry Smith .  name - name of function that creates the ordering type,a string
107830de9b25SBarry Smith -  function - function pointer that creates the ordering
107930de9b25SBarry Smith 
108030de9b25SBarry Smith    Level: developer
108130de9b25SBarry Smith 
108230de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
108330de9b25SBarry Smith    is ignored.
108430de9b25SBarry Smith 
108530de9b25SBarry Smith    Sample usage:
108630de9b25SBarry Smith .vb
108730de9b25SBarry Smith    MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
108830de9b25SBarry Smith                "MyOrder",MyOrder);
108930de9b25SBarry Smith .ve
109030de9b25SBarry Smith 
109130de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
109230de9b25SBarry Smith $     MatOrderingSetType(part,"my_order)
109330de9b25SBarry Smith    or at runtime via the option
10942401956bSBarry Smith $     -pc_factor_mat_ordering_type my_order
109530de9b25SBarry Smith 
1096ab901514SBarry Smith    ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
109730de9b25SBarry Smith 
109830de9b25SBarry Smith .keywords: matrix, ordering, register
109930de9b25SBarry Smith 
110030de9b25SBarry Smith .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
110130de9b25SBarry Smith M*/
1102aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1103f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
1104b12f92e5SBarry Smith #else
1105f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
1106b12f92e5SBarry Smith #endif
110730de9b25SBarry Smith 
1108be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void);
1109be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]);
11102bad1931SBarry Smith extern PetscTruth MatOrderingRegisterAllCalled;
1111b0a32e0cSBarry Smith extern PetscFList MatOrderingList;
1112d4fbbf0eSBarry Smith 
1113be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1114a2ce50c7SBarry Smith 
1115d91e6319SBarry Smith /*S
1116d90ac83dSHong Zhang     MatFactorShiftType - Numeric Shift.
1117d90ac83dSHong Zhang 
1118d90ac83dSHong Zhang    Level: beginner
1119d90ac83dSHong Zhang 
1120d90ac83dSHong Zhang S*/
1121d90ac83dSHong Zhang typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
1122d90ac83dSHong Zhang extern const char *MatFactorShiftTypes[];
1123d90ac83dSHong Zhang 
1124d90ac83dSHong Zhang /*S
11252401956bSBarry Smith    MatFactorInfo - Data passed into the matrix factorization routines
1126b00f7748SHong Zhang 
112761cad860SBarry Smith    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
112861cad860SBarry Smith $     MatFactorInfo  info(MAT_FACTORINFO_SIZE)
1129b00f7748SHong Zhang 
113015e8a5b3SHong Zhang    Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
1131b00f7748SHong Zhang 
113261cad860SBarry Smith       You can use MatFactorInfoInitialize() to set default values.
113361cad860SBarry Smith 
1134b00f7748SHong Zhang    Level: developer
1135b00f7748SHong Zhang 
1136d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1137d7d82daaSBarry Smith           MatFactorInfoInitialize()
1138b00f7748SHong Zhang 
1139b00f7748SHong Zhang S*/
1140b00f7748SHong Zhang typedef struct {
114115e8a5b3SHong Zhang   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
114285317021SBarry Smith   PetscReal     usedt;
114315e8a5b3SHong Zhang   PetscReal     dt;             /* drop tolerance */
1144b00f7748SHong Zhang   PetscReal     dtcol;          /* tolerance for pivoting */
114515e8a5b3SHong Zhang   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
114667e28bfeSBarry Smith   PetscReal     fill;           /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1147348344bbSBarry Smith   PetscReal     levels;         /* ICC/ILU(levels) */
1148bcd9e38bSBarry Smith   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1149bcd9e38bSBarry Smith                                    factorization may be faster if do not pivot */
115015e8a5b3SHong Zhang   PetscReal     zeropivot;      /* pivot is called zero if less than this */
1151f4db908eSBarry Smith   PetscReal     shifttype;      /* type of shift added to matrix factor to prevent zero pivots */
1152f4db908eSBarry Smith   PetscReal     shiftamount;     /* how large the shift is */
115315e8a5b3SHong Zhang } MatFactorInfo;
1154ffa6d0a5SLois Curfman McInnes 
1155be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*);
11560481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
11570481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
11580481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
11590481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
11600481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
11610481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
11620481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
11630481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
11640481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,const MatFactorInfo*);
11650481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1166be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1167be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec);
1168be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec);
1169be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec);
1170be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec);
1171be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec);
1172be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1173be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs);
11748ed539a5SBarry Smith 
1175be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat);
1176bb5a7306SBarry Smith 
1177d91e6319SBarry Smith /*E
1178d91e6319SBarry Smith     MatSORType - What type of (S)SOR to perform
1179bb1eb677SSatish Balay 
1180d91e6319SBarry Smith     Level: beginner
1181d91e6319SBarry Smith 
1182d9274352SBarry Smith    May be bitwise ORd together
1183d9274352SBarry Smith 
1184d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1185d91e6319SBarry Smith 
11864e7234bfSBarry Smith    MatSORType may be bitwise ORd together, so do not change the numbers
11874e7234bfSBarry Smith 
118841f059aeSBarry Smith .seealso: MatSOR()
1189d91e6319SBarry Smith E*/
1190ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1191ee50ffe9SBarry Smith               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1192ee50ffe9SBarry Smith               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
119384cb2905SBarry Smith               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
119441f059aeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
11958ed539a5SBarry Smith 
1196d4fbbf0eSBarry Smith /*
1197639f9d9dSBarry Smith     These routines are for efficiently computing Jacobians via finite differences.
1198639f9d9dSBarry Smith */
1199b12f92e5SBarry Smith 
1200d9274352SBarry Smith /*E
1201d9274352SBarry Smith     MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1202d9274352SBarry Smith        with an optional dynamic library name, for example
1203d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1204d9274352SBarry Smith 
1205d9274352SBarry Smith    Level: beginner
1206d9274352SBarry Smith 
1207d9274352SBarry Smith .seealso: MatGetColoring()
1208d9274352SBarry Smith E*/
1209a313700dSBarry Smith #define MatColoringType char*
12102692d6eeSBarry Smith #define MATCOLORINGNATURAL "natural"
12112692d6eeSBarry Smith #define MATCOLORINGSL      "sl"
12122692d6eeSBarry Smith #define MATCOLORINGLF      "lf"
12132692d6eeSBarry Smith #define MATCOLORINGID      "id"
1214b12f92e5SBarry Smith 
1215ab970d9bSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,const MatColoringType,ISColoring*);
12162e90c967SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *));
121730de9b25SBarry Smith 
121830de9b25SBarry Smith /*MC
121930de9b25SBarry Smith    MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
122030de9b25SBarry Smith                                matrix package.
122130de9b25SBarry Smith 
122230de9b25SBarry Smith    Synopsis:
12231890ba74SBarry Smith    PetscErrorCode MatColoringRegisterDynamic(const char *name_coloring,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatColoring))
122430de9b25SBarry Smith 
122530de9b25SBarry Smith    Not Collective
122630de9b25SBarry Smith 
122730de9b25SBarry Smith    Input Parameters:
12282692d6eeSBarry Smith +  sname - name of Coloring (for example MATCOLORINGSL)
122930de9b25SBarry Smith .  path - location of library where creation routine is
123030de9b25SBarry Smith .  name - name of function that creates the Coloring type, a string
123130de9b25SBarry Smith -  function - function pointer that creates the coloring
123230de9b25SBarry Smith 
123330de9b25SBarry Smith    Level: developer
123430de9b25SBarry Smith 
123530de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
123630de9b25SBarry Smith    is ignored.
123730de9b25SBarry Smith 
123830de9b25SBarry Smith    Sample usage:
123930de9b25SBarry Smith .vb
124030de9b25SBarry Smith    MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
124130de9b25SBarry Smith                "MyColor",MyColor);
124230de9b25SBarry Smith .ve
124330de9b25SBarry Smith 
124430de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
124530de9b25SBarry Smith $     MatColoringSetType(part,"my_color")
124630de9b25SBarry Smith    or at runtime via the option
124730de9b25SBarry Smith $     -mat_coloring_type my_color
124830de9b25SBarry Smith 
1249ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
125030de9b25SBarry Smith 
125130de9b25SBarry Smith .keywords: matrix, Coloring, register
125230de9b25SBarry Smith 
125330de9b25SBarry Smith .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
125430de9b25SBarry Smith M*/
1255aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1256f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1257b12f92e5SBarry Smith #else
1258f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1259b12f92e5SBarry Smith #endif
126030de9b25SBarry Smith 
12612bad1931SBarry Smith extern PetscTruth MatColoringRegisterAllCalled;
1262f1144a30SSatish Balay 
1263be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]);
1264be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void);
1265be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1266639f9d9dSBarry Smith 
1267d9274352SBarry Smith /*S
1268d9274352SBarry Smith      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1269d9274352SBarry Smith         and coloring
1270639f9d9dSBarry Smith 
1271d9274352SBarry Smith    Level: beginner
1272d9274352SBarry Smith 
1273d9274352SBarry Smith   Concepts: coloring, sparse Jacobian, finite differences
1274d9274352SBarry Smith 
1275d9274352SBarry Smith .seealso:  MatFDColoringCreate()
1276d9274352SBarry Smith S*/
1277e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring;
1278639f9d9dSBarry Smith 
1279be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1280be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring);
1281be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer);
1282be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
12834a9d489dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1284be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1285be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring);
1286be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1287be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *);
1288be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec);
1289be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1290639f9d9dSBarry Smith /*
12910752156aSBarry Smith     These routines are for partitioning matrices: currently used only
12923eda8832SBarry Smith   for adjacency matrix, MatCreateMPIAdj().
12930752156aSBarry Smith */
1294ca161407SBarry Smith 
1295d9274352SBarry Smith /*S
1296d9274352SBarry Smith      MatPartitioning - Object for managing the partitioning of a matrix or graph
1297d9274352SBarry Smith 
1298d9274352SBarry Smith    Level: beginner
1299d9274352SBarry Smith 
1300d9274352SBarry Smith   Concepts: partitioning
1301d9274352SBarry Smith 
1302743a1026Svictorle .seealso:  MatPartitioningCreate(), MatPartitioningType
1303d9274352SBarry Smith S*/
130491e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning;
1305d9274352SBarry Smith 
1306d9274352SBarry Smith /*E
13075bc6e7ccSvictorle     MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1308d9274352SBarry Smith        with an optional dynamic library name, for example
1309d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1310d9274352SBarry Smith 
1311d9274352SBarry Smith    Level: beginner
1312d9274352SBarry Smith 
1313b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning
1314d9274352SBarry Smith E*/
1315a313700dSBarry Smith #define MatPartitioningType char*
13162692d6eeSBarry Smith #define MATPARTITIONINGCURRENT  "current"
13172692d6eeSBarry Smith #define MATPARTITIONINGSQUARE   "square"
13182692d6eeSBarry Smith #define MATPARTITIONINGPARMETIS "parmetis"
13192692d6eeSBarry Smith #define MATPARTITIONINGCHACO    "chaco"
13202692d6eeSBarry Smith #define MATPARTITIONINGJOSTLE   "jostle"
13212692d6eeSBarry Smith #define MATPARTITIONINGPARTY    "party"
13222692d6eeSBarry Smith #define MATPARTITIONINGSCOTCH   "scotch"
132371306c60Sjroman 
1324ca161407SBarry Smith 
1325be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1326a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,const MatPartitioningType);
1327be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt);
1328be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat);
1329be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1330be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1331be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*);
1332be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning);
13332aabb6bbSBarry Smith 
1334be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
133530de9b25SBarry Smith 
133630de9b25SBarry Smith /*MC
133730de9b25SBarry Smith    MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
133830de9b25SBarry Smith    matrix package.
133930de9b25SBarry Smith 
134030de9b25SBarry Smith    Synopsis:
13411890ba74SBarry Smith    PetscErrorCode MatPartitioningRegisterDynamic(const char *name_partitioning,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
134230de9b25SBarry Smith 
134330de9b25SBarry Smith    Not Collective
134430de9b25SBarry Smith 
134530de9b25SBarry Smith    Input Parameters:
13462692d6eeSBarry Smith +  sname - name of partitioning (for example MATPARTITIONINGCURRENT) or parmetis
134730de9b25SBarry Smith .  path - location of library where creation routine is
134830de9b25SBarry Smith .  name - name of function that creates the partitioning type, a string
134930de9b25SBarry Smith -  function - function pointer that creates the partitioning type
135030de9b25SBarry Smith 
135130de9b25SBarry Smith    Level: developer
135230de9b25SBarry Smith 
135330de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
135430de9b25SBarry Smith    is ignored.
135530de9b25SBarry Smith 
135630de9b25SBarry Smith    Sample usage:
135730de9b25SBarry Smith .vb
135830de9b25SBarry Smith    MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
135930de9b25SBarry Smith                "MyPartCreate",MyPartCreate);
136030de9b25SBarry Smith .ve
136130de9b25SBarry Smith 
136230de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
136330de9b25SBarry Smith $     MatPartitioningSetType(part,"my_part")
136430de9b25SBarry Smith    or at runtime via the option
136530de9b25SBarry Smith $     -mat_partitioning_type my_part
136630de9b25SBarry Smith 
1367ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
136830de9b25SBarry Smith 
136930de9b25SBarry Smith .keywords: matrix, partitioning, register
137030de9b25SBarry Smith 
137130de9b25SBarry Smith .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
137230de9b25SBarry Smith M*/
1373aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1374f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
13752aabb6bbSBarry Smith #else
1376f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
13772aabb6bbSBarry Smith #endif
13782aabb6bbSBarry Smith 
13792bad1931SBarry Smith extern PetscTruth MatPartitioningRegisterAllCalled;
1380f1144a30SSatish Balay 
1381be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]);
1382be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void);
13832bad1931SBarry Smith 
1384be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer);
1385be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning);
1386a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,const MatPartitioningType*);
1387ca161407SBarry Smith 
1388be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
13890e8af3caSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);
13900752156aSBarry Smith 
1391be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal);
1392be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning);
139371306c60Sjroman 
1394954b3ec6SBarry Smith typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType;
1395be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
139671306c60Sjroman typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType;
1397be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1398be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
139971306c60Sjroman typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType;
1400be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1401be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1402be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
140371306c60Sjroman 
140471306c60Sjroman #define MP_PARTY_OPT "opt"
140571306c60Sjroman #define MP_PARTY_LIN "lin"
140671306c60Sjroman #define MP_PARTY_SCA "sca"
140771306c60Sjroman #define MP_PARTY_RAN "ran"
140871306c60Sjroman #define MP_PARTY_GBF "gbf"
140971306c60Sjroman #define MP_PARTY_GCF "gcf"
141071306c60Sjroman #define MP_PARTY_BUB "bub"
141171306c60Sjroman #define MP_PARTY_DEF "def"
1412be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*);
141371306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs"
141471306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl"
141571306c60Sjroman #define MP_PARTY_NONE "no"
1416be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*);
1417be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1418be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscTruth);
1419be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth);
142071306c60Sjroman 
142171306c60Sjroman typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType;
1422be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*);
1423be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning);
1424be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType);
1425be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal);
1426be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*);
142771306c60Sjroman typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType;
1428be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType);
1429be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning);
1430be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*);
143171306c60Sjroman 
1432591294e4SBarry Smith EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
143314196391SBarry Smith EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);
1434591294e4SBarry Smith 
14350752156aSBarry Smith /*
14360a835dfdSSatish Balay     If you add entries here you must also add them to finclude/petscmat.h
1437d4fbbf0eSBarry Smith */
14381c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0,
14391c1c02c0SLois Curfman McInnes                MATOP_GET_ROW=1,
14401c1c02c0SLois Curfman McInnes                MATOP_RESTORE_ROW=2,
14411c1c02c0SLois Curfman McInnes                MATOP_MULT=3,
14421c1c02c0SLois Curfman McInnes                MATOP_MULT_ADD=4,
14437c922b88SBarry Smith                MATOP_MULT_TRANSPOSE=5,
14447c922b88SBarry Smith                MATOP_MULT_TRANSPOSE_ADD=6,
14451c1c02c0SLois Curfman McInnes                MATOP_SOLVE=7,
14461c1c02c0SLois Curfman McInnes                MATOP_SOLVE_ADD=8,
14477c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE=9,
14487c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE_ADD=10,
14491c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR=11,
14501c1c02c0SLois Curfman McInnes                MATOP_CHOLESKYFACTOR=12,
1451a714c06dSBarry Smith                MATOP_SOR=13,
14521c1c02c0SLois Curfman McInnes                MATOP_TRANSPOSE=14,
14531c1c02c0SLois Curfman McInnes                MATOP_GETINFO=15,
14541c1c02c0SLois Curfman McInnes                MATOP_EQUAL=16,
14551c1c02c0SLois Curfman McInnes                MATOP_GET_DIAGONAL=17,
14561c1c02c0SLois Curfman McInnes                MATOP_DIAGONAL_SCALE=18,
14571c1c02c0SLois Curfman McInnes                MATOP_NORM=19,
14581c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_BEGIN=20,
14591c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_END=21,
1460d519adbfSMatthew Knepley                MATOP_SET_OPTION=22,
1461d519adbfSMatthew Knepley                MATOP_ZERO_ENTRIES=23,
1462d519adbfSMatthew Knepley                MATOP_ZERO_ROWS=24,
1463d519adbfSMatthew Knepley                MATOP_LUFACTOR_SYMBOLIC=25,
1464d519adbfSMatthew Knepley                MATOP_LUFACTOR_NUMERIC=26,
1465d519adbfSMatthew Knepley                MATOP_CHOLESKY_FACTOR_SYMBOLIC=27,
1466d519adbfSMatthew Knepley                MATOP_CHOLESKY_FACTOR_NUMERIC=28,
1467d519adbfSMatthew Knepley                MATOP_SETUP_PREALLOCATION=29,
1468d519adbfSMatthew Knepley                MATOP_ILUFACTOR_SYMBOLIC=30,
1469d519adbfSMatthew Knepley                MATOP_ICCFACTOR_SYMBOLIC=31,
1470d519adbfSMatthew Knepley                MATOP_GET_ARRAY=32,
1471d519adbfSMatthew Knepley                MATOP_RESTORE_ARRAY=33,
1472d519adbfSMatthew Knepley                MATOP_DUPLICATE=34,
1473d519adbfSMatthew Knepley                MATOP_FORWARD_SOLVE=35,
1474d519adbfSMatthew Knepley                MATOP_BACKWARD_SOLVE=36,
1475d519adbfSMatthew Knepley                MATOP_ILUFACTOR=37,
1476d519adbfSMatthew Knepley                MATOP_ICCFACTOR=38,
1477d519adbfSMatthew Knepley                MATOP_AXPY=39,
1478d519adbfSMatthew Knepley                MATOP_GET_SUBMATRICES=40,
1479d519adbfSMatthew Knepley                MATOP_INCREASE_OVERLAP=41,
1480d519adbfSMatthew Knepley                MATOP_GET_VALUES=42,
1481d519adbfSMatthew Knepley                MATOP_COPY=43,
1482d519adbfSMatthew Knepley                MATOP_GET_ROW_MAX=44,
1483d519adbfSMatthew Knepley                MATOP_SCALE=45,
1484d519adbfSMatthew Knepley                MATOP_SHIFT=46,
148535153367SBarry Smith                MATOP_DIAGONAL_SET=47,
1486d519adbfSMatthew Knepley                MATOP_ILUDT_FACTOR=48,
1487d519adbfSMatthew Knepley                MATOP_SET_BLOCK_SIZE=49,
1488d519adbfSMatthew Knepley                MATOP_GET_ROW_IJ=50,
1489d519adbfSMatthew Knepley                MATOP_RESTORE_ROW_IJ=51,
1490d519adbfSMatthew Knepley                MATOP_GET_COLUMN_IJ=52,
1491d519adbfSMatthew Knepley                MATOP_RESTORE_COLUMN_IJ=53,
1492d519adbfSMatthew Knepley                MATOP_FDCOLORING_CREATE=54,
1493d519adbfSMatthew Knepley                MATOP_COLORING_PATCH=55,
1494d519adbfSMatthew Knepley                MATOP_SET_UNFACTORED=56,
1495d519adbfSMatthew Knepley                MATOP_PERMUTE=57,
1496d519adbfSMatthew Knepley                MATOP_SET_VALUES_BLOCKED=58,
1497d519adbfSMatthew Knepley                MATOP_GET_SUBMATRIX=59,
1498d519adbfSMatthew Knepley                MATOP_DESTROY=60,
1499d519adbfSMatthew Knepley                MATOP_VIEW=61,
1500d519adbfSMatthew Knepley                MATOP_CONVERT_FROM=62,
1501d519adbfSMatthew Knepley                MATOP_USE_SCALED_FORM=63,
1502d519adbfSMatthew Knepley                MATOP_SCALE_SYSTEM=64,
1503d519adbfSMatthew Knepley                MATOP_UNSCALE_SYSTEM=65,
1504d519adbfSMatthew Knepley                MATOP_SET_LOCAL_TO_GLOBAL_MAP=66,
1505d519adbfSMatthew Knepley                MATOP_SET_VALUES_LOCAL=67,
1506d519adbfSMatthew Knepley                MATOP_ZERO_ROWS_LOCAL=68,
1507d519adbfSMatthew Knepley                MATOP_GET_ROW_MAX_ABS=69,
1508d519adbfSMatthew Knepley                MATOP_GET_ROW_MIN_ABS=70,
1509d519adbfSMatthew Knepley                MATOP_CONVERT=71,
1510d519adbfSMatthew Knepley                MATOP_SET_COLORING=72,
1511d519adbfSMatthew Knepley                MATOP_SET_VALUES_ADIC=73,
1512d519adbfSMatthew Knepley                MATOP_SET_VALUES_ADIFOR=74,
1513d519adbfSMatthew Knepley                MATOP_FD_COLORING_APPLY=75,
1514d519adbfSMatthew Knepley                MATOP_SET_FROM_OPTIONS=76,
1515d519adbfSMatthew Knepley                MATOP_MULT_CON=77,
1516d519adbfSMatthew Knepley                MATOP_MULT_TRANSPOSE_CON=78,
1517d519adbfSMatthew Knepley                MATOP_PERMUTE_SPARSIFY=79,
1518d519adbfSMatthew Knepley                MATOP_MULT_MULTIPLE=80,
1519d519adbfSMatthew Knepley                MATOP_SOLVE_MULTIPLE=81,
1520d519adbfSMatthew Knepley                MATOP_GET_INERTIA=82,
1521d519adbfSMatthew Knepley                MATOP_LOAD=83,
1522d519adbfSMatthew Knepley                MATOP_IS_SYMMETRIC=84,
1523d519adbfSMatthew Knepley                MATOP_IS_HERMITIAN=85,
1524d519adbfSMatthew Knepley                MATOP_IS_STRUCTURALLY_SYMMETRIC=86,
152541f059aeSBarry Smith                MATOP_DUMMY=87,
1526d519adbfSMatthew Knepley                MATOP_GET_VECS=88,
1527d519adbfSMatthew Knepley                MATOP_MAT_MULT=89,
1528d519adbfSMatthew Knepley                MATOP_MAT_MULT_SYMBOLIC=90,
1529d519adbfSMatthew Knepley                MATOP_MAT_MULT_NUMERIC=91,
1530d519adbfSMatthew Knepley                MATOP_PTAP=92,
1531d519adbfSMatthew Knepley                MATOP_PTAP_SYMBOLIC=93,
1532d519adbfSMatthew Knepley                MATOP_PTAP_NUMERIC=94,
1533d519adbfSMatthew Knepley                MATOP_MAT_MULTTRANSPOSE=95,
15341763ac4eSSatish Balay                MATOP_MAT_MULTTRANSPOSE_SYM=96,
15351763ac4eSSatish Balay                MATOP_MAT_MULTTRANSPOSE_NUM=97,
1536d519adbfSMatthew Knepley                MATOP_PTAP_SYMBOLIC_SEQAIJ=98,
1537d519adbfSMatthew Knepley                MATOP_PTAP_NUMERIC_SEQAIJ=99,
1538d519adbfSMatthew Knepley                MATOP_PTAP_SYMBOLIC_MPIAIJ=100,
1539d519adbfSMatthew Knepley                MATOP_PTAP_NUMERIC_MPIAIJ=101,
1540d519adbfSMatthew Knepley                MATOP_CONJUGATE=102,
1541d519adbfSMatthew Knepley                MATOP_SET_SIZES=103,
1542d519adbfSMatthew Knepley                MATOP_SET_VALUES_ROW=104,
1543d519adbfSMatthew Knepley                MATOP_REAL_PART=105,
1544d519adbfSMatthew Knepley                MATOP_IMAG_PART=106,
1545d519adbfSMatthew Knepley                MATOP_GET_ROW_UTRIANGULAR=107,
1546d519adbfSMatthew Knepley                MATOP_RESTORE_ROW_UTRIANGULAR=108,
1547d519adbfSMatthew Knepley                MATOP_MATSOLVE=109,
1548d519adbfSMatthew Knepley                MATOP_GET_REDUNDANTMATRIX=110,
1549d519adbfSMatthew Knepley                MATOP_GET_ROW_MIN=111,
1550d519adbfSMatthew Knepley                MATOP_GET_COLUMN_VEC=112,
1551d519adbfSMatthew Knepley                MATOP_MISSING_DIAGONAL=113,
1552d519adbfSMatthew Knepley                MATOP_MATGETSEQNONZEROSTRUCTURE=114,
155389c6957cSBarry Smith                MATOP_CREATE=115,
155489c6957cSBarry Smith                MATOP_GET_GHOSTS=116,
1555eeffb40dSHong Zhang                MATOP_MULT_DIAGONAL_BLOCK=119,
1556547795f9SHong Zhang                MATOP_HERMITIANTRANSPOSE=120,
1557547795f9SHong Zhang                MATOP_MULTHERMITIANTRANSPOSE=121,
1558fbdbba38SShri Abhyankar                MATOP_MULTHERMITIANTRANSPOSEADD=122,
1559d6037b41SHong Zhang 	       MATOP_GETMULTIPROCBLOCK=123,
1560fae171e0SBarry Smith              } MatOperation;
1561be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscTruth*);
1562be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void));
1563be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void));
1564be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*);
1565112a2221SBarry Smith 
156690ace30eSBarry Smith /*
156790ace30eSBarry Smith    Codes for matrices stored on disk. By default they are
156890ace30eSBarry Smith    stored in a universal format. By changing the format with
15697973ad04SBarry Smith    PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
157090ace30eSBarry Smith    be stored in a way natural for the matrix, for example dense matrices
157190ace30eSBarry Smith    would be stored as dense. Matrices stored this way may only be
1572f4403165SShri Abhyankar    read into matrices of the same type.
157390ace30eSBarry Smith */
157490ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1
157590ace30eSBarry Smith 
1576be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1577be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*);
15781f4e1ec7SBarry Smith 
1579d9274352SBarry Smith /*S
1580d9274352SBarry Smith      MatNullSpace - Object that removes a null space from a vector, i.e.
1581d9274352SBarry Smith          orthogonalizes the vector to a subsapce
1582d9274352SBarry Smith 
1583f7a9e4ceSBarry Smith    Level: advanced
1584d9274352SBarry Smith 
1585d9274352SBarry Smith   Concepts: matrix; linear operator, null space
1586d9274352SBarry Smith 
15876e1639daSBarry Smith   Users manual sections:
15886e1639daSBarry Smith .   sec_singular
15896e1639daSBarry Smith 
1590d9274352SBarry Smith .seealso:  MatNullSpaceCreate()
1591d9274352SBarry Smith S*/
159274637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace;
1593d9274352SBarry Smith 
1594be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*);
1595b22b330cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1596be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace);
1597be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1598be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace);
159995902228SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat,PetscTruth *);
160074637425SBarry Smith 
1601be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS);
1602be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1603be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
160446129b97SKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat);
16053f1d51d7SBarry Smith 
1606be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*);
1607be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*);
1608be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*);
1609c4f061fbSSatish Balay 
1610be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*);
1611b0a32e0cSBarry Smith 
1612be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec);
161304f1ad80SBarry Smith 
1614fef1beadSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
16153ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetBase(Mat,Vec,Vec);
16163ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1617e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1618e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1619e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDAddNullSpace(Mat,MatNullSpace);
1620e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1621e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDResetHHistory(Mat);
1622e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctionError(Mat,PetscReal);
1623e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetPeriod(Mat,PetscInt);
1624e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDGetH(Mat,PetscScalar *);
16256aa9148fSLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetOptionsPrefix(Mat,const char[]);
1626e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFromOptions(Mat);
1627e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1628e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);
1629e884886fSBarry Smith 
16306370053bSBarry Smith /*S
16316370053bSBarry Smith     MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free
16326370053bSBarry Smith               Jacobian vector products
1633e884886fSBarry Smith 
16346370053bSBarry Smith     Notes: MATMFFD is a specific MatType which uses the MatMFFD data structure
16356370053bSBarry Smith 
16366370053bSBarry Smith            MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure
16376370053bSBarry Smith 
16386370053bSBarry Smith     Level: developer
16396370053bSBarry Smith 
16406370053bSBarry Smith .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
16416370053bSBarry Smith S*/
1642e884886fSBarry Smith typedef struct _p_MatMFFD* MatMFFD;
1643e884886fSBarry Smith 
1644e884886fSBarry Smith /*E
1645e884886fSBarry Smith     MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function
1646e884886fSBarry Smith 
1647e884886fSBarry Smith    Level: beginner
1648e884886fSBarry Smith 
1649e884886fSBarry Smith .seealso: MatMFFDSetType(), MatMFFDRegister()
1650e884886fSBarry Smith E*/
1651a313700dSBarry Smith #define MatMFFDType char*
1652e884886fSBarry Smith #define MATMFFD_DS  "ds"
1653e884886fSBarry Smith #define MATMFFD_WP  "wp"
1654e884886fSBarry Smith 
1655a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetType(Mat,const MatMFFDType);
1656e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatMFFD));
1657e884886fSBarry Smith 
1658e884886fSBarry Smith /*MC
1659e884886fSBarry Smith    MatMFFDRegisterDynamic - Adds a method to the MatMFFD registry.
1660e884886fSBarry Smith 
1661e884886fSBarry Smith    Synopsis:
16621890ba74SBarry Smith    PetscErrorCode MatMFFDRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatMFFD))
1663e884886fSBarry Smith 
1664e884886fSBarry Smith    Not Collective
1665e884886fSBarry Smith 
1666e884886fSBarry Smith    Input Parameters:
1667e884886fSBarry Smith +  name_solver - name of a new user-defined compute-h module
1668e884886fSBarry Smith .  path - path (either absolute or relative) the library containing this solver
1669e884886fSBarry Smith .  name_create - name of routine to create method context
1670e884886fSBarry Smith -  routine_create - routine to create method context
1671e884886fSBarry Smith 
1672e884886fSBarry Smith    Level: developer
1673e884886fSBarry Smith 
1674e884886fSBarry Smith    Notes:
1675e884886fSBarry Smith    MatMFFDRegisterDynamic() may be called multiple times to add several user-defined solvers.
1676e884886fSBarry Smith 
1677e884886fSBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
1678e884886fSBarry Smith    is ignored.
1679e884886fSBarry Smith 
1680e884886fSBarry Smith    Sample usage:
1681e884886fSBarry Smith .vb
1682e884886fSBarry Smith    MatMFFDRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a,
1683e884886fSBarry Smith                "MyHCreate",MyHCreate);
1684e884886fSBarry Smith .ve
1685e884886fSBarry Smith 
1686e884886fSBarry Smith    Then, your solver can be chosen with the procedural interface via
1687e884886fSBarry Smith $     MatMFFDSetType(mfctx,"my_h")
1688e884886fSBarry Smith    or at runtime via the option
1689e884886fSBarry Smith $     -snes_mf_type my_h
1690e884886fSBarry Smith 
1691e884886fSBarry Smith .keywords: MatMFFD, register
1692e884886fSBarry Smith 
1693e884886fSBarry Smith .seealso: MatMFFDRegisterAll(), MatMFFDRegisterDestroy()
1694e884886fSBarry Smith M*/
1695e884886fSBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1696e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,0)
1697e884886fSBarry Smith #else
1698e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,d)
1699e884886fSBarry Smith #endif
1700e884886fSBarry Smith 
1701e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterAll(const char[]);
1702e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterDestroy(void);
17031d0fab5eSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDDSSetUmin(Mat,PetscReal);
1704e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDWPSetComputeNormU(Mat,PetscTruth);
1705e884886fSBarry Smith 
1706e884886fSBarry Smith 
1707be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1708be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
17097dbadf16SMatthew Knepley 
171097969023SHong Zhang /*
171197969023SHong Zhang    PETSc interface to MUMPS
171297969023SHong Zhang */
171397969023SHong Zhang #ifdef PETSC_HAVE_MUMPS
1714a1f19f5aSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetMumpsIcntl(Mat,PetscInt,PetscInt);
171597969023SHong Zhang #endif
171623a5497aSJed Brown 
171723a5497aSJed Brown PETSC_EXTERN_CXX_END
171823a5497aSJed Brown #endif
1719