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[]); 335014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*); 3363b00a383SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSeqAIJ(MPI_Comm,Mat,Mat,const PetscInt[],Mat*); 3373b00a383SHong Zhang 338014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 339014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 340014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*); 3417e8381f9SStefano Zampini 34282a78a4eSJed Brown PETSC_EXTERN PetscErrorCode MatSetPreallocationCOO(Mat,PetscCount,const PetscInt[],const PetscInt[]); 34382a78a4eSJed Brown PETSC_EXTERN PetscErrorCode MatSetPreallocationCOOLocal(Mat,PetscCount,PetscInt[],PetscInt[]); 3447e8381f9SStefano Zampini PETSC_EXTERN PetscErrorCode MatSetValuesCOO(Mat,const PetscScalar[],InsertMode); 345d21a29f3SJed Brown 346014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*); 347014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 348d21a29f3SJed Brown 349014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 350014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *); 35138f409ebSLisandro Dalcin PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 352014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 3534cce697cSJed Brown PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],const PetscInt[]); 354dfb205c3SBarry Smith 355014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*); 356c1fff1c6SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatCreateCentering(MPI_Comm,PetscInt,PetscInt,Mat*); 357014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat,Mat*); 358c5e4d11fSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatCreateNormalHermitian(Mat,Mat*); 359986c4d72SJose E. Roman PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat,Mat,Vec,Mat,Mat*); 360267ca84cSJose E. Roman PETSC_EXTERN PetscErrorCode MatLRCGetMats(Mat,Mat*,Mat*,Vec*,Mat*); 361c5e4d11fSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,ISLocalToGlobalMapping,Mat*); 362014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 363014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 364c0cdd4a1SDahai Guo 365014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*); 366014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter); 367014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*); 368014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*); 369014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat,Mat); 370014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat); 3718c8613bfSJakub Kruzik typedef enum {MAT_COMPOSITE_MERGE_RIGHT,MAT_COMPOSITE_MERGE_LEFT} MatCompositeMergeType; 3728c8613bfSJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeSetMergeType(Mat,MatCompositeMergeType); 373014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*); 3746d7c1e57SBarry Smith typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType; 375014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat,MatCompositeType); 3766dbc55e5SJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetType(Mat,MatCompositeType*); 3773b35acafSJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeSetMatStructure(Mat,MatStructure); 3783b35acafSJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetMatStructure(Mat,MatStructure*); 3796d0add67SJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetNumberMat(Mat,PetscInt*); 3808b5c3584SJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetMat(Mat,PetscInt,Mat*); 38103049c21SJunchao Zhang PETSC_EXTERN PetscErrorCode MatCompositeSetScalings(Mat,const PetscScalar*); 3826d7c1e57SBarry Smith 38319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateFFT(MPI_Comm,PetscInt,const PetscInt[],MatType,Mat*); 384014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqCUFFT(MPI_Comm,PetscInt,const PetscInt[],Mat*); 385dedccee8SHong Zhang 386014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*); 3878060fb66Sstefano_zampini PETSC_EXTERN PetscErrorCode MatTransposeGetMat(Mat,Mat*); 388d0de2241SAndrew Spott PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat,Mat*); 38906511a5cSPierre Jolivet PETSC_EXTERN PetscErrorCode MatHermitianTransposeGetMat(Mat,Mat*); 390fa80d070SPierre Jolivet PETSC_EXTERN PetscErrorCode MatNormalGetMat(Mat,Mat*); 39165f45395SPierre Jolivet PETSC_EXTERN PetscErrorCode MatNormalHermitianGetMat(Mat,Mat*); 39254e05e6cSHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatrixVirtual(Mat,IS,IS,Mat*); 39354e05e6cSHong Zhang PETSC_EXTERN PetscErrorCode MatSubMatrixVirtualUpdate(Mat,Mat,IS,IS); 394014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*); 3953423f386SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateConstantDiagonal(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar,Mat*); 3961472f72bSBarry Smith 397978814f1SStefano Zampini #if defined(PETSC_HAVE_HYPRE) 398d975228cSstefano_zampini PETSC_EXTERN PetscErrorCode MatHYPRESetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 399978814f1SStefano Zampini #endif 400978814f1SStefano Zampini 401014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPythonSetType(Mat,const char[]); 4021d6018f0SLisandro Dalcin 403846b4da1SFande Kong PETSC_EXTERN PetscErrorCode MatResetPreallocation(Mat); 404014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetUp(Mat); 405014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDestroy(Mat*); 406e56f5c9eSBarry Smith PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat,PetscObjectState*); 40721c89e3eSBarry Smith 408014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatConjugate(Mat); 409014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRealPart(Mat); 410014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat); 411014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,Mat*); 412014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetTrace(Mat,PetscScalar*); 413713ccfa9SJed Brown PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat,const PetscScalar **); 4140da83c2eSBarry Smith PETSC_EXTERN PetscErrorCode MatInvertVariableBlockDiagonal(Mat,PetscInt,const PetscInt*,PetscScalar*); 415479a70c0SJed Brown PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonalMat(Mat,Mat); 4168a9c020eSBarry Smith PETSC_EXTERN PetscErrorCode MatInvertVariableBlockEnvelope(Mat,MatReuse,Mat*); 41799cafbc1SBarry Smith 4188ed539a5SBarry Smith /* ------------------------------------------------------------*/ 419014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 4208a9c020eSBarry Smith PETSC_EXTERN PetscErrorCode MatSetValuesIS(Mat,IS,IS,const PetscScalar[],InsertMode); 421014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 422014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]); 423014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]); 424014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat,PetscInt,PetscInt,PetscInt[],const PetscScalar[]); 42573a71a0fSBarry Smith PETSC_EXTERN PetscErrorCode MatSetRandom(Mat,PetscRandom); 42684cb2905SBarry Smith 4272ef4de8bSBarry Smith /*S 4282ef4de8bSBarry Smith MatStencil - Data structure (C struct) for storing information about a single row or 42962ef0227SBarry Smith column of a matrix as indexed on an associated grid. These are arguments to MatSetStencil() and MatSetBlockStencil() 43062ef0227SBarry Smith 43162ef0227SBarry 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). 43262ef0227SBarry 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. 43362ef0227SBarry Smith 43462ef0227SBarry Smith For stencil access to vectors see DMDAVecGetArray(), DMDAVecGetArrayF90(). 435be479b30SJed Brown 436be479b30SJed Brown Fortran usage is different, see MatSetValuesStencil() for details. 4372ef4de8bSBarry Smith 4382ef4de8bSBarry Smith Level: beginner 4392ef4de8bSBarry Smith 440db781477SPatrick Sanan .seealso: `MatSetValuesStencil()`, `MatSetStencil()`, `MatSetValuesBlockedStencil()`, `DMDAVecGetArray()`, `DMDAVecGetArrayF90()` 4412ef4de8bSBarry Smith S*/ 442435da068SBarry Smith typedef struct { 443c1ac3661SBarry Smith PetscInt k,j,i,c; 444435da068SBarry Smith } MatStencil; 4452ef4de8bSBarry Smith 446014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 447014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 448014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt); 449435da068SBarry Smith 450d91e6319SBarry Smith /*E 451d91e6319SBarry Smith MatAssemblyType - Indicates if the matrix is now to be used, or if you plan 45262ef0227SBarry Smith to continue to add or insert values to it 453d91e6319SBarry Smith 454d91e6319SBarry Smith Level: beginner 455d91e6319SBarry Smith 456db781477SPatrick Sanan .seealso: `MatAssemblyBegin()`, `MatAssemblyEnd()` 457d91e6319SBarry Smith E*/ 4586d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType; 459014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType); 460014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType); 461014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssembled(Mat,PetscBool *); 4624f9c727eSBarry Smith 463d91e6319SBarry Smith /*E 464d91e6319SBarry Smith MatOption - Options that may be set for a matrix and its behavior or storage 465d91e6319SBarry Smith 466d91e6319SBarry Smith Level: beginner 467d91e6319SBarry Smith 468af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 4690f8fb01aSBarry Smith Any additions/changes here must also be made in src/mat/interface/dlregismat.c in MatOptions[] 470d91e6319SBarry Smith 47195452b02SPatrick Sanan Developer Notes: 47295452b02SPatrick Sanan Entries that are negative need not be called collectively by all processes. 473382164b0SBarry Smith 474db781477SPatrick Sanan .seealso: `MatSetOption()` 475d91e6319SBarry Smith E*/ 476c5e4d11fSDmitry Karpeev typedef enum {MAT_OPTION_MIN = -3, 477c5e4d11fSDmitry Karpeev MAT_UNUSED_NONZERO_LOCATION_ERR = -2, 47892d4d306SBarry Smith MAT_ROW_ORIENTED = -1, 479382164b0SBarry Smith MAT_SYMMETRIC = 1, 480382164b0SBarry Smith MAT_STRUCTURALLY_SYMMETRIC = 2, 4818c78258cSHong Zhang MAT_FORCE_DIAGONAL_ENTRIES = 3, 482382164b0SBarry Smith MAT_IGNORE_OFF_PROC_ENTRIES = 4, 483382164b0SBarry Smith MAT_USE_HASH_TABLE = 5, 484382164b0SBarry Smith MAT_KEEP_NONZERO_PATTERN = 6, 485382164b0SBarry Smith MAT_IGNORE_ZERO_ENTRIES = 7, 486382164b0SBarry Smith MAT_USE_INODES = 8, 487382164b0SBarry Smith MAT_HERMITIAN = 9, 488382164b0SBarry Smith MAT_SYMMETRY_ETERNAL = 10, 489c5e4d11fSDmitry Karpeev MAT_NEW_NONZERO_LOCATION_ERR = 11, 490382164b0SBarry Smith MAT_IGNORE_LOWER_TRIANGULAR = 12, 491382164b0SBarry Smith MAT_ERROR_LOWER_TRIANGULAR = 13, 492382164b0SBarry Smith MAT_GETROW_UPPERTRIANGULAR = 14, 493382164b0SBarry Smith MAT_SPD = 15, 49492d4d306SBarry Smith MAT_NO_OFF_PROC_ZERO_ROWS = 16, 49592d4d306SBarry Smith MAT_NO_OFF_PROC_ENTRIES = 17, 49692d4d306SBarry Smith MAT_NEW_NONZERO_LOCATIONS = 18, 497c5e4d11fSDmitry Karpeev MAT_NEW_NONZERO_ALLOCATION_ERR = 19, 498c5e4d11fSDmitry Karpeev MAT_SUBSET_OFF_PROC_ENTRIES = 20, 499c10200c1SHong Zhang MAT_SUBMAT_SINGLEIS = 21, 500957cac9fSHong Zhang MAT_STRUCTURE_ONLY = 22, 501071fcb05SBarry Smith MAT_SORTED_FULL = 23, 5021a2c6b5cSJunchao Zhang MAT_FORM_EXPLICIT_TRANSPOSE = 24, 5031a2c6b5cSJunchao Zhang MAT_OPTION_MAX = 25} MatOption; 504e057df02SPaul Mullowney 5050f8fb01aSBarry Smith PETSC_EXTERN const char *const *MatOptions; 506014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscBool); 5077d68702bSBarry Smith PETSC_EXTERN PetscErrorCode MatGetOption(Mat,MatOption,PetscBool*); 508856afa8bSStefano Zampini PETSC_EXTERN PetscErrorCode MatPropagateSymmetryOptions(Mat,Mat); 50919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatGetType(Mat,MatType*); 51084cb2905SBarry Smith 511014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]); 512014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 513014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 514014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat); 515014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat); 516014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt); 5178c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat,PetscScalar *[]); 5188f1ea47aSStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJGetArrayRead(Mat,const PetscScalar *[]); 519d67d9f35SJunchao Zhang PETSC_EXTERN PetscErrorCode MatSeqAIJGetArrayWrite(Mat,PetscScalar *[]); 5208c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat,PetscScalar *[]); 5218f1ea47aSStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArrayRead(Mat,const PetscScalar *[]); 522d67d9f35SJunchao Zhang PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArrayWrite(Mat,PetscScalar *[]); 52321e72a00SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJGetMaxRowNonzeros(Mat,PetscInt*); 524bd04181cSBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJSetValuesLocalFast(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 5254099cc6bSBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJSetType(Mat,MatType); 526ad7e164aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatSeqAIJKron(Mat,Mat,MatReuse,Mat*); 527388d47a6SSatish Balay PETSC_EXTERN PetscErrorCode MatSeqAIJRegister(const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat *)); 5284099cc6bSBarry Smith PETSC_EXTERN PetscFunctionList MatSeqAIJList; 529cda14afcSprj- PETSC_EXTERN PetscErrorCode MatSeqBAIJGetArray(Mat,PetscScalar *[]); 530cda14afcSprj- PETSC_EXTERN PetscErrorCode MatSeqBAIJRestoreArray(Mat,PetscScalar *[]); 5318397e458SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqSBAIJGetArray(Mat,PetscScalar *[]); 5328397e458SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqSBAIJRestoreArray(Mat,PetscScalar *[]); 5338c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat,PetscScalar *[]); 5348c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat,PetscScalar *[]); 535d3042a70SBarry Smith PETSC_EXTERN PetscErrorCode MatDensePlaceArray(Mat,const PetscScalar[]); 536d5ea218eSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseReplaceArray(Mat,const PetscScalar[]); 537d3042a70SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseResetArray(Mat); 5388572280aSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetArrayRead(Mat,const PetscScalar *[]); 5398572280aSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayRead(Mat,const PetscScalar *[]); 5406947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseGetArrayWrite(Mat,PetscScalar *[]); 5416947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayWrite(Mat,PetscScalar *[]); 542014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *); 543014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt); 544014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat,PetscInt *,PetscInt *); 545014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat,PetscInt,PetscInt); 54633d57670SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSizesFromMats(Mat,Mat,Mat); 5470da83c2eSBarry Smith PETSC_EXTERN PetscErrorCode MatSetVariableBlockSizes(Mat,PetscInt,PetscInt*); 5480da83c2eSBarry Smith PETSC_EXTERN PetscErrorCode MatGetVariableBlockSizes(Mat,PetscInt*,const PetscInt**); 5490da83c2eSBarry Smith 55086aefd0dSHong Zhang PETSC_EXTERN PetscErrorCode MatDenseGetColumn(Mat,PetscInt,PetscScalar*[]); 55186aefd0dSHong Zhang PETSC_EXTERN PetscErrorCode MatDenseRestoreColumn(Mat,PetscScalar*[]); 5526947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseGetColumnVec(Mat,PetscInt,Vec*); 5536947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVec(Mat,PetscInt,Vec*); 5546947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecRead(Mat,PetscInt,Vec*); 5556947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecRead(Mat,PetscInt,Vec*); 5566947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecWrite(Mat,PetscInt,Vec*); 5576947451fSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecWrite(Mat,PetscInt,Vec*); 558a2748737SPierre Jolivet PETSC_EXTERN PetscErrorCode MatDenseGetSubMatrix(Mat,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 5595ea7661aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatDenseRestoreSubMatrix(Mat,Mat*); 5601620fd73SBarry Smith 561014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMult(Mat,Vec,Vec); 562014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec); 563014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec); 564014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec); 565014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec); 566014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *); 567014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *); 568014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec); 569014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec); 570014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat); 571bdc285e1SStefano Zampini PETSC_EXTERN PetscErrorCode MatMatSolveTranspose(Mat,Mat,Mat); 572eb3ef3b2SHong Zhang PETSC_EXTERN PetscErrorCode MatMatTransposeSolve(Mat,Mat,Mat); 573f9426fe0SMark Adams PETSC_EXTERN PetscErrorCode MatResidual(Mat,Vec,Vec,Vec); 574f5edf698SHong Zhang 575d91e6319SBarry Smith /*E 576d91e6319SBarry Smith MatDuplicateOption - Indicates if a duplicated sparse matrix should have 577d91e6319SBarry Smith its numerical values copied over or just its nonzero structure. 578d91e6319SBarry Smith 579d91e6319SBarry Smith Level: beginner 580d91e6319SBarry Smith 581af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 582d91e6319SBarry Smith 5830018da39SRichard Tran Mills $ MAT_DO_NOT_COPY_VALUES - Create a matrix using the same nonzero pattern as the original matrix, 5840018da39SRichard Tran Mills $ with zeros for the numerical values. 5850018da39SRichard Tran Mills $ MAT_COPY_VALUES - Create a matrix with the same nonzero pattern as the original matrix 5860018da39SRichard Tran Mills $ and with the same numerical values. 5870018da39SRichard Tran Mills $ MAT_SHARE_NONZERO_PATTERN - Create a matrix that shares the nonzero structure with the previous matrix 5880018da39SRichard Tran Mills $ and does not copy it, using zeros for the numerical values. The parent and 5890018da39SRichard Tran Mills $ child matrices will share their index (i and j) arrays, and you cannot 5900018da39SRichard Tran Mills $ insert new nonzero entries into either matrix. 5910018da39SRichard Tran Mills 59295452b02SPatrick Sanan Notes: 59395452b02SPatrick Sanan Many matrix types (including SeqAIJ) do not support the MAT_SHARE_NONZERO_PATTERN optimization; in 5940018da39SRichard Tran Mills this case the behavior is as if MAT_DO_NOT_COPY_VALUES has been specified. 59570dcbbb9SBarry Smith 596db781477SPatrick Sanan .seealso: `MatDuplicate()` 597d91e6319SBarry Smith E*/ 59870dcbbb9SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption; 5992e8a6d31SBarry Smith 60019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*); 601014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*); 60294a9d846SBarry Smith 603014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure); 604014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer); 605014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *); 606014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *); 607014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *); 608014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *); 609014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *); 610014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool *,PetscInt *); 611014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer); 6127b80b807SBarry Smith 6131a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *); 6141a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *); 6151a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *); 6161a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *); 617d4fbbf0eSBarry Smith 618d91e6319SBarry Smith /*S 619d91e6319SBarry Smith MatInfo - Context of matrix information, used with MatGetInfo() 620d91e6319SBarry Smith 621d91e6319SBarry Smith In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE 622d91e6319SBarry Smith 623d91e6319SBarry Smith Level: intermediate 624d91e6319SBarry Smith 625db781477SPatrick Sanan .seealso: `MatGetInfo()`, `MatInfoType` 626d91e6319SBarry Smith S*/ 6274e220ebcSLois Curfman McInnes typedef struct { 628b0a32e0cSBarry Smith PetscLogDouble block_size; /* block size */ 629b0a32e0cSBarry Smith PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */ 630b0a32e0cSBarry Smith PetscLogDouble memory; /* memory allocated */ 631b0a32e0cSBarry Smith PetscLogDouble assemblies; /* number of matrix assemblies called */ 632b0a32e0cSBarry Smith PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */ 633b0a32e0cSBarry Smith PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */ 634b0a32e0cSBarry Smith PetscLogDouble factor_mallocs; /* number of mallocs during factorization */ 6354e220ebcSLois Curfman McInnes } MatInfo; 6364e220ebcSLois Curfman McInnes 637d9274352SBarry Smith /*E 638d9274352SBarry Smith MatInfoType - Indicates if you want information about the local part of the matrix, 639d9274352SBarry Smith the entire parallel matrix or the maximum over all the local parts. 640d9274352SBarry Smith 641d9274352SBarry Smith Level: beginner 642d9274352SBarry Smith 643af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 644d9274352SBarry Smith 645db781477SPatrick Sanan .seealso: `MatGetInfo()`, `MatInfo` 646d9274352SBarry Smith E*/ 6477b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType; 648014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*); 649014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec); 650014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]); 651014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]); 652014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]); 653014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]); 654014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat,Vec); 655014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*); 656014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*); 657014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat*); 658014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec); 659014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode); 660a52676ecSHong Zhang 661014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool*); 662014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool*); 663014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool*); 664014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool*); 665014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*); 666e573050aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeEqual(Mat,Mat,PetscInt,PetscBool*); 667e573050aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*); 668a52676ecSHong Zhang PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 669a52676ecSHong Zhang PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 670cc48ffa7SToby Isaac PETSC_EXTERN PetscErrorCode MatMatTransposeMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 6714222ddf1SHong Zhang PETSC_EXTERN PetscErrorCode MatPtAPMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 672447fed29SStefano Zampini PETSC_EXTERN PetscErrorCode MatRARtMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 67386919fd6SHong Zhang PETSC_EXTERN PetscErrorCode MatIsLinear(Mat,PetscInt,PetscBool*); 6747b80b807SBarry Smith 675014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal*); 676014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal*); 677857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnSums(Mat,PetscScalar*); 678857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnSumsRealPart(Mat,PetscReal*); 679857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnSumsImaginaryPart(Mat,PetscReal*); 680857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnMeans(Mat,PetscScalar*); 681857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnMeansRealPart(Mat,PetscReal*); 682857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnMeansImaginaryPart(Mat,PetscReal*); 683857cbf51SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetColumnReductions(Mat,PetscInt,PetscReal*); 684014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat); 6851b2b9847SBarry Smith PETSC_EXTERN PetscErrorCode MatSetInf(Mat); 686014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 687014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec); 688014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec); 689014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec); 690014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 691014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec); 6927b80b807SBarry Smith 693014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*); 694014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*); 695014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*); 696014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**); 697014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*); 698014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**); 699566876eaSJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*); 7005ef9f2a5SBarry Smith 7017dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 7029fbee547SJacob 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);} 7037dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 7049fbee547SJacob 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);} 705014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]); 706df750dc8SHong Zhang PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt,Mat *[]); 7077dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,MatReuse,Mat *); 7089fbee547SJacob 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);} 709014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*); 710014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*); 711014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*); 712014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*); 7137b80b807SBarry Smith 714014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*); 715014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*); 716014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat); 717014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*); 7188a9c020eSBarry Smith PETSC_EXTERN PetscErrorCode MatAIJGetLocalMat(Mat,Mat*); 719014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*); 720ed502f03SStefano Zampini PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatMerge(Mat,MatReuse,IS*,Mat*); 721014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*); 722014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]); 7238efafbd8SBarry Smith 724014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt); 725aa1e27eaSFande Kong PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat mat,PetscInt n,IS is[],PetscInt ov); 726d2b2a242SBarry Smith PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat,PetscBool); 7277b80b807SBarry Smith 728014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 72922440eb1SKris Buschelman 7307bab7c10SHong Zhang PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*); 7312df6c5c3SPatrick Farrell PETSC_EXTERN PetscErrorCode MatGalerkin(Mat,Mat,Mat,MatReuse,PetscReal,Mat*); 7327bab7c10SHong Zhang 733014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*); 734014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*); 73522440eb1SKris Buschelman 736014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 737014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*); 738bc011b1eSHong Zhang 739014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure); 740014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure); 7411c741599SHong Zhang 742014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar); 743014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar); 7447b80b807SBarry Smith 745014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping); 746014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*); 747a93ff8c4SPeter Brune PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat,PetscLayout*,PetscLayout*); 74881fa06acSBarry Smith PETSC_EXTERN PetscErrorCode MatSetLayouts(Mat,PetscLayout,PetscLayout); 749014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 750014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec); 751014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 752014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec); 753e265f6d6SPatrick Sanan PETSC_EXTERN PetscErrorCode MatGetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]); 754014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 755014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 756052efed2SBarry Smith 757014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt); 758014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 75990f02eecSBarry Smith 760014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec); 761014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec); 762014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec); 76330b0564aSStefano Zampini PETSC_EXTERN PetscErrorCode MatMatInterpolate(Mat,Mat,Mat*); 76430b0564aSStefano Zampini PETSC_EXTERN PetscErrorCode MatMatInterpolateAdd(Mat,Mat,Mat,Mat*); 76530b0564aSStefano Zampini PETSC_EXTERN PetscErrorCode MatMatRestrict(Mat,Mat,Mat*); 7662a7a6963SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat,Vec*,Vec*); 7679fbee547SJacob 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);} 76853cd1579SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat,PetscInt,MPI_Comm,MatReuse,Mat*); 769014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*); 770014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*); 7713a062f41SBarry Smith PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat,IS*); 7729c8f2541SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm,Mat,PetscInt,MatReuse,Mat*); 773bd481603SBarry Smith 774bd481603SBarry Smith /*MC 7751620fd73SBarry Smith MatSetValue - Set a single entry into a matrix. 7761620fd73SBarry Smith 7771620fd73SBarry Smith Not collective 7781620fd73SBarry Smith 779a9834a7dSSatish Balay Synopsis: 780a9834a7dSSatish Balay #include <petscmat.h> 781a9834a7dSSatish Balay PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode) 782a9834a7dSSatish Balay 7831620fd73SBarry Smith Input Parameters: 7841620fd73SBarry Smith + m - the matrix 7851620fd73SBarry Smith . row - the row location of the entry 7861620fd73SBarry Smith . col - the column location of the entry 7871620fd73SBarry Smith . value - the value to insert 7881620fd73SBarry Smith - mode - either INSERT_VALUES or ADD_VALUES 7891620fd73SBarry Smith 7901620fd73SBarry Smith Notes: 791e5e5a7b5SPatrick Sanan For efficiency one should use MatSetValues() and set several values simultaneously. 7921620fd73SBarry Smith 7931620fd73SBarry Smith Level: beginner 7941620fd73SBarry Smith 795db781477SPatrick Sanan .seealso: `MatGetValue()`, `MatSetValues()`, `MatSetValueLocal()`, `MatSetValuesLocal()` 7961620fd73SBarry Smith M*/ 7979fbee547SJacob Faibussowitsch static inline PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);} 7981620fd73SBarry Smith 799e5e5a7b5SPatrick Sanan /*@C 800e5e5a7b5SPatrick Sanan MatGetValue - Gets a single value from a matrix 8011620fd73SBarry Smith 802e5e5a7b5SPatrick Sanan Not Collective; can only return a value owned by the given process 803e5e5a7b5SPatrick Sanan 804e5e5a7b5SPatrick Sanan Input Parameters: 805e5e5a7b5SPatrick Sanan + mat - the matrix 806e5e5a7b5SPatrick Sanan . row - the row location of the entry 807e5e5a7b5SPatrick Sanan - col - the column location of the entry 808e5e5a7b5SPatrick Sanan 809e5e5a7b5SPatrick Sanan Output Parameter: 810e5e5a7b5SPatrick Sanan . va - the value 811e5e5a7b5SPatrick Sanan 812e5e5a7b5SPatrick Sanan Notes: 813e5e5a7b5SPatrick Sanan For efficiency one should use MatGetValues() and get several values simultaneously. 814e5e5a7b5SPatrick Sanan 815e5e5a7b5SPatrick Sanan See notes for MatGetValues(). 816e5e5a7b5SPatrick Sanan 817e5e5a7b5SPatrick Sanan Level: advanced 818e5e5a7b5SPatrick Sanan 819db781477SPatrick Sanan .seealso: `MatSetValue()`, `MatGetValueLocal()`, `MatGetValues()` 820e5e5a7b5SPatrick Sanan @*/ 8219fbee547SJacob Faibussowitsch static inline PetscErrorCode MatGetValue(Mat mat,PetscInt row,PetscInt col,PetscScalar *va) {return MatGetValues(mat,1,&row,1,&col,va);} 822e5e5a7b5SPatrick Sanan 823e5e5a7b5SPatrick Sanan /*MC 824e5e5a7b5SPatrick Sanan MatSetValueLocal - Inserts or adds a single value into a matrix, 825e5e5a7b5SPatrick Sanan using a local numbering of the nodes. 826e5e5a7b5SPatrick Sanan 827e5e5a7b5SPatrick Sanan Not Collective 828e5e5a7b5SPatrick Sanan 829e5e5a7b5SPatrick Sanan Input Parameters: 830e5e5a7b5SPatrick Sanan + m - the matrix 831e5e5a7b5SPatrick Sanan . row - the row location of the entry 832e5e5a7b5SPatrick Sanan . col - the column location of the entry 833e5e5a7b5SPatrick Sanan . value - the value to insert 834e5e5a7b5SPatrick Sanan - mode - either INSERT_VALUES or ADD_VALUES 835e5e5a7b5SPatrick Sanan 836e5e5a7b5SPatrick Sanan Notes: 837e5e5a7b5SPatrick Sanan For efficiency one should use MatSetValuesLocal() and set several values simultaneously. 838e5e5a7b5SPatrick Sanan 839e5e5a7b5SPatrick Sanan See notes for MatSetValuesLocal() for additional information on when and how this function can be used. 840e5e5a7b5SPatrick Sanan 841e5e5a7b5SPatrick Sanan Level: intermediate 842e5e5a7b5SPatrick Sanan 843db781477SPatrick Sanan .seealso: `MatSetValue()`, `MatSetValuesLocal()` 844e5e5a7b5SPatrick Sanan M*/ 8459fbee547SJacob Faibussowitsch static inline PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);} 8461620fd73SBarry Smith 8471620fd73SBarry Smith /*MC 848d0609cedSBarry Smith MatPreallocateBegin - Begins the block of code that will count the number of nonzeros per 849bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 850bd481603SBarry Smith 851bd481603SBarry Smith Synopsis: 852aaa7dc30SBarry Smith #include <petscmat.h> 853d0609cedSBarry Smith PetscErrorCode MatPreallocateBegin(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 854bd481603SBarry Smith 855d083f849SBarry Smith Collective 856bd481603SBarry Smith 857bd481603SBarry Smith Input Parameters: 858bd481603SBarry Smith + comm - the communicator that will share the eventually allocated matrix 859859fcb39SBarry Smith . nrows - the number of LOCAL rows in the matrix 860859fcb39SBarry Smith - ncols - the number of LOCAL columns in the matrix 861bd481603SBarry Smith 862bd481603SBarry Smith Output Parameters: 863bd481603SBarry Smith + dnz - the array that will be passed to the matrix preallocation routines 864a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 865bd481603SBarry Smith 866bd481603SBarry Smith Level: intermediate 867bd481603SBarry Smith 868bd481603SBarry Smith Notes: 869d0609cedSBarry Smith This is a macro that handles its own error checking, it does not return an error code. 870d0609cedSBarry Smith 871a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 872bd481603SBarry Smith 8731d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 874bd481603SBarry Smith 875d0609cedSBarry Smith Developer Notes: 8761620fd73SBarry Smith This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize(). 8771620fd73SBarry Smith 878db781477SPatrick Sanan .seealso: `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`, 879db781477SPatrick Sanan `MatPreallocateSymmetricSetLocalBlock()` 880bd481603SBarry Smith M*/ 881d0609cedSBarry Smith #define MatPreallocateBegin(comm,nrows,ncols,dnz,onz) do { \ 8825f80ce2aSJacob Faibussowitsch PetscInt __nrows = (nrows),__ncols = (ncols),__rstart,__start,__end = 0; \ 8839566063dSJacob Faibussowitsch PetscCall(PetscCalloc2(__nrows,&(dnz),__nrows,&(onz))); \ 8849566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&__ncols,&__end,1,MPIU_INT,MPI_SUM,comm)); \ 8855f80ce2aSJacob Faibussowitsch __start = __end - __ncols; (void)__start; \ 8869566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm)); \ 8875f80ce2aSJacob Faibussowitsch __rstart -= __nrows 8887c922b88SBarry Smith 889d0609cedSBarry Smith #define MatPreallocateInitialize(...) PETSC_DEPRECATED_MACRO("GCC warning \"Use MatPreallocateBegin() (since version 3.18)\"") MatPreallocateBegin(__VA_ARGS__) 890d0609cedSBarry Smith 891bd481603SBarry Smith /*MC 892bd481603SBarry Smith MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 893bd481603SBarry Smith inserted using a local number of the rows and columns 894bd481603SBarry Smith 895bd481603SBarry Smith Synopsis: 896aaa7dc30SBarry Smith #include <petscmat.h> 897c1ac3661SBarry Smith PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 898bd481603SBarry Smith 899bd481603SBarry Smith Not Collective 900bd481603SBarry Smith 901bd481603SBarry Smith Input Parameters: 902784ac674SJed Brown + map - the row mapping from local numbering to global numbering 903bd481603SBarry Smith . nrows - the number of rows indicated 9041d73ed98SBarry Smith . rows - the indices of the rows 905784ac674SJed Brown . cmap - the column mapping from local to global numbering 906bd481603SBarry Smith . ncols - the number of columns in the matrix 907bd481603SBarry Smith . cols - the columns indicated 908bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 909a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 910bd481603SBarry Smith 911bd481603SBarry Smith Level: intermediate 912bd481603SBarry Smith 913bd481603SBarry Smith Notes: 914a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 915bd481603SBarry Smith 9161d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 917bd481603SBarry Smith 918db781477SPatrick Sanan .seealso: `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()` 919db781477SPatrick Sanan `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocalRemoveDups()` 920bd481603SBarry Smith M*/ 92194bad497SJacob Faibussowitsch #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) \ 92294bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 9239566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApply(rmap,nrows,rows,rows)); \ 9249566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApply(cmap,ncols,cols,cols)); \ 9259566063dSJacob Faibussowitsch for (PetscInt __l=0;__l<nrows;__l++) PetscCall(MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz)); \ 92694bad497SJacob Faibussowitsch ) 927c4f061fbSSatish Balay 928bd481603SBarry Smith /*MC 929c1154cd5SBarry Smith MatPreallocateSetLocalRemoveDups - Indicates the locations (rows and columns) in the matrix where nonzeros will be 930c1154cd5SBarry Smith inserted using a local number of the rows and columns. This version removes any duplicate columns in cols 931c1154cd5SBarry Smith 932c1154cd5SBarry Smith Synopsis: 933c1154cd5SBarry Smith #include <petscmat.h> 934c1154cd5SBarry Smith PetscErrorCode MatPreallocateSetLocalRemoveDups(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 935c1154cd5SBarry Smith 936c1154cd5SBarry Smith Not Collective 937c1154cd5SBarry Smith 938c1154cd5SBarry Smith Input Parameters: 939c1154cd5SBarry Smith + map - the row mapping from local numbering to global numbering 940c1154cd5SBarry Smith . nrows - the number of rows indicated 941c1154cd5SBarry Smith . rows - the indices of the rows (these values are mapped to the global values) 942c1154cd5SBarry Smith . cmap - the column mapping from local to global numbering 943c1154cd5SBarry Smith . ncols - the number of columns in the matrix (this value will be changed if duplicate columns are found) 944c1154cd5SBarry Smith . cols - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed) 945c1154cd5SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 946a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 947c1154cd5SBarry Smith 948c1154cd5SBarry Smith Level: intermediate 949c1154cd5SBarry Smith 950c1154cd5SBarry Smith Notes: 951c1154cd5SBarry Smith See Users-Manual: ch_performance for more details. 952c1154cd5SBarry Smith 953c1154cd5SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 954c1154cd5SBarry Smith 955db781477SPatrick Sanan .seealso: `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()` 956db781477SPatrick Sanan `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocal()` 957c1154cd5SBarry Smith M*/ 95894bad497SJacob Faibussowitsch #define MatPreallocateSetLocalRemoveDups(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) \ 95994bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 9609566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApply(rmap,nrows,rows,rows)); \ 9619566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApply(cmap,ncols,cols,cols)); \ 9629566063dSJacob Faibussowitsch PetscCall(PetscSortRemoveDupsInt(&ncols,cols)); \ 9639566063dSJacob Faibussowitsch for (PetscInt __l=0;__l<nrows;__l++) PetscCall(MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz)); \ 96494bad497SJacob Faibussowitsch ) 965c1154cd5SBarry Smith 966c1154cd5SBarry Smith /*MC 967d6e23781SBarry Smith MatPreallocateSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 968bd481603SBarry Smith inserted using a local number of the rows and columns 969bd481603SBarry Smith 970bd481603SBarry Smith Synopsis: 971aaa7dc30SBarry Smith #include <petscmat.h> 972d6e23781SBarry Smith PetscErrorCode MatPreallocateSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 973d6e23781SBarry Smith 974d6e23781SBarry Smith Not Collective 975d6e23781SBarry Smith 976d6e23781SBarry Smith Input Parameters: 977d6e23781SBarry Smith + map - the row mapping from local numbering to global numbering 978d6e23781SBarry Smith . nrows - the number of rows indicated 979d6e23781SBarry Smith . rows - the indices of the rows 980d6e23781SBarry Smith . cmap - the column mapping from local to global numbering 981d6e23781SBarry Smith . ncols - the number of columns in the matrix 982d6e23781SBarry Smith . cols - the columns indicated 983d6e23781SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 984a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 985d6e23781SBarry Smith 986d6e23781SBarry Smith Level: intermediate 987d6e23781SBarry Smith 988d6e23781SBarry Smith Notes: 989d6e23781SBarry Smith See Users-Manual: ch_performance for more details. 990d6e23781SBarry Smith 991d6e23781SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 992d6e23781SBarry Smith 993db781477SPatrick Sanan .seealso: `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()` 994db781477SPatrick Sanan `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()` 995d6e23781SBarry Smith M*/ 99694bad497SJacob Faibussowitsch #define MatPreallocateSetLocalBlock(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) \ 99794bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 9989566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApplyBlock(rmap,nrows,rows,rows)); \ 9999566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApplyBlock(cmap,ncols,cols,cols)); \ 10009566063dSJacob Faibussowitsch for (PetscInt __l=0;__l<nrows;__l++) PetscCall(MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz)); \ 100194bad497SJacob Faibussowitsch ) 1002d6e23781SBarry Smith 1003d6e23781SBarry Smith /*MC 1004d6e23781SBarry Smith MatPreallocateSymmetricSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 1005d6e23781SBarry Smith inserted using a local number of the rows and columns 1006d6e23781SBarry Smith 1007d6e23781SBarry Smith Synopsis: 1008d6e23781SBarry Smith #include <petscmat.h> 1009d6e23781SBarry Smith PetscErrorCode MatPreallocateSymmetricSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1010bd481603SBarry Smith 1011bd481603SBarry Smith Not Collective 1012bd481603SBarry Smith 1013bd481603SBarry Smith Input Parameters: 1014bd481603SBarry Smith + map - the mapping between local numbering and global numbering 1015bd481603SBarry Smith . nrows - the number of rows indicated 10161d73ed98SBarry Smith . rows - the indices of the rows 1017bd481603SBarry Smith . ncols - the number of columns in the matrix 1018bd481603SBarry Smith . cols - the columns indicated 1019bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 1020a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 1021bd481603SBarry Smith 1022bd481603SBarry Smith Level: intermediate 1023bd481603SBarry Smith 1024bd481603SBarry Smith Notes: 1025a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 1026bd481603SBarry Smith 1027bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 1028bd481603SBarry Smith 1029db781477SPatrick Sanan .seealso: `MatPreallocateEnd()`, `MatPreallocateSet()` 1030db781477SPatrick Sanan `MatPreallocateBegin()`, `MatPreallocateSetLocal()` 1031bd481603SBarry Smith M*/ 103294bad497SJacob Faibussowitsch #define MatPreallocateSymmetricSetLocalBlock(map,nrows,rows,ncols,cols,dnz,onz) \ 103394bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 10349566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApplyBlock(map,nrows,rows,rows)); \ 10359566063dSJacob Faibussowitsch PetscCall(ISLocalToGlobalMappingApplyBlock(map,ncols,cols,cols)); \ 10369566063dSJacob Faibussowitsch for (PetscInt __l=0;__l<nrows;__l++) PetscCall(MatPreallocateSymmetricSetBlock((rows)[__l],ncols,cols,dnz,onz)); \ 103794bad497SJacob Faibussowitsch ) 1038e83a5d19SLisandro Dalcin 1039bd481603SBarry Smith /*MC 1040bd481603SBarry Smith MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 1041bd481603SBarry Smith inserted using a local number of the rows and columns 1042bd481603SBarry Smith 1043bd481603SBarry Smith Synopsis: 1044aaa7dc30SBarry Smith #include <petscmat.h> 1045c1ac3661SBarry Smith PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1046bd481603SBarry Smith 1047bd481603SBarry Smith Not Collective 1048bd481603SBarry Smith 1049bd481603SBarry Smith Input Parameters: 105064075487SBarry Smith + row - the row 1051bd481603SBarry Smith . ncols - the number of columns in the matrix 1052a50f8bf6SHong Zhang - cols - the columns indicated 1053a50f8bf6SHong Zhang 1054a50f8bf6SHong Zhang Output Parameters: 1055a50f8bf6SHong Zhang + dnz - the array that will be passed to the matrix preallocation routines 1056a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 1057bd481603SBarry Smith 1058bd481603SBarry Smith Level: intermediate 1059bd481603SBarry Smith 1060bd481603SBarry Smith Notes: 1061a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 1062bd481603SBarry Smith 1063bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 1064bd481603SBarry Smith 1065d0609cedSBarry Smith This is a MACRO not a function because it uses variables declared in MatPreallocateBegin(). 10661620fd73SBarry Smith 1067db781477SPatrick Sanan .seealso: `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()` 1068db781477SPatrick Sanan `MatPreallocateBegin()`, `MatPreallocateSetLocal()` 1069bd481603SBarry Smith M*/ 107094bad497SJacob Faibussowitsch #define MatPreallocateSet(row,nc,cols,dnz,onz) PetscMacroReturnStandard( \ 10712c71b3e2SJacob 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); \ 10722c71b3e2SJacob 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); \ 10735f80ce2aSJacob Faibussowitsch for (PetscInt __i = 0; __i < nc; ++__i) { \ 107464075487SBarry Smith if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \ 1075a6042fd4SStefano Zampini else if (dnz[row - __rstart] < __ncols) dnz[row - __rstart]++; \ 10767c922b88SBarry Smith } \ 107794bad497SJacob Faibussowitsch ) 10787c922b88SBarry Smith 1079bd481603SBarry Smith /*MC 1080d6e23781SBarry Smith MatPreallocateSymmetricSetBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 1081bd481603SBarry Smith inserted using a local number of the rows and columns 1082bd481603SBarry Smith 1083bd481603SBarry Smith Synopsis: 1084aaa7dc30SBarry Smith #include <petscmat.h> 1085d6e23781SBarry Smith PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1086bd481603SBarry Smith 1087bd481603SBarry Smith Not Collective 1088bd481603SBarry Smith 1089bd481603SBarry Smith Input Parameters: 1090bd481603SBarry Smith + nrows - the number of rows indicated 10911d73ed98SBarry Smith . rows - the indices of the rows 1092bd481603SBarry Smith . ncols - the number of columns in the matrix 1093bd481603SBarry Smith . cols - the columns indicated 1094bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 1095a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 1096bd481603SBarry Smith 1097bd481603SBarry Smith Level: intermediate 1098bd481603SBarry Smith 1099bd481603SBarry Smith Notes: 1100a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 1101bd481603SBarry Smith 1102bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 1103bd481603SBarry Smith 1104d0609cedSBarry Smith This is a MACRO not a function because it uses variables declared in MatPreallocateBegin(). 11051620fd73SBarry Smith 1106db781477SPatrick Sanan .seealso: `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateBegin()`, 1107db781477SPatrick Sanan `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocal()` 1108bd481603SBarry Smith M*/ 110994bad497SJacob Faibussowitsch #define MatPreallocateSymmetricSetBlock(row,nc,cols,dnz,onz) \ 111094bad497SJacob Faibussowitsch PetscMacroReturnStandard( \ 11115f80ce2aSJacob Faibussowitsch for (PetscInt __i=0; __i<nc; __i++) { \ 1112d3d32019SBarry Smith if (cols[__i] >= __end) onz[row - __rstart]++; \ 1113a6042fd4SStefano Zampini else if (cols[__i] >= row && dnz[row - __rstart] < __ncols) dnz[row - __rstart]++; \ 1114d3d32019SBarry Smith } \ 111594bad497SJacob Faibussowitsch ) 1116d3d32019SBarry Smith 1117bd481603SBarry Smith /*MC 1118a6042fd4SStefano Zampini MatPreallocateLocation - An alternative to MatPreallocateSet() that puts the nonzero locations into the matrix if it exists 111916371a99SBarry Smith 112016371a99SBarry Smith Synopsis: 1121aaa7dc30SBarry Smith #include <petscmat.h> 112216371a99SBarry Smith PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz) 112316371a99SBarry Smith 112416371a99SBarry Smith Not Collective 112516371a99SBarry Smith 112616371a99SBarry Smith Input Parameters: 1127a2b725a8SWilliam Gropp + A - matrix 112816371a99SBarry Smith . row - row where values exist (must be local to this process) 112916371a99SBarry Smith . ncols - number of columns 113016371a99SBarry Smith . cols - columns with nonzeros 113116371a99SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 1132a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 113316371a99SBarry Smith 113416371a99SBarry Smith Level: intermediate 113516371a99SBarry Smith 113616371a99SBarry Smith Notes: 1137a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 113816371a99SBarry Smith 113916371a99SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 114016371a99SBarry Smith 114116371a99SBarry Smith This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines. 114216371a99SBarry Smith 1143db781477SPatrick Sanan .seealso: `MatPreallocateBegin()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`, 1144db781477SPatrick Sanan `MatPreallocateSymmetricSetLocalBlock()` 114516371a99SBarry Smith M*/ 1146d0609cedSBarry 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)) 114716371a99SBarry Smith 114816371a99SBarry Smith /*MC 1149d0609cedSBarry Smith MatPreallocateEnd - Ends the block of code that will count the number of nonzeros per 1150bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 1151bd481603SBarry Smith 1152bd481603SBarry Smith Synopsis: 1153aaa7dc30SBarry Smith #include <petscmat.h> 1154d0609cedSBarry Smith PetscErrorCode MatPreallocateEnd(PetscInt *dnz, PetscInt *onz) 1155bd481603SBarry Smith 1156d083f849SBarry Smith Collective 1157bd481603SBarry Smith 1158bd481603SBarry Smith Input Parameters: 115916371a99SBarry Smith + dnz - the array that was be passed to the matrix preallocation routines 1160a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 1161bd481603SBarry Smith 1162bd481603SBarry Smith Level: intermediate 1163bd481603SBarry Smith 1164bd481603SBarry Smith Notes: 1165d0609cedSBarry Smith This is a macro that handles its own error checking, it does not return an error code. 1166d0609cedSBarry Smith 1167a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 1168bd481603SBarry Smith 1169d0609cedSBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 1170bd481603SBarry Smith 1171d0609cedSBarry Smith Developer Notes: 1172d0609cedSBarry Smith This is a MACRO not a function because it closes the { started in MatPreallocateBegin(). 11731620fd73SBarry Smith 1174db781477SPatrick Sanan .seealso: `MatPreallocateBegin()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`, 1175db781477SPatrick Sanan `MatPreallocateSymmetricSetLocalBlock()` 1176bd481603SBarry Smith M*/ 1177d0609cedSBarry Smith #define MatPreallocateEnd(dnz,onz) PetscCall(PetscFree2(dnz,onz));} while (0) 1178d0609cedSBarry Smith 1179d0609cedSBarry Smith #define MatPreallocateFinalize(...) PETSC_DEPRECATED_MACRO("GCC warning \"Use MatPreallocateEnd() (since version 3.18)\"") MatPreallocateEnd(__VA_ARGS__) 11807c922b88SBarry Smith 11817b80b807SBarry Smith /* Routines unique to particular data structures */ 1182014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat,void *); 1183698d4c6aSKris Buschelman 1184014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*); 1185014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *); 1186698d4c6aSKris Buschelman 1187014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]); 1188014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]); 1189014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1190014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1191014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1192014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool); 11937b80b807SBarry Smith 1194a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4 1195a96a251dSBarry Smith 1196014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1197014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1198014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]); 119919b08ed1SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJSetTotalPreallocation(Mat,PetscInt); 1200273d9f13SBarry Smith 1201014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1202014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1203014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1204014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []); 1205014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 1206014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]); 1207014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 1208014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]); 1209b44e7856SBarry Smith PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat,Mat*); 1210*252a1336SBarry Smith PETSC_EXTERN PetscErrorCode MatMPIAdjToSeqRankZero(Mat,Mat*); 1211014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]); 1212014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]); 12139230625dSJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]); 12149230625dSJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]); 1215014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*); 1216273d9f13SBarry Smith 121749a6ff4bSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetLDA(Mat,PetscInt*); 1218ad16ce7aSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseSetLDA(Mat,PetscInt); 12199fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatDenseSetLDA() (since version 3.14)") static inline PetscErrorCode MatSeqDenseSetLDA(Mat A,PetscInt lda) {return MatDenseSetLDA(A,lda);} 1220014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*); 12211b807ce4Svictorle 1222621e819fSSatish Balay PETSC_EXTERN PetscErrorCode MatBlockMatSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1223621e819fSSatish Balay 1224014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStoreValues(Mat); 1225014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat); 12262e8a6d31SBarry Smith 1227014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*); 12287cfe41e4SPatrick Farrell PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat,IS*); 12297b80b807SBarry Smith /* 12307b80b807SBarry Smith These routines are not usually accessed directly, rather solving is 123194b7f48cSBarry Smith done through the KSP and PC interfaces. 12327b80b807SBarry Smith */ 12337b80b807SBarry Smith 123476bdecfbSBarry Smith /*J 12358f6c3df8SBarry Smith MatOrderingType - String with the name of a PETSc matrix ordering 1236d9274352SBarry Smith 1237d9274352SBarry Smith Level: beginner 1238d9274352SBarry Smith 12392c7c0729SBarry Smith Notes: 12402c7c0729SBarry Smith If MATORDERINGEXTERNAL is used then PETSc does not compute an ordering and utilizes one built into the factorization package 12412c7c0729SBarry Smith 1242db781477SPatrick Sanan .seealso: `MatGetOrdering()` 124376bdecfbSBarry Smith J*/ 124419fd82e9SBarry Smith typedef const char* MatOrderingType; 12452692d6eeSBarry Smith #define MATORDERINGNATURAL "natural" 12462692d6eeSBarry Smith #define MATORDERINGND "nd" 12472692d6eeSBarry Smith #define MATORDERING1WD "1wd" 12482692d6eeSBarry Smith #define MATORDERINGRCM "rcm" 12492692d6eeSBarry Smith #define MATORDERINGQMD "qmd" 12502692d6eeSBarry Smith #define MATORDERINGROWLENGTH "rowlength" 1251510184a7SJed Brown #define MATORDERINGWBM "wbm" 1252fc1bef75SJed Brown #define MATORDERINGSPECTRAL "spectral" 1253312e372aSBarry Smith #define MATORDERINGAMD "amd" /* only works if UMFPACK is installed with PETSc */ 1254048412efSPablo Brubeck #define MATORDERINGMETISND "metisnd" /* only works if METIS is installed with PETSc */ 12559bd791bbSBarry 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 */ 12562c7c0729SBarry Smith #define MATORDERINGEXTERNAL "external" /* uses an ordering type internal to the factorization package */ 1257b12f92e5SBarry Smith 125819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*); 1259140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*); 1260bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*)); 1261140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatOrderingList; 1262d4fbbf0eSBarry Smith 1263014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS); 1264fc1bef75SJed Brown PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*); 1265a2ce50c7SBarry Smith 12664ac6704cSBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetPreferredOrdering(Mat,MatFactorType,MatOrderingType*); 12674ac6704cSBarry Smith 1268d91e6319SBarry Smith /*S 1269ec5066bdSBarry Smith MatFactorShiftType - Numeric Shift for factorizations 1270d90ac83dSHong Zhang 1271d90ac83dSHong Zhang Level: beginner 1272d90ac83dSHong Zhang 1273db781477SPatrick Sanan .seealso: `MatGetFactor()` 1274d90ac83dSHong Zhang S*/ 1275d90ac83dSHong Zhang typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType; 12766a6fc655SJed Brown PETSC_EXTERN const char *const MatFactorShiftTypes[]; 12775e9742b9SJed Brown PETSC_EXTERN const char *const MatFactorShiftTypesDetail[]; 1278d90ac83dSHong Zhang 1279d90ac83dSHong Zhang /*S 1280ec5066bdSBarry Smith MatFactorError - indicates what type of error was generated in a matrix factorization 12819aa7eafdSHong Zhang 12829aa7eafdSHong Zhang Level: beginner 12839aa7eafdSHong Zhang 128495452b02SPatrick Sanan Developer Notes: 128595452b02SPatrick Sanan Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 128600e125f8SBarry Smith 1287db781477SPatrick Sanan .seealso: `MatGetFactor()` 12889aa7eafdSHong Zhang S*/ 12895cd7cf9dSHong Zhang typedef enum {MAT_FACTOR_NOERROR,MAT_FACTOR_STRUCT_ZEROPIVOT,MAT_FACTOR_NUMERIC_ZEROPIVOT,MAT_FACTOR_OUTMEMORY,MAT_FACTOR_OTHER} MatFactorError; 12909aa7eafdSHong Zhang 129100e125f8SBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat,MatFactorError*); 1292b8b68cfdSBarry Smith PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat); 12937b6c816cSBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat,PetscReal*,PetscInt*); 129400e125f8SBarry Smith 12959aa7eafdSHong Zhang /*S 1296422a814eSBarry Smith MatFactorInfo - Data passed into the matrix factorization routines, and information about the resulting factorization 1297b00f7748SHong Zhang 129861cad860SBarry Smith In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use 129961cad860SBarry Smith $ MatFactorInfo info(MAT_FACTORINFO_SIZE) 1300b00f7748SHong Zhang 130195452b02SPatrick Sanan Notes: 130295452b02SPatrick Sanan These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC. 1303b00f7748SHong Zhang 130461cad860SBarry Smith You can use MatFactorInfoInitialize() to set default values. 130561cad860SBarry Smith 1306b00f7748SHong Zhang Level: developer 1307b00f7748SHong Zhang 1308db781477SPatrick Sanan .seealso: `MatLUFactorSymbolic()`, `MatILUFactorSymbolic()`, `MatCholeskyFactorSymbolic()`, `MatICCFactorSymbolic()`, `MatICCFactor()`, 1309db781477SPatrick Sanan `MatFactorInfoInitialize()` 1310b00f7748SHong Zhang 1311b00f7748SHong Zhang S*/ 1312b00f7748SHong Zhang typedef struct { 131315e8a5b3SHong Zhang PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 131485317021SBarry Smith PetscReal usedt; 131515e8a5b3SHong Zhang PetscReal dt; /* drop tolerance */ 1316b00f7748SHong Zhang PetscReal dtcol; /* tolerance for pivoting */ 131715e8a5b3SHong Zhang PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 131867e28bfeSBarry Smith PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */ 1319348344bbSBarry Smith PetscReal levels; /* ICC/ILU(levels) */ 1320bcd9e38bSBarry Smith PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 1321bcd9e38bSBarry Smith factorization may be faster if do not pivot */ 132215e8a5b3SHong Zhang PetscReal zeropivot; /* pivot is called zero if less than this */ 1323f4db908eSBarry Smith PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */ 1324f4db908eSBarry Smith PetscReal shiftamount; /* how large the shift is */ 132515e8a5b3SHong Zhang } MatFactorInfo; 1326ffa6d0a5SLois Curfman McInnes 1327014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*); 13289a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*); 13299a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 13309a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*); 13319a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*); 13329a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*); 13339a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 13349a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 13359a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 13369a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*); 13379a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*); 13383f498edaSToby Isaac PETSC_EXTERN PetscErrorCode MatQRFactor(Mat,IS,const MatFactorInfo*); 13393f498edaSToby Isaac PETSC_EXTERN PetscErrorCode MatQRFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 13403f498edaSToby Isaac PETSC_EXTERN PetscErrorCode MatQRFactorNumeric(Mat,Mat,const MatFactorInfo*); 1341014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*); 1342014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec); 1343014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec); 1344014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec); 1345014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec); 1346014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec); 1347014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec); 1348014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs); 13497c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat); 13507c2f51b8SStefano Zampini 13517c2f51b8SStefano Zampini typedef enum {MAT_FACTOR_SCHUR_UNFACTORED, MAT_FACTOR_SCHUR_FACTORED, MAT_FACTOR_SCHUR_INVERTED} MatFactorSchurStatus; 13528e7ba810SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat,IS); 13537c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat,Mat*,MatFactorSchurStatus*); 13547c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat,Mat*,MatFactorSchurStatus); 13555a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat); 13567c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat,Mat*,MatFactorSchurStatus*); 13575a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat,Vec,Vec); 13585a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat,Vec,Vec); 13596dba178dSStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat); 1360bb5a7306SBarry Smith 13618a9c020eSBarry Smith PETSC_EXTERN PetscErrorCode MatSeqDenseInvert(Mat); 1362d91e6319SBarry Smith /*E 1363d91e6319SBarry Smith MatSORType - What type of (S)SOR to perform 1364bb1eb677SSatish Balay 1365d91e6319SBarry Smith Level: beginner 1366d91e6319SBarry Smith 1367d9274352SBarry Smith May be bitwise ORd together 1368d9274352SBarry Smith 1369af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 1370d91e6319SBarry Smith 13714e7234bfSBarry Smith MatSORType may be bitwise ORd together, so do not change the numbers 13724e7234bfSBarry Smith 1373db781477SPatrick Sanan .seealso: `MatSOR()` 1374d91e6319SBarry Smith E*/ 1375ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 1376ee50ffe9SBarry Smith SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 1377ee50ffe9SBarry Smith SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 137884cb2905SBarry Smith SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType; 1379014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 13808ed539a5SBarry Smith 1381d4fbbf0eSBarry Smith /* 1382639f9d9dSBarry Smith These routines are for efficiently computing Jacobians via finite differences. 1383639f9d9dSBarry Smith */ 1384b12f92e5SBarry Smith 13857086a01eSPeter Brune /*S 13867086a01eSPeter Brune MatColoring - Object for managing the coloring of matrices. 13877086a01eSPeter Brune 13887086a01eSPeter Brune Level: beginner 13897086a01eSPeter Brune 1390ec5066bdSBarry Smith Notes: 1391ec5066bdSBarry 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 1392ec5066bdSBarry Smith matrix comes from via DMCreateColoring(). In general using the mesh produces a more optimal coloring (fewer colors). 1393ec5066bdSBarry Smith 1394ec5066bdSBarry Smith Once a coloring is available MatFDColoringCreate() creates an object that can be used to efficiently compute Jacobians using that coloring. This 1395ec5066bdSBarry Smith same object can also be used to efficiently convert data created by Automatic Differentation tools to PETSc sparse matrices. 1396ec5066bdSBarry Smith 1397db781477SPatrick Sanan .seealso: `MatFDColoringCreate()`, `MatColoringWeightType`, `ISColoring`, `MatFDColoring`, `DMCreateColoring()`, `MatColoringCreate()`, `MatOrdering`, `MatPartitioning`, `MatColoringType` 13987086a01eSPeter Brune S*/ 1399d4db15c4SBarry Smith typedef struct _p_MatColoring* MatColoring; 1400d4db15c4SBarry Smith 1401d4db15c4SBarry Smith /*J 1402d4db15c4SBarry Smith MatColoringType - String with the name of a PETSc matrix coloring 1403d9274352SBarry Smith 1404d9274352SBarry Smith Level: beginner 1405d9274352SBarry Smith 1406db781477SPatrick Sanan .seealso: `MatColoringSetType()`, `MatColoring` 140776bdecfbSBarry Smith J*/ 140819fd82e9SBarry Smith typedef const char* MatColoringType; 14095567d71aSPeter Brune #define MATCOLORINGJP "jp" 1410b9acb617SPeter Brune #define MATCOLORINGPOWER "power" 14112692d6eeSBarry Smith #define MATCOLORINGNATURAL "natural" 14122692d6eeSBarry Smith #define MATCOLORINGSL "sl" 14132692d6eeSBarry Smith #define MATCOLORINGLF "lf" 14142692d6eeSBarry Smith #define MATCOLORINGID "id" 14158121bdceSPeter Brune #define MATCOLORINGGREEDY "greedy" 1416b12f92e5SBarry Smith 14178ac6da0aSPeter Brune /*E 14188ac6da0aSPeter Brune MatColoringWeightType - Type of weight scheme 14198ac6da0aSPeter Brune 14208ac6da0aSPeter Brune Not Collective 14218ac6da0aSPeter Brune 14228ac6da0aSPeter Brune + MAT_COLORING_RANDOM - Random weights 14238ac6da0aSPeter Brune . MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering. 14248ac6da0aSPeter Brune - MAT_COLORING_LF - Last-first weighting. 14258ac6da0aSPeter Brune 14268ac6da0aSPeter Brune Level: intermediate 14278ac6da0aSPeter Brune 1428af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 1429ec5066bdSBarry Smith 1430db781477SPatrick Sanan .seealso: `MatColoring`, `MatColoringCreate()` 14318ac6da0aSPeter Brune E*/ 1432301c140bSPeter Brune typedef enum {MAT_COLORING_WEIGHT_RANDOM,MAT_COLORING_WEIGHT_LEXICAL,MAT_COLORING_WEIGHT_LF,MAT_COLORING_WEIGHT_SL} MatColoringWeightType; 14338ac6da0aSPeter Brune 1434335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*); 1435d7f2a307SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*); 1436335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*); 1437335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer); 1438335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType); 1439335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring); 1440335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt); 1441335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*); 1442335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt); 1443335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*); 1444335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*); 1445335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring)); 1446014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*); 14478ac6da0aSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType); 1448c29971fcSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*); 14498ac6da0aSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm); 1450bc76d17bSHong Zhang PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring,ISColoring); 14519fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatColoringTest() (since version 3.10)") static inline PetscErrorCode MatColoringTestValid(MatColoring matcoloring,ISColoring iscoloring) {return MatColoringTest(matcoloring,iscoloring);} 1452bc76d17bSHong Zhang PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat,ISColoring); 1453639f9d9dSBarry Smith 1454d9274352SBarry Smith /*S 1455d9274352SBarry Smith MatFDColoring - Object for computing a sparse Jacobian via finite differences 1456d9274352SBarry Smith and coloring 1457639f9d9dSBarry Smith 1458d9274352SBarry Smith Level: beginner 1459d9274352SBarry Smith 1460ec5066bdSBarry Smith Notes: 1461ec5066bdSBarry Smith This object is creating utilizing a coloring provided by the MatColoring object or DMCreateColoring() 1462ec5066bdSBarry Smith 1463db781477SPatrick Sanan .seealso: `MatFDColoringCreate()`, `MatColoring`, `DMCreateColoring()` 1464d9274352SBarry Smith S*/ 1465e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring; 1466639f9d9dSBarry Smith 1467014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *); 1468014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*); 1469014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer); 1470014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*); 1471014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**); 1472014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal); 1473014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring); 1474d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *); 1475014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec); 1476edaa7c33SBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,const PetscInt*[]); 1477f86b9fbaSHong Zhang PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring); 1478f86b9fbaSHong Zhang PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt); 1479bdaf1daeSBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringSetValues(Mat,MatFDColoring,const PetscScalar*); 1480b1683b59SHong Zhang 1481b1683b59SHong Zhang /*S 1482b9af6bddSHong Zhang MatTransposeColoring - Object for computing a sparse matrix product C=A*B^T via coloring 1483b1683b59SHong Zhang 1484b1683b59SHong Zhang Level: beginner 1485b1683b59SHong Zhang 1486db781477SPatrick Sanan .seealso: `MatTransposeColoringCreate()` 1487b1683b59SHong Zhang S*/ 1488b9af6bddSHong Zhang typedef struct _p_MatTransposeColoring* MatTransposeColoring; 1489b1683b59SHong Zhang 1490014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *); 1491014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat); 1492014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat); 1493014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*); 1494b1683b59SHong Zhang 1495639f9d9dSBarry Smith /* 14960752156aSBarry Smith These routines are for partitioning matrices: currently used only 14973eda8832SBarry Smith for adjacency matrix, MatCreateMPIAdj(). 14980752156aSBarry Smith */ 1499ca161407SBarry Smith 1500d9274352SBarry Smith /*S 1501d9274352SBarry Smith MatPartitioning - Object for managing the partitioning of a matrix or graph 1502d9274352SBarry Smith 1503d9274352SBarry Smith Level: beginner 1504d9274352SBarry Smith 1505ec5066bdSBarry Smith Notes: 1506ec5066bdSBarry Smith There is also a PetscPartitioner object that provides the same functionality. It can utilize the MatPartitioning operations 1507ec5066bdSBarry Smith via PetscPartitionerSetType(p,PETSCPARTITIONERMATPARTITIONING) 1508ec5066bdSBarry Smith 1509ec5066bdSBarry Smith Developers Note: 1510ec5066bdSBarry Smith It is an extra maintainance and documentation cost to have two objects with the same functionality. 1511ec5066bdSBarry Smith 1512db781477SPatrick Sanan .seealso: `MatPartitioningCreate()`, `MatPartitioningType`, `MatColoring`, `MatGetOrdering()` 1513d9274352SBarry Smith S*/ 151491e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning; 1515d9274352SBarry Smith 151676bdecfbSBarry Smith /*J 15178f6c3df8SBarry Smith MatPartitioningType - String with the name of a PETSc matrix partitioning 1518d9274352SBarry Smith 1519d9274352SBarry Smith Level: beginner 15200d04baf8SBarry Smith dm 1521db781477SPatrick Sanan .seealso: `MatPartitioningCreate()`, `MatPartitioning` 152276bdecfbSBarry Smith J*/ 152319fd82e9SBarry Smith typedef const char* MatPartitioningType; 15242692d6eeSBarry Smith #define MATPARTITIONINGCURRENT "current" 1525aa1e27eaSFande Kong #define MATPARTITIONINGAVERAGE "average" 15262692d6eeSBarry Smith #define MATPARTITIONINGSQUARE "square" 15272692d6eeSBarry Smith #define MATPARTITIONINGPARMETIS "parmetis" 15282692d6eeSBarry Smith #define MATPARTITIONINGCHACO "chaco" 15292692d6eeSBarry Smith #define MATPARTITIONINGPARTY "party" 153050d91057SBarry Smith #define MATPARTITIONINGPTSCOTCH "ptscotch" 153188d2ac2bSFande Kong #define MATPARTITIONINGHIERARCH "hierarch" 153271306c60Sjroman 1533014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*); 153419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType); 1535014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt); 1536014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat); 1537*252a1336SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningSetNumberVertexWeights(MatPartitioning,PetscInt); 1538014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]); 1539014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []); 1540ebf67979SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningSetUseEdgeWeights(MatPartitioning,PetscBool); 1541ebf67979SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningGetUseEdgeWeights(MatPartitioning,PetscBool*); 1542014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*); 1543fdd1c351SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningImprove(MatPartitioning,IS*); 1544668144dbSFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningViewImbalance(MatPartitioning,IS); 1545f3ad2dabSStefano Zampini PETSC_EXTERN PetscErrorCode MatPartitioningApplyND(MatPartitioning,IS*); 1546014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*); 1547bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[],PetscErrorCode (*)(MatPartitioning)); 1548014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer); 1549fe2efc57SMark PETSC_EXTERN PetscErrorCode MatPartitioningViewFromOptions(MatPartitioning,PetscObject,const char[]); 1550014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning); 155119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*); 1552ca161407SBarry Smith 155327538973SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part); 1554014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 1555014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *); 15560752156aSBarry Smith 1557b6956c12SJose Roman typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType; 15586a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoGlobalTypes[]; 1559b6956c12SJose Roman typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType; 15606a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoLocalTypes[]; 1561b6956c12SJose Roman typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType; 15626a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoEigenTypes[]; 1563b6956c12SJose Roman 1564014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType); 1565014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*); 1566014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType); 1567014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*); 1568014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal); 1569014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType); 1570014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*); 1571014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal); 1572014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*); 1573014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt); 1574014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*); 157571306c60Sjroman 157671306c60Sjroman #define MP_PARTY_OPT "opt" 157771306c60Sjroman #define MP_PARTY_LIN "lin" 157871306c60Sjroman #define MP_PARTY_SCA "sca" 157971306c60Sjroman #define MP_PARTY_RAN "ran" 158071306c60Sjroman #define MP_PARTY_GBF "gbf" 158171306c60Sjroman #define MP_PARTY_GCF "gcf" 158271306c60Sjroman #define MP_PARTY_BUB "bub" 158371306c60Sjroman #define MP_PARTY_DEF "def" 1584014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*); 158571306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs" 158671306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl" 158771306c60Sjroman #define MP_PARTY_NONE "no" 1588014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*); 1589014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal); 1590014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool); 1591014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool); 159271306c60Sjroman 1593b0ca845eSVaclav Hapla typedef enum { MP_PTSCOTCH_DEFAULT,MP_PTSCOTCH_QUALITY,MP_PTSCOTCH_SPEED,MP_PTSCOTCH_BALANCE,MP_PTSCOTCH_SAFETY,MP_PTSCOTCH_SCALABILITY } MPPTScotchStrategyType; 15946a6fc655SJed Brown PETSC_EXTERN const char *const MPPTScotchStrategyTypes[]; 1595e0f1cffaSJose Roman 1596014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal); 1597014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*); 1598014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType); 1599014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*); 160071306c60Sjroman 1601b43b03e9SMark F. Adams /* 16026294fa2bSFande Kong * hierarchical partitioning 16036294fa2bSFande Kong */ 16044e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning,IS*); 16054e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning,IS*); 16064e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning,PetscInt); 16074e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt); 16086294fa2bSFande Kong 1609014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*); 1610014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*); 1611591294e4SBarry Smith 16120752156aSBarry Smith /* 1613c786d857SStefano Zampini If you add entries here you must also add them to src/mat/f90-mod/petscmat.h 1614c786d857SStefano Zampini If any of the enum values are changed, also update dMatOps dict at src/binding/petsc4py/src/libpetsc4py/libpetsc4py.pyx 1615d4fbbf0eSBarry Smith */ 16161c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0, 16171c1c02c0SLois Curfman McInnes MATOP_GET_ROW=1, 16181c1c02c0SLois Curfman McInnes MATOP_RESTORE_ROW=2, 16191c1c02c0SLois Curfman McInnes MATOP_MULT=3, 16201c1c02c0SLois Curfman McInnes MATOP_MULT_ADD=4, 16217c922b88SBarry Smith MATOP_MULT_TRANSPOSE=5, 16227c922b88SBarry Smith MATOP_MULT_TRANSPOSE_ADD=6, 16231c1c02c0SLois Curfman McInnes MATOP_SOLVE=7, 16241c1c02c0SLois Curfman McInnes MATOP_SOLVE_ADD=8, 16257c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE=9, 16267c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE_ADD=10, 16271c1c02c0SLois Curfman McInnes MATOP_LUFACTOR=11, 16281c1c02c0SLois Curfman McInnes MATOP_CHOLESKYFACTOR=12, 1629a714c06dSBarry Smith MATOP_SOR=13, 16301c1c02c0SLois Curfman McInnes MATOP_TRANSPOSE=14, 16311c1c02c0SLois Curfman McInnes MATOP_GETINFO=15, 16321c1c02c0SLois Curfman McInnes MATOP_EQUAL=16, 16331c1c02c0SLois Curfman McInnes MATOP_GET_DIAGONAL=17, 16341c1c02c0SLois Curfman McInnes MATOP_DIAGONAL_SCALE=18, 16351c1c02c0SLois Curfman McInnes MATOP_NORM=19, 16361c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_BEGIN=20, 16371c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_END=21, 1638d519adbfSMatthew Knepley MATOP_SET_OPTION=22, 1639d519adbfSMatthew Knepley MATOP_ZERO_ENTRIES=23, 1640d519adbfSMatthew Knepley MATOP_ZERO_ROWS=24, 1641d519adbfSMatthew Knepley MATOP_LUFACTOR_SYMBOLIC=25, 1642d519adbfSMatthew Knepley MATOP_LUFACTOR_NUMERIC=26, 1643d519adbfSMatthew Knepley MATOP_CHOLESKY_FACTOR_SYMBOLIC=27, 1644d519adbfSMatthew Knepley MATOP_CHOLESKY_FACTOR_NUMERIC=28, 1645e5f2d425SStefano Zampini MATOP_SETUP=29, 1646d519adbfSMatthew Knepley MATOP_ILUFACTOR_SYMBOLIC=30, 1647d519adbfSMatthew Knepley MATOP_ICCFACTOR_SYMBOLIC=31, 1648a5b7ff6bSBarry Smith MATOP_GET_DIAGONAL_BLOCK=32, 1649e5f2d425SStefano Zampini MATOP_SET_INF=33, 1650d519adbfSMatthew Knepley MATOP_DUPLICATE=34, 1651d519adbfSMatthew Knepley MATOP_FORWARD_SOLVE=35, 1652d519adbfSMatthew Knepley MATOP_BACKWARD_SOLVE=36, 1653d519adbfSMatthew Knepley MATOP_ILUFACTOR=37, 1654d519adbfSMatthew Knepley MATOP_ICCFACTOR=38, 1655d519adbfSMatthew Knepley MATOP_AXPY=39, 16567dae84e0SHong Zhang MATOP_CREATE_SUBMATRICES=40, 1657d519adbfSMatthew Knepley MATOP_INCREASE_OVERLAP=41, 1658d519adbfSMatthew Knepley MATOP_GET_VALUES=42, 1659d519adbfSMatthew Knepley MATOP_COPY=43, 1660d519adbfSMatthew Knepley MATOP_GET_ROW_MAX=44, 1661d519adbfSMatthew Knepley MATOP_SCALE=45, 1662d519adbfSMatthew Knepley MATOP_SHIFT=46, 166335153367SBarry Smith MATOP_DIAGONAL_SET=47, 16649d39f69dSJed Brown MATOP_ZERO_ROWS_COLUMNS=48, 16659d39f69dSJed Brown MATOP_SET_RANDOM=49, 1666d519adbfSMatthew Knepley MATOP_GET_ROW_IJ=50, 1667d519adbfSMatthew Knepley MATOP_RESTORE_ROW_IJ=51, 1668d519adbfSMatthew Knepley MATOP_GET_COLUMN_IJ=52, 1669d519adbfSMatthew Knepley MATOP_RESTORE_COLUMN_IJ=53, 1670d519adbfSMatthew Knepley MATOP_FDCOLORING_CREATE=54, 1671d519adbfSMatthew Knepley MATOP_COLORING_PATCH=55, 1672d519adbfSMatthew Knepley MATOP_SET_UNFACTORED=56, 1673d519adbfSMatthew Knepley MATOP_PERMUTE=57, 1674d519adbfSMatthew Knepley MATOP_SET_VALUES_BLOCKED=58, 16757dae84e0SHong Zhang MATOP_CREATE_SUBMATRIX=59, 1676d519adbfSMatthew Knepley MATOP_DESTROY=60, 1677d519adbfSMatthew Knepley MATOP_VIEW=61, 1678d519adbfSMatthew Knepley MATOP_CONVERT_FROM=62, 1679e5f2d425SStefano Zampini /* MATOP_PLACEHOLDER_63=63 */ 16807bab7c10SHong Zhang MATOP_MATMAT_MULT_SYMBOLIC=64, 16817bab7c10SHong Zhang MATOP_MATMAT_MULT_NUMERIC=65, 1682d519adbfSMatthew Knepley MATOP_SET_LOCAL_TO_GLOBAL_MAP=66, 1683d519adbfSMatthew Knepley MATOP_SET_VALUES_LOCAL=67, 1684d519adbfSMatthew Knepley MATOP_ZERO_ROWS_LOCAL=68, 1685d519adbfSMatthew Knepley MATOP_GET_ROW_MAX_ABS=69, 1686d519adbfSMatthew Knepley MATOP_GET_ROW_MIN_ABS=70, 1687d519adbfSMatthew Knepley MATOP_CONVERT=71, 1688e5f2d425SStefano Zampini MATOP_HAS_OPERATION=72, 16899d39f69dSJed Brown /* MATOP_PLACEHOLDER_73=73, */ 1690d519adbfSMatthew Knepley MATOP_SET_VALUES_ADIFOR=74, 1691d519adbfSMatthew Knepley MATOP_FD_COLORING_APPLY=75, 1692d519adbfSMatthew Knepley MATOP_SET_FROM_OPTIONS=76, 1693e5f2d425SStefano Zampini /* MATOP_PLACEHOLDER_77=77, */ 1694e5f2d425SStefano Zampini /* MATOP_PLACEHOLDER_78=78, */ 16959d39f69dSJed Brown MATOP_FIND_ZERO_DIAGONALS=79, 1696d519adbfSMatthew Knepley MATOP_MULT_MULTIPLE=80, 1697d519adbfSMatthew Knepley MATOP_SOLVE_MULTIPLE=81, 1698d519adbfSMatthew Knepley MATOP_GET_INERTIA=82, 1699d519adbfSMatthew Knepley MATOP_LOAD=83, 1700d519adbfSMatthew Knepley MATOP_IS_SYMMETRIC=84, 1701d519adbfSMatthew Knepley MATOP_IS_HERMITIAN=85, 1702d519adbfSMatthew Knepley MATOP_IS_STRUCTURALLY_SYMMETRIC=86, 1703820469bcSHong Zhang MATOP_SET_VALUES_BLOCKEDLOCAL=87, 1704b41ce5d5SBarry Smith MATOP_CREATE_VECS=88, 1705e5f2d425SStefano Zampini /* MATOP_PLACEHOLDER_89=89, */ 1706d519adbfSMatthew Knepley MATOP_MAT_MULT_SYMBOLIC=90, 1707d519adbfSMatthew Knepley MATOP_MAT_MULT_NUMERIC=91, 1708e5f2d425SStefano Zampini /* MATOP_PLACEHOLDER_92=92, */ 1709d519adbfSMatthew Knepley MATOP_PTAP_SYMBOLIC=93, 1710d519adbfSMatthew Knepley MATOP_PTAP_NUMERIC=94, 1711e5f2d425SStefano Zampini /* MATOP_PLACEHOLDER_95=95, */ 1712bda6c4cbSBarry Smith MATOP_MAT_TRANSPOSE_MULT_SYMBO=96, 1713bda6c4cbSBarry Smith MATOP_MAT_TRANSPOSE_MULT_NUMER=97, 1714e5f2d425SStefano Zampini MATOP_BIND_TO_CPU=98, 17157a3c3d58SStefano Zampini MATOP_PRODUCTSETFROMOPTIONS=99, 17167a3c3d58SStefano Zampini MATOP_PRODUCTSYMBOLIC=100, 17177a3c3d58SStefano Zampini MATOP_PRODUCTNUMERIC=101, 1718d519adbfSMatthew Knepley MATOP_CONJUGATE=102, 1719e5f2d425SStefano Zampini MATOP_VIEW_NATIVE=103, 1720d519adbfSMatthew Knepley MATOP_SET_VALUES_ROW=104, 1721d519adbfSMatthew Knepley MATOP_REAL_PART=105, 1722bda6c4cbSBarry Smith MATOP_IMAGINARY_PART=106, 1723bda6c4cbSBarry Smith MATOP_GET_ROW_UPPER_TRIANGULAR=107, 1724bda6c4cbSBarry Smith MATOP_RESTORE_ROW_UPPER_TRIANG=108, 1725bda6c4cbSBarry Smith MATOP_MAT_SOLVE=109, 172629eadf9eSStefano Zampini MATOP_MAT_SOLVE_TRANSPOSE=110, 1727d519adbfSMatthew Knepley MATOP_GET_ROW_MIN=111, 17280e8d04f7SBarry Smith MATOP_GET_COLUMN_VECTOR=112, 1729d519adbfSMatthew Knepley MATOP_MISSING_DIAGONAL=113, 17300e8d04f7SBarry Smith MATOP_GET_SEQ_NONZERO_STRUCTUR=114, 173189c6957cSBarry Smith MATOP_CREATE=115, 173289c6957cSBarry Smith MATOP_GET_GHOSTS=116, 17330e8d04f7SBarry Smith MATOP_GET_LOCAL_SUB_MATRIX=117, 17340e8d04f7SBarry Smith MATOP_RESTORE_LOCALSUB_MATRIX=118, 1735eeffb40dSHong Zhang MATOP_MULT_DIAGONAL_BLOCK=119, 17360e8d04f7SBarry Smith MATOP_HERMITIAN_TRANSPOSE=120, 17370e8d04f7SBarry Smith MATOP_MULT_HERMITIAN_TRANSPOSE=121, 17380e8d04f7SBarry Smith MATOP_MULT_HERMITIAN_TRANS_ADD=122, 17390e8d04f7SBarry Smith MATOP_GET_MULTI_PROC_BLOCK=123, 17409d39f69dSJed Brown MATOP_FIND_NONZERO_ROWS=124, 17410e8d04f7SBarry Smith MATOP_GET_COLUMN_NORMS=125, 17429d39f69dSJed Brown MATOP_INVERT_BLOCK_DIAGONAL=126, 1743e5f2d425SStefano Zampini MATOP_INVERT_VBLOCK_DIAGONAL=127, 1744b41ce5d5SBarry Smith MATOP_CREATE_SUB_MATRICES_MPI=128, 17452b8ad9a3SHong Zhang MATOP_SET_VALUES_BATCH=129, 1746e5f2d425SStefano Zampini /* MATOP_PLACEHOLDER_130=130, */ 17470e8d04f7SBarry Smith MATOP_TRANSPOSE_MAT_MULT_SYMBO=131, 1748e9b602ebSSatish Balay MATOP_TRANSPOSE_MAT_MULT_NUMER=132, 17490e8d04f7SBarry Smith MATOP_TRANSPOSE_COLORING_CREAT=133, 17500e8d04f7SBarry Smith MATOP_TRANS_COLORING_APPLY_SPT=134, 17510e8d04f7SBarry Smith MATOP_TRANS_COLORING_APPLY_DEN=135, 1752e5f2d425SStefano Zampini /* MATOP_PLACEHOLDER_136=136, */ 17530e8d04f7SBarry Smith MATOP_RART_SYMBOLIC=137, 17540e8d04f7SBarry Smith MATOP_RART_NUMERIC=138, 1755e09a3074SHong Zhang MATOP_SET_BLOCK_SIZES=139, 1756f9426fe0SMark Adams MATOP_AYPX=140, 17571919a2e2SJed Brown MATOP_RESIDUAL=141, 17589c8f2541SHong Zhang MATOP_FDCOLORING_SETUP=142, 1759e5f2d425SStefano Zampini MATOP_FIND_OFFBLOCK_ENTRIES=143, 17602d033e1fSHong Zhang MATOP_MPICONCATENATESEQ=144, 1761bb01b7b0SPatrick Sanan MATOP_DESTROYSUBMATRICES=145, 1762e265f6d6SPatrick Sanan MATOP_TRANSPOSE_SOLVE=146, 1763e265f6d6SPatrick Sanan MATOP_GET_VALUES_LOCAL=147 1764fae171e0SBarry Smith } MatOperation; 17650c0fd78eSBarry Smith PETSC_EXTERN PetscErrorCode MatSetOperation(Mat,MatOperation,void(*)(void)); 1766976e8c5aSLisandro Dalcin PETSC_EXTERN PetscErrorCode MatGetOperation(Mat,MatOperation,void(**)(void)); 1767976e8c5aSLisandro Dalcin PETSC_EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool*); 176894342113SStefano Zampini PETSC_EXTERN PetscErrorCode MatHasCongruentLayouts(Mat,PetscBool*); 17699fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatProductClear() (since version 3.14)") static inline PetscErrorCode MatFreeIntermediateDataStructures(Mat A) {return MatProductClear(A);} 1770014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void)); 1771014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void)); 1772014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*); 1773db77db73SJeremy L Thompson PETSC_EXTERN PetscErrorCode MatShellSetVecType(Mat,VecType); 1774f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*); 1775f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*); 17760c0fd78eSBarry Smith PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat); 1777b77ba244SStefano Zampini PETSC_EXTERN PetscErrorCode MatShellSetMatProductOperation(Mat,MatProductType,PetscErrorCode (*)(Mat,Mat,Mat,void**),PetscErrorCode (*)(Mat,Mat,Mat,void*),PetscErrorCode (*)(void*),MatType,MatType); 1778b77ba244SStefano Zampini PETSC_EXTERN PetscErrorCode MatIsShell(Mat,PetscBool*); 1779112a2221SBarry Smith 178090ace30eSBarry Smith /* 178190ace30eSBarry Smith Codes for matrices stored on disk. By default they are 178290ace30eSBarry Smith stored in a universal format. By changing the format with 17836a9046bcSBarry Smith PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will 178490ace30eSBarry Smith be stored in a way natural for the matrix, for example dense matrices 178590ace30eSBarry Smith would be stored as dense. Matrices stored this way may only be 1786f4403165SShri Abhyankar read into matrices of the same type. 178790ace30eSBarry Smith */ 178890ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1 178990ace30eSBarry Smith 1790014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal); 179175d48cdbSStefano Zampini 17928546b261SStefano Zampini PETSC_EXTERN PetscErrorCode MatISSetLocalMatType(Mat,MatType); 179375d48cdbSStefano Zampini PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 179475d48cdbSStefano Zampini PETSC_EXTERN PetscErrorCode MatISStoreL2L(Mat,PetscBool); 1795f03112d0SStefano Zampini PETSC_EXTERN PetscErrorCode MatISFixLocalEmpty(Mat,PetscBool); 1796014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*); 17973b3b1effSJed Brown PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat,Mat*); 1798014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat); 1799e432b41dSStefano Zampini PETSC_EXTERN PetscErrorCode MatISGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*); 180025ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use the MatConvert() interface (since version 3.10)") PetscErrorCode MatISGetMPIXAIJ(Mat,MatReuse,Mat*); 18011f4e1ec7SBarry Smith 1802d9274352SBarry Smith /*S 1803d9274352SBarry Smith MatNullSpace - Object that removes a null space from a vector, i.e. 1804cb6b9846SMatthew Knepley orthogonalizes the vector to a subspace 1805d9274352SBarry Smith 1806f7a9e4ceSBarry Smith Level: advanced 1807d9274352SBarry Smith 1808db781477SPatrick Sanan .seealso: `MatNullSpaceCreate()` 1809d9274352SBarry Smith S*/ 181074637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace; 1811d9274352SBarry Smith 1812014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*); 1813014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*); 1814014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*); 1815d0195637SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec); 1816014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *); 18175fa7ec2dSBarry Smith PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *); 18185fa7ec2dSBarry Smith PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat,MatNullSpace); 1819014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace); 1820014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace); 1821014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*); 1822014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool *); 1823014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer); 1824014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**); 1825014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*); 182674637425SBarry Smith 1827014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS); 1828014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal); 1829014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *); 18303f1d51d7SBarry Smith 1831014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*); 1832014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*); 1833014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*); 1834c4f061fbSSatish Balay 18350bacdadaSStefano Zampini PETSC_EXTERN PetscErrorCode MatComputeOperator(Mat,MatType,Mat*); 18360bacdadaSStefano Zampini PETSC_EXTERN PetscErrorCode MatComputeOperatorTranspose(Mat,MatType,Mat*); 18370bacdadaSStefano Zampini 18389fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatComputeOperator() (since version 3.12)") static inline PetscErrorCode MatComputeExplicitOperator(Mat A,Mat* B) { return MatComputeOperator(A,NULL,B); } 18399fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatComputeOperatorTranspose() (since version 3.12)") static inline PetscErrorCode MatComputeExplicitOperatorTranspose(Mat A,Mat* B) { return MatComputeOperatorTranspose(A,NULL,B); } 1840b0a32e0cSBarry Smith 184149bd79ccSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode MatCreateKAIJ(Mat,PetscInt,PetscInt,const PetscScalar[],const PetscScalar[],Mat*); 184249bd79ccSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode MatKAIJGetAIJ(Mat,Mat*); 1843a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetS(Mat,PetscInt*,PetscInt*,PetscScalar**); 1844a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetSRead(Mat,PetscInt*,PetscInt*,const PetscScalar**); 1845a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreS(Mat,PetscScalar**); 1846a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreSRead(Mat,const PetscScalar**); 1847a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetT(Mat,PetscInt*,PetscInt*,PetscScalar**); 1848a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetTRead(Mat,PetscInt*,PetscInt*,const PetscScalar**); 1849a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreT(Mat,PetscScalar**); 1850a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreTRead(Mat,const PetscScalar**); 1851dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetAIJ(Mat,Mat); 1852dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetS(Mat,PetscInt,PetscInt,const PetscScalar[]); 1853dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetT(Mat,PetscInt,PetscInt,const PetscScalar[]); 1854910cf402Sprj- PETSC_EXTERN PetscErrorCode MatKAIJGetScaledIdentity(Mat,PetscBool*); 185549bd79ccSDebojyoti Ghosh 1856014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec); 185704f1ad80SBarry Smith 1858014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 1859014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec); 1860014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*); 1861014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*)); 1862014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec)); 1863014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt); 1864014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat); 1865014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal); 1866014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt); 1867014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *); 1868014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]); 1869014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*); 1870014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*); 1871e884886fSBarry Smith 18726370053bSBarry Smith /*S 18736370053bSBarry Smith MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free 18746370053bSBarry Smith Jacobian vector products 1875e884886fSBarry Smith 187695452b02SPatrick Sanan Notes: 187795452b02SPatrick Sanan MATMFFD is a specific MatType which uses the MatMFFD data structure 18786370053bSBarry Smith 18796370053bSBarry Smith MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure 18806370053bSBarry Smith 18816370053bSBarry Smith Level: developer 18826370053bSBarry Smith 1883db781477SPatrick Sanan .seealso: `MATMFFD`, `MatCreateMFFD()`, `MatMFFDSetFuction()`, `MatMFFDSetType()`, `MatMFFDRegister()` 18846370053bSBarry Smith S*/ 1885e884886fSBarry Smith typedef struct _p_MatMFFD* MatMFFD; 1886e884886fSBarry Smith 188776bdecfbSBarry Smith /*J 1888e884886fSBarry Smith MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function 1889e884886fSBarry Smith 1890e884886fSBarry Smith Level: beginner 1891e884886fSBarry Smith 1892db781477SPatrick Sanan .seealso: `MatMFFDSetType()`, `MatMFFDRegister()` 189376bdecfbSBarry Smith J*/ 189419fd82e9SBarry Smith typedef const char* MatMFFDType; 1895e884886fSBarry Smith #define MATMFFD_DS "ds" 1896e884886fSBarry Smith #define MATMFFD_WP "wp" 1897e884886fSBarry Smith 189819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat,MatMFFDType); 1899bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[],PetscErrorCode (*)(MatMFFD)); 1900e884886fSBarry Smith 1901014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal); 1902014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool); 1903e884886fSBarry Smith 190461ab5df0SBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring,MatMFFDType); 190561ab5df0SBarry Smith 1906014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *); 1907014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *); 19087dbadf16SMatthew Knepley 190953022affSStefano Zampini #ifdef PETSC_HAVE_H2OPUS 191053022affSStefano Zampini PETSC_EXTERN_TYPEDEF typedef PetscScalar (*MatH2OpusKernel)(PetscInt,PetscReal[],PetscReal[],void*); 191153022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatCreateH2OpusFromKernel(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscReal[],PetscBool,MatH2OpusKernel,void*,PetscReal,PetscInt,PetscInt,Mat*); 191253022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatCreateH2OpusFromMat(Mat,PetscInt,const PetscReal[],PetscBool,PetscReal,PetscInt,PetscInt,PetscInt,PetscReal,Mat*); 191353022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusSetSamplingMat(Mat,Mat,PetscInt,PetscReal); 191453022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusOrthogonalize(Mat); 191553022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusCompress(Mat,PetscReal); 191653022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusSetNativeMult(Mat,PetscBool); 191753022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusGetNativeMult(Mat,PetscBool*); 191853022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusGetIndexMap(Mat,IS*); 191953022affSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusMapVec(Mat,PetscBool,Vec,Vec*); 1920300d917bSStefano Zampini PETSC_EXTERN PetscErrorCode MatH2OpusLowRankUpdate(Mat,Mat,Mat,PetscScalar); 1921a0d2e7d8SStefano Zampini #endif 1922a0d2e7d8SStefano Zampini 1923c7a4214aSPierre Jolivet #ifdef PETSC_HAVE_HTOOL 192498e73e17SPierre Jolivet PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*MatHtoolKernel)(PetscInt,PetscInt,PetscInt,const PetscInt*,const PetscInt*,PetscScalar*,void*); 1925c7a4214aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatCreateHtoolFromKernel(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscReal[],const PetscReal[],MatHtoolKernel,void*,Mat*); 1926c7a4214aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolSetKernel(Mat,MatHtoolKernel,void*); 192798e73e17SPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolGetPermutationSource(Mat,IS*); 192898e73e17SPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolGetPermutationTarget(Mat,IS*); 192998e73e17SPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolUsePermutation(Mat,PetscBool); 1930c7a4214aSPierre Jolivet /*E 1931c7a4214aSPierre Jolivet MatHtoolCompressorType - Indicates the type of compressor used by a MATHTOOL 1932c7a4214aSPierre Jolivet 1933c7a4214aSPierre Jolivet Level: beginner 1934c7a4214aSPierre Jolivet 1935c7a4214aSPierre Jolivet Values: 1936c7a4214aSPierre Jolivet + MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA (default) - symmetric partial adaptive cross approximation 1937c7a4214aSPierre Jolivet . MAT_HTOOL_COMPRESSOR_FULL_ACA - full adaptive cross approximation 1938c7a4214aSPierre Jolivet - MAT_HTOOL_COMPRESSOR_SVD - singular value decomposition 1939c7a4214aSPierre Jolivet 1940db781477SPatrick Sanan .seealso: `MatCreateHtoolFromKernel()`, `MATHTOOL`, `MatHtoolClusteringType` 1941c7a4214aSPierre Jolivet E*/ 1942c7a4214aSPierre Jolivet typedef enum { MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA, MAT_HTOOL_COMPRESSOR_FULL_ACA, MAT_HTOOL_COMPRESSOR_SVD } MatHtoolCompressorType; 194398e73e17SPierre Jolivet /*E 194498e73e17SPierre Jolivet MatHtoolClusteringType - Indicates the type of clustering used by a MATHTOOL 194598e73e17SPierre Jolivet 194698e73e17SPierre Jolivet Level: beginner 194798e73e17SPierre Jolivet 194898e73e17SPierre Jolivet Values: 194998e73e17SPierre Jolivet + MAT_HTOOL_CLUSTERING_PCA_REGULAR (default) - axis computed via principle component analysis, split uniformly 195098e73e17SPierre Jolivet . MAT_HTOOL_CLUSTERING_PCA_GEOMETRIC - axis computed via principle component analysis, split barycentrically 195198e73e17SPierre Jolivet . MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_REGULAR - axis along the largest extent of the bounding box, split uniformly 195298e73e17SPierre Jolivet - MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_GEOMETRIC - axis along the largest extent of the bounding box, split barycentrically 195398e73e17SPierre Jolivet 195498e73e17SPierre Jolivet Notes: higher-dimensional clustering is not yet supported in Htool, but once it is, one should add BOUNDING_BOX_{2,3} types 195598e73e17SPierre Jolivet 1956db781477SPatrick Sanan .seealso: `MatCreateHtoolFromKernel()`, `MATHTOOL`, `MatHtoolCompressorType` 195798e73e17SPierre Jolivet E*/ 195898e73e17SPierre 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; 1959c7a4214aSPierre Jolivet #endif 1960c7a4214aSPierre Jolivet 196197969023SHong Zhang /* 196297969023SHong Zhang PETSc interface to MUMPS 196397969023SHong Zhang */ 196497969023SHong Zhang #ifdef PETSC_HAVE_MUMPS 1965014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt); 1966bc6112feSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat,PetscInt,PetscInt*); 1967b9e9ea26SSatish Balay PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal); 1968bc6112feSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat,PetscInt,PetscReal*); 1969bc6112feSHong Zhang 1970ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat,PetscInt,PetscInt*); 1971ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat,PetscInt,PetscInt*); 1972ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat,PetscInt,PetscReal*); 1973ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat,PetscInt,PetscReal*); 197489a9c03aSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat,Mat); 19750e6b8875SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInverseTranspose(Mat,Mat); 197697969023SHong Zhang #endif 197723a5497aSJed Brown 1978d954db57SHong Zhang /* 1979d615f992SSatish Balay PETSc interface to Mkl_Pardiso 1980b500a6b7SJose David Bermeol */ 1981b500a6b7SJose David Bermeol #ifdef PETSC_HAVE_MKL_PARDISO 1982d615f992SSatish Balay PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt); 1983b500a6b7SJose David Bermeol #endif 1984b500a6b7SJose David Bermeol 1985b500a6b7SJose David Bermeol /* 1986d305a81bSVasiliy Kozyrev PETSc interface to Mkl_CPardiso 1987d305a81bSVasiliy Kozyrev */ 1988d305a81bSVasiliy Kozyrev #ifdef PETSC_HAVE_MKL_CPARDISO 1989d305a81bSVasiliy Kozyrev PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt); 1990d305a81bSVasiliy Kozyrev #endif 1991d305a81bSVasiliy Kozyrev 1992d305a81bSVasiliy Kozyrev /* 1993d954db57SHong Zhang PETSc interface to SUPERLU 1994d954db57SHong Zhang */ 1995d954db57SHong Zhang #ifdef PETSC_HAVE_SUPERLU 1996014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal); 1997d954db57SHong Zhang #endif 1998d954db57SHong Zhang 1999fb785984SHong Zhang /* 2000fb785984SHong Zhang PETSc interface to SUPERLU_DIST 2001fb785984SHong Zhang */ 2002fb785984SHong Zhang #ifdef PETSC_HAVE_SUPERLU_DIST 2003fb785984SHong Zhang PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat,PetscScalar*); 2004fb785984SHong Zhang #endif 2005fb785984SHong Zhang 2006575704cbSPieter Ghysels /* 2007575704cbSPieter Ghysels PETSc interface to STRUMPACK 2008575704cbSPieter Ghysels */ 2009575704cbSPieter Ghysels #ifdef PETSC_HAVE_STRUMPACK 2010542aee0fSPieter Ghysels /*E 2011542aee0fSPieter Ghysels MatSTRUMPACKReordering - sparsity reducing ordering to be used in STRUMPACK 2012542aee0fSPieter Ghysels 2013542aee0fSPieter Ghysels Level: intermediate 2014542aee0fSPieter Ghysels E*/ 201534f43fa5SPieter Ghysels typedef enum {MAT_STRUMPACK_NATURAL=0, 201634f43fa5SPieter Ghysels MAT_STRUMPACK_METIS=1, 201734f43fa5SPieter Ghysels MAT_STRUMPACK_PARMETIS=2, 201834f43fa5SPieter Ghysels MAT_STRUMPACK_SCOTCH=3, 201934f43fa5SPieter Ghysels MAT_STRUMPACK_PTSCOTCH=4, 202034f43fa5SPieter Ghysels MAT_STRUMPACK_RCM=5} MatSTRUMPACKReordering; 202134f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat,MatSTRUMPACKReordering); 2022575704cbSPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat,PetscBool); 202334f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSRelTol(Mat,PetscReal); 20249fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSRelTol() (since version 3.9)") static inline PetscErrorCode MatSTRUMPACKSetHSSRelCompTol(Mat mat,PetscReal rtol) {return MatSTRUMPACKSetHSSRelTol(mat,rtol);} 202534f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSAbsTol(Mat,PetscReal); 202634f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMinSepSize(Mat,PetscInt); 20279fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSMinSepSize() (since version 3.9)") static inline PetscErrorCode MatSTRUMPACKSetHSSMinSize(Mat mat,PetscInt hssminsize) {return MatSTRUMPACKSetHSSMinSepSize(mat,hssminsize);} 202834f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMaxRank(Mat,PetscInt); 2029a36bf211SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSLeafSize(Mat,PetscInt); 2030575704cbSPieter Ghysels #endif 2031575704cbSPieter Ghysels 2032b470e4b4SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatBindToCPU(Mat,PetscBool); 20332216c58aSStefano Zampini PETSC_EXTERN PetscErrorCode MatBoundToCPU(Mat,PetscBool*); 20349fbee547SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION("Use MatBindToCPU (since v3.13)") static inline PetscErrorCode MatPinToCPU(Mat A,PetscBool flg) {return MatBindToCPU(A,flg);} 203565a9ecf2SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatSetBindingPropagates(Mat,PetscBool); 2036e9c74fd6SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatGetBindingPropagates(Mat,PetscBool *); 2037e7e92044SBarry Smith 2038042217e8SBarry Smith typedef struct _n_SplitCSRMat *PetscSplitCSRDataStructure; 2039042217e8SBarry Smith PETSC_EXTERN PetscErrorCode MatCUSPARSEGetDeviceMatWrite(Mat,PetscSplitCSRDataStructure*); 2040a587d139SMark 2041a587d139SMark #ifdef PETSC_HAVE_KOKKOS_KERNELS 2042042217e8SBarry Smith PETSC_EXTERN PetscErrorCode MatKokkosGetDeviceMatWrite(Mat,PetscSplitCSRDataStructure*); 2043042217e8SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJKokkosSetDeviceMat(Mat,PetscSplitCSRDataStructure); 2044042217e8SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJKokkosGetDeviceMat(Mat,PetscSplitCSRDataStructure*); 2045a587d139SMark #endif 2046a587d139SMark 2047aa372e3fSPaul Mullowney #ifdef PETSC_HAVE_CUDA 20483f9c0db1SPaul Mullowney /*E 2049e057df02SPaul Mullowney MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU) 20502692e278SPaul Mullowney matrices. 2051e057df02SPaul Mullowney 2052e057df02SPaul Mullowney Not Collective 2053e057df02SPaul Mullowney 20548468deeeSKarl Rupp + MAT_CUSPARSE_CSR - Compressed Sparse Row 20552692e278SPaul Mullowney . MAT_CUSPARSE_ELL - Ellpack (requires CUDA 4.2 or later). 20562692e278SPaul Mullowney - MAT_CUSPARSE_HYB - Hybrid, a combination of Ellpack and Coordinate format (requires CUDA 4.2 or later). 2057e057df02SPaul Mullowney 2058e057df02SPaul Mullowney Level: intermediate 2059e057df02SPaul Mullowney 2060af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 2061e057df02SPaul Mullowney 2062db781477SPatrick Sanan .seealso: `MatCUSPARSESetFormat()`, `MatCUSPARSEFormatOperation` 2063e057df02SPaul Mullowney E*/ 2064e057df02SPaul Mullowney 20653f9c0db1SPaul Mullowney typedef enum {MAT_CUSPARSE_CSR, MAT_CUSPARSE_ELL, MAT_CUSPARSE_HYB} MatCUSPARSEStorageFormat; 2066e057df02SPaul Mullowney 2067e057df02SPaul Mullowney /* these will be strings associated with enumerated type defined above */ 2068e057df02SPaul Mullowney PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[]; 2069e057df02SPaul Mullowney 20703f9c0db1SPaul Mullowney /*E 2071e057df02SPaul Mullowney MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU) 20722692e278SPaul Mullowney matrices whose operation should use a particular storage format. 2073e057df02SPaul Mullowney 2074e057df02SPaul Mullowney Not Collective 2075e057df02SPaul Mullowney 20768468deeeSKarl Rupp + MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult 20778468deeeSKarl Rupp . MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult 20788468deeeSKarl Rupp . MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult 20798468deeeSKarl Rupp - MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices 2080e057df02SPaul Mullowney 2081e057df02SPaul Mullowney Level: intermediate 2082e057df02SPaul Mullowney 2083db781477SPatrick Sanan .seealso: `MatCUSPARSESetFormat()`, `MatCUSPARSEStorageFormat` 2084e057df02SPaul Mullowney E*/ 208536d62e41SPaul Mullowney typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation; 2086e057df02SPaul Mullowney 208710e9db80SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 208810e9db80SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 2089e057df02SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat); 2090365b711fSMark Adams PETSC_EXTERN PetscErrorCode MatCUSPARSESetUseCPUSolve(Mat,PetscBool); 2091e8d2b73aSMark Adams typedef struct Mat_SeqAIJCUSPARSETriFactors* Mat_SeqAIJCUSPARSETriFactors_p; 20925f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetIJ(Mat,PetscBool,const int**,const int**); 20935f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreIJ(Mat,PetscBool,const int**,const int**); 20945f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArrayRead(Mat,const PetscScalar**); 20955f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArrayRead(Mat,const PetscScalar**); 20965f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArrayWrite(Mat,PetscScalar**); 20975f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArrayWrite(Mat,PetscScalar**); 20985f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArray(Mat,PetscScalar**); 20995f101d05SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArray(Mat,PetscScalar**); 2100637a0070SStefano Zampini 2101637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatCreateDenseCUDA(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*); 2102637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatCreateSeqDenseCUDA(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*); 2103637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatMPIDenseCUDASetPreallocation(Mat,PetscScalar[]); 2104637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatSeqDenseCUDASetPreallocation(Mat,PetscScalar[]); 2105637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayWrite(Mat,PetscScalar**); 2106637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayRead(Mat,const PetscScalar**); 2107637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArray(Mat,PetscScalar**); 2108637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayWrite(Mat,PetscScalar**); 2109637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayRead(Mat,const PetscScalar**); 2110637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArray(Mat,PetscScalar**); 2111637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAPlaceArray(Mat,const PetscScalar*); 2112d5ea218eSStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAReplaceArray(Mat,const PetscScalar*); 2113637a0070SStefano Zampini PETSC_EXTERN PetscErrorCode MatDenseCUDAResetArray(Mat); 21143fa6b06aSMark Adams 21159ae82921SPaul Mullowney #endif 21169ae82921SPaul Mullowney 2117d67ff14aSKarl Rupp #if defined(PETSC_HAVE_VIENNACL) 2118d67ff14aSKarl Rupp PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 2119d67ff14aSKarl Rupp PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 2120d67ff14aSKarl Rupp #endif 2121d67ff14aSKarl Rupp 212254efbe56SHong Zhang /* 212354efbe56SHong Zhang PETSc interface to FFTW 212454efbe56SHong Zhang */ 212554efbe56SHong Zhang #if defined(PETSC_HAVE_FFTW) 2126014dd563SJed Brown PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec); 2127014dd563SJed Brown PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec); 21282a7a6963SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*); 212954efbe56SHong Zhang #endif 213054efbe56SHong Zhang 2131d24d4204SJose E. Roman #if defined(PETSC_HAVE_SCALAPACK) 2132d24d4204SJose E. Roman PETSC_EXTERN PetscErrorCode MatCreateScaLAPACK(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 2133d24d4204SJose E. Roman PETSC_EXTERN PetscErrorCode MatScaLAPACKSetBlockSizes(Mat,PetscInt,PetscInt); 2134d24d4204SJose E. Roman PETSC_EXTERN PetscErrorCode MatScaLAPACKGetBlockSizes(Mat,PetscInt*,PetscInt*); 2135d24d4204SJose E. Roman #endif 2136d24d4204SJose E. Roman 2137014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*); 2138014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*); 2139014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]); 2140014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]); 2141014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***); 2142014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*); 214319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType); 2144014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]); 2145014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat); 2146d8588912SDave May 21474325cce7SMatthew G Knepley PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal); 2148e0a58c10SMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*); 21494325cce7SMatthew G Knepley 2150b541e6a4SDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSubdomainsCreateCoalesce(Mat,PetscInt,PetscInt*,IS**); 215153dd7562SDmitry Karpeev 2152c094ef40SMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatPreallocatorPreallocate(Mat,PetscBool,Mat); 2153c094ef40SMatthew G. Knepley 2154539c167fSBarry Smith PETSC_INTERN PetscErrorCode MatHeaderMerge(Mat,Mat*); 2155539c167fSBarry Smith PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat,Mat*); 21561a2c6b5cSJunchao Zhang 21577ee59b9bSJunchao Zhang PETSC_EXTERN PetscErrorCode MatSeqAIJGetCSRAndMemType(Mat,const PetscInt**,const PetscInt**,PetscScalar**,PetscMemType*); 215872833a62Smarkadams4 215972833a62Smarkadams4 PETSC_EXTERN PetscErrorCode MatCreateGraph(Mat,PetscBool,PetscBool,Mat*); 216072833a62Smarkadams4 PETSC_EXTERN PetscErrorCode MatFilter(Mat,PetscReal,Mat*); 216172833a62Smarkadams4 216223a5497aSJed Brown #endif 2163