Three-dimensional Euclidean heat flux vector. Contains three components in Cartesian coordinates: x, y, and z. For a two-dimensional Euclidean heat flux vector in the XY plane, see PhQ::PlanarHeatFlux. For scalar heat flux components or for the magnitude of a heat flux vector, see PhQ::ScalarHeatFlux. More...

#include "HeatFlux.hpp"

Public Member Functions
	HeatFlux ()=default
	Default constructor. Constructs a heat flux vector with an uninitialized value. More...

	HeatFlux (const Vector< NumericType > &value, const Unit::EnergyFlux unit)
	Constructor. Constructs a heat flux vector with a given value expressed in a given energy flux unit. More...

	HeatFlux (const ScalarHeatFlux< NumericType > &x, const ScalarHeatFlux< NumericType > &y, const ScalarHeatFlux< NumericType > &z)
	Constructor. Constructs a heat flux vector from a given set of scalar heat flux components. More...

constexpr	HeatFlux (const ScalarHeatFlux< NumericType > &scalar_heat_flux, const Direction< NumericType > &direction)
	Constructor. Constructs a heat flux vector from a given scalar heat flux magnitude and direction. More...

constexpr	HeatFlux (const PlanarHeatFlux< NumericType > &planar_heat_flux)
	Constructor. Constructs a heat flux vector from a given planar heat flux vector in the XY plane. This heat flux vector's z-component is initialized to zero. More...

constexpr	HeatFlux (const ScalarThermalConductivity< NumericType > &scalar_thermal_conductivity, const TemperatureGradient< NumericType > &temperature_gradient)
	Constructor. Constructs a heat flux vector from a given scalar thermal conductivity and temperature gradient vector using Fourier's law of heat conduction. Since heat flows opposite the temperature gradient, the resulting heat flux direction is opposite the temperature gradient direction. More...

constexpr	HeatFlux (const ThermalConductivity< NumericType > &thermal_conductivity, const TemperatureGradient< NumericType > &temperature_gradient)
	Constructor. Constructs a heat flux vector from a given thermal conductivity tensor and temperature gradient vector using Fourier's law of heat conduction. Since heat flows opposite the temperature gradient, the resulting heat flux direction is opposite the temperature gradient direction. More...

	~HeatFlux () noexcept=default
	Destructor. Destroys this heat flux vector. More...

constexpr	HeatFlux (const HeatFlux< NumericType > &other)=default
	Copy constructor. Constructs a heat flux vector by copying another one. More...

template<typename OtherNumericType >
constexpr	HeatFlux (const HeatFlux< OtherNumericType > &other)
	Copy constructor. Constructs a heat flux vector by copying another one. More...

constexpr	HeatFlux (HeatFlux< NumericType > &&other) noexcept=default
	Move constructor. Constructs a heat flux vector by moving another one. More...

constexpr HeatFlux< NumericType > &	operator= (const HeatFlux< NumericType > &other)=default
	Copy assignment operator. Assigns this heat flux vector by copying another one. More...

template<typename OtherNumericType >
constexpr HeatFlux< NumericType > &	operator= (const HeatFlux< OtherNumericType > &other)
	Copy assignment operator. Assigns this heat flux vector by copying another one. More...

constexpr HeatFlux< NumericType > &	operator= (HeatFlux< NumericType > &&other) noexcept=default
	Move assignment operator. Assigns this heat flux vector by moving another one. More...

constexpr ScalarHeatFlux< NumericType >	x () const noexcept
	Returns the x Cartesian component of this heat flux vector. More...

constexpr ScalarHeatFlux< NumericType >	y () const noexcept
	Returns the y Cartesian component of this heat flux vector. More...

constexpr ScalarHeatFlux< NumericType >	z () const noexcept
	Returns the z Cartesian component of this heat flux vector. More...

ScalarHeatFlux< NumericType >	Magnitude () const
	Returns the magnitude of this heat flux vector. More...

PhQ::Direction< NumericType >	Direction () const
	Returns the direction of this heat flux vector. More...

