Topology::Cubic< hyEdge_dimT, space_dimT, NodeIndexVecT, ConstructorVecT, hyEdge_index_t, NodeOrientationT >::hyEdge Class Reference

Definition of the topology of a hypergraph's edges — Cubic HyperGraph's edges. More...

Public Member Functions
	hyEdge (const hyEdge_index_t index, const Cubic &topology)
	Construct a cubic hyperedge from its index and a the global topology class. More...
const NodeIndexVecT &	get_hyNode_indices () const
	Return indices of hypernodes adjacent to the hyperedge. More...
const NodeOrientationT	get_hyNode_oriantation (unsigned int) const
	Return orienation of hypernode. More...

Private Attributes
NodeIndexVecT	hyNode_indices_
	Indices of the hypernodes adjacent to the hyperedge. More...

Detailed Description

template<unsigned int hyEdge_dimT, unsigned int space_dimT, typename NodeIndexVecT = SmallVec<2 * hyEdge_dimT, unsigned int>, typename ConstructorVecT = SmallVec<space_dimT, unsigned int>, typename hyEdge_index_t = typename NodeIndexVecT::value_type, typename NodeOrientationT = SmallVec<2 * hyEdge_dimT - 2, unsigned int>>
class Topology::Cubic< hyEdge_dimT, space_dimT, NodeIndexVecT, ConstructorVecT, hyEdge_index_t, NodeOrientationT >::hyEdge

Definition of the topology of a hypergraph's edges — Cubic HyperGraph's edges.

---

Authors

Guido Kanschat, Heidelberg University, 2019–2020.

Andreas Rupp, Heidelberg University, 2019–2020.

Constructor & Destructor Documentation

hyEdge()

template<unsigned int hyEdge_dimT, unsigned int space_dimT, typename NodeIndexVecT = SmallVec<2 * hyEdge_dimT, unsigned int>, typename ConstructorVecT = SmallVec<space_dimT, unsigned int>, typename hyEdge_index_t = typename NodeIndexVecT::value_type, typename NodeOrientationT = SmallVec<2 * hyEdge_dimT - 2, unsigned int>>

Topology::Cubic< hyEdge_dimT, space_dimT, NodeIndexVecT, ConstructorVecT, hyEdge_index_t, NodeOrientationT >::hyEdge::hyEdge ( const hyEdge_index_t  index, const Cubic &  topology  )

inline

Construct a cubic hyperedge from its index and a the global topology class.

---

Parameters

index	The index of the hyperedge to be created.
topology	A cubic topology.

Here is the call graph for this function:

Member Function Documentation

get_hyNode_indices()

template<unsigned int hyEdge_dimT, unsigned int space_dimT, typename NodeIndexVecT = SmallVec<2 * hyEdge_dimT, unsigned int>, typename ConstructorVecT = SmallVec<space_dimT, unsigned int>, typename hyEdge_index_t = typename NodeIndexVecT::value_type, typename NodeOrientationT = SmallVec<2 * hyEdge_dimT - 2, unsigned int>>

const NodeIndexVecT& Topology::Cubic< hyEdge_dimT, space_dimT, NodeIndexVecT, ConstructorVecT, hyEdge_index_t, NodeOrientationT >::hyEdge::get_hyNode_indices ( ) const

inline

Return indices of hypernodes adjacent to the hyperedge.

---

Return values

hypernode_indices

Topological information on the hyperedge (cf. value_type).

get_hyNode_oriantation()

template<unsigned int hyEdge_dimT, unsigned int space_dimT, typename NodeIndexVecT = SmallVec<2 * hyEdge_dimT, unsigned int>, typename ConstructorVecT = SmallVec<space_dimT, unsigned int>, typename hyEdge_index_t = typename NodeIndexVecT::value_type, typename NodeOrientationT = SmallVec<2 * hyEdge_dimT - 2, unsigned int>>

const NodeOrientationT Topology::Cubic< hyEdge_dimT, space_dimT, NodeIndexVecT, ConstructorVecT, hyEdge_index_t, NodeOrientationT >::hyEdge::get_hyNode_oriantation ( unsigned int  ) const

inline

Return orienation of hypernode.

---

Member Data Documentation

hyNode_indices_

template<unsigned int hyEdge_dimT, unsigned int space_dimT, typename NodeIndexVecT = SmallVec<2 * hyEdge_dimT, unsigned int>, typename ConstructorVecT = SmallVec<space_dimT, unsigned int>, typename hyEdge_index_t = typename NodeIndexVecT::value_type, typename NodeOrientationT = SmallVec<2 * hyEdge_dimT - 2, unsigned int>>

NodeIndexVecT Topology::Cubic< hyEdge_dimT, space_dimT, NodeIndexVecT, ConstructorVecT, hyEdge_index_t, NodeOrientationT >::hyEdge::hyNode_indices_

private

Indices of the hypernodes adjacent to the hyperedge.

---

---

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

• /home/runner/work/HyperHDG/HyperHDG/include/HyperHDG/topology/cubic.hxx