setsToFaceZone.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::setsToFaceZone
26 
27 Description
28  A topoSetSource to select faces based on usage in a faceSet and cellSet
29 
30 SourceFiles
31  setsToFaceZone.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef setsToFaceZone_H
36 #define setsToFaceZone_H
37 
38 #include "topoSetSource.H"
39 #include "Switch.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class setsToFaceZone Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class setsToFaceZone
51 :
52  public topoSetSource
53 {
54  // Private Data
55 
56  //- Name of set to use
57  const word faceSetName_;
58 
59  //- Name of set to use
60  const word cellSetName_;
61 
62  //- Whether cellSet is slave cells or master cells
63  const Switch flip_;
64 
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("setsToFaceZone");
70 
71 
72  // Constructors
73 
74  //- Construct from components
76  (
77  const polyMesh& mesh,
78  const word& faceSetName,
79  const word& cellSetName,
80  const Switch& flip
81  );
82 
83  //- Construct from dictionary
85  (
86  const polyMesh& mesh,
87  const dictionary& dict
88  );
89 
90 
91  //- Destructor
92  virtual ~setsToFaceZone();
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 } // End namespace Foam
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 #endif
117 
118 // ************************************************************************* //
A simple wrapper around bool so that it can be read as a word: true/false, on/off,...
Definition: Switch.H:61
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:80
A topoSetSource to select faces based on usage in a faceSet and cellSet.
virtual ~setsToFaceZone()
Destructor.
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
virtual sourceType setType() const
setsToFaceZone(const polyMesh &mesh, const word &faceSetName, const word &cellSetName, const Switch &flip)
Construct from components.
TypeName("setsToFaceZone")
Runtime type information.
Base class of a source for a topoSet.
Definition: topoSetSource.H:64
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:71
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:83
const polyMesh & mesh() const
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.
dictionary dict