OpenFOAM logo
Open Source CFD Toolkit

octreeDataPoint Class Reference

Collaboration diagram for octreeDataPoint:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 octreeDataPoint (const pointField &points)
 Construct from components. Holds reference to points!
const pointFieldpoints () const
label size () const
label getSampleType (const octree< octreeDataPoint > &, const point &) const
 Get type of sample.
bool overlaps (const label index, const treeBoundBox &sampleBb) const
 Does (bb of) shape at index overlap bb.
bool contains (const label index, const point &sample) const
 Does shape at index contain sample.
bool intersects (const label index, const point &start, const point &end, point &intersectionPoint) const
 Segment (from start to end) intersection with shape.
bool findTightest (const label index, const point &sample, treeBoundBox &tightest) const
 Sets newTightest to bounding box (and returns true) if.
scalar calcSign (const label index, const point &sample, vector &n) const
 Given index get unit normal and calculate (numerical) sign.
scalar calcNearest (const label index, const point &sample, point &nearest) const
 Calculates nearest (to sample) point on/in shape.
scalar calcNearest (const label index, const linePointRef &ln, point &linePt, point &shapePt) const
 Calculates nearest (to line segment) point in shape.
void write (Ostream &os, const label index) const
 Write shape at index.

Friends

Ostreamoperator<< (Ostream &, const octreeDataPoint &)

Constructor & Destructor Documentation

octreeDataPoint const pointField points  ) 
 

Construct from components. Holds reference to points!


Member Function Documentation

scalar calcNearest const label  index,
const linePointRef ln,
point linePt,
point shapePt
const
 

Calculates nearest (to line segment) point in shape.

Returns distance and both point.

scalar calcNearest const label  index,
const point sample,
point nearest
const
 

Calculates nearest (to sample) point on/in shape.

Returns point and mag(nearest - sample)

scalar calcSign const label  index,
const point sample,
vector n
const
 

Given index get unit normal and calculate (numerical) sign.

of sample. Used to determine accuracy of calcNearest or inside/outside. Note: always returns GREAT since no inside/outside.

bool contains const label  index,
const point sample
const
 

Does shape at index contain sample.

bool findTightest const label  index,
const point sample,
treeBoundBox tightest
const
 

Sets newTightest to bounding box (and returns true) if.

nearer to sample than tightest bounding box. Otherwise returns false.

label getSampleType const octree< octreeDataPoint > &  ,
const point
const
 

Get type of sample.

bool intersects const label  index,
const point start,
const point end,
point intersectionPoint
const
 

Segment (from start to end) intersection with shape.

at index. If intersects returns true and sets intersectionPoint

bool overlaps const label  index,
const treeBoundBox sampleBb
const
 

Does (bb of) shape at index overlap bb.

const pointField& points  )  const [inline]
 

Definition at line 85 of file octreeDataPoint.H.

label size  )  const [inline]
 

Definition at line 90 of file octreeDataPoint.H.

References Foam::label, Foam::linePointRef, Foam::point, and Foam::vector.

void write Ostream os,
const label  index
const
 

Write shape at index.


Friends And Related Function Documentation

Ostream& operator<< Ostream ,
const octreeDataPoint
[friend]
 


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org