Kinematic viscosity, also known as molecular kinematic viscosity. Defined as dynamic viscosity divided by mass density; see PhQ::DynamicViscosity and PhQ::MassDensity. Also appears in the definition of the Prandtl number; see PhQ::PrandtlNumber and PhQ::ThermalDiffusivity. More...

#include "KinematicViscosity.hpp"

Public Member Functions
	KinematicViscosity ()=default
	Default constructor. Constructs a kinematic viscosity with an uninitialized value. More...

	KinematicViscosity (const NumericType value, const Unit::Diffusivity unit)
	Constructor. Constructs a kinematic viscosity with a given value expressed in a given diffusivity unit. More...

constexpr	KinematicViscosity (const DynamicViscosity< NumericType > &dynamic_viscosity, const MassDensity< NumericType > &mass_density)
	Constructor. Constructs a kinematic viscosity from a given dynamic viscosity and mass density using the definition of kinematic viscosity. More...

constexpr	KinematicViscosity (const Speed< NumericType > &speed, const Length< NumericType > &length, const ReynoldsNumber< NumericType > &reynolds_number)
	Constructor. Constructs a kinematic viscosity from a given speed, length, and Reynolds number using the definition of the Reynolds number. More...

constexpr	KinematicViscosity (const PrandtlNumber< NumericType > &prandtl_number, const ThermalDiffusivity< NumericType > &thermal_diffusivity)
	Constructor. Constructs a kinematic viscosity from a given Prandtl number and thermal diffusivity using the definition of Prandtl number. More...

	~KinematicViscosity () noexcept=default
	Destructor. Destroys this kinematic viscosity. More...

constexpr	KinematicViscosity (const KinematicViscosity< NumericType > &other)=default
	Copy constructor. Constructs a kinematic viscosity by copying another one. More...

template<typename OtherNumericType >
constexpr	KinematicViscosity (const KinematicViscosity< OtherNumericType > &other)
	Copy constructor. Constructs a kinematic viscosity by copying another one. More...

constexpr	KinematicViscosity (KinematicViscosity< NumericType > &&other) noexcept=default
	Move constructor. Constructs a kinematic viscosity by moving another one. More...

constexpr KinematicViscosity< NumericType > &	operator= (const KinematicViscosity< NumericType > &other)=default
	Copy assignment operator. Assigns this kinematic viscosity by copying another one. More...

template<typename OtherNumericType >
constexpr KinematicViscosity< NumericType > &	operator= (const KinematicViscosity< OtherNumericType > &other)
	Copy assignment operator. Assigns this kinematic viscosity by copying another one. More...

constexpr KinematicViscosity< NumericType > &	operator= (KinematicViscosity< NumericType > &&other) noexcept=default
	Move assignment operator. Assigns this kinematic viscosity by moving another one. More...

constexpr KinematicViscosity< NumericType >	operator+ (const KinematicViscosity< NumericType > &kinematic_viscosity) const

constexpr KinematicViscosity< NumericType >	operator- (const KinematicViscosity< NumericType > &kinematic_viscosity) const

constexpr KinematicViscosity< NumericType >	operator* (const NumericType number) const

constexpr DynamicViscosity< NumericType >	operator* (const MassDensity< NumericType > &mass_density) const

constexpr KinematicViscosity< NumericType >	operator/ (const NumericType number) const

constexpr NumericType	operator/ (const KinematicViscosity< NumericType > &kinematic_viscosity) const noexcept

constexpr void	operator+= (const KinematicViscosity< NumericType > &kinematic_viscosity) noexcept

constexpr void	operator-= (const KinematicViscosity< NumericType > &kinematic_viscosity) 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::Diffusivity 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::Diffusivity 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::Diffusivity 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::Diffusivity 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::Diffusivity 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 KinematicViscosity< NumericType >	Zero ()
	Statically creates a kinematic viscosity of zero. More...

template<Unit::Diffusivity Unit>
static constexpr KinematicViscosity< NumericType >	Create (const NumericType value)
	Statically creates a kinematic viscosity with a given value expressed in a given diffusivity unit. More...

static constexpr const PhQ::Dimensions &	Dimensions ()
	Physical dimension set of this physical quantity. More...

static constexpr Unit::Diffusivity	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	KinematicViscosity (const NumericType value)
	Constructor. Constructs a kinematic viscosity with a given value expressed in the standard diffusivity unit. More...

Detailed Description

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

Kinematic viscosity, also known as molecular kinematic viscosity. Defined as dynamic viscosity divided by mass density; see PhQ::DynamicViscosity and PhQ::MassDensity. Also appears in the definition of the Prandtl number; see PhQ::PrandtlNumber and PhQ::ThermalDiffusivity.

Definition at line 70 of file KinematicViscosity.hpp.

