treeDataEdge Class Reference

Holds data for octree to work on an edges subset. More...

Collaboration diagram for treeDataEdge:

Data Structures
class	findIntersectOp
class	findNearestOp

Public Member Functions
	ClassName ("treeDataEdge")
	treeDataEdge (const bool cacheBb, const edgeList &edges, const pointField &points, const labelUList &edgeLabels)
	Construct from selected edges. !Holds references to edges and points. More...
	treeDataEdge (const bool cacheBb, const edgeList &edges, const pointField &points, const Xfer< labelList > &edgeLabels)
	Construct from selected edges, transferring contents. More...
const edgeList &	edges () const
const pointField &	points () const
const labelList &	edgeLabels () const
label	size () const
pointField	shapePoints () const
	Get representative point cloud for all shapes inside. More...
volumeType	getVolumeType (const indexedOctree< treeDataEdge > &, 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	overlaps (const label index, const point &centre, const scalar radiusSqr) const
	Does (bb of) shape at index overlap bb. More...

Private Member Functions
treeBoundBox	calcBb (const label edgeI) const
	Calculate edge bounding box. More...
void	update ()
	Initialise all member data. More...

Private Attributes
const edgeList &	edges_
	Reference to edgeList. More...
const pointField &	points_
	Reference to points. More...
const labelList	edgeLabels_
	Labels of edges. More...
const bool	cacheBb_
	Whether to precalculate and store face bounding box. More...
treeBoundBoxList	bbs_
	Bbs for all above edges (valid only if cacheBb_) More...

Static Private Attributes
static scalar	tol
	Tolerance on linear dimensions. More...

Detailed Description

Holds data for octree to work on an edges subset.

Source files

• treeDataEdge.H
• treeDataEdge.C

Definition at line 53 of file treeDataEdge.H.

Constructor & Destructor Documentation

treeDataEdge() [1/2]

treeDataEdge	(	const bool	cacheBb,
		const edgeList &	edges,
		const pointField &	points,
		const labelUList &	edgeLabels
	)

Construct from selected edges. !Holds references to edges and points.

Definition at line 66 of file treeDataEdge.C.

treeDataEdge() [2/2]

treeDataEdge	(	const bool	cacheBb,
		const edgeList &	edges,
		const pointField &	points,
		const Xfer< labelList > &	edgeLabels
	)

Construct from selected edges, transferring contents.

!Holds references to edges and points

Definition at line 83 of file treeDataEdge.C.

Member Function Documentation

calcBb()

Foam::treeBoundBox calcBb ( const label  edgeI ) const

private

Calculate edge bounding box.

Definition at line 39 of file treeDataEdge.C.

References Foam::e, treeDataEdge::edges_, Foam::max(), Foam::min(), and treeDataEdge::points_.

Here is the call graph for this function:

update()

void update ( )

private

Initialise all member data.

Definition at line 49 of file treeDataEdge.C.

References forAll.

ClassName()

ClassName

(

"treeDataEdge"

)

edges()

const edgeList& edges ( ) const

inline

Definition at line 169 of file treeDataEdge.H.

References treeDataEdge::edges_.

Referenced by refinementFeatures::findNearestEdge(), refinementFeatures::findNearestRegionEdge(), and treeDataEdge::findNearestOp::operator()().

Here is the caller graph for this function:

points()

const pointField& points ( ) const

inline

Definition at line 174 of file treeDataEdge.H.

References treeDataEdge::points_.

Referenced by refinementFeatures::findNearestEdge(), refinementFeatures::findNearestRegionEdge(), and treeDataEdge::findNearestOp::operator()().

Here is the caller graph for this function:

edgeLabels()

const labelList& edgeLabels ( ) const

inline

Definition at line 179 of file treeDataEdge.H.

References treeDataEdge::edgeLabels_.

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

Here is the caller graph for this function:

size()

label size ( ) const

inline

Definition at line 184 of file treeDataEdge.H.

References treeDataEdge::edgeLabels_, and List::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 117 of file treeDataEdge.C.

References Foam::e, and forAll.

getVolumeType()

Foam::volumeType getVolumeType	(	const indexedOctree< treeDataEdge > &	oc,
		const point &	sample
	)		const

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

Only makes sense for closed surfaces.

Definition at line 134 of file treeDataEdge.C.

References volumeType::UNKNOWN.

overlaps() [1/2]

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

Does (bb of) shape at index overlap bb.

Definition at line 145 of file treeDataEdge.C.

References Foam::e, intersect(), and treeBoundBox::intersects().

Here is the call graph for this function:

overlaps() [2/2]

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

Does (bb of) shape at index overlap bb.

Definition at line 163 of file treeDataEdge.C.

References PointHit::distance(), Foam::e, and Foam::sqr().

Here is the call graph for this function:

Field Documentation

tol

scalar tol

staticprivate

Tolerance on linear dimensions.

Definition at line 58 of file treeDataEdge.H.

edges_

const edgeList& edges_

private

Reference to edgeList.

Definition at line 64 of file treeDataEdge.H.

Referenced by treeDataEdge::calcBb(), and treeDataEdge::edges().

points_

const pointField& points_

private

Reference to points.

Definition at line 67 of file treeDataEdge.H.

Referenced by treeDataEdge::calcBb(), and treeDataEdge::points().

edgeLabels_

const labelList edgeLabels_

private

Labels of edges.

Definition at line 70 of file treeDataEdge.H.

Referenced by treeDataEdge::edgeLabels(), and treeDataEdge::size().

cacheBb_

const bool cacheBb_

private

Whether to precalculate and store face bounding box.

Definition at line 73 of file treeDataEdge.H.

bbs_

treeBoundBoxList bbs_

private

Bbs for all above edges (valid only if cacheBb_)

Definition at line 76 of file treeDataEdge.H.

---

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

• src/meshTools/indexedOctree/treeDataEdge.H
• src/meshTools/indexedOctree/treeDataEdge.C