setAndNormalToFaceZone.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) 2013 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  //- Add usage string
57  static addToUsageTable usage_;
58 
59  //- Name of set to use
60  word setName_;
61 
62  //- Normal used to orient the faces
63  vector normal_;
64 
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("setAndNormalToFaceZone");
70 
71  // Constructors
72 
73  //- Construct from components
75  (
76  const polyMesh& mesh,
77  const word& setName,
78  const vector& normal
79  );
80 
81  //- Construct from dictionary
83  (
84  const polyMesh& mesh,
85  const dictionary& dict
86  );
87 
88  //- Construct from Istream
90  (
91  const polyMesh& mesh,
92  Istream&
93  );
94 
95 
96  //- Destructor
97  virtual ~setAndNormalToFaceZone();
98 
99 
100  // Member Functions
102  virtual sourceType setType() const
103  {
104  return FACEZONESOURCE;
105  }
106 
107  virtual void applyToSet
108  (
109  const topoSetSource::setAction action,
110  topoSet&
111  ) const;
112 
113 };
114 
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 } // End namespace Foam
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 #endif
123 
124 // ************************************************************************* //
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:137
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
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
A normal distribution model.
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
TypeName("setAndNormalToFaceZone")
Runtime type information.
virtual ~setAndNormalToFaceZone()
Destructor.
Namespace for OpenFOAM.