faceToCell.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
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::faceToCell
26 
27 Description
28  A topoSetSource to select cells based on usage in faces.
29 
30 SourceFiles
31  faceToCell.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef faceToCell_H
36 #define faceToCell_H
37 
38 #include "topoSetSource.H"
39 #include "NamedEnum.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class faceToCell Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class faceToCell
51 :
52  public topoSetSource
53 {
54 public:
55  //- Enumeration defining the valid options
56  enum faceAction
57  {
60  ANY,
61  ALL
62  };
63 
64 private:
65 
66  static const NamedEnum<faceAction, 4> faceActionNames_;
67 
68 
69  //- Add usage string
70  static addToUsageTable usage_;
71 
72  //- Name of set to use
73  word setName_;
74 
75  //- Option
76  faceAction option_;
77 
78 
79  // Private Member Functions
80 
81  //- Depending on face to cell option add to or delete from cellSet.
82  void combine(topoSet& set, const bool add) const;
83 
84 
85 public:
86 
87  //- Runtime type information
88  TypeName("faceToCell");
89 
90 
91  // Constructors
92 
93  //- Construct from components
95  (
96  const polyMesh& mesh,
97  const word& setName,
98  const faceAction option
99  );
100 
101  //- Construct from dictionary
102  faceToCell
103  (
104  const polyMesh& mesh,
105  const dictionary& dict
106  );
107 
108  //- Construct from Istream
109  faceToCell
110  (
111  const polyMesh& mesh,
112  Istream&
113  );
114 
115 
116  //- Destructor
117  virtual ~faceToCell();
118 
119 
120  // Member Functions
122  virtual sourceType setType() const
123  {
124  return CELLSETSOURCE;
125  }
126 
127  virtual void applyToSet
128  (
129  const topoSetSource::setAction action,
130  topoSet&
131  ) const;
132 
133 };
134 
135 
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 
138 } // End namespace Foam
139 
140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
141 
142 #endif
143 
144 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
const polyMesh & mesh() const
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: faceToCell.C:200
A class for handling words, derived from string.
Definition: word.H:59
virtual ~faceToCell()
Destructor.
Definition: faceToCell.C:193
A topoSetSource to select cells based on usage in faces.
Definition: faceToCell.H:49
TypeName("faceToCell")
Runtime type information.
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
faceToCell(const polyMesh &mesh, const word &setName, const faceAction option)
Construct from components.
Definition: faceToCell.C:155
Class with constructor to add usage string to table.
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:70
virtual sourceType setType() const
Definition: faceToCell.H:121
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
faceAction
Enumeration defining the valid options.
Definition: faceToCell.H:55
Namespace for OpenFOAM.