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
|
<!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/MatColoringSetFromOptions.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatColoringSetFromOptions</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/MatColoringSetFromOptions.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatColoringSetFromOptions"><H1>MatColoringSetFromOptions</H1></A>
Sets <A HREF="../Mat/MatColoring.html#MatColoring">MatColoring</A> options from user parameters
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../MatOrderings/MatColoringSetFromOptions.html#MatColoringSetFromOptions">MatColoringSetFromOptions</A>(<A HREF="../Mat/MatColoring.html#MatColoring">MatColoring</A> mc)
</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>mc </B></TD><TD>- <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>-snes_fd_color </B></TD><TD>- instruct <A HREF="../SNES/SNES.html#SNES">SNES</A> to using coloring and then <A HREF="../Mat/MatFDColoring.html#MatFDColoring">MatFDColoring</A> to compute the Jacobians
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_fd_color_use_mat </B></TD><TD>- instruct <A HREF="../SNES/SNES.html#SNES">SNES</A> to color the matrix directly instead of the <A HREF="../DM/DM.html#DM">DM</A> from which the matrix comes (the default)
</TD></TR></TABLE>
<P>
<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="../MatOrderings/MatColoringSetDistance.html#MatColoringSetDistance">MatColoringSetDistance</A>(), <A HREF="../SNES/SNESComputeJacobianDefaultColor.html#SNESComputeJacobianDefaultColor">SNESComputeJacobianDefaultColor</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#MatColoringSetFromOptions">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#MatColoringSetFromOptions_Greedy">MatColoringSetFromOptions_Greedy in src/mat/color/impls/greedy/greedy.c</A><BR>
<A HREF="../../../src/mat/color/impls/jp/jp.c.html#MatColoringSetFromOptions_JP">MatColoringSetFromOptions_JP in src/mat/color/impls/jp/jp.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>
|
