File: TaoSetHessianRoutine.html

package info (click to toggle)
petsc 3.10.3%2Bdfsg1-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 209,064 kB
  • sloc: ansic: 587,333; python: 29,696; makefile: 12,445; fortran: 11,626; f90: 9,677; cpp: 8,768; sh: 1,027; xml: 621; objc: 445; csh: 194; java: 13
file content (69 lines) | stat: -rw-r--r-- 5,218 bytes parent folder | download
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
<!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/TaoSetHessianRoutine.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TaoSetHessianRoutine</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.10.3 2018-12-18</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.10.3 v3.10.3 docs/manualpages/Tao/TaoSetHessianRoutine.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TaoSetHessianRoutine"><H1>TaoSetHessianRoutine</H1></A>
Sets the function to compute the Hessian as well as the location to store the matrix. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsctao.h" 
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Tao/TaoSetHessianRoutine.html#TaoSetHessianRoutine">TaoSetHessianRoutine</A>(<A HREF="../Tao/Tao.html#Tao">Tao</A> tao, <A HREF="../Mat/Mat.html#Mat">Mat</A> H, <A HREF="../Mat/Mat.html#Mat">Mat</A> Hpre, <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (*func)(<A HREF="../Tao/Tao.html#Tao">Tao</A>, <A HREF="../Vec/Vec.html#Vec">Vec</A>, <A HREF="../Mat/Mat.html#Mat">Mat</A>, <A HREF="../Mat/Mat.html#Mat">Mat</A>, 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>H    </B></TD><TD>- Matrix used for the hessian
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>Hpre </B></TD><TD>- Matrix that will be used operated on by preconditioner, can be same as H
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>func </B></TD><TD>- Hessian 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
Hessian evaluation routine (may be NULL)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Calling sequence of func</FONT></H3>
<pre>
   func(<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> H,<A HREF="../Mat/Mat.html#Mat">Mat</A> Hpre,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>H    </B></TD><TD>- Hessian matrix
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>Hpre </B></TD><TD>- preconditioner matrix, usually the same as H
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx  </B></TD><TD>- [optional] user-defined Hessian context
</TD></TR></TABLE>
<P>

<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/tao/interface/taosolver_hj.c.html#TaoSetHessianRoutine">src/tao/interface/taosolver_hj.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/eptorsion1.c.html">src/tao/unconstrained/examples/tutorials/eptorsion1.c.html</A><BR>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/eptorsion2.c.html">src/tao/unconstrained/examples/tutorials/eptorsion2.c.html</A><BR>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/minsurf2.c.html">src/tao/unconstrained/examples/tutorials/minsurf2.c.html</A><BR>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/rosenbrock1.c.html">src/tao/unconstrained/examples/tutorials/rosenbrock1.c.html</A><BR>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/eptorsion2f.F.html">src/tao/unconstrained/examples/tutorials/eptorsion2f.F.html</A><BR>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/rosenbrock1f.F90.html">src/tao/unconstrained/examples/tutorials/rosenbrock1f.F90.html</A><BR>
<A HREF="../../../src/tao/constrained/examples/tutorials/maros.c.html">src/tao/constrained/examples/tutorials/maros.c.html</A><BR>
<A HREF="../../../src/tao/constrained/examples/tutorials/toy.c.html">src/tao/constrained/examples/tutorials/toy.c.html</A><BR>
<A HREF="../../../src/tao/constrained/examples/tutorials/toyf.F90.html">src/tao/constrained/examples/tutorials/toyf.F90.html</A><BR>
<A HREF="../../../src/tao/bound/examples/tutorials/plate2.c.html">src/tao/bound/examples/tutorials/plate2.c.html</A><BR>
<A HREF="../../../src/tao/bound/examples/tutorials/jbearing2.c.html">src/tao/bound/examples/tutorials/jbearing2.c.html</A><BR>
<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>
</BODY></HTML>