setToFaceZone.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-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::setToFaceZone
26 
27 Description
28  A topoSetSource to select faces based on usage in a faceSet. Sets flipMap
29  to true.
30 
31 SourceFiles
32  setToFaceZone.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef setToFaceZone_H
37 #define setToFaceZone_H
38 
39 #include "topoSetSource.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class setToFaceZone Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class setToFaceZone
51 :
52  public topoSetSource
53 {
54  // Private data
55 
56  //- Add usage string
57  static addToUsageTable usage_;
58 
59  //- Name of set to use
60  word setName_;
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("setToFaceZone");
66 
67  // Constructors
68 
69  //- Construct from components
71  (
72  const polyMesh& mesh,
73  const word& setName
74  );
75 
76  //- Construct from dictionary
78  (
79  const polyMesh& mesh,
80  const dictionary& dict
81  );
82 
83  //- Construct from Istream
85  (
86  const polyMesh& mesh,
87  Istream&
88  );
89 
90 
91  //- Destructor
92  virtual ~setToFaceZone();
93 
94 
95  // Member Functions
96 
97  virtual sourceType setType() const
98  {
99  return FACEZONESOURCE;
100  }
101 
102  virtual void applyToSet
103  (
104  const topoSetSource::setAction action,
105  topoSet&
106  ) const;
107 
108 };
109 
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #endif
118 
119 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
virtual sourceType setType() const
Definition: setToFaceZone.H:96
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
const polyMesh & mesh() const
A class for handling words, derived from string.
Definition: word.H:59
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
TypeName("setToFaceZone")
Runtime type information.
setToFaceZone(const polyMesh &mesh, const word &setName)
Construct from components.
Definition: setToFaceZone.C:53
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
virtual ~setToFaceZone()
Destructor.
Definition: setToFaceZone.C:87
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:70
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
A topoSetSource to select faces based on usage in a faceSet. Sets flipMap to true.
Definition: setToFaceZone.H:49
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: setToFaceZone.C:94
Namespace for OpenFOAM.