This class describes the interaction of (usually) a face and a point. It carries the info of a successful hit and (if successful), returns the interaction point. More...
Public Types | |
typedef PointType | point_type |
The point type. More... | |
Public Member Functions | |
PointIndexHit () | |
Default construct. A zero point, with no hit and index = -1. More... | |
PointIndexHit (const point_type &p) | |
Construct from a point, with no hit and index = -1. More... | |
PointIndexHit (const bool success, const point_type &p, const label index) | |
Construct from components. More... | |
PointIndexHit (Istream &is) | |
Construct from Istream. More... | |
bool | hit () const noexcept |
Is there a hit? More... | |
label | index () const noexcept |
Return the hit index. More... | |
const point_type & | point () const noexcept |
Return point, no checks. More... | |
point_type & | point () noexcept |
Access the point, no checks. More... | |
const point_type & | hitPoint () const |
Return hit point. Fatal if not hit. More... | |
const point_type & | missPoint () const |
Return miss point. Fatal if hit. More... | |
const point_type & | rawPoint () const noexcept |
The point, no checks. Same as point() More... | |
point_type & | rawPoint () noexcept |
The point, no checks. Same as point() More... | |
void | setHit () noexcept |
Set the hit status on. More... | |
void | setMiss () noexcept |
Set the hit status off. More... | |
void | setPoint (const point_type &p) |
Set the point. More... | |
void | setIndex (const label index) noexcept |
Set the index. More... | |
void | hitPoint (const point_type &p, const label index) |
Set the point as hit and the hit-index. More... | |
void | write (Ostream &os) |
bool | operator== (const PointIndexHit &rhs) const |
Test for equality of all components. More... | |
bool | operator!= (const PointIndexHit &rhs) const |
Test for inequality of components. More... | |
Friends | |
Ostream & | operator<< (Ostream &os, const PointIndexHit &pHit) |
Istream & | operator>> (Istream &is, PointIndexHit &pHit) |
This class describes the interaction of (usually) a face and a point. It carries the info of a successful hit and (if successful), returns the interaction point.
like pointHit but carries face (or cell, edge etc.) index
Definition at line 52 of file PointIndexHit.H.
typedef PointType point_type |
The point type.
Definition at line 84 of file PointIndexHit.H.
|
inline |
Default construct. A zero point, with no hit and index = -1.
Definition at line 90 of file PointIndexHit.H.
|
inlineexplicit |
Construct from a point, with no hit and index = -1.
Definition at line 98 of file PointIndexHit.H.
|
inline |
Construct from components.
Definition at line 107 of file PointIndexHit.H.
|
inlineexplicit |
Construct from Istream.
Definition at line 119 of file PointIndexHit.H.
|
inlinenoexcept |
Is there a hit?
Definition at line 130 of file PointIndexHit.H.
Referenced by nearWallFields::calcAddressing(), Foam::calcProximityOfFeatureEdges(), Foam::calcProximityOfFeaturePoints(), nearestFaceAMI::calculate(), patchProbes::findElements(), mapNearestMethod::findInitialSeeds(), searchableCone::findLine(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findLine(), triSurfaceSearch::findLineAll(), searchableDisk::findLineAll(), searchableCylinder::findLineAll(), searchableRotatedBox::findLineAll(), searchableBox::findLineAll(), searchableCone::findLineAll(), searchableSphere::findLineAll(), triSurfaceRegionSearch::findNearest(), distributedTriSurfaceMesh::findNearest(), meshSearch::findNearestBoundaryFace(), refinementFeatures::findNearestEdge(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), boundaryMesh::getNearest(), meshSearch::intersection(), meshSearch::intersections(), edgeIntersections::merge(), surfaceFeatures::nearestFeatEdge(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSurfEdge(), Foam::operator<<(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), triSurfaceTools::track(), and triSurfaceTools::trackToEdge().
|
inlinenoexcept |
Return the hit index.
Definition at line 136 of file PointIndexHit.H.
Referenced by nearWallFields::calcAddressing(), Foam::calcProximityOfFeatureEdges(), nearestFaceAMI::calculate(), patchProbes::findElements(), mapNearestMethod::findInitialSeeds(), searchableBox::findLine(), triSurfaceSearch::findLineAll(), searchableRotatedBox::findLineAll(), searchableBox::findLineAll(), distributedTriSurfaceMesh::findNearest(), meshSearch::findNearestBoundaryFace(), refinementFeatures::findNearestEdge(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), searchableExtrudedCircle::findParametricNearest(), boundaryMesh::getNearest(), searchableExtrudedCircle::getNormal(), treeDataFace::getVolumeType(), treeDataPrimitivePatch< PatchType >::getVolumeType(), PointIndexHit< PointType >::hitPoint(), meshSearch::intersection(), meshSearch::intersections(), edgeIntersections::merge(), surfaceFeatures::nearestFeatEdge(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSurfEdge(), surfaceLocation::normal(), Foam::operator<<(), PointIndexHit< PointType >::setIndex(), surfaceIntersection::surfaceIntersection(), and triSurfaceTools::trackToEdge().
|
inlinenoexcept |
Return point, no checks.
Definition at line 142 of file PointIndexHit.H.
Referenced by Foam::normalDistance_nonzero(), Foam::normalDistance_zero(), and Foam::operator<<().
|
inlinenoexcept |
Access the point, no checks.
Definition at line 148 of file PointIndexHit.H.
|
inline |
Return hit point. Fatal if not hit.
Definition at line 154 of file PointIndexHit.H.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
Referenced by nearWallFields::calcAddressing(), Foam::calcProximityOfFeatureEdges(), Foam::calcProximityOfFeaturePoints(), patchProbes::findElements(), searchableRotatedBox::findLineAll(), searchableBox::findLineAll(), triSurfaceRegionSearch::findNearest(), distributedTriSurfaceMesh::findNearest(), refinementFeatures::findNearestEdge(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), searchableExtrudedCircle::findParametricNearest(), boundaryMesh::getNearest(), searchableExtrudedCircle::getNormal(), surfaceFeatures::nearestSurfEdge(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), and surfaceIntersection::surfaceIntersection().
|
inline |
Return miss point. Fatal if hit.
Definition at line 166 of file PointIndexHit.H.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
|
inlinenoexcept |
The point, no checks. Same as point()
Definition at line 178 of file PointIndexHit.H.
Referenced by searchableRotatedBox::findLine(), searchableBox::findLine(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findLine(), searchableRotatedBox::findNearest(), searchableBox::findNearestOnEdge(), edgeIntersections::merge(), surfaceFeatures::nearestSurfEdge(), and triSurfaceTools::trackToEdge().
|
inlinenoexcept |
The point, no checks. Same as point()
Definition at line 184 of file PointIndexHit.H.
|
inlinenoexcept |
Set the hit status on.
Definition at line 193 of file PointIndexHit.H.
Referenced by triSurfaceTools::classify(), and searchableBox::findLine().
|
inlinenoexcept |
Set the hit status off.
Definition at line 199 of file PointIndexHit.H.
Referenced by triSurfaceTools::classify(), searchableBox::findNearestOnEdge(), and triSurfaceTools::trackToEdge().
|
inline |
Set the point.
Definition at line 205 of file PointIndexHit.H.
References p.
Referenced by triSurfaceTools::classify().
|
inlinenoexcept |
Set the index.
Definition at line 211 of file PointIndexHit.H.
References PointIndexHit< PointType >::index().
Referenced by triSurfaceTools::classify(), searchableBox::findLine(), searchableBox::findNearestOnEdge(), meshSearch::intersection(), and meshSearch::intersections().
|
inline |
Set the point as hit and the hit-index.
Definition at line 217 of file PointIndexHit.H.
References PointIndexHit< PointType >::index(), and p.
|
inline |
Definition at line 227 of file PointIndexHit.H.
References os().
|
inline |
Test for equality of all components.
Definition at line 237 of file PointIndexHit.H.
|
inline |
Test for inequality of components.
Definition at line 248 of file PointIndexHit.H.
|
friend |
Definition at line 256 of file PointIndexHit.H.
|
friend |
Definition at line 278 of file PointIndexHit.H.