File size: 5,326 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::PointHit
Description
This class describes the interaction of a face and a point. It
carries the info of a successful hit and (if successful), returns
the interaction point.
\*---------------------------------------------------------------------------*/
#ifndef PointHit_H
#define PointHit_H
#include "bool.H"
#include "token.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class Ostream;
// Forward declaration of friend functions and operators
template<class Point> class PointHit;
template<class Point>
inline Ostream& operator<<(Ostream&, const PointHit<Point>&);
/*---------------------------------------------------------------------------*\
Class PointHit Declaration
\*---------------------------------------------------------------------------*/
template<class Point>
class PointHit
{
// Private Data
//- Hit success
bool hit_;
//- Point of hit; for miss holds best estimate outside the object
Point hitPoint_;
//- Distance to hit point
scalar distance_;
//- Eligible miss
bool eligibleMiss_;
public:
// Constructors
//- Construct null
PointHit()
:
hit_(false),
hitPoint_(Zero),
distance_(great),
eligibleMiss_(false)
{}
//- Construct from components
PointHit
(
const bool hit,
const Point& p,
const scalar dist,
const bool eligibleMiss
)
:
hit_(hit),
hitPoint_(p),
distance_(dist),
eligibleMiss_(eligibleMiss)
{}
//- Construct from point. Hit and distance set later
PointHit(const Point& p)
:
hit_(false),
hitPoint_(p),
distance_(great),
eligibleMiss_(false)
{}
// Member Functions
//- Is there a hit
bool hit() const
{
return hit_;
}
//- Return hit point
const Point& hitPoint() const
{
if (!hit_)
{
FatalErrorInFunction
<< "requested a hit point for a miss"
<< abort(FatalError);
}
return hitPoint_;
}
//- Return distance to hit
scalar distance() const
{
return distance_;
}
//- Return miss point
const Point& missPoint() const
{
if (hit_)
{
FatalErrorInFunction
<< "requested a miss point for a hit"
<< abort(FatalError);
}
return hitPoint_;
}
//- Return point with no checking
const Point& rawPoint() const
{
return hitPoint_;
}
//- Is this an eligible miss
bool eligibleMiss() const
{
return eligibleMiss_;
}
void setHit()
{
hit_ = true;
eligibleMiss_ = false;
}
void setMiss(const bool eligible)
{
hit_ = false;
eligibleMiss_ = eligible;
}
void setPoint(const Point& p)
{
hitPoint_ = p;
}
void setDistance(const scalar d)
{
distance_ = d;
}
// Ostream operator
friend Ostream& operator<< <Point>
(
Ostream& os,
const PointHit<Point>& b
);
};
template<class Point>
inline Ostream& operator<<(Ostream& os, const PointHit<Point>& b)
{
os << b.hit() << token::SPACE
<< b.rawPoint() << token::SPACE
<< b.distance() << token::SPACE
<< b.eligibleMiss();
return os;
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|