Public Member Functions | Private Attributes | Friends
PointHit Class Reference

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. More...

Inheritance diagram for PointHit:
Inheritance graph
[legend]

Public Member Functions

 PointHit ()
 Construct null. More...
 
 PointHit (const bool hit, const Point &p, const scalar dist, const bool eligibleMiss)
 Construct from components. More...
 
 PointHit (const Point &p)
 Construct from point. Hit and distance set later. More...
 
bool hit () const
 Is there a hit. More...
 
const Point & hitPoint () const
 Return hit point. More...
 
scalar distance () const
 Return distance to hit. More...
 
const Point & missPoint () const
 Return miss point. More...
 
const Point & rawPoint () const
 Return point with no checking. More...
 
bool eligibleMiss () const
 Is this an eligible miss. More...
 
void setHit ()
 
void setMiss (const bool eligible)
 
void setPoint (const Point &p)
 
void setDistance (const scalar d)
 

Private Attributes

bool hit_
 Hit success. More...
 
Point hitPoint_
 Point of hit; for miss holds best estimate outside the object. More...
 
scalar distance_
 Distance to hit point. More...
 
bool eligibleMiss_
 Eligible miss. More...
 

Friends

Ostream & operator (Ostream &os, const PointHit< Point > &b)
 

Detailed 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.

Definition at line 51 of file PointHit.H.

Constructor & Destructor Documentation

◆ PointHit() [1/3]

PointHit ( )
inline

Construct null.

Definition at line 84 of file PointHit.H.

◆ PointHit() [2/3]

PointHit ( const bool  hit,
const Point &  p,
const scalar  dist,
const bool  eligibleMiss 
)
inline

Construct from components.

Definition at line 94 of file PointHit.H.

◆ PointHit() [3/3]

PointHit ( const Point &  p)
inline

Construct from point. Hit and distance set later.

Definition at line 108 of file PointHit.H.

Member Function Documentation

◆ hit()

bool hit ( ) const
inline

Is there a hit.

Definition at line 120 of file PointHit.H.

Referenced by extendedEdgeMesh::allNearestFeatureEdges(), directAMI< SourcePatch, TargetPatch >::appendToDirectSeeds(), triSurfaceTools::calcInterpolationWeights(), slidingInterface::coupleInterface(), surfaceFeatures::edgeNearest(), mappedPatchBase::facePoint(), faceTriangulation::findDiagonal(), treeDataPrimitivePatch< PatchType >::findIntersection(), sampledSet::findNearFace(), treeDataFace::getVolumeType(), treeDataPrimitivePatch< PatchType >::getVolumeType(), particle< Type >::hitWallFaces(), face::intersection(), treeDataTriSurface::intersects(), slidingInterface::modifyMotionPoints(), face::nearestPointClassify(), treeDataCell::findIntersectOp::operator()(), treeDataFace::findIntersectOp::operator()(), searchableRotatedBox::overlaps(), PrimitivePatch< labelledTri, List, pointField, point >::projectFaceCentres(), PrimitivePatch< labelledTri, List, pointField, point >::projectPoints(), slidingInterface::projectPoints(), face::ray(), triangle< Foam::Vector, Foam::Vector >::ray(), AMIInterpolation< SourcePatch, TargetPatch >::srcPointFace(), and AMIInterpolation< SourcePatch, TargetPatch >::tgtPointFace().

Here is the caller graph for this function:

◆ hitPoint()

const Point& hitPoint ( ) const
inline

Return hit point.

Definition at line 126 of file PointHit.H.

Referenced by PatchToPatchInterpolation< FromPatch, ToPatch >::calcFaceAddressing(), PatchToPatchInterpolation< FromPatch, ToPatch >::calcPointAddressing(), slidingInterface::coupleInterface(), mappedPatchBase::facePoint(), treeDataPrimitivePatch< PatchType >::findIntersection(), sampledSet::findNearFace(), face::intersection(), treeDataTriSurface::intersects(), slidingInterface::modifyMotionPoints(), face::nearestPointClassify(), treeDataCell::findIntersectOp::operator()(), treeDataFace::findIntersectOp::operator()(), PrimitivePatch< labelledTri, List, pointField, point >::projectFaceCentres(), PrimitivePatch< labelledTri, List, pointField, point >::projectPoints(), slidingInterface::projectPoints(), and face::ray().

Here is the caller graph for this function:

◆ distance()

scalar distance ( ) const
inline

Return distance to hit.

Definition at line 139 of file PointHit.H.

Referenced by booleanSurface::booleanSurface(), PatchToPatchInterpolation< FromPatch, ToPatch >::calcFaceAddressing(), triSurfaceTools::calcInterpolationWeights(), PatchToPatchInterpolation< FromPatch, ToPatch >::calcPointAddressing(), slidingInterface::coupleInterface(), mappedPatchBase::facePoint(), faceTriangulation::findDiagonal(), treeDataPrimitivePatch< PatchType >::findIntersection(), dynamicTreeDataPoint::findNearest(), meshSearch::findNearestBoundaryFace(), meshSearch::findNearestBoundaryFaceWalk(), cellPointWeight::findTetrahedron(), cellPointWeight::findTriangle(), face::intersection(), treeDataTriSurface::intersects(), faceCoupleInfo::maxDistance(), slidingInterface::modifyMotionPoints(), tetrahedron::nearestPoint(), face::nearestPointClassify(), treeDataPoint::findNearestOp::operator()(), treeDataEdge::findNearestOp::operator()(), treeDataPrimitivePatch< PatchType >::findNearestOp::operator()(), treeDataFace::findNearestOp::operator()(), treeDataCell::findIntersectOp::operator()(), treeDataFace::findIntersectOp::operator()(), pointHitSort::operator<(), pointHitSort::operator==(), orientedSurface::orient(), searchableRotatedBox::overlaps(), treeDataEdge::overlaps(), treeDataPrimitivePatch< PatchType >::overlaps(), PrimitivePatch< labelledTri, List, pointField, point >::projectFaceCentres(), PrimitivePatch< labelledTri, List, pointField, point >::projectPoints(), slidingInterface::projectPoints(), face::ray(), cellDistFuncs::smallestDist(), sampledTriSurfaceMesh::update(), and PairCollision< CloudType >::wallInteraction().

