Public Types | Public Member Functions | Friends | List of all members
PointIndexHit Class 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:
Inheritance graph
[legend]

Public Types

typedef PointType point_type
 

Public Member Functions

 PointIndexHit ()
 
 PointIndexHit (const point_type &p)
 
 PointIndexHit (const bool success, const point_type &p, const label index)
 
 PointIndexHit (Istream &is)
 
bool hit () const noexcept
 
label index () const noexcept
 
const point_type & point () const noexcept
 
point_type & point () noexcept
 
const point_type & hitPoint () const
 
const point_type & missPoint () const
 
const point_type & rawPoint () const noexcept
 
point_type & rawPoint () noexcept
 
void setHit () noexcept
 
void setMiss () noexcept
 
void setPoint (const point_type &p)
 
void setIndex (const label index) noexcept
 
void hitPoint (const point_type &p, const label index)
 
void write (Ostream &os)
 
bool operator== (const PointIndexHit &rhs) const
 
bool operator!= (const PointIndexHit &rhs) const
 

Friends

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

Detailed Description

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

Member Typedef Documentation

◆ point_type

typedef PointType point_type

Definition at line 80 of file PointIndexHit.H.

Constructor & Destructor Documentation

◆ PointIndexHit() [1/4]

PointIndexHit ( )
inline

Definition at line 86 of file PointIndexHit.H.

◆ PointIndexHit() [2/4]

PointIndexHit ( const point_type &  p)
inlineexplicit

Definition at line 94 of file PointIndexHit.H.

◆ PointIndexHit() [3/4]

PointIndexHit ( const bool  success,
const point_type &  p,
const label  index 
)
inline

Definition at line 103 of file PointIndexHit.H.

◆ PointIndexHit() [4/4]

PointIndexHit ( Istream &  is)
inlineexplicit

Definition at line 115 of file PointIndexHit.H.

Member Function Documentation

◆ hit()

bool hit ( ) const
inlinenoexcept

Definition at line 126 of file PointIndexHit.H.

Referenced by nearWallFields::calcAddressing(), Foam::calcProximityOfFeatureEdges(), Foam::calcProximityOfFeaturePoints(), nearestFaceAMI::calculate(), patchProbes::findElements(), mapNearestMethod::findInitialSeeds(), searchableCone::findLine(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findLine(), triSurfaceSearch::findLineAll(), searchableDisk::findLineAll(), searchableCylinder::findLineAll(), searchableRotatedBox::findLineAll(), searchableBox::findLineAll(), searchableCone::findLineAll(), searchableSphere::findLineAll(), triSurfaceRegionSearch::findNearest(), distributedTriSurfaceMesh::findNearest(), meshSearch::findNearestBoundaryFace(), refinementFeatures::findNearestEdge(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), boundaryMesh::getNearest(), meshSearch::intersection(), meshSearch::intersections(), edgeIntersections::merge(), surfaceFeatures::nearestEdges(), surfaceFeatures::nearestFeatEdge(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSurfEdge(), Foam::operator<<(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), triSurfaceTools::track(), and triSurfaceTools::trackToEdge().

Here is the caller graph for this function:

◆ index()

label index ( ) const
inlinenoexcept

Definition at line 132 of file PointIndexHit.H.

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

Here is the caller graph for this function:

◆ point() [1/2]

const point_type& point ( ) const
inlinenoexcept

Definition at line 138 of file PointIndexHit.H.

Referenced by Foam::normalDistance_nonzero(), Foam::normalDistance_zero(), and Foam::operator<<().

Here is the caller graph for this function:

◆ point() [2/2]

point_type& point ( )
inlinenoexcept

Definition at line 144 of file PointIndexHit.H.

◆ hitPoint() [1/2]

const point_type& hitPoint ( ) const
inline

Definition at line 150 of file PointIndexHit.H.

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

Referenced by nearWallFields::calcAddressing(), Foam::calcProximityOfFeatureEdges(), Foam::calcProximityOfFeaturePoints(), patchProbes::findElements(), searchableRotatedBox::findLineAll(), searchableBox::findLineAll(), triSurfaceRegionSearch::findNearest(), distributedTriSurfaceMesh::findNearest(), refinementFeatures::findNearestEdge(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), searchableExtrudedCircle::findParametricNearest(), boundaryMesh::getNearest(), searchableExtrudedCircle::getNormal(), surfaceFeatures::nearestEdges(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSurfEdge(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), and surfaceIntersection::surfaceIntersection().

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

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

Here is the call graph for this function:

◆ rawPoint() [1/2]

const point_type& rawPoint ( ) const
inlinenoexcept

Definition at line 174 of file PointIndexHit.H.

Referenced by searchableRotatedBox::findLine(), searchableBox::findLine(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findLine(), searchableRotatedBox::findNearest(), searchableBox::findNearestOnEdge(), edgeIntersections::merge(), surfaceFeatures::nearestSurfEdge(), and triSurfaceTools::trackToEdge().

Here is the caller graph for this function:

◆ rawPoint() [2/2]

point_type& rawPoint ( )
inlinenoexcept

Definition at line 180 of file PointIndexHit.H.

◆ setHit()

void setHit ( )
inlinenoexcept

Definition at line 189 of file PointIndexHit.H.

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

Here is the caller graph for this function:

◆ setMiss()

void setMiss ( )
inlinenoexcept

Definition at line 195 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_type &  p)
inline

Definition at line 201 of file PointIndexHit.H.

References p.

Referenced by triSurfaceTools::classify().

Here is the caller graph for this function:

◆ setIndex()

void setIndex ( const label  index)
inlinenoexcept

Definition at line 207 of file PointIndexHit.H.

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

◆ hitPoint() [2/2]

void hitPoint ( const point_type &  p,
const label  index 
)
inline

Definition at line 213 of file PointIndexHit.H.

References PointIndexHit::index(), and p.

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os)
inline

Definition at line 223 of file PointIndexHit.H.

References os().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const PointIndexHit &  rhs) const
inline

Definition at line 233 of file PointIndexHit.H.

◆ operator!=()

bool operator!= ( const PointIndexHit &  rhs) const
inline

Definition at line 244 of file PointIndexHit.H.

Friends And Related Function Documentation

◆ operator<<

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

Definition at line 252 of file PointIndexHit.H.

◆ operator>>

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

Definition at line 274 of file PointIndexHit.H.

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