src/meshTools/octree/octreeDataEdges.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::octreeDataEdges
  26
  27 Description
  28     Holds data for octree to work on an edges subset.
  29
  30 SourceFiles
  31     octreeDataEdges.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef octreeDataEdges_H
  36 #define octreeDataEdges_H
  37
  38 #include "line.H"
  39 #include "linePointRef.H"
  40 #include "treeBoundBoxList.H"
  41 #include "labelList.H"
  42 #include "className.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 // Forward declaration of classes
  50 template<class Type> class octree;
  51
  52 /*---------------------------------------------------------------------------*\
  53                        Class octreeDataEdges Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class octreeDataEdges
  57 {
  58     // Static data
  59
  60         //- tolerance on linear dimensions
  61         static scalar tol;
  62
  63
  64     // Private data
  65
  66         //- Reference to edgeList
  67         const edgeList& edges_;
  68
  69         //- Reference to points
  70         const pointField& points_;
  71
  72         //- labels of edges
  73         labelList edgeLabels_;
  74
  75         //- bbs for all above edges
  76         treeBoundBoxList allBb_;
  77
  78
  79 public:
  80
  81     // Declare name of the class and its debug switch
  82     ClassName("octreeDataEdges");
  83
  84     // Constructors
  85
  86         //- Construct from selected edges. !Holds references to edges and points
  87         octreeDataEdges
  88         (
  89             const edgeList& edges,
  90             const pointField& points,
  91             const labelList& edgeLabels
  92         );
  93
  94         //- Construct as copy
  95         octreeDataEdges(const octreeDataEdges&);
  96
  97
  98     //- Destructor
  99     ~octreeDataEdges();
 100
 101
 102     // Member Functions
 103
 104         // Access
 105
 106             const edgeList& edges() const
 107             {
 108                 return edges_;
 109             }
 110
 111             const pointField& points() const
 112             {
 113                 return points_;
 114             }
 115
 116             const labelList& edgeLabels() const
 117             {
 118                 return edgeLabels_;
 119             }
 120
 121             const treeBoundBoxList& allBb() const
 122             {
 123                 return allBb_;
 124             }
 125
 126             label size() const
 127             {
 128                 return allBb_.size();
 129             }
 130
 131
 132         // Search
 133
 134             //- Get type of sample
 135             label getSampleType
 136             (
 137                 const octree<octreeDataEdges>&,
 138                 const point&
 139             ) const;
 140
 141             //- Does (bb of) shape at index overlap bb
 142             bool overlaps
 143             (
 144                 const label index,
 145                 const treeBoundBox& sampleBb
 146             ) const;
 147
 148             //- Does shape at index contain sample
 149             bool contains
 150             (
 151                 const label index,
 152                 const point& sample
 153             ) const;
 154
 155             //- Segment (from start to end) intersection with shape at index.
 156             //  If intersects returns true and sets intersectionPoint
 157             bool intersects
 158             (
 159                 const label index,
 160                 const point& start,
 161                 const point& end,
 162                 point& intersectionPoint
 163             ) const;
 164
 165             //- Sets newTightest to bounding box (and returns true) if
 166             //  nearer to sample than tightest bounding box. Otherwise
 167             //  returns false.
 168             bool findTightest
 169             (
 170                 const label index,
 171                 const point& sample,
 172                 treeBoundBox& tightest
 173             ) const;
 174
 175             //- Given index get unit normal and calculate (numerical) sign
 176             //  of sample.
 177             //  Used to determine accuracy of calcNearest or inside/outside.
 178             scalar calcSign
 179             (
 180                 const label index,
 181                 const point& sample,
 182                 vector& n
 183             ) const;
 184
 185             //- Calculates nearest (to sample) point in shape.
 186             //  Returns point and mag(nearest - sample).
 187             scalar calcNearest
 188             (
 189                 const label index,
 190                 const point& sample,
 191                 point& nearest
 192             ) const;
 193
 194             //- Calculates nearest (to line segment) point in shape.
 195             //  Returns distance and both point.
 196             scalar calcNearest
 197             (
 198                 const label index,
 199                 const linePointRef& ln,
 200                 point& linePt,          // nearest point on line
 201                 point& shapePt          // nearest point on shape
 202             ) const;
 203
 204
 205         // Write
 206
 207             //- Write shape at index
 208             void write(Ostream& os, const label index) const;
 209 };
 210
 211
 212 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 213
 214 } // End namespace Foam
 215
 216 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 217
 218
 219 #endif
 220
 221 // ************************************************************************* //