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

Total kinematic pressure, which is total pressure divided by mass density; see PhQ::TotalPressure and PhQ::MassDensity. More...

#include "TotalKinematicPressure.hpp"

Public Member Functions

 TotalKinematicPressure ()=default
 Default constructor. Constructs a total kinematic pressure with an uninitialized value. More...
 
 TotalKinematicPressure (const NumericType value, const Unit::SpecificEnergy unit)
 Constructor. Constructs a total kinematic pressure with a given value expressed in a given specific energy unit. More...
 
constexpr TotalKinematicPressure (const StaticKinematicPressure< NumericType > &static_kinematic_pressure, const DynamicKinematicPressure< NumericType > &dynamic_kinematic_pressure)
 Constructor. Constructs a total kinematic pressure from a given static kinematic pressure and dynamic kinematic pressure using the definition of total kinematic pressure. More...
 
constexpr TotalKinematicPressure (const TotalPressure< NumericType > &total_pressure, const MassDensity< NumericType > &mass_density)
 Constructor. Constructs a total kinematic pressure from a given total pressure and mass density using the definition of total kinematic pressure. More...
 
 ~TotalKinematicPressure () noexcept=default
 Destructor. Destroys this total kinematic pressure. More...
 
constexpr TotalKinematicPressure (const TotalKinematicPressure< NumericType > &other)=default
 Copy constructor. Constructs a total kinematic pressure by copying another one. More...
 
template<typename OtherNumericType >
constexpr TotalKinematicPressure (const TotalKinematicPressure< OtherNumericType > &other)
 Copy constructor. Constructs a total kinematic pressure by copying another one. More...
 
constexpr TotalKinematicPressure (TotalKinematicPressure< NumericType > &&other) noexcept=default
 Move constructor. Constructs a total kinematic pressure by moving another one. More...
 
constexpr TotalKinematicPressure< NumericType > & operator= (const TotalKinematicPressure< NumericType > &other)=default
 Copy assignment operator. Assigns this total kinematic pressure by copying another one. More...
 
template<typename OtherNumericType >
constexpr TotalKinematicPressure< NumericType > & operator= (const TotalKinematicPressure< OtherNumericType > &other)
 Copy assignment operator. Assigns this total kinematic pressure by copying another one. More...
 
constexpr TotalKinematicPressure< NumericType > & operator= (TotalKinematicPressure< NumericType > &&other) noexcept=default
 Move assignment operator. Assigns this total kinematic pressure by moving another one. More...
 
constexpr TotalKinematicPressure< NumericType > operator+ (const TotalKinematicPressure< NumericType > &total_kinematic_pressure) const
 
constexpr TotalKinematicPressure< NumericType > operator- (const TotalKinematicPressure< NumericType > &total_kinematic_pressure) const
 
constexpr DynamicKinematicPressure< NumericType > operator- (const StaticKinematicPressure< NumericType > &static_kinematic_pressure) const
 
constexpr StaticKinematicPressure< NumericType > operator- (const DynamicKinematicPressure< NumericType > &dynamic_kinematic_pressure) const
 
constexpr TotalKinematicPressure< NumericType > operator* (const NumericType number) const
 
constexpr TotalKinematicPressure< NumericType > operator/ (const NumericType number) const
 
constexpr NumericType operator/ (const TotalKinematicPressure< NumericType > &total_kinematic_pressure) const noexcept
 
constexpr void operator+= (const TotalKinematicPressure< NumericType > &total_kinematic_pressure) noexcept
 
constexpr void operator-= (const TotalKinematicPressure< NumericType > &total_kinematic_pressure) 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 TotalKinematicPressure< NumericType > Zero ()
 Statically creates a total kinematic pressure of zero. More...
 
template<Unit::SpecificEnergy Unit>
static constexpr TotalKinematicPressure< NumericType > Create (const NumericType value)
 Statically creates a total kinematic pressure 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 TotalKinematicPressure (const NumericType value)
 Constructor. Constructs a total kinematic pressure with a given value expressed in the standard specific energy unit. More...
 

Detailed Description

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

Total kinematic pressure, which is total pressure divided by mass density; see PhQ::TotalPressure and PhQ::MassDensity.

Definition at line 44 of file TotalKinematicPressure.hpp.

Constructor & Destructor Documentation

◆ TotalKinematicPressure() [1/8]

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

Default constructor. Constructs a total kinematic pressure with an uninitialized value.

