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
|
<!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/PCSORGetSymmetric.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PCSORGetSymmetric</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.10.3 2018-12-18</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.10.3 v3.10.3 docs/manualpages/PC/PCSORGetSymmetric.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PCSORGetSymmetric"><H1>PCSORGetSymmetric</H1></A>
Gets the form the SOR preconditioner is using; backward, or forward relaxation. The local variants perform SOR on each processor. By default forward relaxation is used.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscpc.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../PC/PCSORGetSymmetric.html#PCSORGetSymmetric">PCSORGetSymmetric</A>(<A HREF="../PC/PC.html#PC">PC</A> pc,<A HREF="../Mat/MatSORType.html#MatSORType">MatSORType</A> *flag)
</PRE>
Logically Collective on <A HREF="../PC/PC.html#PC">PC</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<DT><B>pc </B> -the preconditioner context
<br>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>flag </B> -one of the following
<br>
<PRE>
<A HREF="../Mat/MatSORType.html#MatSORType">SOR_FORWARD_SWEEP</A>
<A HREF="../Mat/MatSORType.html#MatSORType">SOR_BACKWARD_SWEEP</A>
<A HREF="../Mat/MatSORType.html#MatSORType">SOR_SYMMETRIC_SWEEP</A>
<A HREF="../Mat/MatSORType.html#MatSORType">SOR_LOCAL_FORWARD_SWEEP</A>
<A HREF="../Mat/MatSORType.html#MatSORType">SOR_LOCAL_BACKWARD_SWEEP</A>
<A HREF="../Mat/MatSORType.html#MatSORType">SOR_LOCAL_SYMMETRIC_SWEEP</A>
</PRE>
<P>
<H3><FONT COLOR="#CC3333">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-pc_sor_symmetric </B></TD><TD>- Activates symmetric version
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-pc_sor_backward </B></TD><TD>- Activates backward version
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-pc_sor_local_forward </B></TD><TD>- Activates local forward version
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-pc_sor_local_symmetric </B></TD><TD>- Activates local symmetric version
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-pc_sor_local_backward </B></TD><TD>- Activates local backward version
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
To use the Eisenstat trick with SSOR, employ the <A HREF="../PC/PCEISENSTAT.html#PCEISENSTAT">PCEISENSTAT</A> preconditioner,
which can be chosen with the option
<DT><B>-pc_type eisenstat </B> -Activates Eisenstat trick
<br>
<P>
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
<A HREF="../PC/PC.html#PC">PC</A>, SOR, SSOR, set, relaxation, sweep, forward, backward, symmetric
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../PC/PCEisenstatSetOmega.html#PCEisenstatSetOmega">PCEisenstatSetOmega</A>(), <A HREF="../PC/PCSORSetIterations.html#PCSORSetIterations">PCSORSetIterations</A>(), <A HREF="../PC/PCSORSetOmega.html#PCSORSetOmega">PCSORSetOmega</A>(), <A HREF="../PC/PCSORSetSymmetric.html#PCSORSetSymmetric">PCSORSetSymmetric</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/ksp/pc/impls/sor/sor.c.html#PCSORGetSymmetric">src/ksp/pc/impls/sor/sor.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/ksp/pc/impls/sor/sor.c.html#PCSORGetSymmetric_SOR">PCSORGetSymmetric_SOR in src/ksp/pc/impls/sor/sor.c</A><BR>
<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>
</BODY></HTML>
|
