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

Definition of the topology of a hypergraph's edges. More...

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

Public Member Functions

 hyEdge (const File &topology, const hyEdge_index_t index)
 Construct hyperedge from hypergraph and index. More...
 
const auto & get_hyNode_indices () const
 Return hypernodes of a hyperedge. More...
 
const NodeOrientationT get_hyNode_oriantation (unsigned int) const
 Return orienation of hypernode. More...
 

Static Public Member Functions

static constexpr unsigned int n_hyNodes ()
 Number of hypernodes per hyperedge. 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 > hyNode_indices_
 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, typename NodeOrientationT = SmallVec<2 * hyEdge_dimT - 2, unsigned int>>
class Topology::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t, NodeOrientationT >::hyEdge

Definition of the topology 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, typename NodeOrientationT = SmallVec<2 * hyEdge_dimT - 2, unsigned int>>
Topology::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t, NodeOrientationT >::hyEdge::hyEdge ( const File topology,
const hyEdge_index_t  index 
)
inline

Construct hyperedge from hypergraph and index.


Here is the call graph for this function:

Member Function Documentation

◆ get_hyNode_indices()

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, typename NodeOrientationT = SmallVec<2 * hyEdge_dimT - 2, unsigned int>>
const auto& Topology::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t, NodeOrientationT >::hyEdge::get_hyNode_indices ( ) const
inline

Return hypernodes of a hyperedge.


◆ get_hyNode_oriantation()

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, typename NodeOrientationT = SmallVec<2 * hyEdge_dimT - 2, unsigned int>>
const NodeOrientationT Topology::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t, NodeOrientationT >::hyEdge::get_hyNode_oriantation ( unsigned int  ) const
inline

Return orienation of hypernode.


◆ 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, typename NodeOrientationT = SmallVec<2 * hyEdge_dimT - 2, unsigned int>>
static constexpr unsigned int Topology::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t, NodeOrientationT >::hyEdge::n_hyNodes ( )
inlinestaticconstexpr

Number of hypernodes per hyperedge.


Member Data Documentation

◆ 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, typename NodeOrientationT = SmallVec<2 * hyEdge_dimT - 2, unsigned int>>
const File& Topology::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t, NodeOrientationT >::hyEdge::hyGraph_topology_
private

Reference to parent hypergraph.


◆ hyNode_indices_

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, typename NodeOrientationT = SmallVec<2 * hyEdge_dimT - 2, unsigned int>>
std::array<hyNode_index_t, 2 * hyEdge_dimT> Topology::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t, NodeOrientationT >::hyEdge::hyNode_indices_
private

Indices of the hypernodes adjacent to the hyperedge.


◆ 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, typename NodeOrientationT = SmallVec<2 * hyEdge_dimT - 2, unsigned int>>
const hyEdge_index_t Topology::File< hyEdge_dimT, space_dimT, vectorT, pointT, hyEdge_index_t, hyNode_index_t, pt_index_t, NodeOrientationT >::hyEdge::index_
private

Index of the hyperedge within the hypergraph.



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