PCICG.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-2018 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::PCICG
26 
27 Description
28  Preconditioned conjugate gradient solver for symmetric lduMatrices
29  using a run-time selectable preconditioner.
30 
31 SourceFiles
32  PCICG.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef PCICG_H
37 #define PCICG_H
38 
39 #include "LduMatrix.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class PCICG Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type, class DType, class LUType>
51 class PCICG
52 :
53  public LduMatrix<Type, DType, LUType>::solver
54 {
55  // Private Member Functions
56 
57  //- Disallow default bitwise copy construct
58  PCICG(const PCICG&);
59 
60  //- Disallow default bitwise assignment
61  void operator=(const PCICG&);
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("PCICG");
68 
69 
70  // Constructors
71 
72  //- Construct from matrix components and solver data dictionary
73  PCICG
74  (
75  const word& fieldName,
77  const dictionary& solverDict
78  );
79 
80 
81  // Destructor
82 
83  virtual ~PCICG()
84  {}
85 
86 
87  // Member Functions
88 
89  //- Solve the matrix with this solver
91 };
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #ifdef NoRepository
101  #include "PCICG.C"
102 #endif
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************************************************************* //
TypeName("PCICG")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual SolverPerformance< Type > solve(Field< Type > &psi) const
Solve the matrix with this solver.
Definition: PCICG.C:51
const LduMatrix< Type, DType, LUType > & matrix() const
Definition: LduMatrix.H:235
const word & fieldName() const
Definition: LduMatrix.H:230
virtual ~PCICG()
Definition: PCICG.H:82
Pre-declare SubField and related Field type.
Definition: Field.H:57
A class for handling words, derived from string.
Definition: word.H:59
SolverPerformance is the class returned by the LduMatrix solver containing performance statistics...
Preconditioned conjugate gradient solver for symmetric lduMatrices using a run-time selectable precon...
Definition: PCICG.H:50
LduMatrix is a general matrix class in which the coefficients are stored as three arrays...
Definition: LduMatrix.H:69
const volScalarField & psi
Namespace for OpenFOAM.