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-2020 OpenCFD Ltd.
9-------------------------------------------------------------------------------
10License
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
34namespace Foam
35{
42 (
45 word,
46 patch
47 );
49 (
52 istream,
53 patch
54 );
55}
56
57
58Foam::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
68void Foam::patchToCell::combine(topoSet& set, const bool add) const
69{
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
112(
113 const polyMesh& mesh,
114 const wordRe& patchName
115)
116:
118 selectedPatches_(one{}, patchName)
119{}
120
121
123(
124 const polyMesh& mesh,
125 const dictionary& dict
126)
127:
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
142(
143 const polyMesh& mesh,
144 Istream& is
145)
146:
148 selectedPatches_(one{}, wordRe(checkIs(is)))
149{}
150
151
152// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
153
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// ************************************************************************* //
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 topoSetCellSource to select cells associated with given patch(es).
Definition: patchToCell.H:158
virtual void applyToSet(const topoSetSource::setAction action, topoSet &set) const
Apply specified action to the topoSet.
Definition: patchToCell.C:155
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
virtual const labelList & faceOwner() const
Return face owner.
Definition: polyMesh.C:1121
const polyBoundaryMesh & boundaryMesh() const
Return boundary mesh.
Definition: polyMesh.H:456
The topoSetCellSource is a intermediate class for handling topoSet sources for selecting cells.
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