xref: /petsc/include/petscmat.h (revision 2b40b63f2d83c74feb0a2167f386cf143c8f6e2d)
12eac72dbSBarry Smith /*
22eac72dbSBarry Smith      Include file for the matrix component of PETSc
32eac72dbSBarry Smith */
40a835dfdSSatish Balay #ifndef __PETSCMAT_H
50a835dfdSSatish Balay #define __PETSCMAT_H
60a835dfdSSatish Balay #include "petscvec.h"
7e9fa29b7SSatish Balay PETSC_EXTERN_CXX_BEGIN
82eac72dbSBarry Smith 
9d9274352SBarry Smith /*S
10d9274352SBarry Smith      Mat - Abstract PETSc matrix object
112eac72dbSBarry Smith 
12d91e6319SBarry Smith    Level: beginner
13d91e6319SBarry Smith 
14d9274352SBarry Smith   Concepts: matrix; linear operator
15d9274352SBarry Smith 
16d9274352SBarry Smith .seealso:  MatCreate(), MatType, MatSetType()
17d9274352SBarry Smith S*/
18d9274352SBarry Smith typedef struct _p_Mat*           Mat;
19d9274352SBarry Smith 
20d9274352SBarry Smith /*E
21d9274352SBarry Smith     MatType - String with the name of a PETSc matrix or the creation function
22d9274352SBarry Smith        with an optional dynamic library name, for example
23d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:mymatcreate()
24d9274352SBarry Smith 
25d9274352SBarry Smith    Level: beginner
26d9274352SBarry Smith 
27c7393fdbSBarry Smith .seealso: MatSetType(), Mat, MatSolverPackage
28d91e6319SBarry Smith E*/
29a313700dSBarry Smith #define MatType char*
30273d9f13SBarry Smith #define MATSAME            "same"
315a11e1b2SBarry Smith #define MATMAIJ            "maij"
32273d9f13SBarry Smith #define MATSEQMAIJ           "seqmaij"
33273d9f13SBarry Smith #define MATMPIMAIJ           "mpimaij"
34273d9f13SBarry Smith #define MATIS              "is"
355a11e1b2SBarry Smith #define MATAIJ             "aij"
36273d9f13SBarry Smith #define MATSEQAIJ            "seqaij"
37273d9f13SBarry Smith #define MATMPIAIJ            "mpiaij"
385a11e1b2SBarry Smith #define MATAIJCRL              "aijcrl"
395a11e1b2SBarry Smith #define MATSEQAIJCRL             "seqaijcrl"
405a11e1b2SBarry Smith #define MATMPIAIJCRL             "mpiaijcrl"
415a11e1b2SBarry Smith #define MATAIJCUDA             "aijcuda"
425a11e1b2SBarry Smith #define MATSEQAIJCUDA            "seqaijcuda"
435a11e1b2SBarry Smith #define MATMPIAIJCUDA            "mpiaijcuda"
445a11e1b2SBarry Smith #define MATAIJPERM             "aijperm"
455a11e1b2SBarry Smith #define MATSEQAIJPERM            "seqaijperm"
465a11e1b2SBarry Smith #define MATMPIAIJPERM            "mpiaijperm"
47273d9f13SBarry Smith #define MATSHELL           "shell"
485a11e1b2SBarry Smith #define MATDENSE           "dense"
49209238afSKris Buschelman #define MATSEQDENSE          "seqdense"
50273d9f13SBarry Smith #define MATMPIDENSE          "mpidense"
515a11e1b2SBarry Smith #define MATBAIJ            "baij"
52273d9f13SBarry Smith #define MATSEQBAIJ           "seqbaij"
53273d9f13SBarry Smith #define MATMPIBAIJ           "mpibaij"
54273d9f13SBarry Smith #define MATMPIADJ          "mpiadj"
555a11e1b2SBarry Smith #define MATSBAIJ           "sbaij"
56273d9f13SBarry Smith #define MATSEQSBAIJ          "seqsbaij"
57273d9f13SBarry Smith #define MATMPISBAIJ          "mpisbaij"
58cebc7f6cSBarry Smith #define MATDAAD            "daad"
59cebc7f6cSBarry Smith #define MATMFFD            "mffd"
60c8a8475eSBarry Smith #define MATNORMAL          "normal"
61ab92ecdeSBarry Smith #define MATLRC             "lrc"
622a6744ebSBarry Smith #define MATSCATTER         "scatter"
63421e10b8SBarry Smith #define MATBLOCKMAT        "blockmat"
64793850ffSBarry Smith #define MATCOMPOSITE       "composite"
655a7f1df3SHong Zhang #define MATSEQFFTW         "seqfftw"
66e133240eSMatthew G Knepley #define MATSEQCUFFT        "seqcufft"
67557cca28SSatish Balay #define MATTRANSPOSEMAT    "transpose"
6872ca8751SBarry Smith #define MATSCHURCOMPLEMENT "schurcomplement"
691d6018f0SLisandro Dalcin #define MATPYTHON          "python"
70f91d8e95SBarry Smith #define MATHYPRESTRUCT     "hyprestruct"
71a9e6138eSGlenn Hammond #define MATHYPRESSTRUCT    "hypresstruct"
72ee1cef2cSJed Brown #define MATSUBMATRIX       "submatrix"
73dbc6227fSDmitry Karpeev #define MATDD              "matdd"
74ba2f8784SDmitry Karpeev #define MATIM              "matim"
75ba2f8784SDmitry Karpeev 
76773941d6SBarry Smith 
779989ab13SBarry Smith /*E
78c7393fdbSBarry Smith     MatSolverPackage - String with the name of a PETSc matrix solver type.
799989ab13SBarry Smith 
809989ab13SBarry Smith     For example: "petsc" indicates what PETSc provides, "superlu" indicates either
819989ab13SBarry Smith        SuperLU or SuperLU_Dist etc.
829989ab13SBarry Smith 
839989ab13SBarry Smith 
849989ab13SBarry Smith    Level: beginner
859989ab13SBarry Smith 
865c9eb25fSBarry Smith .seealso: MatGetFactor(), Mat, MatSetType(), MatType
879989ab13SBarry Smith E*/
88c7393fdbSBarry Smith #define MatSolverPackage char*
892692d6eeSBarry Smith #define MATSOLVERSPOOLES      "spooles"
902692d6eeSBarry Smith #define MATSOLVERSUPERLU      "superlu"
912692d6eeSBarry Smith #define MATSOLVERSUPERLU_DIST "superlu_dist"
922692d6eeSBarry Smith #define MATSOLVERUMFPACK      "umfpack"
9320db9a53SJed Brown #define MATSOLVERCHOLMOD      "cholmod"
942692d6eeSBarry Smith #define MATSOLVERESSL         "essl"
952692d6eeSBarry Smith #define MATSOLVERLUSOL        "lusol"
962692d6eeSBarry Smith #define MATSOLVERMUMPS        "mumps"
972692d6eeSBarry Smith #define MATSOLVERPASTIX       "pastix"
982692d6eeSBarry Smith #define MATSOLVERDSCPACK      "dscpack"
992692d6eeSBarry Smith #define MATSOLVERMATLAB       "matlab"
1002692d6eeSBarry Smith #define MATSOLVERPETSC        "petsc"
1012692d6eeSBarry Smith #define MATSOLVERPLAPACK      "plapack"
1022692d6eeSBarry Smith #define MATSOLVERBAS          "bas"
103773941d6SBarry Smith 
104b24902e0SBarry Smith /*E
105b24902e0SBarry Smith     MatFactorType - indicates what type of factorization is requested
106b24902e0SBarry Smith 
107b24902e0SBarry Smith     Level: beginner
108b24902e0SBarry Smith 
109b24902e0SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
110b24902e0SBarry Smith 
111c7393fdbSBarry Smith .seealso: MatSolverPackage, MatGetFactor()
112b24902e0SBarry Smith E*/
113599ef60dSHong Zhang typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType;
11434918c53SJed Brown extern const char *const MatFactorTypes[];
115e92e720dSBarry Smith 
116c7393fdbSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactor(Mat,const MatSolverPackage,MatFactorType,Mat*);
117ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactorAvailable(Mat,const MatSolverPackage,MatFactorType,PetscBool *);
11835bd34faSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorGetSolverPackage(Mat,const MatSolverPackage*);
1196335c336SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactorType(Mat,MatFactorType*);
1209989ab13SBarry Smith 
121c06d978dSMatthew Knepley /* Logging support */
1220700a824SBarry Smith #define    MAT_FILE_CLASSID 1211216    /* used to indicate matrices in binary files */
1230700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_CLASSID;
1240700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_FDCOLORING_CLASSID;
1250700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_PARTITIONING_CLASSID;
1260700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_NULLSPACE_CLASSID;
1270700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MATMFFD_CLASSID;
128c06d978dSMatthew Knepley 
129ceb03754SKris Buschelman /*E
130ceb03754SKris Buschelman     MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
131ceb03754SKris Buschelman      or MatGetSubMatrix() are to be reused to store the new matrix values.
132ceb03754SKris Buschelman 
133ceb03754SKris Buschelman     Level: beginner
134ceb03754SKris Buschelman 
135ceb03754SKris Buschelman    Any additions/changes here MUST also be made in include/finclude/petscmat.h
136ceb03754SKris Buschelman 
1370c451bc4SBarry Smith .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
138ceb03754SKris Buschelman E*/
139dfe085dbSJed Brown typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX} MatReuse;
140ceb03754SKris Buschelman 
1415494a064SHong Zhang /*E
1425494a064SHong Zhang     MatGetSubMatrixOption - Indicates if matrices obtained from a call to MatGetSubMatrices()
143829201f2SHong Zhang      include the matrix values. Currently it is only used by MatGetSeqNonzerostructure().
1445494a064SHong Zhang 
1455494a064SHong Zhang     Level: beginner
1465494a064SHong Zhang 
147829201f2SHong Zhang .seealso: MatGetSeqNonzerostructure()
1485494a064SHong Zhang E*/
1495494a064SHong Zhang typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatGetSubMatrixOption;
1505494a064SHong Zhang 
151e5bd5246SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(const char[]);
152c06d978dSMatthew Knepley 
153f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreate(MPI_Comm,Mat*);
154a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(MPI_Comm comm),(comm,&A),Mat,A)
155a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(),(PETSC_COMM_WORLD,&A),Mat,A)
156f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
157a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat,const MatType);
158be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetFromOptions(Mat);
159be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUpPreallocation(Mat);
160be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]);
161be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat));
16230de9b25SBarry Smith 
163f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOptionsPrefix(Mat,const char[]);
164f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAppendOptionsPrefix(Mat,const char[]);
165f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOptionsPrefix(Mat,const char*[]);
166f69a0ea3SMatthew Knepley 
16730de9b25SBarry Smith /*MC
16830de9b25SBarry Smith    MatRegisterDynamic - Adds a new matrix type
16930de9b25SBarry Smith 
17030de9b25SBarry Smith    Synopsis:
1711890ba74SBarry Smith    PetscErrorCode MatRegisterDynamic(const char *name,const char *path,const char *name_create,PetscErrorCode (*routine_create)(Mat))
17230de9b25SBarry Smith 
17330de9b25SBarry Smith    Not Collective
17430de9b25SBarry Smith 
17530de9b25SBarry Smith    Input Parameters:
17630de9b25SBarry Smith +  name - name of a new user-defined matrix type
17730de9b25SBarry Smith .  path - path (either absolute or relative) the library containing this solver
17830de9b25SBarry Smith .  name_create - name of routine to create method context
17930de9b25SBarry Smith -  routine_create - routine to create method context
18030de9b25SBarry Smith 
18130de9b25SBarry Smith    Notes:
18230de9b25SBarry Smith    MatRegisterDynamic() may be called multiple times to add several user-defined solvers.
18330de9b25SBarry Smith 
18430de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
18530de9b25SBarry Smith    is ignored.
18630de9b25SBarry Smith 
18730de9b25SBarry Smith    Sample usage:
18830de9b25SBarry Smith .vb
18930de9b25SBarry Smith    MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a,
19030de9b25SBarry Smith                "MyMatCreate",MyMatCreate);
19130de9b25SBarry Smith .ve
19230de9b25SBarry Smith 
19330de9b25SBarry Smith    Then, your solver can be chosen with the procedural interface via
19430de9b25SBarry Smith $     MatSetType(Mat,"my_mat")
19530de9b25SBarry Smith    or at runtime via the option
19630de9b25SBarry Smith $     -mat_type my_mat
19730de9b25SBarry Smith 
19830de9b25SBarry Smith    Level: advanced
19930de9b25SBarry Smith 
200ab901514SBarry Smith    Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
20130de9b25SBarry Smith          If your function is not being put into a shared library then use VecRegister() instead
20230de9b25SBarry Smith 
20330de9b25SBarry Smith .keywords: Mat, register
20430de9b25SBarry Smith 
20530de9b25SBarry Smith .seealso: MatRegisterAll(), MatRegisterDestroy()
20630de9b25SBarry Smith 
20730de9b25SBarry Smith M*/
208273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
209273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0)
210273d9f13SBarry Smith #else
211273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d)
21230de9b25SBarry Smith #endif
21330de9b25SBarry Smith 
214ace3abfcSBarry Smith extern PetscBool  MatRegisterAllCalled;
215b0a32e0cSBarry Smith extern PetscFList MatList;
216b022a5c1SBarry Smith extern PetscFList MatColoringList;
217b022a5c1SBarry Smith extern PetscFList MatPartitioningList;
21828988994SBarry Smith 
2193b224e63SBarry Smith /*E
2203b224e63SBarry Smith     MatStructure - Indicates if the matrix has the same nonzero structure
2213b224e63SBarry Smith 
2223b224e63SBarry Smith     Level: beginner
2233b224e63SBarry Smith 
2243b224e63SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
2253b224e63SBarry Smith 
2263b224e63SBarry Smith .seealso: MatCopy(), KSPSetOperators(), PCSetOperators()
2273b224e63SBarry Smith E*/
2283b224e63SBarry Smith typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure;
2293b224e63SBarry Smith 
230be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
231be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
232be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
233ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A)
234ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A)
235ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A)
236ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A)
237ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A))
238ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A))
239ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A))
240be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
241ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(comm,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
242ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(comm,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
243ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(comm,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
244ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(comm,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
245ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(comm,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
246ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(comm,m,n,M,N,0,nnz,0,onz,A))
247ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(comm,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
248ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(PETSC_COMM_WORLD,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
249ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(PETSC_COMM_WORLD,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
250ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(PETSC_COMM_WORLD,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
251ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N),(PETSC_COMM_WORLD,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
252ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(PETSC_COMM_WORLD,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
253ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(PETSC_COMM_WORLD,m,n,M,N,0,nnz,0,onz,A))
254ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(PETSC_COMM_WORLD,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
25563ab93bfSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
2568d7a6e47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
2578d7a6e47SBarry Smith 
258be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
259ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A)
260ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
261ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
262ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
263ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
264ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
265ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
266be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
267ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(comm,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
268ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
269ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(comm,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
270ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
271ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
272ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(comm,bs,m,n,M,N,0,nnz,0,onz,A))
273ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
274ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
275ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
276ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
277ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
278ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
279ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,A))
280ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
281d21a29f3SJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*);
282d21a29f3SJed Brown 
283be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
284be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
285ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A)
286ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
287ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
288ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
289ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
290ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
291ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
292d21a29f3SJed Brown 
293be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
294ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(comm,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
295ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
296ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(comm,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
297ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
298ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
299ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(comm,bs,m,n,M,N,0,nnz,0,onz,A))
300ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
301ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
302ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
303ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
304ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
305ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
306ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,A))
307ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
308dfb205c3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
309dfb205c3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
310dfb205c3SBarry Smith 
311be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
312ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(comm,m,n,M,N,ctx,&A),Mat,A)
313ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A)
314be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*);
315be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateNormal(Mat,Mat*);
316ba966639SSatish Balay PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A)
317ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateLRC(Mat,Mat,Mat,Mat*);
318284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*);
3195a11e1b2SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
3205a11e1b2SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
3212a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateScatter(MPI_Comm,VecScatter,Mat*);
3222a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterSetVecScatter(Mat,VecScatter);
3232a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterGetVecScatter(Mat,VecScatter*);
3248cdf2d9bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
325793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeAddMat(Mat,Mat);
326b52f573bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeMerge(Mat);
327793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
3286d7c1e57SBarry Smith typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
3296d7c1e57SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeSetType(Mat,MatCompositeType);
3306d7c1e57SBarry Smith 
331dbc6227fSDmitry Karpeev typedef enum {MATDD_BLOCK_COMM_DEFAULT = 0, MATDD_BLOCK_COMM_SELF = -1, MATDD_BLOCK_COMM_DETERMINE = -2} MatDDBlockCommType;
332dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDAIJSetPreallocation(Mat A,PetscInt nz,PetscInt *nnz);
333dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDGetDefaltBlockType(Mat A, const MatType *type);
334dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetDefaltBlockType(Mat A, const MatType type);
335dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetPreallocation_AIJ(Mat A,PetscInt nz,PetscInt *nnz);
336dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDAddBlock(Mat A, PetscInt rowblock, PetscInt colblock, const MatType blockmattype,  MatDDBlockCommType blockcommtype, Mat *block);
337dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetBlock(Mat A, PetscInt rowblock, PetscInt colblock, Mat block);
338dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDGetBlock(Mat A, PetscInt rowblock, PetscInt colblock, Mat *block);
339dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetScatters(Mat A, PetscInt blockcount, Mat scatters[]);
340dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetGathers(Mat A, PetscInt blockcount,  Mat gathers[]);
34162ee7b53SDmitry Karpeev 
342ba2f8784SDmitry Karpeev #if defined PETSC_HAVE_MATIM
343ba2f8784SDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIMSetIS(Mat A, IS in, IS out);
344ba2f8784SDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIMGetIS(Mat A, IS *in, IS *out);
345ba2f8784SDmitry Karpeev #endif
346ba2f8784SDmitry Karpeev 
347ba2f8784SDmitry Karpeev 
348a6a5cd3fSDmitry Karpeev 
3495a7f1df3SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqFFTW(MPI_Comm,PetscInt,const PetscInt[],Mat*);
350e133240eSMatthew G Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqCUFFT(MPI_Comm,PetscInt,const PetscInt[],Mat*);
351f20085c4SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateTranspose(Mat,Mat*);
352ee1cef2cSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSubMatrix(Mat,IS,IS,Mat*);
353ee1cef2cSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSubMatrixUpdate(Mat,Mat,IS,IS);
3541472f72bSBarry Smith 
3551d6018f0SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreatePython(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const char[],Mat*);
3561d6018f0SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPythonSetType(Mat,const char[]);
3571d6018f0SLisandro Dalcin 
3581d6018f0SLisandro Dalcin 
359f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUp(Mat);
360be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat);
36121c89e3eSBarry Smith 
3620c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat);
36399cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRealPart(Mat);
36499cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatImaginaryPart(Mat);
365ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonalBlock(Mat,PetscBool *,MatReuse,Mat*);
366fe97e370SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetTrace(Mat,PetscScalar*);
36799cafbc1SBarry Smith 
3688ed539a5SBarry Smith /* ------------------------------------------------------------*/
369be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
370be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
37187d4246cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
372f259bd47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
37384cb2905SBarry Smith 
3742ef4de8bSBarry Smith /*S
3752ef4de8bSBarry Smith      MatStencil - Data structure (C struct) for storing information about a single row or
3762ef4de8bSBarry Smith         column of a matrix as index on an associated grid.
3772ef4de8bSBarry Smith 
3782ef4de8bSBarry Smith    Level: beginner
3792ef4de8bSBarry Smith 
3802ef4de8bSBarry Smith   Concepts: matrix; linear operator
3812ef4de8bSBarry Smith 
382d7bd93baSBarry Smith .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil()
3832ef4de8bSBarry Smith S*/
384435da068SBarry Smith typedef struct {
385c1ac3661SBarry Smith   PetscInt k,j,i,c;
386435da068SBarry Smith } MatStencil;
3872ef4de8bSBarry Smith 
388be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
389be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
390be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
391435da068SBarry Smith 
392be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat,ISColoring);
393be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat,void*);
394be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat,PetscInt,void*);
3953a7fca6bSBarry Smith 
396d91e6319SBarry Smith /*E
397d91e6319SBarry Smith     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
398d91e6319SBarry Smith      to continue to add values to it
399d91e6319SBarry Smith 
400d91e6319SBarry Smith     Level: beginner
401d91e6319SBarry Smith 
402d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd()
403d91e6319SBarry Smith E*/
4046d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
405be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat,MatAssemblyType);
406be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat,MatAssemblyType);
407ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat,PetscBool *);
4084f9c727eSBarry Smith 
4091d73ed98SBarry Smith 
41030de9b25SBarry Smith 
411d91e6319SBarry Smith /*E
412d91e6319SBarry Smith     MatOption - Options that may be set for a matrix and its behavior or storage
413d91e6319SBarry Smith 
414d91e6319SBarry Smith     Level: beginner
415d91e6319SBarry Smith 
4160a835dfdSSatish Balay    Any additions/changes here MUST also be made in include/finclude/petscmat.h
417d91e6319SBarry Smith 
418d91e6319SBarry Smith .seealso: MatSetOption()
419d91e6319SBarry Smith E*/
420512a5fc5SBarry Smith typedef enum {MAT_ROW_ORIENTED,MAT_NEW_NONZERO_LOCATIONS,
4214e0d8c25SBarry Smith               MAT_SYMMETRIC,
4224e0d8c25SBarry Smith               MAT_STRUCTURALLY_SYMMETRIC,
4238047e77bSBarry Smith               MAT_NEW_DIAGONALS,MAT_IGNORE_OFF_PROC_ENTRIES,
4244e0d8c25SBarry Smith               MAT_NEW_NONZERO_LOCATION_ERR,
4254e0d8c25SBarry Smith               MAT_NEW_NONZERO_ALLOCATION_ERR,MAT_USE_HASH_TABLE,
426a9817697SBarry Smith               MAT_KEEP_NONZERO_PATTERN,MAT_IGNORE_ZERO_ENTRIES,
4274e0d8c25SBarry Smith               MAT_USE_INODES,
4284e0d8c25SBarry Smith               MAT_HERMITIAN,
4294e0d8c25SBarry Smith               MAT_SYMMETRY_ETERNAL,
4304e0d8c25SBarry Smith               MAT_USE_COMPRESSEDROW,
4314e0d8c25SBarry Smith               MAT_IGNORE_LOWER_TRIANGULAR,MAT_ERROR_LOWER_TRIANGULAR,
43228b2fa4aSMatthew Knepley               MAT_GETROW_UPPERTRIANGULAR,MAT_UNUSED_NONZERO_LOCATION_ERR,
4334cb17eb5SBarry Smith               MAT_SPD,MAT_NO_OFF_PROC_ENTRIES,MAT_NO_OFF_PROC_ZERO_ROWS,
43428b2fa4aSMatthew Knepley               NUM_MAT_OPTIONS} MatOption;
435290bbb0aSBarry Smith extern const char *MatOptions[];
436ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption,PetscBool );
437a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,const MatType*);
438a313700dSBarry Smith PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),const MatType,t)
43984cb2905SBarry Smith 
440be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
441be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
442be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
443f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowUpperTriangular(Mat);
444f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowUpperTriangular(Mat);
445be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
446be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
447be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt);
448be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]);
449ba966639SSatish Balay PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a)
450be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]);
451be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *);
452ba966639SSatish Balay PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a)
453be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt);
4547b80b807SBarry Smith 
4551620fd73SBarry Smith 
456be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec);
45789c6957cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultDiagonalBlock(Mat,Vec,Vec);
458be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec);
459ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
460be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec);
461547795f9SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultHermitianTranspose(Mat,Vec,Vec);
462ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscBool *);
463ace3abfcSBarry Smith PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscBool ,t)
464ace3abfcSBarry Smith PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0,&t),PetscBool ,t)
465ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *);
466be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec);
4675cb05578SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
468ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
469be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec);
470be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec);
4712bebee5dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatSolve(Mat,Mat,Mat);
472f5edf698SHong Zhang 
473d91e6319SBarry Smith /*E
474d91e6319SBarry Smith     MatDuplicateOption - Indicates if a duplicated sparse matrix should have
475d91e6319SBarry Smith   its numerical values copied over or just its nonzero structure.
476d91e6319SBarry Smith 
477d91e6319SBarry Smith     Level: beginner
478d91e6319SBarry Smith 
479d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
480d91e6319SBarry Smith 
48170dcbbb9SBarry Smith $   MAT_SHARE_NONZERO_PATTERN - the i and j arrays in the new matrix will be shared with the original matrix
48270dcbbb9SBarry Smith $                               this also triggers the MAT_DO_NOT_COPY_VALUES option. This is used when you
48370dcbbb9SBarry Smith $                               have several matrices with the same nonzero pattern.
48470dcbbb9SBarry Smith 
485d91e6319SBarry Smith .seealso: MatDuplicate()
486d91e6319SBarry Smith E*/
48770dcbbb9SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;
4882e8a6d31SBarry Smith 
489a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat,const MatType,MatReuse,Mat*);
490a313700dSBarry Smith PetscPolymorphicFunction(MatConvert,(Mat A,const MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a)
491be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat,MatDuplicateOption,Mat*);
492ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a)
493ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a)
49494a9d846SBarry Smith 
495cb5b572fSBarry Smith 
496be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat,Mat,MatStructure);
497be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat,PetscViewer);
498ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat,PetscReal,PetscBool *);
499ace3abfcSBarry Smith PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscBool ,t)
500ace3abfcSBarry Smith PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0,&t),PetscBool ,t)
501ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscBool *);
502ace3abfcSBarry Smith PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscBool ,t)
503ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscReal,PetscBool *);
504ace3abfcSBarry Smith PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,0,&t),PetscBool ,t)
505ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *);
506ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat,PetscBool *,PetscBool *);
507ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMissingDiagonal(Mat,PetscBool  *,PetscInt *);
508112444f4SShri Abhyankar EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoad(Mat, PetscViewer);
5097b80b807SBarry Smith 
510ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,PetscInt *[],PetscInt *[],PetscBool  *);
511ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,PetscInt *[],PetscInt *[],PetscBool  *);
512ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,PetscInt *[],PetscInt *[],PetscBool  *);
513ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,PetscInt *[],PetscInt *[],PetscBool  *);
514d4fbbf0eSBarry Smith 
515d91e6319SBarry Smith /*S
516d91e6319SBarry Smith      MatInfo - Context of matrix information, used with MatGetInfo()
517d91e6319SBarry Smith 
518d91e6319SBarry Smith    In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
519d91e6319SBarry Smith 
520d91e6319SBarry Smith    Level: intermediate
521d91e6319SBarry Smith 
522d91e6319SBarry Smith   Concepts: matrix^nonzero information
523d91e6319SBarry Smith 
524d9274352SBarry Smith .seealso:  MatGetInfo(), MatInfoType
525d91e6319SBarry Smith S*/
5264e220ebcSLois Curfman McInnes typedef struct {
527b0a32e0cSBarry Smith   PetscLogDouble block_size;                         /* block size */
528b0a32e0cSBarry Smith   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
529b0a32e0cSBarry Smith   PetscLogDouble memory;                             /* memory allocated */
530b0a32e0cSBarry Smith   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
531b0a32e0cSBarry Smith   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
532b0a32e0cSBarry Smith   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
533b0a32e0cSBarry Smith   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
5344e220ebcSLois Curfman McInnes } MatInfo;
5354e220ebcSLois Curfman McInnes 
536d9274352SBarry Smith /*E
537d9274352SBarry Smith     MatInfoType - Indicates if you want information about the local part of the matrix,
538d9274352SBarry Smith      the entire parallel matrix or the maximum over all the local parts.
539d9274352SBarry Smith 
540d9274352SBarry Smith     Level: beginner
541d9274352SBarry Smith 
542d9274352SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
543d9274352SBarry Smith 
544d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo
545d9274352SBarry Smith E*/
5467b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
547be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat,MatInfoType,MatInfo*);
548be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat,Vec);
549985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec,PetscInt[]);
550985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMin(Mat,Vec,PetscInt[]);
551985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
552c87e5d42SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMinAbs(Mat,Vec,PetscInt[]);
55386697f06SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowSum(Mat,Vec);
554fc4dec0aSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,MatReuse,Mat*);
555fc4dec0aSBarry Smith PetscPolymorphicFunction(MatTranspose,(Mat A),(A,MAT_INITIAL_MATRIX,&t),Mat,t)
556eeffb40dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHermitianTranspose(Mat,MatReuse,Mat*);
557be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *);
558ba966639SSatish Balay PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t)
559be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *);
560be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec);
561be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode);
562ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscBool *);
563ace3abfcSBarry Smith PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscBool ,t)
564ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscBool *);
565ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscBool *);
566ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool *);
567ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool *);
5687b80b807SBarry Smith 
569be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *);
570ba966639SSatish Balay PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n)
571242f1d38SBarry Smith EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal *);
572be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat);
573*2b40b63fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
574*2b40b63fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec);
575*2b40b63fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec);
5766e169961SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
5776e169961SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec);
5787b80b807SBarry Smith 
579ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscBool );
580be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec);
581be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec);
5825ef9f2a5SBarry Smith 
583be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*);
584be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*);
585be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
5868ee2e534SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRanges(Mat,const PetscInt**);
587f4b8409dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
58872ca8751SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangesColumn(Mat,const PetscInt**);
5897b80b807SBarry Smith 
590be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
591be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]);
5924aa3045dSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,MatReuse,Mat *);
593f6d58c54SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSeqNonzeroStructure(Mat,Mat*);
594f6d58c54SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroySeqNonzeroStructure(Mat*);
5955494a064SHong Zhang 
596be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
597be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
598be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
599be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat);
600be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat);
601be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*);
602be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
603be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*);
6041d79065fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscInt**,MatScalar**,Mat*);
60543eb5e2fSMatthew Knepley #if defined (PETSC_USE_CTABLE)
606cd116e26SSatish Balay #include "petscctable.h"
60743eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *);
60843eb5e2fSMatthew Knepley #else
60943eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *);
61043eb5e2fSMatthew Knepley #endif
6118c7482ecSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);
6128efafbd8SBarry Smith 
613be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
6147b80b807SBarry Smith 
615be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
616be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
617be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat);
61822440eb1SKris Buschelman 
619be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
620be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
621be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat);
62222440eb1SKris Buschelman 
623be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*);
624be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*);
625be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat);
626bc011b1eSHong Zhang 
627f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure);
62804aac2b0SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat,MatStructure);
6291c741599SHong Zhang 
630f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar);
631f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar);
6327b80b807SBarry Smith 
633be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping);
634be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping);
635*2b40b63fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
636*2b40b63fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
637be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
638be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
639052efed2SBarry Smith 
640be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt);
641be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
64290f02eecSBarry Smith 
643be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec);
6440c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec);
645ba966639SSatish Balay PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
646be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec);
647be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*);
64869db28dcSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*);
649d6037b41SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetMultiProcBlock(Mat,MPI_Comm,Mat*);
650bd481603SBarry Smith 
651bd481603SBarry Smith /*MC
6521620fd73SBarry Smith    MatSetValue - Set a single entry into a matrix.
6531620fd73SBarry Smith 
6541620fd73SBarry Smith    Not collective
6551620fd73SBarry Smith 
6561620fd73SBarry Smith    Input Parameters:
6571620fd73SBarry Smith +  m - the matrix
6581620fd73SBarry Smith .  row - the row location of the entry
6591620fd73SBarry Smith .  col - the column location of the entry
6601620fd73SBarry Smith .  value - the value to insert
6611620fd73SBarry Smith -  mode - either INSERT_VALUES or ADD_VALUES
6621620fd73SBarry Smith 
6631620fd73SBarry Smith    Notes:
6641620fd73SBarry Smith    For efficiency one should use MatSetValues() and set several or many
6651620fd73SBarry Smith    values simultaneously if possible.
6661620fd73SBarry Smith 
6671620fd73SBarry Smith    Level: beginner
6681620fd73SBarry Smith 
6691620fd73SBarry Smith .seealso: MatSetValues(), MatSetValueLocal()
6701620fd73SBarry Smith M*/
6711620fd73SBarry 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);}
6721620fd73SBarry Smith 
6731620fd73SBarry Smith PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);}
6741620fd73SBarry Smith 
6751620fd73SBarry 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);}
6761620fd73SBarry Smith 
6771620fd73SBarry Smith /*MC
6780d2a7ff2SSatish Balay    MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
679bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
680bd481603SBarry Smith 
681bd481603SBarry Smith    Synopsis:
682c1ac3661SBarry Smith    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
683bd481603SBarry Smith 
684bd481603SBarry Smith    Collective on MPI_Comm
685bd481603SBarry Smith 
686bd481603SBarry Smith    Input Parameters:
687bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
688859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
689859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
690bd481603SBarry Smith 
691bd481603SBarry Smith    Output Parameters:
692bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
693bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
694bd481603SBarry Smith 
695bd481603SBarry Smith 
696bd481603SBarry Smith    Level: intermediate
697bd481603SBarry Smith 
698bd481603SBarry Smith    Notes:
6990598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
700bd481603SBarry Smith 
7011d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
702bd481603SBarry Smith 
703bd481603SBarry Smith    Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
704bd481603SBarry Smith 
7051620fd73SBarry Smith    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
7061620fd73SBarry Smith 
707bd481603SBarry Smith   Concepts: preallocation^Matrix
708bd481603SBarry Smith 
709bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
710bd481603SBarry Smith           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
711bd481603SBarry Smith M*/
712c4f061fbSSatish Balay #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
7137c922b88SBarry Smith { \
714a89bc211SBarry Smith   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
715a89bc211SBarry Smith   _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
716a89bc211SBarry Smith   _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
717a89bc211SBarry Smith   _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
718c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
719a89bc211SBarry Smith   _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
7207c922b88SBarry Smith 
721bd481603SBarry Smith /*MC
7220d2a7ff2SSatish Balay    MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per
723bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
724bd481603SBarry Smith 
725bd481603SBarry Smith    Synopsis:
726c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
727bd481603SBarry Smith 
728bd481603SBarry Smith    Collective on MPI_Comm
729bd481603SBarry Smith 
730bd481603SBarry Smith    Input Parameters:
731bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
732859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
733859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
734bd481603SBarry Smith 
735bd481603SBarry Smith    Output Parameters:
736bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
737bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
738bd481603SBarry Smith 
739bd481603SBarry Smith 
740bd481603SBarry Smith    Level: intermediate
741bd481603SBarry Smith 
742bd481603SBarry Smith    Notes:
7430598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
744bd481603SBarry Smith 
7451d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
746bd481603SBarry Smith 
7471620fd73SBarry Smith    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
7481620fd73SBarry Smith 
749bd481603SBarry Smith   Concepts: preallocation^Matrix
750bd481603SBarry Smith 
751bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
752bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
753bd481603SBarry Smith M*/
754222b16d4SBarry Smith #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \
755222b16d4SBarry Smith { \
756a89bc211SBarry Smith   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__end; \
757a89bc211SBarry Smith   _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
758a89bc211SBarry Smith   _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
759a89bc211SBarry Smith   _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
760c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\
761a89bc211SBarry Smith   _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
762222b16d4SBarry Smith 
763bd481603SBarry Smith /*MC
764bd481603SBarry Smith    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
765bd481603SBarry Smith        inserted using a local number of the rows and columns
766bd481603SBarry Smith 
767bd481603SBarry Smith    Synopsis:
768c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
769bd481603SBarry Smith 
770bd481603SBarry Smith    Not Collective
771bd481603SBarry Smith 
772bd481603SBarry Smith    Input Parameters:
773bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
774bd481603SBarry Smith .  nrows - the number of rows indicated
7751d73ed98SBarry Smith .  rows - the indices of the rows
776bd481603SBarry Smith .  ncols - the number of columns in the matrix
777bd481603SBarry Smith .  cols - the columns indicated
778bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
779bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
780bd481603SBarry Smith 
781bd481603SBarry Smith 
782bd481603SBarry Smith    Level: intermediate
783bd481603SBarry Smith 
784bd481603SBarry Smith    Notes:
7850598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
786bd481603SBarry Smith 
7871d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
788bd481603SBarry Smith 
789bd481603SBarry Smith   Concepts: preallocation^Matrix
790bd481603SBarry Smith 
791bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
792bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
793bd481603SBarry Smith M*/
794c4f061fbSSatish Balay #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
795c4f061fbSSatish Balay {\
796c1ac3661SBarry Smith   PetscInt __l;\
797ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
798ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
799c4f061fbSSatish Balay   for (__l=0;__l<nrows;__l++) {\
800ef66eb69SBarry Smith     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
801c4f061fbSSatish Balay   }\
802c4f061fbSSatish Balay }
803c4f061fbSSatish Balay 
804bd481603SBarry Smith /*MC
805bd481603SBarry Smith    MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
806bd481603SBarry Smith        inserted using a local number of the rows and columns
807bd481603SBarry Smith 
808bd481603SBarry Smith    Synopsis:
809c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
810bd481603SBarry Smith 
811bd481603SBarry Smith    Not Collective
812bd481603SBarry Smith 
813bd481603SBarry Smith    Input Parameters:
814bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
815bd481603SBarry Smith .  nrows - the number of rows indicated
8161d73ed98SBarry Smith .  rows - the indices of the rows
817bd481603SBarry Smith .  ncols - the number of columns in the matrix
818bd481603SBarry Smith .  cols - the columns indicated
819bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
820bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
821bd481603SBarry Smith 
822bd481603SBarry Smith 
823bd481603SBarry Smith    Level: intermediate
824bd481603SBarry Smith 
825bd481603SBarry Smith    Notes:
8260598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
827bd481603SBarry Smith 
828bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
829bd481603SBarry Smith 
830bd481603SBarry Smith   Concepts: preallocation^Matrix
831bd481603SBarry Smith 
832bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
833bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
834bd481603SBarry Smith M*/
835d3d32019SBarry Smith #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
836d3d32019SBarry Smith {\
837c1ac3661SBarry Smith   PetscInt __l;\
838d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
839d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
840d3d32019SBarry Smith   for (__l=0;__l<nrows;__l++) {\
841d3d32019SBarry Smith     _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
842d3d32019SBarry Smith   }\
843d3d32019SBarry Smith }
844d3d32019SBarry Smith 
845bd481603SBarry Smith /*MC
846bd481603SBarry Smith    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
847bd481603SBarry Smith        inserted using a local number of the rows and columns
848bd481603SBarry Smith 
849bd481603SBarry Smith    Synopsis:
850c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
851bd481603SBarry Smith 
852bd481603SBarry Smith    Not Collective
853bd481603SBarry Smith 
854bd481603SBarry Smith    Input Parameters:
85564075487SBarry Smith +  row - the row
856bd481603SBarry Smith .  ncols - the number of columns in the matrix
857a50f8bf6SHong Zhang -  cols - the columns indicated
858a50f8bf6SHong Zhang 
859a50f8bf6SHong Zhang    Output Parameters:
860a50f8bf6SHong Zhang +  dnz - the array that will be passed to the matrix preallocation routines
861bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
862bd481603SBarry Smith 
863bd481603SBarry Smith 
864bd481603SBarry Smith    Level: intermediate
865bd481603SBarry Smith 
866bd481603SBarry Smith    Notes:
8670598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
868bd481603SBarry Smith 
869bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
870bd481603SBarry Smith 
8711620fd73SBarry Smith    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
8721620fd73SBarry Smith 
873bd481603SBarry Smith   Concepts: preallocation^Matrix
874bd481603SBarry Smith 
875bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
876bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
877bd481603SBarry Smith M*/
878c4f061fbSSatish Balay #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
879c1ac3661SBarry Smith { PetscInt __i; \
880e32f2f54SBarry 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);\
881e32f2f54SBarry 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);\
8827c922b88SBarry Smith   for (__i=0; __i<nc; __i++) {\
88364075487SBarry Smith     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
8847cc688d7SBarry Smith     else dnz[row - __rstart]++;\
8857c922b88SBarry Smith   }\
8867c922b88SBarry Smith }
8877c922b88SBarry Smith 
888bd481603SBarry Smith /*MC
889bd481603SBarry Smith    MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
890bd481603SBarry Smith        inserted using a local number of the rows and columns
891bd481603SBarry Smith 
892bd481603SBarry Smith    Synopsis:
893c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
894bd481603SBarry Smith 
895bd481603SBarry Smith    Not Collective
896bd481603SBarry Smith 
897bd481603SBarry Smith    Input Parameters:
898bd481603SBarry Smith +  nrows - the number of rows indicated
8991d73ed98SBarry Smith .  rows - the indices of the rows
900bd481603SBarry Smith .  ncols - the number of columns in the matrix
901bd481603SBarry Smith .  cols - the columns indicated
902bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
903bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
904bd481603SBarry Smith 
905bd481603SBarry Smith 
906bd481603SBarry Smith    Level: intermediate
907bd481603SBarry Smith 
908bd481603SBarry Smith    Notes:
9090598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
910bd481603SBarry Smith 
911bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
912bd481603SBarry Smith 
9131620fd73SBarry Smith    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
9141620fd73SBarry Smith 
915bd481603SBarry Smith   Concepts: preallocation^Matrix
916bd481603SBarry Smith 
917bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
918bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
919bd481603SBarry Smith M*/
920d3d32019SBarry Smith #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
921c1ac3661SBarry Smith { PetscInt __i; \
922d3d32019SBarry Smith   for (__i=0; __i<nc; __i++) {\
923d3d32019SBarry Smith     if (cols[__i] >= __end) onz[row - __rstart]++; \
924d3d32019SBarry Smith     else if (cols[__i] >= row) dnz[row - __rstart]++;\
925d3d32019SBarry Smith   }\
926d3d32019SBarry Smith }
927d3d32019SBarry Smith 
928bd481603SBarry Smith /*MC
92916371a99SBarry Smith    MatPreallocateLocation -  An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists
93016371a99SBarry Smith 
93116371a99SBarry Smith    Synopsis:
93216371a99SBarry Smith    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)
93316371a99SBarry Smith 
93416371a99SBarry Smith    Not Collective
93516371a99SBarry Smith 
93616371a99SBarry Smith    Input Parameters:
93716371a99SBarry Smith .  A - matrix
93816371a99SBarry Smith .  row - row where values exist (must be local to this process)
93916371a99SBarry Smith .  ncols - number of columns
94016371a99SBarry Smith .  cols - columns with nonzeros
94116371a99SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
94216371a99SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
94316371a99SBarry Smith 
94416371a99SBarry Smith 
94516371a99SBarry Smith    Level: intermediate
94616371a99SBarry Smith 
94716371a99SBarry Smith    Notes:
9480598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
94916371a99SBarry Smith 
95016371a99SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
95116371a99SBarry Smith 
95216371a99SBarry Smith    This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.
95316371a99SBarry Smith 
95416371a99SBarry Smith   Concepts: preallocation^Matrix
95516371a99SBarry Smith 
95616371a99SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
95716371a99SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
95816371a99SBarry Smith M*/
95916371a99SBarry 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);}
96016371a99SBarry Smith 
96116371a99SBarry Smith 
96216371a99SBarry Smith /*MC
9630d2a7ff2SSatish Balay    MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
964bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
965bd481603SBarry Smith 
966bd481603SBarry Smith    Synopsis:
967c1ac3661SBarry Smith    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
968bd481603SBarry Smith 
969bd481603SBarry Smith    Collective on MPI_Comm
970bd481603SBarry Smith 
971bd481603SBarry Smith    Input Parameters:
97216371a99SBarry Smith +  dnz - the array that was be passed to the matrix preallocation routines
973bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
974bd481603SBarry Smith 
975bd481603SBarry Smith 
976bd481603SBarry Smith    Level: intermediate
977bd481603SBarry Smith 
978bd481603SBarry Smith    Notes:
9790598bfebSBarry Smith     See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details.
980bd481603SBarry Smith 
981bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
982bd481603SBarry Smith 
9831620fd73SBarry Smith    This is a MACRO not a function because it closes the { started in MatPreallocateInitialize().
9841620fd73SBarry Smith 
985bd481603SBarry Smith   Concepts: preallocation^Matrix
986bd481603SBarry Smith 
987bd481603SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
988bd481603SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
989bd481603SBarry Smith M*/
990a89bc211SBarry Smith #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}
9917c922b88SBarry Smith 
992bd481603SBarry Smith 
993bd481603SBarry Smith 
9947b80b807SBarry Smith /* Routines unique to particular data structures */
995be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **);
996ba966639SSatish Balay PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t)
997698d4c6aSKris Buschelman 
998be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*);
999be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
1000698d4c6aSKris Buschelman 
1001be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
1002be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
1003be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1004c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1005c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
10067b80b807SBarry Smith 
1007a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4
1008a96a251dSBarry Smith 
1009be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1010ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
1011be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1012ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
1013be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
1014ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz))
1015273d9f13SBarry Smith 
1016be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1017ba966639SSatish Balay PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz))
1018be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1019be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
102053803f26SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
1021725b52f3SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1022be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
1023be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1024be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
1025be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
1026284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
1027be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
1028be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
1029be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void));
1030273d9f13SBarry Smith 
1031be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt);
1032ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDenseGetLocalMatrix(Mat,Mat*);
10331b807ce4Svictorle 
1034be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat);
1035be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat);
10362e8a6d31SBarry Smith 
1037be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*);
10383a7fca6bSBarry Smith 
10397b80b807SBarry Smith /*
10407b80b807SBarry Smith   These routines are not usually accessed directly, rather solving is
104194b7f48cSBarry Smith   done through the KSP and PC interfaces.
10427b80b807SBarry Smith */
10437b80b807SBarry Smith 
1044d9274352SBarry Smith /*E
1045d9274352SBarry Smith     MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
1046d9274352SBarry Smith        with an optional dynamic library name, for example
1047d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
1048d9274352SBarry Smith 
1049d9274352SBarry Smith    Level: beginner
1050d9274352SBarry Smith 
1051e5a9bf91SBarry Smith    Cannot use const because the PC objects manipulate the string
1052e5a9bf91SBarry Smith 
1053d9274352SBarry Smith .seealso: MatGetOrdering()
1054d9274352SBarry Smith E*/
10553eaad2caSSatish Balay #define MatOrderingType char*
10562692d6eeSBarry Smith #define MATORDERINGNATURAL     "natural"
10572692d6eeSBarry Smith #define MATORDERINGND          "nd"
10582692d6eeSBarry Smith #define MATORDERING1WD         "1wd"
10592692d6eeSBarry Smith #define MATORDERINGRCM         "rcm"
10602692d6eeSBarry Smith #define MATORDERINGQMD         "qmd"
10612692d6eeSBarry Smith #define MATORDERINGROWLENGTH   "rowlength"
10622692d6eeSBarry Smith #define MATORDERINGDSC_ND      "dsc_nd"         /* these three are only for DSCPACK, see its documentation for details */
10632692d6eeSBarry Smith #define MATORDERINGDSC_MMD     "dsc_mmd"
10642692d6eeSBarry Smith #define MATORDERINGDSC_MDF     "dsc_mdf"
1065312e372aSBarry Smith #define MATORDERINGAMD         "amd"            /* only works if UMFPACK is installed with PETSc */
1066b12f92e5SBarry Smith 
1067f2416520SSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
1068be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list);
1069f2416520SSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));
107030de9b25SBarry Smith 
107130de9b25SBarry Smith /*MC
10721890ba74SBarry Smith    MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the matrix package.
107330de9b25SBarry Smith 
107430de9b25SBarry Smith    Synopsis:
10751890ba74SBarry Smith    PetscErrorCode MatOrderingRegisterDynamic(const char *name_ordering,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
107630de9b25SBarry Smith 
107730de9b25SBarry Smith    Not Collective
107830de9b25SBarry Smith 
107930de9b25SBarry Smith    Input Parameters:
10802692d6eeSBarry Smith +  sname - name of ordering (for example MATORDERINGND)
108130de9b25SBarry Smith .  path - location of library where creation routine is
108230de9b25SBarry Smith .  name - name of function that creates the ordering type,a string
108330de9b25SBarry Smith -  function - function pointer that creates the ordering
108430de9b25SBarry Smith 
108530de9b25SBarry Smith    Level: developer
108630de9b25SBarry Smith 
108730de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
108830de9b25SBarry Smith    is ignored.
108930de9b25SBarry Smith 
109030de9b25SBarry Smith    Sample usage:
109130de9b25SBarry Smith .vb
109230de9b25SBarry Smith    MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
109330de9b25SBarry Smith                "MyOrder",MyOrder);
109430de9b25SBarry Smith .ve
109530de9b25SBarry Smith 
109630de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
109730de9b25SBarry Smith $     MatOrderingSetType(part,"my_order)
109830de9b25SBarry Smith    or at runtime via the option
10992401956bSBarry Smith $     -pc_factor_mat_ordering_type my_order
110030de9b25SBarry Smith 
1101ab901514SBarry Smith    ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
110230de9b25SBarry Smith 
110330de9b25SBarry Smith .keywords: matrix, ordering, register
110430de9b25SBarry Smith 
110530de9b25SBarry Smith .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
110630de9b25SBarry Smith M*/
1107aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1108f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
1109b12f92e5SBarry Smith #else
1110f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
1111b12f92e5SBarry Smith #endif
111230de9b25SBarry Smith 
1113be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void);
1114be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]);
1115ace3abfcSBarry Smith extern PetscBool  MatOrderingRegisterAllCalled;
1116b0a32e0cSBarry Smith extern PetscFList MatOrderingList;
1117d4fbbf0eSBarry Smith 
1118be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1119a2ce50c7SBarry Smith 
1120d91e6319SBarry Smith /*S
1121d90ac83dSHong Zhang     MatFactorShiftType - Numeric Shift.
1122d90ac83dSHong Zhang 
1123d90ac83dSHong Zhang    Level: beginner
1124d90ac83dSHong Zhang 
1125d90ac83dSHong Zhang S*/
1126d90ac83dSHong Zhang typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
1127d90ac83dSHong Zhang extern const char *MatFactorShiftTypes[];
1128d90ac83dSHong Zhang 
1129d90ac83dSHong Zhang /*S
11302401956bSBarry Smith    MatFactorInfo - Data passed into the matrix factorization routines
1131b00f7748SHong Zhang 
113261cad860SBarry Smith    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
113361cad860SBarry Smith $     MatFactorInfo  info(MAT_FACTORINFO_SIZE)
1134b00f7748SHong Zhang 
113515e8a5b3SHong Zhang    Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
1136b00f7748SHong Zhang 
113761cad860SBarry Smith       You can use MatFactorInfoInitialize() to set default values.
113861cad860SBarry Smith 
1139b00f7748SHong Zhang    Level: developer
1140b00f7748SHong Zhang 
1141d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1142d7d82daaSBarry Smith           MatFactorInfoInitialize()
1143b00f7748SHong Zhang 
1144b00f7748SHong Zhang S*/
1145b00f7748SHong Zhang typedef struct {
114615e8a5b3SHong Zhang   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
114785317021SBarry Smith   PetscReal     usedt;
114815e8a5b3SHong Zhang   PetscReal     dt;             /* drop tolerance */
1149b00f7748SHong Zhang   PetscReal     dtcol;          /* tolerance for pivoting */
115015e8a5b3SHong Zhang   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
115167e28bfeSBarry Smith   PetscReal     fill;           /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1152348344bbSBarry Smith   PetscReal     levels;         /* ICC/ILU(levels) */
1153bcd9e38bSBarry Smith   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1154bcd9e38bSBarry Smith                                    factorization may be faster if do not pivot */
115515e8a5b3SHong Zhang   PetscReal     zeropivot;      /* pivot is called zero if less than this */
1156f4db908eSBarry Smith   PetscReal     shifttype;      /* type of shift added to matrix factor to prevent zero pivots */
1157f4db908eSBarry Smith   PetscReal     shiftamount;     /* how large the shift is */
115815e8a5b3SHong Zhang } MatFactorInfo;
1159ffa6d0a5SLois Curfman McInnes 
1160be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*);
11610481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
11620481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
11630481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
11640481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
11650481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
11660481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
11670481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
11680481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
11690481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,const MatFactorInfo*);
11700481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1171be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1172be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec);
1173be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec);
1174be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec);
1175be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec);
1176be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec);
1177be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1178be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs);
11798ed539a5SBarry Smith 
1180be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat);
1181bb5a7306SBarry Smith 
1182d91e6319SBarry Smith /*E
1183d91e6319SBarry Smith     MatSORType - What type of (S)SOR to perform
1184bb1eb677SSatish Balay 
1185d91e6319SBarry Smith     Level: beginner
1186d91e6319SBarry Smith 
1187d9274352SBarry Smith    May be bitwise ORd together
1188d9274352SBarry Smith 
1189d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1190d91e6319SBarry Smith 
11914e7234bfSBarry Smith    MatSORType may be bitwise ORd together, so do not change the numbers
11924e7234bfSBarry Smith 
119341f059aeSBarry Smith .seealso: MatSOR()
1194d91e6319SBarry Smith E*/
1195ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1196ee50ffe9SBarry Smith               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1197ee50ffe9SBarry Smith               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
119884cb2905SBarry Smith               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
119941f059aeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
12008ed539a5SBarry Smith 
1201d4fbbf0eSBarry Smith /*
1202639f9d9dSBarry Smith     These routines are for efficiently computing Jacobians via finite differences.
1203639f9d9dSBarry Smith */
1204b12f92e5SBarry Smith 
1205d9274352SBarry Smith /*E
1206d9274352SBarry Smith     MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1207d9274352SBarry Smith        with an optional dynamic library name, for example
1208d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1209d9274352SBarry Smith 
1210d9274352SBarry Smith    Level: beginner
1211d9274352SBarry Smith 
1212d9274352SBarry Smith .seealso: MatGetColoring()
1213d9274352SBarry Smith E*/
1214a313700dSBarry Smith #define MatColoringType char*
12152692d6eeSBarry Smith #define MATCOLORINGNATURAL "natural"
12162692d6eeSBarry Smith #define MATCOLORINGSL      "sl"
12172692d6eeSBarry Smith #define MATCOLORINGLF      "lf"
12182692d6eeSBarry Smith #define MATCOLORINGID      "id"
1219b12f92e5SBarry Smith 
1220ab970d9bSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,const MatColoringType,ISColoring*);
12212e90c967SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *));
122230de9b25SBarry Smith 
122330de9b25SBarry Smith /*MC
122430de9b25SBarry Smith    MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
122530de9b25SBarry Smith                                matrix package.
122630de9b25SBarry Smith 
122730de9b25SBarry Smith    Synopsis:
12281890ba74SBarry Smith    PetscErrorCode MatColoringRegisterDynamic(const char *name_coloring,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatColoring))
122930de9b25SBarry Smith 
123030de9b25SBarry Smith    Not Collective
123130de9b25SBarry Smith 
123230de9b25SBarry Smith    Input Parameters:
12332692d6eeSBarry Smith +  sname - name of Coloring (for example MATCOLORINGSL)
123430de9b25SBarry Smith .  path - location of library where creation routine is
123530de9b25SBarry Smith .  name - name of function that creates the Coloring type, a string
123630de9b25SBarry Smith -  function - function pointer that creates the coloring
123730de9b25SBarry Smith 
123830de9b25SBarry Smith    Level: developer
123930de9b25SBarry Smith 
124030de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
124130de9b25SBarry Smith    is ignored.
124230de9b25SBarry Smith 
124330de9b25SBarry Smith    Sample usage:
124430de9b25SBarry Smith .vb
124530de9b25SBarry Smith    MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
124630de9b25SBarry Smith                "MyColor",MyColor);
124730de9b25SBarry Smith .ve
124830de9b25SBarry Smith 
124930de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
125030de9b25SBarry Smith $     MatColoringSetType(part,"my_color")
125130de9b25SBarry Smith    or at runtime via the option
125230de9b25SBarry Smith $     -mat_coloring_type my_color
125330de9b25SBarry Smith 
1254ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
125530de9b25SBarry Smith 
125630de9b25SBarry Smith .keywords: matrix, Coloring, register
125730de9b25SBarry Smith 
125830de9b25SBarry Smith .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
125930de9b25SBarry Smith M*/
1260aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1261f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1262b12f92e5SBarry Smith #else
1263f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1264b12f92e5SBarry Smith #endif
126530de9b25SBarry Smith 
1266ace3abfcSBarry Smith extern PetscBool  MatColoringRegisterAllCalled;
1267f1144a30SSatish Balay 
1268be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]);
1269be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void);
1270be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1271639f9d9dSBarry Smith 
1272d9274352SBarry Smith /*S
1273d9274352SBarry Smith      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1274d9274352SBarry Smith         and coloring
1275639f9d9dSBarry Smith 
1276d9274352SBarry Smith    Level: beginner
1277d9274352SBarry Smith 
1278d9274352SBarry Smith   Concepts: coloring, sparse Jacobian, finite differences
1279d9274352SBarry Smith 
1280d9274352SBarry Smith .seealso:  MatFDColoringCreate()
1281d9274352SBarry Smith S*/
1282e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring;
1283639f9d9dSBarry Smith 
1284be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1285be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring);
1286be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer);
1287be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
12884a9d489dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1289be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1290be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring);
1291be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1292be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *);
1293be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec);
1294be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1295639f9d9dSBarry Smith /*
12960752156aSBarry Smith     These routines are for partitioning matrices: currently used only
12973eda8832SBarry Smith   for adjacency matrix, MatCreateMPIAdj().
12980752156aSBarry Smith */
1299ca161407SBarry Smith 
1300d9274352SBarry Smith /*S
1301d9274352SBarry Smith      MatPartitioning - Object for managing the partitioning of a matrix or graph
1302d9274352SBarry Smith 
1303d9274352SBarry Smith    Level: beginner
1304d9274352SBarry Smith 
1305d9274352SBarry Smith   Concepts: partitioning
1306d9274352SBarry Smith 
1307743a1026Svictorle .seealso:  MatPartitioningCreate(), MatPartitioningType
1308d9274352SBarry Smith S*/
130991e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning;
1310d9274352SBarry Smith 
1311d9274352SBarry Smith /*E
13125bc6e7ccSvictorle     MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1313d9274352SBarry Smith        with an optional dynamic library name, for example
1314d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1315d9274352SBarry Smith 
1316d9274352SBarry Smith    Level: beginner
1317d9274352SBarry Smith 
1318b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning
1319d9274352SBarry Smith E*/
1320a313700dSBarry Smith #define MatPartitioningType char*
13212692d6eeSBarry Smith #define MATPARTITIONINGCURRENT  "current"
13222692d6eeSBarry Smith #define MATPARTITIONINGSQUARE   "square"
13232692d6eeSBarry Smith #define MATPARTITIONINGPARMETIS "parmetis"
13242692d6eeSBarry Smith #define MATPARTITIONINGCHACO    "chaco"
13252692d6eeSBarry Smith #define MATPARTITIONINGJOSTLE   "jostle"
13262692d6eeSBarry Smith #define MATPARTITIONINGPARTY    "party"
13272692d6eeSBarry Smith #define MATPARTITIONINGSCOTCH   "scotch"
132871306c60Sjroman 
1329ca161407SBarry Smith 
1330be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1331a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,const MatPartitioningType);
1332be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt);
1333be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat);
1334be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1335be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1336be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*);
1337be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning);
13382aabb6bbSBarry Smith 
1339be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
134030de9b25SBarry Smith 
134130de9b25SBarry Smith /*MC
134230de9b25SBarry Smith    MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
134330de9b25SBarry Smith    matrix package.
134430de9b25SBarry Smith 
134530de9b25SBarry Smith    Synopsis:
13461890ba74SBarry Smith    PetscErrorCode MatPartitioningRegisterDynamic(const char *name_partitioning,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
134730de9b25SBarry Smith 
134830de9b25SBarry Smith    Not Collective
134930de9b25SBarry Smith 
135030de9b25SBarry Smith    Input Parameters:
13512692d6eeSBarry Smith +  sname - name of partitioning (for example MATPARTITIONINGCURRENT) or parmetis
135230de9b25SBarry Smith .  path - location of library where creation routine is
135330de9b25SBarry Smith .  name - name of function that creates the partitioning type, a string
135430de9b25SBarry Smith -  function - function pointer that creates the partitioning type
135530de9b25SBarry Smith 
135630de9b25SBarry Smith    Level: developer
135730de9b25SBarry Smith 
135830de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
135930de9b25SBarry Smith    is ignored.
136030de9b25SBarry Smith 
136130de9b25SBarry Smith    Sample usage:
136230de9b25SBarry Smith .vb
136330de9b25SBarry Smith    MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
136430de9b25SBarry Smith                "MyPartCreate",MyPartCreate);
136530de9b25SBarry Smith .ve
136630de9b25SBarry Smith 
136730de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
136830de9b25SBarry Smith $     MatPartitioningSetType(part,"my_part")
136930de9b25SBarry Smith    or at runtime via the option
137030de9b25SBarry Smith $     -mat_partitioning_type my_part
137130de9b25SBarry Smith 
1372ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
137330de9b25SBarry Smith 
137430de9b25SBarry Smith .keywords: matrix, partitioning, register
137530de9b25SBarry Smith 
137630de9b25SBarry Smith .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
137730de9b25SBarry Smith M*/
1378aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1379f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
13802aabb6bbSBarry Smith #else
1381f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
13822aabb6bbSBarry Smith #endif
13832aabb6bbSBarry Smith 
1384ace3abfcSBarry Smith extern PetscBool  MatPartitioningRegisterAllCalled;
1385f1144a30SSatish Balay 
1386be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]);
1387be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void);
13882bad1931SBarry Smith 
1389be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer);
1390be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning);
1391a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,const MatPartitioningType*);
1392ca161407SBarry Smith 
1393be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
13940e8af3caSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);
13950752156aSBarry Smith 
1396be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal);
1397be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning);
139871306c60Sjroman 
1399954b3ec6SBarry Smith typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType;
1400be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
140171306c60Sjroman typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType;
1402be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1403be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
140471306c60Sjroman typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType;
1405be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1406be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1407be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
140871306c60Sjroman 
140971306c60Sjroman #define MP_PARTY_OPT "opt"
141071306c60Sjroman #define MP_PARTY_LIN "lin"
141171306c60Sjroman #define MP_PARTY_SCA "sca"
141271306c60Sjroman #define MP_PARTY_RAN "ran"
141371306c60Sjroman #define MP_PARTY_GBF "gbf"
141471306c60Sjroman #define MP_PARTY_GCF "gcf"
141571306c60Sjroman #define MP_PARTY_BUB "bub"
141671306c60Sjroman #define MP_PARTY_DEF "def"
1417be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*);
141871306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs"
141971306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl"
142071306c60Sjroman #define MP_PARTY_NONE "no"
1421be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*);
1422be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1423ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscBool );
1424ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool );
142571306c60Sjroman 
142671306c60Sjroman typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType;
1427be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*);
1428be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning);
1429be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType);
1430be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal);
1431be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*);
143271306c60Sjroman typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType;
1433be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType);
1434be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning);
1435be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*);
143671306c60Sjroman 
1437591294e4SBarry Smith EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
143814196391SBarry Smith EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);
1439591294e4SBarry Smith 
14400752156aSBarry Smith /*
14410a835dfdSSatish Balay     If you add entries here you must also add them to finclude/petscmat.h
1442d4fbbf0eSBarry Smith */
14431c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0,
14441c1c02c0SLois Curfman McInnes                MATOP_GET_ROW=1,
14451c1c02c0SLois Curfman McInnes                MATOP_RESTORE_ROW=2,
14461c1c02c0SLois Curfman McInnes                MATOP_MULT=3,
14471c1c02c0SLois Curfman McInnes                MATOP_MULT_ADD=4,
14487c922b88SBarry Smith                MATOP_MULT_TRANSPOSE=5,
14497c922b88SBarry Smith                MATOP_MULT_TRANSPOSE_ADD=6,
14501c1c02c0SLois Curfman McInnes                MATOP_SOLVE=7,
14511c1c02c0SLois Curfman McInnes                MATOP_SOLVE_ADD=8,
14527c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE=9,
14537c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE_ADD=10,
14541c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR=11,
14551c1c02c0SLois Curfman McInnes                MATOP_CHOLESKYFACTOR=12,
1456a714c06dSBarry Smith                MATOP_SOR=13,
14571c1c02c0SLois Curfman McInnes                MATOP_TRANSPOSE=14,
14581c1c02c0SLois Curfman McInnes                MATOP_GETINFO=15,
14591c1c02c0SLois Curfman McInnes                MATOP_EQUAL=16,
14601c1c02c0SLois Curfman McInnes                MATOP_GET_DIAGONAL=17,
14611c1c02c0SLois Curfman McInnes                MATOP_DIAGONAL_SCALE=18,
14621c1c02c0SLois Curfman McInnes                MATOP_NORM=19,
14631c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_BEGIN=20,
14641c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_END=21,
1465d519adbfSMatthew Knepley                MATOP_SET_OPTION=22,
1466d519adbfSMatthew Knepley                MATOP_ZERO_ENTRIES=23,
1467d519adbfSMatthew Knepley                MATOP_ZERO_ROWS=24,
1468d519adbfSMatthew Knepley                MATOP_LUFACTOR_SYMBOLIC=25,
1469d519adbfSMatthew Knepley                MATOP_LUFACTOR_NUMERIC=26,
1470d519adbfSMatthew Knepley                MATOP_CHOLESKY_FACTOR_SYMBOLIC=27,
1471d519adbfSMatthew Knepley                MATOP_CHOLESKY_FACTOR_NUMERIC=28,
1472d519adbfSMatthew Knepley                MATOP_SETUP_PREALLOCATION=29,
1473d519adbfSMatthew Knepley                MATOP_ILUFACTOR_SYMBOLIC=30,
1474d519adbfSMatthew Knepley                MATOP_ICCFACTOR_SYMBOLIC=31,
1475d519adbfSMatthew Knepley                MATOP_GET_ARRAY=32,
1476d519adbfSMatthew Knepley                MATOP_RESTORE_ARRAY=33,
1477d519adbfSMatthew Knepley                MATOP_DUPLICATE=34,
1478d519adbfSMatthew Knepley                MATOP_FORWARD_SOLVE=35,
1479d519adbfSMatthew Knepley                MATOP_BACKWARD_SOLVE=36,
1480d519adbfSMatthew Knepley                MATOP_ILUFACTOR=37,
1481d519adbfSMatthew Knepley                MATOP_ICCFACTOR=38,
1482d519adbfSMatthew Knepley                MATOP_AXPY=39,
1483d519adbfSMatthew Knepley                MATOP_GET_SUBMATRICES=40,
1484d519adbfSMatthew Knepley                MATOP_INCREASE_OVERLAP=41,
1485d519adbfSMatthew Knepley                MATOP_GET_VALUES=42,
1486d519adbfSMatthew Knepley                MATOP_COPY=43,
1487d519adbfSMatthew Knepley                MATOP_GET_ROW_MAX=44,
1488d519adbfSMatthew Knepley                MATOP_SCALE=45,
1489d519adbfSMatthew Knepley                MATOP_SHIFT=46,
149035153367SBarry Smith                MATOP_DIAGONAL_SET=47,
1491d519adbfSMatthew Knepley                MATOP_ILUDT_FACTOR=48,
1492d519adbfSMatthew Knepley                MATOP_SET_BLOCK_SIZE=49,
1493d519adbfSMatthew Knepley                MATOP_GET_ROW_IJ=50,
1494d519adbfSMatthew Knepley                MATOP_RESTORE_ROW_IJ=51,
1495d519adbfSMatthew Knepley                MATOP_GET_COLUMN_IJ=52,
1496d519adbfSMatthew Knepley                MATOP_RESTORE_COLUMN_IJ=53,
1497d519adbfSMatthew Knepley                MATOP_FDCOLORING_CREATE=54,
1498d519adbfSMatthew Knepley                MATOP_COLORING_PATCH=55,
1499d519adbfSMatthew Knepley                MATOP_SET_UNFACTORED=56,
1500d519adbfSMatthew Knepley                MATOP_PERMUTE=57,
1501d519adbfSMatthew Knepley                MATOP_SET_VALUES_BLOCKED=58,
1502d519adbfSMatthew Knepley                MATOP_GET_SUBMATRIX=59,
1503d519adbfSMatthew Knepley                MATOP_DESTROY=60,
1504d519adbfSMatthew Knepley                MATOP_VIEW=61,
1505d519adbfSMatthew Knepley                MATOP_CONVERT_FROM=62,
1506d519adbfSMatthew Knepley                MATOP_USE_SCALED_FORM=63,
1507d519adbfSMatthew Knepley                MATOP_SCALE_SYSTEM=64,
1508d519adbfSMatthew Knepley                MATOP_UNSCALE_SYSTEM=65,
1509d519adbfSMatthew Knepley                MATOP_SET_LOCAL_TO_GLOBAL_MAP=66,
1510d519adbfSMatthew Knepley                MATOP_SET_VALUES_LOCAL=67,
1511d519adbfSMatthew Knepley                MATOP_ZERO_ROWS_LOCAL=68,
1512d519adbfSMatthew Knepley                MATOP_GET_ROW_MAX_ABS=69,
1513d519adbfSMatthew Knepley                MATOP_GET_ROW_MIN_ABS=70,
1514d519adbfSMatthew Knepley                MATOP_CONVERT=71,
1515d519adbfSMatthew Knepley                MATOP_SET_COLORING=72,
1516d519adbfSMatthew Knepley                MATOP_SET_VALUES_ADIC=73,
1517d519adbfSMatthew Knepley                MATOP_SET_VALUES_ADIFOR=74,
1518d519adbfSMatthew Knepley                MATOP_FD_COLORING_APPLY=75,
1519d519adbfSMatthew Knepley                MATOP_SET_FROM_OPTIONS=76,
1520d519adbfSMatthew Knepley                MATOP_MULT_CON=77,
1521d519adbfSMatthew Knepley                MATOP_MULT_TRANSPOSE_CON=78,
1522d519adbfSMatthew Knepley                MATOP_PERMUTE_SPARSIFY=79,
1523d519adbfSMatthew Knepley                MATOP_MULT_MULTIPLE=80,
1524d519adbfSMatthew Knepley                MATOP_SOLVE_MULTIPLE=81,
1525d519adbfSMatthew Knepley                MATOP_GET_INERTIA=82,
1526d519adbfSMatthew Knepley                MATOP_LOAD=83,
1527d519adbfSMatthew Knepley                MATOP_IS_SYMMETRIC=84,
1528d519adbfSMatthew Knepley                MATOP_IS_HERMITIAN=85,
1529d519adbfSMatthew Knepley                MATOP_IS_STRUCTURALLY_SYMMETRIC=86,
153041f059aeSBarry Smith                MATOP_DUMMY=87,
1531d519adbfSMatthew Knepley                MATOP_GET_VECS=88,
1532d519adbfSMatthew Knepley                MATOP_MAT_MULT=89,
1533d519adbfSMatthew Knepley                MATOP_MAT_MULT_SYMBOLIC=90,
1534d519adbfSMatthew Knepley                MATOP_MAT_MULT_NUMERIC=91,
1535d519adbfSMatthew Knepley                MATOP_PTAP=92,
1536d519adbfSMatthew Knepley                MATOP_PTAP_SYMBOLIC=93,
1537d519adbfSMatthew Knepley                MATOP_PTAP_NUMERIC=94,
1538d519adbfSMatthew Knepley                MATOP_MAT_MULTTRANSPOSE=95,
15391763ac4eSSatish Balay                MATOP_MAT_MULTTRANSPOSE_SYM=96,
15401763ac4eSSatish Balay                MATOP_MAT_MULTTRANSPOSE_NUM=97,
1541d519adbfSMatthew Knepley                MATOP_PTAP_SYMBOLIC_SEQAIJ=98,
1542d519adbfSMatthew Knepley                MATOP_PTAP_NUMERIC_SEQAIJ=99,
1543d519adbfSMatthew Knepley                MATOP_PTAP_SYMBOLIC_MPIAIJ=100,
1544d519adbfSMatthew Knepley                MATOP_PTAP_NUMERIC_MPIAIJ=101,
1545d519adbfSMatthew Knepley                MATOP_CONJUGATE=102,
1546d519adbfSMatthew Knepley                MATOP_SET_SIZES=103,
1547d519adbfSMatthew Knepley                MATOP_SET_VALUES_ROW=104,
1548d519adbfSMatthew Knepley                MATOP_REAL_PART=105,
1549d519adbfSMatthew Knepley                MATOP_IMAG_PART=106,
1550d519adbfSMatthew Knepley                MATOP_GET_ROW_UTRIANGULAR=107,
1551d519adbfSMatthew Knepley                MATOP_RESTORE_ROW_UTRIANGULAR=108,
1552d519adbfSMatthew Knepley                MATOP_MATSOLVE=109,
1553d519adbfSMatthew Knepley                MATOP_GET_REDUNDANTMATRIX=110,
1554d519adbfSMatthew Knepley                MATOP_GET_ROW_MIN=111,
1555d519adbfSMatthew Knepley                MATOP_GET_COLUMN_VEC=112,
1556d519adbfSMatthew Knepley                MATOP_MISSING_DIAGONAL=113,
1557d519adbfSMatthew Knepley                MATOP_MATGETSEQNONZEROSTRUCTURE=114,
155889c6957cSBarry Smith                MATOP_CREATE=115,
155989c6957cSBarry Smith                MATOP_GET_GHOSTS=116,
1560eeffb40dSHong Zhang                MATOP_MULT_DIAGONAL_BLOCK=119,
1561547795f9SHong Zhang                MATOP_HERMITIANTRANSPOSE=120,
1562547795f9SHong Zhang                MATOP_MULTHERMITIANTRANSPOSE=121,
1563fbdbba38SShri Abhyankar                MATOP_MULTHERMITIANTRANSPOSEADD=122,
1564503cfe85SJed Brown                MATOP_GETMULTIPROCBLOCK=123
1565fae171e0SBarry Smith              } MatOperation;
1566ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscBool *);
1567be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void));
1568be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void));
1569be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*);
1570112a2221SBarry Smith 
157190ace30eSBarry Smith /*
157290ace30eSBarry Smith    Codes for matrices stored on disk. By default they are
157390ace30eSBarry Smith    stored in a universal format. By changing the format with
15747973ad04SBarry Smith    PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
157590ace30eSBarry Smith    be stored in a way natural for the matrix, for example dense matrices
157690ace30eSBarry Smith    would be stored as dense. Matrices stored this way may only be
1577f4403165SShri Abhyankar    read into matrices of the same type.
157890ace30eSBarry Smith */
157990ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1
158090ace30eSBarry Smith 
1581be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1582be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*);
15831f4e1ec7SBarry Smith 
1584d9274352SBarry Smith /*S
1585d9274352SBarry Smith      MatNullSpace - Object that removes a null space from a vector, i.e.
1586d9274352SBarry Smith          orthogonalizes the vector to a subsapce
1587d9274352SBarry Smith 
1588f7a9e4ceSBarry Smith    Level: advanced
1589d9274352SBarry Smith 
1590d9274352SBarry Smith   Concepts: matrix; linear operator, null space
1591d9274352SBarry Smith 
15926e1639daSBarry Smith   Users manual sections:
15936e1639daSBarry Smith .   sec_singular
15946e1639daSBarry Smith 
1595d9274352SBarry Smith .seealso:  MatNullSpaceCreate()
1596d9274352SBarry Smith S*/
159774637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace;
1598d9274352SBarry Smith 
1599ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*);
1600b22b330cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1601be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace);
1602be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1603be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace);
1604ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat,PetscBool  *);
160574637425SBarry Smith 
1606be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS);
1607be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1608be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
160946129b97SKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat);
16103f1d51d7SBarry Smith 
1611be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*);
1612be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*);
1613be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*);
1614c4f061fbSSatish Balay 
1615be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*);
1616b0a32e0cSBarry Smith 
1617be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec);
161804f1ad80SBarry Smith 
1619fef1beadSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
16203ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetBase(Mat,Vec,Vec);
16213ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1622e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1623e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1624e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDAddNullSpace(Mat,MatNullSpace);
1625e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1626e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDResetHHistory(Mat);
1627e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctionError(Mat,PetscReal);
1628e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetPeriod(Mat,PetscInt);
1629e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDGetH(Mat,PetscScalar *);
16306aa9148fSLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetOptionsPrefix(Mat,const char[]);
1631e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFromOptions(Mat);
1632e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1633e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);
1634e884886fSBarry Smith 
16356370053bSBarry Smith /*S
16366370053bSBarry Smith     MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free
16376370053bSBarry Smith               Jacobian vector products
1638e884886fSBarry Smith 
16396370053bSBarry Smith     Notes: MATMFFD is a specific MatType which uses the MatMFFD data structure
16406370053bSBarry Smith 
16416370053bSBarry Smith            MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure
16426370053bSBarry Smith 
16436370053bSBarry Smith     Level: developer
16446370053bSBarry Smith 
16456370053bSBarry Smith .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
16466370053bSBarry Smith S*/
1647e884886fSBarry Smith typedef struct _p_MatMFFD* MatMFFD;
1648e884886fSBarry Smith 
1649e884886fSBarry Smith /*E
1650e884886fSBarry Smith     MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function
1651e884886fSBarry Smith 
1652e884886fSBarry Smith    Level: beginner
1653e884886fSBarry Smith 
1654e884886fSBarry Smith .seealso: MatMFFDSetType(), MatMFFDRegister()
1655e884886fSBarry Smith E*/
1656a313700dSBarry Smith #define MatMFFDType char*
1657e884886fSBarry Smith #define MATMFFD_DS  "ds"
1658e884886fSBarry Smith #define MATMFFD_WP  "wp"
1659e884886fSBarry Smith 
1660a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetType(Mat,const MatMFFDType);
1661e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatMFFD));
1662e884886fSBarry Smith 
1663e884886fSBarry Smith /*MC
1664e884886fSBarry Smith    MatMFFDRegisterDynamic - Adds a method to the MatMFFD registry.
1665e884886fSBarry Smith 
1666e884886fSBarry Smith    Synopsis:
16671890ba74SBarry Smith    PetscErrorCode MatMFFDRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatMFFD))
1668e884886fSBarry Smith 
1669e884886fSBarry Smith    Not Collective
1670e884886fSBarry Smith 
1671e884886fSBarry Smith    Input Parameters:
1672e884886fSBarry Smith +  name_solver - name of a new user-defined compute-h module
1673e884886fSBarry Smith .  path - path (either absolute or relative) the library containing this solver
1674e884886fSBarry Smith .  name_create - name of routine to create method context
1675e884886fSBarry Smith -  routine_create - routine to create method context
1676e884886fSBarry Smith 
1677e884886fSBarry Smith    Level: developer
1678e884886fSBarry Smith 
1679e884886fSBarry Smith    Notes:
1680e884886fSBarry Smith    MatMFFDRegisterDynamic() may be called multiple times to add several user-defined solvers.
1681e884886fSBarry Smith 
1682e884886fSBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
1683e884886fSBarry Smith    is ignored.
1684e884886fSBarry Smith 
1685e884886fSBarry Smith    Sample usage:
1686e884886fSBarry Smith .vb
1687e884886fSBarry Smith    MatMFFDRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a,
1688e884886fSBarry Smith                "MyHCreate",MyHCreate);
1689e884886fSBarry Smith .ve
1690e884886fSBarry Smith 
1691e884886fSBarry Smith    Then, your solver can be chosen with the procedural interface via
1692e884886fSBarry Smith $     MatMFFDSetType(mfctx,"my_h")
1693e884886fSBarry Smith    or at runtime via the option
1694e884886fSBarry Smith $     -snes_mf_type my_h
1695e884886fSBarry Smith 
1696e884886fSBarry Smith .keywords: MatMFFD, register
1697e884886fSBarry Smith 
1698e884886fSBarry Smith .seealso: MatMFFDRegisterAll(), MatMFFDRegisterDestroy()
1699e884886fSBarry Smith M*/
1700e884886fSBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1701e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,0)
1702e884886fSBarry Smith #else
1703e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,d)
1704e884886fSBarry Smith #endif
1705e884886fSBarry Smith 
1706e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterAll(const char[]);
1707e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterDestroy(void);
17081d0fab5eSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDDSSetUmin(Mat,PetscReal);
1709ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDWPSetComputeNormU(Mat,PetscBool );
1710e884886fSBarry Smith 
1711e884886fSBarry Smith 
1712be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1713be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
17147dbadf16SMatthew Knepley 
171597969023SHong Zhang /*
171697969023SHong Zhang    PETSc interface to MUMPS
171797969023SHong Zhang */
171897969023SHong Zhang #ifdef PETSC_HAVE_MUMPS
1719a1f19f5aSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetMumpsIcntl(Mat,PetscInt,PetscInt);
172097969023SHong Zhang #endif
172123a5497aSJed Brown 
172223a5497aSJed Brown PETSC_EXTERN_CXX_END
172323a5497aSJed Brown #endif
1724