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

   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.
  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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::BICCG
  27
  28 Description
  29     Diagonal incomplete LU preconditioned BiCG solver derived from the general
  30     preconditioned BiCG solver PBiCG but with the choice of preconditioner
  31     pre-selected.
  32
  33 Deprecated
  34     This solver is present for backward-compatibility and the PBiCG solver
  35     should be used instead.
  36
  37 SourceFiles
  38     BICCG.C
  39
  40 \*---------------------------------------------------------------------------*/
  41
  42 #ifndef BICCG_H
  43 #define BICCG_H
  44
  45 #include "PBiCG.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class BICCG Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class BICCG
  57 :
  58     public PBiCG
  59 {
  60     // Private Member Functions
  61
  62         //- Disallow default bitwise copy construct
  63         BICCG(const BICCG&);
  64
  65         //- Disallow default bitwise assignment
  66         void operator=(const BICCG&);
  67
  68 public:
  69
  70     //- Return the dictionary constructed from the components.
  71     //  Needed for backward compatibility
  72     static dictionary solverDict
  73     (
  74         const scalar tol,
  75         const scalar relTol
  76     );
  77
  78     //- Return the dictionary constructed from the old-style data-stream.
  79     //  Needed for backward compatibility
  80     static dictionary solverDict(Istream&);
  81
  82
  83     //- Runtime type information
  84     TypeName("BICCG");
  85
  86
  87     // Constructors
  88
  89         //- Construct from matrix components and solver data stream
  90         BICCG
  91         (
  92             const word& fieldName,
  93             const lduMatrix& matrix,
  94             const FieldField<Field, scalar>& interfaceBouCoeffs,
  95             const FieldField<Field, scalar>& interfaceIntCoeffs,
  96             const lduInterfaceFieldPtrsList& interfaces,
  97             const dictionary& solverControls
  98         );
  99
 100
 101         //- Construct from matrix components and tolerances
 102         BICCG
 103         (
 104             const word& fieldName,
 105             const lduMatrix& matrix,
 106             const FieldField<Field, scalar>& interfaceBouCoeffs,
 107             const FieldField<Field, scalar>& interfaceIntCoeffs,
 108             const lduInterfaceFieldPtrsList& interfaces,
 109             const scalar tolerance,
 110             const scalar relTol = 0.0
 111         );
 112
 113     // Destructor
 114
 115         virtual ~BICCG()
 116         {}
 117
 118 };
 119
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 } // End namespace Foam
 124
 125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 126
 127 #endif
 128
 129 // ************************************************************************* //