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
|
<!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/SNESKSPSetParametersEW.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESKSPSetParametersEW</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/SNESKSPSetParametersEW.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESKSPSetParametersEW"><H1>SNESKSPSetParametersEW</H1></A>
Sets parameters for Eisenstat-Walker convergence criteria for the linear solvers within an inexact Newton method.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
PetscErrorCode SNESKSPSetParametersEW(SNES snes,PetscInt version,PetscReal rtol_0,PetscReal rtol_max,PetscReal gamma,PetscReal alpha,PetscReal alpha2,PetscReal threshold)
</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>- <A HREF="../SNES/SNES.html#SNES">SNES</A> context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>version </B></TD><TD>- version 1, 2 (default is 2) or 3
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>rtol_0 </B></TD><TD>- initial relative tolerance (0 <= rtol_0 < 1)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>rtol_max </B></TD><TD>- maximum relative tolerance (0 <= rtol_max < 1)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>gamma </B></TD><TD>- multiplicative factor for version 2 rtol computation
(0 <= gamma2 <= 1)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>alpha </B></TD><TD>- power for version 2 rtol computation (1 < alpha <= 2)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>alpha2 </B></TD><TD>- power for safeguard
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>threshold </B></TD><TD>- threshold for imposing safeguard (0 < threshold < 1)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Note</FONT></H3>
Version 3 was contributed by Luis Chacon, June 2006.
<P>
Use <A HREF="../Sys/PETSC_DEFAULT.html#PETSC_DEFAULT">PETSC_DEFAULT</A> to retain the default for any of the parameters.
<P>
<P>
<H3><FONT COLOR="#CC3333">Reference</FONT></H3>
S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
inexact Newton method", Utah State University Math. Stat. Dept. Res.
Report 6/94/75, June, 1994, to appear in SIAM J. Sci. Comput.
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
<A HREF="../SNES/SNES.html#SNES">SNES</A>, <A HREF="../KSP/KSP.html#KSP">KSP</A>, Eisenstat, Walker, set, parameters
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/SNESKSPSetUseEW.html#SNESKSPSetUseEW">SNESKSPSetUseEW</A>(), <A HREF="../SNES/SNESKSPGetUseEW.html#SNESKSPGetUseEW">SNESKSPGetUseEW</A>(), <A HREF="../SNES/SNESKSPGetParametersEW.html#SNESKSPGetParametersEW">SNESKSPGetParametersEW</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/snes/interface/snes.c.html#SNESKSPSetParametersEW">src/snes/interface/snes.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>
|