Physical Quantities  v1.0.0
C++ library of physical quantities, physical models, and units of measure for scientific computing. https://github.com/acodcha/phq
Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions | List of all members
PhQ::ScalarAngularAcceleration< NumericType > Class Template Reference

Scalar angular acceleration. Represents the time rate of change of an angular speed; see also PhQ::AngularSpeed, PhQ::Time, and PhQ::Frequency. Can also represent a component or the magnitude of an angular acceleration pseudovector. More...

#include "ScalarAngularAcceleration.hpp"

Public Member Functions

 ScalarAngularAcceleration ()=default
 Default constructor. Constructs a scalar angular acceleration with an uninitialized value. More...
 
 ScalarAngularAcceleration (const NumericType value, const Unit::AngularAcceleration unit)
 Constructor. Constructs a scalar angular acceleration with a given value expressed in a given angular acceleration unit. More...
 
constexpr ScalarAngularAcceleration (const AngularSpeed< NumericType > &angular_speed, const Time< NumericType > &time)
 Constructor. Constructs a scalar angular acceleration from a given angular speed and time using the definition of angular acceleration. More...
 
constexpr ScalarAngularAcceleration (const AngularSpeed< NumericType > &angular_speed, const Frequency< NumericType > &frequency)
 Constructor. Constructs a scalar angular acceleration from a given angular speed and frequency using the definition of angular acceleration. More...
 
 ~ScalarAngularAcceleration () noexcept=default
 Destructor. Destroys this scalar angular acceleration. More...
 
constexpr ScalarAngularAcceleration (const ScalarAngularAcceleration< NumericType > &other)=default
 Copy constructor. Constructs a scalar angular acceleration by copying another one. More...
 
template<typename OtherNumericType >
constexpr ScalarAngularAcceleration (const ScalarAngularAcceleration< OtherNumericType > &other)
 Copy constructor. Constructs a scalar angular acceleration by copying another one. More...
 
constexpr ScalarAngularAcceleration (ScalarAngularAcceleration< NumericType > &&other) noexcept=default
 Move constructor. Constructs a scalar angular acceleration by moving another one. More...
 
constexpr ScalarAngularAcceleration< NumericType > & operator= (const ScalarAngularAcceleration< NumericType > &other)=default
 Copy assignment operator. Assigns this scalar angular acceleration by copying another one. More...
 
template<typename OtherNumericType >
constexpr ScalarAngularAcceleration< NumericType > & operator= (const ScalarAngularAcceleration< OtherNumericType > &other)
 Copy assignment operator. Assigns this scalar angular acceleration by copying another one. More...
 
constexpr ScalarAngularAcceleration< NumericType > & operator= (ScalarAngularAcceleration< NumericType > &&other) noexcept=default
 Move assignment operator. Assigns this scalar angular acceleration by moving another one. More...
 
constexpr ScalarAngularAcceleration< NumericType > operator+ (const ScalarAngularAcceleration< NumericType > &scalar_angular_acceleration) const
 
constexpr ScalarAngularAcceleration< NumericType > operator- (const ScalarAngularAcceleration< NumericType > &scalar_angular_acceleration) const
 
constexpr ScalarAngularAcceleration< NumericType > operator* (const NumericType number) const
 
constexpr AngularSpeed< NumericType > operator* (const Time< NumericType > &time) const
 
constexpr ScalarAngularAcceleration< NumericType > operator/ (const NumericType number) const
 
constexpr AngularSpeed< NumericType > operator/ (const Frequency< NumericType > &frequency) const
 
constexpr Frequency< NumericType > operator/ (const AngularSpeed< NumericType > &angular_speed) const
 
constexpr NumericType operator/ (const ScalarAngularAcceleration< NumericType > &scalar_angular_acceleration) const noexcept
 
constexpr void operator+= (const ScalarAngularAcceleration< NumericType > &scalar_angular_acceleration) noexcept
 
