Classes | Public Member Functions | List of all members
treeDataPoint Class Reference

Holds (reference to) pointField. Encapsulation of data needed for octree searches. Used for searching for nearest point. No bounding boxes around points. Only overlaps and calcNearest are implemented, rest makes little sense. More...

Classes

class  findIntersectOp
 
class  findNearestOp
 

Public Member Functions

 ClassName ("treeDataPoint")
 
 treeDataPoint (const pointField &points)
 
 treeDataPoint (const pointField &points, const labelUList &pointLabels, const bool useSubsetPoints=true)
 
 treeDataPoint (const pointField &points, labelList &&pointLabels, const bool useSubsetPoints=true)
 
bool empty () const
 
label size () const
 
const pointFieldpoints () const
 
const labelListpointLabels () const
 
bool useSubset () const
 
label pointLabel (const label index) const
 
const pointshapePoint (const label index) const
 
pointField shapePoints () const
 
volumeType getVolumeType (const indexedOctree< treeDataPoint > &os, const point &sample) const
 
bool overlaps (const label index, const treeBoundBox &sampleBb) const
 
bool overlaps (const label index, const point &centre, const scalar radiusSqr) const
 
const pointoperator[] (const label index) const
 

Detailed Description

Holds (reference to) pointField. Encapsulation of data needed for octree searches. Used for searching for nearest point. No bounding boxes around points. Only overlaps and calcNearest are implemented, rest makes little sense.

Optionally works on subset of points.

Source files

Definition at line 58 of file treeDataPoint.H.

Constructor & Destructor Documentation

◆ treeDataPoint() [1/3]

treeDataPoint ( const pointField points)
explicit

Definition at line 37 of file treeDataPoint.C.

◆ treeDataPoint() [2/3]

treeDataPoint ( const pointField points,
const labelUList pointLabels,
const bool  useSubsetPoints = true 
)

Definition at line 45 of file treeDataPoint.C.

◆ treeDataPoint() [3/3]

treeDataPoint ( const pointField points,
labelList &&  pointLabels,
const bool  useSubsetPoints = true 
)

Definition at line 58 of file treeDataPoint.C.

Member Function Documentation

◆ ClassName()

ClassName ( "treeDataPoint"  )

◆ empty()

bool empty ( ) const
inline

Definition at line 155 of file treeDataPoint.H.

◆ size()

label size ( ) const
inline

Definition at line 166 of file treeDataPoint.H.

◆ points()

const pointField& points ( ) const
inline

Definition at line 177 of file treeDataPoint.H.

◆ pointLabels()

const labelList& pointLabels ( ) const
inline

Definition at line 183 of file treeDataPoint.H.

◆ useSubset()

bool useSubset ( ) const
inline

Definition at line 189 of file treeDataPoint.H.

◆ pointLabel()

label pointLabel ( const label  index) const
inline

Definition at line 195 of file treeDataPoint.H.

Referenced by lumpedPointMovement::setInterpolator(), and lumpedPointMovement::setPatchControl().

Here is the caller graph for this function:

◆ shapePoint()

const point& shapePoint ( const label  index) const
inline

Definition at line 206 of file treeDataPoint.H.

Referenced by treeDataPoint::findNearestOp::operator()(), and treeDataPoint::operator[]().

Here is the caller graph for this function:

◆ shapePoints()

Foam::pointField shapePoints ( ) const

Definition at line 88 of file treeDataPoint.C.

◆ getVolumeType()

Foam::volumeType getVolumeType ( const indexedOctree< treeDataPoint > &  os,
const point sample 
) const

Definition at line 100 of file treeDataPoint.C.

References volumeType::UNKNOWN.

◆ overlaps() [1/2]

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

Definition at line 110 of file treeDataPoint.C.

References treeBoundBox::contains().

Here is the call graph for this function:

◆ overlaps() [2/2]

bool overlaps ( const label  index,
const point centre,
const scalar  radiusSqr 
) const

Definition at line 120 of file treeDataPoint.C.

References Foam::magSqr().

Here is the call graph for this function:

◆ operator[]()

const point& operator[] ( const label  index) const
inline

Definition at line 250 of file treeDataPoint.H.

References treeDataPoint::shapePoint().

Here is the call graph for this function:

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