Two-dimensional Euclidean temperature gradient vector in the XY plane. Contains two components in Cartesian coordinates: x and y. For a three-dimensional Euclidean temperature gradient vector, see PhQ::TemperatureGradient. For scalar temperature gradient components or for the magnitude of a temperature gradient vector, see PhQ::ScalarTemperatureGradient. More...

#include "PlanarTemperatureGradient.hpp"

Public Member Functions
	PlanarTemperatureGradient ()=default
	Default constructor. Constructs a planar temperature gradient vector with an uninitialized value. More...

	PlanarTemperatureGradient (const PlanarVector< NumericType > &value, const Unit::TemperatureGradient unit)
	Constructor. Constructs a planar temperature gradient vector with a given value expressed in a given temperature gradient unit. More...

	PlanarTemperatureGradient (const ScalarTemperatureGradient< NumericType > &x, const ScalarTemperatureGradient< NumericType > &y)
	Constructor. Constructs a planar temperature gradient vector from a given set of scalar temperature gradient components. More...

constexpr	PlanarTemperatureGradient (const ScalarTemperatureGradient< NumericType > &scalar_temperature_gradient, const PlanarDirection< NumericType > &planar_direction)
	Constructor. Constructs a planar temperature gradient vector from a given scalar temperature gradient magnitude and planar direction. More...

constexpr	PlanarTemperatureGradient (const TemperatureGradient< NumericType > &temperature_gradient)
	Constructor. Constructs a planar temperature gradient vector from a given temperature gradient vector by projecting the temperature gradient vector onto the XY plane. More...

	~PlanarTemperatureGradient () noexcept=default
	Destructor. Destroys this planar temperature gradient vector. More...

constexpr	PlanarTemperatureGradient (const PlanarTemperatureGradient< NumericType > &other)=default
	Copy constructor. Constructs a planar temperature gradient vector by copying another one. More...

template<typename OtherNumericType >
constexpr	PlanarTemperatureGradient (const PlanarTemperatureGradient< OtherNumericType > &other)
	Copy constructor. Constructs a planar temperature gradient vector by copying another one. More...

constexpr	PlanarTemperatureGradient (PlanarTemperatureGradient< NumericType > &&other) noexcept=default
	Move constructor. Constructs a planar temperature gradient vector by moving another one. More...

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

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

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

constexpr ScalarTemperatureGradient< NumericType >	x () const noexcept
	Returns the x Cartesian component of this planar temperature gradient vector. More...

constexpr ScalarTemperatureGradient< NumericType >	y () const noexcept
	Returns the y Cartesian component of this planar temperature gradient vector. More...

ScalarTemperatureGradient< NumericType >	Magnitude () const
	Returns the magnitude of this planar temperature gradient vector. More...

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

PhQ::Angle< NumericType >	Angle (const PlanarTemperatureGradient< NumericType > &planar_temperature_gradient) const
	Returns the angle between this planar temperature gradient vector and another one. More...

constexpr PlanarTemperatureGradient< NumericType >	operator+ (const PlanarTemperatureGradient< NumericType > &planar_temperature_gradient) const

constexpr PlanarTemperatureGradient< NumericType >	operator- (const PlanarTemperatureGradient< NumericType > &planar_temperature_gradient) const

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

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

constexpr void	operator+= (const PlanarTemperatureGradient< NumericType > &planar_temperature_gradient) noexcept

constexpr void	operator-= (const PlanarTemperatureGradient< NumericType > &planar_temperature_gradient) 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::TemperatureGradient 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::TemperatureGradient 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::TemperatureGradient 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::TemperatureGradient 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::TemperatureGradient 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 PlanarTemperatureGradient< NumericType >	Zero ()
	Statically creates a planar temperature gradient vector of zero. More...

template<Unit::TemperatureGradient Unit>
static constexpr PlanarTemperatureGradient< NumericType >	Create (const NumericType x, const NumericType y)
	Statically creates a planar temperature gradient vector from the given x and y Cartesian components expressed in a given temperature gradient unit. More...

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