Constructor & Destructor Documentation

◆ KinematicViscosity() [1/9]

template<typename NumericType = double>

PhQ::KinematicViscosity< NumericType >::KinematicViscosity ( )

default

Default constructor. Constructs a kinematic viscosity with an uninitialized value.

◆ KinematicViscosity() [2/9]

template<typename NumericType = double>

PhQ::KinematicViscosity< NumericType >::KinematicViscosity	(	const NumericType	value,
		const Unit::Diffusivity	unit
	)

inline

Constructor. Constructs a kinematic viscosity with a given value expressed in a given diffusivity unit.

Definition at line 77 of file KinematicViscosity.hpp.

◆ KinematicViscosity() [3/9]

template<typename NumericType >

constexpr PhQ::KinematicViscosity< NumericType >::KinematicViscosity	(	const DynamicViscosity< NumericType > &	dynamic_viscosity,
		const MassDensity< NumericType > &	mass_density
	)

inlineconstexpr

Constructor. Constructs a kinematic viscosity from a given dynamic viscosity and mass density using the definition of kinematic viscosity.

Definition at line 241 of file DynamicViscosity.hpp.

◆ KinematicViscosity() [4/9]

template<typename NumericType >

constexpr PhQ::KinematicViscosity< NumericType >::KinematicViscosity	(	const Speed< NumericType > &	speed,
		const Length< NumericType > &	length,
		const ReynoldsNumber< NumericType > &	reynolds_number
	)

inlineconstexpr

Constructor. Constructs a kinematic viscosity from a given speed, length, and Reynolds number using the definition of the Reynolds number.

Definition at line 271 of file ReynoldsNumber.hpp.

◆ KinematicViscosity() [5/9]

template<typename NumericType >

constexpr PhQ::KinematicViscosity< NumericType >::KinematicViscosity	(	const PrandtlNumber< NumericType > &	prandtl_number,
		const ThermalDiffusivity< NumericType > &	thermal_diffusivity
	)

inlineconstexpr

Constructor. Constructs a kinematic viscosity from a given Prandtl number and thermal diffusivity using the definition of Prandtl number.

Definition at line 255 of file PrandtlNumber.hpp.

◆ ~KinematicViscosity()

template<typename NumericType = double>

PhQ::KinematicViscosity< NumericType >::~KinematicViscosity ( )

defaultnoexcept

Destructor. Destroys this kinematic viscosity.

◆ KinematicViscosity() [6/9]

template<typename NumericType = double>

constexpr PhQ::KinematicViscosity< NumericType >::KinematicViscosity ( const KinematicViscosity< NumericType > & other )

constexprdefault

Copy constructor. Constructs a kinematic viscosity by copying another one.

◆ KinematicViscosity() [7/9]

template<typename NumericType = double>

template<typename OtherNumericType >

constexpr PhQ::KinematicViscosity< NumericType >::KinematicViscosity ( const KinematicViscosity< OtherNumericType > & other )

inlineexplicitconstexpr

Copy constructor. Constructs a kinematic viscosity by copying another one.

Definition at line 103 of file KinematicViscosity.hpp.

◆ KinematicViscosity() [8/9]

template<typename NumericType = double>

constexpr PhQ::KinematicViscosity< NumericType >::KinematicViscosity ( KinematicViscosity< NumericType > && other )

constexprdefaultnoexcept

Move constructor. Constructs a kinematic viscosity by moving another one.

◆ KinematicViscosity() [9/9]

template<typename NumericType = double>

constexpr PhQ::KinematicViscosity< NumericType >::KinematicViscosity ( const NumericType value )

inlineexplicitconstexprprivate

Constructor. Constructs a kinematic viscosity with a given value expressed in the standard diffusivity unit.

Definition at line 183 of file KinematicViscosity.hpp.

Member Function Documentation

◆ Create()

template<typename NumericType = double>

template<Unit::Diffusivity Unit>

static constexpr KinematicViscosity<NumericType> PhQ::KinematicViscosity< NumericType >::Create ( const NumericType value )

inlinestaticconstexpr

Statically creates a kinematic viscosity with a given value expressed in a given diffusivity unit.

Definition at line 133 of file KinematicViscosity.hpp.

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

◆ Dimensions()

static constexpr const PhQ::Dimensions& PhQ::DimensionalScalar< Unit::Diffusivity , 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::Diffusivity , 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::Diffusivity , 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::Diffusivity , 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 >

constexpr DynamicViscosity< NumericType > PhQ::KinematicViscosity< NumericType >::operator* ( const MassDensity< NumericType > & mass_density ) const

inlineconstexpr

Definition at line 247 of file DynamicViscosity.hpp.

◆ operator*() [2/2]

template<typename NumericType = double>