PhQ::Angle< NumericType >	Angle (const HeatFlux< NumericType > &heat_flux) const
	Returns the angle between this heat flux vector and another one. More...

constexpr HeatFlux< NumericType >	operator+ (const HeatFlux< NumericType > &heat_flux) const

constexpr HeatFlux< NumericType >	operator- (const HeatFlux< NumericType > &heat_flux) const

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

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

constexpr void	operator+= (const HeatFlux< NumericType > &heat_flux) noexcept

constexpr void	operator-= (const HeatFlux< NumericType > &heat_flux) noexcept

constexpr void	operator*= (const NumericType number) noexcept

constexpr void	operator/= (const NumericType number) noexcept

constexpr const PhQ::Vector< double > &	Value () const noexcept
	Value of this physical quantity expressed in its standard unit of measure. More...

PhQ::Vector< double >	Value (const Unit::EnergyFlux unit) const
	Value of this physical quantity expressed in a given unit of measure. More...

constexpr PhQ::Vector< 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 PhQ::Vector< 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 PhQ::Vector< 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::EnergyFlux 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::EnergyFlux 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::EnergyFlux 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::EnergyFlux 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 HeatFlux< NumericType >	Zero ()
	Statically creates a heat flux vector of zero. More...

template<Unit::EnergyFlux Unit>
static constexpr HeatFlux< NumericType >	Create (const NumericType x, const NumericType y, const NumericType z)
	Statically creates a heat flux vector from the given x, y, and z Cartesian components expressed in a given energy flux unit. More...

template<Unit::EnergyFlux Unit>
static constexpr HeatFlux< NumericType >	Create (const std::array< NumericType, 3 > &x_y_z)
	Statically creates a heat flux vector from the given x, y, and z Cartesian components expressed in a given energy flux unit. More...

template<Unit::EnergyFlux Unit>
static constexpr HeatFlux< NumericType >	Create (const Vector< NumericType > &value)
	Statically creates a heat flux vector with a given value expressed in a given energy flux unit. More...

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

static constexpr Unit::EnergyFlux	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
PhQ::Vector< double >	value
	Value of this physical quantity expressed in its standard unit of measure. More...

Private Member Functions
constexpr	HeatFlux (const Vector< NumericType > &value)
	Constructor. Constructs a heat flux vector with a given value expressed in the standard energy flux unit. More...

Detailed Description

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

Three-dimensional Euclidean heat flux vector. Contains three components in Cartesian coordinates: x, y, and z. For a two-dimensional Euclidean heat flux vector in the XY plane, see PhQ::PlanarHeatFlux. For scalar heat flux components or for the magnitude of a heat flux vector, see PhQ::ScalarHeatFlux.

Definition at line 50 of file HeatFlux.hpp.

Constructor & Destructor Documentation

◆ HeatFlux() [1/11]

template<typename NumericType = double>

PhQ::HeatFlux< NumericType >::HeatFlux ( )

default

Default constructor. Constructs a heat flux vector with an uninitialized value.

◆ HeatFlux() [2/11]

template<typename NumericType = double>

PhQ::HeatFlux< NumericType >::HeatFlux	(	const Vector< NumericType > &	value,
		const Unit::EnergyFlux	unit
	)

inline

Constructor. Constructs a heat flux vector with a given value expressed in a given energy flux unit.

Definition at line 57 of file HeatFlux.hpp.

◆ HeatFlux() [3/11]

template<typename NumericType = double>

PhQ::HeatFlux< NumericType >::HeatFlux	(	const ScalarHeatFlux< NumericType > &	x,
		const ScalarHeatFlux< NumericType > &	y,
		const ScalarHeatFlux< NumericType > &	z
	)

inline

Constructor. Constructs a heat flux vector from a given set of scalar heat flux components.

Definition at line 62 of file HeatFlux.hpp.

References PhQ::HeatFlux< NumericType >::x(), PhQ::HeatFlux< NumericType >::y(), and PhQ::HeatFlux< NumericType >::z().

◆ HeatFlux() [4/11]

template<typename NumericType = double>

constexpr PhQ::HeatFlux< NumericType >::HeatFlux	(	const ScalarHeatFlux< NumericType > &	scalar_heat_flux,
		const Direction< NumericType > &	direction
	)

inlineconstexpr

Constructor. Constructs a heat flux vector from a given scalar heat flux magnitude and direction.

Definition at line 68 of file HeatFlux.hpp.

◆ HeatFlux() [5/11]

template<typename NumericType = double>

constexpr PhQ::HeatFlux< NumericType >::HeatFlux ( const PlanarHeatFlux< NumericType > & planar_heat_flux )

inlineexplicitconstexpr

Constructor. Constructs a heat flux vector from a given planar heat flux vector in the XY plane. This heat flux vector's z-component is initialized to zero.

Definition at line 74 of file HeatFlux.hpp.

References PhQ::DimensionalPlanarVector< UnitType, NumericType >::Value().

◆ HeatFlux() [6/11]

template<typename NumericType = double>

constexpr PhQ::HeatFlux< NumericType >::HeatFlux	(	const ScalarThermalConductivity< NumericType > &	scalar_thermal_conductivity,
		const TemperatureGradient< NumericType > &	temperature_gradient
	)

inlineconstexpr

Constructor. Constructs a heat flux vector from a given scalar thermal conductivity and temperature gradient vector using Fourier's law of heat conduction. Since heat flows opposite the temperature gradient, the resulting heat flux direction is opposite the temperature gradient direction.

Definition at line 81 of file HeatFlux.hpp.

◆ HeatFlux() [7/11]

template<typename NumericType = double>

constexpr PhQ::HeatFlux< NumericType >::HeatFlux	(	const ThermalConductivity< NumericType > &	thermal_conductivity,
		const TemperatureGradient< NumericType > &	temperature_gradient
	)

inlineconstexpr

Constructor. Constructs a heat flux vector from a given thermal conductivity tensor and temperature gradient vector using Fourier's law of heat conduction. Since heat flows opposite the temperature gradient, the resulting heat flux direction is opposite the temperature gradient direction.

Definition at line 89 of file HeatFlux.hpp.

◆ ~HeatFlux()

template<typename NumericType = double>

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

defaultnoexcept

Destructor. Destroys this heat flux vector.

◆ HeatFlux() [8/11]

template<typename NumericType = double>

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

constexprdefault

Copy constructor. Constructs a heat flux vector by copying another one.

◆ HeatFlux() [9/11]

template<typename NumericType = double>

template<typename OtherNumericType >

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

inlineexplicitconstexpr

Copy constructor. Constructs a heat flux vector by copying another one.

Definition at line 101 of file HeatFlux.hpp.

◆ HeatFlux() [10/11]

template<typename NumericType = double>

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

constexprdefaultnoexcept

Move constructor. Constructs a heat flux vector by moving another one.

◆ HeatFlux() [11/11]

template<typename NumericType = double>

constexpr PhQ::HeatFlux< NumericType >::HeatFlux ( const Vector< NumericType > & value )

inlineexplicitconstexprprivate

Constructor. Constructs a heat flux vector with a given value expressed in the standard energy flux unit.

Definition at line 218 of file HeatFlux.hpp.

Member Function Documentation

◆ Angle()

template<typename NumericType = double>

PhQ::Angle<NumericType> PhQ::HeatFlux< NumericType >::Angle ( const HeatFlux< NumericType > & heat_flux ) const

inline

Returns the angle between this heat flux vector and another one.

Definition at line 179 of file HeatFlux.hpp.

◆ Create() [1/3]

template<typename NumericType = double>

template<Unit::EnergyFlux Unit>

static constexpr HeatFlux<NumericType> PhQ::HeatFlux< NumericType >::Create	(	const NumericType	x,
		const NumericType	y,
		const NumericType	z
	)

inlinestaticconstexpr

