faceSet.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011 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 
54 
55 public:
56 
57  //- Runtime type information
58  TypeName("faceSet");
59 
60 
61  // Constructors
62 
63 
64  //- Construct from IOobject
65  faceSet(const IOobject& obj);
66 
67  //- Construct from objectRegistry and name
68  faceSet
69  (
70  const polyMesh& mesh,
71  const word& name,
74  );
75 
76  //- Construct from additional size of labelHashSet
77  faceSet
78  (
79  const polyMesh& mesh,
80  const word& name,
81  const label,
83  );
84 
85  //- Construct from existing set
86  faceSet
87  (
88  const polyMesh& mesh,
89  const word& name,
90  const topoSet&,
92  );
93 
94  //- Construct from additional labelHashSet
95  faceSet
96  (
97  const polyMesh& mesh,
98  const word& name,
99  const labelHashSet&,
101  );
102 
103 
104  //- Destructor
105  virtual ~faceSet();
106 
107 
108  // Member functions
109 
110  //- Sync faceSet across coupled patches.
111  virtual void sync(const polyMesh& mesh);
112 
113  //- Return max index+1.
114  virtual label maxSize(const polyMesh& mesh) const;
115 
116  //- Update any stored data for new labels
117  virtual void updateMesh(const mapPolyMesh& morphMap);
118 
119  //- Write maxLen items with label and coordinates.
120  virtual void writeDebug
121  (
122  Ostream& os,
123  const primitiveMesh&,
124  const label maxLen
125  ) const;
126 
127 };
128 
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 } // End namespace Foam
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 #endif
137 
138 // ************************************************************************* //
virtual label maxSize(const polyMesh &mesh) const
Return max index+1.
Definition: faceSet.C:152
A list of face labels.
Definition: faceSet.H:48
TypeName("faceSet")
Runtime type information.
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Definition: mapPolyMesh.H:158
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
A class for handling words, derived from string.
Definition: word.H:59
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
dynamicFvMesh & mesh
virtual void updateMesh(const mapPolyMesh &morphMap)
Update any stored data for new labels.
Definition: faceSet.C:158
Namespace for OpenFOAM.
Cell-face mesh analysis engine.
Definition: primitiveMesh.H:74
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:91
virtual void sync(const polyMesh &mesh)
Sync faceSet across coupled patches.
Definition: faceSet.C:113
readOption
Enumeration defining the read options.
Definition: IOobject.H:106
const word & name() const
Return name.
Definition: IOobject.H:260
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
writeOption
Enumeration defining the write options.
Definition: IOobject.H:115
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
virtual ~faceSet()
Destructor.
Definition: faceSet.C:107
virtual void writeDebug(Ostream &os, const primitiveMesh &, const label maxLen) const
Write maxLen items with label and coordinates.
Definition: faceSet.C:165
faceSet(const IOobject &obj)
Construct from IOobject.
Definition: faceSet.C:49