eagerGAMGProcAgglomeration.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) 2013-2018 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::eagerGAMGProcAgglomeration
26 
27 Description
28  'Eager' processor agglomeration of GAMGAgglomerations: at every
29  level agglomerates 'mergeLevels' number of processors onto the
30  minimum processor number.
31 
32 SourceFiles
33  eagerGAMGProcAgglomeration.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef eagerGAMGProcAgglomeration_H
38 #define eagerGAMGProcAgglomeration_H
39 
40 #include "GAMGProcAgglomeration.H"
41 #include "DynamicList.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 class GAMGAgglomeration;
49 
50 /*---------------------------------------------------------------------------*\
51  Class eagerGAMGProcAgglomeration Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
57 {
58  // Private data
59 
60  //- Agglpmeration level
61  const label mergeLevels_;
62 
63  DynamicList<label> comms_;
64 
65  // Private Member Functions
66 
67  //- Disallow default bitwise copy construct
69  (
71  );
72 
73  //- Disallow default bitwise assignment
74  void operator=(const eagerGAMGProcAgglomeration&);
75 
76 
77 public:
78 
79  //- Runtime type information
80  TypeName("eager");
81 
82 
83  // Constructors
84 
85  //- Construct given agglomerator and controls
87  (
88  GAMGAgglomeration& agglom,
89  const dictionary& controlDict
90  );
91 
92 
93  //- Destructor
95 
96 
97  // Member Functions
98 
99  //- Modify agglomeration. Return true if modified
100  virtual bool agglomerate();
101 
102 };
103 
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 } // End namespace Foam
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // ************************************************************************* //
TypeName("eager")
Runtime type information.
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
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual bool agglomerate()
Modify agglomeration. Return true if modified.
&#39;Eager&#39; processor agglomeration of GAMGAgglomerations: at every level agglomerates &#39;mergeLevels&#39; numb...
Processor agglomeration of GAMGAgglomerations.
Geometric agglomerated algebraic multigrid agglomeration class.
Namespace for OpenFOAM.