boxToCell.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::boxToCell
26 
27 Description
28  A topoSetSource to select cells based on cell centres inside box(es).
29 
30 SourceFiles
31  boxToCell.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef boxToCell_H
36 #define boxToCell_H
37 
38 #include "topoSetSource.H"
39 #include "treeBoundBoxList.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class boxToCell Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class boxToCell
51 :
52  public topoSetSource
53 {
54  // Private Data
55 
56  //- Bounding box.
57  treeBoundBoxList bbs_;
58 
59 
60  // Private Member Functions
61 
62  void combine(topoSet& set, const bool add) const;
63 
64 
65 public:
66 
67  //- Runtime type information
68  TypeName("boxToCell");
69 
70 
71  // Constructors
72 
73  //- Construct from components
74  boxToCell
75  (
76  const polyMesh& mesh,
77  const treeBoundBoxList& bbs
78  );
79 
80  //- Construct from dictionary
81  boxToCell
82  (
83  const polyMesh& mesh,
84  const dictionary& dict
85  );
86 
87 
88  //- Destructor
89  virtual ~boxToCell();
90 
91 
92  // Member Functions
93 
94  virtual sourceType setType() const
95  {
96  return CELLSETSOURCE;
97  }
98 
99  virtual void applyToSet
100  (
101  const topoSetSource::setAction action,
102  topoSet&
103  ) const;
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #endif
114 
115 // ************************************************************************* //
A topoSetSource to select cells based on cell centres inside box(es).
Definition: boxToCell.H:52
virtual ~boxToCell()
Destructor.
Definition: boxToCell.C:90
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: boxToCell.C:97
virtual sourceType setType() const
Definition: boxToCell.H:93
boxToCell(const polyMesh &mesh, const treeBoundBoxList &bbs)
Construct from components.
Definition: boxToCell.C:62
TypeName("boxToCell")
Runtime type information.
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
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