Inheritance diagram for Nektar::FieldUtils::Octree::Octant:

[legend]

Public Member Functions
	Octant ()
	Construct a new Octree::Octant object. More...

	Octant (int loc, int depth, int id, const Array< OneD, NekDouble > &bounds)
	Construct a new Octree::Octant object. More...

	Octant (int loc, Octant &parent)
	Construct a new Octree::Octant object. More...

int	GetNpoints () const

int	GetLoc () const

int	GetDepth () const

double	GetDelta () const

int	GetID () const

bool	IsLeaf () const

Array< OneD, NekDouble > &	GetCentre ()

Array< OneD, NekDouble > &	GetBounds ()

std::vector< int > &	GetIndices ()

Array< OneD, OctantSharedPtr > &	GetChildren ()

std::vector< OctantWeakPtr > &	GetNeighbours ()

void	SetID (int id)

void	GetLeaves (std::vector< OctantSharedPtr > &leaves)
	Updates 'leaves' so that it contains all the leaf nodes belonging to the octant. More...

void	SetIndices (const std::vector< int > &indices)
	Sets the values of 'm_pointInd' to those in 'indices'. More...

void	AddNeighbours (const std::vector< OctantSharedPtr > &neighbours)
	Adds to 'm_neighbours' the octants that are not already in the list. More...

void	AddPoints (const Array< OneD, Array< OneD, NekDouble > > &pts, const std::vector< int > &indices)
	Adds to 'm_pointInd' the IDs of the points in 'pts' that fall inside the octant. More...

void	Subdivide (int maxPts, const Array< OneD, Array< OneD, NekDouble > > &pts, std::vector< OctantSharedPtr > &nodes)
	Recursively divides the octant into 8 children and fills the leaf nodes with their corresponding points. Does NOT add neighbours. More...

int	GetLocInNode (const Array< OneD, NekDouble > &coords)
	Returns the position inside an octant in the range (1-8). The name convention is as follows: let \(\Delta\) be a value between 0 and the length of the side of the father octant, and \(x_c,y_c,z_c\) be the coordinates of the centre of the father node. Then, position 1 corresponds to \(x=x_c-\Delta\), \(y=y_c-\Delta\) and \(y=y_c-\Delta\). The next positions are obtained by rotating counter-clockwise around the Z axis and then, making the same rotation for \(z=z_c+\Delta\). More...

Private Attributes
int	m_nPts
	Number of points in the octant. More...

int	m_loc
	Position in the father octant (1-8) More...

int	m_depth
	Depth in octree (root is 1) More...

int	m_id
	ID of the octant (index in 'm_nodes' vector) More...

double	m_delta
	Length of the octant side. More...

Array< OneD, NekDouble >	m_centre
	Coordinates of the centre of the octant. More...

Array< OneD, NekDouble >	m_bounds
	Min/max coordinates of the octant (x, y, z) More...

std::vector< int >	m_pointInd
	Indices of the points comprised by the octant. More...

bool	m_isLeaf
	True for a leaf octant, false otherwise. More...

Array< OneD, OctantSharedPtr >	m_children
	Vector of pointers to the children octants. More...

std::vector< OctantWeakPtr >	m_neighbours
	Vector of pointers to the neighbouring octants. More...

Detailed Description

Definition at line 93 of file Octree.h.

Constructor & Destructor Documentation

◆ Octant() [1/3]

Nektar::FieldUtils::Octree::Octant::Octant ( )

Construct a new Octree::Octant object.

Definition at line 358 of file Octree.cpp.

    : m_nPts(-1), m_loc(-1), m_depth(-1), m_id(-1), m_delta(-1), m_centre(3),
      m_bounds(6), m_isLeaf(true)
{
}

◆ Octant() [2/3]

Nektar::FieldUtils::Octree::Octant::Octant	(	int	loc,
		int	depth,
		int	id,
		const Array< OneD, NekDouble > &	bounds
	)

Construct a new Octree::Octant object.

Parameters

loc
depth
id
bounds