template<Unit::TemperatureGradient Unit>
static constexpr PlanarTemperatureGradient< NumericType >	Create (const PlanarVector< NumericType > &value)
	Statically creates a planar temperature gradient vector with a given value expressed in a given temperature gradient unit. More...

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

static constexpr Unit::TemperatureGradient	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	PlanarTemperatureGradient (const PlanarVector< NumericType > &value)
	Constructor. Constructs a planar temperature gradient vector with a given value expressed in the standard temperature gradient unit. More...

Detailed Description

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

Two-dimensional Euclidean temperature gradient vector in the XY plane. Contains two components in Cartesian coordinates: x and y. For a three-dimensional Euclidean temperature gradient vector, see PhQ::TemperatureGradient. For scalar temperature gradient components or for the magnitude of a temperature gradient vector, see PhQ::ScalarTemperatureGradient.

Definition at line 47 of file PlanarTemperatureGradient.hpp.

Constructor & Destructor Documentation

◆ PlanarTemperatureGradient() [1/9]

template<typename NumericType = double>

PhQ::PlanarTemperatureGradient< NumericType >::PlanarTemperatureGradient ( )

default

Default constructor. Constructs a planar temperature gradient vector with an uninitialized value.

◆ PlanarTemperatureGradient() [2/9]

template<typename NumericType = double>

PhQ::PlanarTemperatureGradient< NumericType >::PlanarTemperatureGradient	(	const PlanarVector< NumericType > &	value,
		const Unit::TemperatureGradient	unit
	)

inline

Constructor. Constructs a planar temperature gradient vector with a given value expressed in a given temperature gradient unit.

Definition at line 56 of file PlanarTemperatureGradient.hpp.

◆ PlanarTemperatureGradient() [3/9]

template<typename NumericType = double>

PhQ::PlanarTemperatureGradient< NumericType >::PlanarTemperatureGradient	(	const ScalarTemperatureGradient< NumericType > &	x,
		const ScalarTemperatureGradient< NumericType > &	y
	)

inline

Constructor. Constructs a planar temperature gradient vector from a given set of scalar temperature gradient components.

Definition at line 62 of file PlanarTemperatureGradient.hpp.

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

◆ PlanarTemperatureGradient() [4/9]

template<typename NumericType = double>

constexpr PhQ::PlanarTemperatureGradient< NumericType >::PlanarTemperatureGradient	(	const ScalarTemperatureGradient< NumericType > &	scalar_temperature_gradient,
		const PlanarDirection< NumericType > &	planar_direction
	)

inlineconstexpr

Constructor. Constructs a planar temperature gradient vector from a given scalar temperature gradient magnitude and planar direction.

Definition at line 68 of file PlanarTemperatureGradient.hpp.

◆ PlanarTemperatureGradient() [5/9]

template<typename NumericType >

constexpr PhQ::PlanarTemperatureGradient< NumericType >::PlanarTemperatureGradient ( const TemperatureGradient< NumericType > & temperature_gradient )

inlineexplicitconstexpr

Constructor. Constructs a planar temperature gradient vector from a given temperature gradient vector by projecting the temperature gradient vector onto the XY plane.

Definition at line 292 of file TemperatureGradient.hpp.

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

◆ ~PlanarTemperatureGradient()

template<typename NumericType = double>

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

defaultnoexcept

Destructor. Destroys this planar temperature gradient vector.

◆ PlanarTemperatureGradient() [6/9]

template<typename NumericType = double>

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

constexprdefault

Copy constructor. Constructs a planar temperature gradient vector by copying another one.

◆ PlanarTemperatureGradient() [7/9]

template<typename NumericType = double>

template<typename OtherNumericType >

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

inlineexplicitconstexpr

Copy constructor. Constructs a planar temperature gradient vector by copying another one.

Definition at line 90 of file PlanarTemperatureGradient.hpp.

◆ PlanarTemperatureGradient() [8/9]

template<typename NumericType = double>

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

