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