#include <binary_tree.h>

Inheritance diagram for oomph::BinaryTreeRoot:

Public Member Functions
	BinaryTreeRoot (RefineableElement *const &object_pt)

	BinaryTreeRoot (const BinaryTreeRoot &dummy)=delete
	Broken copy constructor. More...

void	operator= (const BinaryTreeRoot &)=delete
	Broken assignment operator. More...

int	direction_of_neighbour (BinaryTreeRoot *binary_tree_root_pt)

Public Member Functions inherited from oomph::BinaryTree
virtual	~BinaryTree ()

	BinaryTree (const BinaryTree &dummy)=delete
	Broken copy constructor. More...

void	operator= (const BinaryTree &)=delete
	Broken assignment operator. More...

Tree *	construct_son (RefineableElement const &object_pt, Tree const &father_pt, const int &son_type)

BinaryTree *	gteq_edge_neighbour (const int &direction, Vector< double > &s_in_neighbour, int &edge, int &diff_level, bool &in_neighbouring_tree) const

unsigned	self_test ()

Public Member Functions inherited from oomph::Tree
virtual	~Tree ()

	Tree (const Tree &dummy)=delete
	Broken copy constructor. More...

void	operator= (const Tree &)=delete
	Broken assignment operator. More...

RefineableElement *	object_pt () const

void	flush_object ()
	Flush the object represented by the tree. More...

Tree *	son_pt (const int &son_index) const

void	set_son_pt (const Vector< Tree * > &son_pt)

