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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2012 OpenFOAM Foundation
9 Copyright (C) 2019 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27Class
28 Foam::PCG
29
30Group
31 grpLduMatrixSolvers
32
33Description
34 Preconditioned conjugate gradient solver for symmetric lduMatrices
35 using a run-time selectable preconditioner.
36
37SourceFiles
38 PCG.C
39
40\*---------------------------------------------------------------------------*/
41
42#ifndef PCG_H
43#define PCG_H
44
45#include "lduMatrix.H"
46
47// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48
49namespace Foam
50{
51
52/*---------------------------------------------------------------------------*\
53 Class PCG Declaration
54\*---------------------------------------------------------------------------*/
56class PCG
57:
59{
60 // Private Member Functions
61
62 //- No copy construct
63 PCG(const PCG&) = delete;
64
65 //- No copy assignment
66 void operator=(const PCG&) = delete;
67
68
69public:
70
71 //- Runtime type information
72 TypeName("PCG");
73
74
75 // Constructors
76
77 //- Construct from matrix components and solver controls
78 PCG
79 (
80 const word& fieldName,
81 const lduMatrix& matrix,
85 const dictionary& solverControls
86 );
87
88
89 //- Destructor
90 virtual ~PCG() = default;
91
92
93 // Member Functions
94
95 //- Solve the matrix with this solver
97 (
99 const solveScalarField& source,
100 const direction cmpt=0
101 ) const;
102
103 //- Solve the matrix with this solver
105 (
107 const scalarField& source,
108 const direction cmpt=0
109 ) const;
110};
111
112
113// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114
115} // End namespace Foam
116
117// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118
119#endif
120
121// ************************************************************************* //
A field of fields is a PtrList of fields with reference counting.
Definition: FieldField.H:80
Preconditioned conjugate gradient solver for symmetric lduMatrices using a run-time selectable precon...
Definition: PCG.H:58
virtual ~PCG()=default
Destructor.
TypeName("PCG")
Runtime type information.
virtual solverPerformance scalarSolve(solveScalarField &psi, const solveScalarField &source, const direction cmpt=0) const
Solve the matrix with this solver.
Definition: PCG.C:70
SolverPerformance is the class returned by the LduMatrix solver containing performance statistics.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Abstract base-class for lduMatrix solvers.
Definition: lduMatrix.H:99
const FieldField< Field, scalar > & interfaceIntCoeffs() const noexcept
Definition: lduMatrix.H:243
const lduInterfaceFieldPtrsList & interfaces() const noexcept
Definition: lduMatrix.H:248
const lduMatrix & matrix() const noexcept
Definition: lduMatrix.H:233
const FieldField< Field, scalar > & interfaceBouCoeffs() const noexcept
Definition: lduMatrix.H:238
const word & fieldName() const noexcept
Definition: lduMatrix.H:228
lduMatrix is a general matrix class in which the coefficients are stored as three arrays,...
Definition: lduMatrix.H:84
A class for handling words, derived from Foam::string.
Definition: word.H:68
const volScalarField & psi
Namespace for OpenFOAM.
uint8_t direction
Definition: direction.H:56
CEqn solve()
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73