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::SpecificGasConstant< NumericType > Class Template Reference

Mass-specific gas constant of a gas. Gas constant per unit mass; see PhQ::GasConstant and PhQ::Mass. PhQ::Mass. More...

#include "SpecificGasConstant.hpp"

Public Member Functions

 SpecificGasConstant ()=default
 Default constructor. Constructs a specific gas constant with an uninitialized value. More...
 
 SpecificGasConstant (const NumericType value, const Unit::SpecificHeatCapacity unit)
 Constructor. Constructs a specific gas constant with a given value expressed in a given specific heat capacity unit. More...
 
constexpr SpecificGasConstant (const SpecificIsobaricHeatCapacity< NumericType > &specific_isobaric_heat_capacity, const SpecificIsochoricHeatCapacity< NumericType > &specific_isochoric_heat_capacity)
 Constructor. Constructs a specific gas constant from a given specific isobaric heat capacity and specific isochoric heat capacity using Mayer's relation. More...
 
constexpr SpecificGasConstant (const HeatCapacityRatio< NumericType > &heat_capacity_ratio, const SpecificIsobaricHeatCapacity< NumericType > &specific_isobaric_heat_capacity)
 Constructor. Constructs a specific gas constant from a given specific isobaric heat capacity and heat capacity ratio using the definition of the heat capacity ratio and Mayer's relation. More...
 
constexpr SpecificGasConstant (const HeatCapacityRatio< NumericType > &heat_capacity_ratio, const SpecificIsochoricHeatCapacity< NumericType > &specific_isochoric_heat_capacity)
 Constructor. Constructs a specific gas constant from a given specific isochoric heat capacity and heat capacity ratio using the definition of the heat capacity ratio and Mayer's relation. More...
 
constexpr SpecificGasConstant (const GasConstant< NumericType > &gas_constant, const Mass< NumericType > &mass)
 Constructor. Constructs a specific gas constant from a given gas constant and mass using the definition of the specific gas constant. More...
 
 ~SpecificGasConstant () noexcept=default
 Destructor. Destroys this specific gas constant. More...
 
constexpr SpecificGasConstant (const SpecificGasConstant< NumericType > &other)=default
 Copy constructor. Constructs a specific gas constant by copying another one. More...
 
template<typename OtherNumericType >
constexpr SpecificGasConstant (const SpecificGasConstant< OtherNumericType > &other)
 Copy constructor. Constructs a specific gas constant by copying another one. More...
 
constexpr SpecificGasConstant (SpecificGasConstant< NumericType > &&other) noexcept=default
 Move constructor. Constructs a specific gas constant by moving another one. More...
 
constexpr SpecificGasConstant< NumericType > & operator= (const SpecificGasConstant< NumericType > &other)=default
 Copy assignment operator. Assigns this specific gas constant by copying another one. More...
 
template<typename OtherNumericType >
constexpr SpecificGasConstant< NumericType > & operator= (const SpecificGasConstant< OtherNumericType > &other)
 Copy assignment operator. Assigns this specific gas constant by copying another one. More...
 
constexpr SpecificGasConstant< NumericType > & operator= (SpecificGasConstant< NumericType > &&other) noexcept=default
 Move assignment operator. Assigns this specific gas constant by moving another one. More...
 
constexpr SpecificGasConstant< NumericType > operator+ (const SpecificGasConstant< NumericType > &specific_gas_constant) const
 
constexpr SpecificIsobaricHeatCapacity< NumericType > operator+ (const SpecificIsochoricHeatCapacity< NumericType > &specific_isochoric_heat_capacity) const
 
constexpr SpecificGasConstant< NumericType > operator- (const SpecificGasConstant< NumericType > &specific_gas_constant) const
 
constexpr SpecificGasConstant< NumericType > operator* (const NumericType number) const
 
constexpr GasConstant< NumericType > operator* (const Mass< NumericType > &mass) const
 
constexpr SpecificGasConstant< NumericType > operator/ (const NumericType number) const
 