Here is the caller graph for this function:

◆ missPoint()

const Point& missPoint ( ) const
inline

Return miss point.

Definition at line 145 of file PointHit.H.

Referenced by PatchToPatchInterpolation< FromPatch, ToPatch >::calcPointAddressing(), sampledSet::findNearFace(), slidingInterface::modifyMotionPoints(), face::nearestPointClassify(), PrimitivePatch< labelledTri, List, pointField, point >::projectFaceCentres(), PrimitivePatch< labelledTri, List, pointField, point >::projectPoints(), slidingInterface::projectPoints(), and face::ray().

Here is the caller graph for this function:

◆ rawPoint()

const Point& rawPoint ( ) const
inline

Return point with no checking.

Definition at line 158 of file PointHit.H.

Referenced by extendedEdgeMesh::allNearestFeatureEdges(), booleanSurface::booleanSurface(), triSurfaceTools::calcInterpolationWeights(), tetrahedron::containmentSphere(), surfaceFeatures::edgeNearest(), dynamicTreeDataPoint::findNearest(), treeDataFace::getVolumeType(), treeDataPrimitivePatch< PatchType >::getVolumeType(), tetrahedron::nearestPoint(), treeDataPoint::findNearestOp::operator()(), treeDataEdge::findNearestOp::operator()(), treeDataPrimitivePatch< PatchType >::findNearestOp::operator()(), treeDataFace::findNearestOp::operator()(), orientedSurface::orient(), triangle< Foam::Vector, Foam::Vector >::ray(), faceCollapser::setRefinement(), AMIInterpolation< SourcePatch, TargetPatch >::srcPointFace(), triSurfaceTools::surfaceSide(), AMIInterpolation< SourcePatch, TargetPatch >::tgtPointFace(), sampledTriSurfaceMesh::update(), and PairCollision< CloudType >::wallInteraction().

Here is the caller graph for this function:

◆ eligibleMiss()

bool eligibleMiss ( ) const
inline

Is this an eligible miss.

Definition at line 164 of file PointHit.H.

Referenced by PrimitivePatch< labelledTri, List, pointField, point >::projectFaceCentres(), PrimitivePatch< labelledTri, List, pointField, point >::projectPoints(), and face::ray().

Here is the caller graph for this function:

◆ setHit()

void setHit ( )
inline

Definition at line 169 of file PointHit.H.

Referenced by tetrahedron::containmentSphere(), face::intersection(), face::nearestPointClassify(), face::ray(), triangle< Foam::Vector, Foam::Vector >::ray(), and faceTriangulation::rayEdgeIntersect().

Here is the caller graph for this function:

◆ setMiss()

void setMiss ( const bool  eligible)
inline

Definition at line 175 of file PointHit.H.

Referenced by tetrahedron::containmentSphere(), face::nearestPointClassify(), face::ray(), and triangle< Foam::Vector, Foam::Vector >::ray().

Here is the caller graph for this function:

◆ setPoint()

void setPoint ( const Point &  p)
inline

Definition at line 181 of file PointHit.H.

Referenced by tetrahedron::containmentSphere(), face::intersection(), face::nearestPointClassify(), face::ray(), triangle< Foam::Vector, Foam::Vector >::ray(), faceTriangulation::rayEdgeIntersect(), and faceCollapser::setRefinement().

Here is the caller graph for this function:

◆ setDistance()

void setDistance ( const scalar  d)
inline

Definition at line 186 of file PointHit.H.

Referenced by tetrahedron::containmentSphere(), face::intersection(), face::nearestPointClassify(), face::ray(), triangle< Foam::Vector, Foam::Vector >::ray(), and faceTriangulation::rayEdgeIntersect().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator

Ostream& operator ( Ostream &  os,
const PointHit< Point > &  b 
)
friend

Field Documentation

◆ hit_

bool hit_
private

Hit success.

Definition at line 67 of file PointHit.H.

Referenced by PointHit< point >::hit(), PointHit< point >::hitPoint(), PointHit< point >::missPoint(), PointHit< point >::setHit(), and PointHit< point >::setMiss().

◆ hitPoint_

Point hitPoint_
private

Point of hit; for miss holds best estimate outside the object.

Definition at line 70 of file PointHit.H.

Referenced by PointHit< point >::hitPoint(), PointHit< point >::missPoint(), PointHit< point >::rawPoint(), and PointHit< point >::setPoint().

◆ distance_

scalar distance_
private

Distance to hit point.

Definition at line 73 of file PointHit.H.

Referenced by PointHit< point >::distance(), and PointHit< point >::setDistance().

◆ eligibleMiss_

bool eligibleMiss_
private

Eligible miss.

Definition at line 76 of file PointHit.H.

Referenced by PointHit< point >::eligibleMiss(), PointHit< point >::setHit(), and PointHit< point >::setMiss().

The documentation for this class was generated from the following file:

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17