12eac72dbSBarry Smith /* 22eac72dbSBarry Smith Include file for the matrix component of PETSc 32eac72dbSBarry Smith */ 426bd1501SBarry Smith #ifndef PETSCMAT_H 526bd1501SBarry Smith #define PETSCMAT_H 62c8e378dSBarry Smith #include <petscvec.h> 72eac72dbSBarry Smith 8d9274352SBarry Smith /*S 98f6c3df8SBarry Smith Mat - Abstract PETSc matrix object used to manage all linear operators in PETSc, even those without 108f6c3df8SBarry Smith an explicit sparse representation (such as matrix-free operators) 112eac72dbSBarry Smith 12d91e6319SBarry Smith Level: beginner 13d91e6319SBarry Smith 148f6c3df8SBarry Smith .seealso: MatCreate(), MatType, MatSetType(), MatDestroy() 15d9274352SBarry Smith S*/ 16d9274352SBarry Smith typedef struct _p_Mat* Mat; 17d9274352SBarry Smith 1876bdecfbSBarry Smith /*J 198f6c3df8SBarry Smith MatType - String with the name of a PETSc matrix type 20d9274352SBarry Smith 21d9274352SBarry Smith Level: beginner 22d9274352SBarry Smith 233ca39a21SBarry Smith .seealso: MatSetType(), Mat, MatSolverType, MatRegister() 2476bdecfbSBarry Smith J*/ 2519fd82e9SBarry Smith typedef const char* MatType; 26273d9f13SBarry Smith #define MATSAME "same" 275a11e1b2SBarry Smith #define MATMAIJ "maij" 28273d9f13SBarry Smith #define MATSEQMAIJ "seqmaij" 29273d9f13SBarry Smith #define MATMPIMAIJ "mpimaij" 3049bd79ccSDebojyoti Ghosh #define MATKAIJ "kaij" 3149bd79ccSDebojyoti Ghosh #define MATSEQKAIJ "seqkaij" 3249bd79ccSDebojyoti Ghosh #define MATMPIKAIJ "mpikaij" 33273d9f13SBarry Smith #define MATIS "is" 345a11e1b2SBarry Smith #define MATAIJ "aij" 35273d9f13SBarry Smith #define MATSEQAIJ "seqaij" 36273d9f13SBarry Smith #define MATMPIAIJ "mpiaij" 375a11e1b2SBarry Smith #define MATAIJCRL "aijcrl" 385a11e1b2SBarry Smith #define MATSEQAIJCRL "seqaijcrl" 395a11e1b2SBarry Smith #define MATMPIAIJCRL "mpiaijcrl" 409ae82921SPaul Mullowney #define MATAIJCUSPARSE "aijcusparse" 419ae82921SPaul Mullowney #define MATSEQAIJCUSPARSE "seqaijcusparse" 429ae82921SPaul Mullowney #define MATMPIAIJCUSPARSE "mpiaijcusparse" 43d67ff14aSKarl Rupp #define MATAIJVIENNACL "aijviennacl" 44d67ff14aSKarl Rupp #define MATSEQAIJVIENNACL "seqaijviennacl" 45d67ff14aSKarl Rupp #define MATMPIAIJVIENNACL "mpiaijviennacl" 465a11e1b2SBarry Smith #define MATAIJPERM "aijperm" 475a11e1b2SBarry Smith #define MATSEQAIJPERM "seqaijperm" 485a11e1b2SBarry Smith #define MATMPIAIJPERM "mpiaijperm" 494dfdc2d9SRichard Tran Mills #define MATAIJSELL "aijsell" 504dfdc2d9SRichard Tran Mills #define MATSEQAIJSELL "seqaijsell" 514dfdc2d9SRichard Tran Mills #define MATMPIAIJSELL "mpiaijsell" 524a2a386eSRichard Tran Mills #define MATAIJMKL "aijmkl" 534a2a386eSRichard Tran Mills #define MATSEQAIJMKL "seqaijmkl" 544a2a386eSRichard Tran Mills #define MATMPIAIJMKL "mpiaijmkl" 55b5b72c8aSIrina Sokolova #define MATBAIJMKL "baijmkl" 56b5b72c8aSIrina Sokolova #define MATSEQBAIJMKL "seqbaijmkl" 57b5b72c8aSIrina Sokolova #define MATMPIBAIJMKL "mpibaijmkl" 58273d9f13SBarry Smith #define MATSHELL "shell" 595a11e1b2SBarry Smith #define MATDENSE "dense" 60209238afSKris Buschelman #define MATSEQDENSE "seqdense" 61bfc799aaSStefano Zampini #define MATSEQDENSECUDA "seqdensecuda" 62273d9f13SBarry Smith #define MATMPIDENSE "mpidense" 63db31f6deSJed Brown #define MATELEMENTAL "elemental" 645a11e1b2SBarry Smith #define MATBAIJ "baij" 65273d9f13SBarry Smith #define MATSEQBAIJ "seqbaij" 66273d9f13SBarry Smith #define MATMPIBAIJ "mpibaij" 67273d9f13SBarry Smith #define MATMPIADJ "mpiadj" 685a11e1b2SBarry Smith #define MATSBAIJ "sbaij" 69273d9f13SBarry Smith #define MATSEQSBAIJ "seqsbaij" 70273d9f13SBarry Smith #define MATMPISBAIJ "mpisbaij" 71cebc7f6cSBarry Smith #define MATDAAD "daad" 72cebc7f6cSBarry Smith #define MATMFFD "mffd" 73c8a8475eSBarry Smith #define MATNORMAL "normal" 74c5e4d11fSDmitry Karpeev #define MATNORMALHERMITIAN "normalh" 75ab92ecdeSBarry Smith #define MATLRC "lrc" 762a6744ebSBarry Smith #define MATSCATTER "scatter" 77421e10b8SBarry Smith #define MATBLOCKMAT "blockmat" 78793850ffSBarry Smith #define MATCOMPOSITE "composite" 791f8c7532SHong Zhang #define MATFFT "fft" 801f8c7532SHong Zhang #define MATFFTW "fftw" 81e133240eSMatthew G Knepley #define MATSEQCUFFT "seqcufft" 82557cca28SSatish Balay #define MATTRANSPOSEMAT "transpose" 8372ca8751SBarry Smith #define MATSCHURCOMPLEMENT "schurcomplement" 841d6018f0SLisandro Dalcin #define MATPYTHON "python" 8563c07aadSStefano Zampini #define MATHYPRE "hypre" 86f91d8e95SBarry Smith #define MATHYPRESTRUCT "hyprestruct" 87a9e6138eSGlenn Hammond #define MATHYPRESSTRUCT "hypresstruct" 88ee1cef2cSJed Brown #define MATSUBMATRIX "submatrix" 892c0dbf93SJed Brown #define MATLOCALREF "localref" 90d8588912SDave May #define MATNEST "nest" 91c094ef40SMatthew G. Knepley #define MATPREALLOCATOR "preallocator" 92d4002b98SHong Zhang #define MATSELL "sell" 93d4002b98SHong Zhang #define MATSEQSELL "seqsell" 94d4002b98SHong Zhang #define MATMPISELL "mpisell" 95a3b2e22bSHong Zhang #define MATDUMMY "dummy" 96cd929ea3SAlp Dener #define MATLMVM "lmvm" 9778e4361aSAlp Dener #define MATLMVMDFP "lmvmdfp" 9878e4361aSAlp Dener #define MATLMVMBFGS "lmvmbfgs" 9978e4361aSAlp Dener #define MATLMVMSR1 "lmvmsr1" 10078e4361aSAlp Dener #define MATLMVMBRDN "lmvmbrdn" 10178e4361aSAlp Dener #define MATLMVMBADBRDN "lmvmbadbrdn" 10278e4361aSAlp Dener #define MATLMVMSYMBRDN "lmvmsymbrdn" 10318ad3407SAlp Dener #define MATLMVMSYMBADBRDN "lmvmsymbadbrdn" 10450b47da0SAdam Denchfield #define MATLMVMDIAGBRDN "lmvmdiagbrdn" 1053423f386SBarry Smith #define MATCONSTANTDIAGONAL "constantdiagonal" 106773941d6SBarry Smith 10776bdecfbSBarry Smith /*J 1083ca39a21SBarry Smith MatSolverType - String with the name of a PETSc matrix solver type. 1099989ab13SBarry Smith 110c2b89b5dSBarry Smith For example: "petsc" indicates what PETSc provides, "superlu_dist" the parallel SuperLU_DIST package etc 1119989ab13SBarry Smith 1129989ab13SBarry Smith Level: beginner 1139989ab13SBarry Smith 114b198fc33SVáclav Hapla .seealso: MatGetFactor(), PCFactorSetMatSolverType(), PCFactorGetMatSolverType() 11576bdecfbSBarry Smith J*/ 116ea799195SBarry Smith typedef const char* MatSolverType; 1172692d6eeSBarry Smith #define MATSOLVERSUPERLU "superlu" 1182692d6eeSBarry Smith #define MATSOLVERSUPERLU_DIST "superlu_dist" 11908f5efcfSPieter Ghysels #define MATSOLVERSTRUMPACK "strumpack" 1202692d6eeSBarry Smith #define MATSOLVERUMFPACK "umfpack" 12120db9a53SJed Brown #define MATSOLVERCHOLMOD "cholmod" 122d89f5e7aSBarry Smith #define MATSOLVERKLU "klu" 123418810c4SBarry Smith #define MATSOLVERSPARSEELEMENTAL "sparseelemental" 124d89f5e7aSBarry Smith #define MATSOLVERELEMENTAL "elemental" 1252692d6eeSBarry Smith #define MATSOLVERESSL "essl" 1262692d6eeSBarry Smith #define MATSOLVERLUSOL "lusol" 1272692d6eeSBarry Smith #define MATSOLVERMUMPS "mumps" 128d615f992SSatish Balay #define MATSOLVERMKL_PARDISO "mkl_pardiso" 129d305a81bSVasiliy Kozyrev #define MATSOLVERMKL_CPARDISO "mkl_cpardiso" 1302692d6eeSBarry Smith #define MATSOLVERPASTIX "pastix" 1312692d6eeSBarry Smith #define MATSOLVERMATLAB "matlab" 1322692d6eeSBarry Smith #define MATSOLVERPETSC "petsc" 1332692d6eeSBarry Smith #define MATSOLVERBAS "bas" 1349ae82921SPaul Mullowney #define MATSOLVERCUSPARSE "cusparse" 135bfc799aaSStefano Zampini #define MATSOLVERCUDA "cuda" 136c0cdd4a1SDahai Guo 137b24902e0SBarry Smith /*E 138b24902e0SBarry Smith MatFactorType - indicates what type of factorization is requested 139b24902e0SBarry Smith 140b24902e0SBarry Smith Level: beginner 141b24902e0SBarry Smith 142af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 143b24902e0SBarry Smith 1443ca39a21SBarry Smith .seealso: MatSolverType, MatGetFactor() 145b24902e0SBarry Smith E*/ 146552a653fSAlp Dener typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType; 147014dd563SJed Brown PETSC_EXTERN const char *const MatFactorTypes[]; 148e92e720dSBarry Smith 149ea799195SBarry Smith PETSC_EXTERN PetscErrorCode MatGetFactor(Mat,MatSolverType,MatFactorType,Mat*); 150ea799195SBarry Smith PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat,MatSolverType,MatFactorType,PetscBool *); 151ea799195SBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetSolverType(Mat,MatSolverType*); 152014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat,MatFactorType*); 1537abd51d3SMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatSetFactorType(Mat,MatFactorType); 154fd9d3c67SJed Brown PETSC_EXTERN PetscErrorCode MatSolverTypeRegister(MatSolverType,MatType,MatFactorType,PetscErrorCode(*)(Mat,MatFactorType,Mat*)); 155fd9d3c67SJed Brown PETSC_EXTERN PetscErrorCode MatSolverTypeGet(MatSolverType,MatType,MatFactorType,PetscBool*,PetscBool*,PetscErrorCode (**)(Mat,MatFactorType,Mat*)); 15625ef9dfeSBarry Smith typedef MatSolverType MatSolverPackage PETSC_DEPRECATED_TYPEDEF("Use MatSolverType (since version 3.9)"); 15725ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatSolverTypeRegister() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSolverPackageRegister(MatSolverType stype,MatType mtype,MatFactorType ftype,PetscErrorCode(*f)(Mat,MatFactorType,Mat*)) 158c19b563cSJed Brown { return MatSolverTypeRegister(stype,mtype,ftype,f); } 15925ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatSolverTypeGet() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSolverPackageGet(MatSolverType stype,MatType mtype,MatFactorType ftype,PetscBool *foundmtype,PetscBool *foundstype,PetscErrorCode(**f)(Mat,MatFactorType,Mat*)) 160c19b563cSJed Brown { return MatSolverTypeGet(stype,mtype,ftype,foundmtype,foundstype,f); } 1619989ab13SBarry Smith 162c06d978dSMatthew Knepley /* Logging support */ 1630700a824SBarry Smith #define MAT_FILE_CLASSID 1211216 /* used to indicate matrices in binary files */ 164014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_CLASSID; 165335efc43SPeter Brune PETSC_EXTERN PetscClassId MAT_COLORING_CLASSID; 166014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_FDCOLORING_CLASSID; 167014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_TRANSPOSECOLORING_CLASSID; 168014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_PARTITIONING_CLASSID; 169014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_COARSEN_CLASSID; 170014dd563SJed Brown PETSC_EXTERN PetscClassId MAT_NULLSPACE_CLASSID; 171014dd563SJed Brown PETSC_EXTERN PetscClassId MATMFFD_CLASSID; 172c06d978dSMatthew Knepley 173ceb03754SKris Buschelman /*E 1747dae84e0SHong Zhang MatReuse - Indicates if matrices obtained from a previous call to MatCreateSubMatrices(), MatCreateSubMatrix(), MatConvert() or several other functions 175cf37664fSBarry Smith are to be reused to store the new matrix values. 176cf37664fSBarry Smith 177cf37664fSBarry Smith $ MAT_INITIAL_MATRIX - create a new matrix 178cf37664fSBarry Smith $ MAT_REUSE_MATRIX - reuse the matrix created with a previous call that used MAT_INITIAL_MATRIX 179cf37664fSBarry Smith $ MAT_INPLACE_MATRIX - replace the first input matrix with the new matrix (not applicable to all functions) 180cf37664fSBarry 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) 181ceb03754SKris Buschelman 182ceb03754SKris Buschelman Level: beginner 183ceb03754SKris Buschelman 184af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 185ceb03754SKris Buschelman 1867dae84e0SHong Zhang .seealso: MatCreateSubMatrices(), MatCreateSubMatrix(), MatDestroyMatrices(), MatConvert() 187ceb03754SKris Buschelman E*/ 188511c6705SHong Zhang typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX,MAT_INPLACE_MATRIX} MatReuse; 189ceb03754SKris Buschelman 1905494a064SHong Zhang /*E 1917dae84e0SHong Zhang MatCreateSubMatrixOption - Indicates if matrices obtained from a call to MatCreateSubMatrices() 192829201f2SHong Zhang include the matrix values. Currently it is only used by MatGetSeqNonzerostructure(). 1935494a064SHong Zhang 1945494a064SHong Zhang Level: beginner 1955494a064SHong Zhang 196829201f2SHong Zhang .seealso: MatGetSeqNonzerostructure() 1975494a064SHong Zhang E*/ 1987dae84e0SHong Zhang typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatCreateSubMatrixOption; 1995494a064SHong Zhang 200607a6623SBarry Smith PETSC_EXTERN PetscErrorCode MatInitializePackage(void); 201c06d978dSMatthew Knepley 202014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm,Mat*); 203014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt); 20419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatSetType(Mat,MatType); 205014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat); 206685405a1SBarry Smith PETSC_STATIC_INLINE PetscErrorCode MatViewFromOptions(Mat A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);} 207bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatRegister(const char[],PetscErrorCode(*)(Mat)); 20823bebc0bSBarry Smith PETSC_EXTERN PetscErrorCode MatRegisterRootName(const char[],const char[],const char[]); 209014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat,const char[]); 210014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat,const char[]); 211014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat,const char*[]); 21284d44b13SHong Zhang PETSC_EXTERN PetscErrorCode MatSetErrorIfFailure(Mat,PetscBool); 213f69a0ea3SMatthew Knepley 214140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatList; 215140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatColoringList; 216140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatPartitioningList; 21728988994SBarry Smith 2183b224e63SBarry Smith /*E 219aa6c7ce3SBarry Smith MatStructure - Indicates if two matrices have the same nonzero structure 2203b224e63SBarry Smith 2213b224e63SBarry Smith Level: beginner 2223b224e63SBarry Smith 223af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 2243b224e63SBarry Smith 225aa6c7ce3SBarry Smith .seealso: MatCopy(), MatAXPY() 2263b224e63SBarry Smith E*/ 227aa6c7ce3SBarry Smith typedef enum {DIFFERENT_NONZERO_PATTERN,SUBSET_NONZERO_PATTERN,SAME_NONZERO_PATTERN} MatStructure; 2283b224e63SBarry Smith 2299779e05dSSatish Balay #if defined PETSC_HAVE_MKL_SPARSE 230ddee360bSSatish Balay PETSC_EXTERN PetscErrorCode MatCreateSeqAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 231ddee360bSSatish Balay PETSC_EXTERN PetscErrorCode MatCreateMPIAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 23280095d54SIrina Sokolova PETSC_EXTERN PetscErrorCode MatCreateBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 233ddee360bSSatish Balay PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 23480095d54SIrina Sokolova #endif 235cd929ea3SAlp Dener 236d4002b98SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSeqSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 237d4002b98SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 238d4002b98SHong Zhang PETSC_EXTERN PetscErrorCode MatSeqSELLSetPreallocation(Mat,PetscInt,const PetscInt[]); 239d4002b98SHong Zhang PETSC_EXTERN PetscErrorCode MatMPISELLSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 24080095d54SIrina Sokolova 241014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*); 242014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*); 243014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 244014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 245014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *); 2468f8f2f0dSBarry Smith PETSC_EXTERN PetscErrorCode MatUpdateMPIAIJWithArrays(Mat,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 247014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*); 2483b00a383SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSeqAIJ(MPI_Comm,Mat,Mat,const PetscInt[],Mat*); 2493b00a383SHong Zhang 250014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 251014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 252014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*); 253d21a29f3SJed Brown 254014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*); 255014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 256d21a29f3SJed Brown 257014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 258014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *); 25938f409ebSLisandro Dalcin PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 260014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 2614cce697cSJed Brown PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],const PetscInt[]); 262dfb205c3SBarry Smith 263014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*); 264014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat,Mat*); 265c5e4d11fSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatCreateNormalHermitian(Mat,Mat*); 266986c4d72SJose E. Roman PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat,Mat,Vec,Mat,Mat*); 267267ca84cSJose E. Roman PETSC_EXTERN PetscErrorCode MatLRCGetMats(Mat,Mat*,Mat*,Vec*,Mat*); 268c5e4d11fSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,ISLocalToGlobalMapping,Mat*); 269014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 270014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 271c0cdd4a1SDahai Guo 272014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*); 273014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter); 274014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*); 275014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*); 276014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat,Mat); 277014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat); 2788c8613bfSJakub Kruzik typedef enum {MAT_COMPOSITE_MERGE_RIGHT,MAT_COMPOSITE_MERGE_LEFT} MatCompositeMergeType; 2798c8613bfSJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeSetMergeType(Mat,MatCompositeMergeType); 280014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*); 2816d7c1e57SBarry Smith typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType; 282014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat,MatCompositeType); 2836dbc55e5SJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetType(Mat,MatCompositeType*); 2843b35acafSJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeSetMatStructure(Mat,MatStructure); 2853b35acafSJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetMatStructure(Mat,MatStructure*); 2866d0add67SJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetNumberMat(Mat,PetscInt*); 2878b5c3584SJakub Kruzik PETSC_EXTERN PetscErrorCode MatCompositeGetMat(Mat,PetscInt,Mat*); 2886d7c1e57SBarry Smith 28919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateFFT(MPI_Comm,PetscInt,const PetscInt[],MatType,Mat*); 290014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqCUFFT(MPI_Comm,PetscInt,const PetscInt[],Mat*); 291dedccee8SHong Zhang 292014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*); 2938060fb66Sstefano_zampini PETSC_EXTERN PetscErrorCode MatTransposeGetMat(Mat,Mat*); 294d0de2241SAndrew Spott PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat,Mat*); 29506511a5cSPierre Jolivet PETSC_EXTERN PetscErrorCode MatHermitianTransposeGetMat(Mat,Mat*); 29654e05e6cSHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatrixVirtual(Mat,IS,IS,Mat*); 29754e05e6cSHong Zhang PETSC_EXTERN PetscErrorCode MatSubMatrixVirtualUpdate(Mat,Mat,IS,IS); 298014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*); 2993423f386SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateConstantDiagonal(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar,Mat*); 3001472f72bSBarry Smith 301978814f1SStefano Zampini #if defined(PETSC_HAVE_HYPRE) 302d975228cSstefano_zampini PETSC_EXTERN PetscErrorCode MatHYPRESetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 303978814f1SStefano Zampini #endif 304978814f1SStefano Zampini 305014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPythonSetType(Mat,const char[]); 3061d6018f0SLisandro Dalcin 307846b4da1SFande Kong PETSC_EXTERN PetscErrorCode MatResetPreallocation(Mat); 308014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetUp(Mat); 309014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDestroy(Mat*); 310e56f5c9eSBarry Smith PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat,PetscObjectState*); 31121c89e3eSBarry Smith 312014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatConjugate(Mat); 313014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRealPart(Mat); 314014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat); 315014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,Mat*); 316014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetTrace(Mat,PetscScalar*); 317713ccfa9SJed Brown PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat,const PetscScalar **); 3180da83c2eSBarry Smith PETSC_EXTERN PetscErrorCode MatInvertVariableBlockDiagonal(Mat,PetscInt,const PetscInt*,PetscScalar*); 319479a70c0SJed Brown PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonalMat(Mat,Mat); 32099cafbc1SBarry Smith 3218ed539a5SBarry Smith /* ------------------------------------------------------------*/ 322014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 323014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 324014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]); 325014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]); 326014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat,PetscInt,PetscInt,PetscInt[],const PetscScalar[]); 32773a71a0fSBarry Smith PETSC_EXTERN PetscErrorCode MatSetRandom(Mat,PetscRandom); 32884cb2905SBarry Smith 3292ef4de8bSBarry Smith /*S 3302ef4de8bSBarry Smith MatStencil - Data structure (C struct) for storing information about a single row or 33162ef0227SBarry Smith column of a matrix as indexed on an associated grid. These are arguments to MatSetStencil() and MatSetBlockStencil() 33262ef0227SBarry Smith 33362ef0227SBarry 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). 33462ef0227SBarry 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. 33562ef0227SBarry Smith 33662ef0227SBarry Smith For stencil access to vectors see DMDAVecGetArray(), DMDAVecGetArrayF90(). 337be479b30SJed Brown 338be479b30SJed Brown Fortran usage is different, see MatSetValuesStencil() for details. 3392ef4de8bSBarry Smith 3402ef4de8bSBarry Smith Level: beginner 3412ef4de8bSBarry Smith 34262ef0227SBarry Smith .seealso: MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockedStencil(), DMDAVecGetArray(), DMDAVecGetArrayF90() 3432ef4de8bSBarry Smith S*/ 344435da068SBarry Smith typedef struct { 345c1ac3661SBarry Smith PetscInt k,j,i,c; 346435da068SBarry Smith } MatStencil; 3472ef4de8bSBarry Smith 348014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 349014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 350014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt); 351435da068SBarry Smith 352d91e6319SBarry Smith /*E 353d91e6319SBarry Smith MatAssemblyType - Indicates if the matrix is now to be used, or if you plan 35462ef0227SBarry Smith to continue to add or insert values to it 355d91e6319SBarry Smith 356d91e6319SBarry Smith Level: beginner 357d91e6319SBarry Smith 358d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd() 359d91e6319SBarry Smith E*/ 3606d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType; 361014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType); 362014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType); 363014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAssembled(Mat,PetscBool *); 3644f9c727eSBarry Smith 3651d73ed98SBarry Smith 36630de9b25SBarry Smith 367d91e6319SBarry Smith /*E 368d91e6319SBarry Smith MatOption - Options that may be set for a matrix and its behavior or storage 369d91e6319SBarry Smith 370d91e6319SBarry Smith Level: beginner 371d91e6319SBarry Smith 372af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 3730f8fb01aSBarry Smith Any additions/changes here must also be made in src/mat/interface/dlregismat.c in MatOptions[] 374d91e6319SBarry Smith 37595452b02SPatrick Sanan Developer Notes: 37695452b02SPatrick Sanan Entries that are negative need not be called collectively by all processes. 377382164b0SBarry Smith 378d91e6319SBarry Smith .seealso: MatSetOption() 379d91e6319SBarry Smith E*/ 380c5e4d11fSDmitry Karpeev typedef enum {MAT_OPTION_MIN = -3, 381c5e4d11fSDmitry Karpeev MAT_UNUSED_NONZERO_LOCATION_ERR = -2, 38292d4d306SBarry Smith MAT_ROW_ORIENTED = -1, 383382164b0SBarry Smith MAT_SYMMETRIC = 1, 384382164b0SBarry Smith MAT_STRUCTURALLY_SYMMETRIC = 2, 385382164b0SBarry Smith MAT_NEW_DIAGONALS = 3, 386382164b0SBarry Smith MAT_IGNORE_OFF_PROC_ENTRIES = 4, 387382164b0SBarry Smith MAT_USE_HASH_TABLE = 5, 388382164b0SBarry Smith MAT_KEEP_NONZERO_PATTERN = 6, 389382164b0SBarry Smith MAT_IGNORE_ZERO_ENTRIES = 7, 390382164b0SBarry Smith MAT_USE_INODES = 8, 391382164b0SBarry Smith MAT_HERMITIAN = 9, 392382164b0SBarry Smith MAT_SYMMETRY_ETERNAL = 10, 393c5e4d11fSDmitry Karpeev MAT_NEW_NONZERO_LOCATION_ERR = 11, 394382164b0SBarry Smith MAT_IGNORE_LOWER_TRIANGULAR = 12, 395382164b0SBarry Smith MAT_ERROR_LOWER_TRIANGULAR = 13, 396382164b0SBarry Smith MAT_GETROW_UPPERTRIANGULAR = 14, 397382164b0SBarry Smith MAT_SPD = 15, 39892d4d306SBarry Smith MAT_NO_OFF_PROC_ZERO_ROWS = 16, 39992d4d306SBarry Smith MAT_NO_OFF_PROC_ENTRIES = 17, 40092d4d306SBarry Smith MAT_NEW_NONZERO_LOCATIONS = 18, 401c5e4d11fSDmitry Karpeev MAT_NEW_NONZERO_ALLOCATION_ERR = 19, 402c5e4d11fSDmitry Karpeev MAT_SUBSET_OFF_PROC_ENTRIES = 20, 403c10200c1SHong Zhang MAT_SUBMAT_SINGLEIS = 21, 404957cac9fSHong Zhang MAT_STRUCTURE_ONLY = 22, 405071fcb05SBarry Smith MAT_SORTED_FULL = 23, 406071fcb05SBarry Smith MAT_OPTION_MAX = 24} MatOption; 407e057df02SPaul Mullowney 4080f8fb01aSBarry Smith PETSC_EXTERN const char *const *MatOptions; 409014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscBool); 4107d68702bSBarry Smith PETSC_EXTERN PetscErrorCode MatGetOption(Mat,MatOption,PetscBool*); 41119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatGetType(Mat,MatType*); 41284cb2905SBarry Smith 413014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]); 414014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 415014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 416014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat); 417014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat); 418014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt); 4198c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat,PetscScalar *[]); 4208c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat,PetscScalar *[]); 42121e72a00SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJGetMaxRowNonzeros(Mat,PetscInt*); 422bd04181cSBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJSetValuesLocalFast(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 4234099cc6bSBarry Smith PETSC_EXTERN PetscErrorCode MatSeqAIJSetType(Mat,MatType); 424388d47a6SSatish Balay PETSC_EXTERN PetscErrorCode MatSeqAIJRegister(const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat *)); 4254099cc6bSBarry Smith PETSC_EXTERN PetscFunctionList MatSeqAIJList; 4268397e458SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqSBAIJGetArray(Mat,PetscScalar *[]); 4278397e458SBarry Smith PETSC_EXTERN PetscErrorCode MatSeqSBAIJRestoreArray(Mat,PetscScalar *[]); 4288c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat,PetscScalar *[]); 4298c778c55SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat,PetscScalar *[]); 430d3042a70SBarry Smith PETSC_EXTERN PetscErrorCode MatDensePlaceArray(Mat,const PetscScalar[]); 431d3042a70SBarry Smith PETSC_EXTERN PetscErrorCode MatDenseResetArray(Mat); 4328572280aSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetArrayRead(Mat,const PetscScalar *[]); 4338572280aSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayRead(Mat,const PetscScalar *[]); 434014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *); 435014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt); 436014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat,PetscInt *,PetscInt *); 437014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat,PetscInt,PetscInt); 43833d57670SJed Brown PETSC_EXTERN PetscErrorCode MatSetBlockSizesFromMats(Mat,Mat,Mat); 4390da83c2eSBarry Smith PETSC_EXTERN PetscErrorCode MatSetVariableBlockSizes(Mat,PetscInt,PetscInt*); 4400da83c2eSBarry Smith PETSC_EXTERN PetscErrorCode MatGetVariableBlockSizes(Mat,PetscInt*,const PetscInt**); 4410da83c2eSBarry Smith 44286aefd0dSHong Zhang PETSC_EXTERN PetscErrorCode MatDenseGetColumn(Mat,PetscInt,PetscScalar *[]); 44386aefd0dSHong Zhang PETSC_EXTERN PetscErrorCode MatDenseRestoreColumn(Mat,PetscScalar *[]); 4441620fd73SBarry Smith 445014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMult(Mat,Vec,Vec); 446014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec); 447014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec); 448014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec); 449014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec); 450014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *); 451014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *); 452014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec); 453014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec); 454014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultConstrained(Mat,Vec,Vec); 455014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeConstrained(Mat,Vec,Vec); 456014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat); 457bdc285e1SStefano Zampini PETSC_EXTERN PetscErrorCode MatMatSolveTranspose(Mat,Mat,Mat); 458eb3ef3b2SHong Zhang PETSC_EXTERN PetscErrorCode MatMatTransposeSolve(Mat,Mat,Mat); 459f9426fe0SMark Adams PETSC_EXTERN PetscErrorCode MatResidual(Mat,Vec,Vec,Vec); 460f5edf698SHong Zhang 461d91e6319SBarry Smith /*E 462d91e6319SBarry Smith MatDuplicateOption - Indicates if a duplicated sparse matrix should have 463d91e6319SBarry Smith its numerical values copied over or just its nonzero structure. 464d91e6319SBarry Smith 465d91e6319SBarry Smith Level: beginner 466d91e6319SBarry Smith 467af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 468d91e6319SBarry Smith 4690018da39SRichard Tran Mills $ MAT_DO_NOT_COPY_VALUES - Create a matrix using the same nonzero pattern as the original matrix, 4700018da39SRichard Tran Mills $ with zeros for the numerical values. 4710018da39SRichard Tran Mills $ MAT_COPY_VALUES - Create a matrix with the same nonzero pattern as the original matrix 4720018da39SRichard Tran Mills $ and with the same numerical values. 4730018da39SRichard Tran Mills $ MAT_SHARE_NONZERO_PATTERN - Create a matrix that shares the nonzero structure with the previous matrix 4740018da39SRichard Tran Mills $ and does not copy it, using zeros for the numerical values. The parent and 4750018da39SRichard Tran Mills $ child matrices will share their index (i and j) arrays, and you cannot 4760018da39SRichard Tran Mills $ insert new nonzero entries into either matrix. 4770018da39SRichard Tran Mills 47895452b02SPatrick Sanan Notes: 47995452b02SPatrick Sanan Many matrix types (including SeqAIJ) do not support the MAT_SHARE_NONZERO_PATTERN optimization; in 4800018da39SRichard Tran Mills this case the behavior is as if MAT_DO_NOT_COPY_VALUES has been specified. 48170dcbbb9SBarry Smith 482d91e6319SBarry Smith .seealso: MatDuplicate() 483d91e6319SBarry Smith E*/ 48470dcbbb9SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption; 4852e8a6d31SBarry Smith 48619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*); 487014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*); 48894a9d846SBarry Smith 489cb5b572fSBarry Smith 490014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure); 491014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer); 492014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *); 493014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *); 494014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *); 495014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *); 496014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *); 497014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool *,PetscInt *); 498014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer); 4997b80b807SBarry Smith 5001a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *); 5011a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *); 5021a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *); 5031a83f524SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *); 504d4fbbf0eSBarry Smith 505d91e6319SBarry Smith /*S 506d91e6319SBarry Smith MatInfo - Context of matrix information, used with MatGetInfo() 507d91e6319SBarry Smith 508d91e6319SBarry Smith In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE 509d91e6319SBarry Smith 510d91e6319SBarry Smith Level: intermediate 511d91e6319SBarry Smith 512d9274352SBarry Smith .seealso: MatGetInfo(), MatInfoType 513d91e6319SBarry Smith S*/ 5144e220ebcSLois Curfman McInnes typedef struct { 515b0a32e0cSBarry Smith PetscLogDouble block_size; /* block size */ 516b0a32e0cSBarry Smith PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */ 517b0a32e0cSBarry Smith PetscLogDouble memory; /* memory allocated */ 518b0a32e0cSBarry Smith PetscLogDouble assemblies; /* number of matrix assemblies called */ 519b0a32e0cSBarry Smith PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */ 520b0a32e0cSBarry Smith PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */ 521b0a32e0cSBarry Smith PetscLogDouble factor_mallocs; /* number of mallocs during factorization */ 5224e220ebcSLois Curfman McInnes } MatInfo; 5234e220ebcSLois Curfman McInnes 524d9274352SBarry Smith /*E 525d9274352SBarry Smith MatInfoType - Indicates if you want information about the local part of the matrix, 526d9274352SBarry Smith the entire parallel matrix or the maximum over all the local parts. 527d9274352SBarry Smith 528d9274352SBarry Smith Level: beginner 529d9274352SBarry Smith 530af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 531d9274352SBarry Smith 532d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo 533d9274352SBarry Smith E*/ 5347b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType; 535014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*); 536014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec); 537014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]); 538014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]); 539014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]); 540014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]); 541014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat,Vec); 542014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*); 543014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*); 544014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat*); 545014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec); 546014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode); 547a52676ecSHong Zhang 548014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool*); 549014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool*); 550014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool*); 551014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool*); 552014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*); 553a52676ecSHong Zhang PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 554a52676ecSHong Zhang PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 555cc48ffa7SToby Isaac PETSC_EXTERN PetscErrorCode MatMatTransposeMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 55686919fd6SHong Zhang PETSC_EXTERN PetscErrorCode MatIsLinear(Mat,PetscInt,PetscBool*); 5577b80b807SBarry Smith 558014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal*); 559014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal*); 560014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat); 561014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 562014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec); 563014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec); 564014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec); 565014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 566014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec); 5677b80b807SBarry Smith 568014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*); 569014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*); 570014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*); 571014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**); 572014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*); 573014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**); 574566876eaSJed Brown PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*); 5755ef9f2a5SBarry Smith 5767dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 57725ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatCreateSubMatrices() (since version 3.8)") PETSC_STATIC_INLINE PetscErrorCode MatGetSubMatrices(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[]) {return MatCreateSubMatrices(mat,n,irow,icol,scall,submat);} 5787dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 57925ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatCreateSubMatricesMPI() (since version 3.8)") PETSC_STATIC_INLINE PetscErrorCode MatGetSubMatricesMPI(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[]) {return MatCreateSubMatricesMPI(mat,n,irow,icol,scall,submat);} 580014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]); 581df750dc8SHong Zhang PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt,Mat *[]); 5827dae84e0SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,MatReuse,Mat *); 58325ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatCreateSubMatrix() (since version 3.8)") PETSC_STATIC_INLINE PetscErrorCode MatGetSubMatrix(Mat mat,IS isrow,IS iscol,MatReuse cll,Mat *newmat) {return MatCreateSubMatrix(mat,isrow,iscol,cll,newmat);} 584014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*); 585014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*); 586014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*); 587014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*); 5887b80b807SBarry Smith 589014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*); 590014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*); 591014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat); 592014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*); 593014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*); 594014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*); 595014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]); 5968efafbd8SBarry Smith 597014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt); 598aa1e27eaSFande Kong PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat mat,PetscInt n,IS is[],PetscInt ov); 599d2b2a242SBarry Smith PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat,PetscBool); 6007b80b807SBarry Smith 601014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 602014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*); 603014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatMultNumeric(Mat,Mat,Mat); 60422440eb1SKris Buschelman 6057bab7c10SHong Zhang PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*); 6062df6c5c3SPatrick Farrell PETSC_EXTERN PetscErrorCode MatGalerkin(Mat,Mat,Mat,MatReuse,PetscReal,Mat*); 6077bab7c10SHong Zhang 608014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*); 609014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*); 610014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPtAPNumeric(Mat,Mat,Mat); 611014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*); 612014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRARtSymbolic(Mat,Mat,PetscReal,Mat*); 613014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRARtNumeric(Mat,Mat,Mat); 61422440eb1SKris Buschelman 615014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 616014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposetMatMultSymbolic(Mat,Mat,PetscReal,Mat*); 617014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposetMatMultNumeric(Mat,Mat,Mat); 618014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*); 619014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatTransposeMultSymbolic(Mat,Mat,PetscReal,Mat*); 620014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMatTransposeMultNumeric(Mat,Mat,Mat); 621bc011b1eSHong Zhang 622014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure); 623014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure); 6241c741599SHong Zhang 625014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar); 626014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar); 6277b80b807SBarry Smith 628014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping); 629014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*); 630a93ff8c4SPeter Brune PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat,PetscLayout*,PetscLayout*); 631014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 632014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec); 633014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 634014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec); 635014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 636014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 637052efed2SBarry Smith 638014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt); 639014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 64090f02eecSBarry Smith 641014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec); 642014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec); 643014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec); 6442a7a6963SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat,Vec*,Vec*); 64525ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatCreateVecs() (since version 3.6)") PETSC_STATIC_INLINE PetscErrorCode MatGetVecs(Mat mat,Vec *x,Vec *y) {return MatCreateVecs(mat,x,y);} 64653cd1579SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat,PetscInt,MPI_Comm,MatReuse,Mat*); 647014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*); 648014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*); 6493a062f41SBarry Smith PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat,IS*); 6509c8f2541SHong Zhang PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm,Mat,PetscInt,MatReuse,Mat*); 651bd481603SBarry Smith 652bd481603SBarry Smith /*MC 6531620fd73SBarry Smith MatSetValue - Set a single entry into a matrix. 6541620fd73SBarry Smith 6551620fd73SBarry Smith Not collective 6561620fd73SBarry Smith 657a9834a7dSSatish Balay Synopsis: 658a9834a7dSSatish Balay #include <petscmat.h> 659a9834a7dSSatish Balay PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode) 660a9834a7dSSatish Balay 6611620fd73SBarry Smith Input Parameters: 6621620fd73SBarry Smith + m - the matrix 6631620fd73SBarry Smith . row - the row location of the entry 6641620fd73SBarry Smith . col - the column location of the entry 6651620fd73SBarry Smith . value - the value to insert 6661620fd73SBarry Smith - mode - either INSERT_VALUES or ADD_VALUES 6671620fd73SBarry Smith 6681620fd73SBarry Smith Notes: 6691620fd73SBarry Smith For efficiency one should use MatSetValues() and set several or many 6701620fd73SBarry Smith values simultaneously if possible. 6711620fd73SBarry Smith 6721620fd73SBarry Smith Level: beginner 6731620fd73SBarry Smith 6741620fd73SBarry Smith .seealso: MatSetValues(), MatSetValueLocal() 6751620fd73SBarry Smith M*/ 6761620fd73SBarry Smith PETSC_STATIC_INLINE PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);} 6771620fd73SBarry Smith 6781620fd73SBarry Smith PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);} 6791620fd73SBarry Smith 6801620fd73SBarry Smith PETSC_STATIC_INLINE PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);} 6811620fd73SBarry Smith 6821620fd73SBarry Smith /*MC 6830d2a7ff2SSatish Balay MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per 684bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 685bd481603SBarry Smith 686bd481603SBarry Smith Synopsis: 687aaa7dc30SBarry Smith #include <petscmat.h> 688c1ac3661SBarry Smith PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 689bd481603SBarry Smith 690d083f849SBarry Smith Collective 691bd481603SBarry Smith 692bd481603SBarry Smith Input Parameters: 693bd481603SBarry Smith + comm - the communicator that will share the eventually allocated matrix 694859fcb39SBarry Smith . nrows - the number of LOCAL rows in the matrix 695859fcb39SBarry Smith - ncols - the number of LOCAL columns in the matrix 696bd481603SBarry Smith 697bd481603SBarry Smith Output Parameters: 698bd481603SBarry Smith + dnz - the array that will be passed to the matrix preallocation routines 699a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 700bd481603SBarry Smith 701bd481603SBarry Smith Level: intermediate 702bd481603SBarry Smith 703bd481603SBarry Smith Notes: 704a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 705bd481603SBarry Smith 7061d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 707bd481603SBarry Smith 7081620fd73SBarry Smith This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize(). 7091620fd73SBarry Smith 710d6e23781SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(), 711de25e9cbSPierre Jolivet MatPreallocateSymmetricSetLocalBlock() 712bd481603SBarry Smith M*/ 713c4f061fbSSatish Balay #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \ 714e83a5d19SLisandro Dalcin do { \ 715a6042fd4SStefano Zampini PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ncols = (ncols),__rstart,__start,__end; \ 7167282cfc1SLisandro Dalcin _4_ierr = PetscCalloc2((size_t)__nrows,&dnz,(size_t)__nrows,&onz);CHKERRQ(_4_ierr); \ 7171795a4d1SJed Brown __start = 0; __end = __start; \ 718a6042fd4SStefano Zampini _4_ierr = MPI_Scan(&__ncols,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ncols;\ 719e83a5d19SLisandro Dalcin _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows; \ 720e83a5d19SLisandro Dalcin do { } while(0) 7217c922b88SBarry Smith 722bd481603SBarry Smith /*MC 723bd481603SBarry Smith MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 724bd481603SBarry Smith inserted using a local number of the rows and columns 725bd481603SBarry Smith 726bd481603SBarry Smith Synopsis: 727aaa7dc30SBarry Smith #include <petscmat.h> 728c1ac3661SBarry Smith PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 729bd481603SBarry Smith 730bd481603SBarry Smith Not Collective 731bd481603SBarry Smith 732bd481603SBarry Smith Input Parameters: 733784ac674SJed Brown + map - the row mapping from local numbering to global numbering 734bd481603SBarry Smith . nrows - the number of rows indicated 7351d73ed98SBarry Smith . rows - the indices of the rows 736784ac674SJed Brown . cmap - the column mapping from local to global numbering 737bd481603SBarry Smith . ncols - the number of columns in the matrix 738bd481603SBarry Smith . cols - the columns indicated 739bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 740a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 741bd481603SBarry Smith 742bd481603SBarry Smith Level: intermediate 743bd481603SBarry Smith 744bd481603SBarry Smith Notes: 745a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 746bd481603SBarry Smith 7471d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 748bd481603SBarry Smith 749a6042fd4SStefano Zampini .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock() 750c1154cd5SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocalRemoveDups() 751bd481603SBarry Smith M*/ 752784ac674SJed Brown #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \ 753e83a5d19SLisandro Dalcin do {\ 754c1ac3661SBarry Smith PetscInt __l;\ 755784ac674SJed Brown _4_ierr = ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\ 756784ac674SJed Brown _4_ierr = ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\ 757c4f061fbSSatish Balay for (__l=0;__l<nrows;__l++) {\ 758ef66eb69SBarry Smith _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 759c4f061fbSSatish Balay }\ 760e83a5d19SLisandro Dalcin } while (0) 761c4f061fbSSatish Balay 762bd481603SBarry Smith /*MC 763c1154cd5SBarry Smith MatPreallocateSetLocalRemoveDups - Indicates the locations (rows and columns) in the matrix where nonzeros will be 764c1154cd5SBarry Smith inserted using a local number of the rows and columns. This version removes any duplicate columns in cols 765c1154cd5SBarry Smith 766c1154cd5SBarry Smith Synopsis: 767c1154cd5SBarry Smith #include <petscmat.h> 768c1154cd5SBarry Smith PetscErrorCode MatPreallocateSetLocalRemoveDups(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 769c1154cd5SBarry Smith 770c1154cd5SBarry Smith Not Collective 771c1154cd5SBarry Smith 772c1154cd5SBarry Smith Input Parameters: 773c1154cd5SBarry Smith + map - the row mapping from local numbering to global numbering 774c1154cd5SBarry Smith . nrows - the number of rows indicated 775c1154cd5SBarry Smith . rows - the indices of the rows (these values are mapped to the global values) 776c1154cd5SBarry Smith . cmap - the column mapping from local to global numbering 777c1154cd5SBarry Smith . ncols - the number of columns in the matrix (this value will be changed if duplicate columns are found) 778c1154cd5SBarry Smith . cols - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed) 779c1154cd5SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 780a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 781c1154cd5SBarry Smith 782c1154cd5SBarry Smith Level: intermediate 783c1154cd5SBarry Smith 784c1154cd5SBarry Smith Notes: 785c1154cd5SBarry Smith See Users-Manual: ch_performance for more details. 786c1154cd5SBarry Smith 787c1154cd5SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 788c1154cd5SBarry Smith 789a6042fd4SStefano Zampini .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock() 790c1154cd5SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal() 791c1154cd5SBarry Smith M*/ 792c1154cd5SBarry Smith #define MatPreallocateSetLocalRemoveDups(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \ 793e83a5d19SLisandro Dalcin do {\ 794c1154cd5SBarry Smith PetscInt __l;\ 795c1154cd5SBarry Smith _4_ierr = ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\ 796c1154cd5SBarry Smith _4_ierr = ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\ 797c1154cd5SBarry Smith _4_ierr = PetscSortRemoveDupsInt(&ncols,cols);CHKERRQ(_4_ierr);\ 798c1154cd5SBarry Smith for (__l=0;__l<nrows;__l++) {\ 799c1154cd5SBarry Smith _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 800c1154cd5SBarry Smith }\ 801e83a5d19SLisandro Dalcin } while (0) 802c1154cd5SBarry Smith 803c1154cd5SBarry Smith /*MC 804d6e23781SBarry Smith MatPreallocateSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 805bd481603SBarry Smith inserted using a local number of the rows and columns 806bd481603SBarry Smith 807bd481603SBarry Smith Synopsis: 808aaa7dc30SBarry Smith #include <petscmat.h> 809d6e23781SBarry Smith PetscErrorCode MatPreallocateSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 810d6e23781SBarry Smith 811d6e23781SBarry Smith Not Collective 812d6e23781SBarry Smith 813d6e23781SBarry Smith Input Parameters: 814d6e23781SBarry Smith + map - the row mapping from local numbering to global numbering 815d6e23781SBarry Smith . nrows - the number of rows indicated 816d6e23781SBarry Smith . rows - the indices of the rows 817d6e23781SBarry Smith . cmap - the column mapping from local to global numbering 818d6e23781SBarry Smith . ncols - the number of columns in the matrix 819d6e23781SBarry Smith . cols - the columns indicated 820d6e23781SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 821a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 822d6e23781SBarry Smith 823d6e23781SBarry Smith Level: intermediate 824d6e23781SBarry Smith 825d6e23781SBarry Smith Notes: 826d6e23781SBarry Smith See Users-Manual: ch_performance for more details. 827d6e23781SBarry Smith 828d6e23781SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 829d6e23781SBarry Smith 830a6042fd4SStefano Zampini .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock() 831d6e23781SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock() 832d6e23781SBarry Smith M*/ 833d6e23781SBarry Smith #define MatPreallocateSetLocalBlock(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \ 834e83a5d19SLisandro Dalcin do {\ 835d6e23781SBarry Smith PetscInt __l;\ 836d6e23781SBarry Smith _4_ierr = ISLocalToGlobalMappingApplyBlock(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\ 837d6e23781SBarry Smith _4_ierr = ISLocalToGlobalMappingApplyBlock(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\ 838d6e23781SBarry Smith for (__l=0;__l<nrows;__l++) {\ 839d6e23781SBarry Smith _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 840d6e23781SBarry Smith }\ 841e83a5d19SLisandro Dalcin } while (0) 842d6e23781SBarry Smith 843d6e23781SBarry Smith /*MC 844d6e23781SBarry Smith MatPreallocateSymmetricSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 845d6e23781SBarry Smith inserted using a local number of the rows and columns 846d6e23781SBarry Smith 847d6e23781SBarry Smith Synopsis: 848d6e23781SBarry Smith #include <petscmat.h> 849d6e23781SBarry Smith PetscErrorCode MatPreallocateSymmetricSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 850bd481603SBarry Smith 851bd481603SBarry Smith Not Collective 852bd481603SBarry Smith 853bd481603SBarry Smith Input Parameters: 854bd481603SBarry Smith + map - the mapping between local numbering and global numbering 855bd481603SBarry Smith . nrows - the number of rows indicated 8561d73ed98SBarry Smith . rows - the indices of the rows 857bd481603SBarry Smith . ncols - the number of columns in the matrix 858bd481603SBarry Smith . cols - the columns indicated 859bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 860a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 861bd481603SBarry Smith 862bd481603SBarry Smith Level: intermediate 863bd481603SBarry Smith 864bd481603SBarry Smith Notes: 865a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 866bd481603SBarry Smith 867bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 868bd481603SBarry Smith 869a6042fd4SStefano Zampini .seealso: MatPreallocateFinalize(), MatPreallocateSet() 870d6e23781SBarry Smith MatPreallocateInitialize(), MatPreallocateSetLocal() 871bd481603SBarry Smith M*/ 872d6e23781SBarry Smith #define MatPreallocateSymmetricSetLocalBlock(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 873e83a5d19SLisandro Dalcin do {\ 874c1ac3661SBarry Smith PetscInt __l;\ 875d6e23781SBarry Smith _4_ierr = ISLocalToGlobalMappingApplyBlock(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 876d6e23781SBarry Smith _4_ierr = ISLocalToGlobalMappingApplyBlock(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 877d3d32019SBarry Smith for (__l=0;__l<nrows;__l++) {\ 878d6e23781SBarry Smith _4_ierr = MatPreallocateSymmetricSetBlock((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 879d3d32019SBarry Smith }\ 880e83a5d19SLisandro Dalcin } while (0) 881e83a5d19SLisandro Dalcin 882bd481603SBarry Smith /*MC 883bd481603SBarry Smith MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 884bd481603SBarry Smith inserted using a local number of the rows and columns 885bd481603SBarry Smith 886bd481603SBarry Smith Synopsis: 887aaa7dc30SBarry Smith #include <petscmat.h> 888c1ac3661SBarry Smith PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 889bd481603SBarry Smith 890bd481603SBarry Smith Not Collective 891bd481603SBarry Smith 892bd481603SBarry Smith Input Parameters: 89364075487SBarry Smith + row - the row 894bd481603SBarry Smith . ncols - the number of columns in the matrix 895a50f8bf6SHong Zhang - cols - the columns indicated 896a50f8bf6SHong Zhang 897a50f8bf6SHong Zhang Output Parameters: 898a50f8bf6SHong Zhang + dnz - the array that will be passed to the matrix preallocation routines 899a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 900bd481603SBarry Smith 901bd481603SBarry Smith Level: intermediate 902bd481603SBarry Smith 903bd481603SBarry Smith Notes: 904a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 905bd481603SBarry Smith 906bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 907bd481603SBarry Smith 9081620fd73SBarry Smith This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize(). 9091620fd73SBarry Smith 910a6042fd4SStefano Zampini .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock() 911d6e23781SBarry Smith MatPreallocateInitialize(), MatPreallocateSetLocal() 912bd481603SBarry Smith M*/ 913c4f061fbSSatish Balay #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\ 914e83a5d19SLisandro Dalcin do { PetscInt __i; \ 915e32f2f54SBarry Smith if (row < __rstart) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D less than first local row %D",row,__rstart);\ 916e32f2f54SBarry Smith if (row >= __rstart+__nrows) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D greater than last local row %D",row,__rstart+__nrows-1);\ 9177c922b88SBarry Smith for (__i=0; __i<nc; __i++) {\ 91864075487SBarry Smith if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \ 919a6042fd4SStefano Zampini else if (dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\ 9207c922b88SBarry Smith }\ 921e83a5d19SLisandro Dalcin } while (0) 9227c922b88SBarry Smith 923bd481603SBarry Smith /*MC 924d6e23781SBarry Smith MatPreallocateSymmetricSetBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 925bd481603SBarry Smith inserted using a local number of the rows and columns 926bd481603SBarry Smith 927bd481603SBarry Smith Synopsis: 928aaa7dc30SBarry Smith #include <petscmat.h> 929d6e23781SBarry Smith PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 930bd481603SBarry Smith 931bd481603SBarry Smith Not Collective 932bd481603SBarry Smith 933bd481603SBarry Smith Input Parameters: 934bd481603SBarry Smith + nrows - the number of rows indicated 9351d73ed98SBarry Smith . rows - the indices of the rows 936bd481603SBarry Smith . ncols - the number of columns in the matrix 937bd481603SBarry Smith . cols - the columns indicated 938bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 939a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 940bd481603SBarry Smith 941bd481603SBarry Smith Level: intermediate 942bd481603SBarry Smith 943bd481603SBarry Smith Notes: 944a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 945bd481603SBarry Smith 946bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 947bd481603SBarry Smith 9481620fd73SBarry Smith This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize(). 9491620fd73SBarry Smith 950d6e23781SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateInitialize(), 951a6042fd4SStefano Zampini MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal() 952bd481603SBarry Smith M*/ 953d6e23781SBarry Smith #define MatPreallocateSymmetricSetBlock(row,nc,cols,dnz,onz) 0;\ 954e83a5d19SLisandro Dalcin do { PetscInt __i; \ 955d3d32019SBarry Smith for (__i=0; __i<nc; __i++) {\ 956d3d32019SBarry Smith if (cols[__i] >= __end) onz[row - __rstart]++; \ 957a6042fd4SStefano Zampini else if (cols[__i] >= row && dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\ 958d3d32019SBarry Smith }\ 959e83a5d19SLisandro Dalcin } while (0) 960d3d32019SBarry Smith 961bd481603SBarry Smith /*MC 962a6042fd4SStefano Zampini MatPreallocateLocation - An alternative to MatPreallocateSet() that puts the nonzero locations into the matrix if it exists 96316371a99SBarry Smith 96416371a99SBarry Smith Synopsis: 965aaa7dc30SBarry Smith #include <petscmat.h> 96616371a99SBarry Smith PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz) 96716371a99SBarry Smith 96816371a99SBarry Smith Not Collective 96916371a99SBarry Smith 97016371a99SBarry Smith Input Parameters: 971a2b725a8SWilliam Gropp + A - matrix 97216371a99SBarry Smith . row - row where values exist (must be local to this process) 97316371a99SBarry Smith . ncols - number of columns 97416371a99SBarry Smith . cols - columns with nonzeros 97516371a99SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 976a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 97716371a99SBarry Smith 97816371a99SBarry Smith Level: intermediate 97916371a99SBarry Smith 98016371a99SBarry Smith Notes: 981a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 98216371a99SBarry Smith 98316371a99SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 98416371a99SBarry Smith 98516371a99SBarry Smith This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines. 98616371a99SBarry Smith 987d6e23781SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(), 988d6e23781SBarry Smith MatPreallocateSymmetricSetLocalBlock() 98916371a99SBarry Smith M*/ 990e83a5d19SLisandro Dalcin #define MatPreallocateLocation(A,row,ncols,cols,dnz,onz) 0; do {if (A) {ierr = MatSetValues(A,1,&row,ncols,cols,NULL,INSERT_VALUES);CHKERRQ(ierr);} else {ierr = MatPreallocateSet(row,ncols,cols,dnz,onz);CHKERRQ(ierr);}} while(0) 99116371a99SBarry Smith 99216371a99SBarry Smith 99316371a99SBarry Smith /*MC 9940d2a7ff2SSatish Balay MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per 995bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 996bd481603SBarry Smith 997bd481603SBarry Smith Synopsis: 998aaa7dc30SBarry Smith #include <petscmat.h> 999c1ac3661SBarry Smith PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz) 1000bd481603SBarry Smith 1001d083f849SBarry Smith Collective 1002bd481603SBarry Smith 1003bd481603SBarry Smith Input Parameters: 100416371a99SBarry Smith + dnz - the array that was be passed to the matrix preallocation routines 1005a6042fd4SStefano Zampini - onz - the other array passed to the matrix preallocation routines 1006bd481603SBarry Smith 1007bd481603SBarry Smith Level: intermediate 1008bd481603SBarry Smith 1009bd481603SBarry Smith Notes: 1010a7f22e61SSatish Balay See Users-Manual: ch_performance for more details. 1011bd481603SBarry Smith 1012bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 1013bd481603SBarry Smith 10141620fd73SBarry Smith This is a MACRO not a function because it closes the { started in MatPreallocateInitialize(). 10151620fd73SBarry Smith 1016d6e23781SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(), 1017d6e23781SBarry Smith MatPreallocateSymmetricSetLocalBlock() 1018bd481603SBarry Smith M*/ 1019e83a5d19SLisandro Dalcin #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree2(dnz,onz);CHKERRQ(_4_ierr);} while(0) 10207c922b88SBarry Smith 10217b80b807SBarry Smith /* Routines unique to particular data structures */ 1022014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat,void *); 1023698d4c6aSKris Buschelman 1024014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*); 1025014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *); 1026698d4c6aSKris Buschelman 1027014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]); 1028014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]); 1029014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1030014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1031014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1032014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool); 10337b80b807SBarry Smith 1034a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4 1035a96a251dSBarry Smith 1036014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1037014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1038014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]); 1039273d9f13SBarry Smith 1040014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1041014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1042014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1043014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []); 1044014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 1045014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]); 1046014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 1047014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]); 1048b44e7856SBarry Smith PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat,Mat*); 1049014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]); 1050014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]); 10519230625dSJed Brown PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]); 10529230625dSJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]); 1053014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*); 1054273d9f13SBarry Smith 1055014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt); 105649a6ff4bSBarry Smith PETSC_EXTERN PetscErrorCode MatDenseGetLDA(Mat,PetscInt*); 1057014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*); 10581b807ce4Svictorle 1059621e819fSSatish Balay PETSC_EXTERN PetscErrorCode MatBlockMatSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1060621e819fSSatish Balay 1061014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatStoreValues(Mat); 1062014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat); 10632e8a6d31SBarry Smith 1064014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDAADSetCtx(Mat,void*); 10653a7fca6bSBarry Smith 1066014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*); 10677cfe41e4SPatrick Farrell PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat,IS*); 10687b80b807SBarry Smith /* 10697b80b807SBarry Smith These routines are not usually accessed directly, rather solving is 107094b7f48cSBarry Smith done through the KSP and PC interfaces. 10717b80b807SBarry Smith */ 10727b80b807SBarry Smith 107376bdecfbSBarry Smith /*J 10748f6c3df8SBarry Smith MatOrderingType - String with the name of a PETSc matrix ordering 1075d9274352SBarry Smith 1076d9274352SBarry Smith Level: beginner 1077d9274352SBarry Smith 1078d9274352SBarry Smith .seealso: MatGetOrdering() 107976bdecfbSBarry Smith J*/ 108019fd82e9SBarry Smith typedef const char* MatOrderingType; 10812692d6eeSBarry Smith #define MATORDERINGNATURAL "natural" 10822692d6eeSBarry Smith #define MATORDERINGND "nd" 10832692d6eeSBarry Smith #define MATORDERING1WD "1wd" 10842692d6eeSBarry Smith #define MATORDERINGRCM "rcm" 10852692d6eeSBarry Smith #define MATORDERINGQMD "qmd" 10862692d6eeSBarry Smith #define MATORDERINGROWLENGTH "rowlength" 1087510184a7SJed Brown #define MATORDERINGWBM "wbm" 1088fc1bef75SJed Brown #define MATORDERINGSPECTRAL "spectral" 1089312e372aSBarry Smith #define MATORDERINGAMD "amd" /* only works if UMFPACK is installed with PETSc */ 1090b12f92e5SBarry Smith 109119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*); 1092140e18c1SBarry Smith PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*); 1093bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*)); 1094140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList MatOrderingList; 1095d4fbbf0eSBarry Smith 1096014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS); 1097fc1bef75SJed Brown PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*); 1098a2ce50c7SBarry Smith 1099d91e6319SBarry Smith /*S 1100d90ac83dSHong Zhang MatFactorShiftType - Numeric Shift. 1101d90ac83dSHong Zhang 1102d90ac83dSHong Zhang Level: beginner 1103d90ac83dSHong Zhang 1104d90ac83dSHong Zhang S*/ 1105d90ac83dSHong Zhang typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType; 11066a6fc655SJed Brown PETSC_EXTERN const char *const MatFactorShiftTypes[]; 11075e9742b9SJed Brown PETSC_EXTERN const char *const MatFactorShiftTypesDetail[]; 1108d90ac83dSHong Zhang 1109d90ac83dSHong Zhang /*S 11109aa7eafdSHong Zhang MatFactorError - indicates what type of error in matrix factor 11119aa7eafdSHong Zhang 11129aa7eafdSHong Zhang Level: beginner 11139aa7eafdSHong Zhang 111495452b02SPatrick Sanan Developer Notes: 111595452b02SPatrick Sanan Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 111600e125f8SBarry Smith 111700e125f8SBarry Smith .seealso: MatGetFactor() 11189aa7eafdSHong Zhang S*/ 11195cd7cf9dSHong Zhang typedef enum {MAT_FACTOR_NOERROR,MAT_FACTOR_STRUCT_ZEROPIVOT,MAT_FACTOR_NUMERIC_ZEROPIVOT,MAT_FACTOR_OUTMEMORY,MAT_FACTOR_OTHER} MatFactorError; 11209aa7eafdSHong Zhang 112100e125f8SBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat,MatFactorError*); 1122b8b68cfdSBarry Smith PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat); 11237b6c816cSBarry Smith PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat,PetscReal*,PetscInt*); 112400e125f8SBarry Smith 11259aa7eafdSHong Zhang /*S 1126422a814eSBarry Smith MatFactorInfo - Data passed into the matrix factorization routines, and information about the resulting factorization 1127b00f7748SHong Zhang 112861cad860SBarry Smith In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use 112961cad860SBarry Smith $ MatFactorInfo info(MAT_FACTORINFO_SIZE) 1130b00f7748SHong Zhang 113195452b02SPatrick Sanan Notes: 113295452b02SPatrick Sanan These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC. 1133b00f7748SHong Zhang 113461cad860SBarry Smith You can use MatFactorInfoInitialize() to set default values. 113561cad860SBarry Smith 1136b00f7748SHong Zhang Level: developer 1137b00f7748SHong Zhang 1138d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(), 1139d7d82daaSBarry Smith MatFactorInfoInitialize() 1140b00f7748SHong Zhang 1141b00f7748SHong Zhang S*/ 1142b00f7748SHong Zhang typedef struct { 114315e8a5b3SHong Zhang PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 114485317021SBarry Smith PetscReal usedt; 114515e8a5b3SHong Zhang PetscReal dt; /* drop tolerance */ 1146b00f7748SHong Zhang PetscReal dtcol; /* tolerance for pivoting */ 114715e8a5b3SHong Zhang PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 114867e28bfeSBarry Smith PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */ 1149348344bbSBarry Smith PetscReal levels; /* ICC/ILU(levels) */ 1150bcd9e38bSBarry Smith PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 1151bcd9e38bSBarry Smith factorization may be faster if do not pivot */ 115215e8a5b3SHong Zhang PetscReal zeropivot; /* pivot is called zero if less than this */ 1153f4db908eSBarry Smith PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */ 1154f4db908eSBarry Smith PetscReal shiftamount; /* how large the shift is */ 115515e8a5b3SHong Zhang } MatFactorInfo; 1156ffa6d0a5SLois Curfman McInnes 1157014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*); 11589a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*); 11599a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 11609a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*); 11619a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*); 11629a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*); 11639a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 11649a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 11659a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 11669a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*); 11679a625307SHong Zhang PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*); 1168014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*); 1169014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec); 1170014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec); 1171014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec); 1172014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec); 1173014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec); 1174014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec); 1175014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs); 11767c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat); 11777c2f51b8SStefano Zampini 11787c2f51b8SStefano Zampini typedef enum {MAT_FACTOR_SCHUR_UNFACTORED, MAT_FACTOR_SCHUR_FACTORED, MAT_FACTOR_SCHUR_INVERTED} MatFactorSchurStatus; 11798e7ba810SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat,IS); 11807c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat,Mat*,MatFactorSchurStatus*); 11817c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat,Mat*,MatFactorSchurStatus); 11825a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat); 11837c2f51b8SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat,Mat*,MatFactorSchurStatus*); 11845a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat,Vec,Vec); 11855a05ddb0SStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat,Vec,Vec); 11866dba178dSStefano Zampini PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat); 1187bb5a7306SBarry Smith 1188d91e6319SBarry Smith /*E 1189d91e6319SBarry Smith MatSORType - What type of (S)SOR to perform 1190bb1eb677SSatish Balay 1191d91e6319SBarry Smith Level: beginner 1192d91e6319SBarry Smith 1193d9274352SBarry Smith May be bitwise ORd together 1194d9274352SBarry Smith 1195af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 1196d91e6319SBarry Smith 11974e7234bfSBarry Smith MatSORType may be bitwise ORd together, so do not change the numbers 11984e7234bfSBarry Smith 119941f059aeSBarry Smith .seealso: MatSOR() 1200d91e6319SBarry Smith E*/ 1201ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 1202ee50ffe9SBarry Smith SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 1203ee50ffe9SBarry Smith SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 120484cb2905SBarry Smith SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType; 1205014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 12068ed539a5SBarry Smith 1207d4fbbf0eSBarry Smith /* 1208639f9d9dSBarry Smith These routines are for efficiently computing Jacobians via finite differences. 1209639f9d9dSBarry Smith */ 1210b12f92e5SBarry Smith 12117086a01eSPeter Brune /*S 12127086a01eSPeter Brune MatColoring - Object for managing the coloring of matrices. 12137086a01eSPeter Brune 12147086a01eSPeter Brune Level: beginner 12157086a01eSPeter Brune 12167086a01eSPeter Brune .seealso: MatFDColoringCreate() ISColoring MatFDColoring 12177086a01eSPeter Brune S*/ 12187086a01eSPeter Brune typedef struct _p_MatColoring* MatColoring; 121976bdecfbSBarry Smith /*J 12208f6c3df8SBarry Smith MatColoringType - String with the name of a PETSc matrix coloring 1221d9274352SBarry Smith 1222d9274352SBarry Smith Level: beginner 1223d9274352SBarry Smith 12247086a01eSPeter Brune .seealso: MatColoringSetType(), MatColoring 122576bdecfbSBarry Smith J*/ 12267086a01eSPeter Brune 122719fd82e9SBarry Smith typedef const char* MatColoringType; 12285567d71aSPeter Brune #define MATCOLORINGJP "jp" 1229b9acb617SPeter Brune #define MATCOLORINGPOWER "power" 12302692d6eeSBarry Smith #define MATCOLORINGNATURAL "natural" 12312692d6eeSBarry Smith #define MATCOLORINGSL "sl" 12322692d6eeSBarry Smith #define MATCOLORINGLF "lf" 12332692d6eeSBarry Smith #define MATCOLORINGID "id" 12348121bdceSPeter Brune #define MATCOLORINGGREEDY "greedy" 1235b12f92e5SBarry Smith 12368ac6da0aSPeter Brune /*E 12378ac6da0aSPeter Brune MatColoringWeightType - Type of weight scheme 12388ac6da0aSPeter Brune 12398ac6da0aSPeter Brune Not Collective 12408ac6da0aSPeter Brune 12418ac6da0aSPeter Brune + MAT_COLORING_RANDOM - Random weights 12428ac6da0aSPeter Brune . MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering. 12438ac6da0aSPeter Brune - MAT_COLORING_LF - Last-first weighting. 12448ac6da0aSPeter Brune 12458ac6da0aSPeter Brune Level: intermediate 12468ac6da0aSPeter Brune 1247af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 12488ac6da0aSPeter Brune E*/ 1249301c140bSPeter Brune typedef enum {MAT_COLORING_WEIGHT_RANDOM,MAT_COLORING_WEIGHT_LEXICAL,MAT_COLORING_WEIGHT_LF,MAT_COLORING_WEIGHT_SL} MatColoringWeightType; 12508ac6da0aSPeter Brune 1251335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*); 1252d7f2a307SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*); 1253335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*); 1254335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer); 1255335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType); 1256335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring); 1257335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt); 1258335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*); 1259335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt); 1260335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*); 1261335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*); 1262335efc43SPeter Brune PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring)); 1263014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*); 12648ac6da0aSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType); 1265c29971fcSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*); 12668ac6da0aSPeter Brune PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm); 1267bc76d17bSHong Zhang PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring,ISColoring); 126825ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatColoringTest() (since version 3.10)") PETSC_STATIC_INLINE PetscErrorCode MatColoringTestValid(MatColoring matcoloring,ISColoring iscoloring) {return MatColoringTest(matcoloring,iscoloring);} 1269bc76d17bSHong Zhang PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat,ISColoring); 1270639f9d9dSBarry Smith 1271d9274352SBarry Smith /*S 1272d9274352SBarry Smith MatFDColoring - Object for computing a sparse Jacobian via finite differences 1273d9274352SBarry Smith and coloring 1274639f9d9dSBarry Smith 1275d9274352SBarry Smith Level: beginner 1276d9274352SBarry Smith 1277d9274352SBarry Smith .seealso: MatFDColoringCreate() 1278d9274352SBarry Smith S*/ 1279e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring; 1280639f9d9dSBarry Smith 1281014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *); 1282014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*); 1283014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer); 1284014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*); 1285014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**); 1286014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal); 1287014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring); 1288d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *); 1289014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec); 1290edaa7c33SBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,const PetscInt*[]); 1291f86b9fbaSHong Zhang PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring); 1292f86b9fbaSHong Zhang PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt); 1293*bdaf1daeSBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringSetValues(Mat,MatFDColoring,const PetscScalar*); 1294b1683b59SHong Zhang 1295b1683b59SHong Zhang /*S 1296b9af6bddSHong Zhang MatTransposeColoring - Object for computing a sparse matrix product C=A*B^T via coloring 1297b1683b59SHong Zhang 1298b1683b59SHong Zhang Level: beginner 1299b1683b59SHong Zhang 1300b9af6bddSHong Zhang .seealso: MatTransposeColoringCreate() 1301b1683b59SHong Zhang S*/ 1302b9af6bddSHong Zhang typedef struct _p_MatTransposeColoring* MatTransposeColoring; 1303b1683b59SHong Zhang 1304014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *); 1305014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat); 1306014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat); 1307014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*); 1308b1683b59SHong Zhang 1309639f9d9dSBarry Smith /* 13100752156aSBarry Smith These routines are for partitioning matrices: currently used only 13113eda8832SBarry Smith for adjacency matrix, MatCreateMPIAdj(). 13120752156aSBarry Smith */ 1313ca161407SBarry Smith 1314d9274352SBarry Smith /*S 1315d9274352SBarry Smith MatPartitioning - Object for managing the partitioning of a matrix or graph 1316d9274352SBarry Smith 1317d9274352SBarry Smith Level: beginner 1318d9274352SBarry Smith 1319743a1026Svictorle .seealso: MatPartitioningCreate(), MatPartitioningType 1320d9274352SBarry Smith S*/ 132191e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning; 1322d9274352SBarry Smith 132376bdecfbSBarry Smith /*J 13248f6c3df8SBarry Smith MatPartitioningType - String with the name of a PETSc matrix partitioning 1325d9274352SBarry Smith 1326d9274352SBarry Smith Level: beginner 13270d04baf8SBarry Smith dm 1328b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning 132976bdecfbSBarry Smith J*/ 133019fd82e9SBarry Smith typedef const char* MatPartitioningType; 13312692d6eeSBarry Smith #define MATPARTITIONINGCURRENT "current" 1332aa1e27eaSFande Kong #define MATPARTITIONINGAVERAGE "average" 13332692d6eeSBarry Smith #define MATPARTITIONINGSQUARE "square" 13342692d6eeSBarry Smith #define MATPARTITIONINGPARMETIS "parmetis" 13352692d6eeSBarry Smith #define MATPARTITIONINGCHACO "chaco" 13362692d6eeSBarry Smith #define MATPARTITIONINGPARTY "party" 133750d91057SBarry Smith #define MATPARTITIONINGPTSCOTCH "ptscotch" 133888d2ac2bSFande Kong #define MATPARTITIONINGHIERARCH "hierarch" 133971306c60Sjroman 1340ca161407SBarry Smith 1341014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*); 134219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType); 1343014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt); 1344014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat); 1345014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]); 1346014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []); 1347014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*); 1348fdd1c351SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningImprove(MatPartitioning,IS*); 1349668144dbSFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningViewImbalance(MatPartitioning,IS); 1350f3ad2dabSStefano Zampini PETSC_EXTERN PetscErrorCode MatPartitioningApplyND(MatPartitioning,IS*); 1351014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*); 13522aabb6bbSBarry Smith 1353bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[],PetscErrorCode (*)(MatPartitioning)); 135430de9b25SBarry Smith 1355f1144a30SSatish Balay 13562bad1931SBarry Smith 1357014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer); 1358854f7285SStefano Zampini PETSC_STATIC_INLINE PetscErrorCode MatPartitioningViewFromOptions(MatPartitioning A,PetscObject B,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,B,name);} 1359854f7285SStefano Zampini 1360014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning); 136119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*); 1362ca161407SBarry Smith 136327538973SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part); 1364014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 1365014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *); 13660752156aSBarry Smith 1367b6956c12SJose Roman typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType; 13686a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoGlobalTypes[]; 1369b6956c12SJose Roman typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType; 13706a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoLocalTypes[]; 1371b6956c12SJose Roman typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType; 13726a6fc655SJed Brown PETSC_EXTERN const char *const MPChacoEigenTypes[]; 1373b6956c12SJose Roman 1374014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType); 1375014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*); 1376014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType); 1377014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*); 1378014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal); 1379014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType); 1380014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*); 1381014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal); 1382014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*); 1383014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt); 1384014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*); 138571306c60Sjroman 138671306c60Sjroman #define MP_PARTY_OPT "opt" 138771306c60Sjroman #define MP_PARTY_LIN "lin" 138871306c60Sjroman #define MP_PARTY_SCA "sca" 138971306c60Sjroman #define MP_PARTY_RAN "ran" 139071306c60Sjroman #define MP_PARTY_GBF "gbf" 139171306c60Sjroman #define MP_PARTY_GCF "gcf" 139271306c60Sjroman #define MP_PARTY_BUB "bub" 139371306c60Sjroman #define MP_PARTY_DEF "def" 1394014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*); 139571306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs" 139671306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl" 139771306c60Sjroman #define MP_PARTY_NONE "no" 1398014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*); 1399014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal); 1400014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool); 1401014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool); 140271306c60Sjroman 1403b0ca845eSVaclav Hapla typedef enum { MP_PTSCOTCH_DEFAULT,MP_PTSCOTCH_QUALITY,MP_PTSCOTCH_SPEED,MP_PTSCOTCH_BALANCE,MP_PTSCOTCH_SAFETY,MP_PTSCOTCH_SCALABILITY } MPPTScotchStrategyType; 14046a6fc655SJed Brown PETSC_EXTERN const char *const MPPTScotchStrategyTypes[]; 1405e0f1cffaSJose Roman 1406014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal); 1407014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*); 1408014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType); 1409014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*); 141071306c60Sjroman 1411b43b03e9SMark F. Adams /* 14126294fa2bSFande Kong * hierarchical partitioning 14136294fa2bSFande Kong */ 14144e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning,IS*); 14154e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning,IS*); 14164e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning,PetscInt); 14174e713f55SFande Kong PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt); 14186294fa2bSFande Kong 1419014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*); 1420014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*); 1421591294e4SBarry Smith 14220752156aSBarry Smith /* 1423af0996ceSBarry Smith If you add entries here you must also add them to petsc/finclude/petscmat.h 1424d4fbbf0eSBarry Smith */ 14251c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0, 14261c1c02c0SLois Curfman McInnes MATOP_GET_ROW=1, 14271c1c02c0SLois Curfman McInnes MATOP_RESTORE_ROW=2, 14281c1c02c0SLois Curfman McInnes MATOP_MULT=3, 14291c1c02c0SLois Curfman McInnes MATOP_MULT_ADD=4, 14307c922b88SBarry Smith MATOP_MULT_TRANSPOSE=5, 14317c922b88SBarry Smith MATOP_MULT_TRANSPOSE_ADD=6, 14321c1c02c0SLois Curfman McInnes MATOP_SOLVE=7, 14331c1c02c0SLois Curfman McInnes MATOP_SOLVE_ADD=8, 14347c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE=9, 14357c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE_ADD=10, 14361c1c02c0SLois Curfman McInnes MATOP_LUFACTOR=11, 14371c1c02c0SLois Curfman McInnes MATOP_CHOLESKYFACTOR=12, 1438a714c06dSBarry Smith MATOP_SOR=13, 14391c1c02c0SLois Curfman McInnes MATOP_TRANSPOSE=14, 14401c1c02c0SLois Curfman McInnes MATOP_GETINFO=15, 14411c1c02c0SLois Curfman McInnes MATOP_EQUAL=16, 14421c1c02c0SLois Curfman McInnes MATOP_GET_DIAGONAL=17, 14431c1c02c0SLois Curfman McInnes MATOP_DIAGONAL_SCALE=18, 14441c1c02c0SLois Curfman McInnes MATOP_NORM=19, 14451c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_BEGIN=20, 14461c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_END=21, 1447d519adbfSMatthew Knepley MATOP_SET_OPTION=22, 1448d519adbfSMatthew Knepley MATOP_ZERO_ENTRIES=23, 1449d519adbfSMatthew Knepley MATOP_ZERO_ROWS=24, 1450d519adbfSMatthew Knepley MATOP_LUFACTOR_SYMBOLIC=25, 1451d519adbfSMatthew Knepley MATOP_LUFACTOR_NUMERIC=26, 1452d519adbfSMatthew Knepley MATOP_CHOLESKY_FACTOR_SYMBOLIC=27, 1453d519adbfSMatthew Knepley MATOP_CHOLESKY_FACTOR_NUMERIC=28, 1454d519adbfSMatthew Knepley MATOP_SETUP_PREALLOCATION=29, 1455d519adbfSMatthew Knepley MATOP_ILUFACTOR_SYMBOLIC=30, 1456d519adbfSMatthew Knepley MATOP_ICCFACTOR_SYMBOLIC=31, 1457a5b7ff6bSBarry Smith MATOP_GET_DIAGONAL_BLOCK=32, 1458dd4011a9SHong Zhang MATOP_FREE_INTER_STRUCT=33, 1459d519adbfSMatthew Knepley MATOP_DUPLICATE=34, 1460d519adbfSMatthew Knepley MATOP_FORWARD_SOLVE=35, 1461d519adbfSMatthew Knepley MATOP_BACKWARD_SOLVE=36, 1462d519adbfSMatthew Knepley MATOP_ILUFACTOR=37, 1463d519adbfSMatthew Knepley MATOP_ICCFACTOR=38, 1464d519adbfSMatthew Knepley MATOP_AXPY=39, 14657dae84e0SHong Zhang MATOP_CREATE_SUBMATRICES=40, 1466d519adbfSMatthew Knepley MATOP_INCREASE_OVERLAP=41, 1467d519adbfSMatthew Knepley MATOP_GET_VALUES=42, 1468d519adbfSMatthew Knepley MATOP_COPY=43, 1469d519adbfSMatthew Knepley MATOP_GET_ROW_MAX=44, 1470d519adbfSMatthew Knepley MATOP_SCALE=45, 1471d519adbfSMatthew Knepley MATOP_SHIFT=46, 147235153367SBarry Smith MATOP_DIAGONAL_SET=47, 14739d39f69dSJed Brown MATOP_ZERO_ROWS_COLUMNS=48, 14749d39f69dSJed Brown MATOP_SET_RANDOM=49, 1475d519adbfSMatthew Knepley MATOP_GET_ROW_IJ=50, 1476d519adbfSMatthew Knepley MATOP_RESTORE_ROW_IJ=51, 1477d519adbfSMatthew Knepley MATOP_GET_COLUMN_IJ=52, 1478d519adbfSMatthew Knepley MATOP_RESTORE_COLUMN_IJ=53, 1479d519adbfSMatthew Knepley MATOP_FDCOLORING_CREATE=54, 1480d519adbfSMatthew Knepley MATOP_COLORING_PATCH=55, 1481d519adbfSMatthew Knepley MATOP_SET_UNFACTORED=56, 1482d519adbfSMatthew Knepley MATOP_PERMUTE=57, 1483d519adbfSMatthew Knepley MATOP_SET_VALUES_BLOCKED=58, 14847dae84e0SHong Zhang MATOP_CREATE_SUBMATRIX=59, 1485d519adbfSMatthew Knepley MATOP_DESTROY=60, 1486d519adbfSMatthew Knepley MATOP_VIEW=61, 1487d519adbfSMatthew Knepley MATOP_CONVERT_FROM=62, 14887bab7c10SHong Zhang MATOP_MATMAT_MULT=63, 14897bab7c10SHong Zhang MATOP_MATMAT_MULT_SYMBOLIC=64, 14907bab7c10SHong Zhang MATOP_MATMAT_MULT_NUMERIC=65, 1491d519adbfSMatthew Knepley MATOP_SET_LOCAL_TO_GLOBAL_MAP=66, 1492d519adbfSMatthew Knepley MATOP_SET_VALUES_LOCAL=67, 1493d519adbfSMatthew Knepley MATOP_ZERO_ROWS_LOCAL=68, 1494d519adbfSMatthew Knepley MATOP_GET_ROW_MAX_ABS=69, 1495d519adbfSMatthew Knepley MATOP_GET_ROW_MIN_ABS=70, 1496d519adbfSMatthew Knepley MATOP_CONVERT=71, 1497d519adbfSMatthew Knepley MATOP_SET_COLORING=72, 14989d39f69dSJed Brown /* MATOP_PLACEHOLDER_73=73, */ 1499d519adbfSMatthew Knepley MATOP_SET_VALUES_ADIFOR=74, 1500d519adbfSMatthew Knepley MATOP_FD_COLORING_APPLY=75, 1501d519adbfSMatthew Knepley MATOP_SET_FROM_OPTIONS=76, 1502bda6c4cbSBarry Smith MATOP_MULT_CONSTRAINED=77, 1503bda6c4cbSBarry Smith MATOP_MULT_TRANSPOSE_CONSTRAIN=78, 15049d39f69dSJed Brown MATOP_FIND_ZERO_DIAGONALS=79, 1505d519adbfSMatthew Knepley MATOP_MULT_MULTIPLE=80, 1506d519adbfSMatthew Knepley MATOP_SOLVE_MULTIPLE=81, 1507d519adbfSMatthew Knepley MATOP_GET_INERTIA=82, 1508d519adbfSMatthew Knepley MATOP_LOAD=83, 1509d519adbfSMatthew Knepley MATOP_IS_SYMMETRIC=84, 1510d519adbfSMatthew Knepley MATOP_IS_HERMITIAN=85, 1511d519adbfSMatthew Knepley MATOP_IS_STRUCTURALLY_SYMMETRIC=86, 1512820469bcSHong Zhang MATOP_SET_VALUES_BLOCKEDLOCAL=87, 1513b41ce5d5SBarry Smith MATOP_CREATE_VECS=88, 1514d519adbfSMatthew Knepley MATOP_MAT_MULT=89, 1515d519adbfSMatthew Knepley MATOP_MAT_MULT_SYMBOLIC=90, 1516d519adbfSMatthew Knepley MATOP_MAT_MULT_NUMERIC=91, 1517d519adbfSMatthew Knepley MATOP_PTAP=92, 1518d519adbfSMatthew Knepley MATOP_PTAP_SYMBOLIC=93, 1519d519adbfSMatthew Knepley MATOP_PTAP_NUMERIC=94, 1520bda6c4cbSBarry Smith MATOP_MAT_TRANSPOSE_MULT=95, 1521bda6c4cbSBarry Smith MATOP_MAT_TRANSPOSE_MULT_SYMBO=96, 1522bda6c4cbSBarry Smith MATOP_MAT_TRANSPOSE_MULT_NUMER=97, 15239d39f69dSJed Brown /* MATOP_PLACEHOLDER_98=98, */ 15249d39f69dSJed Brown /* MATOP_PLACEHOLDER_99=99, */ 15259d39f69dSJed Brown /* MATOP_PLACEHOLDER_100=100, */ 15269d39f69dSJed Brown /* MATOP_PLACEHOLDER_101=101, */ 1527d519adbfSMatthew Knepley MATOP_CONJUGATE=102, 15289d39f69dSJed Brown /* MATOP_PLACEHOLDER_103=103, */ 1529d519adbfSMatthew Knepley MATOP_SET_VALUES_ROW=104, 1530d519adbfSMatthew Knepley MATOP_REAL_PART=105, 1531bda6c4cbSBarry Smith MATOP_IMAGINARY_PART=106, 1532bda6c4cbSBarry Smith MATOP_GET_ROW_UPPER_TRIANGULAR=107, 1533bda6c4cbSBarry Smith MATOP_RESTORE_ROW_UPPER_TRIANG=108, 1534bda6c4cbSBarry Smith MATOP_MAT_SOLVE=109, 153529eadf9eSStefano Zampini MATOP_MAT_SOLVE_TRANSPOSE=110, 1536d519adbfSMatthew Knepley MATOP_GET_ROW_MIN=111, 15370e8d04f7SBarry Smith MATOP_GET_COLUMN_VECTOR=112, 1538d519adbfSMatthew Knepley MATOP_MISSING_DIAGONAL=113, 15390e8d04f7SBarry Smith MATOP_GET_SEQ_NONZERO_STRUCTUR=114, 154089c6957cSBarry Smith MATOP_CREATE=115, 154189c6957cSBarry Smith MATOP_GET_GHOSTS=116, 15420e8d04f7SBarry Smith MATOP_GET_LOCAL_SUB_MATRIX=117, 15430e8d04f7SBarry Smith MATOP_RESTORE_LOCALSUB_MATRIX=118, 1544eeffb40dSHong Zhang MATOP_MULT_DIAGONAL_BLOCK=119, 15450e8d04f7SBarry Smith MATOP_HERMITIAN_TRANSPOSE=120, 15460e8d04f7SBarry Smith MATOP_MULT_HERMITIAN_TRANSPOSE=121, 15470e8d04f7SBarry Smith MATOP_MULT_HERMITIAN_TRANS_ADD=122, 15480e8d04f7SBarry Smith MATOP_GET_MULTI_PROC_BLOCK=123, 15499d39f69dSJed Brown MATOP_FIND_NONZERO_ROWS=124, 15500e8d04f7SBarry Smith MATOP_GET_COLUMN_NORMS=125, 15519d39f69dSJed Brown MATOP_INVERT_BLOCK_DIAGONAL=126, 15529d39f69dSJed Brown /* MATOP_PLACEHOLDER_127=127, */ 1553b41ce5d5SBarry Smith MATOP_CREATE_SUB_MATRICES_MPI=128, 15542b8ad9a3SHong Zhang MATOP_SET_VALUES_BATCH=129, 15550e8d04f7SBarry Smith MATOP_TRANSPOSE_MAT_MULT=130, 15560e8d04f7SBarry Smith MATOP_TRANSPOSE_MAT_MULT_SYMBO=131, 1557e9b602ebSSatish Balay MATOP_TRANSPOSE_MAT_MULT_NUMER=132, 15580e8d04f7SBarry Smith MATOP_TRANSPOSE_COLORING_CREAT=133, 15590e8d04f7SBarry Smith MATOP_TRANS_COLORING_APPLY_SPT=134, 15600e8d04f7SBarry Smith MATOP_TRANS_COLORING_APPLY_DEN=135, 15610e8d04f7SBarry Smith MATOP_RART=136, 15620e8d04f7SBarry Smith MATOP_RART_SYMBOLIC=137, 15630e8d04f7SBarry Smith MATOP_RART_NUMERIC=138, 1564e09a3074SHong Zhang MATOP_SET_BLOCK_SIZES=139, 1565f9426fe0SMark Adams MATOP_AYPX=140, 15661919a2e2SJed Brown MATOP_RESIDUAL=141, 15679c8f2541SHong Zhang MATOP_FDCOLORING_SETUP=142, 15682d033e1fSHong Zhang MATOP_MPICONCATENATESEQ=144, 15692d033e1fSHong Zhang MATOP_DESTROYSUBMATRICES=145 1570fae171e0SBarry Smith } MatOperation; 15710c0fd78eSBarry Smith PETSC_EXTERN PetscErrorCode MatSetOperation(Mat,MatOperation,void(*)(void)); 1572976e8c5aSLisandro Dalcin PETSC_EXTERN PetscErrorCode MatGetOperation(Mat,MatOperation,void(**)(void)); 1573976e8c5aSLisandro Dalcin PETSC_EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool *); 157494342113SStefano Zampini PETSC_EXTERN PetscErrorCode MatHasCongruentLayouts(Mat,PetscBool *); 1575dd4011a9SHong Zhang PETSC_EXTERN PetscErrorCode MatFreeIntermediateDataStructures(Mat); 1576976e8c5aSLisandro Dalcin 1577014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void)); 1578014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void)); 1579014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*); 1580f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*); 1581f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*); 15820c0fd78eSBarry Smith PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat); 1583112a2221SBarry Smith 158490ace30eSBarry Smith /* 158590ace30eSBarry Smith Codes for matrices stored on disk. By default they are 158690ace30eSBarry Smith stored in a universal format. By changing the format with 15876a9046bcSBarry Smith PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will 158890ace30eSBarry Smith be stored in a way natural for the matrix, for example dense matrices 158990ace30eSBarry Smith would be stored as dense. Matrices stored this way may only be 1590f4403165SShri Abhyankar read into matrices of the same type. 159190ace30eSBarry Smith */ 159290ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1 159390ace30eSBarry Smith 1594014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal); 159575d48cdbSStefano Zampini 15968546b261SStefano Zampini PETSC_EXTERN PetscErrorCode MatISSetLocalMatType(Mat,MatType); 159775d48cdbSStefano Zampini PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 159875d48cdbSStefano Zampini PETSC_EXTERN PetscErrorCode MatISStoreL2L(Mat,PetscBool); 1599f03112d0SStefano Zampini PETSC_EXTERN PetscErrorCode MatISFixLocalEmpty(Mat,PetscBool); 1600014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*); 16013b3b1effSJed Brown PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat,Mat*); 1602014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat); 160325ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use the MatConvert() interface (since version 3.10)") PetscErrorCode MatISGetMPIXAIJ(Mat,MatReuse,Mat*); 16041f4e1ec7SBarry Smith 1605d9274352SBarry Smith /*S 1606d9274352SBarry Smith MatNullSpace - Object that removes a null space from a vector, i.e. 1607d9274352SBarry Smith orthogonalizes the vector to a subsapce 1608d9274352SBarry Smith 1609f7a9e4ceSBarry Smith Level: advanced 1610d9274352SBarry Smith 16116e1639daSBarry Smith Users manual sections: 16126e1639daSBarry Smith . sec_singular 16136e1639daSBarry Smith 1614d9274352SBarry Smith .seealso: MatNullSpaceCreate() 1615d9274352SBarry Smith S*/ 161674637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace; 1617d9274352SBarry Smith 1618014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*); 1619014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*); 1620014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*); 1621d0195637SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec); 1622014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *); 16235fa7ec2dSBarry Smith PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *); 16245fa7ec2dSBarry Smith PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat,MatNullSpace); 1625014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace); 1626014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace); 1627014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*); 1628014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool *); 1629014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer); 1630014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**); 1631014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*); 163274637425SBarry Smith 1633014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS); 1634014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal); 1635014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *); 1636014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat); 16373f1d51d7SBarry Smith 1638014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*); 1639014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*); 1640014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*); 1641c4f061fbSSatish Balay 16420bacdadaSStefano Zampini PETSC_EXTERN PetscErrorCode MatComputeOperator(Mat,MatType,Mat*); 16430bacdadaSStefano Zampini PETSC_EXTERN PetscErrorCode MatComputeOperatorTranspose(Mat,MatType,Mat*); 16440bacdadaSStefano Zampini 164525ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatComputeOperator() (since version 3.12)") PETSC_STATIC_INLINE PetscErrorCode MatComputeExplicitOperator(Mat A,Mat* B) { return MatComputeOperator(A,NULL,B); } 164625ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatComputeOperatorTranspose() (since version 3.12)") PETSC_STATIC_INLINE PetscErrorCode MatComputeExplicitOperatorTranspose(Mat A,Mat* B) { return MatComputeOperatorTranspose(A,NULL,B); } 1647b0a32e0cSBarry Smith 164849bd79ccSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode MatCreateKAIJ(Mat,PetscInt,PetscInt,const PetscScalar[],const PetscScalar[],Mat*); 164949bd79ccSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode MatKAIJGetAIJ(Mat,Mat*); 1650a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetS(Mat,PetscInt*,PetscInt*,PetscScalar**); 1651a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetSRead(Mat,PetscInt*,PetscInt*,const PetscScalar**); 1652a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreS(Mat,PetscScalar**); 1653a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreSRead(Mat,const PetscScalar**); 1654a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetT(Mat,PetscInt*,PetscInt*,PetscScalar**); 1655a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJGetTRead(Mat,PetscInt*,PetscInt*,const PetscScalar**); 1656a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreT(Mat,PetscScalar**); 1657a5b5c723SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJRestoreTRead(Mat,const PetscScalar**); 1658dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetAIJ(Mat,Mat); 1659dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetS(Mat,PetscInt,PetscInt,const PetscScalar []); 1660dbb4b592SRichard Tran Mills PETSC_EXTERN PetscErrorCode MatKAIJSetT(Mat,PetscInt,PetscInt,const PetscScalar []); 166149bd79ccSDebojyoti Ghosh 1662014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec); 166304f1ad80SBarry Smith 1664014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 1665014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec); 1666014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*); 1667014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*)); 1668014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec)); 1669014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt); 1670014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat); 1671014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal); 1672014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt); 1673014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *); 1674014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]); 1675014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*); 1676014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*); 1677e884886fSBarry Smith 16786370053bSBarry Smith /*S 16796370053bSBarry Smith MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free 16806370053bSBarry Smith Jacobian vector products 1681e884886fSBarry Smith 168295452b02SPatrick Sanan Notes: 168395452b02SPatrick Sanan MATMFFD is a specific MatType which uses the MatMFFD data structure 16846370053bSBarry Smith 16856370053bSBarry Smith MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure 16866370053bSBarry Smith 16876370053bSBarry Smith Level: developer 16886370053bSBarry Smith 16896370053bSBarry Smith .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister() 16906370053bSBarry Smith S*/ 1691e884886fSBarry Smith typedef struct _p_MatMFFD* MatMFFD; 1692e884886fSBarry Smith 169376bdecfbSBarry Smith /*J 1694e884886fSBarry Smith MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function 1695e884886fSBarry Smith 1696e884886fSBarry Smith Level: beginner 1697e884886fSBarry Smith 1698e884886fSBarry Smith .seealso: MatMFFDSetType(), MatMFFDRegister() 169976bdecfbSBarry Smith J*/ 170019fd82e9SBarry Smith typedef const char* MatMFFDType; 1701e884886fSBarry Smith #define MATMFFD_DS "ds" 1702e884886fSBarry Smith #define MATMFFD_WP "wp" 1703e884886fSBarry Smith 170419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat,MatMFFDType); 1705bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[],PetscErrorCode (*)(MatMFFD)); 1706e884886fSBarry Smith 1707014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal); 1708014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool ); 1709e884886fSBarry Smith 171061ab5df0SBarry Smith PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring,MatMFFDType); 171161ab5df0SBarry Smith 1712014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *); 1713014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *); 17147dbadf16SMatthew Knepley 171597969023SHong Zhang /* 171697969023SHong Zhang PETSc interface to MUMPS 171797969023SHong Zhang */ 171897969023SHong Zhang #ifdef PETSC_HAVE_MUMPS 1719014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt); 1720bc6112feSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat,PetscInt,PetscInt*); 1721b9e9ea26SSatish Balay PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal); 1722bc6112feSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat,PetscInt,PetscReal*); 1723bc6112feSHong Zhang 1724ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat,PetscInt,PetscInt*); 1725ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat,PetscInt,PetscInt*); 1726ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat,PetscInt,PetscReal*); 1727ca810319SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat,PetscInt,PetscReal*); 172889a9c03aSHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat,Mat); 17290e6b8875SHong Zhang PETSC_EXTERN PetscErrorCode MatMumpsGetInverseTranspose(Mat,Mat); 173097969023SHong Zhang #endif 173123a5497aSJed Brown 1732d954db57SHong Zhang /* 1733d615f992SSatish Balay PETSc interface to Mkl_Pardiso 1734b500a6b7SJose David Bermeol */ 1735b500a6b7SJose David Bermeol #ifdef PETSC_HAVE_MKL_PARDISO 1736d615f992SSatish Balay PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt); 1737b500a6b7SJose David Bermeol #endif 1738b500a6b7SJose David Bermeol 1739b500a6b7SJose David Bermeol /* 1740d305a81bSVasiliy Kozyrev PETSc interface to Mkl_CPardiso 1741d305a81bSVasiliy Kozyrev */ 1742d305a81bSVasiliy Kozyrev #ifdef PETSC_HAVE_MKL_CPARDISO 1743d305a81bSVasiliy Kozyrev PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt); 1744d305a81bSVasiliy Kozyrev #endif 1745d305a81bSVasiliy Kozyrev 1746d305a81bSVasiliy Kozyrev /* 1747d954db57SHong Zhang PETSc interface to SUPERLU 1748d954db57SHong Zhang */ 1749d954db57SHong Zhang #ifdef PETSC_HAVE_SUPERLU 1750014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal); 1751d954db57SHong Zhang #endif 1752d954db57SHong Zhang 1753fb785984SHong Zhang /* 1754fb785984SHong Zhang PETSc interface to SUPERLU_DIST 1755fb785984SHong Zhang */ 1756fb785984SHong Zhang #ifdef PETSC_HAVE_SUPERLU_DIST 1757fb785984SHong Zhang PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat,PetscScalar*); 1758fb785984SHong Zhang #endif 1759fb785984SHong Zhang 1760575704cbSPieter Ghysels /* 1761575704cbSPieter Ghysels PETSc interface to STRUMPACK 1762575704cbSPieter Ghysels */ 1763575704cbSPieter Ghysels #ifdef PETSC_HAVE_STRUMPACK 1764542aee0fSPieter Ghysels /*E 1765542aee0fSPieter Ghysels MatSTRUMPACKReordering - sparsity reducing ordering to be used in STRUMPACK 1766542aee0fSPieter Ghysels 1767542aee0fSPieter Ghysels Level: intermediate 1768542aee0fSPieter Ghysels E*/ 176934f43fa5SPieter Ghysels typedef enum {MAT_STRUMPACK_NATURAL=0, 177034f43fa5SPieter Ghysels MAT_STRUMPACK_METIS=1, 177134f43fa5SPieter Ghysels MAT_STRUMPACK_PARMETIS=2, 177234f43fa5SPieter Ghysels MAT_STRUMPACK_SCOTCH=3, 177334f43fa5SPieter Ghysels MAT_STRUMPACK_PTSCOTCH=4, 177434f43fa5SPieter Ghysels MAT_STRUMPACK_RCM=5} MatSTRUMPACKReordering; 177534f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat,MatSTRUMPACKReordering); 1776575704cbSPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat,PetscBool); 177734f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSRelTol(Mat,PetscReal); 177825ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSRelTol() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSRelCompTol(Mat mat,PetscReal rtol) {return MatSTRUMPACKSetHSSRelTol(mat,rtol);} 177934f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSAbsTol(Mat,PetscReal); 178034f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMinSepSize(Mat,PetscInt); 178125ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSMinSepSize() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSMinSize(Mat mat,PetscInt hssminsize) {return MatSTRUMPACKSetHSSMinSepSize(mat,hssminsize);} 178234f43fa5SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMaxRank(Mat,PetscInt); 1783a36bf211SPieter Ghysels PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSLeafSize(Mat,PetscInt); 1784575704cbSPieter Ghysels #endif 1785575704cbSPieter Ghysels 1786575704cbSPieter Ghysels 1787e7e92044SBarry Smith PETSC_EXTERN PetscErrorCode MatPinToCPU(Mat,PetscBool); 1788e7e92044SBarry Smith 1789aa372e3fSPaul Mullowney #ifdef PETSC_HAVE_CUDA 17903f9c0db1SPaul Mullowney /*E 1791e057df02SPaul Mullowney MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU) 17922692e278SPaul Mullowney matrices. 1793e057df02SPaul Mullowney 1794e057df02SPaul Mullowney Not Collective 1795e057df02SPaul Mullowney 17968468deeeSKarl Rupp + MAT_CUSPARSE_CSR - Compressed Sparse Row 17972692e278SPaul Mullowney . MAT_CUSPARSE_ELL - Ellpack (requires CUDA 4.2 or later). 17982692e278SPaul Mullowney - MAT_CUSPARSE_HYB - Hybrid, a combination of Ellpack and Coordinate format (requires CUDA 4.2 or later). 1799e057df02SPaul Mullowney 1800e057df02SPaul Mullowney Level: intermediate 1801e057df02SPaul Mullowney 1802af0996ceSBarry Smith Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 1803e057df02SPaul Mullowney 1804e057df02SPaul Mullowney .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation 1805e057df02SPaul Mullowney E*/ 1806e057df02SPaul Mullowney 18073f9c0db1SPaul Mullowney typedef enum {MAT_CUSPARSE_CSR, MAT_CUSPARSE_ELL, MAT_CUSPARSE_HYB} MatCUSPARSEStorageFormat; 1808e057df02SPaul Mullowney 1809e057df02SPaul Mullowney /* these will be strings associated with enumerated type defined above */ 1810e057df02SPaul Mullowney PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[]; 1811e057df02SPaul Mullowney 18123f9c0db1SPaul Mullowney /*E 1813e057df02SPaul Mullowney MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU) 18142692e278SPaul Mullowney matrices whose operation should use a particular storage format. 1815e057df02SPaul Mullowney 1816e057df02SPaul Mullowney Not Collective 1817e057df02SPaul Mullowney 18188468deeeSKarl Rupp + MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult 18198468deeeSKarl Rupp . MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult 18208468deeeSKarl Rupp . MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult 18218468deeeSKarl Rupp - MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices 1822e057df02SPaul Mullowney 1823e057df02SPaul Mullowney Level: intermediate 1824e057df02SPaul Mullowney 1825e057df02SPaul Mullowney .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat 1826e057df02SPaul Mullowney E*/ 182736d62e41SPaul Mullowney typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation; 1828e057df02SPaul Mullowney 182910e9db80SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 183010e9db80SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 1831e057df02SPaul Mullowney PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat); 18329ae82921SPaul Mullowney #endif 18339ae82921SPaul Mullowney 1834d67ff14aSKarl Rupp #if defined(PETSC_HAVE_VIENNACL) 1835d67ff14aSKarl Rupp PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 1836d67ff14aSKarl Rupp PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 1837d67ff14aSKarl Rupp #endif 1838d67ff14aSKarl Rupp 183954efbe56SHong Zhang /* 184054efbe56SHong Zhang PETSc interface to FFTW 184154efbe56SHong Zhang */ 184254efbe56SHong Zhang #if defined(PETSC_HAVE_FFTW) 1843014dd563SJed Brown PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec); 1844014dd563SJed Brown PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec); 18452a7a6963SBarry Smith PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*); 184654efbe56SHong Zhang #endif 184754efbe56SHong Zhang 1848014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*); 1849014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*); 1850014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]); 1851014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]); 1852014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***); 1853014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*); 185419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType); 1855014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]); 1856014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat); 1857d8588912SDave May 18584325cce7SMatthew G Knepley PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal); 1859e0a58c10SMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*); 18604325cce7SMatthew G Knepley 1861b541e6a4SDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSubdomainsCreateCoalesce(Mat,PetscInt,PetscInt*,IS**); 186253dd7562SDmitry Karpeev 1863c094ef40SMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatPreallocatorPreallocate(Mat,PetscBool,Mat); 1864c094ef40SMatthew G. Knepley 1865539c167fSBarry Smith PETSC_INTERN PetscErrorCode MatHeaderMerge(Mat,Mat*); 1866539c167fSBarry Smith PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat,Mat*); 1867539c167fSBarry Smith 186823a5497aSJed Brown #endif 1869