Definition at line 372 of file Octree.cpp.

    : m_nPts(0), m_loc(loc), m_depth(depth), m_id(id), m_isLeaf(true)
{
    // Check the size of 'bounds'
    if (bounds.size() != 6)
    {
        throw std::out_of_range("Size of bounds must be 6.");
    }
 
    // If all deltas are not equal, use the largest ones
    NekDouble deltaX = bounds[1] - bounds[0];
    NekDouble deltaY = bounds[3] - bounds[2];
    NekDouble deltaZ = bounds[5] - bounds[4];
    if (deltaX != deltaY || deltaY != deltaZ)
    {
        m_delta = (deltaX > deltaY) ? deltaX : deltaY;
        m_delta = (m_delta > deltaZ) ? m_delta : deltaZ;
    }
    else
    {
        m_delta = deltaX;
    }
 
    // Fill in the rest of the data
    m_centre = Array<OneD, NekDouble>(3);
    m_bounds = Array<OneD, NekDouble>(6);
    for (int i = 0; i < 3; ++i)
    {
        m_centre[i]         = (bounds[2 * i + 1] + bounds[2 * i]) / 2.0;
        m_bounds[2 * i]     = m_centre[i] - m_delta / 2.0;
        m_bounds[2 * i + 1] = m_centre[i] + m_delta / 2.0;
    }
}

References m_bounds, m_centre, and m_delta.

◆ Octant() [3/3]

Nektar::FieldUtils::Octree::Octant::Octant	(	int	loc,
		Octant &	parent
	)

Construct a new Octree::Octant object.

Parameters

loc
parent

Definition at line 413 of file Octree.cpp.

    : m_nPts(0), m_loc(loc), m_id(-1), m_isLeaf(true)
{
    // Set depth
    m_depth = parent.GetDepth() + 1;
 
    // Set delta
    m_delta = parent.GetDelta() / 2.0;
 
    // Set centre
    NekDouble centreDX;
    NekDouble centreDY;
    NekDouble centreDZ;
    switch (loc)
    {
        case 1: // x-, y-, z-
            centreDX = -m_delta / 2.0;
            centreDY = -m_delta / 2.0;
            centreDZ = -m_delta / 2.0;
            break;
        case 2: // x+, y-, z-
            centreDX = m_delta / 2.0;
            centreDY = -m_delta / 2.0;
            centreDZ = -m_delta / 2.0;
            break;
        case 3: // x+, y+, z-
            centreDX = m_delta / 2.0;
            centreDY = m_delta / 2.0;
            centreDZ = -m_delta / 2.0;
            break;
        case 4: // x-, y+, z-
            centreDX = -m_delta / 2.0;
            centreDY = m_delta / 2.0;
            centreDZ = -m_delta / 2.0;
            break;
        case 5: // x-, y-, z+
            centreDX = -m_delta / 2.0;
            centreDY = -m_delta / 2.0;
            centreDZ = m_delta / 2.0;
            break;
        case 6: // x+, y-, z+
            centreDX = m_delta / 2.0;
            centreDY = -m_delta / 2.0;
            centreDZ = m_delta / 2.0;
            break;
        case 7: // x+, y+, z+
            centreDX = m_delta / 2.0;
            centreDY = m_delta / 2.0;
            centreDZ = m_delta / 2.0;
            break;
        case 8: // x-, y+, z+
            centreDX = -m_delta / 2.0;
            centreDY = m_delta / 2.0;
            centreDZ = m_delta / 2.0;
            break;
        default:
            throw std::out_of_range("Loc must be in the range (1,8).");
    }
    Array<OneD, NekDouble> pCentre = parent.GetCentre();
    m_centre                       = Array<OneD, NekDouble>(3);
    m_centre[0]                    = pCentre[0] + centreDX;
    m_centre[1]                    = pCentre[1] + centreDY;
    m_centre[2]                    = pCentre[2] + centreDZ;
 
    // Set bounds
    m_bounds = Array<OneD, NekDouble>(6);
    for (int i = 0; i < 3; ++i)
    {
        m_bounds[2 * i]     = m_centre[i] - m_delta / 2.0;
        m_bounds[2 * i + 1] = m_centre[i] + m_delta / 2.0;
    }
}

