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
|
<!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/SNESLineSearchSetUp.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESLineSearchSetUp</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/SNES/SNESLineSearchSetUp.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESLineSearchSetUp"><H1>SNESLineSearchSetUp</H1></A>
Prepares the line search for being applied by allocating any required vectors.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
PetscErrorCode SNESLineSearchSetUp(SNESLineSearch linesearch)
</PRE>
Collective on <A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<DT><B>linesearch </B> -The LineSearch instance.
<br>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
For most cases, this needn't be called by users or outside of <A HREF="../SNES/SNESLineSearchApply.html#SNESLineSearchApply">SNESLineSearchApply</A>().
The only current case where this is called outside of this is for the VI
solvers, which modify the solution and work vectors before the first call
of <A HREF="../SNES/SNESLineSearchApply.html#SNESLineSearchApply">SNESLineSearchApply</A>, requiring the <A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A> work vectors to be
allocated upfront.
<P>
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
<A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A>, SetUp
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/SNESLineSearchReset.html#SNESLineSearchReset">SNESLineSearchReset</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/snes/linesearch/interface/linesearch.c.html#SNESLineSearchSetUp">src/snes/linesearch/interface/linesearch.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>
</BODY></HTML>
|
