Ikarus::Volume< DisplacementBasedElement, Traits > Class Template Reference

Volume class represents distributed volume load that can be applied. More...

#include <ikarus/finiteelements/mechanics/loads/volume.hh>

Inheritance diagram for Ikarus::Volume< DisplacementBasedElement, Traits >:

Public Types
using	FERequirementType = typename Traits::FERequirementType
using	LocalView = typename Traits::LocalView

Public Member Functions
template<typename VolumeLoad >
	Volume (VolumeLoad p_volumeLoad={})
	Constructor for the Loads class. More...
double	calculateScalar (const FERequirementType &req) const
	Calculate the scalar value. More...
void	calculateVector (const FERequirementType &req, typename Traits::template VectorType<> force) const
	Calculate the vector associated with the given FERequirementType. More...
void	calculateMatrix (const FERequirementType &req, typename Traits::template MatrixType<> K) const
	Calculate the matrix associated with the given FERequirementType. More...

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

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
template<typename ScalarType >
void	calculateMatrixImpl (const FERequirementType &par, typename Traits::template MatrixType<> K, const std::optional< const Eigen::VectorX< ScalarType > > &dx=std::nullopt) const

Detailed Description

template<typename DisplacementBasedElement, typename Traits>
class Ikarus::Volume< DisplacementBasedElement, Traits >

Template Parameters

DisplacementBasedElement	The type of the displacement-based finite element.
Traits	Type of traits for handling finite elements.

Member Typedef Documentation

FERequirementType

template<typename DisplacementBasedElement , typename Traits >

using Ikarus::Volume< DisplacementBasedElement, Traits >::FERequirementType = typename Traits::FERequirementType

LocalView

template<typename DisplacementBasedElement , typename Traits >

using Ikarus::Volume< DisplacementBasedElement, Traits >::LocalView = typename Traits::LocalView

Constructor & Destructor Documentation

Volume()

template<typename DisplacementBasedElement , typename Traits >

template<typename VolumeLoad >

Ikarus::Volume< DisplacementBasedElement, Traits >::Volume ( VolumeLoad  p_volumeLoad = {} )

inlineexplicit

Template Parameters

VolumeLoad

The type for the volume load function.

Parameters

p_volumeLoad

Volume load function.

Member Function Documentation

calculateMatrix()

template<typename DisplacementBasedElement , typename Traits >

void Ikarus::Volume< DisplacementBasedElement, Traits >::calculateMatrix ( const FERequirementType &  req, typename Traits::template MatrixType<>  K  ) const

inline

Template Parameters

ScalarType

The scalar type for the calculation.

Parameters

req	The FERequirementType object specifying the requirements for the calculation.
K	The matrix to store the calculated result.

Here is the caller graph for this function:

calculateMatrixImpl()

template<typename DisplacementBasedElement , typename Traits >

template<typename ScalarType >

void Ikarus::Volume< DisplacementBasedElement, Traits >::calculateMatrixImpl ( const FERequirementType &  par, typename Traits::template MatrixType<>  K, const std::optional< const Eigen::VectorX< ScalarType > > &  dx = std::nullopt  ) const

inlineprotected

Here is the caller graph for this function:

calculateScalar()

template<typename DisplacementBasedElement , typename Traits >

double Ikarus::Volume< DisplacementBasedElement, Traits >::calculateScalar ( const FERequirementType &  req ) const

inline

Calculates the scalar value based on the given FERequirements.

Parameters

req	The FERequirements.

Returns

The calculated scalar value.

calculateScalarImpl()

template<typename DisplacementBasedElement , typename Traits >

template<typename ScalarType >

auto Ikarus::Volume< DisplacementBasedElement, Traits >::calculateScalarImpl ( const FERequirementType &  par, const std::optional< const Eigen::VectorX< ScalarType > > &  dx = std::nullopt  ) const -> ScalarType

inlineprotected

Here is the caller graph for this function:

calculateVector()

template<typename DisplacementBasedElement , typename Traits >

void Ikarus::Volume< DisplacementBasedElement, Traits >::calculateVector ( const FERequirementType &  req, typename Traits::template VectorType<>  force  ) const

inline

Template Parameters

ScalarType

The scalar type for the calculation.

Parameters

req	The FERequirementType object specifying the requirements for the calculation.
force	The vector to store the calculated result.

calculateVectorImpl()

template<typename DisplacementBasedElement , typename Traits >

template<typename ScalarType >

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

inlineprotected

Here is the caller graph for this function:

Member Data Documentation

worldDim

template<typename DisplacementBasedElement , typename Traits >

constexpr int Ikarus::Volume< DisplacementBasedElement, Traits >::worldDim = Traits::worlddim

staticconstexpr

---

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

• volume.hh