HyperHDG
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
NodeDescriptor::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t >::hyEdge Class Reference

Definition of the node types of a hypergraph's edges. More...

Collaboration diagram for NodeDescriptor::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t >::hyEdge:
Collaboration graph
[legend]

Public Member Functions

 hyEdge (const File &node_desc, const hyEdge_index_t index)
 Construct hyperedge from hypergraph and index. More...
 
const auto & get_hyFaces_types () const
 Return hypernode types of the hyEdge. More...
 
unsigned int operator[] (const unsigned int index) const
 Return hypernode type of given index. More...
 

Static Public Member Functions

static constexpr unsigned int n_hyNodes ()
 
static constexpr unsigned int hyEdge_dim ()
 Return dimension of the hyperedge. More...
 
static constexpr unsigned int space_dim ()
 Return dimension of the surrounding space. More...
 

Private Attributes

const FilehyGraph_topology_
 Reference to parent hypergraph. More...
 
const hyEdge_index_t index_
 Index of the hyperedge within the hypergraph. More...
 
std::array< hyNode_index_t, 2 *hyEdge_dimT > hyFace_types_
 Indices of the hypernodes adjacent to the hyperedge. More...
 

Detailed Description

template<unsigned int hyEdge_dimT, unsigned int space_dimT, template< typename... > typename vectorT = std::vector, typename pointT = Point<space_dimT, float>, typename hyEdge_index_t = unsigned int, typename hyNode_index_t = hyEdge_index_t, typename pt_index_t = hyNode_index_t>
class NodeDescriptor::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t >::hyEdge

Definition of the node types of a hypergraph's edges.


Constructor & Destructor Documentation

◆ hyEdge()

template<unsigned int hyEdge_dimT, unsigned int space_dimT, template< typename... > typename vectorT = std::vector, typename pointT = Point<space_dimT, float>, typename hyEdge_index_t = unsigned int, typename hyNode_index_t = hyEdge_index_t, typename pt_index_t = hyNode_index_t>
NodeDescriptor::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t >::hyEdge::hyEdge ( const File node_desc,
const hyEdge_index_t  index 
)
inline

Construct hyperedge from hypergraph and index.


Here is the call graph for this function:

Member Function Documentation

◆ get_hyFaces_types()

template<unsigned int hyEdge_dimT, unsigned int space_dimT, template< typename... > typename vectorT = std::vector, typename pointT = Point<space_dimT, float>, typename hyEdge_index_t = unsigned int, typename hyNode_index_t = hyEdge_index_t, typename pt_index_t = hyNode_index_t>
const auto& NodeDescriptor::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t >::hyEdge::get_hyFaces_types ( ) const
inline

Return hypernode types of the hyEdge.


◆ hyEdge_dim()

template<unsigned int hyEdge_dimT, unsigned int space_dimT, template< typename... > typename vectorT = std::vector, typename pointT = Point<space_dimT, float>, typename hyEdge_index_t = unsigned int, typename hyNode_index_t = hyEdge_index_t, typename pt_index_t = hyNode_index_t>
static constexpr unsigned int NodeDescriptor::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t >::hyEdge::hyEdge_dim ( )
inlinestaticconstexpr

Return dimension of the hyperedge.


◆ n_hyNodes()

template<unsigned int hyEdge_dimT, unsigned int space_dimT, template< typename... > typename vectorT = std::vector, typename pointT = Point<space_dimT, float>, typename hyEdge_index_t = unsigned int, typename hyNode_index_t = hyEdge_index_t, typename pt_index_t = hyNode_index_t>
static constexpr unsigned int NodeDescriptor::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t >::hyEdge::n_hyNodes ( )
inlinestaticconstexpr

◆ operator[]()

template<unsigned int hyEdge_dimT, unsigned int space_dimT, template< typename... > typename vectorT = std::vector, typename pointT = Point<space_dimT, float>, typename hyEdge_index_t = unsigned int, typename hyNode_index_t = hyEdge_index_t, typename pt_index_t = hyNode_index_t>
unsigned int NodeDescriptor::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t >::hyEdge::operator[] ( const unsigned int  index) const
inline

Return hypernode type of given index.


◆ space_dim()

template<unsigned int hyEdge_dimT, unsigned int space_dimT, template< typename... > typename vectorT = std::vector, typename pointT = Point<space_dimT, float>, typename hyEdge_index_t = unsigned int, typename hyNode_index_t = hyEdge_index_t, typename pt_index_t = hyNode_index_t>
static constexpr unsigned int NodeDescriptor::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t >::hyEdge::space_dim ( )
inlinestaticconstexpr

Return dimension of the surrounding space.


Member Data Documentation

◆ hyFace_types_

template<unsigned int hyEdge_dimT, unsigned int space_dimT, template< typename... > typename vectorT = std::vector, typename pointT = Point<space_dimT, float>, typename hyEdge_index_t = unsigned int, typename hyNode_index_t = hyEdge_index_t, typename pt_index_t = hyNode_index_t>
std::array<hyNode_index_t, 2 * hyEdge_dimT> NodeDescriptor::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t >::hyEdge::hyFace_types_
private

Indices of the hypernodes adjacent to the hyperedge.


◆ hyGraph_topology_

template<unsigned int hyEdge_dimT, unsigned int space_dimT, template< typename... > typename vectorT = std::vector, typename pointT = Point<space_dimT, float>, typename hyEdge_index_t = unsigned int, typename hyNode_index_t = hyEdge_index_t, typename pt_index_t = hyNode_index_t>
const File& NodeDescriptor::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t >::hyEdge::hyGraph_topology_
private

Reference to parent hypergraph.


◆ index_

template<unsigned int hyEdge_dimT, unsigned int space_dimT, template< typename... > typename vectorT = std::vector, typename pointT = Point<space_dimT, float>, typename hyEdge_index_t = unsigned int, typename hyNode_index_t = hyEdge_index_t, typename pt_index_t = hyNode_index_t>
const hyEdge_index_t NodeDescriptor::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t >::hyEdge::index_
private

Index of the hyperedge within the hypergraph.



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