constexpr void operator-= (const ScalarAngularAcceleration< NumericType > &scalar_angular_acceleration) 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::AngularAcceleration 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::AngularAcceleration 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::AngularAcceleration 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::AngularAcceleration 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::AngularAcceleration 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 ScalarAngularAcceleration< NumericType > Zero ()
 Statically creates a scalar angular acceleration of zero. More...
 
template<Unit::AngularAcceleration Unit>
static constexpr ScalarAngularAcceleration< NumericType > Create (const NumericType value)
 Statically creates a scalar angular acceleration with a given value expressed in a given angular acceleration unit. More...
 
static constexpr const PhQ::Dimensions & Dimensions ()
 Physical dimension set of this physical quantity. More...
 
static constexpr Unit::AngularAcceleration 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 ScalarAngularAcceleration (const NumericType value)
 Constructor. Constructs a scalar angular acceleration with a given value expressed in the standard angular acceleration unit. More...
 

Detailed Description

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

Scalar angular acceleration. Represents the time rate of change of an angular speed; see also PhQ::AngularSpeed, PhQ::Time, and PhQ::Frequency. Can also represent a component or the magnitude of an angular acceleration pseudovector.

Definition at line 44 of file ScalarAngularAcceleration.hpp.

Constructor & Destructor Documentation

◆ ScalarAngularAcceleration() [1/8]

template<typename NumericType = double>
PhQ::ScalarAngularAcceleration< NumericType >::ScalarAngularAcceleration ( )
default

Default constructor. Constructs a scalar angular acceleration with an uninitialized value.

◆ ScalarAngularAcceleration() [2/8]

template<typename NumericType = double>
PhQ::ScalarAngularAcceleration< NumericType >::ScalarAngularAcceleration ( const NumericType  value,
const Unit::AngularAcceleration  unit 
)
inline

Constructor. Constructs a scalar angular acceleration with a given value expressed in a given angular acceleration unit.

Definition at line 52 of file ScalarAngularAcceleration.hpp.

◆ ScalarAngularAcceleration() [3/8]

template<typename NumericType = double>
constexpr PhQ::ScalarAngularAcceleration< NumericType >::ScalarAngularAcceleration ( const AngularSpeed< NumericType > &  angular_speed,
const Time< NumericType > &  time 
)
inlineconstexpr

Constructor. Constructs a scalar angular acceleration from a given angular speed and time using the definition of angular acceleration.

Definition at line 57 of file ScalarAngularAcceleration.hpp.

◆ ScalarAngularAcceleration() [4/8]

template<typename NumericType = double>
constexpr PhQ::ScalarAngularAcceleration< NumericType >::ScalarAngularAcceleration ( const AngularSpeed< NumericType > &  angular_speed,
const Frequency< NumericType > &  frequency 
)
inlineconstexpr

Constructor. Constructs a scalar angular acceleration from a given angular speed and frequency using the definition of angular acceleration.

Definition at line 63 of file ScalarAngularAcceleration.hpp.

◆ ~ScalarAngularAcceleration()

template<typename NumericType = double>
PhQ::ScalarAngularAcceleration< NumericType >::~ScalarAngularAcceleration ( )
defaultnoexcept

Destructor. Destroys this scalar angular acceleration.

◆ ScalarAngularAcceleration() [5/8]

template<typename NumericType = double>
constexpr PhQ::ScalarAngularAcceleration< NumericType >::ScalarAngularAcceleration ( const ScalarAngularAcceleration< NumericType > &  other)
constexprdefault

Copy constructor. Constructs a scalar angular acceleration by copying another one.

◆ ScalarAngularAcceleration() [6/8]

template<typename NumericType = double>
template<typename OtherNumericType >
constexpr PhQ::ScalarAngularAcceleration< NumericType >::ScalarAngularAcceleration ( const ScalarAngularAcceleration< OtherNumericType > &  other)
inlineexplicitconstexpr

Copy constructor. Constructs a scalar angular acceleration by copying another one.

Definition at line 76 of file ScalarAngularAcceleration.hpp.

◆ ScalarAngularAcceleration() [7/8]

template<typename NumericType = double>
constexpr PhQ::ScalarAngularAcceleration< NumericType >::ScalarAngularAcceleration ( ScalarAngularAcceleration< NumericType > &&  other)
constexprdefaultnoexcept

Move constructor. Constructs a scalar angular acceleration by moving another one.

◆ ScalarAngularAcceleration() [8/8]

template<typename NumericType = double>
constexpr PhQ::ScalarAngularAcceleration< NumericType >::ScalarAngularAcceleration ( const NumericType  value)
inlineexplicitconstexprprivate

Constructor. Constructs a scalar angular acceleration with a given value expressed in the standard angular acceleration unit.

Definition at line 174 of file ScalarAngularAcceleration.hpp.

Member Function Documentation

◆ Create()

template<typename NumericType = double>
template<Unit::AngularAcceleration Unit>
static constexpr ScalarAngularAcceleration<NumericType> PhQ::ScalarAngularAcceleration< NumericType >::Create ( const NumericType  value)
inlinestaticconstexpr

Statically creates a scalar angular acceleration with a given value expressed in a given angular acceleration unit.

Definition at line 111 of file ScalarAngularAcceleration.hpp.

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

◆ Dimensions()

static constexpr const PhQ::Dimensions& PhQ::DimensionalScalar< Unit::AngularAcceleration , 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::AngularAcceleration , 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::AngularAcceleration , double >::JSON ( const Unit::AngularAcceleration  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::AngularAcceleration , 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 ScalarAngularAcceleration<NumericType> PhQ::ScalarAngularAcceleration< NumericType >::operator* ( const NumericType  number) const
inlineconstexpr

Definition at line 128 of file ScalarAngularAcceleration.hpp.

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

◆ operator*() [2/2]

template<typename NumericType = double>
constexpr AngularSpeed<NumericType> PhQ::ScalarAngularAcceleration< NumericType >::operator* ( const Time< NumericType > &  time) const
inlineconstexpr

Definition at line 132 of file ScalarAngularAcceleration.hpp.

◆ operator*=()

template<typename NumericType = double>
constexpr void PhQ::ScalarAngularAcceleration< NumericType >::operator*= ( const NumericType  number)
inlineconstexprnoexcept

Definition at line 163 of file ScalarAngularAcceleration.hpp.

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

◆ operator+()

template<typename NumericType = double>
constexpr ScalarAngularAcceleration<NumericType> PhQ::ScalarAngularAcceleration< NumericType >::operator+ ( const ScalarAngularAcceleration< NumericType > &  scalar_angular_acceleration) const
inlineconstexpr

Definition at line 118 of file ScalarAngularAcceleration.hpp.

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

◆ operator+=()

template<typename NumericType = double>
constexpr void PhQ::ScalarAngularAcceleration< NumericType >::operator+= ( const ScalarAngularAcceleration< NumericType > &  scalar_angular_acceleration)
inlineconstexprnoexcept

Definition at line 153 of file ScalarAngularAcceleration.hpp.

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

◆ operator-()

template<typename NumericType = double>
constexpr ScalarAngularAcceleration<NumericType> PhQ::ScalarAngularAcceleration< NumericType >::operator- ( const ScalarAngularAcceleration< NumericType > &  scalar_angular_acceleration) const
inlineconstexpr

Definition at line 123 of file ScalarAngularAcceleration.hpp.

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

◆ operator-=()

template<typename NumericType = double>
constexpr void PhQ::ScalarAngularAcceleration< NumericType >::operator-= ( const ScalarAngularAcceleration< NumericType > &  scalar_angular_acceleration)
inlineconstexprnoexcept

Definition at line 158 of file ScalarAngularAcceleration.hpp.

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

◆ operator/() [1/4]

template<typename NumericType = double>
constexpr Frequency<NumericType> PhQ::ScalarAngularAcceleration< NumericType >::operator/ ( const AngularSpeed< NumericType > &  angular_speed) const
inlineconstexpr

Definition at line 144 of file ScalarAngularAcceleration.hpp.

◆ operator/() [2/4]

template<typename NumericType = double>
constexpr AngularSpeed<NumericType> PhQ::ScalarAngularAcceleration< NumericType >::operator/ ( const Frequency< NumericType > &  frequency) const
inlineconstexpr

Definition at line 140 of file ScalarAngularAcceleration.hpp.

◆ operator/() [3/4]

template<typename NumericType = double>
constexpr ScalarAngularAcceleration<NumericType> PhQ::ScalarAngularAcceleration< NumericType >::operator/ ( const NumericType  number) const
inlineconstexpr

Definition at line 136 of file ScalarAngularAcceleration.hpp.

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

◆ operator/() [4/4]

template<typename NumericType = double>
constexpr NumericType PhQ::ScalarAngularAcceleration< NumericType >::operator/ ( const ScalarAngularAcceleration< NumericType > &  scalar_angular_acceleration) const
inlineconstexprnoexcept

Definition at line 148 of file ScalarAngularAcceleration.hpp.

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

◆ operator/=()

template<typename NumericType = double>
constexpr void PhQ::ScalarAngularAcceleration< NumericType >::operator/= ( const NumericType  number)
inlineconstexprnoexcept

Definition at line 167 of file ScalarAngularAcceleration.hpp.

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

◆ operator=() [1/3]

template<typename NumericType = double>
constexpr ScalarAngularAcceleration<NumericType>& PhQ::ScalarAngularAcceleration< NumericType >::operator= ( const ScalarAngularAcceleration< NumericType > &  other)
constexprdefault

Copy assignment operator. Assigns this scalar angular acceleration by copying another one.

◆ operator=() [2/3]

template<typename NumericType = double>
template<typename OtherNumericType >
constexpr ScalarAngularAcceleration<NumericType>& PhQ::ScalarAngularAcceleration< NumericType >::operator= ( const ScalarAngularAcceleration< OtherNumericType > &  other)
inlineconstexpr

Copy assignment operator. Assigns this scalar angular acceleration by copying another one.

Definition at line 92 of file ScalarAngularAcceleration.hpp.

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

◆ operator=() [3/3]

template<typename NumericType = double>
constexpr ScalarAngularAcceleration<NumericType>& PhQ::ScalarAngularAcceleration< NumericType >::operator= ( ScalarAngularAcceleration< NumericType > &&  other)
constexprdefaultnoexcept

Move assignment operator. Assigns this scalar angular acceleration by moving another one.

◆ Print() [1/2]

std::string PhQ::DimensionalScalar< Unit::AngularAcceleration , 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::AngularAcceleration , double >::Print ( const Unit::AngularAcceleration  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::AngularAcceleration , double >::SetValue ( const double  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::AngularAcceleration , 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::AngularAcceleration PhQ::DimensionalScalar< Unit::AngularAcceleration , 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::AngularAcceleration , 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::AngularAcceleration , double >::Value ( const Unit::AngularAcceleration  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::AngularAcceleration , 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::AngularAcceleration , double >::XML ( const Unit::AngularAcceleration  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::AngularAcceleration , 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::AngularAcceleration , double >::YAML ( const Unit::AngularAcceleration  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 ScalarAngularAcceleration<NumericType> PhQ::ScalarAngularAcceleration< NumericType >::Zero ( )
inlinestaticconstexpr

Statically creates a scalar angular acceleration of zero.

Definition at line 104 of file ScalarAngularAcceleration.hpp.

Member Data Documentation

◆ value

double PhQ::DimensionalScalar< Unit::AngularAcceleration , 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:
Physical Quantities (PhQ): Git Repository | Documentation