xref: /petsc/include/petscmat.h (revision c7ccbb75de912957a93720cfae5155dcd0be1046)
12eac72dbSBarry Smith /*
22eac72dbSBarry Smith      Include file for the matrix component of PETSc
32eac72dbSBarry Smith */
426bd1501SBarry Smith #ifndef PETSCMAT_H
526bd1501SBarry Smith #define PETSCMAT_H
62c8e378dSBarry Smith #include <petscvec.h>
72eac72dbSBarry Smith 
8d9274352SBarry Smith /*S
98f6c3df8SBarry Smith      Mat - Abstract PETSc matrix object used to manage all linear operators in PETSc, even those without
108f6c3df8SBarry Smith            an explicit sparse representation (such as matrix-free operators)
112eac72dbSBarry Smith 
12d91e6319SBarry Smith    Level: beginner
13d91e6319SBarry Smith 
148f6c3df8SBarry Smith .seealso:  MatCreate(), MatType, MatSetType(), MatDestroy()
15d9274352SBarry Smith S*/
16d9274352SBarry Smith typedef struct _p_Mat*           Mat;
17d9274352SBarry Smith 
1876bdecfbSBarry Smith /*J
198f6c3df8SBarry Smith     MatType - String with the name of a PETSc matrix type
20d9274352SBarry Smith 
21d9274352SBarry Smith    Level: beginner
22d9274352SBarry Smith 
233ca39a21SBarry Smith .seealso: MatSetType(), Mat, MatSolverType, MatRegister()
2476bdecfbSBarry Smith J*/
2519fd82e9SBarry Smith typedef const char* MatType;
26273d9f13SBarry Smith #define MATSAME            "same"
275a11e1b2SBarry Smith #define MATMAIJ            "maij"
28273d9f13SBarry Smith #define MATSEQMAIJ         "seqmaij"
29273d9f13SBarry Smith #define MATMPIMAIJ         "mpimaij"
3049bd79ccSDebojyoti Ghosh #define MATKAIJ            "kaij"
3149bd79ccSDebojyoti Ghosh #define MATSEQKAIJ         "seqkaij"
3249bd79ccSDebojyoti Ghosh #define MATMPIKAIJ         "mpikaij"
33273d9f13SBarry Smith #define MATIS              "is"
345a11e1b2SBarry Smith #define MATAIJ             "aij"
35273d9f13SBarry Smith #define MATSEQAIJ          "seqaij"
36273d9f13SBarry Smith #define MATMPIAIJ          "mpiaij"
375a11e1b2SBarry Smith #define MATAIJCRL          "aijcrl"
385a11e1b2SBarry Smith #define MATSEQAIJCRL       "seqaijcrl"
395a11e1b2SBarry Smith #define MATMPIAIJCRL       "mpiaijcrl"
409ae82921SPaul Mullowney #define MATAIJCUSPARSE     "aijcusparse"
419ae82921SPaul Mullowney #define MATSEQAIJCUSPARSE  "seqaijcusparse"
429ae82921SPaul Mullowney #define MATMPIAIJCUSPARSE  "mpiaijcusparse"
43d67ff14aSKarl Rupp #define MATAIJVIENNACL     "aijviennacl"
44d67ff14aSKarl Rupp #define MATSEQAIJVIENNACL  "seqaijviennacl"
45d67ff14aSKarl Rupp #define MATMPIAIJVIENNACL  "mpiaijviennacl"
465a11e1b2SBarry Smith #define MATAIJPERM         "aijperm"
475a11e1b2SBarry Smith #define MATSEQAIJPERM      "seqaijperm"
485a11e1b2SBarry Smith #define MATMPIAIJPERM      "mpiaijperm"
494dfdc2d9SRichard Tran Mills #define MATAIJSELL         "aijsell"
504dfdc2d9SRichard Tran Mills #define MATSEQAIJSELL      "seqaijsell"
514dfdc2d9SRichard Tran Mills #define MATMPIAIJSELL      "mpiaijsell"
524a2a386eSRichard Tran Mills #define MATAIJMKL          "aijmkl"
534a2a386eSRichard Tran Mills #define MATSEQAIJMKL       "seqaijmkl"
544a2a386eSRichard Tran Mills #define MATMPIAIJMKL       "mpiaijmkl"
55b5b72c8aSIrina Sokolova #define MATBAIJMKL         "baijmkl"
56b5b72c8aSIrina Sokolova #define MATSEQBAIJMKL      "seqbaijmkl"
57b5b72c8aSIrina Sokolova #define MATMPIBAIJMKL      "mpibaijmkl"
58273d9f13SBarry Smith #define MATSHELL           "shell"
595a11e1b2SBarry Smith #define MATDENSE           "dense"
60209238afSKris Buschelman #define MATSEQDENSE        "seqdense"
61bfc799aaSStefano Zampini #define MATSEQDENSECUDA    "seqdensecuda"
62273d9f13SBarry Smith #define MATMPIDENSE        "mpidense"
63db31f6deSJed Brown #define MATELEMENTAL       "elemental"
645a11e1b2SBarry Smith #define MATBAIJ            "baij"
65273d9f13SBarry Smith #define MATSEQBAIJ         "seqbaij"
66273d9f13SBarry Smith #define MATMPIBAIJ         "mpibaij"
67273d9f13SBarry Smith #define MATMPIADJ          "mpiadj"
685a11e1b2SBarry Smith #define MATSBAIJ           "sbaij"
69273d9f13SBarry Smith #define MATSEQSBAIJ        "seqsbaij"
70273d9f13SBarry Smith #define MATMPISBAIJ        "mpisbaij"
71cebc7f6cSBarry Smith #define MATDAAD            "daad"
72cebc7f6cSBarry Smith #define MATMFFD            "mffd"
73c8a8475eSBarry Smith #define MATNORMAL          "normal"
74c5e4d11fSDmitry Karpeev #define MATNORMALHERMITIAN "normalh"
75ab92ecdeSBarry Smith #define MATLRC             "lrc"
762a6744ebSBarry Smith #define MATSCATTER         "scatter"
77421e10b8SBarry Smith #define MATBLOCKMAT        "blockmat"
78793850ffSBarry Smith #define MATCOMPOSITE       "composite"
791f8c7532SHong Zhang #define MATFFT             "fft"
801f8c7532SHong Zhang #define MATFFTW            "fftw"
81e133240eSMatthew G Knepley #define MATSEQCUFFT        "seqcufft"
82557cca28SSatish Balay #define MATTRANSPOSEMAT    "transpose"
8372ca8751SBarry Smith #define MATSCHURCOMPLEMENT "schurcomplement"
841d6018f0SLisandro Dalcin #define MATPYTHON          "python"
8563c07aadSStefano Zampini #define MATHYPRE           "hypre"
86f91d8e95SBarry Smith #define MATHYPRESTRUCT     "hyprestruct"
87a9e6138eSGlenn Hammond #define MATHYPRESSTRUCT    "hypresstruct"
88ee1cef2cSJed Brown #define MATSUBMATRIX       "submatrix"
892c0dbf93SJed Brown #define MATLOCALREF        "localref"
90d8588912SDave May #define MATNEST            "nest"
91c094ef40SMatthew G. Knepley #define MATPREALLOCATOR    "preallocator"
92d4002b98SHong Zhang #define MATSELL            "sell"
93d4002b98SHong Zhang #define MATSEQSELL         "seqsell"
94d4002b98SHong Zhang #define MATMPISELL         "mpisell"
95a3b2e22bSHong Zhang #define MATDUMMY           "dummy"
96cd929ea3SAlp Dener #define MATLMVM            "lmvm"
9778e4361aSAlp Dener #define MATLMVMDFP         "lmvmdfp"
9878e4361aSAlp Dener #define MATLMVMBFGS        "lmvmbfgs"
9978e4361aSAlp Dener #define MATLMVMSR1         "lmvmsr1"
10078e4361aSAlp Dener #define MATLMVMBRDN        "lmvmbrdn"
10178e4361aSAlp Dener #define MATLMVMBADBRDN     "lmvmbadbrdn"
10278e4361aSAlp Dener #define MATLMVMSYMBRDN     "lmvmsymbrdn"
10318ad3407SAlp Dener #define MATLMVMSYMBADBRDN  "lmvmsymbadbrdn"
10450b47da0SAdam Denchfield #define MATLMVMDIAGBRDN    "lmvmdiagbrdn"
1053423f386SBarry Smith #define MATCONSTANTDIAGONAL "constantdiagonal"
106773941d6SBarry Smith 
10776bdecfbSBarry Smith /*J
1083ca39a21SBarry Smith     MatSolverType - String with the name of a PETSc matrix solver type.
1099989ab13SBarry Smith 
110c2b89b5dSBarry Smith     For example: "petsc" indicates what PETSc provides, "superlu_dist" the parallel SuperLU_DIST package etc
1119989ab13SBarry Smith 
1129989ab13SBarry Smith    Level: beginner
1139989ab13SBarry Smith 
114*c7ccbb75SBarry Smith    Notes:  MATSOLVERUMFPACK, MATSOLVERCHOLMOD, MATSOLVERKLU form the SuiteSparse package for which you can use --download-suitesparse
115*c7ccbb75SBarry Smith 
116b198fc33SVáclav Hapla .seealso: MatGetFactor(), PCFactorSetMatSolverType(), PCFactorGetMatSolverType()
11776bdecfbSBarry Smith J*/
118ea799195SBarry Smith typedef const char* MatSolverType;
1192692d6eeSBarry Smith #define MATSOLVERSUPERLU          "superlu"
1202692d6eeSBarry Smith #define MATSOLVERSUPERLU_DIST     "superlu_dist"
12108f5efcfSPieter Ghysels #define MATSOLVERSTRUMPACK        "strumpack"
1222692d6eeSBarry Smith #define MATSOLVERUMFPACK          "umfpack"
12320db9a53SJed Brown #define MATSOLVERCHOLMOD          "cholmod"
124d89f5e7aSBarry Smith #define MATSOLVERKLU              "klu"
125418810c4SBarry Smith #define MATSOLVERSPARSEELEMENTAL  "sparseelemental"
126d89f5e7aSBarry Smith #define MATSOLVERELEMENTAL        "elemental"
1272692d6eeSBarry Smith #define MATSOLVERESSL             "essl"
1282692d6eeSBarry Smith #define MATSOLVERLUSOL            "lusol"
1292692d6eeSBarry Smith #define MATSOLVERMUMPS            "mumps"
130d615f992SSatish Balay #define MATSOLVERMKL_PARDISO      "mkl_pardiso"
131d305a81bSVasiliy Kozyrev #define MATSOLVERMKL_CPARDISO     "mkl_cpardiso"
1322692d6eeSBarry Smith #define MATSOLVERPASTIX           "pastix"
1332692d6eeSBarry Smith #define MATSOLVERMATLAB           "matlab"
1342692d6eeSBarry Smith #define MATSOLVERPETSC            "petsc"
1352692d6eeSBarry Smith #define MATSOLVERBAS              "bas"
1369ae82921SPaul Mullowney #define MATSOLVERCUSPARSE         "cusparse"
137bfc799aaSStefano Zampini #define MATSOLVERCUDA             "cuda"
138c0cdd4a1SDahai Guo 
139b24902e0SBarry Smith /*E
140b24902e0SBarry Smith     MatFactorType - indicates what type of factorization is requested
141b24902e0SBarry Smith 
142b24902e0SBarry Smith     Level: beginner
143b24902e0SBarry Smith 
144af0996ceSBarry Smith    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
145b24902e0SBarry Smith 
1463ca39a21SBarry Smith .seealso: MatSolverType, MatGetFactor()
147b24902e0SBarry Smith E*/
148552a653fSAlp Dener typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType;
149014dd563SJed Brown PETSC_EXTERN const char *const MatFactorTypes[];
150e92e720dSBarry Smith 
151ea799195SBarry Smith PETSC_EXTERN PetscErrorCode MatGetFactor(Mat,MatSolverType,MatFactorType,Mat*);
152ea799195SBarry Smith PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat,MatSolverType,MatFactorType,PetscBool *);
153ea799195SBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetSolverType(Mat,MatSolverType*);
154014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat,MatFactorType*);
1557abd51d3SMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatSetFactorType(Mat,MatFactorType);
156fd9d3c67SJed Brown PETSC_EXTERN PetscErrorCode MatSolverTypeRegister(MatSolverType,MatType,MatFactorType,PetscErrorCode(*)(Mat,MatFactorType,Mat*));
157fd9d3c67SJed Brown PETSC_EXTERN PetscErrorCode MatSolverTypeGet(MatSolverType,MatType,MatFactorType,PetscBool*,PetscBool*,PetscErrorCode (**)(Mat,MatFactorType,Mat*));
15825ef9dfeSBarry Smith typedef MatSolverType MatSolverPackage PETSC_DEPRECATED_TYPEDEF("Use MatSolverType (since version 3.9)");
15925ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatSolverTypeRegister() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSolverPackageRegister(MatSolverType stype,MatType mtype,MatFactorType ftype,PetscErrorCode(*f)(Mat,MatFactorType,Mat*))
160c19b563cSJed Brown { return MatSolverTypeRegister(stype,mtype,ftype,f); }
16125ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatSolverTypeGet() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSolverPackageGet(MatSolverType stype,MatType mtype,MatFactorType ftype,PetscBool *foundmtype,PetscBool *foundstype,PetscErrorCode(**f)(Mat,MatFactorType,Mat*))
162c19b563cSJed Brown { return MatSolverTypeGet(stype,mtype,ftype,foundmtype,foundstype,f); }
1639989ab13SBarry Smith 
164c06d978dSMatthew Knepley /* Logging support */
1650700a824SBarry Smith #define    MAT_FILE_CLASSID 1211216    /* used to indicate matrices in binary files */
166014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_CLASSID;
167335efc43SPeter Brune PETSC_EXTERN PetscClassId MAT_COLORING_CLASSID;
168014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_FDCOLORING_CLASSID;
169014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_TRANSPOSECOLORING_CLASSID;
170014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_PARTITIONING_CLASSID;
171014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_COARSEN_CLASSID;
172014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_NULLSPACE_CLASSID;
173014dd563SJed Brown PETSC_EXTERN PetscClassId MATMFFD_CLASSID;
174c06d978dSMatthew Knepley 
175ceb03754SKris Buschelman /*E
1767dae84e0SHong Zhang     MatReuse - Indicates if matrices obtained from a previous call to MatCreateSubMatrices(), MatCreateSubMatrix(), MatConvert() or several other functions
177cf37664fSBarry Smith      are to be reused to store the new matrix values.
178cf37664fSBarry Smith 
179cf37664fSBarry Smith $  MAT_INITIAL_MATRIX - create a new matrix
180cf37664fSBarry Smith $  MAT_REUSE_MATRIX - reuse the matrix created with a previous call that used MAT_INITIAL_MATRIX
181cf37664fSBarry Smith $  MAT_INPLACE_MATRIX - replace the first input matrix with the new matrix (not applicable to all functions)
182cf37664fSBarry Smith $  MAT_IGNORE_MATRIX - do not create a new matrix or reuse a give matrix, just ignore that matrix argument (not applicable to all functions)
183ceb03754SKris Buschelman 
184ceb03754SKris Buschelman     Level: beginner
185ceb03754SKris Buschelman 
186af0996ceSBarry Smith    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
187ceb03754SKris Buschelman 
1887dae84e0SHong Zhang .seealso: MatCreateSubMatrices(), MatCreateSubMatrix(), MatDestroyMatrices(), MatConvert()
189ceb03754SKris Buschelman E*/
190511c6705SHong Zhang typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX,MAT_INPLACE_MATRIX} MatReuse;
191ceb03754SKris Buschelman 
1925494a064SHong Zhang /*E
1937dae84e0SHong Zhang     MatCreateSubMatrixOption - Indicates if matrices obtained from a call to MatCreateSubMatrices()
194829201f2SHong Zhang      include the matrix values. Currently it is only used by MatGetSeqNonzerostructure().
1955494a064SHong Zhang 
1965494a064SHong Zhang     Level: beginner
1975494a064SHong Zhang 
198829201f2SHong Zhang .seealso: MatGetSeqNonzerostructure()
1995494a064SHong Zhang E*/
2007dae84e0SHong Zhang typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatCreateSubMatrixOption;
2015494a064SHong Zhang 
202607a6623SBarry Smith PETSC_EXTERN PetscErrorCode MatInitializePackage(void);
203c06d978dSMatthew Knepley 
204014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm,Mat*);
205014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
20619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatSetType(Mat,MatType);
207014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat);
208685405a1SBarry Smith PETSC_STATIC_INLINE PetscErrorCode MatViewFromOptions(Mat A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
209bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatRegister(const char[],PetscErrorCode(*)(Mat));
21023bebc0bSBarry Smith PETSC_EXTERN PetscErrorCode MatRegisterRootName(const char[],const char[],const char[]);
211014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat,const char[]);
212014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat,const char[]);
213014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat,const char*[]);
21484d44b13SHong Zhang PETSC_EXTERN PetscErrorCode MatSetErrorIfFailure(Mat,PetscBool);
215f69a0ea3SMatthew Knepley 
216140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatList;
217140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatColoringList;
218140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatPartitioningList;
21928988994SBarry Smith 
2203b224e63SBarry Smith /*E
221aa6c7ce3SBarry Smith     MatStructure - Indicates if two matrices have the same nonzero structure
2223b224e63SBarry Smith 
2233b224e63SBarry Smith     Level: beginner
2243b224e63SBarry Smith 
225af0996ceSBarry Smith    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
2263b224e63SBarry Smith 
227aa6c7ce3SBarry Smith .seealso: MatCopy(), MatAXPY()
2283b224e63SBarry Smith E*/
229aa6c7ce3SBarry Smith typedef enum {DIFFERENT_NONZERO_PATTERN,SUBSET_NONZERO_PATTERN,SAME_NONZERO_PATTERN} MatStructure;
2303b224e63SBarry Smith 
2319779e05dSSatish Balay #if defined PETSC_HAVE_MKL_SPARSE
232ddee360bSSatish Balay PETSC_EXTERN PetscErrorCode MatCreateSeqAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
233ddee360bSSatish Balay PETSC_EXTERN PetscErrorCode MatCreateMPIAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
23480095d54SIrina Sokolova PETSC_EXTERN PetscErrorCode MatCreateBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
235ddee360bSSatish Balay PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
23680095d54SIrina Sokolova #endif
237cd929ea3SAlp Dener 
238d4002b98SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSeqSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
239d4002b98SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
240d4002b98SHong Zhang PETSC_EXTERN PetscErrorCode MatSeqSELLSetPreallocation(Mat,PetscInt,const PetscInt[]);
241d4002b98SHong Zhang PETSC_EXTERN PetscErrorCode MatMPISELLSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
24280095d54SIrina Sokolova 
243014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
244014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
245014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
246014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
247014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
2488f8f2f0dSBarry Smith PETSC_EXTERN PetscErrorCode MatUpdateMPIAIJWithArrays(Mat,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
249014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
2503b00a383SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSeqAIJ(MPI_Comm,Mat,Mat,const PetscInt[],Mat*);
2513b00a383SHong Zhang 
252014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
253014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
254014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*);
255d21a29f3SJed Brown 
256014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
257014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
258d21a29f3SJed Brown 
259014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
260014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
26138f409ebSLisandro Dalcin PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
262014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
2634cce697cSJed Brown PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],const PetscInt[]);
264dfb205c3SBarry Smith 
265014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
266014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat,Mat*);
267c5e4d11fSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatCreateNormalHermitian(Mat,Mat*);
268986c4d72SJose E. Roman PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat,Mat,Vec,Mat,Mat*);
269267ca84cSJose E. Roman PETSC_EXTERN PetscErrorCode MatLRCGetMats(Mat,Mat*,Mat*,Vec*,Mat*);
270c5e4d11fSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,ISLocalToGlobalMapping,Mat*);
271014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
272014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
273c0cdd4a1SDahai Guo 
274014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*);
275014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter);
276014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*);
277014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
278014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat,Mat);
279014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat);
2808c8613bfSJakub Kruzik typedef enum {MAT_COMPOSITE_MERGE_RIGHT,MAT_COMPOSITE_MERGE_LEFT} MatCompositeMergeType;
2818c8613bfSJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeSetMergeType(Mat,MatCompositeMergeType);
282014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
2836d7c1e57SBarry Smith typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
284014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat,MatCompositeType);
2856dbc55e5SJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetType(Mat,MatCompositeType*);
2863b35acafSJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeSetMatStructure(Mat,MatStructure);
2873b35acafSJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetMatStructure(Mat,MatStructure*);
2886d0add67SJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetNumberMat(Mat,PetscInt*);
2898b5c3584SJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetMat(Mat,PetscInt,Mat*);
29003049c21SJunchao Zhang PETSC_EXTERN PetscErrorCode MatCompositeSetScalings(Mat,const PetscScalar*);
2916d7c1e57SBarry Smith 
29219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateFFT(MPI_Comm,PetscInt,const PetscInt[],MatType,Mat*);
293014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqCUFFT(MPI_Comm,PetscInt,const PetscInt[],Mat*);
294dedccee8SHong Zhang 
295014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*);
2968060fb66Sstefano_zampini PETSC_EXTERN PetscErrorCode MatTransposeGetMat(Mat,Mat*);
297d0de2241SAndrew Spott PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat,Mat*);
29806511a5cSPierre Jolivet PETSC_EXTERN PetscErrorCode MatHermitianTransposeGetMat(Mat,Mat*);
29954e05e6cSHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatrixVirtual(Mat,IS,IS,Mat*);
30054e05e6cSHong Zhang PETSC_EXTERN PetscErrorCode MatSubMatrixVirtualUpdate(Mat,Mat,IS,IS);
301014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*);
3023423f386SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateConstantDiagonal(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar,Mat*);
3031472f72bSBarry Smith 
304978814f1SStefano Zampini #if defined(PETSC_HAVE_HYPRE)
305d975228cSstefano_zampini PETSC_EXTERN PetscErrorCode MatHYPRESetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
306978814f1SStefano Zampini #endif
307978814f1SStefano Zampini 
308014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPythonSetType(Mat,const char[]);
3091d6018f0SLisandro Dalcin 
310846b4da1SFande Kong PETSC_EXTERN PetscErrorCode MatResetPreallocation(Mat);
311014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetUp(Mat);
312014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDestroy(Mat*);
313e56f5c9eSBarry Smith PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat,PetscObjectState*);
31421c89e3eSBarry Smith 
315014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatConjugate(Mat);
316014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRealPart(Mat);
317014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat);
318014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,Mat*);
319014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetTrace(Mat,PetscScalar*);
320713ccfa9SJed Brown PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat,const PetscScalar **);
3210da83c2eSBarry Smith PETSC_EXTERN PetscErrorCode MatInvertVariableBlockDiagonal(Mat,PetscInt,const PetscInt*,PetscScalar*);
322479a70c0SJed Brown PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonalMat(Mat,Mat);
32399cafbc1SBarry Smith 
3248ed539a5SBarry Smith /* ------------------------------------------------------------*/
325014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
326014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
327014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
328014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
329014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat,PetscInt,PetscInt,PetscInt[],const PetscScalar[]);
33073a71a0fSBarry Smith PETSC_EXTERN PetscErrorCode MatSetRandom(Mat,PetscRandom);
33184cb2905SBarry Smith 
3322ef4de8bSBarry Smith /*S
3332ef4de8bSBarry Smith      MatStencil - Data structure (C struct) for storing information about a single row or
33462ef0227SBarry Smith         column of a matrix as indexed on an associated grid. These are arguments to MatSetStencil() and MatSetBlockStencil()
33562ef0227SBarry Smith 
33662ef0227SBarry Smith    The i,j, and k represent the logical coordinates over the entire grid (for 2 and 1 dimensional problems the k and j entries are ignored).
33762ef0227SBarry Smith    The c represents the the degrees of freedom at each grid point (the dof argument to DMDASetDOF()). If dof is 1 then this entry is ignored.
33862ef0227SBarry Smith 
33962ef0227SBarry Smith    For stencil access to vectors see DMDAVecGetArray(), DMDAVecGetArrayF90().
340be479b30SJed Brown 
341be479b30SJed Brown    Fortran usage is different, see MatSetValuesStencil() for details.
3422ef4de8bSBarry Smith 
3432ef4de8bSBarry Smith    Level: beginner
3442ef4de8bSBarry Smith 
34562ef0227SBarry Smith .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockedStencil(), DMDAVecGetArray(), DMDAVecGetArrayF90()
3462ef4de8bSBarry Smith S*/
347435da068SBarry Smith typedef struct {
348c1ac3661SBarry Smith   PetscInt k,j,i,c;
349435da068SBarry Smith } MatStencil;
3502ef4de8bSBarry Smith 
351014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
352014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
353014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
354435da068SBarry Smith 
355d91e6319SBarry Smith /*E
356d91e6319SBarry Smith     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
35762ef0227SBarry Smith      to continue to add or insert values to it
358d91e6319SBarry Smith 
359d91e6319SBarry Smith     Level: beginner
360d91e6319SBarry Smith 
361d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd()
362d91e6319SBarry Smith E*/
3636d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
364014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType);
365014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType);
366014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssembled(Mat,PetscBool *);
3674f9c727eSBarry Smith 
3681d73ed98SBarry Smith 
36930de9b25SBarry Smith 
370d91e6319SBarry Smith /*E
371d91e6319SBarry Smith     MatOption - Options that may be set for a matrix and its behavior or storage
372d91e6319SBarry Smith 
373d91e6319SBarry Smith     Level: beginner
374d91e6319SBarry Smith 
375af0996ceSBarry Smith    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
3760f8fb01aSBarry Smith    Any additions/changes here must also be made in src/mat/interface/dlregismat.c in MatOptions[]
377d91e6319SBarry Smith 
37895452b02SPatrick Sanan    Developer Notes:
37995452b02SPatrick Sanan     Entries that are negative need not be called collectively by all processes.
380382164b0SBarry Smith 
381d91e6319SBarry Smith .seealso: MatSetOption()
382d91e6319SBarry Smith E*/
383c5e4d11fSDmitry Karpeev typedef enum {MAT_OPTION_MIN = -3,
384c5e4d11fSDmitry Karpeev               MAT_UNUSED_NONZERO_LOCATION_ERR = -2,
38592d4d306SBarry Smith               MAT_ROW_ORIENTED = -1,
386382164b0SBarry Smith               MAT_SYMMETRIC = 1,
387382164b0SBarry Smith               MAT_STRUCTURALLY_SYMMETRIC = 2,
388382164b0SBarry Smith               MAT_NEW_DIAGONALS = 3,
389382164b0SBarry Smith               MAT_IGNORE_OFF_PROC_ENTRIES = 4,
390382164b0SBarry Smith               MAT_USE_HASH_TABLE = 5,
391382164b0SBarry Smith               MAT_KEEP_NONZERO_PATTERN = 6,
392382164b0SBarry Smith               MAT_IGNORE_ZERO_ENTRIES = 7,
393382164b0SBarry Smith               MAT_USE_INODES = 8,
394382164b0SBarry Smith               MAT_HERMITIAN = 9,
395382164b0SBarry Smith               MAT_SYMMETRY_ETERNAL = 10,
396c5e4d11fSDmitry Karpeev               MAT_NEW_NONZERO_LOCATION_ERR = 11,
397382164b0SBarry Smith               MAT_IGNORE_LOWER_TRIANGULAR = 12,
398382164b0SBarry Smith               MAT_ERROR_LOWER_TRIANGULAR = 13,
399382164b0SBarry Smith               MAT_GETROW_UPPERTRIANGULAR = 14,
400382164b0SBarry Smith               MAT_SPD = 15,
40192d4d306SBarry Smith               MAT_NO_OFF_PROC_ZERO_ROWS = 16,
40292d4d306SBarry Smith               MAT_NO_OFF_PROC_ENTRIES = 17,
40392d4d306SBarry Smith               MAT_NEW_NONZERO_LOCATIONS = 18,
404c5e4d11fSDmitry Karpeev               MAT_NEW_NONZERO_ALLOCATION_ERR = 19,
405c5e4d11fSDmitry Karpeev               MAT_SUBSET_OFF_PROC_ENTRIES = 20,
406c10200c1SHong Zhang               MAT_SUBMAT_SINGLEIS = 21,
407957cac9fSHong Zhang               MAT_STRUCTURE_ONLY = 22,
408071fcb05SBarry Smith               MAT_SORTED_FULL = 23,
409071fcb05SBarry Smith               MAT_OPTION_MAX = 24} MatOption;
410e057df02SPaul Mullowney 
4110f8fb01aSBarry Smith PETSC_EXTERN const char *const *MatOptions;
412014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscBool);
4137d68702bSBarry Smith PETSC_EXTERN PetscErrorCode MatGetOption(Mat,MatOption,PetscBool*);
41419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatGetType(Mat,MatType*);
41584cb2905SBarry Smith 
416014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
417014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
418014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
419014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat);
420014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat);
421014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt);
4228c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat,PetscScalar *[]);
4238c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat,PetscScalar *[]);
42421e72a00SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJGetMaxRowNonzeros(Mat,PetscInt*);
425bd04181cSBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJSetValuesLocalFast(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
4264099cc6bSBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJSetType(Mat,MatType);
427388d47a6SSatish Balay PETSC_EXTERN PetscErrorCode MatSeqAIJRegister(const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat *));
4284099cc6bSBarry Smith PETSC_EXTERN PetscFunctionList MatSeqAIJList;
4298397e458SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqSBAIJGetArray(Mat,PetscScalar *[]);
4308397e458SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqSBAIJRestoreArray(Mat,PetscScalar *[]);
4318c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat,PetscScalar *[]);
4328c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat,PetscScalar *[]);
433d3042a70SBarry Smith PETSC_EXTERN PetscErrorCode MatDensePlaceArray(Mat,const PetscScalar[]);
434d3042a70SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseResetArray(Mat);
4358572280aSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetArrayRead(Mat,const PetscScalar *[]);
4368572280aSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayRead(Mat,const PetscScalar *[]);
437014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *);
438014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt);
439014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat,PetscInt *,PetscInt *);
440014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat,PetscInt,PetscInt);
44133d57670SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSizesFromMats(Mat,Mat,Mat);
4420da83c2eSBarry Smith PETSC_EXTERN PetscErrorCode MatSetVariableBlockSizes(Mat,PetscInt,PetscInt*);
4430da83c2eSBarry Smith PETSC_EXTERN PetscErrorCode MatGetVariableBlockSizes(Mat,PetscInt*,const PetscInt**);
4440da83c2eSBarry Smith 
44586aefd0dSHong Zhang PETSC_EXTERN PetscErrorCode MatDenseGetColumn(Mat,PetscInt,PetscScalar *[]);
44686aefd0dSHong Zhang PETSC_EXTERN PetscErrorCode MatDenseRestoreColumn(Mat,PetscScalar *[]);
4471620fd73SBarry Smith 
448014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMult(Mat,Vec,Vec);
449014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec);
450014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec);
451014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec);
452014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec);
453014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *);
454014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *);
455014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec);
456014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
457014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultConstrained(Mat,Vec,Vec);
458014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeConstrained(Mat,Vec,Vec);
459014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat);
460bdc285e1SStefano Zampini PETSC_EXTERN PetscErrorCode MatMatSolveTranspose(Mat,Mat,Mat);
461eb3ef3b2SHong Zhang PETSC_EXTERN PetscErrorCode MatMatTransposeSolve(Mat,Mat,Mat);
462f9426fe0SMark Adams PETSC_EXTERN PetscErrorCode MatResidual(Mat,Vec,Vec,Vec);
463f5edf698SHong Zhang 
464d91e6319SBarry Smith /*E
465d91e6319SBarry Smith     MatDuplicateOption - Indicates if a duplicated sparse matrix should have
466d91e6319SBarry Smith   its numerical values copied over or just its nonzero structure.
467d91e6319SBarry Smith 
468d91e6319SBarry Smith     Level: beginner
469d91e6319SBarry Smith 
470af0996ceSBarry Smith    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
471d91e6319SBarry Smith 
4720018da39SRichard Tran Mills $   MAT_DO_NOT_COPY_VALUES    - Create a matrix using the same nonzero pattern as the original matrix,
4730018da39SRichard Tran Mills $                               with zeros for the numerical values.
4740018da39SRichard Tran Mills $   MAT_COPY_VALUES           - Create a matrix with the same nonzero pattern as the original matrix
4750018da39SRichard Tran Mills $                               and with the same numerical values.
4760018da39SRichard Tran Mills $   MAT_SHARE_NONZERO_PATTERN - Create a matrix that shares the nonzero structure with the previous matrix
4770018da39SRichard Tran Mills $                               and does not copy it, using zeros for the numerical values. The parent and
4780018da39SRichard Tran Mills $                               child matrices will share their index (i and j) arrays, and you cannot
4790018da39SRichard Tran Mills $                               insert new nonzero entries into either matrix.
4800018da39SRichard Tran Mills 
48195452b02SPatrick Sanan Notes:
48295452b02SPatrick Sanan     Many matrix types (including SeqAIJ) do not support the MAT_SHARE_NONZERO_PATTERN optimization; in
4830018da39SRichard Tran Mills this case the behavior is as if MAT_DO_NOT_COPY_VALUES has been specified.
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 
48919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*);
490014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*);
49194a9d846SBarry Smith 
492cb5b572fSBarry Smith 
493014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure);
494014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer);
495014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *);
496014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *);
497014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *);
498014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *);
499014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *);
500014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool  *,PetscInt *);
501014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer);
5027b80b807SBarry Smith 
5031a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
5041a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);
5051a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
5061a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);
507d4fbbf0eSBarry Smith 
508d91e6319SBarry Smith /*S
509d91e6319SBarry Smith      MatInfo - Context of matrix information, used with MatGetInfo()
510d91e6319SBarry Smith 
511d91e6319SBarry Smith    In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
512d91e6319SBarry Smith 
513d91e6319SBarry Smith    Level: intermediate
514d91e6319SBarry Smith 
515d9274352SBarry Smith .seealso:  MatGetInfo(), MatInfoType
516d91e6319SBarry Smith S*/
5174e220ebcSLois Curfman McInnes typedef struct {
518b0a32e0cSBarry Smith   PetscLogDouble block_size;                         /* block size */
519b0a32e0cSBarry Smith   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
520b0a32e0cSBarry Smith   PetscLogDouble memory;                             /* memory allocated */
521b0a32e0cSBarry Smith   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
522b0a32e0cSBarry Smith   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
523b0a32e0cSBarry Smith   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
524b0a32e0cSBarry Smith   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
5254e220ebcSLois Curfman McInnes } MatInfo;
5264e220ebcSLois Curfman McInnes 
527d9274352SBarry Smith /*E
528d9274352SBarry Smith     MatInfoType - Indicates if you want information about the local part of the matrix,
529d9274352SBarry Smith      the entire parallel matrix or the maximum over all the local parts.
530d9274352SBarry Smith 
531d9274352SBarry Smith     Level: beginner
532d9274352SBarry Smith 
533af0996ceSBarry Smith    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
534d9274352SBarry Smith 
535d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo
536d9274352SBarry Smith E*/
5377b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
538014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*);
539014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec);
540014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]);
541014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]);
542014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
543014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]);
544014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat,Vec);
545014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*);
546014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*);
547014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat*);
548014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec);
549014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode);
550a52676ecSHong Zhang 
551014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool*);
552014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool*);
553014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool*);
554014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool*);
555014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*);
556a52676ecSHong Zhang PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
557a52676ecSHong Zhang PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
558cc48ffa7SToby Isaac PETSC_EXTERN PetscErrorCode MatMatTransposeMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
55986919fd6SHong Zhang PETSC_EXTERN PetscErrorCode MatIsLinear(Mat,PetscInt,PetscBool*);
5607b80b807SBarry Smith 
561014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal*);
562014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal*);
563014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat);
564014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
565014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec);
566014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec);
567014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec);
568014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
569014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec);
5707b80b807SBarry Smith 
571014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*);
572014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*);
573014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
574014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**);
575014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
576014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**);
577566876eaSJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*);
5785ef9f2a5SBarry Smith 
5797dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
58025ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatCreateSubMatrices() (since version 3.8)") PETSC_STATIC_INLINE PetscErrorCode MatGetSubMatrices(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[]) {return MatCreateSubMatrices(mat,n,irow,icol,scall,submat);}
5817dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
58225ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatCreateSubMatricesMPI() (since version 3.8)") PETSC_STATIC_INLINE PetscErrorCode MatGetSubMatricesMPI(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[]) {return MatCreateSubMatricesMPI(mat,n,irow,icol,scall,submat);}
583014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]);
584df750dc8SHong Zhang PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt,Mat *[]);
5857dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,MatReuse,Mat *);
58625ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatCreateSubMatrix() (since version 3.8)") PETSC_STATIC_INLINE PetscErrorCode MatGetSubMatrix(Mat mat,IS isrow,IS iscol,MatReuse cll,Mat *newmat) {return MatCreateSubMatrix(mat,isrow,iscol,cll,newmat);}
587014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*);
588014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*);
589014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*);
590014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*);
5917b80b807SBarry Smith 
592014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
593014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
594014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat);
595014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*);
596014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
597014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*);
598014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);
5998efafbd8SBarry Smith 
600014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
601aa1e27eaSFande Kong PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat mat,PetscInt n,IS is[],PetscInt ov);
602d2b2a242SBarry Smith PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat,PetscBool);
6037b80b807SBarry Smith 
604014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
605014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
606014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatMultNumeric(Mat,Mat,Mat);
60722440eb1SKris Buschelman 
6087bab7c10SHong Zhang PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
6092df6c5c3SPatrick Farrell PETSC_EXTERN PetscErrorCode MatGalerkin(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
6107bab7c10SHong Zhang 
611014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
612014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
613014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPtAPNumeric(Mat,Mat,Mat);
614014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*);
615014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRARtSymbolic(Mat,Mat,PetscReal,Mat*);
616014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRARtNumeric(Mat,Mat,Mat);
61722440eb1SKris Buschelman 
618014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
619014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposetMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
620014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposetMatMultNumeric(Mat,Mat,Mat);
621014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*);
622014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatTransposeMultSymbolic(Mat,Mat,PetscReal,Mat*);
623014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatTransposeMultNumeric(Mat,Mat,Mat);
624bc011b1eSHong Zhang 
625014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure);
626014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure);
6271c741599SHong Zhang 
628014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar);
629014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar);
6307b80b807SBarry Smith 
631014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
632014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*);
633a93ff8c4SPeter Brune PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat,PetscLayout*,PetscLayout*);
634014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
635014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
636014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
637014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
638014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
639014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
640052efed2SBarry Smith 
641014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt);
642014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
64390f02eecSBarry Smith 
644014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec);
645014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec);
646014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec);
6472a7a6963SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat,Vec*,Vec*);
64825ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatCreateVecs() (since version 3.6)") PETSC_STATIC_INLINE PetscErrorCode MatGetVecs(Mat mat,Vec *x,Vec *y) {return MatCreateVecs(mat,x,y);}
64953cd1579SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat,PetscInt,MPI_Comm,MatReuse,Mat*);
650014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*);
651014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*);
6523a062f41SBarry Smith PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat,IS*);
6539c8f2541SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
654bd481603SBarry Smith 
655bd481603SBarry Smith /*MC
6561620fd73SBarry Smith    MatSetValue - Set a single entry into a matrix.
6571620fd73SBarry Smith 
6581620fd73SBarry Smith    Not collective
6591620fd73SBarry Smith 
660a9834a7dSSatish Balay    Synopsis:
661a9834a7dSSatish Balay      #include <petscmat.h>
662a9834a7dSSatish Balay      PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode)
663a9834a7dSSatish Balay 
6641620fd73SBarry Smith    Input Parameters:
6651620fd73SBarry Smith +  m - the matrix
6661620fd73SBarry Smith .  row - the row location of the entry
6671620fd73SBarry Smith .  col - the column location of the entry
6681620fd73SBarry Smith .  value - the value to insert
6691620fd73SBarry Smith -  mode - either INSERT_VALUES or ADD_VALUES
6701620fd73SBarry Smith 
6711620fd73SBarry Smith    Notes:
6721620fd73SBarry Smith    For efficiency one should use MatSetValues() and set several or many
6731620fd73SBarry Smith    values simultaneously if possible.
6741620fd73SBarry Smith 
6751620fd73SBarry Smith    Level: beginner
6761620fd73SBarry Smith 
6771620fd73SBarry Smith .seealso: MatSetValues(), MatSetValueLocal()
6781620fd73SBarry Smith M*/
6791620fd73SBarry 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);}
6801620fd73SBarry Smith 
6811620fd73SBarry Smith PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);}
6821620fd73SBarry Smith 
6831620fd73SBarry 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);}
6841620fd73SBarry Smith 
6851620fd73SBarry Smith /*MC
6860d2a7ff2SSatish Balay    MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
687bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
688bd481603SBarry Smith 
689bd481603SBarry Smith    Synopsis:
690aaa7dc30SBarry Smith    #include <petscmat.h>
691c1ac3661SBarry Smith    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
692bd481603SBarry Smith 
693d083f849SBarry Smith    Collective
694bd481603SBarry Smith 
695bd481603SBarry Smith    Input Parameters:
696bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
697859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
698859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
699bd481603SBarry Smith 
700bd481603SBarry Smith    Output Parameters:
701bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
702a6042fd4SStefano Zampini -  onz - the other array passed to the matrix preallocation routines
703bd481603SBarry Smith 
704bd481603SBarry Smith    Level: intermediate
705bd481603SBarry Smith 
706bd481603SBarry Smith    Notes:
707a7f22e61SSatish Balay     See Users-Manual: ch_performance for more details.
708bd481603SBarry Smith 
7091d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
710bd481603SBarry Smith 
7111620fd73SBarry Smith    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
7121620fd73SBarry Smith 
713d6e23781SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
714de25e9cbSPierre Jolivet           MatPreallocateSymmetricSetLocalBlock()
715bd481603SBarry Smith M*/
716c4f061fbSSatish Balay #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
717e83a5d19SLisandro Dalcin do { \
718a6042fd4SStefano Zampini   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ncols = (ncols),__rstart,__start,__end; \
7197282cfc1SLisandro Dalcin   _4_ierr = PetscCalloc2((size_t)__nrows,&dnz,(size_t)__nrows,&onz);CHKERRQ(_4_ierr); \
7201795a4d1SJed Brown   __start = 0; __end = __start;                                         \
721a6042fd4SStefano Zampini   _4_ierr = MPI_Scan(&__ncols,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ncols;\
722e83a5d19SLisandro Dalcin   _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows; \
723e83a5d19SLisandro Dalcin   do { } while(0)
7247c922b88SBarry Smith 
725bd481603SBarry Smith /*MC
726bd481603SBarry Smith    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
727bd481603SBarry Smith        inserted using a local number of the rows and columns
728bd481603SBarry Smith 
729bd481603SBarry Smith    Synopsis:
730aaa7dc30SBarry Smith    #include <petscmat.h>
731c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
732bd481603SBarry Smith 
733bd481603SBarry Smith    Not Collective
734bd481603SBarry Smith 
735bd481603SBarry Smith    Input Parameters:
736784ac674SJed Brown +  map - the row mapping from local numbering to global numbering
737bd481603SBarry Smith .  nrows - the number of rows indicated
7381d73ed98SBarry Smith .  rows - the indices of the rows
739784ac674SJed Brown .  cmap - the column mapping from local to global numbering
740bd481603SBarry Smith .  ncols - the number of columns in the matrix
741bd481603SBarry Smith .  cols - the columns indicated
742bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
743a6042fd4SStefano Zampini -  onz - the other array passed to the matrix preallocation routines
744bd481603SBarry Smith 
745bd481603SBarry Smith    Level: intermediate
746bd481603SBarry Smith 
747bd481603SBarry Smith    Notes:
748a7f22e61SSatish Balay     See Users-Manual: ch_performance for more details.
749bd481603SBarry Smith 
7501d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
751bd481603SBarry Smith 
752a6042fd4SStefano Zampini .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
753c1154cd5SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocalRemoveDups()
754bd481603SBarry Smith M*/
755784ac674SJed Brown #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
756e83a5d19SLisandro Dalcin do {\
757c1ac3661SBarry Smith   PetscInt __l;\
758784ac674SJed Brown   _4_ierr = ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
759784ac674SJed Brown   _4_ierr = ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
760c4f061fbSSatish Balay   for (__l=0;__l<nrows;__l++) {\
761ef66eb69SBarry Smith     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
762c4f061fbSSatish Balay   }\
763e83a5d19SLisandro Dalcin  } while (0)
764c4f061fbSSatish Balay 
765bd481603SBarry Smith /*MC
766c1154cd5SBarry Smith    MatPreallocateSetLocalRemoveDups - Indicates the locations (rows and columns) in the matrix where nonzeros will be
767c1154cd5SBarry Smith        inserted using a local number of the rows and columns. This version removes any duplicate columns in cols
768c1154cd5SBarry Smith 
769c1154cd5SBarry Smith    Synopsis:
770c1154cd5SBarry Smith    #include <petscmat.h>
771c1154cd5SBarry Smith    PetscErrorCode MatPreallocateSetLocalRemoveDups(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
772c1154cd5SBarry Smith 
773c1154cd5SBarry Smith    Not Collective
774c1154cd5SBarry Smith 
775c1154cd5SBarry Smith    Input Parameters:
776c1154cd5SBarry Smith +  map - the row mapping from local numbering to global numbering
777c1154cd5SBarry Smith .  nrows - the number of rows indicated
778c1154cd5SBarry Smith .  rows - the indices of the rows (these values are mapped to the global values)
779c1154cd5SBarry Smith .  cmap - the column mapping from local to global numbering
780c1154cd5SBarry Smith .  ncols - the number of columns in the matrix   (this value will be changed if duplicate columns are found)
781c1154cd5SBarry Smith .  cols - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed)
782c1154cd5SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
783a6042fd4SStefano Zampini -  onz - the other array passed to the matrix preallocation routines
784c1154cd5SBarry Smith 
785c1154cd5SBarry Smith    Level: intermediate
786c1154cd5SBarry Smith 
787c1154cd5SBarry Smith    Notes:
788c1154cd5SBarry Smith     See Users-Manual: ch_performance for more details.
789c1154cd5SBarry Smith 
790c1154cd5SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
791c1154cd5SBarry Smith 
792a6042fd4SStefano Zampini .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
793c1154cd5SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal()
794c1154cd5SBarry Smith M*/
795c1154cd5SBarry Smith #define MatPreallocateSetLocalRemoveDups(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
796e83a5d19SLisandro Dalcin do {\
797c1154cd5SBarry Smith   PetscInt __l;\
798c1154cd5SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
799c1154cd5SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
800c1154cd5SBarry Smith   _4_ierr = PetscSortRemoveDupsInt(&ncols,cols);CHKERRQ(_4_ierr);\
801c1154cd5SBarry Smith   for (__l=0;__l<nrows;__l++) {\
802c1154cd5SBarry Smith     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
803c1154cd5SBarry Smith   }\
804e83a5d19SLisandro Dalcin  } while (0)
805c1154cd5SBarry Smith 
806c1154cd5SBarry Smith /*MC
807d6e23781SBarry Smith    MatPreallocateSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
808bd481603SBarry Smith        inserted using a local number of the rows and columns
809bd481603SBarry Smith 
810bd481603SBarry Smith    Synopsis:
811aaa7dc30SBarry Smith    #include <petscmat.h>
812d6e23781SBarry Smith    PetscErrorCode MatPreallocateSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
813d6e23781SBarry Smith 
814d6e23781SBarry Smith    Not Collective
815d6e23781SBarry Smith 
816d6e23781SBarry Smith    Input Parameters:
817d6e23781SBarry Smith +  map - the row mapping from local numbering to global numbering
818d6e23781SBarry Smith .  nrows - the number of rows indicated
819d6e23781SBarry Smith .  rows - the indices of the rows
820d6e23781SBarry Smith .  cmap - the column mapping from local to global numbering
821d6e23781SBarry Smith .  ncols - the number of columns in the matrix
822d6e23781SBarry Smith .  cols - the columns indicated
823d6e23781SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
824a6042fd4SStefano Zampini -  onz - the other array passed to the matrix preallocation routines
825d6e23781SBarry Smith 
826d6e23781SBarry Smith    Level: intermediate
827d6e23781SBarry Smith 
828d6e23781SBarry Smith    Notes:
829d6e23781SBarry Smith     See Users-Manual: ch_performance for more details.
830d6e23781SBarry Smith 
831d6e23781SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
832d6e23781SBarry Smith 
833a6042fd4SStefano Zampini .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
834d6e23781SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock()
835d6e23781SBarry Smith M*/
836d6e23781SBarry Smith #define MatPreallocateSetLocalBlock(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
837e83a5d19SLisandro Dalcin do {\
838d6e23781SBarry Smith   PetscInt __l;\
839d6e23781SBarry Smith   _4_ierr = ISLocalToGlobalMappingApplyBlock(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
840d6e23781SBarry Smith   _4_ierr = ISLocalToGlobalMappingApplyBlock(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
841d6e23781SBarry Smith   for (__l=0;__l<nrows;__l++) {\
842d6e23781SBarry Smith     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
843d6e23781SBarry Smith   }\
844e83a5d19SLisandro Dalcin } while (0)
845d6e23781SBarry Smith 
846d6e23781SBarry Smith /*MC
847d6e23781SBarry Smith    MatPreallocateSymmetricSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
848d6e23781SBarry Smith        inserted using a local number of the rows and columns
849d6e23781SBarry Smith 
850d6e23781SBarry Smith    Synopsis:
851d6e23781SBarry Smith    #include <petscmat.h>
852d6e23781SBarry Smith    PetscErrorCode MatPreallocateSymmetricSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
853bd481603SBarry Smith 
854bd481603SBarry Smith    Not Collective
855bd481603SBarry Smith 
856bd481603SBarry Smith    Input Parameters:
857bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
858bd481603SBarry Smith .  nrows - the number of rows indicated
8591d73ed98SBarry Smith .  rows - the indices of the rows
860bd481603SBarry Smith .  ncols - the number of columns in the matrix
861bd481603SBarry Smith .  cols - the columns indicated
862bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
863a6042fd4SStefano Zampini -  onz - the other array passed to the matrix preallocation routines
864bd481603SBarry Smith 
865bd481603SBarry Smith    Level: intermediate
866bd481603SBarry Smith 
867bd481603SBarry Smith    Notes:
868a7f22e61SSatish Balay     See Users-Manual: ch_performance for more details.
869bd481603SBarry Smith 
870bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
871bd481603SBarry Smith 
872a6042fd4SStefano Zampini .seealso: MatPreallocateFinalize(), MatPreallocateSet()
873d6e23781SBarry Smith           MatPreallocateInitialize(),  MatPreallocateSetLocal()
874bd481603SBarry Smith M*/
875d6e23781SBarry Smith #define MatPreallocateSymmetricSetLocalBlock(map,nrows,rows,ncols,cols,dnz,onz) 0;\
876e83a5d19SLisandro Dalcin do {\
877c1ac3661SBarry Smith   PetscInt __l;\
878d6e23781SBarry Smith   _4_ierr = ISLocalToGlobalMappingApplyBlock(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
879d6e23781SBarry Smith   _4_ierr = ISLocalToGlobalMappingApplyBlock(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
880d3d32019SBarry Smith   for (__l=0;__l<nrows;__l++) {\
881d6e23781SBarry Smith     _4_ierr = MatPreallocateSymmetricSetBlock((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
882d3d32019SBarry Smith   }\
883e83a5d19SLisandro Dalcin } while (0)
884e83a5d19SLisandro Dalcin 
885bd481603SBarry Smith /*MC
886bd481603SBarry Smith    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
887bd481603SBarry Smith        inserted using a local number of the rows and columns
888bd481603SBarry Smith 
889bd481603SBarry Smith    Synopsis:
890aaa7dc30SBarry Smith    #include <petscmat.h>
891c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
892bd481603SBarry Smith 
893bd481603SBarry Smith    Not Collective
894bd481603SBarry Smith 
895bd481603SBarry Smith    Input Parameters:
89664075487SBarry Smith +  row - the row
897bd481603SBarry Smith .  ncols - the number of columns in the matrix
898a50f8bf6SHong Zhang -  cols - the columns indicated
899a50f8bf6SHong Zhang 
900a50f8bf6SHong Zhang    Output Parameters:
901a50f8bf6SHong Zhang +  dnz - the array that will be passed to the matrix preallocation routines
902a6042fd4SStefano Zampini -  onz - the other array passed to the matrix preallocation routines
903bd481603SBarry Smith 
904bd481603SBarry Smith    Level: intermediate
905bd481603SBarry Smith 
906bd481603SBarry Smith    Notes:
907a7f22e61SSatish Balay     See Users-Manual: ch_performance for more details.
908bd481603SBarry Smith 
909bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
910bd481603SBarry Smith 
9111620fd73SBarry Smith    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
9121620fd73SBarry Smith 
913a6042fd4SStefano Zampini .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
914d6e23781SBarry Smith           MatPreallocateInitialize(), MatPreallocateSetLocal()
915bd481603SBarry Smith M*/
916c4f061fbSSatish Balay #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
917e83a5d19SLisandro Dalcin do { PetscInt __i; \
918e32f2f54SBarry 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);\
919e32f2f54SBarry 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);\
9207c922b88SBarry Smith   for (__i=0; __i<nc; __i++) {\
92164075487SBarry Smith     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
922a6042fd4SStefano Zampini     else if (dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\
9237c922b88SBarry Smith   }\
924e83a5d19SLisandro Dalcin } while (0)
9257c922b88SBarry Smith 
926bd481603SBarry Smith /*MC
927d6e23781SBarry Smith    MatPreallocateSymmetricSetBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
928bd481603SBarry Smith        inserted using a local number of the rows and columns
929bd481603SBarry Smith 
930bd481603SBarry Smith    Synopsis:
931aaa7dc30SBarry Smith    #include <petscmat.h>
932d6e23781SBarry Smith    PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
933bd481603SBarry Smith 
934bd481603SBarry Smith    Not Collective
935bd481603SBarry Smith 
936bd481603SBarry Smith    Input Parameters:
937bd481603SBarry Smith +  nrows - the number of rows indicated
9381d73ed98SBarry Smith .  rows - the indices of the rows
939bd481603SBarry Smith .  ncols - the number of columns in the matrix
940bd481603SBarry Smith .  cols - the columns indicated
941bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
942a6042fd4SStefano Zampini -  onz - the other array passed to the matrix preallocation routines
943bd481603SBarry Smith 
944bd481603SBarry Smith    Level: intermediate
945bd481603SBarry Smith 
946bd481603SBarry Smith    Notes:
947a7f22e61SSatish Balay     See Users-Manual: ch_performance for more details.
948bd481603SBarry Smith 
949bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
950bd481603SBarry Smith 
9511620fd73SBarry Smith    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
9521620fd73SBarry Smith 
953d6e23781SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(),  MatPreallocateInitialize(),
954a6042fd4SStefano Zampini           MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal()
955bd481603SBarry Smith M*/
956d6e23781SBarry Smith #define MatPreallocateSymmetricSetBlock(row,nc,cols,dnz,onz) 0;\
957e83a5d19SLisandro Dalcin do { PetscInt __i; \
958d3d32019SBarry Smith   for (__i=0; __i<nc; __i++) {\
959d3d32019SBarry Smith     if (cols[__i] >= __end) onz[row - __rstart]++; \
960a6042fd4SStefano Zampini     else if (cols[__i] >= row && dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\
961d3d32019SBarry Smith   }\
962e83a5d19SLisandro Dalcin } while (0)
963d3d32019SBarry Smith 
964bd481603SBarry Smith /*MC
965a6042fd4SStefano Zampini    MatPreallocateLocation -  An alternative to MatPreallocateSet() that puts the nonzero locations into the matrix if it exists
96616371a99SBarry Smith 
96716371a99SBarry Smith    Synopsis:
968aaa7dc30SBarry Smith    #include <petscmat.h>
96916371a99SBarry Smith    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)
97016371a99SBarry Smith 
97116371a99SBarry Smith    Not Collective
97216371a99SBarry Smith 
97316371a99SBarry Smith    Input Parameters:
974a2b725a8SWilliam Gropp +  A - matrix
97516371a99SBarry Smith .  row - row where values exist (must be local to this process)
97616371a99SBarry Smith .  ncols - number of columns
97716371a99SBarry Smith .  cols - columns with nonzeros
97816371a99SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
979a6042fd4SStefano Zampini -  onz - the other array passed to the matrix preallocation routines
98016371a99SBarry Smith 
98116371a99SBarry Smith    Level: intermediate
98216371a99SBarry Smith 
98316371a99SBarry Smith    Notes:
984a7f22e61SSatish Balay     See Users-Manual: ch_performance for more details.
98516371a99SBarry Smith 
98616371a99SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
98716371a99SBarry Smith 
98816371a99SBarry Smith    This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.
98916371a99SBarry Smith 
990d6e23781SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
991d6e23781SBarry Smith           MatPreallocateSymmetricSetLocalBlock()
99216371a99SBarry Smith M*/
993e83a5d19SLisandro Dalcin #define MatPreallocateLocation(A,row,ncols,cols,dnz,onz) 0; do {if (A) {ierr = MatSetValues(A,1,&row,ncols,cols,NULL,INSERT_VALUES);CHKERRQ(ierr);} else {ierr =  MatPreallocateSet(row,ncols,cols,dnz,onz);CHKERRQ(ierr);}} while(0)
99416371a99SBarry Smith 
99516371a99SBarry Smith 
99616371a99SBarry Smith /*MC
9970d2a7ff2SSatish Balay    MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
998bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
999bd481603SBarry Smith 
1000bd481603SBarry Smith    Synopsis:
1001aaa7dc30SBarry Smith    #include <petscmat.h>
1002c1ac3661SBarry Smith    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
1003bd481603SBarry Smith 
1004d083f849SBarry Smith    Collective
1005bd481603SBarry Smith 
1006bd481603SBarry Smith    Input Parameters:
100716371a99SBarry Smith +  dnz - the array that was be passed to the matrix preallocation routines
1008a6042fd4SStefano Zampini -  onz - the other array passed to the matrix preallocation routines
1009bd481603SBarry Smith 
1010bd481603SBarry Smith    Level: intermediate
1011bd481603SBarry Smith 
1012bd481603SBarry Smith    Notes:
1013a7f22e61SSatish Balay     See Users-Manual: ch_performance for more details.
1014bd481603SBarry Smith 
1015bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
1016bd481603SBarry Smith 
10171620fd73SBarry Smith    This is a MACRO not a function because it closes the { started in MatPreallocateInitialize().
10181620fd73SBarry Smith 
1019d6e23781SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
1020d6e23781SBarry Smith           MatPreallocateSymmetricSetLocalBlock()
1021bd481603SBarry Smith M*/
1022e83a5d19SLisandro Dalcin #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree2(dnz,onz);CHKERRQ(_4_ierr);} while(0)
10237c922b88SBarry Smith 
10247b80b807SBarry Smith /* Routines unique to particular data structures */
1025014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat,void *);
1026698d4c6aSKris Buschelman 
1027014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*);
1028014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
1029698d4c6aSKris Buschelman 
1030014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
1031014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
1032014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1033014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1034014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1035014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool);
10367b80b807SBarry Smith 
1037a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4
1038a96a251dSBarry Smith 
1039014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1040014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1041014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
1042273d9f13SBarry Smith 
1043014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1044014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1045014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1046014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
1047014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1048014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
1049014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1050014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
1051b44e7856SBarry Smith PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat,Mat*);
1052014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
1053014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
10549230625dSJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
10559230625dSJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
1056014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*);
1057273d9f13SBarry Smith 
1058014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt);
105949a6ff4bSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetLDA(Mat,PetscInt*);
1060014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*);
10611b807ce4Svictorle 
1062621e819fSSatish Balay PETSC_EXTERN PetscErrorCode MatBlockMatSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1063621e819fSSatish Balay 
1064014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStoreValues(Mat);
1065014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat);
10662e8a6d31SBarry Smith 
1067014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDAADSetCtx(Mat,void*);
10683a7fca6bSBarry Smith 
1069014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*);
10707cfe41e4SPatrick Farrell PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat,IS*);
10717b80b807SBarry Smith /*
10727b80b807SBarry Smith   These routines are not usually accessed directly, rather solving is
107394b7f48cSBarry Smith   done through the KSP and PC interfaces.
10747b80b807SBarry Smith */
10757b80b807SBarry Smith 
107676bdecfbSBarry Smith /*J
10778f6c3df8SBarry Smith     MatOrderingType - String with the name of a PETSc matrix ordering
1078d9274352SBarry Smith 
1079d9274352SBarry Smith    Level: beginner
1080d9274352SBarry Smith 
1081d9274352SBarry Smith .seealso: MatGetOrdering()
108276bdecfbSBarry Smith J*/
108319fd82e9SBarry Smith typedef const char* MatOrderingType;
10842692d6eeSBarry Smith #define MATORDERINGNATURAL     "natural"
10852692d6eeSBarry Smith #define MATORDERINGND          "nd"
10862692d6eeSBarry Smith #define MATORDERING1WD         "1wd"
10872692d6eeSBarry Smith #define MATORDERINGRCM         "rcm"
10882692d6eeSBarry Smith #define MATORDERINGQMD         "qmd"
10892692d6eeSBarry Smith #define MATORDERINGROWLENGTH   "rowlength"
1090510184a7SJed Brown #define MATORDERINGWBM         "wbm"
1091fc1bef75SJed Brown #define MATORDERINGSPECTRAL    "spectral"
1092312e372aSBarry Smith #define MATORDERINGAMD         "amd"            /* only works if UMFPACK is installed with PETSc */
1093b12f92e5SBarry Smith 
109419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*);
1095140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*);
1096bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*));
1097140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatOrderingList;
1098d4fbbf0eSBarry Smith 
1099014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1100fc1bef75SJed Brown PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*);
1101a2ce50c7SBarry Smith 
1102d91e6319SBarry Smith /*S
1103d90ac83dSHong Zhang     MatFactorShiftType - Numeric Shift.
1104d90ac83dSHong Zhang 
1105d90ac83dSHong Zhang    Level: beginner
1106d90ac83dSHong Zhang 
1107d90ac83dSHong Zhang S*/
1108d90ac83dSHong Zhang typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
11096a6fc655SJed Brown PETSC_EXTERN const char *const MatFactorShiftTypes[];
11105e9742b9SJed Brown PETSC_EXTERN const char *const MatFactorShiftTypesDetail[];
1111d90ac83dSHong Zhang 
1112d90ac83dSHong Zhang /*S
11139aa7eafdSHong Zhang     MatFactorError - indicates what type of error in matrix factor
11149aa7eafdSHong Zhang 
11159aa7eafdSHong Zhang     Level: beginner
11169aa7eafdSHong Zhang 
111795452b02SPatrick Sanan     Developer Notes:
111895452b02SPatrick Sanan     Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
111900e125f8SBarry Smith 
112000e125f8SBarry Smith .seealso: MatGetFactor()
11219aa7eafdSHong Zhang S*/
11225cd7cf9dSHong Zhang typedef enum {MAT_FACTOR_NOERROR,MAT_FACTOR_STRUCT_ZEROPIVOT,MAT_FACTOR_NUMERIC_ZEROPIVOT,MAT_FACTOR_OUTMEMORY,MAT_FACTOR_OTHER} MatFactorError;
11239aa7eafdSHong Zhang 
112400e125f8SBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat,MatFactorError*);
1125b8b68cfdSBarry Smith PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat);
11267b6c816cSBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat,PetscReal*,PetscInt*);
112700e125f8SBarry Smith 
11289aa7eafdSHong Zhang /*S
1129422a814eSBarry Smith    MatFactorInfo - Data passed into the matrix factorization routines, and information about the resulting factorization
1130b00f7748SHong Zhang 
113161cad860SBarry Smith    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
113261cad860SBarry Smith $     MatFactorInfo  info(MAT_FACTORINFO_SIZE)
1133b00f7748SHong Zhang 
113495452b02SPatrick Sanan    Notes:
113595452b02SPatrick Sanan     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 
1160014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*);
11619a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
11629a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
11639a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
11649a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
11659a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
11669a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
11679a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
11689a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
11699a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*);
11709a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1171014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1172014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec);
1173014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec);
1174014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec);
1175014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec);
1176014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec);
1177014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1178014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs);
11797c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat);
11807c2f51b8SStefano Zampini 
11817c2f51b8SStefano Zampini typedef enum {MAT_FACTOR_SCHUR_UNFACTORED, MAT_FACTOR_SCHUR_FACTORED, MAT_FACTOR_SCHUR_INVERTED} MatFactorSchurStatus;
11828e7ba810SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat,IS);
11837c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
11847c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat,Mat*,MatFactorSchurStatus);
11855a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat);
11867c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
11875a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat,Vec,Vec);
11885a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat,Vec,Vec);
11896dba178dSStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat);
1190bb5a7306SBarry Smith 
1191d91e6319SBarry Smith /*E
1192d91e6319SBarry Smith     MatSORType - What type of (S)SOR to perform
1193bb1eb677SSatish Balay 
1194d91e6319SBarry Smith     Level: beginner
1195d91e6319SBarry Smith 
1196d9274352SBarry Smith    May be bitwise ORd together
1197d9274352SBarry Smith 
1198af0996ceSBarry Smith    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
1199d91e6319SBarry Smith 
12004e7234bfSBarry Smith    MatSORType may be bitwise ORd together, so do not change the numbers
12014e7234bfSBarry Smith 
120241f059aeSBarry Smith .seealso: MatSOR()
1203d91e6319SBarry Smith E*/
1204ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1205ee50ffe9SBarry Smith               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1206ee50ffe9SBarry Smith               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
120784cb2905SBarry Smith               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1208014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
12098ed539a5SBarry Smith 
1210d4fbbf0eSBarry Smith /*
1211639f9d9dSBarry Smith     These routines are for efficiently computing Jacobians via finite differences.
1212639f9d9dSBarry Smith */
1213b12f92e5SBarry Smith 
12147086a01eSPeter Brune /*S
12157086a01eSPeter Brune      MatColoring - Object for managing the coloring of matrices.
12167086a01eSPeter Brune 
12177086a01eSPeter Brune    Level: beginner
12187086a01eSPeter Brune 
12197086a01eSPeter Brune .seealso:  MatFDColoringCreate() ISColoring MatFDColoring
12207086a01eSPeter Brune S*/
12217086a01eSPeter Brune typedef struct _p_MatColoring* MatColoring;
122276bdecfbSBarry Smith /*J
12238f6c3df8SBarry Smith     MatColoringType - String with the name of a PETSc matrix coloring
1224d9274352SBarry Smith 
1225d9274352SBarry Smith    Level: beginner
1226d9274352SBarry Smith 
12277086a01eSPeter Brune .seealso: MatColoringSetType(), MatColoring
122876bdecfbSBarry Smith J*/
12297086a01eSPeter Brune 
123019fd82e9SBarry Smith typedef const  char*           MatColoringType;
12315567d71aSPeter Brune #define MATCOLORINGJP      "jp"
1232b9acb617SPeter Brune #define MATCOLORINGPOWER   "power"
12332692d6eeSBarry Smith #define MATCOLORINGNATURAL "natural"
12342692d6eeSBarry Smith #define MATCOLORINGSL      "sl"
12352692d6eeSBarry Smith #define MATCOLORINGLF      "lf"
12362692d6eeSBarry Smith #define MATCOLORINGID      "id"
12378121bdceSPeter Brune #define MATCOLORINGGREEDY  "greedy"
1238b12f92e5SBarry Smith 
12398ac6da0aSPeter Brune /*E
12408ac6da0aSPeter Brune    MatColoringWeightType - Type of weight scheme
12418ac6da0aSPeter Brune 
12428ac6da0aSPeter Brune     Not Collective
12438ac6da0aSPeter Brune 
12448ac6da0aSPeter Brune +   MAT_COLORING_RANDOM  - Random weights
12458ac6da0aSPeter Brune .   MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering.
12468ac6da0aSPeter Brune -   MAT_COLORING_LF      - Last-first weighting.
12478ac6da0aSPeter Brune 
12488ac6da0aSPeter Brune     Level: intermediate
12498ac6da0aSPeter Brune 
1250af0996ceSBarry Smith    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
12518ac6da0aSPeter Brune E*/
1252301c140bSPeter Brune typedef enum {MAT_COLORING_WEIGHT_RANDOM,MAT_COLORING_WEIGHT_LEXICAL,MAT_COLORING_WEIGHT_LF,MAT_COLORING_WEIGHT_SL} MatColoringWeightType;
12538ac6da0aSPeter Brune 
1254335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*);
1255d7f2a307SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*);
1256335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*);
1257335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer);
1258335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType);
1259335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring);
1260335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt);
1261335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*);
1262335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt);
1263335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*);
1264335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*);
1265335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring));
1266014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
12678ac6da0aSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType);
1268c29971fcSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*);
12698ac6da0aSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm);
1270bc76d17bSHong Zhang PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring,ISColoring);
127125ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatColoringTest() (since version 3.10)") PETSC_STATIC_INLINE PetscErrorCode MatColoringTestValid(MatColoring matcoloring,ISColoring iscoloring) {return MatColoringTest(matcoloring,iscoloring);}
1272bc76d17bSHong Zhang PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat,ISColoring);
1273639f9d9dSBarry Smith 
1274d9274352SBarry Smith /*S
1275d9274352SBarry Smith      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1276d9274352SBarry Smith         and coloring
1277639f9d9dSBarry Smith 
1278d9274352SBarry Smith    Level: beginner
1279d9274352SBarry Smith 
1280d9274352SBarry Smith .seealso:  MatFDColoringCreate()
1281d9274352SBarry Smith S*/
1282e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring;
1283639f9d9dSBarry Smith 
1284014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1285014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*);
1286014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer);
1287014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1288014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1289014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1290014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
1291d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *);
1292014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec);
1293edaa7c33SBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,const PetscInt*[]);
1294f86b9fbaSHong Zhang PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring);
1295f86b9fbaSHong Zhang PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt);
1296bdaf1daeSBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringSetValues(Mat,MatFDColoring,const PetscScalar*);
1297b1683b59SHong Zhang 
1298b1683b59SHong Zhang /*S
1299b9af6bddSHong Zhang      MatTransposeColoring - Object for computing a sparse matrix product C=A*B^T via coloring
1300b1683b59SHong Zhang 
1301b1683b59SHong Zhang    Level: beginner
1302b1683b59SHong Zhang 
1303b9af6bddSHong Zhang .seealso:  MatTransposeColoringCreate()
1304b1683b59SHong Zhang S*/
1305b9af6bddSHong Zhang typedef struct _p_MatTransposeColoring* MatTransposeColoring;
1306b1683b59SHong Zhang 
1307014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *);
1308014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat);
1309014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat);
1310014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*);
1311b1683b59SHong Zhang 
1312639f9d9dSBarry Smith /*
13130752156aSBarry Smith     These routines are for partitioning matrices: currently used only
13143eda8832SBarry Smith   for adjacency matrix, MatCreateMPIAdj().
13150752156aSBarry Smith */
1316ca161407SBarry Smith 
1317d9274352SBarry Smith /*S
1318d9274352SBarry Smith      MatPartitioning - Object for managing the partitioning of a matrix or graph
1319d9274352SBarry Smith 
1320d9274352SBarry Smith    Level: beginner
1321d9274352SBarry Smith 
1322743a1026Svictorle .seealso:  MatPartitioningCreate(), MatPartitioningType
1323d9274352SBarry Smith S*/
132491e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning;
1325d9274352SBarry Smith 
132676bdecfbSBarry Smith /*J
13278f6c3df8SBarry Smith     MatPartitioningType - String with the name of a PETSc matrix partitioning
1328d9274352SBarry Smith 
1329d9274352SBarry Smith    Level: beginner
13300d04baf8SBarry Smith dm
1331b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning
133276bdecfbSBarry Smith J*/
133319fd82e9SBarry Smith typedef const char* MatPartitioningType;
13342692d6eeSBarry Smith #define MATPARTITIONINGCURRENT  "current"
1335aa1e27eaSFande Kong #define MATPARTITIONINGAVERAGE   "average"
13362692d6eeSBarry Smith #define MATPARTITIONINGSQUARE   "square"
13372692d6eeSBarry Smith #define MATPARTITIONINGPARMETIS "parmetis"
13382692d6eeSBarry Smith #define MATPARTITIONINGCHACO    "chaco"
13392692d6eeSBarry Smith #define MATPARTITIONINGPARTY    "party"
134050d91057SBarry Smith #define MATPARTITIONINGPTSCOTCH "ptscotch"
134188d2ac2bSFande Kong #define MATPARTITIONINGHIERARCH  "hierarch"
134271306c60Sjroman 
1343ca161407SBarry Smith 
1344014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*);
134519fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType);
1346014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt);
1347014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat);
1348014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1349014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1350014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*);
1351fdd1c351SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningImprove(MatPartitioning,IS*);
1352668144dbSFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningViewImbalance(MatPartitioning,IS);
1353f3ad2dabSStefano Zampini PETSC_EXTERN PetscErrorCode MatPartitioningApplyND(MatPartitioning,IS*);
1354014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*);
13552aabb6bbSBarry Smith 
1356bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[],PetscErrorCode (*)(MatPartitioning));
135730de9b25SBarry Smith 
1358f1144a30SSatish Balay 
13592bad1931SBarry Smith 
1360014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer);
1361854f7285SStefano Zampini PETSC_STATIC_INLINE PetscErrorCode MatPartitioningViewFromOptions(MatPartitioning A,PetscObject B,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,B,name);}
1362854f7285SStefano Zampini 
1363014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
136419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*);
1365ca161407SBarry Smith 
136627538973SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part);
1367014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1368014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);
13690752156aSBarry Smith 
1370b6956c12SJose Roman typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType;
13716a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoGlobalTypes[];
1372b6956c12SJose Roman typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType;
13736a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoLocalTypes[];
1374b6956c12SJose Roman typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType;
13756a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoEigenTypes[];
1376b6956c12SJose Roman 
1377014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType);
1378014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*);
1379014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType);
1380014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*);
1381014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
1382014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1383014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*);
1384014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal);
1385014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*);
1386014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt);
1387014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*);
138871306c60Sjroman 
138971306c60Sjroman #define MP_PARTY_OPT "opt"
139071306c60Sjroman #define MP_PARTY_LIN "lin"
139171306c60Sjroman #define MP_PARTY_SCA "sca"
139271306c60Sjroman #define MP_PARTY_RAN "ran"
139371306c60Sjroman #define MP_PARTY_GBF "gbf"
139471306c60Sjroman #define MP_PARTY_GCF "gcf"
139571306c60Sjroman #define MP_PARTY_BUB "bub"
139671306c60Sjroman #define MP_PARTY_DEF "def"
1397014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*);
139871306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs"
139971306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl"
140071306c60Sjroman #define MP_PARTY_NONE "no"
1401014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*);
1402014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1403014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool);
1404014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool);
140571306c60Sjroman 
1406b0ca845eSVaclav Hapla typedef enum { MP_PTSCOTCH_DEFAULT,MP_PTSCOTCH_QUALITY,MP_PTSCOTCH_SPEED,MP_PTSCOTCH_BALANCE,MP_PTSCOTCH_SAFETY,MP_PTSCOTCH_SCALABILITY } MPPTScotchStrategyType;
14076a6fc655SJed Brown PETSC_EXTERN const char *const MPPTScotchStrategyTypes[];
1408e0f1cffaSJose Roman 
1409014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal);
1410014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*);
1411014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType);
1412014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*);
141371306c60Sjroman 
1414b43b03e9SMark F. Adams /*
14156294fa2bSFande Kong  * hierarchical partitioning
14166294fa2bSFande Kong  */
14174e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning,IS*);
14184e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning,IS*);
14194e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning,PetscInt);
14204e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt);
14216294fa2bSFande Kong 
1422014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
1423014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);
1424591294e4SBarry Smith 
14250752156aSBarry Smith /*
1426af0996ceSBarry Smith     If you add entries here you must also add them to petsc/finclude/petscmat.h
1427d4fbbf0eSBarry Smith */
14281c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0,
14291c1c02c0SLois Curfman McInnes                MATOP_GET_ROW=1,
14301c1c02c0SLois Curfman McInnes                MATOP_RESTORE_ROW=2,
14311c1c02c0SLois Curfman McInnes                MATOP_MULT=3,
14321c1c02c0SLois Curfman McInnes                MATOP_MULT_ADD=4,
14337c922b88SBarry Smith                MATOP_MULT_TRANSPOSE=5,
14347c922b88SBarry Smith                MATOP_MULT_TRANSPOSE_ADD=6,
14351c1c02c0SLois Curfman McInnes                MATOP_SOLVE=7,
14361c1c02c0SLois Curfman McInnes                MATOP_SOLVE_ADD=8,
14377c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE=9,
14387c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE_ADD=10,
14391c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR=11,
14401c1c02c0SLois Curfman McInnes                MATOP_CHOLESKYFACTOR=12,
1441a714c06dSBarry Smith                MATOP_SOR=13,
14421c1c02c0SLois Curfman McInnes                MATOP_TRANSPOSE=14,
14431c1c02c0SLois Curfman McInnes                MATOP_GETINFO=15,
14441c1c02c0SLois Curfman McInnes                MATOP_EQUAL=16,
14451c1c02c0SLois Curfman McInnes                MATOP_GET_DIAGONAL=17,
14461c1c02c0SLois Curfman McInnes                MATOP_DIAGONAL_SCALE=18,
14471c1c02c0SLois Curfman McInnes                MATOP_NORM=19,
14481c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_BEGIN=20,
14491c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_END=21,
1450d519adbfSMatthew Knepley                MATOP_SET_OPTION=22,
1451d519adbfSMatthew Knepley                MATOP_ZERO_ENTRIES=23,
1452d519adbfSMatthew Knepley                MATOP_ZERO_ROWS=24,
1453d519adbfSMatthew Knepley                MATOP_LUFACTOR_SYMBOLIC=25,
1454d519adbfSMatthew Knepley                MATOP_LUFACTOR_NUMERIC=26,
1455d519adbfSMatthew Knepley                MATOP_CHOLESKY_FACTOR_SYMBOLIC=27,
1456d519adbfSMatthew Knepley                MATOP_CHOLESKY_FACTOR_NUMERIC=28,
1457d519adbfSMatthew Knepley                MATOP_SETUP_PREALLOCATION=29,
1458d519adbfSMatthew Knepley                MATOP_ILUFACTOR_SYMBOLIC=30,
1459d519adbfSMatthew Knepley                MATOP_ICCFACTOR_SYMBOLIC=31,
1460a5b7ff6bSBarry Smith                MATOP_GET_DIAGONAL_BLOCK=32,
1461dd4011a9SHong Zhang                MATOP_FREE_INTER_STRUCT=33,
1462d519adbfSMatthew Knepley                MATOP_DUPLICATE=34,
1463d519adbfSMatthew Knepley                MATOP_FORWARD_SOLVE=35,
1464d519adbfSMatthew Knepley                MATOP_BACKWARD_SOLVE=36,
1465d519adbfSMatthew Knepley                MATOP_ILUFACTOR=37,
1466d519adbfSMatthew Knepley                MATOP_ICCFACTOR=38,
1467d519adbfSMatthew Knepley                MATOP_AXPY=39,
14687dae84e0SHong Zhang                MATOP_CREATE_SUBMATRICES=40,
1469d519adbfSMatthew Knepley                MATOP_INCREASE_OVERLAP=41,
1470d519adbfSMatthew Knepley                MATOP_GET_VALUES=42,
1471d519adbfSMatthew Knepley                MATOP_COPY=43,
1472d519adbfSMatthew Knepley                MATOP_GET_ROW_MAX=44,
1473d519adbfSMatthew Knepley                MATOP_SCALE=45,
1474d519adbfSMatthew Knepley                MATOP_SHIFT=46,
147535153367SBarry Smith                MATOP_DIAGONAL_SET=47,
14769d39f69dSJed Brown                MATOP_ZERO_ROWS_COLUMNS=48,
14779d39f69dSJed Brown                MATOP_SET_RANDOM=49,
1478d519adbfSMatthew Knepley                MATOP_GET_ROW_IJ=50,
1479d519adbfSMatthew Knepley                MATOP_RESTORE_ROW_IJ=51,
1480d519adbfSMatthew Knepley                MATOP_GET_COLUMN_IJ=52,
1481d519adbfSMatthew Knepley                MATOP_RESTORE_COLUMN_IJ=53,
1482d519adbfSMatthew Knepley                MATOP_FDCOLORING_CREATE=54,
1483d519adbfSMatthew Knepley                MATOP_COLORING_PATCH=55,
1484d519adbfSMatthew Knepley                MATOP_SET_UNFACTORED=56,
1485d519adbfSMatthew Knepley                MATOP_PERMUTE=57,
1486d519adbfSMatthew Knepley                MATOP_SET_VALUES_BLOCKED=58,
14877dae84e0SHong Zhang                MATOP_CREATE_SUBMATRIX=59,
1488d519adbfSMatthew Knepley                MATOP_DESTROY=60,
1489d519adbfSMatthew Knepley                MATOP_VIEW=61,
1490d519adbfSMatthew Knepley                MATOP_CONVERT_FROM=62,
14917bab7c10SHong Zhang                MATOP_MATMAT_MULT=63,
14927bab7c10SHong Zhang                MATOP_MATMAT_MULT_SYMBOLIC=64,
14937bab7c10SHong Zhang                MATOP_MATMAT_MULT_NUMERIC=65,
1494d519adbfSMatthew Knepley                MATOP_SET_LOCAL_TO_GLOBAL_MAP=66,
1495d519adbfSMatthew Knepley                MATOP_SET_VALUES_LOCAL=67,
1496d519adbfSMatthew Knepley                MATOP_ZERO_ROWS_LOCAL=68,
1497d519adbfSMatthew Knepley                MATOP_GET_ROW_MAX_ABS=69,
1498d519adbfSMatthew Knepley                MATOP_GET_ROW_MIN_ABS=70,
1499d519adbfSMatthew Knepley                MATOP_CONVERT=71,
1500d519adbfSMatthew Knepley                MATOP_SET_COLORING=72,
15019d39f69dSJed Brown                /* MATOP_PLACEHOLDER_73=73, */
1502d519adbfSMatthew Knepley                MATOP_SET_VALUES_ADIFOR=74,
1503d519adbfSMatthew Knepley                MATOP_FD_COLORING_APPLY=75,
1504d519adbfSMatthew Knepley                MATOP_SET_FROM_OPTIONS=76,
1505bda6c4cbSBarry Smith                MATOP_MULT_CONSTRAINED=77,
1506bda6c4cbSBarry Smith                MATOP_MULT_TRANSPOSE_CONSTRAIN=78,
15079d39f69dSJed Brown                MATOP_FIND_ZERO_DIAGONALS=79,
1508d519adbfSMatthew Knepley                MATOP_MULT_MULTIPLE=80,
1509d519adbfSMatthew Knepley                MATOP_SOLVE_MULTIPLE=81,
1510d519adbfSMatthew Knepley                MATOP_GET_INERTIA=82,
1511d519adbfSMatthew Knepley                MATOP_LOAD=83,
1512d519adbfSMatthew Knepley                MATOP_IS_SYMMETRIC=84,
1513d519adbfSMatthew Knepley                MATOP_IS_HERMITIAN=85,
1514d519adbfSMatthew Knepley                MATOP_IS_STRUCTURALLY_SYMMETRIC=86,
1515820469bcSHong Zhang                MATOP_SET_VALUES_BLOCKEDLOCAL=87,
1516b41ce5d5SBarry Smith                MATOP_CREATE_VECS=88,
1517d519adbfSMatthew Knepley                MATOP_MAT_MULT=89,
1518d519adbfSMatthew Knepley                MATOP_MAT_MULT_SYMBOLIC=90,
1519d519adbfSMatthew Knepley                MATOP_MAT_MULT_NUMERIC=91,
1520d519adbfSMatthew Knepley                MATOP_PTAP=92,
1521d519adbfSMatthew Knepley                MATOP_PTAP_SYMBOLIC=93,
1522d519adbfSMatthew Knepley                MATOP_PTAP_NUMERIC=94,
1523bda6c4cbSBarry Smith                MATOP_MAT_TRANSPOSE_MULT=95,
1524bda6c4cbSBarry Smith                MATOP_MAT_TRANSPOSE_MULT_SYMBO=96,
1525bda6c4cbSBarry Smith                MATOP_MAT_TRANSPOSE_MULT_NUMER=97,
15269d39f69dSJed Brown                /* MATOP_PLACEHOLDER_98=98, */
15279d39f69dSJed Brown                /* MATOP_PLACEHOLDER_99=99, */
15289d39f69dSJed Brown                /* MATOP_PLACEHOLDER_100=100, */
15299d39f69dSJed Brown                /* MATOP_PLACEHOLDER_101=101, */
1530d519adbfSMatthew Knepley                MATOP_CONJUGATE=102,
15319d39f69dSJed Brown                /* MATOP_PLACEHOLDER_103=103, */
1532d519adbfSMatthew Knepley                MATOP_SET_VALUES_ROW=104,
1533d519adbfSMatthew Knepley                MATOP_REAL_PART=105,
1534bda6c4cbSBarry Smith                MATOP_IMAGINARY_PART=106,
1535bda6c4cbSBarry Smith                MATOP_GET_ROW_UPPER_TRIANGULAR=107,
1536bda6c4cbSBarry Smith                MATOP_RESTORE_ROW_UPPER_TRIANG=108,
1537bda6c4cbSBarry Smith                MATOP_MAT_SOLVE=109,
153829eadf9eSStefano Zampini                MATOP_MAT_SOLVE_TRANSPOSE=110,
1539d519adbfSMatthew Knepley                MATOP_GET_ROW_MIN=111,
15400e8d04f7SBarry Smith                MATOP_GET_COLUMN_VECTOR=112,
1541d519adbfSMatthew Knepley                MATOP_MISSING_DIAGONAL=113,
15420e8d04f7SBarry Smith                MATOP_GET_SEQ_NONZERO_STRUCTUR=114,
154389c6957cSBarry Smith                MATOP_CREATE=115,
154489c6957cSBarry Smith                MATOP_GET_GHOSTS=116,
15450e8d04f7SBarry Smith                MATOP_GET_LOCAL_SUB_MATRIX=117,
15460e8d04f7SBarry Smith                MATOP_RESTORE_LOCALSUB_MATRIX=118,
1547eeffb40dSHong Zhang                MATOP_MULT_DIAGONAL_BLOCK=119,
15480e8d04f7SBarry Smith                MATOP_HERMITIAN_TRANSPOSE=120,
15490e8d04f7SBarry Smith                MATOP_MULT_HERMITIAN_TRANSPOSE=121,
15500e8d04f7SBarry Smith                MATOP_MULT_HERMITIAN_TRANS_ADD=122,
15510e8d04f7SBarry Smith                MATOP_GET_MULTI_PROC_BLOCK=123,
15529d39f69dSJed Brown                MATOP_FIND_NONZERO_ROWS=124,
15530e8d04f7SBarry Smith                MATOP_GET_COLUMN_NORMS=125,
15549d39f69dSJed Brown                MATOP_INVERT_BLOCK_DIAGONAL=126,
15559d39f69dSJed Brown                /* MATOP_PLACEHOLDER_127=127, */
1556b41ce5d5SBarry Smith                MATOP_CREATE_SUB_MATRICES_MPI=128,
15572b8ad9a3SHong Zhang                MATOP_SET_VALUES_BATCH=129,
15580e8d04f7SBarry Smith                MATOP_TRANSPOSE_MAT_MULT=130,
15590e8d04f7SBarry Smith                MATOP_TRANSPOSE_MAT_MULT_SYMBO=131,
1560e9b602ebSSatish Balay                MATOP_TRANSPOSE_MAT_MULT_NUMER=132,
15610e8d04f7SBarry Smith                MATOP_TRANSPOSE_COLORING_CREAT=133,
15620e8d04f7SBarry Smith                MATOP_TRANS_COLORING_APPLY_SPT=134,
15630e8d04f7SBarry Smith                MATOP_TRANS_COLORING_APPLY_DEN=135,
15640e8d04f7SBarry Smith                MATOP_RART=136,
15650e8d04f7SBarry Smith                MATOP_RART_SYMBOLIC=137,
15660e8d04f7SBarry Smith                MATOP_RART_NUMERIC=138,
1567e09a3074SHong Zhang                MATOP_SET_BLOCK_SIZES=139,
1568f9426fe0SMark Adams                MATOP_AYPX=140,
15691919a2e2SJed Brown                MATOP_RESIDUAL=141,
15709c8f2541SHong Zhang                MATOP_FDCOLORING_SETUP=142,
15712d033e1fSHong Zhang                MATOP_MPICONCATENATESEQ=144,
15722d033e1fSHong Zhang                MATOP_DESTROYSUBMATRICES=145
1573fae171e0SBarry Smith              } MatOperation;
15740c0fd78eSBarry Smith PETSC_EXTERN PetscErrorCode MatSetOperation(Mat,MatOperation,void(*)(void));
1575976e8c5aSLisandro Dalcin PETSC_EXTERN PetscErrorCode MatGetOperation(Mat,MatOperation,void(**)(void));
1576976e8c5aSLisandro Dalcin PETSC_EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool *);
157794342113SStefano Zampini PETSC_EXTERN PetscErrorCode MatHasCongruentLayouts(Mat,PetscBool *);
1578dd4011a9SHong Zhang PETSC_EXTERN PetscErrorCode MatFreeIntermediateDataStructures(Mat);
1579976e8c5aSLisandro Dalcin 
1580014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void));
1581014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void));
1582014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*);
1583f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*);
1584f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*);
15850c0fd78eSBarry Smith PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat);
1586112a2221SBarry Smith 
158790ace30eSBarry Smith /*
158890ace30eSBarry Smith    Codes for matrices stored on disk. By default they are
158990ace30eSBarry Smith    stored in a universal format. By changing the format with
15906a9046bcSBarry Smith    PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
159190ace30eSBarry Smith    be stored in a way natural for the matrix, for example dense matrices
159290ace30eSBarry Smith    would be stored as dense. Matrices stored this way may only be
1593f4403165SShri Abhyankar    read into matrices of the same type.
159490ace30eSBarry Smith */
159590ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1
159690ace30eSBarry Smith 
1597014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
159875d48cdbSStefano Zampini 
15998546b261SStefano Zampini PETSC_EXTERN PetscErrorCode MatISSetLocalMatType(Mat,MatType);
160075d48cdbSStefano Zampini PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
160175d48cdbSStefano Zampini PETSC_EXTERN PetscErrorCode MatISStoreL2L(Mat,PetscBool);
1602f03112d0SStefano Zampini PETSC_EXTERN PetscErrorCode MatISFixLocalEmpty(Mat,PetscBool);
1603014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*);
16043b3b1effSJed Brown PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat,Mat*);
1605014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat);
160625ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use the MatConvert() interface (since version 3.10)") PetscErrorCode MatISGetMPIXAIJ(Mat,MatReuse,Mat*);
16071f4e1ec7SBarry Smith 
1608d9274352SBarry Smith /*S
1609d9274352SBarry Smith      MatNullSpace - Object that removes a null space from a vector, i.e.
1610d9274352SBarry Smith          orthogonalizes the vector to a subsapce
1611d9274352SBarry Smith 
1612f7a9e4ceSBarry Smith    Level: advanced
1613d9274352SBarry Smith 
16146e1639daSBarry Smith   Users manual sections:
16156e1639daSBarry Smith .   sec_singular
16166e1639daSBarry Smith 
1617d9274352SBarry Smith .seealso:  MatNullSpaceCreate()
1618d9274352SBarry Smith S*/
161974637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace;
1620d9274352SBarry Smith 
1621014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*);
1622014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1623014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*);
1624d0195637SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec);
1625014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *);
16265fa7ec2dSBarry Smith PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *);
16275fa7ec2dSBarry Smith PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat,MatNullSpace);
1628014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace);
1629014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace);
1630014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*);
1631014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool  *);
1632014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer);
1633014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**);
1634014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*);
163574637425SBarry Smith 
1636014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS);
1637014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1638014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
1639014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat);
16403f1d51d7SBarry Smith 
1641014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*);
1642014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*);
1643014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*);
1644c4f061fbSSatish Balay 
16450bacdadaSStefano Zampini PETSC_EXTERN PetscErrorCode MatComputeOperator(Mat,MatType,Mat*);
16460bacdadaSStefano Zampini PETSC_EXTERN PetscErrorCode MatComputeOperatorTranspose(Mat,MatType,Mat*);
16470bacdadaSStefano Zampini 
164825ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatComputeOperator() (since version 3.12)") PETSC_STATIC_INLINE PetscErrorCode MatComputeExplicitOperator(Mat A,Mat* B) { return MatComputeOperator(A,NULL,B); }
164925ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatComputeOperatorTranspose() (since version 3.12)") PETSC_STATIC_INLINE PetscErrorCode MatComputeExplicitOperatorTranspose(Mat A,Mat* B) { return MatComputeOperatorTranspose(A,NULL,B); }
1650b0a32e0cSBarry Smith 
165149bd79ccSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode MatCreateKAIJ(Mat,PetscInt,PetscInt,const PetscScalar[],const PetscScalar[],Mat*);
165249bd79ccSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode MatKAIJGetAIJ(Mat,Mat*);
1653a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetS(Mat,PetscInt*,PetscInt*,PetscScalar**);
1654a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetSRead(Mat,PetscInt*,PetscInt*,const PetscScalar**);
1655a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreS(Mat,PetscScalar**);
1656a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreSRead(Mat,const PetscScalar**);
1657a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetT(Mat,PetscInt*,PetscInt*,PetscScalar**);
1658a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetTRead(Mat,PetscInt*,PetscInt*,const PetscScalar**);
1659a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreT(Mat,PetscScalar**);
1660a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreTRead(Mat,const PetscScalar**);
1661dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetAIJ(Mat,Mat);
1662dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetS(Mat,PetscInt,PetscInt,const PetscScalar []);
1663dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetT(Mat,PetscInt,PetscInt,const PetscScalar []);
166449bd79ccSDebojyoti Ghosh 
1665014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec);
166604f1ad80SBarry Smith 
1667014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
1668014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec);
1669014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1670014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1671014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1672014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1673014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
1674014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal);
1675014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt);
1676014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *);
1677014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]);
1678014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1679014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);
1680e884886fSBarry Smith 
16816370053bSBarry Smith /*S
16826370053bSBarry Smith     MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free
16836370053bSBarry Smith               Jacobian vector products
1684e884886fSBarry Smith 
168595452b02SPatrick Sanan     Notes:
168695452b02SPatrick Sanan     MATMFFD is a specific MatType which uses the MatMFFD data structure
16876370053bSBarry Smith 
16886370053bSBarry Smith            MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure
16896370053bSBarry Smith 
16906370053bSBarry Smith     Level: developer
16916370053bSBarry Smith 
16926370053bSBarry Smith .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
16936370053bSBarry Smith S*/
1694e884886fSBarry Smith typedef struct _p_MatMFFD* MatMFFD;
1695e884886fSBarry Smith 
169676bdecfbSBarry Smith /*J
1697e884886fSBarry Smith     MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function
1698e884886fSBarry Smith 
1699e884886fSBarry Smith    Level: beginner
1700e884886fSBarry Smith 
1701e884886fSBarry Smith .seealso: MatMFFDSetType(), MatMFFDRegister()
170276bdecfbSBarry Smith J*/
170319fd82e9SBarry Smith typedef const char* MatMFFDType;
1704e884886fSBarry Smith #define MATMFFD_DS  "ds"
1705e884886fSBarry Smith #define MATMFFD_WP  "wp"
1706e884886fSBarry Smith 
170719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat,MatMFFDType);
1708bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[],PetscErrorCode (*)(MatMFFD));
1709e884886fSBarry Smith 
1710014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal);
1711014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool );
1712e884886fSBarry Smith 
171361ab5df0SBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring,MatMFFDType);
171461ab5df0SBarry Smith 
1715014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1716014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
17177dbadf16SMatthew Knepley 
171897969023SHong Zhang /*
171997969023SHong Zhang    PETSc interface to MUMPS
172097969023SHong Zhang */
172197969023SHong Zhang #ifdef PETSC_HAVE_MUMPS
1722014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
1723bc6112feSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat,PetscInt,PetscInt*);
1724b9e9ea26SSatish Balay PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal);
1725bc6112feSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat,PetscInt,PetscReal*);
1726bc6112feSHong Zhang 
1727ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat,PetscInt,PetscInt*);
1728ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat,PetscInt,PetscInt*);
1729ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat,PetscInt,PetscReal*);
1730ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat,PetscInt,PetscReal*);
173189a9c03aSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat,Mat);
17320e6b8875SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInverseTranspose(Mat,Mat);
173397969023SHong Zhang #endif
173423a5497aSJed Brown 
1735d954db57SHong Zhang /*
1736d615f992SSatish Balay    PETSc interface to Mkl_Pardiso
1737b500a6b7SJose David Bermeol */
1738b500a6b7SJose David Bermeol #ifdef PETSC_HAVE_MKL_PARDISO
1739d615f992SSatish Balay PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt);
1740b500a6b7SJose David Bermeol #endif
1741b500a6b7SJose David Bermeol 
1742b500a6b7SJose David Bermeol /*
1743d305a81bSVasiliy Kozyrev    PETSc interface to Mkl_CPardiso
1744d305a81bSVasiliy Kozyrev */
1745d305a81bSVasiliy Kozyrev #ifdef PETSC_HAVE_MKL_CPARDISO
1746d305a81bSVasiliy Kozyrev PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt);
1747d305a81bSVasiliy Kozyrev #endif
1748d305a81bSVasiliy Kozyrev 
1749d305a81bSVasiliy Kozyrev /*
1750d954db57SHong Zhang    PETSc interface to SUPERLU
1751d954db57SHong Zhang */
1752d954db57SHong Zhang #ifdef PETSC_HAVE_SUPERLU
1753014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal);
1754d954db57SHong Zhang #endif
1755d954db57SHong Zhang 
1756fb785984SHong Zhang /*
1757fb785984SHong Zhang    PETSc interface to SUPERLU_DIST
1758fb785984SHong Zhang */
1759fb785984SHong Zhang #ifdef PETSC_HAVE_SUPERLU_DIST
1760fb785984SHong Zhang PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat,PetscScalar*);
1761fb785984SHong Zhang #endif
1762fb785984SHong Zhang 
1763575704cbSPieter Ghysels /*
1764575704cbSPieter Ghysels    PETSc interface to STRUMPACK
1765575704cbSPieter Ghysels */
1766575704cbSPieter Ghysels #ifdef PETSC_HAVE_STRUMPACK
1767542aee0fSPieter Ghysels /*E
1768542aee0fSPieter Ghysels     MatSTRUMPACKReordering - sparsity reducing ordering to be used in STRUMPACK
1769542aee0fSPieter Ghysels 
1770542aee0fSPieter Ghysels     Level: intermediate
1771542aee0fSPieter Ghysels E*/
177234f43fa5SPieter Ghysels typedef enum {MAT_STRUMPACK_NATURAL=0,
177334f43fa5SPieter Ghysels               MAT_STRUMPACK_METIS=1,
177434f43fa5SPieter Ghysels               MAT_STRUMPACK_PARMETIS=2,
177534f43fa5SPieter Ghysels               MAT_STRUMPACK_SCOTCH=3,
177634f43fa5SPieter Ghysels               MAT_STRUMPACK_PTSCOTCH=4,
177734f43fa5SPieter Ghysels               MAT_STRUMPACK_RCM=5} MatSTRUMPACKReordering;
177834f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat,MatSTRUMPACKReordering);
1779575704cbSPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat,PetscBool);
178034f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSRelTol(Mat,PetscReal);
178125ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSRelTol() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSRelCompTol(Mat mat,PetscReal rtol) {return MatSTRUMPACKSetHSSRelTol(mat,rtol);}
178234f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSAbsTol(Mat,PetscReal);
178334f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMinSepSize(Mat,PetscInt);
178425ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSMinSepSize() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSMinSize(Mat mat,PetscInt hssminsize) {return MatSTRUMPACKSetHSSMinSepSize(mat,hssminsize);}
178534f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMaxRank(Mat,PetscInt);
1786a36bf211SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSLeafSize(Mat,PetscInt);
1787575704cbSPieter Ghysels #endif
1788575704cbSPieter Ghysels 
1789575704cbSPieter Ghysels 
1790e7e92044SBarry Smith PETSC_EXTERN PetscErrorCode MatPinToCPU(Mat,PetscBool);
1791e7e92044SBarry Smith 
1792aa372e3fSPaul Mullowney #ifdef PETSC_HAVE_CUDA
17933f9c0db1SPaul Mullowney /*E
1794e057df02SPaul Mullowney     MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU)
17952692e278SPaul Mullowney     matrices.
1796e057df02SPaul Mullowney 
1797e057df02SPaul Mullowney     Not Collective
1798e057df02SPaul Mullowney 
17998468deeeSKarl Rupp +   MAT_CUSPARSE_CSR - Compressed Sparse Row
18002692e278SPaul Mullowney .   MAT_CUSPARSE_ELL - Ellpack (requires CUDA 4.2 or later).
18012692e278SPaul Mullowney -   MAT_CUSPARSE_HYB - Hybrid, a combination of Ellpack and Coordinate format (requires CUDA 4.2 or later).
1802e057df02SPaul Mullowney 
1803e057df02SPaul Mullowney     Level: intermediate
1804e057df02SPaul Mullowney 
1805af0996ceSBarry Smith    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
1806e057df02SPaul Mullowney 
1807e057df02SPaul Mullowney .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation
1808e057df02SPaul Mullowney E*/
1809e057df02SPaul Mullowney 
18103f9c0db1SPaul Mullowney typedef enum {MAT_CUSPARSE_CSR, MAT_CUSPARSE_ELL, MAT_CUSPARSE_HYB} MatCUSPARSEStorageFormat;
1811e057df02SPaul Mullowney 
1812e057df02SPaul Mullowney /* these will be strings associated with enumerated type defined above */
1813e057df02SPaul Mullowney PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[];
1814e057df02SPaul Mullowney 
18153f9c0db1SPaul Mullowney /*E
1816e057df02SPaul Mullowney     MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU)
18172692e278SPaul Mullowney     matrices whose operation should use a particular storage format.
1818e057df02SPaul Mullowney 
1819e057df02SPaul Mullowney     Not Collective
1820e057df02SPaul Mullowney 
18218468deeeSKarl Rupp +   MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
18228468deeeSKarl Rupp .   MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
18238468deeeSKarl Rupp .   MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
18248468deeeSKarl Rupp -   MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices
1825e057df02SPaul Mullowney 
1826e057df02SPaul Mullowney     Level: intermediate
1827e057df02SPaul Mullowney 
1828e057df02SPaul Mullowney .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat
1829e057df02SPaul Mullowney E*/
183036d62e41SPaul Mullowney typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation;
1831e057df02SPaul Mullowney 
183210e9db80SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
183310e9db80SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1834e057df02SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat);
18359ae82921SPaul Mullowney #endif
18369ae82921SPaul Mullowney 
1837d67ff14aSKarl Rupp #if defined(PETSC_HAVE_VIENNACL)
1838d67ff14aSKarl Rupp PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1839d67ff14aSKarl Rupp PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1840d67ff14aSKarl Rupp #endif
1841d67ff14aSKarl Rupp 
184254efbe56SHong Zhang /*
184354efbe56SHong Zhang    PETSc interface to FFTW
184454efbe56SHong Zhang */
184554efbe56SHong Zhang #if defined(PETSC_HAVE_FFTW)
1846014dd563SJed Brown PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec);
1847014dd563SJed Brown PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec);
18482a7a6963SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*);
184954efbe56SHong Zhang #endif
185054efbe56SHong Zhang 
1851014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*);
1852014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*);
1853014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]);
1854014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]);
1855014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***);
1856014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*);
185719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType);
1858014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]);
1859014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat);
1860d8588912SDave May 
18614325cce7SMatthew G Knepley PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal);
1862e0a58c10SMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*);
18634325cce7SMatthew G Knepley 
1864b541e6a4SDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSubdomainsCreateCoalesce(Mat,PetscInt,PetscInt*,IS**);
186553dd7562SDmitry Karpeev 
1866c094ef40SMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatPreallocatorPreallocate(Mat,PetscBool,Mat);
1867c094ef40SMatthew G. Knepley 
1868539c167fSBarry Smith PETSC_INTERN PetscErrorCode MatHeaderMerge(Mat,Mat*);
1869539c167fSBarry Smith PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat,Mat*);
1870539c167fSBarry Smith 
187123a5497aSJed Brown #endif
1872