Non-pointer based hierarchical recursive searching. More...

Inheritance diagram for indexedOctree< Type >:

[legend]

Collaboration diagram for indexedOctree< Type >:

Public Member Functions
	indexedOctree (const Type &shapes)
	Construct null. More...

	indexedOctree (const Type &shapes, const List< node > &nodes, const List< labelList > &contents)
	Construct from components. More...

	indexedOctree (const Type &shapes, const treeBoundBox &bb, const label maxLevels, const scalar maxLeafRatio, const scalar maxDuplicity)
	Construct from shapes. More...

	indexedOctree (const Type &shapes, Istream &is)
	Construct from Istream. More...

autoPtr< indexedOctree< Type > >	clone () const
	Clone. More...

const Type &	shapes () const noexcept
	Reference to shape. More...

const List< node > &	nodes () const noexcept
	List of all nodes. More...

const List< labelList > &	contents () const noexcept
	List of all contents (referenced by those nodes that are contents) More...

PackedList< 2 > &	nodeTypes () const noexcept
	Per node, per octant whether is fully inside/outside/mixed. More...

const treeBoundBox &	bb () const
	Top bounding box. More...

label	nLeafs () const
	Return the number of leaf nodes. More...

pointIndexHit	findNearest (const point &sample, const scalar nearestDistSqr) const

template<class FindNearestOp >
pointIndexHit	findNearest (const point &sample, const scalar nearestDistSqr, const FindNearestOp &fnOp) const
	Calculate nearest point on nearest shape. More...

template<class FindNearestOp >
void	findNearest (const label nodeI, const point &, scalar &nearestDistSqr, label &nearestShapeI, point &nearestPoint, const FindNearestOp &fnOp) const
	Low level: calculate nearest starting from subnode. More...

pointIndexHit	findNearest (const linePointRef &ln, treeBoundBox &tightest, point &linePoint) const
	Find nearest to line. More...

template<class FindNearestOp >
pointIndexHit	findNearest (const linePointRef &ln, treeBoundBox &tightest, point &linePoint, const FindNearestOp &fnOp) const

pointIndexHit	findLine (const point &start, const point &end) const
	Find nearest intersection of line between start and end. More...

pointIndexHit	findLineAny (const point &start, const point &end) const
	Find any intersection of line between start and end. More...

template<class FindIntersectOp >
pointIndexHit	findLine (const point &start, const point &end, const FindIntersectOp &fiOp) const
	Find nearest intersection of line between start and end. More...

template<class FindIntersectOp >
pointIndexHit	findLineAny (const point &start, const point &end, const FindIntersectOp &fiOp) const
	Find any intersection of line between start and end. More...

bool	overlaps (const treeBoundBox &bb) const
	True if any shapes overlap the bounding box. More...

labelList	findBox (const treeBoundBox &bb) const
	Find indices of all shapes inside or overlapping a bounding box (i.e. all shapes not outside box) More...

label	findBox (const treeBoundBox &bb, labelHashSet &elements) const
	Find indices of all shapes inside or overlapping a bounding box (i.e. all shapes not outside box) More...

bool	overlaps (const point &centre, const scalar radiusSqr) const
	True if any shapes overlap the bounding sphere. More...

labelList	findSphere (const point &centre, const scalar radiusSqr) const
	Find indices of all shapes inside or overlapping a bounding sphere (i.e. all shapes not outside a sphere) More...

label	findSphere (const point &centre, const scalar radiusSqr, labelHashSet &elements) const
	Find indices of all shapes inside or overlapping a bounding sphere (i.e. all shapes not outside sphere) More...

labelBits	findNode (const label nodeI, const point &) const
	Find deepest node (as parent+octant) containing point. Starts. More...

label	findInside (const point &) const
	Find shape containing point. Only implemented for certain. More...

const labelList &	findIndices (const point &) const
	Find the shape indices that occupy the result of findNode. More...

volumeType	getVolumeType (const point &) const
	Determine type (inside/outside/mixed) for point. unknown if. More...

