Class representing the octant of octree. More...

#include <octreelocalizer.h>

Collaboration diagram for oofem::OctantRec:

Public Types
enum	BoundingBoxStatus { BBS_OutsideCell, BBS_InsideCell, BBS_ContainsCell }

enum	ChildStatus { CS_ChildFound, CS_NoChild }

Public Member Functions
	OctantRec (OctreeSpatialLocalizer loc, OctantRec parent, FloatArray &origin, double halfWidth)
	Constructor. More...

	~OctantRec ()
	Destructor. More...

OctantRec *	giveParent ()

const FloatArray &	giveOrigin ()
	Gives the cell origin. More...

double	giveWidth ()

int	giveCellDepth ()

OctantRec *	giveChild (int xi, int yi, int zi)
	Gives the Child at given local indices. More...

ChildStatus	giveChildContainingPoint (OctantRec **child, const FloatArray &coords)
	Returns the child containing given point. More...

bool	isTerminalOctant ()

std::list< int > &	giveNodeList ()

IntArray &	giveIPElementList ()

std::list< int > &	giveElementList (int region)

void	divideLocally (int level, const IntArray &octantMask)
	Divide receiver further, creating corresponding children. More...

BoundingBoxStatus	testBoundingBox (const FloatArray &coords, double radius)
	Test if receiver within bounding box (sphere). More...

void	addElementIP (int elementNum)
	Adds given element to cell list of elements having IP within this cell. More...

void	addElement (int region, int elementNum)
	Adds given element to cell list of elements having IP within this cell. More...

void	addNode (int nodeNum)
	Adds given Node to node list of nodes contained by receiver. More...

void	deleteNodeList ()
	Clears and deletes the nodeList. More...

void	printYourself ()
	Recursively prints structure. More...

std::string	errorInfo (const char *func) const
	Error printing helper. More...

Protected Attributes
OctreeSpatialLocalizer *	localizer
	Link to octree class. More...

OctantRec *	parent
	Link to parent cell record. More...

OctantRec *	child [2][2][2]
	Link to octant children. More...

FloatArray	origin
	Octant origin coordinates (lower corner) More...

double	halfWidth
	Octant size. More...

int	depth
	Tree depth. More...

std::list< int >	nodeList
	Octant node list. More...

IntArray	elementIPList
	Element list, containing all elements having IP in cell. More...

std::vector< std::list< int > >	elementList
	Element list of all elements close to the cell. More...

Detailed Description

Class representing the octant of octree.

It maintains the link to parent cell or if it it the root cell, this link pointer is set to NULL. Maintains links to possible child octree cells as well as its position and size. Also list of node numbers contained in given octree cell can be maintained if cell is terminal cell.

Definition at line 64 of file octreelocalizer.h.

Member Enumeration Documentation

enum oofem::OctantRec::BoundingBoxStatus

Enumerator
BBS_OutsideCell
BBS_InsideCell
BBS_ContainsCell

Definition at line 88 of file octreelocalizer.h.

enum oofem::OctantRec::ChildStatus

Enumerator
CS_ChildFound
CS_NoChild

Definition at line 89 of file octreelocalizer.h.

Constructor & Destructor Documentation

oofem::OctantRec::OctantRec	(	OctreeSpatialLocalizer *	loc,
		OctantRec *	parent,
		FloatArray &	origin,
		double	halfWidth
	)

Constructor.

Definition at line 51 of file octreelocalizer.C.

References child, depth, and giveCellDepth().

Referenced by divideLocally().

oofem::OctantRec::~OctantRec ( )

Destructor.

Definition at line 68 of file octreelocalizer.C.

References child.

Member Function Documentation

void oofem::OctantRec::addElement	(	int	region,
		int	elementNum
	)

inline

Adds given element to cell list of elements having IP within this cell.

Parameters

region	Element region number (0 for global).
elementNum	Element number to add.

Definition at line 158 of file octreelocalizer.h.

Referenced by oofem::OctreeSpatialLocalizer::insertElementIntoOctree().

void oofem::OctantRec::addElementIP ( int elementNum )

inline

Adds given element to cell list of elements having IP within this cell.

Parameters

elementNum Element number to add.

Definition at line 152 of file octreelocalizer.h.

References oofem::IntArray::insertSortedOnce().

Referenced by oofem::OctreeSpatialLocalizer::insertElementsUsingNodalConnectivitiesIntoOctree(), and oofem::OctreeSpatialLocalizer::insertIPElementIntoOctree().

void oofem::OctantRec::addNode ( int nodeNum )

inline

Adds given Node to node list of nodes contained by receiver.

Parameters

nodeNum Node number to add.

Definition at line 163 of file octreelocalizer.h.

Referenced by oofem::OctreeSpatialLocalizer::insertNodeIntoOctree().

void oofem::OctantRec::deleteNodeList ( )

inline

Clears and deletes the nodeList.

Definition at line 167 of file octreelocalizer.h.

Referenced by oofem::OctreeSpatialLocalizer::insertNodeIntoOctree().

void oofem::OctantRec::divideLocally	(	int	level,
		const IntArray &	octantMask
	)

Divide receiver further, creating corresponding children.

Parameters

level	Depth of tree.
octantMask	Masking of dimensions.

Definition at line 151 of file octreelocalizer.C.

References oofem::IntArray::at(), oofem::FloatArray::at(), child, divideLocally(), halfWidth, isTerminalOctant(), localizer, OctantRec(), and origin.

Referenced by oofem::OctreeSpatialLocalizer::buildOctreeDataStructure(), divideLocally(), and oofem::OctreeSpatialLocalizer::insertNodeIntoOctree().

std :: string oofem::OctantRec::errorInfo ( const char * func ) const

inline

Error printing helper.

Definition at line 173 of file octreelocalizer.h.

int oofem::OctantRec::giveCellDepth ( )

inline

Returns: Depth in the tree for this octant.

Definition at line 106 of file octreelocalizer.h.

Referenced by oofem::OctreeSpatialLocalizer::giveMaxTreeDepthFrom(), oofem::OctreeSpatialLocalizer::insertNodeIntoOctree(), and OctantRec().

OctantRec * oofem::OctantRec::giveChild	(	int	xi,
		int	yi,
		int	zi
	)

Gives the Child at given local indices.

Parameters

xi	First index.
yi	Second index.
zi	Third index.

Returns: Child cell with given local cell coordinates.

Definition at line 106 of file octreelocalizer.C.

References child, and OOFEM_ERROR.

OctantRec::ChildStatus oofem::OctantRec::giveChildContainingPoint	(	OctantRec **	child,
		const FloatArray &	coords
	)

Returns the child containing given point.

If not full 3d coordinates are provided, then only provided coordinates are taken into account, assuming remaining to be same as origin. If point is contained by receiver, corresponding child is set, otherwise. child is set to NULL.

Parameters