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
|
<!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/MatFDColoringSetFunction.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatFDColoringSetFunction</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.7.5 2017-01-01</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.7.5 v3.7.5 docs/manualpages/MatFD/MatFDColoringSetFunction.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatFDColoringSetFunction"><H1>MatFDColoringSetFunction</H1></A>
Sets the function to use for computing the Jacobian.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
PetscErrorCode MatFDColoringSetFunction(MatFDColoring matfd,PetscErrorCode (*f)(void),void *fctx)
</PRE>
Logically Collective on <A HREF="../Mat/MatFDColoring.html#MatFDColoring">MatFDColoring</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>coloring </B></TD><TD>- the coloring context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>f </B></TD><TD>- the function
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fctx </B></TD><TD>- the optional user-defined function context
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Calling sequence of (*f) function</FONT></H3>
For <A HREF="../SNES/SNES.html#SNES">SNES</A>: <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (*f)(<A HREF="../SNES/SNES.html#SNES">SNES</A>,<A HREF="../Vec/Vec.html#Vec">Vec</A>,<A HREF="../Vec/Vec.html#Vec">Vec</A>,void*)
If not using <A HREF="../SNES/SNES.html#SNES">SNES</A>: <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (*f)(void *dummy,<A HREF="../Vec/Vec.html#Vec">Vec</A>,<A HREF="../Vec/Vec.html#Vec">Vec</A>,void*) and dummy is ignored
<P>
<P>
Notes: This function is usually used automatically by <A HREF="../SNES/SNES.html#SNES">SNES</A> (when one uses <A HREF="../SNES/SNESSetJacobian.html#SNESSetJacobian">SNESSetJacobian</A>() with the argument
<A HREF="../SNES/SNESComputeJacobianDefaultColor.html#SNESComputeJacobianDefaultColor">SNESComputeJacobianDefaultColor</A>()) and only needs to be used by someone computing a matrix via coloring directly by
calling <A HREF="../MatFD/MatFDColoringApply.html#MatFDColoringApply">MatFDColoringApply</A>()
<P>
<H3><FONT COLOR="#CC3333">Fortran Notes</FONT></H3>
In Fortran you must call <A HREF="../MatFD/MatFDColoringSetFunction.html#MatFDColoringSetFunction">MatFDColoringSetFunction</A>() for a coloring object to
be used without <A HREF="../SNES/SNES.html#SNES">SNES</A> or within the <A HREF="../SNES/SNES.html#SNES">SNES</A> solvers.
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
<A HREF="../Mat/Mat.html#Mat">Mat</A>, Jacobian, finite differences, set, function
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../MatFD/MatFDColoringCreate.html#MatFDColoringCreate">MatFDColoringCreate</A>(), <A HREF="../MatFD/MatFDColoringGetFunction.html#MatFDColoringGetFunction">MatFDColoringGetFunction</A>(), <A HREF="../MatFD/MatFDColoringSetFromOptions.html#MatFDColoringSetFromOptions">MatFDColoringSetFromOptions</A>()
<BR>
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/mat/matfd/fdmatrix.c.html#MatFDColoringSetFunction">src/mat/matfd/fdmatrix.c</A>
<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>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/snes/examples/tutorials/ex5s.c.html">src/snes/examples/tutorials/ex5s.c.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex14.c.html">src/snes/examples/tutorials/ex14.c.html</A><BR>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/minsurf2.c.html">src/tao/unconstrained/examples/tutorials/minsurf2.c.html</A><BR>
</BODY></HTML>
|
