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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
<!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.14.5 2021-03-03</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.14.5 v3.14.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"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatSOR.html#MatSOR">MatSOR</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> mat,<A HREF="../Vec/Vec.html#Vec">Vec</A> b,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> omega,<A HREF="../Mat/MatSORType.html#MatSORType">MatSORType</A> flag,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> shift,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> its,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> lits,<A HREF="../Vec/Vec.html#Vec">Vec</A> x)
</PRE>
Neighbor-wise Collective on <A HREF="../Mat/Mat.html#Mat">Mat</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>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>x </B></TD><TD>- the solution (can contain an initial guess, use option <A HREF="../Mat/MatSORType.html#MatSORType">SOR_ZERO_INITIAL_GUESS</A> to indicate no guess)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">SOR Flags</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../Mat/MatSORType.html#MatSORType">SOR_FORWARD_SWEEP</A> </B></TD><TD>- forward SOR
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../Mat/MatSORType.html#MatSORType">SOR_BACKWARD_SWEEP</A> </B></TD><TD>- backward SOR
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../Mat/MatSORType.html#MatSORType">SOR_SYMMETRIC_SWEEP</A> </B></TD><TD>- SSOR (symmetric SOR)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../Mat/MatSORType.html#MatSORType">SOR_LOCAL_FORWARD_SWEEP</A> </B></TD><TD>- local forward SOR
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../Mat/MatSORType.html#MatSORType">SOR_LOCAL_BACKWARD_SWEEP</A> </B></TD><TD>- local forward SOR
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../Mat/MatSORType.html#MatSORType">SOR_LOCAL_SYMMETRIC_SWEEP</A> </B></TD><TD>- local SSOR
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../Mat/MatSORType.html#MatSORType">SOR_APPLY_UPPER</A>, <A HREF="../Mat/MatSORType.html#MatSORType">SOR_APPLY_LOWER</A> </B></TD><TD>- applies
upper/lower triangular part of matrix to
vector (with omega)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../Mat/MatSORType.html#MatSORType">SOR_ZERO_INITIAL_GUESS</A> </B></TD><TD>- zero initial guess
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
<A HREF="../Mat/MatSORType.html#MatSORType">SOR_LOCAL_FORWARD_SWEEP</A>, <A HREF="../Mat/MatSORType.html#MatSORType">SOR_LOCAL_BACKWARD_SWEEP</A>, and
<A HREF="../Mat/MatSORType.html#MatSORType">SOR_LOCAL_SYMMETRIC_SWEEP</A> 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>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
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 (<A HREF="../Mat/MatSORType.html#MatSORType">SOR_ZERO_INITIAL_GUESS</A> | <A HREF="../Mat/MatSORType.html#MatSORType">SOR_SYMMETRIC_SWEEP</A>)
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><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>developer<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/interface/matrix.c.html#MatSOR">src/mat/interface/matrix.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/tao/pde_constrained/tutorials/parabolic.c.html">src/tao/pde_constrained/tutorials/parabolic.c.html</A><BR>
<A HREF="../../../src/tao/pde_constrained/tutorials/hyperbolic.c.html">src/tao/pde_constrained/tutorials/hyperbolic.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/mat/impls/aij/mpi/mpiaij.c.html#MatSOR_MPIAIJ">MatSOR_MPIAIJ in src/mat/impls/aij/mpi/mpiaij.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aij.c.html#MatSOR_SeqAIJ">MatSOR_SeqAIJ in src/mat/impls/aij/seq/aij.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijsell/aijsell.c.html#MatSOR_SeqAIJSELL">MatSOR_SeqAIJSELL in src/mat/impls/aij/seq/aijsell/aijsell.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/inode.c.html#MatSOR_SeqAIJ_Inode">MatSOR_SeqAIJ_Inode in src/mat/impls/aij/seq/inode.c</A><BR>
<A HREF="../../../src/mat/impls/baij/mpi/mpibaij.c.html#MatSOR_MPIBAIJ">MatSOR_MPIBAIJ in src/mat/impls/baij/mpi/mpibaij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baij.c.html#MatSOR_SeqBAIJ">MatSOR_SeqBAIJ in src/mat/impls/baij/seq/baij.c</A><BR>
<A HREF="../../../src/mat/impls/blockmat/seq/blockmat.c.html#MatSOR_BlockMat_Symmetric">MatSOR_BlockMat_Symmetric in src/mat/impls/blockmat/seq/blockmat.c</A><BR>
<A HREF="../../../src/mat/impls/blockmat/seq/blockmat.c.html#MatSOR_BlockMat">MatSOR_BlockMat in src/mat/impls/blockmat/seq/blockmat.c</A><BR>
<A HREF="../../../src/mat/impls/cdiagonal/cdiagonal.c.html#MatSOR_ConstantDiagonal">MatSOR_ConstantDiagonal in src/mat/impls/cdiagonal/cdiagonal.c</A><BR>
<A HREF="../../../src/mat/impls/dense/seq/dense.c.html#MatSOR_SeqDense">MatSOR_SeqDense in src/mat/impls/dense/seq/dense.c</A><BR>
<A HREF="../../../src/mat/impls/kaij/kaij.c.html#MatSOR_SeqKAIJ">MatSOR_SeqKAIJ in src/mat/impls/kaij/kaij.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/mpi/mpisbaij.c.html#MatSOR_MPISBAIJ">MatSOR_MPISBAIJ in src/mat/impls/sbaij/mpi/mpisbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/seq/relax.h.html#MatSOR_SeqSBAIJ_ushort">MatSOR_SeqSBAIJ_ushort in src/mat/impls/sbaij/seq/relax.h</A><BR>
<A HREF="../../../src/mat/impls/sbaij/seq/relax.h.html#MatSOR_SeqSBAIJ">MatSOR_SeqSBAIJ in src/mat/impls/sbaij/seq/relax.h</A><BR>
<A HREF="../../../src/mat/impls/sell/mpi/mpisell.c.html#MatSOR_MPISELL">MatSOR_MPISELL in src/mat/impls/sell/mpi/mpisell.c</A><BR>
<A HREF="../../../src/mat/impls/sell/seq/sell.c.html#MatSOR_SeqSELL">MatSOR_SeqSELL in src/mat/impls/sell/seq/sell.c</A><BR>
<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>
</BODY></HTML>
|
