src/meshTools/indexedOctree/treeDataCell.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::treeDataCell
  27
  28 Description
  29     Encapsulation of data needed to search in/for cells. Used to find the
  30     cell containing a point (e.g. cell-cell mapping).
  31
  32 SourceFiles
  33     treeDataCell.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef treeDataCell_H
  38 #define treeDataCell_H
  39
  40 #include "treeBoundBox.H"
  41 #include "treeBoundBoxList.H"
  42 #include "labelList.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 // Forward declaration of classes
  50 class polyMesh;
  51 template<class Type> class indexedOctree;
  52
  53 /*---------------------------------------------------------------------------*\
  54                            Class treeDataCell Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class treeDataCell
  58 {
  59     // Private data
  60
  61         const polyMesh& mesh_;
  62
  63         //- Subset of cells to work on
  64         const labelList cellLabels_;
  65
  66         //- Whether to precalculate and store cell bounding box
  67         const bool cacheBb_;
  68
  69         //- cell bounding boxes (valid only if cacheBb_)
  70         treeBoundBoxList bbs_;
  71
  72
  73     // Private Member Functions
  74
  75         //- Calculate cell bounding box
  76         treeBoundBox calcCellBb(const label cellI) const;
  77
  78 public:
  79
  80     // Declare name of the class and its debug switch
  81     ClassName("treeDataCell");
  82
  83
  84     // Constructors
  85
  86         //- Construct from mesh and subset of cells.
  87         treeDataCell
  88         (
  89             const bool cacheBb,
  90             const polyMesh&,
  91             const labelList&
  92         );
  93
  94         //- Construct from mesh. Uses all cells in mesh.
  95         treeDataCell(const bool cacheBb, const polyMesh&);
  96
  97
  98     // Member Functions
  99
 100         // Access
 101
 102             const labelList& cellLabels() const
 103             {
 104                 return cellLabels_;
 105             }
 106
 107             const polyMesh& mesh() const
 108             {
 109                 return mesh_;
 110             }
 111
 112
 113             label size() const
 114             {
 115                 return cellLabels_.size();
 116             }
 117
 118             //- Get representative point cloud for all shapes inside
 119             //  (one point per shape)
 120             pointField points() const;
 121
 122
 123         // Search
 124
 125             //- Get type (inside,outside,mixed,unknown) of point w.r.t. surface.
 126             //  Only makes sense for closed surfaces.
 127             label getVolumeType
 128             (
 129                 const indexedOctree<treeDataCell>&,
 130                 const point&
 131             ) const
 132             {
 133                 notImplemented
 134                 (
 135                     "treeDataCell::getVolumeType"
 136                     "(const indexedOctree<treeDataCell>&, const point&)"
 137                 );
 138                 return -1;
 139             }
 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             //- Calculates nearest (to sample) point in shape.
 149             //  Returns actual point and distance (squared)
 150             void findNearest
 151             (
 152                 const labelList& indices,
 153                 const point& sample,
 154
 155                 scalar& nearestDistSqr,
 156                 label& nearestIndex,
 157                 point& nearestPoint
 158             ) const;
 159
 160             //- Calculates nearest (to line) point in shape.
 161             //  Returns point and distance (squared)
 162             void findNearest
 163             (
 164                 const labelList& indices,
 165                 const linePointRef& ln,
 166
 167                 treeBoundBox& tightest,
 168                 label& minIndex,
 169                 point& linePoint,
 170                 point& nearestPoint
 171             ) const
 172             {
 173                 notImplemented
 174                 (
 175                     "treeDataCell::findNearest"
 176                     "(const labelList&, const linePointRef&, ..)"
 177                 );
 178             }
 179
 180             //- Calculate intersection of shape with ray. Sets result
 181             //  accordingly
 182             bool intersects
 183             (
 184                 const label index,
 185                 const point& start,
 186                 const point& end,
 187                 point& result
 188             ) const;
 189
 190 };
 191
 192
 193 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 194
 195 } // End namespace Foam
 196
 197 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 198
 199
 200 #endif
 201
 202 // ************************************************************************* //