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

#include "PlanarHeatFlux.hpp"

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

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

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

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

constexpr	PlanarHeatFlux (const HeatFlux< NumericType > &heat_flux)
	Constructor. Constructs a planar heat flux vector from a given heat flux vector by projecting the heat flux vector onto the XY plane. More...

constexpr	PlanarHeatFlux (const ScalarThermalConductivity< NumericType > &scalar_thermal_conductivity, const PlanarTemperatureGradient< NumericType > &planar_temperature_gradient)
	Constructor. Constructs a planar heat flux vector from a given scalar thermal conductivity and planar 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	PlanarHeatFlux (const ThermalConductivity< NumericType > &thermal_conductivity, const PlanarTemperatureGradient< NumericType > &planar_temperature_gradient)
	Constructor. Constructs a planar heat flux vector from a given thermal conductivity tensor and planar 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...

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

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

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

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

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

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

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

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

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

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

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

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

constexpr PlanarHeatFlux< NumericType >	operator+ (const PlanarHeatFlux< NumericType > &planar_heat_flux) const

constexpr PlanarHeatFlux< NumericType >	operator- (const PlanarHeatFlux< NumericType > &planar_heat_flux) const

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

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

constexpr void	operator+= (const PlanarHeatFlux< NumericType > &planar_heat_flux) noexcept

constexpr void	operator-= (const PlanarHeatFlux< NumericType > &planar_heat_flux) noexcept

constexpr void	operator*= (const NumericType number) noexcept

constexpr void	operator/= (const NumericType number) noexcept

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

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

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

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

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

template<Unit::EnergyFlux Unit>
static constexpr PlanarHeatFlux< NumericType >	Create (const PlanarVector< NumericType > &value)
	Statically creates a planar 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::PlanarVector< double >	value
	Value of this physical quantity expressed in its standard unit of measure. More...

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

Detailed Description

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

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

Definition at line 49 of file PlanarHeatFlux.hpp.

Constructor & Destructor Documentation

◆ PlanarHeatFlux() [1/11]

template<typename NumericType = double>

PhQ::PlanarHeatFlux< NumericType >::PlanarHeatFlux ( )

default

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

◆ PlanarHeatFlux() [2/11]

template<typename NumericType = double>

PhQ::PlanarHeatFlux< NumericType >::PlanarHeatFlux	(	const PlanarVector< NumericType > &	value,
		const Unit::EnergyFlux	unit
	)

inline

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

Definition at line 56 of file PlanarHeatFlux.hpp.

◆ PlanarHeatFlux() [3/11]

template<typename NumericType = double>

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

inline

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

Definition at line 61 of file PlanarHeatFlux.hpp.

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

◆ PlanarHeatFlux() [4/11]

template<typename NumericType = double>

constexpr PhQ::PlanarHeatFlux< NumericType >::PlanarHeatFlux	(	const ScalarHeatFlux< NumericType > &	scalar_heat_flux,
		const PlanarDirection< NumericType > &	planar_direction
	)

inlineconstexpr

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

Definition at line 66 of file PlanarHeatFlux.hpp.

◆ PlanarHeatFlux() [5/11]

template<typename NumericType >

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

inlineexplicitconstexpr

Constructor. Constructs a planar heat flux vector from a given heat flux vector by projecting the heat flux vector onto the XY plane.

Definition at line 292 of file HeatFlux.hpp.

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

◆ PlanarHeatFlux() [6/11]

template<typename NumericType = double>

constexpr PhQ::PlanarHeatFlux< NumericType >::PlanarHeatFlux	(	const ScalarThermalConductivity< NumericType > &	scalar_thermal_conductivity,
		const PlanarTemperatureGradient< NumericType > &	planar_temperature_gradient
	)

inlineconstexpr

Constructor. Constructs a planar heat flux vector from a given scalar thermal conductivity and planar 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 78 of file PlanarHeatFlux.hpp.

◆ PlanarHeatFlux() [7/11]

template<typename NumericType = double>

constexpr PhQ::PlanarHeatFlux< NumericType >::PlanarHeatFlux	(	const ThermalConductivity< NumericType > &	thermal_conductivity,
		const PlanarTemperatureGradient< NumericType > &	planar_temperature_gradient
	)

inlineconstexpr

Constructor. Constructs a planar heat flux vector from a given thermal conductivity tensor and planar 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 88 of file PlanarHeatFlux.hpp.

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

◆ ~PlanarHeatFlux()

template<typename NumericType = double>

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

