generatedZoneSet.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) 2025 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::generatedZoneSet
26 
27 Description
28 
29 
30 See also
31  Foam::zoneSet
32  Foam::zoneGenerator
33 
34 SourceFiles
35  generatedZoneSet.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef generatedZoneSet_H
40 #define generatedZoneSet_H
41 
42 #include "zoneGenerator.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class generatedZoneSet Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class generatedZoneSet
54 :
55  public zoneSet
56 {
57  // Private Member Data
58 
59  autoPtr<zoneGenerator> zoneGenerator_;
60 
61 
62 public:
63 
64  // Constructors
65 
66  //- Construct null
68  {}
69 
70  //- Construct from name, mesh and dictionary
72  (
73  const word& name,
74  const polyMesh& mesh,
75  const dictionary& dict
76  );
77 
78  //- Construct from name, zoneType, mesh and dictionary
80  (
81  const word& name,
82  const zoneTypes& zoneType,
83  const polyMesh& mesh,
84  const dictionary& dict
85  );
86 
87  //- Disallow default bitwise copy construction
88  generatedZoneSet(const generatedZoneSet&) = delete;
89 
90 
91  // Member Functions
92 
93  //- Read from dictionary
94  void read
95  (
96  const word& name,
97  const polyMesh& mesh,
98  const dictionary& dict
99  );
100 
101  //- Read from dictionary
102  void read
103  (
104  const word& name,
105  const zoneTypes& zoneType,
106  const polyMesh& mesh,
107  const dictionary& dict
108  );
109 
110  //- Set the zoneGenerator and generate the zoneSet
111  void set(const autoPtr<zoneGenerator>& zg);
112 
113  //- Update for mesh motion
114  bool movePoints();
115 
116  //- Redistribute or update using the given distribution map
117  void distribute(const polyDistributionMap& map);
118 
119  //- Update topology using the given map
120  void topoChange(const polyTopoChangeMap& map);
121 
122  //- Update from another mesh using the given map
123  void mapMesh(const polyMeshMap& map);
124 
125 
126  // Member Operators
127 
128  //- Disallow default bitwise assignment
129  void operator=(const generatedZoneSet&) = delete;
130 };
131 
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 } // End namespace Foam
136 
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 
139 #endif
140 
141 // ************************************************************************* //
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
bool movePoints()
Update for mesh motion.
void read(const word &name, const polyMesh &mesh, const dictionary &dict)
Read from dictionary.
generatedZoneSet()
Construct null.
void operator=(const generatedZoneSet &)=delete
Disallow default bitwise assignment.
void set(const autoPtr< zoneGenerator > &zg)
Set the zoneGenerator and generate the zoneSet.
void mapMesh(const polyMeshMap &map)
Update from another mesh using the given map.
void distribute(const polyDistributionMap &map)
Redistribute or update using the given distribution map.
void topoChange(const polyTopoChangeMap &map)
Update topology using the given map.
Class containing mesh-to-mesh mapping information after a mesh distribution where we send parts of me...
Class containing mesh-to-mesh mapping information.
Definition: polyMeshMap.H:51
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:80
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
A class for handling words, derived from string.
Definition: word.H:62
Zone container returned by zoneGenerator::generate.
Definition: zoneSet.H:94
Foam::fvMesh mesh(Foam::IOobject(regionName, runTime.name(), runTime, Foam::IOobject::MUST_READ), false)
Namespace for OpenFOAM.
word name(const LagrangianState state)
Return a string representation of a Lagrangian state enumeration.
zoneTypes
Enumeration defining the zone types.
Definition: zoneSet.H:66
dictionary dict