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

Isothermal bulk modulus of a material. Not to be confused with the isentropic bulk modulus; see PhQ::IsentropicBulkModulus. 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 "IsothermalBulkModulus.hpp"

Public Member Functions

 IsothermalBulkModulus ()=default
 Default constructor. Constructs an isothermal bulk modulus with an uninitialized value. More...
 
 IsothermalBulkModulus (const NumericType value, const Unit::Pressure unit)
 Constructor. Constructs an isothermal bulk modulus with a given value expressed in a given pressure unit. More...
 
 ~IsothermalBulkModulus () noexcept=default
 Destructor. Destroys this isothermal bulk modulus. More...
 
constexpr IsothermalBulkModulus (const IsothermalBulkModulus< NumericType > &other)=default
 Copy constructor. Constructs an isothermal bulk modulus by copying another one. More...
 
template<typename OtherNumericType >
constexpr IsothermalBulkModulus (const IsothermalBulkModulus< OtherNumericType > &other)
 Copy constructor. Constructs a isothermal bulk modulus by copying another one. More...
 
constexpr IsothermalBulkModulus (IsothermalBulkModulus< NumericType > &&other) noexcept=default
 Move constructor. Constructs an isothermal bulk modulus by moving another one. More...
 
constexpr IsothermalBulkModulus< NumericType > & operator= (const IsothermalBulkModulus< NumericType > &other)=default
 Copy assignment operator. Assigns this isothermal bulk modulus by copying another one. More...
 
template<typename OtherNumericType >
constexpr IsothermalBulkModulus< NumericType > & operator= (const IsothermalBulkModulus< OtherNumericType > &other)
 Copy assignment operator. Assigns this isothermal bulk modulus by copying another one. More...
 
constexpr IsothermalBulkModulus< NumericType > & operator= (IsothermalBulkModulus< NumericType > &&other) noexcept=default
 Move assignment operator. Assigns this isothermal bulk modulus by moving another one. More...
 
constexpr IsothermalBulkModulus< NumericType > operator+ (const IsothermalBulkModulus< NumericType > &isothermal_bulk_modulus) const
 
constexpr IsothermalBulkModulus< NumericType > operator- (const IsothermalBulkModulus< NumericType > &isothermal_bulk_modulus) const
 
constexpr IsothermalBulkModulus< NumericType > operator* (const NumericType number) const
 
constexpr IsothermalBulkModulus< NumericType > operator/ (const NumericType number) const
 
constexpr NumericType operator/ (const IsothermalBulkModulus< NumericType > &isothermal_bulk_modulus) const noexcept
 
constexpr void operator+= (const IsothermalBulkModulus< NumericType > &isothermal_bulk_modulus) noexcept
 
constexpr void operator-= (const IsothermalBulkModulus< NumericType > &isothermal_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 IsothermalBulkModulus< NumericType > Zero ()
 Statically creates an isothermal bulk modulus of zero. More...
 
template<Unit::Pressure Unit>
static constexpr IsothermalBulkModulus< NumericType > Create (const NumericType value)
 Statically creates an isothermal 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 IsothermalBulkModulus (const NumericType value)
 Constructor. Constructs an isothermal bulk modulus with a given value expressed in the standard pressure unit. More...
 

Detailed Description

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

Isothermal bulk modulus of a material. Not to be confused with the isentropic bulk modulus; see PhQ::IsentropicBulkModulus. 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 42 of file IsothermalBulkModulus.hpp.

Constructor & Destructor Documentation

◆ IsothermalBulkModulus() [1/6]

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

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

◆ IsothermalBulkModulus() [2/6]

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

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

Definition at line 49 of file IsothermalBulkModulus.hpp.

◆ ~IsothermalBulkModulus()

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

Destructor. Destroys this isothermal bulk modulus.

◆ IsothermalBulkModulus() [3/6]

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

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

◆ IsothermalBulkModulus() [4/6]

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

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

Definition at line 60 of file IsothermalBulkModulus.hpp.

◆ IsothermalBulkModulus() [5/6]

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

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

◆ IsothermalBulkModulus() [6/6]

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

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

Definition at line 140 of file IsothermalBulkModulus.hpp.

Member Function Documentation

◆ Create()

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

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

Definition at line 90 of file IsothermalBulkModulus.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 IsothermalBulkModulus<NumericType> PhQ::IsothermalBulkModulus< NumericType >::operator* ( const NumericType  number) const
inlineconstexpr

◆ operator*=()

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

◆ operator+()

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

◆ operator+=()

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

◆ operator-()

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

◆ operator-=()

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

◆ operator/() [1/2]

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

◆ operator/() [2/2]

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

◆ operator/=()

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

◆ operator=() [1/3]

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

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

◆ operator=() [2/3]

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

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

Definition at line 72 of file IsothermalBulkModulus.hpp.

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

◆ operator=() [3/3]

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

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

Statically creates an isothermal bulk modulus of zero.

Definition at line 83 of file IsothermalBulkModulus.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 file: