PointIndexHit< Point > Class Template Reference | OpenFOAM Source Code Guide

The OpenFOAM Foundation

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

Inheritance graph

[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 53 of file PointIndexHit.H.

Constructor & Destructor Documentation

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

inline

Construct from components.

Definition at line 72 of file PointIndexHit.H.

PointIndexHit ( const Point & p )

inline

Construct from point. Hit and distance set later.

Definition at line 80 of file PointIndexHit.H.

PointIndexHit ( )

inline

Construct null.

Definition at line 88 of file PointIndexHit.H.

PointIndexHit ( Istream & is )

inline

Construct from Istream.

Definition at line 96 of file PointIndexHit.H.

Member Function Documentation

bool hit ( ) const

inline

Is there a hit.

Definition at line 105 of file PointIndexHit.H.

Referenced by nearWallFields::calcAddressing(), searchableSurfacesQueries::facesIntersection(), polyMesh::findCellFacePt(), patchProbes::findElements(), mapNearestMethod::findInitialSeeds(), searchableSphere::findLine(), searchableCylinder::findLine(), indexedOctree< Type >::findLine(), triSurfaceSearch::findLineAll(), searchableSphere::findLineAll(), searchableDisk::findLineAll(), searchableCylinder::findLineAll(), searchableBox::findLineAll(), searchableSphere::findLineAny(), searchableCylinder::findLineAny(), triSurfaceRegionSearch::findNearest(), dynamicIndexedOctree< Type >::findNearest(), indexedOctree< Type >::findNearest(), meshSearch::findNearestBoundaryFace(), refinementFeatures::findNearestEdge(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), mappedPatchBase::findSamples(), AMIMethod< SourcePatch, TargetPatch >::findTargetFace(), boundaryMesh::getNearest(), meshSearch::intersection(), meshSearch::intersections(), edgeIntersections::merge(), NamedEnum< Enum, nEnum >::names(), surfaceFeatures::nearestFeatEdge(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSurfEdge(), listPlusEqOp< T >::operator()(), nearestEqOp::operator()(), Foam::operator<<(), PointIndexHit< Point >::operator==(), triSurfaceTools::track(), triSurfaceTools::trackToEdge(), AMIInterpolation< SourcePatch, TargetPatch >::wordTointerpolationMethod(), and PointIndexHit< Point >::write().

Here is the caller graph for this function:

label index ( ) const

inline

Return index.

Definition at line 111 of file PointIndexHit.H.

Referenced by polyMesh::findCellFacePt(), patchProbes::findElements(), mapNearestMethod::findInitialSeeds(), searchableBox::findLine(), triSurfaceSearch::findLineAll(), searchableBox::findLineAll(), meshSearch::findNearestBoundaryFace(), refinementFeatures::findNearestEdge(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), mappedPatchBase::findSamples(), AMIMethod< SourcePatch, TargetPatch >::findTargetFace(), boundaryMesh::getNearest(), treeDataFace::getVolumeType(), treeDataPrimitivePatch< PatchType >::getVolumeType(), meshSearch::intersection(), meshSearch::intersections(), edgeIntersections::merge(), surfaceFeatures::nearestFeatEdge(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSurfEdge(), surfaceLocation::normal(), listPlusEqOp< T >::operator()(), nearestEqOp::operator()(), Foam::operator<<(), PointIndexHit< Point >::operator==(), PointIndexHit< Point >::setIndex(), surfaceIntersection::surfaceIntersection(), triSurfaceTools::trackToEdge(), surfaceLocation::write(), and PointIndexHit< Point >::write().

Here is the caller graph for this function:

const Point& hitPoint ( ) const

inline

Return hit point.

Definition at line 117 of file PointIndexHit.H.

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

Referenced by nearWallFields::calcAddressing(), searchableSurfacesQueries::facesIntersection(), searchableBox::findLineAll(), triSurfaceRegionSearch::findNearest(), refinementFeatures::findNearestEdge(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), mappedPatchBase::findSamples(), AMIMethod< SourcePatch, TargetPatch >::findTargetFace(), boundaryMesh::getNearest(), meshSearch::intersections(), NamedEnum< Enum, nEnum >::names(), surfaceFeatures::nearestSurfEdge(), listPlusEqOp< T >::operator()(), nearestEqOp::operator()(), surfaceIntersection::surfaceIntersection(), AMIInterpolation< SourcePatch, TargetPatch >::wordTointerpolationMethod(), and PointIndexHit< Point >::write().

Here is the call graph for this function:

Here is the caller graph for this function:

const Point& missPoint ( ) const

inline

Return miss point.

Definition at line 130 of file PointIndexHit.H.

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

Referenced by listPlusEqOp< T >::operator()(), and PointIndexHit< Point >::write().

Here is the call graph for this function:

Here is the caller graph for this function:

const Point& rawPoint ( ) const

inline

Return point with no checking.

Definition at line 143 of file PointIndexHit.H.

Referenced by searchableBox::findLine(), indexedOctree< Type >::findLine(), dynamicIndexedOctree< Type >::findNearest(), searchableBox::findNearestOnEdge(), edgeIntersections::merge(), NamedEnum< Enum, nEnum >::names(), surfaceFeatures::nearestSurfEdge(), Foam::operator<<(), PointIndexHit< Point >::operator==(), searchableCylinder::points(), and triSurfaceTools::trackToEdge().

Here is the caller graph for this function:

Point& rawPoint ( )

inline

Definition at line 148 of file PointIndexHit.H.

void setHit ( )

inline

Definition at line 153 of file PointIndexHit.H.

Referenced by triSurfaceTools::classify(), searchableBox::findLine(), dynamicIndexedOctree< Type >::findNearest(), indexedOctree< Type >::findNearest(), and searchableCylinder::points().

Here is the caller graph for this function:

void setMiss ( )

inline

Definition at line 158 of file PointIndexHit.H.

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

Here is the caller graph for this function:

void setPoint ( const Point & p )

inline

Definition at line 163 of file PointIndexHit.H.

References p.

Referenced by triSurfaceTools::classify(), dynamicIndexedOctree< Type >::findNearest(), indexedOctree< Type >::findNearest(), mappedPatchBase::findSamples(), and searchableCylinder::points().

Here is the caller graph for this function:

void setIndex ( const label index )

inline

Definition at line 168 of file PointIndexHit.H.

References PointIndexHit< Point >::index().

Referenced by triSurfaceTools::classify(), searchableBox::findLine(), dynamicIndexedOctree< Type >::findNearest(), indexedOctree< Type >::findNearest(), searchableBox::findNearestOnEdge(), meshSearch::intersection(), NamedEnum< Enum, nEnum >::names(), and searchableCylinder::points().

Here is the call graph for this function:

Here is the caller graph for this function:

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

inline

Definition at line 173 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:

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

inline

Definition at line 181 of file PointIndexHit.H.

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

Here is the call graph for this function:

void write ( Ostream & os )

inline

Definition at line 186 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

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

friend

Definition at line 198 of file PointIndexHit.H.

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

friend

Definition at line 220 of file PointIndexHit.H.

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

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