◆ TotalKinematicPressure() [2/8]

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

Constructor. Constructs a total kinematic pressure with a given value expressed in a given specific energy unit.

Definition at line 51 of file TotalKinematicPressure.hpp.

◆ TotalKinematicPressure() [3/8]

template<typename NumericType = double>
constexpr PhQ::TotalKinematicPressure< NumericType >::TotalKinematicPressure ( const StaticKinematicPressure< NumericType > &  static_kinematic_pressure,
const DynamicKinematicPressure< NumericType > &  dynamic_kinematic_pressure 
)
inlineconstexpr

Constructor. Constructs a total kinematic pressure from a given static kinematic pressure and dynamic kinematic pressure using the definition of total kinematic pressure.

Definition at line 56 of file TotalKinematicPressure.hpp.

◆ TotalKinematicPressure() [4/8]

template<typename NumericType = double>
constexpr PhQ::TotalKinematicPressure< NumericType >::TotalKinematicPressure ( const TotalPressure< NumericType > &  total_pressure,
const MassDensity< NumericType > &  mass_density 
)
inlineconstexpr

Constructor. Constructs a total kinematic pressure from a given total pressure and mass density using the definition of total kinematic pressure.

Definition at line 64 of file TotalKinematicPressure.hpp.

◆ ~TotalKinematicPressure()

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

Destructor. Destroys this total kinematic pressure.

◆ TotalKinematicPressure() [5/8]

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

Copy constructor. Constructs a total kinematic pressure by copying another one.

◆ TotalKinematicPressure() [6/8]

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

Copy constructor. Constructs a total kinematic pressure by copying another one.

Definition at line 76 of file TotalKinematicPressure.hpp.

◆ TotalKinematicPressure() [7/8]

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

Move constructor. Constructs a total kinematic pressure by moving another one.

◆ TotalKinematicPressure() [8/8]

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

Constructor. Constructs a total kinematic pressure with a given value expressed in the standard specific energy unit.

Definition at line 166 of file TotalKinematicPressure.hpp.

Member Function Documentation

◆ Create()

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

Statically creates a total kinematic pressure with a given value expressed in a given specific energy unit.

Definition at line 106 of file TotalKinematicPressure.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*()

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

Definition at line 132 of file TotalKinematicPressure.hpp.

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

◆ operator*=()

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

Definition at line 155 of file TotalKinematicPressure.hpp.

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

◆ operator+()

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

Definition at line 112 of file TotalKinematicPressure.hpp.

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

◆ operator+=()

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

Definition at line 145 of file TotalKinematicPressure.hpp.

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

◆ operator-() [1/3]

template<typename NumericType = double>
constexpr StaticKinematicPressure<NumericType> PhQ::TotalKinematicPressure< NumericType >::operator- ( const DynamicKinematicPressure< NumericType > &  dynamic_kinematic_pressure) const
inlineconstexpr

Definition at line 127 of file TotalKinematicPressure.hpp.

◆ operator-() [2/3]

template<typename NumericType = double>
constexpr DynamicKinematicPressure<NumericType> PhQ::TotalKinematicPressure< NumericType >::operator- ( const StaticKinematicPressure< NumericType > &  static_kinematic_pressure) const
inlineconstexpr

Definition at line 122 of file TotalKinematicPressure.hpp.

◆ operator-() [3/3]

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

Definition at line 117 of file TotalKinematicPressure.hpp.

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

◆ operator-=()

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

Definition at line 150 of file TotalKinematicPressure.hpp.

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

◆ operator/() [1/2]

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

Definition at line 136 of file TotalKinematicPressure.hpp.

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

◆ operator/() [2/2]

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

Definition at line 140 of file TotalKinematicPressure.hpp.

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

◆ operator/=()

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

Definition at line 159 of file TotalKinematicPressure.hpp.

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

◆ operator=() [1/3]

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

Copy assignment operator. Assigns this total kinematic pressure by copying another one.

◆ operator=() [2/3]

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

Copy assignment operator. Assigns this total kinematic pressure by copying another one.

Definition at line 88 of file TotalKinematicPressure.hpp.

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

◆ operator=() [3/3]

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

Move assignment operator. Assigns this total kinematic pressure 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 TotalKinematicPressure<NumericType> PhQ::TotalKinematicPressure< NumericType >::Zero ( )
inlinestaticconstexpr

Statically creates a total kinematic pressure of zero.

Definition at line 99 of file TotalKinematicPressure.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