Implementation of the Neo-Hookean material model.The energy is computed as. More...

#include <ikarus/finiteelements/mechanics/materials/neohooke.hh>

Inheritance diagram for Ikarus::NeoHookeT< ScalarType_ >:

Public Types
using	ScalarType = ScalarType_

using	StrainMatrix = Eigen::Matrix< ScalarType, worldDimension, worldDimension >

using	StressMatrix = StrainMatrix

using	MaterialImplType = NeoHookeT< ScalarType_ >
	Type of material implementation. More...

Public Member Functions
constexpr std::string	nameImpl () const noexcept

	NeoHookeT (const LamesFirstParameterAndShearModulus &mpt)
	Constructor for NeoHookeT. More...

template<typename Derived >
ScalarType	storedEnergyImpl (const Eigen::MatrixBase< Derived > &C) const noexcept
	Computes the stored energy in the Neo-Hookean material model. More...

template<bool voigt, typename Derived >
auto	stressesImpl (const Eigen::MatrixBase< Derived > &C) const
	Computes the stresses in the Neo-Hookean material model. More...

template<bool voigt, typename Derived >
auto	tangentModuliImpl (const Eigen::MatrixBase< Derived > &C) const
	Computes the tangent moduli in the Neo-Hookean material model. More...

template<typename ScalarTypeOther >
auto	rebind () const
	Rebinds the material to a different scalar type. More...

constexpr const NeoHookeT< ScalarType_ > &	impl () const
	Const accessor to the underlying material (CRTP). More...

constexpr NeoHookeT< ScalarType_ > &	impl ()
	Accessor to the underlying material (CRTP). More...

constexpr std::string	name () const
	Get the name of the implemented material. More...

auto	storedEnergy (const Eigen::MatrixBase< Derived > &Eraw) const
	Return the stored potential energy of the material. More...

auto	stresses (const Eigen::MatrixBase< Derived > &Eraw) const
	Get the stresses of the material. More...

auto	tangentModuli (const Eigen::MatrixBase< Derived > &Eraw) const
	Get the tangentModuli of the material. More...

Public Attributes
LamesFirstParameterAndShearModulus	lambdaAndmu

Static Public Attributes
static constexpr int	worldDimension = 3

static constexpr auto	strainTag = StrainTags::rightCauchyGreenTensor

static constexpr auto	stressTag = StressTags::PK2

static constexpr auto	tangentModuliTag = TangentModuliTags::Material

static constexpr bool	energyAcceptsVoigt = false

static constexpr bool	stressToVoigt = false

static constexpr bool	stressAcceptsVoigt = false

static constexpr bool	moduliToVoigt = false

static constexpr bool	moduliAcceptsVoigt = false

static constexpr double	derivativeFactor = 2

static constexpr bool	isReduced
	Static constant for determining if the material has vanishing stress components (is reduced). More...

Detailed Description

template<typename ScalarType_>
struct Ikarus::NeoHookeT< ScalarType_ >

\[ \psi(\BC) = \frac{\mu}{2} (\tr \BC-3- 2 \log \sqrt{\det \BC}) + \frac{\lambda}{2} (\log \sqrt{\det \BC})^2 ,\]

where \( \BC \) denotes the right Cauchy-Green strain tensor.

The second Piola-Kirchhoff stresses are computed as

\[ \BS(\BC) =\fracpt{\psi(\BC)}{\BC} = \mu (\BI-\BC^{-1}) + \lambda \log \sqrt{\det \BC} \BC^{-1},\]

and the material tangent moduli are computed as

\[ \BBC(\BC) =\fracpt{^2\psi(\BC)}{\BC^2} = \lambda \BC^{-1} \otimes \BC^{-1} + 2 (\mu- \lambda \log \sqrt{\det \BC} ) \CI,\]

where \( \CI_{IJKL} = \frac{1}{2}({(\BC^{-1})}^{IK}{(\BC^{-1})}^{JL}+{(\BC^{-1})}^{IL} {(\BC^{-1})}^{JK}).\)

Remarks: See [1], Section 6.4.3 for a discussion of this material

Template Parameters

ScalarType_ The scalar type for the strains and stresses,....

Member Typedef Documentation

