PointHit< PointType > Class Template Reference

Describes the interaction of a face and a point. It carries the info of a successful hit and (if successful) the interaction point. More...

Public Types
typedef PointType	point_type

Public Member Functions
	PointHit ()
	PointHit (const point_type &p)
	PointHit (const bool hit, const point_type &p, const scalar dist, const bool eligibleMiss=false)
bool	hit () const noexcept
bool	eligibleMiss () const noexcept
const point_type &	point () const noexcept
scalar	distance () const noexcept
const point_type &	hitPoint () const
const point_type &	missPoint () const
const point_type &	rawPoint () const noexcept
void	setHit () noexcept
void	setMiss (const bool eligible) noexcept
void	setPoint (const point_type &p)
void	setDistance (const scalar d) noexcept
template<class AnyPointType >
bool	operator< (const PointHit< AnyPointType > &rhs) const noexcept

Detailed Description

template<class PointType>
class Foam::PointHit< PointType >

Describes the interaction of a face and a point. It carries the info of a successful hit and (if successful) the interaction point.

Definition at line 47 of file PointHit.H.

Member Typedef Documentation

point_type

typedef PointType point_type

Definition at line 69 of file PointHit.H.

Constructor & Destructor Documentation

PointHit() [1/3]

PointHit ( )

inline

Definition at line 76 of file PointHit.H.

PointHit() [2/3]

PointHit ( const point_type &  p )

inlineexplicit

Definition at line 86 of file PointHit.H.

PointHit() [3/3]

PointHit ( const bool  hit, const point_type &  p, const scalar  dist, const bool  eligibleMiss = false  )

inline

Definition at line 96 of file PointHit.H.

Member Function Documentation

hit()

bool hit ( ) const

inlinenoexcept

Definition at line 115 of file PointHit.H.