constexprdefaultnoexcept

Move constructor. Constructs a planar temperature gradient vector by moving another one.

◆ PlanarTemperatureGradient() [9/9]

template<typename NumericType = double>

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

inlineexplicitconstexprprivate

Constructor. Constructs a planar temperature gradient vector with a given value expressed in the standard temperature gradient unit.

Definition at line 218 of file PlanarTemperatureGradient.hpp.

Member Function Documentation

◆ Angle()

template<typename NumericType = double>

PhQ::Angle<NumericType> PhQ::PlanarTemperatureGradient< NumericType >::Angle ( const PlanarTemperatureGradient< NumericType > & planar_temperature_gradient ) const

inline

Returns the angle between this planar temperature gradient vector and another one.

Definition at line 174 of file PlanarTemperatureGradient.hpp.

◆ Create() [1/3]

template<typename NumericType = double>

template<Unit::TemperatureGradient Unit>

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

inlinestaticconstexpr

Statically creates a planar temperature gradient vector from the given x and y Cartesian components expressed in a given temperature gradient unit.

Definition at line 126 of file PlanarTemperatureGradient.hpp.

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

◆ Create() [2/3]

template<typename NumericType = double>

template<Unit::TemperatureGradient Unit>

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

inlinestaticconstexpr

Statically creates a planar temperature gradient vector with a given value expressed in a given temperature gradient unit.

Definition at line 146 of file PlanarTemperatureGradient.hpp.

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

◆ Create() [3/3]

template<typename NumericType = double>

template<Unit::TemperatureGradient Unit>

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

inlinestaticconstexpr

Statically creates a planar temperature gradient vector from the given x and y Cartesian components expressed in a given temperature gradient unit.

Definition at line 136 of file PlanarTemperatureGradient.hpp.

◆ Dimensions()

