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
|
<!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/DMSNESGetGS.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMSNESGetGS</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.4.2 2013-07-02</b></div>
<A NAME="DMSNESGetGS"><H1>DMSNESGetGS</H1></A>
get <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 DMSNESGetGS(DM dm,PetscErrorCode (**SNESGSFunction)(SNES,Vec,Vec,void*),void **ctx)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Argument</FONT></H3>
<DT><B>dm </B> -DM to be used with <A HREF="../SNES/SNES.html#SNES">SNES</A>
<br>
<P>
<H3><FONT COLOR="#CC3333">Output Arguments</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../SNES/SNESGSFunction.html#SNESGSFunction">SNESGSFunction</A> </B></TD><TD>- relaxation function which performs Gauss-Seidel sweeps
</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/SNESGetGS.html#SNESGetGS">SNESGetGS</A>() is normally used, but it calls this function internally because the user context is actually
associated with the DM. This makes the interface consistent regardless of whether the user interacts with a DM or
not. If DM 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/SNESGetGS.html#SNESGetGS">SNESGetGS</A>(), <A HREF="../SNES/DMSNESGetJacobian.html#DMSNESGetJacobian">DMSNESGetJacobian</A>(), <A HREF="../SNES/DMSNESGetFunction.html#DMSNESGetFunction">DMSNESGetFunction</A>(), <A HREF="../SNES/SNESGSFunction.html#SNESGSFunction">SNESGSFunction</A>
<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#DMSNESGetGS">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>
|
