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
|
<!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/SNESGetNPC.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESGetNPC</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/SNESGetNPC.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESGetNPC"><H1>SNESGetNPC</H1></A>
Creates a nonlinear preconditioning solver (<A HREF="../SNES/SNES.html#SNES">SNES</A>) to be used to precondition the nonlinear solver.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../SNES/SNESGetNPC.html#SNESGetNPC">SNESGetNPC</A>(<A HREF="../SNES/SNES.html#SNES">SNES</A> snes, <A HREF="../SNES/SNES.html#SNES">SNES</A> *pc)
</PRE>
Not Collective; but any changes to the obtained <A HREF="../SNES/SNES.html#SNES">SNES</A> object must be applied collectively
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>snes </B></TD><TD>- iterative context obtained from <A HREF="../SNES/SNESCreate.html#SNESCreate">SNESCreate</A>()
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>pc </B></TD><TD>- preconditioner context
</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>-npc_snes_type <type> </B></TD><TD>- set the type of the <A HREF="../SNES/SNES.html#SNES">SNES</A> to use as the nonlinear preconditioner
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
If a <A HREF="../SNES/SNES.html#SNES">SNES</A> was previously set with <A HREF="../SNES/SNESSetNPC.html#SNESSetNPC">SNESSetNPC</A>() then that <A HREF="../SNES/SNES.html#SNES">SNES</A> is returned, otherwise a new <A HREF="../SNES/SNES.html#SNES">SNES</A> object is created.
<P>
The (preconditioner) <A HREF="../SNES/SNES.html#SNES">SNES</A> returned automatically inherits the same nonlinear function and Jacobian supplied to the original
<A HREF="../SNES/SNES.html#SNES">SNES</A> during <A HREF="../SNES/SNESSetUp.html#SNESSetUp">SNESSetUp</A>()
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/SNESSetNPC.html#SNESSetNPC">SNESSetNPC</A>(), <A HREF="../SNES/SNESHasNPC.html#SNESHasNPC">SNESHasNPC</A>(), <A HREF="../SNES/SNES.html#SNES">SNES</A>, <A HREF="../SNES/SNESCreate.html#SNESCreate">SNESCreate</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/interface/snes.c.html#SNESGetNPC">src/snes/interface/snes.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/snes/tutorials/ex35.c.html">src/snes/tutorials/ex35.c.html</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>
|
