FE class is a base class for all finite elements. More...

#include <ikarus/finiteelements/febase.hh>

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

Public Types
using	Traits = PreFE::Traits
	Type traits. More...

using	BasisHandler = Traits::BasisHandler
	Type of the basisHandler. More...

using	LocalView = typename Traits::LocalView
	Type of the local view. More...

using	GridView = typename Traits::GridView
	Type of the global view. More...

using	GlobalIndex = typename Traits::GlobalIndex
	Type of the global index. More...

using	GridElement = typename Traits::Element
	Type of the grid element. More...

using	PreTuple = std::tuple< typename Skills< PreFE, FE >::Pre... >

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	Requirement = RequirementType< requirementDetected >::type

using	Token = std::shared_ptr< void >

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

void	bind (const GridElement &element)
	Convenient function to bind the local view to the element. More...

constexpr size_t	size () const
	Get the size of the local view. More...

const GridElement &	gridElement () const
	Get the grid element associated with the local view. More...

const LocalView &	localView () const
	Get the const reference to the local view. More...

LocalView &	localView ()
	Get the reference to the local view. More...

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...

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...

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...

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...

auto	subscribeTo (BC &bc)
	Subscribes the elements to listen to functions provided from the skills emitted by the given broadcaster. More...

template<typename Broadcaster , typename F >
auto	subscribe (Broadcaster &broadcaster, F &&f)
	Function to subscribe to a broadcaster with a given function (either a lambda, std::function or function pointer). More...

template<typename Broadcaster , typename Signature , typename F > requires (not Concepts::PointerOrSmartPointer<Broadcaster>)
auto	subscribe (Broadcaster &broadcaster, F &&f)
	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 (Token &&ts)

Static Public Member Functions
static consteval bool	hasSkill ()
	Checks if the mixin class has a specific skill. More...

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

Static Public Attributes
static constexpr int	myDim = Traits::mydim

static constexpr int	worldDim = Traits::worlddim

static constexpr bool	hasEAS

Protected Types
using	Mixin = FEMixin< PreFE, Skills... >
	Type of the FE mixin. More...

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...

Protected Attributes
friend	Mixin

Detailed Description

template<typename PreFE, template< typename, typename > class... Skills>
class Ikarus::FE< PreFE, Skills >

A single class which can be used by the finite elements to get different information from the local view of the element. It works for both the flat and untouched version of the basis.

Template Parameters

PreFE	The type of the pre finite element.
Skills	Variadic template for skill arguments possessed by the FE.

Member Typedef Documentation

◆ BasisHandler

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

using Ikarus::FE< PreFE, Skills >::BasisHandler = Traits::BasisHandler

◆ GlobalIndex

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

using Ikarus::FE< PreFE, Skills >::GlobalIndex = typename Traits::GlobalIndex

◆ GridElement

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

using Ikarus::FE< PreFE, Skills >::GridElement = typename Traits::Element

◆ GridView

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

using Ikarus::FE< PreFE, Skills >::GridView = typename Traits::GridView

◆ LocalView

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

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

◆ Mixin

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

using Ikarus::FE< PreFE, Skills >::Mixin = FEMixin<PreFE, Skills...>

protected

◆ PreTuple

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

using Ikarus::FE< PreFE, Skills >::PreTuple = std::tuple<typename Skills<PreFE, FE>::Pre...>

◆ Requirement

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

inherited

◆ SupportedResultTypes

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

inherited

◆ Token

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

inherited

◆ Traits

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

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

Constructor & Destructor Documentation

◆ FE()

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

Ikarus::FE< PreFE, Skills >::FE	(	const BasisHandler &	basisHandler,
		typename Skills< PreFE< PreFE, Skills >, FE< PreFE, Skills > >::Pre...	skillsArgs
	)

inlineexplicit

Parameters

basisHandler	The basis handler.
skillsArgs	Skill arguments.

Member Function Documentation

◆ bind() [1/2]

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

inlineinherited

◆ bind() [2/2]

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

void Ikarus::FE< PreFE, Skills >::bind ( const GridElement & element )

inline

Parameters

element The element to be bounded

Here is the caller graph for this function:

◆ calculateAt()

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

inlineinherited

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()

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

