src/meshTools/octree/octreeDataEdges.H

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