MassRate.hpp

Go to the documentation of this file.

// 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_UNIT_MASS_RATE_HPP
#define PHQ_UNIT_MASS_RATE_HPP
 
#include <cstddef>
#include <cstdint>
#include <functional>
#include <map>
#include <ostream>
#include <string_view>
#include <unordered_map>
 
#include "../Base.hpp"
#include "../Dimension/ElectricCurrent.hpp"
#include "../Dimension/Length.hpp"
#include "../Dimension/LuminousIntensity.hpp"
#include "../Dimension/Mass.hpp"
#include "../Dimension/SubstanceAmount.hpp"
#include "../Dimension/Temperature.hpp"
#include "../Dimension/Time.hpp"
#include "../Dimensions.hpp"
#include "../Unit.hpp"
#include "../UnitSystem.hpp"
 
namespace PhQ {
 
namespace Unit {
 
/// \brief Mass rate units. Can represent the time rate of change of a mass or a mass flow rate.
enum class MassRate : int8_t {
  /// \brief Kilogram per second (kg/s) mass rate unit.
  KilogramPerSecond,
 
  /// \brief Gram per second (g/s) mass rate unit.
  GramPerSecond,
 
  /// \brief Slug per second (slug/s) mass rate unit.
  SlugPerSecond,
 
  /// \brief Slinch per second (slinch/s) mass rate unit.
  SlinchPerSecond,
 
  /// \brief Pound per second (lbm/s) mass rate unit.
  PoundPerSecond,
 
  /// \brief Kilogram per minute (kg/min) mass rate unit.
  KilogramPerMinute,
 
  /// \brief Gram per minute (g/min) mass rate unit.
  GramPerMinute,
 
  /// \brief Slug per minute (slug/min) mass rate unit.
  SlugPerMinute,
 
  /// \brief Slinch per minute (slinch/min) mass rate unit.
  SlinchPerMinute,
 
  /// \brief Pound per minute (lbm/min) mass rate unit.
  PoundPerMinute,
 
  /// \brief Kilogram per hour (kg/hr) mass rate unit.
  KilogramPerHour,
 
  /// \brief Gram per hour (g/hr) mass rate unit.
  GramPerHour,
 
  /// \brief Slug per hour (slug/hr) mass rate unit.
  SlugPerHour,
 
  /// \brief Slinch per hour (slinch/hr) mass rate unit.
  SlinchPerHour,
 
