src/lduSolvers/lduSolver/amgSolver/amgSolver.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-6 H. Jasak All rights reserved
   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     amgSolver
  27
  28 Description
  29     Algebraic Multigrid solver with run-time selection of policy and cycle
  30
  31 Author
  32     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  33
  34 SourceFiles
  35     amgSolver.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef amgSolver_H
  40 #define amgSolver_H
  41
  42 #include "lduMatrix.H"
  43 #include "amgPrecon.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class amgSolver Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class amgSolver
  55 :
  56     public lduSolver
  57 {
  58 private:
  59
  60     // Private data
  61
  62         //- AMG preconditioner
  63         amgPrecon amg_;
  64
  65
  66     // Private Member Functions
  67
  68         //- Disallow default bitwise copy construct
  69         amgSolver(const amgSolver&);
  70
  71         //- Disallow default bitwise assignment
  72         void operator=(const amgSolver&);
  73
  74
  75 public:
  76
  77     //- Runtime type information
  78     TypeName("amgSolver");
  79
  80
  81     // Constructors
  82
  83         //- Construct from matrix components and solver data stream
  84         amgSolver
  85         (
  86             const word& fieldName,
  87             const lduMatrix& matrix,
  88             const FieldField<Field, scalar>& coupleBouCoeffs,
  89             const FieldField<Field, scalar>& coupleIntCoeffs,
  90             const lduInterfaceFieldPtrsList& interfaces,
  91             const dictionary& dict
  92         );
  93
  94
  95     // Destructor
  96
  97         virtual ~amgSolver()
  98         {}
  99
 100
 101     // Member Functions
 102
 103         //- Solve the matrix with this solver
 104         virtual lduSolverPerformance solve
 105         (
 106             scalarField& x,
 107             const scalarField& b,
 108             const direction cmpt = 0
 109         ) const;
 110 };
 111
 112
 113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 114
 115 } // End namespace Foam
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 #endif
 120
 121 // ************************************************************************* //