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" 438c3ff71bSJunchao Zhang #define MATAIJKOKKOS "aijkokkos" 448c3ff71bSJunchao Zhang #define MATSEQAIJKOKKOS "seqaijkokkos" 458c3ff71bSJunchao Zhang #define MATMPIAIJKOKKOS "mpiaijkokkos" 46d67ff14aSKarl Rupp #define MATAIJVIENNACL "aijviennacl" 47d67ff14aSKarl Rupp #define MATSEQAIJVIENNACL "seqaijviennacl" 48d67ff14aSKarl Rupp #define MATMPIAIJVIENNACL "mpiaijviennacl" 495a11e1b2SBarry Smith #define MATAIJPERM "aijperm" 505a11e1b2SBarry Smith #define MATSEQAIJPERM "seqaijperm" 515a11e1b2SBarry Smith #define MATMPIAIJPERM "mpiaijperm" 524dfdc2d9SRichard Tran Mills #define MATAIJSELL "aijsell" 534dfdc2d9SRichard Tran Mills #define MATSEQAIJSELL "seqaijsell" 544dfdc2d9SRichard Tran Mills #define MATMPIAIJSELL "mpiaijsell" 554a2a386eSRichard Tran Mills #define MATAIJMKL "aijmkl" 564a2a386eSRichard Tran Mills #define MATSEQAIJMKL "seqaijmkl" 574a2a386eSRichard Tran Mills #define MATMPIAIJMKL "mpiaijmkl" 58b5b72c8aSIrina Sokolova #define MATBAIJMKL "baijmkl" 59b5b72c8aSIrina Sokolova #define MATSEQBAIJMKL "seqbaijmkl" 60b5b72c8aSIrina Sokolova #define MATMPIBAIJMKL "mpibaijmkl" 61273d9f13SBarry Smith #define MATSHELL "shell" 62c1fff1c6SRichard Tran Mills #define MATCENTERING "centering" 635a11e1b2SBarry Smith #define MATDENSE "dense" 64637a0070SStefano Zampini #define MATDENSECUDA "densecuda" 65209238afSKris Buschelman #define MATSEQDENSE "seqdense" 66bfc799aaSStefano Zampini #define MATSEQDENSECUDA "seqdensecuda" 67273d9f13SBarry Smith #define MATMPIDENSE "mpidense" 68637a0070SStefano Zampini #define MATMPIDENSECUDA "mpidensecuda" 69db31f6deSJed Brown #define MATELEMENTAL "elemental" 70d24d4204SJose E. Roman #define MATSCALAPACK "scalapack" 715a11e1b2SBarry Smith #define MATBAIJ "baij" 72273d9f13SBarry Smith #define MATSEQBAIJ "seqbaij" 73273d9f13SBarry Smith #define MATMPIBAIJ "mpibaij" 74273d9f13SBarry Smith #define MATMPIADJ "mpiadj" 755a11e1b2SBarry Smith #define MATSBAIJ "sbaij" 76273d9f13SBarry Smith #define MATSEQSBAIJ "seqsbaij" 77273d9f13SBarry Smith #define MATMPISBAIJ "mpisbaij" 78cebc7f6cSBarry Smith #define MATMFFD "mffd" 79c8a8475eSBarry Smith #define MATNORMAL "normal" 80c5e4d11fSDmitry Karpeev #define MATNORMALHERMITIAN "normalh" 81ab92ecdeSBarry Smith #define MATLRC "lrc" 822a6744ebSBarry Smith #define MATSCATTER "scatter" 83421e10b8SBarry Smith #define MATBLOCKMAT "blockmat" 84793850ffSBarry Smith #define MATCOMPOSITE "composite" 851f8c7532SHong Zhang #define MATFFT "fft" 861f8c7532SHong Zhang #define MATFFTW "fftw" 87e133240eSMatthew G Knepley #define MATSEQCUFFT "seqcufft" 88557cca28SSatish Balay #define MATTRANSPOSEMAT "transpose" 8972ca8751SBarry Smith #define MATSCHURCOMPLEMENT "schurcomplement" 901d6018f0SLisandro Dalcin #define MATPYTHON "python" 9163c07aadSStefano Zampini #define MATHYPRE "hypre" 92f91d8e95SBarry Smith #define MATHYPRESTRUCT "hyprestruct" 93a9e6138eSGlenn Hammond #define MATHYPRESSTRUCT "hypresstruct" 94ee1cef2cSJed Brown #define MATSUBMATRIX "submatrix" 952c0dbf93SJed Brown #define MATLOCALREF "localref" 96d8588912SDave May #define MATNEST "nest" 97c094ef40SMatthew G. Knepley #define MATPREALLOCATOR "preallocator" 98d4002b98SHong Zhang #define MATSELL "sell" 99d4002b98SHong Zhang #define MATSEQSELL "seqsell" 100d4002b98SHong Zhang #define MATMPISELL "mpisell" 101a3b2e22bSHong Zhang #define MATDUMMY "dummy" 102cd929ea3SAlp Dener #define MATLMVM "lmvm" 10378e4361aSAlp Dener #define MATLMVMDFP "lmvmdfp" 10478e4361aSAlp Dener #define MATLMVMBFGS "lmvmbfgs" 10578e4361aSAlp Dener #define MATLMVMSR1 "lmvmsr1" 106864588a7SAlp Dener #define MATLMVMBROYDEN "lmvmbroyden" 107864588a7SAlp Dener #define MATLMVMBADBROYDEN "lmvmbadbroyden" 108864588a7SAlp Dener #define MATLMVMSYMBROYDEN "lmvmsymbroyden" 109864588a7SAlp Dener #define MATLMVMSYMBADBROYDEN "lmvmsymbadbroyden" 110864588a7SAlp Dener #define MATLMVMDIAGBROYDEN "lmvmdiagbroyden" 1113423f386SBarry Smith #define MATCONSTANTDIAGONAL "constantdiagonal" 112c7a4214aSPierre Jolivet #define MATHTOOL "htool" 11353022affSStefano Zampini #define MATH2OPUS "h2opus" 114773941d6SBarry Smith 11576bdecfbSBarry Smith /*J 1163ca39a21SBarry Smith MatSolverType - String with the name of a PETSc matrix solver type. 1179989ab13SBarry Smith 118c2b89b5dSBarry Smith For example: "petsc" indicates what PETSc provides, "superlu_dist" the parallel SuperLU_DIST package etc 1199989ab13SBarry Smith 1209989ab13SBarry Smith Level: beginner 1219989ab13SBarry Smith 1223f498edaSToby Isaac Notes: MATSOLVERUMFPACK, MATSOLVERCHOLMOD, MATSOLVERKLU, MATSOLVERSPQR form the SuiteSparse package for which you can use --download-suitesparse 123c7ccbb75SBarry Smith 124b198fc33SVáclav Hapla .seealso: MatGetFactor(), PCFactorSetMatSolverType(), PCFactorGetMatSolverType() 12576bdecfbSBarry Smith J*/ 126ea799195SBarry Smith typedef const char* MatSolverType; 1272692d6eeSBarry Smith #define MATSOLVERSUPERLU "superlu" 1282692d6eeSBarry Smith #define MATSOLVERSUPERLU_DIST "superlu_dist" 12908f5efcfSPieter Ghysels #define MATSOLVERSTRUMPACK "strumpack" 1302692d6eeSBarry Smith #define MATSOLVERUMFPACK "umfpack" 13120db9a53SJed Brown #define MATSOLVERCHOLMOD "cholmod" 132d89f5e7aSBarry Smith #define MATSOLVERKLU "klu" 133418810c4SBarry Smith #define MATSOLVERSPARSEELEMENTAL "sparseelemental" 134d89f5e7aSBarry Smith #define MATSOLVERELEMENTAL "elemental" 135d24d4204SJose E. Roman #define MATSOLVERSCALAPACK "scalapack" 1362692d6eeSBarry Smith #define MATSOLVERESSL "essl" 1372692d6eeSBarry Smith #define MATSOLVERLUSOL "lusol" 1382692d6eeSBarry Smith #define MATSOLVERMUMPS "mumps" 139d615f992SSatish Balay #define MATSOLVERMKL_PARDISO "mkl_pardiso" 140d305a81bSVasiliy Kozyrev #define MATSOLVERMKL_CPARDISO "mkl_cpardiso" 1412692d6eeSBarry Smith #define MATSOLVERPASTIX "pastix" 1422692d6eeSBarry Smith #define MATSOLVERMATLAB "matlab" 1432692d6eeSBarry Smith #define MATSOLVERPETSC "petsc" 1442692d6eeSBarry Smith #define MATSOLVERBAS "bas" 1459ae82921SPaul Mullowney #define MATSOLVERCUSPARSE "cusparse" 146bddcd29dSMark Adams #define MATSOLVERCUSPARSEBAND "cusparseband" 147bfc799aaSStefano Zampini #define MATSOLVERCUDA "cuda" 148930e68a5SMark Adams #define MATSOLVERKOKKOS "kokkos" 1498f7e8f9dSMark Adams #define MATSOLVERKOKKOSDEVICE "kokkosdevice" 150a2fc1e05SToby Isaac #define MATSOLVERSPQR "spqr" 151c0cdd4a1SDahai Guo 152b24902e0SBarry Smith /*E 153b24902e0SBarry Smith MatFactorType - indicates what type of factorization is requested 154b24902e0SBarry Smith 155b24902e0SBarry Smith Level: beginner 156b24902e0SBarry Smith 157af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 158b24902e0SBarry Smith 1592a350339SBarry Smith .seealso: MatSolverType, MatGetFactor(), MatGetFactorAvailable(), MatSolverTypeRegister() 160b24902e0SBarry Smith E*/ 1613f498edaSToby Isaac typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC, MAT_FACTOR_ILUDT, MAT_FACTOR_QR, MAT_FACTOR_NUM_TYPES} MatFactorType; 162014dd563SJed Brown PETSC_EXTERN const char *const MatFactorTypes[]; 163e92e720dSBarry Smith 164ea799195SBarry Smith PETSC_EXTERN PetscErrorCode MatGetFactor(Mat,MatSolverType,MatFactorType,Mat*); 165ea799195SBarry Smith PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat,MatSolverType,MatFactorType,PetscBool *); 166f73b0415SBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetCanUseOrdering(Mat, PetscBool*); 1679fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatFactorGetCanUseOrdering() (since version 3.15)") static inline PetscErrorCode MatFactorGetUseOrdering(Mat A,PetscBool *b) {return MatFactorGetCanUseOrdering(A,b);} 168ea799195SBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetSolverType(Mat,MatSolverType*); 169014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat,MatFactorType*); 1707abd51d3SMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatSetFactorType(Mat,MatFactorType); 1712430ea28SJose E. Roman PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*MatSolverFunction)(Mat,MatFactorType,Mat*); 1722430ea28SJose E. Roman PETSC_EXTERN PetscErrorCode MatSolverTypeRegister(MatSolverType,MatType,MatFactorType,MatSolverFunction); 1732430ea28SJose E. Roman PETSC_EXTERN PetscErrorCode MatSolverTypeGet(MatSolverType,MatType,MatFactorType,PetscBool*,PetscBool*,MatSolverFunction*); 17425ef9dfeSBarry Smith typedef MatSolverType MatSolverPackage PETSC_DEPRECATED_TYPEDEF("Use MatSolverType (since version 3.9)"); 1759fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatSolverTypeRegister() (since version 3.9)") static inline PetscErrorCode MatSolverPackageRegister(MatSolverType stype,MatType mtype,MatFactorType ftype,MatSolverFunction f) 176c19b563cSJed Brown { return MatSolverTypeRegister(stype,mtype,ftype,f); } 1779fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatSolverTypeGet() (since version 3.9)") static inline PetscErrorCode MatSolverPackageGet(MatSolverType stype,MatType mtype,MatFactorType ftype,PetscBool *foundmtype,PetscBool *foundstype,MatSolverFunction *f) 178c19b563cSJed Brown { return MatSolverTypeGet(stype,mtype,ftype,foundmtype,foundstype,f); } 1799989ab13SBarry Smith 1804222ddf1SHong Zhang /*E 1814222ddf1SHong Zhang MatProductType - indicates what type of matrix product is requested 1824222ddf1SHong Zhang 1834222ddf1SHong Zhang Level: beginner 1844222ddf1SHong Zhang 1853e662e0bSHong Zhang .seealso: MatProductSetType() 1864222ddf1SHong Zhang E*/ 1876718818eSStefano Zampini typedef enum {MATPRODUCT_UNSPECIFIED=0,MATPRODUCT_AB,MATPRODUCT_AtB,MATPRODUCT_ABt,MATPRODUCT_PtAP,MATPRODUCT_RARt,MATPRODUCT_ABC} MatProductType; 188544a5e07SHong Zhang PETSC_EXTERN const char *const MatProductTypes[]; 1894222ddf1SHong Zhang 1904222ddf1SHong Zhang /*J 1914222ddf1SHong Zhang MatProductAlgorithm - String with the name of an algorithm for a PETSc matrix product implementation 1924222ddf1SHong Zhang 1934222ddf1SHong Zhang Level: beginner 1944222ddf1SHong Zhang 1953e662e0bSHong Zhang .seealso: MatSetType(), Mat, MatProductSetAlgorithm(), MatProductType 1964222ddf1SHong Zhang J*/ 1974222ddf1SHong Zhang typedef const char* MatProductAlgorithm; 1983e662e0bSHong Zhang #define MATPRODUCTALGORITHMDEFAULT "default" 1993e662e0bSHong Zhang #define MATPRODUCTALGORITHMSORTED "sorted" 2003e662e0bSHong Zhang #define MATPRODUCTALGORITHMSCALABLE "scalable" 2013e662e0bSHong Zhang #define MATPRODUCTALGORITHMSCALABLEFAST "scalable_fast" 2023e662e0bSHong Zhang #define MATPRODUCTALGORITHMHEAP "heap" 2033e662e0bSHong Zhang #define MATPRODUCTALGORITHMBHEAP "btheap" 2043e662e0bSHong Zhang #define MATPRODUCTALGORITHMLLCONDENSED "llcondensed" 2053e662e0bSHong Zhang #define MATPRODUCTALGORITHMROWMERGE "rowmerge" 2063e662e0bSHong Zhang #define MATPRODUCTALGORITHMOUTERPRODUCT "outerproduct" 2073e662e0bSHong Zhang #define MATPRODUCTALGORITHMATB "at*b" 2083e662e0bSHong Zhang #define MATPRODUCTALGORITHMRAP "rap" 2093e662e0bSHong Zhang #define MATPRODUCTALGORITHMNONSCALABLE "nonscalable" 2103e662e0bSHong Zhang #define MATPRODUCTALGORITHMSEQMPI "seqmpi" 2113e662e0bSHong Zhang #define MATPRODUCTALGORITHMBACKEND "backend" 2123e662e0bSHong Zhang #define MATPRODUCTALGORITHMOVERLAPPING "overlapping" 2133e662e0bSHong Zhang #define MATPRODUCTALGORITHMMERGED "merged" 2143e662e0bSHong Zhang #define MATPRODUCTALGORITHMALLATONCE "allatonce" 2153e662e0bSHong Zhang #define MATPRODUCTALGORITHMALLATONCEMERGED "allatonce_merged" 2163e662e0bSHong Zhang #define MATPRODUCTALGORITHMALLGATHERV "allgatherv" 2173e662e0bSHong Zhang #define MATPRODUCTALGORITHMCYCLIC "cyclic" 2183e662e0bSHong Zhang #if defined(PETSC_HAVE_HYPRE) 2193e662e0bSHong Zhang #define MATPRODUCTALGORITHMHYPRE "hypre" 2203e662e0bSHong Zhang #endif 2214222ddf1SHong Zhang 2224222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductCreate(Mat,Mat,Mat,Mat*); 2234222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductCreateWithMat(Mat,Mat,Mat,Mat); 2244222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductSetType(Mat,MatProductType); 2254222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductSetAlgorithm(Mat,MatProductAlgorithm); 2264222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductSetFill(Mat,PetscReal); 2274222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductSetFromOptions(Mat); 2284222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductSymbolic(Mat); 2294222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductNumeric(Mat); 2304222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductReplaceMats(Mat,Mat,Mat,Mat); 2314417c5e8SHong Zhang PETSC_EXTERN PetscErrorCode MatProductClear(Mat); 2326718818eSStefano Zampini PETSC_EXTERN PetscErrorCode MatProductView(Mat,PetscViewer); 233c600787bSStefano Zampini PETSC_EXTERN PetscErrorCode MatProductGetType(Mat,MatProductType*); 234c600787bSStefano Zampini PETSC_EXTERN PetscErrorCode MatProductGetMats(Mat,Mat*,Mat*,Mat*); 2354222ddf1SHong Zhang 236c06d978dSMatthew Knepley /* Logging support */ 2370700a824SBarry Smith #define MAT_FILE_CLASSID 1211216 /* used to indicate matrices in binary files */ 238014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_CLASSID; 239335efc43SPeter Brune PETSC_EXTERN PetscClassId MAT_COLORING_CLASSID; 240014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_FDCOLORING_CLASSID; 241014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_TRANSPOSECOLORING_CLASSID; 242014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_PARTITIONING_CLASSID; 243014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_COARSEN_CLASSID; 244014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_NULLSPACE_CLASSID; 245014dd563SJed Brown PETSC_EXTERN PetscClassId MATMFFD_CLASSID; 246c06d978dSMatthew Knepley 247ceb03754SKris Buschelman /*E 2487dae84e0SHong Zhang MatReuse - Indicates if matrices obtained from a previous call to MatCreateSubMatrices(), MatCreateSubMatrix(), MatConvert() or several other functions 249cf37664fSBarry Smith are to be reused to store the new matrix values. 250cf37664fSBarry Smith 251cf37664fSBarry Smith $ MAT_INITIAL_MATRIX - create a new matrix 252cf37664fSBarry Smith $ MAT_REUSE_MATRIX - reuse the matrix created with a previous call that used MAT_INITIAL_MATRIX 253cf37664fSBarry Smith $ MAT_INPLACE_MATRIX - replace the first input matrix with the new matrix (not applicable to all functions) 254cf37664fSBarry 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) 255ceb03754SKris Buschelman 256ceb03754SKris Buschelman Level: beginner 257ceb03754SKris Buschelman 258af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 259ceb03754SKris Buschelman 2607dae84e0SHong Zhang .seealso: MatCreateSubMatrices(), MatCreateSubMatrix(), MatDestroyMatrices(), MatConvert() 261ceb03754SKris Buschelman E*/ 262511c6705SHong Zhang typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX,MAT_INPLACE_MATRIX} MatReuse; 263ceb03754SKris Buschelman 2645494a064SHong Zhang /*E 2657dae84e0SHong Zhang MatCreateSubMatrixOption - Indicates if matrices obtained from a call to MatCreateSubMatrices() 266446c23c1SPierre Jolivet include the matrix values. Currently it is only used by MatGetSeqNonzeroStructure(). 2675494a064SHong Zhang 2685494a064SHong Zhang Level: beginner 2695494a064SHong Zhang 270446c23c1SPierre Jolivet .seealso: MatGetSeqNonzeroStructure() 2715494a064SHong Zhang E*/ 2727dae84e0SHong Zhang typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatCreateSubMatrixOption; 2735494a064SHong Zhang 274607a6623SBarry Smith PETSC_EXTERN PetscErrorCode MatInitializePackage(void); 275c06d978dSMatthew Knepley 276014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm,Mat*); 277014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt); 27819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatSetType(Mat,MatType); 2790d229a57SStefano Zampini PETSC_EXTERN PetscErrorCode MatGetVecType(Mat,VecType*); 2800d229a57SStefano Zampini PETSC_EXTERN PetscErrorCode MatSetVecType(Mat,VecType); 281014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat); 282fe2efc57SMark PETSC_EXTERN PetscErrorCode MatViewFromOptions(Mat,PetscObject,const char[]); 283bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatRegister(const char[],PetscErrorCode(*)(Mat)); 28423bebc0bSBarry Smith PETSC_EXTERN PetscErrorCode MatRegisterRootName(const char[],const char[],const char[]); 285014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat,const char[]); 286014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat,const char[]); 287014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat,const char*[]); 28884d44b13SHong Zhang PETSC_EXTERN PetscErrorCode MatSetErrorIfFailure(Mat,PetscBool); 289f69a0ea3SMatthew Knepley 290140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatList; 291140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatColoringList; 292140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatPartitioningList; 29328988994SBarry Smith 2943b224e63SBarry Smith /*E 295aa6c7ce3SBarry Smith MatStructure - Indicates if two matrices have the same nonzero structure 2963b224e63SBarry Smith 2973b224e63SBarry Smith Level: beginner 2983b224e63SBarry Smith 299531d0c6aSBarry Smith $ SAME_NONZERO_PATTERN - the two matrices have identical nonzero patterns 300531d0c6aSBarry Smith $ DIFFERENT_NONZERO_PATTERN - the two matrices may have different nonzero patterns 301531d0c6aSBarry Smith $ SUBSET_NONZERO_PATTERN - the nonzero pattern of the second matrix is a subset of the nonzero pattern of the first matrix 302531d0c6aSBarry Smith $ UNKNOWN_NONZERO_PATTERN - there is no known relationship between the nonzero patterns. In this case the implementations may try to detect a relationship to optimize the operation 303531d0c6aSBarry Smith 304531d0c6aSBarry Smith Developer Notes: 305d60b7d5cSBarry Smith Any additions/changes here MUST also be made in src/mat/f90-mod/petscmat.h 3063b224e63SBarry Smith 307531d0c6aSBarry Smith .seealso: MatCopy(), MatAXPY(), MatAYPX() 3083b224e63SBarry Smith E*/ 309d60b7d5cSBarry Smith typedef enum {DIFFERENT_NONZERO_PATTERN,SUBSET_NONZERO_PATTERN,SAME_NONZERO_PATTERN,UNKNOWN_NONZERO_PATTERN} MatStructure; 310d60b7d5cSBarry Smith PETSC_EXTERN const char *const MatStructures[]; 3113b224e63SBarry Smith 3129779e05dSSatish Balay #if defined PETSC_HAVE_MKL_SPARSE 313ddee360bSSatish Balay PETSC_EXTERN PetscErrorCode MatCreateSeqAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 314ddee360bSSatish Balay PETSC_EXTERN PetscErrorCode MatCreateMPIAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 31580095d54SIrina Sokolova PETSC_EXTERN PetscErrorCode MatCreateBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 316ddee360bSSatish Balay PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 31780095d54SIrina Sokolova #endif 318cd929ea3SAlp Dener 319d4002b98SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSeqSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 320d4002b98SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 321d4002b98SHong Zhang PETSC_EXTERN PetscErrorCode MatSeqSELLSetPreallocation(Mat,PetscInt,const PetscInt[]); 322d4002b98SHong Zhang PETSC_EXTERN PetscErrorCode MatMPISELLSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 32380095d54SIrina Sokolova 324014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*); 325014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*); 326014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 327014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 328014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*); 3298f8f2f0dSBarry Smith PETSC_EXTERN PetscErrorCode MatUpdateMPIAIJWithArrays(Mat,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 330014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*); 3313b00a383SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSeqAIJ(MPI_Comm,Mat,Mat,const PetscInt[],Mat*); 3323b00a383SHong Zhang 333014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 334014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 335014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*); 3367e8381f9SStefano Zampini 33782a78a4eSJed Brown PETSC_EXTERN PetscErrorCode MatSetPreallocationCOO(Mat,PetscCount,const PetscInt[],const PetscInt[]); 33882a78a4eSJed Brown PETSC_EXTERN PetscErrorCode MatSetPreallocationCOOLocal(Mat,PetscCount,PetscInt[],PetscInt[]); 3397e8381f9SStefano Zampini PETSC_EXTERN PetscErrorCode MatSetValuesCOO(Mat,const PetscScalar[],InsertMode); 340d21a29f3SJed Brown 341014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*); 342014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 343d21a29f3SJed Brown 344014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 345014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *); 34638f409ebSLisandro Dalcin PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 347014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 3484cce697cSJed Brown PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],const PetscInt[]); 349dfb205c3SBarry Smith 350014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*); 351c1fff1c6SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatCreateCentering(MPI_Comm,PetscInt,PetscInt,Mat*); 352014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat,Mat*); 353c5e4d11fSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatCreateNormalHermitian(Mat,Mat*); 354986c4d72SJose E. Roman PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat,Mat,Vec,Mat,Mat*); 355267ca84cSJose E. Roman PETSC_EXTERN PetscErrorCode MatLRCGetMats(Mat,Mat*,Mat*,Vec*,Mat*); 356c5e4d11fSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,ISLocalToGlobalMapping,Mat*); 357014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 358014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 359c0cdd4a1SDahai Guo 360014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*); 361014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter); 362014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*); 363014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*); 364014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat,Mat); 365014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat); 3668c8613bfSJakub Kruzik typedef enum {MAT_COMPOSITE_MERGE_RIGHT,MAT_COMPOSITE_MERGE_LEFT} MatCompositeMergeType; 3678c8613bfSJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeSetMergeType(Mat,MatCompositeMergeType); 368014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*); 3696d7c1e57SBarry Smith typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType; 370014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat,MatCompositeType); 3716dbc55e5SJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetType(Mat,MatCompositeType*); 3723b35acafSJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeSetMatStructure(Mat,MatStructure); 3733b35acafSJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetMatStructure(Mat,MatStructure*); 3746d0add67SJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetNumberMat(Mat,PetscInt*); 3758b5c3584SJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetMat(Mat,PetscInt,Mat*); 37603049c21SJunchao Zhang PETSC_EXTERN PetscErrorCode MatCompositeSetScalings(Mat,const PetscScalar*); 3776d7c1e57SBarry Smith 37819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateFFT(MPI_Comm,PetscInt,const PetscInt[],MatType,Mat*); 379014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqCUFFT(MPI_Comm,PetscInt,const PetscInt[],Mat*); 380dedccee8SHong Zhang 381014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*); 3828060fb66Sstefano_zampini PETSC_EXTERN PetscErrorCode MatTransposeGetMat(Mat,Mat*); 383d0de2241SAndrew Spott PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat,Mat*); 38406511a5cSPierre Jolivet PETSC_EXTERN PetscErrorCode MatHermitianTransposeGetMat(Mat,Mat*); 385fa80d070SPierre Jolivet PETSC_EXTERN PetscErrorCode MatNormalGetMat(Mat,Mat*); 38665f45395SPierre Jolivet PETSC_EXTERN PetscErrorCode MatNormalHermitianGetMat(Mat,Mat*); 38754e05e6cSHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatrixVirtual(Mat,IS,IS,Mat*); 38854e05e6cSHong Zhang PETSC_EXTERN PetscErrorCode MatSubMatrixVirtualUpdate(Mat,Mat,IS,IS); 389014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*); 3903423f386SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateConstantDiagonal(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar,Mat*); 3911472f72bSBarry Smith 392978814f1SStefano Zampini #if defined(PETSC_HAVE_HYPRE) 393d975228cSstefano_zampini PETSC_EXTERN PetscErrorCode MatHYPRESetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 394978814f1SStefano Zampini #endif 395978814f1SStefano Zampini 396014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPythonSetType(Mat,const char[]); 3971d6018f0SLisandro Dalcin 398846b4da1SFande Kong PETSC_EXTERN PetscErrorCode MatResetPreallocation(Mat); 399014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetUp(Mat); 400014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDestroy(Mat*); 401e56f5c9eSBarry Smith PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat,PetscObjectState*); 40221c89e3eSBarry Smith 403014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatConjugate(Mat); 404014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRealPart(Mat); 405014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat); 406014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,Mat*); 407014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetTrace(Mat,PetscScalar*); 408713ccfa9SJed Brown PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat,const PetscScalar **); 4090da83c2eSBarry Smith PETSC_EXTERN PetscErrorCode MatInvertVariableBlockDiagonal(Mat,PetscInt,const PetscInt*,PetscScalar*); 410479a70c0SJed Brown PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonalMat(Mat,Mat); 411*8a9c020eSBarry Smith PETSC_EXTERN PetscErrorCode MatInvertVariableBlockEnvelope(Mat,MatReuse,Mat*); 41299cafbc1SBarry Smith 4138ed539a5SBarry Smith /* ------------------------------------------------------------*/ 414014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 415*8a9c020eSBarry Smith PETSC_EXTERN PetscErrorCode MatSetValuesIS(Mat,IS,IS,const PetscScalar[],InsertMode); 416014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 417014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]); 418014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]); 419014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat,PetscInt,PetscInt,PetscInt[],const PetscScalar[]); 42073a71a0fSBarry Smith PETSC_EXTERN PetscErrorCode MatSetRandom(Mat,PetscRandom); 42184cb2905SBarry Smith 4222ef4de8bSBarry Smith /*S 4232ef4de8bSBarry Smith MatStencil - Data structure (C struct) for storing information about a single row or 42462ef0227SBarry Smith column of a matrix as indexed on an associated grid. These are arguments to MatSetStencil() and MatSetBlockStencil() 42562ef0227SBarry Smith 42662ef0227SBarry 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). 42762ef0227SBarry 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. 42862ef0227SBarry Smith 42962ef0227SBarry Smith For stencil access to vectors see DMDAVecGetArray(), DMDAVecGetArrayF90(). 430be479b30SJed Brown 431be479b30SJed Brown Fortran usage is different, see MatSetValuesStencil() for details. 4322ef4de8bSBarry Smith 4332ef4de8bSBarry Smith Level: beginner 4342ef4de8bSBarry Smith 43562ef0227SBarry Smith .seealso: MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockedStencil(), DMDAVecGetArray(), DMDAVecGetArrayF90() 4362ef4de8bSBarry Smith S*/ 437435da068SBarry Smith typedef struct { 438c1ac3661SBarry Smith PetscInt k,j,i,c; 439435da068SBarry Smith } MatStencil; 4402ef4de8bSBarry Smith 441014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 442014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 443014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt); 444435da068SBarry Smith 445d91e6319SBarry Smith /*E 446d91e6319SBarry Smith MatAssemblyType - Indicates if the matrix is now to be used, or if you plan 44762ef0227SBarry Smith to continue to add or insert values to it 448d91e6319SBarry Smith 449d91e6319SBarry Smith Level: beginner 450d91e6319SBarry Smith 451d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd() 452d91e6319SBarry Smith E*/ 4536d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType; 454014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType); 455014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType); 456014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssembled(Mat,PetscBool *); 4574f9c727eSBarry Smith 458d91e6319SBarry Smith /*E 459d91e6319SBarry Smith MatOption - Options that may be set for a matrix and its behavior or storage 460d91e6319SBarry Smith 461d91e6319SBarry Smith Level: beginner 462d91e6319SBarry Smith 463af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 4640f8fb01aSBarry Smith Any additions/changes here must also be made in src/mat/interface/dlregismat.c in MatOptions[] 465d91e6319SBarry Smith 46695452b02SPatrick Sanan Developer Notes: 46795452b02SPatrick Sanan Entries that are negative need not be called collectively by all processes. 468382164b0SBarry Smith 469d91e6319SBarry Smith .seealso: MatSetOption() 470d91e6319SBarry Smith E*/ 471c5e4d11fSDmitry Karpeev typedef enum {MAT_OPTION_MIN = -3, 472c5e4d11fSDmitry Karpeev MAT_UNUSED_NONZERO_LOCATION_ERR = -2, 47392d4d306SBarry Smith MAT_ROW_ORIENTED = -1, 474382164b0SBarry Smith MAT_SYMMETRIC = 1, 475382164b0SBarry Smith MAT_STRUCTURALLY_SYMMETRIC = 2, 4768c78258cSHong Zhang MAT_FORCE_DIAGONAL_ENTRIES = 3, 477382164b0SBarry Smith MAT_IGNORE_OFF_PROC_ENTRIES = 4, 478382164b0SBarry Smith MAT_USE_HASH_TABLE = 5, 479382164b0SBarry Smith MAT_KEEP_NONZERO_PATTERN = 6, 480382164b0SBarry Smith MAT_IGNORE_ZERO_ENTRIES = 7, 481382164b0SBarry Smith MAT_USE_INODES = 8, 482382164b0SBarry Smith MAT_HERMITIAN = 9, 483382164b0SBarry Smith MAT_SYMMETRY_ETERNAL = 10, 484c5e4d11fSDmitry Karpeev MAT_NEW_NONZERO_LOCATION_ERR = 11, 485382164b0SBarry Smith MAT_IGNORE_LOWER_TRIANGULAR = 12, 486382164b0SBarry Smith MAT_ERROR_LOWER_TRIANGULAR = 13, 487382164b0SBarry Smith MAT_GETROW_UPPERTRIANGULAR = 14, 488382164b0SBarry Smith MAT_SPD = 15, 48992d4d306SBarry Smith MAT_NO_OFF_PROC_ZERO_ROWS = 16, 49092d4d306SBarry Smith MAT_NO_OFF_PROC_ENTRIES = 17, 49192d4d306SBarry Smith MAT_NEW_NONZERO_LOCATIONS = 18, 492c5e4d11fSDmitry Karpeev MAT_NEW_NONZERO_ALLOCATION_ERR = 19, 493c5e4d11fSDmitry Karpeev MAT_SUBSET_OFF_PROC_ENTRIES = 20, 494c10200c1SHong Zhang MAT_SUBMAT_SINGLEIS = 21, 495957cac9fSHong Zhang MAT_STRUCTURE_ONLY = 22, 496071fcb05SBarry Smith MAT_SORTED_FULL = 23, 4971a2c6b5cSJunchao Zhang MAT_FORM_EXPLICIT_TRANSPOSE = 24, 4981a2c6b5cSJunchao Zhang MAT_OPTION_MAX = 25} MatOption; 499e057df02SPaul Mullowney 5000f8fb01aSBarry Smith PETSC_EXTERN const char *const *MatOptions; 501014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscBool); 5027d68702bSBarry Smith PETSC_EXTERN PetscErrorCode MatGetOption(Mat,MatOption,PetscBool*); 503856afa8bSStefano Zampini PETSC_EXTERN PetscErrorCode MatPropagateSymmetryOptions(Mat,Mat); 50419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatGetType(Mat,MatType*); 50584cb2905SBarry Smith 506014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]); 507014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 508014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 509014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat); 510014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat); 511014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt); 5128c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat,PetscScalar *[]); 5138f1ea47aSStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJGetArrayRead(Mat,const PetscScalar *[]); 514d67d9f35SJunchao Zhang PETSC_EXTERN PetscErrorCode MatSeqAIJGetArrayWrite(Mat,PetscScalar *[]); 5158c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat,PetscScalar *[]); 5168f1ea47aSStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArrayRead(Mat,const PetscScalar *[]); 517d67d9f35SJunchao Zhang PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArrayWrite(Mat,PetscScalar *[]); 51821e72a00SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJGetMaxRowNonzeros(Mat,PetscInt*); 519bd04181cSBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJSetValuesLocalFast(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 5204099cc6bSBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJSetType(Mat,MatType); 521ad7e164aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatSeqAIJKron(Mat,Mat,MatReuse,Mat*); 522388d47a6SSatish Balay PETSC_EXTERN PetscErrorCode MatSeqAIJRegister(const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat *)); 5234099cc6bSBarry Smith PETSC_EXTERN PetscFunctionList MatSeqAIJList; 524cda14afcSprj- PETSC_EXTERN PetscErrorCode MatSeqBAIJGetArray(Mat,PetscScalar *[]); 525cda14afcSprj- PETSC_EXTERN PetscErrorCode MatSeqBAIJRestoreArray(Mat,PetscScalar *[]); 5268397e458SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqSBAIJGetArray(Mat,PetscScalar *[]); 5278397e458SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqSBAIJRestoreArray(Mat,PetscScalar *[]); 5288c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat,PetscScalar *[]); 5298c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat,PetscScalar *[]); 530d3042a70SBarry Smith PETSC_EXTERN PetscErrorCode MatDensePlaceArray(Mat,const PetscScalar[]); 531d5ea218eSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseReplaceArray(Mat,const PetscScalar[]); 532d3042a70SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseResetArray(Mat); 5338572280aSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetArrayRead(Mat,const PetscScalar *[]); 5348572280aSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayRead(Mat,const PetscScalar *[]); 5356947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseGetArrayWrite(Mat,PetscScalar *[]); 5366947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayWrite(Mat,PetscScalar *[]); 537014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *); 538014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt); 539014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat,PetscInt *,PetscInt *); 540014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat,PetscInt,PetscInt); 54133d57670SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSizesFromMats(Mat,Mat,Mat); 5420da83c2eSBarry Smith PETSC_EXTERN PetscErrorCode MatSetVariableBlockSizes(Mat,PetscInt,PetscInt*); 5430da83c2eSBarry Smith PETSC_EXTERN PetscErrorCode MatGetVariableBlockSizes(Mat,PetscInt*,const PetscInt**); 544*8a9c020eSBarry Smith PETSC_EXTERN PetscErrorCode MatComputeVariableBlockSizes(Mat); 5450da83c2eSBarry Smith 54686aefd0dSHong Zhang PETSC_EXTERN PetscErrorCode MatDenseGetColumn(Mat,PetscInt,PetscScalar*[]); 54786aefd0dSHong Zhang PETSC_EXTERN PetscErrorCode MatDenseRestoreColumn(Mat,PetscScalar*[]); 5486947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseGetColumnVec(Mat,PetscInt,Vec*); 5496947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVec(Mat,PetscInt,Vec*); 5506947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecRead(Mat,PetscInt,Vec*); 5516947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecRead(Mat,PetscInt,Vec*); 5526947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecWrite(Mat,PetscInt,Vec*); 5536947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecWrite(Mat,PetscInt,Vec*); 5545ea7661aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatDenseGetSubMatrix(Mat,PetscInt,PetscInt,Mat*); 5555ea7661aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatDenseRestoreSubMatrix(Mat,Mat*); 5561620fd73SBarry Smith 557014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMult(Mat,Vec,Vec); 558014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec); 559014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec); 560014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec); 561014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec); 562014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *); 563014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *); 564014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec); 565014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec); 566014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat); 567bdc285e1SStefano Zampini PETSC_EXTERN PetscErrorCode MatMatSolveTranspose(Mat,Mat,Mat); 568eb3ef3b2SHong Zhang PETSC_EXTERN PetscErrorCode MatMatTransposeSolve(Mat,Mat,Mat); 569f9426fe0SMark Adams PETSC_EXTERN PetscErrorCode MatResidual(Mat,Vec,Vec,Vec); 570f5edf698SHong Zhang 571d91e6319SBarry Smith /*E 572d91e6319SBarry Smith MatDuplicateOption - Indicates if a duplicated sparse matrix should have 573d91e6319SBarry Smith its numerical values copied over or just its nonzero structure. 574d91e6319SBarry Smith 575d91e6319SBarry Smith Level: beginner 576d91e6319SBarry Smith 577af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 578d91e6319SBarry Smith 5790018da39SRichard Tran Mills $ MAT_DO_NOT_COPY_VALUES - Create a matrix using the same nonzero pattern as the original matrix, 5800018da39SRichard Tran Mills $ with zeros for the numerical values. 5810018da39SRichard Tran Mills $ MAT_COPY_VALUES - Create a matrix with the same nonzero pattern as the original matrix 5820018da39SRichard Tran Mills $ and with the same numerical values. 5830018da39SRichard Tran Mills $ MAT_SHARE_NONZERO_PATTERN - Create a matrix that shares the nonzero structure with the previous matrix 5840018da39SRichard Tran Mills $ and does not copy it, using zeros for the numerical values. The parent and 5850018da39SRichard Tran Mills $ child matrices will share their index (i and j) arrays, and you cannot 5860018da39SRichard Tran Mills $ insert new nonzero entries into either matrix. 5870018da39SRichard Tran Mills 58895452b02SPatrick Sanan Notes: 58995452b02SPatrick Sanan Many matrix types (including SeqAIJ) do not support the MAT_SHARE_NONZERO_PATTERN optimization; in 5900018da39SRichard Tran Mills this case the behavior is as if MAT_DO_NOT_COPY_VALUES has been specified. 59170dcbbb9SBarry Smith 592d91e6319SBarry Smith .seealso: MatDuplicate() 593d91e6319SBarry Smith E*/ 59470dcbbb9SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption; 5952e8a6d31SBarry Smith 59619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*); 597014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*); 59894a9d846SBarry Smith 599014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure); 600014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer); 601014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *); 602014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *); 603014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *); 604014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *); 605014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *); 606014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool *,PetscInt *); 607014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer); 6087b80b807SBarry Smith 6091a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *); 6101a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *); 6111a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *); 6121a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *); 613d4fbbf0eSBarry Smith 614d91e6319SBarry Smith /*S 615d91e6319SBarry Smith MatInfo - Context of matrix information, used with MatGetInfo() 616d91e6319SBarry Smith 617d91e6319SBarry Smith In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE 618d91e6319SBarry Smith 619d91e6319SBarry Smith Level: intermediate 620d91e6319SBarry Smith 621d9274352SBarry Smith .seealso: MatGetInfo(), MatInfoType 622d91e6319SBarry Smith S*/ 6234e220ebcSLois Curfman McInnes typedef struct { 624b0a32e0cSBarry Smith PetscLogDouble block_size; /* block size */ 625b0a32e0cSBarry Smith PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */ 626b0a32e0cSBarry Smith PetscLogDouble memory; /* memory allocated */ 627b0a32e0cSBarry Smith PetscLogDouble assemblies; /* number of matrix assemblies called */ 628b0a32e0cSBarry Smith PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */ 629b0a32e0cSBarry Smith PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */ 630b0a32e0cSBarry Smith PetscLogDouble factor_mallocs; /* number of mallocs during factorization */ 6314e220ebcSLois Curfman McInnes } MatInfo; 6324e220ebcSLois Curfman McInnes 633d9274352SBarry Smith /*E 634d9274352SBarry Smith MatInfoType - Indicates if you want information about the local part of the matrix, 635d9274352SBarry Smith the entire parallel matrix or the maximum over all the local parts. 636d9274352SBarry Smith 637d9274352SBarry Smith Level: beginner 638d9274352SBarry Smith 639af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 640d9274352SBarry Smith 641d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo 642d9274352SBarry Smith E*/ 6437b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType; 644014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*); 645014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec); 646014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]); 647014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]); 648014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]); 649014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]); 650014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat,Vec); 651014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*); 652014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*); 653014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat*); 654014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec); 655014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode); 656a52676ecSHong Zhang 657014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool*); 658014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool*); 659014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool*); 660014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool*); 661014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*); 662e573050aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeEqual(Mat,Mat,PetscInt,PetscBool*); 663e573050aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*); 664a52676ecSHong Zhang PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 665a52676ecSHong Zhang PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 666cc48ffa7SToby Isaac PETSC_EXTERN PetscErrorCode MatMatTransposeMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 6674222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatPtAPMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 668447fed29SStefano Zampini PETSC_EXTERN PetscErrorCode MatRARtMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 66986919fd6SHong Zhang PETSC_EXTERN PetscErrorCode MatIsLinear(Mat,PetscInt,PetscBool*); 6707b80b807SBarry Smith 671014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal*); 672014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal*); 673857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnSums(Mat,PetscScalar*); 674857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnSumsRealPart(Mat,PetscReal*); 675857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnSumsImaginaryPart(Mat,PetscReal*); 676857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnMeans(Mat,PetscScalar*); 677857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnMeansRealPart(Mat,PetscReal*); 678857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnMeansImaginaryPart(Mat,PetscReal*); 679857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnReductions(Mat,PetscInt,PetscReal*); 680014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat); 6811b2b9847SBarry Smith PETSC_EXTERN PetscErrorCode MatSetInf(Mat); 682014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 683014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec); 684014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec); 685014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec); 686014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 687014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec); 6887b80b807SBarry Smith 689014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*); 690014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*); 691014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*); 692014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**); 693014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*); 694014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**); 695566876eaSJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*); 6965ef9f2a5SBarry Smith 6977dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 6989fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatCreateSubMatrices() (since version 3.8)") 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);} 6997dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 7009fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatCreateSubMatricesMPI() (since version 3.8)") 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);} 701014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]); 702df750dc8SHong Zhang PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt,Mat *[]); 7037dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,MatReuse,Mat *); 7049fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatCreateSubMatrix() (since version 3.8)") static inline PetscErrorCode MatGetSubMatrix(Mat mat,IS isrow,IS iscol,MatReuse cll,Mat *newmat) {return MatCreateSubMatrix(mat,isrow,iscol,cll,newmat);} 705014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*); 706014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*); 707014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*); 708014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*); 7097b80b807SBarry Smith 710014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*); 711014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*); 712014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat); 713014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*); 714*8a9c020eSBarry Smith PETSC_EXTERN PetscErrorCode MatAIJGetLocalMat(Mat,Mat*); 715014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*); 716ed502f03SStefano Zampini PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatMerge(Mat,MatReuse,IS*,Mat*); 717014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*); 718014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]); 7198efafbd8SBarry Smith 720014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt); 721aa1e27eaSFande Kong PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat mat,PetscInt n,IS is[],PetscInt ov); 722d2b2a242SBarry Smith PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat,PetscBool); 7237b80b807SBarry Smith 724014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 72522440eb1SKris Buschelman 7267bab7c10SHong Zhang PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*); 7272df6c5c3SPatrick Farrell PETSC_EXTERN PetscErrorCode MatGalerkin(Mat,Mat,Mat,MatReuse,PetscReal,Mat*); 7287bab7c10SHong Zhang 729014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*); 730014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*); 73122440eb1SKris Buschelman 732014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 733014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*); 734bc011b1eSHong Zhang 735014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure); 736014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure); 7371c741599SHong Zhang 738014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar); 739014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar); 7407b80b807SBarry Smith 741014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping); 742014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*); 743a93ff8c4SPeter Brune PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat,PetscLayout*,PetscLayout*); 74481fa06acSBarry Smith PETSC_EXTERN PetscErrorCode MatSetLayouts(Mat,PetscLayout,PetscLayout); 745014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 746014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec); 747014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 748014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec); 749e265f6d6SPatrick Sanan PETSC_EXTERN PetscErrorCode MatGetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]); 750014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 751014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 752052efed2SBarry Smith 753014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt); 754014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 75590f02eecSBarry Smith 756014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec); 757014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec); 758014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec); 75930b0564aSStefano Zampini PETSC_EXTERN PetscErrorCode MatMatInterpolate(Mat,Mat,Mat*); 76030b0564aSStefano Zampini PETSC_EXTERN PetscErrorCode MatMatInterpolateAdd(Mat,Mat,Mat,Mat*); 76130b0564aSStefano Zampini PETSC_EXTERN PetscErrorCode MatMatRestrict(Mat,Mat,Mat*); 7622a7a6963SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat,Vec*,Vec*); 7639fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatCreateVecs() (since version 3.6)") static inline PetscErrorCode MatGetVecs(Mat mat,Vec *x,Vec *y) {return MatCreateVecs(mat,x,y);} 76453cd1579SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat,PetscInt,MPI_Comm,MatReuse,Mat*); 765014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*); 766014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*); 7673a062f41SBarry Smith PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat,IS*); 7689c8f2541SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm,Mat,PetscInt,MatReuse,Mat*); 769bd481603SBarry Smith 770bd481603SBarry Smith /*MC 7711620fd73SBarry Smith MatSetValue - Set a single entry into a matrix. 7721620fd73SBarry Smith 7731620fd73SBarry Smith Not collective 7741620fd73SBarry Smith 775a9834a7dSSatish Balay Synopsis: 776a9834a7dSSatish Balay #include <petscmat.h> 777a9834a7dSSatish Balay PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode) 778a9834a7dSSatish Balay 7791620fd73SBarry Smith Input Parameters: 7801620fd73SBarry Smith + m - the matrix 7811620fd73SBarry Smith . row - the row location of the entry 7821620fd73SBarry Smith . col - the column location of the entry 7831620fd73SBarry Smith . value - the value to insert 7841620fd73SBarry Smith - mode - either INSERT_VALUES or ADD_VALUES 7851620fd73SBarry Smith 7861620fd73SBarry Smith Notes: 787e5e5a7b5SPatrick Sanan For efficiency one should use MatSetValues() and set several values simultaneously. 7881620fd73SBarry Smith 7891620fd73SBarry Smith Level: beginner 7901620fd73SBarry Smith 791e5e5a7b5SPatrick Sanan .seealso: MatGetValue(), MatSetValues(), MatSetValueLocal(), MatSetValuesLocal() 7921620fd73SBarry Smith M*/ 7939fbee547SJacob Faibussowitsch static inline PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);} 7941620fd73SBarry Smith 795e5e5a7b5SPatrick Sanan /*@C 796e5e5a7b5SPatrick Sanan MatGetValue - Gets a single value from a matrix 7971620fd73SBarry Smith 798e5e5a7b5SPatrick Sanan Not Collective; can only return a value owned by the given process 799e5e5a7b5SPatrick Sanan 800e5e5a7b5SPatrick Sanan Input Parameters: 801e5e5a7b5SPatrick Sanan + mat - the matrix 802e5e5a7b5SPatrick Sanan . row - the row location of the entry 803e5e5a7b5SPatrick Sanan - col - the column location of the entry 804e5e5a7b5SPatrick Sanan 805e5e5a7b5SPatrick Sanan Output Parameter: 806e5e5a7b5SPatrick Sanan . va - the value 807e5e5a7b5SPatrick Sanan 808e5e5a7b5SPatrick Sanan Notes: 809e5e5a7b5SPatrick Sanan For efficiency one should use MatGetValues() and get several values simultaneously. 810e5e5a7b5SPatrick Sanan 811e5e5a7b5SPatrick Sanan See notes for MatGetValues(). 812e5e5a7b5SPatrick Sanan 813e5e5a7b5SPatrick Sanan Level: advanced 814e5e5a7b5SPatrick Sanan 815e5e5a7b5SPatrick Sanan .seealso: MatSetValue(), MatGetValueLocal(), MatGetValues() 816e5e5a7b5SPatrick Sanan @*/ 8179fbee547SJacob Faibussowitsch static inline PetscErrorCode MatGetValue(Mat mat,PetscInt row,PetscInt col,PetscScalar *va) {return MatGetValues(mat,1,&row,1,&col,va);} 818e5e5a7b5SPatrick Sanan 819e5e5a7b5SPatrick Sanan /*MC 820e5e5a7b5SPatrick Sanan MatSetValueLocal - Inserts or adds a single value into a matrix, 821e5e5a7b5SPatrick Sanan using a local numbering of the nodes. 822e5e5a7b5SPatrick Sanan 823e5e5a7b5SPatrick Sanan Not Collective 824e5e5a7b5SPatrick Sanan 825e5e5a7b5SPatrick Sanan Input Parameters: 826e5e5a7b5SPatrick Sanan + m - the matrix 827e5e5a7b5SPatrick Sanan . row - the row location of the entry 828e5e5a7b5SPatrick Sanan . col - the column location of the entry 829e5e5a7b5SPatrick Sanan . value - the value to insert 830e5e5a7b5SPatrick Sanan - mode - either INSERT_VALUES or ADD_VALUES 831e5e5a7b5SPatrick Sanan 832e5e5a7b5SPatrick Sanan Notes: 833e5e5a7b5SPatrick Sanan For efficiency one should use MatSetValuesLocal() and set several values simultaneously. 834e5e5a7b5SPatrick Sanan 835e5e5a7b5SPatrick Sanan See notes for MatSetValuesLocal() for additional information on when and how this function can be used. 836e5e5a7b5SPatrick Sanan 837e5e5a7b5SPatrick Sanan Level: intermediate 838e5e5a7b5SPatrick Sanan 839e5e5a7b5SPatrick Sanan .seealso: MatSetValue(), MatSetValuesLocal() 840e5e5a7b5SPatrick Sanan M*/ 8419fbee547SJacob Faibussowitsch static inline PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);} 8421620fd73SBarry Smith 8431620fd73SBarry Smith /*MC 844d0609cedSBarry Smith MatPreallocateBegin - Begins the block of code that will count the number of nonzeros per 845bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 846bd481603SBarry Smith 847bd481603SBarry Smith Synopsis: 848aaa7dc30SBarry Smith #include <petscmat.h> 849d0609cedSBarry Smith PetscErrorCode MatPreallocateBegin(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 850bd481603SBarry Smith 851d083f849SBarry Smith Collective 852bd481603SBarry Smith 853bd481603SBarry Smith Input Parameters: 854bd481603SBarry Smith + comm - the communicator that will share the eventually allocated matrix 855859fcb39SBarry Smith . nrows - the number of LOCAL rows in the matrix 856859fcb39SBarry Smith - ncols - the number of LOCAL columns in the matrix 857bd481603SBarry Smith 858bd481603SBarry Smith Output Parameters: 859bd481603SBarry Smith + dnz - the array that will be passed to the matrix preallocation routines 860a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 861bd481603SBarry Smith 862bd481603SBarry Smith Level: intermediate 863bd481603SBarry Smith 864bd481603SBarry Smith Notes: 865d0609cedSBarry Smith This is a macro that handles its own error checking, it does not return an error code. 866d0609cedSBarry Smith 867a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 868bd481603SBarry Smith 8691d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 870bd481603SBarry Smith 871d0609cedSBarry Smith Developer Notes: 8721620fd73SBarry Smith This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize(). 8731620fd73SBarry Smith 874d0609cedSBarry Smith .seealso: MatPreallocateEnd(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(), 875de25e9cbSPierre Jolivet MatPreallocateSymmetricSetLocalBlock() 876bd481603SBarry Smith M*/ 877d0609cedSBarry Smith #define MatPreallocateBegin(comm,nrows,ncols,dnz,onz) do { \ 8785f80ce2aSJacob Faibussowitsch PetscInt __nrows = (nrows),__ncols = (ncols),__rstart,__start,__end = 0; \ 8799566063dSJacob Faibussowitsch PetscCall(PetscCalloc2(__nrows,&(dnz),__nrows,&(onz))); \ 8809566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&__ncols,&__end,1,MPIU_INT,MPI_SUM,comm)); \ 8815f80ce2aSJacob Faibussowitsch __start = __end - __ncols; (void)__start; \ 8829566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm)); \ 8835f80ce2aSJacob Faibussowitsch __rstart -= __nrows 8847c922b88SBarry Smith 885d0609cedSBarry Smith #define MatPreallocateInitialize(...) PETSC_DEPRECATED_MACRO("GCC warning \"Use MatPreallocateBegin() (since version 3.18)\"") MatPreallocateBegin(__VA_ARGS__) 886d0609cedSBarry Smith 887bd481603SBarry Smith /*MC 888bd481603SBarry Smith MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 889bd481603SBarry Smith inserted using a local number of the rows and columns 890bd481603SBarry Smith 891bd481603SBarry Smith Synopsis: 892aaa7dc30SBarry Smith #include <petscmat.h> 893c1ac3661SBarry Smith PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 894bd481603SBarry Smith 895bd481603SBarry Smith Not Collective 896bd481603SBarry Smith 897bd481603SBarry Smith Input Parameters: 898784ac674SJed Brown + map - the row mapping from local numbering to global numbering 899bd481603SBarry Smith . nrows - the number of rows indicated 9001d73ed98SBarry Smith . rows - the indices of the rows 901784ac674SJed Brown . cmap - the column mapping from local to global numbering 902bd481603SBarry Smith . ncols - the number of columns in the matrix 903bd481603SBarry Smith . cols - the columns indicated 904bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 905a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 906bd481603SBarry Smith 907bd481603SBarry Smith Level: intermediate 908bd481603SBarry Smith 909bd481603SBarry Smith Notes: 910a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 911bd481603SBarry Smith 9121d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 913bd481603SBarry Smith 914d0609cedSBarry Smith .seealso: MatPreallocateEnd(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock() 915d0609cedSBarry Smith MatPreallocateBegin(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocalRemoveDups() 916bd481603SBarry Smith M*/ 91794bad497SJacob Faibussowitsch #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) \ 91894bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 9199566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApply(rmap,nrows,rows,rows)); \ 9209566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApply(cmap,ncols,cols,cols)); \ 9219566063dSJacob Faibussowitsch for (PetscInt __l=0;__l<nrows;__l++) PetscCall(MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz)); \ 92294bad497SJacob Faibussowitsch ) 923c4f061fbSSatish Balay 924bd481603SBarry Smith /*MC 925c1154cd5SBarry Smith MatPreallocateSetLocalRemoveDups - Indicates the locations (rows and columns) in the matrix where nonzeros will be 926c1154cd5SBarry Smith inserted using a local number of the rows and columns. This version removes any duplicate columns in cols 927c1154cd5SBarry Smith 928c1154cd5SBarry Smith Synopsis: 929c1154cd5SBarry Smith #include <petscmat.h> 930c1154cd5SBarry Smith PetscErrorCode MatPreallocateSetLocalRemoveDups(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 931c1154cd5SBarry Smith 932c1154cd5SBarry Smith Not Collective 933c1154cd5SBarry Smith 934c1154cd5SBarry Smith Input Parameters: 935c1154cd5SBarry Smith + map - the row mapping from local numbering to global numbering 936c1154cd5SBarry Smith . nrows - the number of rows indicated 937c1154cd5SBarry Smith . rows - the indices of the rows (these values are mapped to the global values) 938c1154cd5SBarry Smith . cmap - the column mapping from local to global numbering 939c1154cd5SBarry Smith . ncols - the number of columns in the matrix (this value will be changed if duplicate columns are found) 940c1154cd5SBarry Smith . cols - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed) 941c1154cd5SBarry 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 943c1154cd5SBarry Smith 944c1154cd5SBarry Smith Level: intermediate 945c1154cd5SBarry Smith 946c1154cd5SBarry Smith Notes: 947c1154cd5SBarry Smith See Users-Manual: ch_performance for more details. 948c1154cd5SBarry Smith 949c1154cd5SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 950c1154cd5SBarry Smith 951d0609cedSBarry Smith .seealso: MatPreallocateEnd(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock() 952d0609cedSBarry Smith MatPreallocateBegin(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal() 953c1154cd5SBarry Smith M*/ 95494bad497SJacob Faibussowitsch #define MatPreallocateSetLocalRemoveDups(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) \ 95594bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 9569566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApply(rmap,nrows,rows,rows)); \ 9579566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApply(cmap,ncols,cols,cols)); \ 9589566063dSJacob Faibussowitsch PetscCall(PetscSortRemoveDupsInt(&ncols,cols)); \ 9599566063dSJacob Faibussowitsch for (PetscInt __l=0;__l<nrows;__l++) PetscCall(MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz)); \ 96094bad497SJacob Faibussowitsch ) 961c1154cd5SBarry Smith 962c1154cd5SBarry Smith /*MC 963d6e23781SBarry Smith MatPreallocateSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 964bd481603SBarry Smith inserted using a local number of the rows and columns 965bd481603SBarry Smith 966bd481603SBarry Smith Synopsis: 967aaa7dc30SBarry Smith #include <petscmat.h> 968d6e23781SBarry Smith PetscErrorCode MatPreallocateSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 969d6e23781SBarry Smith 970d6e23781SBarry Smith Not Collective 971d6e23781SBarry Smith 972d6e23781SBarry Smith Input Parameters: 973d6e23781SBarry Smith + map - the row mapping from local numbering to global numbering 974d6e23781SBarry Smith . nrows - the number of rows indicated 975d6e23781SBarry Smith . rows - the indices of the rows 976d6e23781SBarry Smith . cmap - the column mapping from local to global numbering 977d6e23781SBarry Smith . ncols - the number of columns in the matrix 978d6e23781SBarry Smith . cols - the columns indicated 979d6e23781SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 980a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 981d6e23781SBarry Smith 982d6e23781SBarry Smith Level: intermediate 983d6e23781SBarry Smith 984d6e23781SBarry Smith Notes: 985d6e23781SBarry Smith See Users-Manual: ch_performance for more details. 986d6e23781SBarry Smith 987d6e23781SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 988d6e23781SBarry Smith 989d0609cedSBarry Smith .seealso: MatPreallocateEnd(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock() 990d0609cedSBarry Smith MatPreallocateBegin(), MatPreallocateSymmetricSetLocalBlock() 991d6e23781SBarry Smith M*/ 99294bad497SJacob Faibussowitsch #define MatPreallocateSetLocalBlock(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) \ 99394bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 9949566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApplyBlock(rmap,nrows,rows,rows)); \ 9959566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApplyBlock(cmap,ncols,cols,cols)); \ 9969566063dSJacob Faibussowitsch for (PetscInt __l=0;__l<nrows;__l++) PetscCall(MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz)); \ 99794bad497SJacob Faibussowitsch ) 998d6e23781SBarry Smith 999d6e23781SBarry Smith /*MC 1000d6e23781SBarry Smith MatPreallocateSymmetricSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 1001d6e23781SBarry Smith inserted using a local number of the rows and columns 1002d6e23781SBarry Smith 1003d6e23781SBarry Smith Synopsis: 1004d6e23781SBarry Smith #include <petscmat.h> 1005d6e23781SBarry Smith PetscErrorCode MatPreallocateSymmetricSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1006bd481603SBarry Smith 1007bd481603SBarry Smith Not Collective 1008bd481603SBarry Smith 1009bd481603SBarry Smith Input Parameters: 1010bd481603SBarry Smith + map - the mapping between local numbering and global numbering 1011bd481603SBarry Smith . nrows - the number of rows indicated 10121d73ed98SBarry Smith . rows - the indices of the rows 1013bd481603SBarry Smith . ncols - the number of columns in the matrix 1014bd481603SBarry Smith . cols - the columns indicated 1015bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 1016a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 1017bd481603SBarry Smith 1018bd481603SBarry Smith Level: intermediate 1019bd481603SBarry Smith 1020bd481603SBarry Smith Notes: 1021a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 1022bd481603SBarry Smith 1023bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 1024bd481603SBarry Smith 1025d0609cedSBarry Smith .seealso: MatPreallocateEnd(), MatPreallocateSet() 1026d0609cedSBarry Smith MatPreallocateBegin(), MatPreallocateSetLocal() 1027bd481603SBarry Smith M*/ 102894bad497SJacob Faibussowitsch #define MatPreallocateSymmetricSetLocalBlock(map,nrows,rows,ncols,cols,dnz,onz) \ 102994bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 10309566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApplyBlock(map,nrows,rows,rows)); \ 10319566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApplyBlock(map,ncols,cols,cols)); \ 10329566063dSJacob Faibussowitsch for (PetscInt __l=0;__l<nrows;__l++) PetscCall(MatPreallocateSymmetricSetBlock((rows)[__l],ncols,cols,dnz,onz)); \ 103394bad497SJacob Faibussowitsch ) 1034e83a5d19SLisandro Dalcin 1035bd481603SBarry Smith /*MC 1036bd481603SBarry Smith MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 1037bd481603SBarry Smith inserted using a local number of the rows and columns 1038bd481603SBarry Smith 1039bd481603SBarry Smith Synopsis: 1040aaa7dc30SBarry Smith #include <petscmat.h> 1041c1ac3661SBarry Smith PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1042bd481603SBarry Smith 1043bd481603SBarry Smith Not Collective 1044bd481603SBarry Smith 1045bd481603SBarry Smith Input Parameters: 104664075487SBarry Smith + row - the row 1047bd481603SBarry Smith . ncols - the number of columns in the matrix 1048a50f8bf6SHong Zhang - cols - the columns indicated 1049a50f8bf6SHong Zhang 1050a50f8bf6SHong Zhang Output Parameters: 1051a50f8bf6SHong Zhang + dnz - the array that will be passed to the matrix preallocation routines 1052a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 1053bd481603SBarry Smith 1054bd481603SBarry Smith Level: intermediate 1055bd481603SBarry Smith 1056bd481603SBarry Smith Notes: 1057a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 1058bd481603SBarry Smith 1059bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 1060bd481603SBarry Smith 1061d0609cedSBarry Smith This is a MACRO not a function because it uses variables declared in MatPreallocateBegin(). 10621620fd73SBarry Smith 1063d0609cedSBarry Smith .seealso: MatPreallocateEnd(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock() 1064d0609cedSBarry Smith MatPreallocateBegin(), MatPreallocateSetLocal() 1065bd481603SBarry Smith M*/ 106694bad497SJacob Faibussowitsch #define MatPreallocateSet(row,nc,cols,dnz,onz) PetscMacroReturnStandard( \ 10672c71b3e2SJacob Faibussowitsch PetscCheck(row >= __rstart,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %" PetscInt_FMT " less than first local row %" PetscInt_FMT,row,__rstart); \ 10682c71b3e2SJacob Faibussowitsch PetscCheck(row < __rstart+__nrows,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %" PetscInt_FMT " greater than last local row %" PetscInt_FMT,row,__rstart+__nrows-1); \ 10695f80ce2aSJacob Faibussowitsch for (PetscInt __i = 0; __i < nc; ++__i) { \ 107064075487SBarry Smith if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \ 1071a6042fd4SStefano Zampini else if (dnz[row - __rstart] < __ncols) dnz[row - __rstart]++; \ 10727c922b88SBarry Smith } \ 107394bad497SJacob Faibussowitsch ) 10747c922b88SBarry Smith 1075bd481603SBarry Smith /*MC 1076d6e23781SBarry Smith MatPreallocateSymmetricSetBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 1077bd481603SBarry Smith inserted using a local number of the rows and columns 1078bd481603SBarry Smith 1079bd481603SBarry Smith Synopsis: 1080aaa7dc30SBarry Smith #include <petscmat.h> 1081d6e23781SBarry Smith PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1082bd481603SBarry Smith 1083bd481603SBarry Smith Not Collective 1084bd481603SBarry Smith 1085bd481603SBarry Smith Input Parameters: 1086bd481603SBarry Smith + nrows - the number of rows indicated 10871d73ed98SBarry Smith . rows - the indices of the rows 1088bd481603SBarry Smith . ncols - the number of columns in the matrix 1089bd481603SBarry Smith . cols - the columns indicated 1090bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 1091a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 1092bd481603SBarry Smith 1093bd481603SBarry Smith Level: intermediate 1094bd481603SBarry Smith 1095bd481603SBarry Smith Notes: 1096a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 1097bd481603SBarry Smith 1098bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 1099bd481603SBarry Smith 1100d0609cedSBarry Smith This is a MACRO not a function because it uses variables declared in MatPreallocateBegin(). 11011620fd73SBarry Smith 1102d0609cedSBarry Smith .seealso: MatPreallocateEnd(), MatPreallocateSet(), MatPreallocateBegin(), 1103a6042fd4SStefano Zampini MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal() 1104bd481603SBarry Smith M*/ 110594bad497SJacob Faibussowitsch #define MatPreallocateSymmetricSetBlock(row,nc,cols,dnz,onz) \ 110694bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 11075f80ce2aSJacob Faibussowitsch for (PetscInt __i=0; __i<nc; __i++) { \ 1108d3d32019SBarry Smith if (cols[__i] >= __end) onz[row - __rstart]++; \ 1109a6042fd4SStefano Zampini else if (cols[__i] >= row && dnz[row - __rstart] < __ncols) dnz[row - __rstart]++; \ 1110d3d32019SBarry Smith } \ 111194bad497SJacob Faibussowitsch ) 1112d3d32019SBarry Smith 1113bd481603SBarry Smith /*MC 1114a6042fd4SStefano Zampini MatPreallocateLocation - An alternative to MatPreallocateSet() that puts the nonzero locations into the matrix if it exists 111516371a99SBarry Smith 111616371a99SBarry Smith Synopsis: 1117aaa7dc30SBarry Smith #include <petscmat.h> 111816371a99SBarry Smith PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz) 111916371a99SBarry Smith 112016371a99SBarry Smith Not Collective 112116371a99SBarry Smith 112216371a99SBarry Smith Input Parameters: 1123a2b725a8SWilliam Gropp + A - matrix 112416371a99SBarry Smith . row - row where values exist (must be local to this process) 112516371a99SBarry Smith . ncols - number of columns 112616371a99SBarry Smith . cols - columns with nonzeros 112716371a99SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 1128a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 112916371a99SBarry Smith 113016371a99SBarry Smith Level: intermediate 113116371a99SBarry Smith 113216371a99SBarry Smith Notes: 1133a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 113416371a99SBarry Smith 113516371a99SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 113616371a99SBarry Smith 113716371a99SBarry Smith This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines. 113816371a99SBarry Smith 1139d0609cedSBarry Smith .seealso: MatPreallocateBegin(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(), 1140d6e23781SBarry Smith MatPreallocateSymmetricSetLocalBlock() 114116371a99SBarry Smith M*/ 1142d0609cedSBarry Smith #define MatPreallocateLocation(A,row,ncols,cols,dnz,onz) (A ? MatSetValues(A,1,&row,ncols,cols,NULL,INSERT_VALUES) : MatPreallocateSet(row,ncols,cols,dnz,onz)) 114316371a99SBarry Smith 114416371a99SBarry Smith /*MC 1145d0609cedSBarry Smith MatPreallocateEnd - Ends the block of code that will count the number of nonzeros per 1146bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 1147bd481603SBarry Smith 1148bd481603SBarry Smith Synopsis: 1149aaa7dc30SBarry Smith #include <petscmat.h> 1150d0609cedSBarry Smith PetscErrorCode MatPreallocateEnd(PetscInt *dnz, PetscInt *onz) 1151bd481603SBarry Smith 1152d083f849SBarry Smith Collective 1153bd481603SBarry Smith 1154bd481603SBarry Smith Input Parameters: 115516371a99SBarry Smith + dnz - the array that was be passed to the matrix preallocation routines 1156a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 1157bd481603SBarry Smith 1158bd481603SBarry Smith Level: intermediate 1159bd481603SBarry Smith 1160bd481603SBarry Smith Notes: 1161d0609cedSBarry Smith This is a macro that handles its own error checking, it does not return an error code. 1162d0609cedSBarry Smith 1163a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 1164bd481603SBarry Smith 1165d0609cedSBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 1166bd481603SBarry Smith 1167d0609cedSBarry Smith Developer Notes: 1168d0609cedSBarry Smith This is a MACRO not a function because it closes the { started in MatPreallocateBegin(). 11691620fd73SBarry Smith 1170d0609cedSBarry Smith .seealso: MatPreallocateBegin(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(), 1171d6e23781SBarry Smith MatPreallocateSymmetricSetLocalBlock() 1172bd481603SBarry Smith M*/ 1173d0609cedSBarry Smith #define MatPreallocateEnd(dnz,onz) PetscCall(PetscFree2(dnz,onz));} while (0) 1174d0609cedSBarry Smith 1175d0609cedSBarry Smith #define MatPreallocateFinalize(...) PETSC_DEPRECATED_MACRO("GCC warning \"Use MatPreallocateEnd() (since version 3.18)\"") MatPreallocateEnd(__VA_ARGS__) 11767c922b88SBarry Smith 11777b80b807SBarry Smith /* Routines unique to particular data structures */ 1178014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat,void *); 1179698d4c6aSKris Buschelman 1180014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*); 1181014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *); 1182698d4c6aSKris Buschelman 1183014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]); 1184014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]); 1185014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1186014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1187014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1188014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool); 11897b80b807SBarry Smith 1190a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4 1191a96a251dSBarry Smith 1192014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1193014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1194014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]); 119519b08ed1SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJSetTotalPreallocation(Mat,PetscInt); 1196273d9f13SBarry Smith 1197014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1198014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1199014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1200014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []); 1201014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 1202014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]); 1203014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 1204014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]); 1205b44e7856SBarry Smith PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat,Mat*); 1206014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]); 1207014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]); 12089230625dSJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]); 12099230625dSJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]); 1210014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*); 1211273d9f13SBarry Smith 121249a6ff4bSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetLDA(Mat,PetscInt*); 1213ad16ce7aSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseSetLDA(Mat,PetscInt); 12149fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatDenseSetLDA() (since version 3.14)") static inline PetscErrorCode MatSeqDenseSetLDA(Mat A,PetscInt lda) {return MatDenseSetLDA(A,lda);} 1215014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*); 12161b807ce4Svictorle 1217621e819fSSatish Balay PETSC_EXTERN PetscErrorCode MatBlockMatSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1218621e819fSSatish Balay 1219014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStoreValues(Mat); 1220014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat); 12212e8a6d31SBarry Smith 1222014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*); 12237cfe41e4SPatrick Farrell PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat,IS*); 12247b80b807SBarry Smith /* 12257b80b807SBarry Smith These routines are not usually accessed directly, rather solving is 122694b7f48cSBarry Smith done through the KSP and PC interfaces. 12277b80b807SBarry Smith */ 12287b80b807SBarry Smith 122976bdecfbSBarry Smith /*J 12308f6c3df8SBarry Smith MatOrderingType - String with the name of a PETSc matrix ordering 1231d9274352SBarry Smith 1232d9274352SBarry Smith Level: beginner 1233d9274352SBarry Smith 12342c7c0729SBarry Smith Notes: 12352c7c0729SBarry Smith If MATORDERINGEXTERNAL is used then PETSc does not compute an ordering and utilizes one built into the factorization package 12362c7c0729SBarry Smith 1237d9274352SBarry Smith .seealso: MatGetOrdering() 123876bdecfbSBarry Smith J*/ 123919fd82e9SBarry Smith typedef const char* MatOrderingType; 12402692d6eeSBarry Smith #define MATORDERINGNATURAL "natural" 12412692d6eeSBarry Smith #define MATORDERINGND "nd" 12422692d6eeSBarry Smith #define MATORDERING1WD "1wd" 12432692d6eeSBarry Smith #define MATORDERINGRCM "rcm" 12442692d6eeSBarry Smith #define MATORDERINGQMD "qmd" 12452692d6eeSBarry Smith #define MATORDERINGROWLENGTH "rowlength" 1246510184a7SJed Brown #define MATORDERINGWBM "wbm" 1247fc1bef75SJed Brown #define MATORDERINGSPECTRAL "spectral" 1248312e372aSBarry Smith #define MATORDERINGAMD "amd" /* only works if UMFPACK is installed with PETSc */ 1249048412efSPablo Brubeck #define MATORDERINGMETISND "metisnd" /* only works if METIS is installed with PETSc */ 12509bd791bbSBarry Smith #define MATORDERINGNATURAL_OR_ND "natural_or_nd" /* special coase used for Cholesky and ICC, allows ND when AIJ matrix is used but Natural when SBAIJ is used */ 12512c7c0729SBarry Smith #define MATORDERINGEXTERNAL "external" /* uses an ordering type internal to the factorization package */ 1252b12f92e5SBarry Smith 125319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*); 1254140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*); 1255bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*)); 1256140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatOrderingList; 1257d4fbbf0eSBarry Smith 1258014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS); 1259fc1bef75SJed Brown PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*); 1260a2ce50c7SBarry Smith 12614ac6704cSBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetPreferredOrdering(Mat,MatFactorType,MatOrderingType*); 12624ac6704cSBarry Smith 1263d91e6319SBarry Smith /*S 1264ec5066bdSBarry Smith MatFactorShiftType - Numeric Shift for factorizations 1265d90ac83dSHong Zhang 1266d90ac83dSHong Zhang Level: beginner 1267d90ac83dSHong Zhang 1268ec5066bdSBarry Smith .seealso: MatGetFactor() 1269d90ac83dSHong Zhang S*/ 1270d90ac83dSHong Zhang typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType; 12716a6fc655SJed Brown PETSC_EXTERN const char *const MatFactorShiftTypes[]; 12725e9742b9SJed Brown PETSC_EXTERN const char *const MatFactorShiftTypesDetail[]; 1273d90ac83dSHong Zhang 1274d90ac83dSHong Zhang /*S 1275ec5066bdSBarry Smith MatFactorError - indicates what type of error was generated in a matrix factorization 12769aa7eafdSHong Zhang 12779aa7eafdSHong Zhang Level: beginner 12789aa7eafdSHong Zhang 127995452b02SPatrick Sanan Developer Notes: 128095452b02SPatrick Sanan Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 128100e125f8SBarry Smith 128200e125f8SBarry Smith .seealso: MatGetFactor() 12839aa7eafdSHong Zhang S*/ 12845cd7cf9dSHong Zhang typedef enum {MAT_FACTOR_NOERROR,MAT_FACTOR_STRUCT_ZEROPIVOT,MAT_FACTOR_NUMERIC_ZEROPIVOT,MAT_FACTOR_OUTMEMORY,MAT_FACTOR_OTHER} MatFactorError; 12859aa7eafdSHong Zhang 128600e125f8SBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat,MatFactorError*); 1287b8b68cfdSBarry Smith PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat); 12887b6c816cSBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat,PetscReal*,PetscInt*); 128900e125f8SBarry Smith 12909aa7eafdSHong Zhang /*S 1291422a814eSBarry Smith MatFactorInfo - Data passed into the matrix factorization routines, and information about the resulting factorization 1292b00f7748SHong Zhang 129361cad860SBarry Smith In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use 129461cad860SBarry Smith $ MatFactorInfo info(MAT_FACTORINFO_SIZE) 1295b00f7748SHong Zhang 129695452b02SPatrick Sanan Notes: 129795452b02SPatrick Sanan These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC. 1298b00f7748SHong Zhang 129961cad860SBarry Smith You can use MatFactorInfoInitialize() to set default values. 130061cad860SBarry Smith 1301b00f7748SHong Zhang Level: developer 1302b00f7748SHong Zhang 1303d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(), 1304d7d82daaSBarry Smith MatFactorInfoInitialize() 1305b00f7748SHong Zhang 1306b00f7748SHong Zhang S*/ 1307b00f7748SHong Zhang typedef struct { 130815e8a5b3SHong Zhang PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 130985317021SBarry Smith PetscReal usedt; 131015e8a5b3SHong Zhang PetscReal dt; /* drop tolerance */ 1311b00f7748SHong Zhang PetscReal dtcol; /* tolerance for pivoting */ 131215e8a5b3SHong Zhang PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 131367e28bfeSBarry Smith PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */ 1314348344bbSBarry Smith PetscReal levels; /* ICC/ILU(levels) */ 1315bcd9e38bSBarry Smith PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 1316bcd9e38bSBarry Smith factorization may be faster if do not pivot */ 131715e8a5b3SHong Zhang PetscReal zeropivot; /* pivot is called zero if less than this */ 1318f4db908eSBarry Smith PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */ 1319f4db908eSBarry Smith PetscReal shiftamount; /* how large the shift is */ 132015e8a5b3SHong Zhang } MatFactorInfo; 1321ffa6d0a5SLois Curfman McInnes 1322014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*); 13239a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*); 13249a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 13259a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*); 13269a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*); 13279a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*); 13289a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 13299a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 13309a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 13319a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*); 13329a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*); 13333f498edaSToby Isaac PETSC_EXTERN PetscErrorCode MatQRFactor(Mat,IS,const MatFactorInfo*); 13343f498edaSToby Isaac PETSC_EXTERN PetscErrorCode MatQRFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 13353f498edaSToby Isaac PETSC_EXTERN PetscErrorCode MatQRFactorNumeric(Mat,Mat,const MatFactorInfo*); 1336014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*); 1337014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec); 1338014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec); 1339014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec); 1340014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec); 1341014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec); 1342014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec); 1343014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs); 13447c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat); 13457c2f51b8SStefano Zampini 13467c2f51b8SStefano Zampini typedef enum {MAT_FACTOR_SCHUR_UNFACTORED, MAT_FACTOR_SCHUR_FACTORED, MAT_FACTOR_SCHUR_INVERTED} MatFactorSchurStatus; 13478e7ba810SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat,IS); 13487c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat,Mat*,MatFactorSchurStatus*); 13497c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat,Mat*,MatFactorSchurStatus); 13505a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat); 13517c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat,Mat*,MatFactorSchurStatus*); 13525a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat,Vec,Vec); 13535a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat,Vec,Vec); 13546dba178dSStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat); 1355bb5a7306SBarry Smith 1356*8a9c020eSBarry Smith PETSC_EXTERN PetscErrorCode MatSeqDenseInvert(Mat); 1357d91e6319SBarry Smith /*E 1358d91e6319SBarry Smith MatSORType - What type of (S)SOR to perform 1359bb1eb677SSatish Balay 1360d91e6319SBarry Smith Level: beginner 1361d91e6319SBarry Smith 1362d9274352SBarry Smith May be bitwise ORd together 1363d9274352SBarry Smith 1364af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 1365d91e6319SBarry Smith 13664e7234bfSBarry Smith MatSORType may be bitwise ORd together, so do not change the numbers 13674e7234bfSBarry Smith 136841f059aeSBarry Smith .seealso: MatSOR() 1369d91e6319SBarry Smith E*/ 1370ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 1371ee50ffe9SBarry Smith SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 1372ee50ffe9SBarry Smith SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 137384cb2905SBarry Smith SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType; 1374014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 13758ed539a5SBarry Smith 1376d4fbbf0eSBarry Smith /* 1377639f9d9dSBarry Smith These routines are for efficiently computing Jacobians via finite differences. 1378639f9d9dSBarry Smith */ 1379b12f92e5SBarry Smith 13807086a01eSPeter Brune /*S 13817086a01eSPeter Brune MatColoring - Object for managing the coloring of matrices. 13827086a01eSPeter Brune 13837086a01eSPeter Brune Level: beginner 13847086a01eSPeter Brune 1385ec5066bdSBarry Smith Notes: 1386ec5066bdSBarry Smith Coloring of matrices can be computed directly from the sparse matrix nonzero structure via the MatColoring object or from the mesh from which the 1387ec5066bdSBarry Smith matrix comes from via DMCreateColoring(). In general using the mesh produces a more optimal coloring (fewer colors). 1388ec5066bdSBarry Smith 1389ec5066bdSBarry Smith Once a coloring is available MatFDColoringCreate() creates an object that can be used to efficiently compute Jacobians using that coloring. This 1390ec5066bdSBarry Smith same object can also be used to efficiently convert data created by Automatic Differentation tools to PETSc sparse matrices. 1391ec5066bdSBarry Smith 13923d1c4b3aSPatrick Sanan .seealso: MatFDColoringCreate(), MatColoringWeightType, ISColoring, MatFDColoring, DMCreateColoring(), MatColoringCreate(), MatOrdering, MatPartitioning, MatColoringType 13937086a01eSPeter Brune S*/ 1394d4db15c4SBarry Smith typedef struct _p_MatColoring* MatColoring; 1395d4db15c4SBarry Smith 1396d4db15c4SBarry Smith /*J 1397d4db15c4SBarry Smith MatColoringType - String with the name of a PETSc matrix coloring 1398d9274352SBarry Smith 1399d9274352SBarry Smith Level: beginner 1400d9274352SBarry Smith 14017086a01eSPeter Brune .seealso: MatColoringSetType(), MatColoring 140276bdecfbSBarry Smith J*/ 140319fd82e9SBarry Smith typedef const char* MatColoringType; 14045567d71aSPeter Brune #define MATCOLORINGJP "jp" 1405b9acb617SPeter Brune #define MATCOLORINGPOWER "power" 14062692d6eeSBarry Smith #define MATCOLORINGNATURAL "natural" 14072692d6eeSBarry Smith #define MATCOLORINGSL "sl" 14082692d6eeSBarry Smith #define MATCOLORINGLF "lf" 14092692d6eeSBarry Smith #define MATCOLORINGID "id" 14108121bdceSPeter Brune #define MATCOLORINGGREEDY "greedy" 1411b12f92e5SBarry Smith 14128ac6da0aSPeter Brune /*E 14138ac6da0aSPeter Brune MatColoringWeightType - Type of weight scheme 14148ac6da0aSPeter Brune 14158ac6da0aSPeter Brune Not Collective 14168ac6da0aSPeter Brune 14178ac6da0aSPeter Brune + MAT_COLORING_RANDOM - Random weights 14188ac6da0aSPeter Brune . MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering. 14198ac6da0aSPeter Brune - MAT_COLORING_LF - Last-first weighting. 14208ac6da0aSPeter Brune 14218ac6da0aSPeter Brune Level: intermediate 14228ac6da0aSPeter Brune 1423af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 1424ec5066bdSBarry Smith 1425ec5066bdSBarry Smith .seealso: MatColoring, MatColoringCreate() 14268ac6da0aSPeter Brune E*/ 1427301c140bSPeter Brune typedef enum {MAT_COLORING_WEIGHT_RANDOM,MAT_COLORING_WEIGHT_LEXICAL,MAT_COLORING_WEIGHT_LF,MAT_COLORING_WEIGHT_SL} MatColoringWeightType; 14288ac6da0aSPeter Brune 1429335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*); 1430d7f2a307SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*); 1431335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*); 1432335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer); 1433335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType); 1434335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring); 1435335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt); 1436335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*); 1437335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt); 1438335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*); 1439335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*); 1440335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring)); 1441014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*); 14428ac6da0aSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType); 1443c29971fcSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*); 14448ac6da0aSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm); 1445bc76d17bSHong Zhang PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring,ISColoring); 14469fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatColoringTest() (since version 3.10)") static inline PetscErrorCode MatColoringTestValid(MatColoring matcoloring,ISColoring iscoloring) {return MatColoringTest(matcoloring,iscoloring);} 1447bc76d17bSHong Zhang PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat,ISColoring); 1448639f9d9dSBarry Smith 1449d9274352SBarry Smith /*S 1450d9274352SBarry Smith MatFDColoring - Object for computing a sparse Jacobian via finite differences 1451d9274352SBarry Smith and coloring 1452639f9d9dSBarry Smith 1453d9274352SBarry Smith Level: beginner 1454d9274352SBarry Smith 1455ec5066bdSBarry Smith Notes: 1456ec5066bdSBarry Smith This object is creating utilizing a coloring provided by the MatColoring object or DMCreateColoring() 1457ec5066bdSBarry Smith 1458ec5066bdSBarry Smith .seealso: MatFDColoringCreate(), MatColoring, DMCreateColoring() 1459d9274352SBarry Smith S*/ 1460e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring; 1461639f9d9dSBarry Smith 1462014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *); 1463014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*); 1464014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer); 1465014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*); 1466014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**); 1467014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal); 1468014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring); 1469d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *); 1470014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec); 1471edaa7c33SBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,const PetscInt*[]); 1472f86b9fbaSHong Zhang PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring); 1473f86b9fbaSHong Zhang PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt); 1474bdaf1daeSBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringSetValues(Mat,MatFDColoring,const PetscScalar*); 1475b1683b59SHong Zhang 1476b1683b59SHong Zhang /*S 1477b9af6bddSHong Zhang MatTransposeColoring - Object for computing a sparse matrix product C=A*B^T via coloring 1478b1683b59SHong Zhang 1479b1683b59SHong Zhang Level: beginner 1480b1683b59SHong Zhang 1481b9af6bddSHong Zhang .seealso: MatTransposeColoringCreate() 1482b1683b59SHong Zhang S*/ 1483b9af6bddSHong Zhang typedef struct _p_MatTransposeColoring* MatTransposeColoring; 1484b1683b59SHong Zhang 1485014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *); 1486014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat); 1487014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat); 1488014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*); 1489b1683b59SHong Zhang 1490639f9d9dSBarry Smith /* 14910752156aSBarry Smith These routines are for partitioning matrices: currently used only 14923eda8832SBarry Smith for adjacency matrix, MatCreateMPIAdj(). 14930752156aSBarry Smith */ 1494ca161407SBarry Smith 1495d9274352SBarry Smith /*S 1496d9274352SBarry Smith MatPartitioning - Object for managing the partitioning of a matrix or graph 1497d9274352SBarry Smith 1498d9274352SBarry Smith Level: beginner 1499d9274352SBarry Smith 1500ec5066bdSBarry Smith Notes: 1501ec5066bdSBarry Smith There is also a PetscPartitioner object that provides the same functionality. It can utilize the MatPartitioning operations 1502ec5066bdSBarry Smith via PetscPartitionerSetType(p,PETSCPARTITIONERMATPARTITIONING) 1503ec5066bdSBarry Smith 1504ec5066bdSBarry Smith Developers Note: 1505ec5066bdSBarry Smith It is an extra maintainance and documentation cost to have two objects with the same functionality. 1506ec5066bdSBarry Smith 1507ec5066bdSBarry Smith .seealso: MatPartitioningCreate(), MatPartitioningType, MatColoring, MatGetOrdering() 1508d9274352SBarry Smith S*/ 150991e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning; 1510d9274352SBarry Smith 151176bdecfbSBarry Smith /*J 15128f6c3df8SBarry Smith MatPartitioningType - String with the name of a PETSc matrix partitioning 1513d9274352SBarry Smith 1514d9274352SBarry Smith Level: beginner 15150d04baf8SBarry Smith dm 1516b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning 151776bdecfbSBarry Smith J*/ 151819fd82e9SBarry Smith typedef const char* MatPartitioningType; 15192692d6eeSBarry Smith #define MATPARTITIONINGCURRENT "current" 1520aa1e27eaSFande Kong #define MATPARTITIONINGAVERAGE "average" 15212692d6eeSBarry Smith #define MATPARTITIONINGSQUARE "square" 15222692d6eeSBarry Smith #define MATPARTITIONINGPARMETIS "parmetis" 15232692d6eeSBarry Smith #define MATPARTITIONINGCHACO "chaco" 15242692d6eeSBarry Smith #define MATPARTITIONINGPARTY "party" 152550d91057SBarry Smith #define MATPARTITIONINGPTSCOTCH "ptscotch" 152688d2ac2bSFande Kong #define MATPARTITIONINGHIERARCH "hierarch" 152771306c60Sjroman 1528014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*); 152919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType); 1530014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt); 1531014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat); 1532014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]); 1533014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []); 1534ebf67979SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningSetUseEdgeWeights(MatPartitioning,PetscBool); 1535ebf67979SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningGetUseEdgeWeights(MatPartitioning,PetscBool*); 1536014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*); 1537fdd1c351SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningImprove(MatPartitioning,IS*); 1538668144dbSFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningViewImbalance(MatPartitioning,IS); 1539f3ad2dabSStefano Zampini PETSC_EXTERN PetscErrorCode MatPartitioningApplyND(MatPartitioning,IS*); 1540014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*); 1541bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[],PetscErrorCode (*)(MatPartitioning)); 1542014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer); 1543fe2efc57SMark PETSC_EXTERN PetscErrorCode MatPartitioningViewFromOptions(MatPartitioning,PetscObject,const char[]); 1544014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning); 154519fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*); 1546ca161407SBarry Smith 154727538973SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part); 1548014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 1549014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *); 15500752156aSBarry Smith 1551b6956c12SJose Roman typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType; 15526a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoGlobalTypes[]; 1553b6956c12SJose Roman typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType; 15546a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoLocalTypes[]; 1555b6956c12SJose Roman typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType; 15566a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoEigenTypes[]; 1557b6956c12SJose Roman 1558014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType); 1559014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*); 1560014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType); 1561014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*); 1562014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal); 1563014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType); 1564014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*); 1565014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal); 1566014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*); 1567014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt); 1568014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*); 156971306c60Sjroman 157071306c60Sjroman #define MP_PARTY_OPT "opt" 157171306c60Sjroman #define MP_PARTY_LIN "lin" 157271306c60Sjroman #define MP_PARTY_SCA "sca" 157371306c60Sjroman #define MP_PARTY_RAN "ran" 157471306c60Sjroman #define MP_PARTY_GBF "gbf" 157571306c60Sjroman #define MP_PARTY_GCF "gcf" 157671306c60Sjroman #define MP_PARTY_BUB "bub" 157771306c60Sjroman #define MP_PARTY_DEF "def" 1578014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*); 157971306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs" 158071306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl" 158171306c60Sjroman #define MP_PARTY_NONE "no" 1582014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*); 1583014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal); 1584014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool); 1585014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool); 158671306c60Sjroman 1587b0ca845eSVaclav Hapla typedef enum { MP_PTSCOTCH_DEFAULT,MP_PTSCOTCH_QUALITY,MP_PTSCOTCH_SPEED,MP_PTSCOTCH_BALANCE,MP_PTSCOTCH_SAFETY,MP_PTSCOTCH_SCALABILITY } MPPTScotchStrategyType; 15886a6fc655SJed Brown PETSC_EXTERN const char *const MPPTScotchStrategyTypes[]; 1589e0f1cffaSJose Roman 1590014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal); 1591014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*); 1592014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType); 1593014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*); 159471306c60Sjroman 1595b43b03e9SMark F. Adams /* 15966294fa2bSFande Kong * hierarchical partitioning 15976294fa2bSFande Kong */ 15984e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning,IS*); 15994e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning,IS*); 16004e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning,PetscInt); 16014e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt); 16026294fa2bSFande Kong 1603014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*); 1604014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*); 1605591294e4SBarry Smith 16060752156aSBarry Smith /* 1607c786d857SStefano Zampini If you add entries here you must also add them to src/mat/f90-mod/petscmat.h 1608c786d857SStefano Zampini If any of the enum values are changed, also update dMatOps dict at src/binding/petsc4py/src/libpetsc4py/libpetsc4py.pyx 1609d4fbbf0eSBarry Smith */ 16101c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0, 16111c1c02c0SLois Curfman McInnes MATOP_GET_ROW=1, 16121c1c02c0SLois Curfman McInnes MATOP_RESTORE_ROW=2, 16131c1c02c0SLois Curfman McInnes MATOP_MULT=3, 16141c1c02c0SLois Curfman McInnes MATOP_MULT_ADD=4, 16157c922b88SBarry Smith MATOP_MULT_TRANSPOSE=5, 16167c922b88SBarry Smith MATOP_MULT_TRANSPOSE_ADD=6, 16171c1c02c0SLois Curfman McInnes MATOP_SOLVE=7, 16181c1c02c0SLois Curfman McInnes MATOP_SOLVE_ADD=8, 16197c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE=9, 16207c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE_ADD=10, 16211c1c02c0SLois Curfman McInnes MATOP_LUFACTOR=11, 16221c1c02c0SLois Curfman McInnes MATOP_CHOLESKYFACTOR=12, 1623a714c06dSBarry Smith MATOP_SOR=13, 16241c1c02c0SLois Curfman McInnes MATOP_TRANSPOSE=14, 16251c1c02c0SLois Curfman McInnes MATOP_GETINFO=15, 16261c1c02c0SLois Curfman McInnes MATOP_EQUAL=16, 16271c1c02c0SLois Curfman McInnes MATOP_GET_DIAGONAL=17, 16281c1c02c0SLois Curfman McInnes MATOP_DIAGONAL_SCALE=18, 16291c1c02c0SLois Curfman McInnes MATOP_NORM=19, 16301c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_BEGIN=20, 16311c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_END=21, 1632d519adbfSMatthew Knepley MATOP_SET_OPTION=22, 1633d519adbfSMatthew Knepley MATOP_ZERO_ENTRIES=23, 1634d519adbfSMatthew Knepley MATOP_ZERO_ROWS=24, 1635d519adbfSMatthew Knepley MATOP_LUFACTOR_SYMBOLIC=25, 1636d519adbfSMatthew Knepley MATOP_LUFACTOR_NUMERIC=26, 1637d519adbfSMatthew Knepley MATOP_CHOLESKY_FACTOR_SYMBOLIC=27, 1638d519adbfSMatthew Knepley MATOP_CHOLESKY_FACTOR_NUMERIC=28, 1639d519adbfSMatthew Knepley MATOP_SETUP_PREALLOCATION=29, 1640d519adbfSMatthew Knepley MATOP_ILUFACTOR_SYMBOLIC=30, 1641d519adbfSMatthew Knepley MATOP_ICCFACTOR_SYMBOLIC=31, 1642a5b7ff6bSBarry Smith MATOP_GET_DIAGONAL_BLOCK=32, 1643dd4011a9SHong Zhang MATOP_FREE_INTER_STRUCT=33, 1644d519adbfSMatthew Knepley MATOP_DUPLICATE=34, 1645d519adbfSMatthew Knepley MATOP_FORWARD_SOLVE=35, 1646d519adbfSMatthew Knepley MATOP_BACKWARD_SOLVE=36, 1647d519adbfSMatthew Knepley MATOP_ILUFACTOR=37, 1648d519adbfSMatthew Knepley MATOP_ICCFACTOR=38, 1649d519adbfSMatthew Knepley MATOP_AXPY=39, 16507dae84e0SHong Zhang MATOP_CREATE_SUBMATRICES=40, 1651d519adbfSMatthew Knepley MATOP_INCREASE_OVERLAP=41, 1652d519adbfSMatthew Knepley MATOP_GET_VALUES=42, 1653d519adbfSMatthew Knepley MATOP_COPY=43, 1654d519adbfSMatthew Knepley MATOP_GET_ROW_MAX=44, 1655d519adbfSMatthew Knepley MATOP_SCALE=45, 1656d519adbfSMatthew Knepley MATOP_SHIFT=46, 165735153367SBarry Smith MATOP_DIAGONAL_SET=47, 16589d39f69dSJed Brown MATOP_ZERO_ROWS_COLUMNS=48, 16599d39f69dSJed Brown MATOP_SET_RANDOM=49, 1660d519adbfSMatthew Knepley MATOP_GET_ROW_IJ=50, 1661d519adbfSMatthew Knepley MATOP_RESTORE_ROW_IJ=51, 1662d519adbfSMatthew Knepley MATOP_GET_COLUMN_IJ=52, 1663d519adbfSMatthew Knepley MATOP_RESTORE_COLUMN_IJ=53, 1664d519adbfSMatthew Knepley MATOP_FDCOLORING_CREATE=54, 1665d519adbfSMatthew Knepley MATOP_COLORING_PATCH=55, 1666d519adbfSMatthew Knepley MATOP_SET_UNFACTORED=56, 1667d519adbfSMatthew Knepley MATOP_PERMUTE=57, 1668d519adbfSMatthew Knepley MATOP_SET_VALUES_BLOCKED=58, 16697dae84e0SHong Zhang MATOP_CREATE_SUBMATRIX=59, 1670d519adbfSMatthew Knepley MATOP_DESTROY=60, 1671d519adbfSMatthew Knepley MATOP_VIEW=61, 1672d519adbfSMatthew Knepley MATOP_CONVERT_FROM=62, 16737bab7c10SHong Zhang MATOP_MATMAT_MULT=63, 16747bab7c10SHong Zhang MATOP_MATMAT_MULT_SYMBOLIC=64, 16757bab7c10SHong Zhang MATOP_MATMAT_MULT_NUMERIC=65, 1676d519adbfSMatthew Knepley MATOP_SET_LOCAL_TO_GLOBAL_MAP=66, 1677d519adbfSMatthew Knepley MATOP_SET_VALUES_LOCAL=67, 1678d519adbfSMatthew Knepley MATOP_ZERO_ROWS_LOCAL=68, 1679d519adbfSMatthew Knepley MATOP_GET_ROW_MAX_ABS=69, 1680d519adbfSMatthew Knepley MATOP_GET_ROW_MIN_ABS=70, 1681d519adbfSMatthew Knepley MATOP_CONVERT=71, 1682d519adbfSMatthew Knepley MATOP_SET_COLORING=72, 16839d39f69dSJed Brown /* MATOP_PLACEHOLDER_73=73, */ 1684d519adbfSMatthew Knepley MATOP_SET_VALUES_ADIFOR=74, 1685d519adbfSMatthew Knepley MATOP_FD_COLORING_APPLY=75, 1686d519adbfSMatthew Knepley MATOP_SET_FROM_OPTIONS=76, 1687bda6c4cbSBarry Smith MATOP_MULT_CONSTRAINED=77, 1688bda6c4cbSBarry Smith MATOP_MULT_TRANSPOSE_CONSTRAIN=78, 16899d39f69dSJed Brown MATOP_FIND_ZERO_DIAGONALS=79, 1690d519adbfSMatthew Knepley MATOP_MULT_MULTIPLE=80, 1691d519adbfSMatthew Knepley MATOP_SOLVE_MULTIPLE=81, 1692d519adbfSMatthew Knepley MATOP_GET_INERTIA=82, 1693d519adbfSMatthew Knepley MATOP_LOAD=83, 1694d519adbfSMatthew Knepley MATOP_IS_SYMMETRIC=84, 1695d519adbfSMatthew Knepley MATOP_IS_HERMITIAN=85, 1696d519adbfSMatthew Knepley MATOP_IS_STRUCTURALLY_SYMMETRIC=86, 1697820469bcSHong Zhang MATOP_SET_VALUES_BLOCKEDLOCAL=87, 1698b41ce5d5SBarry Smith MATOP_CREATE_VECS=88, 1699d519adbfSMatthew Knepley MATOP_MAT_MULT=89, 1700d519adbfSMatthew Knepley MATOP_MAT_MULT_SYMBOLIC=90, 1701d519adbfSMatthew Knepley MATOP_MAT_MULT_NUMERIC=91, 1702d519adbfSMatthew Knepley MATOP_PTAP=92, 1703d519adbfSMatthew Knepley MATOP_PTAP_SYMBOLIC=93, 1704d519adbfSMatthew Knepley MATOP_PTAP_NUMERIC=94, 1705bda6c4cbSBarry Smith MATOP_MAT_TRANSPOSE_MULT=95, 1706bda6c4cbSBarry Smith MATOP_MAT_TRANSPOSE_MULT_SYMBO=96, 1707bda6c4cbSBarry Smith MATOP_MAT_TRANSPOSE_MULT_NUMER=97, 17089d39f69dSJed Brown /* MATOP_PLACEHOLDER_98=98, */ 17097a3c3d58SStefano Zampini MATOP_PRODUCTSETFROMOPTIONS=99, 17107a3c3d58SStefano Zampini MATOP_PRODUCTSYMBOLIC=100, 17117a3c3d58SStefano Zampini MATOP_PRODUCTNUMERIC=101, 1712d519adbfSMatthew Knepley MATOP_CONJUGATE=102, 17139d39f69dSJed Brown /* MATOP_PLACEHOLDER_103=103, */ 1714d519adbfSMatthew Knepley MATOP_SET_VALUES_ROW=104, 1715d519adbfSMatthew Knepley MATOP_REAL_PART=105, 1716bda6c4cbSBarry Smith MATOP_IMAGINARY_PART=106, 1717bda6c4cbSBarry Smith MATOP_GET_ROW_UPPER_TRIANGULAR=107, 1718bda6c4cbSBarry Smith MATOP_RESTORE_ROW_UPPER_TRIANG=108, 1719bda6c4cbSBarry Smith MATOP_MAT_SOLVE=109, 172029eadf9eSStefano Zampini MATOP_MAT_SOLVE_TRANSPOSE=110, 1721d519adbfSMatthew Knepley MATOP_GET_ROW_MIN=111, 17220e8d04f7SBarry Smith MATOP_GET_COLUMN_VECTOR=112, 1723d519adbfSMatthew Knepley MATOP_MISSING_DIAGONAL=113, 17240e8d04f7SBarry Smith MATOP_GET_SEQ_NONZERO_STRUCTUR=114, 172589c6957cSBarry Smith MATOP_CREATE=115, 172689c6957cSBarry Smith MATOP_GET_GHOSTS=116, 17270e8d04f7SBarry Smith MATOP_GET_LOCAL_SUB_MATRIX=117, 17280e8d04f7SBarry Smith MATOP_RESTORE_LOCALSUB_MATRIX=118, 1729eeffb40dSHong Zhang MATOP_MULT_DIAGONAL_BLOCK=119, 17300e8d04f7SBarry Smith MATOP_HERMITIAN_TRANSPOSE=120, 17310e8d04f7SBarry Smith MATOP_MULT_HERMITIAN_TRANSPOSE=121, 17320e8d04f7SBarry Smith MATOP_MULT_HERMITIAN_TRANS_ADD=122, 17330e8d04f7SBarry Smith MATOP_GET_MULTI_PROC_BLOCK=123, 17349d39f69dSJed Brown MATOP_FIND_NONZERO_ROWS=124, 17350e8d04f7SBarry Smith MATOP_GET_COLUMN_NORMS=125, 17369d39f69dSJed Brown MATOP_INVERT_BLOCK_DIAGONAL=126, 17379d39f69dSJed Brown /* MATOP_PLACEHOLDER_127=127, */ 1738b41ce5d5SBarry Smith MATOP_CREATE_SUB_MATRICES_MPI=128, 17392b8ad9a3SHong Zhang MATOP_SET_VALUES_BATCH=129, 17400e8d04f7SBarry Smith MATOP_TRANSPOSE_MAT_MULT=130, 17410e8d04f7SBarry Smith MATOP_TRANSPOSE_MAT_MULT_SYMBO=131, 1742e9b602ebSSatish Balay MATOP_TRANSPOSE_MAT_MULT_NUMER=132, 17430e8d04f7SBarry Smith MATOP_TRANSPOSE_COLORING_CREAT=133, 17440e8d04f7SBarry Smith MATOP_TRANS_COLORING_APPLY_SPT=134, 17450e8d04f7SBarry Smith MATOP_TRANS_COLORING_APPLY_DEN=135, 17460e8d04f7SBarry Smith MATOP_RART=136, 17470e8d04f7SBarry Smith MATOP_RART_SYMBOLIC=137, 17480e8d04f7SBarry Smith MATOP_RART_NUMERIC=138, 1749e09a3074SHong Zhang MATOP_SET_BLOCK_SIZES=139, 1750f9426fe0SMark Adams MATOP_AYPX=140, 17511919a2e2SJed Brown MATOP_RESIDUAL=141, 17529c8f2541SHong Zhang MATOP_FDCOLORING_SETUP=142, 17532d033e1fSHong Zhang MATOP_MPICONCATENATESEQ=144, 1754bb01b7b0SPatrick Sanan MATOP_DESTROYSUBMATRICES=145, 1755e265f6d6SPatrick Sanan MATOP_TRANSPOSE_SOLVE=146, 1756e265f6d6SPatrick Sanan MATOP_GET_VALUES_LOCAL=147 1757fae171e0SBarry Smith } MatOperation; 17580c0fd78eSBarry Smith PETSC_EXTERN PetscErrorCode MatSetOperation(Mat,MatOperation,void(*)(void)); 1759976e8c5aSLisandro Dalcin PETSC_EXTERN PetscErrorCode MatGetOperation(Mat,MatOperation,void(**)(void)); 1760976e8c5aSLisandro Dalcin PETSC_EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool*); 176194342113SStefano Zampini PETSC_EXTERN PetscErrorCode MatHasCongruentLayouts(Mat,PetscBool*); 17629fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatProductClear() (since version 3.14)") static inline PetscErrorCode MatFreeIntermediateDataStructures(Mat A) {return MatProductClear(A);} 1763014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void)); 1764014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void)); 1765014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*); 1766db77db73SJeremy L Thompson PETSC_EXTERN PetscErrorCode MatShellSetVecType(Mat,VecType); 1767f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*); 1768f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*); 17690c0fd78eSBarry Smith PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat); 1770b77ba244SStefano Zampini PETSC_EXTERN PetscErrorCode MatShellSetMatProductOperation(Mat,MatProductType,PetscErrorCode (*)(Mat,Mat,Mat,void**),PetscErrorCode (*)(Mat,Mat,Mat,void*),PetscErrorCode (*)(void*),MatType,MatType); 1771b77ba244SStefano Zampini PETSC_EXTERN PetscErrorCode MatIsShell(Mat,PetscBool*); 1772112a2221SBarry Smith 177390ace30eSBarry Smith /* 177490ace30eSBarry Smith Codes for matrices stored on disk. By default they are 177590ace30eSBarry Smith stored in a universal format. By changing the format with 17766a9046bcSBarry Smith PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will 177790ace30eSBarry Smith be stored in a way natural for the matrix, for example dense matrices 177890ace30eSBarry Smith would be stored as dense. Matrices stored this way may only be 1779f4403165SShri Abhyankar read into matrices of the same type. 178090ace30eSBarry Smith */ 178190ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1 178290ace30eSBarry Smith 1783014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal); 178475d48cdbSStefano Zampini 17858546b261SStefano Zampini PETSC_EXTERN PetscErrorCode MatISSetLocalMatType(Mat,MatType); 178675d48cdbSStefano Zampini PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 178775d48cdbSStefano Zampini PETSC_EXTERN PetscErrorCode MatISStoreL2L(Mat,PetscBool); 1788f03112d0SStefano Zampini PETSC_EXTERN PetscErrorCode MatISFixLocalEmpty(Mat,PetscBool); 1789014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*); 17903b3b1effSJed Brown PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat,Mat*); 1791014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat); 1792e432b41dSStefano Zampini PETSC_EXTERN PetscErrorCode MatISGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*); 179325ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use the MatConvert() interface (since version 3.10)") PetscErrorCode MatISGetMPIXAIJ(Mat,MatReuse,Mat*); 17941f4e1ec7SBarry Smith 1795d9274352SBarry Smith /*S 1796d9274352SBarry Smith MatNullSpace - Object that removes a null space from a vector, i.e. 1797cb6b9846SMatthew Knepley orthogonalizes the vector to a subspace 1798d9274352SBarry Smith 1799f7a9e4ceSBarry Smith Level: advanced 1800d9274352SBarry Smith 1801d9274352SBarry Smith .seealso: MatNullSpaceCreate() 1802d9274352SBarry Smith S*/ 180374637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace; 1804d9274352SBarry Smith 1805014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*); 1806014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*); 1807014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*); 1808d0195637SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec); 1809014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *); 18105fa7ec2dSBarry Smith PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *); 18115fa7ec2dSBarry Smith PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat,MatNullSpace); 1812014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace); 1813014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace); 1814014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*); 1815014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool *); 1816014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer); 1817014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**); 1818014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*); 181974637425SBarry Smith 1820014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS); 1821014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal); 1822014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *); 18233f1d51d7SBarry Smith 1824014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*); 1825014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*); 1826014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*); 1827c4f061fbSSatish Balay 18280bacdadaSStefano Zampini PETSC_EXTERN PetscErrorCode MatComputeOperator(Mat,MatType,Mat*); 18290bacdadaSStefano Zampini PETSC_EXTERN PetscErrorCode MatComputeOperatorTranspose(Mat,MatType,Mat*); 18300bacdadaSStefano Zampini 18319fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatComputeOperator() (since version 3.12)") static inline PetscErrorCode MatComputeExplicitOperator(Mat A,Mat* B) { return MatComputeOperator(A,NULL,B); } 18329fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatComputeOperatorTranspose() (since version 3.12)") static inline PetscErrorCode MatComputeExplicitOperatorTranspose(Mat A,Mat* B) { return MatComputeOperatorTranspose(A,NULL,B); } 1833b0a32e0cSBarry Smith 183449bd79ccSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode MatCreateKAIJ(Mat,PetscInt,PetscInt,const PetscScalar[],const PetscScalar[],Mat*); 183549bd79ccSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode MatKAIJGetAIJ(Mat,Mat*); 1836a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetS(Mat,PetscInt*,PetscInt*,PetscScalar**); 1837a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetSRead(Mat,PetscInt*,PetscInt*,const PetscScalar**); 1838a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreS(Mat,PetscScalar**); 1839a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreSRead(Mat,const PetscScalar**); 1840a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetT(Mat,PetscInt*,PetscInt*,PetscScalar**); 1841a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetTRead(Mat,PetscInt*,PetscInt*,const PetscScalar**); 1842a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreT(Mat,PetscScalar**); 1843a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreTRead(Mat,const PetscScalar**); 1844dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetAIJ(Mat,Mat); 1845dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetS(Mat,PetscInt,PetscInt,const PetscScalar[]); 1846dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetT(Mat,PetscInt,PetscInt,const PetscScalar[]); 1847910cf402Sprj- PETSC_EXTERN PetscErrorCode MatKAIJGetScaledIdentity(Mat,PetscBool*); 184849bd79ccSDebojyoti Ghosh 1849014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec); 185004f1ad80SBarry Smith 1851014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 1852014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec); 1853014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*); 1854014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*)); 1855014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec)); 1856014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt); 1857014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat); 1858014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal); 1859014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt); 1860014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *); 1861014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]); 1862014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*); 1863014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*); 1864e884886fSBarry Smith 18656370053bSBarry Smith /*S 18666370053bSBarry Smith MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free 18676370053bSBarry Smith Jacobian vector products 1868e884886fSBarry Smith 186995452b02SPatrick Sanan Notes: 187095452b02SPatrick Sanan MATMFFD is a specific MatType which uses the MatMFFD data structure 18716370053bSBarry Smith 18726370053bSBarry Smith MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure 18736370053bSBarry Smith 18746370053bSBarry Smith Level: developer 18756370053bSBarry Smith 18766370053bSBarry Smith .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister() 18776370053bSBarry Smith S*/ 1878e884886fSBarry Smith typedef struct _p_MatMFFD* MatMFFD; 1879e884886fSBarry Smith 188076bdecfbSBarry Smith /*J 1881e884886fSBarry Smith MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function 1882e884886fSBarry Smith 1883e884886fSBarry Smith Level: beginner 1884e884886fSBarry Smith 1885e884886fSBarry Smith .seealso: MatMFFDSetType(), MatMFFDRegister() 188676bdecfbSBarry Smith J*/ 188719fd82e9SBarry Smith typedef const char* MatMFFDType; 1888e884886fSBarry Smith #define MATMFFD_DS "ds" 1889e884886fSBarry Smith #define MATMFFD_WP "wp" 1890e884886fSBarry Smith 189119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat,MatMFFDType); 1892bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[],PetscErrorCode (*)(MatMFFD)); 1893e884886fSBarry Smith 1894014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal); 1895014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool); 1896e884886fSBarry Smith 189761ab5df0SBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring,MatMFFDType); 189861ab5df0SBarry Smith 1899014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *); 1900014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *); 19017dbadf16SMatthew Knepley 190253022affSStefano Zampini #ifdef PETSC_HAVE_H2OPUS 190353022affSStefano Zampini PETSC_EXTERN_TYPEDEF typedef PetscScalar (*MatH2OpusKernel)(PetscInt,PetscReal[],PetscReal[],void*); 190453022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatCreateH2OpusFromKernel(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscReal[],PetscBool,MatH2OpusKernel,void*,PetscReal,PetscInt,PetscInt,Mat*); 190553022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatCreateH2OpusFromMat(Mat,PetscInt,const PetscReal[],PetscBool,PetscReal,PetscInt,PetscInt,PetscInt,PetscReal,Mat*); 190653022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusSetSamplingMat(Mat,Mat,PetscInt,PetscReal); 190753022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusOrthogonalize(Mat); 190853022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusCompress(Mat,PetscReal); 190953022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusSetNativeMult(Mat,PetscBool); 191053022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusGetNativeMult(Mat,PetscBool*); 191153022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusGetIndexMap(Mat,IS*); 191253022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusMapVec(Mat,PetscBool,Vec,Vec*); 1913300d917bSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusLowRankUpdate(Mat,Mat,Mat,PetscScalar); 1914a0d2e7d8SStefano Zampini #endif 1915a0d2e7d8SStefano Zampini 1916c7a4214aSPierre Jolivet #ifdef PETSC_HAVE_HTOOL 191798e73e17SPierre Jolivet PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*MatHtoolKernel)(PetscInt,PetscInt,PetscInt,const PetscInt*,const PetscInt*,PetscScalar*,void*); 1918c7a4214aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatCreateHtoolFromKernel(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscReal[],const PetscReal[],MatHtoolKernel,void*,Mat*); 1919c7a4214aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolSetKernel(Mat,MatHtoolKernel,void*); 192098e73e17SPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolGetPermutationSource(Mat,IS*); 192198e73e17SPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolGetPermutationTarget(Mat,IS*); 192298e73e17SPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolUsePermutation(Mat,PetscBool); 1923c7a4214aSPierre Jolivet /*E 1924c7a4214aSPierre Jolivet MatHtoolCompressorType - Indicates the type of compressor used by a MATHTOOL 1925c7a4214aSPierre Jolivet 1926c7a4214aSPierre Jolivet Level: beginner 1927c7a4214aSPierre Jolivet 1928c7a4214aSPierre Jolivet Values: 1929c7a4214aSPierre Jolivet + MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA (default) - symmetric partial adaptive cross approximation 1930c7a4214aSPierre Jolivet . MAT_HTOOL_COMPRESSOR_FULL_ACA - full adaptive cross approximation 1931c7a4214aSPierre Jolivet - MAT_HTOOL_COMPRESSOR_SVD - singular value decomposition 1932c7a4214aSPierre Jolivet 193398e73e17SPierre Jolivet .seealso: MatCreateHtoolFromKernel(), MATHTOOL, MatHtoolClusteringType 1934c7a4214aSPierre Jolivet E*/ 1935c7a4214aSPierre Jolivet typedef enum { MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA, MAT_HTOOL_COMPRESSOR_FULL_ACA, MAT_HTOOL_COMPRESSOR_SVD } MatHtoolCompressorType; 193698e73e17SPierre Jolivet /*E 193798e73e17SPierre Jolivet MatHtoolClusteringType - Indicates the type of clustering used by a MATHTOOL 193898e73e17SPierre Jolivet 193998e73e17SPierre Jolivet Level: beginner 194098e73e17SPierre Jolivet 194198e73e17SPierre Jolivet Values: 194298e73e17SPierre Jolivet + MAT_HTOOL_CLUSTERING_PCA_REGULAR (default) - axis computed via principle component analysis, split uniformly 194398e73e17SPierre Jolivet . MAT_HTOOL_CLUSTERING_PCA_GEOMETRIC - axis computed via principle component analysis, split barycentrically 194498e73e17SPierre Jolivet . MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_REGULAR - axis along the largest extent of the bounding box, split uniformly 194598e73e17SPierre Jolivet - MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_GEOMETRIC - axis along the largest extent of the bounding box, split barycentrically 194698e73e17SPierre Jolivet 194798e73e17SPierre Jolivet Notes: higher-dimensional clustering is not yet supported in Htool, but once it is, one should add BOUNDING_BOX_{2,3} types 194898e73e17SPierre Jolivet 194998e73e17SPierre Jolivet .seealso: MatCreateHtoolFromKernel(), MATHTOOL, MatHtoolCompressorType 195098e73e17SPierre Jolivet E*/ 195198e73e17SPierre Jolivet typedef enum { MAT_HTOOL_CLUSTERING_PCA_REGULAR, MAT_HTOOL_CLUSTERING_PCA_GEOMETRIC, MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_REGULAR, MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_GEOMETRIC } MatHtoolClusteringType; 1952c7a4214aSPierre Jolivet #endif 1953c7a4214aSPierre Jolivet 195497969023SHong Zhang /* 195597969023SHong Zhang PETSc interface to MUMPS 195697969023SHong Zhang */ 195797969023SHong Zhang #ifdef PETSC_HAVE_MUMPS 1958014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt); 1959bc6112feSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat,PetscInt,PetscInt*); 1960b9e9ea26SSatish Balay PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal); 1961bc6112feSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat,PetscInt,PetscReal*); 1962bc6112feSHong Zhang 1963ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat,PetscInt,PetscInt*); 1964ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat,PetscInt,PetscInt*); 1965ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat,PetscInt,PetscReal*); 1966ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat,PetscInt,PetscReal*); 196789a9c03aSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat,Mat); 19680e6b8875SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInverseTranspose(Mat,Mat); 196997969023SHong Zhang #endif 197023a5497aSJed Brown 1971d954db57SHong Zhang /* 1972d615f992SSatish Balay PETSc interface to Mkl_Pardiso 1973b500a6b7SJose David Bermeol */ 1974b500a6b7SJose David Bermeol #ifdef PETSC_HAVE_MKL_PARDISO 1975d615f992SSatish Balay PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt); 1976b500a6b7SJose David Bermeol #endif 1977b500a6b7SJose David Bermeol 1978b500a6b7SJose David Bermeol /* 1979d305a81bSVasiliy Kozyrev PETSc interface to Mkl_CPardiso 1980d305a81bSVasiliy Kozyrev */ 1981d305a81bSVasiliy Kozyrev #ifdef PETSC_HAVE_MKL_CPARDISO 1982d305a81bSVasiliy Kozyrev PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt); 1983d305a81bSVasiliy Kozyrev #endif 1984d305a81bSVasiliy Kozyrev 1985d305a81bSVasiliy Kozyrev /* 1986d954db57SHong Zhang PETSc interface to SUPERLU 1987d954db57SHong Zhang */ 1988d954db57SHong Zhang #ifdef PETSC_HAVE_SUPERLU 1989014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal); 1990d954db57SHong Zhang #endif 1991d954db57SHong Zhang 1992fb785984SHong Zhang /* 1993fb785984SHong Zhang PETSc interface to SUPERLU_DIST 1994fb785984SHong Zhang */ 1995fb785984SHong Zhang #ifdef PETSC_HAVE_SUPERLU_DIST 1996fb785984SHong Zhang PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat,PetscScalar*); 1997fb785984SHong Zhang #endif 1998fb785984SHong Zhang 1999575704cbSPieter Ghysels /* 2000575704cbSPieter Ghysels PETSc interface to STRUMPACK 2001575704cbSPieter Ghysels */ 2002575704cbSPieter Ghysels #ifdef PETSC_HAVE_STRUMPACK 2003542aee0fSPieter Ghysels /*E 2004542aee0fSPieter Ghysels MatSTRUMPACKReordering - sparsity reducing ordering to be used in STRUMPACK 2005542aee0fSPieter Ghysels 2006542aee0fSPieter Ghysels Level: intermediate 2007542aee0fSPieter Ghysels E*/ 200834f43fa5SPieter Ghysels typedef enum {MAT_STRUMPACK_NATURAL=0, 200934f43fa5SPieter Ghysels MAT_STRUMPACK_METIS=1, 201034f43fa5SPieter Ghysels MAT_STRUMPACK_PARMETIS=2, 201134f43fa5SPieter Ghysels MAT_STRUMPACK_SCOTCH=3, 201234f43fa5SPieter Ghysels MAT_STRUMPACK_PTSCOTCH=4, 201334f43fa5SPieter Ghysels MAT_STRUMPACK_RCM=5} MatSTRUMPACKReordering; 201434f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat,MatSTRUMPACKReordering); 2015575704cbSPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat,PetscBool); 201634f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSRelTol(Mat,PetscReal); 20179fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSRelTol() (since version 3.9)") static inline PetscErrorCode MatSTRUMPACKSetHSSRelCompTol(Mat mat,PetscReal rtol) {return MatSTRUMPACKSetHSSRelTol(mat,rtol);} 201834f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSAbsTol(Mat,PetscReal); 201934f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMinSepSize(Mat,PetscInt); 20209fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSMinSepSize() (since version 3.9)") static inline PetscErrorCode MatSTRUMPACKSetHSSMinSize(Mat mat,PetscInt hssminsize) {return MatSTRUMPACKSetHSSMinSepSize(mat,hssminsize);} 202134f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMaxRank(Mat,PetscInt); 2022a36bf211SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSLeafSize(Mat,PetscInt); 2023575704cbSPieter Ghysels #endif 2024575704cbSPieter Ghysels 2025b470e4b4SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatBindToCPU(Mat,PetscBool); 20262216c58aSStefano Zampini PETSC_EXTERN PetscErrorCode MatBoundToCPU(Mat,PetscBool*); 20279fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatBindToCPU (since v3.13)") static inline PetscErrorCode MatPinToCPU(Mat A,PetscBool flg) {return MatBindToCPU(A,flg);} 202865a9ecf2SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatSetBindingPropagates(Mat,PetscBool); 2029e9c74fd6SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetBindingPropagates(Mat,PetscBool *); 2030e7e92044SBarry Smith 2031042217e8SBarry Smith typedef struct _n_SplitCSRMat *PetscSplitCSRDataStructure; 2032042217e8SBarry Smith PETSC_EXTERN PetscErrorCode MatCUSPARSEGetDeviceMatWrite(Mat,PetscSplitCSRDataStructure*); 2033a587d139SMark 2034a587d139SMark #ifdef PETSC_HAVE_KOKKOS_KERNELS 2035042217e8SBarry Smith PETSC_EXTERN PetscErrorCode MatKokkosGetDeviceMatWrite(Mat,PetscSplitCSRDataStructure*); 2036042217e8SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJKokkosSetDeviceMat(Mat,PetscSplitCSRDataStructure); 2037042217e8SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJKokkosGetDeviceMat(Mat,PetscSplitCSRDataStructure*); 2038a587d139SMark #endif 2039a587d139SMark 2040aa372e3fSPaul Mullowney #ifdef PETSC_HAVE_CUDA 20413f9c0db1SPaul Mullowney /*E 2042e057df02SPaul Mullowney MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU) 20432692e278SPaul Mullowney matrices. 2044e057df02SPaul Mullowney 2045e057df02SPaul Mullowney Not Collective 2046e057df02SPaul Mullowney 20478468deeeSKarl Rupp + MAT_CUSPARSE_CSR - Compressed Sparse Row 20482692e278SPaul Mullowney . MAT_CUSPARSE_ELL - Ellpack (requires CUDA 4.2 or later). 20492692e278SPaul Mullowney - MAT_CUSPARSE_HYB - Hybrid, a combination of Ellpack and Coordinate format (requires CUDA 4.2 or later). 2050e057df02SPaul Mullowney 2051e057df02SPaul Mullowney Level: intermediate 2052e057df02SPaul Mullowney 2053af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 2054e057df02SPaul Mullowney 2055e057df02SPaul Mullowney .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation 2056e057df02SPaul Mullowney E*/ 2057e057df02SPaul Mullowney 20583f9c0db1SPaul Mullowney typedef enum {MAT_CUSPARSE_CSR, MAT_CUSPARSE_ELL, MAT_CUSPARSE_HYB} MatCUSPARSEStorageFormat; 2059e057df02SPaul Mullowney 2060e057df02SPaul Mullowney /* these will be strings associated with enumerated type defined above */ 2061e057df02SPaul Mullowney PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[]; 2062e057df02SPaul Mullowney 20633f9c0db1SPaul Mullowney /*E 2064e057df02SPaul Mullowney MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU) 20652692e278SPaul Mullowney matrices whose operation should use a particular storage format. 2066e057df02SPaul Mullowney 2067e057df02SPaul Mullowney Not Collective 2068e057df02SPaul Mullowney 20698468deeeSKarl Rupp + MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult 20708468deeeSKarl Rupp . MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult 20718468deeeSKarl Rupp . MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult 20728468deeeSKarl Rupp - MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices 2073e057df02SPaul Mullowney 2074e057df02SPaul Mullowney Level: intermediate 2075e057df02SPaul Mullowney 2076e057df02SPaul Mullowney .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat 2077e057df02SPaul Mullowney E*/ 207836d62e41SPaul Mullowney typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation; 2079e057df02SPaul Mullowney 208010e9db80SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 208110e9db80SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 2082e057df02SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat); 2083365b711fSMark Adams PETSC_EXTERN PetscErrorCode MatCUSPARSESetUseCPUSolve(Mat,PetscBool); 2084e8d2b73aSMark Adams typedef struct Mat_SeqAIJCUSPARSETriFactors* Mat_SeqAIJCUSPARSETriFactors_p; 20855f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetIJ(Mat,PetscBool,const int**,const int**); 20865f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreIJ(Mat,PetscBool,const int**,const int**); 20875f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArrayRead(Mat,const PetscScalar**); 20885f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArrayRead(Mat,const PetscScalar**); 20895f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArrayWrite(Mat,PetscScalar**); 20905f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArrayWrite(Mat,PetscScalar**); 20915f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArray(Mat,PetscScalar**); 20925f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArray(Mat,PetscScalar**); 2093637a0070SStefano Zampini 2094637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatCreateDenseCUDA(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*); 2095637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatCreateSeqDenseCUDA(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*); 2096637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatMPIDenseCUDASetPreallocation(Mat,PetscScalar[]); 2097637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqDenseCUDASetPreallocation(Mat,PetscScalar[]); 2098637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayWrite(Mat,PetscScalar**); 2099637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayRead(Mat,const PetscScalar**); 2100637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArray(Mat,PetscScalar**); 2101637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayWrite(Mat,PetscScalar**); 2102637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayRead(Mat,const PetscScalar**); 2103637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArray(Mat,PetscScalar**); 2104637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAPlaceArray(Mat,const PetscScalar*); 2105d5ea218eSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAReplaceArray(Mat,const PetscScalar*); 2106637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAResetArray(Mat); 21073fa6b06aSMark Adams 21089ae82921SPaul Mullowney #endif 21099ae82921SPaul Mullowney 2110d67ff14aSKarl Rupp #if defined(PETSC_HAVE_VIENNACL) 2111d67ff14aSKarl Rupp PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 2112d67ff14aSKarl Rupp PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 2113d67ff14aSKarl Rupp #endif 2114d67ff14aSKarl Rupp 211554efbe56SHong Zhang /* 211654efbe56SHong Zhang PETSc interface to FFTW 211754efbe56SHong Zhang */ 211854efbe56SHong Zhang #if defined(PETSC_HAVE_FFTW) 2119014dd563SJed Brown PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec); 2120014dd563SJed Brown PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec); 21212a7a6963SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*); 212254efbe56SHong Zhang #endif 212354efbe56SHong Zhang 2124d24d4204SJose E. Roman #if defined(PETSC_HAVE_SCALAPACK) 2125d24d4204SJose E. Roman PETSC_EXTERN PetscErrorCode MatCreateScaLAPACK(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 2126d24d4204SJose E. Roman PETSC_EXTERN PetscErrorCode MatScaLAPACKSetBlockSizes(Mat,PetscInt,PetscInt); 2127d24d4204SJose E. Roman PETSC_EXTERN PetscErrorCode MatScaLAPACKGetBlockSizes(Mat,PetscInt*,PetscInt*); 2128d24d4204SJose E. Roman #endif 2129d24d4204SJose E. Roman 2130014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*); 2131014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*); 2132014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]); 2133014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]); 2134014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***); 2135014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*); 213619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType); 2137014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]); 2138014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat); 2139d8588912SDave May 21404325cce7SMatthew G Knepley PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal); 2141e0a58c10SMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*); 21424325cce7SMatthew G Knepley 2143b541e6a4SDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSubdomainsCreateCoalesce(Mat,PetscInt,PetscInt*,IS**); 214453dd7562SDmitry Karpeev 2145c094ef40SMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatPreallocatorPreallocate(Mat,PetscBool,Mat); 2146c094ef40SMatthew G. Knepley 2147539c167fSBarry Smith PETSC_INTERN PetscErrorCode MatHeaderMerge(Mat,Mat*); 2148539c167fSBarry Smith PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat,Mat*); 21491a2c6b5cSJunchao Zhang 21507ee59b9bSJunchao Zhang PETSC_EXTERN PetscErrorCode MatSeqAIJGetCSRAndMemType(Mat,const PetscInt**,const PetscInt**,PetscScalar**,PetscMemType*); 215123a5497aSJed Brown #endif 2152