version 0.4.1
Ikarus::ScalarAssembler< SA, FEC, DV, ST > Class Template Reference

The ScalarAssembler provides an interface for an assembler that assembles scalar quantities. More...

#include <ikarus/assembler/interface.hh>

Inheritance diagram for Ikarus::ScalarAssembler< SA, FEC, DV, ST >:
[legend]

Public Types

using ScalarAssemblerType = SA
 
using ScalarType = ST
 
using DirichletValuesType = DV
 
using FEContainer = FEC
 
using FEContainerRaw = std::remove_cvref_t< FEC >
 Type of the raw finite element container. More...
 
using FERequirement = typename FEContainerRaw::value_type::Requirement
 

Public Member Functions

const ScalarTypescalar (const FERequirement &feRequirements, ScalarAffordance affordance)
 Calculates the scalar quantity requested by feRequirements and affordance. More...
 
const ScalarTypescalar ()
 Calculates the scalar quantity requested by the bound feRequirements and returns a reference. More...
 

Detailed Description

template<typename SA, typename FEC, typename DV, typename ST>
class Ikarus::ScalarAssembler< SA, FEC, DV, ST >
Template Parameters
SAType of the scalar assembler
FECType of the finite element container.
DVType of the Dirichlet values.
STType of the scalar quantity

Member Typedef Documentation

◆ DirichletValuesType

template<typename SA , typename FEC , typename DV , typename ST >
using Ikarus::ScalarAssembler< SA, FEC, DV, ST >::DirichletValuesType = DV

◆ FEContainer

template<typename SA , typename FEC , typename DV , typename ST >
using Ikarus::ScalarAssembler< SA, FEC, DV, ST >::FEContainer = FEC

◆ FEContainerRaw

template<typename SA , typename FEC , typename DV , typename ST >
using Ikarus::ScalarAssembler< SA, FEC, DV, ST >::FEContainerRaw = std::remove_cvref_t<FEC>

◆ FERequirement

template<typename SA , typename FEC , typename DV , typename ST >
using Ikarus::ScalarAssembler< SA, FEC, DV, ST >::FERequirement = typename FEContainerRaw::value_type::Requirement

◆ ScalarAssemblerType

template<typename SA , typename FEC , typename DV , typename ST >
using Ikarus::ScalarAssembler< SA, FEC, DV, ST >::ScalarAssemblerType = SA

◆ ScalarType

template<typename SA , typename FEC , typename DV , typename ST >
using Ikarus::ScalarAssembler< SA, FEC, DV, ST >::ScalarType = ST

Member Function Documentation

◆ scalar() [1/2]

template<typename SA , typename FEC , typename DV , typename ST >
const ScalarType & Ikarus::ScalarAssembler< SA, FEC, DV, ST >::scalar ( )
inline
Returns
Const reference to the calculated scalar quantity.

◆ scalar() [2/2]

template<typename SA , typename FEC , typename DV , typename ST >
const ScalarType & Ikarus::ScalarAssembler< SA, FEC, DV, ST >::scalar ( const FERequirement feRequirements,
ScalarAffordance  affordance 
)
inline
Parameters
feRequirementsReference to the finite element requirements.
affordanceThe scalar affordance
Returns
Const reference to the calculated scalar quantity.

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