Referenced by extendedEdgeMesh::allNearestFeatureEdges(), triSurfaceTools::calcInterpolationWeights(), mappedPatchBase::facePoint(), treeDataPrimitivePatch< PatchType >::findIntersection(), sampledSet::findNearFace(), treeDataFace::getVolumeType(), treeDataPrimitivePatch< PatchType >::getVolumeType(), triangleFuncs::intersectBb(), face::intersection(), slidingInterface::modifyMotionPoints(), face::nearestPointClassify(), treeDataCell::findIntersectOp::operator()(), treeDataFace::findIntersectOp::operator()(), Foam::operator<<(), searchableRotatedBox::overlaps(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::projectFaceCentres(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::projectPoints(), face::ray(), triangle::ray(), AMIInterpolation::srcPointFace(), and AMIInterpolation::tgtPointFace().

Here is the caller graph for this function:

eligibleMiss()

bool eligibleMiss ( ) const

inlinenoexcept

Definition at line 121 of file PointHit.H.

Referenced by Foam::operator<<(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::projectFaceCentres(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::projectPoints(), face::ray(), AMIInterpolation::srcPointFace(), and AMIInterpolation::tgtPointFace().

Here is the caller graph for this function:

point()

const point_type& point ( ) const

inlinenoexcept

Definition at line 127 of file PointHit.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

distance()

scalar distance ( ) const

inlinenoexcept

Definition at line 133 of file PointHit.H.

Referenced by booleanSurface::booleanSurface(), triSurfaceTools::calcInterpolationWeights(), mappedPatchBase::facePoint(), treeDataPrimitivePatch< PatchType >::findIntersection(), dynamicTreeDataPoint::findNearest(), meshSearch::findNearestBoundaryFace(), wallBoundedStreamLine::findNearestTet(), cellPointWeight::findTetrahedron(), cellPointWeight::findTriangle(), triangleFuncs::intersectBb(), face::intersection(), slidingInterface::modifyMotionPoints(), tetrahedron::nearestPoint(), face::nearestPointClassify(), findNearestMaskedOp< PatchType >::operator()(), treeDataPoint::findNearestOp::operator()(), treeDataPrimitivePatch< PatchType >::findNearestOp::operator()(), treeDataEdge::findNearestOp::operator()(), treeDataFace::findNearestOp::operator()(), treeDataCell::findIntersectOp::operator()(), treeDataFace::findIntersectOp::operator()(), Foam::operator<<(), orientedSurface::orient(), searchableRotatedBox::overlaps(), treeDataEdge::overlaps(), treeDataPrimitivePatch< PatchType >::overlaps(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::projectFaceCentres(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::projectPoints(), face::ray(), cellDistFuncs::smallestDist(), AMIInterpolation::srcPointFace(), and AMIInterpolation::tgtPointFace().

Here is the caller graph for this function:

hitPoint()

const point_type& hitPoint ( ) const

inline

Definition at line 139 of file PointHit.H.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Referenced by mappedPatchBase::facePoint(), treeDataPrimitivePatch< PatchType >::findIntersection(), sampledSet::findNearFace(), face::intersection(), slidingInterface::modifyMotionPoints(), face::nearestPointClassify(), treeDataCell::findIntersectOp::operator()(), treeDataFace::findIntersectOp::operator()(), and face::ray().

Here is the call graph for this function:

Here is the caller graph for this function:

missPoint()

const point_type& missPoint ( ) const

inline

Definition at line 152 of file PointHit.H.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Referenced by sampledSet::findNearFace(), slidingInterface::modifyMotionPoints(), face::nearestPointClassify(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::projectFaceCentres(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::projectPoints(), and face::ray().

Here is the call graph for this function:

Here is the caller graph for this function:

rawPoint()

const point_type& rawPoint ( ) const

inlinenoexcept

Definition at line 166 of file PointHit.H.

Referenced by extendedEdgeMesh::allNearestFeatureEdges(), booleanSurface::booleanSurface(), triSurfaceTools::calcInterpolationWeights(), tetrahedron::containmentSphere(), dynamicTreeDataPoint::findNearest(), wallBoundedStreamLine::findNearestTet(), treeDataFace::getVolumeType(), treeDataPrimitivePatch< PatchType >::getVolumeType(), tetrahedron::nearestPoint(), findNearestMaskedOp< PatchType >::operator()(), treeDataPoint::findNearestOp::operator()(), treeDataPrimitivePatch< PatchType >::findNearestOp::operator()(), treeDataEdge::findNearestOp::operator()(), treeDataFace::findNearestOp::operator()(), orientedSurface::orient(), triangle::ray(), faceCollapser::setRefinement(), AMIInterpolation::srcPointFace(), triSurfaceTools::surfaceSide(), and AMIInterpolation::tgtPointFace().

Here is the caller graph for this function:

setHit()

void setHit ( )

inlinenoexcept

Definition at line 175 of file PointHit.H.

Referenced by tetrahedron::containmentSphere(), face::intersection(), face::nearestPointClassify(), face::ray(), and triangle::ray().

Here is the caller graph for this function:

setMiss()

void setMiss ( const bool  eligible )

inlinenoexcept

Definition at line 182 of file PointHit.H.

Referenced by tetrahedron::containmentSphere(), face::nearestPointClassify(), face::ray(), and triangle::ray().

Here is the caller graph for this function:

setPoint()

void setPoint ( const point_type &  p )

inline

Definition at line 189 of file PointHit.H.

References p.

Referenced by tetrahedron::containmentSphere(), face::intersection(), face::nearestPointClassify(), face::ray(), triangle::ray(), and faceCollapser::setRefinement().

Here is the caller graph for this function:

setDistance()

void setDistance ( const scalar  d )

inlinenoexcept

Definition at line 195 of file PointHit.H.

Referenced by tetrahedron::containmentSphere(), face::intersection(), face::nearestPointClassify(), face::ray(), triangle::ray(), AMIInterpolation::srcPointFace(), and AMIInterpolation::tgtPointFace().

Here is the caller graph for this function:

operator<()

bool operator< ( const PointHit< AnyPointType > &  rhs ) const

inlinenoexcept

Definition at line 205 of file PointHit.H.

---

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

• src/OpenFOAM/meshes/primitiveShapes/objectHit/PointHit.H