src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/GAMGAgglomerations/pairGAMGAgglomeration/pairGAMGAgglomeration.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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 Class
  25     Foam::pairGAMGAgglomeration
  26
  27 Description
  28     Agglomerate using the pair algorithm.
  29
  30 SourceFiles
  31     pairGAMGAgglomeration.C
  32     pairGAMGAgglomerate.C
  33     pairGAMGAgglomerationCombineLevels.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef pairGAMGAgglomeration_H
  38 #define pairGAMGAgglomeration_H
  39
  40 #include "GAMGAgglomeration.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class pairGAMGAgglomeration Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class pairGAMGAgglomeration
  52 :
  53     public GAMGAgglomeration
  54 {
  55     // Private data
  56
  57         //- Number of levels to merge, 1 = don't merge, 2 = merge pairs etc.
  58         label mergeLevels_;
  59
  60
  61 protected:
  62
  63     // Protected Member Functions
  64
  65         //- Calculate and return agglomeration of given level
  66         tmp<labelField> agglomerate
  67         (
  68             label& nCoarseCells,
  69             const lduAddressing& fineMatrixAddressing,
  70             const scalarField& faceWeights
  71         );
  72
  73         //- Agglomerate all levels starting from the given face weights
  74         void agglomerate
  75         (
  76             const lduMesh& mesh,
  77             const scalarField& faceWeights
  78         );
  79
  80         void combineLevels(const label curLevel);
  81
  82         //- Disallow default bitwise copy construct
  83         pairGAMGAgglomeration(const pairGAMGAgglomeration&);
  84
  85         //- Disallow default bitwise assignment
  86         void operator=(const pairGAMGAgglomeration&);
  87
  88
  89 public:
  90
  91     //- Runtime type information
  92     TypeName("pair");
  93
  94
  95     // Constructors
  96
  97         //- Construct given mesh and controls
  98         pairGAMGAgglomeration
  99         (
 100             const lduMesh& mesh,
 101             const dictionary& controlDict
 102         );
 103 };
 104
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 } // End namespace Foam
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 #endif
 113
 114 // ************************************************************************* //