COOLFluiD  Release kernel
COOLFluiD is a Collaborative Simulation Environment (CSE) focused on complex MultiPhysics simulations.
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
FaceConnectivity Class Reference

#include <ConnectivityData.hpp>

Inherits Component.

Public Types

typedef NodeConnectivity::EntitiesT EntitiesT
 Storage for a list of elements. More...
 
typedef NodeConnectivity::CountsT CountsT
 Storage for counted numbers. More...
 
typedef NodeConnectivity::IndicesT IndicesT
 Storage for indices into other arrays. More...
 
typedef std::vector< bool > BoolsT
 Storage for a list of boolean values. More...
 
typedef NodeConnectivity::ElementReferenceT ElementReferenceT
 Uniquely refer an element by its Elements and local element index. More...
 
- Public Types inherited from Component
typedef ComponentIterator< Componentiterator
 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< SignalPtrstorage_t
 storage type for signals More...
 

Public Member Functions

 FaceConnectivity (const std::string &name)
 
virtual ~FaceConnectivity ()
 Virtual destructor. More...
 
void initialize (const Elements &own_celements, const NodeConnectivity &node_connectivity)
 
void initialize (const NodeConnectivity &node_connectivity)
 Shortcut assuming the parent is the own_celements. More...
 
bool has_adjacent_element (const Uint element, const Uint face) const
 True if the given face of the given element has an adjacent element. More...
 
ElementReferenceT adjacent_element (const Uint element, const Uint face) const
 Get the element that is adjacent to the given face of the given element. More...
 
Uint adjacent_face (const Uint element, const Uint face) const
 Get the face that is adjacent to the given face of the given element. More...
 
Uint element_nb_faces () const
 Access to the raw data. More...
 
const BoolsTface_has_neighbour () const
 
const NodeConnectivity::NodeElementsTface_element_connectivity () const
 
const IndicesTface_face_connectivity () const
 
const NodeConnectivitynode_connectivity () 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< Componentaccess_component (const URI &path) const
 
Handle< Componentaccess_component_checked (const URI &path)
 
Handle< Component const > access_component_checked (const URI &path) const
 
Handle< Componenthandle ()
 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< Componentparent () const
 
Handle< Component const > root () const
 
Handle< Componentroot ()
 
Handle< Componentget_child (const std::string &name)
 
Handle< Component const > get_child (const std::string &name) const
 
Handle< Componentget_child_checked (const std::string &name)
 
Handle< Component const > get_child_checked (const std::string &name) const
 
Handle< Componentcreate_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...
 
Componentadd_component (const boost::shared_ptr< Component > &subcomp)
 Add the passed component as a subcomponent. More...
 
void add_link (Component &linked_component)
 
boost::shared_ptr< Componentremove_component (const std::string &name)
 Remove a (sub)component of this component. More...
 
boost::shared_ptr< Componentremove_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
 
PropertyListproperties ()
 
const PropertyListproperties () const
 
OptionListoptions ()
 
const OptionListoptions () const
 
void reset_options ()
 Reset all options to their default value. More...
 
void configure_option_recursively (const std::string &optname, const boost::any &val)
 
Componentmark_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_tsignal_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...
 
Signalregist_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...
 
Connectionconnection (const std::string &name)
 
Connectionmanage_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

const NodeConnectivitym_node_connectivity
 
Uint m_element_nb_faces
 Number of faces per element. More...
 
BoolsT m_face_has_neighbour
 
NodeConnectivity::NodeElementsT m_face_element_connectivity
 
IndicesT m_face_face_connectivity
 

Additional Inherited Members

- Public Attributes inherited from SignalHandler
storage_t m_signals
 storage of the signals More...
 
- Protected Member Functions inherited from Component
Componentadd_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 element faces and their adjacent elements and provides a convenient API to access the data

Definition at line 101 of file ConnectivityData.hpp.

Member Typedef Documentation

typedef std::vector<bool> BoolsT

Storage for a list of boolean values.

Definition at line 114 of file ConnectivityData.hpp.

Storage for counted numbers.

Definition at line 108 of file ConnectivityData.hpp.

Uniquely refer an element by its Elements and local element index.

Definition at line 117 of file ConnectivityData.hpp.

Storage for a list of elements.

Definition at line 105 of file ConnectivityData.hpp.

Storage for indices into other arrays.

Definition at line 111 of file ConnectivityData.hpp.

Constructor & Destructor Documentation

FaceConnectivity ( const std::string &  name)

Contructor

Parameters
nameof the component

Definition at line 88 of file ConnectivityData.cpp.

~FaceConnectivity ( )
virtual

Virtual destructor.

Definition at line 93 of file ConnectivityData.cpp.

Member Function Documentation

FaceConnectivity::ElementReferenceT adjacent_element ( const Uint  element,
const Uint  face 
) const

Get the element that is adjacent to the given face of the given element.

Definition at line 127 of file ConnectivityData.cpp.

Uint adjacent_face ( const Uint  element,
const Uint  face 
) const

Get the face that is adjacent to the given face of the given element.

Definition at line 134 of file ConnectivityData.cpp.

Uint element_nb_faces ( ) const
inline

Access to the raw data.

Definition at line 152 of file ConnectivityData.hpp.

const NodeConnectivity::NodeElementsT& face_element_connectivity ( ) const
inline

Definition at line 154 of file ConnectivityData.hpp.

const IndicesT& face_face_connectivity ( ) const
inline

Definition at line 155 of file ConnectivityData.hpp.

const BoolsT& face_has_neighbour ( ) const
inline

Definition at line 153 of file ConnectivityData.hpp.

bool has_adjacent_element ( const Uint  element,
const Uint  face 
) const

True if the given face of the given element has an adjacent element.

Definition at line 122 of file ConnectivityData.cpp.

void initialize ( const Elements own_celements,
const NodeConnectivity node_connectivity 
)

Initialize the connectivity arrays so the adjacent face- and element lookups are defined for celements Parameters use the convention from the low level interface

See also
create_node_element_connectivity
create_face_element_connectivity
create_face_face_connectivity

Definition at line 97 of file ConnectivityData.cpp.

void initialize ( const NodeConnectivity node_connectivity)

Shortcut assuming the parent is the own_celements.

Definition at line 115 of file ConnectivityData.cpp.

const NodeConnectivity& node_connectivity ( ) const
inline

Definition at line 156 of file ConnectivityData.hpp.

static std::string type_name ( )
inlinestatic

Get the class name.

Definition at line 127 of file ConnectivityData.hpp.

Member Data Documentation

Uint m_element_nb_faces
private

Number of faces per element.

Definition at line 162 of file ConnectivityData.hpp.

NodeConnectivity::NodeElementsT m_face_element_connectivity
private

Definition at line 165 of file ConnectivityData.hpp.

IndicesT m_face_face_connectivity
private

Definition at line 166 of file ConnectivityData.hpp.

BoolsT m_face_has_neighbour
private

Definition at line 164 of file ConnectivityData.hpp.

const NodeConnectivity* m_node_connectivity
private

Definition at line 159 of file ConnectivityData.hpp.


The documentation for this class was generated from the following files:
Send comments to:
COOLFluiD Web Admin