constexpr NumericType operator/ (const SpecificGasConstant< NumericType > &specific_gas_constant) const noexcept
 
constexpr void operator+= (const SpecificGasConstant< NumericType > &specific_gas_constant) noexcept
 
constexpr void operator-= (const SpecificGasConstant< NumericType > &specific_gas_constant) 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::SpecificHeatCapacity 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::SpecificHeatCapacity 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::SpecificHeatCapacity 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::SpecificHeatCapacity 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::SpecificHeatCapacity 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 SpecificGasConstant< NumericType > Zero ()
 Statically creates a specific gas constant of zero. More...
 
template<Unit::SpecificHeatCapacity Unit>
static constexpr SpecificGasConstant< NumericType > Create (const NumericType value)
 Statically creates a specific gas constant with a given value expressed in a given specific heat capacity unit. More...
 
static constexpr const PhQ::Dimensions & Dimensions ()
 Physical dimension set of this physical quantity. More...
 
static constexpr Unit::SpecificHeatCapacity 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 SpecificGasConstant (const NumericType value)
 Constructor. Constructs a specific gas constant with a given value expressed in the standard specific heat capacity unit. More...
 

Detailed Description

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

Mass-specific gas constant of a gas. Gas constant per unit mass; see PhQ::GasConstant and PhQ::Mass. PhQ::Mass.

Definition at line 45 of file SpecificGasConstant.hpp.

Constructor & Destructor Documentation

◆ SpecificGasConstant() [1/10]

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

Default constructor. Constructs a specific gas constant with an uninitialized value.

◆ SpecificGasConstant() [2/10]

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

Constructor. Constructs a specific gas constant with a given value expressed in a given specific heat capacity unit.

Definition at line 52 of file SpecificGasConstant.hpp.

◆ SpecificGasConstant() [3/10]

template<typename NumericType = double>
constexpr PhQ::SpecificGasConstant< NumericType >::SpecificGasConstant ( const SpecificIsobaricHeatCapacity< NumericType > &  specific_isobaric_heat_capacity,
const SpecificIsochoricHeatCapacity< NumericType > &  specific_isochoric_heat_capacity 
)
inlineconstexpr

Constructor. Constructs a specific gas constant from a given specific isobaric heat capacity and specific isochoric heat capacity using Mayer's relation.

Definition at line 57 of file SpecificGasConstant.hpp.

◆ SpecificGasConstant() [4/10]

template<typename NumericType = double>
constexpr PhQ::SpecificGasConstant< NumericType >::SpecificGasConstant ( const HeatCapacityRatio< NumericType > &  heat_capacity_ratio,
const SpecificIsobaricHeatCapacity< NumericType > &  specific_isobaric_heat_capacity 
)
inlineconstexpr

Constructor. Constructs a specific gas constant from a given specific isobaric heat capacity and heat capacity ratio using the definition of the heat capacity ratio and Mayer's relation.

Definition at line 66 of file SpecificGasConstant.hpp.

◆ SpecificGasConstant() [5/10]

template<typename NumericType = double>
constexpr PhQ::SpecificGasConstant< NumericType >::SpecificGasConstant ( const HeatCapacityRatio< NumericType > &  heat_capacity_ratio,
const SpecificIsochoricHeatCapacity< NumericType > &  specific_isochoric_heat_capacity 
)
inlineconstexpr

Constructor. Constructs a specific gas constant from a given specific isochoric heat capacity and heat capacity ratio using the definition of the heat capacity ratio and Mayer's relation.

Definition at line 75 of file SpecificGasConstant.hpp.

◆ SpecificGasConstant() [6/10]

template<typename NumericType = double>
constexpr PhQ::SpecificGasConstant< NumericType >::SpecificGasConstant ( const GasConstant< NumericType > &  gas_constant,
const Mass< NumericType > &  mass 
)
inlineconstexpr

Constructor. Constructs a specific gas constant from a given gas constant and mass using the definition of the specific gas constant.

Definition at line 83 of file SpecificGasConstant.hpp.

◆ ~SpecificGasConstant()

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

