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

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

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

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

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

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

Public Member Functions
	VanishingStress (MI mat, typename MI::ScalarType 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 MaterialImpl &	impl () const
	Const accessor to the underlying material (CRTP). More...

constexpr 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
	Number of fixed diagonal indices. More...

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

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

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

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

static constexpr bool	energyAcceptsVoigt = Underlying::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 MI>
struct Ikarus::VanishingStress< stressIndexPair, MI >

Template Parameters

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

Member Typedef Documentation

◆ MaterialImpl

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

inherited

◆ ScalarType

template<auto stressIndexPair, typename MI >

using Ikarus::VanishingStress< stressIndexPair, MI >::ScalarType = typename Underlying::ScalarType

◆ Underlying

template<auto stressIndexPair, typename MI >

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

Constructor & Destructor Documentation

◆ VanishingStress()

template<auto stressIndexPair, typename MI >

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

inlineexplicit

Parameters

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

Member Function Documentation

◆ impl() [1/2]

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

inlineconstexprinherited

Returns: Reference to the underlying material.

◆ impl() [2/2]

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

inlineconstexprinherited

Returns: Const reference to the underlying material.

◆ name()

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

inlineconstexprinherited

Returns: Name of the material.

◆ nameImpl()

template<auto stressIndexPair, typename MI >

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

inlineconstexprnoexcept

◆ rebind()

template<auto stressIndexPair, typename MI >

template<typename ScalarTypeOther >

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

inline

Template Parameters

ScalarTypeOther The target scalar type.

Returns: VanishingStress The rebound VanishingStress material.

◆ storedEnergy()

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

template<typename Derived >

ScalarType Ikarus::VanishingStress< stressIndexPair, MI >::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, MI > >::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 MI >

template<bool voigt, typename Derived >

auto Ikarus::VanishingStress< stressIndexPair, MI >::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, MI > >::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 MI >

template<bool voigt, typename Derived >

auto Ikarus::VanishingStress< stressIndexPair, MI >::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 MI >

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

staticconstexpr

◆ energyAcceptsVoigt

template<auto stressIndexPair, typename MI >

constexpr bool Ikarus::VanishingStress< stressIndexPair, MI >::energyAcceptsVoigt = Underlying::energyAcceptsVoigt

staticconstexpr

◆ fixedDiagonalVoigtIndicesSize

template<auto stressIndexPair, typename MI >

constexpr auto Ikarus::VanishingStress< stressIndexPair, MI >::fixedDiagonalVoigtIndicesSize

staticconstexpr

Initial value:

=

countDiagonalIndices(fixedPairs)

Ikarus::VanishingStress::fixedPairs

static constexpr auto fixedPairs

Array of fixed stress components.

Definition: vanishingstress.hh:101

◆ fixedPairs

template<auto stressIndexPair, typename MI >

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

staticconstexpr

◆ fixedVoigtIndices

template<auto stressIndexPair, typename MI >

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

staticconstexpr

◆ freeStrains

template<auto stressIndexPair, typename MI >

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

staticconstexpr

◆ freeVoigtIndices

template<auto stressIndexPair, typename MI >

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

staticconstexpr

◆ isReduced

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

staticconstexprinherited

◆ moduliAcceptsVoigt

template<auto stressIndexPair, typename MI >

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

staticconstexpr

◆ moduliToVoigt

template<auto stressIndexPair, typename MI >

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

staticconstexpr

◆ strainTag

template<auto stressIndexPair, typename MI >

constexpr auto Ikarus::VanishingStress< stressIndexPair, MI >::strainTag = Underlying::strainTag

staticconstexpr

◆ stressAcceptsVoigt

template<auto stressIndexPair, typename MI >

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

staticconstexpr

◆ stressTag

template<auto stressIndexPair, typename MI >

constexpr auto Ikarus::VanishingStress< stressIndexPair, MI >::stressTag = Underlying::stressTag

staticconstexpr

◆ stressToVoigt

template<auto stressIndexPair, typename MI >

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

staticconstexpr

◆ tangentModuliTag

template<auto stressIndexPair, typename MI >

constexpr auto Ikarus::VanishingStress< stressIndexPair, MI >::tangentModuliTag = Underlying::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

◆ MaterialImpl

◆ 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