PBiCG.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-2012 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::PBiCG
26 
27 Description
28  Preconditioned bi-conjugate gradient solver for asymmetric lduMatrices
29  using a run-time selectable preconditiioner.
30 
31 SourceFiles
32  PBiCG.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef PBiCG_H
37 #define PBiCG_H
38 
39 #include "lduMatrix.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class PBiCG Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class PBiCG
51 :
52  public lduMatrix::solver
53 {
54  // Private Member Functions
55 
56  //- Disallow default bitwise copy construct
57  PBiCG(const PBiCG&);
58 
59  //- Disallow default bitwise assignment
60  void operator=(const PBiCG&);
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("PBiCG");
67 
68 
69  // Constructors
70 
71  //- Construct from matrix components and solver data stream
72  PBiCG
73  (
74  const word& fieldName,
75  const lduMatrix& matrix,
79  const dictionary& solverControls
80  );
81 
82 
83  //- Destructor
84  virtual ~PBiCG()
85  {}
86 
87 
88  // Member Functions
89 
90  //- Solve the matrix with this solver
91  virtual solverPerformance solve
92  (
94  const scalarField& source,
95  const direction cmpt=0
96  ) const;
97 };
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace Foam
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************************************************************* //
uint8_t direction
Definition: direction.H:46
const word & fieldName() const
Definition: lduMatrix.H:218
const FieldField< Field, scalar > & interfaceIntCoeffs() const
Definition: lduMatrix.H:233
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Generic field type.
Definition: FieldField.H:51
const lduInterfaceFieldPtrsList & interfaces() const
Definition: lduMatrix.H:238
A class for handling words, derived from string.
Definition: word.H:59
SolverPerformance is the class returned by the LduMatrix solver containing performance statistics...
virtual ~PBiCG()
Destructor.
Definition: PBiCG.H:83
Abstract base-class for lduMatrix solvers.
Definition: lduMatrix.H:93
TypeName("PBiCG")
Runtime type information.
const lduMatrix & matrix() const
Definition: lduMatrix.H:223
virtual solverPerformance solve(scalarField &psi, const scalarField &source, const direction cmpt=0) const
Solve the matrix with this solver.
Definition: PBiCG.C:66
Preconditioned bi-conjugate gradient solver for asymmetric lduMatrices using a run-time selectable pr...
Definition: PBiCG.H:49
lduMatrix is a general matrix class in which the coefficients are stored as three arrays...
Definition: lduMatrix.H:79
const FieldField< Field, scalar > & interfaceBouCoeffs() const
Definition: lduMatrix.H:228
const volScalarField & psi
Namespace for OpenFOAM.