FreeFOAM The Cross-Platform CFD Toolkit
normalToFace.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) 1991-2010 OpenCFD Ltd.
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 
39 #include <OpenFOAM/NamedEnum.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class normalToFace Declaration
48 \*---------------------------------------------------------------------------*/
49 
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  //- Normalize 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 
97  virtual ~normalToFace();
98 
99 
100  // Member Functions
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 // ************************ vim: set sw=4 sts=4 et: ************************ //