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
|
<!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/SNESLineSearchCreate.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESLineSearchCreate</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.14.5 2021-03-03</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.14.5 v3.14.5 docs/manualpages/SNES/SNESLineSearchCreate.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESLineSearchCreate"><H1>SNESLineSearchCreate</H1></A>
Creates the line search context.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../SNES/SNESLineSearchCreate.html#SNESLineSearchCreate">SNESLineSearchCreate</A>(<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A> comm, <A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A> *outlinesearch)
</PRE>
Logically Collective on Comm
<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>comm </B></TD><TD>- MPI communicator for the line search (typically from the associated <A HREF="../SNES/SNES.html#SNES">SNES</A> context).
</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>outlinesearch </B></TD><TD>- the new linesearch context
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
The preferred calling sequence for users is to use <A HREF="../SNES/SNESGetLineSearch.html#SNESGetLineSearch">SNESGetLineSearch</A>() to acquire the <A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A> instance
already associated with the <A HREF="../SNES/SNES.html#SNES">SNES</A>. This function is for developer use.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
LineSearchDestroy(), <A HREF="../SNES/SNESGetLineSearch.html#SNESGetLineSearch">SNESGetLineSearch</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/snes/linesearch/interface/linesearch.c.html#SNESLineSearchCreate">src/snes/linesearch/interface/linesearch.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/snes/impls/ncg/snesncg.c.html#SNESLineSearchCreate_NCGLinear">SNESLineSearchCreate_NCGLinear in src/snes/impls/ncg/snesncg.c</A><BR>
<A HREF="../../../src/snes/linesearch/impls/basic/linesearchbasic.c.html#SNESLineSearchCreate_Basic">SNESLineSearchCreate_Basic in src/snes/linesearch/impls/basic/linesearchbasic.c</A><BR>
<A HREF="../../../src/snes/linesearch/impls/bt/linesearchbt.c.html#SNESLineSearchCreate_BT">SNESLineSearchCreate_BT in src/snes/linesearch/impls/bt/linesearchbt.c</A><BR>
<A HREF="../../../src/snes/linesearch/impls/cp/linesearchcp.c.html#SNESLineSearchCreate_CP">SNESLineSearchCreate_CP in src/snes/linesearch/impls/cp/linesearchcp.c</A><BR>
<A HREF="../../../src/snes/linesearch/impls/l2/linesearchl2.c.html#SNESLineSearchCreate_L2">SNESLineSearchCreate_L2 in src/snes/linesearch/impls/l2/linesearchl2.c</A><BR>
<A HREF="../../../src/snes/linesearch/impls/nleqerr/linesearchnleqerr.c.html#SNESLineSearchCreate_NLEQERR">SNESLineSearchCreate_NLEQERR in src/snes/linesearch/impls/nleqerr/linesearchnleqerr.c</A><BR>
<A HREF="../../../src/snes/linesearch/impls/shell/linesearchshell.c.html#SNESLineSearchCreate_Shell">SNESLineSearchCreate_Shell in src/snes/linesearch/impls/shell/linesearchshell.c</A><BR>
<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>
|
