cylinderAnnulusToFace.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) 2017-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::cylinderAnnulusToFace
26 
27 Description
28  A topoSetSource to select faces based on face centres inside a
29  cylinder annulus.
30 
31 SourceFiles
32  cylinderAnnulusToFace.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef cylinderAnnulusToFace_H
37 #define cylinderAnnulusToFace_H
38 
39 #include "topoSetSource.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class cylinderAnnulusToFace Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public topoSetSource
53 {
54 
55  // Private Data
56 
57 
58  //- First point on cylinder axis
59  vector point1_;
60 
61  //- Second point on cylinder axis
62  vector point2_;
63 
64  //- Outer Radius
65  scalar outerRadius_;
66 
67  //- Inner Radius
68  scalar innerRadius_;
69 
70 
71  // Private Member Functions
72 
73  void combine(topoSet& set, const bool add) const;
74 
75 
76 public:
77 
78  //- Runtime type information
79  TypeName("cylinderAnnulusToFace");
80 
81 
82  // Constructors
83 
84  //- Construct from components
86  (
87  const polyMesh& mesh,
88  const vector& point1,
89  const vector& point2,
90  const scalar outerRadius,
91  const scalar innerRadius
92  );
93 
94  //- Construct from dictionary
96  (
97  const polyMesh& mesh,
98  const dictionary& dict
99  );
100 
101 
102  // Destructor
103  virtual ~cylinderAnnulusToFace();
104 
105 
106  // Member Functions
108  virtual sourceType setType() const
109  {
110  return FACESETSOURCE;
111  }
112 
113  virtual void applyToSet
114  (
115  const topoSetSource::setAction action,
116  topoSet&
117  ) const;
118 };
119 
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 } // End namespace Foam
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 #endif
128 
129 // ************************************************************************* //
cylinderAnnulusToFace(const polyMesh &mesh, const vector &point1, const vector &point2, const scalar outerRadius, const scalar innerRadius)
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
virtual sourceType setType() const
TypeName("cylinderAnnulusToFace")
Runtime type information.
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
A topoSetSource to select faces based on face centres inside a cylinder annulus.
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
const polyMesh & mesh() const
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
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
Namespace for OpenFOAM.