FreeFOAM The Cross-Platform CFD Toolkit
regionToCell.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::regionToCell
26 
27 Description
28  TopoSetSource. Select cells belonging to topological connected region
29  (that contains given point)
30 
31 SourceFiles
32  regionToCell.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef regionToCell_H
37 #define regionToCell_H
38 
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class regionToCell Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public topoSetSource
53 {
54 
55  // Private data
56 
57  //- Add usage string
58  static addToUsageTable usage_;
59 
60  //- Name of cellSet to keep to
61  word setName_;
62 
63  //- Coordinate that is inside connected region
64  point insidePoint_;
65 
66 
67  // Private Member Functions
68 
69  void combine(topoSet& set, const bool add) const;
70 
71 
72 public:
73 
74  //- Runtime type information
75  TypeName("regionToCell");
76 
77  // Constructors
78 
79  //- Construct from components
81  (
82  const polyMesh& mesh,
83  const word& setName,
84  const point& insidePoint
85  );
86 
87  //- Construct from dictionary
89  (
90  const polyMesh& mesh,
91  const dictionary& dict
92  );
93 
94  //- Construct from Istream
96  (
97  const polyMesh& mesh,
98  Istream&
99  );
100 
101 
102  // Destructor
103 
104  virtual ~regionToCell();
105 
106 
107  // Member Functions
108 
109  virtual void applyToSet(const topoSetSource::setAction action, 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: ************************ //