LinearThermalExpansionCoefficient.hpp

// Copyright © 2020-2024 Alexandre Coderre-Chabot
//
// This file is part of Physical Quantities (PhQ), a C++ library of physical quantities, physical
// models, and units of measure for scientific computing.
//
// Physical Quantities is hosted at:
//     https://github.com/acodcha/phq
//
// Physical Quantities is licensed under the MIT License:
//     https://mit-license.org
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
// associated documentation files (the "Software"), to deal in the Software without restriction,
// including without limitation the rights to use, copy, modify, merge, publish, distribute,
// sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//   - The above copyright notice and this permission notice shall be included in all copies or
//     substantial portions of the Software.
//   - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
//     BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
//     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
//     DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM
//     OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

#ifndef PHQ_LINEAR_THERMAL_EXPANSION_COEFFICIENT_HPP
#define PHQ_LINEAR_THERMAL_EXPANSION_COEFFICIENT_HPP

#include <cstddef>
#include <functional>
#include <ostream>

#include "DimensionalScalar.hpp"
#include "ScalarStrain.hpp"
#include "TemperatureDifference.hpp"
#include "Unit/ReciprocalTemperature.hpp"

namespace PhQ {

/// \brief Linear thermal expansion coefficient. Not to be confused with the volumetric thermal
/// expansion coefficient; see PhQ::VolumetricThermalExpansionCoefficient. For isotropic materials,
/// the volumetric thermal expansion coefficient is usually three times the linear thermal expansion
/// coefficient.
template <typename NumericType = double>
class LinearThermalExpansionCoefficient
  : public DimensionalScalar<Unit::ReciprocalTemperature, NumericType> {
public:
  /// \brief Default constructor. Constructs a linear thermal expansion coefficient with an
  /// uninitialized value.
  LinearThermalExpansionCoefficient() = default;

  /// \brief Constructor. Constructs a linear thermal expansion coefficient with a given value
  /// expressed in a given reciprocal temperature unit.
  LinearThermalExpansionCoefficient(const NumericType value, const Unit::ReciprocalTemperature unit)
    : DimensionalScalar<Unit::ReciprocalTemperature, NumericType>(value, unit) {}

  /// \brief Destructor. Destroys this linear thermal expansion coefficient.
  ~LinearThermalExpansionCoefficient() noexcept = default;

  /// \brief Copy constructor. Constructs a linear thermal expansion coefficient by copying another
  /// one.
  constexpr LinearThermalExpansionCoefficient(
      const LinearThermalExpansionCoefficient<NumericType>& other) = default;

  /// \brief Copy constructor. Constructs a linear thermal expansion coefficient by copying another
  /// one.
  template <typename OtherNumericType>
  explicit constexpr LinearThermalExpansionCoefficient(
      const LinearThermalExpansionCoefficient<OtherNumericType>& other)
    : LinearThermalExpansionCoefficient(static_cast<NumericType>(other.Value())) {}

  /// \brief Move constructor. Constructs a linear thermal expansion coefficient by moving another
  /// one.
  constexpr LinearThermalExpansionCoefficient(
      LinearThermalExpansionCoefficient<NumericType>&& other) noexcept = default;

  /// \brief Copy assignment operator. Assigns this linear thermal expansion coefficient by copying
  /// another one.
  constexpr LinearThermalExpansionCoefficient<NumericType>& operator=(
      const LinearThermalExpansionCoefficient<NumericType>& other) = default;

  /// \brief Copy assignment operator. Assigns this linear thermal expansion coefficient by copying
  /// another one.
  template <typename OtherNumericType>
  constexpr LinearThermalExpansionCoefficient<NumericType>& operator=(
      const LinearThermalExpansionCoefficient<OtherNumericType>& other) {
    this->value = static_cast<NumericType>(other.Value());
    return *this;
  }

  /// \brief Move assignment operator. Assigns this linear thermal expansion coefficient by moving
  /// another one.
  constexpr LinearThermalExpansionCoefficient<NumericType>& operator=(
      LinearThermalExpansionCoefficient<NumericType>&& other) noexcept = default;

  /// \brief Statically creates a linear thermal expansion coefficient of zero.
  [[nodiscard]] static constexpr LinearThermalExpansionCoefficient<NumericType> Zero() {
    return LinearThermalExpansionCoefficient<NumericType>{static_cast<NumericType>(0)};
  }

  /// \brief Statically creates a linear thermal expansion coefficient with a given value expressed
  /// in a given reciprocal temperature unit.
  template <Unit::ReciprocalTemperature Unit>
  [[nodiscard]] static constexpr LinearThermalExpansionCoefficient<NumericType> Create(
      const NumericType value) {
    return LinearThermalExpansionCoefficient<NumericType>{
      ConvertStatically<Unit::ReciprocalTemperature, Unit, Standard<Unit::ReciprocalTemperature>>(
          value)};
  }

  constexpr LinearThermalExpansionCoefficient<NumericType> operator+(
      const LinearThermalExpansionCoefficient<NumericType>& linear_thermal_expansion_coefficient)
      const {
    return LinearThermalExpansionCoefficient<NumericType>{
      this->value + linear_thermal_expansion_coefficient.value};
  }

  constexpr LinearThermalExpansionCoefficient<NumericType> operator-(
      const LinearThermalExpansionCoefficient<NumericType>& linear_thermal_expansion_coefficient)
      const {
    return LinearThermalExpansionCoefficient<NumericType>{
      this->value - linear_thermal_expansion_coefficient.value};
  }

  constexpr LinearThermalExpansionCoefficient<NumericType> operator*(
      const NumericType number) const {
    return LinearThermalExpansionCoefficient<NumericType>{this->value * number};
  }

  constexpr ScalarStrain<NumericType> operator*(
      const TemperatureDifference<NumericType>& temperature_difference) const {
    return ScalarStrain<NumericType>{*this, temperature_difference};
  }

  constexpr LinearThermalExpansionCoefficient<NumericType> operator/(
      const NumericType number) const {
    return LinearThermalExpansionCoefficient<NumericType>{this->value / number};
  }

  constexpr NumericType operator/(
      const LinearThermalExpansionCoefficient<NumericType>& linear_thermal_expansion_coefficient)
      const noexcept {
    return this->value / linear_thermal_expansion_coefficient.value;
  }

  constexpr void operator+=(const LinearThermalExpansionCoefficient<NumericType>&
                                linear_thermal_expansion_coefficient) noexcept {
    this->value += linear_thermal_expansion_coefficient.value;
  }

  constexpr void operator-=(const LinearThermalExpansionCoefficient<NumericType>&
                                linear_thermal_expansion_coefficient) noexcept {
    this->value -= linear_thermal_expansion_coefficient.value;
  }

  constexpr void operator*=(const NumericType number) noexcept {
    this->value *= number;
  }

  constexpr void operator/=(const NumericType number) noexcept {
    this->value /= number;
  }

private:
  /// \brief Constructor. Constructs a linear thermal expansion coefficient with a given value
  /// expressed in the standard reciprocal temperature unit.
  explicit constexpr LinearThermalExpansionCoefficient(const NumericType value)
    : DimensionalScalar<Unit::ReciprocalTemperature, NumericType>(value) {}
};

template <typename NumericType>
inline constexpr bool operator==(
    const LinearThermalExpansionCoefficient<NumericType>& left,
    const LinearThermalExpansionCoefficient<NumericType>& right) noexcept {
  return left.Value() == right.Value();
}

template <typename NumericType>
inline constexpr bool operator!=(
    const LinearThermalExpansionCoefficient<NumericType>& left,
    const LinearThermalExpansionCoefficient<NumericType>& right) noexcept {
  return left.Value() != right.Value();
}

template <typename NumericType>
inline constexpr bool operator<(
    const LinearThermalExpansionCoefficient<NumericType>& left,
    const LinearThermalExpansionCoefficient<NumericType>& right) noexcept {
  return left.Value() < right.Value();
}

template <typename NumericType>
inline constexpr bool operator>(
    const LinearThermalExpansionCoefficient<NumericType>& left,
    const LinearThermalExpansionCoefficient<NumericType>& right) noexcept {
  return left.Value() > right.Value();
}

template <typename NumericType>
inline constexpr bool operator<=(
    const LinearThermalExpansionCoefficient<NumericType>& left,
    const LinearThermalExpansionCoefficient<NumericType>& right) noexcept {
  return left.Value() <= right.Value();
}

template <typename NumericType>
inline constexpr bool operator>=(
    const LinearThermalExpansionCoefficient<NumericType>& left,
    const LinearThermalExpansionCoefficient<NumericType>& right) noexcept {
  return left.Value() >= right.Value();
}

template <typename NumericType>
inline std::ostream& operator<<(
    std::ostream& stream,
    const LinearThermalExpansionCoefficient<NumericType>& linear_thermal_expansion_coefficient) {
  stream << linear_thermal_expansion_coefficient.Print();
  return stream;
}

template <typename NumericType>
inline constexpr LinearThermalExpansionCoefficient<NumericType> operator*(
    const NumericType number,
    const LinearThermalExpansionCoefficient<NumericType>& linear_thermal_expansion_coefficient) {
  return linear_thermal_expansion_coefficient * number;
}

template <typename NumericType>
inline constexpr ScalarStrain<NumericType>::ScalarStrain(
    const LinearThermalExpansionCoefficient<NumericType>& linear_thermal_expansion_coefficient,
    const TemperatureDifference<NumericType>& temperature_difference)
  : ScalarStrain<NumericType>(
        linear_thermal_expansion_coefficient.Value() * temperature_difference.Value()) {}

template <typename NumericType>
inline constexpr ScalarStrain<NumericType> TemperatureDifference<NumericType>::operator*(
    const LinearThermalExpansionCoefficient<NumericType>& linear_thermal_expansion_coefficient)
    const {
  return ScalarStrain<NumericType>{linear_thermal_expansion_coefficient, *this};
}

}  // namespace PhQ

namespace std {

template <typename NumericType>
struct hash<PhQ::LinearThermalExpansionCoefficient<NumericType>> {
  inline size_t operator()(const PhQ::LinearThermalExpansionCoefficient<NumericType>&
                               linear_thermal_expansion_coefficient) const {
    return hash<NumericType>()(linear_thermal_expansion_coefficient.Value());
  }
};

}  // namespace std

#endif  // PHQ_LINEAR_THERMAL_EXPANSION_COEFFICIENT_HPP