ViennaGrid - The Vienna Grid Library  2.1.0
Public Types | Public Member Functions | Protected Attributes
mesh< WrappedConfigType > Class Template Reference

The main mesh class holding all the different elements. The data structure is configured using a configuration class. See viennagrid::config for predefined configurations. More...

#include <mesh.hpp>

Public Types

typedef
result_of::mesh_appendix_type
< WrappedConfigType >::type 
appendix_type
typedef
result_of::mesh_change_counter_type
< WrappedConfigType >::type 
change_counter_type
typedef WrappedConfigType::type config_type
typedef
result_of::mesh_element_collection_type
< WrappedConfigType >::type 
element_collection_type
typedef
result_of::mesh_inserter_type
< WrappedConfigType >::type 
inserter_type
typedef WrappedConfigType wrapped_config_type

Public Member Functions

appendix_typeappendix ()
 For internal use only.
appendix_type const & appendix () const
void clear ()
 Completely clears a mesh.
element_collection_typeelement_collection ()
 For internal use only.
element_collection_type const & element_collection () const
inserter_typeget_inserter ()
 For internal use only.
inserter_type const & get_inserter () const
void increment_change_counter ()
bool is_obsolete (change_counter_type change_counter_to_check) const
 For internal use only.
 mesh ()
 Default constructor.
template<typename OtherWrappedConfigT >
 mesh (mesh_proxy< viennagrid::mesh< OtherWrappedConfigT > > proxy)
 Constructor for creating a view from another mesh/mesh view.
 mesh (const mesh &other)
 Copy constructor, remember that copying a mesh might have performance impact due to handle fixing: handles for boundary element will point to other locations.
meshoperator= (mesh const &other)
 Assignement operator, remember that assigning a mesh to another might have performance impact due to handle fixing: handles for boundary element will point to other locations.
void update_change_counter (change_counter_type &change_counter_to_update) const
 ~mesh ()

Protected Attributes

appendix_type appendix_
change_counter_type change_counter_
element_collection_type element_container_collection
inserter_type inserter

Detailed Description

template<typename WrappedConfigType>
class viennagrid::mesh< WrappedConfigType >

The main mesh class holding all the different elements. The data structure is configured using a configuration class. See viennagrid::config for predefined configurations.

Template Parameters:
WrappedConfigTypeA class wrapping the configuration typemap. See namespace viennagrid::config for examples.

Member Typedef Documentation

typedef result_of::mesh_appendix_type<WrappedConfigType>::type appendix_type
typedef result_of::mesh_change_counter_type<WrappedConfigType>::type change_counter_type
typedef WrappedConfigType::type config_type
typedef result_of::mesh_element_collection_type<WrappedConfigType>::type element_collection_type
typedef result_of::mesh_inserter_type<WrappedConfigType>::type inserter_type
typedef WrappedConfigType wrapped_config_type

Constructor & Destructor Documentation

mesh ( ) [inline]

Default constructor.

mesh ( mesh_proxy< viennagrid::mesh< OtherWrappedConfigT > >  proxy) [inline]

Constructor for creating a view from another mesh/mesh view.

Template Parameters:
OtherWrappedConfigTWrapped config type of the mesh type from which the view is created
proxyProxy object wrapping the mesh object from which the view is created
~mesh ( ) [inline]
mesh ( const mesh< WrappedConfigType > &  other) [inline]

Copy constructor, remember that copying a mesh might have performance impact due to handle fixing: handles for boundary element will point to other locations.

Parameters:
otherThe mesh which is copied to *this

Member Function Documentation

appendix_type& appendix ( ) [inline]

For internal use only.

appendix_type const& appendix ( ) const [inline]
void clear ( ) [inline]

Completely clears a mesh.

For internal use only.

element_collection_type const& element_collection ( ) const [inline]
inserter_type& get_inserter ( ) [inline]

For internal use only.

inserter_type const& get_inserter ( ) const [inline]
void increment_change_counter ( ) [inline]
bool is_obsolete ( change_counter_type  change_counter_to_check) const [inline]

For internal use only.

mesh& operator= ( mesh< WrappedConfigType > const &  other) [inline]

Assignement operator, remember that assigning a mesh to another might have performance impact due to handle fixing: handles for boundary element will point to other locations.

Parameters:
otherThe mesh which is assigned to *this
Returns:
reference to *this
void update_change_counter ( change_counter_type change_counter_to_update) const [inline]

Field Documentation

appendix_type appendix_ [protected]
inserter_type inserter [protected]

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