version 0.4.1
Ikarus::AffordanceCollection< Affordances > Struct Template Reference

Struct representing a collection of affordances.

#include <ikarus/finiteelements/ferequirements.hh>

Inheritance diagram for Ikarus::AffordanceCollection< Affordances >:
[legend]

Public Types

using Base = std::tuple< Affordances... >
 

Public Member Functions

 AffordanceCollection ()=default
 
constexpr AffordanceCollection (Affordances... affordances)
 
template<FEAffordance Affordance>
constexpr bool hasAffordance (Affordance &&affordances) const
 Check if a specific affordance is present in the requirements. More...
 
auto scalarAffordance () const
 
auto vectorAffordance () const
 
auto matrixAffordance () const
 

Static Public Attributes

static constexpr bool hasScalarAffordance = traits::hasType<ScalarAffordance, std::tuple<Affordances...>>::value
 
static constexpr bool hasVectorAffordance = traits::hasType<VectorAffordance, std::tuple<Affordances...>>::value
 
static constexpr bool hasMatrixAffordance = traits::hasType<MatrixAffordance, std::tuple<Affordances...>>::value
 

Member Typedef Documentation

◆ Base

template<FEAffordance... Affordances>
using Ikarus::AffordanceCollection< Affordances >::Base = std::tuple<Affordances...>

Constructor & Destructor Documentation

◆ AffordanceCollection() [1/2]

template<FEAffordance... Affordances>
Ikarus::AffordanceCollection< Affordances >::AffordanceCollection ( )
default

◆ AffordanceCollection() [2/2]

template<FEAffordance... Affordances>
constexpr Ikarus::AffordanceCollection< Affordances >::AffordanceCollection ( Affordances...  affordances)
inlineconstexpr

Member Function Documentation

◆ hasAffordance()

template<FEAffordance... Affordances>
template<FEAffordance Affordance>
constexpr bool Ikarus::AffordanceCollection< Affordances >::hasAffordance ( Affordance &&  affordances) const
inlineconstexpr

This function checks if the specified affordance is present in the requirements.

Template Parameters
AffordanceType of affordance to be checked.
Parameters
affordanceThe affordance to be checked. This can also be an affordance collection.
Returns
True if the affordance is present, false otherwise.

◆ matrixAffordance()

template<FEAffordance... Affordances>
auto Ikarus::AffordanceCollection< Affordances >::matrixAffordance ( ) const
inline
Here is the caller graph for this function:

◆ scalarAffordance()

template<FEAffordance... Affordances>
auto Ikarus::AffordanceCollection< Affordances >::scalarAffordance ( ) const
inline
Here is the caller graph for this function:

◆ vectorAffordance()

template<FEAffordance... Affordances>
auto Ikarus::AffordanceCollection< Affordances >::vectorAffordance ( ) const
inline
Here is the caller graph for this function:

Member Data Documentation

◆ hasMatrixAffordance

template<FEAffordance... Affordances>
constexpr bool Ikarus::AffordanceCollection< Affordances >::hasMatrixAffordance = traits::hasType<MatrixAffordance, std::tuple<Affordances...>>::value
staticconstexpr

◆ hasScalarAffordance

template<FEAffordance... Affordances>
constexpr bool Ikarus::AffordanceCollection< Affordances >::hasScalarAffordance = traits::hasType<ScalarAffordance, std::tuple<Affordances...>>::value
staticconstexpr

◆ hasVectorAffordance

template<FEAffordance... Affordances>
constexpr bool Ikarus::AffordanceCollection< Affordances >::hasVectorAffordance = traits::hasType<VectorAffordance, std::tuple<Affordances...>>::value
staticconstexpr

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