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) 2011 OpenFOAM Foundation
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 "lduMatrix.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class diagonalPreconditioner Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
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
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
81  (
82  const lduMatrix::solver&,
83  const dictionary& solverControlsUnused
84  );
85 
86 
87  //- Destructor
88  virtual ~diagonalPreconditioner()
89  {}
90 
91 
92  // Member Functions
93 
94  //- Return wA the preconditioned form of residual rA
95  virtual void precondition
96  (
97  scalarField& wA,
98  const scalarField& rA,
99  const direction cmpt=0
100  ) const;
101 
102  //- Return wT the transpose-matrix preconditioned form of residual rT.
103  virtual void preconditionT
104  (
105  scalarField& wT,
106  const scalarField& rT,
107  const direction cmpt=0
108  ) const
109  {
110  return precondition(wT, rT, cmpt);
111  }
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace Foam
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 #endif
122 
123 // ************************************************************************* //
uint8_t direction
Definition: direction.H:46
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual void precondition(scalarField &wA, const scalarField &rA, const direction cmpt=0) const
Return wA the preconditioned form of residual rA.
virtual void preconditionT(scalarField &wT, const scalarField &rT, const direction cmpt=0) const
Return wT the transpose-matrix preconditioned form of residual rT.
Abstract base-class for lduMatrix solvers.
Definition: lduMatrix.H:93
TypeName("diagonal")
Runtime type information.
Diagonal preconditioner for both symmetric and asymmetric matrices.
virtual ~diagonalPreconditioner()
Destructor.
Abstract base-class for lduMatrix preconditioners.
Definition: lduMatrix.H:407
Namespace for OpenFOAM.