src/OpenFOAM/meshes/meshTools/matchPoints.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     Determine correspondence between points. See below.
  27
  28 SourceFiles
  29     matchPoints.C
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef matchPoints_H
  34 #define matchPoints_H
  35
  36 #include "scalarField.H"
  37 #include "pointField.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 /*---------------------------------------------------------------------------*\
  45                            Function matchPoints Declaration
  46 \*---------------------------------------------------------------------------*/
  47
  48 //- Determine correspondence between pointFields. Gets passed
  49 //  local matching distance per point. Returns map from 0 to 1. Returns
  50 //  true if found corresponding point in 1 for every point in 0; false
  51 //  otherwise. Compares mag(pt - origin) and does proper comparison for points
  52 //  with (almost) identical mag. pts0 can be subset of pts1.
  53 bool matchPoints
  54 (
  55     const UList<point>& pts0,
  56     const UList<point>& pts1,
  57     const UList<scalar>& matchDistance,
  58     const bool verbose,
  59     labelList& from0To1,
  60     const point& origin = point::zero
  61 );
  62
  63 } // End namespace Foam
  64
  65 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  66
  67 #endif
  68
  69 // ************************************************************************* //