patchToFace.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-2016 OpenFOAM Foundation
9  Copyright (C) 2018-2020 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 "patchToFace.H"
30 #include "polyMesh.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37  defineTypeNameAndDebug(patchToFace, 0);
38  addToRunTimeSelectionTable(topoSetSource, patchToFace, word);
39  addToRunTimeSelectionTable(topoSetSource, patchToFace, istream);
40  addToRunTimeSelectionTable(topoSetFaceSource, patchToFace, word);
41  addToRunTimeSelectionTable(topoSetFaceSource, patchToFace, istream);
43  (
44  topoSetFaceSource,
45  patchToFace,
46  word,
47  patch
48  );
50  (
51  topoSetFaceSource,
52  patchToFace,
53  istream,
54  patch
55  );
56 }
57 
58 
59 Foam::topoSetSource::addToUsageTable Foam::patchToFace::usage_
60 (
61  patchToFace::typeName,
62  "\n Usage: patchToFace patch\n\n"
63  " Select all faces in the patch. Note:accepts wildcards for patch.\n\n"
64 );
65 
66 
67 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
68 
69 void Foam::patchToFace::combine(topoSet& set, const bool add) const
70 {
72  (
73  selectedPatches_,
74  true, // warn if not found
75  true // use patch groups if available
76  );
77 
78  for (const label patchi : patchIDs)
79  {
80  const polyPatch& pp = mesh_.boundaryMesh()[patchi];
81 
82  if (verbose_)
83  {
84  Info<< " Found matching patch " << pp.name()
85  << " with " << pp.size() << " faces." << endl;
86  }
87 
88  for
89  (
90  label facei = pp.start();
91  facei < pp.start() + pp.size();
92  ++facei
93  )
94  {
95  addOrDelete(set, facei, add);
96  }
97  }
98 
99  if (patchIDs.empty())
100  {
102  << "Cannot find any patches matching "
103  << flatOutput(selectedPatches_) << nl
104  << "Valid names are " << flatOutput(mesh_.boundaryMesh().names())
105  << endl;
106  }
107 }
108 
109 
110 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
111 
113 (
114  const polyMesh& mesh,
115  const wordRe& patchName
116 )
117 :
119  selectedPatches_(one{}, patchName)
120 {}
121 
122 
124 (
125  const polyMesh& mesh,
126  const dictionary& dict
127 )
128 :
130  selectedPatches_()
131 {
132  // Look for 'patches' and 'patch', but accept 'name' as well
133  if (!dict.readIfPresent("patches", selectedPatches_))
134  {
135  selectedPatches_.resize(1);
136  selectedPatches_.first() =
137  dict.getCompat<wordRe>("patch", {{"name", 1806}});
138  }
139 }
140 
141 
143 (
144  const polyMesh& mesh,
145  Istream& is
146 )
147 :
149  selectedPatches_(one{}, wordRe(checkIs(is)))
150 {}
151 
152 
153 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
154 
156 (
157  const topoSetSource::setAction action,
158  topoSet& set
159 ) const
160 {
161  if (action == topoSetSource::ADD || action == topoSetSource::NEW)
162  {
163  if (verbose_)
164  {
165  Info<< " Adding all faces of patches "
166  << flatOutput(selectedPatches_) << " ..." << endl;
167  }
168 
169  combine(set, true);
170  }
171  else if (action == topoSetSource::SUBTRACT)
172  {
173  if (verbose_)
174  {
175  Info<< " Removing all faces of patches "
176  << flatOutput(selectedPatches_) << " ..." << endl;
177  }
178 
179  combine(set, false);
180  }
181 }
182 
183 
184 // ************************************************************************* //
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(decompositionMethod, kahipDecomp, dictionary)
Foam::topoSetSource::ADD
Add elements to current set.
Definition: topoSetSource.H:103
Foam::BitOps::set
void set(List< bool > &bools, const labelRange &range)
Set the specified range 'on' in a boolList.
Definition: BitOps.C:37
Foam::patchToFace::applyToSet
virtual void applyToSet(const topoSetSource::setAction action, topoSet &set) const
Apply specified action to the topoSet.
Definition: patchToFace.C:156
Foam::topoSetSource::addToUsageTable
Class with constructor to add usage string to table.
Definition: topoSetSource.H:129
Foam::one
A class representing the concept of 1 (one) that can be used to avoid manipulating objects known to b...
Definition: one.H:61
Foam::polyMesh::boundaryMesh
const polyBoundaryMesh & boundaryMesh() const
Return boundary mesh.
Definition: polyMesh.H:444
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
Foam::topoSetSource::setAction
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:100
Foam::topoSetFaceSource
The topoSetFaceSource is a intermediate class for handling topoSet sources for selecting faces.
Definition: topoSetFaceSource.H:54
Foam::dictionary::getCompat
T getCompat(const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
Definition: dictionaryTemplates.C:134
Foam::topoSetSource::NEW
Create a new set and ADD elements to it.
Definition: topoSetSource.H:104
polyMesh.H
Foam::wordRe
A wordRe is a Foam::word, but can contain a regular expression for matching words or strings.
Definition: wordRe.H:80
Foam::polyMesh
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:77
Foam::polyBoundaryMesh::names
wordList names() const
Return a list of patch names.
Definition: polyBoundaryMesh.C:555
Foam::topoSetSource::verbose_
bool verbose_
Output verbosity (default: true)
Definition: topoSetSource.H:159
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:61
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
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)
Foam::topoSet
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:63
patchToFace.H
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
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 current set.
Definition: topoSetSource.H:105
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::flatOutput
FlatOutput::OutputAdaptor< Container, Delimiters > flatOutput(const Container &obj, Delimiters delim)
Global flatOutput() function with specified output delimiters.
Definition: FlatOutput.H:216
Foam::nl
constexpr char nl
Definition: Ostream.H:404
Foam::foamVersion::patch
const std::string patch
OpenFOAM patch number as a std::string.
Foam::polyBoundaryMesh::patchSet
labelHashSet patchSet(const UList< wordRe > &patchNames, const bool warnNotFound=true, const bool useGroups=true) const
Return the set of patch IDs corresponding to the given names.
Definition: polyBoundaryMesh.C:864
Foam::topoSetSource::addOrDelete
void addOrDelete(topoSet &set, const label id, const bool add) const
Add or delete id from set. Add when 'add' is true.
Definition: topoSetSource.C:171
Foam::labelHashSet
HashSet< label, Hash< label > > labelHashSet
A HashSet of labels, uses label hasher.
Definition: HashSet.H:85
Foam::patchToFace::patchToFace
patchToFace(const polyMesh &mesh, const wordRe &patchName)
Construct from components.
Definition: patchToFace.C:113
Foam::topoSetSource::mesh_
const polyMesh & mesh_
Reference to the mesh.
Definition: topoSetSource.H:156
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
WarningInFunction
#define WarningInFunction
Report a warning using Foam::Warning.
Definition: messageStream.H:328
Foam::dictionary::readIfPresent
bool readIfPresent(const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const
Definition: dictionaryTemplates.C:405