unsigned	nsons () const
	Return number of sons (zero if it's a leaf node) More...

void	flush_sons ()
	Flush the sons. More...

TreeRoot *&	root_pt ()
	Return pointer to root of the tree. More...

TreeRoot *	root_pt () const
	Return pointer to root of the tree (const version) More...

template<class ELEMENT >
void	split_if_required ()

template<class ELEMENT >
void	p_refine_if_required (Mesh *&mesh_pt)

void	merge_sons_if_required (Mesh *&mesh_pt)

void	deactivate_object ()
	Call the RefineableElement's deactivate_element() function. More...

void	traverse_all (Tree::VoidMemberFctPt member_function)

void	traverse_all (Tree::VoidMeshPtArgumentMemberFctPt member_function, Mesh *&mesh_pt)

void	traverse_all_but_leaves (Tree::VoidMemberFctPt member_function)

void	traverse_leaves (Tree::VoidMemberFctPt member_function)

void	traverse_leaves (Tree::VoidMeshPtArgumentMemberFctPt member_function, Mesh *&mesh_pt)

void	stick_leaves_into_vector (Vector< Tree * > &)
	Traverse tree and stick pointers to leaf "nodes" (only) into Vector. More...

void	stick_all_tree_nodes_into_vector (Vector< Tree * > &)
	Traverse and stick pointers to all "nodes" into Vector. More...

int	son_type () const
	Return son type. More...

bool	is_leaf ()
	Return true if the tree is a leaf node. More...

Tree *	father_pt () const
	Return pointer to father: NULL if it's a root node. More...

void	set_father_pt (Tree *const &father_pt)
	Set the father. More...

unsigned	level () const
	Return the level of the Tree (root=0) More...

Public Member Functions inherited from oomph::TreeRoot
	TreeRoot (RefineableElement *const &object_pt)
	Constructor for the (empty) root tree. More...

	TreeRoot (const TreeRoot &dummy)=delete
	Broken copy constructor. More...

void	operator= (const TreeRoot &)=delete
	Broken assignment operator. More...

TreeRoot *&	neighbour_pt (const int &direction)

bool	is_neighbour_periodic (const int &direction)

void	set_neighbour_periodic (const int &direction)
	Set the neighbour in particular direction to be periodic. More...

void	set_neighbour_nonperiodic (const int &direction)
	Set the neighbour in particular direction to be nonperiodic. More...

unsigned	nneighbour ()
	Return the number of neighbours. More...

Additional Inherited Members
Public Types inherited from oomph::Tree
typedef void(Tree::*	VoidMemberFctPt) ()
	Function pointer to argument-free void Tree member function. More...

typedef void(Tree::*	VoidMeshPtArgumentMemberFctPt) (Mesh *&mesh_pt)

Static Public Member Functions inherited from oomph::BinaryTree
static void	setup_static_data ()
	Set up the static data, reflection schemes, etc. More...

static void	doc_neighbours (Vector< Tree * > forest_nodes_pt, std::ofstream &neighbours_file, std::ofstream &neighbours_txt_file, double &max_error)

Static Public Member Functions inherited from oomph::Tree
static double &	max_neighbour_finding_tolerance ()

Static Public Attributes inherited from oomph::BinaryTree
static Vector< std::string >	Direct_string
	Translate (enumerated) directions into strings. More...

Static Public Attributes inherited from oomph::Tree
static const int	OMEGA = 26
	Default value for an unassigned neighbour. More...

Protected Member Functions inherited from oomph::BinaryTree
	BinaryTree ()
	Default constructor (empty and broken) More...

	BinaryTree (RefineableElement *const &object_pt)

	BinaryTree (RefineableElement const &object_pt, Tree const &father_pt, const int &son_type)

Protected Member Functions inherited from oomph::Tree
	Tree ()
	Default constructor (empty and broken) More...

	Tree (RefineableElement *const &object_pt)

	Tree (RefineableElement const &object_pt, Tree const &father_pt, const int &son_type)

Protected Attributes inherited from oomph::Tree
TreeRoot *	Root_pt
	Pointer to the root of the tree. More...

Tree *	Father_pt
	Pointer to the Father of the Tree. More...

Vector< Tree * >	Son_pt
	Vector of pointers to the sons of the Tree. More...

int	Level
	Level of the Tree (level 0 = root) More...

int	Son_type
	Son type (e.g. SW/SE/NW/NE in a quadtree) More...

RefineableElement *	Object_pt
	Pointer to the object represented by the tree. More...

Protected Attributes inherited from oomph::TreeRoot
std::map< int, TreeRoot * >	Neighbour_pt

std::map< int, bool >	Neighbour_periodic

Static Protected Attributes inherited from oomph::BinaryTree
static bool	Static_data_has_been_setup = false
	Boolean indicating that static member data has been setup. More...

Static Protected Attributes inherited from oomph::Tree
static double	Max_neighbour_finding_tolerance = 1.0e-14

Detailed Description

BinaryTreeRoot is a BinaryTree that forms the root of a (recursive) binary tree. The "root node" is special as it holds additional information about its neighbours.

Constructor & Destructor Documentation

◆ BinaryTreeRoot() [1/2]

oomph::BinaryTreeRoot::BinaryTreeRoot ( RefineableElement *const & object_pt )

inline

Constructor for the (empty) root binary tree: Pass pointer to associated object, a RefineableQElement<1>.

       : Tree(object_pt), BinaryTree(object_pt), TreeRoot(object_pt)
     {
 #ifdef PARANOID
       // Check that static member data has been setup
       if (!Static_data_has_been_setup)
       {
         std::string error_message =
           "Static member data hasn't been setup yet.\n";
         error_message +=
           "Call BinaryTree::setup_static_data() before creating\n";
         error_message += "any BinaryTreeRoots\n";
  
         throw OomphLibError(
           error_message, OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
       }
 #endif
     }

References OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, oomph::BinaryTree::Static_data_has_been_setup, and oomph::Global_string_for_annotation::string().

◆ BinaryTreeRoot() [2/2]

oomph::BinaryTreeRoot::BinaryTreeRoot ( const BinaryTreeRoot & dummy )

delete

Broken copy constructor.

Member Function Documentation

◆ direction_of_neighbour()

int oomph::BinaryTreeRoot::direction_of_neighbour ( BinaryTreeRoot * binary_tree_root_pt )

inline

If binary_tree_root_pt is a neighbour, return the direction (L/R) in which it is found, otherwise return OMEGA

     {
       using namespace BinaryTreeNames;
  
       if (Neighbour_pt[L] == binary_tree_root_pt)
       {
         return L;
       }
       if (Neighbour_pt[R] == binary_tree_root_pt)
       {
         return R;
       }
  
       // If we get here, it's not a neighbour
       return OMEGA;
     }

References L, oomph::TreeRoot::Neighbour_pt, oomph::Tree::OMEGA, and R.

◆ operator=()

void oomph::BinaryTreeRoot::operator= ( const BinaryTreeRoot & )

delete

Broken assignment operator.

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

binary_tree.h

Public Member Functions