Destructor. Destroys this specific gas constant.

◆ SpecificGasConstant() [7/10]

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

Copy constructor. Constructs a specific gas constant by copying another one.

◆ SpecificGasConstant() [8/10]

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

Copy constructor. Constructs a specific gas constant by copying another one.

Definition at line 95 of file SpecificGasConstant.hpp.

◆ SpecificGasConstant() [9/10]

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

Move constructor. Constructs a specific gas constant by moving another one.

◆ SpecificGasConstant() [10/10]

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

Constructor. Constructs a specific gas constant with a given value expressed in the standard specific heat capacity unit.

Definition at line 184 of file SpecificGasConstant.hpp.

Member Function Documentation

◆ Create()

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

Statically creates a specific gas constant with a given value expressed in a given specific heat capacity unit.

Definition at line 125 of file SpecificGasConstant.hpp.

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

◆ Dimensions()

static constexpr const PhQ::Dimensions& PhQ::DimensionalScalar< Unit::SpecificHeatCapacity , 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::SpecificHeatCapacity , 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::SpecificHeatCapacity , 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::SpecificHeatCapacity , 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 GasConstant<NumericType> PhQ::SpecificGasConstant< NumericType >::operator* ( const Mass< NumericType > &  mass) const
inlineconstexpr

Definition at line 150 of file SpecificGasConstant.hpp.

◆ operator*() [2/2]

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

Definition at line 146 of file SpecificGasConstant.hpp.

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

◆ operator*=()

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

Definition at line 173 of file SpecificGasConstant.hpp.

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

◆ operator+() [1/2]

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

Definition at line 131 of file SpecificGasConstant.hpp.

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

◆ operator+() [2/2]

template<typename NumericType = double>
constexpr SpecificIsobaricHeatCapacity<NumericType> PhQ::SpecificGasConstant< NumericType >::operator+ ( const SpecificIsochoricHeatCapacity< NumericType > &  specific_isochoric_heat_capacity) const
inlineconstexpr

Definition at line 136 of file SpecificGasConstant.hpp.

◆ operator+=()

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

Definition at line 163 of file SpecificGasConstant.hpp.

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

◆ operator-()

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

Definition at line 141 of file SpecificGasConstant.hpp.

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

◆ operator-=()

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

Definition at line 168 of file SpecificGasConstant.hpp.

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

◆ operator/() [1/2]

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

Definition at line 154 of file SpecificGasConstant.hpp.

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

◆ operator/() [2/2]

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

Definition at line 158 of file SpecificGasConstant.hpp.

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

◆ operator/=()

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

Definition at line 177 of file SpecificGasConstant.hpp.

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

◆ operator=() [1/3]

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

Copy assignment operator. Assigns this specific gas constant by copying another one.

◆ operator=() [2/3]

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

Copy assignment operator. Assigns this specific gas constant by copying another one.

Definition at line 107 of file SpecificGasConstant.hpp.

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

◆ operator=() [3/3]

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

Move assignment operator. Assigns this specific gas constant by moving another one.

◆ Print() [1/2]

std::string PhQ::DimensionalScalar< Unit::SpecificHeatCapacity , 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::SpecificHeatCapacity , 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::SpecificHeatCapacity , 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::SpecificHeatCapacity , 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::SpecificHeatCapacity PhQ::DimensionalScalar< Unit::SpecificHeatCapacity , 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::SpecificHeatCapacity , 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::SpecificHeatCapacity , 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::SpecificHeatCapacity , 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::SpecificHeatCapacity , 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::SpecificHeatCapacity , 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::SpecificHeatCapacity , 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 SpecificGasConstant<NumericType> PhQ::SpecificGasConstant< NumericType >::Zero ( )
inlinestaticconstexpr

Statically creates a specific gas constant of zero.

Definition at line 118 of file SpecificGasConstant.hpp.

Member Data Documentation

◆ value

double PhQ::DimensionalScalar< Unit::SpecificHeatCapacity , 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 files:
Physical Quantities (PhQ): Git Repository | Documentation