CRTP mixin class for finite elements with additional skills. More...

#include <ikarus/finiteelements/mixin.hh>

Inheritance diagram for Ikarus::FEMixin< PreFE, Skills >:

Classes
struct	RequirementType

struct	RequirementType< false, T >

struct	RequirementType< true, T >

Public Types
using	SupportedResultTypes = decltype(std::tuple_cat(computeSupportedResultTypes< Skills< PreFE, typename PreFE::template FE< Skills... > > >()...))
	Type alias for the supported result types by the mixin. More...

using	Traits = PreFE::Traits

using	Requirement = RequirementType< requirementDetected >::type

using	LocalView = typename Traits::LocalView

using	Token = std::shared_ptr< void >

using	Args = std::tuple< ARGS... >

Public Member Functions
	FEMixin (typename Skills< PreFE, typename PreFE::template FE< Skills... > >::Pre &&... skillsArgs)
	Constructor for the FEMixin class. More...

template<template< typename, int, int > class RT> requires requires(FEMixin m, const Requirement& req, const Dune::FieldVector<double, Traits::mydim>& local) { m.template calculateAtImpl<RT>(req, local, Dune::PriorityTag<10>()); }
auto	calculateAt (const Requirement &req, const Dune::FieldVector< double, Traits::mydim > &local) const
	Calculate the element values at a specific location for a given ResultType. More...

void	bind ()
	Call all bind functions if the skill implements it. More...

template<typename ScalarType = double> requires implementsCalculateScalarImpl
auto	calculateScalarImpl (const Requirement &par, ScalarAffordance affordance, const std::optional< std::reference_wrapper< const Eigen::VectorX< ScalarType > > > &dx=std::nullopt) const
	Calculate the scalar value in each skill and joins them by `+`. More...

template<typename ScalarType > requires implementsCalculateVectorImpl
void	calculateVectorImpl (const Requirement &par, VectorAffordance affordance, typename Traits::template VectorType< ScalarType > force, const std::optional< std::reference_wrapper< const Eigen::VectorX< ScalarType > > > &dx=std::nullopt) const
	Calculate the vector for each skill. More...

template<typename ScalarType > requires implementsCalculateMatrixImpl
void	calculateMatrixImpl (const Requirement &par, MatrixAffordance affordance, typename Traits::template MatrixType< ScalarType > K, const std::optional< std::reference_wrapper< const Eigen::VectorX< ScalarType > > > &dx=std::nullopt) const
	Calculate the matrix for each skill. More...

void	updateState (const Requirement &par, const std::remove_reference_t< typename Traits::template VectorType<> > &correction)
	Call all updateStateImpl functions if the skill implements it. More...

template<typename MT , typename BC >
auto	subscribeTo (BC &bc)
	Subscribes the elements to listen to functions provided from the skills emitted by the given broadcaster. More...

template<typename Broadcaster >
auto	subscribe (Broadcaster &broadcaster, std::function< void(typename Broadcaster::MessageType, const typename Broadcaster::State &)> callback)
	Function to subscribe to a broadcaster with a given function (either a lambda, std::function or function pointer). More...

void	unSubscribeAll ()
	Unsubscribe from all listeners. At the moment unsubscribing can't be done more granularly. More...

void	unSubscribeLast ()
	Unsubscribe from the last subscribed listener. More...

void	unSubscribe (const Token &token)
	Unsubscribe from a specific token. More...

Static Public Member Functions
template<template< typename, typename > class Skill>
static consteval bool	hasSkill ()
	Checks if the mixin class has a specific skill. More...

static constexpr bool	hasEAS ()

static constexpr bool	hasAssumedStress ()

static constexpr bool	isMixed ()

static auto	createRequirement ()
	Create a Requirement object. More...

Public Attributes
Args	args

Static Public Attributes
static constexpr int	worldDim = Traits::worlddim

Protected Member Functions
const auto &	underlying () const
	Get a reference to the underlying finite element object. More...

auto &	underlying ()
	Get a reference to the underlying finite element object. More...

Detailed Description

template<typename PreFE, template< typename, typename > class... Skills>
struct Ikarus::FEMixin< PreFE, Skills >

This mixin class is designed for finite elements and provides the ability to include additional skills through the CRTP (Curiously Recurring Template Pattern).

Template Parameters

PreFE	The base finite element class.
Skills	A template parameter pack for additional skills to be mixed into the finite element.

Member Typedef Documentation

◆ Args

using Ikarus::Skills< ARGS >::Args = std::tuple<ARGS...>

