OpenFOAM logo
Open Source CFD Toolkit

matchPoints.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Description
00026     Determine correspondence between points. See below.
00027 
00028 SourceFiles
00029     matchPoints.C
00030 
00031 \*---------------------------------------------------------------------------*/
00032 
00033 #ifndef matchPoints_H
00034 #define matchPoints_H
00035 
00036 #include "scalarField.H"
00037 #include "pointField.H"
00038 
00039 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00040 
00041 namespace Foam
00042 {
00043 
00044 /*---------------------------------------------------------------------------*\
00045                            Function matchPoints Declaration
00046 \*---------------------------------------------------------------------------*/
00047 
00048 //- Determine correspondence between pointFields. Gets passed
00049 //  local tolerance per point. Returns map from 0 to 1. Returns
00050 //  true if found corresponding point in 1 for every point in 0; false
00051 //  otherwise. Compares mag(pt - origin) and does proper comparison for points
00052 //  with (almost) identical mag. pts0 can be subset of pts1.
00053 bool matchPoints
00054 (
00055     const pointField& pts0,
00056     const pointField& pts1,
00057     const scalarField& tols,
00058     const bool verbose,
00059     labelList& from0To1,
00060     const point& origin = point::zero
00061 );
00062 
00063 } // End namespace Foam
00064 
00065 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00066 
00067 #endif
00068 
00069 // ************************************************************************* //
For further information go to www.openfoam.org