comma::Tree< CoMMAIndexType, CoMMAWeightType, CoMMAIntType > Class Template Reference

Tree structure that represent a coarse cell, the fine cell and the neighbours to them. More...

#include <Tree.h>

Public Types
using	NodeType = Node< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >
	Type of node for the current tree. More...

Public Member Functions
	Tree (std::shared_ptr< NodeType > &root)
	Constructor. More...
	~Tree ()=default
	Destructor. More...
void	insertSon (const CoMMAIndexType &father_index, const CoMMAIndexType &index, const CoMMAWeightType &volume, const CoMMAIntType &root)
	Insert a node as child of a given node. More...
std::shared_ptr< NodeType >	search (std::shared_ptr< NodeType > &node, const CoMMAIndexType &value)
	Look for a node. More...
std::shared_ptr< NodeType >	transverse (std::shared_ptr< NodeType > &node)
	Traverse the tree. More...
void	deleteNode (const CoMMAIndexType &value)
	Delete a node. More...
void	delete_node (std::shared_ptr< NodeType > &searched_node, const CoMMAIndexType &value)
	Delete a node. More...
void	print ()
	Print the tree. More...
void	print_nodes (std::shared_ptr< NodeType > &node)
	Print the branches starting from a given node. More...

Public Attributes
std::shared_ptr< NodeType >	_root
	The Node at the root of the tree. More...

Detailed Description

template<typename CoMMAIndexType, typename CoMMAWeightType, typename CoMMAIntType>
class comma::Tree< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >

Tree structure that represent a coarse cell, the fine cell and the neighbours to them.

Template Parameters

CoMMAIndexType	the CoMMA index type for the global index of the mesh
CoMMAWeightType	the CoMMA weight type for the weights (volume or area) of the nodes or edges of the Mesh
CoMMAIntType	the CoMMA type for integers

Member Typedef Documentation

NodeType

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

using comma::Tree< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::NodeType = Node<CoMMAIndexType, CoMMAWeightType, CoMMAIntType>

Type of node for the current tree.

Constructor & Destructor Documentation

Tree()

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

comma::Tree< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::Tree ( std::shared_ptr< NodeType > &  root )

inlineexplicit

Constructor.

Parameters

[in]

root

A Node which is the root of the Tree

~Tree()

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

comma::Tree< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::~Tree ( )

default

Destructor.

Member Function Documentation

delete_node()

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

void comma::Tree< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::delete_node ( std::shared_ptr< NodeType > &  searched_node, const CoMMAIndexType &  value  )

inline

Delete a node.

Parameters

[in]	searched_node	Where to look
[in]	value	Target

deleteNode()

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

void comma::Tree< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::deleteNode ( const CoMMAIndexType &  value )

inline

Delete a node.

Parameters

[in]

value

Target

insertSon()

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

void comma::Tree< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::insertSon ( const CoMMAIndexType &  father_index, const CoMMAIndexType &  index, const CoMMAWeightType &  volume, const CoMMAIntType &  root  )

inline

Insert a node as child of a given node.

Parameters

[in]	father_index	Index of the parent node
[in]	index	Index of the child
[in]	volume	Volume of the child
[in]	root	Whether it is at the root

print()

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

void comma::Tree< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::print ( )

inline

Print the tree.

print_nodes()

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

void comma::Tree< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::print_nodes ( std::shared_ptr< NodeType > &  node )

inline

Print the branches starting from a given node.

Parameters

[in]

node

Where to start

search()

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

std::shared_ptr< NodeType > comma::Tree< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::search ( std::shared_ptr< NodeType > &  node, const CoMMAIndexType &  value  )

inline

Look for a node.

Parameters

[in]	node	Starting point
[in]	value	Target

Returns

a pointer (possibly null) to the target

transverse()

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

std::shared_ptr< NodeType > comma::Tree< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::transverse ( std::shared_ptr< NodeType > &  node )

inline

Traverse the tree.

Parameters

[in]

node

Where to start the search

Returns

a pointer to a leaf

Member Data Documentation

_root

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

std::shared_ptr<NodeType> comma::Tree< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::_root

The Node at the root of the tree.

---

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

• include/CoMMA/deprecated/Tree.h