Formatting
[foam-extend-3.2.git] / src / fvAgglomerationMethods / MGridGenGamgAgglomeration / MGridGenGAMGAgglomeration.H
blobd1b6d9969bfd69e5eec8e6e50b9be65fa0a1cd1f
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.
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.
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.
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/>.
24 Class
25     Foam::MGridGenGAMGAgglomeration
27 Description
28     Agglomerate using the MGridGen algorithm.
30 SourceFiles
31     MGridGenGAMGAgglomeration.C
32     MGridGenGAMGAgglomerate.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef MGridGenGAMGAgglomeration_H
37 #define MGridGenGAMGAgglomeration_H
39 #include "fvMesh.H"
40 #include "GAMGAgglomeration.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 class fvMesh;
49 /*---------------------------------------------------------------------------*\
50                    Class MGridGenGAMGAgglomeration Declaration
51 \*---------------------------------------------------------------------------*/
53 class MGridGenGAMGAgglomeration
55     public GAMGAgglomeration
57     // Private data
59         const fvMesh& fvMesh_;
62     // Private Member Functions
64         //- Construct the CSR format addressing
65         void makeCompactCellFaceAddressingAndFaceWeights
66         (
67             const lduAddressing& fineAddressing,
68             labelList& cellCells,
69             labelList& cellCellOffsets,
70             const vectorField& Si,
71             List<scalar>& faceWeights
72         );
74         //- Calculate and return agglomeration
75         tmp<labelField> agglomerate
76         (
77             label& nCoarseCells,
78             const label minSize,
79             const label maxSize,
80             const lduAddressing& fineAddressing,
81             const scalarField& V,
82             const vectorField& Sf,
83             const scalarField& Sb
84         );
87         //- Disallow default bitwise copy construct
88         MGridGenGAMGAgglomeration(const MGridGenGAMGAgglomeration&);
90         //- Disallow default bitwise assignment
91         void operator=(const MGridGenGAMGAgglomeration&);
94 public:
96     //- Runtime type information
97     TypeName("MGridGen");
100     // Constructors
102         //- Construct given mesh and controls
103         MGridGenGAMGAgglomeration
104         (
105             const lduMesh& mesh,
106             const dictionary& dict
107         );
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 } // End namespace Foam
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 #endif
119 // ************************************************************************* //