treeDataCell Class Reference

Encapsulation of data needed to search in/for cells. Used to find the cell containing a point (e.g. cell-cell mapping). More...

Classes

class  findIntersectOp
 
class  findNearestOp
 

Public Member Functions

 ClassName ("treeDataCell")
 
 treeDataCell (const bool cacheBb, const polyMesh &, const labelUList &, const polyMesh::cellDecomposition decompMode)
 Construct from mesh and subset of cells. More...
 
 treeDataCell (const bool cacheBb, const polyMesh &, labelList &&, const polyMesh::cellDecomposition decompMode)
 Move construct from mesh and subset of cells, transferring contents. More...
 
 treeDataCell (const bool cacheBb, const polyMesh &, const polyMesh::cellDecomposition decompMode)
 Construct from mesh. Uses all cells in mesh. More...
 
const labelListcellLabels () const
 
const polyMeshmesh () const
 
polyMesh::cellDecomposition decompMode () const
 
label size () const
 
pointField shapePoints () const
 Get representative point cloud for all shapes inside. More...
 
volumeType getVolumeType (const indexedOctree< treeDataCell > &, const point &) const
 Get type (inside,outside,mixed,unknown) of point w.r.t. surface. More...
 
bool overlaps (const label index, const treeBoundBox &sampleBb) const
 Does (bb of) shape at index overlap bb. More...
 
bool contains (const label index, const point &sample) const
 Does shape at index contain sample. More...
 

Detailed Description

Encapsulation of data needed to search in/for cells. Used to find the cell containing a point (e.g. cell-cell mapping).

Source files

Definition at line 54 of file treeDataCell.H.

Constructor & Destructor Documentation

◆ treeDataCell() [1/3]

treeDataCell ( const bool  cacheBb,
const polyMesh mesh,
const labelUList cellLabels,
const polyMesh::cellDecomposition  decompMode 
)

Construct from mesh and subset of cells.

Definition at line 87 of file treeDataCell.C.

Referenced by treeDataCell::treeDataCell().

Here is the caller graph for this function:

◆ treeDataCell() [2/3]

treeDataCell ( const bool  cacheBb,
const polyMesh mesh,
labelList &&  cellLabels,
const polyMesh::cellDecomposition  decompMode 
)

Move construct from mesh and subset of cells, transferring contents.

Definition at line 104 of file treeDataCell.C.

References treeDataCell::treeDataCell().

Here is the call graph for this function:

◆ treeDataCell() [3/3]

treeDataCell ( const bool  cacheBb,
const polyMesh mesh,
const polyMesh::cellDecomposition  decompMode 
)

Construct from mesh. Uses all cells in mesh.

Definition at line 121 of file treeDataCell.C.

References treeDataCell::findNearestOp::findNearestOp().

Here is the call graph for this function:

Member Function Documentation

◆ ClassName()

ClassName ( "treeDataCell"  )

◆ cellLabels()

const labelList& cellLabels ( ) const
inline

Definition at line 170 of file treeDataCell.H.

Referenced by treeDataCell::findNearestOp::operator()().

Here is the caller graph for this function:

◆ mesh()

const polyMesh& mesh ( ) const
inline

Definition at line 175 of file treeDataCell.H.

Referenced by treeDataCell::findNearestOp::operator()().

Here is the caller graph for this function:

◆ decompMode()

polyMesh::cellDecomposition decompMode ( ) const
inline

Definition at line 180 of file treeDataCell.H.

◆ size()

label size ( ) const
inline

Definition at line 185 of file treeDataCell.H.

References treeDataCell::getVolumeType(), treeDataCell::shapePoints(), and List< T >::size().

Here is the call graph for this function:

◆ shapePoints()

Foam::pointField shapePoints ( ) const

Get representative point cloud for all shapes inside.

(one point per shape)

Definition at line 156 of file treeDataCell.C.

References forAll, and treeDataCell::overlaps().

Referenced by treeDataCell::size().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getVolumeType()

volumeType getVolumeType ( const indexedOctree< treeDataCell > &  ,
const point  
) const
inline

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

Only makes sense for closed surfaces.

Definition at line 200 of file treeDataCell.H.

References treeDataCell::contains(), NotImplemented, treeDataCell::overlaps(), and volumeType::unknown.

Referenced by treeDataCell::size().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ overlaps()

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

Does (bb of) shape at index overlap bb.

Definition at line 170 of file treeDataCell.C.

References treeDataCell::contains(), and boundBox::overlaps().

Referenced by treeDataCell::getVolumeType(), and treeDataCell::shapePoints().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ contains()

bool contains ( const label  index,
const point sample 
) const

Does shape at index contain sample.

Definition at line 187 of file treeDataCell.C.

Referenced by treeDataCell::getVolumeType(), and treeDataCell::overlaps().

Here is the caller graph for this function:

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