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 63 64 65 66 67 68 69 70 71 72 73
|
<!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/SNESSetType.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESSetType</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/SNESSetType.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESSetType"><H1>SNESSetType</H1></A>
Sets the method for the nonlinear solver.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
PetscErrorCode SNESSetType(SNES snes,SNESType type)
</PRE>
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 <A HREF="../SNES/SNES.html#SNES">SNES</A> context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>type </B></TD><TD>- a known method
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database Key</FONT></H3>
<DT><B>-snes_type <type> </B> -Sets the method; use -help for a list
of available methods (for instance, newtonls or newtontr)
<br>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
See "petsc/include/petscsnes.h" for available methods (for instance)
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../SNES/SNESNEWTONLS.html#SNESNEWTONLS">SNESNEWTONLS</A> </B></TD><TD>- Newton's method with line search
(systems of nonlinear equations)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../SNES/SNESNEWTONTR.html#SNESNEWTONTR">SNESNEWTONTR</A> </B></TD><TD>- Newton's method with trust region
(systems of nonlinear equations)
</TD></TR>
<P>
Normally, it is best to use the <A HREF="../SNES/SNESSetFromOptions.html#SNESSetFromOptions">SNESSetFromOptions</A>() command and then
set the <A HREF="../SNES/SNES.html#SNES">SNES</A> solver type from the options database rather than by using
this routine. Using the options database provides the user with
maximum flexibility in evaluating the many nonlinear solvers.
The <A HREF="../SNES/SNESSetType.html#SNESSetType">SNESSetType</A>() routine is provided for those situations where it
is necessary to set the nonlinear solver independently of the command
line or options database. This might be the case, for example, when
the choice of solver changes during the execution of the program,
and the user's application is taking responsibility for choosing the
appropriate method.
<P>
Developer Notes: <A HREF="../SNES/SNESRegister.html#SNESRegister">SNESRegister</A>() adds a constructor for a new <A HREF="../SNES/SNESType.html#SNESType">SNESType</A> to SNESList, <A HREF="../SNES/SNESSetType.html#SNESSetType">SNESSetType</A>() locates
the constructor in that list and calls it to create the spexific object.
<P>
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
<A HREF="../SNES/SNES.html#SNES">SNES</A>, set, type
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/SNESType.html#SNESType">SNESType</A>, <A HREF="../SNES/SNESCreate.html#SNESCreate">SNESCreate</A>(), <A HREF="../SNES/SNESDestroy.html#SNESDestroy">SNESDestroy</A>(), <A HREF="../SNES/SNESGetType.html#SNESGetType">SNESGetType</A>(), <A HREF="../SNES/SNESSetFromOptions.html#SNESSetFromOptions">SNESSetFromOptions</A>()
<BR>
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>intermediate
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/snes/interface/snes.c.html#SNESSetType">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>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/snes/examples/tutorials/ex35.c.html">src/snes/examples/tutorials/ex35.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex22.c.html">src/ts/examples/tutorials/ex22.c.html</A><BR>
</BODY></HTML>
|