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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/MatFD/MatFDColoringCreate.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatFDColoringCreate</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/MatFD/MatFDColoringCreate.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatFDColoringCreate"><H1>MatFDColoringCreate</H1></A>
Creates a matrix coloring context for finite difference computation of Jacobians.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../MatFD/MatFDColoringCreate.html#MatFDColoringCreate">MatFDColoringCreate</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> mat,<A HREF="../IS/ISColoring.html#ISColoring">ISColoring</A> iscoloring,<A HREF="../Mat/MatFDColoring.html#MatFDColoring">MatFDColoring</A> *color)
</PRE>
Collective on <A HREF="../Mat/Mat.html#Mat">Mat</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>mat </B></TD><TD>- the matrix containing the nonzero structure of the Jacobian
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>iscoloring </B></TD><TD>- the coloring of the matrix; usually obtained with <A HREF="../MatOrderings/MatColoringCreate.html#MatColoringCreate">MatColoringCreate</A>() or <A HREF="../DM/DMCreateColoring.html#DMCreateColoring">DMCreateColoring</A>()
</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>color </B></TD><TD>- the new coloring context
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../MatFD/MatFDColoringDestroy.html#MatFDColoringDestroy">MatFDColoringDestroy</A>(),<A HREF="../SNES/SNESComputeJacobianDefaultColor.html#SNESComputeJacobianDefaultColor">SNESComputeJacobianDefaultColor</A>(), <A HREF="../IS/ISColoringCreate.html#ISColoringCreate">ISColoringCreate</A>(),
<BR><A HREF="../MatFD/MatFDColoringSetFunction.html#MatFDColoringSetFunction">MatFDColoringSetFunction</A>(), <A HREF="../MatFD/MatFDColoringSetFromOptions.html#MatFDColoringSetFromOptions">MatFDColoringSetFromOptions</A>(), <A HREF="../MatFD/MatFDColoringApply.html#MatFDColoringApply">MatFDColoringApply</A>(),
<A HREF="../MatFD/MatFDColoringView.html#MatFDColoringView">MatFDColoringView</A>(), <A HREF="../MatFD/MatFDColoringSetParameters.html#MatFDColoringSetParameters">MatFDColoringSetParameters</A>(), <A HREF="../MatOrderings/MatColoringCreate.html#MatColoringCreate">MatColoringCreate</A>(), <A HREF="../DM/DMCreateColoring.html#DMCreateColoring">DMCreateColoring</A>(), <A HREF="../Mat/MatFDColoringSetValues.html#MatFDColoringSetValues">MatFDColoringSetValues</A>()
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/matfd/fdmatrix.c.html#MatFDColoringCreate">src/mat/matfd/fdmatrix.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>
<A HREF="../../../src/snes/tutorials/ex14.c.html">src/snes/tutorials/ex14.c.html</A><BR>
<A HREF="../../../src/tao/unconstrained/tutorials/minsurf2.c.html">src/tao/unconstrained/tutorials/minsurf2.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/mat/impls/aij/mpi/fdmpiaij.c.html#MatFDColoringCreate_MPIXAIJ">MatFDColoringCreate_MPIXAIJ in src/mat/impls/aij/mpi/fdmpiaij.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/fdaij.c.html#MatFDColoringCreate_SeqXAIJ">MatFDColoringCreate_SeqXAIJ in src/mat/impls/aij/seq/fdaij.c</A><BR>
<BR><A HREF="./index.html">Index of all MatFD 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>
|
