FreeFOAM The Cross-Platform CFD Toolkit
treeDataPrimitivePatch< Face, FaceList, PointField, PointType > Class Template Reference

Encapsulation of data needed to search on PrimitivePatches. More...


Detailed Description

template<class Face, template< class > class FaceList, class PointField, class PointType = point>
class Foam::treeDataPrimitivePatch< Face, FaceList, PointField, PointType >

Encapsulation of data needed to search on PrimitivePatches.

Source files

Definition at line 69 of file treeDataPrimitivePatch.H.

List of all members.

Public Member Functions

 treeDataPrimitivePatch (const bool cacheBb, const PrimitivePatch< Face, FaceList, PointField, PointType > &)
 Construct from patch.
label size () const
pointField points () const
 Get representative point cloud for all shapes inside.
label getVolumeType (const indexedOctree< treeDataPrimitivePatch< Face, FaceList, PointField, PointType > > &, const point &) const
 Get type (inside,outside,mixed,unknown) of point w.r.t. surface.
bool overlaps (const label index, const treeBoundBox &sampleBb) const
 Does (bb of) shape at index overlap bb.
void findNearest (const labelList &indices, const point &sample, scalar &nearestDistSqr, label &nearestIndex, point &nearestPoint) const
 Calculates nearest (to sample) point in shape.
void findNearest (const labelList &indices, const linePointRef &ln, treeBoundBox &tightest, label &minIndex, point &linePoint, point &nearestPoint) const
 Calculates nearest (to line) point in shape.
bool intersects (const label index, const point &start, const point &end, point &result) const
 Calculate intersection of shape with ray. Sets result.

Constructor & Destructor Documentation

treeDataPrimitivePatch ( const bool  cacheBb,
const PrimitivePatch< Face, FaceList, PointField, PointType > &   
)

Construct from patch.


Member Function Documentation

label size ( ) const
inline

Definition at line 114 of file treeDataPrimitivePatch.H.

pointField points ( ) const

Get representative point cloud for all shapes inside.

(one point per shape)

label getVolumeType ( const indexedOctree< treeDataPrimitivePatch< Face, FaceList, PointField, PointType > > &  ,
const point  
) const

Get type (inside,outside,mixed,unknown) of point w.r.t. surface.

Only makes sense for closed surfaces.

bool overlaps ( const label  index,
const treeBoundBox sampleBb 
) const

Does (bb of) shape at index overlap bb.

void findNearest ( const labelList indices,
const point sample,
scalar &  nearestDistSqr,
label &  nearestIndex,
point nearestPoint 
) const

Calculates nearest (to sample) point in shape.

Returns actual point and distance (squared)

void findNearest ( const labelList indices,
const linePointRef ln,
treeBoundBox tightest,
label &  minIndex,
point linePoint,
point nearestPoint 
) const
inline

Calculates nearest (to line) point in shape.

Returns point and distance (squared)

Definition at line 165 of file treeDataPrimitivePatch.H.

References notImplemented.

bool intersects ( const label  index,
const point start,
const point end,
point result 
) const

Calculate intersection of shape with ray. Sets result.

accordingly


The documentation for this class was generated from the following file: