FreeFOAM The Cross-Platform CFD Toolkit
zoneToCell.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::zoneToCell
26 
27 Description
28  A topoSetSource to select faces based on cellZone.
29 
30 SourceFiles
31  zoneToCell.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef zoneToCell_H
36 #define zoneToCell_H
37 
39 #include <OpenFOAM/wordRe.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class zoneToCell Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public topoSetSource
53 {
54 
55  // Private data
56 
57  //- Add usage string
58  static addToUsageTable usage_;
59 
60  //- Name/regular expression of cellZone
61  wordRe zoneName_;
62 
63 
64  // Private Member Functions
65 
66  void combine(topoSet& set, const bool add) const;
67 
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("zoneToCell");
73 
74  // Constructors
75 
76  //- Construct from components
78  (
79  const polyMesh& mesh,
80  const word& zoneName
81  );
82 
83  //- Construct from dictionary
85  (
86  const polyMesh& mesh,
87  const dictionary& dict
88  );
89 
90  //- Construct from Istream
92  (
93  const polyMesh& mesh,
94  Istream&
95  );
96 
97 
98  // Destructor
99 
100  virtual ~zoneToCell();
101 
102 
103  // Member Functions
104 
105  virtual void applyToSet
106  (
107  const topoSetSource::setAction action,
108  topoSet&
109  ) const;
110 
111 };
112 
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 } // End namespace Foam
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 #endif
121 
122 // ************************ vim: set sw=4 sts=4 et: ************************ //