VanishingStress material model that enforces stress components to be zero. More...

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

Inheritance diagram for Ikarus::VanishingStress< stressIndexPair, MaterialImpl >:

Public Types
using	Underlying = MaterialImpl
	The underlying material type. More...

using	ScalarType = typename MaterialImpl::ScalarType
	Scalar type. More...

using	MaterialImplType = VanishingStress< stressIndexPair, MaterialImpl >
	Type of material implementation. More...

Public Member Functions
	VanishingStress (MaterialImpl mat, typename MaterialImpl::ScalarType p_tol=1e-12)
	Constructor for VanishingStress. More...

constexpr std::string	nameImpl () const noexcept

template<typename Derived >
ScalarType	storedEnergyImpl (const Eigen::MatrixBase< Derived > &E) const
	Computes the stored energy for the VanishingStress material. More...

template<bool voigt, typename Derived >
auto	stressesImpl (const Eigen::MatrixBase< Derived > &E) const
	Computes the stresses for the VanishingStress material. More...

template<bool voigt, typename Derived >
auto	tangentModuliImpl (const Eigen::MatrixBase< Derived > &E) const
	Computes the tangent moduli for the VanishingStress material. More...

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

constexpr const VanishingStress< stressIndexPair, MaterialImpl > &	impl () const
	Const accessor to the underlying material (CRTP). More...

constexpr VanishingStress< stressIndexPair, MaterialImpl > &	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...

Static Public Attributes
static constexpr auto	fixedPairs = stressIndexPair
	Array of fixed stress components. More...

static constexpr auto	freeVoigtIndices = createfreeVoigtIndices(fixedPairs)
	Free Voigt indices. More...

static constexpr auto	fixedVoigtIndices = createFixedVoigtIndices(fixedPairs)
	Fixed Voigt indices. More...

static constexpr auto	fixedDiagonalVoigtIndicesSize = countDiagonalIndices(fixedPairs)
	Number of fixed diagonal indices. More...

static constexpr auto	freeStrains = freeVoigtIndices.size()
	Number of free strains. More...

static constexpr auto	strainTag = MaterialImpl::strainTag
	Strain tag. More...

static constexpr auto	stressTag = MaterialImpl::stressTag
	Stress tag. More...

static constexpr auto	tangentModuliTag = MaterialImpl::tangentModuliTag
	Tangent moduli tag. More...

static constexpr bool	energyAcceptsVoigt = MaterialImpl::energyAcceptsVoigt
	Energy accepts Voigt notation. More...

static constexpr bool	stressToVoigt = true
	Stress to Voigt notation. More...

static constexpr bool	stressAcceptsVoigt = true
	Stress accepts Voigt notation. More...

static constexpr bool	moduliToVoigt = true
	Moduli to Voigt notation. More...

static constexpr bool	moduliAcceptsVoigt = true
	Moduli accepts Voigt notation. More...

static constexpr double	derivativeFactor = 1
	Derivative factor. More...

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

Detailed Description

template<auto stressIndexPair, typename MaterialImpl>
struct Ikarus::VanishingStress< stressIndexPair, MaterialImpl >

Template Parameters

stressIndexPair	An array of StressIndexPair representing fixed stress components.
MaterialImpl	The underlying material model.

Member Typedef Documentation

◆ MaterialImplType

using Ikarus::Material< VanishingStress< stressIndexPair, MaterialImpl > >::MaterialImplType = VanishingStress< stressIndexPair, MaterialImpl >

inherited

◆ ScalarType

template<auto stressIndexPair, typename MaterialImpl >

using Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::ScalarType = typename MaterialImpl::ScalarType

◆ Underlying

template<auto stressIndexPair, typename MaterialImpl >

using Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::Underlying = MaterialImpl

Constructor & Destructor Documentation

◆ VanishingStress()

template<auto stressIndexPair, typename MaterialImpl >

Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::VanishingStress	(	MaterialImpl	mat,
		typename MaterialImpl::ScalarType	p_tol = `1e-12`
	)

inlineexplicit

Parameters

mat	The underlying material model.
p_tol	Tolerance for stress reduction.

Member Function Documentation

◆ impl() [1/2]

constexpr VanishingStress< stressIndexPair, MaterialImpl > & Ikarus::Material< VanishingStress< stressIndexPair, MaterialImpl > >::impl ( )

inlineconstexprinherited

Returns: Reference to the underlying material.

◆ impl() [2/2]

constexpr const VanishingStress< stressIndexPair, MaterialImpl > & Ikarus::Material< VanishingStress< stressIndexPair, MaterialImpl > >::impl ( ) const

inlineconstexprinherited

Returns: Const reference to the underlying material.

◆ name()

constexpr std::string Ikarus::Material< VanishingStress< stressIndexPair, MaterialImpl > >::name ( ) const

inlineconstexprinherited

Returns: Name of the material.

◆ nameImpl()

template<auto stressIndexPair, typename MaterialImpl >

constexpr std::string Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::nameImpl ( ) const

inlineconstexprnoexcept

◆ rebind()

template<auto stressIndexPair, typename MaterialImpl >

template<typename ScalarTypeOther >

auto Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::rebind ( ) const

