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

Mass-specific energy. Energy per unit mass; see PhQ::Energy and PhQ::Mass. More...

#include "SpecificEnergy.hpp"

Public Member Functions

 SpecificEnergy ()=default
 Default constructor. Constructs a specific energy quantity with an uninitialized value. More...
 
 SpecificEnergy (const NumericType value, const Unit::SpecificEnergy unit)
 Constructor. Constructs a specific energy quantity with a given value expressed in a given specific energy unit. More...
 
constexpr SpecificEnergy (const Energy< NumericType > &energy, const Mass< NumericType > &mass)
 Constructor. Constructs a specific energy quantity from a given energy and mass using the definition of specific energy. More...
 
constexpr SpecificEnergy (const SpecificPower< NumericType > &specific_power, const Time< NumericType > &time)
 Constructor. Constructs a specific energy quantity from a given specific power and time duration using the definition of specific power. More...
 
constexpr SpecificEnergy (const SpecificPower< NumericType > &specific_power, const Frequency< NumericType > &frequency)
 Constructor. Constructs a specific energy quantity from a given specific power and frequency using the definition of specific power. More...
 
 ~SpecificEnergy () noexcept=default
 Destructor. Destroys this specific energy quantity. More...
 
constexpr SpecificEnergy (const SpecificEnergy< NumericType > &other)=default
 Copy constructor. Constructs a specific energy quantity by copying another one. More...
 
template<typename OtherNumericType >
constexpr SpecificEnergy (const SpecificEnergy< OtherNumericType > &other)
 Copy constructor. Constructs a specific energy quantity by copying another one. More...
 
constexpr SpecificEnergy (SpecificEnergy< NumericType > &&other) noexcept=default
 Move constructor. Constructs a specific energy quantity by moving another one. More...
 
constexpr SpecificEnergy< NumericType > & operator= (const SpecificEnergy< NumericType > &other)=default
 Copy assignment operator. Assigns this specific energy quantity by copying another one. More...
 
template<typename OtherNumericType >
constexpr SpecificEnergy< NumericType > & operator= (const SpecificEnergy< OtherNumericType > &other)
 Copy assignment operator. Assigns this specific energy quantity by copying another one. More...
 
constexpr SpecificEnergy< NumericType > & operator= (SpecificEnergy< NumericType > &&other) noexcept=default
 Move assignment operator. Assigns this specific energy quantity by moving another one. More...
 
constexpr SpecificEnergy< NumericType > operator+ (const SpecificEnergy< NumericType > &specific_energy) const
 
constexpr SpecificEnergy< NumericType > operator- (const SpecificEnergy< NumericType > &specific_energy) const
 
constexpr SpecificEnergy< NumericType > operator* (const NumericType number) const
 
constexpr Energy< NumericType > operator* (const Mass< NumericType > &mass) const
 
constexpr SpecificPower< NumericType > operator* (const Frequency< NumericType > &frequency) const
 
constexpr SpecificEnergy< NumericType > operator/ (const NumericType number) const
 
constexpr SpecificPower< NumericType > operator/ (const Time< NumericType > &time) const
 
constexpr Time< NumericType > operator/ (const SpecificPower< NumericType > &specific_power) const
 
constexpr NumericType operator/ (const SpecificEnergy< NumericType > &specific_energy) const noexcept
 
constexpr void operator+= (const SpecificEnergy< NumericType > &specific_energy) noexcept
 
constexpr void operator-= (const SpecificEnergy< NumericType > &specific_energy) 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::SpecificEnergy 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::SpecificEnergy 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::SpecificEnergy 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::SpecificEnergy 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::SpecificEnergy 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 SpecificEnergy< NumericType > Zero ()
 Statically creates a specific energy quantity of zero. More...
 
template<Unit::SpecificEnergy Unit>
static constexpr SpecificEnergy< NumericType > Create (const NumericType value)
 Statically creates a specific energy quantity with a given value expressed in a given specific energy unit. More...
 
static constexpr const PhQ::Dimensions & Dimensions ()
 Physical dimension set of this physical quantity. More...
 
static constexpr Unit::SpecificEnergy 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 SpecificEnergy (const NumericType value)
 Constructor. Constructs a specific energy quantity with a given value expressed in the standard specific energy unit. More...
 

Detailed Description

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

Mass-specific energy. Energy per unit mass; see PhQ::Energy and PhQ::Mass.

Definition at line 48 of file SpecificEnergy.hpp.

Constructor & Destructor Documentation

◆ SpecificEnergy() [1/9]

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

Default constructor. Constructs a specific energy quantity with an uninitialized value.

◆ SpecificEnergy() [2/9]

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

Constructor. Constructs a specific energy quantity with a given value expressed in a given specific energy unit.

