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

Isentropic bulk modulus. Not to be confused with the isothermal bulk modulus; see PhQ::IsothermalBulkModulus. Solid materials usually have very similar isentropic and isothermal bulk moduli; however, in general, fluid materials have differing isentropic and isothermal bulk moduli. More...

#include "IsentropicBulkModulus.hpp"

Public Member Functions

 IsentropicBulkModulus ()=default
 Default constructor. Constructs an isentropic bulk modulus with an uninitialized value. More...
 
 IsentropicBulkModulus (const NumericType value, const Unit::Pressure unit)
 Constructor. Constructs an isentropic bulk modulus with a given value expressed in a given pressure unit. More...
 
constexpr IsentropicBulkModulus (const MassDensity< NumericType > &mass_density, const SoundSpeed< NumericType > &sound_speed)
 Constructor. Constructs an isentropic bulk modulus from a given mass density and sound speed using the definition of the isentropic bulk modulus. More...
 
 ~IsentropicBulkModulus () noexcept=default
 Destructor. Destroys this isentropic bulk modulus. More...
 
constexpr IsentropicBulkModulus (const IsentropicBulkModulus< NumericType > &other)=default
 Copy constructor. Constructs an isentropic bulk modulus by copying another one. More...
 
template<typename OtherNumericType >
constexpr IsentropicBulkModulus (const IsentropicBulkModulus< OtherNumericType > &other)
 Copy constructor. Constructs a isentropic bulk modulus by copying another one. More...
 
constexpr IsentropicBulkModulus (IsentropicBulkModulus< NumericType > &&other) noexcept=default
 Move constructor. Constructs an isentropic bulk modulus by moving another one. More...
 
constexpr IsentropicBulkModulus< NumericType > & operator= (const IsentropicBulkModulus< NumericType > &other)=default
 Copy assignment operator. Assigns this isentropic bulk modulus by copying another one. More...
 
template<typename OtherNumericType >
constexpr IsentropicBulkModulus< NumericType > & operator= (const IsentropicBulkModulus< OtherNumericType > &other)
 Copy assignment operator. Assigns this isentropic bulk modulus by copying another one. More...
 
constexpr IsentropicBulkModulus< NumericType > & operator= (IsentropicBulkModulus< NumericType > &&other) noexcept=default
 Move assignment operator. Assigns this isentropic bulk modulus by moving another one. More...
 
constexpr IsentropicBulkModulus< NumericType > operator+ (const IsentropicBulkModulus< NumericType > &isentropic_bulk_modulus) const
 
constexpr IsentropicBulkModulus< NumericType > operator- (const IsentropicBulkModulus< NumericType > &isentropic_bulk_modulus) const
 
constexpr IsentropicBulkModulus< NumericType > operator* (const NumericType number) const
 
constexpr IsentropicBulkModulus< NumericType > operator/ (const NumericType number) const
 
constexpr NumericType operator/ (const IsentropicBulkModulus< NumericType > &isentropic_bulk_modulus) const noexcept
 
constexpr void operator+= (const IsentropicBulkModulus< NumericType > &isentropic_bulk_modulus) noexcept
 
constexpr void operator-= (const IsentropicBulkModulus< NumericType > &isentropic_bulk_modulus) 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::Pressure 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::Pressure 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::Pressure 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::Pressure 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::Pressure 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 IsentropicBulkModulus< NumericType > Zero ()
 Statically creates an isentropic bulk modulus of zero. More...
 
template<Unit::Pressure Unit>
static constexpr IsentropicBulkModulus< NumericType > Create (const NumericType value)
 Statically creates an isentropic bulk modulus with a given value expressed in a given pressure unit. More...
 
static constexpr const PhQ::DimensionsDimensions ()
 Physical dimension set of this physical quantity. More...
 
static constexpr Unit::Pressure 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 IsentropicBulkModulus (const NumericType value)
 Constructor. Constructs an isentropic bulk modulus with a given value expressed in the standard pressure unit. More...
 

Detailed Description

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

Isentropic bulk modulus. Not to be confused with the isothermal bulk modulus; see PhQ::IsothermalBulkModulus. Solid materials usually have very similar isentropic and isothermal bulk moduli; however, in general, fluid materials have differing isentropic and isothermal bulk moduli.

Definition at line 50 of file IsentropicBulkModulus.hpp.

Constructor & Destructor Documentation

◆ IsentropicBulkModulus() [1/7]

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

Default constructor. Constructs an isentropic bulk modulus with an uninitialized value.

◆ IsentropicBulkModulus() [2/7]

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

Constructor. Constructs an isentropic bulk modulus with a given value expressed in a given pressure unit.

Definition at line 57 of file IsentropicBulkModulus.hpp.

◆ IsentropicBulkModulus() [3/7]

template<typename NumericType >
constexpr PhQ::IsentropicBulkModulus< NumericType >::IsentropicBulkModulus ( const MassDensity< NumericType > &  mass_density,
const SoundSpeed< NumericType > &  sound_speed 
)
constexpr

Constructor. Constructs an isentropic bulk modulus from a given mass density and sound speed using the definition of the isentropic bulk modulus.

Definition at line 269 of file SoundSpeed.hpp.

◆ ~IsentropicBulkModulus()

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

Destructor. Destroys this isentropic bulk modulus.

◆ IsentropicBulkModulus() [4/7]

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

Copy constructor. Constructs an isentropic bulk modulus by copying another one.

◆ IsentropicBulkModulus() [5/7]

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

Copy constructor. Constructs a isentropic bulk modulus by copying another one.

Definition at line 73 of file IsentropicBulkModulus.hpp.

◆ IsentropicBulkModulus() [6/7]

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

Move constructor. Constructs an isentropic bulk modulus by moving another one.

◆ IsentropicBulkModulus() [7/7]

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

Constructor. Constructs an isentropic bulk modulus with a given value expressed in the standard pressure unit.

Definition at line 153 of file IsentropicBulkModulus.hpp.

Member Function Documentation

◆ Create()

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

Statically creates an isentropic bulk modulus with a given value expressed in a given pressure unit.

Definition at line 103 of file IsentropicBulkModulus.hpp.

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

◆ Dimensions()

static constexpr const PhQ::Dimensions& PhQ::DimensionalScalar< Unit::Pressure , 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::Pressure , 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::Pressure , 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::Pressure , 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 IsentropicBulkModulus<NumericType> PhQ::IsentropicBulkModulus< NumericType >::operator* ( const NumericType  number) const
inlineconstexpr

◆ operator*=()

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

◆ operator+()

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

◆ operator+=()

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

◆ operator-()

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

◆ operator-=()

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

◆ operator/() [1/2]

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

◆ operator/() [2/2]

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

◆ operator/=()

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

◆ operator=() [1/3]

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

Copy assignment operator. Assigns this isentropic bulk modulus by copying another one.

◆ operator=() [2/3]

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

Copy assignment operator. Assigns this isentropic bulk modulus by copying another one.

Definition at line 85 of file IsentropicBulkModulus.hpp.

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

◆ operator=() [3/3]

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

Move assignment operator. Assigns this isentropic bulk modulus by moving another one.

◆ Print() [1/2]

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

Statically creates an isentropic bulk modulus of zero.

Definition at line 96 of file IsentropicBulkModulus.hpp.

Member Data Documentation

◆ value

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