patchToCell.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) 2018 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "patchToCell.H"
29 #include "polyMesh.H"
31 
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36  defineTypeNameAndDebug(patchToCell, 0);
37  addToRunTimeSelectionTable(topoSetSource, patchToCell, word);
38  addToRunTimeSelectionTable(topoSetSource, patchToCell, istream);
39  addToRunTimeSelectionTable(topoSetCellSource, patchToCell, word);
40  addToRunTimeSelectionTable(topoSetCellSource, patchToCell, istream);
42  (
43  topoSetCellSource,
44  patchToCell,
45  word,
46  patch
47  );
49  (
50  topoSetCellSource,
51  patchToCell,
52  istream,
53  patch
54  );
55 }
56 
57 
58 Foam::topoSetSource::addToUsageTable Foam::patchToCell::usage_
59 (
60  patchToCell::typeName,
61  "\n Usage: patchToCell patch\n\n"
62  " Select cells attached to patch. Note:accepts wildcards for patch.\n\n"
63 );
64 
65 
66 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
67 
68 void Foam::patchToCell::combine(topoSet& set, const bool add) const
69 {
70  labelHashSet patchIDs = mesh_.boundaryMesh().patchSet
71  (
72  selectedPatches_,
73  true, // warn if not found
74  true // use patch groups if available
75  );
76 
77  for (const label patchi : patchIDs)
78  {
79  const polyPatch& pp = mesh_.boundaryMesh()[patchi];
80 
81  if (verbose_)
82  {
83  Info<< " Found matching patch " << pp.name()
84  << " with " << pp.size() << " faces." << endl;
85  }
86 
87  for
88  (
89  label facei = pp.start();
90  facei < pp.start() + pp.size();
91  ++facei
92  )
93  {
94  addOrDelete(set, mesh_.faceOwner()[facei], add);
95  }
96  }
97 
98  if (patchIDs.empty())
99  {
101  << "Cannot find any patches matching "
102  << flatOutput(selectedPatches_) << nl
103  << "Valid names are " << flatOutput(mesh_.boundaryMesh().names())
104  << endl;
105  }
106 }
107 
108 
109 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
110 
111 Foam::patchToCell::patchToCell
112 (
113  const polyMesh& mesh,
114  const wordRe& patchName
115 )
116 :
117  topoSetCellSource(mesh),
118  selectedPatches_(one(), patchName)
119 {}
120 
121 
122 Foam::patchToCell::patchToCell
123 (
124  const polyMesh& mesh,
125  const dictionary& dict
126 )
127 :
128  topoSetCellSource(mesh),
129  selectedPatches_()
130 {
131  // Look for 'patches' and 'patch', but accept 'name' as well
132  if (!dict.readIfPresent("patches", selectedPatches_))
133  {
134  selectedPatches_.resize(1);
135  selectedPatches_.first() =
136  dict.getCompat<wordRe>("patch", {{"name", 1806}});
137  }
138 }
139 
140 
141 Foam::patchToCell::patchToCell
142 (
143  const polyMesh& mesh,
144  Istream& is
145 )
146 :
147  topoSetCellSource(mesh),
148  selectedPatches_(one(), wordRe(checkIs(is)))
149 {}
150 
151 
152 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
153 
154 void Foam::patchToCell::applyToSet
155 (
156  const topoSetSource::setAction action,
157  topoSet& set
158 ) const
159 {
160  if (action == topoSetSource::ADD || action == topoSetSource::NEW)
161  {
162  if (verbose_)
163  {
164  Info<< " Adding cells associated with patches "
165  << flatOutput(selectedPatches_) << " ..." << endl;
166  }
167 
168  combine(set, true);
169  }
170  else if (action == topoSetSource::SUBTRACT)
171  {
172  if (verbose_)
173  {
174  Info<< " Removing cells associated with patches "
175  << flatOutput(selectedPatches_) << " ..." << endl;
176  }
177 
178  combine(set, false);
179  }
180 }
181 
182 
183 // ************************************************************************* //
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(decompositionMethod, kahipDecomp, dictionary)
Foam::topoSetSource::ADD
Add elements to the set.
Definition: topoSetSource.H:101
Foam::topoSetSource::addToUsageTable
Class with constructor to add usage string to table.
Definition: topoSetSource.H:124
patchToCell.H
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:350
Foam::topoSetSource::setAction
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:99
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
Foam::addNamedToRunTimeSelectionTable
addNamedToRunTimeSelectionTable(topoSetCellSource, badQualityToCell, word, badQuality)
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
Foam::flatOutput
FlatOutput< Container > flatOutput(const Container &obj, label len=0)
Global flatOutput function.
Definition: FlatOutput.H:85
Foam::foamVersion::patch
const std::string patch
OpenFOAM patch number as a std::string.
Foam::labelHashSet
HashSet< label, Hash< label > > labelHashSet
A HashSet with label keys and label hasher.
Definition: HashSet.H:410
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
WarningInFunction
#define WarningInFunction
Report a warning using Foam::Warning.
Definition: messageStream.H:298