PCG.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2020 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::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 "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 
55 public:
56 
57  //- Runtime type information
58  TypeName("PCG");
59 
60 
61  // Constructors
62 
63  //- Construct from matrix components and solver controls
64  PCG
65  (
66  const word& fieldName,
67  const lduMatrix& matrix,
71  const dictionary& solverControls
72  );
73 
74  //- Disallow default bitwise copy construction
75  PCG(const PCG&) = delete;
76 
77 
78  //- Destructor
79  virtual ~PCG()
80  {}
81 
82 
83  // Member Functions
84 
85  //- Solve the matrix with this solver
86  virtual solverPerformance solve
87  (
89  const scalarField& source,
90  const direction cmpt=0
91  ) const;
92 
93 
94  // Member Operators
95 
96  //- Disallow default bitwise assignment
97  void operator=(const PCG&) = delete;
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace Foam
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #endif
108 
109 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
uint8_t direction
Definition: direction.H:45
const lduMatrix & matrix() const
Definition: lduMatrix.H:226
const FieldField< Field, scalar > & interfaceBouCoeffs() const
Definition: lduMatrix.H:231
virtual solverPerformance solve(scalarField &psi, const scalarField &source, const direction cmpt=0) const
Solve the matrix with this solver.
Definition: PCG.C:66
PCG(const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls)
Construct from matrix components and solver controls.
Definition: PCG.C:42
Generic field type.
Definition: FieldField.H:51
virtual ~PCG()
Destructor.
Definition: PCG.H:78
const FieldField< Field, scalar > & interfaceIntCoeffs() const
Definition: lduMatrix.H:236
A class for handling words, derived from string.
Definition: word.H:59
SolverPerformance is the class returned by the LduMatrix solver containing performance statistics...
TypeName("PCG")
Runtime type information.
Abstract base-class for lduMatrix solvers.
Definition: lduMatrix.H:93
const lduInterfaceFieldPtrsList & interfaces() const
Definition: lduMatrix.H:241
const volScalarField & psi
void operator=(const PCG &)=delete
Disallow default bitwise assignment.
lduMatrix is a general matrix class in which the coefficients are stored as three arrays...
Definition: lduMatrix.H:79
const word & fieldName() const
Definition: lduMatrix.H:221
Preconditioned conjugate gradient solver for symmetric lduMatrices using a run-time selectable precon...
Definition: PCG.H:49
Namespace for OpenFOAM.