Lamé's first modulus of elasticity of a deformable solid material. First of the two Lamé parameters. A measure of a deformable solid material's elastic modulus. For other measures of a material's elastic modulus, see PhQ::YoungModulus, PhQ::ShearModulus, PhQ::IsentropicBulkModulus, PhQ::IsothermalBulkModulus, PhQ::PWaveModulus, and PhQ::PoissonRatio. More...

#include "LameFirstModulus.hpp"

Public Member Functions
	LameFirstModulus ()=default
	Default constructor. Constructs a Lamé's first modulus with an uninitialized value. More...

	LameFirstModulus (const NumericType value, const Unit::Pressure unit)
	Constructor. Constructs a Lamé's first modulus with a given value expressed in a given pressure unit. More...

	~LameFirstModulus () noexcept=default
	Destructor. Destroys this Lamé's first modulus. More...

constexpr	LameFirstModulus (const LameFirstModulus< NumericType > &other)=default
	Copy constructor. Constructs a Lamé's first modulus by copying another one. More...

template<typename OtherNumericType >
constexpr	LameFirstModulus (const LameFirstModulus< OtherNumericType > &other)
	Copy constructor. Constructs a Lamé's first modulus by copying another one. More...

constexpr	LameFirstModulus (LameFirstModulus< NumericType > &&other) noexcept=default
	Move constructor. Constructs a Lamé's first modulus by moving another one. More...

constexpr LameFirstModulus< NumericType > &	operator= (const LameFirstModulus< NumericType > &other)=default
	Copy assignment operator. Assigns this Lamé's first modulus by copying another one. More...

template<typename OtherNumericType >
constexpr LameFirstModulus< NumericType > &	operator= (const LameFirstModulus< OtherNumericType > &other)
	Copy assignment operator. Assigns this Lamé's first modulus by copying another one. More...

constexpr LameFirstModulus< NumericType > &	operator= (LameFirstModulus< NumericType > &&other) noexcept=default
	Move assignment operator. Assigns this Lamé's first modulus by moving another one. More...

constexpr LameFirstModulus< NumericType >	operator+ (const LameFirstModulus< NumericType > &lame_first_modulus) const

constexpr LameFirstModulus< NumericType >	operator- (const LameFirstModulus< NumericType > &lame_first_modulus) const

constexpr LameFirstModulus< NumericType >	operator* (const NumericType number) const

constexpr LameFirstModulus< NumericType >	operator/ (const NumericType number) const

constexpr NumericType	operator/ (const LameFirstModulus< NumericType > &lame_first_modulus) const noexcept

constexpr void	operator+= (const LameFirstModulus< NumericType > &lame_first_modulus) noexcept

constexpr void	operator-= (const LameFirstModulus< NumericType > &lame_first_modulus) noexcept

constexpr void	operator*= (const NumericType number) noexcept

constexpr void	operator/= (const NumericType number) noexcept

constexpr double	Value () const noexcept
	Value of this physical quantity expressed in its standard unit of measure. More...

double	Value (const Unit::Pressure unit) const
	Value of this physical quantity expressed in a given unit of measure. More...

constexpr double	StaticValue () const
	Value of this physical quantity expressed in a given unit of measure. This method can be evaluated statically at compile-time. More...

constexpr double &	MutableValue () noexcept
	Returns the value of this physical quantity expressed in its standard unit of measure as a mutable value. More...

constexpr void	SetValue (const double value) noexcept
	Sets the value of this physical quantity expressed in its standard unit of measure to the given value. More...

std::string	Print () const
	Prints this physical quantity as a string. This physical quantity's value is expressed in its standard unit of measure. More...

std::string	Print (const Unit::Pressure unit) const
	Prints this physical quantity as a string. This physical quantity's value is expressed in the given unit of measure. More...

std::string	JSON () const
	Serializes this physical quantity as a JSON message. This physical quantity's value is expressed in its standard unit of measure. More...

std::string	JSON (const Unit::Pressure unit) const
	Serializes this physical quantity as a JSON message. This physical quantity's value is expressed in the given unit of measure. More...

std::string	XML () const
	Serializes this physical quantity as an XML message. This physical quantity's value is expressed in its standard unit of measure. More...

std::string	XML (const Unit::Pressure unit) const
	Serializes this physical quantity as an XML message. This physical quantity's value is expressed in the given unit of measure. More...

std::string	YAML () const
	Serializes this physical quantity as a YAML message. This physical quantity's value is expressed in its standard unit of measure. More...

std::string	YAML (const Unit::Pressure unit) const
	Serializes this physical quantity as a YAML message. This physical quantity's value is expressed in the given unit of measure. More...

Static Public Member Functions
static constexpr LameFirstModulus< NumericType >	Zero ()
	Statically creates a Lamé's first modulus of zero. More...

template<Unit::Pressure Unit>
static constexpr LameFirstModulus< NumericType >	Create (const NumericType value)
	Statically creates a Lamé's first modulus with a given value expressed in a given pressure unit. More...

static constexpr const PhQ::Dimensions &	Dimensions ()
	Physical dimension set of this physical quantity. More...

static constexpr Unit::Pressure	Unit ()
	Standard unit of measure for this physical quantity. This physical quantity's value is stored internally in this unit of measure. More...

Protected Attributes
double	value
	Value of this physical quantity expressed in its standard unit of measure. More...

Private Member Functions
constexpr	LameFirstModulus (const NumericType value)
	Constructor. Constructs a Lamé's first modulus with a given value expressed in the standard pressure unit. More...

Friends
class	ConstitutiveModel

Detailed Description

template<typename NumericType = double>
class PhQ::LameFirstModulus< NumericType >

Lamé's first modulus of elasticity of a deformable solid material. First of the two Lamé parameters. A measure of a deformable solid material's elastic modulus. For other measures of a material's elastic modulus, see PhQ::YoungModulus, PhQ::ShearModulus, PhQ::IsentropicBulkModulus, PhQ::IsothermalBulkModulus, PhQ::PWaveModulus, and PhQ::PoissonRatio.

Definition at line 43 of file LameFirstModulus.hpp.

Constructor & Destructor Documentation

◆ LameFirstModulus() [1/6]

template<typename NumericType = double>

PhQ::LameFirstModulus< NumericType >::LameFirstModulus ( )

default

Default constructor. Constructs a Lamé's first modulus with an uninitialized value.

◆ LameFirstModulus() [2/6]

template<typename NumericType = double>

PhQ::LameFirstModulus< NumericType >::LameFirstModulus	(	const NumericType	value,
		const Unit::Pressure	unit
	)

inline

Constructor. Constructs a Lamé's first modulus with a given value expressed in a given pressure unit.

Definition at line 50 of file LameFirstModulus.hpp.

◆ ~LameFirstModulus()

template<typename NumericType = double>

PhQ::LameFirstModulus< NumericType >::~LameFirstModulus ( )

defaultnoexcept

Destructor. Destroys this Lamé's first modulus.

◆ LameFirstModulus() [3/6]

template<typename NumericType = double>

constexpr PhQ::LameFirstModulus< NumericType >::LameFirstModulus ( const LameFirstModulus< NumericType > & other )

constexprdefault

Copy constructor. Constructs a Lamé's first modulus by copying another one.

◆ LameFirstModulus() [4/6]

template<typename NumericType = double>

template<typename OtherNumericType >

constexpr PhQ::LameFirstModulus< NumericType >::LameFirstModulus ( const LameFirstModulus< OtherNumericType > & other )

inlineexplicitconstexpr

Copy constructor. Constructs a Lamé's first modulus by copying another one.

Definition at line 61 of file LameFirstModulus.hpp.

◆ LameFirstModulus() [5/6]

template<typename NumericType = double>

constexpr PhQ::LameFirstModulus< NumericType >::LameFirstModulus ( LameFirstModulus< NumericType > && other )

constexprdefaultnoexcept

