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
|
<!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/DMSNESSetNGS.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMSNESSetNGS</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/DMSNESSetNGS.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMSNESSetNGS"><H1>DMSNESSetNGS</H1></A>
set <A HREF="../SNES/SNES.html#SNES">SNES</A> Gauss-Seidel relaxation function
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
#include "petscdm.h"
PetscErrorCode DMSNESSetNGS(DM dm,PetscErrorCode (*f)(SNES,Vec,Vec,void*),void *ctx)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Argument</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>dm </B></TD><TD>- <A HREF="../DM/DM.html#DM">DM</A> to be used with <A HREF="../SNES/SNES.html#SNES">SNES</A>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>f </B></TD><TD>- relaxation function, see SNESGSFunction
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD>- context for residual evaluation
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Note</FONT></H3>
<A HREF="../SNES/SNESSetNGS.html#SNESSetNGS">SNESSetNGS</A>() is normally used, but it calls this function internally because the user context is actually
associated with the <A HREF="../DM/DM.html#DM">DM</A>. This makes the interface consistent regardless of whether the user interacts with a <A HREF="../DM/DM.html#DM">DM</A> or
not. If <A HREF="../DM/DM.html#DM">DM</A> took a more central role at some later date, this could become the primary method of setting the residual.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
DMSNESSetContext(), <A HREF="../SNES/SNESSetFunction.html#SNESSetFunction">SNESSetFunction</A>(), <A HREF="../SNES/DMSNESSetJacobian.html#DMSNESSetJacobian">DMSNESSetJacobian</A>(), <A HREF="../SNES/DMSNESSetFunction.html#DMSNESSetFunction">DMSNESSetFunction</A>(), SNESGSFunction
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/snes/utils/dmsnes.c.html#DMSNESSetNGS">src/snes/utils/dmsnes.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>
|
