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-2019 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  //- Add usage string
58  static addToUsageTable usage_;
59 
60  //- First point on cylinder axis
61  vector p1_;
62 
63  //- Second point on cylinder axis
64  vector p2_;
65 
66  //- Outer Radius
67  scalar outerRadius_;
68 
69  //- Inner Radius
70  scalar innerRadius_;
71 
72 
73  // Private Member Functions
74 
75  void combine(topoSet& set, const bool add) const;
76 
77 
78 public:
79 
80  //- Runtime type information
81  TypeName("cylinderAnnulusToFace");
82 
83 
84  // Constructors
85 
86  //- Construct from components
88  (
89  const polyMesh& mesh,
90  const vector& p1,
91  const vector& p2,
92  const scalar outerRadius,
93  const scalar innerRadius
94  );
95 
96  //- Construct from dictionary
98  (
99  const polyMesh& mesh,
100  const dictionary& dict
101  );
102 
103  //- Construct from Istream
105  (
106  const polyMesh& mesh,
107  Istream&
108  );
109 
110 
111  // Destructor
112  virtual ~cylinderAnnulusToFace();
113 
114  // Member Functions
116  virtual sourceType setType() const
117  {
118  return CELLSETSOURCE;
119  }
120 
121  virtual void applyToSet
122  (
123  const topoSetSource::setAction action,
124  topoSet&
125  ) const;
126 };
127 
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 } // End namespace Foam
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #endif
136 
137 // ************************************************************************* //
cylinderAnnulusToFace(const polyMesh &mesh, const vector &p1, const vector &p2, 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:158
virtual sourceType setType() const
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
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
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
Namespace for OpenFOAM.