Physical Quantities  v1.0.0
C++ library of physical quantities, physical models, and units of measure for scientific computing. https://github.com/acodcha/phq
Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions | List of all members
PhQ::LinearThermalExpansionCoefficient< NumericType > Class Template Reference

Linear thermal expansion coefficient. Not to be confused with the volumetric thermal expansion coefficient; see PhQ::VolumetricThermalExpansionCoefficient. For isotropic materials, the volumetric thermal expansion coefficient is usually three times the linear thermal expansion coefficient. More...

#include "LinearThermalExpansionCoefficient.hpp"

Public Member Functions

 LinearThermalExpansionCoefficient ()=default
 Default constructor. Constructs a linear thermal expansion coefficient with an uninitialized value. More...
 
 LinearThermalExpansionCoefficient (const NumericType value, const Unit::ReciprocalTemperature unit)
 Constructor. Constructs a linear thermal expansion coefficient with a given value expressed in a given reciprocal temperature unit. More...
 
 ~LinearThermalExpansionCoefficient () noexcept=default
 Destructor. Destroys this linear thermal expansion coefficient. More...
 
constexpr LinearThermalExpansionCoefficient (const LinearThermalExpansionCoefficient< NumericType > &other)=default
 Copy constructor. Constructs a linear thermal expansion coefficient by copying another one. More...
 
template<typename OtherNumericType >
constexpr LinearThermalExpansionCoefficient (const LinearThermalExpansionCoefficient< OtherNumericType > &other)
 Copy constructor. Constructs a linear thermal expansion coefficient by copying another one. More...
 
constexpr LinearThermalExpansionCoefficient (LinearThermalExpansionCoefficient< NumericType > &&other) noexcept=default
 Move constructor. Constructs a linear thermal expansion coefficient by moving another one. More...
 
constexpr LinearThermalExpansionCoefficient< NumericType > & operator= (const LinearThermalExpansionCoefficient< NumericType > &other)=default
 Copy assignment operator. Assigns this linear thermal expansion coefficient by copying another one. More...
 
template<typename OtherNumericType >
constexpr LinearThermalExpansionCoefficient< NumericType > & operator= (const LinearThermalExpansionCoefficient< OtherNumericType > &other)
 Copy assignment operator. Assigns this linear thermal expansion coefficient by copying another one. More...
 
constexpr LinearThermalExpansionCoefficient< NumericType > & operator= (LinearThermalExpansionCoefficient< NumericType > &&other) noexcept=default
 Move assignment operator. Assigns this linear thermal expansion coefficient by moving another one. More...
 
constexpr LinearThermalExpansionCoefficient< NumericType > operator+ (const LinearThermalExpansionCoefficient< NumericType > &linear_thermal_expansion_coefficient) const
 
constexpr LinearThermalExpansionCoefficient< NumericType > operator- (const LinearThermalExpansionCoefficient< NumericType > &linear_thermal_expansion_coefficient) const
 
constexpr LinearThermalExpansionCoefficient< NumericType > operator* (const NumericType number) const
 
constexpr ScalarStrain< NumericType > operator* (const TemperatureDifference< NumericType > &temperature_difference) const
 
constexpr LinearThermalExpansionCoefficient< NumericType > operator/ (const NumericType number) const
 
constexpr NumericType operator/ (const LinearThermalExpansionCoefficient< NumericType > &linear_thermal_expansion_coefficient) const noexcept
 
constexpr void operator+= (const LinearThermalExpansionCoefficient< NumericType > &linear_thermal_expansion_coefficient) noexcept
 
constexpr void operator-= (const LinearThermalExpansionCoefficient< NumericType > &linear_thermal_expansion_coefficient) 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::ReciprocalTemperature 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::ReciprocalTemperature 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::ReciprocalTemperature 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::ReciprocalTemperature 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::ReciprocalTemperature 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 LinearThermalExpansionCoefficient< NumericType > Zero ()
 Statically creates a linear thermal expansion coefficient of zero. More...
 
template<Unit::ReciprocalTemperature Unit>
static constexpr LinearThermalExpansionCoefficient< NumericType > Create (const NumericType value)
 Statically creates a linear thermal expansion coefficient with a given value expressed in a given reciprocal temperature unit. More...
 
static constexpr const PhQ::DimensionsDimensions ()
 Physical dimension set of this physical quantity. More...
 
static constexpr Unit::ReciprocalTemperature 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 LinearThermalExpansionCoefficient (const NumericType value)
 Constructor. Constructs a linear thermal expansion coefficient with a given value expressed in the standard reciprocal temperature unit. More...
 

Detailed Description

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

