matchPoints.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2023 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Description
25  Determine correspondence between points. See below.
26 
27 SourceFiles
28  matchPoints.C
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef matchPoints_H
33 #define matchPoints_H
34 
35 #include "scalarField.H"
36 #include "pointField.H"
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 /*---------------------------------------------------------------------------*\
44  Function matchPoints Declaration
45 \*---------------------------------------------------------------------------*/
46 
47 //- Determine correspondence between pointFields. Gets passed
48 // local matching distance per point. Returns map from 0 to 1. Returns
49 // true if found corresponding point in 1 for every point in 0; false
50 // otherwise. Compares mag(pt - origin) and does proper comparison for points
51 // with (almost) identical mag. pts0 can be subset of pts1.
52 bool matchPoints
53 (
54  const UList<point>& pts0,
55  const UList<point>& pts1,
56  const UList<scalar>& matchDistance,
57  const bool verbose,
58  labelList& from0To1,
59  const point& origin = point::zero
60 );
61 
62 
63 //- Supply pts0Dir and pts1Dir. They are directions associated with the points
64 // e.g., a face normal associated with each face centre.
65 // A match between similar points is only allowed if their directions are
66 // equal and opposite
67 bool matchPoints
68 (
69  const UList<point>& pts0,
70  const UList<point>& pts1,
71  const UList<point>& pts0Dir,
72  const UList<point>& pts1Dir,
73  const UList<scalar>& matchDistance,
74  const bool verbose,
75  labelList& from0To1,
76  const point& origin = point::zero
77 );
78 
79 
80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81 
82 } // End namespace Foam
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 #endif
87 
88 // ************************************************************************* //
static const Form zero
Definition: VectorSpace.H:118
Namespace for OpenFOAM.
List< label > labelList
A List of labels.
Definition: labelList.H:56
vector point
Point is a vector.
Definition: point.H:41
bool matchPoints(const UList< point > &pts0, const UList< point > &pts1, const UList< scalar > &matchDistance, const bool verbose, labelList &from0To1, const point &origin=point::zero)
Determine correspondence between pointFields. Gets passed.
Definition: matchPoints.C:33