faceToCell.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2017 OpenFOAM Foundation
9  Copyright (C) 2018 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "faceToCell.H"
30 #include "polyMesh.H"
31 #include "faceSet.H"
33 
34 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
35 
36 namespace Foam
37 {
38  defineTypeNameAndDebug(faceToCell, 0);
39  addToRunTimeSelectionTable(topoSetSource, faceToCell, word);
40  addToRunTimeSelectionTable(topoSetSource, faceToCell, istream);
41  addToRunTimeSelectionTable(topoSetCellSource, faceToCell, word);
42  addToRunTimeSelectionTable(topoSetCellSource, faceToCell, istream);
43 }
44 
45 
46 Foam::topoSetSource::addToUsageTable Foam::faceToCell::usage_
47 (
48  faceToCell::typeName,
49  "\n Usage: faceToCell <faceSet> neighbour|owner|any|all\n\n"
50  " Select cells that are the owner|neighbour|any"
51  " of the faces in the faceSet or where all faces are in the faceSet\n\n"
52 );
53 
54 const Foam::Enum
55 <
56  Foam::faceToCell::faceAction
57 >
58 Foam::faceToCell::faceActionNames_
59 ({
60  { faceAction::ANY, "any" },
61  { faceAction::ALL, "all" },
62  { faceAction::OWNER, "owner" },
63  { faceAction::NEIGHBOUR, "neighbour" },
64 });
65 
66 
67 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
68 
70 (
71  topoSet& set,
72  const bool add,
73  const word& setName
74 ) const
75 {
76  // Load the set
77  faceSet loadedSet(mesh_, setName);
78 
79  const labelHashSet& faceLabels = loadedSet;
80 
81  // Handle owner/neighbour/any selection
82  for (const label facei : faceLabels)
83  {
84  if ((option_ == OWNER) || (option_ == ANY))
85  {
86  const label celli = mesh_.faceOwner()[facei];
87 
88  addOrDelete(set, celli, add);
89  }
90 
91  if (mesh_.isInternalFace(facei))
92  {
93  if ((option_ == NEIGHBOUR) || (option_ == ANY))
94  {
95  const label celli = mesh_.faceNeighbour()[facei];
96 
97  addOrDelete(set, celli, add);
98  }
99  }
100  }
101 
102  // Handle all selection.
103  if (option_ == ALL)
104  {
105  // Count number of selected faces per cell.
106 
107  Map<label> facesPerCell(loadedSet.size());
108 
109  for (const label facei : faceLabels)
110  {
111  // Count faces on owner
112  ++(facesPerCell(mesh_.faceOwner()[facei], 0));
113 
114  if (mesh_.isInternalFace(facei))
115  {
116  // Count faces on neighbour
117  ++(facesPerCell(mesh_.faceNeighbour()[facei], 0));
118  }
119  }
120 
121  // Include cells that are referenced as many times as they have faces
122  // -> all faces in set.
123  forAllConstIters(facesPerCell, iter)
124  {
125  const label celli = iter.key();
126  const label count = iter.val();
127 
128  if (count == mesh_.cells()[celli].size())
129  {
130  addOrDelete(set, celli, add);
131  }
132  }
133  }
134 }
135 
136 
137 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
138 
139 Foam::faceToCell::faceToCell
140 (
141  const polyMesh& mesh,
142  const word& setName,
143  const faceAction option
144 )
145 :
146  topoSetCellSource(mesh),
147  names_(one(), setName),
148  option_(option)
149 {}
150 
151 
152 Foam::faceToCell::faceToCell
153 (
154  const polyMesh& mesh,
155  const dictionary& dict
156 )
157 :
158  topoSetCellSource(mesh),
159  names_(),
160  option_(faceActionNames_.get("option", dict))
161 {
162  // Look for 'sets' or 'set'
163  if (!dict.readIfPresent("sets", names_))
164  {
165  names_.resize(1);
166  dict.readEntry("set", names_.first());
167  }
168 }
169 
170 
171 Foam::faceToCell::faceToCell
172 (
173  const polyMesh& mesh,
174  Istream& is
175 )
176 :
177  topoSetCellSource(mesh),
178  names_(one(), word(checkIs(is))),
179  option_(faceActionNames_.read(checkIs(is)))
180 {}
181 
182 
183 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
184 
185 void Foam::faceToCell::applyToSet
186 (
187  const topoSetSource::setAction action,
188  topoSet& set
189 ) const
190 {
191  if (action == topoSetSource::ADD || action == topoSetSource::NEW)
192  {
193  if (verbose_)
194  {
195  Info<< " Adding cells according to faceSet "
196  << flatOutput(names_) << nl;
197  }
198 
199  for (const word& setName : names_)
200  {
201  combine(set, true, setName);
202  }
203  }
204  else if (action == topoSetSource::SUBTRACT)
205  {
206  if (verbose_)
207  {
208  Info<< " Removing cells according to faceSet "
209  << flatOutput(names_) << nl;
210  }
211 
212  for (const word& setName : names_)
213  {
214  combine(set, false, setName);
215  }
216  }
217 }
218 
219 
220 // ************************************************************************* //
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(decompositionMethod, kahipDecomp, dictionary)
Foam::topoSetSource::ADD
Add elements to the set.
Definition: topoSetSource.H:101
Foam::Enum
Enum is a wrapper around a list of names/values that represent particular enumeration (or int) values...
Definition: IOstreamOption.H:57
Foam::topoSetSource::addToUsageTable
Class with constructor to add usage string to table.
Definition: topoSetSource.H:124
Foam::read
bool read(const char *buf, int32_t &val)
Same as readInt32.
Definition: int32.H:107
Foam::topoSetSource::setAction
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:99
faceToCell.H
Foam::topoSetSource::NEW
Create a new set and ADD elements to it.
Definition: topoSetSource.H:106
polyMesh.H
Foam::Info
messageStream Info
Information stream (uses stdout - output is on the master only)
Foam::ListListOps::combine
AccessType combine(const UList< T > &lists, AccessOp aop=accessOp< T >())
Combines sub-lists into a single list.
Definition: ListListOps.C:69
faceSet.H
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::add
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
Definition: FieldFieldFunctions.C:939
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam::topoSetSource::SUBTRACT
Subtract elements from the set.
Definition: topoSetSource.H:102
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::nl
constexpr char nl
Definition: Ostream.H:385
forAllConstIters
forAllConstIters(mixture.phases(), phase)
Definition: pEqn.H:28
Foam::flatOutput
FlatOutput< Container > flatOutput(const Container &obj, label len=0)
Global flatOutput function.
Definition: FlatOutput.H:85
Foam::BitOps::count
unsigned int count(const UList< bool > &bools, const bool val=true)
Count number of 'true' entries.
Definition: BitOps.H:74
Foam::labelHashSet
HashSet< label, Hash< label > > labelHashSet
A HashSet with label keys and label hasher.
Definition: HashSet.H:410
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)