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); 41199cafbc1SBarry Smith 4128ed539a5SBarry Smith /* ------------------------------------------------------------*/ 413014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 414014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 415014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]); 416014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]); 417014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat,PetscInt,PetscInt,PetscInt[],const PetscScalar[]); 41873a71a0fSBarry Smith PETSC_EXTERN PetscErrorCode MatSetRandom(Mat,PetscRandom); 41984cb2905SBarry Smith 4202ef4de8bSBarry Smith /*S 4212ef4de8bSBarry Smith MatStencil - Data structure (C struct) for storing information about a single row or 42262ef0227SBarry Smith column of a matrix as indexed on an associated grid. These are arguments to MatSetStencil() and MatSetBlockStencil() 42362ef0227SBarry Smith 42462ef0227SBarry 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). 42562ef0227SBarry 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. 42662ef0227SBarry Smith 42762ef0227SBarry Smith For stencil access to vectors see DMDAVecGetArray(), DMDAVecGetArrayF90(). 428be479b30SJed Brown 429be479b30SJed Brown Fortran usage is different, see MatSetValuesStencil() for details. 4302ef4de8bSBarry Smith 4312ef4de8bSBarry Smith Level: beginner 4322ef4de8bSBarry Smith 43362ef0227SBarry Smith .seealso: MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockedStencil(), DMDAVecGetArray(), DMDAVecGetArrayF90() 4342ef4de8bSBarry Smith S*/ 435435da068SBarry Smith typedef struct { 436c1ac3661SBarry Smith PetscInt k,j,i,c; 437435da068SBarry Smith } MatStencil; 4382ef4de8bSBarry Smith 439014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 440014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 441014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt); 442435da068SBarry Smith 443d91e6319SBarry Smith /*E 444d91e6319SBarry Smith MatAssemblyType - Indicates if the matrix is now to be used, or if you plan 44562ef0227SBarry Smith to continue to add or insert values to it 446d91e6319SBarry Smith 447d91e6319SBarry Smith Level: beginner 448d91e6319SBarry Smith 449d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd() 450d91e6319SBarry Smith E*/ 4516d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType; 452014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType); 453014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType); 454014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssembled(Mat,PetscBool *); 4554f9c727eSBarry Smith 456d91e6319SBarry Smith /*E 457d91e6319SBarry Smith MatOption - Options that may be set for a matrix and its behavior or storage 458d91e6319SBarry Smith 459d91e6319SBarry Smith Level: beginner 460d91e6319SBarry Smith 461af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 4620f8fb01aSBarry Smith Any additions/changes here must also be made in src/mat/interface/dlregismat.c in MatOptions[] 463d91e6319SBarry Smith 46495452b02SPatrick Sanan Developer Notes: 46595452b02SPatrick Sanan Entries that are negative need not be called collectively by all processes. 466382164b0SBarry Smith 467d91e6319SBarry Smith .seealso: MatSetOption() 468d91e6319SBarry Smith E*/ 469c5e4d11fSDmitry Karpeev typedef enum {MAT_OPTION_MIN = -3, 470c5e4d11fSDmitry Karpeev MAT_UNUSED_NONZERO_LOCATION_ERR = -2, 47192d4d306SBarry Smith MAT_ROW_ORIENTED = -1, 472382164b0SBarry Smith MAT_SYMMETRIC = 1, 473382164b0SBarry Smith MAT_STRUCTURALLY_SYMMETRIC = 2, 4748c78258cSHong Zhang MAT_FORCE_DIAGONAL_ENTRIES = 3, 475382164b0SBarry Smith MAT_IGNORE_OFF_PROC_ENTRIES = 4, 476382164b0SBarry Smith MAT_USE_HASH_TABLE = 5, 477382164b0SBarry Smith MAT_KEEP_NONZERO_PATTERN = 6, 478382164b0SBarry Smith MAT_IGNORE_ZERO_ENTRIES = 7, 479382164b0SBarry Smith MAT_USE_INODES = 8, 480382164b0SBarry Smith MAT_HERMITIAN = 9, 481382164b0SBarry Smith MAT_SYMMETRY_ETERNAL = 10, 482c5e4d11fSDmitry Karpeev MAT_NEW_NONZERO_LOCATION_ERR = 11, 483382164b0SBarry Smith MAT_IGNORE_LOWER_TRIANGULAR = 12, 484382164b0SBarry Smith MAT_ERROR_LOWER_TRIANGULAR = 13, 485382164b0SBarry Smith MAT_GETROW_UPPERTRIANGULAR = 14, 486382164b0SBarry Smith MAT_SPD = 15, 48792d4d306SBarry Smith MAT_NO_OFF_PROC_ZERO_ROWS = 16, 48892d4d306SBarry Smith MAT_NO_OFF_PROC_ENTRIES = 17, 48992d4d306SBarry Smith MAT_NEW_NONZERO_LOCATIONS = 18, 490c5e4d11fSDmitry Karpeev MAT_NEW_NONZERO_ALLOCATION_ERR = 19, 491c5e4d11fSDmitry Karpeev MAT_SUBSET_OFF_PROC_ENTRIES = 20, 492c10200c1SHong Zhang MAT_SUBMAT_SINGLEIS = 21, 493957cac9fSHong Zhang MAT_STRUCTURE_ONLY = 22, 494071fcb05SBarry Smith MAT_SORTED_FULL = 23, 4951a2c6b5cSJunchao Zhang MAT_FORM_EXPLICIT_TRANSPOSE = 24, 4961a2c6b5cSJunchao Zhang MAT_OPTION_MAX = 25} MatOption; 497e057df02SPaul Mullowney 4980f8fb01aSBarry Smith PETSC_EXTERN const char *const *MatOptions; 499014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscBool); 5007d68702bSBarry Smith PETSC_EXTERN PetscErrorCode MatGetOption(Mat,MatOption,PetscBool*); 501856afa8bSStefano Zampini PETSC_EXTERN PetscErrorCode MatPropagateSymmetryOptions(Mat,Mat); 50219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatGetType(Mat,MatType*); 50384cb2905SBarry Smith 504014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]); 505014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 506014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 507014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat); 508014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat); 509014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt); 5108c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat,PetscScalar *[]); 5118f1ea47aSStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJGetArrayRead(Mat,const PetscScalar *[]); 512d67d9f35SJunchao Zhang PETSC_EXTERN PetscErrorCode MatSeqAIJGetArrayWrite(Mat,PetscScalar *[]); 5138c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat,PetscScalar *[]); 5148f1ea47aSStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArrayRead(Mat,const PetscScalar *[]); 515d67d9f35SJunchao Zhang PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArrayWrite(Mat,PetscScalar *[]); 51621e72a00SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJGetMaxRowNonzeros(Mat,PetscInt*); 517bd04181cSBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJSetValuesLocalFast(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 5184099cc6bSBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJSetType(Mat,MatType); 519ad7e164aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatSeqAIJKron(Mat,Mat,MatReuse,Mat*); 520388d47a6SSatish Balay PETSC_EXTERN PetscErrorCode MatSeqAIJRegister(const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat *)); 5214099cc6bSBarry Smith PETSC_EXTERN PetscFunctionList MatSeqAIJList; 522cda14afcSprj- PETSC_EXTERN PetscErrorCode MatSeqBAIJGetArray(Mat,PetscScalar *[]); 523cda14afcSprj- PETSC_EXTERN PetscErrorCode MatSeqBAIJRestoreArray(Mat,PetscScalar *[]); 5248397e458SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqSBAIJGetArray(Mat,PetscScalar *[]); 5258397e458SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqSBAIJRestoreArray(Mat,PetscScalar *[]); 5268c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat,PetscScalar *[]); 5278c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat,PetscScalar *[]); 528d3042a70SBarry Smith PETSC_EXTERN PetscErrorCode MatDensePlaceArray(Mat,const PetscScalar[]); 529d5ea218eSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseReplaceArray(Mat,const PetscScalar[]); 530d3042a70SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseResetArray(Mat); 5318572280aSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetArrayRead(Mat,const PetscScalar *[]); 5328572280aSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayRead(Mat,const PetscScalar *[]); 5336947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseGetArrayWrite(Mat,PetscScalar *[]); 5346947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayWrite(Mat,PetscScalar *[]); 535014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *); 536014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt); 537014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat,PetscInt *,PetscInt *); 538014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat,PetscInt,PetscInt); 53933d57670SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSizesFromMats(Mat,Mat,Mat); 5400da83c2eSBarry Smith PETSC_EXTERN PetscErrorCode MatSetVariableBlockSizes(Mat,PetscInt,PetscInt*); 5410da83c2eSBarry Smith PETSC_EXTERN PetscErrorCode MatGetVariableBlockSizes(Mat,PetscInt*,const PetscInt**); 5420da83c2eSBarry Smith 54386aefd0dSHong Zhang PETSC_EXTERN PetscErrorCode MatDenseGetColumn(Mat,PetscInt,PetscScalar*[]); 54486aefd0dSHong Zhang PETSC_EXTERN PetscErrorCode MatDenseRestoreColumn(Mat,PetscScalar*[]); 5456947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseGetColumnVec(Mat,PetscInt,Vec*); 5466947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVec(Mat,PetscInt,Vec*); 5476947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecRead(Mat,PetscInt,Vec*); 5486947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecRead(Mat,PetscInt,Vec*); 5496947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecWrite(Mat,PetscInt,Vec*); 5506947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecWrite(Mat,PetscInt,Vec*); 5515ea7661aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatDenseGetSubMatrix(Mat,PetscInt,PetscInt,Mat*); 5525ea7661aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatDenseRestoreSubMatrix(Mat,Mat*); 5531620fd73SBarry Smith 554014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMult(Mat,Vec,Vec); 555014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec); 556014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec); 557014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec); 558014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec); 559014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *); 560014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *); 561014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec); 562014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec); 563014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat); 564bdc285e1SStefano Zampini PETSC_EXTERN PetscErrorCode MatMatSolveTranspose(Mat,Mat,Mat); 565eb3ef3b2SHong Zhang PETSC_EXTERN PetscErrorCode MatMatTransposeSolve(Mat,Mat,Mat); 566f9426fe0SMark Adams PETSC_EXTERN PetscErrorCode MatResidual(Mat,Vec,Vec,Vec); 567f5edf698SHong Zhang 568d91e6319SBarry Smith /*E 569d91e6319SBarry Smith MatDuplicateOption - Indicates if a duplicated sparse matrix should have 570d91e6319SBarry Smith its numerical values copied over or just its nonzero structure. 571d91e6319SBarry Smith 572d91e6319SBarry Smith Level: beginner 573d91e6319SBarry Smith 574af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 575d91e6319SBarry Smith 5760018da39SRichard Tran Mills $ MAT_DO_NOT_COPY_VALUES - Create a matrix using the same nonzero pattern as the original matrix, 5770018da39SRichard Tran Mills $ with zeros for the numerical values. 5780018da39SRichard Tran Mills $ MAT_COPY_VALUES - Create a matrix with the same nonzero pattern as the original matrix 5790018da39SRichard Tran Mills $ and with the same numerical values. 5800018da39SRichard Tran Mills $ MAT_SHARE_NONZERO_PATTERN - Create a matrix that shares the nonzero structure with the previous matrix 5810018da39SRichard Tran Mills $ and does not copy it, using zeros for the numerical values. The parent and 5820018da39SRichard Tran Mills $ child matrices will share their index (i and j) arrays, and you cannot 5830018da39SRichard Tran Mills $ insert new nonzero entries into either matrix. 5840018da39SRichard Tran Mills 58595452b02SPatrick Sanan Notes: 58695452b02SPatrick Sanan Many matrix types (including SeqAIJ) do not support the MAT_SHARE_NONZERO_PATTERN optimization; in 5870018da39SRichard Tran Mills this case the behavior is as if MAT_DO_NOT_COPY_VALUES has been specified. 58870dcbbb9SBarry Smith 589d91e6319SBarry Smith .seealso: MatDuplicate() 590d91e6319SBarry Smith E*/ 59170dcbbb9SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption; 5922e8a6d31SBarry Smith 59319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*); 594014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*); 59594a9d846SBarry Smith 596014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure); 597014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer); 598014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *); 599014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *); 600014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *); 601014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *); 602014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *); 603014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool *,PetscInt *); 604014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer); 6057b80b807SBarry Smith 6061a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *); 6071a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *); 6081a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *); 6091a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *); 610d4fbbf0eSBarry Smith 611d91e6319SBarry Smith /*S 612d91e6319SBarry Smith MatInfo - Context of matrix information, used with MatGetInfo() 613d91e6319SBarry Smith 614d91e6319SBarry Smith In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE 615d91e6319SBarry Smith 616d91e6319SBarry Smith Level: intermediate 617d91e6319SBarry Smith 618d9274352SBarry Smith .seealso: MatGetInfo(), MatInfoType 619d91e6319SBarry Smith S*/ 6204e220ebcSLois Curfman McInnes typedef struct { 621b0a32e0cSBarry Smith PetscLogDouble block_size; /* block size */ 622b0a32e0cSBarry Smith PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */ 623b0a32e0cSBarry Smith PetscLogDouble memory; /* memory allocated */ 624b0a32e0cSBarry Smith PetscLogDouble assemblies; /* number of matrix assemblies called */ 625b0a32e0cSBarry Smith PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */ 626b0a32e0cSBarry Smith PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */ 627b0a32e0cSBarry Smith PetscLogDouble factor_mallocs; /* number of mallocs during factorization */ 6284e220ebcSLois Curfman McInnes } MatInfo; 6294e220ebcSLois Curfman McInnes 630d9274352SBarry Smith /*E 631d9274352SBarry Smith MatInfoType - Indicates if you want information about the local part of the matrix, 632d9274352SBarry Smith the entire parallel matrix or the maximum over all the local parts. 633d9274352SBarry Smith 634d9274352SBarry Smith Level: beginner 635d9274352SBarry Smith 636af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 637d9274352SBarry Smith 638d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo 639d9274352SBarry Smith E*/ 6407b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType; 641014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*); 642014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec); 643014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]); 644014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]); 645014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]); 646014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]); 647014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat,Vec); 648014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*); 649014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*); 650014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat*); 651014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec); 652014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode); 653a52676ecSHong Zhang 654014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool*); 655014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool*); 656014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool*); 657014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool*); 658014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*); 659e573050aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeEqual(Mat,Mat,PetscInt,PetscBool*); 660e573050aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*); 661a52676ecSHong Zhang PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 662a52676ecSHong Zhang PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 663cc48ffa7SToby Isaac PETSC_EXTERN PetscErrorCode MatMatTransposeMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 6644222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatPtAPMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 665447fed29SStefano Zampini PETSC_EXTERN PetscErrorCode MatRARtMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 66686919fd6SHong Zhang PETSC_EXTERN PetscErrorCode MatIsLinear(Mat,PetscInt,PetscBool*); 6677b80b807SBarry Smith 668014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal*); 669014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal*); 670857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnSums(Mat,PetscScalar*); 671857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnSumsRealPart(Mat,PetscReal*); 672857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnSumsImaginaryPart(Mat,PetscReal*); 673857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnMeans(Mat,PetscScalar*); 674857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnMeansRealPart(Mat,PetscReal*); 675857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnMeansImaginaryPart(Mat,PetscReal*); 676857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnReductions(Mat,PetscInt,PetscReal*); 677014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat); 6781b2b9847SBarry Smith PETSC_EXTERN PetscErrorCode MatSetInf(Mat); 679014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 680014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec); 681014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec); 682014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec); 683014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 684014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec); 6857b80b807SBarry Smith 686014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*); 687014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*); 688014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*); 689014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**); 690014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*); 691014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**); 692566876eaSJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*); 6935ef9f2a5SBarry Smith 6947dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 6959fbee547SJacob 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);} 6967dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 6979fbee547SJacob 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);} 698014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]); 699df750dc8SHong Zhang PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt,Mat *[]); 7007dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,MatReuse,Mat *); 7019fbee547SJacob 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);} 702014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*); 703014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*); 704014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*); 705014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*); 7067b80b807SBarry Smith 707014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*); 708014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*); 709014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat); 710014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*); 711014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*); 712ed502f03SStefano Zampini PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatMerge(Mat,MatReuse,IS*,Mat*); 713014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*); 714014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]); 7158efafbd8SBarry Smith 716014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt); 717aa1e27eaSFande Kong PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat mat,PetscInt n,IS is[],PetscInt ov); 718d2b2a242SBarry Smith PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat,PetscBool); 7197b80b807SBarry Smith 720014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 72122440eb1SKris Buschelman 7227bab7c10SHong Zhang PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*); 7232df6c5c3SPatrick Farrell PETSC_EXTERN PetscErrorCode MatGalerkin(Mat,Mat,Mat,MatReuse,PetscReal,Mat*); 7247bab7c10SHong Zhang 725014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*); 726014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*); 72722440eb1SKris Buschelman 728014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 729014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*); 730bc011b1eSHong Zhang 731014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure); 732014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure); 7331c741599SHong Zhang 734014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar); 735014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar); 7367b80b807SBarry Smith 737014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping); 738014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*); 739a93ff8c4SPeter Brune PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat,PetscLayout*,PetscLayout*); 74081fa06acSBarry Smith PETSC_EXTERN PetscErrorCode MatSetLayouts(Mat,PetscLayout,PetscLayout); 741014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 742014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec); 743014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 744014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec); 745e265f6d6SPatrick Sanan PETSC_EXTERN PetscErrorCode MatGetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]); 746014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 747014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 748052efed2SBarry Smith 749014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt); 750014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 75190f02eecSBarry Smith 752014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec); 753014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec); 754014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec); 75530b0564aSStefano Zampini PETSC_EXTERN PetscErrorCode MatMatInterpolate(Mat,Mat,Mat*); 75630b0564aSStefano Zampini PETSC_EXTERN PetscErrorCode MatMatInterpolateAdd(Mat,Mat,Mat,Mat*); 75730b0564aSStefano Zampini PETSC_EXTERN PetscErrorCode MatMatRestrict(Mat,Mat,Mat*); 7582a7a6963SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat,Vec*,Vec*); 7599fbee547SJacob 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);} 76053cd1579SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat,PetscInt,MPI_Comm,MatReuse,Mat*); 761014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*); 762014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*); 7633a062f41SBarry Smith PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat,IS*); 7649c8f2541SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm,Mat,PetscInt,MatReuse,Mat*); 765bd481603SBarry Smith 766bd481603SBarry Smith /*MC 7671620fd73SBarry Smith MatSetValue - Set a single entry into a matrix. 7681620fd73SBarry Smith 7691620fd73SBarry Smith Not collective 7701620fd73SBarry Smith 771a9834a7dSSatish Balay Synopsis: 772a9834a7dSSatish Balay #include <petscmat.h> 773a9834a7dSSatish Balay PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode) 774a9834a7dSSatish Balay 7751620fd73SBarry Smith Input Parameters: 7761620fd73SBarry Smith + m - the matrix 7771620fd73SBarry Smith . row - the row location of the entry 7781620fd73SBarry Smith . col - the column location of the entry 7791620fd73SBarry Smith . value - the value to insert 7801620fd73SBarry Smith - mode - either INSERT_VALUES or ADD_VALUES 7811620fd73SBarry Smith 7821620fd73SBarry Smith Notes: 783e5e5a7b5SPatrick Sanan For efficiency one should use MatSetValues() and set several values simultaneously. 7841620fd73SBarry Smith 7851620fd73SBarry Smith Level: beginner 7861620fd73SBarry Smith 787e5e5a7b5SPatrick Sanan .seealso: MatGetValue(), MatSetValues(), MatSetValueLocal(), MatSetValuesLocal() 7881620fd73SBarry Smith M*/ 7899fbee547SJacob Faibussowitsch static inline PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);} 7901620fd73SBarry Smith 791e5e5a7b5SPatrick Sanan /*@C 792e5e5a7b5SPatrick Sanan MatGetValue - Gets a single value from a matrix 7931620fd73SBarry Smith 794e5e5a7b5SPatrick Sanan Not Collective; can only return a value owned by the given process 795e5e5a7b5SPatrick Sanan 796e5e5a7b5SPatrick Sanan Input Parameters: 797e5e5a7b5SPatrick Sanan + mat - the matrix 798e5e5a7b5SPatrick Sanan . row - the row location of the entry 799e5e5a7b5SPatrick Sanan - col - the column location of the entry 800e5e5a7b5SPatrick Sanan 801e5e5a7b5SPatrick Sanan Output Parameter: 802e5e5a7b5SPatrick Sanan . va - the value 803e5e5a7b5SPatrick Sanan 804e5e5a7b5SPatrick Sanan Notes: 805e5e5a7b5SPatrick Sanan For efficiency one should use MatGetValues() and get several values simultaneously. 806e5e5a7b5SPatrick Sanan 807e5e5a7b5SPatrick Sanan See notes for MatGetValues(). 808e5e5a7b5SPatrick Sanan 809e5e5a7b5SPatrick Sanan Level: advanced 810e5e5a7b5SPatrick Sanan 811e5e5a7b5SPatrick Sanan .seealso: MatSetValue(), MatGetValueLocal(), MatGetValues() 812e5e5a7b5SPatrick Sanan @*/ 8139fbee547SJacob Faibussowitsch static inline PetscErrorCode MatGetValue(Mat mat,PetscInt row,PetscInt col,PetscScalar *va) {return MatGetValues(mat,1,&row,1,&col,va);} 814e5e5a7b5SPatrick Sanan 815e5e5a7b5SPatrick Sanan /*MC 816e5e5a7b5SPatrick Sanan MatSetValueLocal - Inserts or adds a single value into a matrix, 817e5e5a7b5SPatrick Sanan using a local numbering of the nodes. 818e5e5a7b5SPatrick Sanan 819e5e5a7b5SPatrick Sanan Not Collective 820e5e5a7b5SPatrick Sanan 821e5e5a7b5SPatrick Sanan Input Parameters: 822e5e5a7b5SPatrick Sanan + m - the matrix 823e5e5a7b5SPatrick Sanan . row - the row location of the entry 824e5e5a7b5SPatrick Sanan . col - the column location of the entry 825e5e5a7b5SPatrick Sanan . value - the value to insert 826e5e5a7b5SPatrick Sanan - mode - either INSERT_VALUES or ADD_VALUES 827e5e5a7b5SPatrick Sanan 828e5e5a7b5SPatrick Sanan Notes: 829e5e5a7b5SPatrick Sanan For efficiency one should use MatSetValuesLocal() and set several values simultaneously. 830e5e5a7b5SPatrick Sanan 831e5e5a7b5SPatrick Sanan See notes for MatSetValuesLocal() for additional information on when and how this function can be used. 832e5e5a7b5SPatrick Sanan 833e5e5a7b5SPatrick Sanan Level: intermediate 834e5e5a7b5SPatrick Sanan 835e5e5a7b5SPatrick Sanan .seealso: MatSetValue(), MatSetValuesLocal() 836e5e5a7b5SPatrick Sanan M*/ 8379fbee547SJacob Faibussowitsch static inline PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);} 8381620fd73SBarry Smith 8391620fd73SBarry Smith /*MC 840*d0609cedSBarry Smith MatPreallocateBegin - Begins the block of code that will count the number of nonzeros per 841bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 842bd481603SBarry Smith 843bd481603SBarry Smith Synopsis: 844aaa7dc30SBarry Smith #include <petscmat.h> 845*d0609cedSBarry Smith PetscErrorCode MatPreallocateBegin(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 846bd481603SBarry Smith 847d083f849SBarry Smith Collective 848bd481603SBarry Smith 849bd481603SBarry Smith Input Parameters: 850bd481603SBarry Smith + comm - the communicator that will share the eventually allocated matrix 851859fcb39SBarry Smith . nrows - the number of LOCAL rows in the matrix 852859fcb39SBarry Smith - ncols - the number of LOCAL columns in the matrix 853bd481603SBarry Smith 854bd481603SBarry Smith Output Parameters: 855bd481603SBarry Smith + dnz - the array that will be passed to the matrix preallocation routines 856a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 857bd481603SBarry Smith 858bd481603SBarry Smith Level: intermediate 859bd481603SBarry Smith 860bd481603SBarry Smith Notes: 861*d0609cedSBarry Smith This is a macro that handles its own error checking, it does not return an error code. 862*d0609cedSBarry Smith 863a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 864bd481603SBarry Smith 8651d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 866bd481603SBarry Smith 867*d0609cedSBarry Smith Developer Notes: 8681620fd73SBarry Smith This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize(). 8691620fd73SBarry Smith 870*d0609cedSBarry Smith .seealso: MatPreallocateEnd(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(), 871de25e9cbSPierre Jolivet MatPreallocateSymmetricSetLocalBlock() 872bd481603SBarry Smith M*/ 873*d0609cedSBarry Smith #define MatPreallocateBegin(comm,nrows,ncols,dnz,onz) do { \ 8745f80ce2aSJacob Faibussowitsch PetscInt __nrows = (nrows),__ncols = (ncols),__rstart,__start,__end = 0; \ 8759566063dSJacob Faibussowitsch PetscCall(PetscCalloc2(__nrows,&(dnz),__nrows,&(onz))); \ 8769566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&__ncols,&__end,1,MPIU_INT,MPI_SUM,comm)); \ 8775f80ce2aSJacob Faibussowitsch __start = __end - __ncols; (void)__start; \ 8789566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm)); \ 8795f80ce2aSJacob Faibussowitsch __rstart -= __nrows 8807c922b88SBarry Smith 881*d0609cedSBarry Smith #define MatPreallocateInitialize(...) PETSC_DEPRECATED_MACRO("GCC warning \"Use MatPreallocateBegin() (since version 3.18)\"") MatPreallocateBegin(__VA_ARGS__) 882*d0609cedSBarry Smith 883bd481603SBarry Smith /*MC 884bd481603SBarry Smith MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 885bd481603SBarry Smith inserted using a local number of the rows and columns 886bd481603SBarry Smith 887bd481603SBarry Smith Synopsis: 888aaa7dc30SBarry Smith #include <petscmat.h> 889c1ac3661SBarry Smith PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 890bd481603SBarry Smith 891bd481603SBarry Smith Not Collective 892bd481603SBarry Smith 893bd481603SBarry Smith Input Parameters: 894784ac674SJed Brown + map - the row mapping from local numbering to global numbering 895bd481603SBarry Smith . nrows - the number of rows indicated 8961d73ed98SBarry Smith . rows - the indices of the rows 897784ac674SJed Brown . cmap - the column mapping from local to global numbering 898bd481603SBarry Smith . ncols - the number of columns in the matrix 899bd481603SBarry Smith . cols - the columns indicated 900bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 901a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 902bd481603SBarry Smith 903bd481603SBarry Smith Level: intermediate 904bd481603SBarry Smith 905bd481603SBarry Smith Notes: 906a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 907bd481603SBarry Smith 9081d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 909bd481603SBarry Smith 910*d0609cedSBarry Smith .seealso: MatPreallocateEnd(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock() 911*d0609cedSBarry Smith MatPreallocateBegin(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocalRemoveDups() 912bd481603SBarry Smith M*/ 91394bad497SJacob Faibussowitsch #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) \ 91494bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 9159566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApply(rmap,nrows,rows,rows)); \ 9169566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApply(cmap,ncols,cols,cols)); \ 9179566063dSJacob Faibussowitsch for (PetscInt __l=0;__l<nrows;__l++) PetscCall(MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz)); \ 91894bad497SJacob Faibussowitsch ) 919c4f061fbSSatish Balay 920bd481603SBarry Smith /*MC 921c1154cd5SBarry Smith MatPreallocateSetLocalRemoveDups - Indicates the locations (rows and columns) in the matrix where nonzeros will be 922c1154cd5SBarry Smith inserted using a local number of the rows and columns. This version removes any duplicate columns in cols 923c1154cd5SBarry Smith 924c1154cd5SBarry Smith Synopsis: 925c1154cd5SBarry Smith #include <petscmat.h> 926c1154cd5SBarry Smith PetscErrorCode MatPreallocateSetLocalRemoveDups(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 927c1154cd5SBarry Smith 928c1154cd5SBarry Smith Not Collective 929c1154cd5SBarry Smith 930c1154cd5SBarry Smith Input Parameters: 931c1154cd5SBarry Smith + map - the row mapping from local numbering to global numbering 932c1154cd5SBarry Smith . nrows - the number of rows indicated 933c1154cd5SBarry Smith . rows - the indices of the rows (these values are mapped to the global values) 934c1154cd5SBarry Smith . cmap - the column mapping from local to global numbering 935c1154cd5SBarry Smith . ncols - the number of columns in the matrix (this value will be changed if duplicate columns are found) 936c1154cd5SBarry Smith . cols - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed) 937c1154cd5SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 938a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 939c1154cd5SBarry Smith 940c1154cd5SBarry Smith Level: intermediate 941c1154cd5SBarry Smith 942c1154cd5SBarry Smith Notes: 943c1154cd5SBarry Smith See Users-Manual: ch_performance for more details. 944c1154cd5SBarry Smith 945c1154cd5SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 946c1154cd5SBarry Smith 947*d0609cedSBarry Smith .seealso: MatPreallocateEnd(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock() 948*d0609cedSBarry Smith MatPreallocateBegin(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal() 949c1154cd5SBarry Smith M*/ 95094bad497SJacob Faibussowitsch #define MatPreallocateSetLocalRemoveDups(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) \ 95194bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 9529566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApply(rmap,nrows,rows,rows)); \ 9539566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApply(cmap,ncols,cols,cols)); \ 9549566063dSJacob Faibussowitsch PetscCall(PetscSortRemoveDupsInt(&ncols,cols)); \ 9559566063dSJacob Faibussowitsch for (PetscInt __l=0;__l<nrows;__l++) PetscCall(MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz)); \ 95694bad497SJacob Faibussowitsch ) 957c1154cd5SBarry Smith 958c1154cd5SBarry Smith /*MC 959d6e23781SBarry Smith MatPreallocateSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 960bd481603SBarry Smith inserted using a local number of the rows and columns 961bd481603SBarry Smith 962bd481603SBarry Smith Synopsis: 963aaa7dc30SBarry Smith #include <petscmat.h> 964d6e23781SBarry Smith PetscErrorCode MatPreallocateSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 965d6e23781SBarry Smith 966d6e23781SBarry Smith Not Collective 967d6e23781SBarry Smith 968d6e23781SBarry Smith Input Parameters: 969d6e23781SBarry Smith + map - the row mapping from local numbering to global numbering 970d6e23781SBarry Smith . nrows - the number of rows indicated 971d6e23781SBarry Smith . rows - the indices of the rows 972d6e23781SBarry Smith . cmap - the column mapping from local to global numbering 973d6e23781SBarry Smith . ncols - the number of columns in the matrix 974d6e23781SBarry Smith . cols - the columns indicated 975d6e23781SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 976a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 977d6e23781SBarry Smith 978d6e23781SBarry Smith Level: intermediate 979d6e23781SBarry Smith 980d6e23781SBarry Smith Notes: 981d6e23781SBarry Smith See Users-Manual: ch_performance for more details. 982d6e23781SBarry Smith 983d6e23781SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 984d6e23781SBarry Smith 985*d0609cedSBarry Smith .seealso: MatPreallocateEnd(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock() 986*d0609cedSBarry Smith MatPreallocateBegin(), MatPreallocateSymmetricSetLocalBlock() 987d6e23781SBarry Smith M*/ 98894bad497SJacob Faibussowitsch #define MatPreallocateSetLocalBlock(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) \ 98994bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 9909566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApplyBlock(rmap,nrows,rows,rows)); \ 9919566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApplyBlock(cmap,ncols,cols,cols)); \ 9929566063dSJacob Faibussowitsch for (PetscInt __l=0;__l<nrows;__l++) PetscCall(MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz)); \ 99394bad497SJacob Faibussowitsch ) 994d6e23781SBarry Smith 995d6e23781SBarry Smith /*MC 996d6e23781SBarry Smith MatPreallocateSymmetricSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 997d6e23781SBarry Smith inserted using a local number of the rows and columns 998d6e23781SBarry Smith 999d6e23781SBarry Smith Synopsis: 1000d6e23781SBarry Smith #include <petscmat.h> 1001d6e23781SBarry Smith PetscErrorCode MatPreallocateSymmetricSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1002bd481603SBarry Smith 1003bd481603SBarry Smith Not Collective 1004bd481603SBarry Smith 1005bd481603SBarry Smith Input Parameters: 1006bd481603SBarry Smith + map - the mapping between local numbering and global numbering 1007bd481603SBarry Smith . nrows - the number of rows indicated 10081d73ed98SBarry Smith . rows - the indices of the rows 1009bd481603SBarry Smith . ncols - the number of columns in the matrix 1010bd481603SBarry Smith . cols - the columns indicated 1011bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 1012a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 1013bd481603SBarry Smith 1014bd481603SBarry Smith Level: intermediate 1015bd481603SBarry Smith 1016bd481603SBarry Smith Notes: 1017a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 1018bd481603SBarry Smith 1019bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 1020bd481603SBarry Smith 1021*d0609cedSBarry Smith .seealso: MatPreallocateEnd(), MatPreallocateSet() 1022*d0609cedSBarry Smith MatPreallocateBegin(), MatPreallocateSetLocal() 1023bd481603SBarry Smith M*/ 102494bad497SJacob Faibussowitsch #define MatPreallocateSymmetricSetLocalBlock(map,nrows,rows,ncols,cols,dnz,onz) \ 102594bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 10269566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApplyBlock(map,nrows,rows,rows)); \ 10279566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApplyBlock(map,ncols,cols,cols)); \ 10289566063dSJacob Faibussowitsch for (PetscInt __l=0;__l<nrows;__l++) PetscCall(MatPreallocateSymmetricSetBlock((rows)[__l],ncols,cols,dnz,onz)); \ 102994bad497SJacob Faibussowitsch ) 1030e83a5d19SLisandro Dalcin 1031bd481603SBarry Smith /*MC 1032bd481603SBarry Smith MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 1033bd481603SBarry Smith inserted using a local number of the rows and columns 1034bd481603SBarry Smith 1035bd481603SBarry Smith Synopsis: 1036aaa7dc30SBarry Smith #include <petscmat.h> 1037c1ac3661SBarry Smith PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1038bd481603SBarry Smith 1039bd481603SBarry Smith Not Collective 1040bd481603SBarry Smith 1041bd481603SBarry Smith Input Parameters: 104264075487SBarry Smith + row - the row 1043bd481603SBarry Smith . ncols - the number of columns in the matrix 1044a50f8bf6SHong Zhang - cols - the columns indicated 1045a50f8bf6SHong Zhang 1046a50f8bf6SHong Zhang Output Parameters: 1047a50f8bf6SHong Zhang + dnz - the array that will be passed to the matrix preallocation routines 1048a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 1049bd481603SBarry Smith 1050bd481603SBarry Smith Level: intermediate 1051bd481603SBarry Smith 1052bd481603SBarry Smith Notes: 1053a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 1054bd481603SBarry Smith 1055bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 1056bd481603SBarry Smith 1057*d0609cedSBarry Smith This is a MACRO not a function because it uses variables declared in MatPreallocateBegin(). 10581620fd73SBarry Smith 1059*d0609cedSBarry Smith .seealso: MatPreallocateEnd(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock() 1060*d0609cedSBarry Smith MatPreallocateBegin(), MatPreallocateSetLocal() 1061bd481603SBarry Smith M*/ 106294bad497SJacob Faibussowitsch #define MatPreallocateSet(row,nc,cols,dnz,onz) PetscMacroReturnStandard( \ 10632c71b3e2SJacob 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); \ 10642c71b3e2SJacob 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); \ 10655f80ce2aSJacob Faibussowitsch for (PetscInt __i = 0; __i < nc; ++__i) { \ 106664075487SBarry Smith if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \ 1067a6042fd4SStefano Zampini else if (dnz[row - __rstart] < __ncols) dnz[row - __rstart]++; \ 10687c922b88SBarry Smith } \ 106994bad497SJacob Faibussowitsch ) 10707c922b88SBarry Smith 1071bd481603SBarry Smith /*MC 1072d6e23781SBarry Smith MatPreallocateSymmetricSetBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 1073bd481603SBarry Smith inserted using a local number of the rows and columns 1074bd481603SBarry Smith 1075bd481603SBarry Smith Synopsis: 1076aaa7dc30SBarry Smith #include <petscmat.h> 1077d6e23781SBarry Smith PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1078bd481603SBarry Smith 1079bd481603SBarry Smith Not Collective 1080bd481603SBarry Smith 1081bd481603SBarry Smith Input Parameters: 1082bd481603SBarry Smith + nrows - the number of rows indicated 10831d73ed98SBarry Smith . rows - the indices of the rows 1084bd481603SBarry Smith . ncols - the number of columns in the matrix 1085bd481603SBarry Smith . cols - the columns indicated 1086bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 1087a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 1088bd481603SBarry Smith 1089bd481603SBarry Smith Level: intermediate 1090bd481603SBarry Smith 1091bd481603SBarry Smith Notes: 1092a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 1093bd481603SBarry Smith 1094bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 1095bd481603SBarry Smith 1096*d0609cedSBarry Smith This is a MACRO not a function because it uses variables declared in MatPreallocateBegin(). 10971620fd73SBarry Smith 1098*d0609cedSBarry Smith .seealso: MatPreallocateEnd(), MatPreallocateSet(), MatPreallocateBegin(), 1099a6042fd4SStefano Zampini MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal() 1100bd481603SBarry Smith M*/ 110194bad497SJacob Faibussowitsch #define MatPreallocateSymmetricSetBlock(row,nc,cols,dnz,onz) \ 110294bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 11035f80ce2aSJacob Faibussowitsch for (PetscInt __i=0; __i<nc; __i++) { \ 1104d3d32019SBarry Smith if (cols[__i] >= __end) onz[row - __rstart]++; \ 1105a6042fd4SStefano Zampini else if (cols[__i] >= row && dnz[row - __rstart] < __ncols) dnz[row - __rstart]++; \ 1106d3d32019SBarry Smith } \ 110794bad497SJacob Faibussowitsch ) 1108d3d32019SBarry Smith 1109bd481603SBarry Smith /*MC 1110a6042fd4SStefano Zampini MatPreallocateLocation - An alternative to MatPreallocateSet() that puts the nonzero locations into the matrix if it exists 111116371a99SBarry Smith 111216371a99SBarry Smith Synopsis: 1113aaa7dc30SBarry Smith #include <petscmat.h> 111416371a99SBarry Smith PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz) 111516371a99SBarry Smith 111616371a99SBarry Smith Not Collective 111716371a99SBarry Smith 111816371a99SBarry Smith Input Parameters: 1119a2b725a8SWilliam Gropp + A - matrix 112016371a99SBarry Smith . row - row where values exist (must be local to this process) 112116371a99SBarry Smith . ncols - number of columns 112216371a99SBarry Smith . cols - columns with nonzeros 112316371a99SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 1124a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 112516371a99SBarry Smith 112616371a99SBarry Smith Level: intermediate 112716371a99SBarry Smith 112816371a99SBarry Smith Notes: 1129a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 113016371a99SBarry Smith 113116371a99SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 113216371a99SBarry Smith 113316371a99SBarry Smith This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines. 113416371a99SBarry Smith 1135*d0609cedSBarry Smith .seealso: MatPreallocateBegin(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(), 1136d6e23781SBarry Smith MatPreallocateSymmetricSetLocalBlock() 113716371a99SBarry Smith M*/ 1138*d0609cedSBarry 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)) 113916371a99SBarry Smith 114016371a99SBarry Smith /*MC 1141*d0609cedSBarry Smith MatPreallocateEnd - Ends the block of code that will count the number of nonzeros per 1142bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 1143bd481603SBarry Smith 1144bd481603SBarry Smith Synopsis: 1145aaa7dc30SBarry Smith #include <petscmat.h> 1146*d0609cedSBarry Smith PetscErrorCode MatPreallocateEnd(PetscInt *dnz, PetscInt *onz) 1147bd481603SBarry Smith 1148d083f849SBarry Smith Collective 1149bd481603SBarry Smith 1150bd481603SBarry Smith Input Parameters: 115116371a99SBarry Smith + dnz - the array that was be passed to the matrix preallocation routines 1152a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 1153bd481603SBarry Smith 1154bd481603SBarry Smith Level: intermediate 1155bd481603SBarry Smith 1156bd481603SBarry Smith Notes: 1157*d0609cedSBarry Smith This is a macro that handles its own error checking, it does not return an error code. 1158*d0609cedSBarry Smith 1159a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 1160bd481603SBarry Smith 1161*d0609cedSBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 1162bd481603SBarry Smith 1163*d0609cedSBarry Smith Developer Notes: 1164*d0609cedSBarry Smith This is a MACRO not a function because it closes the { started in MatPreallocateBegin(). 11651620fd73SBarry Smith 1166*d0609cedSBarry Smith .seealso: MatPreallocateBegin(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(), 1167d6e23781SBarry Smith MatPreallocateSymmetricSetLocalBlock() 1168bd481603SBarry Smith M*/ 1169*d0609cedSBarry Smith #define MatPreallocateEnd(dnz,onz) PetscCall(PetscFree2(dnz,onz));} while (0) 1170*d0609cedSBarry Smith 1171*d0609cedSBarry Smith #define MatPreallocateFinalize(...) PETSC_DEPRECATED_MACRO("GCC warning \"Use MatPreallocateEnd() (since version 3.18)\"") MatPreallocateEnd(__VA_ARGS__) 11727c922b88SBarry Smith 11737b80b807SBarry Smith /* Routines unique to particular data structures */ 1174014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat,void *); 1175698d4c6aSKris Buschelman 1176014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*); 1177014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *); 1178698d4c6aSKris Buschelman 1179014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]); 1180014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]); 1181014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1182014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1183014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1184014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool); 11857b80b807SBarry Smith 1186a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4 1187a96a251dSBarry Smith 1188014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1189014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1190014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]); 119119b08ed1SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJSetTotalPreallocation(Mat,PetscInt); 1192273d9f13SBarry Smith 1193014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1194014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1195014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1196014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []); 1197014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 1198014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]); 1199014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 1200014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]); 1201b44e7856SBarry Smith PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat,Mat*); 1202014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]); 1203014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]); 12049230625dSJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]); 12059230625dSJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]); 1206014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*); 1207273d9f13SBarry Smith 120849a6ff4bSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetLDA(Mat,PetscInt*); 1209ad16ce7aSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseSetLDA(Mat,PetscInt); 12109fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatDenseSetLDA() (since version 3.14)") static inline PetscErrorCode MatSeqDenseSetLDA(Mat A,PetscInt lda) {return MatDenseSetLDA(A,lda);} 1211014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*); 12121b807ce4Svictorle 1213621e819fSSatish Balay PETSC_EXTERN PetscErrorCode MatBlockMatSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1214621e819fSSatish Balay 1215014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStoreValues(Mat); 1216014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat); 12172e8a6d31SBarry Smith 1218014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*); 12197cfe41e4SPatrick Farrell PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat,IS*); 12207b80b807SBarry Smith /* 12217b80b807SBarry Smith These routines are not usually accessed directly, rather solving is 122294b7f48cSBarry Smith done through the KSP and PC interfaces. 12237b80b807SBarry Smith */ 12247b80b807SBarry Smith 122576bdecfbSBarry Smith /*J 12268f6c3df8SBarry Smith MatOrderingType - String with the name of a PETSc matrix ordering 1227d9274352SBarry Smith 1228d9274352SBarry Smith Level: beginner 1229d9274352SBarry Smith 12302c7c0729SBarry Smith Notes: 12312c7c0729SBarry Smith If MATORDERINGEXTERNAL is used then PETSc does not compute an ordering and utilizes one built into the factorization package 12322c7c0729SBarry Smith 1233d9274352SBarry Smith .seealso: MatGetOrdering() 123476bdecfbSBarry Smith J*/ 123519fd82e9SBarry Smith typedef const char* MatOrderingType; 12362692d6eeSBarry Smith #define MATORDERINGNATURAL "natural" 12372692d6eeSBarry Smith #define MATORDERINGND "nd" 12382692d6eeSBarry Smith #define MATORDERING1WD "1wd" 12392692d6eeSBarry Smith #define MATORDERINGRCM "rcm" 12402692d6eeSBarry Smith #define MATORDERINGQMD "qmd" 12412692d6eeSBarry Smith #define MATORDERINGROWLENGTH "rowlength" 1242510184a7SJed Brown #define MATORDERINGWBM "wbm" 1243fc1bef75SJed Brown #define MATORDERINGSPECTRAL "spectral" 1244312e372aSBarry Smith #define MATORDERINGAMD "amd" /* only works if UMFPACK is installed with PETSc */ 1245048412efSPablo Brubeck #define MATORDERINGMETISND "metisnd" /* only works if METIS is installed with PETSc */ 12469bd791bbSBarry 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 */ 12472c7c0729SBarry Smith #define MATORDERINGEXTERNAL "external" /* uses an ordering type internal to the factorization package */ 1248b12f92e5SBarry Smith 124919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*); 1250140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*); 1251bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*)); 1252140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatOrderingList; 1253d4fbbf0eSBarry Smith 1254014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS); 1255fc1bef75SJed Brown PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*); 1256a2ce50c7SBarry Smith 12574ac6704cSBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetPreferredOrdering(Mat,MatFactorType,MatOrderingType*); 12584ac6704cSBarry Smith 1259d91e6319SBarry Smith /*S 1260ec5066bdSBarry Smith MatFactorShiftType - Numeric Shift for factorizations 1261d90ac83dSHong Zhang 1262d90ac83dSHong Zhang Level: beginner 1263d90ac83dSHong Zhang 1264ec5066bdSBarry Smith .seealso: MatGetFactor() 1265d90ac83dSHong Zhang S*/ 1266d90ac83dSHong Zhang typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType; 12676a6fc655SJed Brown PETSC_EXTERN const char *const MatFactorShiftTypes[]; 12685e9742b9SJed Brown PETSC_EXTERN const char *const MatFactorShiftTypesDetail[]; 1269d90ac83dSHong Zhang 1270d90ac83dSHong Zhang /*S 1271ec5066bdSBarry Smith MatFactorError - indicates what type of error was generated in a matrix factorization 12729aa7eafdSHong Zhang 12739aa7eafdSHong Zhang Level: beginner 12749aa7eafdSHong Zhang 127595452b02SPatrick Sanan Developer Notes: 127695452b02SPatrick Sanan Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 127700e125f8SBarry Smith 127800e125f8SBarry Smith .seealso: MatGetFactor() 12799aa7eafdSHong Zhang S*/ 12805cd7cf9dSHong Zhang typedef enum {MAT_FACTOR_NOERROR,MAT_FACTOR_STRUCT_ZEROPIVOT,MAT_FACTOR_NUMERIC_ZEROPIVOT,MAT_FACTOR_OUTMEMORY,MAT_FACTOR_OTHER} MatFactorError; 12819aa7eafdSHong Zhang 128200e125f8SBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat,MatFactorError*); 1283b8b68cfdSBarry Smith PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat); 12847b6c816cSBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat,PetscReal*,PetscInt*); 128500e125f8SBarry Smith 12869aa7eafdSHong Zhang /*S 1287422a814eSBarry Smith MatFactorInfo - Data passed into the matrix factorization routines, and information about the resulting factorization 1288b00f7748SHong Zhang 128961cad860SBarry Smith In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use 129061cad860SBarry Smith $ MatFactorInfo info(MAT_FACTORINFO_SIZE) 1291b00f7748SHong Zhang 129295452b02SPatrick Sanan Notes: 129395452b02SPatrick Sanan These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC. 1294b00f7748SHong Zhang 129561cad860SBarry Smith You can use MatFactorInfoInitialize() to set default values. 129661cad860SBarry Smith 1297b00f7748SHong Zhang Level: developer 1298b00f7748SHong Zhang 1299d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(), 1300d7d82daaSBarry Smith MatFactorInfoInitialize() 1301b00f7748SHong Zhang 1302b00f7748SHong Zhang S*/ 1303b00f7748SHong Zhang typedef struct { 130415e8a5b3SHong Zhang PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 130585317021SBarry Smith PetscReal usedt; 130615e8a5b3SHong Zhang PetscReal dt; /* drop tolerance */ 1307b00f7748SHong Zhang PetscReal dtcol; /* tolerance for pivoting */ 130815e8a5b3SHong Zhang PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 130967e28bfeSBarry Smith PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */ 1310348344bbSBarry Smith PetscReal levels; /* ICC/ILU(levels) */ 1311bcd9e38bSBarry Smith PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 1312bcd9e38bSBarry Smith factorization may be faster if do not pivot */ 131315e8a5b3SHong Zhang PetscReal zeropivot; /* pivot is called zero if less than this */ 1314f4db908eSBarry Smith PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */ 1315f4db908eSBarry Smith PetscReal shiftamount; /* how large the shift is */ 131615e8a5b3SHong Zhang } MatFactorInfo; 1317ffa6d0a5SLois Curfman McInnes 1318014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*); 13199a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*); 13209a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 13219a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*); 13229a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*); 13239a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*); 13249a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 13259a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 13269a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 13279a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*); 13289a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*); 13293f498edaSToby Isaac PETSC_EXTERN PetscErrorCode MatQRFactor(Mat,IS,const MatFactorInfo*); 13303f498edaSToby Isaac PETSC_EXTERN PetscErrorCode MatQRFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 13313f498edaSToby Isaac PETSC_EXTERN PetscErrorCode MatQRFactorNumeric(Mat,Mat,const MatFactorInfo*); 1332014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*); 1333014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec); 1334014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec); 1335014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec); 1336014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec); 1337014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec); 1338014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec); 1339014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs); 13407c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat); 13417c2f51b8SStefano Zampini 13427c2f51b8SStefano Zampini typedef enum {MAT_FACTOR_SCHUR_UNFACTORED, MAT_FACTOR_SCHUR_FACTORED, MAT_FACTOR_SCHUR_INVERTED} MatFactorSchurStatus; 13438e7ba810SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat,IS); 13447c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat,Mat*,MatFactorSchurStatus*); 13457c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat,Mat*,MatFactorSchurStatus); 13465a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat); 13477c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat,Mat*,MatFactorSchurStatus*); 13485a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat,Vec,Vec); 13495a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat,Vec,Vec); 13506dba178dSStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat); 1351bb5a7306SBarry Smith 1352d91e6319SBarry Smith /*E 1353d91e6319SBarry Smith MatSORType - What type of (S)SOR to perform 1354bb1eb677SSatish Balay 1355d91e6319SBarry Smith Level: beginner 1356d91e6319SBarry Smith 1357d9274352SBarry Smith May be bitwise ORd together 1358d9274352SBarry Smith 1359af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 1360d91e6319SBarry Smith 13614e7234bfSBarry Smith MatSORType may be bitwise ORd together, so do not change the numbers 13624e7234bfSBarry Smith 136341f059aeSBarry Smith .seealso: MatSOR() 1364d91e6319SBarry Smith E*/ 1365ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 1366ee50ffe9SBarry Smith SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 1367ee50ffe9SBarry Smith SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 136884cb2905SBarry Smith SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType; 1369014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 13708ed539a5SBarry Smith 1371d4fbbf0eSBarry Smith /* 1372639f9d9dSBarry Smith These routines are for efficiently computing Jacobians via finite differences. 1373639f9d9dSBarry Smith */ 1374b12f92e5SBarry Smith 13757086a01eSPeter Brune /*S 13767086a01eSPeter Brune MatColoring - Object for managing the coloring of matrices. 13777086a01eSPeter Brune 13787086a01eSPeter Brune Level: beginner 13797086a01eSPeter Brune 1380ec5066bdSBarry Smith Notes: 1381ec5066bdSBarry 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 1382ec5066bdSBarry Smith matrix comes from via DMCreateColoring(). In general using the mesh produces a more optimal coloring (fewer colors). 1383ec5066bdSBarry Smith 1384ec5066bdSBarry Smith Once a coloring is available MatFDColoringCreate() creates an object that can be used to efficiently compute Jacobians using that coloring. This 1385ec5066bdSBarry Smith same object can also be used to efficiently convert data created by Automatic Differentation tools to PETSc sparse matrices. 1386ec5066bdSBarry Smith 13873d1c4b3aSPatrick Sanan .seealso: MatFDColoringCreate(), MatColoringWeightType, ISColoring, MatFDColoring, DMCreateColoring(), MatColoringCreate(), MatOrdering, MatPartitioning, MatColoringType 13887086a01eSPeter Brune S*/ 1389d4db15c4SBarry Smith typedef struct _p_MatColoring* MatColoring; 1390d4db15c4SBarry Smith 1391d4db15c4SBarry Smith /*J 1392d4db15c4SBarry Smith MatColoringType - String with the name of a PETSc matrix coloring 1393d9274352SBarry Smith 1394d9274352SBarry Smith Level: beginner 1395d9274352SBarry Smith 13967086a01eSPeter Brune .seealso: MatColoringSetType(), MatColoring 139776bdecfbSBarry Smith J*/ 139819fd82e9SBarry Smith typedef const char* MatColoringType; 13995567d71aSPeter Brune #define MATCOLORINGJP "jp" 1400b9acb617SPeter Brune #define MATCOLORINGPOWER "power" 14012692d6eeSBarry Smith #define MATCOLORINGNATURAL "natural" 14022692d6eeSBarry Smith #define MATCOLORINGSL "sl" 14032692d6eeSBarry Smith #define MATCOLORINGLF "lf" 14042692d6eeSBarry Smith #define MATCOLORINGID "id" 14058121bdceSPeter Brune #define MATCOLORINGGREEDY "greedy" 1406b12f92e5SBarry Smith 14078ac6da0aSPeter Brune /*E 14088ac6da0aSPeter Brune MatColoringWeightType - Type of weight scheme 14098ac6da0aSPeter Brune 14108ac6da0aSPeter Brune Not Collective 14118ac6da0aSPeter Brune 14128ac6da0aSPeter Brune + MAT_COLORING_RANDOM - Random weights 14138ac6da0aSPeter Brune . MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering. 14148ac6da0aSPeter Brune - MAT_COLORING_LF - Last-first weighting. 14158ac6da0aSPeter Brune 14168ac6da0aSPeter Brune Level: intermediate 14178ac6da0aSPeter Brune 1418af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 1419ec5066bdSBarry Smith 1420ec5066bdSBarry Smith .seealso: MatColoring, MatColoringCreate() 14218ac6da0aSPeter Brune E*/ 1422301c140bSPeter Brune typedef enum {MAT_COLORING_WEIGHT_RANDOM,MAT_COLORING_WEIGHT_LEXICAL,MAT_COLORING_WEIGHT_LF,MAT_COLORING_WEIGHT_SL} MatColoringWeightType; 14238ac6da0aSPeter Brune 1424335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*); 1425d7f2a307SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*); 1426335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*); 1427335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer); 1428335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType); 1429335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring); 1430335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt); 1431335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*); 1432335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt); 1433335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*); 1434335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*); 1435335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring)); 1436014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*); 14378ac6da0aSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType); 1438c29971fcSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*); 14398ac6da0aSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm); 1440bc76d17bSHong Zhang PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring,ISColoring); 14419fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatColoringTest() (since version 3.10)") static inline PetscErrorCode MatColoringTestValid(MatColoring matcoloring,ISColoring iscoloring) {return MatColoringTest(matcoloring,iscoloring);} 1442bc76d17bSHong Zhang PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat,ISColoring); 1443639f9d9dSBarry Smith 1444d9274352SBarry Smith /*S 1445d9274352SBarry Smith MatFDColoring - Object for computing a sparse Jacobian via finite differences 1446d9274352SBarry Smith and coloring 1447639f9d9dSBarry Smith 1448d9274352SBarry Smith Level: beginner 1449d9274352SBarry Smith 1450ec5066bdSBarry Smith Notes: 1451ec5066bdSBarry Smith This object is creating utilizing a coloring provided by the MatColoring object or DMCreateColoring() 1452ec5066bdSBarry Smith 1453ec5066bdSBarry Smith .seealso: MatFDColoringCreate(), MatColoring, DMCreateColoring() 1454d9274352SBarry Smith S*/ 1455e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring; 1456639f9d9dSBarry Smith 1457014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *); 1458014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*); 1459014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer); 1460014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*); 1461014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**); 1462014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal); 1463014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring); 1464d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *); 1465014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec); 1466edaa7c33SBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,const PetscInt*[]); 1467f86b9fbaSHong Zhang PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring); 1468f86b9fbaSHong Zhang PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt); 1469bdaf1daeSBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringSetValues(Mat,MatFDColoring,const PetscScalar*); 1470b1683b59SHong Zhang 1471b1683b59SHong Zhang /*S 1472b9af6bddSHong Zhang MatTransposeColoring - Object for computing a sparse matrix product C=A*B^T via coloring 1473b1683b59SHong Zhang 1474b1683b59SHong Zhang Level: beginner 1475b1683b59SHong Zhang 1476b9af6bddSHong Zhang .seealso: MatTransposeColoringCreate() 1477b1683b59SHong Zhang S*/ 1478b9af6bddSHong Zhang typedef struct _p_MatTransposeColoring* MatTransposeColoring; 1479b1683b59SHong Zhang 1480014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *); 1481014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat); 1482014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat); 1483014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*); 1484b1683b59SHong Zhang 1485639f9d9dSBarry Smith /* 14860752156aSBarry Smith These routines are for partitioning matrices: currently used only 14873eda8832SBarry Smith for adjacency matrix, MatCreateMPIAdj(). 14880752156aSBarry Smith */ 1489ca161407SBarry Smith 1490d9274352SBarry Smith /*S 1491d9274352SBarry Smith MatPartitioning - Object for managing the partitioning of a matrix or graph 1492d9274352SBarry Smith 1493d9274352SBarry Smith Level: beginner 1494d9274352SBarry Smith 1495ec5066bdSBarry Smith Notes: 1496ec5066bdSBarry Smith There is also a PetscPartitioner object that provides the same functionality. It can utilize the MatPartitioning operations 1497ec5066bdSBarry Smith via PetscPartitionerSetType(p,PETSCPARTITIONERMATPARTITIONING) 1498ec5066bdSBarry Smith 1499ec5066bdSBarry Smith Developers Note: 1500ec5066bdSBarry Smith It is an extra maintainance and documentation cost to have two objects with the same functionality. 1501ec5066bdSBarry Smith 1502ec5066bdSBarry Smith .seealso: MatPartitioningCreate(), MatPartitioningType, MatColoring, MatGetOrdering() 1503d9274352SBarry Smith S*/ 150491e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning; 1505d9274352SBarry Smith 150676bdecfbSBarry Smith /*J 15078f6c3df8SBarry Smith MatPartitioningType - String with the name of a PETSc matrix partitioning 1508d9274352SBarry Smith 1509d9274352SBarry Smith Level: beginner 15100d04baf8SBarry Smith dm 1511b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning 151276bdecfbSBarry Smith J*/ 151319fd82e9SBarry Smith typedef const char* MatPartitioningType; 15142692d6eeSBarry Smith #define MATPARTITIONINGCURRENT "current" 1515aa1e27eaSFande Kong #define MATPARTITIONINGAVERAGE "average" 15162692d6eeSBarry Smith #define MATPARTITIONINGSQUARE "square" 15172692d6eeSBarry Smith #define MATPARTITIONINGPARMETIS "parmetis" 15182692d6eeSBarry Smith #define MATPARTITIONINGCHACO "chaco" 15192692d6eeSBarry Smith #define MATPARTITIONINGPARTY "party" 152050d91057SBarry Smith #define MATPARTITIONINGPTSCOTCH "ptscotch" 152188d2ac2bSFande Kong #define MATPARTITIONINGHIERARCH "hierarch" 152271306c60Sjroman 1523014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*); 152419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType); 1525014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt); 1526014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat); 1527014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]); 1528014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []); 1529ebf67979SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningSetUseEdgeWeights(MatPartitioning,PetscBool); 1530ebf67979SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningGetUseEdgeWeights(MatPartitioning,PetscBool*); 1531014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*); 1532fdd1c351SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningImprove(MatPartitioning,IS*); 1533668144dbSFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningViewImbalance(MatPartitioning,IS); 1534f3ad2dabSStefano Zampini PETSC_EXTERN PetscErrorCode MatPartitioningApplyND(MatPartitioning,IS*); 1535014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*); 1536bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[],PetscErrorCode (*)(MatPartitioning)); 1537014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer); 1538fe2efc57SMark PETSC_EXTERN PetscErrorCode MatPartitioningViewFromOptions(MatPartitioning,PetscObject,const char[]); 1539014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning); 154019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*); 1541ca161407SBarry Smith 154227538973SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part); 1543014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 1544014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *); 15450752156aSBarry Smith 1546b6956c12SJose Roman typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType; 15476a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoGlobalTypes[]; 1548b6956c12SJose Roman typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType; 15496a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoLocalTypes[]; 1550b6956c12SJose Roman typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType; 15516a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoEigenTypes[]; 1552b6956c12SJose Roman 1553014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType); 1554014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*); 1555014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType); 1556014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*); 1557014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal); 1558014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType); 1559014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*); 1560014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal); 1561014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*); 1562014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt); 1563014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*); 156471306c60Sjroman 156571306c60Sjroman #define MP_PARTY_OPT "opt" 156671306c60Sjroman #define MP_PARTY_LIN "lin" 156771306c60Sjroman #define MP_PARTY_SCA "sca" 156871306c60Sjroman #define MP_PARTY_RAN "ran" 156971306c60Sjroman #define MP_PARTY_GBF "gbf" 157071306c60Sjroman #define MP_PARTY_GCF "gcf" 157171306c60Sjroman #define MP_PARTY_BUB "bub" 157271306c60Sjroman #define MP_PARTY_DEF "def" 1573014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*); 157471306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs" 157571306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl" 157671306c60Sjroman #define MP_PARTY_NONE "no" 1577014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*); 1578014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal); 1579014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool); 1580014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool); 158171306c60Sjroman 1582b0ca845eSVaclav Hapla typedef enum { MP_PTSCOTCH_DEFAULT,MP_PTSCOTCH_QUALITY,MP_PTSCOTCH_SPEED,MP_PTSCOTCH_BALANCE,MP_PTSCOTCH_SAFETY,MP_PTSCOTCH_SCALABILITY } MPPTScotchStrategyType; 15836a6fc655SJed Brown PETSC_EXTERN const char *const MPPTScotchStrategyTypes[]; 1584e0f1cffaSJose Roman 1585014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal); 1586014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*); 1587014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType); 1588014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*); 158971306c60Sjroman 1590b43b03e9SMark F. Adams /* 15916294fa2bSFande Kong * hierarchical partitioning 15926294fa2bSFande Kong */ 15934e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning,IS*); 15944e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning,IS*); 15954e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning,PetscInt); 15964e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt); 15976294fa2bSFande Kong 1598014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*); 1599014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*); 1600591294e4SBarry Smith 16010752156aSBarry Smith /* 1602c786d857SStefano Zampini If you add entries here you must also add them to src/mat/f90-mod/petscmat.h 1603c786d857SStefano Zampini If any of the enum values are changed, also update dMatOps dict at src/binding/petsc4py/src/libpetsc4py/libpetsc4py.pyx 1604d4fbbf0eSBarry Smith */ 16051c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0, 16061c1c02c0SLois Curfman McInnes MATOP_GET_ROW=1, 16071c1c02c0SLois Curfman McInnes MATOP_RESTORE_ROW=2, 16081c1c02c0SLois Curfman McInnes MATOP_MULT=3, 16091c1c02c0SLois Curfman McInnes MATOP_MULT_ADD=4, 16107c922b88SBarry Smith MATOP_MULT_TRANSPOSE=5, 16117c922b88SBarry Smith MATOP_MULT_TRANSPOSE_ADD=6, 16121c1c02c0SLois Curfman McInnes MATOP_SOLVE=7, 16131c1c02c0SLois Curfman McInnes MATOP_SOLVE_ADD=8, 16147c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE=9, 16157c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE_ADD=10, 16161c1c02c0SLois Curfman McInnes MATOP_LUFACTOR=11, 16171c1c02c0SLois Curfman McInnes MATOP_CHOLESKYFACTOR=12, 1618a714c06dSBarry Smith MATOP_SOR=13, 16191c1c02c0SLois Curfman McInnes MATOP_TRANSPOSE=14, 16201c1c02c0SLois Curfman McInnes MATOP_GETINFO=15, 16211c1c02c0SLois Curfman McInnes MATOP_EQUAL=16, 16221c1c02c0SLois Curfman McInnes MATOP_GET_DIAGONAL=17, 16231c1c02c0SLois Curfman McInnes MATOP_DIAGONAL_SCALE=18, 16241c1c02c0SLois Curfman McInnes MATOP_NORM=19, 16251c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_BEGIN=20, 16261c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_END=21, 1627d519adbfSMatthew Knepley MATOP_SET_OPTION=22, 1628d519adbfSMatthew Knepley MATOP_ZERO_ENTRIES=23, 1629d519adbfSMatthew Knepley MATOP_ZERO_ROWS=24, 1630d519adbfSMatthew Knepley MATOP_LUFACTOR_SYMBOLIC=25, 1631d519adbfSMatthew Knepley MATOP_LUFACTOR_NUMERIC=26, 1632d519adbfSMatthew Knepley MATOP_CHOLESKY_FACTOR_SYMBOLIC=27, 1633d519adbfSMatthew Knepley MATOP_CHOLESKY_FACTOR_NUMERIC=28, 1634d519adbfSMatthew Knepley MATOP_SETUP_PREALLOCATION=29, 1635d519adbfSMatthew Knepley MATOP_ILUFACTOR_SYMBOLIC=30, 1636d519adbfSMatthew Knepley MATOP_ICCFACTOR_SYMBOLIC=31, 1637a5b7ff6bSBarry Smith MATOP_GET_DIAGONAL_BLOCK=32, 1638dd4011a9SHong Zhang MATOP_FREE_INTER_STRUCT=33, 1639d519adbfSMatthew Knepley MATOP_DUPLICATE=34, 1640d519adbfSMatthew Knepley MATOP_FORWARD_SOLVE=35, 1641d519adbfSMatthew Knepley MATOP_BACKWARD_SOLVE=36, 1642d519adbfSMatthew Knepley MATOP_ILUFACTOR=37, 1643d519adbfSMatthew Knepley MATOP_ICCFACTOR=38, 1644d519adbfSMatthew Knepley MATOP_AXPY=39, 16457dae84e0SHong Zhang MATOP_CREATE_SUBMATRICES=40, 1646d519adbfSMatthew Knepley MATOP_INCREASE_OVERLAP=41, 1647d519adbfSMatthew Knepley MATOP_GET_VALUES=42, 1648d519adbfSMatthew Knepley MATOP_COPY=43, 1649d519adbfSMatthew Knepley MATOP_GET_ROW_MAX=44, 1650d519adbfSMatthew Knepley MATOP_SCALE=45, 1651d519adbfSMatthew Knepley MATOP_SHIFT=46, 165235153367SBarry Smith MATOP_DIAGONAL_SET=47, 16539d39f69dSJed Brown MATOP_ZERO_ROWS_COLUMNS=48, 16549d39f69dSJed Brown MATOP_SET_RANDOM=49, 1655d519adbfSMatthew Knepley MATOP_GET_ROW_IJ=50, 1656d519adbfSMatthew Knepley MATOP_RESTORE_ROW_IJ=51, 1657d519adbfSMatthew Knepley MATOP_GET_COLUMN_IJ=52, 1658d519adbfSMatthew Knepley MATOP_RESTORE_COLUMN_IJ=53, 1659d519adbfSMatthew Knepley MATOP_FDCOLORING_CREATE=54, 1660d519adbfSMatthew Knepley MATOP_COLORING_PATCH=55, 1661d519adbfSMatthew Knepley MATOP_SET_UNFACTORED=56, 1662d519adbfSMatthew Knepley MATOP_PERMUTE=57, 1663d519adbfSMatthew Knepley MATOP_SET_VALUES_BLOCKED=58, 16647dae84e0SHong Zhang MATOP_CREATE_SUBMATRIX=59, 1665d519adbfSMatthew Knepley MATOP_DESTROY=60, 1666d519adbfSMatthew Knepley MATOP_VIEW=61, 1667d519adbfSMatthew Knepley MATOP_CONVERT_FROM=62, 16687bab7c10SHong Zhang MATOP_MATMAT_MULT=63, 16697bab7c10SHong Zhang MATOP_MATMAT_MULT_SYMBOLIC=64, 16707bab7c10SHong Zhang MATOP_MATMAT_MULT_NUMERIC=65, 1671d519adbfSMatthew Knepley MATOP_SET_LOCAL_TO_GLOBAL_MAP=66, 1672d519adbfSMatthew Knepley MATOP_SET_VALUES_LOCAL=67, 1673d519adbfSMatthew Knepley MATOP_ZERO_ROWS_LOCAL=68, 1674d519adbfSMatthew Knepley MATOP_GET_ROW_MAX_ABS=69, 1675d519adbfSMatthew Knepley MATOP_GET_ROW_MIN_ABS=70, 1676d519adbfSMatthew Knepley MATOP_CONVERT=71, 1677d519adbfSMatthew Knepley MATOP_SET_COLORING=72, 16789d39f69dSJed Brown /* MATOP_PLACEHOLDER_73=73, */ 1679d519adbfSMatthew Knepley MATOP_SET_VALUES_ADIFOR=74, 1680d519adbfSMatthew Knepley MATOP_FD_COLORING_APPLY=75, 1681d519adbfSMatthew Knepley MATOP_SET_FROM_OPTIONS=76, 1682bda6c4cbSBarry Smith MATOP_MULT_CONSTRAINED=77, 1683bda6c4cbSBarry Smith MATOP_MULT_TRANSPOSE_CONSTRAIN=78, 16849d39f69dSJed Brown MATOP_FIND_ZERO_DIAGONALS=79, 1685d519adbfSMatthew Knepley MATOP_MULT_MULTIPLE=80, 1686d519adbfSMatthew Knepley MATOP_SOLVE_MULTIPLE=81, 1687d519adbfSMatthew Knepley MATOP_GET_INERTIA=82, 1688d519adbfSMatthew Knepley MATOP_LOAD=83, 1689d519adbfSMatthew Knepley MATOP_IS_SYMMETRIC=84, 1690d519adbfSMatthew Knepley MATOP_IS_HERMITIAN=85, 1691d519adbfSMatthew Knepley MATOP_IS_STRUCTURALLY_SYMMETRIC=86, 1692820469bcSHong Zhang MATOP_SET_VALUES_BLOCKEDLOCAL=87, 1693b41ce5d5SBarry Smith MATOP_CREATE_VECS=88, 1694d519adbfSMatthew Knepley MATOP_MAT_MULT=89, 1695d519adbfSMatthew Knepley MATOP_MAT_MULT_SYMBOLIC=90, 1696d519adbfSMatthew Knepley MATOP_MAT_MULT_NUMERIC=91, 1697d519adbfSMatthew Knepley MATOP_PTAP=92, 1698d519adbfSMatthew Knepley MATOP_PTAP_SYMBOLIC=93, 1699d519adbfSMatthew Knepley MATOP_PTAP_NUMERIC=94, 1700bda6c4cbSBarry Smith MATOP_MAT_TRANSPOSE_MULT=95, 1701bda6c4cbSBarry Smith MATOP_MAT_TRANSPOSE_MULT_SYMBO=96, 1702bda6c4cbSBarry Smith MATOP_MAT_TRANSPOSE_MULT_NUMER=97, 17039d39f69dSJed Brown /* MATOP_PLACEHOLDER_98=98, */ 17047a3c3d58SStefano Zampini MATOP_PRODUCTSETFROMOPTIONS=99, 17057a3c3d58SStefano Zampini MATOP_PRODUCTSYMBOLIC=100, 17067a3c3d58SStefano Zampini MATOP_PRODUCTNUMERIC=101, 1707d519adbfSMatthew Knepley MATOP_CONJUGATE=102, 17089d39f69dSJed Brown /* MATOP_PLACEHOLDER_103=103, */ 1709d519adbfSMatthew Knepley MATOP_SET_VALUES_ROW=104, 1710d519adbfSMatthew Knepley MATOP_REAL_PART=105, 1711bda6c4cbSBarry Smith MATOP_IMAGINARY_PART=106, 1712bda6c4cbSBarry Smith MATOP_GET_ROW_UPPER_TRIANGULAR=107, 1713bda6c4cbSBarry Smith MATOP_RESTORE_ROW_UPPER_TRIANG=108, 1714bda6c4cbSBarry Smith MATOP_MAT_SOLVE=109, 171529eadf9eSStefano Zampini MATOP_MAT_SOLVE_TRANSPOSE=110, 1716d519adbfSMatthew Knepley MATOP_GET_ROW_MIN=111, 17170e8d04f7SBarry Smith MATOP_GET_COLUMN_VECTOR=112, 1718d519adbfSMatthew Knepley MATOP_MISSING_DIAGONAL=113, 17190e8d04f7SBarry Smith MATOP_GET_SEQ_NONZERO_STRUCTUR=114, 172089c6957cSBarry Smith MATOP_CREATE=115, 172189c6957cSBarry Smith MATOP_GET_GHOSTS=116, 17220e8d04f7SBarry Smith MATOP_GET_LOCAL_SUB_MATRIX=117, 17230e8d04f7SBarry Smith MATOP_RESTORE_LOCALSUB_MATRIX=118, 1724eeffb40dSHong Zhang MATOP_MULT_DIAGONAL_BLOCK=119, 17250e8d04f7SBarry Smith MATOP_HERMITIAN_TRANSPOSE=120, 17260e8d04f7SBarry Smith MATOP_MULT_HERMITIAN_TRANSPOSE=121, 17270e8d04f7SBarry Smith MATOP_MULT_HERMITIAN_TRANS_ADD=122, 17280e8d04f7SBarry Smith MATOP_GET_MULTI_PROC_BLOCK=123, 17299d39f69dSJed Brown MATOP_FIND_NONZERO_ROWS=124, 17300e8d04f7SBarry Smith MATOP_GET_COLUMN_NORMS=125, 17319d39f69dSJed Brown MATOP_INVERT_BLOCK_DIAGONAL=126, 17329d39f69dSJed Brown /* MATOP_PLACEHOLDER_127=127, */ 1733b41ce5d5SBarry Smith MATOP_CREATE_SUB_MATRICES_MPI=128, 17342b8ad9a3SHong Zhang MATOP_SET_VALUES_BATCH=129, 17350e8d04f7SBarry Smith MATOP_TRANSPOSE_MAT_MULT=130, 17360e8d04f7SBarry Smith MATOP_TRANSPOSE_MAT_MULT_SYMBO=131, 1737e9b602ebSSatish Balay MATOP_TRANSPOSE_MAT_MULT_NUMER=132, 17380e8d04f7SBarry Smith MATOP_TRANSPOSE_COLORING_CREAT=133, 17390e8d04f7SBarry Smith MATOP_TRANS_COLORING_APPLY_SPT=134, 17400e8d04f7SBarry Smith MATOP_TRANS_COLORING_APPLY_DEN=135, 17410e8d04f7SBarry Smith MATOP_RART=136, 17420e8d04f7SBarry Smith MATOP_RART_SYMBOLIC=137, 17430e8d04f7SBarry Smith MATOP_RART_NUMERIC=138, 1744e09a3074SHong Zhang MATOP_SET_BLOCK_SIZES=139, 1745f9426fe0SMark Adams MATOP_AYPX=140, 17461919a2e2SJed Brown MATOP_RESIDUAL=141, 17479c8f2541SHong Zhang MATOP_FDCOLORING_SETUP=142, 17482d033e1fSHong Zhang MATOP_MPICONCATENATESEQ=144, 1749bb01b7b0SPatrick Sanan MATOP_DESTROYSUBMATRICES=145, 1750e265f6d6SPatrick Sanan MATOP_TRANSPOSE_SOLVE=146, 1751e265f6d6SPatrick Sanan MATOP_GET_VALUES_LOCAL=147 1752fae171e0SBarry Smith } MatOperation; 17530c0fd78eSBarry Smith PETSC_EXTERN PetscErrorCode MatSetOperation(Mat,MatOperation,void(*)(void)); 1754976e8c5aSLisandro Dalcin PETSC_EXTERN PetscErrorCode MatGetOperation(Mat,MatOperation,void(**)(void)); 1755976e8c5aSLisandro Dalcin PETSC_EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool*); 175694342113SStefano Zampini PETSC_EXTERN PetscErrorCode MatHasCongruentLayouts(Mat,PetscBool*); 17579fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatProductClear() (since version 3.14)") static inline PetscErrorCode MatFreeIntermediateDataStructures(Mat A) {return MatProductClear(A);} 1758014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void)); 1759014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void)); 1760014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*); 1761db77db73SJeremy L Thompson PETSC_EXTERN PetscErrorCode MatShellSetVecType(Mat,VecType); 1762f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*); 1763f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*); 17640c0fd78eSBarry Smith PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat); 1765b77ba244SStefano Zampini PETSC_EXTERN PetscErrorCode MatShellSetMatProductOperation(Mat,MatProductType,PetscErrorCode (*)(Mat,Mat,Mat,void**),PetscErrorCode (*)(Mat,Mat,Mat,void*),PetscErrorCode (*)(void*),MatType,MatType); 1766b77ba244SStefano Zampini PETSC_EXTERN PetscErrorCode MatIsShell(Mat,PetscBool*); 1767112a2221SBarry Smith 176890ace30eSBarry Smith /* 176990ace30eSBarry Smith Codes for matrices stored on disk. By default they are 177090ace30eSBarry Smith stored in a universal format. By changing the format with 17716a9046bcSBarry Smith PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will 177290ace30eSBarry Smith be stored in a way natural for the matrix, for example dense matrices 177390ace30eSBarry Smith would be stored as dense. Matrices stored this way may only be 1774f4403165SShri Abhyankar read into matrices of the same type. 177590ace30eSBarry Smith */ 177690ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1 177790ace30eSBarry Smith 1778014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal); 177975d48cdbSStefano Zampini 17808546b261SStefano Zampini PETSC_EXTERN PetscErrorCode MatISSetLocalMatType(Mat,MatType); 178175d48cdbSStefano Zampini PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 178275d48cdbSStefano Zampini PETSC_EXTERN PetscErrorCode MatISStoreL2L(Mat,PetscBool); 1783f03112d0SStefano Zampini PETSC_EXTERN PetscErrorCode MatISFixLocalEmpty(Mat,PetscBool); 1784014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*); 17853b3b1effSJed Brown PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat,Mat*); 1786014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat); 1787e432b41dSStefano Zampini PETSC_EXTERN PetscErrorCode MatISGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*); 178825ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use the MatConvert() interface (since version 3.10)") PetscErrorCode MatISGetMPIXAIJ(Mat,MatReuse,Mat*); 17891f4e1ec7SBarry Smith 1790d9274352SBarry Smith /*S 1791d9274352SBarry Smith MatNullSpace - Object that removes a null space from a vector, i.e. 1792cb6b9846SMatthew Knepley orthogonalizes the vector to a subspace 1793d9274352SBarry Smith 1794f7a9e4ceSBarry Smith Level: advanced 1795d9274352SBarry Smith 1796d9274352SBarry Smith .seealso: MatNullSpaceCreate() 1797d9274352SBarry Smith S*/ 179874637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace; 1799d9274352SBarry Smith 1800014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*); 1801014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*); 1802014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*); 1803d0195637SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec); 1804014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *); 18055fa7ec2dSBarry Smith PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *); 18065fa7ec2dSBarry Smith PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat,MatNullSpace); 1807014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace); 1808014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace); 1809014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*); 1810014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool *); 1811014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer); 1812014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**); 1813014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*); 181474637425SBarry Smith 1815014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS); 1816014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal); 1817014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *); 18183f1d51d7SBarry Smith 1819014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*); 1820014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*); 1821014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*); 1822c4f061fbSSatish Balay 18230bacdadaSStefano Zampini PETSC_EXTERN PetscErrorCode MatComputeOperator(Mat,MatType,Mat*); 18240bacdadaSStefano Zampini PETSC_EXTERN PetscErrorCode MatComputeOperatorTranspose(Mat,MatType,Mat*); 18250bacdadaSStefano Zampini 18269fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatComputeOperator() (since version 3.12)") static inline PetscErrorCode MatComputeExplicitOperator(Mat A,Mat* B) { return MatComputeOperator(A,NULL,B); } 18279fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatComputeOperatorTranspose() (since version 3.12)") static inline PetscErrorCode MatComputeExplicitOperatorTranspose(Mat A,Mat* B) { return MatComputeOperatorTranspose(A,NULL,B); } 1828b0a32e0cSBarry Smith 182949bd79ccSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode MatCreateKAIJ(Mat,PetscInt,PetscInt,const PetscScalar[],const PetscScalar[],Mat*); 183049bd79ccSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode MatKAIJGetAIJ(Mat,Mat*); 1831a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetS(Mat,PetscInt*,PetscInt*,PetscScalar**); 1832a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetSRead(Mat,PetscInt*,PetscInt*,const PetscScalar**); 1833a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreS(Mat,PetscScalar**); 1834a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreSRead(Mat,const PetscScalar**); 1835a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetT(Mat,PetscInt*,PetscInt*,PetscScalar**); 1836a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetTRead(Mat,PetscInt*,PetscInt*,const PetscScalar**); 1837a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreT(Mat,PetscScalar**); 1838a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreTRead(Mat,const PetscScalar**); 1839dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetAIJ(Mat,Mat); 1840dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetS(Mat,PetscInt,PetscInt,const PetscScalar[]); 1841dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetT(Mat,PetscInt,PetscInt,const PetscScalar[]); 1842910cf402Sprj- PETSC_EXTERN PetscErrorCode MatKAIJGetScaledIdentity(Mat,PetscBool*); 184349bd79ccSDebojyoti Ghosh 1844014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec); 184504f1ad80SBarry Smith 1846014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 1847014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec); 1848014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*); 1849014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*)); 1850014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec)); 1851014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt); 1852014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat); 1853014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal); 1854014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt); 1855014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *); 1856014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]); 1857014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*); 1858014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*); 1859e884886fSBarry Smith 18606370053bSBarry Smith /*S 18616370053bSBarry Smith MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free 18626370053bSBarry Smith Jacobian vector products 1863e884886fSBarry Smith 186495452b02SPatrick Sanan Notes: 186595452b02SPatrick Sanan MATMFFD is a specific MatType which uses the MatMFFD data structure 18666370053bSBarry Smith 18676370053bSBarry Smith MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure 18686370053bSBarry Smith 18696370053bSBarry Smith Level: developer 18706370053bSBarry Smith 18716370053bSBarry Smith .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister() 18726370053bSBarry Smith S*/ 1873e884886fSBarry Smith typedef struct _p_MatMFFD* MatMFFD; 1874e884886fSBarry Smith 187576bdecfbSBarry Smith /*J 1876e884886fSBarry Smith MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function 1877e884886fSBarry Smith 1878e884886fSBarry Smith Level: beginner 1879e884886fSBarry Smith 1880e884886fSBarry Smith .seealso: MatMFFDSetType(), MatMFFDRegister() 188176bdecfbSBarry Smith J*/ 188219fd82e9SBarry Smith typedef const char* MatMFFDType; 1883e884886fSBarry Smith #define MATMFFD_DS "ds" 1884e884886fSBarry Smith #define MATMFFD_WP "wp" 1885e884886fSBarry Smith 188619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat,MatMFFDType); 1887bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[],PetscErrorCode (*)(MatMFFD)); 1888e884886fSBarry Smith 1889014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal); 1890014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool); 1891e884886fSBarry Smith 189261ab5df0SBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring,MatMFFDType); 189361ab5df0SBarry Smith 1894014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *); 1895014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *); 18967dbadf16SMatthew Knepley 189753022affSStefano Zampini #ifdef PETSC_HAVE_H2OPUS 189853022affSStefano Zampini PETSC_EXTERN_TYPEDEF typedef PetscScalar (*MatH2OpusKernel)(PetscInt,PetscReal[],PetscReal[],void*); 189953022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatCreateH2OpusFromKernel(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscReal[],PetscBool,MatH2OpusKernel,void*,PetscReal,PetscInt,PetscInt,Mat*); 190053022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatCreateH2OpusFromMat(Mat,PetscInt,const PetscReal[],PetscBool,PetscReal,PetscInt,PetscInt,PetscInt,PetscReal,Mat*); 190153022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusSetSamplingMat(Mat,Mat,PetscInt,PetscReal); 190253022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusOrthogonalize(Mat); 190353022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusCompress(Mat,PetscReal); 190453022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusSetNativeMult(Mat,PetscBool); 190553022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusGetNativeMult(Mat,PetscBool*); 190653022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusGetIndexMap(Mat,IS*); 190753022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusMapVec(Mat,PetscBool,Vec,Vec*); 1908300d917bSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusLowRankUpdate(Mat,Mat,Mat,PetscScalar); 1909a0d2e7d8SStefano Zampini #endif 1910a0d2e7d8SStefano Zampini 1911c7a4214aSPierre Jolivet #ifdef PETSC_HAVE_HTOOL 191298e73e17SPierre Jolivet PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*MatHtoolKernel)(PetscInt,PetscInt,PetscInt,const PetscInt*,const PetscInt*,PetscScalar*,void*); 1913c7a4214aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatCreateHtoolFromKernel(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscReal[],const PetscReal[],MatHtoolKernel,void*,Mat*); 1914c7a4214aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolSetKernel(Mat,MatHtoolKernel,void*); 191598e73e17SPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolGetPermutationSource(Mat,IS*); 191698e73e17SPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolGetPermutationTarget(Mat,IS*); 191798e73e17SPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolUsePermutation(Mat,PetscBool); 1918c7a4214aSPierre Jolivet /*E 1919c7a4214aSPierre Jolivet MatHtoolCompressorType - Indicates the type of compressor used by a MATHTOOL 1920c7a4214aSPierre Jolivet 1921c7a4214aSPierre Jolivet Level: beginner 1922c7a4214aSPierre Jolivet 1923c7a4214aSPierre Jolivet Values: 1924c7a4214aSPierre Jolivet + MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA (default) - symmetric partial adaptive cross approximation 1925c7a4214aSPierre Jolivet . MAT_HTOOL_COMPRESSOR_FULL_ACA - full adaptive cross approximation 1926c7a4214aSPierre Jolivet - MAT_HTOOL_COMPRESSOR_SVD - singular value decomposition 1927c7a4214aSPierre Jolivet 192898e73e17SPierre Jolivet .seealso: MatCreateHtoolFromKernel(), MATHTOOL, MatHtoolClusteringType 1929c7a4214aSPierre Jolivet E*/ 1930c7a4214aSPierre Jolivet typedef enum { MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA, MAT_HTOOL_COMPRESSOR_FULL_ACA, MAT_HTOOL_COMPRESSOR_SVD } MatHtoolCompressorType; 193198e73e17SPierre Jolivet /*E 193298e73e17SPierre Jolivet MatHtoolClusteringType - Indicates the type of clustering used by a MATHTOOL 193398e73e17SPierre Jolivet 193498e73e17SPierre Jolivet Level: beginner 193598e73e17SPierre Jolivet 193698e73e17SPierre Jolivet Values: 193798e73e17SPierre Jolivet + MAT_HTOOL_CLUSTERING_PCA_REGULAR (default) - axis computed via principle component analysis, split uniformly 193898e73e17SPierre Jolivet . MAT_HTOOL_CLUSTERING_PCA_GEOMETRIC - axis computed via principle component analysis, split barycentrically 193998e73e17SPierre Jolivet . MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_REGULAR - axis along the largest extent of the bounding box, split uniformly 194098e73e17SPierre Jolivet - MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_GEOMETRIC - axis along the largest extent of the bounding box, split barycentrically 194198e73e17SPierre Jolivet 194298e73e17SPierre Jolivet Notes: higher-dimensional clustering is not yet supported in Htool, but once it is, one should add BOUNDING_BOX_{2,3} types 194398e73e17SPierre Jolivet 194498e73e17SPierre Jolivet .seealso: MatCreateHtoolFromKernel(), MATHTOOL, MatHtoolCompressorType 194598e73e17SPierre Jolivet E*/ 194698e73e17SPierre 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; 1947c7a4214aSPierre Jolivet #endif 1948c7a4214aSPierre Jolivet 194997969023SHong Zhang /* 195097969023SHong Zhang PETSc interface to MUMPS 195197969023SHong Zhang */ 195297969023SHong Zhang #ifdef PETSC_HAVE_MUMPS 1953014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt); 1954bc6112feSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat,PetscInt,PetscInt*); 1955b9e9ea26SSatish Balay PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal); 1956bc6112feSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat,PetscInt,PetscReal*); 1957bc6112feSHong Zhang 1958ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat,PetscInt,PetscInt*); 1959ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat,PetscInt,PetscInt*); 1960ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat,PetscInt,PetscReal*); 1961ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat,PetscInt,PetscReal*); 196289a9c03aSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat,Mat); 19630e6b8875SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInverseTranspose(Mat,Mat); 196497969023SHong Zhang #endif 196523a5497aSJed Brown 1966d954db57SHong Zhang /* 1967d615f992SSatish Balay PETSc interface to Mkl_Pardiso 1968b500a6b7SJose David Bermeol */ 1969b500a6b7SJose David Bermeol #ifdef PETSC_HAVE_MKL_PARDISO 1970d615f992SSatish Balay PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt); 1971b500a6b7SJose David Bermeol #endif 1972b500a6b7SJose David Bermeol 1973b500a6b7SJose David Bermeol /* 1974d305a81bSVasiliy Kozyrev PETSc interface to Mkl_CPardiso 1975d305a81bSVasiliy Kozyrev */ 1976d305a81bSVasiliy Kozyrev #ifdef PETSC_HAVE_MKL_CPARDISO 1977d305a81bSVasiliy Kozyrev PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt); 1978d305a81bSVasiliy Kozyrev #endif 1979d305a81bSVasiliy Kozyrev 1980d305a81bSVasiliy Kozyrev /* 1981d954db57SHong Zhang PETSc interface to SUPERLU 1982d954db57SHong Zhang */ 1983d954db57SHong Zhang #ifdef PETSC_HAVE_SUPERLU 1984014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal); 1985d954db57SHong Zhang #endif 1986d954db57SHong Zhang 1987fb785984SHong Zhang /* 1988fb785984SHong Zhang PETSc interface to SUPERLU_DIST 1989fb785984SHong Zhang */ 1990fb785984SHong Zhang #ifdef PETSC_HAVE_SUPERLU_DIST 1991fb785984SHong Zhang PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat,PetscScalar*); 1992fb785984SHong Zhang #endif 1993fb785984SHong Zhang 1994575704cbSPieter Ghysels /* 1995575704cbSPieter Ghysels PETSc interface to STRUMPACK 1996575704cbSPieter Ghysels */ 1997575704cbSPieter Ghysels #ifdef PETSC_HAVE_STRUMPACK 1998542aee0fSPieter Ghysels /*E 1999542aee0fSPieter Ghysels MatSTRUMPACKReordering - sparsity reducing ordering to be used in STRUMPACK 2000542aee0fSPieter Ghysels 2001542aee0fSPieter Ghysels Level: intermediate 2002542aee0fSPieter Ghysels E*/ 200334f43fa5SPieter Ghysels typedef enum {MAT_STRUMPACK_NATURAL=0, 200434f43fa5SPieter Ghysels MAT_STRUMPACK_METIS=1, 200534f43fa5SPieter Ghysels MAT_STRUMPACK_PARMETIS=2, 200634f43fa5SPieter Ghysels MAT_STRUMPACK_SCOTCH=3, 200734f43fa5SPieter Ghysels MAT_STRUMPACK_PTSCOTCH=4, 200834f43fa5SPieter Ghysels MAT_STRUMPACK_RCM=5} MatSTRUMPACKReordering; 200934f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat,MatSTRUMPACKReordering); 2010575704cbSPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat,PetscBool); 201134f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSRelTol(Mat,PetscReal); 20129fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSRelTol() (since version 3.9)") static inline PetscErrorCode MatSTRUMPACKSetHSSRelCompTol(Mat mat,PetscReal rtol) {return MatSTRUMPACKSetHSSRelTol(mat,rtol);} 201334f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSAbsTol(Mat,PetscReal); 201434f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMinSepSize(Mat,PetscInt); 20159fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSMinSepSize() (since version 3.9)") static inline PetscErrorCode MatSTRUMPACKSetHSSMinSize(Mat mat,PetscInt hssminsize) {return MatSTRUMPACKSetHSSMinSepSize(mat,hssminsize);} 201634f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMaxRank(Mat,PetscInt); 2017a36bf211SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSLeafSize(Mat,PetscInt); 2018575704cbSPieter Ghysels #endif 2019575704cbSPieter Ghysels 2020b470e4b4SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatBindToCPU(Mat,PetscBool); 20212216c58aSStefano Zampini PETSC_EXTERN PetscErrorCode MatBoundToCPU(Mat,PetscBool*); 20229fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatBindToCPU (since v3.13)") static inline PetscErrorCode MatPinToCPU(Mat A,PetscBool flg) {return MatBindToCPU(A,flg);} 202365a9ecf2SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatSetBindingPropagates(Mat,PetscBool); 2024e9c74fd6SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetBindingPropagates(Mat,PetscBool *); 2025e7e92044SBarry Smith 2026042217e8SBarry Smith typedef struct _n_SplitCSRMat *PetscSplitCSRDataStructure; 2027042217e8SBarry Smith PETSC_EXTERN PetscErrorCode MatCUSPARSEGetDeviceMatWrite(Mat,PetscSplitCSRDataStructure*); 2028a587d139SMark 2029a587d139SMark #ifdef PETSC_HAVE_KOKKOS_KERNELS 2030042217e8SBarry Smith PETSC_EXTERN PetscErrorCode MatKokkosGetDeviceMatWrite(Mat,PetscSplitCSRDataStructure*); 2031042217e8SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJKokkosSetDeviceMat(Mat,PetscSplitCSRDataStructure); 2032042217e8SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJKokkosGetDeviceMat(Mat,PetscSplitCSRDataStructure*); 2033a587d139SMark #endif 2034a587d139SMark 2035aa372e3fSPaul Mullowney #ifdef PETSC_HAVE_CUDA 20363f9c0db1SPaul Mullowney /*E 2037e057df02SPaul Mullowney MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU) 20382692e278SPaul Mullowney matrices. 2039e057df02SPaul Mullowney 2040e057df02SPaul Mullowney Not Collective 2041e057df02SPaul Mullowney 20428468deeeSKarl Rupp + MAT_CUSPARSE_CSR - Compressed Sparse Row 20432692e278SPaul Mullowney . MAT_CUSPARSE_ELL - Ellpack (requires CUDA 4.2 or later). 20442692e278SPaul Mullowney - MAT_CUSPARSE_HYB - Hybrid, a combination of Ellpack and Coordinate format (requires CUDA 4.2 or later). 2045e057df02SPaul Mullowney 2046e057df02SPaul Mullowney Level: intermediate 2047e057df02SPaul Mullowney 2048af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 2049e057df02SPaul Mullowney 2050e057df02SPaul Mullowney .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation 2051e057df02SPaul Mullowney E*/ 2052e057df02SPaul Mullowney 20533f9c0db1SPaul Mullowney typedef enum {MAT_CUSPARSE_CSR, MAT_CUSPARSE_ELL, MAT_CUSPARSE_HYB} MatCUSPARSEStorageFormat; 2054e057df02SPaul Mullowney 2055e057df02SPaul Mullowney /* these will be strings associated with enumerated type defined above */ 2056e057df02SPaul Mullowney PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[]; 2057e057df02SPaul Mullowney 20583f9c0db1SPaul Mullowney /*E 2059e057df02SPaul Mullowney MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU) 20602692e278SPaul Mullowney matrices whose operation should use a particular storage format. 2061e057df02SPaul Mullowney 2062e057df02SPaul Mullowney Not Collective 2063e057df02SPaul Mullowney 20648468deeeSKarl Rupp + MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult 20658468deeeSKarl Rupp . MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult 20668468deeeSKarl Rupp . MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult 20678468deeeSKarl Rupp - MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices 2068e057df02SPaul Mullowney 2069e057df02SPaul Mullowney Level: intermediate 2070e057df02SPaul Mullowney 2071e057df02SPaul Mullowney .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat 2072e057df02SPaul Mullowney E*/ 207336d62e41SPaul Mullowney typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation; 2074e057df02SPaul Mullowney 207510e9db80SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 207610e9db80SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 2077e057df02SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat); 2078365b711fSMark Adams PETSC_EXTERN PetscErrorCode MatCUSPARSESetUseCPUSolve(Mat,PetscBool); 2079e8d2b73aSMark Adams typedef struct Mat_SeqAIJCUSPARSETriFactors* Mat_SeqAIJCUSPARSETriFactors_p; 20805f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetIJ(Mat,PetscBool,const int**,const int**); 20815f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreIJ(Mat,PetscBool,const int**,const int**); 20825f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArrayRead(Mat,const PetscScalar**); 20835f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArrayRead(Mat,const PetscScalar**); 20845f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArrayWrite(Mat,PetscScalar**); 20855f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArrayWrite(Mat,PetscScalar**); 20865f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArray(Mat,PetscScalar**); 20875f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArray(Mat,PetscScalar**); 2088637a0070SStefano Zampini 2089637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatCreateDenseCUDA(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*); 2090637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatCreateSeqDenseCUDA(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*); 2091637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatMPIDenseCUDASetPreallocation(Mat,PetscScalar[]); 2092637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqDenseCUDASetPreallocation(Mat,PetscScalar[]); 2093637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayWrite(Mat,PetscScalar**); 2094637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayRead(Mat,const PetscScalar**); 2095637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArray(Mat,PetscScalar**); 2096637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayWrite(Mat,PetscScalar**); 2097637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayRead(Mat,const PetscScalar**); 2098637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArray(Mat,PetscScalar**); 2099637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAPlaceArray(Mat,const PetscScalar*); 2100d5ea218eSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAReplaceArray(Mat,const PetscScalar*); 2101637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAResetArray(Mat); 21023fa6b06aSMark Adams 21039ae82921SPaul Mullowney #endif 21049ae82921SPaul Mullowney 2105d67ff14aSKarl Rupp #if defined(PETSC_HAVE_VIENNACL) 2106d67ff14aSKarl Rupp PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 2107d67ff14aSKarl Rupp PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 2108d67ff14aSKarl Rupp #endif 2109d67ff14aSKarl Rupp 211054efbe56SHong Zhang /* 211154efbe56SHong Zhang PETSc interface to FFTW 211254efbe56SHong Zhang */ 211354efbe56SHong Zhang #if defined(PETSC_HAVE_FFTW) 2114014dd563SJed Brown PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec); 2115014dd563SJed Brown PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec); 21162a7a6963SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*); 211754efbe56SHong Zhang #endif 211854efbe56SHong Zhang 2119d24d4204SJose E. Roman #if defined(PETSC_HAVE_SCALAPACK) 2120d24d4204SJose E. Roman PETSC_EXTERN PetscErrorCode MatCreateScaLAPACK(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 2121d24d4204SJose E. Roman PETSC_EXTERN PetscErrorCode MatScaLAPACKSetBlockSizes(Mat,PetscInt,PetscInt); 2122d24d4204SJose E. Roman PETSC_EXTERN PetscErrorCode MatScaLAPACKGetBlockSizes(Mat,PetscInt*,PetscInt*); 2123d24d4204SJose E. Roman #endif 2124d24d4204SJose E. Roman 2125014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*); 2126014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*); 2127014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]); 2128014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]); 2129014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***); 2130014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*); 213119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType); 2132014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]); 2133014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat); 2134d8588912SDave May 21354325cce7SMatthew G Knepley PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal); 2136e0a58c10SMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*); 21374325cce7SMatthew G Knepley 2138b541e6a4SDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSubdomainsCreateCoalesce(Mat,PetscInt,PetscInt*,IS**); 213953dd7562SDmitry Karpeev 2140c094ef40SMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatPreallocatorPreallocate(Mat,PetscBool,Mat); 2141c094ef40SMatthew G. Knepley 2142539c167fSBarry Smith PETSC_INTERN PetscErrorCode MatHeaderMerge(Mat,Mat*); 2143539c167fSBarry Smith PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat,Mat*); 21441a2c6b5cSJunchao Zhang 21457ee59b9bSJunchao Zhang PETSC_EXTERN PetscErrorCode MatSeqAIJGetCSRAndMemType(Mat,const PetscInt**,const PetscInt**,PetscScalar**,PetscMemType*); 214623a5497aSJed Brown #endif 2147