nearestToCell.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) 2017-2018 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 "nearestToCell.H"
30#include "polyMesh.H"
32#include "mappedPatchBase.H"
33
34// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
35
36namespace Foam
37{
44 (
47 word,
48 nearest
49 );
51 (
54 istream,
55 nearest
56 );
57}
58
59
60Foam::topoSetSource::addToUsageTable Foam::nearestToCell::usage_
61(
62 nearestToCell::typeName,
63 "\n Usage: nearestToCell (pt0 .. ptn)\n\n"
64 " Select the nearest cell for each of the points pt0 ..ptn\n\n"
65);
66
67
68// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
69
70void Foam::nearestToCell::combine(topoSet& set, const bool add) const
71{
72 // All the info for nearest. Construct to miss
73 List<mappedPatchBase::nearInfo> nearest(points_.size());
74
75 forAll(points_, pointi)
76 {
77 const label celli = mesh_.findNearestCell(points_[pointi]);
78 const point& cc = mesh_.cellCentres()[celli];
79
80 nearest[pointi].first() = pointIndexHit(true, cc, celli);
81 nearest[pointi].second() = Tuple2<scalar, label>
82 (
83 magSqr(cc-points_[pointi]),
85 );
86 }
87
88 Pstream::listCombineAllGather(nearest, mappedPatchBase::nearestEqOp());
89
90 for (const auto& near : nearest)
91 {
92 if (near.second().second() == Pstream::myProcNo())
93 {
94 addOrDelete(set, near.first().index(), add);
95 }
96 }
97}
98
99
100// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
101
103(
104 const polyMesh& mesh,
105 const pointField& points
106)
107:
109 points_(points)
110{}
111
112
114(
115 const polyMesh& mesh,
117)
118:
120 points_(std::move(points))
121{}
122
123
125(
126 const polyMesh& mesh,
127 const dictionary& dict
128)
129:
131 (
132 mesh,
133 dict.get<pointField>("points")
134 )
135{}
136
137
139(
140 const polyMesh& mesh,
141 Istream& is
142)
143:
145 points_(checkIs(is))
146{}
147
148
149// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
150
152(
153 const topoSetSource::setAction action,
154 topoSet& set
155) const
156{
157 if (action == topoSetSource::ADD || action == topoSetSource::NEW)
158 {
159 if (verbose_)
160 {
161 Info<< " Adding cells nearest to " << points_ << endl;
162 }
163
164 combine(set, true);
165 }
166 else if (action == topoSetSource::SUBTRACT)
167 {
168 if (verbose_)
169 {
170 Info<< " Removing cells nearest to " << points_ << endl;
171 }
172
173 combine(set, false);
174 }
175}
176
177
178// ************************************************************************* //
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
static void listCombineAllGather(const List< commsStruct > &comms, List< T > &values, const CombineOp &cop, const int tag, const label comm)
After completion all processors have the same data.
T & first()
Return the first element of the list.
Definition: UListI.H:202
void size(const label n)
Older name for setAddressableSize.
Definition: UList.H:114
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
A topoSetCellSource to select cells whose cell centre nearest to given points.
virtual void applyToSet(const topoSetSource::setAction action, topoSet &set) const
Apply specified action to the topoSet.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:81
label findNearestCell(const point &location) const
Find the cell with the nearest cell centre to location.
const vectorField & cellCentres() const
int myProcNo() const noexcept
Return processor number.
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.
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
dynamicFvMesh & mesh
const pointField & points
Namespace for OpenFOAM.
PointIndexHit< point > pointIndexHit
A PointIndexHit for 3D points.
Definition: pointIndexHit.H:46
messageStream Info
Information stream (stdout output on master, null elsewhere)
vector point
Point is a vector.
Definition: point.H:43
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)
dimensioned< typename typeOfMag< Type >::type > magSqr(const dimensioned< Type > &dt)
dict add("bounds", meshBb)
dictionary dict
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:333