template<class CompareOp >
void	findNear (const scalar nearDist, const indexedOctree< Type > &tree2, CompareOp &cop) const
	Find near pairs and apply CompareOp to them. More...

void	writeOBJ (Ostream &os) const
	Write (non-empty) tree boxes in OBJ format. More...

void	print (prefixOSstream &, const bool printContents, const label) const
	Print tree. Either print all indices (printContent = true) or. More...

bool	write (Ostream &os) const

template<class FindIntersectOp >
Foam::pointIndexHit	findLine (const bool findAny, const point &treeStart, const point &treeEnd, const label startNodeI, const direction startOctant, const FindIntersectOp &fiOp, const bool verbose) const

template<class FindIntersectOp >
Foam::pointIndexHit	findLine (const bool findAny, const point &start, const point &end, const FindIntersectOp &fiOp) const

template<class FindNearestOp >
Foam::pointIndexHit	findNearest (const point &sample, const scalar startDistSqr, const FindNearestOp &fnOp) const

template<class FindNearestOp >
Foam::pointIndexHit	findNearest (const linePointRef &ln, treeBoundBox &tightest, point &linePoint, const FindNearestOp &fnOp) const

template<class FindIntersectOp >
Foam::pointIndexHit	findLine (const point &start, const point &end, const FindIntersectOp &fiOp) const

template<class FindIntersectOp >
Foam::pointIndexHit	findLineAny (const point &start, const point &end, const FindIntersectOp &fiOp) const

Public Member Functions inherited from indexedOctreeBase
	ClassName ("indexedOctree")
	Runtime type information. More...

	indexedOctreeBase ()=default
	Default construct. More...

Static Public Member Functions
static volumeType	getSide (const vector &outsideNormal, const vector &vec)
	Helper function to return the side. Returns outside if. More...

Static Public Member Functions inherited from indexedOctreeBase
static bool	isEmpty (labelBits i) noexcept
	An empty node - no content. More...

static bool	isContent (labelBits i) noexcept
	Node with content (leaf) More...

static bool	isNode (labelBits i) noexcept
	A parent node. More...

static label	getContent (labelBits i)
	Return real (dereferenced) index for a content node. More...

static label	getNode (const labelBits i)
	Return real (dereferenced) index for a parent node. More...

static direction	getOctant (labelBits i) noexcept
	Return sub-node direction/octant. More...

static scalar &	perturbTol () noexcept
	Get the perturbation tolerance. More...

static scalar	perturbTol (scalar tol) noexcept
	Set the perturbation tolerance, return the old value. More...

static void	writeOBJ (Ostream &os, const treeBoundBox &bb, label &vertIndex, const bool writeLinesOnly=false)
	Write treeBoundBox in OBJ format. More...

Friends
Ostream &	operator (Ostream &, const indexedOctree< Type > &)

Additional Inherited Members
Static Protected Member Functions inherited from indexedOctreeBase
static labelBits	emptyPlusOctant (direction octant)
	From empty to subNodes_ entry. More...

static labelBits	contentPlusOctant (label i, direction octant)
	From index into contents_ to subNodes_ entry. More...

static labelBits	nodePlusOctant (label i, direction octant)
	From index into nodes_ to subNodes_ entry. More...

Static Protected Attributes inherited from indexedOctreeBase
static scalar	perturbTol_ = 10*SMALL
	Relative perturbation tolerance. More...

Detailed Description

template<class Type>
class Foam::indexedOctree< Type >

Non-pointer based hierarchical recursive searching.

Source files

Definition at line 44 of file treeDataPrimitivePatch.H.

Constructor & Destructor Documentation

◆ indexedOctree() [1/4]

indexedOctree ( const Type & shapes )

Construct null.

Definition at line 2111 of file indexedOctree.C.

◆ indexedOctree() [2/4]

indexedOctree	(	const Type &	shapes,
		const List< node > &	nodes,
		const List< labelList > &	contents
	)

Construct from components.

Definition at line 2122 of file indexedOctree.C.

◆ indexedOctree() [3/4]

