Octtree Class Reference

#include <Octtree.hpp>

Inherits Component.

Public Member Functions
	Octtree (const std::string &name)
	constructor More...
void	create_octtree ()
Entity	find_element (const RealVector &target_coord)
	Find which element contains a given coordinate. More...
virtual bool	find_element (const RealVector &target_coord, Entity &element)
	Find which element contains a given coordinate. More...
bool	find_octtree_cell (const RealVector &coordinate, std::vector< Uint > &octtree_idx)
void	gather_elements_around_idx (const std::vector< Uint > &octtree_idx, const Uint ring, std::vector< Entity > &element_pool)
void	find_cell_ranks (const boost::multi_array< Real, 2 > &coordinates, std::vector< Uint > &ranks)
bool	is_created () const
const Uint	dimension ()
Public Member Functions inherited from Component
	Component (const std::string &name)
virtual	~Component ()
	Virtual destructor. More...
const std::string &	name () const
	Access the name of the component. More...
void	rename (const std::string &name)
	Rename the component. More...
URI	uri () const
	Construct the full path. More...
void	complete_path (URI &path) const
Handle< Component >	access_component (const URI &path) const
Handle< Component >	access_component_checked (const URI &path)
Handle< Component const >	access_component_checked (const URI &path) const
Handle< Component >	handle ()
	Get a handle to the component. More...
Handle< Component const >	handle () const
template<typename ComponentT >
Handle< ComponentT >	handle ()
template<typename ComponentT >
Handle< ComponentT const >	handle () const
Handle< Component >	parent () const
Handle< Component const >	root () const
Handle< Component >	root ()
Handle< Component >	get_child (const std::string &name)
Handle< Component const >	get_child (const std::string &name) const
Handle< Component >	get_child_checked (const std::string &name)
Handle< Component const >	get_child_checked (const std::string &name) const
Handle< Component >	create_component (const std::string &name, const std::string &builder)
	Build a (sub)component of this component using the extended type_name of the component. More...
template<typename T >
Handle< T >	create_component (const std::string &name)
	Create a (sub)component of this component automatically cast to the specified type. More...
template<typename T >
Handle< T >	create_static_component (const std::string &name)
	Create a static "always there" subcomponent. More...
Component &	add_component (const boost::shared_ptr< Component > &subcomp)
	Add the passed component as a subcomponent. More...
void	add_link (Component &linked_component)
boost::shared_ptr< Component >	remove_component (const std::string &name)
	Remove a (sub)component of this component. More...
boost::shared_ptr< Component >	remove_component (Component &subcomp)
	Remove a (sub)component of this component. More...
void	clear ()
	Remove all sub-components of this component, except for the static ones. More...
void	move_to (Component &to_parent)
std::string	tree (bool basic_mode=false, Uint depth=0, Uint recursion_level=0) const
std::string	info (const std::string &what=std::string("cospt")) const
size_t	count_children () const
virtual std::string	derived_type_name () const =0
PropertyList &	properties ()
const PropertyList &	properties () const
OptionList &	options ()
const OptionList &	options () const
void	reset_options ()
	Reset all options to their default value. More...
void	configure_option_recursively (const std::string &optname, const boost::any &val)
Component &	mark_basic ()
	marks this component as basic. More...
template<typename ComponentT >
void	put_components (std::vector< boost::shared_ptr< ComponentT > > &vec, const bool recurse)
template<typename ComponentT >
void	put_components (std::vector< boost::shared_ptr< ComponentT const > > &vec, const bool recurse) const
template<>
void	put_components (std::vector< boost::shared_ptr< Component > > &vec, const bool recurse)
template<>
void	put_components (std::vector< boost::shared_ptr< Component const > > &vec, const bool recurse) const
Component::iterator	begin ()
	The begin iterator for a range containing Components. More...
Component::iterator	end ()
	The end iterator for a range containing Components. More...
Component::const_iterator	begin () const
	The begin iterator for a range containing Components (const version) More...
Component::const_iterator	end () const
	The end iterator for a range containing Components (const version) More...
Component::iterator	recursive_begin ()
	The begin iterator for a recursive range containing Components. More...
Component::iterator	recursive_end ()
	The end iterator for a recursive range containing Components. More...
Component::const_iterator	recursive_begin () const
	The begin iterator for a recursive range containing Components (const version) More...
