FreeFOAM The Cross-Platform CFD Toolkit
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...

#include <meshTools/PointIndexHit_.H>


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 54 of file PointIndexHit_.H.

+ Inheritance diagram for PointIndexHit< Point >:

List of all members.

Public Member Functions

 PointIndexHit (const bool success, const Point &p, const label index)
 Construct from components.
 PointIndexHit (const Point &p)
 Construct from point. Hit and distance set later.
 PointIndexHit ()
 Construct null.
 PointIndexHit (Istream &is)
 Construct from Istream.
bool hit () const
 Is there a hit.
label index () const
 Return index.
const Point & hitPoint () const
 Return hit point.
const Point & missPoint () const
 Return miss point.
const Point & rawPoint () const
 Return point with no checking.
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)

Constructor & Destructor Documentation

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

Construct from components.

Definition at line 73 of file PointIndexHit_.H.

PointIndexHit ( const Point &  p)
inline

Construct from point. Hit and distance set later.

Definition at line 81 of file PointIndexHit_.H.

PointIndexHit ( )
inline

Construct null.

Definition at line 89 of file PointIndexHit_.H.

PointIndexHit ( Istream is)
inline

Construct from Istream.

Definition at line 97 of file PointIndexHit_.H.


Member Function Documentation

const Point& missPoint ( ) const
inline

Return miss point.

Definition at line 131 of file PointIndexHit_.H.

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

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

const Point& rawPoint ( ) const
inline
Point& rawPoint ( )
inline

Definition at line 149 of file PointIndexHit_.H.

void setMiss ( )
inline
void setPoint ( const Point &  p)
inline

Definition at line 164 of file PointIndexHit_.H.

References p.

Referenced by triSurfaceTools::classify(), octree< Type >::findLine(), and octree< Type >::findLineAny().

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

Definition at line 182 of file PointIndexHit_.H.

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


Friends And Related Function Documentation

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

Definition at line 199 of file PointIndexHit_.H.

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: