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

Inheritance diagram for PointIndexHit< Point >:

[legend]

Public Member Functions
	PointIndexHit (const bool success, const Point &p, const label index)
	Construct from components. More...

	PointIndexHit (const Point &p)
	Construct from point. Hit and distance set later. More...

	PointIndexHit ()
	Construct null. More...

	PointIndexHit (Istream &is)
	Construct from Istream. More...

bool	hit () const
	Is there a hit. More...

label	index () const
	Return index. More...

const Point &	hitPoint () const
	Return hit point. More...

const Point &	missPoint () const
	Return miss point. More...

const Point &	rawPoint () const
	Return point with no checking. More...

Point &	rawPoint ()

void	setHit ()

void	setMiss ()

void	setPoint (const Point &p)

void	setIndex (const label index)

bool	operator== (const PointIndexHit &rhs) const

bool	operator!= (const PointIndexHit &rhs) const

void	write (Ostream &os)

Friends
Ostream &	operator<< (Ostream &os, const PointIndexHit &pHit)

Istream &	operator>> (Istream &is, PointIndexHit &pHit)

Detailed Description

template<class Point>
class Foam::PointIndexHit< Point >

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

Source files

PointIndexHit.H

Definition at line 55 of file PointIndexHit.H.

Constructor & Destructor Documentation

◆ PointIndexHit() [1/4]

PointIndexHit	(	const bool	success,
		const Point &	p,
		const label	index
	)

inline

Construct from components.

Definition at line 74 of file PointIndexHit.H.

◆ PointIndexHit() [2/4]

PointIndexHit ( const Point & p )

inline

Construct from point. Hit and distance set later.

Definition at line 82 of file PointIndexHit.H.

◆ PointIndexHit() [3/4]

PointIndexHit ( )

inline

Construct null.

Definition at line 90 of file PointIndexHit.H.

◆ PointIndexHit() [4/4]

PointIndexHit ( Istream & is )

inline

Construct from Istream.

Definition at line 98 of file PointIndexHit.H.

Member Function Documentation

◆ hit()

bool hit ( ) const

inline

Is there a hit.

Definition at line 107 of file PointIndexHit.H.

Referenced by nearWallFields::calcAddressing(), Foam::calcProximityOfFeatureEdges(), Foam::calcProximityOfFeaturePoints(), patchProbes::findElements(), mapNearestMethod::findInitialSeeds(), searchableCone::findLine(), indexedOctree< Foam::treeDataFace >::findLine(), triSurfaceSearch::findLineAll(), searchableSphere::findLineAll(), searchableDisk::findLineAll(), searchableCylinder::findLineAll(), searchableBox::findLineAll(), searchableRotatedBox::findLineAll(), searchableCone::findLineAll(), triSurfaceRegionSearch::findNearest(), distributedTriSurfaceMesh::findNearest(), meshSearch::findNearestBoundaryFace(), refinementFeatures::findNearestEdge(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), AMIMethod< SourcePatch, TargetPatch >::findTargetFace(), boundaryMesh::getNearest(), meshSearch::intersection(), meshSearch::intersections(), edgeIntersections::merge(), surfaceFeatures::nearestFeatEdge(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSurfEdge(), Foam::operator<<(), PointIndexHit< Point >::operator==(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), triSurfaceTools::track(), triSurfaceTools::trackToEdge(), and PointIndexHit< Point >::write().

Here is the caller graph for this function:

◆ index()

label index ( ) const

inline

Return index.

Definition at line 113 of file PointIndexHit.H.

Referenced by nearWallFields::calcAddressing(), Foam::calcProximityOfFeatureEdges(), patchProbes::findElements(), mapNearestMethod::findInitialSeeds(), searchableBox::findLine(), triSurfaceSearch::findLineAll(), searchableBox::findLineAll(), searchableRotatedBox::findLineAll(), distributedTriSurfaceMesh::findNearest(), meshSearch::findNearestBoundaryFace(), refinementFeatures::findNearestEdge(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), searchableExtrudedCircle::findParametricNearest(), AMIMethod< SourcePatch, TargetPatch >::findTargetFace(), boundaryMesh::getNearest(), searchableExtrudedCircle::getNormal(), treeDataFace::getVolumeType(), treeDataPrimitivePatch< PatchType >::getVolumeType(), meshSearch::intersection(), meshSearch::intersections(), edgeIntersections::merge(), surfaceFeatures::nearestFeatEdge(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSurfEdge(), surfaceLocation::normal(), Foam::operator<<(), PointIndexHit< Point >::operator==(), PointIndexHit< Point >::setIndex(), surfaceIntersection::surfaceIntersection(), and PointIndexHit< Point >::write().

Here is the caller graph for this function:

◆ hitPoint()

const Point& hitPoint ( ) const

inline

Return hit point.

Definition at line 119 of file PointIndexHit.H.

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

Referenced by nearWallFields::calcAddressing(), Foam::calcProximityOfFeatureEdges(), Foam::calcProximityOfFeaturePoints(), patchProbes::findElements(), searchableBox::findLineAll(), searchableRotatedBox::findLineAll(), triSurfaceRegionSearch::findNearest(), distributedTriSurfaceMesh::findNearest(), refinementFeatures::findNearestEdge(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), searchableExtrudedCircle::findParametricNearest(), AMIMethod< SourcePatch, TargetPatch >::findTargetFace(), boundaryMesh::getNearest(), searchableExtrudedCircle::getNormal(), surfaceFeatures::nearestSurfEdge(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), surfaceIntersection::surfaceIntersection(), and PointIndexHit< Point >::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ missPoint()

const Point& missPoint ( ) const

inline

Return miss point.

Definition at line 132 of file PointIndexHit.H.

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

Referenced by PointIndexHit< Point >::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rawPoint() [1/2]

const Point& rawPoint ( ) const

inline

Return point with no checking.

Definition at line 145 of file PointIndexHit.H.

Referenced by searchableBox::findLine(), searchableRotatedBox::findLine(), indexedOctree< Foam::treeDataFace >::findLine(), searchableRotatedBox::findNearest(), searchableBox::findNearestOnEdge(), edgeIntersections::merge(), surfaceFeatures::nearestSurfEdge(), Foam::operator<<(), and PointIndexHit< Point >::operator==().

Here is the caller graph for this function:

◆ rawPoint() [2/2]

Point& rawPoint ( )

inline

Definition at line 150 of file PointIndexHit.H.

◆ setHit()

void setHit ( )

inline

Definition at line 155 of file PointIndexHit.H.

Referenced by triSurfaceTools::classify(), and searchableBox::findLine().

Here is the caller graph for this function:

◆ setMiss()

void setMiss ( )

inline

Definition at line 160 of file PointIndexHit.H.

Referenced by triSurfaceTools::classify(), searchableBox::findNearestOnEdge(), and triSurfaceTools::trackToEdge().

Here is the caller graph for this function:

◆ setPoint()

void setPoint ( const Point & p )

inline

Definition at line 165 of file PointIndexHit.H.

References p.

Referenced by triSurfaceTools::classify().

Here is the caller graph for this function:

◆ setIndex()

void setIndex ( const label index )

inline

Definition at line 170 of file PointIndexHit.H.

References PointIndexHit< Point >::index().

Referenced by triSurfaceTools::classify(), searchableBox::findLine(), searchableBox::findNearestOnEdge(), meshSearch::intersection(), and meshSearch::intersections().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator==()

bool operator== ( const PointIndexHit< Point > & rhs ) const

inline

Definition at line 175 of file PointIndexHit.H.

References PointIndexHit< Point >::hit(), PointIndexHit< Point >::index(), and PointIndexHit< Point >::rawPoint().

Referenced by PointIndexHit< Point >::operator!=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator!=()

bool operator!= ( const PointIndexHit< Point > & rhs ) const

inline

Definition at line 183 of file PointIndexHit.H.

References PointIndexHit< Point >::operator==().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os )

inline

Definition at line 188 of file PointIndexHit.H.

References PointIndexHit< Point >::hit(), PointIndexHit< Point >::hitPoint(), PointIndexHit< Point >::index(), and PointIndexHit< Point >::missPoint().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<<	(	Ostream &	os,
		const PointIndexHit< Point > &	pHit
	)

friend

Definition at line 200 of file PointIndexHit.H.

◆ operator>>

Istream& operator>>	(	Istream &	is,
		PointIndexHit< Point > &	pHit
	)

friend

Definition at line 221 of file PointIndexHit.H.

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

src/OpenFOAM/meshes/primitiveShapes/objectHit/PointIndexHit.H

Public Member Functions

Friends

Detailed Description

template<class Point> class Foam::PointIndexHit< Point >

Constructor & Destructor Documentation

◆ PointIndexHit() [1/4]

◆ PointIndexHit() [2/4]

◆ PointIndexHit() [3/4]

◆ PointIndexHit() [4/4]

Member Function Documentation

◆ hit()

◆ index()

◆ hitPoint()

◆ missPoint()

◆ rawPoint() [1/2]

◆ rawPoint() [2/2]

◆ setHit()

◆ setMiss()

◆ setPoint()

◆ setIndex()

◆ operator==()

◆ operator!=()

◆ write()

Friends And Related Function Documentation

◆ operator<<

◆ operator>>

template<class Point>
class Foam::PointIndexHit< Point >