src/OpenFOAM/matrices/lduMatrix/solvers/BICCG/BICCG.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
   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 "BICCG.H"
  27
  28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  29
  30 namespace Foam
  31 {
  32     defineTypeNameAndDebug(BICCG, 0);
  33
  34     lduMatrix::solver::addasymMatrixConstructorToTable<BICCG>
  35         addBICCGSymMatrixConstructorToTable_;
  36 }
  37
  38
  39 // * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * //
  40
  41 Foam::dictionary Foam::BICCG::solverDict
  42 (
  43     const scalar tol,
  44     const scalar relTol
  45 )
  46 {
  47     dictionary dict(IStringStream("solver PBiCG; preconditioner DILU;")());
  48     dict.add("tolerance", tol);
  49     dict.add("relTol", relTol);
  50
  51     return dict;
  52 }
  53
  54
  55 Foam::dictionary Foam::BICCG::solverDict
  56 (
  57     Istream& is
  58 )
  59 {
  60     scalar tol(readScalar(is));
  61     scalar relTol(readScalar(is));
  62
  63     return solverDict(tol, relTol);
  64 }
  65
  66
  67 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  68
  69 Foam::BICCG::BICCG
  70 (
  71     const word& fieldName,
  72     const lduMatrix& matrix,
  73     const FieldField<Field, scalar>& interfaceBouCoeffs,
  74     const FieldField<Field, scalar>& interfaceIntCoeffs,
  75     const lduInterfaceFieldPtrsList& interfaces,
  76     const dictionary& solverControls
  77 )
  78 :
  79     PBiCG
  80     (
  81         fieldName,
  82         matrix,
  83         interfaceBouCoeffs,
  84         interfaceIntCoeffs,
  85         interfaces,
  86         solverControls
  87     )
  88 {}
  89
  90
  91 Foam::BICCG::BICCG
  92 (
  93     const word& fieldName,
  94     const lduMatrix& matrix,
  95     const FieldField<Field, scalar>& interfaceBouCoeffs,
  96     const FieldField<Field, scalar>& interfaceIntCoeffs,
  97     const lduInterfaceFieldPtrsList& interfaces,
  98     const scalar tolerance,
  99     const scalar relTol
 100 )
 101 :
 102     PBiCG
 103     (
 104         fieldName,
 105         matrix,
 106         interfaceBouCoeffs,
 107         interfaceIntCoeffs,
 108         interfaces,
 109         solverDict(tolerance, relTol)
 110     )
 111 {}
 112
 113 // ************************************************************************* //