#include <Entities.hpp>

Public Member Functions
	Entities (const std::string &name)

virtual void	initialize (const std::string &element_type_name, Dictionary &geometry)
	Initialize the Entities using the given type, also setting the nodes in one go. More...

virtual void	create_geometry_space (Dictionary &geometry)
	Set the nodes. More...

virtual	~Entities ()
	Virtual destructor. More...

void	configure_element_type ()
	set the element type More...

ElementType &	element_type () const
	return the elementType More...

Dictionary &	geometry_fields () const
	Const access to the coordinates. More...

common::List< Uint > &	glb_idx ()
	Mutable access to the list of nodes. More...

const common::List< Uint > &	glb_idx () const
	Const access to the list of nodes. More...

common::List< Uint > &	rank ()

const common::List< Uint > &	rank () const

bool	is_ghost (const Uint idx) const

Uint	size () const
	return the number of elements More...

Uint	glb_size () const
	return the number of elements across all processes; More...

Space &	space (const Dictionary &dict)

const Space &	space (const Dictionary &dict) const

std::vector< Handle< Space > >	spaces ()

const std::vector< Handle< Space > >	spaces () const

Space &	create_space (const std::string &shape_function_builder_name, Dictionary &space_fields)

Space &	geometry_space () const

void	resize (const Uint nb_elem)

Uint	entities_idx () const

Handle< ElementConnectivity > &	connectivity_cell2face ()

Handle< FaceCellConnectivity > &	connectivity_face2cell ()

Handle< ElementConnectivity > &	connectivity_cell2cell ()

const Handle< ElementConnectivity > &	connectivity_cell2face () const

const Handle< FaceCellConnectivity > &	connectivity_face2cell () const

const Handle< ElementConnectivity > &	connectivity_cell2cell () const

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 ()
	Get the class name. More...

static common::List< Uint > &	used_nodes (Component &parent, const bool rebuild=false)

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

Protected Attributes
Handle< ElementType >	m_element_type

Handle< Dictionary >	m_geometry_dict

Handle< Space >	m_geometry_space

Handle< common::List< Uint > >	m_global_numbering

Handle< common::Group >	m_spaces_group

std::vector< Handle< Space > >	m_spaces_vector

Handle< common::List< Uint > >	m_rank

Private Attributes
Handle< ElementConnectivity >	m_connectivity_cell2face

Handle< FaceCellConnectivity >	m_connectivity_face2cell

Handle< ElementConnectivity >	m_connectivity_cell2cell

Uint	m_entities_idx
	index as it appears in mesh.elements() More...

Friends
class	Mesh

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

Entities component class This class stores information about a set of elements of the same type

Author: Willem Deconinck, Tiago Quintino, Bart Janssens

Definition at line 35 of file Entities.hpp.

Constructor & Destructor Documentation

Entities ( const std::string & name )

Contructor

Parameters

name	of the component

Definition at line 41 of file Entities.cpp.

~Entities ( )

virtual

Virtual destructor.

Definition at line 68 of file Entities.cpp.

Member Function Documentation

void configure_element_type ( )

set the element type

Definition at line 103 of file Entities.cpp.

Handle<ElementConnectivity>& connectivity_cell2cell ( )

inline

Definition at line 121 of file Entities.hpp.

const Handle<ElementConnectivity>& connectivity_cell2cell ( ) const

inline

Definition at line 124 of file Entities.hpp.

Handle<ElementConnectivity>& connectivity_cell2face ( )

inline

Definition at line 119 of file Entities.hpp.

const Handle<ElementConnectivity>& connectivity_cell2face ( ) const

inline

Definition at line 122 of file Entities.hpp.

Handle<FaceCellConnectivity>& connectivity_face2cell ( )

inline

Definition at line 120 of file Entities.hpp.

const Handle<FaceCellConnectivity>& connectivity_face2cell ( ) const

inline

Definition at line 123 of file Entities.hpp.

void create_geometry_space ( Dictionary & geometry )

virtual

Set the nodes.

