FreeFOAM The Cross-Platform CFD Toolkit
boxToCell.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
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.
29 
30 SourceFiles
31  boxToCell.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef boxToCell_H
36 #define boxToCell_H
37 
39 #include <meshTools/treeBoundBox.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 
55  // Private data
56 
57  //- Add usage string
58  static addToUsageTable usage_;
59 
60 
61  //- bounding box.
62  treeBoundBox bb_;
63 
64 
65  // Private Member Functions
66 
67  void combine(topoSet& set, const bool add) const;
68 
69 
70 public:
71 
72  //- Runtime type information
73  TypeName("boxToCell");
74 
75  // Constructors
76 
77  //- Construct from components
78  boxToCell
79  (
80  const polyMesh& mesh,
81  const treeBoundBox& bb
82  );
83 
84  //- Construct from dictionary
85  boxToCell
86  (
87  const polyMesh& mesh,
88  const dictionary& dict
89  );
90 
91  //- Construct from Istream
92  boxToCell
93  (
94  const polyMesh& mesh,
95  Istream&
96  );
97 
98 
99  // Destructor
100 
101  virtual ~boxToCell();
102 
103 
104  // Member Functions
105 
106  virtual void applyToSet
107  (
108  const topoSetSource::setAction action,
109  topoSet&
110  ) const;
111 
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace Foam
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 #endif
122 
123 // ************************ vim: set sw=4 sts=4 et: ************************ //