indexedOctree	(	const Type &	shapes,
		const treeBoundBox &	bb,
		const label	maxLevels,
		const scalar	maxLeafRatio,
		const scalar	maxDuplicity
	)

Construct from shapes.

Definition at line 2137 of file indexedOctree.C.

◆ indexedOctree() [4/4]

indexedOctree	(	const Type &	shapes,
		Istream &	is
	)

Construct from Istream.

Definition at line 2316 of file indexedOctree.C.

Member Function Documentation

◆ clone()

autoPtr<indexedOctree<Type> > clone ( ) const

inline

Clone.

Definition at line 650 of file indexedOctree.H.

◆ shapes()

const Type& shapes ( ) const

inlinenoexcept

Reference to shape.

Definition at line 663 of file indexedOctree.H.

Referenced by patchProbes::findElements(), refinementFeatures::findNearestRegionEdge(), surfaceFeatures::nearestEdges(), surfaceFeatures::nearestFeatEdge(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSurfEdge(), findNearestMaskedOp< PatchType >::operator()(), lumpedPointMovement::setInterpolator(), and lumpedPointMovement::setPatchControl().

Here is the caller graph for this function:

◆ nodes()

const List<node>& nodes ( ) const

inlinenoexcept

List of all nodes.

Definition at line 668 of file indexedOctree.H.

Referenced by distributedTriSurfaceMesh::getVolumeType().

Here is the caller graph for this function:

◆ contents()

const List<labelList>& contents ( ) const

inlinenoexcept

List of all contents (referenced by those nodes that are contents)

Definition at line 674 of file indexedOctree.H.

◆ nodeTypes()

PackedList<2>& nodeTypes ( ) const

inlinenoexcept

Per node, per octant whether is fully inside/outside/mixed.

Definition at line 682 of file indexedOctree.H.

Referenced by distributedTriSurfaceMesh::getVolumeType().

Here is the caller graph for this function:

◆ bb()

const treeBoundBox& bb ( ) const

inline

Top bounding box.

Definition at line 690 of file indexedOctree.H.

Referenced by patchProbes::findElements(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findNear(), and surfaceFeatures::nearestSamples().

Here is the caller graph for this function:

◆ nLeafs()

Foam::label nLeafs ( ) const

Return the number of leaf nodes.

Definition at line 2876 of file indexedOctree.C.

◆ findNearest() [1/7]

Foam::pointIndexHit findNearest	(	const point &	sample,
		const scalar	nearestDistSqr
	)		const

Definition at line 2332 of file indexedOctree.C.

◆ findNearest() [2/7]

pointIndexHit findNearest	(	const point &	sample,
		const scalar	nearestDistSqr,
		const FindNearestOp &	fnOp
	)		const

Calculate nearest point on nearest shape.

Returns

bool : any point found nearer than nearestDistSqr
label: index in shapes
point: actual nearest point found

◆ findNearest() [3/7]

void findNearest	(	const label	nodeI,
		const point &	sample,
		scalar &	nearestDistSqr,
		label &	nearestShapeI,
		point &	nearestPoint,
		const FindNearestOp &	fnOp
	)		const

Low level: calculate nearest starting from subnode.

Definition at line 390 of file indexedOctree.C.

◆ findNearest() [4/7]

Foam::pointIndexHit findNearest	(	const linePointRef &	ln,
		treeBoundBox &	tightest,
		point &	linePoint
	)		const

Find nearest to line.

Returns

bool : any point found?
label: index in shapes
point: actual nearest point found sets:
linePoint : corresponding nearest point on line

Definition at line 2381 of file indexedOctree.C.

◆ findNearest() [5/7]

pointIndexHit findNearest	(	const linePointRef &	ln,
		treeBoundBox &	tightest,
		point &	linePoint,
		const FindNearestOp &	fnOp
	)		const

◆ findLine() [1/5]

Foam::pointIndexHit findLine	(	const point &	start,
		const point &	end
	)		const

Find nearest intersection of line between start and end.

Definition at line 2433 of file indexedOctree.C.

◆ findLineAny() [1/3]

Foam::pointIndexHit findLineAny	(	const point &	start,
		const point &	end
	)		const

Find any intersection of line between start and end.

Definition at line 2450 of file indexedOctree.C.

Referenced by triSurfaceSearch::findLineAny().

Here is the caller graph for this function:

◆ findLine() [2/5]

pointIndexHit findLine	(	const point &	start,
		const point &	end,
		const FindIntersectOp &	fiOp
	)		const

Find nearest intersection of line between start and end.

◆ findLineAny() [2/3]

pointIndexHit findLineAny	(	const point &	start,
		const point &	end,
		const FindIntersectOp &	fiOp
	)		const

Find any intersection of line between start and end.

◆ overlaps() [1/2]

bool overlaps ( const treeBoundBox & bb ) const

True if any shapes overlap the bounding box.

Definition at line 2493 of file indexedOctree.C.

◆ findBox() [1/2]

Foam::labelList findBox ( const treeBoundBox & bb ) const

Find indices of all shapes inside or overlapping a bounding box (i.e. all shapes not outside box)

Returns: the indices (in no particular order)

Parameters

bb	bound box limits

Definition at line 2527 of file indexedOctree.C.

◆ findBox() [2/2]

Foam::label findBox	(	const treeBoundBox &	bb,
		labelHashSet &	elements
	)		const

Find indices of all shapes inside or overlapping a bounding box (i.e. all shapes not outside box)

Returns: the number of elements found

Parameters

	bb	bound box limits
[out]	elements	elements found

Definition at line 2504 of file indexedOctree.C.

◆ overlaps() [2/2]

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

True if any shapes overlap the bounding sphere.

Parameters

centre	centre of bound sphere
radiusSqr	radius^2 of sphere

Definition at line 2547 of file indexedOctree.C.

◆ findSphere() [1/2]

Foam::labelList findSphere	(	const point &	centre,
		const scalar	radiusSqr
	)		const

Find indices of all shapes inside or overlapping a bounding sphere (i.e. all shapes not outside a sphere)

Returns: the indices (in no particular order)

Parameters

centre	centre of bound sphere
radiusSqr	radius^2 of sphere

Definition at line 2584 of file indexedOctree.C.

◆ findSphere() [2/2]

Foam::label findSphere	(	const point &	centre,
		const scalar	radiusSqr,
		labelHashSet &	elements
	)		const

Find indices of all shapes inside or overlapping a bounding sphere (i.e. all shapes not outside sphere)

Returns: the number of elements found

Parameters

	centre	centre of bound sphere
	radiusSqr	radius^2 of sphere
[out]	elements	elements found

Definition at line 2559 of file indexedOctree.C.

◆ findNode()

Foam::labelBits findNode	(	const label	nodeI,
		const point &	sample
	)		const

Find deepest node (as parent+octant) containing point. Starts.

off from starting index in nodes_ (use 0 to start from top) Use getNode and getOctant to extract info, or call findIndices.

Definition at line 2605 of file indexedOctree.C.

◆ findInside()

Foam::label findInside ( const point & sample ) const

Find shape containing point. Only implemented for certain.

shapes.

Definition at line 2641 of file indexedOctree.C.

◆ findIndices()

const Foam::labelList & findIndices ( const point & sample ) const

Find the shape indices that occupy the result of findNode.

Definition at line 2676 of file indexedOctree.C.

◆ getVolumeType()

Foam::volumeType getVolumeType ( const point & sample ) const

Determine type (inside/outside/mixed) for point. unknown if.

cannot be determined (e.g. non-manifold surface)

Definition at line 2703 of file indexedOctree.C.

◆ getSide()

Foam::volumeType getSide	(	const vector &	outsideNormal,
		const vector &	vec
	)

static

Helper function to return the side. Returns outside if.

outsideNormal&vec >= 0, inside otherwise

Definition at line 371 of file indexedOctree.C.

Referenced by treeDataFace::getVolumeType().

Here is the caller graph for this function:

◆ findNear()

void findNear	(	const scalar	nearDist,
		const indexedOctree< Type > &	tree2,
		CompareOp &	cop
	)		const

Find near pairs and apply CompareOp to them.

tree2 can be *this or different tree.

Definition at line 2773 of file indexedOctree.C.

◆ writeOBJ()

void writeOBJ ( Ostream & os ) const

Write (non-empty) tree boxes in OBJ format.

Definition at line 2097 of file indexedOctree.C.

◆ print()

void print	(	prefixOSstream &	os,
		const bool	printContents,
		const label	nodeI
	)		const

Print tree. Either print all indices (printContent = true) or.

just size of contents nodes.

Definition at line 2799 of file indexedOctree.C.

◆ write()

bool write ( Ostream & os ) const

Definition at line 2889 of file indexedOctree.C.

◆ findLine() [3/5]

Foam::pointIndexHit findLine	(	const bool	findAny,
		const point &	treeStart,
		const point &	treeEnd,
		const label	startNodeI,
		const direction	startOctant,
		const FindIntersectOp &	fiOp,
		const bool	verbose
	)		const

Definition at line 1415 of file indexedOctree.C.

◆ findLine() [4/5]

Foam::pointIndexHit findLine	(	const bool	findAny,
		const point &	start,
		const point &	end,
		const FindIntersectOp &	fiOp
	)		const

Definition at line 1607 of file indexedOctree.C.

◆ findNearest() [6/7]

Foam::pointIndexHit findNearest	(	const point &	sample,
		const scalar	startDistSqr,
		const FindNearestOp &	fnOp
	)		const

Definition at line 2349 of file indexedOctree.C.

◆ findNearest() [7/7]

Foam::pointIndexHit findNearest	(	const linePointRef &	ln,
		treeBoundBox &	tightest,
		point &	linePoint,
		const FindNearestOp &	fnOp
	)		const

Definition at line 2400 of file indexedOctree.C.

◆ findLine() [5/5]

Foam::pointIndexHit findLine	(	const point &	start,
		const point &	end,
		const FindIntersectOp &	fiOp
	)		const

Definition at line 2468 of file indexedOctree.C.

◆ findLineAny() [3/3]

Foam::pointIndexHit findLineAny	(	const point &	start,
		const point &	end,
		const FindIntersectOp &	fiOp
	)		const

Definition at line 2481 of file indexedOctree.C.

Friends And Related Function Documentation

◆ operator

Ostream& operator	(	Ostream &	,
		const indexedOctree< Type > &
	)

friend

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

src/meshTools/indexedOctree/treeDataPrimitivePatch.H
src/OpenFOAM/algorithms/indexedOctree/indexedOctree.H
src/OpenFOAM/algorithms/indexedOctree/indexedOctree.C

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

template<class Type> class Foam::indexedOctree< Type >

Constructor & Destructor Documentation

◆ indexedOctree() [1/4]

◆ indexedOctree() [2/4]

◆ indexedOctree() [3/4]

◆ indexedOctree() [4/4]

Member Function Documentation

◆ clone()

◆ shapes()

◆ nodes()

◆ contents()

◆ nodeTypes()

◆ bb()

◆ nLeafs()

◆ findNearest() [1/7]

◆ findNearest() [2/7]

◆ findNearest() [3/7]

◆ findNearest() [4/7]

◆ findNearest() [5/7]

◆ findLine() [1/5]

◆ findLineAny() [1/3]

◆ findLine() [2/5]

◆ findLineAny() [2/3]

◆ overlaps() [1/2]

◆ findBox() [1/2]

◆ findBox() [2/2]

◆ overlaps() [2/2]

◆ findSphere() [1/2]

◆ findSphere() [2/2]

◆ findNode()

◆ findInside()

◆ findIndices()

◆ getVolumeType()

◆ getSide()

◆ findNear()

◆ writeOBJ()

◆ print()

◆ write()

◆ findLine() [3/5]

◆ findLine() [4/5]

◆ findNearest() [6/7]

◆ findNearest() [7/7]

◆ findLine() [5/5]

◆ findLineAny() [3/3]

Friends And Related Function Documentation

◆ operator

template<class Type>
class Foam::indexedOctree< Type >