src/meshTools/indexedOctree/treeDataPoint.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::treeDataPoint
  26
  27 Description
  28     Holds (reference to) pointField. Encapsulation of data needed for
  29     octree searches.
  30     Used for searching for nearest point. No bounding boxes around points.
  31     Only overlaps and calcNearest are implemented, rest makes little sense.
  32
  33     Optionally works on subset of points.
  34
  35 SourceFiles
  36     treeDataPoint.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef treeDataPoint_H
  41 #define treeDataPoint_H
  42
  43 #include "pointField.H"
  44 #include "treeBoundBox.H"
  45 #include "linePointRef.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 // Forward declaration of classes
  53 template<class Type> class indexedOctree;
  54
  55 /*---------------------------------------------------------------------------*\
  56                            Class treeDataPoint Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 class treeDataPoint
  60 {
  61     // Private data
  62
  63         const pointField& points_;
  64
  65         //- Subset of points to work on (or empty)
  66         const labelList pointLabels_;
  67
  68         const bool useSubset_;
  69
  70 public:
  71
  72     // Declare name of the class and its debug switch
  73     ClassName("treeDataPoint");
  74
  75
  76     // Constructors
  77
  78         //- Construct from pointField. Holds reference!
  79         treeDataPoint(const pointField&);
  80
  81         //- Construct from subset of pointField. Holds reference!
  82         treeDataPoint(const pointField&, const labelList&);
  83
  84
  85     // Member Functions
  86
  87         // Access
  88
  89             inline label size() const
  90             {
  91                 return
  92                 (
  93                     useSubset_
  94                   ? pointLabels_.size()
  95                   : points_.size()
  96                 );
  97             }
  98
  99             inline const labelList& pointLabels() const
 100             {
 101                 return pointLabels_;
 102             }
 103
 104             const pointField& points() const
 105             {
 106                 return points_;
 107             }
 108
 109             //- Get representative point cloud for all shapes inside
 110             //  (one point per shape)
 111             pointField shapePoints() const;
 112
 113
 114         // Search
 115
 116             //- Get type (inside,outside,mixed,unknown) of point w.r.t. surface.
 117             //  Only makes sense for closed surfaces.
 118             label getVolumeType
 119             (
 120                 const indexedOctree<treeDataPoint>&,
 121                 const point&
 122             ) const;
 123
 124             //- Does (bb of) shape at index overlap bb
 125             bool overlaps
 126             (
 127                 const label index,
 128                 const treeBoundBox& sampleBb
 129             ) const;
 130
 131             //- Calculates nearest (to sample) point in shape.
 132             //  Returns actual point and distance (squared)
 133             void findNearest
 134             (
 135                 const labelUList& indices,
 136                 const point& sample,
 137
 138                 scalar& nearestDistSqr,
 139                 label& nearestIndex,
 140                 point& nearestPoint
 141             ) const;
 142
 143             //- Calculates nearest (to line) point in shape.
 144             //  Returns point and distance (squared)
 145             void findNearest
 146             (
 147                 const labelUList& indices,
 148                 const linePointRef& ln,
 149
 150                 treeBoundBox& tightest,
 151                 label& minIndex,
 152                 point& linePoint,
 153                 point& nearestPoint
 154             ) const;
 155
 156             //- Calculate intersection of shape with ray. Sets result
 157             //  accordingly
 158             bool intersects
 159             (
 160                 const label index,
 161                 const point& start,
 162                 const point& end,
 163                 point& result
 164             ) const
 165             {
 166                 notImplemented
 167                 (
 168                     "treeDataPoint::intersects(const label, const point&,"
 169                     "const point&, point&)"
 170                 );
 171                 return false;
 172             }
 173
 174 };
 175
 176
 177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 178
 179 } // End namespace Foam
 180
 181 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 182
 183
 184 #endif
 185
 186 // ************************************************************************* //