FreeFOAM The Cross-Platform CFD Toolkit
sphereToCell.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::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 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class sphereToCell Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
51  public topoSetSource
52 {
53 
54  // Private data
55 
56  //- Add usage string
57  static addToUsageTable usage_;
58 
59  //- Centre
60  vector centre_;
61 
62  //- Radius
63  scalar radius_;
64 
65 
66  // Private Member Functions
67 
68  void combine(topoSet& set, const bool add) const;
69 
70 
71 public:
72 
73  //- Runtime type information
74  TypeName("sphereToCell");
75 
76 
77  // Constructors
78 
79  //- Construct from components
81  (
82  const polyMesh& mesh,
83  const vector& centre,
84  const scalar radius
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 ~sphereToCell();
105 
106 
107  // Member Functions
108 
109  virtual void applyToSet
110  (
111  const topoSetSource::setAction action,
112  topoSet&
113  ) const;
114 
115 };
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace Foam
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 #endif
125 
126 // ************************ vim: set sw=4 sts=4 et: ************************ //