References GetCentre(), GetDelta(), GetDepth(), CG_Iterations::loc, m_bounds, m_centre, m_delta, and m_depth.

Member Function Documentation

◆ AddNeighbours()

void Nektar::FieldUtils::Octree::Octant::AddNeighbours ( const std::vector< OctantSharedPtr > & neighbours )

Adds to 'm_neighbours' the octants that are not already in the list.

Parameters

neighbours

Definition at line 526 of file Octree.cpp.

{
    for (const OctantSharedPtr &neighbour : neighbours)
    {
        bool equal = false;
        for (const OctantWeakPtr &neigh : m_neighbours)
        {
            if (neigh.lock()->GetID() == neighbour->GetID())
            {
                equal = true;
                break;
            }
        }
        if (!equal)
        {
            m_neighbours.push_back(neighbour);
        }
    }
}

◆ AddPoints()

void Nektar::FieldUtils::Octree::Octant::AddPoints	(	const Array< OneD, Array< OneD, NekDouble > > &	pts,
		const std::vector< int > &	indices
	)

Adds to 'm_pointInd' the IDs of the points in 'pts' that fall inside the octant.

Parameters

pts
indices

Definition at line 554 of file Octree.cpp.

{
    for (int i : indices)
    {
        // Check if the point is inside the node
        Array<OneD, NekDouble> pt = pts[i];
        if ((pt[0] < m_bounds[0]) || (pt[0] > m_bounds[1]))
        {
            continue;
        }
        if ((pt[1] < m_bounds[2]) || (pt[1] > m_bounds[3]))
        {
            continue;
        }
        if ((pt[2] < m_bounds[4]) || (pt[2] > m_bounds[5]))
        {
            continue;
        }
 
        // If so, add it to the list
        m_nPts++;
        m_pointInd.push_back(i);
 
        // Flag it as a leaf node
        m_isLeaf = true;
    }
}

◆ GetBounds()

Array< OneD, NekDouble > & Nektar::FieldUtils::Octree::Octant::GetBounds ( )

inline

Definition at line 132 of file Octree.h.

        {
            return m_bounds;
        }

References m_bounds.

◆ GetCentre()

Array< OneD, NekDouble > & Nektar::FieldUtils::Octree::Octant::GetCentre ( )

inline

Definition at line 128 of file Octree.h.

        {
            return m_centre;
        }

References m_centre.

Referenced by Octant().

◆ GetChildren()

Array< OneD, OctantSharedPtr > & Nektar::FieldUtils::Octree::Octant::GetChildren ( )

inline

Definition at line 140 of file Octree.h.

        {
            return m_children;
        }

References m_children.

◆ GetDelta()

double Nektar::FieldUtils::Octree::Octant::GetDelta ( ) const

inline

Definition at line 116 of file Octree.h.

        {
            return m_delta;
        }

References m_delta.

Referenced by Octant().

◆ GetDepth()

int Nektar::FieldUtils::Octree::Octant::GetDepth ( ) const

inline

Definition at line 112 of file Octree.h.

        {
            return m_depth;
        }

References m_depth.

Referenced by Octant().

◆ GetID()

int Nektar::FieldUtils::Octree::Octant::GetID ( ) const

inline

Definition at line 120 of file Octree.h.

        {
            return m_id;
        }

References m_id.

◆ GetIndices()

std::vector< int > & Nektar::FieldUtils::Octree::Octant::GetIndices ( )

inline

Definition at line 136 of file Octree.h.

        {
            return m_pointInd;
        }

References m_pointInd.

◆ GetLeaves()

void Nektar::FieldUtils::Octree::Octant::GetLeaves ( std::vector< OctantSharedPtr > & leaves )

Updates 'leaves' so that it contains all the leaf nodes belonging to the octant.

