petsc-3.12.1 2019-10-22
Report Typos and Errors

# MatCholeskyFactorSymbolic

Performs symbolic Cholesky factorization of a symmetric matrix.

### Synopsis

    #include "petscmat.h"
    PetscErrorCode MatCholeskyFactorSymbolic(Mat fact,Mat mat,IS perm,const MatFactorInfo *info)

Collective on Mat

### Input Parameters

| fact | - the factor matrix obtained with MatGetFactor()
| mat | - the matrix
| perm | - row and column permutations
| info | - options for factorization, includes

             fill - expected fill as ratio of original fill.

             dtcol - pivot tolerance (0 no pivot, 1 full column pivoting)

                      Run with the option -info to determine an optimal value to use

### Notes

See MatLUFactorSymbolic() for the nonsymmetric case. See also MatCholeskyFactor() and MatCholeskyFactorNumeric().

Most users should employ the simplified KSP interface for linear solvers instead of working directly with matrix algebra routines such as this. See, e.g., KSPCreate().

### See Also

MatLUFactorSymbolic(), MatCholeskyFactor(), MatCholeskyFactorNumeric()
MatGetOrdering()

Developer Note: fortran interface is not autogenerated as the f90 interface defintion cannot be generated correctly [due to MatFactorInfo]

### Level

developer

### Location

src/mat/interface/matrix.c

### Implementations

MatCholeskyFactorSymbolic_SparseElemental in src/mat/impls/aij/mpi/clique/clique.cxx
MatCholeskyFactorSymbolic_AIJMKL_CPARDISO in src/mat/impls/aij/mpi/mkl_cpardiso/mkl_cpardiso.c
MatCholeskyFactorSymbolic_MUMPS in src/mat/impls/aij/mpi/mumps/mumps.c
MatCholeskyFactorSymbolic_SBAIJPASTIX in src/mat/impls/aij/mpi/pastix/pastix.c
MatCholeskyFactorSymbolic_SuperLU_DIST in src/mat/impls/aij/mpi/superlu_dist/superlu_dist.c
MatCholeskyFactorSymbolic_SeqAIJ in src/mat/impls/aij/seq/aijfact.c
MatCholeskyFactorSymbolic_SeqAIJ_inplace in src/mat/impls/aij/seq/aijfact.c
MatCholeskyFactorSymbolic_AIJMKL_PARDISO in src/mat/impls/aij/seq/mkl_pardiso/mkl_pardiso.c
MatCholeskyFactorSymbolic_SeqAIJCUSPARSE in src/mat/impls/aij/seq/seqcusparse/aijcusparse.cu
MatCholeskyFactorSymbolic_SeqBAIJ in src/mat/impls/baij/seq/baijfact.c
MatCholeskyFactorSymbolic_SeqDense in src/mat/impls/dense/seq/dense.c
MatCholeskyFactorSymbolic_Elemental in src/mat/impls/elemental/matelem.cxx
MatCholeskyFactorSymbolic_CHOLMOD in src/mat/impls/sbaij/seq/cholmod/sbaijcholmod.c
MatCholeskyFactorSymbolic_SeqSBAIJ_MSR in src/mat/impls/sbaij/seq/sbaijfact.c
MatCholeskyFactorSymbolic_SeqSBAIJ in src/mat/impls/sbaij/seq/sbaijfact.c
MatCholeskyFactorSymbolic_SeqSBAIJ_inplace in src/mat/impls/sbaij/seq/sbaijfact.c
Index of all Mat routines
Table of Contents for all manual pages
Index of all manual pages