faceToCell.C
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 \*---------------------------------------------------------------------------*/
25 
26 #include "faceToCell.H"
27 #include "polyMesh.H"
28 #include "faceSet.H"
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35  defineTypeNameAndDebug(faceToCell, 0);
36  addToRunTimeSelectionTable(topoSetSource, faceToCell, word);
37  addToRunTimeSelectionTable(topoSetSource, faceToCell, istream);
38 
39  template<>
40  const char* Foam::NamedEnum
41  <
43  4
44  >::names[] =
45  {
46  "neighbour",
47  "owner",
48  "any",
49  "all"
50  };
51 }
52 
53 
54 Foam::topoSetSource::addToUsageTable Foam::faceToCell::usage_
55 (
56  faceToCell::typeName,
57  "\n Usage: faceToCell <faceSet> neighbour|owner|any|all\n\n"
58  " Select cells that are the owner|neighbour|any"
59  " of the faces in the faceSet or where all faces are in the faceSet\n\n"
60 );
61 
63  Foam::faceToCell::faceActionNames_;
64 
65 
66 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
67 
68 void Foam::faceToCell::combine(topoSet& set, const bool add) const
69 {
70  // Load the set
71  faceSet loadedSet(mesh_, setName_);
72 
73 
74  // Handle owner/neighbour/any selection
75  forAllConstIter(faceSet, loadedSet, iter)
76  {
77  const label facei = iter.key();
78 
79  if ((option_ == OWNER) || (option_ == ANY))
80  {
81  const label celli = mesh_.faceOwner()[facei];
82 
83  addOrDelete(set, celli, add);
84  }
85 
86  if (mesh_.isInternalFace(facei))
87  {
88  if ((option_ == NEIGHBOUR) || (option_ == ANY))
89  {
90  const label celli = mesh_.faceNeighbour()[facei];
91 
92  addOrDelete(set, celli, add);
93  }
94  }
95  }
96 
97  // Handle all selection.
98  if (option_ == ALL)
99  {
100  // Count number of selected faces per cell.
101 
102  Map<label> facesPerCell(loadedSet.size());
103 
104  forAllConstIter(faceSet, loadedSet, iter)
105  {
106  const label facei = iter.key();
107  const label own = mesh_.faceOwner()[facei];
108 
109  Map<label>::iterator fndOwn = facesPerCell.find(own);
110 
111  if (fndOwn == facesPerCell.end())
112  {
113  facesPerCell.insert(own, 1);
114  }
115  else
116  {
117  fndOwn()++;
118  }
119 
120  if (mesh_.isInternalFace(facei))
121  {
122  label nei = mesh_.faceNeighbour()[facei];
123 
124  Map<label>::iterator fndNei = facesPerCell.find(nei);
125 
126  if (fndNei == facesPerCell.end())
127  {
128  facesPerCell.insert(nei, 1);
129  }
130  else
131  {
132  fndNei()++;
133  }
134  }
135  }
136 
137  // Include cells that are referenced as many times as they have faces
138  // -> all faces in set.
139  forAllConstIter(Map<label>, facesPerCell, iter)
140  {
141  const label celli = iter.key();
142 
143  if (iter() == mesh_.cells()[celli].size())
144  {
145  addOrDelete(set, celli, add);
146  }
147  }
148  }
149 }
150 
151 
152 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
153 
155 (
156  const polyMesh& mesh,
157  const word& setName,
158  const faceAction option
159 )
160 :
161  topoSetSource(mesh),
162  setName_(setName),
163  option_(option)
164 {}
165 
166 
168 (
169  const polyMesh& mesh,
170  const dictionary& dict
171 )
172 :
173  topoSetSource(mesh),
174  setName_(dict.lookup("set")),
175  option_(faceActionNames_.read(dict.lookup("option")))
176 {}
177 
178 
180 (
181  const polyMesh& mesh,
182  Istream& is
183 )
184 :
185  topoSetSource(mesh),
186  setName_(checkIs(is)),
187  option_(faceActionNames_.read(checkIs(is)))
188 {}
189 
190 
191 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
192 
194 {}
195 
196 
197 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
198 
200 (
201  const topoSetSource::setAction action,
202  topoSet& set
203 ) const
204 {
205  if ((action == topoSetSource::NEW) || (action == topoSetSource::ADD))
206  {
207  Info<< " Adding cells according to faceSet " << setName_
208  << " ..." << endl;
209 
210  combine(set, true);
211  }
212  else if (action == topoSetSource::DELETE)
213  {
214  Info<< " Removing cells according to faceSet " << setName_
215  << " ..." << endl;
216 
217  combine(set, false);
218  }
219 }
220 
221 
222 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A list of face labels.
Definition: faceSet.H:48
static iteratorEnd end()
iteratorEnd set to beyond the end of any HashTable
Definition: HashTable.H:110
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
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:256
Initialise the NamedEnum HashTable from the static list of names.
Definition: NamedEnum.H:51
AccessType combine(const List< T > &, AccessOp aop=accessOp< T >())
Combines sublists into one big list.
Definition: ListListOps.C:34
label size() const
Return number of elements in table.
Definition: HashTableI.H:65
Macros for easy insertion into run-time selection tables.
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
iterator find(const Key &)
Find and return an iterator set at the hashedEntry.
Definition: HashTable.C:142
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
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
forAllConstIter(PtrDictionary< phaseModel >, mixture.phases(), phase)
Definition: pEqn.H:29
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
addToRunTimeSelectionTable(ensightPart, ensightPartCells, istream)
defineTypeNameAndDebug(combustionModel, 0)
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.
messageStream Info
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
faceAction
Enumeration defining the valid options.
Definition: faceToCell.H:55
Namespace for OpenFOAM.
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:576