FreeFOAM The Cross-Platform CFD Toolkit
DICPreconditioner.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::DICPreconditioner
26 
27 Description
28  Simplified diagonal-based incomplete Cholesky preconditioner for symmetric
29  matrices (symmetric equivalent of DILU). The reciprocal of the
30  preconditioned diagonal is calculated and stored.
31 
32 SourceFiles
33  DICPreconditioner.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef DICPreconditioner_H
38 #define DICPreconditioner_H
39 
40 #include <OpenFOAM/lduMatrix.H>
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class DICPreconditioner Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
54 {
55  // Private data
56 
57  //- The reciprocal preconditioned diagonal
58  scalarField rD_;
59 
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("DIC");
65 
66 
67  // Constructors
68 
69  //- Construct from matrix components and preconditioner solver controls
71  (
72  const lduMatrix::solver&,
73  const dictionary& solverControlsUnused
74  );
75 
76 
77  // Destructor
78 
80  {}
81 
82 
83  // Member Functions
84 
85  //- Calculate the reciprocal of the preconditioned diagonal
86  static void calcReciprocalD(scalarField& rD, const lduMatrix& matrix);
87 
88  //- Return wA the preconditioned form of residual rA
89  virtual void precondition
90  (
91  scalarField& wA,
92  const scalarField& rA,
93  const direction cmpt=0
94  ) const;
95 };
96 
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 } // End namespace Foam
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 #endif
105 
106 // ************************ vim: set sw=4 sts=4 et: ************************ //