Statically creates a heat flux vector from the given x, y, and z Cartesian components expressed in a given energy flux unit.

Definition at line 128 of file HeatFlux.hpp.

References PhQ::HeatFlux< NumericType >::x(), PhQ::HeatFlux< NumericType >::y(), and PhQ::HeatFlux< NumericType >::z().

◆ Create() [2/3]

template<typename NumericType = double>

template<Unit::EnergyFlux Unit>

static constexpr HeatFlux<NumericType> PhQ::HeatFlux< NumericType >::Create ( const std::array< NumericType, 3 > & x_y_z )

inlinestaticconstexpr

Statically creates a heat flux vector from the given x, y, and z Cartesian components expressed in a given energy flux unit.

Definition at line 138 of file HeatFlux.hpp.

◆ Create() [3/3]

template<typename NumericType = double>

template<Unit::EnergyFlux Unit>

static constexpr HeatFlux<NumericType> PhQ::HeatFlux< NumericType >::Create ( const Vector< NumericType > & value )

inlinestaticconstexpr

Statically creates a heat flux vector with a given value expressed in a given energy flux unit.

Definition at line 148 of file HeatFlux.hpp.

References PhQ::DimensionalVector< Unit::EnergyFlux, double >::value.

◆ Dimensions()

static constexpr const PhQ::Dimensions& PhQ::DimensionalVector< Unit::EnergyFlux , double >::Dimensions ( )

inlinestaticconstexprinherited

Physical dimension set of this physical quantity.

Definition at line 50 of file DimensionalVector.hpp.

◆ Direction()

template<typename NumericType = double>

PhQ::Direction<NumericType> PhQ::HeatFlux< NumericType >::Direction ( ) const

inline

Returns the direction of this heat flux vector.

Definition at line 174 of file HeatFlux.hpp.

References PhQ::Vector< NumericType >::Direction(), and PhQ::DimensionalVector< Unit::EnergyFlux, double >::value.

◆ JSON() [1/2]

std::string PhQ::DimensionalVector< Unit::EnergyFlux , 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 103 of file DimensionalVector.hpp.

◆ JSON() [2/2]

