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
GAMGPreconditioner
GAMGPreconditioner.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::GAMGPreconditioner
26
27
Description
28
Geometric agglomerated algebraic multigrid preconditioner.
29
30
See Also
31
GAMGSolver for more details.
32
33
SourceFiles
34
GAMGPreconditioner.C
35
36
\*---------------------------------------------------------------------------*/
37
38
#ifndef GAMGPreconditioner_H
39
#define GAMGPreconditioner_H
40
41
#include <
OpenFOAM/GAMGSolver.H
>
42
43
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45
namespace
Foam
46
{
47
48
/*---------------------------------------------------------------------------*\
49
Class GAMGPreconditioner Declaration
50
\*---------------------------------------------------------------------------*/
51
52
class
GAMGPreconditioner
53
:
54
public
GAMGSolver
,
55
public
lduMatrix::preconditioner
56
{
57
protected
:
58
// Protected data
59
60
//- Number of V-cycles to perform
61
label
nVcycles_
;
62
63
//- Read the control parameters from the controlDict_
64
virtual
void
readControls
();
65
66
public
:
67
68
//- Runtime type information
69
TypeName
(
"GAMG"
);
70
71
72
// Constructors
73
74
//- Construct from matrix components and preconditioner solver controls
75
GAMGPreconditioner
76
(
77
const
lduMatrix::solver
&,
78
const
dictionary
& solverControls
79
);
80
81
82
// Destructor
83
84
virtual
~GAMGPreconditioner
();
85
86
87
// Member Functions
88
89
//- Return wA the preconditioned form of residual rA
90
virtual
void
precondition
91
(
92
scalarField
& wA,
93
const
scalarField
& rA,
94
const
direction
cmpt=0
95
)
const
;
96
};
97
98
99
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100
101
}
// End namespace Foam
102
103
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104
105
#endif
106
107
// ************************ vim: set sw=4 sts=4 et: ************************ //