#include <Dictionary.hpp>

Inherited by ContinuousDictionary, and DiscontinuousDictionary.

Public Types
typedef common::Map< boost::uint64_t, Uint >	GlbToLocT
	Type for the mapping from global to local IDs. More...

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 Member Functions
	Dictionary (const std::string &name)

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

Field &	create_field (const std::string &name, const Uint cols)
	Create a new field in this group. More...

Field &	create_field (const std::string &name, const VarType var_type=SCALAR)
	Create a new field in this group. More...

Field &	create_field (const std::string &name, const std::string &variables_description)
	Create a new field in this group. More...

Field &	create_field (const std::string &name, math::VariablesDescriptor &variables_descriptor)
	Create a new field in this group. More...

Uint	size () const
	Number of rows of contained fields. More...

void	resize (const Uint size)
	Resize the contained fields. More...

const Space &	space (const Entities &entities) const
	Return the space of given entities. More...

const Handle< Space const > &	space (const Handle< Entities const > &entities) const
	Return the space of given entities. More...

common::List< Uint > &	glb_idx ()
	Return the global index of every field row. More...

const common::List< Uint > &	glb_idx () const
	Return the global index of every field row. More...

common::List< Uint > &	rank ()
	Return the rank of every field row. More...

const common::List< Uint > &	rank () const
	Return the rank of every field row. More...

const GlbToLocT &	glb_to_loc () const
	Return a mapping between global and local indices. More...

const common::DynTable< SpaceElem > &	connectivity () const
	Node to space-element connectivity. More...

common::PE::CommPattern &	comm_pattern ()
	Return the comm pattern valid for this field group. Created based on the glb_idx and rank if it didn't exist already. More...

bool	is_ghost (const Uint idx) const
	Check if a field row is owned by this rank. More...

bool	check_sanity (std::vector< std::string > &messages) const
	Check if all fields are compatible. More...

bool	check_sanity () const

const std::vector< Handle< Entities > > &	entities_range () const

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

Field &	field (const std::string &name)

const Field &	coordinates () const

Field &	coordinates ()

const std::vector< Handle< Field > > &	fields () const

common::DynTable< Uint > &	glb_elem_connectivity ()

void	signal_create_field (common::SignalArgs &node)

void	signature_create_field (common::SignalArgs &node)

bool	defined_for_entities (const Handle< Entities const > &entities) const

void	add_space (const Handle< Space > &space)

void	update_structures ()

bool	continuous () const

bool	discontinuous () const

void	rebuild_map_glb_to_loc ()

void	build ()

virtual void	rebuild_spaces_from_geometry ()=0

virtual void	rebuild_node_to_element_connectivity ()=0

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 Public Member Functions inherited from Component
static std::string	type_name ()
	Get the class name. More...

Protected Member Functions
bool	has_coordinates () const

Field &	create_coordinates ()

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...

Protected Attributes
Handle< common::List< Uint > >	m_glb_idx

Handle< common::List< Uint > >	m_rank

Handle< Field >	m_coordinates

Handle< common::DynTable< Uint > >	m_glb_elem_connectivity

Handle< common::PE::CommPattern >	m_comm_pattern

Handle< GlbToLocT >	m_glb_to_loc

bool	m_is_continuous

Handle< common::DynTable< SpaceElem > >	m_connectivity
	Connectivity with the element of the space. More...

Private Member Functions
void	config_space ()

void	config_topology ()

void	config_regions ()

void	config_type ()

Private Attributes
std::map< Handle< Entities const >, Handle< Space const > >	m_spaces_map

std::map< Entities const *, Handle< Space const > >	m_raw_spaces_map

std::vector< Handle< Space > >	m_spaces

std::vector< Handle< Entities > >	m_entities

std::vector< Handle< Field > >	m_fields

Uint	m_dim

Friends
class	Mesh

Additional Inherited Members
Public Attributes inherited from SignalHandler
storage_t	m_signals
	storage of the signals More...

Detailed Description

Component that holds Fields of the same type (topology and space)

Author: Willem Deconinck

Definition at line 38 of file Dictionary.hpp.

Member Typedef Documentation

typedef common::Map<boost::uint64_t,Uint> GlbToLocT

Type for the mapping from global to local IDs.

Definition at line 47 of file Dictionary.hpp.

Constructor & Destructor Documentation

Dictionary ( const std::string & name )

Contructor

Parameters

name	of the component

Definition at line 54 of file Dictionary.cpp.

~Dictionary ( )

virtual

Virtual destructor.

Definition at line 93 of file Dictionary.cpp.

Member Function Documentation

void add_space ( const Handle< Space > & space )

Definition at line 86 of file Dictionary.cpp.

void build ( )

Definition at line 375 of file Dictionary.cpp.

bool check_sanity ( std::vector< std::string > & messages ) const

Check if all fields are compatible.

Definition at line 272 of file Dictionary.cpp.

bool check_sanity ( ) const

Definition at line 334 of file Dictionary.cpp.

CommPattern & comm_pattern ( )

Return the comm pattern valid for this field group. Created based on the glb_idx and rank if it didn't exist already.

Definition at line 136 of file Dictionary.cpp.

void config_regions ( )

private

void config_space ( )

private

void config_topology ( )

private

void config_type ( )

private

const common::DynTable<SpaceElem>& connectivity ( ) const

inline

Node to space-element connectivity.

Definition at line 99 of file Dictionary.hpp.

bool continuous ( ) const

inline

Definition at line 135 of file Dictionary.hpp.

const Field & coordinates ( ) const

Definition at line 481 of file Dictionary.cpp.

