Public Member Functions | Friends | List of all members
PointIndexHit< Point > Class Template Reference

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

Ostreamoperator<< (Ostream &os, const PointIndexHit &pHit)
 
Istreamoperator>> (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

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()(), PointIndexHit< Point >::operator==(), triSurfaceTools::track(), triSurfaceTools::trackToEdge(), AMIInterpolation< SourcePatch, TargetPatch >::wordTointerpolationMethod(), surfaceLocation::write(), and PointIndexHit< Point >::write().

Here is the caller graph for this function:

label index ( ) const
inline
const Point& hitPoint ( ) const
inline
const Point& missPoint ( ) const
inline

Return miss point.

Definition at line 130 of file PointIndexHit.H.

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

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
Point& rawPoint ( )
inline

Definition at line 148 of file PointIndexHit.H.

void setHit ( )
inline
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
void setIndex ( const label  index)
inline
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

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: