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
|
<!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/SNESNCGSetType.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESNCGSetType</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/SNESNCGSetType.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESNCGSetType"><H1>SNESNCGSetType</H1></A>
Sets the conjugate update type for <A HREF="../SNES/SNESNCG.html#SNESNCG">SNESNCG</A>.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../SNES/SNESNCGSetType.html#SNESNCGSetType">SNESNCGSetType</A>(<A HREF="../SNES/SNES.html#SNES">SNES</A> snes, SNESNCGType btype)
</PRE>
Logically Collective on <A HREF="../SNES/SNES.html#SNES">SNES</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>snes </B></TD><TD>- the iterative context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>btype </B></TD><TD>- update type
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_ncg_type <prp,fr,hs,dy,cd> </B></TD><TD>- strategy for selecting algorithm for computing beta
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">SNESNCGSelectTypes</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>SNES_NCG_FR </B></TD><TD>- Fletcher-Reeves update
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>SNES_NCG_PRP </B></TD><TD>- Polak-Ribiere-Polyak update
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>SNES_NCG_HS </B></TD><TD>- Hestenes-Steifel update
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>SNES_NCG_DY </B></TD><TD>- Dai-Yuan update
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>SNES_NCG_CD </B></TD><TD>- Conjugate Descent update
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
SNES_NCG_PRP is the default, and the only one that tolerates generalized search directions.
<P>
It is not clear what "generalized search directions" means, does it mean use with a nonlinear preconditioner,
that is using -npc_snes_type <type>, <A HREF="../SNES/SNESSetNPC.html#SNESSetNPC">SNESSetNPC</A>(), or <A HREF="../SNES/SNESGetNPC.html#SNESGetNPC">SNESGetNPC</A>()?
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/snes/impls/ncg/snesncg.c.html#SNESNCGSetType">src/snes/impls/ncg/snesncg.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/snes/impls/ncg/snesncg.c.html#SNESNCGSetType_NCG">SNESNCGSetType_NCG in src/snes/impls/ncg/snesncg.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>
|