static constexpr const PhQ::Dimensions& PhQ::DimensionalPlanarVector< Unit::TemperatureGradient , 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::TemperatureGradient , 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::TemperatureGradient , double >::JSON ( const Unit::TemperatureGradient 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>

ScalarTemperatureGradient<NumericType> PhQ::PlanarTemperatureGradient< NumericType >::Magnitude ( ) const

inline

Returns the magnitude of this planar temperature gradient vector.

Definition at line 164 of file PlanarTemperatureGradient.hpp.

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

◆ MutableValue()

constexpr PhQ::PlanarVector<double >& PhQ::DimensionalPlanarVector< Unit::TemperatureGradient , 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 PlanarTemperatureGradient<NumericType> PhQ::PlanarTemperatureGradient< NumericType >::operator* ( const NumericType number ) const

inlineconstexpr

Definition at line 189 of file PlanarTemperatureGradient.hpp.

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

◆ operator*=()

template<typename NumericType = double>

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

inlineconstexprnoexcept

Definition at line 207 of file PlanarTemperatureGradient.hpp.

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

◆ operator+()

template<typename NumericType = double>

constexpr PlanarTemperatureGradient<NumericType> PhQ::PlanarTemperatureGradient< NumericType >::operator+ ( const PlanarTemperatureGradient< NumericType > & planar_temperature_gradient ) const

inlineconstexpr

Definition at line 179 of file PlanarTemperatureGradient.hpp.

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

◆ operator+=()

template<typename NumericType = double>

constexpr void PhQ::PlanarTemperatureGradient< NumericType >::operator+= ( const PlanarTemperatureGradient< NumericType > & planar_temperature_gradient )

inlineconstexprnoexcept

Definition at line 197 of file PlanarTemperatureGradient.hpp.

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

◆ operator-()

template<typename NumericType = double>

constexpr PlanarTemperatureGradient<NumericType> PhQ::PlanarTemperatureGradient< NumericType >::operator- ( const PlanarTemperatureGradient< NumericType > & planar_temperature_gradient ) const

inlineconstexpr

Definition at line 184 of file PlanarTemperatureGradient.hpp.

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

◆ operator-=()

template<typename NumericType = double>

constexpr void PhQ::PlanarTemperatureGradient< NumericType >::operator-= ( const PlanarTemperatureGradient< NumericType > & planar_temperature_gradient )

inlineconstexprnoexcept

Definition at line 202 of file PlanarTemperatureGradient.hpp.

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

◆ operator/()

template<typename NumericType = double>

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

inlineconstexpr

Definition at line 193 of file PlanarTemperatureGradient.hpp.

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

◆ operator/=()

template<typename NumericType = double>

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

inlineconstexprnoexcept

Definition at line 211 of file PlanarTemperatureGradient.hpp.

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

◆ operator=() [1/3]

template<typename NumericType = double>

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

constexprdefault

Copy assignment operator. Assigns this planar temperature gradient vector by copying another one.

◆ operator=() [2/3]

template<typename NumericType = double>

template<typename OtherNumericType >

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

inlineconstexpr

Copy assignment operator. Assigns this planar temperature gradient vector by copying another one.

Definition at line 107 of file PlanarTemperatureGradient.hpp.

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

◆ operator=() [3/3]

template<typename NumericType = double>

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

constexprdefaultnoexcept

Move assignment operator. Assigns this planar temperature gradient vector by moving another one.

◆ PlanarDirection()

template<typename NumericType = double>

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

inline

Returns the direction of this planar temperature gradient vector.

Definition at line 169 of file PlanarTemperatureGradient.hpp.

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

◆ Print() [1/2]

std::string PhQ::DimensionalPlanarVector< Unit::TemperatureGradient , 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::TemperatureGradient , double >::Print ( const Unit::TemperatureGradient 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::TemperatureGradient , 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::TemperatureGradient , 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::TemperatureGradient PhQ::DimensionalPlanarVector< Unit::TemperatureGradient , 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::TemperatureGradient , 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::TemperatureGradient , double >::Value ( const Unit::TemperatureGradient 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 ScalarTemperatureGradient<NumericType> PhQ::PlanarTemperatureGradient< NumericType >::x ( ) const

inlineconstexprnoexcept

Returns the x Cartesian component of this planar temperature gradient vector.

Definition at line 154 of file PlanarTemperatureGradient.hpp.

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

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

◆ XML() [1/2]

std::string PhQ::DimensionalPlanarVector< Unit::TemperatureGradient , 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::TemperatureGradient , double >::XML ( const Unit::TemperatureGradient 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 ScalarTemperatureGradient<NumericType> PhQ::PlanarTemperatureGradient< NumericType >::y ( ) const

inlineconstexprnoexcept

Returns the y Cartesian component of this planar temperature gradient vector.

Definition at line 159 of file PlanarTemperatureGradient.hpp.

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

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

◆ YAML() [1/2]

std::string PhQ::DimensionalPlanarVector< Unit::TemperatureGradient , 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::TemperatureGradient , double >::YAML ( const Unit::TemperatureGradient 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 PlanarTemperatureGradient<NumericType> PhQ::PlanarTemperatureGradient< NumericType >::Zero ( )

inlinestaticconstexpr

Statically creates a planar temperature gradient vector of zero.

Definition at line 119 of file PlanarTemperatureGradient.hpp.

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

Member Data Documentation

◆ value

PhQ::PlanarVector<double > PhQ::DimensionalPlanarVector< Unit::TemperatureGradient , 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::PlanarTemperatureGradient< NumericType >

Constructor & Destructor Documentation

◆ PlanarTemperatureGradient() [1/9]

◆ PlanarTemperatureGradient() [2/9]

◆ PlanarTemperatureGradient() [3/9]

◆ PlanarTemperatureGradient() [4/9]

◆ PlanarTemperatureGradient() [5/9]

◆ ~PlanarTemperatureGradient()

◆ PlanarTemperatureGradient() [6/9]

◆ PlanarTemperatureGradient() [7/9]

◆ PlanarTemperatureGradient() [8/9]

◆ PlanarTemperatureGradient() [9/9]

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::PlanarTemperatureGradient< NumericType >