Parameters

leaves

Definition at line 492 of file Octree.cpp.

{
    if (m_isLeaf)
    {
        leaves.push_back(shared_from_this());
    }
    else
    {
        for (OctantSharedPtr child : m_children)
        {
            child->GetLeaves(leaves);
        }
    }
}

◆ GetLoc()

int Nektar::FieldUtils::Octree::Octant::GetLoc ( ) const

inline

Definition at line 108 of file Octree.h.

        {
            return m_loc;
        }

References m_loc.

◆ GetLocInNode()

int Nektar::FieldUtils::Octree::Octant::GetLocInNode ( const Array< OneD, NekDouble > & coords )

Returns the position inside an octant in the range (1-8). The name convention is as follows: let \(\Delta\) be a value between 0 and the length of the side of the father octant, and \(x_c,y_c,z_c\) be the coordinates of the centre of the father node. Then, position 1 corresponds to \(x=x_c-\Delta\), \(y=y_c-\Delta\) and \(y=y_c-\Delta\). The next positions are obtained by rotating counter-clockwise around the Z axis and then, making the same rotation for \(z=z_c+\Delta\).

Parameters

coords

Returns: int

Definition at line 634 of file Octree.cpp.

{
    // Different positions as bits in 'posByte'
    // MSB <==> LSB
    unsigned char posByte;
 
    if (coords[0] <= m_centre[0]) // x-
    {
        posByte = 153; // 0b10011001;
    }
    else // x+
    {
        posByte = 102; // 0b01100110;
    }
    if (coords[1] <= m_centre[1]) // y-
    {
        posByte &= 51; // 0b00110011;
    }
    else // y+
    {
        posByte &= 204; // 0b11001100;
    }
    if (coords[2] <= m_centre[2]) // z-
    {
        posByte &= 15; // 0b00001111;
    }
    else // z+
    {
        posByte &= 240; // 0b11110000;
    }
 
    // Transform into a position in the range (1,8)
    int position = 1;
    while (posByte > 1)
    {
        posByte = posByte >> 1;
        position++;
    }
 
    return position;
}

◆ GetNeighbours()

std::vector< OctantWeakPtr > & Nektar::FieldUtils::Octree::Octant::GetNeighbours ( )

inline

Definition at line 144 of file Octree.h.

        {
            return m_neighbours;
        }

References m_neighbours.

◆ GetNpoints()

int Nektar::FieldUtils::Octree::Octant::GetNpoints ( void ) const

inline

Definition at line 104 of file Octree.h.

        {
            return m_nPts;
        }

References m_nPts.

◆ IsLeaf()

bool Nektar::FieldUtils::Octree::Octant::IsLeaf ( ) const

inline

Definition at line 124 of file Octree.h.

        {
            return m_isLeaf;
        }

References m_isLeaf.

◆ SetID()

void Nektar::FieldUtils::Octree::Octant::SetID ( int id )

inline

Definition at line 149 of file Octree.h.

        {
            m_id = id;
        }

References m_id.

◆ SetIndices()

void Nektar::FieldUtils::Octree::Octant::SetIndices ( const std::vector< int > & indices )

Sets the values of 'm_pointInd' to those in 'indices'.

Parameters

indices

Definition at line 512 of file Octree.cpp.

{
    for (int i : indices)
    {
        m_pointInd.push_back(i);
    }
    m_nPts = indices.size();
}

◆ Subdivide()

void Nektar::FieldUtils::Octree::Octant::Subdivide	(	int	maxPts,
		const Array< OneD, Array< OneD, NekDouble > > &	pts,
		std::vector< OctantSharedPtr > &	nodes
	)

Recursively divides the octant into 8 children and fills the leaf nodes with their corresponding points. Does NOT add neighbours.

Parameters

maxPts
pts
nodes

Definition at line 591 of file Octree.cpp.

