Template Class t8_scheme_helpers

Inheritance Relationships

Base Type

Derived Types

Class Documentation

template<t8_eclass_t TEclass, class TUnderlyingEclassScheme>
class t8_scheme_helpers : public t8_crtp_basic<TUnderlyingEclassScheme>

Class which provides helper functions and default implementations for different schemes. Functions defined here are overridden by functions implemented in the schemes themselves.

Template Parameters:

TUnderlyingEclassScheme – The scheme this helper class is adding functionality to.

Subclassed by t8_default_scheme_common< T8_ECLASS_PRISM, t8_default_scheme_prism >, t8_default_scheme_common< T8_ECLASS_QUAD, t8_default_scheme_quad >, t8_default_scheme_common< T8_ECLASS_LINE, t8_default_scheme_line >, t8_default_scheme_common< T8_ECLASS_PYRAMID, t8_default_scheme_pyramid >, t8_default_scheme_common< T8_ECLASS_TRIANGLE, t8_default_scheme_tri >, t8_default_scheme_common< T8_ECLASS_TET, t8_default_scheme_tet >, t8_default_scheme_common< T8_ECLASS_VERTEX, t8_default_scheme_vertex >, t8_default_scheme_common< T8_ECLASS_HEX, t8_default_scheme_hex >, t8_default_scheme_common< TEclass, TUnderlyingEclassScheme >

Public Static Functions

static inline constexpr size_t get_dimension(void) noexcept

Return the tree dimension of this scheme.

Returns:

The tree dimension of this scheme.

static inline constexpr t8_eclass_t get_eclass(void) noexcept

Return the tree class of this scheme.

Returns:

The tree class of this scheme.

Protected Functions

inline t8_scheme_helpers() noexcept

Default constructor which is only accessible by derived classes. This class cannot be constructed on its own.