boxToPoint.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-2021 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 "boxToPoint.H"
30#include "polyMesh.H"
32
33// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34
35namespace Foam
36{
43 (
46 word,
47 box
48 );
50 (
53 istream,
54 box
55 );
56}
57
58
59Foam::topoSetSource::addToUsageTable Foam::boxToPoint::usage_
60(
61 boxToPoint::typeName,
62 "\n Usage: boxToPoint ((minx miny minz) (maxx maxy maxz))\n\n"
63 " Select all points with coordinate within bounding box\n\n"
64);
65
66
67// * * * * * * * * * * * * * * * Local Functions * * * * * * * * * * * * * * //
68
69namespace Foam
70{
71
72// Read min/max or min/span
73static void readBoxDim(const dictionary& dict, treeBoundBox& bb)
74{
75 dict.readEntry<point>("min", bb.min());
76
77 const bool hasSpan = dict.found("span");
78 if (!dict.readEntry<point>("max", bb.max(), keyType::REGEX, !hasSpan))
79 {
80 bb.max() = bb.min() + dict.get<vector>("span");
81 }
82}
83
84} // End namespace Foam
85
86
87// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
88
89void Foam::boxToPoint::combine(topoSet& set, const bool add) const
90{
91 const pointField& ctrs = mesh_.points();
92
93 forAll(ctrs, elemi)
94 {
95 for (const auto& bb : bbs_)
96 {
97 if (bb.contains(ctrs[elemi]))
98 {
99 addOrDelete(set, elemi, add);
100 break;
101 }
102 }
103 }
104}
105
106
107// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
108
110(
111 const polyMesh& mesh,
112 const treeBoundBoxList& bbs
113)
114:
116 bbs_(bbs)
117{}
118
119
121(
122 const polyMesh& mesh,
123 treeBoundBoxList&& bbs
124)
125:
127 bbs_(std::move(bbs))
128{}
129
130
132(
133 const polyMesh& mesh,
134 const dictionary& dict
135)
136:
138 bbs_()
139{
140 // Accept 'boxes', 'box' or 'min/max'
141 if (!dict.readIfPresent("boxes", bbs_))
142 {
143 bbs_.resize(1);
144 if (!dict.readIfPresent("box", bbs_.first()))
145 {
146 readBoxDim(dict, bbs_.first());
147 }
148 }
149}
150
151
153(
154 const polyMesh& mesh,
155 Istream& is
156)
157:
159 bbs_(one{}, treeBoundBox(checkIs(is)))
160{}
161
162
163// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
164
166(
167 const topoSetSource::setAction action,
168 topoSet& set
169) const
170{
171 if (action == topoSetSource::ADD || action == topoSetSource::NEW)
172 {
173 if (verbose_)
174 {
175 Info<< " Adding points that are within boxes " << bbs_
176 << " ..." << endl;
177 }
178
179 combine(set, true);
180 }
181 else if (action == topoSetSource::SUBTRACT)
182 {
183 if (verbose_)
184 {
185 Info<< " Removing points that are within boxes " << bbs_
186 << " ..." << endl;
187 }
188
189 combine(set, false);
190 }
191}
192
193
194// ************************************************************************* //
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
const point & min() const
Minimum describing the bounding box.
Definition: boundBoxI.H:91
const point & max() const
Maximum describing the bounding box.
Definition: boundBoxI.H:97
A topoSetPointSource to select all points based on whether they are inside given bounding box(es).
Definition: boxToPoint.H:171
virtual void applyToSet(const topoSetSource::setAction action, topoSet &set) const
Apply specified action to the topoSet.
Definition: boxToPoint.C:166
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
T get(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
bool found(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Search for an entry (const access) with the given keyword.
Definition: dictionaryI.H:87
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
@ REGEX
Regular expression.
Definition: keyType.H:82
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 pointField & points() const
Return raw points.
Definition: polyMesh.C:1083
The topoSetPointSource is a intermediate class for handling topoSet sources for selecting points.
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
Standard boundBox with extra functionality for use in octree.
Definition: treeBoundBox.H:89
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
Namespace for OpenFOAM.
messageStream Info
Information stream (stdout output on master, null elsewhere)
static void readBoxDim(const dictionary &dict, treeBoundBox &bb)
Definition: searchableBox.C:60
vectorField pointField
pointField is a vectorField.
Definition: pointFieldFwd.H:44
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)
dict add("bounds", meshBb)
dictionary dict
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:333