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) 1991-2008 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Description
  26     Merge points. See below.
  27
  28 SourceFiles
  29     mergePoints.C
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef mergePoints_H
  34 #define mergePoints_H
  35
  36 #include "scalarField.H"
  37 #include "pointField.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 /*---------------------------------------------------------------------------*\
  45                            Function mergePoints Declaration
  46 \*---------------------------------------------------------------------------*/
  47
  48 //- Sort & merge points. All points closer than/equal mergeTol get merged.
  49 //  Outputs the new unique points and a map from old to new. Returns
  50 //  true if anything merged, false otherwise.
  51 bool mergePoints
  52 (
  53     const UList<point>& points,
  54     const scalar mergeTol,
  55     const bool verbose,
  56     labelList& pointMap,
  57     List<point>& newPoints,
  58     const point& origin = point::zero
  59 );
  60
  61 } // End namespace Foam
  62
  63 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  64
  65 #endif
  66
  67 // ************************************************************************* //