◆ MaterialImplType

using Ikarus::Material< NeoHookeT< ScalarType_ > >::MaterialImplType = NeoHookeT< ScalarType_ >

inherited

◆ ScalarType

template<typename ScalarType_ >

using Ikarus::NeoHookeT< ScalarType_ >::ScalarType = ScalarType_

◆ StrainMatrix

template<typename ScalarType_ >

using Ikarus::NeoHookeT< ScalarType_ >::StrainMatrix = Eigen::Matrix<ScalarType, worldDimension, worldDimension>

◆ StressMatrix

template<typename ScalarType_ >

using Ikarus::NeoHookeT< ScalarType_ >::StressMatrix = StrainMatrix

Constructor & Destructor Documentation

◆ NeoHookeT()

template<typename ScalarType_ >

Ikarus::NeoHookeT< ScalarType_ >::NeoHookeT ( const LamesFirstParameterAndShearModulus & mpt )

inlineexplicit

Parameters

mpt	The Lame's parameters (first parameter and shear modulus).

Member Function Documentation

◆ impl() [1/2]

constexpr NeoHookeT< ScalarType_ > & Ikarus::Material< NeoHookeT< ScalarType_ > >::impl ( )

inlineconstexprinherited

Returns: Reference to the underlying material.

◆ impl() [2/2]

constexpr const NeoHookeT< ScalarType_ > & Ikarus::Material< NeoHookeT< ScalarType_ > >::impl ( ) const

inlineconstexprinherited

Returns: Const reference to the underlying material.

◆ name()

constexpr std::string Ikarus::Material< NeoHookeT< ScalarType_ > >::name ( ) const

inlineconstexprinherited

Returns: Name of the material.

◆ nameImpl()

template<typename ScalarType_ >

constexpr std::string Ikarus::NeoHookeT< ScalarType_ >::nameImpl ( ) const

inlineconstexprnoexcept

◆ rebind()

template<typename ScalarType_ >

template<typename ScalarTypeOther >

auto Ikarus::NeoHookeT< ScalarType_ >::rebind ( ) const

inline

Template Parameters

ScalarTypeOther The target scalar type.

Returns: NeoHookeT<ScalarTypeOther> The rebound NeoHooke material.

◆ storedEnergy()

auto Ikarus::Material< NeoHookeT< ScalarType_ > >::storedEnergy ( const Eigen::MatrixBase< Derived > & Eraw ) const

inlineinherited

This function return the free Helmholtz energy of the material

Template Parameters

tag	Strain tag indicating which strain tensor components are passed.
Derived	The underlying Eigen type.

Parameters

Eraw	The strain tensor components passed in Voigt notation or matrix notation.

Returns: Scalar return of stored energy.

◆ storedEnergyImpl()

template<typename ScalarType_ >

template<typename Derived >

ScalarType Ikarus::NeoHookeT< ScalarType_ >::storedEnergyImpl ( const Eigen::MatrixBase< Derived > & C ) const

inlinenoexcept

Template Parameters

Derived The derived type of the input matrix.

Parameters

C	The right Cauchy-Green tensor.

Returns: ScalarType The stored energy.

◆ stresses()

auto Ikarus::Material< NeoHookeT< ScalarType_ > >::stresses ( const Eigen::MatrixBase< Derived > & Eraw ) const

inlineinherited

Template Parameters

tag	Strain tag indicating which strain tensor components are passed.
voigt	Boolean indicating whether to return Voigt-shaped result.
Derived	The underlying Eigen type.

Parameters

Eraw	The strain tensor components passed in Voigt notation or matrix notation.

Returns: Vectorial or Matrix return of stresses.

◆ stressesImpl()

template<typename ScalarType_ >

template<bool voigt, typename Derived >

auto Ikarus::NeoHookeT< ScalarType_ >::stressesImpl ( const Eigen::MatrixBase< Derived > & C ) const

inline

Template Parameters

voigt	A boolean indicating whether to return stresses in Voigt notation.
Derived	The derived type of the input matrix.

Parameters

C	The right Cauchy-Green tensor.

Returns: StressMatrix The stresses.

◆ tangentModuli()