Definition at line 55 of file SpecificEnergy.hpp.

◆ SpecificEnergy() [3/9]

template<typename NumericType = double>
constexpr PhQ::SpecificEnergy< NumericType >::SpecificEnergy ( const Energy< NumericType > &  energy,
const Mass< NumericType > &  mass 
)
inlineconstexpr

Constructor. Constructs a specific energy quantity from a given energy and mass using the definition of specific energy.

Definition at line 60 of file SpecificEnergy.hpp.

◆ SpecificEnergy() [4/9]

template<typename NumericType = double>
constexpr PhQ::SpecificEnergy< NumericType >::SpecificEnergy ( const SpecificPower< NumericType > &  specific_power,
const Time< NumericType > &  time 
)
constexpr

Constructor. Constructs a specific energy quantity from a given specific power and time duration using the definition of specific power.

◆ SpecificEnergy() [5/9]

template<typename NumericType = double>
constexpr PhQ::SpecificEnergy< NumericType >::SpecificEnergy ( const SpecificPower< NumericType > &  specific_power,
const Frequency< NumericType > &  frequency 
)
constexpr

Constructor. Constructs a specific energy quantity from a given specific power and frequency using the definition of specific power.

◆ ~SpecificEnergy()

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

Destructor. Destroys this specific energy quantity.

◆ SpecificEnergy() [6/9]

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

Copy constructor. Constructs a specific energy quantity by copying another one.

◆ SpecificEnergy() [7/9]

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

Copy constructor. Constructs a specific energy quantity by copying another one.

Definition at line 81 of file SpecificEnergy.hpp.

◆ SpecificEnergy() [8/9]

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

Move constructor. Constructs a specific energy quantity by moving another one.

◆ SpecificEnergy() [9/9]

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

Constructor. Constructs a specific energy quantity with a given value expressed in the standard specific energy unit.

Definition at line 167 of file SpecificEnergy.hpp.

Member Function Documentation

◆ Create()

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

Statically creates a specific energy quantity with a given value expressed in a given specific energy unit.

Definition at line 110 of file SpecificEnergy.hpp.

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

◆ Dimensions()

static constexpr const PhQ::Dimensions& PhQ::DimensionalScalar< Unit::SpecificEnergy , 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::SpecificEnergy , 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::SpecificEnergy , 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::SpecificEnergy , 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/3]

template<typename NumericType = double>
constexpr SpecificPower<NumericType> PhQ::SpecificEnergy< NumericType >::operator* ( const Frequency< NumericType > &  frequency) const
constexpr

◆ operator*() [2/3]

template<typename NumericType = double>
constexpr Energy<NumericType> PhQ::SpecificEnergy< NumericType >::operator* ( const Mass< NumericType > &  mass) const
inlineconstexpr

Definition at line 129 of file SpecificEnergy.hpp.

◆ operator*() [3/3]

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

Definition at line 125 of file SpecificEnergy.hpp.

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

◆ operator*=()

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

Definition at line 156 of file SpecificEnergy.hpp.

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

◆ operator+()

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

Definition at line 115 of file SpecificEnergy.hpp.

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

◆ operator+=()

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

Definition at line 148 of file SpecificEnergy.hpp.

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

◆ operator-()

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

Definition at line 120 of file SpecificEnergy.hpp.

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

◆ operator-=()

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

Definition at line 152 of file SpecificEnergy.hpp.

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

◆ operator/() [1/4]

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

Definition at line 135 of file SpecificEnergy.hpp.

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

◆ operator/() [2/4]

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

Definition at line 143 of file SpecificEnergy.hpp.

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

◆ operator/() [3/4]

template<typename NumericType = double>
constexpr Time<NumericType> PhQ::SpecificEnergy< NumericType >::operator/ ( const SpecificPower< NumericType > &  specific_power) const
constexpr

◆ operator/() [4/4]

template<typename NumericType = double>
constexpr SpecificPower<NumericType> PhQ::SpecificEnergy< NumericType >::operator/ ( const Time< NumericType > &  time) const
constexpr

◆ operator/=()

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

Definition at line 160 of file SpecificEnergy.hpp.

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

◆ operator=() [1/3]

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

Copy assignment operator. Assigns this specific energy quantity by copying another one.

◆ operator=() [2/3]

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

Copy assignment operator. Assigns this specific energy quantity by copying another one.

Definition at line 93 of file SpecificEnergy.hpp.

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

◆ operator=() [3/3]

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

Move assignment operator. Assigns this specific energy quantity by moving another one.

◆ Print() [1/2]

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

Statically creates a specific energy quantity of zero.

Definition at line 103 of file SpecificEnergy.hpp.

Member Data Documentation

◆ value

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