FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

PointHit< Point > Class Template Reference

This class describes the interaction of a face and a point. It carries the info of a successful hit and (if successful), returns the interaction point. More...

#include <OpenFOAM/PointHit_.H>


Detailed Description

template<class Point>
class Foam::PointHit< Point >

This class describes the interaction of a face and a point. It carries the info of a successful hit and (if successful), returns the interaction point.

Definition at line 63 of file PointHit_.H.

Inheritance diagram for PointHit< Point >:
Collaboration diagram for PointHit< Point >:

List of all members.

Public Member Functions

 PointHit (const bool hit, const Point &p, const scalar dist, const bool eligibleMiss)
 Construct from components.
 PointHit (const Point &p)
 Construct from point. Hit and distance set later.
bool  hit () const
 Is there a hit.
const Point &  hitPoint () const
 Return hit point.
scalar  distance () const
 Return distance to hit.
const Point &  missPoint () const
 Return miss point.
const Point &  rawPoint () const
 Return point with no checking.
bool  eligibleMiss () const
 Is this an eligible miss.
void  setHit ()
void  setMiss (const bool eligible)
void  setPoint (const Point &p)
void  setDistance (const scalar d)

Friends

Ostream &  operator (Ostream &os, const PointHit< Point > &b)

Constructor & Destructor Documentation

PointHit ( const bool   hit,
const Point &   p,
const scalar   dist,
const bool   eligibleMiss  
) [inline]

Construct from components.

Definition at line 86 of file PointHit_.H.

PointHit ( const Point &   p  ) [inline]

Construct from point. Hit and distance set later.

Definition at line 100 of file PointHit_.H.


Member Function Documentation

bool eligibleMiss (  ) const [inline]
void setMiss ( const bool   eligible  ) [inline]

Friends And Related Function Documentation

Ostream& operator ( Ostream &   os,
const PointHit< Point > &   b  
) [friend]

The documentation for this class was generated from the following file:
  • src/OpenFOAM/meshes/primitiveShapes/objectHit/PointHit_.H