File: SNESLineSearchShellSetUserFunc.html

package info (click to toggle)
petsc 3.4.2.dfsg1-8.1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 129,104 kB
  • ctags: 516,422
  • sloc: ansic: 395,939; cpp: 47,201; python: 34,788; makefile: 17,193; fortran: 16,251; f90: 1,592; objc: 954; sh: 822; xml: 621; java: 381; lisp: 293; csh: 241
file content (106 lines) | stat: -rw-r--r-- 5,215 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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/SNES/SNESLineSearchShellSetUserFunc.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESLineSearchShellSetUserFunc</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.4.2 2013-07-02</b></div>
<A NAME="SNESLineSearchShellSetUserFunc"><H1>SNESLineSearchShellSetUserFunc</H1></A>
Sets the user function for the <A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A> Shell implementation. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
PetscErrorCode SNESLineSearchShellSetUserFunc(SNESLineSearch linesearch, SNESLineSearchUserFunc func, void *ctx)
</PRE>
Not Collective
<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>linesearch </B></TD><TD>- <A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A> context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>func </B></TD><TD>- function implementing the linesearch shell.
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD>- context for func
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Calling sequence of func</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>linesearch </B></TD><TD>- the linesearch instance
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD>- the above mentioned context
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Usage</FONT></H3>
<P>
<pre>
 <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> shellfunc(<A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A> linesearch,void * ctx)
</pre>
<pre>
 {
</pre>
<pre>
    <A HREF="../Vec/Vec.html#Vec">Vec</A>  X,Y,F,W,G;
</pre>
<pre>
    <A HREF="../SNES/SNES.html#SNES">SNES</A> snes;
</pre>
<pre>
    <A HREF="../Sys/PetscFunctionBegin.html#PetscFunctionBegin">PetscFunctionBegin</A>;
</pre>
<pre>
    ierr = <A HREF="../SNES/SNESLineSearchGetSNES.html#SNESLineSearchGetSNES">SNESLineSearchGetSNES</A>(linesearch,&amp;snes);<A HREF="../Sys/CHKERRQ.html#CHKERRQ">CHKERRQ</A>(ierr);
</pre>
<pre>
    ierr = <A HREF="../SNES/SNESLineSearchSetSuccess.html#SNESLineSearchSetSuccess">SNESLineSearchSetSuccess</A>(linesearch,<A HREF="../Sys/PETSC_TRUE.html#PETSC_TRUE">PETSC_TRUE</A>);<A HREF="../Sys/CHKERRQ.html#CHKERRQ">CHKERRQ</A>(ierr);
</pre>
<pre>
    ierr = <A HREF="../SNES/SNESLineSearchGetVecs.html#SNESLineSearchGetVecs">SNESLineSearchGetVecs</A>(linesearch,&amp;X,&amp;F,&amp;Y,&amp;W,&amp;G);<A HREF="../Sys/CHKERRQ.html#CHKERRQ">CHKERRQ</A>(ierr);
</pre>
<pre>
    .. determine lambda using W and G as work vecs..
</pre>
<pre>
    ierr = <A HREF="../Vec/VecAXPY.html#VecAXPY">VecAXPY</A>(X,-lambda,Y);<A HREF="../Sys/CHKERRQ.html#CHKERRQ">CHKERRQ</A>(ierr);
</pre>
<pre>
    ierr = <A HREF="../SNES/SNESComputeFunction.html#SNESComputeFunction">SNESComputeFunction</A>(snes,X,F);<A HREF="../Sys/CHKERRQ.html#CHKERRQ">CHKERRQ</A>(ierr);
</pre>
<pre>
    ierr = <A HREF="../SNES/SNESLineSearchComputeNorms.html#SNESLineSearchComputeNorms">SNESLineSearchComputeNorms</A>(linesearch);<A HREF="../Sys/CHKERRQ.html#CHKERRQ">CHKERRQ</A>(ierr);
</pre>
<pre>
    <A HREF="../Sys/PetscFunctionReturn.html#PetscFunctionReturn">PetscFunctionReturn</A>(0);
</pre>
<pre>
 }
</pre>
<pre>
</pre>
<pre>
 ...
</pre>
<pre>
</pre>
<pre>
 ierr = <A HREF="../SNES/SNESGetLineSearch.html#SNESGetLineSearch">SNESGetLineSearch</A>(snes, &amp;linesearch);<A HREF="../Sys/CHKERRQ.html#CHKERRQ">CHKERRQ</A>(ierr);
</pre>
<pre>
 ierr = <A HREF="../SNES/SNESLineSearchSetType.html#SNESLineSearchSetType">SNESLineSearchSetType</A>(linesearch, <A HREF="../SNES/SNESLINESEARCHSHELL.html#SNESLINESEARCHSHELL">SNESLINESEARCHSHELL</A>);<A HREF="../Sys/CHKERRQ.html#CHKERRQ">CHKERRQ</A>(ierr);
</pre>
<pre>
 ierr = <A HREF="../SNES/SNESLineSearchShellSetUserFunc.html#SNESLineSearchShellSetUserFunc">SNESLineSearchShellSetUserFunc</A>(linesearch, shellfunc, NULL);<A HREF="../Sys/CHKERRQ.html#CHKERRQ">CHKERRQ</A>(ierr);
</pre>
<P>

<P>
.keywords: <A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A>, Shell, user, function, set
<P>
.seealso: <A HREF="../SNES/SNESLineSearchShellGetUserFunc.html#SNESLineSearchShellGetUserFunc">SNESLineSearchShellGetUserFunc</A>(), <A HREF="../SNES/SNESLINESEARCHSHELL.html#SNESLINESEARCHSHELL">SNESLINESEARCHSHELL</A>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/snes/linesearch/impls/shell/linesearchshell.c.html#SNESLineSearchShellSetUserFunc">src/snes/linesearch/impls/shell/linesearchshell.c</A>
<BR><A HREF="./index.html">Index of all SNES 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/ex1f.F.html">src/snes/examples/tutorials/ex1f.F.html</A><BR>
</BODY></HTML>