src/OpenFOAM/meshes/primitiveShapes/objectHit/pointHitSort.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::pointHitSort
  26
  27 Description
  28     Container for sorting intersections
  29
  30 SourceFiles
  31
  32 \*---------------------------------------------------------------------------*/
  33
  34 #ifndef pointHitSort_H
  35 #define pointHitSort_H
  36
  37 #include "pointHit.H"
  38 #include "label.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 // Forward declaration of classes
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class pointHitSort Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class pointHitSort
  52 {
  53     // Private data
  54
  55         //- intersection
  56         pointHit inter_;
  57
  58         //- original index
  59         label index_;
  60
  61 public:
  62
  63     // Constructors
  64
  65         //- Construct null
  66         pointHitSort()
  67         :
  68             inter_(false, vector::zero, GREAT, false),
  69             index_(-1)
  70         {}
  71
  72         //- Construct from intersection, index
  73         pointHitSort(const pointHit& inter, const label index)
  74         :
  75             inter_(inter),
  76             index_(index)
  77         {}
  78
  79
  80     // Member Functions
  81
  82         const pointHit& inter() const
  83         {
  84             return inter_;
  85         }
  86
  87         label index() const
  88         {
  89             return index_;
  90         }
  91
  92     // Member Operators
  93
  94         bool operator==(const pointHitSort& rhs) const
  95         {
  96             return inter_.distance() == rhs.inter().distance();
  97         }
  98
  99         bool operator<(const pointHitSort& rhs) const
 100         {
 101             return inter_.distance() < rhs.inter().distance();
 102         }
 103
 104 };
 105
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 } // End namespace Foam
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 #endif
 114
 115 // ************************************************************************* //