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