File: PCMGGetSmoother.html

package info (click to toggle)
petsc 3.7.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 163,864 kB
  • ctags: 618,438
  • sloc: ansic: 515,133; python: 29,793; makefile: 20,458; fortran: 18,998; cpp: 6,515; f90: 3,914; sh: 1,012; xml: 621; objc: 445; csh: 240; java: 13
file content (50 lines) | stat: -rw-r--r-- 3,308 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/PC/PCMGGetSmoother.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PCMGGetSmoother</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/PC/PCMGGetSmoother.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PCMGGetSmoother"><H1>PCMGGetSmoother</H1></A>
Gets the <A HREF="../KSP/KSP.html#KSP">KSP</A> context to be used as smoother for both pre- and post-smoothing.  Call both <A HREF="../PC/PCMGGetSmootherUp.html#PCMGGetSmootherUp">PCMGGetSmootherUp</A>() and <A HREF="../PC/PCMGGetSmootherDown.html#PCMGGetSmootherDown">PCMGGetSmootherDown</A>() to use different functions for pre- and post-smoothing. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscksp.h" 
PetscErrorCode  PCMGGetSmoother(PC pc,PetscInt l,KSP *ksp)
</PRE>
Not Collective, <A HREF="../KSP/KSP.html#KSP">KSP</A> returned is parallel if <A HREF="../PC/PC.html#PC">PC</A> is
<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>pc </B></TD><TD>- the multigrid context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>l </B></TD><TD>- the level (0 is coarsest) to supply
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Ouput Parameters</FONT></H3>
<DT><B>ksp </B> -the smoother
<br>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Once you have called this routine, you can call <A HREF="../KSP/KSPSetOperators.html#KSPSetOperators">KSPSetOperators</A>(ksp,...) on the resulting ksp to provide the operators for the smoother for this level.
You can also modify smoother options by calling the various KSPSetXXX() options on this ksp. In addition you can call <A HREF="../KSP/KSPGetPC.html#KSPGetPC">KSPGetPC</A>(ksp,&amp;pc)
and modify <A HREF="../PC/PC.html#PC">PC</A> options for the smoother; for example <A HREF="../PC/PCSetType.html#PCSetType">PCSetType</A>(pc,<A HREF="../PC/PCSOR.html#PCSOR">PCSOR</A>); to use SOR smoothing.
<P>

<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
 MG, get, multigrid, level, smoother, pre-smoother, post-smoother
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../PC/PCMGGetSmootherUp.html#PCMGGetSmootherUp">PCMGGetSmootherUp</A>(), <A HREF="../PC/PCMGGetSmootherDown.html#PCMGGetSmootherDown">PCMGGetSmootherDown</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/ksp/pc/impls/mg/mgfunc.c.html#PCMGGetSmoother">src/ksp/pc/impls/mg/mgfunc.c</A>
<BR><A HREF="./index.html">Index of all PC 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/ex12.c.html">src/snes/examples/tutorials/ex12.c.html</A><BR>
</BODY></HTML>