std::string PhQ::DimensionalVector< Unit::EnergyFlux , double >::JSON ( const Unit::EnergyFlux 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 113 of file DimensionalVector.hpp.

◆ Magnitude()

template<typename NumericType = double>

ScalarHeatFlux<NumericType> PhQ::HeatFlux< NumericType >::Magnitude ( ) const

inline

Returns the magnitude of this heat flux vector.

Definition at line 169 of file HeatFlux.hpp.

References PhQ::Vector< NumericType >::Magnitude(), and PhQ::DimensionalVector< Unit::EnergyFlux, double >::value.

◆ MutableValue()

constexpr PhQ::Vector<double >& PhQ::DimensionalVector< Unit::EnergyFlux , double >::MutableValue ( )

inlineconstexprnoexceptinherited

Returns the value of this physical quantity expressed in its standard unit of measure as a mutable value.

Definition at line 79 of file DimensionalVector.hpp.

◆ operator*()

template<typename NumericType = double>

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

inlineconstexpr

Definition at line 191 of file HeatFlux.hpp.

References PhQ::DimensionalVector< Unit::EnergyFlux, double >::value.

◆ operator*=()

template<typename NumericType = double>

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

inlineconstexprnoexcept

Definition at line 207 of file HeatFlux.hpp.

References PhQ::DimensionalVector< Unit::EnergyFlux, double >::value.

◆ operator+()

template<typename NumericType = double>

constexpr HeatFlux<NumericType> PhQ::HeatFlux< NumericType >::operator+ ( const HeatFlux< NumericType > & heat_flux ) const

inlineconstexpr

Definition at line 183 of file HeatFlux.hpp.

References PhQ::DimensionalVector< UnitType, NumericType >::value, and PhQ::DimensionalVector< Unit::EnergyFlux, double >::value.

◆ operator+=()

template<typename NumericType = double>

constexpr void PhQ::HeatFlux< NumericType >::operator+= ( const HeatFlux< NumericType > & heat_flux )

inlineconstexprnoexcept

Definition at line 199 of file HeatFlux.hpp.

References PhQ::DimensionalVector< Unit::EnergyFlux, double >::value.

◆ operator-()

template<typename NumericType = double>

constexpr HeatFlux<NumericType> PhQ::HeatFlux< NumericType >::operator- ( const HeatFlux< NumericType > & heat_flux ) const

inlineconstexpr

Definition at line 187 of file HeatFlux.hpp.

References PhQ::DimensionalVector< UnitType, NumericType >::value, and PhQ::DimensionalVector< Unit::EnergyFlux, double >::value.

◆ operator-=()

template<typename NumericType = double>

constexpr void PhQ::HeatFlux< NumericType >::operator-= ( const HeatFlux< NumericType > & heat_flux )

inlineconstexprnoexcept

Definition at line 203 of file HeatFlux.hpp.

References PhQ::DimensionalVector< Unit::EnergyFlux, double >::value.

◆ operator/()

template<typename NumericType = double>

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

inlineconstexpr

Definition at line 195 of file HeatFlux.hpp.

References PhQ::DimensionalVector< Unit::EnergyFlux, double >::value.

◆ operator/=()

template<typename NumericType = double>

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

inlineconstexprnoexcept

Definition at line 211 of file HeatFlux.hpp.

References PhQ::DimensionalVector< Unit::EnergyFlux, double >::value.

◆ operator=() [1/3]

template<typename NumericType = double>

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

constexprdefault

Copy assignment operator. Assigns this heat flux vector by copying another one.

◆ operator=() [2/3]

template<typename NumericType = double>

template<typename OtherNumericType >

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

inlineconstexpr

Copy assignment operator. Assigns this heat flux vector by copying another one.

Definition at line 112 of file HeatFlux.hpp.

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

◆ operator=() [3/3]

template<typename NumericType = double>

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

constexprdefaultnoexcept

Move assignment operator. Assigns this heat flux vector by moving another one.

◆ Print() [1/2]

std::string PhQ::DimensionalVector< Unit::EnergyFlux , 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 91 of file DimensionalVector.hpp.

◆ Print() [2/2]

std::string PhQ::DimensionalVector< Unit::EnergyFlux , double >::Print ( const Unit::EnergyFlux 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 97 of file DimensionalVector.hpp.

◆ SetValue()

constexpr void PhQ::DimensionalVector< Unit::EnergyFlux , double >::SetValue ( const PhQ::Vector< double > & value )

inlineconstexprnoexceptinherited

Sets the value of this physical quantity expressed in its standard unit of measure to the given value.

Definition at line 85 of file DimensionalVector.hpp.

◆ StaticValue()

constexpr PhQ::Vector<double > PhQ::DimensionalVector< Unit::EnergyFlux , 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 73 of file DimensionalVector.hpp.

◆ Unit()

static constexpr Unit::EnergyFlux PhQ::DimensionalVector< Unit::EnergyFlux , 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 56 of file DimensionalVector.hpp.

◆ Value() [1/2]

constexpr const PhQ::Vector<double >& PhQ::DimensionalVector< Unit::EnergyFlux , double >::Value ( ) const

inlineconstexprnoexceptinherited

Value of this physical quantity expressed in its standard unit of measure.

Definition at line 61 of file DimensionalVector.hpp.

◆ Value() [2/2]

PhQ::Vector<double > PhQ::DimensionalVector< Unit::EnergyFlux , double >::Value ( const Unit::EnergyFlux unit ) const

inlineinherited

Value of this physical quantity expressed in a given unit of measure.

Definition at line 66 of file DimensionalVector.hpp.

◆ x()

template<typename NumericType = double>

constexpr ScalarHeatFlux<NumericType> PhQ::HeatFlux< NumericType >::x ( ) const

inlineconstexprnoexcept

Returns the x Cartesian component of this heat flux vector.

Definition at line 154 of file HeatFlux.hpp.

References PhQ::DimensionalVector< Unit::EnergyFlux, double >::value, and PhQ::Vector< NumericType >::x().

Referenced by PhQ::HeatFlux< NumericType >::Create(), and PhQ::HeatFlux< NumericType >::HeatFlux().

◆ XML() [1/2]

std::string PhQ::DimensionalVector< Unit::EnergyFlux , 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 123 of file DimensionalVector.hpp.

◆ XML() [2/2]

std::string PhQ::DimensionalVector< Unit::EnergyFlux , double >::XML ( const Unit::EnergyFlux 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 133 of file DimensionalVector.hpp.

◆ y()

template<typename NumericType = double>

constexpr ScalarHeatFlux<NumericType> PhQ::HeatFlux< NumericType >::y ( ) const

inlineconstexprnoexcept

Returns the y Cartesian component of this heat flux vector.

Definition at line 159 of file HeatFlux.hpp.

References PhQ::DimensionalVector< Unit::EnergyFlux, double >::value, and PhQ::Vector< NumericType >::y().

Referenced by PhQ::HeatFlux< NumericType >::Create(), and PhQ::HeatFlux< NumericType >::HeatFlux().

◆ YAML() [1/2]

std::string PhQ::DimensionalVector< Unit::EnergyFlux , 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 143 of file DimensionalVector.hpp.

◆ YAML() [2/2]

std::string PhQ::DimensionalVector< Unit::EnergyFlux , double >::YAML ( const Unit::EnergyFlux 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 153 of file DimensionalVector.hpp.

◆ z()

template<typename NumericType = double>

constexpr ScalarHeatFlux<NumericType> PhQ::HeatFlux< NumericType >::z ( ) const

inlineconstexprnoexcept

Returns the z Cartesian component of this heat flux vector.

Definition at line 164 of file HeatFlux.hpp.

References PhQ::DimensionalVector< Unit::EnergyFlux, double >::value, and PhQ::Vector< NumericType >::z().

Referenced by PhQ::HeatFlux< NumericType >::Create(), and PhQ::HeatFlux< NumericType >::HeatFlux().

◆ Zero()

template<typename NumericType = double>

static constexpr HeatFlux<NumericType> PhQ::HeatFlux< NumericType >::Zero ( )

inlinestaticconstexpr

Statically creates a heat flux vector of zero.

Definition at line 121 of file HeatFlux.hpp.

References PhQ::Vector< NumericType >::Zero().

Member Data Documentation

◆ value

PhQ::Vector<double > PhQ::DimensionalVector< Unit::EnergyFlux , double >::value

protectedinherited

Value of this physical quantity expressed in its standard unit of measure.

Definition at line 217 of file DimensionalVector.hpp.

The documentation for this class was generated from the following files:

PhQ/Angle.hpp
PhQ/HeatFlux.hpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

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

Constructor & Destructor Documentation

◆ HeatFlux() [1/11]

◆ HeatFlux() [2/11]

◆ HeatFlux() [3/11]

◆ HeatFlux() [4/11]

◆ HeatFlux() [5/11]

◆ HeatFlux() [6/11]

◆ HeatFlux() [7/11]

◆ ~HeatFlux()

◆ HeatFlux() [8/11]

◆ HeatFlux() [9/11]

◆ HeatFlux() [10/11]

◆ HeatFlux() [11/11]

Member Function Documentation

◆ Angle()

◆ Create() [1/3]

◆ Create() [2/3]

◆ Create() [3/3]

◆ Dimensions()

◆ Direction()

◆ JSON() [1/2]

◆ JSON() [2/2]

◆ Magnitude()

◆ MutableValue()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/()

◆ 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]

◆ x()

◆ XML() [1/2]

◆ XML() [2/2]

◆ y()

◆ YAML() [1/2]

◆ YAML() [2/2]

◆ z()

◆ Zero()

Member Data Documentation

◆ value

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