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

nearestToPoint.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 Class
00025     Foam::nearestToPoint
00026 
00027 Description
00028     A topoSetSource to select points nearest to points.
00029 
00030 SourceFiles
00031     nearestToPoint.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef nearestToPoint_H
00036 #define nearestToPoint_H
00037 
00038 #include <meshTools/topoSetSource.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                        Class nearestToPoint Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 class nearestToPoint
00050 :
00051     public topoSetSource
00052 {
00053 
00054     // Private data
00055 
00056         //- Add usage string
00057         static addToUsageTable usage_;
00058 
00059         //- points to select nearest to
00060         pointField points_;
00061 
00062 
00063     // Private Member Functions
00064 
00065         void combine(topoSet& set, const bool add) const;
00066 
00067 
00068 public:
00069 
00070     //- Runtime type information
00071     TypeName("nearestToPoint");
00072 
00073     // Constructors
00074 
00075         //- Construct from components
00076         nearestToPoint
00077         (
00078             const polyMesh& mesh,
00079             const pointField& points
00080         );
00081 
00082         //- Construct from dictionary
00083         nearestToPoint
00084         (
00085             const polyMesh& mesh,
00086             const dictionary& dict
00087         );
00088 
00089         //- Construct from Istream
00090         nearestToPoint
00091         (
00092             const polyMesh& mesh,
00093             Istream&
00094         );
00095 
00096 
00097     // Destructor
00098 
00099         virtual ~nearestToPoint();
00100 
00101 
00102     // Member Functions
00103 
00104         virtual void applyToSet
00105         (
00106             const topoSetSource::setAction action,
00107             topoSet&
00108         ) const;
00109 
00110 };
00111 
00112 
00113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00114 
00115 } // End namespace Foam
00116 
00117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00118 
00119 #endif
00120 
00121 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines