src/OpenFOAM/meshes/meshTools/mergePoints.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 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 "scalarField.H"
  36 #include "pointField.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42
  43 /*---------------------------------------------------------------------------*\
  44                            Function mergePoints Declaration
  45 \*---------------------------------------------------------------------------*/
  46
  47 //- Sort & merge points. All points closer than/equal mergeTol get merged.
  48 //  Outputs the new unique points and a map from old to new. Returns
  49 //  true if anything merged, false otherwise.
  50 bool mergePoints
  51 (
  52     const UList<point>& points,
  53     const scalar mergeTol,
  54     const bool verbose,
  55     labelList& pointMap,
  56     List<point>& newPoints,
  57     const point& origin = point::zero
  58 );
  59
  60 } // End namespace Foam
  61
  62 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  63
  64 #endif
  65
  66 // ************************************************************************* //