nearestToPoint.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 -------------------------------------------------------------------------------
11 License
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 "nearestToPoint.H"
30 #include "polyMesh.H"
32 #include "mappedPatchBase.H"
33 
34 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
35 
36 namespace Foam
37 {
38  defineTypeNameAndDebug(nearestToPoint, 0);
39  addToRunTimeSelectionTable(topoSetSource, nearestToPoint, word);
40  addToRunTimeSelectionTable(topoSetSource, nearestToPoint, istream);
41  addToRunTimeSelectionTable(topoSetPointSource, nearestToPoint, word);
42  addToRunTimeSelectionTable(topoSetPointSource, nearestToPoint, istream);
44  (
45  topoSetPointSource,
46  nearestToPoint,
47  word,
48  nearest
49  );
51  (
52  topoSetPointSource,
53  nearestToPoint,
54  istream,
55  nearest
56  );
57 }
58 
59 
60 Foam::topoSetSource::addToUsageTable Foam::nearestToPoint::usage_
61 (
62  nearestToPoint::typeName,
63  "\n Usage: nearestToPoint (pt0 .. ptn)\n\n"
64  " Select the nearest point for each of the points pt0 ..ptn\n\n"
65 );
66 
67 
68 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
69 
70 void Foam::nearestToPoint::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  // Do linear search since usually just a few points.
76  const pointField& pts = mesh_.points();
77 
78  forAll(points_, pointi)
79  {
80  if (pts.size())
81  {
82  label minPointi = 0;
83  scalar minDistSqr = magSqr(pts[minPointi] - points_[pointi]);
84 
85  for (label i = 1; i < pts.size(); i++)
86  {
87  scalar distSqr = magSqr(pts[i] - points_[pointi]);
88 
89  if (distSqr < minDistSqr)
90  {
91  minDistSqr = distSqr;
92  minPointi = i;
93  }
94  }
95 
96  const point& minPt = pts[minPointi];
97  nearest[pointi].first() = pointIndexHit(true, minPt, minPointi);
98  nearest[pointi].second() = Tuple2<scalar, label>
99  (
100  magSqr(minPt-points_[pointi]),
102  );
103  }
104  }
105 
106 
107  Pstream::listCombineGather(nearest, mappedPatchBase::nearestEqOp());
109 
110  for (const auto& near : nearest)
111  {
112  if (near.second().second() == Pstream::myProcNo())
113  {
114  addOrDelete(set, near.first().index(), add);
115  }
116  }
117 }
118 
119 
120 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
121 
123 (
124  const polyMesh& mesh,
125  const pointField& points
126 )
127 :
129  points_(points)
130 {}
131 
132 
134 (
135  const polyMesh& mesh,
137 )
138 :
140  points_(std::move(points))
141 {}
142 
143 
145 (
146  const polyMesh& mesh,
147  const dictionary& dict
148 )
149 :
150  nearestToPoint(mesh, dict.get<pointField>("points"))
151 {}
152 
153 
155 (
156  const polyMesh& mesh,
157  Istream& is
158 )
159 :
161  points_(checkIs(is))
162 {}
163 
164 
165 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
166 
168 (
169  const topoSetSource::setAction action,
170  topoSet& set
171 ) const
172 {
173  if (action == topoSetSource::ADD || action == topoSetSource::NEW)
174  {
175  if (verbose_)
176  {
177  Info<< " Adding points nearest to " << points_ << endl;
178  }
179 
180  combine(set, true);
181  }
182  else if (action == topoSetSource::SUBTRACT)
183  {
184  if (verbose_)
185  {
186  Info<< " Removing points nearest to " << points_ << endl;
187  }
188 
189  combine(set, false);
190  }
191 }
192 
193 
194 // ************************************************************************* //
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(decompositionMethod, kahipDecomp, dictionary)
Foam::nearestToPoint::applyToSet
virtual void applyToSet(const topoSetSource::setAction action, topoSet &set) const
Apply specified action to the topoSet.
Definition: nearestToPoint.C:168
Foam::pointField
vectorField pointField
pointField is a vectorField.
Definition: pointFieldFwd.H:44
Foam::polyMesh::points
virtual const pointField & points() const
Return raw points.
Definition: polyMesh.C:1069
Foam::topoSetSource::ADD
Add elements to current set.
Definition: topoSetSource.H:103
Foam::BitOps::set
void set(List< bool > &bools, const labelRange &range)
Set the specified range 'on' in a boolList.
Definition: BitOps.C:37
nearestToPoint.H
Foam::topoSetSource::addToUsageTable
Class with constructor to add usage string to table.
Definition: topoSetSource.H:129
Foam::nearestToPoint
A topoSetPointSource to select points nearest to given points.
Definition: nearestToPoint.H:142
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
Foam::topoSetSource::setAction
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:100
Foam::dictionary::get
T get(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Definition: dictionaryTemplates.C:107
Foam::topoSetSource::NEW
Create a new set and ADD elements to it.
Definition: topoSetSource.H:104
polyMesh.H
Foam::polyMesh
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:77
forAll
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:296
Foam::magSqr
dimensioned< typename typeOfMag< Type >::type > magSqr(const dimensioned< Type > &dt)
Foam::Field< vector >
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:61
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
Foam::ListListOps::combine
AccessType combine(const UList< T > &lists, AccessOp aop=accessOp< T >())
Combines sub-lists into a single list.
Definition: ListListOps.C:69
Foam::addNamedToRunTimeSelectionTable
addNamedToRunTimeSelectionTable(topoSetCellSource, badQualityToCell, word, badQuality)
Foam::nearestToPoint::nearestToPoint
nearestToPoint(const polyMesh &mesh, const pointField &points)
Construct from components, copying points.
Definition: nearestToPoint.C:123
Foam::topoSet
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:63
Foam::topoSetPointSource
The topoSetPointSource is a intermediate class for handling topoSet sources for selecting points.
Definition: topoSetPointSource.H:54
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::add
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
Definition: FieldFieldFunctions.C:939
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam::topoSetSource::SUBTRACT
Subtract elements from current set.
Definition: topoSetSource.H:105
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::Pstream::listCombineGather
static void listCombineGather(const List< commsStruct > &comms, List< T > &Value, const CombineOp &cop, const int tag, const label comm)
Definition: combineGatherScatter.C:290
Foam::pointIndexHit
PointIndexHit< point > pointIndexHit
A PointIndexHit for 3D points.
Definition: pointIndexHit.H:46
Foam::UPstream::myProcNo
static int myProcNo(const label communicator=worldComm)
Number of this process (starting from masterNo() = 0)
Definition: UPstream.H:463
points
const pointField & points
Definition: gmvOutputHeader.H:1
Foam::topoSetSource::addOrDelete
void addOrDelete(topoSet &set, const label id, const bool add) const
Add or delete id from set. Add when 'add' is true.
Definition: topoSetSource.C:171
Foam::Pstream::listCombineScatter
static void listCombineScatter(const List< commsStruct > &comms, List< T > &Value, const int tag, const label comm)
Scatter data. Reverse of combineGather.
Definition: combineGatherScatter.C:432
Foam::point
vector point
Point is a vector.
Definition: point.H:43
Foam::topoSetSource::mesh_
const polyMesh & mesh_
Reference to the mesh.
Definition: topoSetSource.H:156
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
mappedPatchBase.H