  /// \brief Pound per hour (lbm/hr) mass rate unit.
  PoundPerHour,
};
 
}  // namespace Unit
 
/// \brief Standard time rate of mass unit: kilogram per second (kg/s).
template <>
inline constexpr const Unit::MassRate Standard<Unit::MassRate>{Unit::MassRate::KilogramPerSecond};
 
/// \brief Physical dimension set of time rate of mass units.
template <>
inline constexpr const Dimensions RelatedDimensions<Unit::MassRate>{
  Dimensions{Dimension::Time{-1}, Dimension::Length{0}, Dimension::Mass{1},
             Dimension::ElectricCurrent{0}, Dimension::Temperature{0},
             Dimension::SubstanceAmount{0}, Dimension::LuminousIntensity{0}}
};
 
inline std::ostream& operator<<(std::ostream& stream, const Unit::MassRate unit) {
  stream << Abbreviation(unit);
  return stream;
}
 
namespace Internal {
 
template <>
inline const std::map<UnitSystem, Unit::MassRate> ConsistentUnits<Unit::MassRate>{
  {UnitSystem::MetreKilogramSecondKelvin,  Unit::MassRate::KilogramPerSecond},
  {UnitSystem::MillimetreGramSecondKelvin, Unit::MassRate::GramPerSecond    },
  {UnitSystem::FootPoundSecondRankine,     Unit::MassRate::SlugPerSecond    },
  {UnitSystem::InchPoundSecondRankine,     Unit::MassRate::SlinchPerSecond  },
};
 
template <>
inline const std::map<Unit::MassRate, UnitSystem> RelatedUnitSystems<Unit::MassRate>{
  {Unit::MassRate::KilogramPerSecond, UnitSystem::MetreKilogramSecondKelvin },
  {Unit::MassRate::GramPerSecond,     UnitSystem::MillimetreGramSecondKelvin},
  {Unit::MassRate::SlugPerSecond,     UnitSystem::FootPoundSecondRankine    },
  {Unit::MassRate::SlinchPerSecond,   UnitSystem::InchPoundSecondRankine    },
};
 
template <>
inline const std::map<Unit::MassRate, std::string_view> Abbreviations<Unit::MassRate>{
  {Unit::MassRate::KilogramPerSecond, "kg/s"      },
  {Unit::MassRate::GramPerSecond,     "g/s"       },
  {Unit::MassRate::SlugPerSecond,     "slug/s"    },
  {Unit::MassRate::SlinchPerSecond,   "slinch/s"  },
  {Unit::MassRate::PoundPerSecond,    "lbm/s"     },
  {Unit::MassRate::KilogramPerMinute, "kg/min"    },
  {Unit::MassRate::GramPerMinute,     "g/min"     },
  {Unit::MassRate::SlugPerMinute,     "slug/min"  },
  {Unit::MassRate::SlinchPerMinute,   "slinch/min"},
  {Unit::MassRate::PoundPerMinute,    "lbm/min"   },
  {Unit::MassRate::KilogramPerHour,   "kg/hr"     },
  {Unit::MassRate::GramPerHour,       "g/hr"      },
  {Unit::MassRate::SlugPerHour,       "slug/hr"   },
  {Unit::MassRate::SlinchPerHour,     "slinch/hr" },
  {Unit::MassRate::PoundPerHour,      "lbm/hr"    },
};
 
template <>
inline const std::unordered_map<std::string_view, Unit::MassRate> Spellings<Unit::MassRate>{
  {"kg/s",       Unit::MassRate::KilogramPerSecond},
  {"g/s",        Unit::MassRate::GramPerSecond    },
  {"slug/s",     Unit::MassRate::SlugPerSecond    },
  {"slinch/s",   Unit::MassRate::SlinchPerSecond  },
  {"lbm/s",      Unit::MassRate::PoundPerSecond   },
  {"lb/s",       Unit::MassRate::PoundPerSecond   },
  {"kg/min",     Unit::MassRate::KilogramPerMinute},
  {"g/min",      Unit::MassRate::GramPerMinute    },
  {"slug/min",   Unit::MassRate::SlugPerMinute    },
  {"slinch/min", Unit::MassRate::SlinchPerMinute  },
  {"lbm/min",    Unit::MassRate::PoundPerMinute   },
  {"lb/min",     Unit::MassRate::PoundPerMinute   },
  {"kg/hr",      Unit::MassRate::KilogramPerHour  },
  {"g/hr",       Unit::MassRate::GramPerHour      },
  {"slug/hr",    Unit::MassRate::SlugPerHour      },
  {"slinch/hr",  Unit::MassRate::SlinchPerHour    },
  {"lbm/hr",     Unit::MassRate::PoundPerHour     },
  {"lb/hr",      Unit::MassRate::PoundPerHour     },
};
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::KilogramPerSecond>::FromStandard(
    NumericType& /*value*/) noexcept {}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::KilogramPerSecond>::ToStandard(
    NumericType& /*value*/) noexcept {}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::GramPerSecond>::FromStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(1000.0L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::GramPerSecond>::ToStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.001L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::SlugPerSecond>::FromStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.3048L)
           / (static_cast<NumericType>(0.45359237L) * static_cast<NumericType>(9.80665L));
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::SlugPerSecond>::ToStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.45359237L) * static_cast<NumericType>(9.80665L)
           / static_cast<NumericType>(0.3048L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::SlinchPerSecond>::FromStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.0254L)
           / (static_cast<NumericType>(0.45359237L) * static_cast<NumericType>(9.80665L));
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::SlinchPerSecond>::ToStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.45359237L) * static_cast<NumericType>(9.80665L)
           / static_cast<NumericType>(0.0254L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::PoundPerSecond>::FromStandard(
    NumericType& value) noexcept {
  value /= static_cast<NumericType>(0.45359237L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::PoundPerSecond>::ToStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.45359237L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::KilogramPerMinute>::FromStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(60.0L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::KilogramPerMinute>::ToStandard(
    NumericType& value) noexcept {
  value /= static_cast<NumericType>(60.0L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::GramPerMinute>::FromStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(60000.0L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::GramPerMinute>::ToStandard(
    NumericType& value) noexcept {
  value /= static_cast<NumericType>(60000.0L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::SlugPerMinute>::FromStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(60.0L) * static_cast<NumericType>(0.3048L)
           / (static_cast<NumericType>(0.45359237L) * static_cast<NumericType>(9.80665L));
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::SlugPerMinute>::ToStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.45359237L) * static_cast<NumericType>(9.80665L)
           / (static_cast<NumericType>(0.3048L) * static_cast<NumericType>(60.0L));
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::SlinchPerMinute>::FromStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(60.0L) * static_cast<NumericType>(0.0254L)
           / (static_cast<NumericType>(0.45359237L) * static_cast<NumericType>(9.80665L));
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::SlinchPerMinute>::ToStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.45359237L) * static_cast<NumericType>(9.80665L)
           / (static_cast<NumericType>(0.0254L) * static_cast<NumericType>(60.0L));
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::PoundPerMinute>::FromStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(60.0L) / static_cast<NumericType>(0.45359237L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::PoundPerMinute>::ToStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.45359237L) / static_cast<NumericType>(60.0L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::KilogramPerHour>::FromStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(3600.0L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::KilogramPerHour>::ToStandard(
    NumericType& value) noexcept {
  value /= static_cast<NumericType>(3600.0L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::GramPerHour>::FromStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(3600000.0L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::GramPerHour>::ToStandard(
    NumericType& value) noexcept {
  value /= static_cast<NumericType>(3600000.0L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::SlugPerHour>::FromStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(3600.0L) * static_cast<NumericType>(0.3048L)
           / (static_cast<NumericType>(0.45359237L) * static_cast<NumericType>(9.80665L));
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::SlugPerHour>::ToStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.45359237L) * static_cast<NumericType>(9.80665L)
           / (static_cast<NumericType>(0.3048L) * static_cast<NumericType>(3600.0L));
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::SlinchPerHour>::FromStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(3600.0L) * static_cast<NumericType>(0.0254L)
           / (static_cast<NumericType>(0.45359237L) * static_cast<NumericType>(9.80665L));
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::SlinchPerHour>::ToStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.45359237L) * static_cast<NumericType>(9.80665L)
           / (static_cast<NumericType>(0.0254L) * static_cast<NumericType>(3600.0L));
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::PoundPerHour>::FromStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(3600.0L) / static_cast<NumericType>(0.45359237L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::MassRate, Unit::MassRate::PoundPerHour>::ToStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.45359237L) / static_cast<NumericType>(3600.0L);
}
 
template <typename NumericType>
inline const std::map<Unit::MassRate,
                      std::function<void(NumericType* values, const std::size_t size)>>
    MapOfConversionsFromStandard<Unit::MassRate, NumericType>{
      {Unit::MassRate::KilogramPerSecond,
       Conversions<Unit::MassRate, Unit::MassRate::KilogramPerSecond>::FromStandard<NumericType>},
      {Unit::MassRate::GramPerSecond,
       Conversions<Unit::MassRate, Unit::MassRate::GramPerSecond>::FromStandard<NumericType>    },
      {Unit::MassRate::SlugPerSecond,
       Conversions<Unit::MassRate, Unit::MassRate::SlugPerSecond>::FromStandard<NumericType>    },
      {Unit::MassRate::SlinchPerSecond,
       Conversions<Unit::MassRate, Unit::MassRate::SlinchPerSecond>::FromStandard<NumericType>  },
      {Unit::MassRate::PoundPerSecond,
       Conversions<Unit::MassRate, Unit::MassRate::PoundPerSecond>::FromStandard<NumericType>   },
      {Unit::MassRate::KilogramPerMinute,
       Conversions<Unit::MassRate, Unit::MassRate::KilogramPerMinute>::FromStandard<NumericType>},
      {Unit::MassRate::GramPerMinute,
       Conversions<Unit::MassRate, Unit::MassRate::GramPerMinute>::FromStandard<NumericType>    },
      {Unit::MassRate::SlugPerMinute,
       Conversions<Unit::MassRate, Unit::MassRate::SlugPerMinute>::FromStandard<NumericType>    },
      {Unit::MassRate::SlinchPerMinute,
       Conversions<Unit::MassRate, Unit::MassRate::SlinchPerMinute>::FromStandard<NumericType>  },
      {Unit::MassRate::PoundPerMinute,
       Conversions<Unit::MassRate, Unit::MassRate::PoundPerMinute>::FromStandard<NumericType>   },
      {Unit::MassRate::KilogramPerHour,
       Conversions<Unit::MassRate, Unit::MassRate::KilogramPerHour>::FromStandard<NumericType>  },
      {Unit::MassRate::GramPerHour,
       Conversions<Unit::MassRate, Unit::MassRate::GramPerHour>::FromStandard<NumericType>      },
      {Unit::MassRate::SlugPerHour,
       Conversions<Unit::MassRate, Unit::MassRate::SlugPerHour>::FromStandard<NumericType>      },
      {Unit::MassRate::SlinchPerHour,
       Conversions<Unit::MassRate, Unit::MassRate::SlinchPerHour>::FromStandard<NumericType>    },
      {Unit::MassRate::PoundPerHour,
       Conversions<Unit::MassRate, Unit::MassRate::PoundPerHour>::FromStandard<NumericType>     },
};
 
template <typename NumericType>
inline const std::
    map<Unit::MassRate, std::function<void(NumericType* const values, const std::size_t size)>>
        MapOfConversionsToStandard<Unit::MassRate, NumericType>{
          {Unit::MassRate::KilogramPerSecond,
           Conversions<Unit::MassRate, Unit::MassRate::KilogramPerSecond>::ToStandard<NumericType>},
          {Unit::MassRate::GramPerSecond,
           Conversions<Unit::MassRate, Unit::MassRate::GramPerSecond>::ToStandard<NumericType>    },
          {Unit::MassRate::SlugPerSecond,
           Conversions<Unit::MassRate, Unit::MassRate::SlugPerSecond>::ToStandard<NumericType>    },
          {Unit::MassRate::SlinchPerSecond,
           Conversions<Unit::MassRate, Unit::MassRate::SlinchPerSecond>::ToStandard<NumericType>  },
          {Unit::MassRate::PoundPerSecond,
           Conversions<Unit::MassRate, Unit::MassRate::PoundPerSecond>::ToStandard<NumericType>   },
          {Unit::MassRate::KilogramPerMinute,
           Conversions<Unit::MassRate, Unit::MassRate::KilogramPerMinute>::ToStandard<NumericType>},
          {Unit::MassRate::GramPerMinute,
           Conversions<Unit::MassRate, Unit::MassRate::GramPerMinute>::ToStandard<NumericType>    },
          {Unit::MassRate::SlugPerMinute,
           Conversions<Unit::MassRate, Unit::MassRate::SlugPerMinute>::ToStandard<NumericType>    },
          {Unit::MassRate::SlinchPerMinute,
           Conversions<Unit::MassRate, Unit::MassRate::SlinchPerMinute>::ToStandard<NumericType>  },
          {Unit::MassRate::PoundPerMinute,
           Conversions<Unit::MassRate, Unit::MassRate::PoundPerMinute>::ToStandard<NumericType>   },
          {Unit::MassRate::KilogramPerHour,
           Conversions<Unit::MassRate, Unit::MassRate::KilogramPerHour>::ToStandard<NumericType>  },
          {Unit::MassRate::GramPerHour,
           Conversions<Unit::MassRate, Unit::MassRate::GramPerHour>::ToStandard<NumericType>      },
          {Unit::MassRate::SlugPerHour,
           Conversions<Unit::MassRate, Unit::MassRate::SlugPerHour>::ToStandard<NumericType>      },
          {Unit::MassRate::SlinchPerHour,
           Conversions<Unit::MassRate, Unit::MassRate::SlinchPerHour>::ToStandard<NumericType>    },
          {Unit::MassRate::PoundPerHour,
           Conversions<Unit::MassRate, Unit::MassRate::PoundPerHour>::ToStandard<NumericType>     },
};
 
}  // namespace Internal
 
}  // namespace PhQ
 
#endif  // PHQ_UNIT_MASS_RATE_HPP