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

Inheritance diagram for indexedOctree< Type >:

[legend]

Collaboration diagram for indexedOctree< Type >:

Classes
class	node
	Tree node. Has up pointer and down pointers. More...

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

	indexedOctree (const Type &shapes, const List< node > &nodes, const labelListList &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
	Reference to shape. More...

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

const labelListList &	contents () const
	List of all contents (referenced by those nodes that are. More...

const treeBoundBox &	bb () const
	Top bounding box. 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...

labelList	findBox (const treeBoundBox &bb) const
	Find (in no particular order) indices of all shapes inside or. More...

labelList	findSphere (const point &centre, const scalar radiusSqr) const
	Find (in no particular order) indices of all shapes inside or. 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	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

Static Public Member Functions
static scalar &	perturbTol ()
	Get the perturbation tolerance. More...

static bool	isContent (const labelBits i)

static bool	isEmpty (const labelBits i)

static bool	isNode (const labelBits i)

static label	getContent (const labelBits i)

static label	getNode (const labelBits i)

static direction	getOctant (const labelBits i)

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

static bool	overlaps (const point &bbMin, const point &bbMax, const scalar nearestDistSqr, const point &sample)
	Helper: does bb intersect a sphere around sample? Or is any. More...

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

Detailed Description

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

Non-pointer based hierarchical recursive searching.

Source files

Definition at line 69 of file indexedOctree.H.

Constructor & Destructor Documentation

◆ indexedOctree() [1/4]

indexedOctree ( const Type & shapes )

Construct null.

Definition at line 2114 of file indexedOctree.C.

◆ indexedOctree() [2/4]

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

Construct from components.

Definition at line 2124 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 2139 of file indexedOctree.C.

References List< T >::append(), indexedOctree< Type >::bb(), indexedOctree< Type >::contents(), Foam::endl(), forAll, Foam::identityMap(), Foam::nl, indexedOctree< Type >::nodes(), Foam::Pout, List< T >::setSize(), indexedOctree< Type >::shapes(), memInfo::size(), and List< T >::size().

Here is the call graph for this function:

◆ indexedOctree() [4/4]

indexedOctree	(	const Type &	shapes,
		Istream &	is
	)

Construct from Istream.

Definition at line 2303 of file indexedOctree.C.

Member Function Documentation

◆ perturbTol()

Foam::scalar & perturbTol

static

Get the perturbation tolerance.

Definition at line 2319 of file indexedOctree.C.

Referenced by triSurface::edgeTree(), triSurfaceSearch::findLine(), triSurfaceSearch::findLineAll(), triSurfaceSearch::findLineAny(), triSurfaceSearch::findNearest(), triSurface::getVolumeType(), and triSurfaceSearch::tree().

Here is the caller graph for this function:

◆ clone()

autoPtr<indexedOctree<Type> > clone ( ) const

inline

Clone.

Definition at line 432 of file indexedOctree.H.

◆ shapes()

const Type& shapes ( ) const

inline

Reference to shape.

Definition at line 445 of file indexedOctree.H.

Referenced by patchProbes::findElements(), meshSearch::findNearestBoundaryFace(), refinementFeatures::findNearestEdge(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), indexedOctree< Type >::indexedOctree(), and surfaceFeatures::nearestEdges().

Here is the caller graph for this function:

◆ nodes()

const List<node>& nodes ( ) const

inline

List of all nodes.

Definition at line 451 of file indexedOctree.H.

Referenced by indexedOctree< Type >::indexedOctree().

Here is the caller graph for this function:

◆ contents()

const labelListList& contents ( ) const

inline

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

contents)

Definition at line 458 of file indexedOctree.H.

Referenced by indexedOctree< Type >::indexedOctree().

Here is the caller graph for this function:

◆ bb()

const treeBoundBox& bb ( ) const

inline

Top bounding box.

Definition at line 464 of file indexedOctree.H.

References Foam::abort(), UList< T >::empty(), Foam::FatalError, and FatalErrorInFunction.

Referenced by patchProbes::findElements(), indexedOctree< Type >::findNear(), meshSearch::findNearestBoundaryFace(), indexedOctree< Type >::indexedOctree(), and surfaceFeatures::nearestSamples().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isContent()

static bool isContent ( const labelBits i )

inlinestatic

Definition at line 477 of file indexedOctree.H.

References labelBits::val().

Referenced by indexedOctree< Type >::getContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isEmpty()

static bool isEmpty ( const labelBits i )

inlinestatic

Definition at line 482 of file indexedOctree.H.

References labelBits::val().

Here is the call graph for this function:

◆ isNode()

static bool isNode ( const labelBits i )

inlinestatic

Definition at line 487 of file indexedOctree.H.

References labelBits::val().

Referenced by indexedOctree< Type >::getNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContent()

static label getContent ( const labelBits i )

inlinestatic

Definition at line 492 of file indexedOctree.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, indexedOctree< Type >::isContent(), and labelBits::val().

Here is the call graph for this function:

◆ getNode()

static label getNode ( const labelBits i )

inlinestatic

Definition at line 502 of file indexedOctree.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, indexedOctree< Type >::isNode(), and labelBits::val().

Here is the call graph for this function:

◆ getOctant()

static direction getOctant ( const labelBits i )

inlinestatic

Definition at line 512 of file indexedOctree.H.

References labelBits::bits().

Here is the call graph for this function:

◆ findNearest() [1/7]

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

Definition at line 2326 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 489 of file indexedOctree.C.

References indexedOctree< Type >::node::bb_, treeBoundBox::searchOrder(), and indexedOctree< Type >::node::subNodes_.

Here is the call graph for this function:

◆ 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 2375 of file indexedOctree.C.

References Foam::ln().

Here is the call graph for this function:

◆ 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 2427 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 2444 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.

◆ findBox()

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

Find (in no particular order) indices of all shapes inside or.

overlapping bounding box (i.e. all shapes not outside box)

Definition at line 2487 of file indexedOctree.C.

References HashTable< T, Key, Hash >::toc().

Here is the call graph for this function:

◆ findSphere()

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

Find (in no particular order) indices of all shapes inside or.

overlapping a bounding sphere (i.e. all shapes not outside sphere)

Definition at line 2505 of file indexedOctree.C.

References HashTable< T, Key, Hash >::toc().

Here is the call graph for this function:

◆ 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 2524 of file indexedOctree.C.

References Foam::abort(), indexedOctree< Type >::node::bb_, treeBoundBox::contains(), Foam::FatalError, FatalErrorInFunction, indexedOctree< Type >::node::subNodes_, and treeBoundBox::subOctant().

Here is the call graph for this function:

◆ findInside()

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

Find shape containing point. Only implemented for certain.

shapes.

Definition at line 2571 of file indexedOctree.C.

References forAll, and indexedOctree< Type >::node::subNodes_.

Referenced by mappedInternalPatchBase::calcMapping(), and polyMesh::findCellFacePt().

Here is the caller graph for this function:

◆ findIndices()

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

Find the shape indices that occupy the result of findNode.

Definition at line 2605 of file indexedOctree.C.

References indexedOctree< Type >::node::subNodes_.

◆ 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 2634 of file indexedOctree.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAll, volumeType::inside, volumeType::mixed, volumeType::outside, Foam::Pout, Foam::type(), and volumeType::unknown.

Here is the call graph for this function:

◆ 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 470 of file indexedOctree.C.

Referenced by treeDataFace::getVolumeType(), and treeDataPrimitivePatch< PatchType >::getVolumeType().

Here is the caller graph for this function:

◆ overlaps()

bool overlaps	(	const point &	bbMin,
		const point &	bbMax,
		const scalar	nearestDistSqr,
		const point &	sample
	)

static

Helper: does bb intersect a sphere around sample? Or is any.

corner point of bb closer than nearestDistSqr to sample.

Definition at line 41 of file indexedOctree.C.

References boundBox::overlaps().

Here is the call 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 2704 of file indexedOctree.C.

References indexedOctree< Type >::bb().

Here is the call graph for this function:

◆ 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 2727 of file indexedOctree.C.

References indexedOctree< Type >::node::bb_, Foam::endl(), forAll, Foam::nl, indexedOctree< Type >::node::parent_, prefixOSstream::prefix(), List< T >::size(), treeBoundBox::subBbox(), indexedOctree< Type >::node::subNodes_, and Foam::meshTools::writeOBJ().

Here is the call graph for this function:

◆ write()

bool write ( Ostream & os ) const

Definition at line 2800 of file indexedOctree.C.

References IOstream::good().

Here is the call graph for this function:

◆ 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 1498 of file indexedOctree.C.

References Foam::abort(), Foam::endl(), treeBoundBox::faceBits(), Foam::FatalError, FatalErrorInFunction, PointIndexHit< Point >::hit(), Foam::nl, Foam::Pout, PointIndexHit< Point >::rawPoint(), and WarningInFunction.

Here is the call graph for this function:

◆ findLine() [4/5]

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

Definition at line 1690 of file indexedOctree.C.

References treeBoundBox::intersects(), treeBoundBox::posBits(), and Foam::Zero.

Here is the call graph for this function:

◆ findNearest() [6/7]

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

Definition at line 2343 of file indexedOctree.C.

References Foam::Zero.

◆ findNearest() [7/7]

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

Definition at line 2394 of file indexedOctree.C.

References Foam::ln(), and Foam::Zero.

Here is the call graph for this function:

◆ findLine() [5/5]

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

Definition at line 2462 of file indexedOctree.C.

◆ findLineAny() [3/3]

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

Definition at line 2475 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/treeDataEdge.H
src/OpenFOAM/algorithms/indexedOctree/indexedOctree.H
src/OpenFOAM/algorithms/indexedOctree/indexedOctree.C

Classes

Public Member Functions

Static Public Member Functions

Friends

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

◆ perturbTol()

◆ clone()

◆ shapes()

◆ nodes()

◆ contents()

◆ bb()

◆ isContent()

◆ isEmpty()

◆ isNode()

◆ getContent()

◆ getNode()

◆ getOctant()

◆ 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]

◆ findBox()

◆ findSphere()

◆ findNode()

◆ findInside()

◆ findIndices()

◆ getVolumeType()

◆ getSide()

◆ overlaps()

◆ findNear()

◆ 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 >