pairGAMGAgglomeration.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2020 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 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef pairGAMGAgglomeration_H
37 #define pairGAMGAgglomeration_H
38 
39 #include "GAMGAgglomeration.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class pairGAMGAgglomeration Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public GAMGAgglomeration
53 {
54  // Private Data
55 
56  //- Number of levels to merge, 1 = don't merge, 2 = merge pairs etc.
57  label mergeLevels_;
58 
59  //- Direction of cell loop for the current level
60  static bool forward_;
61 
62 
63 protected:
64 
65  // Protected Member Functions
66 
67  //- Agglomerate all levels starting from the given face weights
68  void agglomerate
69  (
70  const lduMesh& mesh,
71  const scalarField& faceWeights
72  );
73 
74 
75 public:
76 
77  //- Runtime type information
78  TypeName("pair");
79 
80 
81  // Constructors
82 
83  //- Construct given mesh and controls
85  (
86  const lduMesh& mesh,
87  const dictionary& controlDict
88  );
89 
90  //- Disallow default bitwise copy construction
92 
93  //- Calculate and return agglomeration
95  (
96  label& nCoarseCells,
97  const lduAddressing& fineMatrixAddressing,
98  const scalarField& faceWeights
99  );
100 
101 
102  // Member Operators
103 
104  //- Disallow default bitwise assignment
105  void operator=(const pairGAMGAgglomeration&) = delete;
106 };
107 
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 } // End namespace Foam
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 #endif
116 
117 // ************************************************************************* //
Geometric agglomerated algebraic multigrid agglomeration class.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
The class contains the addressing required by the lduMatrix: upper, lower and losort.
Abstract base class for meshes which provide LDU addressing for the construction of lduMatrix and LDU...
Definition: lduMesh.H:60
Agglomerate using the pair algorithm.
void agglomerate(const lduMesh &mesh, const scalarField &faceWeights)
Agglomerate all levels starting from the given face weights.
TypeName("pair")
Runtime type information.
void operator=(const pairGAMGAgglomeration &)=delete
Disallow default bitwise assignment.
pairGAMGAgglomeration(const lduMesh &mesh, const dictionary &controlDict)
Construct given mesh and controls.
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
runTime controlDict().lookup("adjustTimeStep") >> adjustTimeStep