LinearElastic class represents a linear elastic finite element. More...

#include <ikarus/finiteelements/mechanics/linearelastic.hh>

Inheritance diagram for Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >:

Public Types
using	Basis = Basis_

using	FlatBasis = typename Basis::FlatBasis

using	BaseDisp = PowerBasisFE< FlatBasis >

using	FERequirementType = FERequirements_

using	ResultRequirementsType = ResultRequirements< FERequirementType >

using	LocalView = typename FlatBasis::LocalView

using	Element = typename LocalView::Element

using	Traits = TraitsFromLocalView< LocalView, useEigenRef >

using	Geometry = typename Element::Geometry

using	GridView = typename FlatBasis::GridView

using	LocalBasisType = decltype(std::declval< LocalView >().tree().child(0).finiteElement().localBasis())

using	RootBasis = Basis_::FlatBasis
	Type of the root basis. More...

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

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

Public Member Functions
template<typename VolumeLoad = utils::LoadDefault, typename NeumannBoundaryLoad = utils::LoadDefault>
	LinearElastic (const Basis &globalBasis, const typename LocalView::Element &element, double emod, double nu, VolumeLoad p_volumeLoad={}, const BoundaryPatch< GridView > *p_neumannBoundary=nullptr, NeumannBoundaryLoad p_neumannBoundaryLoad={})
	Constructor for the LinearElastic class. More...

template<typename ScalarType = double>
auto	displacementFunction (const FERequirementType &par, const std::optional< const Eigen::VectorX< ScalarType > > &dx=std::nullopt) const
	Gets the displacement function for the given FERequirementType and optional displacement vector. More...

template<class ScalarType = double>
auto	strainFunction (const FERequirementType &par, const std::optional< const Eigen::VectorX< ScalarType > > &dx=std::nullopt) const
	Gets the strain function for the given FERequirementType and optional displacement vector. More...

auto	materialTangent () const
	Gets the material tangent matrix for the linear elastic material. More...

auto	materialTangentFunction (const FERequirementType &par) const
	Gets the material tangent function for the given FERequirementType. More...

double	calculateScalar (const FERequirementType &par) const
	Calculates the scalar energy for the given FERequirementType. More...

void	calculateVector (const FERequirementType &par, typename Traits::template VectorType<> force) const
	Calculates the vector force for the given FERequirementType. More...

void	calculateMatrix (const FERequirementType &par, typename Traits::template MatrixType<> K) const
	Calculates the matrix stiffness for the given FERequirementType. More...

void	calculateAt (const ResultRequirementsType &req, const Dune::FieldVector< double, Traits::mydim > &local, ResultTypeMap< double > &result) const
	Calculates results at a specific local position. More...

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

void	globalFlatIndices (std::vector< GlobalIndex > &globalIndices) const
	Get the global flat indices for the power basis. 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...

Public Attributes
std::shared_ptr< const Geometry >	geo_

Dune::CachedLocalBasis< std::remove_cvref_t< LocalBasisType > >	localBasis

std::function< Eigen::Vector< double, worldDim >(const Dune::FieldVector< double, worldDim > &, const double &)>	volumeLoad

std::function< Eigen::Vector< double, worldDim >(const Dune::FieldVector< double, worldDim > &, const double &)>	neumannBoundaryLoad

const BoundaryPatch< GridView > *	neumannBoundary

double	emod_

double	nu_

size_t	numberOfNodes {0}

int	order {}

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

static constexpr int	worldDim = Traits::worlddim

static constexpr int	num_children
	Number of children in the powerBasis. More...

Protected Member Functions
template<typename ScalarType >
auto	calculateScalarImpl (const FERequirementType &par, const std::optional< const Eigen::VectorX< ScalarType > > &dx=std::nullopt) const -> ScalarType

template<typename ScalarType >
void	calculateVectorImpl (const FERequirementType &par, typename Traits::template VectorType< ScalarType > force, const std::optional< const Eigen::VectorX< ScalarType > > &dx=std::nullopt) const

Detailed Description

template<typename Basis_, typename FERequirements_ = FERequirements<>, bool useEigenRef = false>
class Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >

Template Parameters

Basis_	The basis type for the finite element.
FERequirements_	The requirements for the finite element.
useEigenRef	A boolean flag indicating whether to use Eigen references.

Member Typedef Documentation

◆ BaseDisp

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

using Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::BaseDisp = PowerBasisFE<FlatBasis>

◆ Basis

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

using Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::Basis = Basis_

◆ Element

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

using Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::Element = typename LocalView::Element

◆ FERequirementType

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

using Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::FERequirementType = FERequirements_

◆ FlatBasis

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

using Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::FlatBasis = typename Basis::FlatBasis

◆ Geometry

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

using Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::Geometry = typename Element::Geometry

◆ GlobalIndex

using Ikarus::PowerBasisFE< Basis_::FlatBasis >::GlobalIndex = typename LocalView::MultiIndex

inherited

◆ GridElement

using Ikarus::PowerBasisFE< Basis_::FlatBasis >::GridElement = typename LocalView::Element

inherited

◆ GridView

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

using Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::GridView = typename FlatBasis::GridView

◆ LocalBasisType

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

using Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::LocalBasisType = decltype(std::declval<LocalView>().tree().child(0).finiteElement().localBasis())

◆ LocalView

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

using Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::LocalView = typename FlatBasis::LocalView

◆ ResultRequirementsType

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

using Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::ResultRequirementsType = ResultRequirements<FERequirementType>

◆ RootBasis

using Ikarus::PowerBasisFE< Basis_::FlatBasis >::RootBasis = Basis_::FlatBasis

inherited

◆ Traits

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

using Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::Traits = TraitsFromLocalView<LocalView, useEigenRef>

Constructor & Destructor Documentation

◆ LinearElastic()

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

template<typename VolumeLoad = utils::LoadDefault, typename NeumannBoundaryLoad = utils::LoadDefault>

Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::LinearElastic	(	const Basis &	globalBasis,
		const typename LocalView::Element &	element,
		double	emod,
		double	nu,
		VolumeLoad	p_volumeLoad = `{}`,
		const BoundaryPatch< GridView > *	p_neumannBoundary = `nullptr`,
		NeumannBoundaryLoad	p_neumannBoundaryLoad = `{}`
	)

inline

Template Parameters

VolumeLoad	The type for the volume load function.
NeumannBoundaryLoad	The type for the Neumann boundary load function.

Parameters

globalBasis	The global basis for the finite element.
element	The element for which the finite element is constructed.
emod	Young's modulus.
nu	Poisson's ratio.
p_volumeLoad	Volume load function (default is LoadDefault).
p_neumannBoundary	Neumann boundary patch (default is nullptr).
p_neumannBoundaryLoad	Neumann boundary load function (default is LoadDefault).

Member Function Documentation

◆ calculateAt()

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

void Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::calculateAt	(	const ResultRequirementsType &	req,
		const Dune::FieldVector< double, Traits::mydim > &	local,
		ResultTypeMap< double > &	result
	)		const

inline

Parameters

req	The ResultRequirementsType object specifying the requested results.
local	Local position vector.
result	Map to store the calculated results.

◆ calculateMatrix()

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

void Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::calculateMatrix	(	const FERequirementType &	par,
		typename Traits::template MatrixType<>	K
	)		const

inline

Parameters

par	The FERequirementType object.
K	Matrix to store the calculated stiffness.

◆ calculateScalar()

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

double Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::calculateScalar ( const FERequirementType & par ) const

inline

Parameters

par	The FERequirementType object.

Returns: The scalar energy.

◆ calculateScalarImpl()

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

template<typename ScalarType >

auto Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::calculateScalarImpl	(	const FERequirementType &	par,
		const std::optional< const Eigen::VectorX< ScalarType > > &	dx = `std::nullopt`
	)		const -> ScalarType

inlineprotected

◆ calculateVector()

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

void Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::calculateVector	(	const FERequirementType &	par,
		typename Traits::template VectorType<>	force
	)		const

inline

Parameters

par	The FERequirementType object.
force	Vector to store the calculated force.

◆ calculateVectorImpl()

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

template<typename ScalarType >

void Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::calculateVectorImpl	(	const FERequirementType &	par,
		typename Traits::template VectorType< ScalarType >	force,
		const std::optional< const Eigen::VectorX< ScalarType > > &	dx = `std::nullopt`
	)		const

inlineprotected

◆ displacementFunction()

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

template<typename ScalarType = double>

auto Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::displacementFunction	(	const FERequirementType &	par,
		const std::optional< const Eigen::VectorX< ScalarType > > &	dx = `std::nullopt`
	)		const

inline

Template Parameters

ScalarType The scalar type for the displacement vector.

Parameters

par	The FERequirementType object.
dx	Optional displacement vector.

Returns: The displacement function.