inherited

◆ LocalView

template<typename PreFE , template< typename, typename > class... Skills>

using Ikarus::FEMixin< PreFE, Skills >::LocalView = typename Traits::LocalView

◆ Requirement

template<typename PreFE , template< typename, typename > class... Skills>

using Ikarus::FEMixin< PreFE, Skills >::Requirement = RequirementType<requirementDetected>::type

◆ SupportedResultTypes

template<typename PreFE , template< typename, typename > class... Skills>

using Ikarus::FEMixin< PreFE, Skills >::SupportedResultTypes = decltype(std::tuple_cat(computeSupportedResultTypes<Skills<PreFE, typename PreFE::template FE<Skills...> >>()...))

◆ Token

using Ikarus::Listener::Token = std::shared_ptr<void>

inherited

◆ Traits

template<typename PreFE , template< typename, typename > class... Skills>

using Ikarus::FEMixin< PreFE, Skills >::Traits = PreFE::Traits

Constructor & Destructor Documentation

◆ FEMixin()

template<typename PreFE , template< typename, typename > class... Skills>

Ikarus::FEMixin< PreFE, Skills >::FEMixin ( typename Skills< PreFE, typename PreFE::template FE< Skills... > >::Pre &&... skillsArgs )

inlineexplicit

Parameters

skillsArgs Variadic arguments for initializing the additional skills.

Member Function Documentation

◆ bind()

template<typename PreFE , template< typename, typename > class... Skills>

void Ikarus::FEMixin< PreFE, Skills >::bind ( )

inline

◆ calculateAt()

template<typename PreFE , template< typename, typename > class... Skills>

template<template< typename, int, int > class RT>
requires requires(FEMixin m, const Requirement& req, const Dune::FieldVector<double, Traits::mydim>& local) { m.template calculateAtImpl<RT>(req, local, Dune::PriorityTag<10>()); }

auto Ikarus::FEMixin< PreFE, Skills >::calculateAt	(	const Requirement &	req,
		const Dune::FieldVector< double, Traits::mydim > &	local
	)		const

inline

Template Parameters

RT	The ResultType to calculate.

Parameters

req	The Requirement object specifying the requirements for the calculation.
local	The local coordinates where the calculation is performed.

Returns: The calculated result as specified by the ResultType.

◆ calculateMatrixImpl()

template<typename PreFE , template< typename, typename > class... Skills>

template<typename ScalarType >
requires implementsCalculateMatrixImpl

void Ikarus::FEMixin< PreFE, Skills >::calculateMatrixImpl	(	const Requirement &	par,
		MatrixAffordance	affordance,
		typename Traits::template MatrixType< ScalarType >	K,
		const std::optional< std::reference_wrapper< const Eigen::VectorX< ScalarType > > > &	dx = `std::nullopt`
	)		const

inline

Template Parameters

ScalarType The scalar type for the calculation.

Parameters

par	The Requirement object specifying the requirements for the calculation.
K	The matrix to store the calculated result.
dx	Optional vector used in the calculation.

◆ calculateScalarImpl()

template<typename PreFE , template< typename, typename > class... Skills>

template<typename ScalarType = double>
requires implementsCalculateScalarImpl

auto Ikarus::FEMixin< PreFE, Skills >::calculateScalarImpl	(	const Requirement &	par,
		ScalarAffordance	affordance,
		const std::optional< std::reference_wrapper< const Eigen::VectorX< ScalarType > > > &	dx = `std::nullopt`
	)		const

inline

Template Parameters

ScalarType The scalar type for the calculation.

Parameters

par	The Requirement object specifying the requirements for the calculation.
dx	Optional vector used in the calculation.

Returns: The calculated scalar value.

◆ calculateVectorImpl()

template<typename PreFE , template< typename, typename > class... Skills>

template<typename ScalarType >
requires implementsCalculateVectorImpl

void Ikarus::FEMixin< PreFE, Skills >::calculateVectorImpl	(	const Requirement &	par,
		VectorAffordance	affordance,
		typename Traits::template VectorType< ScalarType >	force,
		const std::optional< std::reference_wrapper< const Eigen::VectorX< ScalarType > > > &	dx = `std::nullopt`
	)		const

inline

Template Parameters

ScalarType The scalar type for the calculation.

Parameters

par	The Requirement object specifying the requirements for the calculation.
force	The vector to store the calculated result.
dx	Optional vector used in the calculation.

◆ createRequirement()

template<typename PreFE , template< typename, typename > class... Skills>

