src/OpenFOAM/matrices/lduMatrix/solvers/ICCG/ICCG.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::ICCG
  27
  28 Description
  29     Incomplete Cholesky preconditioned CG solver derived from the general
  30     preconditioned CG solver PCG but with the choice of preconditioner
  31     pre-selected.
  32
  33 Deprecated
  34     This solver is present for backward-compatibility and the PCG solver
  35     should be used for preference.
  36
  37 SourceFiles
  38     ICCG.C
  39
  40 \*---------------------------------------------------------------------------*/
  41
  42 #ifndef ICCG_H
  43 #define ICCG_H
  44
  45 #include "PCG.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class ICCG Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class ICCG
  57 :
  58     public PCG
  59 {
  60     // Private Member Functions
  61
  62         //- Disallow default bitwise copy construct
  63         ICCG(const ICCG&);
  64
  65         //- Disallow default bitwise assignment
  66         void operator=(const ICCG&);
  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("ICCG");
  85
  86
  87     // Constructors
  88
  89         //- Construct from matrix components and solver data stream
  90         ICCG
  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         //- Construct from matrix components and tolerances
 101         ICCG
 102         (
 103             const word& fieldName,
 104             const lduMatrix& matrix,
 105             const FieldField<Field, scalar>& interfaceBouCoeffs,
 106             const FieldField<Field, scalar>& interfaceIntCoeffs,
 107             const lduInterfaceFieldPtrsList& interfaces,
 108             const scalar tolerance,
 109             const scalar relTol = 0.0
 110         );
 111
 112     // Destructor
 113
 114         virtual ~ICCG()
 115         {}
 116
 117 };
 118
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 } // End namespace Foam
 123
 124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 125
 126 #endif
 127
 128 // ************************************************************************* //