Field & coordinates ( )

Definition at line 463 of file Dictionary.cpp.

Field & create_coordinates ( )

protected

Definition at line 490 of file Dictionary.cpp.

Field & create_field	(	const std::string &	name,
		const Uint	cols
	)

Create a new field in this group.

Definition at line 178 of file Dictionary.cpp.

Field & create_field	(	const std::string &	name,
		const VarType	var_type = `SCALAR`
	)

Create a new field in this group.

Definition at line 197 of file Dictionary.cpp.

Field & create_field	(	const std::string &	name,
		const std::string &	variables_description
	)

Create a new field in this group.

Definition at line 224 of file Dictionary.cpp.

Field & create_field	(	const std::string &	name,
		math::VariablesDescriptor &	variables_descriptor
	)

Create a new field in this group.

Definition at line 243 of file Dictionary.cpp.

bool defined_for_entities ( const Handle< Entities const > & entities ) const

Definition at line 449 of file Dictionary.cpp.

bool discontinuous ( ) const

inline

Definition at line 137 of file Dictionary.hpp.

const std::vector< Handle< Entities > > & entities_range ( ) const

Definition at line 353 of file Dictionary.cpp.

Field & field ( const std::string & name )

Definition at line 367 of file Dictionary.cpp.

const std::vector< Handle<Field> >& fields ( ) const

inline

Definition at line 121 of file Dictionary.hpp.

DynTable< Uint > & glb_elem_connectivity ( )

Definition at line 537 of file Dictionary.cpp.

common::List<Uint>& glb_idx ( )

inline

Return the global index of every field row.

Definition at line 84 of file Dictionary.hpp.

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

inline

Return the global index of every field row.

Definition at line 87 of file Dictionary.hpp.

const GlbToLocT& glb_to_loc ( ) const

inline

Return a mapping between global and local indices.

Definition at line 96 of file Dictionary.hpp.

bool has_coordinates ( ) const

protected

Definition at line 456 of file Dictionary.cpp.

bool is_ghost ( const Uint idx ) const

Check if a field row is owned by this rank.

Definition at line 151 of file Dictionary.cpp.

common::List<Uint>& rank ( )

inline

Return the rank of every field row.

Definition at line 90 of file Dictionary.hpp.

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

inline

Return the rank of every field row.

Definition at line 93 of file Dictionary.hpp.

void rebuild_map_glb_to_loc ( )

Definition at line 438 of file Dictionary.cpp.

virtual void rebuild_node_to_element_connectivity ( )

pure virtual

Implemented in ContinuousDictionary, and DiscontinuousDictionary.

virtual void rebuild_spaces_from_geometry ( )

pure virtual

Note: This is a function only for non-geometry spaces.

Implemented in ContinuousDictionary, and DiscontinuousDictionary.

void resize ( const Uint size )

Resize the contained fields.

Definition at line 106 of file Dictionary.cpp.

void signal_create_field ( common::SignalArgs & node )

Definition at line 569 of file Dictionary.cpp.

void signature_create_field ( common::SignalArgs & node )

Definition at line 552 of file Dictionary.cpp.

Uint size ( ) const

Number of rows of contained fields.

Definition at line 99 of file Dictionary.cpp.

const Space & space ( const Entities & entities ) const

Return the space of given entities.

Definition at line 161 of file Dictionary.cpp.

const Handle< Space const > & space ( const Handle< Entities const > & entities ) const

Return the space of given entities.

Definition at line 170 of file Dictionary.cpp.

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

Definition at line 360 of file Dictionary.cpp.

static std::string type_name ( )

inlinestatic

Get the class name.

Definition at line 57 of file Dictionary.hpp.

void update_structures ( )

Definition at line 386 of file Dictionary.cpp.

Friends And Related Function Documentation

friend class Mesh

friend

Todo:: find workaround for following hack

Definition at line 41 of file Dictionary.hpp.

Member Data Documentation

Handle<common::PE::CommPattern> m_comm_pattern

protected

Definition at line 169 of file Dictionary.hpp.

Handle<common::DynTable<SpaceElem> > m_connectivity

protected

Connectivity with the element of the space.

Definition at line 174 of file Dictionary.hpp.

Handle<Field> m_coordinates

protected

Definition at line 167 of file Dictionary.hpp.

Uint m_dim

private

Definition at line 185 of file Dictionary.hpp.

std::vector< Handle<Entities> > m_entities

private

Definition at line 182 of file Dictionary.hpp.

std::vector< Handle<Field> > m_fields

private

Definition at line 183 of file Dictionary.hpp.

Handle<common::DynTable<Uint> > m_glb_elem_connectivity

protected

Definition at line 168 of file Dictionary.hpp.

Handle<common::List<Uint> > m_glb_idx

protected

Definition at line 165 of file Dictionary.hpp.

Handle<GlbToLocT> m_glb_to_loc

protected

Definition at line 170 of file Dictionary.hpp.

bool m_is_continuous

protected

Definition at line 171 of file Dictionary.hpp.

Handle<common::List<Uint> > m_rank

protected

Definition at line 166 of file Dictionary.hpp.

std::map< Entities const* , Handle<Space const> > m_raw_spaces_map

private

Definition at line 179 of file Dictionary.hpp.

std::vector< Handle<Space > > m_spaces

private

Definition at line 181 of file Dictionary.hpp.

std::map< Handle<Entities const> , Handle<Space const> > m_spaces_map

private

Definition at line 178 of file Dictionary.hpp.

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

cf3/mesh/Dictionary.hpp
cf3/mesh/Dictionary.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation