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
|
<!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/SNESKSPGetParametersEW.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESKSPGetParametersEW</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.10.3 2018-12-18</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.10.3 v3.10.3 docs/manualpages/SNES/SNESKSPGetParametersEW.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESKSPGetParametersEW"><H1>SNESKSPGetParametersEW</H1></A>
Gets 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"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../SNES/SNESKSPGetParametersEW.html#SNESKSPGetParametersEW">SNESKSPGetParametersEW</A>(<A HREF="../SNES/SNES.html#SNES">SNES</A> snes,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *version,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> *rtol_0,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> *rtol_max,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> *gamma,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> *alpha,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> *alpha2,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> *threshold)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
snes - <A HREF="../SNES/SNES.html#SNES">SNES</A> context
<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>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>
<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, get, 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/SNESKSPSetParametersEW.html#SNESKSPSetParametersEW">SNESKSPSetParametersEW</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/snes/interface/snes.c.html#SNESKSPGetParametersEW">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>
|
