setAndNormalToFaceZone.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) 2013-2021 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::setAndNormalToFaceZone
26 
27 Description
28  A topoSetSource to select faces based on usage in a faceSet, where the
29  normal vector is used to orient the faces.
30 
31 SourceFiles
32  setAndNormalToFaceZone.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef setAndNormalToFaceZone_H
37 #define setAndNormalToFaceZone_H
38 
39 #include "topoSetSource.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class setAndNormalToFaceZone Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public topoSetSource
53 {
54  // Private Data
55 
56 
57  //- Name of set to use
58  word setName_;
59 
60  //- Normal used to orient the faces
61  vector normal_;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("setAndNormalToFaceZone");
68 
69  // Constructors
70 
71  //- Construct from components
73  (
74  const polyMesh& mesh,
75  const word& setName,
76  const vector& normal
77  );
78 
79  //- Construct from dictionary
81  (
82  const polyMesh& mesh,
83  const dictionary& dict
84  );
85 
86 
87  //- Destructor
88  virtual ~setAndNormalToFaceZone();
89 
90 
91  // Member Functions
92 
93  virtual sourceType setType() const
94  {
95  return FACEZONESOURCE;
96  }
97 
98  virtual void applyToSet
99  (
100  const topoSetSource::setAction action,
101  topoSet&
102  ) const;
103 
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #endif
114 
115 // ************************************************************************* //
setAndNormalToFaceZone(const polyMesh &mesh, const word &setName, const vector &normal)
Construct from components.
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
A topoSetSource to select faces based on usage in a faceSet, where the normal vector is used to orien...
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
virtual sourceType setType() const
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:70
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:76
TypeName("setAndNormalToFaceZone")
Runtime type information.
virtual ~setAndNormalToFaceZone()
Destructor.
Namespace for OpenFOAM.