1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/MatOrderings/MatColoringCreate.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatColoringCreate</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.14.5 2021-03-03</b></div>
<div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.14.5 v3.14.5 docs/manualpages/MatOrderings/MatColoringCreate.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatColoringCreate"><H1>MatColoringCreate</H1></A>
Creates a matrix coloring context.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../MatOrderings/MatColoringCreate.html#MatColoringCreate">MatColoringCreate</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> m,<A HREF="../Mat/MatColoring.html#MatColoring">MatColoring</A> *mcptr)
</PRE>
Collective on <A HREF="../Mat/MatColoring.html#MatColoring">MatColoring</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>comm </B></TD><TD>- MPI communicator
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>mcptr </B></TD><TD>- the new <A HREF="../Mat/MatColoring.html#MatColoring">MatColoring</A> context
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_coloring_type </B></TD><TD>- the type of coloring algorithm used
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_coloring_maxcolors </B></TD><TD>- the maximum number of relevant colors, all nodes not in a color are in maxcolors+1
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_coloring_distance </B></TD><TD>- compute a distance 1,2,... coloring.
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_coloring_view </B></TD><TD>- print information about the coloring and the produced index sets
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_coloring_test </B></TD><TD>- debugging option that prints all coloring incompatibilities
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_is_coloring_test </B></TD><TD>- debugging option that throws an error if <A HREF="../MatOrderings/MatColoringApply.html#MatColoringApply">MatColoringApply</A>() generates an incorrect iscoloring
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
A distance one coloring is useful, for example, multi-color SOR. A distance two coloring is for the finite difference computation of Jacobians
(see <A HREF="../MatFD/MatFDColoringCreate.html#MatFDColoringCreate">MatFDColoringCreate</A>()).
<P>
Coloring of matrices can be computed directly from the sparse matrix nonzero structure via the <A HREF="../Mat/MatColoring.html#MatColoring">MatColoring</A> object or from the mesh from which the
matrix comes from with <A HREF="../DM/DMCreateColoring.html#DMCreateColoring">DMCreateColoring</A>(). In general using the mesh produces a more optimal coloring (fewer colors).
<P>
Some coloring types only support distance two colorings
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatColoring.html#MatColoring">MatColoring</A>, <A HREF="../MatOrderings/MatColoringApply.html#MatColoringApply">MatColoringApply</A>(), <A HREF="../MatFD/MatFDColoringCreate.html#MatFDColoringCreate">MatFDColoringCreate</A>(), <A HREF="../DM/DMCreateColoring.html#DMCreateColoring">DMCreateColoring</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/color/interface/matcoloring.c.html#MatColoringCreate">src/mat/color/interface/matcoloring.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/mat/tutorials/ex16.c.html">src/mat/tutorials/ex16.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/mat/color/impls/greedy/greedy.c.html#MatColoringCreate_Greedy">MatColoringCreate_Greedy in src/mat/color/impls/greedy/greedy.c</A><BR>
<A HREF="../../../src/mat/color/impls/jp/jp.c.html#MatColoringCreate_JP">MatColoringCreate_JP in src/mat/color/impls/jp/jp.c</A><BR>
<A HREF="../../../src/mat/color/impls/minpack/color.c.html#MatColoringCreate_SL">MatColoringCreate_SL in src/mat/color/impls/minpack/color.c</A><BR>
<A HREF="../../../src/mat/color/impls/minpack/color.c.html#MatColoringCreate_LF">MatColoringCreate_LF in src/mat/color/impls/minpack/color.c</A><BR>
<A HREF="../../../src/mat/color/impls/minpack/color.c.html#MatColoringCreate_ID">MatColoringCreate_ID in src/mat/color/impls/minpack/color.c</A><BR>
<A HREF="../../../src/mat/color/impls/natural/natural.c.html#MatColoringCreate_Natural">MatColoringCreate_Natural in src/mat/color/impls/natural/natural.c</A><BR>
<A HREF="../../../src/mat/color/impls/power/power.c.html#MatColoringCreate_Power">MatColoringCreate_Power in src/mat/color/impls/power/power.c</A><BR>
<BR><A HREF="./index.html">Index of all MatOrderings routines</A>
<BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>
|
