FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Description
00025     Determine correspondence between points. See below.
00026 
00027 SourceFiles
00028     matchPoints.C
00029 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef matchPoints_H
00033 #define matchPoints_H
00034 
00035 #include <OpenFOAM/scalarField.H>
00036 #include <OpenFOAM/pointField.H>
00037 
00038 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00039 
00040 namespace Foam
00041 {
00042 
00043 /*---------------------------------------------------------------------------*\
00044                            Function matchPoints Declaration
00045 \*---------------------------------------------------------------------------*/
00046 
00047 //- Determine correspondence between pointFields. Gets passed
00048 //  local matching distance per point. Returns map from 0 to 1. Returns
00049 //  true if found corresponding point in 1 for every point in 0; false
00050 //  otherwise. Compares mag(pt - origin) and does proper comparison for points
00051 //  with (almost) identical mag. pts0 can be subset of pts1.
00052 bool matchPoints
00053 (
00054     const UList<point>& pts0,
00055     const UList<point>& pts1,
00056     const UList<scalar>& matchDistance,
00057     const bool verbose,
00058     labelList& from0To1,
00059     const point& origin = point::zero
00060 );
00061 
00062 } // End namespace Foam
00063 
00064 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00065 
00066 #endif
00067 
00068 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines