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-------------------------------------------------------------------------------
11License
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
35namespace Foam
36{
43 (
46 word,
47 patch
48 );
50 (
53 istream,
54 patch
55 );
56}
57
58
59Foam::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
69void 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// ************************************************************************* //
Macros for easy insertion into run-time selection tables.
#define addNamedToRunTimeSelectionTable(baseType, thisType, argNames, lookupName)
Add to construction table with 'lookupName' as the key.
#define addToRunTimeSelectionTable(baseType, thisType, argNames)
Add to construction table with typeName as the key.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:64
void resize(const label len)
Adjust allocated size of list.
Definition: ListI.H:139
T & first()
Return the first element of the list.
Definition: UListI.H:202
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
T getCompat(const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=keyType::REGEX) const
bool readIfPresent(const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const
A class representing the concept of 1 (one) that can be used to avoid manipulating objects known to b...
Definition: one.H:62
A topoSetFaceSource to select cells associated with given patch(es).
Definition: patchToFace.H:159
virtual void applyToSet(const topoSetSource::setAction action, topoSet &set) const
Apply specified action to the topoSet.
Definition: patchToFace.C:156
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.
wordList names() const
Return a list of patch names.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:81
const polyBoundaryMesh & boundaryMesh() const
Return boundary mesh.
Definition: polyMesh.H:456
The topoSetFaceSource is a intermediate class for handling topoSet sources for selecting faces.
Class with constructor to add usage string to table.
Base class of a source for a topoSet.
Definition: topoSetSource.H:68
void addOrDelete(topoSet &set, const label id, const bool add) const
Add or delete id from set. Add when 'add' is true.
setAction
Enumeration defining various actions.
@ SUBTRACT
Subtract elements from current set.
@ ADD
Add elements to current set.
@ NEW
Create a new set and ADD elements to it.
bool verbose_
Output verbosity (default: true)
const polyMesh & mesh_
Reference to the mesh.
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:67
A wordRe is a Foam::word, but can contain a regular expression for matching words or strings.
Definition: wordRe.H:83
A class for handling words, derived from Foam::string.
Definition: word.H:68
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition: className.H:121
dynamicFvMesh & mesh
#define WarningInFunction
Report a warning using Foam::Warning.
Namespace for OpenFOAM.
messageStream Info
Information stream (stdout output on master, null elsewhere)
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:372
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
FlatOutput::OutputAdaptor< Container, Delimiters > flatOutput(const Container &obj, Delimiters delim)
Global flatOutput() function with specified output delimiters.
Definition: FlatOutput.H:215
HashSet< label, Hash< label > > labelHashSet
A HashSet of labels, uses label hasher.
Definition: HashSet.H:85
constexpr char nl
The newline '\n' character (0x0a)
Definition: Ostream.H:53
dict add("bounds", meshBb)
dictionary dict