Move constructor. Constructs a Lamé's first modulus by moving another one.

◆ LameFirstModulus() [6/6]

template<typename NumericType = double>

constexpr PhQ::LameFirstModulus< NumericType >::LameFirstModulus ( const NumericType value )

inlineexplicitconstexprprivate

Constructor. Constructs a Lamé's first modulus with a given value expressed in the standard pressure unit.

Definition at line 138 of file LameFirstModulus.hpp.

Member Function Documentation

◆ Create()

template<typename NumericType = double>

template<Unit::Pressure Unit>

static constexpr LameFirstModulus<NumericType> PhQ::LameFirstModulus< NumericType >::Create ( const NumericType value )

inlinestaticconstexpr

Statically creates a Lamé's first modulus with a given value expressed in a given pressure unit.

Definition at line 91 of file LameFirstModulus.hpp.

References PhQ::DimensionalScalar< Unit::Pressure, double >::value.

◆ Dimensions()

static constexpr const PhQ::Dimensions& PhQ::DimensionalScalar< Unit::Pressure , double >::Dimensions ( )

inlinestaticconstexprinherited

Physical dimension set of this physical quantity.

Definition at line 54 of file DimensionalScalar.hpp.

◆ JSON() [1/2]

std::string PhQ::DimensionalScalar< Unit::Pressure , double >::JSON ( ) const

inlineinherited

Serializes this physical quantity as a JSON message. This physical quantity's value is expressed in its standard unit of measure.

Definition at line 107 of file DimensionalScalar.hpp.

◆ JSON() [2/2]

std::string PhQ::DimensionalScalar< Unit::Pressure , double >::JSON ( const UnitType unit ) const

inlineinherited

Serializes this physical quantity as a JSON message. This physical quantity's value is expressed in the given unit of measure.

Definition at line 117 of file DimensionalScalar.hpp.

◆ MutableValue()

constexpr double & PhQ::DimensionalScalar< Unit::Pressure , double >::MutableValue ( )

inlineconstexprnoexceptinherited

Returns the value of this physical quantity expressed in its standard unit of measure as a mutable value.

Definition at line 83 of file DimensionalScalar.hpp.

◆ operator*()

template<typename NumericType = double>

constexpr LameFirstModulus<NumericType> PhQ::LameFirstModulus< NumericType >::operator* ( const NumericType number ) const

inlineconstexpr

Definition at line 106 of file LameFirstModulus.hpp.

References PhQ::DimensionalScalar< Unit::Pressure, double >::value.

◆ operator*=()

template<typename NumericType = double>

constexpr void PhQ::LameFirstModulus< NumericType >::operator*= ( const NumericType number )

inlineconstexprnoexcept

Definition at line 127 of file LameFirstModulus.hpp.

References PhQ::DimensionalScalar< Unit::Pressure, double >::value.

◆ operator+()

template<typename NumericType = double>

constexpr LameFirstModulus<NumericType> PhQ::LameFirstModulus< NumericType >::operator+ ( const LameFirstModulus< NumericType > & lame_first_modulus ) const

inlineconstexpr

Definition at line 96 of file LameFirstModulus.hpp.

References PhQ::DimensionalScalar< UnitType, NumericType >::value, and PhQ::DimensionalScalar< Unit::Pressure, double >::value.

◆ operator+=()

template<typename NumericType = double>

constexpr void PhQ::LameFirstModulus< NumericType >::operator+= ( const LameFirstModulus< NumericType > & lame_first_modulus )

inlineconstexprnoexcept

Definition at line 119 of file LameFirstModulus.hpp.

References PhQ::DimensionalScalar< Unit::Pressure, double >::value.

◆ operator-()

template<typename NumericType = double>

constexpr LameFirstModulus<NumericType> PhQ::LameFirstModulus< NumericType >::operator- ( const LameFirstModulus< NumericType > & lame_first_modulus ) const

inlineconstexpr

Definition at line 101 of file LameFirstModulus.hpp.