Definition at line 81 of file Entities.cpp.

Space & create_space	(	const std::string &	shape_function_builder_name,
		Dictionary &	space_fields
	)

Note: Everything for a space is set-up, except the filling of the connectivity table (size=0xnb_states)

Definition at line 185 of file Entities.cpp.

ElementType & element_type ( ) const

return the elementType

Definition at line 116 of file Entities.cpp.

Uint entities_idx ( ) const

inline

Definition at line 98 of file Entities.hpp.

Dictionary& geometry_fields ( ) const

inline

Const access to the coordinates.

Definition at line 63 of file Entities.hpp.

Space& geometry_space ( ) const

inline

Definition at line 94 of file Entities.hpp.

common::List<Uint>& glb_idx ( )

inline

Mutable access to the list of nodes.

Definition at line 66 of file Entities.hpp.

const common::List<Uint>& glb_idx ( ) const

inline

Const access to the list of nodes.

Definition at line 69 of file Entities.hpp.

Uint glb_size ( ) const

return the number of elements across all processes;

Definition at line 168 of file Entities.cpp.

void initialize	(	const std::string &	element_type_name,
		Dictionary &	geometry
	)

virtual

Initialize the Entities using the given type, also setting the nodes in one go.

Reimplemented in Cells, Edges, and Faces.

Definition at line 74 of file Entities.cpp.

bool is_ghost ( const Uint idx ) const

Definition at line 197 of file Entities.cpp.

common::List<Uint>& rank ( )

inline

Definition at line 71 of file Entities.hpp.

const common::List<Uint>& rank ( ) const

inline

Definition at line 72 of file Entities.hpp.

void resize ( const Uint nb_elem )

Definition at line 246 of file Entities.cpp.

Uint size ( ) const

return the number of elements

Definition at line 161 of file Entities.cpp.

Space & space ( const Dictionary & dict )

Definition at line 148 of file Entities.cpp.

const Space & space ( const Dictionary & dict ) const

Definition at line 155 of file Entities.cpp.

std::vector< Handle<Space> > spaces ( )

inline

Definition at line 88 of file Entities.hpp.

const std::vector< Handle<Space> > spaces ( ) const

inline

Definition at line 90 of file Entities.hpp.

static std::string type_name ( )

inlinestatic

Get the class name.

Definition at line 54 of file Entities.hpp.

common::List< Uint > & used_nodes	(	Component &	parent,
		const bool	rebuild = `false`
	)

static

Deprecated:: Will be removed soon, use mesh/Functions.hpp –> create_used_nodes_list

Definition at line 124 of file Entities.cpp.

Friends And Related Function Documentation

friend class Mesh

friend

Definition at line 37 of file Entities.hpp.

Member Data Documentation

Handle<ElementConnectivity> m_connectivity_cell2cell

private

Definition at line 130 of file Entities.hpp.

Handle<ElementConnectivity> m_connectivity_cell2face

private

Definition at line 128 of file Entities.hpp.

Handle<FaceCellConnectivity> m_connectivity_face2cell

private

Definition at line 129 of file Entities.hpp.

Handle<ElementType> m_element_type

protected

Definition at line 102 of file Entities.hpp.

Uint m_entities_idx

private

index as it appears in mesh.elements()

Definition at line 133 of file Entities.hpp.

Handle<Dictionary> m_geometry_dict

protected

Definition at line 104 of file Entities.hpp.

Handle<Space> m_geometry_space

protected

Definition at line 106 of file Entities.hpp.

Handle<common::List<Uint> > m_global_numbering

protected

Definition at line 108 of file Entities.hpp.

Handle<common::List<Uint> > m_rank

protected

Definition at line 113 of file Entities.hpp.

Handle<common::Group> m_spaces_group

protected

Definition at line 110 of file Entities.hpp.

std::vector< Handle<Space> > m_spaces_vector

protected

Definition at line 111 of file Entities.hpp.

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

cf3/mesh/Entities.hpp
cf3/mesh/Entities.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation