All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
faceSet.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-2024 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::faceSet
26 
27 Description
28  A list of face labels.
29 
30 SourceFiles
31  faceSet.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef faceSet_H
36 #define faceSet_H
37 
38 #include "topoSet.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class faceSet Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class faceSet
50 :
51  public topoSet
52 {
53 public:
54 
55  //- Runtime type information
56  TypeName("faceSet");
57 
58 
59  // Constructors
60 
61  //- Construct from IOobject
62  faceSet(const IOobject& obj);
63 
64  //- Construct from objectRegistry and name
65  faceSet
66  (
67  const polyMesh& mesh,
68  const word& name,
71  );
72 
73  //- Construct from additional size of labelHashSet
74  faceSet
75  (
76  const polyMesh& mesh,
77  const word& name,
78  const label,
80  );
81 
82  //- Construct from existing set
83  faceSet
84  (
85  const polyMesh& mesh,
86  const word& name,
87  const topoSet&,
89  );
90 
91  //- Construct from additional labelHashSet
92  faceSet
93  (
94  const polyMesh& mesh,
95  const word& name,
96  const labelHashSet&,
98  );
99 
100 
101  //- Destructor
102  virtual ~faceSet();
103 
104 
105  // Member Functions
106 
107  //- Sync faceSet across coupled patches.
108  virtual void sync(const polyMesh& mesh);
109 
110  //- Return max index+1.
111  virtual label maxSize(const polyMesh& mesh) const;
112 
113  //- Update any stored data for new labels
114  virtual void topoChange(const polyTopoChangeMap& map);
115 
116  //- Write maxLen items with label and coordinates.
117  virtual void writeDebug
118  (
119  Ostream& os,
120  const primitiveMesh&,
121  const label maxLen
122  ) const;
123 };
124 
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 } // End namespace Foam
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 #endif
133 
134 // ************************************************************************* //
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:99
readOption
Enumeration defining the read options.
Definition: IOobject.H:117
const word & name() const
Return name.
Definition: IOobject.H:310
writeOption
Enumeration defining the write options.
Definition: IOobject.H:126
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of face labels.
Definition: faceSet.H:51
virtual label maxSize(const polyMesh &mesh) const
Return max index+1.
Definition: faceSet.C:152
TypeName("faceSet")
Runtime type information.
virtual void sync(const polyMesh &mesh)
Sync faceSet across coupled patches.
Definition: faceSet.C:113
faceSet(const IOobject &obj)
Construct from IOobject.
Definition: faceSet.C:49
virtual void writeDebug(Ostream &os, const primitiveMesh &, const label maxLen) const
Write maxLen items with label and coordinates.
Definition: faceSet.C:165
virtual ~faceSet()
Destructor.
Definition: faceSet.C:107
virtual void topoChange(const polyTopoChangeMap &map)
Update any stored data for new labels.
Definition: faceSet.C:158
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:80
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Cell-face mesh analysis engine.
Definition: primitiveMesh.H:75
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:65
A class for handling words, derived from string.
Definition: word.H:62
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