Linear thermal expansion coefficient. Not to be confused with the volumetric thermal expansion coefficient; see PhQ::VolumetricThermalExpansionCoefficient. For isotropic materials, the volumetric thermal expansion coefficient is usually three times the linear thermal expansion coefficient.

Definition at line 44 of file LinearThermalExpansionCoefficient.hpp.

Constructor & Destructor Documentation

◆ LinearThermalExpansionCoefficient() [1/6]

template<typename NumericType = double>
PhQ::LinearThermalExpansionCoefficient< NumericType >::LinearThermalExpansionCoefficient ( )
default

Default constructor. Constructs a linear thermal expansion coefficient with an uninitialized value.

◆ LinearThermalExpansionCoefficient() [2/6]

template<typename NumericType = double>
PhQ::LinearThermalExpansionCoefficient< NumericType >::LinearThermalExpansionCoefficient ( const NumericType  value,
const Unit::ReciprocalTemperature  unit 
)
inline

Constructor. Constructs a linear thermal expansion coefficient with a given value expressed in a given reciprocal temperature unit.

Definition at line 53 of file LinearThermalExpansionCoefficient.hpp.

◆ ~LinearThermalExpansionCoefficient()

template<typename NumericType = double>
PhQ::LinearThermalExpansionCoefficient< NumericType >::~LinearThermalExpansionCoefficient ( )
defaultnoexcept

Destructor. Destroys this linear thermal expansion coefficient.

◆ LinearThermalExpansionCoefficient() [3/6]

template<typename NumericType = double>
constexpr PhQ::LinearThermalExpansionCoefficient< NumericType >::LinearThermalExpansionCoefficient ( const LinearThermalExpansionCoefficient< NumericType > &  other)
constexprdefault

Copy constructor. Constructs a linear thermal expansion coefficient by copying another one.

◆ LinearThermalExpansionCoefficient() [4/6]

template<typename NumericType = double>
template<typename OtherNumericType >
constexpr PhQ::LinearThermalExpansionCoefficient< NumericType >::LinearThermalExpansionCoefficient ( const LinearThermalExpansionCoefficient< OtherNumericType > &  other)
inlineexplicitconstexpr

Copy constructor. Constructs a linear thermal expansion coefficient by copying another one.

Definition at line 67 of file LinearThermalExpansionCoefficient.hpp.

◆ LinearThermalExpansionCoefficient() [5/6]

template<typename NumericType = double>
constexpr PhQ::LinearThermalExpansionCoefficient< NumericType >::LinearThermalExpansionCoefficient ( LinearThermalExpansionCoefficient< NumericType > &&  other)
constexprdefaultnoexcept

Move constructor. Constructs a linear thermal expansion coefficient by moving another one.

◆ LinearThermalExpansionCoefficient() [6/6]

template<typename NumericType = double>
constexpr PhQ::LinearThermalExpansionCoefficient< NumericType >::LinearThermalExpansionCoefficient ( const NumericType  value)
inlineexplicitconstexprprivate

Constructor. Constructs a linear thermal expansion coefficient with a given value expressed in the standard reciprocal temperature unit.

Definition at line 166 of file LinearThermalExpansionCoefficient.hpp.

Member Function Documentation

◆ Create()

template<typename NumericType = double>
template<Unit::ReciprocalTemperature Unit>
static constexpr LinearThermalExpansionCoefficient<NumericType> PhQ::LinearThermalExpansionCoefficient< NumericType >::Create ( const NumericType  value)
inlinestaticconstexpr

Statically creates a linear thermal expansion coefficient with a given value expressed in a given reciprocal temperature unit.

Definition at line 103 of file LinearThermalExpansionCoefficient.hpp.

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

◆ Dimensions()

