FreeFOAM The Cross-Platform CFD Toolkit
cellToFace.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::cellToFace
26 
27 Description
28  A topoSetSource to select a faceSet from cells.
29 
30  Either all faces of cell or some other criterion.
31  See implementation.
32  Note: when picking up coupled faces uses cells on neighbouring processors.
33 
34 SourceFiles
35  cellToFace.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef cellToFace_H
40 #define cellToFace_H
41 
43 #include <OpenFOAM/NamedEnum.H>
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class cellToFace Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
56  public topoSetSource
57 {
58 public:
59  //- Enumeration defining the valid options
61  {
62  ALL,
64  };
65 
66 
67 private:
68 
69  //- Add usage string
70  static addToUsageTable usage_;
71 
72  static const NamedEnum<cellAction, 2> cellActionNames_;
73 
74  //- Name of set to use
75  word setName_;
76 
77  //- Option
78  cellAction option_;
79 
80 
81  // Private Member Functions
82 
83  //- Depending on face to cell option add to or delete from cellSet.
84  void combine(topoSet& set, const bool add) const;
85 
86 
87 public:
88 
89  //- Runtime type information
90  TypeName("cellToFace");
91 
92  // Constructors
93 
94  //- Construct from components
96  (
97  const polyMesh& mesh,
98  const word& setName,
99  const cellAction option
100  );
101 
102  //- Construct from dictionary
103  cellToFace
104  (
105  const polyMesh& mesh,
106  const dictionary& dict
107  );
108 
109  //- Construct from Istream
110  cellToFace
111  (
112  const polyMesh& mesh,
113  Istream&
114  );
115 
116 
117  // Destructor
118 
119  virtual ~cellToFace();
120 
121 
122  // Member Functions
123 
124  virtual void applyToSet
125  (
126  const topoSetSource::setAction action,
127  topoSet&
128  ) const;
129 
130 };
131 
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 } // End namespace Foam
136 
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 
139 #endif
140 
141 // ************************ vim: set sw=4 sts=4 et: ************************ //