Public Member Functions | Private Attributes | Friends
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)
 

Private Attributes

bool hit_
 Hit success. More...
 
Point hitPoint_
 Point of hit; invalid for misses. More...
 
label index_
 Label of face hit. More...
 

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

Definition at line 53 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 72 of file PointIndexHit.H.

◆ PointIndexHit() [2/4]

PointIndexHit ( const Point &  p)
inline

Construct from point. Hit and distance set later.

Definition at line 80 of file PointIndexHit.H.

◆ PointIndexHit() [3/4]

PointIndexHit ( )
inline

Construct null.

Definition at line 88 of file PointIndexHit.H.

◆ PointIndexHit() [4/4]

PointIndexHit ( Istream &  is)
inline

Construct from Istream.

Definition at line 96 of file PointIndexHit.H.

Member Function Documentation

◆ hit()

bool hit ( ) const
inline

Is there a hit.

Definition at line 105 of file PointIndexHit.H.

References PointIndexHit< Point >::hit_.

Referenced by immersedBoundaryFvPatch::addIbCornerCells(), nearWallFields::calcAddressing(), surfaceSlipDisplacementPointPatchVectorField::calcProjection(), surfaceDisplacementPointPatchVectorField::calcProjection(), calcProximityOfFeatureEdges(), calcProximityOfFeaturePoints(), patchSeedSet::calcSamples(), isoSurfaceCell::calcSnappedCc(), surfaceToPoint::combine(), surfaceToCell::combine(), autoSnapDriver::determineFeatures(), surfaceIntersection::doCutEdges(), searchableSurfacesQueries::facesIntersection(), polyMesh::findCellFacePt(), patchProbes::findElements(), mapNearestMethod::findInitialSeeds(), searchablePlate::findLine(), distributedTriSurfaceMesh::findLine(), searchableCone::findLine(), indexedOctree< Foam::treeDataFace >::findLine(), triSurfaceSearch::findLineAll(), searchableSphere::findLineAll(), searchableDisk::findLineAll(), searchableCylinder::findLineAll(), searchableRotatedBox::findLineAll(), searchableBox::findLineAll(), searchableCone::findLineAll(), triSurfaceRegionSearch::findNearest(), meshSearch::findNearestBoundaryFace(), meshSearch::findNearestCellTree(), refinementFeatures::findNearestEdge(), meshSearch::findNearestFaceTree(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), AMIMethod< SourcePatch, TargetPatch >::findTargetFace(), boundaryMesh::getNearest(), treeDataTriSurface::getVolumeType(), edgeIntersections::intersectEdges(), meshSearch::intersection(), meshSearch::intersections(), immersedBoundaryFvPatch::makeIbPointsAndNormals(), cellClassification::markFaces(), edgeIntersections::merge(), surfaceFeatures::nearestEdges(), surfaceFeatures::nearestFeatEdge(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSurfEdge(), PointIndexHit< Point >::operator==(), autoSnapDriver::releasePointsNextToMultiPatch(), triSurfaceTools::track(), triSurfaceTools::trackToEdge(), indexedOctree< Foam::treeDataFace >::traverseNode(), dynamicIndexedOctree::traverseNode(), triSurfaceTools::visitFaces(), and PointIndexHit< Point >::write().

◆ index()

label index ( ) const
inline

Return index.

Definition at line 111 of file PointIndexHit.H.

References PointIndexHit< Point >::index_.

Referenced by immersedBoundaryFvPatch::addIbCornerCells(), calcProximityOfFeatureEdges(), triSurfaceSearch::checkUniqueHit(), surfaceIntersection::classifyHit(), surfaceToCell::combine(), searchableSurfaces::connected(), autoSnapDriver::determineFeatures(), surfaceIntersection::doCutEdges(), polyMesh::findCellFacePt(), patchProbes::findElements(), mapNearestMethod::findInitialSeeds(), searchableBox::findLine(), triSurfaceSearch::findLineAll(), searchableRotatedBox::findLineAll(), searchableBox::findLineAll(), meshSearch::findNearestBoundaryFace(), meshSearch::findNearestCellTree(), refinementFeatures::findNearestEdge(), meshSearch::findNearestFaceTree(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), AMIMethod< SourcePatch, TargetPatch >::findTargetFace(), surfaceToCell::getNearest(), boundaryMesh::getNearest(), treeDataPrimitivePatch< PatchType >::getVolumeType(), treeDataTriSurface::getVolumeType(), treeDataFace::getVolumeType(), edgeIntersections::intersectEdges(), meshSearch::intersection(), meshSearch::intersections(), immersedBoundaryFvPatch::makeIbPointsAndNormals(), cellClassification::markFaces(), edgeIntersections::merge(), surfaceFeatures::nearestEdges(), surfaceFeatures::nearestFeatEdge(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSurfEdge(), surfaceLocation::normal(), edgeIntersections::offsetPerturb(), PointIndexHit< Point >::operator==(), PointIndexHit< Point >::setIndex(), triSurfaceTools::snapToEnd(), surfaceIntersection::surfaceIntersection(), triSurfaceTools::trackToEdge(), triSurfaceTools::visitFaces(), and PointIndexHit< Point >::write().

Here is the caller graph for this function:

◆ hitPoint()

const Point& hitPoint ( ) const
inline

Return hit point.

Definition at line 117 of file PointIndexHit.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, PointIndexHit< Point >::hit_, and PointIndexHit< Point >::hitPoint_.

Referenced by immersedBoundaryFvPatch::addIbCornerCells(), nearWallFields::calcAddressing(), calcProximityOfFeatureEdges(), calcProximityOfFeaturePoints(), patchSeedSet::calcSamples(), isoSurfaceCell::calcSnappedCc(), triSurfaceSearch::checkUniqueHit(), surfaceIntersection::classifyHit(), surfaceToPoint::combine(), surfaceToCell::combine(), autoSnapDriver::determineFeatures(), surfaceIntersection::doCutEdges(), searchableSurfacesQueries::facesIntersection(), patchProbes::findElements(), searchablePlate::findLine(), distributedTriSurfaceMesh::findLine(), searchableRotatedBox::findLineAll(), searchableBox::findLineAll(), triSurfaceRegionSearch::findNearest(), refinementFeatures::findNearestEdge(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), AMIMethod< SourcePatch, TargetPatch >::findTargetFace(), boundaryMesh::getNearest(), treeDataTriSurface::getVolumeType(), searchableCone::insertHit(), edgeIntersections::intersectEdges(), meshSearch::intersections(), immersedBoundaryFvPatch::makeIbPointsAndNormals(), cellClassification::markFaces(), surfaceFeatures::nearestEdges(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSurfEdge(), edgeIntersections::offsetPerturb(), searchableSurfacesQueries::sumDistSqr(), 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 130 of file PointIndexHit.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, PointIndexHit< Point >::hit_, and PointIndexHit< Point >::hitPoint_.

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

References PointIndexHit< Point >::hitPoint_.

Referenced by surfaceSlipDisplacementPointPatchVectorField::calcProjection(), surfaceDisplacementPointPatchVectorField::calcProjection(), patchSeedSet::calcSamples(), searchablePlate::findLine(), searchableRotatedBox::findLine(), searchableBox::findLine(), indexedOctree< Foam::treeDataFace >::findLine(), searchableSphere::findNearest(), searchableDisk::findNearest(), searchableBox::findNearest(), searchableCylinder::findNearest(), searchablePlate::findNearest(), searchableRotatedBox::findNearest(), searchableCone::findNearestAndNormal(), searchableBox::findNearestOnEdge(), edgeIntersections::merge(), surfaceFeatures::nearestSurfEdge(), PointIndexHit< Point >::operator==(), searchableBox::projectOntoCoordPlane(), triSurfaceTools::trackToEdge(), and triSurfaceTools::visitFaces().

Here is the caller graph for this function:

◆ rawPoint() [2/2]

Point& rawPoint ( )
inline

Definition at line 148 of file PointIndexHit.H.

References PointIndexHit< Point >::hitPoint_.

◆ setHit()

void setHit ( )
inline

Definition at line 153 of file PointIndexHit.H.

References PointIndexHit< Point >::hit_.

Referenced by triSurfaceTools::classify(), isoSurfaceCell::collapseSurface(), searchableDisk::findLine(), searchableBox::findLine(), searchableSphere::findLineAll(), searchableCylinder::findLineAll(), searchableCone::findLineAll(), searchableSphere::findNearest(), searchableDisk::findNearest(), searchableCylinder::findNearest(), searchableCone::findNearestAndNormal(), triSurfaceTools::snapToEnd(), indexedOctree< Foam::treeDataFace >::traverseNode(), dynamicIndexedOctree::traverseNode(), and triSurfaceTools::visitFaces().

Here is the caller graph for this function:

◆ setMiss()

void setMiss ( )
inline

Definition at line 158 of file PointIndexHit.H.

References PointIndexHit< Point >::hit_.

Referenced by triSurfaceTools::classify(), searchablePlane::findLine(), searchablePlate::findLine(), searchableSphere::findLineAll(), searchableCylinder::findLineAll(), searchableCone::findLineAll(), searchableBox::findNearest(), searchablePlate::findNearest(), searchableBox::findNearestOnEdge(), triSurfaceTools::trackToEdge(), and triSurfaceTools::visitFaces().

Here is the caller graph for this function:

◆ setPoint()

void setPoint ( const Point &  p)
inline

Definition at line 163 of file PointIndexHit.H.

References PointIndexHit< Point >::hitPoint_, and p.

Referenced by triSurfaceTools::classify(), isoSurfaceCell::collapseSurface(), searchablePlane::findLine(), searchableDisk::findLine(), searchableSphere::findLineAll(), searchableCylinder::findLineAll(), searchableCone::findLineAll(), searchableDisk::findNearest(), searchableCylinder::findNearest(), searchableCone::findNearestAndNormal(), indexedOctree< Foam::treeDataFace >::traverseNode(), and dynamicIndexedOctree::traverseNode().

Here is the caller graph for this function:

◆ setIndex()

void setIndex ( const label  index)
inline

Definition at line 168 of file PointIndexHit.H.

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

Referenced by triSurfaceTools::classify(), searchablePlane::findLine(), searchableDisk::findLine(), searchablePlate::findLine(), searchableBox::findLine(), searchableSphere::findLineAll(), searchableCylinder::findLineAll(), searchableCone::findLineAll(), searchableSphere::findNearest(), searchableBox::findNearest(), searchableDisk::findNearest(), searchableCylinder::findNearest(), searchablePlate::findNearest(), searchableCone::findNearestAndNormal(), searchableBox::findNearestOnEdge(), meshSearch::intersection(), searchableBox::projectOntoCoordPlane(), indexedOctree< Foam::treeDataFace >::traverseNode(), and dynamicIndexedOctree::traverseNode().

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

References PointIndexHit< Point >::hit(), PointIndexHit< Point >::hit_, PointIndexHit< Point >::hitPoint_, PointIndexHit< Point >::index(), 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 181 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 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

◆ operator<<

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

Definition at line 198 of file PointIndexHit.H.

◆ operator>>

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

Definition at line 220 of file PointIndexHit.H.

Field Documentation

◆ hit_

bool hit_
private

Hit success.

Definition at line 58 of file PointIndexHit.H.

Referenced by PointIndexHit< Point >::hit(), PointIndexHit< Point >::hitPoint(), PointIndexHit< Point >::missPoint(), PointIndexHit< Point >::operator==(), PointIndexHit< Point >::setHit(), and PointIndexHit< Point >::setMiss().

◆ hitPoint_

Point hitPoint_
private

Point of hit; invalid for misses.

Definition at line 61 of file PointIndexHit.H.

Referenced by PointIndexHit< Point >::hitPoint(), PointIndexHit< Point >::missPoint(), PointIndexHit< Point >::operator==(), PointIndexHit< Point >::rawPoint(), and PointIndexHit< Point >::setPoint().

◆ index_

label index_
private

Label of face hit.

Definition at line 64 of file PointIndexHit.H.

Referenced by PointIndexHit< Point >::index(), PointIndexHit< Point >::operator==(), and PointIndexHit< Point >::setIndex().

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