defaultnoexcept

Destructor. Destroys this planar heat flux vector.

◆ PlanarHeatFlux() [8/11]

template<typename NumericType = double>

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

constexprdefault

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

◆ PlanarHeatFlux() [9/11]

template<typename NumericType = double>

template<typename OtherNumericType >

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

inlineexplicitconstexpr

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

Definition at line 102 of file PlanarHeatFlux.hpp.

◆ PlanarHeatFlux() [10/11]

template<typename NumericType = double>

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

constexprdefaultnoexcept

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

◆ PlanarHeatFlux() [11/11]

template<typename NumericType = double>

constexpr PhQ::PlanarHeatFlux< NumericType >::PlanarHeatFlux ( const PlanarVector< NumericType > & value )

inlineexplicitconstexprprivate

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

Definition at line 220 of file PlanarHeatFlux.hpp.

Member Function Documentation

◆ Angle()

template<typename NumericType = double>

PhQ::Angle<NumericType> PhQ::PlanarHeatFlux< NumericType >::Angle ( const PlanarHeatFlux< NumericType > & planar_heat_flux ) const

inline

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

Definition at line 178 of file PlanarHeatFlux.hpp.

◆ Create() [1/3]

template<typename NumericType = double>

template<Unit::EnergyFlux Unit>

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

inlinestaticconstexpr

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

Definition at line 131 of file PlanarHeatFlux.hpp.

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

◆ Create() [2/3]

template<typename NumericType = double>

template<Unit::EnergyFlux Unit>

static constexpr PlanarHeatFlux<NumericType> PhQ::PlanarHeatFlux< NumericType >::Create ( const PlanarVector< NumericType > & value )

inlinestaticconstexpr

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

Definition at line 151 of file PlanarHeatFlux.hpp.

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

◆ Create() [3/3]

template<typename NumericType = double>

template<Unit::EnergyFlux Unit>

static constexpr PlanarHeatFlux<NumericType> PhQ::PlanarHeatFlux< NumericType >::Create ( const std::array< NumericType, 2 > & x_y )

inlinestaticconstexpr

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

Definition at line 141 of file PlanarHeatFlux.hpp.

◆ Dimensions()

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

inlinestaticconstexprinherited

Physical dimension set of this physical quantity.

Definition at line 50 of file DimensionalPlanarVector.hpp.

◆ JSON() [1/2]

std::string PhQ::DimensionalPlanarVector< 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 DimensionalPlanarVector.hpp.

◆ JSON() [2/2]

std::string PhQ::DimensionalPlanarVector< 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 DimensionalPlanarVector.hpp.

◆ Magnitude()

template<typename NumericType = double>

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

inline

Returns the magnitude of this planar heat flux vector.

Definition at line 168 of file PlanarHeatFlux.hpp.

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

◆ MutableValue()

constexpr PhQ::PlanarVector<double >& PhQ::DimensionalPlanarVector< 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 DimensionalPlanarVector.hpp.

◆ operator*()

template<typename NumericType = double>

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

inlineconstexpr

Definition at line 193 of file PlanarHeatFlux.hpp.

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

◆ operator*=()

template<typename NumericType = double>

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

inlineconstexprnoexcept

Definition at line 209 of file PlanarHeatFlux.hpp.

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

◆ operator+()

template<typename NumericType = double>

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

inlineconstexpr

Definition at line 183 of file PlanarHeatFlux.hpp.

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

◆ operator+=()

template<typename NumericType = double>

constexpr void PhQ::PlanarHeatFlux< NumericType >::operator+= ( const PlanarHeatFlux< NumericType > & planar_heat_flux )

inlineconstexprnoexcept

Definition at line 201 of file PlanarHeatFlux.hpp.

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

◆ operator-()

template<typename NumericType = double>

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

inlineconstexpr

Definition at line 188 of file PlanarHeatFlux.hpp.

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

◆ operator-=()

template<typename NumericType = double>

constexpr void PhQ::PlanarHeatFlux< NumericType >::operator-= ( const PlanarHeatFlux< NumericType > & planar_heat_flux )

inlineconstexprnoexcept

Definition at line 205 of file PlanarHeatFlux.hpp.

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

◆ operator/()

template<typename NumericType = double>

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

inlineconstexpr

Definition at line 197 of file PlanarHeatFlux.hpp.

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

◆ operator/=()

template<typename NumericType = double>

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

inlineconstexprnoexcept

Definition at line 213 of file PlanarHeatFlux.hpp.

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

