masterCoarsestGAMGProcAgglomeration.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-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::masterCoarsestGAMGProcAgglomeration
26 
27 Description
28  Processor agglomeration of GAMGAgglomerations.
29 
30 SourceFiles
31  masterCoarsestGAMGProcAgglomeration.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef masterCoarsestGAMGProcAgglomeration_H
36 #define masterCoarsestGAMGProcAgglomeration_H
37 
38 #include "GAMGProcAgglomeration.H"
39 #include "DynamicList.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 class GAMGAgglomeration;
47 
48 /*---------------------------------------------------------------------------*\
49  Class masterCoarsestGAMGProcAgglomeration Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
55 {
56  // Private Data
57 
58  DynamicList<label> comms_;
59 
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("masterCoarsest");
65 
66 
67  // Constructors
68 
69  //- Construct given agglomerator and controls
71  (
72  GAMGAgglomeration& agglom,
73  const dictionary& controlDict
74  );
75 
76  //- Disallow default bitwise copy construction
78  (
80  );
81 
82 
83  //- Destructor
85 
86 
87  // Member Functions
88 
89  //- Modify agglomeration. Return true if modified
90  virtual bool agglomerate();
91 
92  //- Disallow default bitwise assignment
93 
94 
95  // Member Operators
96 
97  void operator=(const masterCoarsestGAMGProcAgglomeration&) = delete;
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace Foam
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #endif
108 
109 // ************************************************************************* //
virtual bool agglomerate()
Modify agglomeration. Return true if modified.
void operator=(const masterCoarsestGAMGProcAgglomeration &)=delete
Disallow default bitwise assignment.
runTime controlDict().lookup("adjustTimeStep") >> adjustTimeStep
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
TypeName("masterCoarsest")
Runtime type information.
A 1D vector of objects of type <T> that resizes itself as necessary to accept the new objects...
Definition: DynamicList.H:56
Processor agglomeration of GAMGAgglomerations.
masterCoarsestGAMGProcAgglomeration(GAMGAgglomeration &agglom, const dictionary &controlDict)
Construct given agglomerator and controls.
Processor agglomeration of GAMGAgglomerations.
Geometric agglomerated algebraic multigrid agglomeration class.
Namespace for OpenFOAM.