constexpr KinematicViscosity<NumericType> PhQ::KinematicViscosity< NumericType >::operator* ( const NumericType number ) const

inlineconstexpr

Definition at line 148 of file KinematicViscosity.hpp.

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

◆ operator*=()

template<typename NumericType = double>

constexpr void PhQ::KinematicViscosity< NumericType >::operator*= ( const NumericType number )

inlineconstexprnoexcept

Definition at line 172 of file KinematicViscosity.hpp.

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

◆ operator+()

template<typename NumericType = double>

constexpr KinematicViscosity<NumericType> PhQ::KinematicViscosity< NumericType >::operator+ ( const KinematicViscosity< NumericType > & kinematic_viscosity ) const

inlineconstexpr

Definition at line 138 of file KinematicViscosity.hpp.

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

◆ operator+=()

template<typename NumericType = double>

constexpr void PhQ::KinematicViscosity< NumericType >::operator+= ( const KinematicViscosity< NumericType > & kinematic_viscosity )

inlineconstexprnoexcept

Definition at line 164 of file KinematicViscosity.hpp.

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

◆ operator-()

template<typename NumericType = double>

constexpr KinematicViscosity<NumericType> PhQ::KinematicViscosity< NumericType >::operator- ( const KinematicViscosity< NumericType > & kinematic_viscosity ) const

inlineconstexpr

Definition at line 143 of file KinematicViscosity.hpp.

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

◆ operator-=()

template<typename NumericType = double>

constexpr void PhQ::KinematicViscosity< NumericType >::operator-= ( const KinematicViscosity< NumericType > & kinematic_viscosity )

inlineconstexprnoexcept

Definition at line 168 of file KinematicViscosity.hpp.

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

◆ operator/() [1/2]

template<typename NumericType = double>

constexpr NumericType PhQ::KinematicViscosity< NumericType >::operator/ ( const KinematicViscosity< NumericType > & kinematic_viscosity ) const

inlineconstexprnoexcept

Definition at line 159 of file KinematicViscosity.hpp.

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

◆ operator/() [2/2]

template<typename NumericType = double>

constexpr KinematicViscosity<NumericType> PhQ::KinematicViscosity< NumericType >::operator/ ( const NumericType number ) const

inlineconstexpr

Definition at line 155 of file KinematicViscosity.hpp.

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

◆ operator/=()

template<typename NumericType = double>

constexpr void PhQ::KinematicViscosity< NumericType >::operator/= ( const NumericType number )

inlineconstexprnoexcept

Definition at line 176 of file KinematicViscosity.hpp.

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

◆ operator=() [1/3]

template<typename NumericType = double>

constexpr KinematicViscosity<NumericType>& PhQ::KinematicViscosity< NumericType >::operator= ( const KinematicViscosity< NumericType > & other )

constexprdefault

Copy assignment operator. Assigns this kinematic viscosity by copying another one.

◆ operator=() [2/3]

template<typename NumericType = double>

template<typename OtherNumericType >

constexpr KinematicViscosity<NumericType>& PhQ::KinematicViscosity< NumericType >::operator= ( const KinematicViscosity< OtherNumericType > & other )

inlineconstexpr

Copy assignment operator. Assigns this kinematic viscosity by copying another one.

Definition at line 115 of file KinematicViscosity.hpp.

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

◆ operator=() [3/3]

template<typename NumericType = double>

constexpr KinematicViscosity<NumericType>& PhQ::KinematicViscosity< NumericType >::operator= ( KinematicViscosity< NumericType > && other )

constexprdefaultnoexcept

Move assignment operator. Assigns this kinematic viscosity by moving another one.

◆ Print() [1/2]

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

inlinestaticconstexpr

Statically creates a kinematic viscosity of zero.

Definition at line 126 of file KinematicViscosity.hpp.

Member Data Documentation

◆ value

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

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

Constructor & Destructor Documentation

◆ KinematicViscosity() [1/9]

◆ KinematicViscosity() [2/9]

◆ KinematicViscosity() [3/9]

◆ KinematicViscosity() [4/9]

◆ KinematicViscosity() [5/9]

◆ ~KinematicViscosity()

◆ KinematicViscosity() [6/9]

◆ KinematicViscosity() [7/9]

◆ KinematicViscosity() [8/9]

◆ KinematicViscosity() [9/9]

Member Function Documentation

◆ Create()

◆ Dimensions()

◆ JSON() [1/2]

◆ JSON() [2/2]

◆ MutableValue()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ Print() [1/2]

◆ Print() [2/2]

◆ SetValue()

◆ StaticValue()

◆ Unit()

◆ Value() [1/2]

◆ Value() [2/2]

◆ XML() [1/2]

◆ XML() [2/2]

◆ YAML() [1/2]

◆ YAML() [2/2]

◆ Zero()

Member Data Documentation

◆ value

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