◆ operator=() [1/3]

template<typename NumericType = double>

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

constexprdefault

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

◆ operator=() [2/3]

template<typename NumericType = double>

template<typename OtherNumericType >

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

inlineconstexpr

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

Definition at line 114 of file PlanarHeatFlux.hpp.

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

◆ operator=() [3/3]

template<typename NumericType = double>

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

constexprdefaultnoexcept

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

◆ PlanarDirection()

template<typename NumericType = double>

PhQ::PlanarDirection<NumericType> PhQ::PlanarHeatFlux< NumericType >::PlanarDirection ( ) const

inline

Returns the direction of this planar heat flux vector.

Definition at line 173 of file PlanarHeatFlux.hpp.

References PhQ::PlanarVector< NumericType >::PlanarDirection(), and PhQ::DimensionalPlanarVector< Unit::EnergyFlux, double >::value.

◆ Print() [1/2]

std::string PhQ::DimensionalPlanarVector< 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 DimensionalPlanarVector.hpp.

◆ Print() [2/2]

std::string PhQ::DimensionalPlanarVector< 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 DimensionalPlanarVector.hpp.

◆ SetValue()

constexpr void PhQ::DimensionalPlanarVector< Unit::EnergyFlux , double >::SetValue ( const PhQ::PlanarVector< 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 DimensionalPlanarVector.hpp.

◆ StaticValue()

constexpr PhQ::PlanarVector<double > PhQ::DimensionalPlanarVector< 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 DimensionalPlanarVector.hpp.

◆ Unit()

static constexpr Unit::EnergyFlux PhQ::DimensionalPlanarVector< 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 DimensionalPlanarVector.hpp.

◆ Value() [1/2]

constexpr const PhQ::PlanarVector<double >& PhQ::DimensionalPlanarVector< Unit::EnergyFlux , double >::Value ( ) const

inlineconstexprnoexceptinherited

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

Definition at line 61 of file DimensionalPlanarVector.hpp.

◆ Value() [2/2]

PhQ::PlanarVector<double > PhQ::DimensionalPlanarVector< 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 DimensionalPlanarVector.hpp.

◆ x()

template<typename NumericType = double>

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

inlineconstexprnoexcept

Returns the x Cartesian component of this planar heat flux vector.

Definition at line 158 of file PlanarHeatFlux.hpp.

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

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

◆ XML() [1/2]

std::string PhQ::DimensionalPlanarVector< 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 DimensionalPlanarVector.hpp.

◆ XML() [2/2]

std::string PhQ::DimensionalPlanarVector< 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 DimensionalPlanarVector.hpp.

◆ y()

template<typename NumericType = double>

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

inlineconstexprnoexcept

Returns the y Cartesian component of this planar heat flux vector.

Definition at line 163 of file PlanarHeatFlux.hpp.

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

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

◆ YAML() [1/2]

std::string PhQ::DimensionalPlanarVector< 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 DimensionalPlanarVector.hpp.

◆ YAML() [2/2]

std::string PhQ::DimensionalPlanarVector< 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 DimensionalPlanarVector.hpp.

◆ Zero()

template<typename NumericType = double>

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

inlinestaticconstexpr

Statically creates a planar heat flux vector of zero.

Definition at line 124 of file PlanarHeatFlux.hpp.

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

Member Data Documentation

◆ value

PhQ::PlanarVector<double > PhQ::DimensionalPlanarVector< Unit::EnergyFlux , double >::value

protectedinherited

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

Definition at line 222 of file DimensionalPlanarVector.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::PlanarHeatFlux< NumericType >

Constructor & Destructor Documentation

◆ PlanarHeatFlux() [1/11]

◆ PlanarHeatFlux() [2/11]

◆ PlanarHeatFlux() [3/11]

◆ PlanarHeatFlux() [4/11]

◆ PlanarHeatFlux() [5/11]

◆ PlanarHeatFlux() [6/11]

◆ PlanarHeatFlux() [7/11]

◆ ~PlanarHeatFlux()

◆ PlanarHeatFlux() [8/11]

◆ PlanarHeatFlux() [9/11]

◆ PlanarHeatFlux() [10/11]

◆ PlanarHeatFlux() [11/11]

Member Function Documentation

◆ Angle()

◆ Create() [1/3]

◆ Create() [2/3]

◆ Create() [3/3]

◆ Dimensions()

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

◆ PlanarDirection()

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

◆ Zero()

Member Data Documentation

◆ value

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