All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
cylinderToCell.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::cylinderToCell
26 
27 Description
28  A topoSetSource to select cells based on cell centres inside a cylinder.
29 
30 SourceFiles
31  cylinderToCell.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cylinderToCell_H
36 #define cylinderToCell_H
37 
38 #include "topoSetSource.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class cylinderToCell Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class cylinderToCell
50 :
51  public topoSetSource
52 {
53 
54  // Private Data
55 
56  //- Add usage string
57  static addToUsageTable usage_;
58 
59  //- First point on cylinder axis
60  vector point1_;
61 
62  //- Second point on cylinder axis
63  vector point2_;
64 
65  //- Radius
66  scalar radius_;
67 
68 
69  // Private Member Functions
70 
71  void combine(topoSet& set, const bool add) const;
72 
73 
74 public:
75 
76  //- Runtime type information
77  TypeName("cylinderToCell");
78 
79 
80  // Constructors
81 
82  //- Construct from components
84  (
85  const polyMesh& mesh,
86  const vector& point1,
87  const vector& point2,
88  const scalar radius
89  );
90 
91  //- Construct from dictionary
93  (
94  const polyMesh& mesh,
95  const dictionary& dict
96  );
97 
98  //- Construct from Istream
100  (
101  const polyMesh& mesh,
102  Istream&
103  );
104 
105 
106  //- Destructor
107  virtual ~cylinderToCell();
108 
109 
110  // Member Functions
112  virtual sourceType setType() const
113  {
114  return CELLSETSOURCE;
115  }
116 
117  virtual void applyToSet
118  (
119  const topoSetSource::setAction action,
120  topoSet&
121  ) const;
122 
123 };
124 
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 } // End namespace Foam
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 #endif
133 
134 // ************************************************************************* //
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
A topoSetSource to select cells based on cell centres inside a cylinder.
TypeName("cylinderToCell")
Runtime type information.
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
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
virtual sourceType setType() const
cylinderToCell(const polyMesh &mesh, const vector &point1, const vector &point2, const scalar radius)
Construct from components.
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
virtual ~cylinderToCell()
Destructor.
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.