sphereToCell.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-2024 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::sphereToCell
26 
27 Description
28  A topoSetSource to select cells based on cell centres inside sphere.
29 
30 SourceFiles
31  sphereToCell.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef sphereToCell_H
36 #define sphereToCell_H
37 
38 #include "topoSetSource.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class sphereToCell Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class sphereToCell
50 :
51  public topoSetSource
52 {
53  // Private Data
54 
55  //- Centre
56  vector centre_;
57 
58  //- Radius
59  scalar radius_;
60 
61 
62  // Private Member Functions
63 
64  void combine(topoSet& set, const bool add) const;
65 
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("sphereToCell");
71 
72 
73  // Constructors
74 
75  //- Construct from components
77  (
78  const polyMesh& mesh,
79  const vector& centre,
80  const scalar radius
81  );
82 
83  //- Construct from dictionary
85  (
86  const polyMesh& mesh,
87  const dictionary& dict
88  );
89 
90 
91  //- Destructor
92  virtual ~sphereToCell();
93 
94 
95  // Member Functions
96 
97  virtual sourceType setType() const
98  {
99  return CELLSETSOURCE;
100  }
101 
102  virtual void applyToSet
103  (
104  const topoSetSource::setAction action,
105  topoSet&
106  ) const;
107 };
108 
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 } // End namespace Foam
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 #endif
117 
118 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:80
A topoSetSource to select cells based on cell centres inside sphere.
Definition: sphereToCell.H:51
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: sphereToCell.C:94
virtual sourceType setType() const
Definition: sphereToCell.H:96
TypeName("sphereToCell")
Runtime type information.
sphereToCell(const polyMesh &mesh, const vector &centre, const scalar radius)
Construct from components.
Definition: sphereToCell.C:61
virtual ~sphereToCell()
Destructor.
Definition: sphereToCell.C:87
Base class of a source for a topoSet.
Definition: topoSetSource.H:64
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:71
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:83
const polyMesh & mesh() const
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:65
Namespace for OpenFOAM.
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
dictionary dict