static constexpr const PhQ::Dimensions& PhQ::DimensionalScalar< Unit::ReciprocalTemperature , 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::ReciprocalTemperature , 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::ReciprocalTemperature , double >::JSON ( const Unit::ReciprocalTemperature  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::ReciprocalTemperature , 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*() [1/2]

template<typename NumericType = double>
constexpr LinearThermalExpansionCoefficient<NumericType> PhQ::LinearThermalExpansionCoefficient< NumericType >::operator* ( const NumericType  number) const
inlineconstexpr

◆ operator*() [2/2]

template<typename NumericType = double>
constexpr ScalarStrain<NumericType> PhQ::LinearThermalExpansionCoefficient< NumericType >::operator* ( const TemperatureDifference< NumericType > &  temperature_difference) const
inlineconstexpr

Definition at line 129 of file LinearThermalExpansionCoefficient.hpp.

◆ operator*=()

template<typename NumericType = double>
constexpr void PhQ::LinearThermalExpansionCoefficient< NumericType >::operator*= ( const NumericType  number)
inlineconstexprnoexcept

◆ operator+()

template<typename NumericType = double>
constexpr LinearThermalExpansionCoefficient<NumericType> PhQ::LinearThermalExpansionCoefficient< NumericType >::operator+ ( const LinearThermalExpansionCoefficient< NumericType > &  linear_thermal_expansion_coefficient) const
inlineconstexpr

◆ operator+=()

template<typename NumericType = double>
constexpr void PhQ::LinearThermalExpansionCoefficient< NumericType >::operator+= ( const LinearThermalExpansionCoefficient< NumericType > &  linear_thermal_expansion_coefficient)
inlineconstexprnoexcept

◆ operator-()

template<typename NumericType = double>
constexpr LinearThermalExpansionCoefficient<NumericType> PhQ::LinearThermalExpansionCoefficient< NumericType >::operator- ( const LinearThermalExpansionCoefficient< NumericType > &  linear_thermal_expansion_coefficient) const
inlineconstexpr

◆ operator-=()

template<typename NumericType = double>
constexpr void PhQ::LinearThermalExpansionCoefficient< NumericType >::operator-= ( const LinearThermalExpansionCoefficient< NumericType > &  linear_thermal_expansion_coefficient)
inlineconstexprnoexcept

◆ operator/() [1/2]

template<typename NumericType = double>
constexpr NumericType PhQ::LinearThermalExpansionCoefficient< NumericType >::operator/ ( const LinearThermalExpansionCoefficient< NumericType > &  linear_thermal_expansion_coefficient) const
inlineconstexprnoexcept

◆ operator/() [2/2]

template<typename NumericType = double>
constexpr LinearThermalExpansionCoefficient<NumericType> PhQ::LinearThermalExpansionCoefficient< NumericType >::operator/ ( const NumericType  number) const
inlineconstexpr

◆ operator/=()

template<typename NumericType = double>
constexpr void PhQ::LinearThermalExpansionCoefficient< NumericType >::operator/= ( const NumericType  number)
inlineconstexprnoexcept

◆ operator=() [1/3]

template<typename NumericType = double>
constexpr LinearThermalExpansionCoefficient<NumericType>& PhQ::LinearThermalExpansionCoefficient< NumericType >::operator= ( const LinearThermalExpansionCoefficient< NumericType > &  other)
constexprdefault

Copy assignment operator. Assigns this linear thermal expansion coefficient by copying another one.

◆ operator=() [2/3]

template<typename NumericType = double>
template<typename OtherNumericType >
constexpr LinearThermalExpansionCoefficient<NumericType>& PhQ::LinearThermalExpansionCoefficient< NumericType >::operator= ( const LinearThermalExpansionCoefficient< OtherNumericType > &  other)
inlineconstexpr

Copy assignment operator. Assigns this linear thermal expansion coefficient by copying another one.

Definition at line 84 of file LinearThermalExpansionCoefficient.hpp.

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

◆ operator=() [3/3]

template<typename NumericType = double>
constexpr LinearThermalExpansionCoefficient<NumericType>& PhQ::LinearThermalExpansionCoefficient< NumericType >::operator= ( LinearThermalExpansionCoefficient< NumericType > &&  other)
constexprdefaultnoexcept

Move assignment operator. Assigns this linear thermal expansion coefficient by moving another one.

◆ Print() [1/2]

std::string PhQ::DimensionalScalar< Unit::ReciprocalTemperature , 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::ReciprocalTemperature , double >::Print ( const Unit::ReciprocalTemperature  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::ReciprocalTemperature , double >::SetValue ( const double  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::ReciprocalTemperature , 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::ReciprocalTemperature PhQ::DimensionalScalar< Unit::ReciprocalTemperature , 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::ReciprocalTemperature , 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::ReciprocalTemperature , double >::Value ( const Unit::ReciprocalTemperature  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::ReciprocalTemperature , 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::ReciprocalTemperature , double >::XML ( const Unit::ReciprocalTemperature  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::ReciprocalTemperature , 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::ReciprocalTemperature , double >::YAML ( const Unit::ReciprocalTemperature  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 LinearThermalExpansionCoefficient<NumericType> PhQ::LinearThermalExpansionCoefficient< NumericType >::Zero ( )
inlinestaticconstexpr

Statically creates a linear thermal expansion coefficient of zero.

Definition at line 96 of file LinearThermalExpansionCoefficient.hpp.

Member Data Documentation

◆ value

double PhQ::DimensionalScalar< Unit::ReciprocalTemperature , 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: