Scalar component or resultant of a three-dimensional Euclidean velocity gradient dyadic tensor. For the related tensor, see PhQ::VelocityGradient. Can also represent the time rate of change of a scalar displacement gradient; see PhQ::ScalarDisplacementGradient, PhQ::Time, and PhQ::Frequency. More...

#include "ScalarVelocityGradient.hpp"

Public Member Functions
	ScalarVelocityGradient ()=default
	Default constructor. Constructs a scalar velocity gradient with an uninitialized value. More...

	ScalarVelocityGradient (const NumericType value, const Unit::Frequency unit)
	Constructor. Constructs a scalar velocity gradient with a given value expressed in a given frequency unit. More...

constexpr	ScalarVelocityGradient (const ScalarDisplacementGradient< NumericType > &scalar_displacement_gradient, const Time< NumericType > &time)
	Constructor. Constructs a scalar velocity gradient from a given scalar displacement gradient and time using the definition of speed. More...

constexpr	ScalarVelocityGradient (const ScalarDisplacementGradient< NumericType > &scalar_displacement_gradient, const Frequency< NumericType > &frequency)
	Constructor. Constructs a scalar velocity gradient from a given scalar displacement gradient and frequency using the definition of speed. More...

	~ScalarVelocityGradient () noexcept=default
	Destructor. Destroys this scalar velocity gradient. More...

constexpr	ScalarVelocityGradient (const ScalarVelocityGradient< NumericType > &other)=default
	Copy constructor. Constructs a scalar velocity gradient by copying another one. More...

template<typename OtherNumericType >
constexpr	ScalarVelocityGradient (const ScalarVelocityGradient< OtherNumericType > &other)
	Copy constructor. Constructs a scalar velocity gradient by copying another one. More...

constexpr	ScalarVelocityGradient (ScalarVelocityGradient< NumericType > &&other) noexcept=default
	Move constructor. Constructs a scalar velocity gradient by moving another one. More...

constexpr ScalarVelocityGradient< NumericType > &	operator= (const ScalarVelocityGradient< NumericType > &other)=default
	Copy assignment operator. Assigns this scalar velocity gradient by copying another one. More...

template<typename OtherNumericType >
constexpr ScalarVelocityGradient< NumericType > &	operator= (const ScalarVelocityGradient< OtherNumericType > &other)
	Copy assignment operator. Assigns this scalar velocity gradient by copying another one. More...

constexpr ScalarVelocityGradient< NumericType > &	operator= (ScalarVelocityGradient< NumericType > &&other) noexcept=default
	Move assignment operator. Assigns this scalar velocity gradient by moving another one. More...

constexpr ScalarVelocityGradient< NumericType >	operator+ (const ScalarVelocityGradient< NumericType > &other) const

constexpr ScalarVelocityGradient< NumericType >	operator- (const ScalarVelocityGradient< NumericType > &other) const

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

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

constexpr ScalarDisplacementGradient< NumericType >	operator* (const Time< NumericType > &time) const

constexpr NumericType	operator/ (const ScalarVelocityGradient< NumericType > &other) const noexcept

constexpr ScalarDisplacementGradient< NumericType >	operator/ (const Frequency< NumericType > &frequency) const

constexpr void	operator+= (const ScalarVelocityGradient< NumericType > &other) noexcept

constexpr void	operator-= (const ScalarVelocityGradient< NumericType > &other) 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::Frequency 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::Frequency 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::Frequency 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::Frequency 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::Frequency 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 ScalarVelocityGradient< NumericType >	Zero ()
	Statically creates a scalar velocity gradient of zero. More...

template<Unit::Frequency Unit>
static constexpr ScalarVelocityGradient< NumericType >	Create (const NumericType value)
	Statically creates a scalar velocity gradient with a given value expressed in a given frequency unit. More...

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

static constexpr Unit::Frequency	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	ScalarVelocityGradient (const NumericType value)
	Constructor. Constructs a scalar velocity gradient with a given value expressed in the standard frequency unit. More...

Friends
template<typename OtherNumericType >
class	VelocityGradient

Detailed Description

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

Scalar component or resultant of a three-dimensional Euclidean velocity gradient dyadic tensor. For the related tensor, see PhQ::VelocityGradient. Can also represent the time rate of change of a scalar displacement gradient; see PhQ::ScalarDisplacementGradient, PhQ::Time, and PhQ::Frequency.

Definition at line 45 of file ScalarVelocityGradient.hpp.

Constructor & Destructor Documentation

◆ ScalarVelocityGradient() [1/8]

template<typename NumericType = double>

PhQ::ScalarVelocityGradient< NumericType >::ScalarVelocityGradient ( )

default

Default constructor. Constructs a scalar velocity gradient with an uninitialized value.

◆ ScalarVelocityGradient() [2/8]

template<typename NumericType = double>

PhQ::ScalarVelocityGradient< NumericType >::ScalarVelocityGradient	(	const NumericType	value,
		const Unit::Frequency	unit
	)

inline

Constructor. Constructs a scalar velocity gradient with a given value expressed in a given frequency unit.

Definition at line 52 of file ScalarVelocityGradient.hpp.

◆ ScalarVelocityGradient() [3/8]

template<typename NumericType = double>

constexpr PhQ::ScalarVelocityGradient< NumericType >::ScalarVelocityGradient	(	const ScalarDisplacementGradient< NumericType > &	scalar_displacement_gradient,
		const Time< NumericType > &	time
	)

inlineconstexpr

Constructor. Constructs a scalar velocity gradient from a given scalar displacement gradient and time using the definition of speed.

Definition at line 57 of file ScalarVelocityGradient.hpp.

◆ ScalarVelocityGradient() [4/8]

template<typename NumericType = double>

constexpr PhQ::ScalarVelocityGradient< NumericType >::ScalarVelocityGradient	(	const ScalarDisplacementGradient< NumericType > &	scalar_displacement_gradient,
		const Frequency< NumericType > &	frequency
	)

inlineconstexpr

Constructor. Constructs a scalar velocity gradient from a given scalar displacement gradient and frequency using the definition of speed.

Definition at line 64 of file ScalarVelocityGradient.hpp.

◆ ~ScalarVelocityGradient()

template<typename NumericType = double>

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

defaultnoexcept

Destructor. Destroys this scalar velocity gradient.

◆ ScalarVelocityGradient() [5/8]

template<typename NumericType = double>

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

constexprdefault

Copy constructor. Constructs a scalar velocity gradient by copying another one.

◆ ScalarVelocityGradient() [6/8]

template<typename NumericType = double>

template<typename OtherNumericType >

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

inlineexplicitconstexpr

Copy constructor. Constructs a scalar velocity gradient by copying another one.

Definition at line 78 of file ScalarVelocityGradient.hpp.

◆ ScalarVelocityGradient() [7/8]

template<typename NumericType = double>

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

constexprdefaultnoexcept

Move constructor. Constructs a scalar velocity gradient by moving another one.

◆ ScalarVelocityGradient() [8/8]

template<typename NumericType = double>

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

inlineexplicitconstexprprivate

Constructor. Constructs a scalar velocity gradient with a given value expressed in the standard frequency unit.

Definition at line 164 of file ScalarVelocityGradient.hpp.

Member Function Documentation

◆ Create()

template<typename NumericType = double>

template<Unit::Frequency Unit>

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

inlinestaticconstexpr

Statically creates a scalar velocity gradient with a given value expressed in a given frequency unit.

Definition at line 108 of file ScalarVelocityGradient.hpp.

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

◆ Dimensions()

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

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

inlineconstexpr

Definition at line 124 of file ScalarVelocityGradient.hpp.

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

◆ operator*() [2/2]

template<typename NumericType = double>

constexpr ScalarDisplacementGradient<NumericType> PhQ::ScalarVelocityGradient< NumericType >::operator* ( const Time< NumericType > & time ) const

inlineconstexpr

Definition at line 132 of file ScalarVelocityGradient.hpp.

◆ operator*=()

template<typename NumericType = double>

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

inlineconstexprnoexcept

Definition at line 153 of file ScalarVelocityGradient.hpp.

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

◆ operator+()

template<typename NumericType = double>

constexpr ScalarVelocityGradient<NumericType> PhQ::ScalarVelocityGradient< NumericType >::operator+ ( const ScalarVelocityGradient< NumericType > & other ) const

inlineconstexpr

Definition at line 114 of file ScalarVelocityGradient.hpp.

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

◆ operator+=()

template<typename NumericType = double>

constexpr void PhQ::ScalarVelocityGradient< NumericType >::operator+= ( const ScalarVelocityGradient< NumericType > & other )

inlineconstexprnoexcept

Definition at line 145 of file ScalarVelocityGradient.hpp.

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

◆ operator-()

template<typename NumericType = double>

constexpr ScalarVelocityGradient<NumericType> PhQ::ScalarVelocityGradient< NumericType >::operator- ( const ScalarVelocityGradient< NumericType > & other ) const

inlineconstexpr

Definition at line 119 of file ScalarVelocityGradient.hpp.

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

◆ operator-=()

template<typename NumericType = double>

constexpr void PhQ::ScalarVelocityGradient< NumericType >::operator-= ( const ScalarVelocityGradient< NumericType > & other )

inlineconstexprnoexcept

Definition at line 149 of file ScalarVelocityGradient.hpp.

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

◆ operator/() [1/3]

template<typename NumericType = double>

constexpr ScalarDisplacementGradient<NumericType> PhQ::ScalarVelocityGradient< NumericType >::operator/ ( const Frequency< NumericType > & frequency ) const

inlineconstexpr

Definition at line 140 of file ScalarVelocityGradient.hpp.

◆ operator/() [2/3]

template<typename NumericType = double>

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

inlineconstexpr

Definition at line 128 of file ScalarVelocityGradient.hpp.

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

◆ operator/() [3/3]

template<typename NumericType = double>

constexpr NumericType PhQ::ScalarVelocityGradient< NumericType >::operator/ ( const ScalarVelocityGradient< NumericType > & other ) const

inlineconstexprnoexcept

Definition at line 136 of file ScalarVelocityGradient.hpp.

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

◆ operator/=()

template<typename NumericType = double>

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

inlineconstexprnoexcept

Definition at line 157 of file ScalarVelocityGradient.hpp.

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

◆ operator=() [1/3]

template<typename NumericType = double>

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

constexprdefault

Copy assignment operator. Assigns this scalar velocity gradient by copying another one.

◆ operator=() [2/3]

template<typename NumericType = double>

template<typename OtherNumericType >

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

inlineconstexpr

Copy assignment operator. Assigns this scalar velocity gradient by copying another one.

Definition at line 90 of file ScalarVelocityGradient.hpp.

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

◆ operator=() [3/3]

template<typename NumericType = double>

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

constexprdefaultnoexcept

Move assignment operator. Assigns this scalar velocity gradient by moving another one.

◆ Print() [1/2]

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

inlinestaticconstexpr

Statically creates a scalar velocity gradient of zero.

Definition at line 101 of file ScalarVelocityGradient.hpp.

Friends And Related Function Documentation

◆ VelocityGradient

template<typename NumericType = double>

template<typename OtherNumericType >

friend class VelocityGradient

friend

Definition at line 168 of file ScalarVelocityGradient.hpp.

Member Data Documentation

◆ value

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

PhQ/ScalarDisplacementGradient.hpp
PhQ/ScalarVelocityGradient.hpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

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

Constructor & Destructor Documentation

◆ ScalarVelocityGradient() [1/8]

◆ ScalarVelocityGradient() [2/8]

◆ ScalarVelocityGradient() [3/8]

◆ ScalarVelocityGradient() [4/8]

◆ ~ScalarVelocityGradient()

◆ ScalarVelocityGradient() [5/8]

◆ ScalarVelocityGradient() [6/8]

◆ ScalarVelocityGradient() [7/8]

◆ ScalarVelocityGradient() [8/8]

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/3]

◆ operator/() [2/3]

◆ operator/() [3/3]

◆ 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()

Friends And Related Function Documentation

◆ VelocityGradient

Member Data Documentation

◆ value

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