inline

Template Parameters

ScalarTypeOther The target scalar type.

Returns: VanishingStress The rebound VanishingStress material.

◆ storedEnergy()

auto Ikarus::Material< VanishingStress< stressIndexPair, MaterialImpl > >::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<auto stressIndexPair, typename MaterialImpl >

template<typename Derived >

ScalarType Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::storedEnergyImpl ( const Eigen::MatrixBase< Derived > & E ) const

inline

Template Parameters

Derived The derived type of the input matrix.

Parameters

E	The Green-Lagrangian strain.

Returns: ScalarType The stored energy.

◆ stresses()

auto Ikarus::Material< VanishingStress< stressIndexPair, MaterialImpl > >::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<auto stressIndexPair, typename MaterialImpl >

template<bool voigt, typename Derived >

auto Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::stressesImpl ( const Eigen::MatrixBase< Derived > & E ) const

inline

Template Parameters

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

Parameters

E	The Green-Lagrangian strain.

Returns: StressMatrix The stresses.

◆ tangentModuli()

auto Ikarus::Material< VanishingStress< stressIndexPair, MaterialImpl > >::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<auto stressIndexPair, typename MaterialImpl >

template<bool voigt, typename Derived >

auto Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::tangentModuliImpl ( const Eigen::MatrixBase< Derived > & E ) 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

E	The Green-Lagrangian strain.

Returns: TangentModuli The tangent moduli.

Member Data Documentation

◆ derivativeFactor

template<auto stressIndexPair, typename MaterialImpl >

constexpr double Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::derivativeFactor = 1

staticconstexpr

◆ energyAcceptsVoigt

template<auto stressIndexPair, typename MaterialImpl >

constexpr bool Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::energyAcceptsVoigt = MaterialImpl::energyAcceptsVoigt

staticconstexpr

◆ fixedDiagonalVoigtIndicesSize

template<auto stressIndexPair, typename MaterialImpl >

constexpr auto Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::fixedDiagonalVoigtIndicesSize = countDiagonalIndices(fixedPairs)

staticconstexpr

◆ fixedPairs

template<auto stressIndexPair, typename MaterialImpl >

constexpr auto Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::fixedPairs = stressIndexPair

staticconstexpr

◆ fixedVoigtIndices

template<auto stressIndexPair, typename MaterialImpl >

constexpr auto Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::fixedVoigtIndices = createFixedVoigtIndices(fixedPairs)

staticconstexpr

◆ freeStrains

template<auto stressIndexPair, typename MaterialImpl >

constexpr auto Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::freeStrains = freeVoigtIndices.size()

staticconstexpr

◆ freeVoigtIndices

template<auto stressIndexPair, typename MaterialImpl >

constexpr auto Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::freeVoigtIndices = createfreeVoigtIndices(fixedPairs)

staticconstexpr

◆ isReduced

constexpr bool Ikarus::Material< VanishingStress< stressIndexPair, MaterialImpl > >::isReduced

staticconstexprinherited

◆ moduliAcceptsVoigt

template<auto stressIndexPair, typename MaterialImpl >

constexpr bool Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::moduliAcceptsVoigt = true

staticconstexpr

◆ moduliToVoigt

template<auto stressIndexPair, typename MaterialImpl >

constexpr bool Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::moduliToVoigt = true

staticconstexpr

◆ strainTag

template<auto stressIndexPair, typename MaterialImpl >

constexpr auto Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::strainTag = MaterialImpl::strainTag

staticconstexpr

◆ stressAcceptsVoigt

template<auto stressIndexPair, typename MaterialImpl >

constexpr bool Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::stressAcceptsVoigt = true

staticconstexpr

◆ stressTag

template<auto stressIndexPair, typename MaterialImpl >

constexpr auto Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::stressTag = MaterialImpl::stressTag

staticconstexpr

◆ stressToVoigt

template<auto stressIndexPair, typename MaterialImpl >

constexpr bool Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::stressToVoigt = true

staticconstexpr

◆ tangentModuliTag

template<auto stressIndexPair, typename MaterialImpl >

constexpr auto Ikarus::VanishingStress< stressIndexPair, MaterialImpl >::tangentModuliTag = MaterialImpl::tangentModuliTag

staticconstexpr

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

vanishingstress.hh

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ MaterialImplType

◆ ScalarType

◆ Underlying

Constructor & Destructor Documentation

◆ VanishingStress()

Member Function Documentation

◆ impl() [1/2]

◆ impl() [2/2]

◆ name()

◆ nameImpl()

◆ rebind()

◆ storedEnergy()

◆ storedEnergyImpl()

◆ stresses()

◆ stressesImpl()

◆ tangentModuli()

◆ tangentModuliImpl()

Member Data Documentation

◆ derivativeFactor

◆ energyAcceptsVoigt

◆ fixedDiagonalVoigtIndicesSize

◆ fixedPairs

◆ fixedVoigtIndices

◆ freeStrains

◆ freeVoigtIndices

◆ isReduced

◆ moduliAcceptsVoigt

◆ moduliToVoigt

◆ strainTag

◆ stressAcceptsVoigt

◆ stressTag

◆ stressToVoigt

◆ tangentModuliTag