src/meshTools/octree/octreeDataPoint.C

   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 \*---------------------------------------------------------------------------*/
  26
  27 #include "octreeDataPoint.H"
  28
  29 #include "labelList.H"
  30 #include "treeBoundBox.H"
  31 #include "octree.H"
  32 #include "linePointRef.H"
  33 #include "pointHit.H"
  34
  35 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  36
  37 // Construct from components
  38 Foam::octreeDataPoint::octreeDataPoint(const pointField& points)
  39 :
  40     points_(points)
  41 {}
  42
  43
  44 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  45
  46 //- Get type of volume
  47 Foam::label Foam::octreeDataPoint::getSampleType
  48 (
  49     const octree<octreeDataPoint>&,
  50     const point&
  51 ) const
  52 {
  53     return octree<octreeDataPoint>::UNKNOWN;
  54 }
  55
  56
  57 bool Foam::octreeDataPoint::overlaps
  58 (
  59     const label index,
  60     const treeBoundBox& sampleBb
  61 ) const
  62 {
  63     return sampleBb.contains(points_[index]);
  64 }
  65
  66
  67 bool Foam::octreeDataPoint::contains
  68 (
  69     const label,
  70     const point&
  71 ) const
  72 {
  73     notImplemented
  74     (
  75         "octreeDataPoint::contains(const label, const point&)"
  76     );
  77
  78     return false;
  79 }
  80
  81
  82 bool Foam::octreeDataPoint::intersects
  83 (
  84     const label,
  85     const point&,
  86     const point&,
  87     point&
  88 ) const
  89 {
  90     notImplemented
  91     (
  92         "octreeDataPoint::intersects(const label, const point&,"
  93         "const point&, point&)"
  94     );
  95
  96     return false;
  97 }
  98
  99
 100 bool Foam::octreeDataPoint::findTightest
 101 (
 102     const label,
 103     const point&,
 104     treeBoundBox&
 105 ) const
 106 {
 107     notImplemented
 108     (
 109         "octreeDataPoint::findTightest(const label, const point&,"
 110         "treeBoundBox&)"
 111     );
 112
 113     return false;
 114 }
 115
 116
 117 Foam::scalar Foam::octreeDataPoint::calcSign
 118 (
 119     const label,
 120     const point&,
 121     vector& n
 122 ) const
 123 {
 124     n = vector::zero;
 125
 126     return 1;
 127 }
 128
 129
 130 // Calculate nearest point on/in shapei
 131 inline Foam::scalar Foam::octreeDataPoint::calcNearest
 132 (
 133     const label index,
 134     const point& sample,
 135     point& nearest
 136 ) const
 137 {
 138     nearest = points_[index];
 139     return magSqr(points_[index] - sample);
 140 }
 141
 142
 143 void Foam::octreeDataPoint::write
 144 (
 145     Ostream& os,
 146     const label index
 147 ) const
 148 {
 149     if ((index < 0) || (index > points().size()))
 150     {
 151         FatalErrorIn("octreeDataPoint::write(Ostream&, const label)")
 152             << "Index " << index << " outside 0.." << points().size()
 153             << abort(FatalError);
 154     }
 155     os << ' ' << points()[index];
 156 }
 157
 158
 159 // Calculate nearest point on/in shapei
 160 Foam::scalar Foam::octreeDataPoint::calcNearest
 161 (
 162     const label index,
 163     const linePointRef& ln,
 164     point& linePt,
 165     point& shapePt
 166 ) const
 167 {
 168     // Nearest point on shape
 169     shapePt = points_[index];
 170
 171     // Nearest point on line
 172     pointHit pHit = ln.nearestDist(shapePt);
 173
 174     linePt = pHit.rawPoint();
 175
 176     return pHit.distance();
 177 }
 178
 179
 180 // * * * * * * * * * * * * * * * Friend Operators  * * * * * * * * * * * * * //
 181
 182 Foam::Ostream& Foam::operator<<
 183 (
 184     Foam::Ostream& os,
 185     const Foam::octreeDataPoint& ocPts
 186 )
 187 {
 188     return os << ocPts.points();
 189 }
 190
 191
 192 // ************************************************************************* //