ScalarHeatFlux.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_SCALAR_HEAT_FLUX_HPP
#define PHQ_SCALAR_HEAT_FLUX_HPP

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

#include "DimensionalScalar.hpp"
#include "ScalarTemperatureGradient.hpp"
#include "ScalarThermalConductivity.hpp"
#include "Unit/EnergyFlux.hpp"

namespace PhQ {

// Forward declaration for class PhQ::ScalarHeatFlux.
template <typename NumericType>
class HeatFlux;

// Forward declaration for class PhQ::ScalarHeatFlux.
template <typename NumericType>
class PlanarHeatFlux;

/// \brief Scalar heat flux component or magnitude of a heat flux vector. For a three-dimensional
/// Euclidean heat flux vector, see PhQ::HeatFlux. For a two-dimensional Euclidean heat flux vector
/// in the XY plane, see PhQ::PlanarHeatFlux.
template <typename NumericType = double>
class ScalarHeatFlux : public DimensionalScalar<Unit::EnergyFlux, NumericType> {
public:
  /// \brief Default constructor. Constructs a scalar heat flux with an uninitialized value.
  ScalarHeatFlux() = default;

  /// \brief Constructor. Constructs a scalar heat flux with a given value expressed in a given
  /// energy flux unit.
  ScalarHeatFlux(const NumericType value, const Unit::EnergyFlux unit)
    : DimensionalScalar<Unit::EnergyFlux, NumericType>(value, unit) {}

  /// \brief Constructor. Constructs a scalar heat flux from a given scalar thermal conductivity and
  /// scalar temperature gradient using Fourier's law of heat conduction. Since heat flows opposite
  /// the temperature gradient, the resulting scalar heat flux is negative.
  constexpr ScalarHeatFlux(
      const ScalarThermalConductivity<NumericType>& scalar_thermal_conductivity,
      const ScalarTemperatureGradient<NumericType>& scalar_temperature_gradient)
    : ScalarHeatFlux<NumericType>(
          -scalar_thermal_conductivity.Value() * scalar_temperature_gradient.Value()) {}

  /// \brief Destructor. Destroys this scalar heat flux.
  ~ScalarHeatFlux() noexcept = default;

  /// \brief Copy constructor. Constructs a scalar heat flux by copying another one.
  constexpr ScalarHeatFlux(const ScalarHeatFlux<NumericType>& other) = default;

  /// \brief Copy constructor. Constructs a scalar heat flux by copying another one.
  template <typename OtherNumericType>
  explicit constexpr ScalarHeatFlux(const ScalarHeatFlux<OtherNumericType>& other)
    : ScalarHeatFlux(static_cast<NumericType>(other.Value())) {}

  /// \brief Move constructor. Constructs a scalar heat flux by moving another one.
  constexpr ScalarHeatFlux(ScalarHeatFlux<NumericType>&& other) noexcept = default;

  /// \brief Copy assignment operator. Assigns this scalar heat flux by copying another one.
  constexpr ScalarHeatFlux<NumericType>& operator=(
      const ScalarHeatFlux<NumericType>& other) = default;

  /// \brief Copy assignment operator. Assigns this scalar heat flux by copying another one.
  template <typename OtherNumericType>
  constexpr ScalarHeatFlux<NumericType>& operator=(const ScalarHeatFlux<OtherNumericType>& other) {
    this->value = static_cast<NumericType>(other.Value());
    return *this;
  }

  /// \brief Move assignment operator. Assigns this scalar heat flux by moving another one.
  constexpr ScalarHeatFlux<NumericType>& operator=(
      ScalarHeatFlux<NumericType>&& other) noexcept = default;

  /// \brief Statically creates a scalar heat flux of zero.
  [[nodiscard]] static constexpr ScalarHeatFlux<NumericType> Zero() {
    return ScalarHeatFlux<NumericType>{static_cast<NumericType>(0)};
  }

  /// \brief Statically creates a scalar heat flux with a given value expressed in a given energy
  /// flux unit.
  template <Unit::EnergyFlux Unit>
  [[nodiscard]] static constexpr ScalarHeatFlux<NumericType> Create(const NumericType value) {
    return ScalarHeatFlux<NumericType>{
      ConvertStatically<Unit::EnergyFlux, Unit, Standard<Unit::EnergyFlux>>(value)};
  }

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

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

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

  constexpr PlanarHeatFlux<NumericType> operator*(
      const PlanarDirection<NumericType>& planar_direction) const;

  constexpr HeatFlux<NumericType> operator*(const Direction<NumericType>& direction) const;

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

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

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

  constexpr void operator-=(const ScalarHeatFlux<NumericType>& scalar_heat_flux) noexcept {
    this->value -= scalar_heat_flux.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 scalar heat flux with a given value expressed in the standard
  /// energy flux unit.
  explicit constexpr ScalarHeatFlux(const NumericType value)
    : DimensionalScalar<Unit::EnergyFlux, NumericType>(value) {}

  template <typename OtherNumericType>
  friend class PlanarHeatFlux;

  template <typename OtherNumericType>
  friend class HeatFlux;
};

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

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

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

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

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

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

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

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

}  // namespace PhQ

namespace std {

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

}  // namespace std

#endif  // PHQ_SCALAR_HEAT_FLUX_HPP