{
    // For a non-leaf node
    if (m_nPts > maxPts)
    {
        // Create and fill children RECURSIVELY
        m_children = Array<OneD, OctantSharedPtr>(8);
        for (int i = 0; i < 8; ++i)
        {
            OctantSharedPtr newChild =
                std::make_shared<Octant>(i + 1, *shared_from_this());
            newChild->AddPoints(pts, m_pointInd);
            newChild->SetID(nodes.size()); // ID's start from 0
 
            // Add it to the list
            m_children[i] = newChild;
            nodes.push_back(newChild);
 
            // Keep dividing
            newChild->Subdivide(maxPts, pts, nodes); // Recursion
        }
 
        // Not a leaf node anymore
        m_pointInd.clear();
        m_nPts   = 0;
        m_isLeaf = false;
    }
}

Member Data Documentation

◆ m_bounds

Array<OneD, NekDouble> Nektar::FieldUtils::Octree::Octant::m_bounds

private

Min/max coordinates of the octant (x, y, z)

Definition at line 178 of file Octree.h.

Referenced by GetBounds(), and Octant().

◆ m_centre

Array<OneD, NekDouble> Nektar::FieldUtils::Octree::Octant::m_centre

private

Coordinates of the centre of the octant.

Definition at line 176 of file Octree.h.

Referenced by GetCentre(), and Octant().

◆ m_children

Array<OneD, OctantSharedPtr> Nektar::FieldUtils::Octree::Octant::m_children

private

Vector of pointers to the children octants.

Definition at line 185 of file Octree.h.

Referenced by GetChildren().

◆ m_delta

double Nektar::FieldUtils::Octree::Octant::m_delta

private

Length of the octant side.

Definition at line 174 of file Octree.h.

Referenced by GetDelta(), and Octant().

◆ m_depth

int Nektar::FieldUtils::Octree::Octant::m_depth

private

Depth in octree (root is 1)

Definition at line 170 of file Octree.h.

Referenced by GetDepth(), and Octant().

◆ m_id

int Nektar::FieldUtils::Octree::Octant::m_id

private

ID of the octant (index in 'm_nodes' vector)

Definition at line 172 of file Octree.h.

Referenced by GetID(), and SetID().

◆ m_isLeaf

bool Nektar::FieldUtils::Octree::Octant::m_isLeaf

private

True for a leaf octant, false otherwise.

Definition at line 182 of file Octree.h.

Referenced by IsLeaf().

◆ m_loc

int Nektar::FieldUtils::Octree::Octant::m_loc

private

Position in the father octant (1-8)

Definition at line 168 of file Octree.h.

Referenced by GetLoc().

◆ m_neighbours

std::vector<OctantWeakPtr> Nektar::FieldUtils::Octree::Octant::m_neighbours

private

Vector of pointers to the neighbouring octants.

Definition at line 187 of file Octree.h.

Referenced by GetNeighbours().

◆ m_nPts

int Nektar::FieldUtils::Octree::Octant::m_nPts

private

Number of points in the octant.

Definition at line 166 of file Octree.h.

Referenced by GetNpoints().

◆ m_pointInd

std::vector<int> Nektar::FieldUtils::Octree::Octant::m_pointInd

private

Indices of the points comprised by the octant.

Definition at line 180 of file Octree.h.

Referenced by GetIndices().

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Octant() [1/3]

◆ Octant() [2/3]

◆ Octant() [3/3]

Member Function Documentation

◆ AddNeighbours()

◆ AddPoints()

◆ GetBounds()

◆ GetCentre()

◆ GetChildren()

◆ GetDelta()

◆ GetDepth()

◆ GetID()

◆ GetIndices()

◆ GetLeaves()

◆ GetLoc()

◆ GetLocInNode()

◆ GetNeighbours()

◆ GetNpoints()

◆ IsLeaf()

◆ SetID()

◆ SetIndices()

◆ Subdivide()

Member Data Documentation

◆ m_bounds

◆ m_centre

◆ m_children

◆ m_delta

◆ m_depth

◆ m_id

◆ m_isLeaf

◆ m_loc

◆ m_neighbours

◆ m_nPts

◆ m_pointInd