References PhQ::DimensionalScalar< UnitType, NumericType >::value, and PhQ::DimensionalScalar< Unit::Pressure, double >::value.

◆ operator-=()

template<typename NumericType = double>

constexpr void PhQ::LameFirstModulus< NumericType >::operator-= ( const LameFirstModulus< NumericType > & lame_first_modulus )

inlineconstexprnoexcept

Definition at line 123 of file LameFirstModulus.hpp.

References PhQ::DimensionalScalar< Unit::Pressure, double >::value.

◆ operator/() [1/2]

template<typename NumericType = double>

constexpr NumericType PhQ::LameFirstModulus< NumericType >::operator/ ( const LameFirstModulus< NumericType > & lame_first_modulus ) const

inlineconstexprnoexcept

Definition at line 114 of file LameFirstModulus.hpp.

References PhQ::DimensionalScalar< Unit::Pressure, double >::value.

◆ operator/() [2/2]

template<typename NumericType = double>

constexpr LameFirstModulus<NumericType> PhQ::LameFirstModulus< NumericType >::operator/ ( const NumericType number ) const

inlineconstexpr

Definition at line 110 of file LameFirstModulus.hpp.

References PhQ::DimensionalScalar< Unit::Pressure, double >::value.

◆ operator/=()

template<typename NumericType = double>

constexpr void PhQ::LameFirstModulus< NumericType >::operator/= ( const NumericType number )

inlineconstexprnoexcept

Definition at line 131 of file LameFirstModulus.hpp.

References PhQ::DimensionalScalar< Unit::Pressure, double >::value.

◆ operator=() [1/3]

template<typename NumericType = double>

constexpr LameFirstModulus<NumericType>& PhQ::LameFirstModulus< NumericType >::operator= ( const LameFirstModulus< NumericType > & other )

constexprdefault

Copy assignment operator. Assigns this Lamé's first modulus by copying another one.

◆ operator=() [2/3]

template<typename NumericType = double>

template<typename OtherNumericType >

constexpr LameFirstModulus<NumericType>& PhQ::LameFirstModulus< NumericType >::operator= ( const LameFirstModulus< OtherNumericType > & other )

inlineconstexpr

Copy assignment operator. Assigns this Lamé's first modulus by copying another one.

Definition at line 73 of file LameFirstModulus.hpp.

References PhQ::DimensionalScalar< UnitType, NumericType >::Value(), and PhQ::DimensionalScalar< Unit::Pressure, double >::value.

◆ operator=() [3/3]

template<typename NumericType = double>

constexpr LameFirstModulus<NumericType>& PhQ::LameFirstModulus< NumericType >::operator= ( LameFirstModulus< NumericType > && other )

constexprdefaultnoexcept

Move assignment operator. Assigns this Lamé's first modulus by moving another one.

◆ Print() [1/2]

std::string PhQ::DimensionalScalar< Unit::Pressure , double >::Print ( ) const

inlineinherited

Prints this physical quantity as a string. This physical quantity's value is expressed in its standard unit of measure.

Definition at line 95 of file DimensionalScalar.hpp.

◆ Print() [2/2]

std::string PhQ::DimensionalScalar< Unit::Pressure , double >::Print ( const UnitType unit ) const

inlineinherited

Prints this physical quantity as a string. This physical quantity's value is expressed in the given unit of measure.

Definition at line 101 of file DimensionalScalar.hpp.

◆ SetValue()

constexpr void PhQ::DimensionalScalar< Unit::Pressure , double >::SetValue ( const NumericType value )

inlineconstexprnoexceptinherited

Sets the value of this physical quantity expressed in its standard unit of measure to the given value.

Definition at line 89 of file DimensionalScalar.hpp.

◆ StaticValue()

constexpr double PhQ::DimensionalScalar< Unit::Pressure , double >::StaticValue ( ) const

inlineconstexprinherited

Value of this physical quantity expressed in a given unit of measure. This method can be evaluated statically at compile-time.

Definition at line 77 of file DimensionalScalar.hpp.

◆ Unit()

static constexpr Unit::Pressure PhQ::DimensionalScalar< Unit::Pressure , double >::Unit ( )

inlinestaticconstexprinherited

Standard unit of measure for this physical quantity. This physical quantity's value is stored internally in this unit of measure.

Definition at line 60 of file DimensionalScalar.hpp.

◆ Value() [1/2]

constexpr double PhQ::DimensionalScalar< Unit::Pressure , double >::Value ( ) const

inlineconstexprnoexceptinherited

Value of this physical quantity expressed in its standard unit of measure.

Definition at line 65 of file DimensionalScalar.hpp.

◆ Value() [2/2]

double PhQ::DimensionalScalar< Unit::Pressure , double >::Value ( const UnitType unit ) const

inlineinherited

Value of this physical quantity expressed in a given unit of measure.

Definition at line 70 of file DimensionalScalar.hpp.

◆ XML() [1/2]

std::string PhQ::DimensionalScalar< Unit::Pressure , double >::XML ( ) const

inlineinherited

Serializes this physical quantity as an XML message. This physical quantity's value is expressed in its standard unit of measure.

Definition at line 127 of file DimensionalScalar.hpp.

◆ XML() [2/2]

std::string PhQ::DimensionalScalar< Unit::Pressure , double >::XML ( const UnitType unit ) const

inlineinherited

Serializes this physical quantity as an XML message. This physical quantity's value is expressed in the given unit of measure.

Definition at line 137 of file DimensionalScalar.hpp.

◆ YAML() [1/2]

std::string PhQ::DimensionalScalar< Unit::Pressure , double >::YAML ( ) const

inlineinherited

Serializes this physical quantity as a YAML message. This physical quantity's value is expressed in its standard unit of measure.

Definition at line 147 of file DimensionalScalar.hpp.

◆ YAML() [2/2]

std::string PhQ::DimensionalScalar< Unit::Pressure , double >::YAML ( const UnitType unit ) const

inlineinherited

Serializes this physical quantity as a YAML message. This physical quantity's value is expressed in the given unit of measure.

Definition at line 157 of file DimensionalScalar.hpp.

◆ Zero()

template<typename NumericType = double>

static constexpr LameFirstModulus<NumericType> PhQ::LameFirstModulus< NumericType >::Zero ( )

inlinestaticconstexpr

Statically creates a Lamé's first modulus of zero.

Definition at line 84 of file LameFirstModulus.hpp.

Friends And Related Function Documentation

◆ ConstitutiveModel

template<typename NumericType = double>

friend class ConstitutiveModel

friend

Definition at line 141 of file LameFirstModulus.hpp.

Member Data Documentation

◆ value

double PhQ::DimensionalScalar< Unit::Pressure , double >::value

protectedinherited

Value of this physical quantity expressed in its standard unit of measure.

Definition at line 221 of file DimensionalScalar.hpp.

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

PhQ/LameFirstModulus.hpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

template<typename NumericType = double> class PhQ::LameFirstModulus< NumericType >

Constructor & Destructor Documentation

◆ LameFirstModulus() [1/6]

◆ LameFirstModulus() [2/6]

◆ ~LameFirstModulus()

◆ LameFirstModulus() [3/6]

◆ LameFirstModulus() [4/6]

◆ LameFirstModulus() [5/6]

◆ LameFirstModulus() [6/6]

Member Function Documentation

◆ Create()

◆ Dimensions()

◆ JSON() [1/2]

◆ JSON() [2/2]

◆ MutableValue()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ Print() [1/2]

◆ Print() [2/2]

◆ SetValue()

◆ StaticValue()

◆ Unit()

◆ Value() [1/2]

◆ Value() [2/2]

◆ XML() [1/2]

◆ XML() [2/2]

◆ YAML() [1/2]

◆ YAML() [2/2]

◆ Zero()

Friends And Related Function Documentation

◆ ConstitutiveModel

Member Data Documentation

◆ value

template<typename NumericType = double>
class PhQ::LameFirstModulus< NumericType >