initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / OpenFOAM / matrices / lduMatrix / solvers / BICCG / BICCG.C
blob2514c4f7077ebbf6f0bceb229ae23e2cb905cf25
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 \*---------------------------------------------------------------------------*/
27 #include "BICCG.H"
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
31 namespace Foam
33     defineTypeNameAndDebug(BICCG, 0);
35     lduMatrix::solver::addasymMatrixConstructorToTable<BICCG>
36         addBICCGSymMatrixConstructorToTable_;
40 // * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * //
42 Foam::dictionary Foam::BICCG::solverDict
44     const scalar tol,
45     const scalar relTol
48     dictionary dict(IStringStream("solver PBiCG; preconditioner DILU;")());
49     dict.add("tolerance", tol);
50     dict.add("relTol", relTol);
52     return dict;
56 Foam::dictionary Foam::BICCG::solverDict
58     Istream& is
61     scalar tol(readScalar(is));
62     scalar relTol(readScalar(is));
64     return solverDict(tol, relTol);
68 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
70 Foam::BICCG::BICCG
72     const word& fieldName,
73     const lduMatrix& matrix,
74     const FieldField<Field, scalar>& interfaceBouCoeffs,
75     const FieldField<Field, scalar>& interfaceIntCoeffs,
76     const lduInterfaceFieldPtrsList& interfaces,
77     const dictionary& solverControls
80     PBiCG
81     (
82         fieldName,
83         matrix,
84         interfaceBouCoeffs,
85         interfaceIntCoeffs,
86         interfaces,
87         solverControls
88     )
92 Foam::BICCG::BICCG
94     const word& fieldName,
95     const lduMatrix& matrix,
96     const FieldField<Field, scalar>& interfaceBouCoeffs,
97     const FieldField<Field, scalar>& interfaceIntCoeffs,
98     const lduInterfaceFieldPtrsList& interfaces,
99     const scalar tolerance,
100     const scalar relTol
103     PBiCG
104     (
105         fieldName,
106         matrix,
107         interfaceBouCoeffs,
108         interfaceIntCoeffs,
109         interfaces,
110         solverDict(tolerance, relTol)
111     )
114 // ************************************************************************* //