static auto Ikarus::FEMixin< PreFE, Skills >::createRequirement ( )

inlinestatic

Returns: The created Requirement object.

◆ hasAssumedStress()

template<typename PreFE , template< typename, typename > class... Skills>

static constexpr bool Ikarus::FEMixin< PreFE, Skills >::hasAssumedStress ( )

inlinestaticconstexpr

Here is the caller graph for this function:

◆ hasEAS()

template<typename PreFE , template< typename, typename > class... Skills>

static constexpr bool Ikarus::FEMixin< PreFE, Skills >::hasEAS ( )

inlinestaticconstexpr

Here is the caller graph for this function:

◆ hasSkill()

template<typename PreFE , template< typename, typename > class... Skills>

template<template< typename, typename > class Skill>

static consteval bool Ikarus::FEMixin< PreFE, Skills >::hasSkill ( )

inlinestatic

Template Parameters

Skill The skill to check for.

Returns: True if the skill is present, false otherwise.

◆ isMixed()

template<typename PreFE , template< typename, typename > class... Skills>

static constexpr bool Ikarus::FEMixin< PreFE, Skills >::isMixed ( )

inlinestaticconstexpr

◆ subscribe()

template<typename Broadcaster >

auto Ikarus::Listener::subscribe	(	Broadcaster &	broadcaster,
		std::function< void(typename Broadcaster::MessageType, const typename Broadcaster::State &)>	callback
	)

inlineinherited

Template Parameters

Broadcaster the type of the Broadcaster (for example a NonlinearSolver or ControlRoutine)

Parameters

broadcaster	the broadcaster
callback	the function

Here is the caller graph for this function:

◆ subscribeTo()

template<typename PreFE , template< typename, typename > class... Skills>

template<typename MT , typename BC >

auto Ikarus::FEMixin< PreFE, Skills >::subscribeTo ( BC & bc )

inline

Template Parameters

MT	the message type (for example NonlinerSolverMessages or ControlMessages)
BC	the type of the broadcaster

Parameters

bc	the broadcaster (for example a nonlinearsolver or control routine)

Returns: this-pointer

◆ underlying() [1/2]

template<typename PreFE , template< typename, typename > class... Skills>

auto & Ikarus::FEMixin< PreFE, Skills >::underlying ( )

inlineprotected

Returns: A reference to the underlying finite element object.

◆ underlying() [2/2]

template<typename PreFE , template< typename, typename > class... Skills>

const auto & Ikarus::FEMixin< PreFE, Skills >::underlying ( ) const

inlineprotected

Returns: A reference to the underlying finite element object.

◆ unSubscribe()

void Ikarus::Listener::unSubscribe ( const Token & token )

inlineinherited

◆ unSubscribeAll()

void Ikarus::Listener::unSubscribeAll ( )

inlineinherited

◆ unSubscribeLast()

void Ikarus::Listener::unSubscribeLast ( )

inlineinherited

◆ updateState()

template<typename PreFE , template< typename, typename > class... Skills>

void Ikarus::FEMixin< PreFE, Skills >::updateState	(	const Requirement &	par,
		const std::remove_reference_t< typename Traits::template VectorType<> > &	correction
	)

inline

Update the state variables related to a particular skill.

Parameters

req	The Requirement object specifying the requirements for the update itself.
force	A correction vector (for example, the displacement increment) based on which the state variables are to be updated.

Here is the caller graph for this function:

Member Data Documentation

◆ args

Args Ikarus::Skills< ARGS >::args

inherited

◆ worldDim

template<typename PreFE , template< typename, typename > class... Skills>

constexpr int Ikarus::FEMixin< PreFE, Skills >::worldDim = Traits::worlddim

staticconstexpr

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

mixin.hh

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ Args

◆ LocalView

◆ Requirement

◆ SupportedResultTypes

◆ Token

◆ Traits

Constructor & Destructor Documentation

◆ FEMixin()

Member Function Documentation

◆ bind()

◆ calculateAt()

◆ calculateMatrixImpl()

◆ calculateScalarImpl()

◆ calculateVectorImpl()

◆ createRequirement()

◆ hasAssumedStress()

◆ hasEAS()

◆ hasSkill()

◆ isMixed()

◆ subscribe()

◆ subscribeTo()

◆ underlying() [1/2]

◆ underlying() [2/2]

◆ unSubscribe()

◆ unSubscribeAll()

◆ unSubscribeLast()

◆ updateState()

Member Data Documentation

◆ args

◆ worldDim