Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
OpenFOAM
matrices
lduMatrix
smoothers
GaussSeidel
GaussSeidelSmoother.H
Go to the documentation of this file.
1
/*---------------------------------------------------------------------------*\
2
========= |
3
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4
\\ / O peration |
5
\\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
6
\\/ M anipulation |
7
-------------------------------------------------------------------------------
8
License
9
This file is part of OpenFOAM.
10
11
OpenFOAM is free software: you can redistribute it and/or modify it
12
under the terms of the GNU General Public License as published by
13
the Free Software Foundation, either version 3 of the License, or
14
(at your option) any later version.
15
16
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19
for more details.
20
21
You should have received a copy of the GNU General Public License
22
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23
24
Class
25
Foam::GaussSeidelSmoother
26
27
Description
28
A lduMatrix::smoother for Gauss-Seidel
29
30
SourceFiles
31
GaussSeidelSmoother.C
32
33
\*---------------------------------------------------------------------------*/
34
35
#ifndef GaussSeidelSmoother_H
36
#define GaussSeidelSmoother_H
37
38
#include <
OpenFOAM/lduMatrix.H
>
39
40
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41
42
namespace
Foam
43
{
44
45
/*---------------------------------------------------------------------------*\
46
Class GaussSeidelSmoother Declaration
47
\*---------------------------------------------------------------------------*/
48
49
class
GaussSeidelSmoother
50
:
51
public
lduMatrix::smoother
52
{
53
54
public
:
55
56
//- Runtime type information
57
TypeName
(
"GaussSeidel"
);
58
59
60
// Constructors
61
62
//- Construct from components
63
GaussSeidelSmoother
64
(
65
const
word
&
fieldName
,
66
const
lduMatrix
&
matrix
,
67
const
FieldField<Field, scalar>
&
interfaceBouCoeffs
,
68
const
FieldField<Field, scalar>
&
interfaceIntCoeffs
,
69
const
lduInterfaceFieldPtrsList
&
interfaces
70
);
71
72
73
// Member Functions
74
75
//- Smooth for the given number of sweeps
76
static
void
smooth
77
(
78
const
word
& fieldName,
79
scalarField
&
psi
,
80
const
lduMatrix
& matrix,
81
const
scalarField
& source,
82
const
FieldField<Field, scalar>
& interfaceBouCoeffs,
83
const
lduInterfaceFieldPtrsList
& interfaces,
84
const
direction
cmpt,
85
const
label nSweeps
86
);
87
88
89
//- Smooth the solution for a given number of sweeps
90
virtual
void
smooth
91
(
92
scalarField
& psi,
93
const
scalarField
& Source,
94
const
direction
cmpt,
95
const
label nSweeps
96
)
const
;
97
};
98
99
100
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101
102
}
// End namespace Foam
103
104
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105
106
#endif
107
108
// ************************ vim: set sw=4 sts=4 et: ************************ //