src/lduSolvers/lduSolver/bicgStabSolver/bicgStabSolver.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     bicgStabSolver
  26
  27 Description
  28     Preconditioned Bi-Conjugate Gradient stabilised solver with run-time
  29     selectable preconditioning.
  30
  31 Author
  32     Hrvoje Jasak, Wikki Ltd.  All rights reserved.
  33
  34 SourceFiles
  35     bicgStabSolver.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef bicgStabSolver_H
  40 #define bicgStabSolver_H
  41
  42 #include "lduMatrix.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                          Class bicgStabSolver Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class bicgStabSolver
  54 :
  55     public lduSolver
  56 {
  57     // Private data
  58
  59         //- Preconditioner
  60         autoPtr<lduPreconditioner> preconPtr_;
  61
  62
  63     // Private Member Functions
  64
  65         //- Disallow default bitwise copy construct
  66         bicgStabSolver(const bicgStabSolver&);
  67
  68         //- Disallow default bitwise assignment
  69         void operator=(const bicgStabSolver&);
  70
  71
  72 public:
  73
  74     //- Runtime type information
  75     TypeName("BiCGStab");
  76
  77
  78     // Constructors
  79
  80         //- Construct from matrix components and solver data stream
  81         bicgStabSolver
  82         (
  83             const word& fieldName,
  84             const lduMatrix& matrix,
  85             const FieldField<Field, scalar>& coupleBouCoeffs,
  86             const FieldField<Field, scalar>& coupleIntCoeffs,
  87             const lduInterfaceFieldPtrsList& interfaces,
  88             const dictionary& dict
  89         );
  90
  91
  92     // Destructor
  93
  94         virtual ~bicgStabSolver()
  95         {}
  96
  97
  98     // Member Functions
  99
 100         //- Solve the matrix with this solver
 101         virtual lduSolverPerformance solve
 102         (
 103             scalarField& x,
 104             const scalarField& b,
 105             const direction cmpt = 0
 106         ) const;
 107 };
 108
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 } // End namespace Foam
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 #endif
 117
 118 // ************************************************************************* //