All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
mergePoints.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-2018 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  Merge points. See below.
26 
27 SourceFiles
28  mergePoints.C
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef mergePoints_H
33 #define mergePoints_H
34 
35 #include "scalar.H"
36 #include "labelList.H"
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 /*---------------------------------------------------------------------------*\
44  Function mergePoints Declaration
45 \*---------------------------------------------------------------------------*/
46 
47 //- Sorts and merges points. All points closer than/equal mergeTol get merged.
48 // Returns the number of unique points and a map from old to new.
49 template<class Type>
51 (
52  const UList<Type>& points,
53  const scalar mergeTol,
54  const bool verbose,
55  labelList& pointMap,
56  const Type& origin = Type::zero
57 );
58 
59 //- Sorts and merges points. Determines new points. Returns true if anything
60 // merged (though newPoints still sorted even if not merged).
61 template<class Type>
62 bool mergePoints
63 (
64  const UList<Type>& points,
65  const scalar mergeTol,
66  const bool verbose,
67  labelList& pointMap,
68  List<Type>& newPoints,
69  const Type& origin = Type::zero
70 );
71 
72 } // End namespace Foam
73 
74 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
75 
76 #ifdef NoRepository
77  #include "mergePoints.C"
78 #endif
79 
80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81 
82 #endif
83 
84 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
const pointField & points
List< label > labelList
A List of labels.
Definition: labelList.H:56
label mergePoints(const UList< Type > &points, const scalar mergeTol, const bool verbose, labelList &pointMap, const Type &origin=Type::zero)
Sorts and merges points. All points closer than/equal mergeTol get merged.
Namespace for OpenFOAM.