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
preconditioners
diagonalPreconditioner
diagonalPreconditioner.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::diagonalPreconditioner
26
27
Description
28
Diagonal preconditioner for both symmetric and asymmetric matrices.
29
30
The reciprocal of the diagonal is calculated and stored for reuse
31
because on most systems '*' is faster than '/'.
32
33
SourceFiles
34
diagonalPreconditioner.C
35
36
\*---------------------------------------------------------------------------*/
37
38
#ifndef diagonalPreconditioner_H
39
#define diagonalPreconditioner_H
40
41
#include <
OpenFOAM/lduMatrix.H
>
42
43
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45
namespace
Foam
46
{
47
48
/*---------------------------------------------------------------------------*\
49
Class diagonalPreconditioner Declaration
50
\*---------------------------------------------------------------------------*/
51
52
class
diagonalPreconditioner
53
:
54
public
lduMatrix::preconditioner
55
{
56
// Private data
57
58
//- The reciprocal diagonal
59
scalarField
rD;
60
61
62
// Private Member Functions
63
64
//- Disallow default bitwise copy construct
65
diagonalPreconditioner
(
const
diagonalPreconditioner
&);
66
67
//- Disallow default bitwise assignment
68
void
operator=(
const
diagonalPreconditioner
&);
69
70
71
public
:
72
73
//- Runtime type information
74
TypeName
(
"diagonal"
);
75
76
77
// Constructors
78
79
//- Construct from matrix components and preconditioner solver controls
80
diagonalPreconditioner
81
(
82
const
lduMatrix::solver
&,
83
const
dictionary
& solverControlsUnused
84
);
85
86
87
// Destructor
88
89
virtual
~diagonalPreconditioner
()
90
{}
91
92
93
// Member Functions
94
95
//- Return wA the preconditioned form of residual rA
96
virtual
void
precondition
97
(
98
scalarField
& wA,
99
const
scalarField
& rA,
100
const
direction
cmpt=0
101
)
const
;
102
103
//- Return wT the transpose-matrix preconditioned form of residual rT.
104
virtual
void
preconditionT
105
(
106
scalarField
& wT,
107
const
scalarField
& rT,
108
const
direction
cmpt=0
109
)
const
110
{
111
return
precondition
(wT, rT, cmpt);
112
}
113
};
114
115
116
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117
118
}
// End namespace Foam
119
120
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121
122
#endif
123
124
// ************************ vim: set sw=4 sts=4 et: ************************ //