inlineinherited

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()

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

inlineinherited

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()

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

inlineinherited

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()

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

inlinestaticinherited

Returns: The created Requirement object.

◆ gridElement()

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

const GridElement & Ikarus::FE< PreFE, Skills >::gridElement ( ) const

inline

Returns: The grid element.

Here is the caller graph for this function:

◆ hasSkill()

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

inlinestaticinherited

Template Parameters

Skill The skill to check for.

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

◆ localView() [1/2]

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

LocalView & Ikarus::FE< PreFE, Skills >::localView ( )

inline

Returns: The reference to the local view.

◆ localView() [2/2]

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

const LocalView & Ikarus::FE< PreFE, Skills >::localView ( ) const

inline

Returns: The const reference to the local view.

Here is the caller graph for this function:

◆ size()

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

constexpr size_t Ikarus::FE< PreFE, Skills >::size ( ) const

inlineconstexpr

Returns: The size of the local view.

◆ subscribe() [1/2]

template<typename Broadcaster , typename F >

auto Ikarus::Listener::subscribe	(	Broadcaster &	broadcaster,
		F &&	f
	)

inlineinherited

This function deducts the types of the arguments itself and then forwards it. If there are problems with type deduction use the function below and specify the types of the arguments manually.

Template Parameters

Broadcaster	the type of the Broadcaster (for example a NonlinearSolver or ControlRoutine), can either be a pointer or value.
F	the type of the function

Parameters

broadcaster	the broadcaster
f	the function

Here is the caller graph for this function:

◆ subscribe() [2/2]

template<typename Broadcaster , typename Signature , typename F >
requires (not Concepts::PointerOrSmartPointer<Broadcaster>)

auto Ikarus::Listener::subscribe	(	Broadcaster &	broadcaster,
		F &&	f
	)

inlineinherited

Template Parameters

Broadcaster	the type of the Broadcaster (for example a NonlinearSolver or ControlRoutine), can either be a pointer or value.
Signature	the exact signature of the function F
F	the type of the function

Parameters

broadcaster	the broadcaster
f	the function

◆ subscribeTo()

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

inlineinherited

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: auto

◆ underlying() [1/2]

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

inlineprotectedinherited

Returns: A reference to the underlying finite element object.

◆ underlying() [2/2]

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

inlineprotectedinherited

Returns: A reference to the underlying finite element object.

◆ unSubscribe()

void Ikarus::Listener::unSubscribe ( Token && ts )

inlineinherited

◆ unSubscribeAll()

void Ikarus::Listener::unSubscribeAll ( )

inlineinherited

◆ unSubscribeLast()

void Ikarus::Listener::unSubscribeLast ( )

inlineinherited

◆ updateState()

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

inlineinherited

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.

Member Data Documentation

◆ hasEAS

constexpr bool Ikarus::FEMixin< PreFE, Skills... >::hasEAS

staticconstexprinherited

◆ Mixin

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

friend Ikarus::FE< PreFE, Skills >::Mixin

protected

◆ myDim

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

constexpr int Ikarus::FE< PreFE, Skills >::myDim = Traits::mydim

staticconstexpr

◆ worldDim

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

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

staticconstexpr

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

febase.hh

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ BasisHandler

◆ GlobalIndex

◆ GridElement

◆ GridView

◆ LocalView

◆ Mixin

◆ PreTuple

◆ Requirement

◆ SupportedResultTypes

◆ Token

◆ Traits

Constructor & Destructor Documentation

◆ FE()

Member Function Documentation

◆ bind() [1/2]

◆ bind() [2/2]

◆ calculateAt()

◆ calculateMatrixImpl()

◆ calculateScalarImpl()

◆ calculateVectorImpl()

◆ createRequirement()

◆ gridElement()

◆ hasSkill()

◆ localView() [1/2]

◆ localView() [2/2]

◆ size()

◆ subscribe() [1/2]

◆ subscribe() [2/2]

◆ subscribeTo()

◆ underlying() [1/2]

◆ underlying() [2/2]

◆ unSubscribe()

◆ unSubscribeAll()

◆ unSubscribeLast()

◆ updateState()

Member Data Documentation

◆ hasEAS

◆ Mixin

◆ myDim

◆ worldDim