All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
normalToFace.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-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::normalToFace
26 
27 Description
28  A topoSetSource to select faces based on normal.
29 
30 SourceFiles
31  normalToFace.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef normalToFace_H
36 #define normalToFace_H
37 
38 #include "topoSetSource.H"
39 #include "NamedEnum.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class normalToFace Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class normalToFace
51 :
52  public topoSetSource
53 {
54 
55 private:
56 
57  //- Add usage string
58  static addToUsageTable usage_;
59 
60  //- (unit)vector to compare to
61  vector normal_;
62 
63  //- Tolerance (i.e. cos of angle between normal_ and faceNormal)
64  const scalar tol_;
65 
66 
67  // Private Member Functions
68 
69  //- Normalise normal and check tolerance
70  void setNormal();
71 
72 
73 public:
74 
75  //- Runtime type information
76  TypeName("normalToFace");
77 
78  // Constructors
79 
80  //- Construct from components
82  (
83  const polyMesh& mesh,
84  const vector& normal,
85  const scalar tol
86  );
87 
88  //- Construct from dictionary
89  normalToFace(const polyMesh& mesh, const dictionary& dict);
90 
91  //- Construct from Istream
92  normalToFace(const polyMesh& mesh, Istream&);
93 
94 
95  //- Destructor
96  virtual ~normalToFace();
97 
98 
99  // Member Functions
101  virtual sourceType setType() const
102  {
103  return FACESETSOURCE;
104  }
105 
106  virtual void applyToSet
107  (
108  const topoSetSource::setAction action,
109  topoSet&
110  ) const;
111 
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace Foam
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 #endif
122 
123 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
TypeName("normalToFace")
Runtime type information.
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: normalToFace.C:113
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
const polyMesh & mesh() const
virtual sourceType setType() const
Definition: normalToFace.H:100
A topoSetSource to select faces based on normal.
Definition: normalToFace.H:49
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
virtual ~normalToFace()
Destructor.
Definition: normalToFace.C:106
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
Class with constructor to add usage string to table.
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:70
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
normalToFace(const polyMesh &mesh, const vector &normal, const scalar tol)
Construct from components.
Definition: normalToFace.C:70
Namespace for OpenFOAM.