12eac72dbSBarry Smith /* 22eac72dbSBarry Smith Include file for the matrix component of PETSc 32eac72dbSBarry Smith */ 426bd1501SBarry Smith #ifndef PETSCMAT_H 526bd1501SBarry Smith #define PETSCMAT_H 6ac09b921SBarry Smith 72c8e378dSBarry Smith #include <petscvec.h> 82eac72dbSBarry Smith 9ac09b921SBarry Smith /* SUBMANSEC = Mat */ 10ac09b921SBarry Smith 11d9274352SBarry Smith /*S 128f6c3df8SBarry Smith Mat - Abstract PETSc matrix object used to manage all linear operators in PETSc, even those without 138f6c3df8SBarry Smith an explicit sparse representation (such as matrix-free operators) 142eac72dbSBarry Smith 15d91e6319SBarry Smith Level: beginner 16d91e6319SBarry Smith 17db781477SPatrick Sanan .seealso: `MatCreate()`, `MatType`, `MatSetType()`, `MatDestroy()` 18d9274352SBarry Smith S*/ 19d9274352SBarry Smith typedef struct _p_Mat* Mat; 20d9274352SBarry Smith 2176bdecfbSBarry Smith /*J 228f6c3df8SBarry Smith MatType - String with the name of a PETSc matrix type 23d9274352SBarry Smith 24d9274352SBarry Smith Level: beginner 25d9274352SBarry Smith 26db781477SPatrick Sanan .seealso: `MatSetType()`, `Mat`, `MatSolverType`, `MatRegister()` 2776bdecfbSBarry Smith J*/ 2819fd82e9SBarry Smith typedef const char* MatType; 29273d9f13SBarry Smith #define MATSAME "same" 305a11e1b2SBarry Smith #define MATMAIJ "maij" 31273d9f13SBarry Smith #define MATSEQMAIJ "seqmaij" 32273d9f13SBarry Smith #define MATMPIMAIJ "mpimaij" 3349bd79ccSDebojyoti Ghosh #define MATKAIJ "kaij" 3449bd79ccSDebojyoti Ghosh #define MATSEQKAIJ "seqkaij" 3549bd79ccSDebojyoti Ghosh #define MATMPIKAIJ "mpikaij" 36273d9f13SBarry Smith #define MATIS "is" 375a11e1b2SBarry Smith #define MATAIJ "aij" 38273d9f13SBarry Smith #define MATSEQAIJ "seqaij" 39273d9f13SBarry Smith #define MATMPIAIJ "mpiaij" 405a11e1b2SBarry Smith #define MATAIJCRL "aijcrl" 415a11e1b2SBarry Smith #define MATSEQAIJCRL "seqaijcrl" 425a11e1b2SBarry Smith #define MATMPIAIJCRL "mpiaijcrl" 439ae82921SPaul Mullowney #define MATAIJCUSPARSE "aijcusparse" 449ae82921SPaul Mullowney #define MATSEQAIJCUSPARSE "seqaijcusparse" 459ae82921SPaul Mullowney #define MATMPIAIJCUSPARSE "mpiaijcusparse" 468c3ff71bSJunchao Zhang #define MATAIJKOKKOS "aijkokkos" 478c3ff71bSJunchao Zhang #define MATSEQAIJKOKKOS "seqaijkokkos" 488c3ff71bSJunchao Zhang #define MATMPIAIJKOKKOS "mpiaijkokkos" 49d67ff14aSKarl Rupp #define MATAIJVIENNACL "aijviennacl" 50d67ff14aSKarl Rupp #define MATSEQAIJVIENNACL "seqaijviennacl" 51d67ff14aSKarl Rupp #define MATMPIAIJVIENNACL "mpiaijviennacl" 525a11e1b2SBarry Smith #define MATAIJPERM "aijperm" 535a11e1b2SBarry Smith #define MATSEQAIJPERM "seqaijperm" 545a11e1b2SBarry Smith #define MATMPIAIJPERM "mpiaijperm" 554dfdc2d9SRichard Tran Mills #define MATAIJSELL "aijsell" 564dfdc2d9SRichard Tran Mills #define MATSEQAIJSELL "seqaijsell" 574dfdc2d9SRichard Tran Mills #define MATMPIAIJSELL "mpiaijsell" 584a2a386eSRichard Tran Mills #define MATAIJMKL "aijmkl" 594a2a386eSRichard Tran Mills #define MATSEQAIJMKL "seqaijmkl" 604a2a386eSRichard Tran Mills #define MATMPIAIJMKL "mpiaijmkl" 61b5b72c8aSIrina Sokolova #define MATBAIJMKL "baijmkl" 62b5b72c8aSIrina Sokolova #define MATSEQBAIJMKL "seqbaijmkl" 63b5b72c8aSIrina Sokolova #define MATMPIBAIJMKL "mpibaijmkl" 64273d9f13SBarry Smith #define MATSHELL "shell" 65c1fff1c6SRichard Tran Mills #define MATCENTERING "centering" 665a11e1b2SBarry Smith #define MATDENSE "dense" 67637a0070SStefano Zampini #define MATDENSECUDA "densecuda" 68209238afSKris Buschelman #define MATSEQDENSE "seqdense" 69bfc799aaSStefano Zampini #define MATSEQDENSECUDA "seqdensecuda" 70273d9f13SBarry Smith #define MATMPIDENSE "mpidense" 71637a0070SStefano Zampini #define MATMPIDENSECUDA "mpidensecuda" 72db31f6deSJed Brown #define MATELEMENTAL "elemental" 73d24d4204SJose E. Roman #define MATSCALAPACK "scalapack" 745a11e1b2SBarry Smith #define MATBAIJ "baij" 75273d9f13SBarry Smith #define MATSEQBAIJ "seqbaij" 76273d9f13SBarry Smith #define MATMPIBAIJ "mpibaij" 77273d9f13SBarry Smith #define MATMPIADJ "mpiadj" 785a11e1b2SBarry Smith #define MATSBAIJ "sbaij" 79273d9f13SBarry Smith #define MATSEQSBAIJ "seqsbaij" 80273d9f13SBarry Smith #define MATMPISBAIJ "mpisbaij" 81cebc7f6cSBarry Smith #define MATMFFD "mffd" 82c8a8475eSBarry Smith #define MATNORMAL "normal" 83c5e4d11fSDmitry Karpeev #define MATNORMALHERMITIAN "normalh" 84ab92ecdeSBarry Smith #define MATLRC "lrc" 852a6744ebSBarry Smith #define MATSCATTER "scatter" 86421e10b8SBarry Smith #define MATBLOCKMAT "blockmat" 87793850ffSBarry Smith #define MATCOMPOSITE "composite" 881f8c7532SHong Zhang #define MATFFT "fft" 891f8c7532SHong Zhang #define MATFFTW "fftw" 90e133240eSMatthew G Knepley #define MATSEQCUFFT "seqcufft" 91557cca28SSatish Balay #define MATTRANSPOSEMAT "transpose" 9272ca8751SBarry Smith #define MATSCHURCOMPLEMENT "schurcomplement" 931d6018f0SLisandro Dalcin #define MATPYTHON "python" 9463c07aadSStefano Zampini #define MATHYPRE "hypre" 95f91d8e95SBarry Smith #define MATHYPRESTRUCT "hyprestruct" 96a9e6138eSGlenn Hammond #define MATHYPRESSTRUCT "hypresstruct" 97ee1cef2cSJed Brown #define MATSUBMATRIX "submatrix" 982c0dbf93SJed Brown #define MATLOCALREF "localref" 99d8588912SDave May #define MATNEST "nest" 100c094ef40SMatthew G. Knepley #define MATPREALLOCATOR "preallocator" 101d4002b98SHong Zhang #define MATSELL "sell" 102d4002b98SHong Zhang #define MATSEQSELL "seqsell" 103d4002b98SHong Zhang #define MATMPISELL "mpisell" 104a3b2e22bSHong Zhang #define MATDUMMY "dummy" 105cd929ea3SAlp Dener #define MATLMVM "lmvm" 10678e4361aSAlp Dener #define MATLMVMDFP "lmvmdfp" 10778e4361aSAlp Dener #define MATLMVMBFGS "lmvmbfgs" 10878e4361aSAlp Dener #define MATLMVMSR1 "lmvmsr1" 109864588a7SAlp Dener #define MATLMVMBROYDEN "lmvmbroyden" 110864588a7SAlp Dener #define MATLMVMBADBROYDEN "lmvmbadbroyden" 111864588a7SAlp Dener #define MATLMVMSYMBROYDEN "lmvmsymbroyden" 112864588a7SAlp Dener #define MATLMVMSYMBADBROYDEN "lmvmsymbadbroyden" 113864588a7SAlp Dener #define MATLMVMDIAGBROYDEN "lmvmdiagbroyden" 1143423f386SBarry Smith #define MATCONSTANTDIAGONAL "constantdiagonal" 115c7a4214aSPierre Jolivet #define MATHTOOL "htool" 11653022affSStefano Zampini #define MATH2OPUS "h2opus" 117773941d6SBarry Smith 11876bdecfbSBarry Smith /*J 1193ca39a21SBarry Smith MatSolverType - String with the name of a PETSc matrix solver type. 1209989ab13SBarry Smith 121c2b89b5dSBarry Smith For example: "petsc" indicates what PETSc provides, "superlu_dist" the parallel SuperLU_DIST package etc 1229989ab13SBarry Smith 1239989ab13SBarry Smith Level: beginner 1249989ab13SBarry Smith 1253f498edaSToby Isaac Notes: MATSOLVERUMFPACK, MATSOLVERCHOLMOD, MATSOLVERKLU, MATSOLVERSPQR form the SuiteSparse package for which you can use --download-suitesparse 126c7ccbb75SBarry Smith 127db781477SPatrick Sanan .seealso: `MatGetFactor()`, `PCFactorSetMatSolverType()`, `PCFactorGetMatSolverType()` 12876bdecfbSBarry Smith J*/ 129ea799195SBarry Smith typedef const char* MatSolverType; 1302692d6eeSBarry Smith #define MATSOLVERSUPERLU "superlu" 1312692d6eeSBarry Smith #define MATSOLVERSUPERLU_DIST "superlu_dist" 13208f5efcfSPieter Ghysels #define MATSOLVERSTRUMPACK "strumpack" 1332692d6eeSBarry Smith #define MATSOLVERUMFPACK "umfpack" 13420db9a53SJed Brown #define MATSOLVERCHOLMOD "cholmod" 135d89f5e7aSBarry Smith #define MATSOLVERKLU "klu" 136418810c4SBarry Smith #define MATSOLVERSPARSEELEMENTAL "sparseelemental" 137d89f5e7aSBarry Smith #define MATSOLVERELEMENTAL "elemental" 138d24d4204SJose E. Roman #define MATSOLVERSCALAPACK "scalapack" 1392692d6eeSBarry Smith #define MATSOLVERESSL "essl" 1402692d6eeSBarry Smith #define MATSOLVERLUSOL "lusol" 1412692d6eeSBarry Smith #define MATSOLVERMUMPS "mumps" 142d615f992SSatish Balay #define MATSOLVERMKL_PARDISO "mkl_pardiso" 143d305a81bSVasiliy Kozyrev #define MATSOLVERMKL_CPARDISO "mkl_cpardiso" 1442692d6eeSBarry Smith #define MATSOLVERPASTIX "pastix" 1452692d6eeSBarry Smith #define MATSOLVERMATLAB "matlab" 1462692d6eeSBarry Smith #define MATSOLVERPETSC "petsc" 1472692d6eeSBarry Smith #define MATSOLVERBAS "bas" 1489ae82921SPaul Mullowney #define MATSOLVERCUSPARSE "cusparse" 149bddcd29dSMark Adams #define MATSOLVERCUSPARSEBAND "cusparseband" 150bfc799aaSStefano Zampini #define MATSOLVERCUDA "cuda" 151930e68a5SMark Adams #define MATSOLVERKOKKOS "kokkos" 1528f7e8f9dSMark Adams #define MATSOLVERKOKKOSDEVICE "kokkosdevice" 153a2fc1e05SToby Isaac #define MATSOLVERSPQR "spqr" 154c0cdd4a1SDahai Guo 155b24902e0SBarry Smith /*E 156b24902e0SBarry Smith MatFactorType - indicates what type of factorization is requested 157b24902e0SBarry Smith 158b24902e0SBarry Smith Level: beginner 159b24902e0SBarry Smith 160af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 161b24902e0SBarry Smith 162db781477SPatrick Sanan .seealso: `MatSolverType`, `MatGetFactor()`, `MatGetFactorAvailable()`, `MatSolverTypeRegister()` 163b24902e0SBarry Smith E*/ 1643f498edaSToby 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; 165014dd563SJed Brown PETSC_EXTERN const char *const MatFactorTypes[]; 166e92e720dSBarry Smith 167ea799195SBarry Smith PETSC_EXTERN PetscErrorCode MatGetFactor(Mat,MatSolverType,MatFactorType,Mat*); 168ea799195SBarry Smith PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat,MatSolverType,MatFactorType,PetscBool *); 169f73b0415SBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetCanUseOrdering(Mat, PetscBool*); 1709fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatFactorGetCanUseOrdering() (since version 3.15)") static inline PetscErrorCode MatFactorGetUseOrdering(Mat A,PetscBool *b) {return MatFactorGetCanUseOrdering(A,b);} 171ea799195SBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetSolverType(Mat,MatSolverType*); 172014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat,MatFactorType*); 1737abd51d3SMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatSetFactorType(Mat,MatFactorType); 1742430ea28SJose E. Roman PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*MatSolverFunction)(Mat,MatFactorType,Mat*); 1752430ea28SJose E. Roman PETSC_EXTERN PetscErrorCode MatSolverTypeRegister(MatSolverType,MatType,MatFactorType,MatSolverFunction); 1762430ea28SJose E. Roman PETSC_EXTERN PetscErrorCode MatSolverTypeGet(MatSolverType,MatType,MatFactorType,PetscBool*,PetscBool*,MatSolverFunction*); 17725ef9dfeSBarry Smith typedef MatSolverType MatSolverPackage PETSC_DEPRECATED_TYPEDEF("Use MatSolverType (since version 3.9)"); 1789fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatSolverTypeRegister() (since version 3.9)") static inline PetscErrorCode MatSolverPackageRegister(MatSolverType stype,MatType mtype,MatFactorType ftype,MatSolverFunction f) 179c19b563cSJed Brown { return MatSolverTypeRegister(stype,mtype,ftype,f); } 1809fbee547SJacob 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) 181c19b563cSJed Brown { return MatSolverTypeGet(stype,mtype,ftype,foundmtype,foundstype,f); } 1829989ab13SBarry Smith 1834222ddf1SHong Zhang /*E 1844222ddf1SHong Zhang MatProductType - indicates what type of matrix product is requested 1854222ddf1SHong Zhang 1864222ddf1SHong Zhang Level: beginner 1874222ddf1SHong Zhang 188db781477SPatrick Sanan .seealso: `MatProductSetType()` 1894222ddf1SHong Zhang E*/ 1906718818eSStefano Zampini typedef enum {MATPRODUCT_UNSPECIFIED=0,MATPRODUCT_AB,MATPRODUCT_AtB,MATPRODUCT_ABt,MATPRODUCT_PtAP,MATPRODUCT_RARt,MATPRODUCT_ABC} MatProductType; 191544a5e07SHong Zhang PETSC_EXTERN const char *const MatProductTypes[]; 1924222ddf1SHong Zhang 1934222ddf1SHong Zhang /*J 1944222ddf1SHong Zhang MatProductAlgorithm - String with the name of an algorithm for a PETSc matrix product implementation 1954222ddf1SHong Zhang 1964222ddf1SHong Zhang Level: beginner 1974222ddf1SHong Zhang 198db781477SPatrick Sanan .seealso: `MatSetType()`, `Mat`, `MatProductSetAlgorithm()`, `MatProductType` 1994222ddf1SHong Zhang J*/ 2004222ddf1SHong Zhang typedef const char* MatProductAlgorithm; 2013e662e0bSHong Zhang #define MATPRODUCTALGORITHMDEFAULT "default" 2023e662e0bSHong Zhang #define MATPRODUCTALGORITHMSORTED "sorted" 2033e662e0bSHong Zhang #define MATPRODUCTALGORITHMSCALABLE "scalable" 2043e662e0bSHong Zhang #define MATPRODUCTALGORITHMSCALABLEFAST "scalable_fast" 2053e662e0bSHong Zhang #define MATPRODUCTALGORITHMHEAP "heap" 2063e662e0bSHong Zhang #define MATPRODUCTALGORITHMBHEAP "btheap" 2073e662e0bSHong Zhang #define MATPRODUCTALGORITHMLLCONDENSED "llcondensed" 2083e662e0bSHong Zhang #define MATPRODUCTALGORITHMROWMERGE "rowmerge" 2093e662e0bSHong Zhang #define MATPRODUCTALGORITHMOUTERPRODUCT "outerproduct" 2103e662e0bSHong Zhang #define MATPRODUCTALGORITHMATB "at*b" 2113e662e0bSHong Zhang #define MATPRODUCTALGORITHMRAP "rap" 2123e662e0bSHong Zhang #define MATPRODUCTALGORITHMNONSCALABLE "nonscalable" 2133e662e0bSHong Zhang #define MATPRODUCTALGORITHMSEQMPI "seqmpi" 2143e662e0bSHong Zhang #define MATPRODUCTALGORITHMBACKEND "backend" 2153e662e0bSHong Zhang #define MATPRODUCTALGORITHMOVERLAPPING "overlapping" 2163e662e0bSHong Zhang #define MATPRODUCTALGORITHMMERGED "merged" 2173e662e0bSHong Zhang #define MATPRODUCTALGORITHMALLATONCE "allatonce" 2183e662e0bSHong Zhang #define MATPRODUCTALGORITHMALLATONCEMERGED "allatonce_merged" 2193e662e0bSHong Zhang #define MATPRODUCTALGORITHMALLGATHERV "allgatherv" 2203e662e0bSHong Zhang #define MATPRODUCTALGORITHMCYCLIC "cyclic" 2213e662e0bSHong Zhang #if defined(PETSC_HAVE_HYPRE) 2223e662e0bSHong Zhang #define MATPRODUCTALGORITHMHYPRE "hypre" 2233e662e0bSHong Zhang #endif 2244222ddf1SHong Zhang 2254222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductCreate(Mat,Mat,Mat,Mat*); 2264222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductCreateWithMat(Mat,Mat,Mat,Mat); 2274222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductSetType(Mat,MatProductType); 2284222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductSetAlgorithm(Mat,MatProductAlgorithm); 2294222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductSetFill(Mat,PetscReal); 2304222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductSetFromOptions(Mat); 2314222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductSymbolic(Mat); 2324222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductNumeric(Mat); 2334222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatProductReplaceMats(Mat,Mat,Mat,Mat); 2344417c5e8SHong Zhang PETSC_EXTERN PetscErrorCode MatProductClear(Mat); 2356718818eSStefano Zampini PETSC_EXTERN PetscErrorCode MatProductView(Mat,PetscViewer); 236c600787bSStefano Zampini PETSC_EXTERN PetscErrorCode MatProductGetType(Mat,MatProductType*); 237c600787bSStefano Zampini PETSC_EXTERN PetscErrorCode MatProductGetMats(Mat,Mat*,Mat*,Mat*); 2384222ddf1SHong Zhang 239c06d978dSMatthew Knepley /* Logging support */ 2400700a824SBarry Smith #define MAT_FILE_CLASSID 1211216 /* used to indicate matrices in binary files */ 241014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_CLASSID; 242335efc43SPeter Brune PETSC_EXTERN PetscClassId MAT_COLORING_CLASSID; 243014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_FDCOLORING_CLASSID; 244014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_TRANSPOSECOLORING_CLASSID; 245014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_PARTITIONING_CLASSID; 246014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_COARSEN_CLASSID; 247014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_NULLSPACE_CLASSID; 248014dd563SJed Brown PETSC_EXTERN PetscClassId MATMFFD_CLASSID; 249c06d978dSMatthew Knepley 250ceb03754SKris Buschelman /*E 2517dae84e0SHong Zhang MatReuse - Indicates if matrices obtained from a previous call to MatCreateSubMatrices(), MatCreateSubMatrix(), MatConvert() or several other functions 252cf37664fSBarry Smith are to be reused to store the new matrix values. 253cf37664fSBarry Smith 254cf37664fSBarry Smith $ MAT_INITIAL_MATRIX - create a new matrix 255cf37664fSBarry Smith $ MAT_REUSE_MATRIX - reuse the matrix created with a previous call that used MAT_INITIAL_MATRIX 256cf37664fSBarry Smith $ MAT_INPLACE_MATRIX - replace the first input matrix with the new matrix (not applicable to all functions) 257cf37664fSBarry 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) 258ceb03754SKris Buschelman 259ceb03754SKris Buschelman Level: beginner 260ceb03754SKris Buschelman 261af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 262ceb03754SKris Buschelman 263db781477SPatrick Sanan .seealso: `MatCreateSubMatrices()`, `MatCreateSubMatrix()`, `MatDestroyMatrices()`, `MatConvert()` 264ceb03754SKris Buschelman E*/ 265511c6705SHong Zhang typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX,MAT_INPLACE_MATRIX} MatReuse; 266ceb03754SKris Buschelman 2675494a064SHong Zhang /*E 2687dae84e0SHong Zhang MatCreateSubMatrixOption - Indicates if matrices obtained from a call to MatCreateSubMatrices() 269446c23c1SPierre Jolivet include the matrix values. Currently it is only used by MatGetSeqNonzeroStructure(). 2705494a064SHong Zhang 2715494a064SHong Zhang Level: beginner 2725494a064SHong Zhang 273db781477SPatrick Sanan .seealso: `MatGetSeqNonzeroStructure()` 2745494a064SHong Zhang E*/ 2757dae84e0SHong Zhang typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatCreateSubMatrixOption; 2765494a064SHong Zhang 277607a6623SBarry Smith PETSC_EXTERN PetscErrorCode MatInitializePackage(void); 278c06d978dSMatthew Knepley 279014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm,Mat*); 280014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt); 28119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatSetType(Mat,MatType); 2820d229a57SStefano Zampini PETSC_EXTERN PetscErrorCode MatGetVecType(Mat,VecType*); 2830d229a57SStefano Zampini PETSC_EXTERN PetscErrorCode MatSetVecType(Mat,VecType); 284014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat); 285fe2efc57SMark PETSC_EXTERN PetscErrorCode MatViewFromOptions(Mat,PetscObject,const char[]); 286bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatRegister(const char[],PetscErrorCode(*)(Mat)); 28723bebc0bSBarry Smith PETSC_EXTERN PetscErrorCode MatRegisterRootName(const char[],const char[],const char[]); 288014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat,const char[]); 28926cc229bSBarry Smith PETSC_EXTERN PetscErrorCode MatSetOptionsPrefixFactor(Mat,const char[]); 29026cc229bSBarry Smith PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefixFactor(Mat,const char[]); 291014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat,const char[]); 292014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat,const char*[]); 29384d44b13SHong Zhang PETSC_EXTERN PetscErrorCode MatSetErrorIfFailure(Mat,PetscBool); 294f69a0ea3SMatthew Knepley 295140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatList; 296140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatColoringList; 297140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatPartitioningList; 29828988994SBarry Smith 2993b224e63SBarry Smith /*E 300aa6c7ce3SBarry Smith MatStructure - Indicates if two matrices have the same nonzero structure 3013b224e63SBarry Smith 3023b224e63SBarry Smith Level: beginner 3033b224e63SBarry Smith 304531d0c6aSBarry Smith $ SAME_NONZERO_PATTERN - the two matrices have identical nonzero patterns 305531d0c6aSBarry Smith $ DIFFERENT_NONZERO_PATTERN - the two matrices may have different nonzero patterns 306531d0c6aSBarry Smith $ SUBSET_NONZERO_PATTERN - the nonzero pattern of the second matrix is a subset of the nonzero pattern of the first matrix 307531d0c6aSBarry 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 308531d0c6aSBarry Smith 309531d0c6aSBarry Smith Developer Notes: 310d60b7d5cSBarry Smith Any additions/changes here MUST also be made in src/mat/f90-mod/petscmat.h 3113b224e63SBarry Smith 312db781477SPatrick Sanan .seealso: `MatCopy()`, `MatAXPY()`, `MatAYPX()` 3133b224e63SBarry Smith E*/ 314d60b7d5cSBarry Smith typedef enum {DIFFERENT_NONZERO_PATTERN,SUBSET_NONZERO_PATTERN,SAME_NONZERO_PATTERN,UNKNOWN_NONZERO_PATTERN} MatStructure; 315d60b7d5cSBarry Smith PETSC_EXTERN const char *const MatStructures[]; 3163b224e63SBarry Smith 3179779e05dSSatish Balay #if defined PETSC_HAVE_MKL_SPARSE 318ddee360bSSatish Balay PETSC_EXTERN PetscErrorCode MatCreateSeqAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 319ddee360bSSatish Balay PETSC_EXTERN PetscErrorCode MatCreateMPIAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 32080095d54SIrina Sokolova PETSC_EXTERN PetscErrorCode MatCreateBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 321ddee360bSSatish Balay PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 32280095d54SIrina Sokolova #endif 323cd929ea3SAlp Dener 324d4002b98SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSeqSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 325d4002b98SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 326d4002b98SHong Zhang PETSC_EXTERN PetscErrorCode MatSeqSELLSetPreallocation(Mat,PetscInt,const PetscInt[]); 327d4002b98SHong Zhang PETSC_EXTERN PetscErrorCode MatMPISELLSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 32880095d54SIrina Sokolova 329014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*); 330014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*); 331014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 332014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 333014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*); 3348f8f2f0dSBarry Smith PETSC_EXTERN PetscErrorCode MatUpdateMPIAIJWithArrays(Mat,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 3356a3d2595SBarry Smith PETSC_EXTERN PetscErrorCode MatUpdateMPIAIJWithArray(Mat,const PetscScalar []); 336014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*); 3373b00a383SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSeqAIJ(MPI_Comm,Mat,Mat,const PetscInt[],Mat*); 3383b00a383SHong Zhang 339014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 340014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 341014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*); 3427e8381f9SStefano Zampini 34382a78a4eSJed Brown PETSC_EXTERN PetscErrorCode MatSetPreallocationCOO(Mat,PetscCount,const PetscInt[],const PetscInt[]); 34482a78a4eSJed Brown PETSC_EXTERN PetscErrorCode MatSetPreallocationCOOLocal(Mat,PetscCount,PetscInt[],PetscInt[]); 3457e8381f9SStefano Zampini PETSC_EXTERN PetscErrorCode MatSetValuesCOO(Mat,const PetscScalar[],InsertMode); 346d21a29f3SJed Brown 347014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*); 348014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 349d21a29f3SJed Brown 350014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 351014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *); 35238f409ebSLisandro Dalcin PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 353014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 3544cce697cSJed Brown PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],const PetscInt[]); 355dfb205c3SBarry Smith 356014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*); 357c1fff1c6SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatCreateCentering(MPI_Comm,PetscInt,PetscInt,Mat*); 358014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat,Mat*); 359c5e4d11fSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatCreateNormalHermitian(Mat,Mat*); 360986c4d72SJose E. Roman PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat,Mat,Vec,Mat,Mat*); 361267ca84cSJose E. Roman PETSC_EXTERN PetscErrorCode MatLRCGetMats(Mat,Mat*,Mat*,Vec*,Mat*); 362c5e4d11fSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,ISLocalToGlobalMapping,Mat*); 363014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 364014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 365c0cdd4a1SDahai Guo 366014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*); 367014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter); 368014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*); 369014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*); 370014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat,Mat); 371014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat); 3728c8613bfSJakub Kruzik typedef enum {MAT_COMPOSITE_MERGE_RIGHT,MAT_COMPOSITE_MERGE_LEFT} MatCompositeMergeType; 3738c8613bfSJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeSetMergeType(Mat,MatCompositeMergeType); 374014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*); 3756d7c1e57SBarry Smith typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType; 376014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat,MatCompositeType); 3776dbc55e5SJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetType(Mat,MatCompositeType*); 3783b35acafSJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeSetMatStructure(Mat,MatStructure); 3793b35acafSJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetMatStructure(Mat,MatStructure*); 3806d0add67SJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetNumberMat(Mat,PetscInt*); 3818b5c3584SJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetMat(Mat,PetscInt,Mat*); 38203049c21SJunchao Zhang PETSC_EXTERN PetscErrorCode MatCompositeSetScalings(Mat,const PetscScalar*); 3836d7c1e57SBarry Smith 38419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateFFT(MPI_Comm,PetscInt,const PetscInt[],MatType,Mat*); 385014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqCUFFT(MPI_Comm,PetscInt,const PetscInt[],Mat*); 386dedccee8SHong Zhang 387014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*); 3888060fb66Sstefano_zampini PETSC_EXTERN PetscErrorCode MatTransposeGetMat(Mat,Mat*); 389d0de2241SAndrew Spott PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat,Mat*); 39006511a5cSPierre Jolivet PETSC_EXTERN PetscErrorCode MatHermitianTransposeGetMat(Mat,Mat*); 391fa80d070SPierre Jolivet PETSC_EXTERN PetscErrorCode MatNormalGetMat(Mat,Mat*); 39265f45395SPierre Jolivet PETSC_EXTERN PetscErrorCode MatNormalHermitianGetMat(Mat,Mat*); 39354e05e6cSHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatrixVirtual(Mat,IS,IS,Mat*); 39454e05e6cSHong Zhang PETSC_EXTERN PetscErrorCode MatSubMatrixVirtualUpdate(Mat,Mat,IS,IS); 395014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*); 3963423f386SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateConstantDiagonal(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar,Mat*); 3971472f72bSBarry Smith 398978814f1SStefano Zampini #if defined(PETSC_HAVE_HYPRE) 399d975228cSstefano_zampini PETSC_EXTERN PetscErrorCode MatHYPRESetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 400978814f1SStefano Zampini #endif 401978814f1SStefano Zampini 402014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPythonSetType(Mat,const char[]); 4031d6018f0SLisandro Dalcin 404846b4da1SFande Kong PETSC_EXTERN PetscErrorCode MatResetPreallocation(Mat); 405014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetUp(Mat); 406014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDestroy(Mat*); 407e56f5c9eSBarry Smith PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat,PetscObjectState*); 40821c89e3eSBarry Smith 409014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatConjugate(Mat); 410014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRealPart(Mat); 411014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat); 412014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,Mat*); 413014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetTrace(Mat,PetscScalar*); 414713ccfa9SJed Brown PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat,const PetscScalar **); 4150da83c2eSBarry Smith PETSC_EXTERN PetscErrorCode MatInvertVariableBlockDiagonal(Mat,PetscInt,const PetscInt*,PetscScalar*); 416479a70c0SJed Brown PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonalMat(Mat,Mat); 4178a9c020eSBarry Smith PETSC_EXTERN PetscErrorCode MatInvertVariableBlockEnvelope(Mat,MatReuse,Mat*); 41899cafbc1SBarry Smith 4198ed539a5SBarry Smith /* ------------------------------------------------------------*/ 420014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 4218a9c020eSBarry Smith PETSC_EXTERN PetscErrorCode MatSetValuesIS(Mat,IS,IS,const PetscScalar[],InsertMode); 422014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 423014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]); 424014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]); 425014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat,PetscInt,PetscInt,PetscInt[],const PetscScalar[]); 42673a71a0fSBarry Smith PETSC_EXTERN PetscErrorCode MatSetRandom(Mat,PetscRandom); 42784cb2905SBarry Smith 4282ef4de8bSBarry Smith /*S 4292ef4de8bSBarry Smith MatStencil - Data structure (C struct) for storing information about a single row or 43062ef0227SBarry Smith column of a matrix as indexed on an associated grid. These are arguments to MatSetStencil() and MatSetBlockStencil() 43162ef0227SBarry Smith 43262ef0227SBarry 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). 43362ef0227SBarry 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. 43462ef0227SBarry Smith 43562ef0227SBarry Smith For stencil access to vectors see DMDAVecGetArray(), DMDAVecGetArrayF90(). 436be479b30SJed Brown 437be479b30SJed Brown Fortran usage is different, see MatSetValuesStencil() for details. 4382ef4de8bSBarry Smith 4392ef4de8bSBarry Smith Level: beginner 4402ef4de8bSBarry Smith 441db781477SPatrick Sanan .seealso: `MatSetValuesStencil()`, `MatSetStencil()`, `MatSetValuesBlockedStencil()`, `DMDAVecGetArray()`, `DMDAVecGetArrayF90()` 4422ef4de8bSBarry Smith S*/ 443435da068SBarry Smith typedef struct { 444c1ac3661SBarry Smith PetscInt k,j,i,c; 445435da068SBarry Smith } MatStencil; 4462ef4de8bSBarry Smith 447014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 448014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 449014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt); 450435da068SBarry Smith 451d91e6319SBarry Smith /*E 452d91e6319SBarry Smith MatAssemblyType - Indicates if the matrix is now to be used, or if you plan 45362ef0227SBarry Smith to continue to add or insert values to it 454d91e6319SBarry Smith 455d91e6319SBarry Smith Level: beginner 456d91e6319SBarry Smith 457db781477SPatrick Sanan .seealso: `MatAssemblyBegin()`, `MatAssemblyEnd()` 458d91e6319SBarry Smith E*/ 4596d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType; 460014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType); 461014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType); 462014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssembled(Mat,PetscBool *); 4634f9c727eSBarry Smith 464d91e6319SBarry Smith /*E 465d91e6319SBarry Smith MatOption - Options that may be set for a matrix and its behavior or storage 466d91e6319SBarry Smith 467d91e6319SBarry Smith Level: beginner 468d91e6319SBarry Smith 469af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 4700f8fb01aSBarry Smith Any additions/changes here must also be made in src/mat/interface/dlregismat.c in MatOptions[] 471d91e6319SBarry Smith 47295452b02SPatrick Sanan Developer Notes: 47395452b02SPatrick Sanan Entries that are negative need not be called collectively by all processes. 474382164b0SBarry Smith 475db781477SPatrick Sanan .seealso: `MatSetOption()` 476d91e6319SBarry Smith E*/ 477c5e4d11fSDmitry Karpeev typedef enum {MAT_OPTION_MIN = -3, 478c5e4d11fSDmitry Karpeev MAT_UNUSED_NONZERO_LOCATION_ERR = -2, 47992d4d306SBarry Smith MAT_ROW_ORIENTED = -1, 480382164b0SBarry Smith MAT_SYMMETRIC = 1, 481382164b0SBarry Smith MAT_STRUCTURALLY_SYMMETRIC = 2, 4828c78258cSHong Zhang MAT_FORCE_DIAGONAL_ENTRIES = 3, 483382164b0SBarry Smith MAT_IGNORE_OFF_PROC_ENTRIES = 4, 484382164b0SBarry Smith MAT_USE_HASH_TABLE = 5, 485382164b0SBarry Smith MAT_KEEP_NONZERO_PATTERN = 6, 486382164b0SBarry Smith MAT_IGNORE_ZERO_ENTRIES = 7, 487382164b0SBarry Smith MAT_USE_INODES = 8, 488382164b0SBarry Smith MAT_HERMITIAN = 9, 489382164b0SBarry Smith MAT_SYMMETRY_ETERNAL = 10, 490c5e4d11fSDmitry Karpeev MAT_NEW_NONZERO_LOCATION_ERR = 11, 491382164b0SBarry Smith MAT_IGNORE_LOWER_TRIANGULAR = 12, 492382164b0SBarry Smith MAT_ERROR_LOWER_TRIANGULAR = 13, 493382164b0SBarry Smith MAT_GETROW_UPPERTRIANGULAR = 14, 494382164b0SBarry Smith MAT_SPD = 15, 49592d4d306SBarry Smith MAT_NO_OFF_PROC_ZERO_ROWS = 16, 49692d4d306SBarry Smith MAT_NO_OFF_PROC_ENTRIES = 17, 49792d4d306SBarry Smith MAT_NEW_NONZERO_LOCATIONS = 18, 498c5e4d11fSDmitry Karpeev MAT_NEW_NONZERO_ALLOCATION_ERR = 19, 499c5e4d11fSDmitry Karpeev MAT_SUBSET_OFF_PROC_ENTRIES = 20, 500c10200c1SHong Zhang MAT_SUBMAT_SINGLEIS = 21, 501957cac9fSHong Zhang MAT_STRUCTURE_ONLY = 22, 502071fcb05SBarry Smith MAT_SORTED_FULL = 23, 5031a2c6b5cSJunchao Zhang MAT_FORM_EXPLICIT_TRANSPOSE = 24, 504*b94d7dedSBarry Smith MAT_STRUCTURAL_SYMMETRY_ETERNAL = 25, 505*b94d7dedSBarry Smith MAT_SPD_ETERNAL = 26, 506*b94d7dedSBarry Smith MAT_OPTION_MAX = 27} MatOption; 507e057df02SPaul Mullowney 5080f8fb01aSBarry Smith PETSC_EXTERN const char *const *MatOptions; 509014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscBool); 5107d68702bSBarry Smith PETSC_EXTERN PetscErrorCode MatGetOption(Mat,MatOption,PetscBool*); 511856afa8bSStefano Zampini PETSC_EXTERN PetscErrorCode MatPropagateSymmetryOptions(Mat,Mat); 51219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatGetType(Mat,MatType*); 51384cb2905SBarry Smith 514014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]); 515014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 516014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 517014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat); 518014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat); 519014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt); 5208c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat,PetscScalar *[]); 5218f1ea47aSStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJGetArrayRead(Mat,const PetscScalar *[]); 522d67d9f35SJunchao Zhang PETSC_EXTERN PetscErrorCode MatSeqAIJGetArrayWrite(Mat,PetscScalar *[]); 5238c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat,PetscScalar *[]); 5248f1ea47aSStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArrayRead(Mat,const PetscScalar *[]); 525d67d9f35SJunchao Zhang PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArrayWrite(Mat,PetscScalar *[]); 52621e72a00SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJGetMaxRowNonzeros(Mat,PetscInt*); 527bd04181cSBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJSetValuesLocalFast(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 5284099cc6bSBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJSetType(Mat,MatType); 529ad7e164aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatSeqAIJKron(Mat,Mat,MatReuse,Mat*); 530388d47a6SSatish Balay PETSC_EXTERN PetscErrorCode MatSeqAIJRegister(const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat *)); 5314099cc6bSBarry Smith PETSC_EXTERN PetscFunctionList MatSeqAIJList; 532cda14afcSprj- PETSC_EXTERN PetscErrorCode MatSeqBAIJGetArray(Mat,PetscScalar *[]); 533cda14afcSprj- PETSC_EXTERN PetscErrorCode MatSeqBAIJRestoreArray(Mat,PetscScalar *[]); 5348397e458SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqSBAIJGetArray(Mat,PetscScalar *[]); 5358397e458SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqSBAIJRestoreArray(Mat,PetscScalar *[]); 5368c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat,PetscScalar *[]); 5378c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat,PetscScalar *[]); 538d3042a70SBarry Smith PETSC_EXTERN PetscErrorCode MatDensePlaceArray(Mat,const PetscScalar[]); 539d5ea218eSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseReplaceArray(Mat,const PetscScalar[]); 540d3042a70SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseResetArray(Mat); 5418572280aSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetArrayRead(Mat,const PetscScalar *[]); 5428572280aSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayRead(Mat,const PetscScalar *[]); 5436947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseGetArrayWrite(Mat,PetscScalar *[]); 5446947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayWrite(Mat,PetscScalar *[]); 545014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *); 546014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt); 547014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat,PetscInt *,PetscInt *); 548014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat,PetscInt,PetscInt); 54933d57670SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSizesFromMats(Mat,Mat,Mat); 5500da83c2eSBarry Smith PETSC_EXTERN PetscErrorCode MatSetVariableBlockSizes(Mat,PetscInt,PetscInt*); 5510da83c2eSBarry Smith PETSC_EXTERN PetscErrorCode MatGetVariableBlockSizes(Mat,PetscInt*,const PetscInt**); 5520da83c2eSBarry Smith 55386aefd0dSHong Zhang PETSC_EXTERN PetscErrorCode MatDenseGetColumn(Mat,PetscInt,PetscScalar*[]); 55486aefd0dSHong Zhang PETSC_EXTERN PetscErrorCode MatDenseRestoreColumn(Mat,PetscScalar*[]); 5556947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseGetColumnVec(Mat,PetscInt,Vec*); 5566947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVec(Mat,PetscInt,Vec*); 5576947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecRead(Mat,PetscInt,Vec*); 5586947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecRead(Mat,PetscInt,Vec*); 5596947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecWrite(Mat,PetscInt,Vec*); 5606947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecWrite(Mat,PetscInt,Vec*); 561a2748737SPierre Jolivet PETSC_EXTERN PetscErrorCode MatDenseGetSubMatrix(Mat,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 5625ea7661aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatDenseRestoreSubMatrix(Mat,Mat*); 5631620fd73SBarry Smith 564014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMult(Mat,Vec,Vec); 565014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec); 566014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec); 567014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec); 568014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec); 569014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *); 570014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *); 571014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec); 572014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec); 573014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat); 574bdc285e1SStefano Zampini PETSC_EXTERN PetscErrorCode MatMatSolveTranspose(Mat,Mat,Mat); 575eb3ef3b2SHong Zhang PETSC_EXTERN PetscErrorCode MatMatTransposeSolve(Mat,Mat,Mat); 576f9426fe0SMark Adams PETSC_EXTERN PetscErrorCode MatResidual(Mat,Vec,Vec,Vec); 577f5edf698SHong Zhang 578d91e6319SBarry Smith /*E 579d91e6319SBarry Smith MatDuplicateOption - Indicates if a duplicated sparse matrix should have 580d91e6319SBarry Smith its numerical values copied over or just its nonzero structure. 581d91e6319SBarry Smith 582d91e6319SBarry Smith Level: beginner 583d91e6319SBarry Smith 584af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 585d91e6319SBarry Smith 5860018da39SRichard Tran Mills $ MAT_DO_NOT_COPY_VALUES - Create a matrix using the same nonzero pattern as the original matrix, 5870018da39SRichard Tran Mills $ with zeros for the numerical values. 5880018da39SRichard Tran Mills $ MAT_COPY_VALUES - Create a matrix with the same nonzero pattern as the original matrix 5890018da39SRichard Tran Mills $ and with the same numerical values. 5900018da39SRichard Tran Mills $ MAT_SHARE_NONZERO_PATTERN - Create a matrix that shares the nonzero structure with the previous matrix 5910018da39SRichard Tran Mills $ and does not copy it, using zeros for the numerical values. The parent and 5920018da39SRichard Tran Mills $ child matrices will share their index (i and j) arrays, and you cannot 5930018da39SRichard Tran Mills $ insert new nonzero entries into either matrix. 5940018da39SRichard Tran Mills 59595452b02SPatrick Sanan Notes: 59695452b02SPatrick Sanan Many matrix types (including SeqAIJ) do not support the MAT_SHARE_NONZERO_PATTERN optimization; in 5970018da39SRichard Tran Mills this case the behavior is as if MAT_DO_NOT_COPY_VALUES has been specified. 59870dcbbb9SBarry Smith 599db781477SPatrick Sanan .seealso: `MatDuplicate()` 600d91e6319SBarry Smith E*/ 60170dcbbb9SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption; 6022e8a6d31SBarry Smith 60319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*); 604014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*); 60594a9d846SBarry Smith 606014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure); 607014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer); 608014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *); 609014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *); 610014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *); 611014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *); 612014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *); 613*b94d7dedSBarry Smith PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetricKnown(Mat,PetscBool *,PetscBool*); 614*b94d7dedSBarry Smith PETSC_EXTERN PetscErrorCode MatIsSPDKnown(Mat,PetscBool*,PetscBool*); 615014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool *,PetscInt *); 616014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer); 6177b80b807SBarry Smith 6181a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *); 6191a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *); 6201a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *); 6211a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *); 622d4fbbf0eSBarry Smith 623d91e6319SBarry Smith /*S 624d91e6319SBarry Smith MatInfo - Context of matrix information, used with MatGetInfo() 625d91e6319SBarry Smith 626d91e6319SBarry Smith In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE 627d91e6319SBarry Smith 628d91e6319SBarry Smith Level: intermediate 629d91e6319SBarry Smith 630db781477SPatrick Sanan .seealso: `MatGetInfo()`, `MatInfoType` 631d91e6319SBarry Smith S*/ 6324e220ebcSLois Curfman McInnes typedef struct { 633b0a32e0cSBarry Smith PetscLogDouble block_size; /* block size */ 634b0a32e0cSBarry Smith PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */ 635b0a32e0cSBarry Smith PetscLogDouble memory; /* memory allocated */ 636b0a32e0cSBarry Smith PetscLogDouble assemblies; /* number of matrix assemblies called */ 637b0a32e0cSBarry Smith PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */ 638b0a32e0cSBarry Smith PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */ 639b0a32e0cSBarry Smith PetscLogDouble factor_mallocs; /* number of mallocs during factorization */ 6404e220ebcSLois Curfman McInnes } MatInfo; 6414e220ebcSLois Curfman McInnes 642d9274352SBarry Smith /*E 643d9274352SBarry Smith MatInfoType - Indicates if you want information about the local part of the matrix, 644d9274352SBarry Smith the entire parallel matrix or the maximum over all the local parts. 645d9274352SBarry Smith 646d9274352SBarry Smith Level: beginner 647d9274352SBarry Smith 648af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 649d9274352SBarry Smith 650db781477SPatrick Sanan .seealso: `MatGetInfo()`, `MatInfo` 651d9274352SBarry Smith E*/ 6527b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType; 653014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*); 654014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec); 655014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]); 656014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]); 657014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]); 658014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]); 659014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat,Vec); 660014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*); 661014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*); 662014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat*); 663014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec); 664014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode); 665a52676ecSHong Zhang 666014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool*); 667014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool*); 668014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool*); 669014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool*); 670014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*); 671e573050aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeEqual(Mat,Mat,PetscInt,PetscBool*); 672e573050aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*); 673a52676ecSHong Zhang PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 674a52676ecSHong Zhang PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 675cc48ffa7SToby Isaac PETSC_EXTERN PetscErrorCode MatMatTransposeMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 6764222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatPtAPMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 677447fed29SStefano Zampini PETSC_EXTERN PetscErrorCode MatRARtMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 67886919fd6SHong Zhang PETSC_EXTERN PetscErrorCode MatIsLinear(Mat,PetscInt,PetscBool*); 6797b80b807SBarry Smith 680014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal*); 681014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal*); 682857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnSums(Mat,PetscScalar*); 683857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnSumsRealPart(Mat,PetscReal*); 684857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnSumsImaginaryPart(Mat,PetscReal*); 685857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnMeans(Mat,PetscScalar*); 686857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnMeansRealPart(Mat,PetscReal*); 687857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnMeansImaginaryPart(Mat,PetscReal*); 688857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnReductions(Mat,PetscInt,PetscReal*); 689014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat); 6901b2b9847SBarry Smith PETSC_EXTERN PetscErrorCode MatSetInf(Mat); 691014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 692014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec); 693014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec); 694014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec); 695014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 696014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec); 6977b80b807SBarry Smith 698014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*); 699014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*); 700014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*); 701014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**); 702014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*); 703014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**); 704566876eaSJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*); 7055ef9f2a5SBarry Smith 7067dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 7079fbee547SJacob 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);} 7087dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 7099fbee547SJacob 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);} 710014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]); 711df750dc8SHong Zhang PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt,Mat *[]); 7127dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,MatReuse,Mat *); 7139fbee547SJacob 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);} 714014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*); 715014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*); 716014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*); 717014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*); 7187b80b807SBarry Smith 719014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*); 720014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*); 721014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat); 722014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*); 7238a9c020eSBarry Smith PETSC_EXTERN PetscErrorCode MatAIJGetLocalMat(Mat,Mat*); 724014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*); 725ed502f03SStefano Zampini PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatMerge(Mat,MatReuse,IS*,Mat*); 726f2afee66SBarry Smith PETSC_EXTERN PetscErrorCode MatMPIAIJGetNumberNonzeros(Mat,PetscCount*); 727014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*); 728014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]); 7298efafbd8SBarry Smith 730014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt); 731aa1e27eaSFande Kong PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat mat,PetscInt n,IS is[],PetscInt ov); 732d2b2a242SBarry Smith PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat,PetscBool); 7337b80b807SBarry Smith 734014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 73522440eb1SKris Buschelman 7367bab7c10SHong Zhang PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*); 7372df6c5c3SPatrick Farrell PETSC_EXTERN PetscErrorCode MatGalerkin(Mat,Mat,Mat,MatReuse,PetscReal,Mat*); 7387bab7c10SHong Zhang 739014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*); 740014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*); 74122440eb1SKris Buschelman 742014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 743014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*); 744bc011b1eSHong Zhang 745014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure); 746014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure); 7471c741599SHong Zhang 748014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar); 749014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar); 7507b80b807SBarry Smith 751014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping); 752014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*); 753a93ff8c4SPeter Brune PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat,PetscLayout*,PetscLayout*); 75481fa06acSBarry Smith PETSC_EXTERN PetscErrorCode MatSetLayouts(Mat,PetscLayout,PetscLayout); 755014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 756014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec); 757014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 758014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec); 759e265f6d6SPatrick Sanan PETSC_EXTERN PetscErrorCode MatGetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]); 760014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 761014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 762052efed2SBarry Smith 763014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt); 764014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 76590f02eecSBarry Smith 766014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec); 767014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec); 768014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec); 76930b0564aSStefano Zampini PETSC_EXTERN PetscErrorCode MatMatInterpolate(Mat,Mat,Mat*); 77030b0564aSStefano Zampini PETSC_EXTERN PetscErrorCode MatMatInterpolateAdd(Mat,Mat,Mat,Mat*); 77130b0564aSStefano Zampini PETSC_EXTERN PetscErrorCode MatMatRestrict(Mat,Mat,Mat*); 7722a7a6963SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat,Vec*,Vec*); 7739fbee547SJacob 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);} 77453cd1579SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat,PetscInt,MPI_Comm,MatReuse,Mat*); 775014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*); 776014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*); 7773a062f41SBarry Smith PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat,IS*); 7789c8f2541SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm,Mat,PetscInt,MatReuse,Mat*); 779bd481603SBarry Smith 780bd481603SBarry Smith /*MC 7811620fd73SBarry Smith MatSetValue - Set a single entry into a matrix. 7821620fd73SBarry Smith 7831620fd73SBarry Smith Not collective 7841620fd73SBarry Smith 785a9834a7dSSatish Balay Synopsis: 786a9834a7dSSatish Balay #include <petscmat.h> 787a9834a7dSSatish Balay PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode) 788a9834a7dSSatish Balay 7891620fd73SBarry Smith Input Parameters: 7901620fd73SBarry Smith + m - the matrix 7911620fd73SBarry Smith . row - the row location of the entry 7921620fd73SBarry Smith . col - the column location of the entry 7931620fd73SBarry Smith . value - the value to insert 7941620fd73SBarry Smith - mode - either INSERT_VALUES or ADD_VALUES 7951620fd73SBarry Smith 7961620fd73SBarry Smith Notes: 797e5e5a7b5SPatrick Sanan For efficiency one should use MatSetValues() and set several values simultaneously. 7981620fd73SBarry Smith 7991620fd73SBarry Smith Level: beginner 8001620fd73SBarry Smith 801db781477SPatrick Sanan .seealso: `MatGetValue()`, `MatSetValues()`, `MatSetValueLocal()`, `MatSetValuesLocal()` 8021620fd73SBarry Smith M*/ 8039fbee547SJacob Faibussowitsch static inline PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);} 8041620fd73SBarry Smith 805e5e5a7b5SPatrick Sanan /*@C 806e5e5a7b5SPatrick Sanan MatGetValue - Gets a single value from a matrix 8071620fd73SBarry Smith 808e5e5a7b5SPatrick Sanan Not Collective; can only return a value owned by the given process 809e5e5a7b5SPatrick Sanan 810e5e5a7b5SPatrick Sanan Input Parameters: 811e5e5a7b5SPatrick Sanan + mat - the matrix 812e5e5a7b5SPatrick Sanan . row - the row location of the entry 813e5e5a7b5SPatrick Sanan - col - the column location of the entry 814e5e5a7b5SPatrick Sanan 815e5e5a7b5SPatrick Sanan Output Parameter: 816e5e5a7b5SPatrick Sanan . va - the value 817e5e5a7b5SPatrick Sanan 818e5e5a7b5SPatrick Sanan Notes: 819e5e5a7b5SPatrick Sanan For efficiency one should use MatGetValues() and get several values simultaneously. 820e5e5a7b5SPatrick Sanan 821e5e5a7b5SPatrick Sanan See notes for MatGetValues(). 822e5e5a7b5SPatrick Sanan 823e5e5a7b5SPatrick Sanan Level: advanced 824e5e5a7b5SPatrick Sanan 825db781477SPatrick Sanan .seealso: `MatSetValue()`, `MatGetValueLocal()`, `MatGetValues()` 826e5e5a7b5SPatrick Sanan @*/ 8279fbee547SJacob Faibussowitsch static inline PetscErrorCode MatGetValue(Mat mat,PetscInt row,PetscInt col,PetscScalar *va) {return MatGetValues(mat,1,&row,1,&col,va);} 828e5e5a7b5SPatrick Sanan 829e5e5a7b5SPatrick Sanan /*MC 830e5e5a7b5SPatrick Sanan MatSetValueLocal - Inserts or adds a single value into a matrix, 831e5e5a7b5SPatrick Sanan using a local numbering of the nodes. 832e5e5a7b5SPatrick Sanan 833e5e5a7b5SPatrick Sanan Not Collective 834e5e5a7b5SPatrick Sanan 835e5e5a7b5SPatrick Sanan Input Parameters: 836e5e5a7b5SPatrick Sanan + m - the matrix 837e5e5a7b5SPatrick Sanan . row - the row location of the entry 838e5e5a7b5SPatrick Sanan . col - the column location of the entry 839e5e5a7b5SPatrick Sanan . value - the value to insert 840e5e5a7b5SPatrick Sanan - mode - either INSERT_VALUES or ADD_VALUES 841e5e5a7b5SPatrick Sanan 842e5e5a7b5SPatrick Sanan Notes: 843e5e5a7b5SPatrick Sanan For efficiency one should use MatSetValuesLocal() and set several values simultaneously. 844e5e5a7b5SPatrick Sanan 845e5e5a7b5SPatrick Sanan See notes for MatSetValuesLocal() for additional information on when and how this function can be used. 846e5e5a7b5SPatrick Sanan 847e5e5a7b5SPatrick Sanan Level: intermediate 848e5e5a7b5SPatrick Sanan 849db781477SPatrick Sanan .seealso: `MatSetValue()`, `MatSetValuesLocal()` 850e5e5a7b5SPatrick Sanan M*/ 8519fbee547SJacob Faibussowitsch static inline PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);} 8521620fd73SBarry Smith 8531620fd73SBarry Smith /*MC 854d0609cedSBarry Smith MatPreallocateBegin - Begins the block of code that will count the number of nonzeros per 855bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 856bd481603SBarry Smith 857bd481603SBarry Smith Synopsis: 858aaa7dc30SBarry Smith #include <petscmat.h> 859d0609cedSBarry Smith PetscErrorCode MatPreallocateBegin(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 860bd481603SBarry Smith 861d083f849SBarry Smith Collective 862bd481603SBarry Smith 863bd481603SBarry Smith Input Parameters: 864bd481603SBarry Smith + comm - the communicator that will share the eventually allocated matrix 865859fcb39SBarry Smith . nrows - the number of LOCAL rows in the matrix 866859fcb39SBarry Smith - ncols - the number of LOCAL columns in the matrix 867bd481603SBarry Smith 868bd481603SBarry Smith Output Parameters: 869bd481603SBarry Smith + dnz - the array that will be passed to the matrix preallocation routines 870a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 871bd481603SBarry Smith 872bd481603SBarry Smith Level: intermediate 873bd481603SBarry Smith 874bd481603SBarry Smith Notes: 875d0609cedSBarry Smith This is a macro that handles its own error checking, it does not return an error code. 876d0609cedSBarry Smith 877a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 878bd481603SBarry Smith 8791d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 880bd481603SBarry Smith 881d0609cedSBarry Smith Developer Notes: 8821620fd73SBarry Smith This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize(). 8831620fd73SBarry Smith 884db781477SPatrick Sanan .seealso: `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`, 885db781477SPatrick Sanan `MatPreallocateSymmetricSetLocalBlock()` 886bd481603SBarry Smith M*/ 887d0609cedSBarry Smith #define MatPreallocateBegin(comm,nrows,ncols,dnz,onz) do { \ 8885f80ce2aSJacob Faibussowitsch PetscInt __nrows = (nrows),__ncols = (ncols),__rstart,__start,__end = 0; \ 8899566063dSJacob Faibussowitsch PetscCall(PetscCalloc2(__nrows,&(dnz),__nrows,&(onz))); \ 8909566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&__ncols,&__end,1,MPIU_INT,MPI_SUM,comm)); \ 8915f80ce2aSJacob Faibussowitsch __start = __end - __ncols; (void)__start; \ 8929566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm)); \ 8935f80ce2aSJacob Faibussowitsch __rstart -= __nrows 8947c922b88SBarry Smith 895d0609cedSBarry Smith #define MatPreallocateInitialize(...) PETSC_DEPRECATED_MACRO("GCC warning \"Use MatPreallocateBegin() (since version 3.18)\"") MatPreallocateBegin(__VA_ARGS__) 896d0609cedSBarry Smith 897bd481603SBarry Smith /*MC 898bd481603SBarry Smith MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 899bd481603SBarry Smith inserted using a local number of the rows and columns 900bd481603SBarry Smith 901bd481603SBarry Smith Synopsis: 902aaa7dc30SBarry Smith #include <petscmat.h> 903c1ac3661SBarry Smith PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 904bd481603SBarry Smith 905bd481603SBarry Smith Not Collective 906bd481603SBarry Smith 907bd481603SBarry Smith Input Parameters: 908784ac674SJed Brown + map - the row mapping from local numbering to global numbering 909bd481603SBarry Smith . nrows - the number of rows indicated 9101d73ed98SBarry Smith . rows - the indices of the rows 911784ac674SJed Brown . cmap - the column mapping from local to global numbering 912bd481603SBarry Smith . ncols - the number of columns in the matrix 913bd481603SBarry Smith . cols - the columns indicated 914bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 915a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 916bd481603SBarry Smith 917bd481603SBarry Smith Level: intermediate 918bd481603SBarry Smith 919bd481603SBarry Smith Notes: 920a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 921bd481603SBarry Smith 9221d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 923bd481603SBarry Smith 924db781477SPatrick Sanan .seealso: `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()` 925db781477SPatrick Sanan `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocalRemoveDups()` 926bd481603SBarry Smith M*/ 92794bad497SJacob Faibussowitsch #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) \ 92894bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 9299566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApply(rmap,nrows,rows,rows)); \ 9309566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApply(cmap,ncols,cols,cols)); \ 9319566063dSJacob Faibussowitsch for (PetscInt __l=0;__l<nrows;__l++) PetscCall(MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz)); \ 93294bad497SJacob Faibussowitsch ) 933c4f061fbSSatish Balay 934bd481603SBarry Smith /*MC 935c1154cd5SBarry Smith MatPreallocateSetLocalRemoveDups - Indicates the locations (rows and columns) in the matrix where nonzeros will be 936c1154cd5SBarry Smith inserted using a local number of the rows and columns. This version removes any duplicate columns in cols 937c1154cd5SBarry Smith 938c1154cd5SBarry Smith Synopsis: 939c1154cd5SBarry Smith #include <petscmat.h> 940c1154cd5SBarry Smith PetscErrorCode MatPreallocateSetLocalRemoveDups(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 941c1154cd5SBarry Smith 942c1154cd5SBarry Smith Not Collective 943c1154cd5SBarry Smith 944c1154cd5SBarry Smith Input Parameters: 945c1154cd5SBarry Smith + map - the row mapping from local numbering to global numbering 946c1154cd5SBarry Smith . nrows - the number of rows indicated 947c1154cd5SBarry Smith . rows - the indices of the rows (these values are mapped to the global values) 948c1154cd5SBarry Smith . cmap - the column mapping from local to global numbering 949c1154cd5SBarry Smith . ncols - the number of columns in the matrix (this value will be changed if duplicate columns are found) 950c1154cd5SBarry Smith . cols - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed) 951c1154cd5SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 952a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 953c1154cd5SBarry Smith 954c1154cd5SBarry Smith Level: intermediate 955c1154cd5SBarry Smith 956c1154cd5SBarry Smith Notes: 957c1154cd5SBarry Smith See Users-Manual: ch_performance for more details. 958c1154cd5SBarry Smith 959c1154cd5SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 960c1154cd5SBarry Smith 961db781477SPatrick Sanan .seealso: `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()` 962db781477SPatrick Sanan `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocal()` 963c1154cd5SBarry Smith M*/ 96494bad497SJacob Faibussowitsch #define MatPreallocateSetLocalRemoveDups(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) \ 96594bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 9669566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApply(rmap,nrows,rows,rows)); \ 9679566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApply(cmap,ncols,cols,cols)); \ 9689566063dSJacob Faibussowitsch PetscCall(PetscSortRemoveDupsInt(&ncols,cols)); \ 9699566063dSJacob Faibussowitsch for (PetscInt __l=0;__l<nrows;__l++) PetscCall(MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz)); \ 97094bad497SJacob Faibussowitsch ) 971c1154cd5SBarry Smith 972c1154cd5SBarry Smith /*MC 973d6e23781SBarry Smith MatPreallocateSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 974bd481603SBarry Smith inserted using a local number of the rows and columns 975bd481603SBarry Smith 976bd481603SBarry Smith Synopsis: 977aaa7dc30SBarry Smith #include <petscmat.h> 978d6e23781SBarry Smith PetscErrorCode MatPreallocateSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 979d6e23781SBarry Smith 980d6e23781SBarry Smith Not Collective 981d6e23781SBarry Smith 982d6e23781SBarry Smith Input Parameters: 983d6e23781SBarry Smith + map - the row mapping from local numbering to global numbering 984d6e23781SBarry Smith . nrows - the number of rows indicated 985d6e23781SBarry Smith . rows - the indices of the rows 986d6e23781SBarry Smith . cmap - the column mapping from local to global numbering 987d6e23781SBarry Smith . ncols - the number of columns in the matrix 988d6e23781SBarry Smith . cols - the columns indicated 989d6e23781SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 990a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 991d6e23781SBarry Smith 992d6e23781SBarry Smith Level: intermediate 993d6e23781SBarry Smith 994d6e23781SBarry Smith Notes: 995d6e23781SBarry Smith See Users-Manual: ch_performance for more details. 996d6e23781SBarry Smith 997d6e23781SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 998d6e23781SBarry Smith 999db781477SPatrick Sanan .seealso: `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()` 1000db781477SPatrick Sanan `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()` 1001d6e23781SBarry Smith M*/ 100294bad497SJacob Faibussowitsch #define MatPreallocateSetLocalBlock(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) \ 100394bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 10049566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApplyBlock(rmap,nrows,rows,rows)); \ 10059566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApplyBlock(cmap,ncols,cols,cols)); \ 10069566063dSJacob Faibussowitsch for (PetscInt __l=0;__l<nrows;__l++) PetscCall(MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz)); \ 100794bad497SJacob Faibussowitsch ) 1008d6e23781SBarry Smith 1009d6e23781SBarry Smith /*MC 1010d6e23781SBarry Smith MatPreallocateSymmetricSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 1011d6e23781SBarry Smith inserted using a local number of the rows and columns 1012d6e23781SBarry Smith 1013d6e23781SBarry Smith Synopsis: 1014d6e23781SBarry Smith #include <petscmat.h> 1015d6e23781SBarry Smith PetscErrorCode MatPreallocateSymmetricSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1016bd481603SBarry Smith 1017bd481603SBarry Smith Not Collective 1018bd481603SBarry Smith 1019bd481603SBarry Smith Input Parameters: 1020bd481603SBarry Smith + map - the mapping between local numbering and global numbering 1021bd481603SBarry Smith . nrows - the number of rows indicated 10221d73ed98SBarry Smith . rows - the indices of the rows 1023bd481603SBarry Smith . ncols - the number of columns in the matrix 1024bd481603SBarry Smith . cols - the columns indicated 1025bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 1026a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 1027bd481603SBarry Smith 1028bd481603SBarry Smith Level: intermediate 1029bd481603SBarry Smith 1030bd481603SBarry Smith Notes: 1031a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 1032bd481603SBarry Smith 1033bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 1034bd481603SBarry Smith 1035db781477SPatrick Sanan .seealso: `MatPreallocateEnd()`, `MatPreallocateSet()` 1036db781477SPatrick Sanan `MatPreallocateBegin()`, `MatPreallocateSetLocal()` 1037bd481603SBarry Smith M*/ 103894bad497SJacob Faibussowitsch #define MatPreallocateSymmetricSetLocalBlock(map,nrows,rows,ncols,cols,dnz,onz) \ 103994bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 10409566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApplyBlock(map,nrows,rows,rows)); \ 10419566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApplyBlock(map,ncols,cols,cols)); \ 10429566063dSJacob Faibussowitsch for (PetscInt __l=0;__l<nrows;__l++) PetscCall(MatPreallocateSymmetricSetBlock((rows)[__l],ncols,cols,dnz,onz)); \ 104394bad497SJacob Faibussowitsch ) 1044e83a5d19SLisandro Dalcin 1045bd481603SBarry Smith /*MC 1046bd481603SBarry Smith MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 1047bd481603SBarry Smith inserted using a local number of the rows and columns 1048bd481603SBarry Smith 1049bd481603SBarry Smith Synopsis: 1050aaa7dc30SBarry Smith #include <petscmat.h> 1051c1ac3661SBarry Smith PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1052bd481603SBarry Smith 1053bd481603SBarry Smith Not Collective 1054bd481603SBarry Smith 1055bd481603SBarry Smith Input Parameters: 105664075487SBarry Smith + row - the row 1057bd481603SBarry Smith . ncols - the number of columns in the matrix 1058a50f8bf6SHong Zhang - cols - the columns indicated 1059a50f8bf6SHong Zhang 1060a50f8bf6SHong Zhang Output Parameters: 1061a50f8bf6SHong Zhang + dnz - the array that will be passed to the matrix preallocation routines 1062a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 1063bd481603SBarry Smith 1064bd481603SBarry Smith Level: intermediate 1065bd481603SBarry Smith 1066bd481603SBarry Smith Notes: 1067a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 1068bd481603SBarry Smith 1069bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 1070bd481603SBarry Smith 1071d0609cedSBarry Smith This is a MACRO not a function because it uses variables declared in MatPreallocateBegin(). 10721620fd73SBarry Smith 1073db781477SPatrick Sanan .seealso: `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()` 1074db781477SPatrick Sanan `MatPreallocateBegin()`, `MatPreallocateSetLocal()` 1075bd481603SBarry Smith M*/ 107694bad497SJacob Faibussowitsch #define MatPreallocateSet(row,nc,cols,dnz,onz) PetscMacroReturnStandard( \ 10772c71b3e2SJacob 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); \ 10782c71b3e2SJacob 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); \ 10795f80ce2aSJacob Faibussowitsch for (PetscInt __i = 0; __i < nc; ++__i) { \ 108064075487SBarry Smith if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \ 1081a6042fd4SStefano Zampini else if (dnz[row - __rstart] < __ncols) dnz[row - __rstart]++; \ 10827c922b88SBarry Smith } \ 108394bad497SJacob Faibussowitsch ) 10847c922b88SBarry Smith 1085bd481603SBarry Smith /*MC 1086d6e23781SBarry Smith MatPreallocateSymmetricSetBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 1087bd481603SBarry Smith inserted using a local number of the rows and columns 1088bd481603SBarry Smith 1089bd481603SBarry Smith Synopsis: 1090aaa7dc30SBarry Smith #include <petscmat.h> 1091d6e23781SBarry Smith PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1092bd481603SBarry Smith 1093bd481603SBarry Smith Not Collective 1094bd481603SBarry Smith 1095bd481603SBarry Smith Input Parameters: 1096bd481603SBarry Smith + nrows - the number of rows indicated 10971d73ed98SBarry Smith . rows - the indices of the rows 1098bd481603SBarry Smith . ncols - the number of columns in the matrix 1099bd481603SBarry Smith . cols - the columns indicated 1100bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 1101a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 1102bd481603SBarry Smith 1103bd481603SBarry Smith Level: intermediate 1104bd481603SBarry Smith 1105bd481603SBarry Smith Notes: 1106a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 1107bd481603SBarry Smith 1108bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 1109bd481603SBarry Smith 1110d0609cedSBarry Smith This is a MACRO not a function because it uses variables declared in MatPreallocateBegin(). 11111620fd73SBarry Smith 1112db781477SPatrick Sanan .seealso: `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateBegin()`, 1113db781477SPatrick Sanan `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocal()` 1114bd481603SBarry Smith M*/ 111594bad497SJacob Faibussowitsch #define MatPreallocateSymmetricSetBlock(row,nc,cols,dnz,onz) \ 111694bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 11175f80ce2aSJacob Faibussowitsch for (PetscInt __i=0; __i<nc; __i++) { \ 1118d3d32019SBarry Smith if (cols[__i] >= __end) onz[row - __rstart]++; \ 1119a6042fd4SStefano Zampini else if (cols[__i] >= row && dnz[row - __rstart] < __ncols) dnz[row - __rstart]++; \ 1120d3d32019SBarry Smith } \ 112194bad497SJacob Faibussowitsch ) 1122d3d32019SBarry Smith 1123bd481603SBarry Smith /*MC 1124a6042fd4SStefano Zampini MatPreallocateLocation - An alternative to MatPreallocateSet() that puts the nonzero locations into the matrix if it exists 112516371a99SBarry Smith 112616371a99SBarry Smith Synopsis: 1127aaa7dc30SBarry Smith #include <petscmat.h> 112816371a99SBarry Smith PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz) 112916371a99SBarry Smith 113016371a99SBarry Smith Not Collective 113116371a99SBarry Smith 113216371a99SBarry Smith Input Parameters: 1133a2b725a8SWilliam Gropp + A - matrix 113416371a99SBarry Smith . row - row where values exist (must be local to this process) 113516371a99SBarry Smith . ncols - number of columns 113616371a99SBarry Smith . cols - columns with nonzeros 113716371a99SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 1138a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 113916371a99SBarry Smith 114016371a99SBarry Smith Level: intermediate 114116371a99SBarry Smith 114216371a99SBarry Smith Notes: 1143a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 114416371a99SBarry Smith 114516371a99SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 114616371a99SBarry Smith 114716371a99SBarry Smith This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines. 114816371a99SBarry Smith 1149db781477SPatrick Sanan .seealso: `MatPreallocateBegin()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`, 1150db781477SPatrick Sanan `MatPreallocateSymmetricSetLocalBlock()` 115116371a99SBarry Smith M*/ 1152d0609cedSBarry 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)) 115316371a99SBarry Smith 115416371a99SBarry Smith /*MC 1155d0609cedSBarry Smith MatPreallocateEnd - Ends the block of code that will count the number of nonzeros per 1156bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 1157bd481603SBarry Smith 1158bd481603SBarry Smith Synopsis: 1159aaa7dc30SBarry Smith #include <petscmat.h> 1160d0609cedSBarry Smith PetscErrorCode MatPreallocateEnd(PetscInt *dnz, PetscInt *onz) 1161bd481603SBarry Smith 1162d083f849SBarry Smith Collective 1163bd481603SBarry Smith 1164bd481603SBarry Smith Input Parameters: 116516371a99SBarry Smith + dnz - the array that was be passed to the matrix preallocation routines 1166a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 1167bd481603SBarry Smith 1168bd481603SBarry Smith Level: intermediate 1169bd481603SBarry Smith 1170bd481603SBarry Smith Notes: 1171d0609cedSBarry Smith This is a macro that handles its own error checking, it does not return an error code. 1172d0609cedSBarry Smith 1173a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 1174bd481603SBarry Smith 1175d0609cedSBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 1176bd481603SBarry Smith 1177d0609cedSBarry Smith Developer Notes: 1178d0609cedSBarry Smith This is a MACRO not a function because it closes the { started in MatPreallocateBegin(). 11791620fd73SBarry Smith 1180db781477SPatrick Sanan .seealso: `MatPreallocateBegin()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`, 1181db781477SPatrick Sanan `MatPreallocateSymmetricSetLocalBlock()` 1182bd481603SBarry Smith M*/ 1183d0609cedSBarry Smith #define MatPreallocateEnd(dnz,onz) PetscCall(PetscFree2(dnz,onz));} while (0) 1184d0609cedSBarry Smith 1185d0609cedSBarry Smith #define MatPreallocateFinalize(...) PETSC_DEPRECATED_MACRO("GCC warning \"Use MatPreallocateEnd() (since version 3.18)\"") MatPreallocateEnd(__VA_ARGS__) 11867c922b88SBarry Smith 11877b80b807SBarry Smith /* Routines unique to particular data structures */ 1188014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat,void *); 1189698d4c6aSKris Buschelman 1190014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*); 1191014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *); 1192698d4c6aSKris Buschelman 1193014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]); 1194014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]); 1195014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1196014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1197014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1198014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool); 11997b80b807SBarry Smith 1200a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4 1201a96a251dSBarry Smith 1202014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1203014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1204014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]); 120519b08ed1SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJSetTotalPreallocation(Mat,PetscInt); 1206273d9f13SBarry Smith 1207014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1208014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1209014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1210014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []); 1211014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 1212014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]); 1213014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 1214014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]); 1215b44e7856SBarry Smith PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat,Mat*); 1216252a1336SBarry Smith PETSC_EXTERN PetscErrorCode MatMPIAdjToSeqRankZero(Mat,Mat*); 1217014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]); 1218014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]); 12199230625dSJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]); 12209230625dSJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]); 1221014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*); 1222273d9f13SBarry Smith 122349a6ff4bSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetLDA(Mat,PetscInt*); 1224ad16ce7aSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseSetLDA(Mat,PetscInt); 12259fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatDenseSetLDA() (since version 3.14)") static inline PetscErrorCode MatSeqDenseSetLDA(Mat A,PetscInt lda) {return MatDenseSetLDA(A,lda);} 1226014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*); 12271b807ce4Svictorle 1228621e819fSSatish Balay PETSC_EXTERN PetscErrorCode MatBlockMatSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1229621e819fSSatish Balay 1230014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStoreValues(Mat); 1231014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat); 12322e8a6d31SBarry Smith 1233014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*); 12347cfe41e4SPatrick Farrell PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat,IS*); 12357b80b807SBarry Smith /* 12367b80b807SBarry Smith These routines are not usually accessed directly, rather solving is 123794b7f48cSBarry Smith done through the KSP and PC interfaces. 12387b80b807SBarry Smith */ 12397b80b807SBarry Smith 124076bdecfbSBarry Smith /*J 12418f6c3df8SBarry Smith MatOrderingType - String with the name of a PETSc matrix ordering 1242d9274352SBarry Smith 1243d9274352SBarry Smith Level: beginner 1244d9274352SBarry Smith 12452c7c0729SBarry Smith Notes: 12462c7c0729SBarry Smith If MATORDERINGEXTERNAL is used then PETSc does not compute an ordering and utilizes one built into the factorization package 12472c7c0729SBarry Smith 1248db781477SPatrick Sanan .seealso: `MatGetOrdering()` 124976bdecfbSBarry Smith J*/ 125019fd82e9SBarry Smith typedef const char* MatOrderingType; 12512692d6eeSBarry Smith #define MATORDERINGNATURAL "natural" 12522692d6eeSBarry Smith #define MATORDERINGND "nd" 12532692d6eeSBarry Smith #define MATORDERING1WD "1wd" 12542692d6eeSBarry Smith #define MATORDERINGRCM "rcm" 12552692d6eeSBarry Smith #define MATORDERINGQMD "qmd" 12562692d6eeSBarry Smith #define MATORDERINGROWLENGTH "rowlength" 1257510184a7SJed Brown #define MATORDERINGWBM "wbm" 1258fc1bef75SJed Brown #define MATORDERINGSPECTRAL "spectral" 1259312e372aSBarry Smith #define MATORDERINGAMD "amd" /* only works if UMFPACK is installed with PETSc */ 1260048412efSPablo Brubeck #define MATORDERINGMETISND "metisnd" /* only works if METIS is installed with PETSc */ 12619bd791bbSBarry 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 */ 12622c7c0729SBarry Smith #define MATORDERINGEXTERNAL "external" /* uses an ordering type internal to the factorization package */ 1263b12f92e5SBarry Smith 126419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*); 1265140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*); 1266bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*)); 1267140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatOrderingList; 1268d4fbbf0eSBarry Smith 1269014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS); 1270fc1bef75SJed Brown PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*); 1271a2ce50c7SBarry Smith 12724ac6704cSBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetPreferredOrdering(Mat,MatFactorType,MatOrderingType*); 12734ac6704cSBarry Smith 1274d91e6319SBarry Smith /*S 1275ec5066bdSBarry Smith MatFactorShiftType - Numeric Shift for factorizations 1276d90ac83dSHong Zhang 1277d90ac83dSHong Zhang Level: beginner 1278d90ac83dSHong Zhang 1279db781477SPatrick Sanan .seealso: `MatGetFactor()` 1280d90ac83dSHong Zhang S*/ 1281d90ac83dSHong Zhang typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType; 12826a6fc655SJed Brown PETSC_EXTERN const char *const MatFactorShiftTypes[]; 12835e9742b9SJed Brown PETSC_EXTERN const char *const MatFactorShiftTypesDetail[]; 1284d90ac83dSHong Zhang 1285d90ac83dSHong Zhang /*S 1286ec5066bdSBarry Smith MatFactorError - indicates what type of error was generated in a matrix factorization 12879aa7eafdSHong Zhang 12889aa7eafdSHong Zhang Level: beginner 12899aa7eafdSHong Zhang 129095452b02SPatrick Sanan Developer Notes: 129195452b02SPatrick Sanan Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 129200e125f8SBarry Smith 1293db781477SPatrick Sanan .seealso: `MatGetFactor()` 12949aa7eafdSHong Zhang S*/ 12955cd7cf9dSHong Zhang typedef enum {MAT_FACTOR_NOERROR,MAT_FACTOR_STRUCT_ZEROPIVOT,MAT_FACTOR_NUMERIC_ZEROPIVOT,MAT_FACTOR_OUTMEMORY,MAT_FACTOR_OTHER} MatFactorError; 12969aa7eafdSHong Zhang 129700e125f8SBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat,MatFactorError*); 1298b8b68cfdSBarry Smith PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat); 12997b6c816cSBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat,PetscReal*,PetscInt*); 130000e125f8SBarry Smith 13019aa7eafdSHong Zhang /*S 1302422a814eSBarry Smith MatFactorInfo - Data passed into the matrix factorization routines, and information about the resulting factorization 1303b00f7748SHong Zhang 130461cad860SBarry Smith In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use 130561cad860SBarry Smith $ MatFactorInfo info(MAT_FACTORINFO_SIZE) 1306b00f7748SHong Zhang 130795452b02SPatrick Sanan Notes: 130895452b02SPatrick Sanan These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC. 1309b00f7748SHong Zhang 131061cad860SBarry Smith You can use MatFactorInfoInitialize() to set default values. 131161cad860SBarry Smith 1312b00f7748SHong Zhang Level: developer 1313b00f7748SHong Zhang 1314db781477SPatrick Sanan .seealso: `MatLUFactorSymbolic()`, `MatILUFactorSymbolic()`, `MatCholeskyFactorSymbolic()`, `MatICCFactorSymbolic()`, `MatICCFactor()`, 1315db781477SPatrick Sanan `MatFactorInfoInitialize()` 1316b00f7748SHong Zhang 1317b00f7748SHong Zhang S*/ 1318b00f7748SHong Zhang typedef struct { 131915e8a5b3SHong Zhang PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 132085317021SBarry Smith PetscReal usedt; 132115e8a5b3SHong Zhang PetscReal dt; /* drop tolerance */ 1322b00f7748SHong Zhang PetscReal dtcol; /* tolerance for pivoting */ 132315e8a5b3SHong Zhang PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 132467e28bfeSBarry Smith PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */ 1325348344bbSBarry Smith PetscReal levels; /* ICC/ILU(levels) */ 1326bcd9e38bSBarry Smith PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 1327bcd9e38bSBarry Smith factorization may be faster if do not pivot */ 132815e8a5b3SHong Zhang PetscReal zeropivot; /* pivot is called zero if less than this */ 1329f4db908eSBarry Smith PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */ 1330f4db908eSBarry Smith PetscReal shiftamount; /* how large the shift is */ 133115e8a5b3SHong Zhang } MatFactorInfo; 1332ffa6d0a5SLois Curfman McInnes 1333014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*); 13349a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*); 13359a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 13369a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*); 13379a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*); 13389a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*); 13399a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 13409a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 13419a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 13429a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*); 13439a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*); 13443f498edaSToby Isaac PETSC_EXTERN PetscErrorCode MatQRFactor(Mat,IS,const MatFactorInfo*); 13453f498edaSToby Isaac PETSC_EXTERN PetscErrorCode MatQRFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 13463f498edaSToby Isaac PETSC_EXTERN PetscErrorCode MatQRFactorNumeric(Mat,Mat,const MatFactorInfo*); 1347014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*); 1348014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec); 1349014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec); 1350014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec); 1351014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec); 1352014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec); 1353014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec); 1354014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs); 13557c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat); 13567c2f51b8SStefano Zampini 13577c2f51b8SStefano Zampini typedef enum {MAT_FACTOR_SCHUR_UNFACTORED, MAT_FACTOR_SCHUR_FACTORED, MAT_FACTOR_SCHUR_INVERTED} MatFactorSchurStatus; 13588e7ba810SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat,IS); 13597c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat,Mat*,MatFactorSchurStatus*); 13607c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat,Mat*,MatFactorSchurStatus); 13615a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat); 13627c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat,Mat*,MatFactorSchurStatus*); 13635a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat,Vec,Vec); 13645a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat,Vec,Vec); 13656dba178dSStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat); 1366bb5a7306SBarry Smith 13678a9c020eSBarry Smith PETSC_EXTERN PetscErrorCode MatSeqDenseInvert(Mat); 1368d91e6319SBarry Smith /*E 1369d91e6319SBarry Smith MatSORType - What type of (S)SOR to perform 1370bb1eb677SSatish Balay 1371d91e6319SBarry Smith Level: beginner 1372d91e6319SBarry Smith 1373d9274352SBarry Smith May be bitwise ORd together 1374d9274352SBarry Smith 1375af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 1376d91e6319SBarry Smith 13774e7234bfSBarry Smith MatSORType may be bitwise ORd together, so do not change the numbers 13784e7234bfSBarry Smith 1379db781477SPatrick Sanan .seealso: `MatSOR()` 1380d91e6319SBarry Smith E*/ 1381ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 1382ee50ffe9SBarry Smith SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 1383ee50ffe9SBarry Smith SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 138484cb2905SBarry Smith SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType; 1385014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 13868ed539a5SBarry Smith 1387d4fbbf0eSBarry Smith /* 1388639f9d9dSBarry Smith These routines are for efficiently computing Jacobians via finite differences. 1389639f9d9dSBarry Smith */ 1390b12f92e5SBarry Smith 13917086a01eSPeter Brune /*S 13927086a01eSPeter Brune MatColoring - Object for managing the coloring of matrices. 13937086a01eSPeter Brune 13947086a01eSPeter Brune Level: beginner 13957086a01eSPeter Brune 1396ec5066bdSBarry Smith Notes: 1397ec5066bdSBarry 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 1398ec5066bdSBarry Smith matrix comes from via DMCreateColoring(). In general using the mesh produces a more optimal coloring (fewer colors). 1399ec5066bdSBarry Smith 1400ec5066bdSBarry Smith Once a coloring is available MatFDColoringCreate() creates an object that can be used to efficiently compute Jacobians using that coloring. This 1401ec5066bdSBarry Smith same object can also be used to efficiently convert data created by Automatic Differentation tools to PETSc sparse matrices. 1402ec5066bdSBarry Smith 1403db781477SPatrick Sanan .seealso: `MatFDColoringCreate()`, `MatColoringWeightType`, `ISColoring`, `MatFDColoring`, `DMCreateColoring()`, `MatColoringCreate()`, `MatOrdering`, `MatPartitioning`, `MatColoringType` 14047086a01eSPeter Brune S*/ 1405d4db15c4SBarry Smith typedef struct _p_MatColoring* MatColoring; 1406d4db15c4SBarry Smith 1407d4db15c4SBarry Smith /*J 1408d4db15c4SBarry Smith MatColoringType - String with the name of a PETSc matrix coloring 1409d9274352SBarry Smith 1410d9274352SBarry Smith Level: beginner 1411d9274352SBarry Smith 1412db781477SPatrick Sanan .seealso: `MatColoringSetType()`, `MatColoring` 141376bdecfbSBarry Smith J*/ 141419fd82e9SBarry Smith typedef const char* MatColoringType; 14155567d71aSPeter Brune #define MATCOLORINGJP "jp" 1416b9acb617SPeter Brune #define MATCOLORINGPOWER "power" 14172692d6eeSBarry Smith #define MATCOLORINGNATURAL "natural" 14182692d6eeSBarry Smith #define MATCOLORINGSL "sl" 14192692d6eeSBarry Smith #define MATCOLORINGLF "lf" 14202692d6eeSBarry Smith #define MATCOLORINGID "id" 14218121bdceSPeter Brune #define MATCOLORINGGREEDY "greedy" 1422b12f92e5SBarry Smith 14238ac6da0aSPeter Brune /*E 14248ac6da0aSPeter Brune MatColoringWeightType - Type of weight scheme 14258ac6da0aSPeter Brune 14268ac6da0aSPeter Brune Not Collective 14278ac6da0aSPeter Brune 14288ac6da0aSPeter Brune + MAT_COLORING_RANDOM - Random weights 14298ac6da0aSPeter Brune . MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering. 14308ac6da0aSPeter Brune - MAT_COLORING_LF - Last-first weighting. 14318ac6da0aSPeter Brune 14328ac6da0aSPeter Brune Level: intermediate 14338ac6da0aSPeter Brune 1434af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 1435ec5066bdSBarry Smith 1436db781477SPatrick Sanan .seealso: `MatColoring`, `MatColoringCreate()` 14378ac6da0aSPeter Brune E*/ 1438301c140bSPeter Brune typedef enum {MAT_COLORING_WEIGHT_RANDOM,MAT_COLORING_WEIGHT_LEXICAL,MAT_COLORING_WEIGHT_LF,MAT_COLORING_WEIGHT_SL} MatColoringWeightType; 14398ac6da0aSPeter Brune 1440335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*); 1441d7f2a307SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*); 1442335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*); 1443335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer); 1444335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType); 1445335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring); 1446335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt); 1447335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*); 1448335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt); 1449335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*); 1450335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*); 1451335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring)); 1452014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*); 14538ac6da0aSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType); 1454c29971fcSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*); 14558ac6da0aSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm); 1456bc76d17bSHong Zhang PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring,ISColoring); 14579fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatColoringTest() (since version 3.10)") static inline PetscErrorCode MatColoringTestValid(MatColoring matcoloring,ISColoring iscoloring) {return MatColoringTest(matcoloring,iscoloring);} 1458bc76d17bSHong Zhang PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat,ISColoring); 1459639f9d9dSBarry Smith 1460d9274352SBarry Smith /*S 1461d9274352SBarry Smith MatFDColoring - Object for computing a sparse Jacobian via finite differences 1462d9274352SBarry Smith and coloring 1463639f9d9dSBarry Smith 1464d9274352SBarry Smith Level: beginner 1465d9274352SBarry Smith 1466ec5066bdSBarry Smith Notes: 1467ec5066bdSBarry Smith This object is creating utilizing a coloring provided by the MatColoring object or DMCreateColoring() 1468ec5066bdSBarry Smith 1469db781477SPatrick Sanan .seealso: `MatFDColoringCreate()`, `MatColoring`, `DMCreateColoring()` 1470d9274352SBarry Smith S*/ 1471e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring; 1472639f9d9dSBarry Smith 1473014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *); 1474014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*); 1475014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer); 1476014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*); 1477014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**); 1478014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal); 1479014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring); 1480d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *); 1481014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec); 1482edaa7c33SBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,const PetscInt*[]); 1483f86b9fbaSHong Zhang PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring); 1484f86b9fbaSHong Zhang PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt); 1485bdaf1daeSBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringSetValues(Mat,MatFDColoring,const PetscScalar*); 1486b1683b59SHong Zhang 1487b1683b59SHong Zhang /*S 1488b9af6bddSHong Zhang MatTransposeColoring - Object for computing a sparse matrix product C=A*B^T via coloring 1489b1683b59SHong Zhang 1490b1683b59SHong Zhang Level: beginner 1491b1683b59SHong Zhang 1492db781477SPatrick Sanan .seealso: `MatTransposeColoringCreate()` 1493b1683b59SHong Zhang S*/ 1494b9af6bddSHong Zhang typedef struct _p_MatTransposeColoring* MatTransposeColoring; 1495b1683b59SHong Zhang 1496014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *); 1497014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat); 1498014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat); 1499014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*); 1500b1683b59SHong Zhang 1501639f9d9dSBarry Smith /* 15020752156aSBarry Smith These routines are for partitioning matrices: currently used only 15033eda8832SBarry Smith for adjacency matrix, MatCreateMPIAdj(). 15040752156aSBarry Smith */ 1505ca161407SBarry Smith 1506d9274352SBarry Smith /*S 1507d9274352SBarry Smith MatPartitioning - Object for managing the partitioning of a matrix or graph 1508d9274352SBarry Smith 1509d9274352SBarry Smith Level: beginner 1510d9274352SBarry Smith 1511ec5066bdSBarry Smith Notes: 1512ec5066bdSBarry Smith There is also a PetscPartitioner object that provides the same functionality. It can utilize the MatPartitioning operations 1513ec5066bdSBarry Smith via PetscPartitionerSetType(p,PETSCPARTITIONERMATPARTITIONING) 1514ec5066bdSBarry Smith 1515ec5066bdSBarry Smith Developers Note: 1516ec5066bdSBarry Smith It is an extra maintainance and documentation cost to have two objects with the same functionality. 1517ec5066bdSBarry Smith 1518db781477SPatrick Sanan .seealso: `MatPartitioningCreate()`, `MatPartitioningType`, `MatColoring`, `MatGetOrdering()` 1519d9274352SBarry Smith S*/ 152091e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning; 1521d9274352SBarry Smith 152276bdecfbSBarry Smith /*J 15238f6c3df8SBarry Smith MatPartitioningType - String with the name of a PETSc matrix partitioning 1524d9274352SBarry Smith 1525d9274352SBarry Smith Level: beginner 15260d04baf8SBarry Smith dm 1527db781477SPatrick Sanan .seealso: `MatPartitioningCreate()`, `MatPartitioning` 152876bdecfbSBarry Smith J*/ 152919fd82e9SBarry Smith typedef const char* MatPartitioningType; 15302692d6eeSBarry Smith #define MATPARTITIONINGCURRENT "current" 1531aa1e27eaSFande Kong #define MATPARTITIONINGAVERAGE "average" 15322692d6eeSBarry Smith #define MATPARTITIONINGSQUARE "square" 15332692d6eeSBarry Smith #define MATPARTITIONINGPARMETIS "parmetis" 15342692d6eeSBarry Smith #define MATPARTITIONINGCHACO "chaco" 15352692d6eeSBarry Smith #define MATPARTITIONINGPARTY "party" 153650d91057SBarry Smith #define MATPARTITIONINGPTSCOTCH "ptscotch" 153788d2ac2bSFande Kong #define MATPARTITIONINGHIERARCH "hierarch" 153871306c60Sjroman 1539014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*); 154019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType); 1541014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt); 1542014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat); 1543252a1336SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningSetNumberVertexWeights(MatPartitioning,PetscInt); 1544014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]); 1545014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []); 1546ebf67979SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningSetUseEdgeWeights(MatPartitioning,PetscBool); 1547ebf67979SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningGetUseEdgeWeights(MatPartitioning,PetscBool*); 1548014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*); 1549fdd1c351SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningImprove(MatPartitioning,IS*); 1550668144dbSFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningViewImbalance(MatPartitioning,IS); 1551f3ad2dabSStefano Zampini PETSC_EXTERN PetscErrorCode MatPartitioningApplyND(MatPartitioning,IS*); 1552014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*); 1553bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[],PetscErrorCode (*)(MatPartitioning)); 1554014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer); 1555fe2efc57SMark PETSC_EXTERN PetscErrorCode MatPartitioningViewFromOptions(MatPartitioning,PetscObject,const char[]); 1556014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning); 155719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*); 1558ca161407SBarry Smith 155927538973SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part); 1560014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 1561014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *); 15620752156aSBarry Smith 1563b6956c12SJose Roman typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType; 15646a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoGlobalTypes[]; 1565b6956c12SJose Roman typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType; 15666a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoLocalTypes[]; 1567b6956c12SJose Roman typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType; 15686a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoEigenTypes[]; 1569b6956c12SJose Roman 1570014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType); 1571014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*); 1572014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType); 1573014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*); 1574014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal); 1575014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType); 1576014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*); 1577014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal); 1578014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*); 1579014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt); 1580014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*); 158171306c60Sjroman 158271306c60Sjroman #define MP_PARTY_OPT "opt" 158371306c60Sjroman #define MP_PARTY_LIN "lin" 158471306c60Sjroman #define MP_PARTY_SCA "sca" 158571306c60Sjroman #define MP_PARTY_RAN "ran" 158671306c60Sjroman #define MP_PARTY_GBF "gbf" 158771306c60Sjroman #define MP_PARTY_GCF "gcf" 158871306c60Sjroman #define MP_PARTY_BUB "bub" 158971306c60Sjroman #define MP_PARTY_DEF "def" 1590014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*); 159171306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs" 159271306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl" 159371306c60Sjroman #define MP_PARTY_NONE "no" 1594014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*); 1595014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal); 1596014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool); 1597014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool); 159871306c60Sjroman 1599b0ca845eSVaclav Hapla typedef enum { MP_PTSCOTCH_DEFAULT,MP_PTSCOTCH_QUALITY,MP_PTSCOTCH_SPEED,MP_PTSCOTCH_BALANCE,MP_PTSCOTCH_SAFETY,MP_PTSCOTCH_SCALABILITY } MPPTScotchStrategyType; 16006a6fc655SJed Brown PETSC_EXTERN const char *const MPPTScotchStrategyTypes[]; 1601e0f1cffaSJose Roman 1602014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal); 1603014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*); 1604014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType); 1605014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*); 160671306c60Sjroman 1607b43b03e9SMark F. Adams /* 16086294fa2bSFande Kong * hierarchical partitioning 16096294fa2bSFande Kong */ 16104e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning,IS*); 16114e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning,IS*); 16124e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning,PetscInt); 16134e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt); 16146294fa2bSFande Kong 1615014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*); 1616014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*); 1617591294e4SBarry Smith 16180752156aSBarry Smith /* 1619c786d857SStefano Zampini If you add entries here you must also add them to src/mat/f90-mod/petscmat.h 1620c786d857SStefano Zampini If any of the enum values are changed, also update dMatOps dict at src/binding/petsc4py/src/libpetsc4py/libpetsc4py.pyx 1621d4fbbf0eSBarry Smith */ 16221c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0, 16231c1c02c0SLois Curfman McInnes MATOP_GET_ROW=1, 16241c1c02c0SLois Curfman McInnes MATOP_RESTORE_ROW=2, 16251c1c02c0SLois Curfman McInnes MATOP_MULT=3, 16261c1c02c0SLois Curfman McInnes MATOP_MULT_ADD=4, 16277c922b88SBarry Smith MATOP_MULT_TRANSPOSE=5, 16287c922b88SBarry Smith MATOP_MULT_TRANSPOSE_ADD=6, 16291c1c02c0SLois Curfman McInnes MATOP_SOLVE=7, 16301c1c02c0SLois Curfman McInnes MATOP_SOLVE_ADD=8, 16317c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE=9, 16327c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE_ADD=10, 16331c1c02c0SLois Curfman McInnes MATOP_LUFACTOR=11, 16341c1c02c0SLois Curfman McInnes MATOP_CHOLESKYFACTOR=12, 1635a714c06dSBarry Smith MATOP_SOR=13, 16361c1c02c0SLois Curfman McInnes MATOP_TRANSPOSE=14, 16371c1c02c0SLois Curfman McInnes MATOP_GETINFO=15, 16381c1c02c0SLois Curfman McInnes MATOP_EQUAL=16, 16391c1c02c0SLois Curfman McInnes MATOP_GET_DIAGONAL=17, 16401c1c02c0SLois Curfman McInnes MATOP_DIAGONAL_SCALE=18, 16411c1c02c0SLois Curfman McInnes MATOP_NORM=19, 16421c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_BEGIN=20, 16431c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_END=21, 1644d519adbfSMatthew Knepley MATOP_SET_OPTION=22, 1645d519adbfSMatthew Knepley MATOP_ZERO_ENTRIES=23, 1646d519adbfSMatthew Knepley MATOP_ZERO_ROWS=24, 1647d519adbfSMatthew Knepley MATOP_LUFACTOR_SYMBOLIC=25, 1648d519adbfSMatthew Knepley MATOP_LUFACTOR_NUMERIC=26, 1649d519adbfSMatthew Knepley MATOP_CHOLESKY_FACTOR_SYMBOLIC=27, 1650d519adbfSMatthew Knepley MATOP_CHOLESKY_FACTOR_NUMERIC=28, 1651e5f2d425SStefano Zampini MATOP_SETUP=29, 1652d519adbfSMatthew Knepley MATOP_ILUFACTOR_SYMBOLIC=30, 1653d519adbfSMatthew Knepley MATOP_ICCFACTOR_SYMBOLIC=31, 1654a5b7ff6bSBarry Smith MATOP_GET_DIAGONAL_BLOCK=32, 1655e5f2d425SStefano Zampini MATOP_SET_INF=33, 1656d519adbfSMatthew Knepley MATOP_DUPLICATE=34, 1657d519adbfSMatthew Knepley MATOP_FORWARD_SOLVE=35, 1658d519adbfSMatthew Knepley MATOP_BACKWARD_SOLVE=36, 1659d519adbfSMatthew Knepley MATOP_ILUFACTOR=37, 1660d519adbfSMatthew Knepley MATOP_ICCFACTOR=38, 1661d519adbfSMatthew Knepley MATOP_AXPY=39, 16627dae84e0SHong Zhang MATOP_CREATE_SUBMATRICES=40, 1663d519adbfSMatthew Knepley MATOP_INCREASE_OVERLAP=41, 1664d519adbfSMatthew Knepley MATOP_GET_VALUES=42, 1665d519adbfSMatthew Knepley MATOP_COPY=43, 1666d519adbfSMatthew Knepley MATOP_GET_ROW_MAX=44, 1667d519adbfSMatthew Knepley MATOP_SCALE=45, 1668d519adbfSMatthew Knepley MATOP_SHIFT=46, 166935153367SBarry Smith MATOP_DIAGONAL_SET=47, 16709d39f69dSJed Brown MATOP_ZERO_ROWS_COLUMNS=48, 16719d39f69dSJed Brown MATOP_SET_RANDOM=49, 1672d519adbfSMatthew Knepley MATOP_GET_ROW_IJ=50, 1673d519adbfSMatthew Knepley MATOP_RESTORE_ROW_IJ=51, 1674d519adbfSMatthew Knepley MATOP_GET_COLUMN_IJ=52, 1675d519adbfSMatthew Knepley MATOP_RESTORE_COLUMN_IJ=53, 1676d519adbfSMatthew Knepley MATOP_FDCOLORING_CREATE=54, 1677d519adbfSMatthew Knepley MATOP_COLORING_PATCH=55, 1678d519adbfSMatthew Knepley MATOP_SET_UNFACTORED=56, 1679d519adbfSMatthew Knepley MATOP_PERMUTE=57, 1680d519adbfSMatthew Knepley MATOP_SET_VALUES_BLOCKED=58, 16817dae84e0SHong Zhang MATOP_CREATE_SUBMATRIX=59, 1682d519adbfSMatthew Knepley MATOP_DESTROY=60, 1683d519adbfSMatthew Knepley MATOP_VIEW=61, 1684d519adbfSMatthew Knepley MATOP_CONVERT_FROM=62, 1685e5f2d425SStefano Zampini /* MATOP_PLACEHOLDER_63=63 */ 16867bab7c10SHong Zhang MATOP_MATMAT_MULT_SYMBOLIC=64, 16877bab7c10SHong Zhang MATOP_MATMAT_MULT_NUMERIC=65, 1688d519adbfSMatthew Knepley MATOP_SET_LOCAL_TO_GLOBAL_MAP=66, 1689d519adbfSMatthew Knepley MATOP_SET_VALUES_LOCAL=67, 1690d519adbfSMatthew Knepley MATOP_ZERO_ROWS_LOCAL=68, 1691d519adbfSMatthew Knepley MATOP_GET_ROW_MAX_ABS=69, 1692d519adbfSMatthew Knepley MATOP_GET_ROW_MIN_ABS=70, 1693d519adbfSMatthew Knepley MATOP_CONVERT=71, 1694e5f2d425SStefano Zampini MATOP_HAS_OPERATION=72, 16959d39f69dSJed Brown /* MATOP_PLACEHOLDER_73=73, */ 1696d519adbfSMatthew Knepley MATOP_SET_VALUES_ADIFOR=74, 1697d519adbfSMatthew Knepley MATOP_FD_COLORING_APPLY=75, 1698d519adbfSMatthew Knepley MATOP_SET_FROM_OPTIONS=76, 1699e5f2d425SStefano Zampini /* MATOP_PLACEHOLDER_77=77, */ 1700e5f2d425SStefano Zampini /* MATOP_PLACEHOLDER_78=78, */ 17019d39f69dSJed Brown MATOP_FIND_ZERO_DIAGONALS=79, 1702d519adbfSMatthew Knepley MATOP_MULT_MULTIPLE=80, 1703d519adbfSMatthew Knepley MATOP_SOLVE_MULTIPLE=81, 1704d519adbfSMatthew Knepley MATOP_GET_INERTIA=82, 1705d519adbfSMatthew Knepley MATOP_LOAD=83, 1706d519adbfSMatthew Knepley MATOP_IS_SYMMETRIC=84, 1707d519adbfSMatthew Knepley MATOP_IS_HERMITIAN=85, 1708d519adbfSMatthew Knepley MATOP_IS_STRUCTURALLY_SYMMETRIC=86, 1709820469bcSHong Zhang MATOP_SET_VALUES_BLOCKEDLOCAL=87, 1710b41ce5d5SBarry Smith MATOP_CREATE_VECS=88, 1711e5f2d425SStefano Zampini /* MATOP_PLACEHOLDER_89=89, */ 1712d519adbfSMatthew Knepley MATOP_MAT_MULT_SYMBOLIC=90, 1713d519adbfSMatthew Knepley MATOP_MAT_MULT_NUMERIC=91, 1714e5f2d425SStefano Zampini /* MATOP_PLACEHOLDER_92=92, */ 1715d519adbfSMatthew Knepley MATOP_PTAP_SYMBOLIC=93, 1716d519adbfSMatthew Knepley MATOP_PTAP_NUMERIC=94, 1717e5f2d425SStefano Zampini /* MATOP_PLACEHOLDER_95=95, */ 1718bda6c4cbSBarry Smith MATOP_MAT_TRANSPOSE_MULT_SYMBO=96, 1719bda6c4cbSBarry Smith MATOP_MAT_TRANSPOSE_MULT_NUMER=97, 1720e5f2d425SStefano Zampini MATOP_BIND_TO_CPU=98, 17217a3c3d58SStefano Zampini MATOP_PRODUCTSETFROMOPTIONS=99, 17227a3c3d58SStefano Zampini MATOP_PRODUCTSYMBOLIC=100, 17237a3c3d58SStefano Zampini MATOP_PRODUCTNUMERIC=101, 1724d519adbfSMatthew Knepley MATOP_CONJUGATE=102, 1725e5f2d425SStefano Zampini MATOP_VIEW_NATIVE=103, 1726d519adbfSMatthew Knepley MATOP_SET_VALUES_ROW=104, 1727d519adbfSMatthew Knepley MATOP_REAL_PART=105, 1728bda6c4cbSBarry Smith MATOP_IMAGINARY_PART=106, 1729bda6c4cbSBarry Smith MATOP_GET_ROW_UPPER_TRIANGULAR=107, 1730bda6c4cbSBarry Smith MATOP_RESTORE_ROW_UPPER_TRIANG=108, 1731bda6c4cbSBarry Smith MATOP_MAT_SOLVE=109, 173229eadf9eSStefano Zampini MATOP_MAT_SOLVE_TRANSPOSE=110, 1733d519adbfSMatthew Knepley MATOP_GET_ROW_MIN=111, 17340e8d04f7SBarry Smith MATOP_GET_COLUMN_VECTOR=112, 1735d519adbfSMatthew Knepley MATOP_MISSING_DIAGONAL=113, 17360e8d04f7SBarry Smith MATOP_GET_SEQ_NONZERO_STRUCTUR=114, 173789c6957cSBarry Smith MATOP_CREATE=115, 173889c6957cSBarry Smith MATOP_GET_GHOSTS=116, 17390e8d04f7SBarry Smith MATOP_GET_LOCAL_SUB_MATRIX=117, 17400e8d04f7SBarry Smith MATOP_RESTORE_LOCALSUB_MATRIX=118, 1741eeffb40dSHong Zhang MATOP_MULT_DIAGONAL_BLOCK=119, 17420e8d04f7SBarry Smith MATOP_HERMITIAN_TRANSPOSE=120, 17430e8d04f7SBarry Smith MATOP_MULT_HERMITIAN_TRANSPOSE=121, 17440e8d04f7SBarry Smith MATOP_MULT_HERMITIAN_TRANS_ADD=122, 17450e8d04f7SBarry Smith MATOP_GET_MULTI_PROC_BLOCK=123, 17469d39f69dSJed Brown MATOP_FIND_NONZERO_ROWS=124, 17470e8d04f7SBarry Smith MATOP_GET_COLUMN_NORMS=125, 17489d39f69dSJed Brown MATOP_INVERT_BLOCK_DIAGONAL=126, 1749e5f2d425SStefano Zampini MATOP_INVERT_VBLOCK_DIAGONAL=127, 1750b41ce5d5SBarry Smith MATOP_CREATE_SUB_MATRICES_MPI=128, 17512b8ad9a3SHong Zhang MATOP_SET_VALUES_BATCH=129, 1752e5f2d425SStefano Zampini /* MATOP_PLACEHOLDER_130=130, */ 17530e8d04f7SBarry Smith MATOP_TRANSPOSE_MAT_MULT_SYMBO=131, 1754e9b602ebSSatish Balay MATOP_TRANSPOSE_MAT_MULT_NUMER=132, 17550e8d04f7SBarry Smith MATOP_TRANSPOSE_COLORING_CREAT=133, 17560e8d04f7SBarry Smith MATOP_TRANS_COLORING_APPLY_SPT=134, 17570e8d04f7SBarry Smith MATOP_TRANS_COLORING_APPLY_DEN=135, 1758e5f2d425SStefano Zampini /* MATOP_PLACEHOLDER_136=136, */ 17590e8d04f7SBarry Smith MATOP_RART_SYMBOLIC=137, 17600e8d04f7SBarry Smith MATOP_RART_NUMERIC=138, 1761e09a3074SHong Zhang MATOP_SET_BLOCK_SIZES=139, 1762f9426fe0SMark Adams MATOP_AYPX=140, 17631919a2e2SJed Brown MATOP_RESIDUAL=141, 17649c8f2541SHong Zhang MATOP_FDCOLORING_SETUP=142, 1765e5f2d425SStefano Zampini MATOP_FIND_OFFBLOCK_ENTRIES=143, 17662d033e1fSHong Zhang MATOP_MPICONCATENATESEQ=144, 1767bb01b7b0SPatrick Sanan MATOP_DESTROYSUBMATRICES=145, 1768e265f6d6SPatrick Sanan MATOP_TRANSPOSE_SOLVE=146, 1769e265f6d6SPatrick Sanan MATOP_GET_VALUES_LOCAL=147 1770fae171e0SBarry Smith } MatOperation; 17710c0fd78eSBarry Smith PETSC_EXTERN PetscErrorCode MatSetOperation(Mat,MatOperation,void(*)(void)); 1772976e8c5aSLisandro Dalcin PETSC_EXTERN PetscErrorCode MatGetOperation(Mat,MatOperation,void(**)(void)); 1773976e8c5aSLisandro Dalcin PETSC_EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool*); 177494342113SStefano Zampini PETSC_EXTERN PetscErrorCode MatHasCongruentLayouts(Mat,PetscBool*); 17759fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatProductClear() (since version 3.14)") static inline PetscErrorCode MatFreeIntermediateDataStructures(Mat A) {return MatProductClear(A);} 1776014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void)); 1777014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void)); 1778014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*); 1779db77db73SJeremy L Thompson PETSC_EXTERN PetscErrorCode MatShellSetVecType(Mat,VecType); 1780f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*); 1781f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*); 17820c0fd78eSBarry Smith PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat); 1783b77ba244SStefano Zampini PETSC_EXTERN PetscErrorCode MatShellSetMatProductOperation(Mat,MatProductType,PetscErrorCode (*)(Mat,Mat,Mat,void**),PetscErrorCode (*)(Mat,Mat,Mat,void*),PetscErrorCode (*)(void*),MatType,MatType); 1784b77ba244SStefano Zampini PETSC_EXTERN PetscErrorCode MatIsShell(Mat,PetscBool*); 1785112a2221SBarry Smith 178690ace30eSBarry Smith /* 178790ace30eSBarry Smith Codes for matrices stored on disk. By default they are 178890ace30eSBarry Smith stored in a universal format. By changing the format with 17896a9046bcSBarry Smith PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will 179090ace30eSBarry Smith be stored in a way natural for the matrix, for example dense matrices 179190ace30eSBarry Smith would be stored as dense. Matrices stored this way may only be 1792f4403165SShri Abhyankar read into matrices of the same type. 179390ace30eSBarry Smith */ 179490ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1 179590ace30eSBarry Smith 1796014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal); 179775d48cdbSStefano Zampini 17988546b261SStefano Zampini PETSC_EXTERN PetscErrorCode MatISSetLocalMatType(Mat,MatType); 179975d48cdbSStefano Zampini PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 180075d48cdbSStefano Zampini PETSC_EXTERN PetscErrorCode MatISStoreL2L(Mat,PetscBool); 1801f03112d0SStefano Zampini PETSC_EXTERN PetscErrorCode MatISFixLocalEmpty(Mat,PetscBool); 1802014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*); 18033b3b1effSJed Brown PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat,Mat*); 1804014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat); 1805e432b41dSStefano Zampini PETSC_EXTERN PetscErrorCode MatISGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*); 180625ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use the MatConvert() interface (since version 3.10)") PetscErrorCode MatISGetMPIXAIJ(Mat,MatReuse,Mat*); 18071f4e1ec7SBarry Smith 1808d9274352SBarry Smith /*S 1809d9274352SBarry Smith MatNullSpace - Object that removes a null space from a vector, i.e. 1810cb6b9846SMatthew Knepley orthogonalizes the vector to a subspace 1811d9274352SBarry Smith 1812f7a9e4ceSBarry Smith Level: advanced 1813d9274352SBarry Smith 1814db781477SPatrick Sanan .seealso: `MatNullSpaceCreate()` 1815d9274352SBarry Smith S*/ 181674637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace; 1817d9274352SBarry Smith 1818014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*); 1819014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*); 1820014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*); 1821d0195637SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec); 1822014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *); 18235fa7ec2dSBarry Smith PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *); 18245fa7ec2dSBarry Smith PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat,MatNullSpace); 1825014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace); 1826014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace); 1827014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*); 1828014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool *); 1829014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer); 1830014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**); 1831014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*); 183274637425SBarry Smith 1833014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS); 1834014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal); 1835014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *); 18363f1d51d7SBarry Smith 1837014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*); 1838014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*); 1839014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*); 1840c4f061fbSSatish Balay 18410bacdadaSStefano Zampini PETSC_EXTERN PetscErrorCode MatComputeOperator(Mat,MatType,Mat*); 18420bacdadaSStefano Zampini PETSC_EXTERN PetscErrorCode MatComputeOperatorTranspose(Mat,MatType,Mat*); 18430bacdadaSStefano Zampini 18449fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatComputeOperator() (since version 3.12)") static inline PetscErrorCode MatComputeExplicitOperator(Mat A,Mat* B) { return MatComputeOperator(A,NULL,B); } 18459fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatComputeOperatorTranspose() (since version 3.12)") static inline PetscErrorCode MatComputeExplicitOperatorTranspose(Mat A,Mat* B) { return MatComputeOperatorTranspose(A,NULL,B); } 1846b0a32e0cSBarry Smith 184749bd79ccSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode MatCreateKAIJ(Mat,PetscInt,PetscInt,const PetscScalar[],const PetscScalar[],Mat*); 184849bd79ccSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode MatKAIJGetAIJ(Mat,Mat*); 1849a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetS(Mat,PetscInt*,PetscInt*,PetscScalar**); 1850a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetSRead(Mat,PetscInt*,PetscInt*,const PetscScalar**); 1851a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreS(Mat,PetscScalar**); 1852a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreSRead(Mat,const PetscScalar**); 1853a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetT(Mat,PetscInt*,PetscInt*,PetscScalar**); 1854a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetTRead(Mat,PetscInt*,PetscInt*,const PetscScalar**); 1855a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreT(Mat,PetscScalar**); 1856a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreTRead(Mat,const PetscScalar**); 1857dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetAIJ(Mat,Mat); 1858dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetS(Mat,PetscInt,PetscInt,const PetscScalar[]); 1859dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetT(Mat,PetscInt,PetscInt,const PetscScalar[]); 1860910cf402Sprj- PETSC_EXTERN PetscErrorCode MatKAIJGetScaledIdentity(Mat,PetscBool*); 186149bd79ccSDebojyoti Ghosh 1862014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec); 186304f1ad80SBarry Smith 1864014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 1865014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec); 1866014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*); 1867014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*)); 1868014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec)); 1869014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt); 1870014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat); 1871014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal); 1872014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt); 1873014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *); 1874014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]); 1875014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*); 1876014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*); 1877e884886fSBarry Smith 18786370053bSBarry Smith /*S 18796370053bSBarry Smith MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free 18806370053bSBarry Smith Jacobian vector products 1881e884886fSBarry Smith 188295452b02SPatrick Sanan Notes: 188395452b02SPatrick Sanan MATMFFD is a specific MatType which uses the MatMFFD data structure 18846370053bSBarry Smith 18856370053bSBarry Smith MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure 18866370053bSBarry Smith 18876370053bSBarry Smith Level: developer 18886370053bSBarry Smith 1889db781477SPatrick Sanan .seealso: `MATMFFD`, `MatCreateMFFD()`, `MatMFFDSetFuction()`, `MatMFFDSetType()`, `MatMFFDRegister()` 18906370053bSBarry Smith S*/ 1891e884886fSBarry Smith typedef struct _p_MatMFFD* MatMFFD; 1892e884886fSBarry Smith 189376bdecfbSBarry Smith /*J 1894e884886fSBarry Smith MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function 1895e884886fSBarry Smith 1896e884886fSBarry Smith Level: beginner 1897e884886fSBarry Smith 1898db781477SPatrick Sanan .seealso: `MatMFFDSetType()`, `MatMFFDRegister()` 189976bdecfbSBarry Smith J*/ 190019fd82e9SBarry Smith typedef const char* MatMFFDType; 1901e884886fSBarry Smith #define MATMFFD_DS "ds" 1902e884886fSBarry Smith #define MATMFFD_WP "wp" 1903e884886fSBarry Smith 190419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat,MatMFFDType); 1905bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[],PetscErrorCode (*)(MatMFFD)); 1906e884886fSBarry Smith 1907014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal); 1908014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool); 1909e884886fSBarry Smith 191061ab5df0SBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring,MatMFFDType); 191161ab5df0SBarry Smith 1912014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *); 1913014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *); 19147dbadf16SMatthew Knepley 191553022affSStefano Zampini #ifdef PETSC_HAVE_H2OPUS 191653022affSStefano Zampini PETSC_EXTERN_TYPEDEF typedef PetscScalar (*MatH2OpusKernel)(PetscInt,PetscReal[],PetscReal[],void*); 191753022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatCreateH2OpusFromKernel(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscReal[],PetscBool,MatH2OpusKernel,void*,PetscReal,PetscInt,PetscInt,Mat*); 191853022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatCreateH2OpusFromMat(Mat,PetscInt,const PetscReal[],PetscBool,PetscReal,PetscInt,PetscInt,PetscInt,PetscReal,Mat*); 191953022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusSetSamplingMat(Mat,Mat,PetscInt,PetscReal); 192053022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusOrthogonalize(Mat); 192153022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusCompress(Mat,PetscReal); 192253022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusSetNativeMult(Mat,PetscBool); 192353022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusGetNativeMult(Mat,PetscBool*); 192453022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusGetIndexMap(Mat,IS*); 192553022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusMapVec(Mat,PetscBool,Vec,Vec*); 1926300d917bSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusLowRankUpdate(Mat,Mat,Mat,PetscScalar); 1927a0d2e7d8SStefano Zampini #endif 1928a0d2e7d8SStefano Zampini 1929c7a4214aSPierre Jolivet #ifdef PETSC_HAVE_HTOOL 193098e73e17SPierre Jolivet PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*MatHtoolKernel)(PetscInt,PetscInt,PetscInt,const PetscInt*,const PetscInt*,PetscScalar*,void*); 1931c7a4214aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatCreateHtoolFromKernel(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscReal[],const PetscReal[],MatHtoolKernel,void*,Mat*); 1932c7a4214aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolSetKernel(Mat,MatHtoolKernel,void*); 193398e73e17SPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolGetPermutationSource(Mat,IS*); 193498e73e17SPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolGetPermutationTarget(Mat,IS*); 193598e73e17SPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolUsePermutation(Mat,PetscBool); 1936c7a4214aSPierre Jolivet /*E 1937c7a4214aSPierre Jolivet MatHtoolCompressorType - Indicates the type of compressor used by a MATHTOOL 1938c7a4214aSPierre Jolivet 1939c7a4214aSPierre Jolivet Level: beginner 1940c7a4214aSPierre Jolivet 1941c7a4214aSPierre Jolivet Values: 1942c7a4214aSPierre Jolivet + MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA (default) - symmetric partial adaptive cross approximation 1943c7a4214aSPierre Jolivet . MAT_HTOOL_COMPRESSOR_FULL_ACA - full adaptive cross approximation 1944c7a4214aSPierre Jolivet - MAT_HTOOL_COMPRESSOR_SVD - singular value decomposition 1945c7a4214aSPierre Jolivet 1946db781477SPatrick Sanan .seealso: `MatCreateHtoolFromKernel()`, `MATHTOOL`, `MatHtoolClusteringType` 1947c7a4214aSPierre Jolivet E*/ 1948c7a4214aSPierre Jolivet typedef enum { MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA, MAT_HTOOL_COMPRESSOR_FULL_ACA, MAT_HTOOL_COMPRESSOR_SVD } MatHtoolCompressorType; 194998e73e17SPierre Jolivet /*E 195098e73e17SPierre Jolivet MatHtoolClusteringType - Indicates the type of clustering used by a MATHTOOL 195198e73e17SPierre Jolivet 195298e73e17SPierre Jolivet Level: beginner 195398e73e17SPierre Jolivet 195498e73e17SPierre Jolivet Values: 195598e73e17SPierre Jolivet + MAT_HTOOL_CLUSTERING_PCA_REGULAR (default) - axis computed via principle component analysis, split uniformly 195698e73e17SPierre Jolivet . MAT_HTOOL_CLUSTERING_PCA_GEOMETRIC - axis computed via principle component analysis, split barycentrically 195798e73e17SPierre Jolivet . MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_REGULAR - axis along the largest extent of the bounding box, split uniformly 195898e73e17SPierre Jolivet - MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_GEOMETRIC - axis along the largest extent of the bounding box, split barycentrically 195998e73e17SPierre Jolivet 196098e73e17SPierre Jolivet Notes: higher-dimensional clustering is not yet supported in Htool, but once it is, one should add BOUNDING_BOX_{2,3} types 196198e73e17SPierre Jolivet 1962db781477SPatrick Sanan .seealso: `MatCreateHtoolFromKernel()`, `MATHTOOL`, `MatHtoolCompressorType` 196398e73e17SPierre Jolivet E*/ 196498e73e17SPierre 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; 1965c7a4214aSPierre Jolivet #endif 1966c7a4214aSPierre Jolivet 196797969023SHong Zhang /* 196897969023SHong Zhang PETSc interface to MUMPS 196997969023SHong Zhang */ 197097969023SHong Zhang #ifdef PETSC_HAVE_MUMPS 1971014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt); 1972bc6112feSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat,PetscInt,PetscInt*); 1973b9e9ea26SSatish Balay PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal); 1974bc6112feSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat,PetscInt,PetscReal*); 1975bc6112feSHong Zhang 1976ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat,PetscInt,PetscInt*); 1977ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat,PetscInt,PetscInt*); 1978ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat,PetscInt,PetscReal*); 1979ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat,PetscInt,PetscReal*); 198089a9c03aSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat,Mat); 19810e6b8875SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInverseTranspose(Mat,Mat); 198297969023SHong Zhang #endif 198323a5497aSJed Brown 1984d954db57SHong Zhang /* 1985d615f992SSatish Balay PETSc interface to Mkl_Pardiso 1986b500a6b7SJose David Bermeol */ 1987b500a6b7SJose David Bermeol #ifdef PETSC_HAVE_MKL_PARDISO 1988d615f992SSatish Balay PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt); 1989b500a6b7SJose David Bermeol #endif 1990b500a6b7SJose David Bermeol 1991b500a6b7SJose David Bermeol /* 1992d305a81bSVasiliy Kozyrev PETSc interface to Mkl_CPardiso 1993d305a81bSVasiliy Kozyrev */ 1994d305a81bSVasiliy Kozyrev #ifdef PETSC_HAVE_MKL_CPARDISO 1995d305a81bSVasiliy Kozyrev PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt); 1996d305a81bSVasiliy Kozyrev #endif 1997d305a81bSVasiliy Kozyrev 1998d305a81bSVasiliy Kozyrev /* 1999d954db57SHong Zhang PETSc interface to SUPERLU 2000d954db57SHong Zhang */ 2001d954db57SHong Zhang #ifdef PETSC_HAVE_SUPERLU 2002014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal); 2003d954db57SHong Zhang #endif 2004d954db57SHong Zhang 2005fb785984SHong Zhang /* 2006fb785984SHong Zhang PETSc interface to SUPERLU_DIST 2007fb785984SHong Zhang */ 2008fb785984SHong Zhang #ifdef PETSC_HAVE_SUPERLU_DIST 2009fb785984SHong Zhang PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat,PetscScalar*); 2010fb785984SHong Zhang #endif 2011fb785984SHong Zhang 2012575704cbSPieter Ghysels /* 2013575704cbSPieter Ghysels PETSc interface to STRUMPACK 2014575704cbSPieter Ghysels */ 2015575704cbSPieter Ghysels #ifdef PETSC_HAVE_STRUMPACK 2016542aee0fSPieter Ghysels /*E 2017542aee0fSPieter Ghysels MatSTRUMPACKReordering - sparsity reducing ordering to be used in STRUMPACK 2018542aee0fSPieter Ghysels 2019542aee0fSPieter Ghysels Level: intermediate 2020542aee0fSPieter Ghysels E*/ 202134f43fa5SPieter Ghysels typedef enum {MAT_STRUMPACK_NATURAL=0, 202234f43fa5SPieter Ghysels MAT_STRUMPACK_METIS=1, 202334f43fa5SPieter Ghysels MAT_STRUMPACK_PARMETIS=2, 202434f43fa5SPieter Ghysels MAT_STRUMPACK_SCOTCH=3, 202534f43fa5SPieter Ghysels MAT_STRUMPACK_PTSCOTCH=4, 202634f43fa5SPieter Ghysels MAT_STRUMPACK_RCM=5} MatSTRUMPACKReordering; 202734f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat,MatSTRUMPACKReordering); 2028575704cbSPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat,PetscBool); 202934f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSRelTol(Mat,PetscReal); 20309fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSRelTol() (since version 3.9)") static inline PetscErrorCode MatSTRUMPACKSetHSSRelCompTol(Mat mat,PetscReal rtol) {return MatSTRUMPACKSetHSSRelTol(mat,rtol);} 203134f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSAbsTol(Mat,PetscReal); 203234f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMinSepSize(Mat,PetscInt); 20339fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSMinSepSize() (since version 3.9)") static inline PetscErrorCode MatSTRUMPACKSetHSSMinSize(Mat mat,PetscInt hssminsize) {return MatSTRUMPACKSetHSSMinSepSize(mat,hssminsize);} 203434f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMaxRank(Mat,PetscInt); 2035a36bf211SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSLeafSize(Mat,PetscInt); 2036575704cbSPieter Ghysels #endif 2037575704cbSPieter Ghysels 2038b470e4b4SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatBindToCPU(Mat,PetscBool); 20392216c58aSStefano Zampini PETSC_EXTERN PetscErrorCode MatBoundToCPU(Mat,PetscBool*); 20409fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatBindToCPU (since v3.13)") static inline PetscErrorCode MatPinToCPU(Mat A,PetscBool flg) {return MatBindToCPU(A,flg);} 204165a9ecf2SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatSetBindingPropagates(Mat,PetscBool); 2042e9c74fd6SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetBindingPropagates(Mat,PetscBool *); 2043e7e92044SBarry Smith 2044042217e8SBarry Smith typedef struct _n_SplitCSRMat *PetscSplitCSRDataStructure; 2045042217e8SBarry Smith PETSC_EXTERN PetscErrorCode MatCUSPARSEGetDeviceMatWrite(Mat,PetscSplitCSRDataStructure*); 2046a587d139SMark 2047a587d139SMark #ifdef PETSC_HAVE_KOKKOS_KERNELS 2048042217e8SBarry Smith PETSC_EXTERN PetscErrorCode MatKokkosGetDeviceMatWrite(Mat,PetscSplitCSRDataStructure*); 2049042217e8SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJKokkosSetDeviceMat(Mat,PetscSplitCSRDataStructure); 2050042217e8SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJKokkosGetDeviceMat(Mat,PetscSplitCSRDataStructure*); 2051a587d139SMark #endif 2052a587d139SMark 2053aa372e3fSPaul Mullowney #ifdef PETSC_HAVE_CUDA 20543f9c0db1SPaul Mullowney /*E 2055e057df02SPaul Mullowney MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU) 20562692e278SPaul Mullowney matrices. 2057e057df02SPaul Mullowney 2058e057df02SPaul Mullowney Not Collective 2059e057df02SPaul Mullowney 20608468deeeSKarl Rupp + MAT_CUSPARSE_CSR - Compressed Sparse Row 20612692e278SPaul Mullowney . MAT_CUSPARSE_ELL - Ellpack (requires CUDA 4.2 or later). 20622692e278SPaul Mullowney - MAT_CUSPARSE_HYB - Hybrid, a combination of Ellpack and Coordinate format (requires CUDA 4.2 or later). 2063e057df02SPaul Mullowney 2064e057df02SPaul Mullowney Level: intermediate 2065e057df02SPaul Mullowney 2066af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 2067e057df02SPaul Mullowney 2068db781477SPatrick Sanan .seealso: `MatCUSPARSESetFormat()`, `MatCUSPARSEFormatOperation` 2069e057df02SPaul Mullowney E*/ 2070e057df02SPaul Mullowney 20713f9c0db1SPaul Mullowney typedef enum {MAT_CUSPARSE_CSR, MAT_CUSPARSE_ELL, MAT_CUSPARSE_HYB} MatCUSPARSEStorageFormat; 2072e057df02SPaul Mullowney 2073e057df02SPaul Mullowney /* these will be strings associated with enumerated type defined above */ 2074e057df02SPaul Mullowney PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[]; 2075e057df02SPaul Mullowney 20763f9c0db1SPaul Mullowney /*E 2077e057df02SPaul Mullowney MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU) 20782692e278SPaul Mullowney matrices whose operation should use a particular storage format. 2079e057df02SPaul Mullowney 2080e057df02SPaul Mullowney Not Collective 2081e057df02SPaul Mullowney 20828468deeeSKarl Rupp + MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult 20838468deeeSKarl Rupp . MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult 20848468deeeSKarl Rupp . MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult 20858468deeeSKarl Rupp - MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices 2086e057df02SPaul Mullowney 2087e057df02SPaul Mullowney Level: intermediate 2088e057df02SPaul Mullowney 2089db781477SPatrick Sanan .seealso: `MatCUSPARSESetFormat()`, `MatCUSPARSEStorageFormat` 2090e057df02SPaul Mullowney E*/ 209136d62e41SPaul Mullowney typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation; 2092e057df02SPaul Mullowney 209310e9db80SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 209410e9db80SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 2095e057df02SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat); 2096365b711fSMark Adams PETSC_EXTERN PetscErrorCode MatCUSPARSESetUseCPUSolve(Mat,PetscBool); 2097e8d2b73aSMark Adams typedef struct Mat_SeqAIJCUSPARSETriFactors* Mat_SeqAIJCUSPARSETriFactors_p; 20985f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetIJ(Mat,PetscBool,const int**,const int**); 20995f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreIJ(Mat,PetscBool,const int**,const int**); 21005f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArrayRead(Mat,const PetscScalar**); 21015f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArrayRead(Mat,const PetscScalar**); 21025f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArrayWrite(Mat,PetscScalar**); 21035f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArrayWrite(Mat,PetscScalar**); 21045f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArray(Mat,PetscScalar**); 21055f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArray(Mat,PetscScalar**); 2106637a0070SStefano Zampini 2107637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatCreateDenseCUDA(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*); 2108637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatCreateSeqDenseCUDA(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*); 2109637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatMPIDenseCUDASetPreallocation(Mat,PetscScalar[]); 2110637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqDenseCUDASetPreallocation(Mat,PetscScalar[]); 2111637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayWrite(Mat,PetscScalar**); 2112637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayRead(Mat,const PetscScalar**); 2113637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArray(Mat,PetscScalar**); 2114637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayWrite(Mat,PetscScalar**); 2115637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayRead(Mat,const PetscScalar**); 2116637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArray(Mat,PetscScalar**); 2117637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAPlaceArray(Mat,const PetscScalar*); 2118d5ea218eSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAReplaceArray(Mat,const PetscScalar*); 2119637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAResetArray(Mat); 21203fa6b06aSMark Adams 21219ae82921SPaul Mullowney #endif 21229ae82921SPaul Mullowney 2123d67ff14aSKarl Rupp #if defined(PETSC_HAVE_VIENNACL) 2124d67ff14aSKarl Rupp PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 2125d67ff14aSKarl Rupp PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 2126d67ff14aSKarl Rupp #endif 2127d67ff14aSKarl Rupp 212854efbe56SHong Zhang /* 212954efbe56SHong Zhang PETSc interface to FFTW 213054efbe56SHong Zhang */ 213154efbe56SHong Zhang #if defined(PETSC_HAVE_FFTW) 2132014dd563SJed Brown PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec); 2133014dd563SJed Brown PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec); 21342a7a6963SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*); 213554efbe56SHong Zhang #endif 213654efbe56SHong Zhang 2137d24d4204SJose E. Roman #if defined(PETSC_HAVE_SCALAPACK) 2138d24d4204SJose E. Roman PETSC_EXTERN PetscErrorCode MatCreateScaLAPACK(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 2139d24d4204SJose E. Roman PETSC_EXTERN PetscErrorCode MatScaLAPACKSetBlockSizes(Mat,PetscInt,PetscInt); 2140d24d4204SJose E. Roman PETSC_EXTERN PetscErrorCode MatScaLAPACKGetBlockSizes(Mat,PetscInt*,PetscInt*); 2141d24d4204SJose E. Roman #endif 2142d24d4204SJose E. Roman 2143014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*); 2144014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*); 2145014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]); 2146014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]); 2147014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***); 2148014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*); 214919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType); 2150014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]); 2151014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat); 2152d8588912SDave May 21534325cce7SMatthew G Knepley PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal); 2154e0a58c10SMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*); 21554325cce7SMatthew G Knepley 2156b541e6a4SDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSubdomainsCreateCoalesce(Mat,PetscInt,PetscInt*,IS**); 215753dd7562SDmitry Karpeev 2158c094ef40SMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatPreallocatorPreallocate(Mat,PetscBool,Mat); 2159c094ef40SMatthew G. Knepley 2160539c167fSBarry Smith PETSC_INTERN PetscErrorCode MatHeaderMerge(Mat,Mat*); 2161539c167fSBarry Smith PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat,Mat*); 21621a2c6b5cSJunchao Zhang 21637ee59b9bSJunchao Zhang PETSC_EXTERN PetscErrorCode MatSeqAIJGetCSRAndMemType(Mat,const PetscInt**,const PetscInt**,PetscScalar**,PetscMemType*); 216472833a62Smarkadams4 216572833a62Smarkadams4 PETSC_EXTERN PetscErrorCode MatCreateGraph(Mat,PetscBool,PetscBool,Mat*); 216672833a62Smarkadams4 PETSC_EXTERN PetscErrorCode MatFilter(Mat,PetscReal,Mat*); 216772833a62Smarkadams4 216823a5497aSJed Brown #endif 2169