MatGetColoring

Gets a coloring for a matrix to reduce fill or to improve numerical stability of LU factorization.

Synopsis

int MatGetColoring(Mat mat,MatColoringType type,ISColoring *iscoloring)
Collective on Mat

Input Parameters

mat -the matrix
type -type of coloring, one of the following:
     MATCOLORING_NATURAL - natural
     MATCOLORING_SL - smallest-last
     MATCOLORING_LF - largest-first
     MATCOLORING_ID - incidence-degree

Output Parameters

iscoloring -the coloring

Options Database Keys

To specify the coloring through the options database, use one of the following
   -mat_coloring_type natural, -mat_coloring_type sl, -mat_coloring_type lf,
   -mat_coloring_type id
To see the coloring use
   -mat_coloring_view

The user can define additional colorings; see MatColoringRegisterDynamic().

Keywords

matrix, get, coloring

See Also

MatGetColoringTypeFromOptions(), MatColoringRegisterDynamic()

Examples

src/snes/examples/tutorials/ex4f.F
src/snes/examples/tutorials/ex4.c

Level:intermediate
Location:src/mat/color/color.c
Matrix Index
Table of Contents