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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Mat/MatSOR.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatSOR</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/Mat/MatSOR.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatSOR"><H1>MatSOR</H1></A>
Computes relaxation (SOR, Gauss-Seidel) sweeps.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
PetscErrorCode MatSOR(Mat mat,Vec b,PetscReal omega,MatSORType flag,PetscReal shift,PetscInt its,PetscInt lits,Vec x)
</PRE>
Neighbor-wise Collective on <A HREF="../Mat/Mat.html#Mat">Mat</A> and <A HREF="../Vec/Vec.html#Vec">Vec</A>
<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>mat </B></TD><TD>- the matrix
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>b </B></TD><TD>- the right hand side
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>omega </B></TD><TD>- the relaxation factor
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>flag </B></TD><TD>- flag indicating the type of SOR (see below)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>shift </B></TD><TD>- diagonal shift
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>its </B></TD><TD>- the number of iterations
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>lits </B></TD><TD>- the number of local iterations
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<DT><B>x </B> -the solution (can contain an initial guess, use option SOR_ZERO_INITIAL_GUESS to indicate no guess)
<br>
<P>
<H3><FONT COLOR="#CC3333">SOR Flags</FONT></H3>
<DT><B>SOR_FORWARD_SWEEP </B> -forward SOR
<br>
<DT><B>SOR_BACKWARD_SWEEP </B> -backward SOR
<br>
<DT><B>SOR_SYMMETRIC_SWEEP </B> -SSOR (symmetric SOR)
<br>
<DT><B>SOR_LOCAL_FORWARD_SWEEP </B> -local forward SOR
<br>
<DT><B>SOR_LOCAL_BACKWARD_SWEEP </B> -local forward SOR
<br>
<DT><B>SOR_LOCAL_SYMMETRIC_SWEEP </B> -local SSOR
<br>
<DT><B>SOR_APPLY_UPPER, SOR_APPLY_LOWER </B> -applies
upper/lower triangular part of matrix to
vector (with omega)
<br>
<DT><B>SOR_ZERO_INITIAL_GUESS </B> -zero initial guess
<br>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
SOR_LOCAL_FORWARD_SWEEP, SOR_LOCAL_BACKWARD_SWEEP, and
SOR_LOCAL_SYMMETRIC_SWEEP perform separate independent smoothings
on each processor.
<P>
Application programmers will not generally use <A HREF="../Mat/MatSOR.html#MatSOR">MatSOR</A>() directly,
but instead will employ the <A HREF="../KSP/KSP.html#KSP">KSP</A>/<A HREF="../PC/PC.html#PC">PC</A> interface.
<P>
Notes: for BAIJ, SBAIJ, and AIJ matrices with Inodes this does a block SOR smoothing, otherwise it does a pointwise smoothing
<P>
<H3><FONT COLOR="#CC3333">Notes for Advanced Users</FONT></H3>
The flags are implemented as bitwise inclusive or operations.
For example, use (SOR_ZERO_INITIAL_GUESS | SOR_SYMMETRIC_SWEEP)
to specify a zero initial guess for SSOR.
<P>
Most users should employ the simplified <A HREF="../KSP/KSP.html#KSP">KSP</A> interface for linear solvers
instead of working directly with matrix algebra routines such as this.
See, e.g., <A HREF="../KSP/KSPCreate.html#KSPCreate">KSPCreate</A>().
<P>
Vectors x and b CANNOT be the same
<P>
Developer Note: We should add block SOR support for AIJ matrices with block size set to great than one and no inodes
<P>
<P>
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>developer
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/mat/interface/matrix.c.html#MatSOR">src/mat/interface/matrix.c</A>
<BR><A HREF="./index.html">Index of all Mat 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/tao/pde_constrained/examples/tutorials/parabolic.c.html">src/tao/pde_constrained/examples/tutorials/parabolic.c.html</A><BR>
<A HREF="../../../src/tao/pde_constrained/examples/tutorials/hyperbolic.c.html">src/tao/pde_constrained/examples/tutorials/hyperbolic.c.html</A><BR>
</BODY></HTML>
|
