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
|
<!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/TaoComputeHessian.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TaoComputeHessian</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/TaoComputeHessian.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TaoComputeHessian"><H1>TaoComputeHessian</H1></A>
Computes the Hessian matrix that has been set with <A HREF="../Tao/TaoSetHessianRoutine.html#TaoSetHessianRoutine">TaoSetHessianRoutine</A>().
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsctao.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Tao/TaoComputeHessian.html#TaoComputeHessian">TaoComputeHessian</A>(<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)
</PRE>
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> solver context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>X </B></TD><TD>- input vector
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<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>- Preconditioning matrix
</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>-tao_test_hessian </B></TD><TD>- compare the user provided Hessian with one compute via finite differences to check for errors
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_test_hessian <numerical value> </B></TD><TD>- display entries in the difference between the user provided Hessian and finite difference Hessian that are greater than a certain value to help users detect errors
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_test_hessian_view </B></TD><TD>- display the user provided Hessian, the finite difference Hessian and the difference between them to help users detect the location of errors in the user provided Hessian
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Most users should not need to explicitly call this routine, as it
is used internally within the minimization solvers.
<P>
<A HREF="../Tao/TaoComputeHessian.html#TaoComputeHessian">TaoComputeHessian</A>() is typically used within minimization
implementations, so most users would not generally call this routine
themselves.
<P>
<H3><FONT COLOR="#CC3333">Developer Notes</FONT></H3>
The Hessian test mechanism follows SNESTestJacobian().
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Tao/TaoComputeObjective.html#TaoComputeObjective">TaoComputeObjective</A>(), <A HREF="../Tao/TaoComputeObjectiveAndGradient.html#TaoComputeObjectiveAndGradient">TaoComputeObjectiveAndGradient</A>(), <A HREF="../Tao/TaoSetHessianRoutine.html#TaoSetHessianRoutine">TaoSetHessianRoutine</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>developer<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/tao/interface/taosolver_hj.c.html#TaoComputeHessian">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>
</BODY></HTML>
|
