src/meshTools/octree/pointHitSort.H

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