auto Ikarus::Material< NeoHookeT< ScalarType_ > >::tangentModuli ( const Eigen::MatrixBase< Derived > & Eraw ) const

inlineinherited

Template Parameters

tag	Strain tag indicating which strain tensor components are passed.
voigt	Boolean indicating whether to return Voigt-shaped result.
Derived	The underlying Eigen type.

Parameters

Eraw	The strain tensor components passed in Voigt notation or matrix notation.

Returns: Tangent moduli in Voigt notation or as fourth-order tensor.

◆ tangentModuliImpl()

template<typename ScalarType_ >

template<bool voigt, typename Derived >

auto Ikarus::NeoHookeT< ScalarType_ >::tangentModuliImpl ( const Eigen::MatrixBase< Derived > & C ) const

inline

Template Parameters

voigt	A boolean indicating whether to return tangent moduli in Voigt notation.
Derived	The derived type of the input matrix.

Parameters

C	The right Cauchy-Green tensor.

Returns: Eigen::TensorFixedSize<ScalarType, Eigen::Sizes<3, 3, 3, 3>> The tangent moduli.

Member Data Documentation

◆ derivativeFactor

template<typename ScalarType_ >

constexpr double Ikarus::NeoHookeT< ScalarType_ >::derivativeFactor = 2

staticconstexpr

◆ energyAcceptsVoigt

template<typename ScalarType_ >

constexpr bool Ikarus::NeoHookeT< ScalarType_ >::energyAcceptsVoigt = false

staticconstexpr

◆ isReduced

constexpr bool Ikarus::Material< NeoHookeT< ScalarType_ > >::isReduced

staticconstexprinherited

◆ lambdaAndmu

template<typename ScalarType_ >

LamesFirstParameterAndShearModulus Ikarus::NeoHookeT< ScalarType_ >::lambdaAndmu

◆ moduliAcceptsVoigt

template<typename ScalarType_ >

constexpr bool Ikarus::NeoHookeT< ScalarType_ >::moduliAcceptsVoigt = false

staticconstexpr

◆ moduliToVoigt

template<typename ScalarType_ >

constexpr bool Ikarus::NeoHookeT< ScalarType_ >::moduliToVoigt = false

staticconstexpr

◆ strainTag

template<typename ScalarType_ >

constexpr auto Ikarus::NeoHookeT< ScalarType_ >::strainTag = StrainTags::rightCauchyGreenTensor

staticconstexpr

◆ stressAcceptsVoigt

template<typename ScalarType_ >

constexpr bool Ikarus::NeoHookeT< ScalarType_ >::stressAcceptsVoigt = false

staticconstexpr

◆ stressTag

template<typename ScalarType_ >

constexpr auto Ikarus::NeoHookeT< ScalarType_ >::stressTag = StressTags::PK2

staticconstexpr

◆ stressToVoigt

template<typename ScalarType_ >

constexpr bool Ikarus::NeoHookeT< ScalarType_ >::stressToVoigt = false

staticconstexpr

◆ tangentModuliTag

template<typename ScalarType_ >

constexpr auto Ikarus::NeoHookeT< ScalarType_ >::tangentModuliTag = TangentModuliTags::Material

staticconstexpr

◆ worldDimension

template<typename ScalarType_ >

constexpr int Ikarus::NeoHookeT< ScalarType_ >::worldDimension = 3

staticconstexpr

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

neohooke.hh

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ MaterialImplType

◆ ScalarType

◆ StrainMatrix

◆ StressMatrix

Constructor & Destructor Documentation

◆ NeoHookeT()

Member Function Documentation

◆ impl() [1/2]

◆ impl() [2/2]

◆ name()

◆ nameImpl()

◆ rebind()

◆ storedEnergy()

◆ storedEnergyImpl()

◆ stresses()

◆ stressesImpl()

◆ tangentModuli()

◆ tangentModuliImpl()

Member Data Documentation

◆ derivativeFactor

◆ energyAcceptsVoigt

◆ isReduced

◆ lambdaAndmu

◆ moduliAcceptsVoigt

◆ moduliToVoigt

◆ strainTag

◆ stressAcceptsVoigt

◆ stressTag

◆ stressToVoigt

◆ tangentModuliTag

◆ worldDimension