OpenFOAM logo
Open Source CFD Toolkit

pointHitSort.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 Class
00026     pointHitSort
00027 
00028 Description
00029     Container for sorting intersections
00030 
00031 SourceFiles
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef pointHitSort_H
00036 #define pointHitSort_H
00037 
00038 #include "pointHit.H"
00039 #include "label.H"
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 // Class forward declarations
00047 
00048 /*---------------------------------------------------------------------------*\
00049                            Class pointHitSort Declaration
00050 \*---------------------------------------------------------------------------*/
00051 
00052 class pointHitSort
00053 {
00054     // Private data
00055 
00056         //- intersection
00057         pointHit inter_;
00058 
00059         //- original index
00060         label index_;
00061 
00062 public:
00063 
00064     // Constructors
00065 
00066         //- Construct null
00067         pointHitSort()
00068         :
00069             inter_(false, vector::zero, GREAT),
00070             index_(-1)
00071         {}
00072 
00073         //- Construct from intersection, index
00074         pointHitSort(const pointHit& inter, const label index)
00075         :
00076             inter_(inter),
00077             index_(index)
00078         {}
00079 
00080 
00081     // Member Functions
00082 
00083         const pointHit& inter() const
00084         {
00085             return inter_;
00086         }
00087 
00088         label index() const
00089         {
00090             return index_;
00091         }
00092 
00093     // Member Operators
00094 
00095         bool operator==(const pointHitSort& rhs) const
00096         {
00097             return inter_.distance() == rhs.inter().distance();
00098         }
00099 
00100         bool operator>(const pointHitSort& rhs) const
00101         {
00102             return inter_.distance() > rhs.inter().distance();
00103         }
00104 
00105 };
00106 
00107 
00108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00109 
00110 } // End namespace Foam
00111 
00112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00113 
00114 #endif
00115 
00116 // ************************************************************************* //
For further information go to www.openfoam.org