Here is the caller graph for this function:

◆ globalFlatIndices()

void Ikarus::PowerBasisFE< Basis_::FlatBasis >::globalFlatIndices ( std::vector< GlobalIndex > & globalIndices ) const

inlineinherited

The global indices are collected in a FlatInterLeaved order. I.e. x_0, y_0, z_0, ..., x_n, y_n, z_n

Parameters

globalIndices Output vector to store global indices.

◆ gridElement()

const GridElement & Ikarus::PowerBasisFE< Basis_::FlatBasis >::gridElement ( ) const

inlineinherited

Returns: The grid element.

◆ localView() [1/2]

LocalView & Ikarus::PowerBasisFE< Basis_::FlatBasis >::localView ( )

inlineinherited

Returns: The reference to the local view.

◆ localView() [2/2]

const LocalView & Ikarus::PowerBasisFE< Basis_::FlatBasis >::localView ( ) const

inlineinherited

Returns: The const reference to the local view.

◆ materialTangent()

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

auto Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::materialTangent ( ) const

inline

Returns: The material tangent matrix.

Here is the caller graph for this function:

◆ materialTangentFunction()

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

auto Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::materialTangentFunction ( const FERequirementType & par ) const

inline

Parameters

par	The FERequirementType object.

Returns: The material tangent function.

◆ size()

constexpr size_t Ikarus::PowerBasisFE< Basis_::FlatBasis >::size ( ) const

inlineconstexprinherited

Returns: The size of the local view.

◆ strainFunction()

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

template<class ScalarType = double>

auto Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::strainFunction	(	const FERequirementType &	par,
		const std::optional< const Eigen::VectorX< ScalarType > > &	dx = `std::nullopt`
	)		const

inline

Template Parameters

ScalarType The scalar type for the strain vector.

Parameters

par	The FERequirementType object.
dx	Optional displacement vector.

Returns: The strain function.

Here is the caller graph for this function:

Member Data Documentation

◆ emod_

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

double Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::emod_

◆ geo_

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

std::shared_ptr<const Geometry> Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::geo_

◆ localBasis

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

Dune::CachedLocalBasis<std::remove_cvref_t<LocalBasisType> > Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::localBasis

◆ myDim

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

constexpr int Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::myDim = Traits::mydim

staticconstexpr

◆ neumannBoundary

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

const BoundaryPatch<GridView>* Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::neumannBoundary

◆ neumannBoundaryLoad

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

std::function<Eigen::Vector<double, worldDim>(const Dune::FieldVector<double, worldDim>&, const double&)> Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::neumannBoundaryLoad

◆ nu_

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

double Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::nu_

◆ num_children

constexpr int Ikarus::PowerBasisFE< Basis_::FlatBasis >::num_children

staticconstexprinherited

◆ numberOfNodes

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

size_t Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::numberOfNodes {0}

◆ order

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

int Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::order {}

◆ volumeLoad

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

std::function<Eigen::Vector<double, worldDim>(const Dune::FieldVector<double, worldDim>&, const double&)> Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::volumeLoad

◆ worldDim

template<typename Basis_ , typename FERequirements_ = FERequirements<>, bool useEigenRef = false>

constexpr int Ikarus::LinearElastic< Basis_, FERequirements_, useEigenRef >::worldDim = Traits::worlddim

staticconstexpr

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

finiteelements/mechanics/linearelastic.hh

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ BaseDisp

◆ Basis

◆ Element

◆ FERequirementType

◆ FlatBasis

◆ Geometry

◆ GlobalIndex

◆ GridElement

◆ GridView

◆ LocalBasisType

◆ LocalView

◆ ResultRequirementsType

◆ RootBasis

◆ Traits

Constructor & Destructor Documentation

◆ LinearElastic()

Member Function Documentation

◆ calculateAt()

◆ calculateMatrix()

◆ calculateScalar()

◆ calculateScalarImpl()

◆ calculateVector()

◆ calculateVectorImpl()

◆ displacementFunction()

◆ globalFlatIndices()

◆ gridElement()

◆ localView() [1/2]

◆ localView() [2/2]

◆ materialTangent()

◆ materialTangentFunction()

◆ size()

◆ strainFunction()

Member Data Documentation

◆ emod_

◆ geo_

◆ localBasis

◆ myDim

◆ neumannBoundary

◆ neumannBoundaryLoad

◆ nu_

◆ num_children

◆ numberOfNodes

◆ order

◆ volumeLoad

◆ worldDim