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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Tao/TaoSetJacobianRoutine.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TaoSetJacobianRoutine</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/Tao/TaoSetJacobianRoutine.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TaoSetJacobianRoutine"><H1>TaoSetJacobianRoutine</H1></A>
Sets the function to compute the Jacobian as well as the location to store the matrix.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsctao.h"
PetscErrorCode TaoSetJacobianRoutine(Tao tao, Mat J, Mat Jpre, PetscErrorCode (*func)(Tao, Vec, Mat, Mat, void*), void *ctx)
</PRE>
Logically collective on <A HREF="../Tao/Tao.html#Tao">Tao</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>tao </B></TD><TD>- the <A HREF="../Tao/Tao.html#Tao">Tao</A> context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>J </B></TD><TD>- Matrix used for the jacobian
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>Jpre </B></TD><TD>- Matrix that will be used operated on by preconditioner, can be same as J
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>jac </B></TD><TD>- Jacobian evaluation routine
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD>- [optional] user-defined context for private data for the
Jacobian evaluation routine (may be NULL)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Calling sequence of jac</FONT></H3>
<pre>
jac (<A HREF="../Tao/Tao.html#Tao">Tao</A> tao,<A HREF="../Vec/Vec.html#Vec">Vec</A> x,<A HREF="../Mat/Mat.html#Mat">Mat</A> *J,<A HREF="../Mat/Mat.html#Mat">Mat</A> *Jpre,void *ctx);
</pre>
<P>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>tao </B></TD><TD>- the <A HREF="../Tao/Tao.html#Tao">Tao</A> context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>x </B></TD><TD>- input vector
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>J </B></TD><TD>- Jacobian matrix
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>Jpre </B></TD><TD>- preconditioner matrix, usually the same as J
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD>- [optional] user-defined Jacobian context
</TD></TR></TABLE>
<P>
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>intermediate
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/tao/interface/taosolver_hj.c.html#TaoSetJacobianRoutine">src/tao/interface/taosolver_hj.c</A>
<BR><A HREF="./index.html">Index of all Tao 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/tao/complementarity/examples/tutorials/minsurf1.c.html">src/tao/complementarity/examples/tutorials/minsurf1.c.html</A><BR>
<A HREF="../../../src/tao/complementarity/examples/tutorials/blackscholes.c.html">src/tao/complementarity/examples/tutorials/blackscholes.c.html</A><BR>
<A HREF="../../../src/tao/leastsquares/examples/tutorials/chwirut1.c.html">src/tao/leastsquares/examples/tutorials/chwirut1.c.html</A><BR>
</BODY></HTML>
|
