FreeFOAM The Cross-Platform CFD Toolkit
PCG.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::PCG
26 
27 Description
28  Preconditioned conjugate gradient solver for symmetric lduMatrices
29  using a run-time selectable preconditioner.
30 
31 SourceFiles
32  PCG.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef PCG_H
37 #define PCG_H
38 
39 #include <OpenFOAM/lduMatrix.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class PCG Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class PCG
51 :
52  public lduMatrix::solver
53 {
54  // Private Member Functions
55 
56  //- Disallow default bitwise copy construct
57  PCG(const PCG&);
58 
59  //- Disallow default bitwise assignment
60  void operator=(const PCG&);
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("PCG");
67 
68 
69  // Constructors
70 
71  //- Construct from matrix components and solver controls
72  PCG
73  (
74  const word& fieldName,
75  const lduMatrix& matrix,
79  const dictionary& solverControls
80  );
81 
82 
83  // Destructor
84 
85  virtual ~PCG()
86  {}
87 
88 
89  // Member Functions
90 
91  //- Solve the matrix with this solver
93  (
95  const scalarField& source,
96  const direction cmpt=0
97  ) const;
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace Foam
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #endif
108 
109 // ************************ vim: set sw=4 sts=4 et: ************************ //