#include <FaceCellConnectivity.hpp>

Inherits Component.

Public Types
enum	FaceOrientation { MATCHED =0, INVERTED =1 }

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

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

void	setup (Region &region)

void	build_connectivity ()

ElementConnectivity &	connectivity ()
	const access to the node to element connectivity table in unified indices More...

const ElementConnectivity &	connectivity () const

common::List< bool > &	is_bdry_face ()
	access to see if the face is a bdry face More...

const common::List< bool > &	is_bdry_face () const

common::Table< Uint > &	face_number ()

const common::Table< Uint > &	face_number () const

common::Table< Uint > &	cell_rotation ()

const common::Table< Uint > &	cell_rotation () const

common::Table< bool > &	cell_orientation ()

const common::Table< bool > &	cell_orientation () const

Uint	size () const

std::vector< Uint >	face_nodes (const Uint face) const

std::vector< Handle< Component > >	used ()

void	add_used (Component &used_comp)

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

Private Attributes
Uint	m_nb_faces
	nb_faces More...

Handle< common::Group >	m_used_components
	unified view of the elements More...

Handle< ElementConnectivity >	m_connectivity
	Actual connectivity table. More...

Handle< common::Table< Uint > >	m_face_nb_in_elem

Handle< common::List< bool > >	m_is_bdry_face

Handle< common::Table< bool > >	m_cell_orientation

Handle< common::Table< Uint > >	m_cell_rotation

bool	m_face_building_algorithm

Additional Inherited Members
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

Stores connectivity data between faces and their adjacent elements and provides a convenient API to access the data

Author: Andrea Lani; Willem Deconinck

Definition at line 34 of file FaceCellConnectivity.hpp.

Member Enumeration Documentation

enum FaceOrientation

Enumerator
MATCHED
INVERTED

Definition at line 38 of file FaceCellConnectivity.hpp.

Constructor & Destructor Documentation

FaceCellConnectivity ( const std::string & name )

Contructor

Parameters

name	of the component

Definition at line 42 of file FaceCellConnectivity.cpp.

virtual ~FaceCellConnectivity ( )

inlinevirtual

Virtual destructor.

Definition at line 47 of file FaceCellConnectivity.hpp.

Member Function Documentation

void add_used ( Component & used_comp )

Definition at line 92 of file FaceCellConnectivity.cpp.

void build_connectivity ( )

Build the connectivity table Build the connectivity table as a DynTable<Uint>

Precondition: set_nodes() and set_elements() must have been called

Definition at line 111 of file FaceCellConnectivity.cpp.

common::Table<bool>& cell_orientation ( )

inline

Definition at line 86 of file FaceCellConnectivity.hpp.

const common::Table<bool>& cell_orientation ( ) const

inline

Definition at line 88 of file FaceCellConnectivity.hpp.

common::Table<Uint>& cell_rotation ( )

inline

Definition at line 82 of file FaceCellConnectivity.hpp.

const common::Table<Uint>& cell_rotation ( ) const

inline

Definition at line 84 of file FaceCellConnectivity.hpp.

ElementConnectivity& connectivity ( )

inline

const access to the node to element connectivity table in unified indices

Definition at line 69 of file FaceCellConnectivity.hpp.

const ElementConnectivity& connectivity ( ) const

inline

Definition at line 71 of file FaceCellConnectivity.hpp.

std::vector< Uint > face_nodes ( const Uint face ) const

Definition at line 361 of file FaceCellConnectivity.cpp.

common::Table<Uint>& face_number ( )

inline

Definition at line 78 of file FaceCellConnectivity.hpp.

const common::Table<Uint>& face_number ( ) const

inline

Definition at line 80 of file FaceCellConnectivity.hpp.

common::List<bool>& is_bdry_face ( )

inline

access to see if the face is a bdry face

Definition at line 74 of file FaceCellConnectivity.hpp.

const common::List<bool>& is_bdry_face ( ) const

inline

Definition at line 76 of file FaceCellConnectivity.hpp.

void setup ( Region & region )

setup the node to element connectivity This function calls

set_nodes(nodes)
set_elements(elements_range)
build_connectivity They could be called seperately if wanted
Postcondition
all access functions can be used after setup

Parameters

[in] region The region a face cell connectivity will be built from

Definition at line 68 of file FaceCellConnectivity.cpp.

Uint size ( ) const

Definition at line 66 of file FaceCellConnectivity.cpp.

static std::string type_name ( )

inlinestatic

Get the class name.

Definition at line 50 of file FaceCellConnectivity.hpp.

std::vector< Handle< Component > > used ( )

Definition at line 80 of file FaceCellConnectivity.cpp.

Member Data Documentation

Handle< common::Table<bool> > m_cell_orientation

private

Definition at line 113 of file FaceCellConnectivity.hpp.

Handle< common::Table<Uint> > m_cell_rotation

private

Definition at line 115 of file FaceCellConnectivity.hpp.

Handle<ElementConnectivity> m_connectivity

private

Actual connectivity table.

Definition at line 107 of file FaceCellConnectivity.hpp.

bool m_face_building_algorithm

private

Definition at line 117 of file FaceCellConnectivity.hpp.

Handle< common::Table<Uint> > m_face_nb_in_elem

private

Definition at line 109 of file FaceCellConnectivity.hpp.

Handle< common::List<bool> > m_is_bdry_face

private

Definition at line 111 of file FaceCellConnectivity.hpp.

Uint m_nb_faces

private

nb_faces

Definition at line 101 of file FaceCellConnectivity.hpp.

Handle<common::Group> m_used_components

private

unified view of the elements

Definition at line 104 of file FaceCellConnectivity.hpp.

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

cf3/mesh/FaceCellConnectivity.hpp
cf3/mesh/FaceCellConnectivity.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation