cellToFace.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-2022 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 "cellToFace.H"
30#include "polyMesh.H"
31#include "cellSet.H"
32#include "Time.H"
33#include "syncTools.H"
35
36// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
37
38namespace Foam
39{
45}
46
47
48Foam::topoSetSource::addToUsageTable Foam::cellToFace::usage_
49(
50 cellToFace::typeName,
51 "\n Usage: cellToFace <cellSet> all|both\n\n"
52 " Select -all : all faces of cells in the cellSet\n"
53 " -both: faces where both neighbours are in the cellSet\n\n"
54);
55
56const Foam::Enum
57<
59>
60Foam::cellToFace::cellActionNames_
61({
62 { cellAction::ALL, "all" },
63 { cellAction::BOTH, "both" },
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 if (!exists(mesh_.time().path()/topoSet::localPath(mesh_, setName)))
78 {
79 SeriousError<< "Cannot load set "
80 << setName << endl;
81 }
82
83 cellSet loadedSet(mesh_, setName);
84 const labelHashSet& cellLabels = loadedSet;
85
86 if (option_ == ALL)
87 {
88 // Add all faces from cell
89 for (const label celli : cellLabels)
90 {
91 const labelList& cFaces = mesh_.cells()[celli];
92
93 addOrDelete(set, cFaces, add);
94 }
95 }
96 else if (option_ == BOTH)
97 {
98 // Add all faces whose both neighbours are in set.
99
100 const label nInt = mesh_.nInternalFaces();
101 const labelList& own = mesh_.faceOwner();
102 const labelList& nei = mesh_.faceNeighbour();
103 const polyBoundaryMesh& patches = mesh_.boundaryMesh();
104
105
106 // Check all internal faces
107 for (label facei = 0; facei < nInt; ++facei)
108 {
109 if (cellLabels.found(own[facei]) && cellLabels.found(nei[facei]))
110 {
111 addOrDelete(set, facei, add);
112 }
113 }
114
115
116 // Get coupled cell status
117 boolList neiInSet(mesh_.nBoundaryFaces(), false);
118
119 for (const polyPatch& pp : patches)
120 {
121 if (pp.coupled())
122 {
123 label facei = pp.start();
124 forAll(pp, i)
125 {
126 neiInSet[facei-nInt] = cellLabels.found(own[facei]);
127 ++facei;
128 }
129 }
130 }
132
133
134 // Check all boundary faces
135 for (const polyPatch& pp : patches)
136 {
137 if (pp.coupled())
138 {
139 label facei = pp.start();
140 forAll(pp, i)
141 {
142 if (cellLabels.found(own[facei]) && neiInSet[facei-nInt])
143 {
144 addOrDelete(set, facei, add);
145 }
146 ++facei;
147 }
148 }
149 }
150 }
151}
152
153
154// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
155
157(
158 const polyMesh& mesh,
159 const word& setName,
160 const cellAction option
161)
162:
164 names_(one{}, setName),
165 option_(option)
166{}
167
168
170(
171 const polyMesh& mesh,
172 const dictionary& dict
173)
174:
176 names_(),
177 option_(cellActionNames_.get("option", dict))
178{
179 // Look for 'sets' or 'set'
180 if (!dict.readIfPresent("sets", names_))
181 {
182 names_.resize(1);
183 dict.readEntry("set", names_.first());
184 }
185}
186
187
189(
190 const polyMesh& mesh,
191 Istream& is
192)
193:
195 names_(one{}, word(checkIs(is))),
196 option_(cellActionNames_.read(checkIs(is)))
197{}
198
199
200// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
201
203(
204 const topoSetSource::setAction action,
205 topoSet& set
206) const
207{
208 if (action == topoSetSource::ADD || action == topoSetSource::NEW)
209 {
210 if (verbose_)
211 {
212 Info<< " Adding faces according to cellSet "
213 << flatOutput(names_) << nl;
214 }
215
216 for (const word& setName : names_)
217 {
218 combine(set, true, setName);
219 }
220 }
221 else if (action == topoSetSource::SUBTRACT)
222 {
223 if (verbose_)
224 {
225 Info<< " Removing faces according to cellSet "
226 << flatOutput(names_) << nl;
227 }
228
229 for (const word& setName : names_)
230 {
231 combine(set, false, setName);
232 }
233 }
234}
235
236
237// ************************************************************************* //
Macros for easy insertion into run-time selection tables.
#define addToRunTimeSelectionTable(baseType, thisType, argNames)
Add to construction table with typeName as the key.
virtual fileName localPath() const
Output directory.
Enum is a wrapper around a list of names/values that represent particular enumeration (or int) values...
Definition: Enum.H:61
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
fileName path() const
Return path.
Definition: Time.H:358
T & first()
Return the first element of the list.
Definition: UListI.H:202
A topoSetFaceSource to select all the faces from given cellSet(s).
Definition: cellToFace.H:177
cellAction
Enumeration defining the valid options.
Definition: cellToFace.H:181
virtual void applyToSet(const topoSetSource::setAction action, topoSet &set) const
Apply specified action to the topoSet.
Definition: cellToFace.C:203
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
bool readIfPresent(const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const
bool readEntry(const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
const Time & time() const noexcept
Return time registry.
A class representing the concept of 1 (one) that can be used to avoid manipulating objects known to b...
Definition: one.H:62
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
virtual const labelList & faceNeighbour() const
Return face neighbour.
Definition: polyMesh.C:1127
label nBoundaryFaces() const noexcept
Number of boundary faces (== nFaces - nInternalFaces)
label nInternalFaces() const noexcept
Number of internal faces.
const cellList & cells() const
static void swapBoundaryFaceList(const polyMesh &mesh, UList< T > &faceValues)
Swap coupled boundary face values. Uses eqOp.
Definition: syncTools.H:445
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.
const polyMesh & mesh_
Reference to the mesh.
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:67
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
const polyBoundaryMesh & patches
dynamicFvMesh & mesh
Namespace for OpenFOAM.
bool read(const char *buf, int32_t &val)
Same as readInt32.
Definition: int32.H:108
bool exists(const fileName &name, const bool checkGzip=true, const bool followLink=true)
Does the name exist (as DIRECTORY or FILE) in the file system?
Definition: MSwindows.C:633
List< label > labelList
A List of labels.
Definition: List.H:66
messageStream Info
Information stream (stdout output on master, null elsewhere)
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:372
messageStream SeriousError
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
List< bool > boolList
A List of bools.
Definition: List.H:64
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
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:333