Component::const_iterator	recursive_end () const
	The end iterator for a recursive range containing Components (const version) More...
template<typename T >
Handle< T >	create_component (const std::string &name, const std::string &builder)
	Create a component using the reduced builder name. More...
void	signal_configure (SignalArgs &args)
	configures all the options on this class More...
void	signal_create_component (SignalArgs &args)
	creates a component from this component More...
void	signal_delete_component (SignalArgs &args)
	delete this component More...
void	signal_move_component (SignalArgs &args)
	moves a component from this component to another More...
void	signal_list_tree (SignalArgs &args) const
	lists the sub components and puts them on the xml_tree More...
void	signal_list_tree_recursive (SignalArgs &args) const
	prints tree recursively More...
void	signal_list_properties (SignalArgs &args) const
	lists the properties of this component More...
void	signal_list_options (SignalArgs &args) const
	lists the properties of this component More...
void	signal_list_options_recursive (SignalArgs &args) const
	prints all options recursive More...
void	signal_list_signals (SignalArgs &args) const
	lists the signals of this component More...
void	signal_list_signals_recursive (SignalArgs &args) const
	prints all signals recursive More...
void	signal_print_info (SignalArgs &args) const
	gets info on this component More...
void	signal_print_tree (SignalArgs &args) const
	signal to print the tree More...
void	signature_print_tree (SignalArgs &args) const
	signature to signal_print_tree More...
void	signal_rename_component (SignalArgs &args)
	renames this component More...
void	signal_save_tree (SignalArgs &args)
	dumps the tree to a file More...
void	signal_list_content (SignalArgs &args)
	gives information about this component such as options, signals, ... More...
void	signal_signature (SignalArgs &args)
	Gives a signal signature, if any. More...
void	signature_create_component (SignalArgs &args)
void	signature_rename_component (SignalArgs &args)
void	signature_move_component (SignalArgs &args)
void	signal_store_timings (SignalArgs &args)
	Signal to store the timings (if enabled) into properties, i.e. for readout from python or the GUI. More...
void	signal_clear (SignalArgs &args)
	Signal to remove all sub-components. More...
void	signal_reset_options (SignalArgs &args)
	Signal to set all options to their default value. More...
void	signal_add_tag (SignalArgs &args)
	Signal to add a tag. More...
void	signature_add_tag (SignalArgs &args)
Public Member Functions inherited from SignalHandler
	~SignalHandler ()
const storage_t &	signal_list () const
SignalPtr	signal (const SignalID &sname)
SignalCPtr	signal (const SignalID &sname) const
SignalRet	call_signal (const SignalID &sname, SignalArgs &sinput)
	Calls the signal by providing its name and input. More...
SignalRet	call_signal (const SignalID &sname, std::vector< std::string > &sinput)
	Calls the signal by providing its name and input. More...
bool	signal_exists (const SignalID &sname) const
	Checks if a signal exists or not. More...
Signal &	regist_signal (const SignalID &sname)
	Regist signal. More...
void	unregist_signal (const SignalID &sname)
	Unregist signal. More...
Public Member Functions inherited from ConnectionManager
	~ConnectionManager ()
	destructor closes all connections More...
Connection *	connection (const std::string &name)
Connection *	manage_connection (const std::string &name)
	manages a connection (creates if necessary) More...
Public Member Functions inherited from TaggedObject
	TaggedObject ()
	Constructor. More...
bool	has_tag (const std::string &tag) const
void	add_tag (const std::string &tag)
std::vector< std::string >	get_tags () const
void	remove_tag (const std::string &tag)

Static Public Member Functions
static std::string	type_name ()
	Gets the Class name. More...
Static Public Member Functions inherited from Component
static std::string	type_name ()
	Get the class name. More...

Private Types
typedef std::pair< const Elements *, Uint >	Point
typedef boost::multi_array< std::vector< Entity >,3 >	ArrayT
typedef std::vector< const Point * >	Pointcloud

Private Attributes
ArrayT	m_octtree
Uint	m_dim
std::vector< Uint >	m_N
std::vector< Real >	m_D
Handle< Mesh >	m_mesh
std::vector< Uint >	m_octtree_idx
std::vector< Entity >	m_elements_pool
math::BoundingBox	m_bounding_box

Additional Inherited Members
Public Types inherited from Component
typedef ComponentIterator< Component >	iterator
	type of the iterator to Component More...
typedef ComponentIterator< Component const >	const_iterator
	type of the iterator to constant Component More...
Public Types inherited from SignalHandler
typedef std::vector< SignalPtr >	storage_t
	storage type for signals More...
Public Attributes inherited from SignalHandler
storage_t	m_signals
	storage of the signals More...
Protected Member Functions inherited from Component
Component &	add_static_component (const boost::shared_ptr< Component > &subcomp)
	Add a static (sub)component of this component. More...
void	raise_tree_updated_event ()
	raise event that the path has changed More...

Detailed Description

This class defines neutral mesh format reader

Author

Willem Deconinck

Definition at line 31 of file Octtree.hpp.

Member Typedef Documentation

typedef boost::multi_array<std::vector<Entity> ,3> ArrayT

private

Definition at line 37 of file Octtree.hpp.

typedef std::pair<const Elements*,Uint> Point

private

Definition at line 36 of file Octtree.hpp.

typedef std::vector<const Point*> Pointcloud

private

Definition at line 38 of file Octtree.hpp.

Constructor & Destructor Documentation

Octtree

(

const std::string &

name

)

constructor

Definition at line 52 of file Octtree.cpp.

Member Function Documentation

void create_octtree

(

)

Definition at line 76 of file Octtree.cpp.

const Uint dimension ( )

inline

Definition at line 76 of file Octtree.hpp.

void find_cell_ranks	(	const boost::multi_array< Real, 2 > &	coordinates,
		std::vector< Uint > &	ranks
	)

Definition at line 187 of file Octtree.cpp.

Entity find_element

(

const RealVector &

target_coord

)

Find which element contains a given coordinate.

Parameters

target_coord

[in] the given coordinate

Returns

the elements region, and the local coefficient in this region

Definition at line 405 of file Octtree.cpp.

bool find_element ( const RealVector &  target_coord, Entity &  element  )

virtual

Find which element contains a given coordinate.

Returns

if element was found

Definition at line 414 of file Octtree.cpp.

bool find_octtree_cell	(	const RealVector &	coordinate,
		std::vector< Uint > &	octtree_idx
	)

Given a coordinate, find which box in the octtree it is located in

Parameters

coordinate	[in] The coordinate to look for
octtree_idx	[out] location of the box (i,j,k) in which the coordinate sits

Returns

true if the coordinate is found inside the honeycomb

Definition at line 274 of file Octtree.cpp.

void gather_elements_around_idx	(	const std::vector< Uint > &	octtree_idx,
		const Uint	ring,
		std::vector< Entity > &	element_pool
	)

Assemble the elements in and around a given octtree_idx (i,j,k) It is assumed that first "find_comb_idx(coordinate)" is called

Parameters

octtree_idx	[in] the minimum number of points in the point cloud
ring	[in] the ring of indexes around octtree_idx to look for elements. Elements inside the ring are not looked for, only the ring itself.
unified_elems	[out] the elements are pushed back in this vector. Nothing gets erased, it only grows.

Note

subsequent calls with increasing value for ring starting from 0, will assemble everything within the last passed ring value.

Definition at line 300 of file Octtree.cpp.

bool is_created ( ) const

inline

Definition at line 74 of file Octtree.hpp.

static std::string type_name ( )

inlinestatic

Gets the Class name.

Definition at line 45 of file Octtree.hpp.

Member Data Documentation

math::BoundingBox m_bounding_box

private

Definition at line 92 of file Octtree.hpp.

std::vector<Real> m_D

private

Definition at line 84 of file Octtree.hpp.

Uint m_dim

private

Definition at line 82 of file Octtree.hpp.

std::vector<Entity> m_elements_pool

private

Definition at line 90 of file Octtree.hpp.

Handle<Mesh> m_mesh

private

Definition at line 86 of file Octtree.hpp.

std::vector<Uint> m_N

private

Definition at line 83 of file Octtree.hpp.

ArrayT m_octtree

private

Definition at line 80 of file Octtree.hpp.

std::vector<Uint> m_octtree_idx

private

Definition at line 88 of file Octtree.hpp.

---

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

• cf3/mesh/Octtree.hpp
• cf3/mesh/Octtree.cpp