ICCG.C
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 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 \*---------------------------------------------------------------------------*/
25 
26 #include "ICCG.H"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
32  defineTypeNameAndDebug(ICCG, 0);
33 
34  lduMatrix::solver::addsymMatrixConstructorToTable<ICCG>
36 }
37 
38 // * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * //
39 
41 (
42  const scalar tol,
43  const scalar relTol
44 )
45 {
46  dictionary dict(IStringStream("solver PCG; preconditioner DIC;")());
47  dict.add("tolerance", tol);
48  dict.add("relTol", relTol);
49 
50  return dict;
51 }
52 
53 
55 (
56  Istream& is
57 )
58 {
59  scalar tol(readScalar(is));
60  scalar relTol(readScalar(is));
61 
62  return solverDict(tol, relTol);
63 }
64 
65 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
66 
68 (
69  const word& fieldName,
70  const lduMatrix& matrix,
71  const FieldField<Field, scalar>& interfaceBouCoeffs,
72  const FieldField<Field, scalar>& interfaceIntCoeffs,
73  const lduInterfaceFieldPtrsList& interfaces,
74  const dictionary& solverControls
75 )
76 :
77  PCG
78  (
79  fieldName,
80  matrix,
81  interfaceBouCoeffs,
82  interfaceIntCoeffs,
83  interfaces,
84  solverControls
85  )
86 {}
87 
88 
90 (
91  const word& fieldName,
92  const lduMatrix& matrix,
93  const FieldField<Field, scalar>& interfaceBouCoeffs,
94  const FieldField<Field, scalar>& interfaceIntCoeffs,
95  const lduInterfaceFieldPtrsList& interfaces,
96  const scalar tolerance,
97  const scalar relTol
98 )
99 :
100  PCG
101  (
102  fieldName,
103  matrix,
104  interfaceBouCoeffs,
105  interfaceIntCoeffs,
106  interfaces,
107  solverDict(tolerance, relTol)
108  )
109 {}
110 
111 // ************************************************************************* //
Foam::word
A class for handling words, derived from string.
Definition: word.H:59
Foam::FieldField
Generic field type.
Definition: FieldField.H:51
Foam::PCG
Preconditioned conjugate gradient solver for symmetric lduMatrices using a run-time selectable precon...
Definition: PCG.H:49
Foam::ICCG::solverDict
static dictionary solverDict(const scalar tol, const scalar relTol)
Return the dictionary constructed from the components.
Definition: ICCG.C:41
Foam::lduMatrix
lduMatrix is a general matrix class in which the coefficients are stored as three arrays,...
Definition: lduMatrix.H:77
Foam::addICCGSymMatrixConstructorToTable_
lduMatrix::solver::addsymMatrixConstructorToTable< ICCG > addICCGSymMatrixConstructorToTable_
Definition: ICCG.C:35
ICCG.H
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:57
Foam::UPtrList
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: UPtrList.H:53
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:137
Foam::IStringStream
Input from memory buffer stream.
Definition: IStringStream.H:49
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
readScalar
#define readScalar
Definition: doubleScalar.C:38
Foam::ICCG::ICCG
ICCG(const ICCG &)
Disallow default bitwise copy construct.
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)