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

Static kinematic pressure, which is static pressure divided by mass density; see PhQ::StaticPressure and PhQ::MassDensity. More...

#include "StaticKinematicPressure.hpp"

Public Member Functions

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

Detailed Description

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

Static kinematic pressure, which is static pressure divided by mass density; see PhQ::StaticPressure and PhQ::MassDensity.

Definition at line 50 of file StaticKinematicPressure.hpp.

Constructor & Destructor Documentation

◆ StaticKinematicPressure() [1/8]

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

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

◆ StaticKinematicPressure() [2/8]

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

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

Definition at line 58 of file StaticKinematicPressure.hpp.

◆ StaticKinematicPressure() [3/8]

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

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

Definition at line 226 of file TotalKinematicPressure.hpp.

◆ StaticKinematicPressure() [4/8]

template<typename NumericType = double>
constexpr PhQ::StaticKinematicPressure< NumericType >::StaticKinematicPressure ( const StaticPressure< NumericType > &  static_pressure,
const MassDensity< NumericType > &  mass_density 
)
inlineconstexpr

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

Definition at line 69 of file StaticKinematicPressure.hpp.

◆ ~StaticKinematicPressure()

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

Destructor. Destroys this static kinematic pressure.

◆ StaticKinematicPressure() [5/8]

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

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

◆ StaticKinematicPressure() [6/8]

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

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

Definition at line 81 of file StaticKinematicPressure.hpp.

◆ StaticKinematicPressure() [7/8]

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

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

◆ StaticKinematicPressure() [8/8]

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

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

Definition at line 170 of file StaticKinematicPressure.hpp.

Member Function Documentation

◆ Create()

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

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

Definition at line 114 of file StaticKinematicPressure.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/2]

template<typename NumericType = double>
constexpr StaticPressure<NumericType> PhQ::StaticKinematicPressure< NumericType >::operator* ( const MassDensity< NumericType > &  mass_density) const
inlineconstexpr

Definition at line 137 of file StaticKinematicPressure.hpp.

◆ operator*() [2/2]

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

Definition at line 133 of file StaticKinematicPressure.hpp.

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

◆ operator*=()

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

Definition at line 159 of file StaticKinematicPressure.hpp.

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

◆ operator+() [1/2]

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

Definition at line 241 of file TotalKinematicPressure.hpp.

◆ operator+() [2/2]

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

Definition at line 120 of file StaticKinematicPressure.hpp.

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

◆ operator+=()

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

Definition at line 151 of file StaticKinematicPressure.hpp.

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

◆ operator-()

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

Definition at line 128 of file StaticKinematicPressure.hpp.

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

◆ operator-=()

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

Definition at line 155 of file StaticKinematicPressure.hpp.

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

◆ operator/() [1/2]

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

Definition at line 142 of file StaticKinematicPressure.hpp.

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

◆ operator/() [2/2]

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

Definition at line 146 of file StaticKinematicPressure.hpp.

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

◆ operator/=()

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

Definition at line 163 of file StaticKinematicPressure.hpp.

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

◆ operator=() [1/3]

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

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

◆ operator=() [2/3]

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

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

Definition at line 96 of file StaticKinematicPressure.hpp.

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

◆ operator=() [3/3]

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

Move assignment operator. Assigns this static 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 StaticKinematicPressure<NumericType> PhQ::StaticKinematicPressure< NumericType >::Zero ( )
inlinestaticconstexpr

Statically creates a static kinematic pressure of zero.

Definition at line 107 of file StaticKinematicPressure.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